cloudreve_api/api/v3/
models.rs

1//! Common data models for the Cloudreve API v3
2
3use serde::{Deserialize, Serialize};
4use serde_json::Value;
5
6/// API response wrapper for v3 API
7#[derive(Debug, Serialize, Deserialize)]
8pub struct ApiResponse<T> {
9    pub code: i32,
10    pub msg: String,
11    pub data: Option<T>,
12}
13
14/// User information for v3 API
15#[derive(Debug, Serialize, Deserialize, Clone)]
16pub struct User {
17    pub id: String,
18    pub user_name: String,
19    pub nickname: String,
20    #[serde(default)]
21    pub status: i32,
22    #[serde(default)]
23    pub avatar: String,
24    pub created_at: String,
25    #[serde(default)]
26    pub preferred_theme: String,
27    #[serde(default)]
28    pub anonymous: bool,
29    pub group: UserGroup,
30    #[serde(default)]
31    pub tags: Vec<String>,
32}
33
34/// User group information for v3 API
35#[derive(Debug, Serialize, Deserialize, Clone)]
36pub struct UserGroup {
37    #[serde(default)]
38    pub id: i32,
39    #[serde(default)]
40    pub name: String,
41    #[serde(default)]
42    pub allow_share: bool,
43    #[serde(default)]
44    pub allow_remote_download: bool,
45    #[serde(default)]
46    pub allow_archive_download: bool,
47    #[serde(default)]
48    pub share_download: bool,
49    #[serde(default)]
50    pub compress: bool,
51    #[serde(default)]
52    pub webdav: bool,
53    #[serde(default)]
54    pub source_batch: i32,
55    #[serde(default)]
56    pub advance_delete: bool,
57    #[serde(default)]
58    pub allow_web_dav_proxy: bool,
59}
60
61/// File or folder object for v3 API
62#[derive(Debug, Serialize, Deserialize, Clone)]
63pub struct Object {
64    pub id: String,
65    pub name: String,
66    pub path: String,
67    pub thumb: bool,
68    pub size: i64,
69    #[serde(rename = "type")]
70    pub object_type: String,
71    pub date: String,
72    pub create_date: String,
73    pub source_enabled: bool,
74}
75
76/// Storage policy information for v3 API
77#[derive(Debug, Serialize, Deserialize, Clone, Default)]
78pub struct Policy {
79    #[serde(default)]
80    pub id: String,
81    #[serde(default)]
82    pub name: String,
83    #[serde(rename = "type")]
84    #[serde(default)]
85    pub policy_type: String,
86    #[serde(default)]
87    pub max_size: i64,
88    #[serde(default)]
89    pub file_type: Option<Vec<String>>,
90}
91
92/// File or folder property for v3 API
93#[derive(Debug, Serialize, Deserialize)]
94pub struct Property {
95    pub created_at: String,
96    pub updated_at: String,
97    pub policy: String,
98    pub size: i64,
99    pub child_folder_num: i32,
100    pub child_file_num: i32,
101    pub path: String,
102    pub query_date: String,
103}
104
105/// Directory listing response for v3 API
106#[derive(Debug, Serialize, Deserialize)]
107pub struct DirectoryList {
108    #[serde(default)]
109    pub parent: String,
110    #[serde(default)]
111    pub objects: Vec<Object>,
112    #[serde(default)]
113    pub policy: Policy,
114}
115
116/// Upload session information for v3 API
117#[derive(Debug, Serialize, Deserialize)]
118pub struct UploadSession {
119    #[serde(rename = "sessionID")]
120    pub session_id: String,
121    #[serde(rename = "chunkSize")]
122    pub chunk_size: i64,
123    pub expires: i64,
124}
125
126/// Upload file request for v3 API
127#[derive(Debug, Serialize)]
128pub struct UploadFileRequest<'a> {
129    pub path: &'a str,
130    pub size: i64,
131    pub name: &'a str,
132    pub policy_id: &'a str,
133    pub last_modified: i64,
134    pub mime_type: &'a str,
135}
136
137/// Download file response for v3 API
138#[derive(Debug, Deserialize)]
139pub struct DownloadUrl {
140    pub url: String,
141}
142
143/// File source information for v3 API
144#[derive(Debug, Deserialize)]
145pub struct FileSource {
146    pub url: String,
147    pub name: String,
148    pub parent: i64,
149}
150
151/// Storage information for v3 API
152#[derive(Debug, Serialize, Deserialize)]
153pub struct StorageInfo {
154    pub used: i64,
155    pub free: i64,
156    pub total: i64,
157}
158
159/// Share link information for v3 API
160#[derive(Debug, Deserialize)]
161pub struct Share {
162    pub key: String,
163}
164
165/// Share request for v3 API
166#[derive(Debug, Serialize)]
167pub struct ShareRequest {
168    pub id: String,
169    pub is_dir: bool,
170    pub password: String,
171    pub downloads: i32,
172    pub expire: i32,
173    pub preview: bool,
174}
175
176/// Site configuration for v3 API
177#[derive(Debug, Serialize, Deserialize, Default)]
178pub struct SiteConfig {
179    #[serde(default)]
180    pub title: String,
181    #[serde(default)]
182    pub login_captcha: bool,
183    #[serde(default)]
184    pub reg_captcha: bool,
185    #[serde(default)]
186    pub forget_captcha: bool,
187    #[serde(default)]
188    pub email_active: bool,
189    #[serde(default)]
190    pub themes: String,
191    #[serde(default)]
192    pub default_theme: String,
193    #[serde(default)]
194    pub home_view_method: String,
195    #[serde(default)]
196    pub share_view_method: String,
197    #[serde(default)]
198    pub authn: bool,
199    #[serde(default)]
200    pub user: Option<User>,
201    #[serde(default)]
202    pub captcha_recaptcha_key: String,
203    #[serde(default)]
204    pub captcha_type: String,
205    #[serde(default)]
206    pub tcaptcha_captcha_app_id: String,
207    #[serde(default)]
208    pub register_enabled: bool,
209    #[serde(default)]
210    pub app_promotion: bool,
211    #[serde(default)]
212    pub wopi_exts: Option<Value>,
213}
214
215/// Login request for v3 API
216#[derive(Debug, Serialize)]
217pub struct LoginRequest<'a> {
218    #[serde(rename = "userName")]
219    pub user_name: &'a str,
220    #[serde(rename = "Password")]
221    pub password: &'a str,
222    #[serde(rename = "captchaCode")]
223    pub captcha_code: &'a str,
224}
225
226/// OTP login request for v3 API
227#[derive(Debug, Serialize)]
228pub struct OtpLoginRequest {
229    pub code: String,
230}
231
232/// Create directory request for v3 API
233#[derive(Debug, Serialize)]
234pub struct CreateDirectoryRequest<'a> {
235    pub path: &'a str,
236}
237
238/// Create file request for v3 API
239#[derive(Debug, Serialize)]
240pub struct CreateFileRequest<'a> {
241    pub path: &'a str,
242}
243
244/// File source request for v3 API
245#[derive(Debug, Serialize)]
246pub struct FileSourceRequest {
247    pub items: Vec<String>,
248}
249
250/// Rename object request for v3 API
251#[derive(Debug, Serialize)]
252pub struct RenameObjectRequest<'a> {
253    pub action: &'a str,
254    pub src: SourceItems<'a>,
255    pub new_name: &'a str,
256}
257
258/// Source items for object operations
259#[derive(Debug, Serialize)]
260pub struct SourceItems<'a> {
261    pub dirs: Vec<&'a str>,
262    pub items: Vec<&'a str>,
263}
264
265/// Move object request for v3 API
266#[derive(Debug, Serialize)]
267pub struct MoveObjectRequest<'a> {
268    pub action: &'a str,
269    pub src_dir: &'a str,
270    pub src: SourceItems<'a>,
271    pub dst: &'a str,
272}
273
274/// Copy object request for v3 API
275#[derive(Debug, Serialize)]
276pub struct CopyObjectRequest<'a> {
277    pub src_dir: &'a str,
278    pub src: SourceItems<'a>,
279    pub dst: &'a str,
280}
281
282/// Delete object request for v3 API
283#[derive(Debug, Serialize)]
284pub struct DeleteObjectRequest<'a> {
285    pub items: Vec<&'a str>,
286    pub dirs: Vec<&'a str>,
287    pub force: bool,
288    pub unlink: bool,
289}
290
291/// Object property request for v3 API
292pub struct ObjectPropertyRequest<'a> {
293    pub id: &'a str,
294    pub is_folder: Option<bool>,
295    pub trace_root: Option<bool>,
296}
297
298/// Aria2 task information for v3 API
299#[derive(Debug, Deserialize)]
300pub struct Aria2Task {
301    pub id: String,
302    pub url: String,
303    pub status: String,
304    pub progress: f64,
305    pub created_at: String,
306}
307
308/// Aria2 create download request for v3 API
309#[derive(Debug, Serialize)]
310pub struct Aria2CreateRequest<'a> {
311    pub dst: &'a str,
312    pub url: Vec<&'a str>,
313}
314
315/// WebDAV account information for v3 API
316#[derive(Debug, Deserialize)]
317pub struct WebdavAccount {
318    #[serde(rename = "ID")]
319    pub id: i32,
320    #[serde(rename = "Name")]
321    pub name: String,
322    #[serde(rename = "Root")]
323    pub uri: String,
324    #[serde(rename = "Password")]
325    pub password: String,
326    #[serde(rename = "CreatedAt")]
327    pub created_at: String,
328}
cloudreve_api/api/v3/models.rs

cloudreve_api/api/v3/
models.rs
