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
52

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

use crate::client::client;
use crate::model::role;
use crate::model::types;

/// Retrieves a specific Ruddr Role object by id, and deserializes it to the corresponding model struct.
/// [API Documentation](https://ruddr.readme.io/reference/get-a-project-role)
/// ```ignore
/// let role = role(&client, types::UUID::try_from("7ad5a34a-07b7-48e9-a760-bd220d52e354").expect("uuid conversion failed")).await?;
/// ```
pub async fn role(
    client: &client::Client,
    id: types::UUID,
) -> Result<role::Role, Box<dyn std::error::Error>> {
    // retrieve role
    Ok(client
        .read::<role::Role>(&format!("project-roles/{id}"), None)
        .await?)
}

/// Retrieves the first 100 Ruddr Role objects by filters, and deserializes it to the corresponding vector of model structs.
/// [API Documentation](https://ruddr.readme.io/reference/list-project-roles)
/// ```ignore
/// let roles = roles(
///     &client,
///     Some(types::UUID::try_from("095e0780-48bf-472c-8deb-2fc3ebc7d90c").expect("uuid conversion failed")),
/// ).await?;
/// ```
pub async fn roles(
    client: &client::Client,
    project: Option<types::UUID>,
) -> Result<role::Roles, Box<dyn std::error::Error>> {
    // initialize params
    let mut params = String::from("limit=100");

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

    // retrieve roles
    Ok(client
        .read::<role::Roles>("project-roles", Some(&params))
        .await?)
}

#[cfg(test)]
mod tests;