Struct gusto_api::locations::Locations

pub struct Locations { /* fields omitted */ }

Implementations

impl Locations

pub async fn get_company_locations(
    &self,
    company_id_or_uuid: &str
) -> Result<Vec<Location>>

Get company locations.

This function performs a GET to the /v1/companies/{company_id_or_uuid}/locations endpoint.

Company locations represent all addresses associated with a company. These can be filing addesses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.

Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.

pub async fn get_all_company_locations(
    &self,
    company_id_or_uuid: &str
) -> Result<Vec<Location>>

Get company locations.

This function performs a GET to the /v1/companies/{company_id_or_uuid}/locations endpoint.

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

Company locations represent all addresses associated with a company. These can be filing addesses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.

Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.

pub async fn post_company_location(
    &self,
    company_id_or_uuid: &str,
    body: &PostCompanyLocationRequest
) -> Result<Location>

Create a company location.

This function performs a POST to the /v1/companies/{company_id_or_uuid}/locations endpoint.

Company locations represent all addresses associated with a company. These can be filing addesses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.

Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.

pub async fn get_location(&self, location_id: &str) -> Result<Location>

Get a location.

This function performs a GET to the /v1/locations/{location_id} endpoint.

Get a location.

pub async fn put_location(
    &self,
    location_id: &str,
    body: &PutLocationRequest
) -> Result<Location>

Update a location.

This function performs a PUT to the /v1/locations/{location_id} endpoint.

Update a location.