box-open-sdk 0.2.0

Community, unofficial Box API client for Rust — typed models, async managers, and a reqwest runtime with retry, backoff, and token refresh.
Documentation
// Code generated by box-gantry. DO NOT EDIT.

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

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

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

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

/// Async paginator over [`DocgenTemplateManager::list_docgen_templates`], yielding one `crate::models::schemas::DocGenTemplate`
/// per item across pages (FR-7.3).
pub struct DocgenTemplateListDocgenTemplatesPaginator {
    manager: DocgenTemplateManager,
    options: DocgenTemplateListDocgenTemplatesOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::DocGenTemplate>,
    done: bool,
}

impl DocgenTemplateListDocgenTemplatesPaginator {
    /// 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::DocGenTemplate, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_docgen_templates_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 [`DocgenTemplateManager::list_docgen_template_tags`], yielding one `crate::models::schemas::DocGenTag`
/// per item across pages (FR-7.3).
pub struct DocgenTemplateListDocgenTemplateTagsPaginator {
    manager: DocgenTemplateManager,
    template_id: String,
    options: DocgenTemplateListDocgenTemplateTagsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::DocGenTag>,
    done: bool,
}

impl DocgenTemplateListDocgenTemplateTagsPaginator {
    /// 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::DocGenTag, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_docgen_template_tags_page(
                    self.template_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 [`DocgenTemplateManager::list_job`], yielding one `crate::models::schemas::DocGenJob`
/// per item across pages (FR-7.3).
pub struct DocgenTemplateListJobPaginator {
    manager: DocgenTemplateManager,
    template_id: String,
    options: DocgenTemplateListJobOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::DocGenJob>,
    done: bool,
}

impl DocgenTemplateListJobPaginator {
    /// 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::DocGenJob, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_job_page(self.template_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,
            }
        }
    }
}

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

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

    async fn list_docgen_templates_page(
        &self,
        opts: Option<DocgenTemplateListDocgenTemplatesOptions>,
    ) -> Result<crate::models::schemas::DocGenTemplates, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/docgen_templates");
        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());
        }
        req = runtime::with_header(req, "box-version", "2025.0");
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::DocGenTemplate` across pages, threading the cursor.
    pub fn list_docgen_templates(
        &self,
        opts: Option<DocgenTemplateListDocgenTemplatesOptions>,
    ) -> DocgenTemplateListDocgenTemplatesPaginator {
        DocgenTemplateListDocgenTemplatesPaginator {
            manager: DocgenTemplateManager::new(self.session.clone()),
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn create_docgen_templates(
        &self,
        body: crate::models::schemas::DocGenTemplateCreateRequest,
    ) -> Result<crate::models::schemas::DocGenTemplateBase, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/docgen_templates");
        let mut req = self.session.new_request("POST", &url);
        req = runtime::with_header(req, "box-version", "2025.0");
        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 get_docgen_template(
        &self,
        template_id: String,
    ) -> Result<crate::models::schemas::DocGenTemplate, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/docgen_templates");
        url.push('/');
        let seg = path_escape(&template_id);
        url.push_str(&seg);
        let mut req = self.session.new_request("GET", &url);
        req = runtime::with_header(req, "box-version", "2025.0");
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    pub async fn delete_docgen_template(&self, template_id: String) -> Result<(), Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/docgen_templates");
        url.push('/');
        let seg = path_escape(&template_id);
        url.push_str(&seg);
        let mut req = self.session.new_request("DELETE", &url);
        req = runtime::with_header(req, "box-version", "2025.0");
        let _ = self.session.fetch(req).await?;
        Ok(())
    }

    async fn list_docgen_template_tags_page(
        &self,
        template_id: String,
        opts: Option<DocgenTemplateListDocgenTemplateTagsOptions>,
    ) -> Result<crate::models::schemas::DocGenTags, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/docgen_templates");
        url.push('/');
        let seg = path_escape(&template_id);
        url.push_str(&seg);
        url.push_str("/tags");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.template_version_id {
            req = runtime::with_query(req, "template_version_id", &value);
        }
        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());
        }
        req = runtime::with_header(req, "box-version", "2025.0");
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::DocGenTag` across pages, threading the cursor.
    pub fn list_docgen_template_tags(
        &self,
        template_id: String,
        opts: Option<DocgenTemplateListDocgenTemplateTagsOptions>,
    ) -> DocgenTemplateListDocgenTemplateTagsPaginator {
        DocgenTemplateListDocgenTemplateTagsPaginator {
            manager: DocgenTemplateManager::new(self.session.clone()),
            template_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    async fn list_job_page(
        &self,
        template_id: String,
        opts: Option<DocgenTemplateListJobOptions>,
    ) -> Result<crate::models::schemas::DocGenJobs, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/docgen_template_jobs");
        url.push('/');
        let seg = path_escape(&template_id);
        url.push_str(&seg);
        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());
        }
        req = runtime::with_header(req, "box-version", "2025.0");
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::DocGenJob` across pages, threading the cursor.
    pub fn list_job(
        &self,
        template_id: String,
        opts: Option<DocgenTemplateListJobOptions>,
    ) -> DocgenTemplateListJobPaginator {
        DocgenTemplateListJobPaginator {
            manager: DocgenTemplateManager::new(self.session.clone()),
            template_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }
}