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

use crate::{
    core::{
        api_req::ApiRequest,
        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
        config::Config,
        constants::AccessTokenType,
        endpoints::{EndpointBuilder, Endpoints},
        http::Transport,
        query_params::QueryParams,
        req_option::RequestOption,
        SDKResult,
    },
    service::trust_party::models::{
        CollaborationDepartment, CollaborationOrganization, CollaborationUser,
        OrganizationStructure, PageResponse, SharedMemberScope,
    },
};

/// 关联组织管理服务
pub struct CollaborationOrganizationService {
    pub config: Config,
}

impl CollaborationOrganizationService {
    /// 创建关联组织管理服务实例
    pub fn new(config: Config) -> Self {
        Self { config }
    }

    /// 获取可见关联组织的列表
    ///
    /// 获取当前用户可见的关联组织列表,支持分页查询。
    ///
    /// # Arguments
    ///
    /// * `request` - 组织列表查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回关联组织列表
    pub async fn list_organizations(
        &self,
        request: OrganizationListRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<OrganizationListResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: Endpoints::TRUST_PARTY_V1_COLLABORATION_ORGANIZATIONS.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert(QueryParams::PAGE_TOKEN, page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert(QueryParams::PAGE_SIZE, page_size.to_string());
        }

        Transport::request(api_req, &self.config, option).await
    }

    /// 获取关联组织的部门和成员信息
    ///
    /// 获取指定关联组织的组织架构信息,包括部门和成员。
    ///
    /// # Arguments
    ///
    /// * `org_id` - 关联组织ID
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回组织架构信息
    pub async fn get_organization_structure(
        &self,
        org_id: &str,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<OrganizationStructureResponse>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_param(
                Endpoints::TRUST_PARTY_V1_COLLABORATION_ORGANIZATION_VISIBLE,
                "org_id",
                org_id,
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 获取关联组织详情
    ///
    /// 获取指定关联组织的详细信息。
    ///
    /// # Arguments
    ///
    /// * `org_id` - 关联组织ID
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回关联组织详情
    pub async fn get_organization(
        &self,
        org_id: &str,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<OrganizationGetResponse>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_param(
                Endpoints::TRUST_PARTY_V1_COLLABORATION_ORGANIZATION_GET,
                "org_id",
                org_id,
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 获取关联组织成员详情
    ///
    /// 获取指定关联组织中指定成员的详细信息。
    ///
    /// # Arguments
    ///
    /// * `org_id` - 关联组织ID
    /// * `user_id` - 成员用户ID
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回成员详情
    pub async fn get_organization_user(
        &self,
        org_id: &str,
        user_id: &str,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<OrganizationUserGetResponse>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::TRUST_PARTY_V1_COLLABORATION_ORGANIZATION_USER_GET,
                &[("org_id", org_id), ("user_id", user_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 获取关联组织部门详情
    ///
    /// 获取指定关联组织中指定部门的详细信息。
    ///
    /// # Arguments
    ///
    /// * `org_id` - 关联组织ID
    /// * `department_id` - 部门ID
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回部门详情
    pub async fn get_organization_department(
        &self,
        org_id: &str,
        department_id: &str,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<OrganizationDepartmentGetResponse>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::TRUST_PARTY_V1_COLLABORATION_ORGANIZATION_DEPARTMENT_GET,
                &[("org_id", org_id), ("department_id", department_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 获取关联组织双方共享成员范围
    ///
    /// 获取与指定关联组织之间的共享成员范围信息。
    ///
    /// # Arguments
    ///
    /// * `org_id` - 关联组织ID
    /// * `request` - 共享成员范围查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回共享成员范围信息
    pub async fn list_shared_member_scope(
        &self,
        org_id: &str,
        request: SharedMemberScopeListRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<SharedMemberScopeListResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_param(
                Endpoints::TRUST_PARTY_V1_COLLABORATION_ORGANIZATION_SHARED_MEMBER_SCOPES,
                "org_id",
                org_id,
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert(QueryParams::PAGE_TOKEN, page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert(QueryParams::PAGE_SIZE, page_size.to_string());
        }

        Transport::request(api_req, &self.config, option).await
    }

    /// 管理员获取所有关联组织列表
    ///
    /// 管理员权限获取所有关联组织的列表,包括不可见的组织。
    ///
    /// # Arguments
    ///
    /// * `request` - 管理员组织列表查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回所有关联组织列表
    pub async fn admin_list_organizations(
        &self,
        request: AdminOrganizationListRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<AdminOrganizationListResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: Endpoints::TRUST_PARTY_V1_COLLABORATION_ORGANIZATIONS_ADMIN.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert(QueryParams::PAGE_TOKEN, page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert(QueryParams::PAGE_SIZE, page_size.to_string());
        }

        if let Some(status) = request.status {
            api_req.query_params.insert(QueryParams::STATUS, status);
        }

        Transport::request(api_req, &self.config, option).await
    }
}

/// 组织列表查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrganizationListRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
}

/// 组织列表查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct OrganizationListResponse {
    /// 关联组织列表
    #[serde(flatten)]
    pub organizations: PageResponse<CollaborationOrganization>,
}

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

/// 组织架构查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct OrganizationStructureResponse {
    /// 组织架构信息
    pub organization_structure: OrganizationStructure,
}

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

/// 组织详情查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct OrganizationGetResponse {
    /// 关联组织详情
    pub organization: CollaborationOrganization,
}

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

/// 组织成员详情查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct OrganizationUserGetResponse {
    /// 成员详情
    pub user: CollaborationUser,
}

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

/// 组织部门详情查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct OrganizationDepartmentGetResponse {
    /// 部门详情
    pub department: CollaborationDepartment,
}

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

/// 共享成员范围列表查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SharedMemberScopeListRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
}

/// 共享成员范围列表查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct SharedMemberScopeListResponse {
    /// 共享成员范围列表
    #[serde(flatten)]
    pub shared_scopes: PageResponse<SharedMemberScope>,
}

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

/// 管理员组织列表查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct AdminOrganizationListRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 组织状态筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
}

/// 管理员组织列表查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct AdminOrganizationListResponse {
    /// 关联组织列表
    #[serde(flatten)]
    pub organizations: PageResponse<CollaborationOrganization>,
}

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