box-open-sdk 0.1.1

Generated Box API SDK for Rust (community, unofficial).
Documentation
// Code generated by box-gantry. DO NOT EDIT.

use crate::internal::path_escape;
use crate::runtime::{self, Error};

/// Optional parameters for [`MetadataTemplatesManager::list`].
#[derive(Clone, Debug, Default)]
pub struct MetadataTemplatesListOptions {
    pub marker: Option<String>,
    pub limit: Option<i64>,
}

/// Optional parameters for [`MetadataTemplatesManager::list_global`].
#[derive(Clone, Debug, Default)]
pub struct MetadataTemplatesListGlobalOptions {
    pub marker: Option<String>,
    pub limit: Option<i64>,
}

/// Optional parameters for [`MetadataTemplatesManager::list_enterprise`].
#[derive(Clone, Debug, Default)]
pub struct MetadataTemplatesListEnterpriseOptions {
    pub marker: Option<String>,
    pub limit: Option<i64>,
}

/// Async paginator over [`MetadataTemplatesManager::list`], yielding one `crate::models::schemas::MetadataTemplate`
/// per item across pages (FR-7.3).
pub struct MetadataTemplatesListPaginator {
    manager: MetadataTemplatesManager,
    metadata_instance_id: String,
    options: MetadataTemplatesListOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::MetadataTemplate>,
    done: bool,
}

impl MetadataTemplatesListPaginator {
    /// The next item, advancing pages as needed; `None` at the end.
    /// An error is yielded once, then iteration stops.
    pub async fn next(
        &mut self,
    ) -> Option<Result<crate::models::schemas::MetadataTemplate, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_page(
                    self.metadata_instance_id.clone(),
                    Some(self.options.clone()),
                )
                .await
            {
                Ok(page) => page,
                Err(err) => {
                    self.done = true;
                    return Some(Err(err));
                }
            };
            self.buffer = page.entries.unwrap_or_default().into_iter();
            match page.next_marker.flatten() {
                Some(cursor) if !cursor.is_empty() => self.options.marker = Some(cursor),
                _ => self.done = true,
            }
        }
    }
}

/// Async paginator over [`MetadataTemplatesManager::list_global`], yielding one `crate::models::schemas::MetadataTemplate`
/// per item across pages (FR-7.3).
pub struct MetadataTemplatesListGlobalPaginator {
    manager: MetadataTemplatesManager,
    options: MetadataTemplatesListGlobalOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::MetadataTemplate>,
    done: bool,
}

impl MetadataTemplatesListGlobalPaginator {
    /// The next item, advancing pages as needed; `None` at the end.
    /// An error is yielded once, then iteration stops.
    pub async fn next(
        &mut self,
    ) -> Option<Result<crate::models::schemas::MetadataTemplate, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_global_page(Some(self.options.clone()))
                .await
            {
                Ok(page) => page,
                Err(err) => {
                    self.done = true;
                    return Some(Err(err));
                }
            };
            self.buffer = page.entries.unwrap_or_default().into_iter();
            match page.next_marker.flatten() {
                Some(cursor) if !cursor.is_empty() => self.options.marker = Some(cursor),
                _ => self.done = true,
            }
        }
    }
}

/// Async paginator over [`MetadataTemplatesManager::list_enterprise`], yielding one `crate::models::schemas::MetadataTemplate`
/// per item across pages (FR-7.3).
pub struct MetadataTemplatesListEnterprisePaginator {
    manager: MetadataTemplatesManager,
    options: MetadataTemplatesListEnterpriseOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::MetadataTemplate>,
    done: bool,
}

impl MetadataTemplatesListEnterprisePaginator {
    /// The next item, advancing pages as needed; `None` at the end.
    /// An error is yielded once, then iteration stops.
    pub async fn next(
        &mut self,
    ) -> Option<Result<crate::models::schemas::MetadataTemplate, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_enterprise_page(Some(self.options.clone()))
                .await
            {
                Ok(page) => page,
                Err(err) => {
                    self.done = true;
                    return Some(Err(err));
                }
            };
            self.buffer = page.entries.unwrap_or_default().into_iter();
            match page.next_marker.flatten() {
                Some(cursor) if !cursor.is_empty() => self.options.marker = Some(cursor),
                _ => self.done = true,
            }
        }
    }
}

/// Operations for the "metadata_templates" API area.
pub struct MetadataTemplatesManager {
    session: std::sync::Arc<runtime::Client>,
}

impl MetadataTemplatesManager {
    pub(crate) fn new(session: std::sync::Arc<runtime::Client>) -> Self {
        Self { session }
    }

    async fn list_page(
        &self,
        metadata_instance_id: String,
        opts: Option<MetadataTemplatesListOptions>,
    ) -> Result<crate::models::schemas::MetadataTemplates, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        let mut req = self.session.new_request("GET", &url);
        req = runtime::with_query(req, "metadata_instance_id", &metadata_instance_id);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::MetadataTemplate` across pages, threading the cursor.
    pub fn list(
        &self,
        metadata_instance_id: String,
        opts: Option<MetadataTemplatesListOptions>,
    ) -> MetadataTemplatesListPaginator {
        MetadataTemplatesListPaginator {
            manager: MetadataTemplatesManager::new(self.session.clone()),
            metadata_instance_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn get_schema(
        &self,
        scope: crate::models::schemas::GetFileIdMetadataIdIdScope,
        template_key: String,
    ) -> Result<crate::models::schemas::MetadataTemplate, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        url.push('/');
        let seg = path_escape(&scope.0);
        url.push_str(&seg);
        url.push('/');
        let seg = path_escape(&template_key);
        url.push_str(&seg);
        url.push_str("/schema");
        let req = self.session.new_request("GET", &url);
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    pub async fn update_schema(
        &self,
        scope: crate::models::schemas::GetFileIdMetadataIdIdScope,
        template_key: String,
        body: Vec<crate::models::schemas::SchemaUpdateRequest>,
    ) -> Result<crate::models::schemas::MetadataTemplate, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        url.push('/');
        let seg = path_escape(&scope.0);
        url.push_str(&seg);
        url.push('/');
        let seg = path_escape(&template_key);
        url.push_str(&seg);
        url.push_str("/schema");
        let mut req = self.session.new_request("PUT", &url);
        let payload = serde_json::to_vec(&body)?;
        req = runtime::with_json_body(req, &payload);
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    pub async fn delete_schema(
        &self,
        scope: crate::models::schemas::GetFileIdMetadataIdIdScope,
        template_key: String,
    ) -> Result<(), Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        url.push('/');
        let seg = path_escape(&scope.0);
        url.push_str(&seg);
        url.push('/');
        let seg = path_escape(&template_key);
        url.push_str(&seg);
        url.push_str("/schema");
        let req = self.session.new_request("DELETE", &url);
        let _ = self.session.fetch(req).await?;
        Ok(())
    }

    pub async fn get(
        &self,
        template_id: String,
    ) -> Result<crate::models::schemas::MetadataTemplate, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        url.push('/');
        let seg = path_escape(&template_id);
        url.push_str(&seg);
        let req = self.session.new_request("GET", &url);
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    async fn list_global_page(
        &self,
        opts: Option<MetadataTemplatesListGlobalOptions>,
    ) -> Result<crate::models::schemas::MetadataTemplates, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        url.push_str("/global");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::MetadataTemplate` across pages, threading the cursor.
    pub fn list_global(
        &self,
        opts: Option<MetadataTemplatesListGlobalOptions>,
    ) -> MetadataTemplatesListGlobalPaginator {
        MetadataTemplatesListGlobalPaginator {
            manager: MetadataTemplatesManager::new(self.session.clone()),
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    async fn list_enterprise_page(
        &self,
        opts: Option<MetadataTemplatesListEnterpriseOptions>,
    ) -> Result<crate::models::schemas::MetadataTemplates, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        url.push_str("/enterprise");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::MetadataTemplate` across pages, threading the cursor.
    pub fn list_enterprise(
        &self,
        opts: Option<MetadataTemplatesListEnterpriseOptions>,
    ) -> MetadataTemplatesListEnterprisePaginator {
        MetadataTemplatesListEnterprisePaginator {
            manager: MetadataTemplatesManager::new(self.session.clone()),
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn create_schema(
        &self,
        body: crate::models::schemas::SchemaCreateRequest,
    ) -> Result<crate::models::schemas::MetadataTemplate, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/metadata_templates");
        url.push_str("/schema");
        let mut req = self.session.new_request("POST", &url);
        let payload = serde_json::to_vec(&body)?;
        req = runtime::with_json_body(req, &payload);
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }
}