dropbox_sdk/generated/async_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::async_client_trait::UserAuthClient,
18) -> impl std::future::Future<Output=Result<CountFileRequestsResult, crate::Error<CountFileRequestsError>>> + Send + '_ {
19    crate::client_helpers::request(
20        client,
21        crate::client_trait_common::Endpoint::Api,
22        crate::client_trait_common::Style::Rpc,
23        "file_requests/count",
24        &(),
25        None)
26}
27
28/// Creates a file request for this user.
29pub fn create<'a>(
30    client: &'a impl crate::async_client_trait::UserAuthClient,
31    arg: &'a CreateFileRequestArgs,
32) -> impl std::future::Future<Output=Result<FileRequest, crate::Error<CreateFileRequestError>>> + Send + 'a {
33    crate::client_helpers::request(
34        client,
35        crate::client_trait_common::Endpoint::Api,
36        crate::client_trait_common::Style::Rpc,
37        "file_requests/create",
38        arg,
39        None)
40}
41
42/// Delete a batch of closed file requests.
43pub fn delete<'a>(
44    client: &'a impl crate::async_client_trait::UserAuthClient,
45    arg: &'a DeleteFileRequestArgs,
46) -> impl std::future::Future<Output=Result<DeleteFileRequestsResult, crate::Error<DeleteFileRequestError>>> + Send + 'a {
47    crate::client_helpers::request(
48        client,
49        crate::client_trait_common::Endpoint::Api,
50        crate::client_trait_common::Style::Rpc,
51        "file_requests/delete",
52        arg,
53        None)
54}
55
56/// Delete all closed file requests owned by this user.
57pub fn delete_all_closed(
58    client: &impl crate::async_client_trait::UserAuthClient,
59) -> impl std::future::Future<Output=Result<DeleteAllClosedFileRequestsResult, crate::Error<DeleteAllClosedFileRequestsError>>> + Send + '_ {
60    crate::client_helpers::request(
61        client,
62        crate::client_trait_common::Endpoint::Api,
63        crate::client_trait_common::Style::Rpc,
64        "file_requests/delete_all_closed",
65        &(),
66        None)
67}
68
69/// Returns the specified file request.
70pub fn get<'a>(
71    client: &'a impl crate::async_client_trait::UserAuthClient,
72    arg: &'a GetFileRequestArgs,
73) -> impl std::future::Future<Output=Result<FileRequest, crate::Error<GetFileRequestError>>> + Send + 'a {
74    crate::client_helpers::request(
75        client,
76        crate::client_trait_common::Endpoint::Api,
77        crate::client_trait_common::Style::Rpc,
78        "file_requests/get",
79        arg,
80        None)
81}
82
83/// Returns a list of file requests owned by this user. For apps with the app folder permission,
84/// this will only return file requests with destinations in the app folder.
85pub fn list_v2<'a>(
86    client: &'a impl crate::async_client_trait::UserAuthClient,
87    arg: &'a ListFileRequestsArg,
88) -> impl std::future::Future<Output=Result<ListFileRequestsV2Result, crate::Error<ListFileRequestsError>>> + Send + 'a {
89    crate::client_helpers::request(
90        client,
91        crate::client_trait_common::Endpoint::Api,
92        crate::client_trait_common::Style::Rpc,
93        "file_requests/list_v2",
94        arg,
95        None)
96}
97
98/// Returns a list of file requests owned by this user. For apps with the app folder permission,
99/// this will only return file requests with destinations in the app folder.
100pub fn list(
101    client: &impl crate::async_client_trait::UserAuthClient,
102) -> impl std::future::Future<Output=Result<ListFileRequestsResult, crate::Error<ListFileRequestsError>>> + Send + '_ {
103    crate::client_helpers::request(
104        client,
105        crate::client_trait_common::Endpoint::Api,
106        crate::client_trait_common::Style::Rpc,
107        "file_requests/list",
108        &(),
109        None)
110}
111
112/// Once a cursor has been retrieved from [`list_v2()`](crate::file_requests::list_v2), use this to
113/// paginate through all file requests. The cursor must come from a previous call to
114/// [`list_v2()`](crate::file_requests::list_v2) or
115/// [`list_continue()`](crate::file_requests::list_continue).
116pub fn list_continue<'a>(
117    client: &'a impl crate::async_client_trait::UserAuthClient,
118    arg: &'a ListFileRequestsContinueArg,
119) -> impl std::future::Future<Output=Result<ListFileRequestsV2Result, crate::Error<ListFileRequestsContinueError>>> + Send + 'a {
120    crate::client_helpers::request(
121        client,
122        crate::client_trait_common::Endpoint::Api,
123        crate::client_trait_common::Style::Rpc,
124        "file_requests/list/continue",
125        arg,
126        None)
127}
128
129/// Update a file request.
130pub fn update<'a>(
131    client: &'a impl crate::async_client_trait::UserAuthClient,
132    arg: &'a UpdateFileRequestArgs,
133) -> impl std::future::Future<Output=Result<FileRequest, crate::Error<UpdateFileRequestError>>> + Send + 'a {
134    crate::client_helpers::request(
135        client,
136        crate::client_trait_common::Endpoint::Api,
137        crate::client_trait_common::Style::Rpc,
138        "file_requests/update",
139        arg,
140        None)
141}
142