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

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

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

/// Retrieves a specific Ruddr Cost period object by id, and deserializes it to the corresponding model struct.
/// [API Documentation](https://ruddr.readme.io/reference/get-a-cost-period)
/// ```ignore
/// let cost = cost(&client, types::UUID::try_from("b3a100b0-8e71-4f39-9d96-32f11838aa8c").expect("invalid UUID")).await?;
/// ```
pub async fn cost(
    client: &client::Client,
    id: types::UUID,
) -> Result<cost::Cost, Box<dyn std::error::Error>> {
    // retrieve cost target period
    Ok(client
        .read::<cost::Cost>(&format!("cost-periods/{id}"), None)
        .await?)
}

/// Retrieves the first 100 Ruddr Cost period objects by filters, and deserializes it to the corresponding vector of model structs.
/// [API Documentation](https://ruddr.readme.io/reference/list-cost-periods)
/// ```ignore
/// let costs = costs(
///     &client,
///     Some(types::UUID::try_from("ec5543de-3b0f-47a0-b8ef-a6e18dc4b885").expect("uuid conversion failed")),
/// ).await?;
/// ```
pub async fn costs(
    client: &client::Client,
    member: Option<types::UUID>,
) -> Result<cost::Costs, 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 cost target periods
    Ok(client
        .read::<cost::Costs>("cost-periods", Some(&params))
        .await?)
}

#[cfg(test)]
mod tests;