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 
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

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

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

/// Optional parameters for [`AutomateWorkflowsManager::list`].
#[derive(Clone, Debug, Default)]
pub struct AutomateWorkflowsListOptions {
    pub limit: Option<i64>,
    pub marker: Option<String>,
}

/// Async paginator over [`AutomateWorkflowsManager::list`], yielding one `crate::models::schemas::AutomateWorkflowAction`
/// per item across pages (FR-7.3).
pub struct AutomateWorkflowsListPaginator {
    manager: AutomateWorkflowsManager,
    folder_id: String,
    options: AutomateWorkflowsListOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::AutomateWorkflowAction>,
    done: bool,
}

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

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

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

    async fn list_page(
        &self,
        folder_id: String,
        opts: Option<AutomateWorkflowsListOptions>,
    ) -> Result<crate::models::schemas::AutomateWorkflows, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/automate_workflows");
        let mut req = self.session.new_request("GET", &url);
        req = runtime::with_query(req, "folder_id", &folder_id);
        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.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        req = runtime::with_header(req, "box-version", "2026.0");
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

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

    pub async fn start(
        &self,
        workflow_id: String,
        body: crate::models::schemas::AutomateWorkflowStartRequest,
    ) -> Result<(), Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/automate_workflows");
        url.push('/');
        let seg = path_escape(&workflow_id);
        url.push_str(&seg);
        url.push_str("/start");
        let mut req = self.session.new_request("POST", &url);
        req = runtime::with_header(req, "box-version", "2026.0");
        let payload = serde_json::to_vec(&body)?;
        req = runtime::with_json_body(req, &payload);
        let _ = self.session.fetch(req).await?;
        Ok(())
    }
}