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

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

pub struct PermissionsService {
    config: Config,
}

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

    /// 获取云文档权限设置
    pub async fn get(
        &self,
        request: GetPermissionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GetPermissionResponse>> {
        let mut api_req = request.api_request;
        api_req.http_method = Method::GET;
        api_req.api_path = format!("/open-apis/drive/v2/permissions/{}/public", request.token);
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];

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

        Ok(api_resp)
    }

    /// 更新云文档权限设置
    pub async fn patch(
        &self,
        request: PatchPermissionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GetPermissionResponse>> {
        let mut api_req = request.api_request;
        api_req.http_method = Method::PATCH;
        api_req.api_path = format!("/open-apis/drive/v2/permissions/{}/public", request.token);
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];

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

        Ok(api_resp)
    }
}

/// 获取云文档权限设置
#[derive(Debug, Default)]
pub struct GetPermissionRequest {
    api_request: ApiRequest,
    /// 文件的 token
    token: String,
    /// 文件类型,需要与文件的 token 相匹配
    ///
    /// 示例值:"doc"
    ///
    /// 可选值有:
    ///
    /// - doc:旧版文档
    /// - sheet:电子表格
    /// - file:云空间文件
    /// - wiki:知识库节点
    /// - bitable:多维表格
    /// - docx:新版文档
    /// - mindnote:思维笔记
    /// - minutes:妙记
    /// - slides:幻灯片
    r#type: String,
}

impl GetPermissionRequest {
    pub fn builder() -> GetPermissionRequestBuilder {
        GetPermissionRequestBuilder::default()
    }
}

#[derive(Default)]
pub struct GetPermissionRequestBuilder {
    request: GetPermissionRequest,
}

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

    /// 文件类型,需要与文件的 token 相匹配
    ///
    /// 示例值:"doc"
    ///
    /// 可选值有:
    ///
    /// - doc:旧版文档
    /// - sheet:电子表格
    /// - file:云空间文件
    /// - wiki:知识库节点
    /// - bitable:多维表格
    /// - docx:新版文档
    /// - mindnote:思维笔记
    /// - minutes:妙记
    /// - slides:幻灯片
    pub fn r#type(mut self, r#type: impl ToString) -> Self {
        self.request.r#type = r#type.to_string();
        self.request
            .api_request
            .query_params
            .insert("type".to_string(), r#type.to_string());
        self
    }

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

/// 返回的文档公共设置
#[derive(Debug, Deserialize)]
pub struct GetPermissionResponse {
    /// 返回的文档公共设置
    pub permission_public: PermissionPublic,
}

impl ApiResponseTrait for GetPermissionResponse {
    fn data_format() -> crate::core::api_resp::ResponseFormat {
        crate::core::api_resp::ResponseFormat::Data
    }
}

#[derive(Debug, Deserialize)]
/// 返回的文档公共设置
pub struct PermissionPublic {
    /// 允许内容被分享到组织外
    ///
    /// 可选值有:
    ///
    /// - open:打开
    /// - closed:关闭
    /// - allow_share_partner_tenant:允许分享给关联组织
    pub external_access_entity: Option<String>,
    /// 谁可以创建副本、打印、下载
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    /// - only_full_access:拥有可管理权限(包括我)的用户
    pub security_entity: Option<String>,
    /// 谁可以评论
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    pub comment_entity: Option<String>,
    /// 谁可以添加和管理协作者-组织维度
    ///
    /// 可选值有:
    ///
    /// - anyone:所有可阅读或编辑此文档的用户
    /// - same_tenant:组织内所有可阅读或编辑此文档的用户
    pub share_entity: Option<String>,
    /// 谁可以添加和管理协作者-协作者维度
    ///
    /// 可选值有:
    ///
    /// - collaborator_can_view:拥有可阅读权限的协作者
    /// - collaborator_can_edit:拥有可编辑权限的协作者
    /// - collaborator_full_access:拥有可管理权限(包括我)的协作者
    pub manage_collaborator_entity: Option<String>,
    /// 链接分享设置
    ///
    /// 可选值有:
    ///
    /// - tenant_readable:组织内获得链接的人可阅读
    /// - tenant_editable:组织内获得链接的人可编辑
    /// - partner_tenant_readable:关联组织的人可阅读
    /// - partner_tenant_editable:关联组织的人可编辑
    /// - anyone_readable:互联网上获得链接的任何人可阅读(仅external_access=“open”时有效)
    /// - anyone_editable:互联网上获得链接的任何人可编辑(仅external_access=“open”时有效)
    /// - closed:关闭链接分享
    pub link_share_entity: Option<String>,
    /// 谁可以复制内容
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    /// - only_full_access:拥有可管理权限(包括我)的协作者
    pub copy_entity: Option<String>,
    /// 节点是否已加锁,加锁之后不再继承父级页面的权限
    pub lock_switch: Option<bool>,
}

#[derive(Debug, Default, Serialize)]
pub struct PatchPermissionRequest {
    #[serde(skip)]
    api_request: ApiRequest,
    /// 文件的 token
    #[serde(skip)]
    token: String,
    /// 允许内容被分享到组织外
    ///
    /// 示例值:"open"
    ///
    /// 可选值有:
    ///
    /// - open:打开
    /// - closed:关闭
    /// - allow_share_partner_tenant:允许分享给关联组织(只有租户后台设置仅允许关联组织分享,
    ///   才能设置为该值)
    #[serde(skip_serializing_if = "Option::is_none")]
    external_access_entity: Option<String>,
    /// 谁可以创建副本、打印、下载
    ///
    /// 示例值:"anyone_can_view"
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    /// - only_full_access:拥有可管理权限(包括我)的用户
    #[serde(skip_serializing_if = "Option::is_none")]
    security_entity: Option<String>,
    /// 谁可以评论
    ///
    /// 示例值:"anyone_can_view"
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    #[serde(skip_serializing_if = "Option::is_none")]
    comment_entity: Option<String>,
    /// 谁可以添加和管理协作者-组织维度
    ///
    /// 示例值:"anyone"
    ///
    /// 可选值有:
    ///
    /// - anyone:所有可阅读或编辑此文档的用户
    /// - same_tenant:组织内所有可阅读或编辑此文档的用户
    #[serde(skip_serializing_if = "Option::is_none")]
    share_entity: Option<String>,
    /// 谁可以添加和管理协作者-协作者维度
    ///
    /// 示例值:"collaborator_can_view"
    ///
    /// 可选值有:
    ///
    /// - collaborator_can_view:拥有可阅读权限的协作者
    /// - collaborator_can_edit:拥有可编辑权限的协作者
    /// - collaborator_full_access:拥有可管理权限(包括我)的协作者
    #[serde(skip_serializing_if = "Option::is_none")]
    manage_collaborator_entity: Option<String>,
    /// 链接分享设置
    ///
    /// 示例值:"tenant_readable"
    ///
    /// 可选值有:
    ///
    /// tenant_readable:组织内获得链接的人可阅读
    /// tenant_editable:组织内获得链接的人可编辑
    /// partner_tenant_readable:关联组织的人可阅读(只有租户后台设置仅允许关联组织分享,
    /// 才能设置为该值) partner_tenant_editable:
    /// 关联组织的人可编辑(只有租户后台设置仅允许关联组织分享,才能设置为该值)
    /// anyone_readable:互联网上获得链接的任何人可阅读(仅external_access_entity=“open”时有效)
    /// anyone_editable:互联网上获得链接的任何人可编辑(仅external_access_entity=“open”时有效)
    /// closed:关闭链接分享
    #[serde(skip_serializing_if = "Option::is_none")]
    link_share_entity: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    copy_entity: Option<String>,
}

impl PatchPermissionRequest {
    pub fn builder() -> PatchPermissionRequestBuilder {
        PatchPermissionRequestBuilder::default()
    }
}

#[derive(Default)]
pub struct PatchPermissionRequestBuilder {
    request: PatchPermissionRequest,
}

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

    /// 文件类型,需要与文件的 token 相匹配
    ///
    /// 示例值:"doc"
    ///
    /// 可选值有:
    ///
    /// - doc:旧版文档
    /// - sheet:电子表格
    /// - file:云空间文件
    /// - wiki:知识库节点
    /// - bitable:多维表格
    /// - docx:新版文档
    /// - mindnote:思维笔记
    /// - minutes:妙记
    /// - slides:幻灯片
    pub fn r#type(mut self, r#type: impl ToString) -> Self {
        self.request
            .api_request
            .query_params
            .insert("type".to_string(), r#type.to_string());
        self
    }

    /// 允许内容被分享到组织外
    ///
    /// 示例值:"open"
    ///
    /// 可选值有:
    ///
    /// - open:打开
    /// - closed:关闭
    /// - allow_share_partner_tenant:允许分享给关联组织(只有租户后台设置仅允许关联组织分享,
    ///   才能设置为该值)
    pub fn external_access_entity(mut self, external_access_entity: impl ToString) -> Self {
        self.request.external_access_entity = Some(external_access_entity.to_string());
        self
    }

    /// 谁可以创建副本、打印、下载
    ///
    /// 示例值:"anyone_can_view"
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    /// - only_full_access:拥有可管理权限(包括我)的用户
    pub fn security_entity(mut self, security_entity: impl ToString) -> Self {
        self.request.security_entity = Some(security_entity.to_string());
        self
    }

    /// 谁可以评论
    ///
    /// 示例值:"anyone_can_view"
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    pub fn comment_entity(mut self, comment_entity: impl ToString) -> Self {
        self.request.comment_entity = Some(comment_entity.to_string());
        self
    }

    /// 谁可以添加和管理协作者-组织维度
    ///
    /// 示例值:"anyone"
    ///
    /// 可选值有:
    ///
    /// - anyone:所有可阅读或编辑此文档的用户
    /// - same_tenant:组织内所有可阅读或编辑此文档的用户
    pub fn share_entity(mut self, share_entity: impl ToString) -> Self {
        self.request.share_entity = Some(share_entity.to_string());
        self
    }

    /// 谁可以添加和管理协作者-协作者维度
    ///
    /// 示例值:"collaborator_can_view"
    ///
    /// 可选值有:
    ///
    /// - collaborator_can_view:拥有可阅读权限的协作者
    /// - collaborator_can_edit:拥有可编辑权限的协作者
    /// - collaborator_full_access:拥有可管理权限(包括我)的协作者
    pub fn manage_collaborator_entity(mut self, manage_collaborator_entity: impl ToString) -> Self {
        self.request.manage_collaborator_entity = Some(manage_collaborator_entity.to_string());
        self
    }

    /// 链接分享设置
    ///
    /// 示例值:"tenant_readable"
    ///
    /// 可选值有:
    ///
    /// tenant_readable:组织内获得链接的人可阅读
    /// tenant_editable:组织内获得链接的人可编辑
    /// partner_tenant_readable:关联组织的人可阅读(只有租户后台设置仅允许关联组织分享,
    /// 才能设置为该值) partner_tenant_editable:
    /// 关联组织的人可编辑(只有租户后台设置仅允许关联组织分享,才能设置为该值)
    /// anyone_readable:互联网上获得链接的任何人可阅读(仅external_access_entity=“open”时有效)
    /// anyone_editable:互联网上获得链接的任何人可编辑(仅external_access_entity=“open”时有效)
    /// closed:关闭链接分享
    pub fn link_share_entity(mut self, link_share_entity: impl ToString) -> Self {
        self.request.link_share_entity = Some(link_share_entity.to_string());
        self
    }

    /// 谁可以复制内容
    ///
    /// 可选值有:
    ///
    /// - anyone_can_view:拥有可阅读权限的用户
    /// - anyone_can_edit:拥有可编辑权限的用户
    /// - only_full_access:拥有可管理权限(包括我)的协作者
    pub fn copy_entity(mut self, copy_entity: impl ToString) -> Self {
        self.request.copy_entity = Some(copy_entity.to_string());
        self
    }

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

impl_executable_builder_owned!(
    GetPermissionRequestBuilder,
    PermissionsService,
    GetPermissionRequest,
    BaseResponse<GetPermissionResponse>,
    get
);

impl_executable_builder_owned!(
    PatchPermissionRequestBuilder,
    PermissionsService,
    PatchPermissionRequest,
    BaseResponse<GetPermissionResponse>,
    patch
);