Struct TimeEntries

pub struct TimeEntries {
    pub client: Client,
}

Fields

client: Client

Implementations

impl TimeEntries

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

List time cards

A List of time cards

• Requires: API Tier 2
• Filterable fields: pay_period.start_date, worker_id
• Expandable fields: worker
• 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_time_entries_list_time_cards_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut time_entries = client.time_entries();
    let mut stream = time_entries.list_time_cards_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 get_time_cards<'a>( &'a self, expand: Option<String>, id: &'a str, ) -> Result<GetTimeCardsResponse, Error>

Retrieve a specific time card

Retrieve a specific time card

Parameters:

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

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

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

List time entries

A List of time entries

• Requires: API Tier 2
• Filterable fields: worker_id, start_time, pay_period.start_date
• Expandable fields: worker, time_card
• 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_time_entries_list_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut time_entries = client.time_entries();
    let mut stream = time_entries.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: &TimeEntryRequest, ) -> Result<TimeEntry, Error>

Create a new time entry

Create a new time entry

async fn example_time_entries_create() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::TimeEntry = client
        .time_entries()
        .create(&rippling_api::types::TimeEntryRequest {
            worker_id: "some-string".to_string(),
            duration: Some(3.14 as f64),
            comments: Some(vec![rippling_api::types::TimeEntryCommentRequest {
                text: Some("some-string".to_string()),
            }]),
            job_shifts: Some(vec![rippling_api::types::JobShiftRequest {
                start_time: Some("some-string".to_string()),
                end_time: Some("some-string".to_string()),
                duration: Some(3.14 as f64),
                start_date: Some("some-string".to_string()),
                original_start_time: Some("some-string".to_string()),
                original_end_time: Some("some-string".to_string()),
                job_codes_id: Some(vec!["some-string".to_string()]),
                is_hours_only_input: Some(true),
            }]),
            breaks: Some(vec![rippling_api::types::BreakRequest {
                start_time: Some("some-string".to_string()),
                end_time: Some("some-string".to_string()),
                break_type_id: Some("some-string".to_string()),
            }]),
            tags: Some(vec!["some-string".to_string()]),
            idempotency_key: Some("some-string".to_string()),
            create_extra_hours_run: Some(true),
            status: Some(rippling_api::types::TimeEntryRequestStatus::Paid),
            pay_period: Some(rippling_api::types::PayPeriodRequest {
                start_date: Some("some-string".to_string()),
                end_date: Some("some-string".to_string()),
                pay_schedule_id: Some("some-string".to_string()),
            }),
            shift_input_values: Some(vec![rippling_api::types::ShiftInputValueRequest {
                shift_input_id: "some-string".to_string(),
                author_id: Some("some-string".to_string()),
            }]),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Retrieve a specific time entry

Retrieve a specific time entry

Parameters:

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

async fn example_time_entries_get() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::GetTimeEntriesResponse = client
        .time_entries()
        .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 time entry

Parameters:

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

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

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

Update a time entry

Updated a specific time entry

Parameters:

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

async fn example_time_entries_update() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::TimeEntry = client
        .time_entries()
        .update(
            "d9797f8d-9ad6-4e08-90d7-2ec17e13471c",
            &rippling_api::types::TimeEntryRequest {
                worker_id: "some-string".to_string(),
                duration: Some(3.14 as f64),
                comments: Some(vec![rippling_api::types::TimeEntryCommentRequest {
                    text: Some("some-string".to_string()),
                }]),
                job_shifts: Some(vec![rippling_api::types::JobShiftRequest {
                    start_time: Some("some-string".to_string()),
                    end_time: Some("some-string".to_string()),
                    duration: Some(3.14 as f64),
                    start_date: Some("some-string".to_string()),
                    original_start_time: Some("some-string".to_string()),
                    original_end_time: Some("some-string".to_string()),
                    job_codes_id: Some(vec!["some-string".to_string()]),
                    is_hours_only_input: Some(true),
                }]),
                breaks: Some(vec![rippling_api::types::BreakRequest {
                    start_time: Some("some-string".to_string()),
                    end_time: Some("some-string".to_string()),
                    break_type_id: Some("some-string".to_string()),
                }]),
                tags: Some(vec!["some-string".to_string()]),
                idempotency_key: Some("some-string".to_string()),
                create_extra_hours_run: Some(true),
                status: Some(rippling_api::types::TimeEntryRequestStatus::Paid),
                pay_period: Some(rippling_api::types::PayPeriodRequest {
                    start_date: Some("some-string".to_string()),
                    end_date: Some("some-string".to_string()),
                    pay_schedule_id: Some("some-string".to_string()),
                }),
                shift_input_values: Some(vec![rippling_api::types::ShiftInputValueRequest {
                    shift_input_id: "some-string".to_string(),
                    author_id: Some("some-string".to_string()),
                }]),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for TimeEntries

fn clone(&self) -> TimeEntries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeEntries

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

Formats the value using the given formatter.