Struct gusto_api::jobs::Jobs

pub struct Jobs { /* fields omitted */ }

Implementations

impl Jobs

pub async fn get_job(&self, job_id: &str) -> Result<Job>

Get a job.

This function performs a GET to the /v1/jobs/{job_id} endpoint.

Get a job.

pub async fn put_job(&self, job_id: &str, body: &PutJobRequest) -> Result<Job>

Update a job.

This function performs a PUT to the /v1/jobs/{job_id} endpoint.

Update a job.

pub async fn delete_job(&self, job_id: &str) -> Result<()>

Delete an individual job.

This function performs a DELETE to the /v1/jobs/{job_id} endpoint.

Deletes a specific job that an employee holds.

pub async fn get_employee_jobs(&self, employee_id: &str) -> Result<Vec<Job>>

Get jobs for an employee.

This function performs a GET to the /v1/employees/{employee_id}/jobs endpoint.

Get all of the jobs that an employee holds.

pub async fn get_all_employee_jobs(&self, employee_id: &str) -> Result<Vec<Job>>

Get jobs for an employee.

This function performs a GET to the /v1/employees/{employee_id}/jobs endpoint.

As opposed to get_employee_jobs, this function returns all the pages of the request at once.

Get all of the jobs that an employee holds.

pub async fn post_job(
    &self,
    employee_id: &str,
    body: &PostJobRequest
) -> Result<Job>

Create a job.

This function performs a POST to the /v1/employees/{employee_id}/jobs endpoint.

Create a job.

pub async fn post_job_compensation(
    &self,
    job_id: &str,
    body: &PostJobCompensationRequest
) -> Result<Compensation>

Create a compensation.

This function performs a POST to the /v1/jobs/{job_id}/compensations endpoint.

Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent effective_date.

Note: Currently, jobs are arbitrarily limited to a single compensation as multiple compensations per job are not yet available in Gusto. The API is architected as if multiple compensations may exist, so integrations should integrate under the same assumption. The only exception is that creating a compensation with the same job_id as another will fail with a relevant error