Struct Users

pub struct Users {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Users

pub async fn list<'a>( &'a self, cursor: Option<String>, order_by: Option<String>, ) -> Result<ListUsersResponse, Error>

List users

A List of users

• Requires: API Tier 1
• Sortable fields: id, created_at, updated_at

Parameters:

• cursor: Option<String>
• order_by: Option<String>

use futures_util::TryStreamExt;
async fn example_users_list_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut users = client.users();
    let mut stream = users.list_stream(Some("some-string".to_string()));
    loop {
        match stream.try_next().await {
            Ok(Some(item)) => {
                println!("{:?}", item);
            }
            Ok(None) => {
                break;
            }
            Err(err) => {
                return Err(err.into());
            }
        }
    }

    Ok(())
}

pub async fn get<'a>(&'a self, id: &'a str) -> Result<GetUsersResponse, Error>

Retrieve a specific user

Retrieve a specific user

Parameters:

• id: &'astr: ID of the resource to return (required)

async fn example_users_get() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::GetUsersResponse = client
        .users()
        .get("d9797f8d-9ad6-4e08-90d7-2ec17e13471c")
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Users

fn clone(&self) -> Users

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Users

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.