box-open-sdk 0.3.1

Box API client for Rust (open source, community, punk rock) — 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 [`ListCollaborationsManager::list_file_collaborations`].
#[derive(Clone, Debug, Default)]
pub struct ListCollaborationsListFileCollaborationsOptions {
    pub fields: Option<Vec<String>>,
    pub limit: Option<i64>,
    pub marker: Option<String>,
}

/// Optional parameters for [`ListCollaborationsManager::list_folder_collaborations`].
#[derive(Clone, Debug, Default)]
pub struct ListCollaborationsListFolderCollaborationsOptions {
    pub fields: Option<Vec<String>>,
    pub limit: Option<i64>,
    pub marker: Option<String>,
}

/// Optional parameters for [`ListCollaborationsManager::list_collaborations`].
#[derive(Clone, Debug, Default)]
pub struct ListCollaborationsListCollaborationsOptions {
    pub fields: Option<Vec<String>>,
    pub offset: Option<i64>,
    pub limit: Option<i64>,
}

/// Optional parameters for [`ListCollaborationsManager::list_group_collaborations`].
#[derive(Clone, Debug, Default)]
pub struct ListCollaborationsListGroupCollaborationsOptions {
    pub limit: Option<i64>,
    pub offset: Option<i64>,
}

/// Async paginator over [`ListCollaborationsManager::list_file_collaborations`], yielding one `crate::models::schemas::Collaboration`
/// per item across pages (FR-7.3).
pub struct ListCollaborationsListFileCollaborationsPaginator {
    manager: ListCollaborationsManager,
    file_id: String,
    options: ListCollaborationsListFileCollaborationsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::Collaboration>,
    done: bool,
}

impl ListCollaborationsListFileCollaborationsPaginator {
    /// 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::Collaboration, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_file_collaborations_page(self.file_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 [`ListCollaborationsManager::list_folder_collaborations`], yielding one `crate::models::schemas::Collaboration`
/// per item across pages (FR-7.3).
pub struct ListCollaborationsListFolderCollaborationsPaginator {
    manager: ListCollaborationsManager,
    folder_id: String,
    options: ListCollaborationsListFolderCollaborationsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::Collaboration>,
    done: bool,
}

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

/// Async paginator over [`ListCollaborationsManager::list_collaborations`], yielding one `crate::models::schemas::Collaboration`
/// per item across pages (FR-7.3).
pub struct ListCollaborationsListCollaborationsPaginator {
    manager: ListCollaborationsManager,
    status: crate::models::schemas::GetCollaborationsStatus,
    options: ListCollaborationsListCollaborationsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::Collaboration>,
    done: bool,
}

impl ListCollaborationsListCollaborationsPaginator {
    /// 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::Collaboration, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_collaborations_page(self.status.clone(), Some(self.options.clone()))
                .await
            {
                Ok(page) => page,
                Err(err) => {
                    self.done = true;
                    return Some(Err(err));
                }
            };
            let items = page.entries.unwrap_or_default();
            if items.is_empty() {
                self.done = true;
            } else {
                let next = self.options.offset.unwrap_or(0) + items.len() as i64;
                self.options.offset = Some(next);
            }
            self.buffer = items.into_iter();
        }
    }
}

/// Async paginator over [`ListCollaborationsManager::list_group_collaborations`], yielding one `crate::models::schemas::Collaboration`
/// per item across pages (FR-7.3).
pub struct ListCollaborationsListGroupCollaborationsPaginator {
    manager: ListCollaborationsManager,
    group_id: String,
    options: ListCollaborationsListGroupCollaborationsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::Collaboration>,
    done: bool,
}

impl ListCollaborationsListGroupCollaborationsPaginator {
    /// 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::Collaboration, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_group_collaborations_page(self.group_id.clone(), Some(self.options.clone()))
                .await
            {
                Ok(page) => page,
                Err(err) => {
                    self.done = true;
                    return Some(Err(err));
                }
            };
            let items = page.entries.unwrap_or_default();
            if items.is_empty() {
                self.done = true;
            } else {
                let next = self.options.offset.unwrap_or(0) + items.len() as i64;
                self.options.offset = Some(next);
            }
            self.buffer = items.into_iter();
        }
    }
}

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

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

    async fn list_file_collaborations_page(
        &self,
        file_id: String,
        opts: Option<ListCollaborationsListFileCollaborationsOptions>,
    ) -> Result<crate::models::schemas::Collaborations, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/files");
        url.push('/');
        let seg = path_escape(&file_id);
        url.push_str(&seg);
        url.push_str("/collaborations");
        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.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        if let Some(value) = opts.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::Collaboration` across pages, threading the cursor.
    pub fn list_file_collaborations(
        &self,
        file_id: String,
        opts: Option<ListCollaborationsListFileCollaborationsOptions>,
    ) -> ListCollaborationsListFileCollaborationsPaginator {
        ListCollaborationsListFileCollaborationsPaginator {
            manager: ListCollaborationsManager::new(self.session.clone()),
            file_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    async fn list_folder_collaborations_page(
        &self,
        folder_id: String,
        opts: Option<ListCollaborationsListFolderCollaborationsOptions>,
    ) -> Result<crate::models::schemas::Collaborations, 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("/collaborations");
        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.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        if let Some(value) = opts.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::Collaboration` across pages, threading the cursor.
    pub fn list_folder_collaborations(
        &self,
        folder_id: String,
        opts: Option<ListCollaborationsListFolderCollaborationsOptions>,
    ) -> ListCollaborationsListFolderCollaborationsPaginator {
        ListCollaborationsListFolderCollaborationsPaginator {
            manager: ListCollaborationsManager::new(self.session.clone()),
            folder_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    async fn list_collaborations_page(
        &self,
        status: crate::models::schemas::GetCollaborationsStatus,
        opts: Option<ListCollaborationsListCollaborationsOptions>,
    ) -> Result<crate::models::schemas::CollaborationsOffsetPaginated, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/collaborations");
        let mut req = self.session.new_request("GET", &url);
        req = runtime::with_query(req, "status", &status.0);
        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.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)?)
    }

    /// Iterate every `crate::models::schemas::Collaboration` across pages, threading the cursor.
    pub fn list_collaborations(
        &self,
        status: crate::models::schemas::GetCollaborationsStatus,
        opts: Option<ListCollaborationsListCollaborationsOptions>,
    ) -> ListCollaborationsListCollaborationsPaginator {
        ListCollaborationsListCollaborationsPaginator {
            manager: ListCollaborationsManager::new(self.session.clone()),
            status,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    async fn list_group_collaborations_page(
        &self,
        group_id: String,
        opts: Option<ListCollaborationsListGroupCollaborationsOptions>,
    ) -> Result<crate::models::schemas::CollaborationsOffsetPaginated, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/groups");
        url.push('/');
        let seg = path_escape(&group_id);
        url.push_str(&seg);
        url.push_str("/collaborations");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        if let Some(value) = opts.offset {
            req = runtime::with_query(req, "offset", &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::Collaboration` across pages, threading the cursor.
    pub fn list_group_collaborations(
        &self,
        group_id: String,
        opts: Option<ListCollaborationsListGroupCollaborationsOptions>,
    ) -> ListCollaborationsListGroupCollaborationsPaginator {
        ListCollaborationsListGroupCollaborationsPaginator {
            manager: ListCollaborationsManager::new(self.session.clone()),
            group_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }
}