Struct OrdinaryApiClient 

pub struct OrdinaryApiClient<'a> { /* private fields */ }

Available on crate feature client only.

client for interaction with Ordinary API Server

Implementations

impl<'a> OrdinaryApiClient<'a>

pub fn new( addr: &'a str, account: &'a str, api_domain: Option<&'a str>, danger_accept_invalid_certs: bool, user_agent: &str, ) -> Result<OrdinaryApiClient<'a>, Box<dyn Error>>

pub fn list_accounts() -> Result<Vec<AccountMeta>, Box<dyn Error>>

pub fn get_account( host: &str, account: &str, ) -> Result<AccountMeta, Box<dyn Error>>

pub async fn register( &self, password: &str, invite_code: &str, ) -> Result<(TOTP, String), Box<dyn Error>>

register with API server

pub async fn login( &self, password: &str, mfa_code: &str, ) -> Result<(), Box<dyn Error>>

log in to API server

pub async fn get_access( &self, duration_s: Option<u32>, ) -> Result<Vec<u8>, Box<dyn Error>>

get access token for API server

pub async fn reset_password( &self, old_password: &str, mfa_code: &str, new_password: &str, ) -> Result<(), Box<dyn Error>>

pub async fn invite_api_account( &self, app_domain: &str, account_name: &str, permissions: Vec<u8>, ) -> Result<String, Box<dyn Error>>

invite API account

pub async fn api_accounts_list( &self, proj_path: Option<&str>, ) -> Result<String, Box<dyn Error>>

list accounts for the API server

pub async fn deploy(&self, proj_path: &str) -> Result<u16, Box<dyn Error>>

deploy app to a API server

pub async fn patch(&self, proj_path: &str) -> Result<u16, Box<dyn Error>>

patch app config on API server

pub async fn kill(&self, proj_path: &str) -> Result<(), Box<dyn Error>>

kill app on API server

pub async fn app_logs( &self, proj_path: &str, query: &str, format: &str, limit: &Option<usize>, ) -> Result<Value, Box<dyn Error>>

query an app’s logs

pub async fn app_accounts_list( &self, proj_path: &str, ) -> Result<String, Box<dyn Error>>

list accounts for an app

pub async fn items_list( &self, proj_path: &str, model_name: &str, ) -> Result<String, Box<dyn Error>>

list app items by their model index

pub async fn write( &self, proj_path: &str, asset_path: &str, ) -> Result<(), Box<dyn Error>>

write a single asset

pub async fn write_all(&self, proj_path: &str) -> Result<(), Box<dyn Error>>

write all assets in assets dir_path

pub async fn upload( &self, proj_path: &str, template_name: &str, ) -> Result<(), Box<dyn Error>>

upload a single template

pub async fn upload_all(&self, proj_path: &str) -> Result<(), Box<dyn Error>>

upload all templates

pub async fn install( &self, proj_path: &str, action_name: &str, ) -> Result<(), Box<dyn Error>>

install single action

pub async fn install_all(&self, proj_path: &str) -> Result<(), Box<dyn Error>>

install all actions

pub async fn update(&self, proj_path: &str) -> Result<(), Box<dyn Error>>

update content