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 [`FoldersManager::get`].
#[derive(Clone, Debug, Default)]
pub struct FoldersGetOptions {
    pub fields: Option<Vec<String>>,
    pub if_none_match: Option<String>,
    pub boxapi: Option<String>,
    pub sort: Option<crate::models::schemas::GetIdSort>,
    pub direction: Option<crate::models::schemas::OrderDirection>,
    pub offset: Option<i64>,
    pub limit: Option<i64>,
}

/// Optional parameters for [`FoldersManager::update`].
#[derive(Clone, Debug, Default)]
pub struct FoldersUpdateOptions {
    pub fields: Option<Vec<String>>,
    pub if_match: Option<String>,
}

/// Optional parameters for [`FoldersManager::delete`].
#[derive(Clone, Debug, Default)]
pub struct FoldersDeleteOptions {
    pub if_match: Option<String>,
    pub recursive: Option<bool>,
}

/// Optional parameters for [`FoldersManager::list_items`].
#[derive(Clone, Debug, Default)]
pub struct FoldersListItemsOptions {
    pub fields: Option<Vec<String>>,
    pub usemarker: Option<bool>,
    pub marker: Option<String>,
    pub offset: Option<i64>,
    pub limit: Option<i64>,
    pub boxapi: Option<String>,
    pub sort: Option<crate::models::schemas::GetIdSort>,
    pub direction: Option<crate::models::schemas::OrderDirection>,
}

/// Optional parameters for [`FoldersManager::create`].
#[derive(Clone, Debug, Default)]
pub struct FoldersCreateOptions {
    pub fields: Option<Vec<String>>,
}

/// Optional parameters for [`FoldersManager::copy`].
#[derive(Clone, Debug, Default)]
pub struct FoldersCopyOptions {
    pub fields: Option<Vec<String>>,
}

/// Async paginator over [`FoldersManager::list_items`], yielding one `crate::models::schemas::Item`
/// per item across pages (FR-7.3).
pub struct FoldersListItemsPaginator {
    manager: FoldersManager,
    folder_id: String,
    options: FoldersListItemsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::Item>,
    done: bool,
}

impl FoldersListItemsPaginator {
    /// 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::Item, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_items_page(self.folder_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 "folders" API area.
pub struct FoldersManager {
    session: std::sync::Arc<runtime::Client>,
}

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

    pub async fn get(
        &self,
        folder_id: String,
        opts: Option<FoldersGetOptions>,
    ) -> Result<crate::models::schemas::FolderFull, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/folders");
        url.push('/');
        let seg = path_escape(&folder_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.fields {
            req = runtime::with_query(req, "fields", &value.join(","));
        }
        if let Some(value) = opts.if_none_match {
            req = runtime::with_header(req, "if-none-match", &value);
        }
        if let Some(value) = opts.boxapi {
            req = runtime::with_header(req, "boxapi", &value);
        }
        if let Some(value) = opts.sort {
            req = runtime::with_query(req, "sort", &value.0);
        }
        if let Some(value) = opts.direction {
            req = runtime::with_query(req, "direction", &value.0);
        }
        if let Some(value) = opts.offset {
            req = runtime::with_query(req, "offset", &value.to_string());
        }
        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)?)
    }

    pub async fn update(
        &self,
        folder_id: String,
        body: crate::models::schemas::FolderUpdateRequest,
        opts: Option<FoldersUpdateOptions>,
    ) -> Result<crate::models::schemas::FolderFull, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/folders");
        url.push('/');
        let seg = path_escape(&folder_id);
        url.push_str(&seg);
        let mut req = self.session.new_request("PUT", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.fields {
            req = runtime::with_query(req, "fields", &value.join(","));
        }
        if let Some(value) = opts.if_match {
            req = runtime::with_header(req, "if-match", &value);
        }
        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(
        &self,
        folder_id: String,
        opts: Option<FoldersDeleteOptions>,
    ) -> Result<(), Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/folders");
        url.push('/');
        let seg = path_escape(&folder_id);
        url.push_str(&seg);
        let mut req = self.session.new_request("DELETE", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.if_match {
            req = runtime::with_header(req, "if-match", &value);
        }
        if let Some(value) = opts.recursive {
            req = runtime::with_query(req, "recursive", &value.to_string());
        }
        let _ = self.session.fetch(req).await?;
        Ok(())
    }

    async fn list_items_page(
        &self,
        folder_id: String,
        opts: Option<FoldersListItemsOptions>,
    ) -> Result<crate::models::schemas::Items, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/folders");
        url.push('/');
        let seg = path_escape(&folder_id);
        url.push_str(&seg);
        url.push_str("/items");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.fields {
            req = runtime::with_query(req, "fields", &value.join(","));
        }
        if let Some(value) = opts.usemarker {
            req = runtime::with_query(req, "usemarker", &value.to_string());
        }
        if let Some(value) = opts.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        if let Some(value) = opts.offset {
            req = runtime::with_query(req, "offset", &value.to_string());
        }
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        if let Some(value) = opts.boxapi {
            req = runtime::with_header(req, "boxapi", &value);
        }
        if let Some(value) = opts.sort {
            req = runtime::with_query(req, "sort", &value.0);
        }
        if let Some(value) = opts.direction {
            req = runtime::with_query(req, "direction", &value.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::Item` across pages, threading the cursor.
    pub fn list_items(
        &self,
        folder_id: String,
        opts: Option<FoldersListItemsOptions>,
    ) -> FoldersListItemsPaginator {
        FoldersListItemsPaginator {
            manager: FoldersManager::new(self.session.clone()),
            folder_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn create(
        &self,
        body: crate::models::schemas::FolderCreateRequest,
        opts: Option<FoldersCreateOptions>,
    ) -> Result<crate::models::schemas::FolderFull, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/folders");
        let mut req = self.session.new_request("POST", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.fields {
            req = runtime::with_query(req, "fields", &value.join(","));
        }
        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 copy(
        &self,
        folder_id: String,
        body: crate::models::schemas::FolderCopyRequest,
        opts: Option<FoldersCopyOptions>,
    ) -> Result<crate::models::schemas::FolderFull, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/folders");
        url.push('/');
        let seg = path_escape(&folder_id);
        url.push_str(&seg);
        url.push_str("/copy");
        let mut req = self.session.new_request("POST", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.fields {
            req = runtime::with_query(req, "fields", &value.join(","));
        }
        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)?)
    }
}