box-open-sdk 0.3.0

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 [`SignRequestsManager::list`].
#[derive(Clone, Debug, Default)]
pub struct SignRequestsListOptions {
    pub marker: Option<String>,
    pub limit: Option<i64>,
    pub senders: Option<Vec<String>>,
    pub shared_requests: Option<bool>,
}

/// Async paginator over [`SignRequestsManager::list`], yielding one `crate::models::schemas::SignRequest`
/// per item across pages (FR-7.3).
pub struct SignRequestsListPaginator {
    manager: SignRequestsManager,
    options: SignRequestsListOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::SignRequest>,
    done: bool,
}

impl SignRequestsListPaginator {
    /// 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::SignRequest, 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(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 "sign_requests" API area.
pub struct SignRequestsManager {
    session: std::sync::Arc<runtime::Client>,
}

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

    pub async fn cancel(
        &self,
        sign_request_id: String,
        body: crate::models::schemas::SignRequestCancelRequest,
    ) -> Result<crate::models::schemas::SignRequest, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/sign_requests");
        url.push('/');
        let seg = path_escape(&sign_request_id);
        url.push_str(&seg);
        url.push_str("/cancel");
        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 resend(&self, sign_request_id: String) -> Result<(), Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/sign_requests");
        url.push('/');
        let seg = path_escape(&sign_request_id);
        url.push_str(&seg);
        url.push_str("/resend");
        let req = self.session.new_request("POST", &url);
        let _ = self.session.fetch(req).await?;
        Ok(())
    }

    pub async fn get(
        &self,
        sign_request_id: String,
    ) -> Result<crate::models::schemas::SignRequest, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/sign_requests");
        url.push('/');
        let seg = path_escape(&sign_request_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)?)
    }

    async fn list_page(
        &self,
        opts: Option<SignRequestsListOptions>,
    ) -> Result<crate::models::schemas::SignRequests, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/sign_requests");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.marker {
            req = runtime::with_query(req, "marker", &value);
        }
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        if let Some(value) = opts.senders {
            req = runtime::with_query(req, "senders", &value.join(","));
        }
        if let Some(value) = opts.shared_requests {
            req = runtime::with_query(req, "shared_requests", &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::SignRequest` across pages, threading the cursor.
    pub fn list(&self, opts: Option<SignRequestsListOptions>) -> SignRequestsListPaginator {
        SignRequestsListPaginator {
            manager: SignRequestsManager::new(self.session.clone()),
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn create(
        &self,
        body: crate::models::schemas::SignRequestCreateRequest,
    ) -> Result<crate::models::schemas::SignRequest, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/sign_requests");
        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)?)
    }
}