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: NameSortMode
) -> Result<Vec<User>>

• This function performs a GET to the /organizations endpoint.
• List all organizations.
• 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 – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortMode – Supported set of sort modes for scanning by name or id.

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

• This function performs a GET to the /organizations endpoint.
• As opposed to get, this function returns all the pages of the request at once.
• List all organizations.

pub async fn post(&self, body: &ProjectCreate) -> Result<User>

• This function performs a POST to the /organizations endpoint.
• Create a new organization.

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

• This function performs a GET to the /organizations/{organization_name} endpoint.
• Fetch a specific organization
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.

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

• This function performs a PUT to the /organizations/{organization_name} endpoint.
• Update a specific organization.
• • TODO-correctness: Is it valid for PUT to accept application/json that’s a subset of what the resource actually represents? If not, is that a problem? (HTTP may require that this be idempotent.) If so, can we get around that having this be a slightly different content-type (e.g., “application/json-patch”)? We should see what other APIs do.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.

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

• This function performs a DELETE to the /organizations/{organization_name} endpoint.
• Delete a specific organization.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.

pub async fn projects_put_project(
    &self,
    organization_name: &str,
    project_name: &str,
    body: &ProjectUpdate
) -> Result<Project>

• This function performs a PUT to the /organizations/{organization_name}/projects/{project_name} endpoint.
• Update a specific project.
• • TODO-correctness: Is it valid for PUT to accept application/json that’s a subset of what the resource actually represents? If not, is that a problem? (HTTP may require that this be idempotent.) If so, can we get around that having this be a slightly different content-type (e.g., “application/json-patch”)? We should see what other APIs do.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.