dropbox_sdk/generated/sync_routes/
file_requests.rs

1// DO NOT EDIT
2// This file was @generated by Stone
3
4#![allow(
5    clippy::too_many_arguments,
6    clippy::large_enum_variant,
7    clippy::result_large_err,
8    clippy::doc_markdown,
9)]
10
11#[allow(unused_imports)]
12pub use crate::generated::types::file_requests::*;
13
14/// Returns the total number of file requests owned by this user. Includes both open and closed file
15/// requests.
16pub fn count(
17    client: &impl crate::client_trait::UserAuthClient,
18) -> Result<CountFileRequestsResult, crate::Error<CountFileRequestsError>> {
19    crate::client_helpers::unwrap_async(
20        crate::client_helpers::request(
21            client,
22            crate::client_trait_common::Endpoint::Api,
23            crate::client_trait_common::Style::Rpc,
24            "file_requests/count",
25            &(),
26            None)
27    )
28}
29
30/// Creates a file request for this user.
31pub fn create(
32    client: &impl crate::client_trait::UserAuthClient,
33    arg: &CreateFileRequestArgs,
34) -> Result<FileRequest, crate::Error<CreateFileRequestError>> {
35    crate::client_helpers::unwrap_async(
36        crate::client_helpers::request(
37            client,
38            crate::client_trait_common::Endpoint::Api,
39            crate::client_trait_common::Style::Rpc,
40            "file_requests/create",
41            arg,
42            None)
43    )
44}
45
46/// Delete a batch of closed file requests.
47pub fn delete(
48    client: &impl crate::client_trait::UserAuthClient,
49    arg: &DeleteFileRequestArgs,
50) -> Result<DeleteFileRequestsResult, crate::Error<DeleteFileRequestError>> {
51    crate::client_helpers::unwrap_async(
52        crate::client_helpers::request(
53            client,
54            crate::client_trait_common::Endpoint::Api,
55            crate::client_trait_common::Style::Rpc,
56            "file_requests/delete",
57            arg,
58            None)
59    )
60}
61
62/// Delete all closed file requests owned by this user.
63pub fn delete_all_closed(
64    client: &impl crate::client_trait::UserAuthClient,
65) -> Result<DeleteAllClosedFileRequestsResult, crate::Error<DeleteAllClosedFileRequestsError>> {
66    crate::client_helpers::unwrap_async(
67        crate::client_helpers::request(
68            client,
69            crate::client_trait_common::Endpoint::Api,
70            crate::client_trait_common::Style::Rpc,
71            "file_requests/delete_all_closed",
72            &(),
73            None)
74    )
75}
76
77/// Returns the specified file request.
78pub fn get(
79    client: &impl crate::client_trait::UserAuthClient,
80    arg: &GetFileRequestArgs,
81) -> Result<FileRequest, crate::Error<GetFileRequestError>> {
82    crate::client_helpers::unwrap_async(
83        crate::client_helpers::request(
84            client,
85            crate::client_trait_common::Endpoint::Api,
86            crate::client_trait_common::Style::Rpc,
87            "file_requests/get",
88            arg,
89            None)
90    )
91}
92
93/// Returns a list of file requests owned by this user. For apps with the app folder permission,
94/// this will only return file requests with destinations in the app folder.
95pub fn list_v2(
96    client: &impl crate::client_trait::UserAuthClient,
97    arg: &ListFileRequestsArg,
98) -> Result<ListFileRequestsV2Result, crate::Error<ListFileRequestsError>> {
99    crate::client_helpers::unwrap_async(
100        crate::client_helpers::request(
101            client,
102            crate::client_trait_common::Endpoint::Api,
103            crate::client_trait_common::Style::Rpc,
104            "file_requests/list_v2",
105            arg,
106            None)
107    )
108}
109
110/// Returns a list of file requests owned by this user. For apps with the app folder permission,
111/// this will only return file requests with destinations in the app folder.
112pub fn list(
113    client: &impl crate::client_trait::UserAuthClient,
114) -> Result<ListFileRequestsResult, crate::Error<ListFileRequestsError>> {
115    crate::client_helpers::unwrap_async(
116        crate::client_helpers::request(
117            client,
118            crate::client_trait_common::Endpoint::Api,
119            crate::client_trait_common::Style::Rpc,
120            "file_requests/list",
121            &(),
122            None)
123    )
124}
125
126/// Once a cursor has been retrieved from [`list_v2()`](crate::file_requests::list_v2), use this to
127/// paginate through all file requests. The cursor must come from a previous call to
128/// [`list_v2()`](crate::file_requests::list_v2) or
129/// [`list_continue()`](crate::file_requests::list_continue).
130pub fn list_continue(
131    client: &impl crate::client_trait::UserAuthClient,
132    arg: &ListFileRequestsContinueArg,
133) -> Result<ListFileRequestsV2Result, crate::Error<ListFileRequestsContinueError>> {
134    crate::client_helpers::unwrap_async(
135        crate::client_helpers::request(
136            client,
137            crate::client_trait_common::Endpoint::Api,
138            crate::client_trait_common::Style::Rpc,
139            "file_requests/list/continue",
140            arg,
141            None)
142    )
143}
144
145/// Update a file request.
146pub fn update(
147    client: &impl crate::client_trait::UserAuthClient,
148    arg: &UpdateFileRequestArgs,
149) -> Result<FileRequest, crate::Error<UpdateFileRequestError>> {
150    crate::client_helpers::unwrap_async(
151        crate::client_helpers::request(
152            client,
153            crate::client_trait_common::Endpoint::Api,
154            crate::client_trait_common::Style::Rpc,
155            "file_requests/update",
156            arg,
157            None)
158    )
159}
160