Struct SystemApi 

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

Sub-API for system endpoints.

Implementations

impl<'a> SystemApi<'a>

pub async fn get_system_status(&self) -> Result<Value, RsError>

Get system status - healthcheck information.

Arguments

None

Returns

Returns back system status information (configuration dependant - e.g mysql_log_transactions).

Examples

let status = client.system().get_system_status().await?;

pub async fn get_daily_stat_summary( &self, request: GetDailyStatSummaryRequest, ) -> Result<Value, RsError>

Return a summary of daily statistics by activity type.

Note max 365 days as only the current and previous year’s data is accessed.

Arguments

• request - Parameters built via GetDailyStatSummaryRequest

Returns

Returns an array of daily statistics.

TODO: Errors

Examples

// Default — last 30 days
let stats = client.system()
    .get_daily_stat_summary(GetDailyStatSummaryRequest::new())
    .await?;

// Last 7 days
let stats = client.system()
    .get_daily_stat_summary(GetDailyStatSummaryRequest::new().days(7))
    .await?;

Examples found in repository

examples/basic.rs (line 37)

async fn main() {
    dotenvy::from_path("examples/.env").ok();

    let base_url = std::env::var("RS_BASE_URL").expect("RS_BASE_URL not set");
    let user = std::env::var("RS_USER").expect("RS_USER not set");
    let _password = std::env::var("RS_PASS").expect("RS_PASS not set");
    let key = std::env::var("RS_KEY").expect("RS_KEY not set");

    let client = Client::builder()
        .base_url(&base_url)
        .expect("Error when setting base_url")
        .user_key(&user, &key)
        // .session_key(&user, &password)
        .build()
        .await
        .expect("Error when building client");

    let search_result = client
        .search()
        .do_search(DoSearchRequest::new("909").sort(SortOrder::Asc))
        .await;

    match search_result {
        Ok(response) => println!("{:#?}", response),
        Err(e) => println!("Error: {}", e),
    }

    let system_result = client
        .system()
        .get_daily_stat_summary(GetDailyStatSummaryRequest::new().days(31))
        .await;

    match system_result {
        Ok(response) => println!("{:#?}", response),
        Err(e) => println!("Error: {}", e),
    }

    let message_result = client
        .message()
        .get_user_message(GetUserMessageRequest::new(12))
        .await;

    match message_result {
        Ok(response) => println!("{:#?}", response),
        Err(e) => println!("Error: {}", e),
    }
}

pub async fn get_reports(&self) -> Result<Value, RsError>

pub async fn do_report(&self) -> Result<Value, RsError>

Trait Implementations

impl<'a> Debug for SystemApi<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.