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

//! # Utilization
//!
//! `interface::utilization` consists of functions for interfacing with the Ruddr Utilization target period endpoints.
use std::fmt::Write;

use crate::client::client;
use crate::model::{types, utilization};

/// Retrieves a specific Ruddr Utilization target period object by id, and deserializes it to the corresponding model struct.
/// [API Documentation](https://ruddr.readme.io/reference/get-a-utilization-target-period)
/// ```ignore
/// let utilization = utilization(&client, types::UUID::try_from("8e6d6316-5bc2-4135-b99c-f604f29051ab").expect("invalid UUID")).await?;
/// ```
pub async fn utilization(
    client: &client::Client,
    id: types::UUID,
) -> Result<utilization::Utilization, Box<dyn std::error::Error>> {
    // retrieve utilization target period
    Ok(client
        .read::<utilization::Utilization>(&format!("utilization-target-periods/{id}"), None)
        .await?)
}

/// Retrieves the first 100 Ruddr Utilization target period objects by filters, and deserializes it to the corresponding vector of model structs.
/// [API Documentation](https://ruddr.readme.io/reference/list-utilization-target-periods)
/// ```ignore
/// let utilizations = utilizations(
///     &client,
///     Some(types::UUID::try_from("ec5543de-3b0f-47a0-b8ef-a6e18dc4b885").expect("invalid UUID")),
/// ).await?;
/// ```
pub async fn utilizations(
    client: &client::Client,
    member: Option<types::UUID>,
) -> Result<utilization::Utilizations, Box<dyn std::error::Error>> {
    // initialize params
    let mut params = String::from("limit=100");

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

    // retrieve utilization target periods
    Ok(client
        .read::<utilization::Utilizations>("utilization-target-periods", Some(&params))
        .await?)
}

#[cfg(test)]
mod tests;