Struct TimeOff

pub struct TimeOff {
    pub client: Client,
}

Fields

client: Client

Implementations

impl TimeOff

pub async fn get_index_timeoff<'a>( &'a self, employment_id: Option<String>, order_by: Option<OrderBy>, page: Option<i64>, page_size: Option<i64>, sort_by: Option<SortBy>, status: Option<GetIndexTimeoffStatus>, timeoff_type: Option<TimeoffType>, ) -> Result<ListTimeoffResponse, Error>

List Time Off

Lists all Time Off records.

Parameters:

• employment_id: Option<String>: Only show time off for a specific employment
• order_by: Option<crate::types::OrderBy>: Sort order
• page: Option<i64>: Starts fetching records after the given page
• page_size: Option<i64>: Change the amount of records returned per page, defaults to 20, limited to 100
• sort_by: Option<crate::types::SortBy>: Field to sort by
• status: Option<crate::types::GetIndexTimeoffStatus>: Filter time off by its status
• timeoff_type: Option<crate::types::TimeoffType>: Filter time off by its type

async fn example_time_off_get_index_timeoff() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::ListTimeoffResponse = client
        .time_off()
        .get_index_timeoff(
            Some("some-string".to_string()),
            Some(remote_api::types::OrderBy::Desc),
            Some(4 as i64),
            Some(4 as i64),
            Some(remote_api::types::SortBy::Status),
            Some(remote_api::types::GetIndexTimeoffStatus::CancelRequested),
            Some(remote_api::types::TimeoffType::MilitaryLeave),
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn post_create_timeoff<'a>( &'a self, body: &CreateApprovedTimeoffParams, ) -> Result<TimeoffResponse, Error>

Create Time Off

Creates a Time Off record

async fn example_time_off_post_create_timeoff() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::TimeoffResponse = client
        .time_off()
        .post_create_timeoff(&remote_api::types::CreateApprovedTimeoffParams {
            document: Some(remote_api::types::TimeoffDocumentParams {
                content: "some-string".to_string(),
                name: "some-string".to_string(),
            }),
            employment_id: "some-string".to_string(),
            end_date: chrono::Utc::now().date_naive(),
            notes: Some("some-string".to_string()),
            start_date: chrono::Utc::now().date_naive(),
            timeoff_days: vec![remote_api::types::TimeoffDaysParams {
                day: Some(chrono::Utc::now().date_naive()),
                hours: Some(4 as i64),
            }],
            timeoff_type: remote_api::types::TimeoffType::MilitaryLeave,
            timezone: "some-string".to_string(),
            approved_at: Some(chrono::Utc::now()),
            approver_id: Some("some-string".to_string()),
            status: Some(remote_api::types::CreateApprovedTimeoffParamsStatus::Approved),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get_timeoff_types_timeoff<'a>( &'a self, ) -> Result<ListTimeoffTypesResponse, Error>

List Time Off Types

Lists all time off types that can be used for the timeoff_type parameter

async fn example_time_off_get_timeoff_types_timeoff() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::ListTimeoffTypesResponse =
        client.time_off().get_timeoff_types_timeoff().await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get_show_timeoff<'a>( &'a self, timeoff_id: &'a str, ) -> Result<TimeoffResponse, Error>

Show Time Off

Shows a single Time Off record

Parameters:

• timeoff_id: &'astr: Timeoff ID (required)

async fn example_time_off_get_show_timeoff() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::TimeoffResponse =
        client.time_off().get_show_timeoff("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn patch_update_timeoff_2<'a>( &'a self, body: &UpdateApprovedTimeoffParams, ) -> Result<TimeoffResponse, Error>

Update Time Off

Updates a Time Off record. This endpoint can also be used for cancelling a time off.

async fn example_time_off_patch_update_timeoff_2() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::TimeoffResponse = client
        .time_off()
        .patch_update_timeoff_2(&remote_api::types::UpdateApprovedTimeoffParams {
            approved_at: Some(chrono::Utc::now()),
            approver_id: Some("some-string".to_string()),
            cancel_reason: "some-string".to_string(),
            document: Some(remote_api::types::TimeoffDocumentParams {
                content: "some-string".to_string(),
                name: "some-string".to_string(),
            }),
            edit_reason: "some-string".to_string(),
            end_date: Some(chrono::Utc::now().date_naive()),
            notes: Some("some-string".to_string()),
            start_date: Some(chrono::Utc::now().date_naive()),
            status: Some(remote_api::types::UpdateApprovedTimeoffParamsStatus::Cancelled),
            timeoff_days: Some(vec![remote_api::types::TimeoffDaysParams {
                day: Some(chrono::Utc::now().date_naive()),
                hours: Some(4 as i64),
            }]),
            timeoff_type: Some(remote_api::types::TimeoffType::MilitaryLeave),
            timezone: Some("some-string".to_string()),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn patch_update_timeoff<'a>( &'a self, body: &UpdateApprovedTimeoffParams, ) -> Result<TimeoffResponse, Error>

Update Time Off

Updates a Time Off record. This endpoint can also be used for cancelling a time off.

async fn example_time_off_patch_update_timeoff() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::TimeoffResponse = client
        .time_off()
        .patch_update_timeoff(&remote_api::types::UpdateApprovedTimeoffParams {
            approved_at: Some(chrono::Utc::now()),
            approver_id: Some("some-string".to_string()),
            cancel_reason: "some-string".to_string(),
            document: Some(remote_api::types::TimeoffDocumentParams {
                content: "some-string".to_string(),
                name: "some-string".to_string(),
            }),
            edit_reason: "some-string".to_string(),
            end_date: Some(chrono::Utc::now().date_naive()),
            notes: Some("some-string".to_string()),
            start_date: Some(chrono::Utc::now().date_naive()),
            status: Some(remote_api::types::UpdateApprovedTimeoffParamsStatus::Cancelled),
            timeoff_days: Some(vec![remote_api::types::TimeoffDaysParams {
                day: Some(chrono::Utc::now().date_naive()),
                hours: Some(4 as i64),
            }]),
            timeoff_type: Some(remote_api::types::TimeoffType::MilitaryLeave),
            timezone: Some("some-string".to_string()),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for TimeOff

fn clone(&self) -> TimeOff

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeOff

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

Formats the value using the given formatter.