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
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::{
        BatchRecordQueryRequest, BatchRecordRequest, OqlQueryRequest, OqlQueryResult, PageResponse,
        Record, RecordCreateRequest, RecordDeleteRequest, RecordQueryRequest, RecordSearchRequest,
        RecordUpdateRequest,
    },
};

/// 对象操作服务
pub struct ObjectService {
    pub config: Config,
}

/// OQL查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct OqlQueryResponse {
    /// OQL查询结果
    #[serde(flatten)]
    pub query_result: OqlQueryResult,
}

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

/// 记录搜索响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RecordSearchResponse {
    /// 分页响应数据
    #[serde(flatten)]
    pub page_response: PageResponse<Record>,
}

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

/// 记录查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RecordQueryResponse {
    /// 记录信息
    #[serde(flatten)]
    pub record: Record,
}

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

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

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

/// 记录更新响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RecordUpdateResponse {
    /// 操作是否成功
    #[serde(skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
    /// 更新的记录信息
    #[serde(skip_serializing_if = "Option::is_none")]
    pub record: Option<Record>,
}

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

/// 记录删除响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RecordDeleteResponse {
    /// 操作是否成功
    #[serde(skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

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

/// 批量记录查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct BatchRecordQueryResponse {
    /// 分页响应数据
    #[serde(flatten)]
    pub page_response: PageResponse<Record>,
}

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

/// 批量记录操作响应
#[derive(Debug, Serialize, Deserialize)]
pub struct BatchRecordResponse {
    /// 操作是否成功
    #[serde(skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
    /// 成功的记录ID列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub success_record_ids: Option<Vec<String>>,
    /// 失败的记录信息
    #[serde(skip_serializing_if = "Option::is_none")]
    pub failed_records: Option<Vec<serde_json::Value>>,
}

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

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

    /// 执行OQL查询
    ///
    /// 该接口用于执行OQL(Object Query Language)查询。
    ///
    /// # 参数
    ///
    /// - `request`: OQL查询请求参数
    /// - `option`: 可选的请求配置
    pub async fn oql_query(
        &self,
        request: OqlQueryRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<OqlQueryResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_param(
                Endpoints::APASS_V1_OBJECT_OQL,
                "app_id",
                &request.app_id,
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "oql": request.oql,
                "parameters": request.parameters
            }))?,
            ..Default::default()
        };

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

    /// 搜索记录
    ///
    /// 该接口用于在指定对象中搜索记录。
    ///
    /// # 参数
    ///
    /// - `request`: 记录搜索请求参数
    /// - `option`: 可选的请求配置
    pub async fn search_records(
        &self,
        request: RecordSearchRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RecordSearchResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_SEARCH,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "keyword": request.keyword
            }))?,
            ..Default::default()
        };

        // 添加查询参数
        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 get_record(
        &self,
        request: RecordQueryRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RecordQueryResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_GET,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                    ("record_id", &request.record_id),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加字段查询参数
        if let Some(fields) = request.fields {
            api_req.query_params.insert("fields", fields.join(","));
        }

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

    /// 编辑记录
    ///
    /// 该接口用于编辑指定的记录。
    ///
    /// # 参数
    ///
    /// - `request`: 记录更新请求参数
    /// - `option`: 可选的请求配置
    pub async fn update_record(
        &self,
        request: RecordUpdateRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RecordUpdateResponse>> {
        let api_req = ApiRequest {
            http_method: Method::PATCH,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_UPDATE,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                    ("record_id", &request.record_id),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request.data)?,
            ..Default::default()
        };

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

    /// 删除记录
    ///
    /// 该接口用于删除指定的记录。
    ///
    /// # 参数
    ///
    /// - `request`: 记录删除请求参数
    /// - `option`: 可选的请求配置
    pub async fn delete_record(
        &self,
        request: RecordDeleteRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RecordDeleteResponse>> {
        let api_req = ApiRequest {
            http_method: Method::DELETE,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_DELETE,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                    ("record_id", &request.record_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 create_record(
        &self,
        request: RecordCreateRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RecordCreateResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_CREATE,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request.data)?,
            ..Default::default()
        };

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

    /// 批量编辑记录
    ///
    /// 该接口用于批量编辑记录。
    ///
    /// # 参数
    ///
    /// - `request`: 批量记录请求参数
    /// - `option`: 可选的请求配置
    pub async fn batch_update_records(
        &self,
        request: BatchRecordRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<BatchRecordResponse>> {
        let api_req = ApiRequest {
            http_method: Method::PATCH,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_BATCH_UPDATE,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "records": request.records
            }))?,
            ..Default::default()
        };

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

    /// 查询记录列表
    ///
    /// 该接口用于查询记录列表。
    ///
    /// # 参数
    ///
    /// - `request`: 批量记录查询请求参数
    /// - `option`: 可选的请求配置
    pub async fn batch_query_records(
        &self,
        request: BatchRecordQueryRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<BatchRecordQueryResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_BATCH_QUERY,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "filter": request.filter,
                "sort": request.sort
            }))?,
            ..Default::default()
        };

        // 添加查询参数
        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 batch_delete_records(
        &self,
        request: BatchRecordRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<BatchRecordResponse>> {
        let api_req = ApiRequest {
            http_method: Method::DELETE,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_BATCH_DELETE,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "records": request.records
            }))?,
            ..Default::default()
        };

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

    /// 批量新建记录
    ///
    /// 该接口用于批量新建记录。
    ///
    /// # 参数
    ///
    /// - `request`: 批量记录请求参数
    /// - `option`: 可选的请求配置
    pub async fn batch_create_records(
        &self,
        request: BatchRecordRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<BatchRecordResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: EndpointBuilder::replace_params_from_array(
                Endpoints::APASS_V1_OBJECT_RECORD_BATCH_CREATE,
                &[
                    ("app_id", &request.app_id),
                    ("object_api_name", &request.object_api_name),
                ],
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&serde_json::json!({
                "records": request.records
            }))?,
            ..Default::default()
        };

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