oxide_api/

organizations.rs

use anyhow::Result;

use crate::Client;

pub struct Organizations {
    pub client: Client,
}

impl Organizations {
    #[doc(hidden)]
    pub fn new(client: Client) -> Self {
        Organizations { client }
    }

    /**
     * Fetch an organization by id.
     *
     * This function performs a `GET` to the `/by-id/organizations/{id}` endpoint.
     *
     * **Parameters:**
     *
     * * `id: &str`
     */
    pub async fn view(&self, id: &str) -> Result<crate::types::Organization> {
        let url = format!(
            "/by-id/organizations/{}",
            crate::progenitor_support::encode_path(id),
        );

        self.client.get(&url, None).await
    }

    /**
     * List organizations.
     *
     * This function performs a `GET` to the `/organizations` endpoint.
     *
     * **Parameters:**
     *
     * * `limit: u32` -- Maximum number of items returned by a single call.
     * * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.
     * * `sort_by: crate::types::NameOrIdSortMode` -- Supported set of sort modes for scanning by name or id.
     */
    pub async fn get_page(
        &self,
        limit: u32,
        page_token: &str,
        sort_by: crate::types::NameOrIdSortMode,
    ) -> Result<Vec<crate::types::Organization>> {
        let mut query_args: Vec<(String, String)> = Default::default();
        if !limit.to_string().is_empty() {
            query_args.push(("limit".to_string(), limit.to_string()));
        }
        if !page_token.is_empty() {
            query_args.push(("page_token".to_string(), page_token.to_string()));
        }
        if !sort_by.to_string().is_empty() {
            query_args.push(("sort_by".to_string(), sort_by.to_string()));
        }
        let query_ = serde_urlencoded::to_string(&query_args).unwrap();
        let url = format!("/organizations?{}", query_);

        let resp: crate::types::OrganizationResultsPage = self.client.get(&url, None).await?;

        // Return our response data.
        Ok(resp.items)
    }

    /**
     * List 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 get_all(
        &self,
        sort_by: crate::types::NameOrIdSortMode,
    ) -> Result<Vec<crate::types::Organization>> {
        let mut query_args: Vec<(String, String)> = Default::default();
        if !sort_by.to_string().is_empty() {
            query_args.push(("sort_by".to_string(), sort_by.to_string()));
        }
        let query_ = serde_urlencoded::to_string(&query_args).unwrap();
        let url = format!("/organizations?{}", query_);

        let mut resp: crate::types::OrganizationResultsPage = self.client.get(&url, None).await?;

        let mut items = resp.items;
        let mut page = resp.next_page;

        // Paginate if we should.
        while !page.is_empty() {
            if !url.contains('?') {
                resp = self
                    .client
                    .get(&format!("{}?page={}", url, page), None)
                    .await?;
            } else {
                resp = self
                    .client
                    .get(&format!("{}&page={}", url, page), None)
                    .await?;
            }

            items.append(&mut resp.items);

            if !resp.next_page.is_empty() && resp.next_page != page {
                page = resp.next_page.to_string();
            } else {
                page = "".to_string();
            }
        }

        // Return our response data.
        Ok(items)
    }

    /**
     * Create an organization.
     *
     * This function performs a `POST` to the `/organizations` endpoint.
     */
    pub async fn post(
        &self,
        body: &crate::types::OrganizationCreate,
    ) -> Result<crate::types::Organization> {
        let url = "/organizations".to_string();
        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * Fetch an organization.
     *
     * This function performs a `GET` to the `/organizations/{organization_name}` endpoint.
     *
     * **Parameters:**
     *
     * * `organization_name: &str` -- Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID though they may contain a UUID.
     */
    pub async fn get(&self, organization_name: &str) -> Result<crate::types::Organization> {
        let url = format!(
            "/organizations/{}",
            crate::progenitor_support::encode_path(organization_name),
        );

        self.client.get(&url, None).await
    }

    /**
     * Update an organization.
     *
     * This function performs a `PUT` to the `/organizations/{organization_name}` endpoint.
     *
     * **Parameters:**
     *
     * * `organization_name: &str` -- Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID though they may contain a UUID.
     */
    pub async fn put(
        &self,
        organization_name: &str,
        body: &crate::types::OrganizationUpdate,
    ) -> Result<crate::types::Organization> {
        let url = format!(
            "/organizations/{}",
            crate::progenitor_support::encode_path(organization_name),
        );

        self.client
            .put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * Delete an organization.
     *
     * This function performs a `DELETE` to the `/organizations/{organization_name}` endpoint.
     *
     * **Parameters:**
     *
     * * `organization_name: &str` -- Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID though they may contain a UUID.
     */
    pub async fn delete(&self, organization_name: &str) -> Result<()> {
        let url = format!(
            "/organizations/{}",
            crate::progenitor_support::encode_path(organization_name),
        );

        self.client.delete(&url, None).await
    }

    /**
     * Fetch an organization's IAM policy.
     *
     * This function performs a `GET` to the `/organizations/{organization_name}/policy` endpoint.
     *
     * **Parameters:**
     *
     * * `organization_name: &str` -- Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID though they may contain a UUID.
     */
    pub async fn get_policy(
        &self,
        organization_name: &str,
    ) -> Result<crate::types::OrganizationRolePolicy> {
        let url = format!(
            "/organizations/{}/policy",
            crate::progenitor_support::encode_path(organization_name),
        );

        self.client.get(&url, None).await
    }

    /**
     * Update an organization's IAM policy.
     *
     * This function performs a `PUT` to the `/organizations/{organization_name}/policy` endpoint.
     *
     * **Parameters:**
     *
     * * `organization_name: &str` -- Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID though they may contain a UUID.
     */
    pub async fn put_policy(
        &self,
        organization_name: &str,
        body: &crate::types::OrganizationRolePolicy,
    ) -> Result<crate::types::OrganizationRolePolicy> {
        let url = format!(
            "/organizations/{}/policy",
            crate::progenitor_support::encode_path(organization_name),
        );

        self.client
            .put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }
}