box_open_sdk/managers/
archives.rs

1// Code generated by box-gantry. DO NOT EDIT.
2
3use crate::internal::path_escape;
4use crate::runtime::{self, Error};
5
6/// Optional parameters for [`ArchivesManager::list`].
7#[derive(Clone, Debug, Default)]
8pub struct ArchivesListOptions {
9    pub limit: Option<i64>,
10    pub marker: Option<String>,
11}
12
13/// Async paginator over [`ArchivesManager::list`], yielding one `crate::models::schemas::Archive`
14/// per item across pages (FR-7.3).
15pub struct ArchivesListPaginator {
16    manager: ArchivesManager,
17    options: ArchivesListOptions,
18    buffer: std::vec::IntoIter<crate::models::schemas::Archive>,
19    done: bool,
20}
21
22impl ArchivesListPaginator {
23    /// The next item, advancing pages as needed; `None` at the end.
24    /// An error is yielded once, then iteration stops.
25    pub async fn next(&mut self) -> Option<Result<crate::models::schemas::Archive, Error>> {
26        loop {
27            if let Some(item) = self.buffer.next() {
28                return Some(Ok(item));
29            }
30            if self.done {
31                return None;
32            }
33            let page = match self.manager.list_page(Some(self.options.clone())).await {
34                Ok(page) => page,
35                Err(err) => {
36                    self.done = true;
37                    return Some(Err(err));
38                }
39            };
40            self.buffer = page.entries.unwrap_or_default().into_iter();
41            match page.next_marker.flatten() {
42                Some(cursor) if !cursor.is_empty() => self.options.marker = Some(cursor),
43                _ => self.done = true,
44            }
45        }
46    }
47}
48
49/// Operations for the "archives" API area.
50pub struct ArchivesManager {
51    session: std::sync::Arc<runtime::Client>,
52}
53
54impl ArchivesManager {
55    pub(crate) fn new(session: std::sync::Arc<runtime::Client>) -> Self {
56        Self { session }
57    }
58
59    async fn list_page(
60        &self,
61        opts: Option<ArchivesListOptions>,
62    ) -> Result<crate::models::schemas::Archives, Error> {
63        let mut url = self.session.base_url("api");
64        url.push_str("/archives");
65        let mut req = self.session.new_request("GET", &url);
66        let opts = opts.unwrap_or_default();
67        if let Some(value) = opts.limit {
68            req = runtime::with_query(req, "limit", &value.to_string());
69        }
70        if let Some(value) = opts.marker {
71            req = runtime::with_query(req, "marker", &value);
72        }
73        req = runtime::with_header(req, "box-version", "2025.0");
74        let resp = self.session.fetch(req).await?;
75        let data = runtime::response_bytes(&resp)?;
76        Ok(serde_json::from_slice(&data)?)
77    }
78
79    /// Iterate every `crate::models::schemas::Archive` across pages, threading the cursor.
80    pub fn list(&self, opts: Option<ArchivesListOptions>) -> ArchivesListPaginator {
81        ArchivesListPaginator {
82            manager: ArchivesManager::new(self.session.clone()),
83            options: opts.unwrap_or_default(),
84            buffer: Vec::new().into_iter(),
85            done: false,
86        }
87    }
88
89    pub async fn create(
90        &self,
91        body: crate::models::schemas::CreateArchiveRequest,
92    ) -> Result<crate::models::schemas::Archive, Error> {
93        let mut url = self.session.base_url("api");
94        url.push_str("/archives");
95        let mut req = self.session.new_request("POST", &url);
96        req = runtime::with_header(req, "box-version", "2025.0");
97        let payload = serde_json::to_vec(&body)?;
98        req = runtime::with_json_body(req, &payload);
99        let resp = self.session.fetch(req).await?;
100        let data = runtime::response_bytes(&resp)?;
101        Ok(serde_json::from_slice(&data)?)
102    }
103
104    pub async fn update(
105        &self,
106        archive_id: String,
107        body: crate::models::schemas::UpdateArchiveRequest,
108    ) -> Result<crate::models::schemas::Archive, Error> {
109        let mut url = self.session.base_url("api");
110        url.push_str("/archives");
111        url.push('/');
112        let seg = path_escape(&archive_id);
113        url.push_str(&seg);
114        let mut req = self.session.new_request("PUT", &url);
115        req = runtime::with_header(req, "box-version", "2025.0");
116        let payload = serde_json::to_vec(&body)?;
117        req = runtime::with_json_body(req, &payload);
118        let resp = self.session.fetch(req).await?;
119        let data = runtime::response_bytes(&resp)?;
120        Ok(serde_json::from_slice(&data)?)
121    }
122
123    pub async fn delete(&self, archive_id: String) -> Result<(), Error> {
124        let mut url = self.session.base_url("api");
125        url.push_str("/archives");
126        url.push('/');
127        let seg = path_escape(&archive_id);
128        url.push_str(&seg);
129        let mut req = self.session.new_request("DELETE", &url);
130        req = runtime::with_header(req, "box-version", "2025.0");
131        let _ = self.session.fetch(req).await?;
132        Ok(())
133    }
134}
box_open_sdk/managers/archives.rs

box_open_sdk/managers/
archives.rs
