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 [`FileVersionsManager::list_file_versions`].
#[derive(Clone, Debug, Default)]
pub struct FileVersionsListFileVersionsOptions {
    pub fields: Option<Vec<String>>,
    pub limit: Option<i64>,
    pub offset: Option<i64>,
}

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

/// Optional parameters for [`FileVersionsManager::delete_file_version`].
#[derive(Clone, Debug, Default)]
pub struct FileVersionsDeleteFileVersionOptions {
    pub if_match: Option<String>,
}

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

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

impl FileVersionsListFileVersionsPaginator {
    /// 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::FileVersionFull, 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_versions_page(self.file_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 "file_versions" API area.
pub struct FileVersionsManager {
    session: std::sync::Arc<runtime::Client>,
}

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

    async fn list_file_versions_page(
        &self,
        file_id: String,
        opts: Option<FileVersionsListFileVersionsOptions>,
    ) -> Result<crate::models::schemas::FileVersions, 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("/versions");
        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.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::FileVersionFull` across pages, threading the cursor.
    pub fn list_file_versions(
        &self,
        file_id: String,
        opts: Option<FileVersionsListFileVersionsOptions>,
    ) -> FileVersionsListFileVersionsPaginator {
        FileVersionsListFileVersionsPaginator {
            manager: FileVersionsManager::new(self.session.clone()),
            file_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn get_file_version(
        &self,
        file_id: String,
        file_version_id: String,
        opts: Option<FileVersionsGetFileVersionOptions>,
    ) -> Result<crate::models::schemas::FileVersionFull, 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("/versions");
        url.push('/');
        let seg = path_escape(&file_version_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(","));
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    pub async fn update_file_version(
        &self,
        file_id: String,
        file_version_id: String,
        body: crate::models::schemas::FileVersionUpdateRequest,
    ) -> Result<crate::models::schemas::FileVersionFull, 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("/versions");
        url.push('/');
        let seg = path_escape(&file_version_id);
        url.push_str(&seg);
        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_file_version(
        &self,
        file_id: String,
        file_version_id: String,
        opts: Option<FileVersionsDeleteFileVersionOptions>,
    ) -> Result<(), 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("/versions");
        url.push('/');
        let seg = path_escape(&file_version_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);
        }
        let _ = self.session.fetch(req).await?;
        Ok(())
    }

    pub async fn create_file_version_current(
        &self,
        file_id: String,
        body: crate::models::schemas::FileVersionCurrentCreateRequest,
        opts: Option<FileVersionsCreateFileVersionCurrentOptions>,
    ) -> Result<crate::models::schemas::FileVersionFull, 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("/versions");
        url.push_str("/current");
        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)?)
    }
}