open-lark 0.13.0

Enterprise-grade Lark/Feishu Open API SDK with comprehensive Chinese documentation and advanced error handling
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
use reqwest::Method;
use serde::{Deserialize, Serialize};

use crate::{
    core::{
        api_req::ApiRequest,
        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
        config::Config,
        constants::AccessTokenType,
        http::Transport,
        req_option::RequestOption,
        SDKResult,
    },
    impl_executable_builder_owned,
};

/// 文件服务 - 处理除上传下载外的其他文件操作
pub struct FileService {
    config: Config,
}

impl FileService {
    pub fn new(config: Config) -> Self {
        Self { config }
    }

    /// 获取文件元数据
    ///
    /// 该接口用于根据文件token获取文件的元数据信息。
    ///
    /// <https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/meta/batch_query>
    pub async fn get_file_meta(
        &self,
        request: GetFileMetaRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GetFileMetaRespData>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: "/open-apis/drive/v1/metas/batch_query".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 获取文件统计信息
    ///
    /// 该接口用于根据文件token获取文件的统计信息,如浏览次数等。
    ///
    /// <https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-statistics/get>
    pub async fn get_file_statistics(
        &self,
        request: GetFileStatisticsRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GetFileStatisticsRespData>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: format!(
                "/open-apis/drive/v1/files/{}/statistics",
                request.file_token
            ),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 获取文件访问记录
    ///
    /// 该接口用于获取文件的访问记录列表。
    ///
    /// <https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list>
    pub async fn list_file_view_records(
        &self,
        request: ListFileViewRecordsRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<ListFileViewRecordsRespData>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: format!(
                "/open-apis/drive/v1/files/{}/view_records",
                request.file_token
            ),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert("page_token".to_string(), page_token);
        }
        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert("page_size".to_string(), page_size.to_string());
        }

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 新建文件
    ///
    /// 该接口用于在指定文件夹中新建文件。
    ///
    /// <https://open.feishu.cn/document/ukTMukTMukTM/uQTNzUjL0UzM14CN1MTN>
    pub async fn create_file(
        &self,
        request: CreateFileRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<CreateFileRespData>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: "/open-apis/drive/v1/files".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 复制文件
    ///
    /// 该接口用于复制文件到指定文件夹。
    ///
    /// <https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy>
    pub async fn copy_file(
        &self,
        request: CopyFileRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<CopyFileRespData>> {
        // 构建请求体
        let body = serde_json::json!({
            "name": request.name,
            "type": request.copy_type,
            "parent_token": request.parent_token
        });

        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: format!("/open-apis/drive/v1/files/{}/copy", request.file_token),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&body)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 删除文件
    ///
    /// 该接口用于删除文件。
    ///
    /// <https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete>
    pub async fn delete_file(
        &self,
        request: DeleteFileRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<DeleteFileRespData>> {
        let api_req = ApiRequest {
            http_method: Method::DELETE,
            api_path: format!("/open-apis/drive/v1/files/{}", request.file_token),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 创建文件快捷方式
    ///
    /// 该接口用于创建文件的快捷方式。
    ///
    /// <https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_shortcut>
    pub async fn create_file_shortcut(
        &self,
        request: CreateFileShortcutRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<CreateFileShortcutRespData>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: "/open-apis/drive/v1/files/create_shortcut".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 搜索文件
    ///
    /// 该接口用于搜索文件。
    ///
    /// <https://open.feishu.cn/document/ukTMukTMukTM/ugDM4UjL4ADO14COwgTN>
    pub async fn search_files(
        &self,
        request: SearchFilesRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<SearchFilesRespData>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: "/open-apis/drive/v1/files/search".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            ..Default::default()
        };

        // 添加查询参数
        api_req
            .query_params
            .insert("search_key".to_string(), request.search_key);
        if let Some(count) = request.count {
            api_req
                .query_params
                .insert("count".to_string(), count.to_string());
        }
        if let Some(offset) = request.offset {
            api_req
                .query_params
                .insert("offset".to_string(), offset.to_string());
        }
        if let Some(owner_ids) = request.owner_ids {
            api_req
                .query_params
                .insert("owner_ids".to_string(), owner_ids.join(","));
        }

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 分片上传文件-预上传
    ///
    /// 该接口用于分片上传的预上传步骤,获取上传事务ID和分片信息。
    ///
    /// <https://open.feishu.cn/document/server-docs/docs/drive-v1/upload/multipart-upload-file-/upload_prepare>
    pub async fn upload_prepare(
        &self,
        request: FileUploadPrepareRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<FileUploadPrepareRespData>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: "/open-apis/drive/v1/files/upload_prepare".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 分片上传文件-上传分片
    ///
    /// 该接口用于上传文件分片。
    ///
    /// <https://open.feishu.cn/document/server-docs/docs/drive-v1/upload/multipart-upload-file-/upload_part>
    pub async fn upload_part(
        &self,
        request: FileUploadPartRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<FileUploadPartRespData>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::POST;
        api_req.api_path = "/open-apis/drive/v1/files/upload_part".to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::User, AccessTokenType::Tenant];

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 分片上传文件-完成上传
    ///
    /// 该接口用于完成分片上传。
    ///
    /// <https://open.feishu.cn/document/server-docs/docs/drive-v1/upload/multipart-upload-file-/upload_finish>
    pub async fn upload_finish(
        &self,
        request: FileUploadFinishRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<FileUploadFinishRespData>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: "/open-apis/drive/v1/files/upload_finish".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 创建导入任务
    ///
    /// 该接口用于创建文档导入任务。
    ///
    /// <https://open.feishu.cn/document/server-docs/docs/drive-v1/import_task/create>
    pub async fn create_import_task(
        &self,
        request: CreateImportTaskRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<CreateImportTaskRespData>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: "/open-apis/drive/v1/import_tasks".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 查询导入任务结果
    ///
    /// 该接口用于查询导入任务的执行结果。
    ///
    /// <https://open.feishu.cn/document/server-docs/docs/drive-v1/import_task/get>
    pub async fn get_import_task(
        &self,
        request: GetImportTaskRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GetImportTaskRespData>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: format!("/open-apis/drive/v1/import_tasks/{}", request.ticket),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }
}

// === 请求和响应数据结构 ===

/// 获取文件元数据请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetFileMetaRequest {
    /// 文件token列表
    pub request_docs: Vec<RequestDoc>,
    /// 是否获取额外信息
    pub with_url: Option<bool>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RequestDoc {
    /// 文件token
    pub doc_token: String,
    /// 文件类型
    pub doc_type: String,
}

impl GetFileMetaRequest {
    pub fn new(docs: Vec<(String, String)>) -> Self {
        Self {
            request_docs: docs
                .into_iter()
                .map(|(token, doc_type)| RequestDoc {
                    doc_token: token,
                    doc_type,
                })
                .collect(),
            with_url: Some(true),
        }
    }
}

/// 获取文件元数据响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetFileMetaRespData {
    /// 文件元数据列表
    pub metas: Vec<FileMeta>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileMeta {
    /// 文件token
    pub doc_token: String,
    /// 文件类型
    pub doc_type: String,
    /// 文件标题
    pub title: String,
    /// 拥有者ID
    pub owner_id: String,
    /// 创建时间
    pub create_time: String,
    /// 更新时间
    pub update_time: String,
    /// 文件URL
    pub url: Option<String>,
}

impl ApiResponseTrait for GetFileMetaRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 获取文件统计信息请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetFileStatisticsRequest {
    /// 文件token
    pub file_token: String,
}

impl GetFileStatisticsRequest {
    pub fn new(file_token: impl Into<String>) -> Self {
        Self {
            file_token: file_token.into(),
        }
    }
}

/// 获取文件统计信息响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetFileStatisticsRespData {
    /// 文件浏览次数
    pub uv: i64,
    /// 文件浏览人数
    pub pv: i64,
    /// 文件点赞数
    pub like_count: i64,
    /// 文件评论数
    pub comment_count: i64,
}

impl ApiResponseTrait for GetFileStatisticsRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 获取文件访问记录请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListFileViewRecordsRequest {
    /// 文件token
    pub file_token: String,
    /// 分页token
    pub page_token: Option<String>,
    /// 分页大小
    pub page_size: Option<i32>,
}

impl ListFileViewRecordsRequest {
    pub fn new(file_token: impl Into<String>) -> Self {
        Self {
            file_token: file_token.into(),
            page_token: None,
            page_size: None,
        }
    }

    pub fn with_page_token(mut self, page_token: impl Into<String>) -> Self {
        self.page_token = Some(page_token.into());
        self
    }

    pub fn with_page_size(mut self, page_size: i32) -> Self {
        self.page_size = Some(page_size);
        self
    }
}

/// 获取文件访问记录响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListFileViewRecordsRespData {
    /// 是否还有更多数据
    pub has_more: bool,
    /// 下一页token
    pub page_token: Option<String>,
    /// 访问记录列表
    pub items: Vec<FileViewRecord>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileViewRecord {
    /// 访问者ID
    pub viewer_id: String,
    /// 访问者名称
    pub viewer_name: String,
    /// 访问时间
    pub view_time: String,
    /// 访问设备
    pub view_device: String,
}

impl ApiResponseTrait for ListFileViewRecordsRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 新建文件请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFileRequest {
    /// 文件名称
    pub title: String,
    /// 文件类型
    #[serde(rename = "type")]
    pub file_type: String,
    /// 父文件夹token
    pub parent_token: String,
}

impl CreateFileRequest {
    pub fn new(
        title: impl Into<String>,
        file_type: impl Into<String>,
        parent_token: impl Into<String>,
    ) -> Self {
        Self {
            title: title.into(),
            file_type: file_type.into(),
            parent_token: parent_token.into(),
        }
    }
}

/// 新建文件响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFileRespData {
    /// 新建文件的token
    pub token: String,
    /// 新建文件的链接
    pub url: String,
}

impl ApiResponseTrait for CreateFileRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 复制文件请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CopyFileRequest {
    /// 文件token
    pub file_token: String,
    /// 新文件名称
    pub name: String,
    /// 复制类型
    #[serde(rename = "type")]
    pub copy_type: String,
    /// 目标父文件夹token
    pub parent_token: String,
}

impl CopyFileRequest {
    pub fn new(
        file_token: impl Into<String>,
        name: impl Into<String>,
        parent_token: impl Into<String>,
    ) -> Self {
        Self {
            file_token: file_token.into(),
            name: name.into(),
            copy_type: "copy".to_string(),
            parent_token: parent_token.into(),
        }
    }
}

/// 复制文件响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CopyFileRespData {
    /// 复制后文件的token
    pub token: String,
    /// 复制后文件的链接
    pub url: String,
}

impl ApiResponseTrait for CopyFileRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 删除文件请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeleteFileRequest {
    /// 文件token
    pub file_token: String,
}

impl DeleteFileRequest {
    pub fn new(file_token: impl Into<String>) -> Self {
        Self {
            file_token: file_token.into(),
        }
    }
}

/// 删除文件响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeleteFileRespData {
    /// 异步任务ID
    pub task_id: Option<String>,
}

impl ApiResponseTrait for DeleteFileRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 创建文件快捷方式请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFileShortcutRequest {
    /// 原文件token
    pub refer_entity: ReferEntity,
    /// 快捷方式名称
    pub name: String,
    /// 父文件夹token
    pub parent_token: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ReferEntity {
    /// 原文件类型
    #[serde(rename = "type")]
    pub entity_type: String,
    /// 原文件token
    pub token: String,
}

impl CreateFileShortcutRequest {
    pub fn new(
        file_type: impl Into<String>,
        file_token: impl Into<String>,
        name: impl Into<String>,
        parent_token: impl Into<String>,
    ) -> Self {
        Self {
            refer_entity: ReferEntity {
                entity_type: file_type.into(),
                token: file_token.into(),
            },
            name: name.into(),
            parent_token: parent_token.into(),
        }
    }
}

/// 创建文件快捷方式响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFileShortcutRespData {
    /// 快捷方式token
    pub token: String,
    /// 快捷方式链接
    pub url: String,
}

impl ApiResponseTrait for CreateFileShortcutRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 搜索文件请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SearchFilesRequest {
    /// 搜索关键词
    pub search_key: String,
    /// 返回数量
    pub count: Option<i32>,
    /// 偏移量
    pub offset: Option<i32>,
    /// 所有者ID列表
    pub owner_ids: Option<Vec<String>>,
}

impl SearchFilesRequest {
    pub fn new(search_key: impl Into<String>) -> Self {
        Self {
            search_key: search_key.into(),
            count: None,
            offset: None,
            owner_ids: None,
        }
    }

    pub fn with_count(mut self, count: i32) -> Self {
        self.count = Some(count);
        self
    }

    pub fn with_offset(mut self, offset: i32) -> Self {
        self.offset = Some(offset);
        self
    }

    pub fn with_owner_ids(mut self, owner_ids: Vec<String>) -> Self {
        self.owner_ids = Some(owner_ids);
        self
    }
}

/// 搜索文件响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SearchFilesRespData {
    /// 搜索结果文件列表
    pub files: Vec<SearchFileItem>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SearchFileItem {
    /// 文件token
    pub token: String,
    /// 文件名称
    pub name: String,
    /// 文件类型
    #[serde(rename = "type")]
    pub file_type: String,
    /// 文件链接
    pub url: String,
    /// 拥有者ID
    pub owner_id: String,
}

impl ApiResponseTrait for SearchFilesRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 分片上传文件-预上传请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileUploadPrepareRequest {
    /// 文件名称
    pub file_name: String,
    /// 父文件夹token
    pub parent_token: String,
    /// 文件大小
    pub size: i64,
    /// 分片大小(可选)
    pub block_size: Option<i32>,
    /// 文件校验和(可选)
    pub checksum: Option<String>,
}

impl FileUploadPrepareRequest {
    pub fn new(file_name: impl Into<String>, parent_token: impl Into<String>, size: i64) -> Self {
        Self {
            file_name: file_name.into(),
            parent_token: parent_token.into(),
            size,
            block_size: None,
            checksum: None,
        }
    }

    pub fn with_block_size(mut self, block_size: i32) -> Self {
        self.block_size = Some(block_size);
        self
    }

    pub fn with_checksum(mut self, checksum: impl Into<String>) -> Self {
        self.checksum = Some(checksum.into());
        self
    }
}

/// 分片上传文件-预上传响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileUploadPrepareRespData {
    /// 上传事务ID
    pub upload_id: String,
    /// 分片大小
    pub block_size: i32,
    /// 分片数量
    pub block_num: i32,
}

impl ApiResponseTrait for FileUploadPrepareRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 分片上传文件-上传分片请求参数
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FileUploadPartRequest {
    /// 请求体
    #[serde(skip)]
    pub api_req: ApiRequest,
    /// 上传事务ID
    upload_id: String,
    /// 分片序号
    seq: i32,
    /// 分片大小
    size: i32,
    /// 分片校验和(可选)
    checksum: Option<String>,
}

impl FileUploadPartRequest {
    pub fn builder() -> FileUploadPartRequestBuilder {
        FileUploadPartRequestBuilder::default()
    }
}

/// 分片上传文件-上传分片请求构建器
#[derive(Default)]
pub struct FileUploadPartRequestBuilder {
    request: FileUploadPartRequest,
}

impl FileUploadPartRequestBuilder {
    pub fn upload_id(mut self, upload_id: impl Into<String>) -> Self {
        self.request.upload_id = upload_id.into();
        self
    }

    pub fn seq(mut self, seq: i32) -> Self {
        self.request.seq = seq;
        self
    }

    pub fn size(mut self, size: i32) -> Self {
        self.request.size = size;
        self
    }

    pub fn checksum(mut self, checksum: impl Into<String>) -> Self {
        self.request.checksum = Some(checksum.into());
        self
    }

    pub fn file_chunk(mut self, chunk: Vec<u8>) -> Self {
        self.request.api_req.file = chunk;
        self
    }

    pub fn build(mut self) -> FileUploadPartRequest {
        self.request.api_req.body = serde_json::to_vec(&self.request).unwrap();
        self.request
    }
}

impl_executable_builder_owned!(
    FileUploadPartRequestBuilder,
    FileService,
    FileUploadPartRequest,
    BaseResponse<FileUploadPartRespData>,
    upload_part
);

/// 分片上传文件-上传分片响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileUploadPartRespData {
    /// 分片ETag
    pub etag: String,
}

impl ApiResponseTrait for FileUploadPartRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 分片上传文件-完成上传请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileUploadFinishRequest {
    /// 上传事务ID
    pub upload_id: String,
    /// 分片信息列表
    pub block_infos: Vec<FileBlockInfo>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileBlockInfo {
    /// 分片ETag
    pub etag: String,
    /// 分片序号
    pub seq: i32,
}

impl FileUploadFinishRequest {
    pub fn new(upload_id: impl Into<String>, block_infos: Vec<FileBlockInfo>) -> Self {
        Self {
            upload_id: upload_id.into(),
            block_infos,
        }
    }
}

/// 分片上传文件-完成上传响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileUploadFinishRespData {
    /// 文件token
    pub file_token: String,
}

impl ApiResponseTrait for FileUploadFinishRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 创建导入任务请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateImportTaskRequest {
    /// 导入文件的token
    pub file_extension: String,
    /// 导入文件类型
    pub file_token: String,
    /// 导入文件类型
    #[serde(rename = "type")]
    pub import_type: String,
    /// 导入的目标文件夹token
    pub parent_token: String,
    /// 导入的文件名称
    pub file_name: String,
    /// 导入点类型
    pub parent_type: String,
}

impl CreateImportTaskRequest {
    pub fn new(
        file_extension: impl Into<String>,
        file_token: impl Into<String>,
        import_type: impl Into<String>,
        parent_token: impl Into<String>,
        file_name: impl Into<String>,
        parent_type: impl Into<String>,
    ) -> Self {
        Self {
            file_extension: file_extension.into(),
            file_token: file_token.into(),
            import_type: import_type.into(),
            parent_token: parent_token.into(),
            file_name: file_name.into(),
            parent_type: parent_type.into(),
        }
    }
}

/// 创建导入任务响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateImportTaskRespData {
    /// 导入任务ID
    pub ticket: String,
}

impl ApiResponseTrait for CreateImportTaskRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 查询导入任务结果请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetImportTaskRequest {
    /// 导入任务ID
    pub ticket: String,
}

impl GetImportTaskRequest {
    pub fn new(ticket: impl Into<String>) -> Self {
        Self {
            ticket: ticket.into(),
        }
    }
}

/// 查询导入任务结果响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetImportTaskRespData {
    /// 任务结果
    pub result: ImportTaskResult,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ImportTaskResult {
    /// 任务类型
    #[serde(rename = "type")]
    pub task_type: String,
    /// 任务ID
    pub ticket: String,
    /// 任务状态
    pub job_status: i32,
    /// 任务错误码
    pub job_error_msg: Option<String>,
    /// 导入结果
    pub token: Option<String>,
    /// 导入结果类型
    pub url: Option<String>,
}

impl ApiResponseTrait for GetImportTaskRespData {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}