box_open_sdk/managers/
collections.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 [`CollectionsManager::list`].
7#[derive(Clone, Debug, Default)]
8pub struct CollectionsListOptions {
9    pub fields: Option<Vec<String>>,
10    pub offset: Option<i64>,
11    pub limit: Option<i64>,
12}
13
14/// Optional parameters for [`CollectionsManager::list_items`].
15#[derive(Clone, Debug, Default)]
16pub struct CollectionsListItemsOptions {
17    pub fields: Option<Vec<String>>,
18    pub offset: Option<i64>,
19    pub limit: Option<i64>,
20}
21
22/// Async paginator over [`CollectionsManager::list`], yielding one `crate::models::schemas::Collection`
23/// per item across pages (FR-7.3).
24pub struct CollectionsListPaginator {
25    manager: CollectionsManager,
26    options: CollectionsListOptions,
27    buffer: std::vec::IntoIter<crate::models::schemas::Collection>,
28    done: bool,
29}
30
31impl CollectionsListPaginator {
32    /// The next item, advancing pages as needed; `None` at the end.
33    /// An error is yielded once, then iteration stops.
34    pub async fn next(&mut self) -> Option<Result<crate::models::schemas::Collection, Error>> {
35        loop {
36            if let Some(item) = self.buffer.next() {
37                return Some(Ok(item));
38            }
39            if self.done {
40                return None;
41            }
42            let page = match self.manager.list_page(Some(self.options.clone())).await {
43                Ok(page) => page,
44                Err(err) => {
45                    self.done = true;
46                    return Some(Err(err));
47                }
48            };
49            let items = page.entries.unwrap_or_default();
50            if items.is_empty() {
51                self.done = true;
52            } else {
53                let next = self.options.offset.unwrap_or(0) + items.len() as i64;
54                self.options.offset = Some(next);
55            }
56            self.buffer = items.into_iter();
57        }
58    }
59}
60
61/// Async paginator over [`CollectionsManager::list_items`], yielding one `crate::models::schemas::Item`
62/// per item across pages (FR-7.3).
63pub struct CollectionsListItemsPaginator {
64    manager: CollectionsManager,
65    collection_id: String,
66    options: CollectionsListItemsOptions,
67    buffer: std::vec::IntoIter<crate::models::schemas::Item>,
68    done: bool,
69}
70
71impl CollectionsListItemsPaginator {
72    /// The next item, advancing pages as needed; `None` at the end.
73    /// An error is yielded once, then iteration stops.
74    pub async fn next(&mut self) -> Option<Result<crate::models::schemas::Item, Error>> {
75        loop {
76            if let Some(item) = self.buffer.next() {
77                return Some(Ok(item));
78            }
79            if self.done {
80                return None;
81            }
82            let page = match self
83                .manager
84                .list_items_page(self.collection_id.clone(), Some(self.options.clone()))
85                .await
86            {
87                Ok(page) => page,
88                Err(err) => {
89                    self.done = true;
90                    return Some(Err(err));
91                }
92            };
93            let items = page.entries.unwrap_or_default();
94            if items.is_empty() {
95                self.done = true;
96            } else {
97                let next = self.options.offset.unwrap_or(0) + items.len() as i64;
98                self.options.offset = Some(next);
99            }
100            self.buffer = items.into_iter();
101        }
102    }
103}
104
105/// Operations for the "collections" API area.
106pub struct CollectionsManager {
107    session: std::sync::Arc<runtime::Client>,
108}
109
110impl CollectionsManager {
111    pub(crate) fn new(session: std::sync::Arc<runtime::Client>) -> Self {
112        Self { session }
113    }
114
115    async fn list_page(
116        &self,
117        opts: Option<CollectionsListOptions>,
118    ) -> Result<crate::models::schemas::Collections, Error> {
119        let mut url = self.session.base_url("api");
120        url.push_str("/collections");
121        let mut req = self.session.new_request("GET", &url);
122        let opts = opts.unwrap_or_default();
123        if let Some(value) = opts.fields {
124            req = runtime::with_query(req, "fields", &value.join(","));
125        }
126        if let Some(value) = opts.offset {
127            req = runtime::with_query(req, "offset", &value.to_string());
128        }
129        if let Some(value) = opts.limit {
130            req = runtime::with_query(req, "limit", &value.to_string());
131        }
132        let resp = self.session.fetch(req).await?;
133        let data = runtime::response_bytes(&resp)?;
134        Ok(serde_json::from_slice(&data)?)
135    }
136
137    /// Iterate every `crate::models::schemas::Collection` across pages, threading the cursor.
138    pub fn list(&self, opts: Option<CollectionsListOptions>) -> CollectionsListPaginator {
139        CollectionsListPaginator {
140            manager: CollectionsManager::new(self.session.clone()),
141            options: opts.unwrap_or_default(),
142            buffer: Vec::new().into_iter(),
143            done: false,
144        }
145    }
146
147    async fn list_items_page(
148        &self,
149        collection_id: String,
150        opts: Option<CollectionsListItemsOptions>,
151    ) -> Result<crate::models::schemas::ItemsOffsetPaginated, Error> {
152        let mut url = self.session.base_url("api");
153        url.push_str("/collections");
154        url.push('/');
155        let seg = path_escape(&collection_id);
156        url.push_str(&seg);
157        url.push_str("/items");
158        let mut req = self.session.new_request("GET", &url);
159        let opts = opts.unwrap_or_default();
160        if let Some(value) = opts.fields {
161            req = runtime::with_query(req, "fields", &value.join(","));
162        }
163        if let Some(value) = opts.offset {
164            req = runtime::with_query(req, "offset", &value.to_string());
165        }
166        if let Some(value) = opts.limit {
167            req = runtime::with_query(req, "limit", &value.to_string());
168        }
169        let resp = self.session.fetch(req).await?;
170        let data = runtime::response_bytes(&resp)?;
171        Ok(serde_json::from_slice(&data)?)
172    }
173
174    /// Iterate every `crate::models::schemas::Item` across pages, threading the cursor.
175    pub fn list_items(
176        &self,
177        collection_id: String,
178        opts: Option<CollectionsListItemsOptions>,
179    ) -> CollectionsListItemsPaginator {
180        CollectionsListItemsPaginator {
181            manager: CollectionsManager::new(self.session.clone()),
182            collection_id,
183            options: opts.unwrap_or_default(),
184            buffer: Vec::new().into_iter(),
185            done: false,
186        }
187    }
188
189    pub async fn get(
190        &self,
191        collection_id: String,
192    ) -> Result<crate::models::schemas::Collection, Error> {
193        let mut url = self.session.base_url("api");
194        url.push_str("/collections");
195        url.push('/');
196        let seg = path_escape(&collection_id);
197        url.push_str(&seg);
198        let req = self.session.new_request("GET", &url);
199        let resp = self.session.fetch(req).await?;
200        let data = runtime::response_bytes(&resp)?;
201        Ok(serde_json::from_slice(&data)?)
202    }
203}
box_open_sdk/managers/collections.rs

box_open_sdk/managers/
collections.rs
