Skip to main content

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