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
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
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::*, EndpointBuilder},
    http::Transport,
    req_option::RequestOption,
    SDKResult,
};

use super::batch_create::Permission;

/// 移除协作者权限请求
#[derive(Debug, Serialize, Default, Clone)]
pub struct DeletePermissionMemberRequest {
    #[serde(skip)]
    api_request: ApiRequest,
    /// 文档token
    #[serde(skip)]
    token: String,
    /// 文档类型
    #[serde(skip)]
    obj_type: String,
    /// 协作者ID类型
    #[serde(skip)]
    member_type: String,
    /// 协作者ID
    #[serde(skip)]
    member_id: String,
    /// 是否通知
    #[serde(skip_serializing_if = "Option::is_none")]
    need_notification: Option<bool>,
}

impl DeletePermissionMemberRequest {
    pub fn builder() -> DeletePermissionMemberRequestBuilder {
        DeletePermissionMemberRequestBuilder::default()
    }

    pub fn new(
        token: impl ToString,
        obj_type: impl ToString,
        member_type: impl ToString,
        member_id: impl ToString,
    ) -> Self {
        Self {
            token: token.to_string(),
            obj_type: obj_type.to_string(),
            member_type: member_type.to_string(),
            member_id: member_id.to_string(),
            ..Default::default()
        }
    }

    /// 移除用户权限
    pub fn for_user(token: impl ToString, obj_type: impl ToString, user_id: impl ToString) -> Self {
        Self::new(token, obj_type, "user", user_id)
    }

    /// 移除群组权限
    pub fn for_chat(token: impl ToString, obj_type: impl ToString, chat_id: impl ToString) -> Self {
        Self::new(token, obj_type, "chat", chat_id)
    }

    /// 移除部门权限
    pub fn for_department(
        token: impl ToString,
        obj_type: impl ToString,
        department_id: impl ToString,
    ) -> Self {
        Self::new(token, obj_type, "department", department_id)
    }
}

#[derive(Default)]
pub struct DeletePermissionMemberRequestBuilder {
    request: DeletePermissionMemberRequest,
}

impl DeletePermissionMemberRequestBuilder {
    /// 文档token
    pub fn token(mut self, token: impl ToString) -> Self {
        self.request.token = token.to_string();
        self
    }

    /// 文档类型
    pub fn obj_type(mut self, obj_type: impl ToString) -> Self {
        self.request.obj_type = obj_type.to_string();
        self
    }

    /// 设置为文档类型
    pub fn as_doc(mut self) -> Self {
        self.request.obj_type = "doc".to_string();
        self
    }

    /// 设置为电子表格类型
    pub fn as_sheet(mut self) -> Self {
        self.request.obj_type = "sheet".to_string();
        self
    }

    /// 设置为多维表格类型
    pub fn as_bitable(mut self) -> Self {
        self.request.obj_type = "bitable".to_string();
        self
    }

    /// 设置为知识库类型
    pub fn as_wiki(mut self) -> Self {
        self.request.obj_type = "wiki".to_string();
        self
    }

    /// 协作者类型和ID
    pub fn member(mut self, member_type: impl ToString, member_id: impl ToString) -> Self {
        self.request.member_type = member_type.to_string();
        self.request.member_id = member_id.to_string();
        self
    }

    /// 用户协作者
    pub fn user(mut self, user_id: impl ToString) -> Self {
        self.request.member_type = "user".to_string();
        self.request.member_id = user_id.to_string();
        self
    }

    /// 群组协作者
    pub fn chat(mut self, chat_id: impl ToString) -> Self {
        self.request.member_type = "chat".to_string();
        self.request.member_id = chat_id.to_string();
        self
    }

    /// 部门协作者
    pub fn department(mut self, department_id: impl ToString) -> Self {
        self.request.member_type = "department".to_string();
        self.request.member_id = department_id.to_string();
        self
    }

    /// 是否通知
    pub fn need_notification(mut self, need: bool) -> Self {
        self.request.need_notification = Some(need);
        self
    }

    /// 启用通知
    pub fn with_notification(mut self) -> Self {
        self.request.need_notification = Some(true);
        self
    }

    /// 禁用通知
    pub fn without_notification(mut self) -> Self {
        self.request.need_notification = Some(false);
        self
    }

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

/// 协作者删除结果
#[derive(Debug, Deserialize)]
pub struct PermissionMemberDeleted {
    /// 协作者ID类型
    pub member_type: String,
    /// 协作者ID
    pub member_id: String,
    /// 删除时间(毫秒时间戳)
    pub delete_time: Option<i64>,
    /// 删除前的权限(如果有)
    pub old_perm: Option<Permission>,
    /// 是否通知了用户
    pub notified: Option<bool>,
}

/// 移除协作者权限响应
#[derive(Debug, Deserialize)]
pub struct DeletePermissionMemberResponse {
    /// 协作者信息
    pub member: PermissionMemberDeleted,
}

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

/// 移除协作者权限
pub async fn delete_permission_member(
    request: DeletePermissionMemberRequest,
    config: &Config,
    option: Option<RequestOption>,
) -> SDKResult<BaseResponse<DeletePermissionMemberResponse>> {
    let mut api_req = request.api_request;
    api_req.http_method = Method::DELETE;
    api_req.api_path = format!(
        "{}?type={}&member_type={}",
        EndpointBuilder::replace_params_from_array(
            DRIVE_V1_PERMISSIONS_MEMBER_GET,
            &[("token", &request.token), ("member_id", &request.member_id)]
        ),
        request.obj_type,
        request.member_type
    );

    // 添加通知参数
    if let Some(need_notification) = request.need_notification {
        api_req.api_path = format!(
            "{}&need_notification={}",
            api_req.api_path, need_notification
        );
    }

    api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];

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

impl PermissionMemberDeleted {
    /// 获取成员ID
    pub fn member_id(&self) -> &str {
        &self.member_id
    }

    /// 获取成员类型
    pub fn member_type(&self) -> &str {
        &self.member_type
    }

    /// 获取删除前的权限
    pub fn old_permission(&self) -> Option<&Permission> {
        self.old_perm.as_ref()
    }

    /// 是否是用户
    pub fn is_user(&self) -> bool {
        self.member_type == "user"
    }

    /// 是否是群组
    pub fn is_chat(&self) -> bool {
        self.member_type == "chat"
    }

    /// 是否是部门
    pub fn is_department(&self) -> bool {
        self.member_type == "department"
    }

    /// 是否通知了用户
    pub fn was_notified(&self) -> bool {
        self.notified.unwrap_or(false)
    }

    /// 是否有删除时间
    pub fn has_delete_time(&self) -> bool {
        self.delete_time.is_some()
    }

    /// 是否有原权限信息
    pub fn has_old_permission(&self) -> bool {
        self.old_perm.is_some()
    }

    /// 原权限是否是所有者
    pub fn was_owner(&self) -> bool {
        if let Some(old_perm) = &self.old_perm {
            old_perm.is_owner()
        } else {
            false
        }
    }

    /// 原权限是否有编辑权限
    pub fn could_edit(&self) -> bool {
        if let Some(old_perm) = &self.old_perm {
            old_perm.can_edit()
        } else {
            false
        }
    }

    /// 获取删除时间的格式化字符串
    pub fn delete_time_formatted(&self) -> Option<String> {
        self.delete_time
            .map(|timestamp| format!("删除时间: {timestamp}"))
    }

    /// 获取成员类型描述
    pub fn member_type_description(&self) -> String {
        match self.member_type.as_str() {
            "user" => "用户".to_string(),
            "chat" => "群组".to_string(),
            "department" => "部门".to_string(),
            _ => "未知".to_string(),
        }
    }

    /// 获取原权限描述
    pub fn old_permission_description(&self) -> Option<String> {
        self.old_perm
            .as_ref()
            .map(|perm| perm.description().to_string())
    }

    /// 获取摘要信息
    pub fn summary(&self) -> String {
        let mut parts = vec![format!(
            "{} ({})",
            self.member_id,
            self.member_type_description()
        )];

        if let Some(old_perm_desc) = self.old_permission_description() {
            parts.push(format!("原权限: {old_perm_desc}"));
        }

        if let Some(time) = self.delete_time_formatted() {
            parts.push(time);
        }

        if self.was_notified() {
            parts.push("已通知".to_string());
        }

        parts.join(", ")
    }
}

impl DeletePermissionMemberResponse {
    /// 获取协作者ID
    pub fn member_id(&self) -> &str {
        self.member.member_id()
    }

    /// 获取协作者类型
    pub fn member_type(&self) -> &str {
        self.member.member_type()
    }

    /// 获取删除前的权限
    pub fn old_permission(&self) -> Option<&Permission> {
        self.member.old_permission()
    }

    /// 是否删除成功
    pub fn is_deleted(&self) -> bool {
        !self.member.member_id.is_empty()
    }

    /// 获取删除成功摘要
    pub fn success_summary(&self) -> String {
        format!("协作者权限移除成功: {}", self.member.summary())
    }

    /// 是否通知了用户
    pub fn was_notified(&self) -> bool {
        self.member.was_notified()
    }

    /// 删除的是否是所有者
    pub fn deleted_owner(&self) -> bool {
        self.member.was_owner()
    }

    /// 删除的是否有编辑权限
    pub fn deleted_editor(&self) -> bool {
        self.member.could_edit()
    }

    /// 获取删除时间
    pub fn delete_time(&self) -> Option<i64> {
        self.member.delete_time
    }

    /// 操作风险级别(基于删除的权限)
    pub fn risk_level(&self) -> &'static str {
        if self.deleted_owner() {
            "高风险" // 删除所有者
        } else if self.deleted_editor() {
            "中风险" // 删除编辑者
        } else {
            "低风险" // 删除查看者或评论者
        }
    }
}

#[cfg(test)]
#[allow(unused_variables, unused_unsafe)]
mod tests {
    use super::*;

    #[test]
    fn test_delete_permission_member_request_builder() {
        let request = DeletePermissionMemberRequest::builder()
            .token("doccnxxxxxx")
            .as_doc()
            .user("user123")
            .with_notification()
            .build();

        assert_eq!(request.token, "doccnxxxxxx");
        assert_eq!(request.obj_type, "doc");
        assert_eq!(request.member_type, "user");
        assert_eq!(request.member_id, "user123");
        assert_eq!(request.need_notification, Some(true));
    }

    #[test]
    fn test_delete_permission_member_convenience_methods() {
        let request = DeletePermissionMemberRequest::for_user("doccnxxxxxx", "doc", "user123");
        assert_eq!(request.member_type, "user");
        assert_eq!(request.member_id, "user123");

        let request = DeletePermissionMemberRequest::for_chat("doccnxxxxxx", "doc", "chat456");
        assert_eq!(request.member_type, "chat");
        assert_eq!(request.member_id, "chat456");

        let request =
            DeletePermissionMemberRequest::for_department("doccnxxxxxx", "doc", "dept789");
        assert_eq!(request.member_type, "department");
        assert_eq!(request.member_id, "dept789");
    }

    #[test]
    fn test_permission_member_deleted_methods() {
        let member = PermissionMemberDeleted {
            member_type: "user".to_string(),
            member_id: "user123".to_string(),
            delete_time: Some(1234567890),
            old_perm: Some(Permission::Edit),
            notified: Some(true),
        };

        assert!(member.is_user());
        assert!(!member.is_chat());
        assert!(!member.is_department());
        assert!(member.was_notified());
        assert!(member.has_delete_time());
        assert!(member.has_old_permission());
        assert!(!member.was_owner());
        assert!(member.could_edit());
        assert_eq!(member.member_type_description(), "用户");
        assert_eq!(
            member.old_permission_description(),
            Some("编辑者".to_string())
        );
    }

    #[test]
    fn test_delete_permission_member_response_risk_level() {
        let response_owner = DeletePermissionMemberResponse {
            member: PermissionMemberDeleted {
                member_type: "user".to_string(),
                member_id: "user123".to_string(),
                delete_time: Some(1234567890),
                old_perm: Some(Permission::FullAccess),
                notified: Some(true),
            },
        };
        assert_eq!(response_owner.risk_level(), "高风险");

        let response_editor = DeletePermissionMemberResponse {
            member: PermissionMemberDeleted {
                member_type: "user".to_string(),
                member_id: "user123".to_string(),
                delete_time: Some(1234567890),
                old_perm: Some(Permission::Edit),
                notified: Some(true),
            },
        };
        assert_eq!(response_editor.risk_level(), "中风险");

        let response_viewer = DeletePermissionMemberResponse {
            member: PermissionMemberDeleted {
                member_type: "user".to_string(),
                member_id: "user123".to_string(),
                delete_time: Some(1234567890),
                old_perm: Some(Permission::View),
                notified: Some(true),
            },
        };
        assert_eq!(response_viewer.risk_level(), "低风险");
    }
}