Struct oxide_api::organizations::Organizations

pub struct Organizations {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Organizations

pub async fn get_page(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameOrIdSortMode
) -> Result<Vec<Rack>>

List all organizations.

This function performs a GET to the /organizations endpoint.

Parameters:

• limit: u32 – A count of bytes, typically used either for memory or storage capacity

The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.

• page_token: &str – Token returned by previous call to retreive the subsequent page.
• sort_by: crate::types::NameOrIdSortMode – Supported set of sort modes for scanning by name or id.

pub async fn get_all(&self, sort_by: NameOrIdSortMode) -> Result<Vec<Rack>>

List all organizations.

This function performs a GET to the /organizations endpoint.

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

pub async fn post(&self, body: &RouterCreate) -> Result<Rack>

Create a new organization.

This function performs a POST to the /organizations endpoint.

pub async fn get(&self, organization_name: &str) -> Result<Rack>

Fetch a specific organization.

This function performs a GET to the /organizations/{organization_name} endpoint.

Parameters:

• organization_name: &str – human-readable free-form text about a resource.

pub async fn put(
    &self,
    organization_name: &str,
    body: &OrganizationUpdate
) -> Result<Rack>

Update a specific organization.

This function performs a PUT to the /organizations/{organization_name} endpoint.

Parameters:

• organization_name: &str – human-readable free-form text about a resource.

pub async fn delete(&self, organization_name: &str) -> Result<()>

Delete a specific organization.

This function performs a DELETE to the /organizations/{organization_name} endpoint.

Parameters:

• organization_name: &str – human-readable free-form text about a resource.