Struct ShiftInputs

pub struct ShiftInputs {
    pub client: Client,
}

Fields

client: Client

Implementations

impl ShiftInputs

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

List shift inputs

A List of shift inputs

• Requires: API Tier 2
• Filterable fields: name
• Expandable fields: creator
• Sortable fields: id, created_at, updated_at

Parameters:

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

use futures_util::TryStreamExt;
async fn example_shift_inputs_list_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut shift_inputs = client.shift_inputs();
    let mut stream = shift_inputs.list_stream(
        Some("some-string".to_string()),
        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 create<'a>( &'a self, body: &ShiftInputRequest, ) -> Result<ShiftInput, Error>

Create a new shift input

Create a new shift input

async fn example_shift_inputs_create() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::ShiftInput = client
        .shift_inputs()
        .create(&rippling_api::types::ShiftInputRequest {
            creator_id: Some("some-string".to_string()),
            name: "some-string".to_string(),
            prompt: "some-string".to_string(),
            type_: "some-string".to_string(),
            country_code: "some-string".to_string(),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get<'a>( &'a self, expand: Option<String>, id: &'a str, ) -> Result<GetShiftInputsResponse, Error>

Retrieve a specific shift input

Retrieve a specific shift input

Parameters:

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

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

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

Delete a shift input

Parameters:

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

async fn example_shift_inputs_delete() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    client
        .shift_inputs()
        .delete("d9797f8d-9ad6-4e08-90d7-2ec17e13471c")
        .await?;
    Ok(())
}

pub async fn update<'a>( &'a self, id: &'a str, body: &ShiftInputRequest, ) -> Result<ShiftInput, Error>

Update a shift input

Updated a specific shift input

Parameters:

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

async fn example_shift_inputs_update() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::ShiftInput = client
        .shift_inputs()
        .update(
            "d9797f8d-9ad6-4e08-90d7-2ec17e13471c",
            &rippling_api::types::ShiftInputRequest {
                creator_id: Some("some-string".to_string()),
                name: "some-string".to_string(),
                prompt: "some-string".to_string(),
                type_: "some-string".to_string(),
                country_code: "some-string".to_string(),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for ShiftInputs

fn clone(&self) -> ShiftInputs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShiftInputs

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

Formats the value using the given formatter.