open-lark 0.14.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
use reqwest::Method;
use serde::{Deserialize, Serialize};

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

/// 文档版本服务
pub struct FileVersionService {
    config: Config,
}

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

    /// 创建文档版本
    ///
    /// 该接口用于创建文档版本。
    ///
    /// <https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/create>
    pub async fn create_version(
        &self,
        request: CreateVersionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<CreateVersionRespData>> {
        let mut api_req = ApiRequest {
            http_method: Method::POST,
            api_path: DRIVE_V1_FILE_VERSIONS.replace("{}", &request.file_token),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            ..Default::default()
        };

        let body = serde_json::json!({
            "name": request.name,
            "obj_type": request.obj_type
        });
        api_req.body = serde_json::to_vec(&body)?;

        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-version/delete>
    pub async fn delete_version(
        &self,
        request: DeleteVersionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<DeleteVersionRespData>> {
        let mut api_req = ApiRequest {
            http_method: Method::DELETE,
            api_path: DRIVE_V1_FILE_VERSION_GET
                .replace("{}", &request.file_token)
                .replace("{}", &request.version_id),
            ..Default::default()
        };
        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/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get>
    pub async fn get_version(
        &self,
        request: GetVersionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GetVersionRespData>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: DRIVE_V1_FILE_VERSION_GET
                .replace("{}", &request.file_token)
                .replace("{}", &request.version_id),
            ..Default::default()
        };
        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/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list>
    pub async fn list_versions(
        &self,
        request: ListVersionsRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<ListVersionsRespData>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: DRIVE_V1_FILE_VERSIONS.replace("{}", &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", page_token);
        }
        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert("page_size", page_size.to_string());
        }

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

// === 数据结构定义 ===

/// 创建文档版本请求参数
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreateVersionRequest {
    /// 文档token
    pub file_token: String,
    /// 版本名称
    pub name: String,
    /// 文档类型
    pub obj_type: String,
}

impl CreateVersionRequest {
    pub fn builder() -> CreateVersionRequestBuilder {
        CreateVersionRequestBuilder::default()
    }

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

/// 创建文档版本请求构建器
#[derive(Default)]
pub struct CreateVersionRequestBuilder {
    request: CreateVersionRequest,
}

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

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

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

    pub fn build(self) -> CreateVersionRequest {
        self.request
    }
}

impl_executable_builder_owned!(
    CreateVersionRequestBuilder,
    FileVersionService,
    CreateVersionRequest,
    BaseResponse<CreateVersionRespData>,
    create_version
);

/// 创建文档版本响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateVersionRespData {
    /// 版本ID
    pub version_id: String,
    /// 版本名称
    pub name: String,
    /// 版本创建时间
    pub create_time: String,
    /// 创建者ID
    pub creator_id: String,
}

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

/// 删除文档版本请求参数
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DeleteVersionRequest {
    /// 文档token
    pub file_token: String,
    /// 版本ID
    pub version_id: String,
}

impl DeleteVersionRequest {
    pub fn builder() -> DeleteVersionRequestBuilder {
        DeleteVersionRequestBuilder::default()
    }

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

/// 删除文档版本请求构建器
#[derive(Default)]
pub struct DeleteVersionRequestBuilder {
    request: DeleteVersionRequest,
}

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

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

    pub fn build(self) -> DeleteVersionRequest {
        self.request
    }
}

impl_executable_builder_owned!(
    DeleteVersionRequestBuilder,
    FileVersionService,
    DeleteVersionRequest,
    BaseResponse<DeleteVersionRespData>,
    delete_version
);

/// 删除文档版本响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeleteVersionRespData {
    /// 删除结果
    pub success: bool,
}

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

/// 获取文档版本请求参数
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct GetVersionRequest {
    /// 文档token
    pub file_token: String,
    /// 版本ID
    pub version_id: String,
}

impl GetVersionRequest {
    pub fn builder() -> GetVersionRequestBuilder {
        GetVersionRequestBuilder::default()
    }

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

/// 获取文档版本请求构建器
#[derive(Default)]
pub struct GetVersionRequestBuilder {
    request: GetVersionRequest,
}

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

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

    pub fn build(self) -> GetVersionRequest {
        self.request
    }
}

impl_executable_builder_owned!(
    GetVersionRequestBuilder,
    FileVersionService,
    GetVersionRequest,
    BaseResponse<GetVersionRespData>,
    get_version
);

/// 获取文档版本响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetVersionRespData {
    /// 版本信息
    pub version: FileVersion,
}

/// 获取文档版本列表请求参数
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ListVersionsRequest {
    /// 文档token
    pub file_token: String,
    /// 分页token
    pub page_token: Option<String>,
    /// 分页大小
    pub page_size: Option<i32>,
}

impl ListVersionsRequest {
    pub fn builder() -> ListVersionsRequestBuilder {
        ListVersionsRequestBuilder::default()
    }

    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(Default)]
pub struct ListVersionsRequestBuilder {
    request: ListVersionsRequest,
}

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

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

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

    pub fn build(self) -> ListVersionsRequest {
        self.request
    }
}

impl_executable_builder_owned!(
    ListVersionsRequestBuilder,
    FileVersionService,
    ListVersionsRequest,
    BaseResponse<ListVersionsRespData>,
    list_versions
);

/// 获取文档版本列表响应数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListVersionsRespData {
    /// 是否还有更多数据
    pub has_more: bool,
    /// 下一页token
    pub page_token: Option<String>,
    /// 版本列表
    pub items: Vec<FileVersion>,
}

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

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

/// 文档版本信息
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileVersion {
    /// 版本ID
    pub version_id: String,
    /// 版本名称
    pub name: String,
    /// 文档token
    pub obj_token: String,
    /// 文档类型
    pub obj_type: String,
    /// 创建者ID
    pub creator_id: String,
    /// 创建时间
    pub create_time: String,
    /// 版本状态
    pub status: String,
    /// 版本父ID
    pub parent_version_id: Option<String>,
}