Struct ramp_api::departments::Departments

pub struct Departments {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Departments

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

List departments.

This function performs a GET to the /departments endpoint.

Retrieve all departments.

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<Department>>

List departments.

This function performs a GET to the /departments endpoint.

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

Retrieve all departments.

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

Create department.

This function performs a POST to the /departments endpoint.

Create a new department.

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

GET a department.

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

Retrieve a single department.

Parameters:

• authorization: &str – The OAuth2 token header.

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

Update department.

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

Modify a department.