Struct Job

pub struct Job {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Job

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

List job codes

A List of job codes

• Requires: API Tier 2
• Filterable fields: job_dimension_id, group_id
• Expandable fields: job_dimension
• 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_job_list_codes_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut job = client.job();
    let mut stream = job.list_codes_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_codes<'a>( &'a self, body: &JobCodeRequest, ) -> Result<JobCode, Error>

Create a new job code

Create a new job code

async fn example_job_create_codes() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::JobCode = client
        .job()
        .create_codes(&rippling_api::types::JobCodeRequest {
            name: "some-string".to_string(),
            job_dimension_id: "some-string".to_string(),
            external_id: Some("some-string".to_string()),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Retrieve a specific job code

Retrieve a specific job code

Parameters:

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

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

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

Delete a job code

Parameters:

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

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

pub async fn update_codes<'a>( &'a self, id: &'a str, body: &JobCodeRequest, ) -> Result<JobCode, Error>

Update a job code

Updated a specific job code

Parameters:

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

async fn example_job_update_codes() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::JobCode = client
        .job()
        .update_codes(
            "d9797f8d-9ad6-4e08-90d7-2ec17e13471c",
            &rippling_api::types::JobCodeRequest {
                name: "some-string".to_string(),
                job_dimension_id: "some-string".to_string(),
                external_id: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

List job dimensions

A List of job dimensions

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

Parameters:

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

use futures_util::TryStreamExt;
async fn example_job_list_dimensions_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut job = client.job();
    let mut stream = job.list_dimensions_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 create_dimensions<'a>( &'a self, body: &JobDimensionRequest, ) -> Result<JobDimension, Error>

Create a new job dimension

Create a new job dimension

async fn example_job_create_dimensions() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::JobDimension = client
        .job()
        .create_dimensions(&rippling_api::types::JobDimensionRequest {
            name: "some-string".to_string(),
            external_id: Some("some-string".to_string()),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Retrieve a specific job dimension

Retrieve a specific job dimension

Parameters:

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

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

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

Delete a job dimension

Parameters:

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

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

pub async fn update_dimensions<'a>( &'a self, id: &'a str, body: &JobDimensionRequest, ) -> Result<JobDimension, Error>

Update a job dimension

Updated a specific job dimension

Parameters:

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

async fn example_job_update_dimensions() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::JobDimension = client
        .job()
        .update_dimensions(
            "d9797f8d-9ad6-4e08-90d7-2ec17e13471c",
            &rippling_api::types::JobDimensionRequest {
                name: "some-string".to_string(),
                external_id: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Job

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

Formats the value using the given formatter.