ruddr 1.1.1

A lightweight Ruddr SDK Rust crate
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! # Customer
//!
//! `interface::customer` consists of functions for interfacing with the Ruddr Client endpoints. This module and base Read function are named differently from the endpoint so as to avoid naming collisions with the API client module in external usage. All other code associated with this endpoint utilizes the endpoint name `client`.
use std::fmt::Write;

use crate::client::client;
use crate::model;

/// Retrieves a specific Ruddr Client object by id, and deserializes it to the corresponding model struct.
/// [API Documentation](https://ruddr.readme.io/reference/get-a-client)
/// ```ignore
/// let customer = customer(&client, types::UUID::try_from("4cacdf11-71d1-4fbb-90ee-b091803581b0").expect("invalid UUID")).await?;
/// ```
pub async fn customer(
    client: &client::Client,
    id: model::types::UUID,
) -> Result<model::client::Client, Box<dyn std::error::Error>> {
    // retrieve client
    Ok(client
        .read::<model::client::Client>(&format!("clients/{id}"), None)
        .await?)
}

/// Retrieves the first 100 Ruddr Client objects by filters, and deserializes it to the corresponding vector of model structs.
/// [API Documentation](https://ruddr.readme.io/reference/list-clients)
/// ```ignore
/// let clients = clients(
///     &client,
///     Some("JOE"),
/// ).await?;
/// ```
pub async fn clients(
    client: &client::Client,
    code: Option<&str>,
) -> Result<model::client::Clients, Box<dyn std::error::Error>> {
    // initialize params
    let mut params = String::from("limit=100");

    // optional parameters for LIST
    if let Some(code) = code {
        write!(params, "&code={}", code)?;
    }

    // retrieve clients
    Ok(client
        .read::<model::client::Clients>("clients", Some(&params))
        .await?)
}

#[cfg(test)]
mod tests;