sure-client-rs 0.4.0

A non-official Rust client library for the Akahu API, providing access to financial data aggregation services in New Zealand
Documentation
mod accounts;
mod auth;
mod categories;
mod chats;
mod core;
mod merchants;
mod sync;
mod transactions;
mod usage;
mod valuations;

use url::Url;

use crate::types::Auth;

/// The main Sure API client
///
/// This client provides access to all Sure API endpoints. It handles authentication,
/// request execution, and error handling.
///
/// The API supports two authentication methods:
/// - Bearer token (JWT) via Authorization header
/// - API key via X-Api-Key header
///
/// # Example with API Key
/// ```no_run
/// use sure_client_rs::{SureClient, Auth};
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let client = SureClient::new(
///     reqwest::Client::new(),
///     Auth::api_key("your_api_key"),
///     "http://localhost:3000".to_string().parse().unwrap(),
/// );
///
/// let categories = client.get_categories().call().await?;
/// # Ok(())
/// # }
/// ```
///
/// # Example with Bearer Token
/// ```no_run
/// use sure_client_rs::{SureClient, Auth};
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let client = SureClient::new(
///     reqwest::Client::new(),
///     Auth::bearer("your_jwt_token"),
///     "http://localhost:3000".to_string().parse().unwrap(),
/// );
///
/// let categories = client.get_categories().call().await?;
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
pub struct SureClient {
    /// The HTTP client for making requests
    pub(crate) client: reqwest::Client,
    /// Authentication credentials (Bearer token or API key)
    pub(crate) auth: Auth,
    /// Base URL for the API
    pub(crate) base_url: Url,
}

impl SureClient {
    /// Create a new Sure API client
    ///
    /// # Arguments
    /// * `client` - A configured reqwest::Client for making HTTP requests
    /// * `auth` - Authentication method (Bearer token or API key)
    /// * `base_url` - base url to target
    ///
    /// # Example with API Key
    /// ```no_run
    /// use sure_client_rs::{SureClient, Auth};
    ///
    /// let client = SureClient::new(
    ///     reqwest::Client::new(),
    ///     Auth::api_key("your_api_key"),
    ///     "http://localhost:3000".to_string().parse().unwrap()
    /// );
    /// ```
    ///
    /// # Example with Bearer Token
    /// ```no_run
    /// use sure_client_rs::{SureClient, Auth};
    ///
    /// let client = SureClient::new(
    ///     reqwest::Client::new(),
    ///     Auth::bearer("your_token"),
    ///     "http://localhost:3000".to_string().parse().unwrap()
    /// );
    /// ```
    pub fn new<T: Into<Auth>>(client: reqwest::Client, auth: T, base_url: Url) -> Self {
        Self {
            client,
            auth: auth.into(),
            base_url,
        }
    }
}