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
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;

/// 分页响应
#[derive(Debug, Serialize, Deserialize)]
pub struct PageResponse<T> {
    /// 是否还有更多项目
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_more: Option<bool>,
    /// 分页标记,下次请求的起点
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 数据项目列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub items: Option<Vec<T>>,
}

// ============ 登录密码管理相关结构 ============

/// 重置用户企业邮箱密码请求
#[derive(Debug, Serialize, Deserialize)]
pub struct PasswordResetRequest {
    /// 用户ID,ID类型与查询参数中的user_id_type对应
    pub user_id: String,
    /// 新密码
    pub password: String,
}

/// 重置用户企业邮箱密码响应
#[derive(Debug, Serialize, Deserialize)]
pub struct PasswordResetResponse {
    /// 重置结果
    #[serde(skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
    /// 操作时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reset_time: Option<String>,
}

// ============ 数据报表管理相关结构 ============

/// 部门维度数据报表查询请求
#[derive(Debug, Serialize, Deserialize)]
pub struct DepartmentDataReportRequest {
    /// 开始日期,格式为YYYY-MM-DD
    pub start_date: String,
    /// 结束日期,格式为YYYY-MM-DD
    pub end_date: String,
    /// 部门ID类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub department_id_type: Option<String>,
    /// 部门ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub department_id: Option<String>,
    /// 分页大小
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 分页标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
}

/// 用户维度数据报表查询请求
#[derive(Debug, Serialize, Deserialize)]
pub struct UserDataReportRequest {
    /// 开始日期,格式为YYYY-MM-DD
    pub start_date: String,
    /// 结束日期,格式为YYYY-MM-DD
    pub end_date: String,
    /// 用户ID类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_id_type: Option<String>,
    /// 用户ID列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_ids: Option<Vec<String>>,
    /// 部门ID类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub department_id_type: Option<String>,
    /// 部门ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub department_id: Option<String>,
    /// 分页大小
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 分页标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
}

/// 数据报表信息
#[derive(Debug, Serialize, Deserialize)]
pub struct DataReport {
    /// 日期
    #[serde(skip_serializing_if = "Option::is_none")]
    pub date: Option<String>,
    /// 用户ID或部门ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// 用户名或部门名
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// 活跃用户数
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active_users: Option<i32>,
    /// 新增用户数
    #[serde(skip_serializing_if = "Option::is_none")]
    pub new_users: Option<i32>,
    /// 消息发送数
    #[serde(skip_serializing_if = "Option::is_none")]
    pub messages_sent: Option<i32>,
    /// 云文档使用数
    #[serde(skip_serializing_if = "Option::is_none")]
    pub docs_usage: Option<i32>,
    /// 会议时长(分钟)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub meeting_duration: Option<i32>,
    /// 其他统计数据
    #[serde(skip_serializing_if = "Option::is_none")]
    pub additional_metrics: Option<HashMap<String, Value>>,
}

// ============ 企业勋章相关结构 ============

/// 勋章创建请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeCreateRequest {
    /// 勋章名称
    pub name: String,
    /// 勋章说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 勋章详情描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub detail_description: Option<String>,
    /// 是否展示详情时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub show_detail_time: Option<bool>,
    /// 勋章图片key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image_key: Option<String>,
    /// 国际化名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_name: Option<HashMap<String, String>>,
    /// 国际化说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_description: Option<HashMap<String, String>>,
    /// 国际化详情描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_detail_description: Option<HashMap<String, String>>,
}

/// 勋章更新请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeUpdateRequest {
    /// 勋章ID
    pub badge_id: String,
    /// 勋章名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// 勋章说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 勋章详情描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub detail_description: Option<String>,
    /// 是否展示详情时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub show_detail_time: Option<bool>,
    /// 勋章图片key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image_key: Option<String>,
    /// 国际化名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_name: Option<HashMap<String, String>>,
    /// 国际化说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_description: Option<HashMap<String, String>>,
    /// 国际化详情描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_detail_description: Option<HashMap<String, String>>,
}

/// 勋章图片上传请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeImageUploadRequest {
    /// 图片文件内容(base64编码或文件流)
    pub image: String,
    /// 图片文件名
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_name: Option<String>,
}

/// 勋章列表查询请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeListRequest {
    /// 分页大小
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 分页标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 勋章名称(模糊搜索)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
}

/// 勋章查询请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGetRequest {
    /// 勋章ID
    pub badge_id: String,
}

/// 勋章信息
#[derive(Debug, Serialize, Deserialize)]
pub struct Badge {
    /// 勋章ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub badge_id: Option<String>,
    /// 勋章名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// 勋章说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 勋章详情描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub detail_description: Option<String>,
    /// 是否展示详情时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub show_detail_time: Option<bool>,
    /// 勋章图片URL
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image_url: Option<String>,
    /// 勋章图片key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image_key: Option<String>,
    /// 创建时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub create_time: Option<String>,
    /// 更新时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub update_time: Option<String>,
    /// 创建者ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub creator_id: Option<String>,
    /// 国际化名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_name: Option<HashMap<String, String>>,
    /// 国际化说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_description: Option<HashMap<String, String>>,
    /// 国际化详情描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub i18n_detail_description: Option<HashMap<String, String>>,
}

/// 图片上传结果
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeImageUploadResult {
    /// 图片key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image_key: Option<String>,
    /// 图片URL
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image_url: Option<String>,
}

// ============ 勋章授予名单相关结构 ============

/// 勋章授予名单创建请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGrantCreateRequest {
    /// 勋章ID
    pub badge_id: String,
    /// 授予名单名称
    pub name: String,
    /// 名单说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 授予用户列表
    pub user_list: Vec<BadgeGrantUser>,
    /// 生效时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub effective_time: Option<String>,
    /// 失效时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expiry_time: Option<String>,
    /// 授予时间展示类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub time_zone: Option<String>,
}

/// 勋章授予名单更新请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGrantUpdateRequest {
    /// 授予名单ID
    pub grant_id: String,
    /// 授予名单名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// 名单说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 授予用户列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_list: Option<Vec<BadgeGrantUser>>,
    /// 生效时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub effective_time: Option<String>,
    /// 失效时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expiry_time: Option<String>,
    /// 授予时间展示类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub time_zone: Option<String>,
}

/// 勋章授予名单删除请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGrantDeleteRequest {
    /// 授予名单ID
    pub grant_id: String,
}

/// 勋章授予名单列表查询请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGrantListRequest {
    /// 勋章ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub badge_id: Option<String>,
    /// 分页大小
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 分页标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 授予名单名称(模糊搜索)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
}

/// 勋章授予名单查询请求
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGrantGetRequest {
    /// 授予名单ID
    pub grant_id: String,
}

/// 勋章授予用户信息
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGrantUser {
    /// 用户ID
    pub user_id: String,
    /// 用户ID类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_id_type: Option<String>,
    /// 授予理由
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    /// 授予时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub grant_time: Option<String>,
}

/// 勋章授予名单信息
#[derive(Debug, Serialize, Deserialize)]
pub struct BadgeGrant {
    /// 授予名单ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub grant_id: Option<String>,
    /// 勋章ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub badge_id: Option<String>,
    /// 授予名单名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// 名单说明
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 授予用户列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_list: Option<Vec<BadgeGrantUser>>,
    /// 生效时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub effective_time: Option<String>,
    /// 失效时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expiry_time: Option<String>,
    /// 授予时间展示类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub time_zone: Option<String>,
    /// 创建时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub create_time: Option<String>,
    /// 更新时间
    #[serde(skip_serializing_if = "Option::is_none")]
    pub update_time: Option<String>,
    /// 创建者ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub creator_id: Option<String>,
}