box-open-sdk 0.4.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 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

// Code generated by box-gantry. DO NOT EDIT.

use crate::internal::path_escape;
use crate::runtime::{self, Error};

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

/// Optional parameters for [`ChunkedUploadsManager::commit_file_upload_session`].
#[derive(Clone, Debug, Default)]
pub struct ChunkedUploadsCommitFileUploadSessionOptions {
    pub if_match: Option<String>,
    pub if_none_match: Option<String>,
}

/// Async paginator over [`ChunkedUploadsManager::list_file_upload_session_parts`], yielding one `crate::models::schemas::UploadPart`
/// per item across pages (FR-7.3).
pub struct ChunkedUploadsListFileUploadSessionPartsPaginator {
    manager: ChunkedUploadsManager,
    upload_session_id: String,
    options: ChunkedUploadsListFileUploadSessionPartsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::UploadPart>,
    done: bool,
}

impl ChunkedUploadsListFileUploadSessionPartsPaginator {
    /// 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::UploadPart, 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_upload_session_parts_page(
                    self.upload_session_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 "chunked_uploads" API area.
pub struct ChunkedUploadsManager {
    session: std::sync::Arc<runtime::Client>,
}

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

    pub async fn create_file_upload_session(
        &self,
        body: crate::models::schemas::CreateFileUploadSessionRequest,
    ) -> Result<crate::models::schemas::UploadSession, Error> {
        let mut url = self.session.base_url("upload");
        url.push_str("/files");
        url.push_str("/upload_sessions");
        let mut req = self.session.new_request("POST", &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 create_file_version_upload_session(
        &self,
        file_id: String,
        body: crate::models::schemas::CreateFileVersionUploadSessionRequest,
    ) -> Result<crate::models::schemas::UploadSession, Error> {
        let mut url = self.session.base_url("upload");
        url.push_str("/files");
        url.push('/');
        let seg = path_escape(&file_id);
        url.push_str(&seg);
        url.push_str("/upload_sessions");
        let mut req = self.session.new_request("POST", &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 get_file_upload_session(
        &self,
        upload_session_id: String,
    ) -> Result<crate::models::schemas::UploadSession, Error> {
        let mut url = self.session.base_url("upload_session");
        url.push_str("/files");
        url.push_str("/upload_sessions");
        url.push('/');
        let seg = path_escape(&upload_session_id);
        url.push_str(&seg);
        let req = self.session.new_request("GET", &url);
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    pub async fn update_file_upload_session(
        &self,
        upload_session_id: String,
        digest: String,
        content_range: String,
        body: Vec<u8>,
    ) -> Result<crate::models::schemas::UploadedPart, Error> {
        let mut url = self.session.base_url("upload_session");
        url.push_str("/files");
        url.push_str("/upload_sessions");
        url.push('/');
        let seg = path_escape(&upload_session_id);
        url.push_str(&seg);
        let mut req = self.session.new_request("PUT", &url);
        req = runtime::with_header(req, "digest", &digest);
        req = runtime::with_header(req, "content-range", &content_range);
        req = runtime::with_stream_body(
            req,
            runtime::Stream::from_bytes(body),
            "application/octet-stream",
        );
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    pub async fn delete_file_upload_session(&self, upload_session_id: String) -> Result<(), Error> {
        let mut url = self.session.base_url("upload_session");
        url.push_str("/files");
        url.push_str("/upload_sessions");
        url.push('/');
        let seg = path_escape(&upload_session_id);
        url.push_str(&seg);
        let req = self.session.new_request("DELETE", &url);
        let _ = self.session.fetch(req).await?;
        Ok(())
    }

    async fn list_file_upload_session_parts_page(
        &self,
        upload_session_id: String,
        opts: Option<ChunkedUploadsListFileUploadSessionPartsOptions>,
    ) -> Result<crate::models::schemas::UploadParts, Error> {
        let mut url = self.session.base_url("upload_session");
        url.push_str("/files");
        url.push_str("/upload_sessions");
        url.push('/');
        let seg = path_escape(&upload_session_id);
        url.push_str(&seg);
        url.push_str("/parts");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        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::UploadPart` across pages, threading the cursor.
    pub fn list_file_upload_session_parts(
        &self,
        upload_session_id: String,
        opts: Option<ChunkedUploadsListFileUploadSessionPartsOptions>,
    ) -> ChunkedUploadsListFileUploadSessionPartsPaginator {
        ChunkedUploadsListFileUploadSessionPartsPaginator {
            manager: ChunkedUploadsManager::new(self.session.clone()),
            upload_session_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn commit_file_upload_session(
        &self,
        upload_session_id: String,
        digest: String,
        body: crate::models::schemas::CommitFileUploadSessionRequest,
        opts: Option<ChunkedUploadsCommitFileUploadSessionOptions>,
    ) -> Result<crate::models::schemas::Files, Error> {
        let mut url = self.session.base_url("upload_session");
        url.push_str("/files");
        url.push_str("/upload_sessions");
        url.push('/');
        let seg = path_escape(&upload_session_id);
        url.push_str(&seg);
        url.push_str("/commit");
        let mut req = self.session.new_request("POST", &url);
        req = runtime::with_header(req, "digest", &digest);
        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.if_none_match {
            req = runtime::with_header(req, "if-none-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)?)
    }
}