Struct ramp_api::locations::Locations

pub struct Locations {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Locations

pub async fn get_page(
    &self,
    start: &str,
    page_size: f64
) -> Result<Vec<Location>>

List locations.

This function performs a GET to the /locations endpoint.

Retrieves all locations for your business.

Parameters:

• authorization: &str – The OAuth2 token header.
• start: &str – The ID of the last entity of the previous page, used for pagination to get the next page.
• page_size: f64 – The number of results to be returned in each page. The value must be between 2 and 10,000. If not specified, the default will be 1,000.

pub async fn get_all(&self) -> Result<Vec<Location>>

List locations.

This function performs a GET to the /locations endpoint.

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

Retrieves all locations for your business.

pub async fn post(&self, body: &PostLocationRequest) -> Result<Location>

Create new location.

This function performs a POST to the /locations endpoint.

Creates a new location for the business.

Parameters:

• authorization: &str – The OAuth2 token header.

pub async fn get(&self, id: &str) -> Result<Location>

GET a location.

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

Retrieve a specific location.

Parameters:

• authorization: &str – The OAuth2 token header.

pub async fn patch(
    &self,
    id: &str,
    body: &PostLocationRequest
) -> Result<Location>

Update location.

This function performs a PATCH to the /locations/{id} endpoint.

Modifies a specific location.