Struct Compensations

pub struct Compensations {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Compensations

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

List compensations

A List of compensations

• Requires: API Tier 2
• Expandable fields: worker
• Sortable fields: id, created_at, updated_at

Parameters:

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

use futures_util::TryStreamExt;
async fn example_compensations_list_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut compensations = client.compensations();
    let mut stream = compensations.list_stream(
        Some("some-string".to_string()),
        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, expand: Option<String>, id: &'a str, ) -> Result<GetCompensationsResponse, Error>

Retrieve a specific compensation

Retrieves the Compensation for the Worker with the ID provided in the URL path.

Parameters:

• expand: Option<String>
• id: &'astr: ID of the resource to return (required)

async fn example_compensations_get() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::GetCompensationsResponse = client
        .compensations()
        .get(
            Some("some-string".to_string()),
            "d9797f8d-9ad6-4e08-90d7-2ec17e13471c",
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Compensations

fn clone(&self) -> Compensations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Compensations

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

Formats the value using the given formatter.