sure-client-rs 0.4.3

A non-official Rust client library for the Akahu API, providing access to financial data aggregation services in New Zealand
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use crate::error::ApiResult;
use crate::models::sync::SyncResponse;
use reqwest::Method;

use super::SureClient;

impl SureClient {
    /// Trigger a family sync
    ///
    /// Triggers a sync operation that will apply all active rules, sync all accounts,
    /// and auto-match transfers.
    ///
    /// # Returns
    /// Sync response with status information.
    ///
    /// # Errors
    /// Returns `ApiError::Unauthorized` if the API key is invalid.
    /// Returns `ApiError::Forbidden` if the API key has insufficient scope.
    /// Returns `ApiError::InternalServerError` if the sync fails to start.
    /// Returns `ApiError::Network` if the request fails due to network issues.
    ///
    /// # Example
    /// ```no_run
    /// use sure_client_rs::{SureClient, BearerToken};
    ///
    /// # async fn example(client: SureClient) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = client.trigger_sync().await?;
    /// println!("Sync queued: {}", response.message);
    /// # Ok(())
    /// # }
    /// ```
    ///
    pub async fn trigger_sync(&self) -> ApiResult<SyncResponse> {
        self.execute_request(Method::POST, "/api/v1/sync", None, None)
            .await
    }
}