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
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,
        req_option::RequestOption,
        SDKResult,
    },
    service::apass::models::{
        FlowExecuteRequest, FlowExecuteResult, PageResponse, RollbackPoint, UserTask,
        UserTaskActionRequest, UserTaskAddAssigneeRequest, UserTaskCcRequest,
        UserTaskChatGroupRequest, UserTaskQueryRequest, UserTaskRollbackRequest,
        UserTaskTransferRequest,
    },
};

/// 流程管理服务
pub struct FlowService {
    pub config: Config,
}

/// 流程执行响应
#[derive(Debug, Serialize, Deserialize)]
pub struct FlowExecuteResponse {
    /// 流程执行结果
    #[serde(flatten)]
    pub execute_result: FlowExecuteResult,
}

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

/// 人工任务查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct UserTaskQueryResponse {
    /// 分页响应数据
    #[serde(flatten)]
    pub page_response: PageResponse<UserTask>,
}

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

/// 人工任务操作成功响应
#[derive(Debug, Serialize, Deserialize)]
pub struct UserTaskActionResponse {
    /// 操作是否成功
    #[serde(skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
    /// 操作消息
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

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

/// 退回位置查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct UserTaskRollbackPointsResponse {
    /// 可退回的位置列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rollback_points: Option<Vec<RollbackPoint>>,
}

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

/// 群聊创建响应
#[derive(Debug, Serialize, Deserialize)]
pub struct UserTaskChatGroupResponse {
    /// 创建的群聊ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub chat_id: Option<String>,
    /// 操作是否成功
    #[serde(skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

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

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

    /// 发起流程
    ///
    /// 该接口用于发起一个新的流程实例。
    ///
    /// # 参数
    ///
    /// - `request`: 流程执行请求参数
    /// - `option`: 可选的请求配置
    pub async fn execute_flow(
        &self,
        request: FlowExecuteRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<FlowExecuteResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_EXECUTE,
                &[
                    ("app_id", &request.app_id),
                    ("flow_api_name", &request.flow_api_name),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "parameters": request.parameters
            }))?,
            ..Default::default()
        };

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

    /// 查询人工任务
    ///
    /// 该接口用于查询人工任务列表。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务查询请求参数
    /// - `option`: 可选的请求配置
    pub async fn query_user_tasks(
        &self,
        request: UserTaskQueryRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskQueryResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_param(
                Endpoints::APASS_V1_FLOW_USER_TASK_QUERY,
                "app_id",
                &request.app_id,
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

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

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

    /// 同意人工任务
    ///
    /// 该接口用于同意指定的人工任务。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务操作请求参数
    /// - `option`: 可选的请求配置
    pub async fn agree_user_task(
        &self,
        request: UserTaskActionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_AGREE,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "comment": request.comment,
                "data": request.data
            }))?,
            ..Default::default()
        };

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

    /// 拒绝人工任务
    ///
    /// 该接口用于拒绝指定的人工任务。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务操作请求参数
    /// - `option`: 可选的请求配置
    pub async fn reject_user_task(
        &self,
        request: UserTaskActionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_REJECT,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "comment": request.comment,
                "data": request.data
            }))?,
            ..Default::default()
        };

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

    /// 转交人工任务
    ///
    /// 该接口用于转交指定的人工任务给其他用户。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务转交请求参数
    /// - `option`: 可选的请求配置
    pub async fn transfer_user_task(
        &self,
        request: UserTaskTransferRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_TRANSFER,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "target_user_id": request.target_user_id,
                "comment": request.comment
            }))?,
            ..Default::default()
        };

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

    /// 人工任务加签
    ///
    /// 该接口用于为人工任务加签处理人。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务加签请求参数
    /// - `option`: 可选的请求配置
    pub async fn add_assignee_user_task(
        &self,
        request: UserTaskAddAssigneeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_ADD_ASSIGNEE,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "assignee_user_ids": request.assignee_user_ids,
                "comment": request.comment
            }))?,
            ..Default::default()
        };

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

    /// 抄送人工任务
    ///
    /// 该接口用于抄送人工任务给其他用户。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务抄送请求参数
    /// - `option`: 可选的请求配置
    pub async fn cc_user_task(
        &self,
        request: UserTaskCcRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_CC,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "cc_user_ids": request.cc_user_ids,
                "comment": request.comment
            }))?,
            ..Default::default()
        };

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

    /// 催办人工任务
    ///
    /// 该接口用于催办指定的人工任务。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务操作请求参数
    /// - `option`: 可选的请求配置
    pub async fn expedite_user_task(
        &self,
        request: UserTaskActionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_EXPEDITING,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "comment": request.comment
            }))?,
            ..Default::default()
        };

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

    /// 撤销人工任务
    ///
    /// 该接口用于撤销指定的人工任务。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务操作请求参数
    /// - `option`: 可选的请求配置
    pub async fn cancel_user_task(
        &self,
        request: UserTaskActionRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_CANCEL,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "comment": request.comment
            }))?,
            ..Default::default()
        };

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

    /// 查询人工任务可退回的位置
    ///
    /// 该接口用于查询指定人工任务可退回的位置列表。
    ///
    /// # 参数
    ///
    /// - `app_id`: 应用ID
    /// - `task_id`: 任务ID
    /// - `option`: 可选的请求配置
    pub async fn get_user_task_rollback_points(
        &self,
        app_id: String,
        task_id: String,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskRollbackPointsResponse>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_ROLLBACK_POINTS,
                &[("app_id", &app_id), ("task_id", &task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

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

    /// 退回人工任务
    ///
    /// 该接口用于退回指定的人工任务到指定节点。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务退回请求参数
    /// - `option`: 可选的请求配置
    pub async fn rollback_user_task(
        &self,
        request: UserTaskRollbackRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskActionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_ROLLBACK,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "target_node_id": request.target_node_id,
                "comment": request.comment
            }))?,
            ..Default::default()
        };

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

    /// 基于人工任务发起群聊
    ///
    /// 该接口用于基于人工任务创建群聊。
    ///
    /// # 参数
    ///
    /// - `request`: 人工任务群聊请求参数
    /// - `option`: 可选的请求配置
    pub async fn create_user_task_chat_group(
        &self,
        request: UserTaskChatGroupRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UserTaskChatGroupResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_FLOW_USER_TASK_CHAT_GROUP,
                &[("app_id", &request.app_id), ("task_id", &request.task_id)],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "group_name": request.group_name
            }))?,
            ..Default::default()
        };

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