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

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

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

/// Retrieves a specific Ruddr Workspace Member object by id, and deserializes it to the corresponding model struct.
/// [API Documentation](https://ruddr.readme.io/reference/get-a-member)
/// ```ignore
/// let member = member(&client, types::UUID::try_from("3f3df320-dd95-4a42-8eae-99243fb2ea86").expect("invalid UUID")).await?;
/// ```
pub async fn member(
    client: &client::Client,
    id: types::UUID,
) -> Result<member::Member, Box<dyn std::error::Error>> {
    // retrieve member
    Ok(client
        .read::<member::Member>(&format!("members/{id}"), None)
        .await?)
}

/// Retrieves the first 100 Ruddr Workspace Member objects, and deserializes it to the corresponding vector of model structs.
/// [API Documentation](https://ruddr.readme.io/reference/list-members)
/// ```ignore
/// let members = members(&client, Some("Joe"), Some("foo@bar.com")).await?;
/// ```
pub async fn members(
    client: &client::Client,
    name_contains: Option<&str>,
    email_contains: Option<&str>,
) -> Result<member::Members, Box<dyn std::error::Error>> {
    // initialize params
    let mut params = String::from("limit=100");

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

    // retrieve members
    Ok(client
        .read::<member::Members>("members", Some(&params))
        .await?)
}

#[cfg(test)]
mod tests;