@satorijs/adapter-lark 3.10.6 → 3.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/lib/index.cjs +2880 -2370
  2. package/lib/internal.d.ts +4 -4
  3. package/lib/types/acs.d.ts +212 -172
  4. package/lib/types/admin.d.ts +331 -291
  5. package/lib/types/aily.d.ts +331 -216
  6. package/lib/types/apaas.d.ts +646 -494
  7. package/lib/types/application.d.ts +559 -458
  8. package/lib/types/approval.d.ts +826 -791
  9. package/lib/types/attendance.d.ts +1094 -994
  10. package/lib/types/auth.d.ts +66 -61
  11. package/lib/types/authen.d.ts +221 -186
  12. package/lib/types/baike.d.ts +258 -233
  13. package/lib/types/base.d.ts +74 -0
  14. package/lib/types/bitable.d.ts +830 -770
  15. package/lib/types/board.d.ts +29 -14
  16. package/lib/types/calendar.d.ts +660 -605
  17. package/lib/types/cardkit.d.ts +149 -134
  18. package/lib/types/compensation.d.ts +84 -49
  19. package/lib/types/contact.d.ts +1279 -1204
  20. package/lib/types/corehr.d.ts +4982 -4526
  21. package/lib/types/directory.d.ts +447 -0
  22. package/lib/types/docs.d.ts +28 -18
  23. package/lib/types/document_ai.d.ts +347 -252
  24. package/lib/types/docx.d.ts +428 -383
  25. package/lib/types/drive.d.ts +1093 -1048
  26. package/lib/types/ehr.d.ts +66 -51
  27. package/lib/types/event.d.ts +16 -6
  28. package/lib/types/helpdesk.d.ts +816 -741
  29. package/lib/types/hire.d.ts +3955 -3589
  30. package/lib/types/human_authentication.d.ts +32 -22
  31. package/lib/types/im.d.ts +1420 -1295
  32. package/lib/types/index.d.ts +1422 -330
  33. package/lib/types/lingo.d.ts +279 -249
  34. package/lib/types/mail.d.ts +1032 -675
  35. package/lib/types/mdm.d.ts +105 -37
  36. package/lib/types/minutes.d.ts +73 -26
  37. package/lib/types/moments.d.ts +23 -13
  38. package/lib/types/okr.d.ts +266 -225
  39. package/lib/types/optical_char_recognition.d.ts +22 -12
  40. package/lib/types/passport.d.ts +58 -48
  41. package/lib/types/payroll.d.ts +210 -53
  42. package/lib/types/performance.d.ts +463 -414
  43. package/lib/types/personal_settings.d.ts +93 -82
  44. package/lib/types/report.d.ts +79 -58
  45. package/lib/types/search.d.ts +265 -235
  46. package/lib/types/security_and_compliance.d.ts +30 -19
  47. package/lib/types/sheets.d.ts +356 -321
  48. package/lib/types/speech_to_text.d.ts +44 -34
  49. package/lib/types/task.d.ts +998 -1087
  50. package/lib/types/tenant.d.ts +25 -15
  51. package/lib/types/translation.d.ts +42 -32
  52. package/lib/types/trust_party.d.ts +81 -0
  53. package/lib/types/vc.d.ts +1218 -1123
  54. package/lib/types/verification.d.ts +11 -6
  55. package/lib/types/wiki.d.ts +270 -235
  56. package/lib/types/workplace.d.ts +58 -38
  57. package/lib/utils.d.ts +2 -2
  58. package/package.json +4 -4
  59. package/src/bot.ts +15 -15
  60. package/src/internal.ts +29 -12
  61. package/src/message.ts +10 -10
  62. package/src/types/acs.ts +234 -186
  63. package/src/types/admin.ts +353 -305
  64. package/src/types/aily.ts +375 -233
  65. package/src/types/apaas.ts +754 -568
  66. package/src/types/application.ts +633 -507
  67. package/src/types/approval.ts +914 -872
  68. package/src/types/attendance.ts +1226 -1104
  69. package/src/types/auth.ts +72 -66
  70. package/src/types/authen.ts +233 -191
  71. package/src/types/baike.ts +276 -246
  72. package/src/types/base.ts +93 -0
  73. package/src/types/bitable.ts +966 -894
  74. package/src/types/board.ts +34 -16
  75. package/src/types/calendar.ts +751 -685
  76. package/src/types/cardkit.ts +164 -146
  77. package/src/types/compensation.ts +97 -55
  78. package/src/types/contact.ts +1465 -1375
  79. package/src/types/corehr.ts +5664 -5077
  80. package/src/types/directory.ts +569 -0
  81. package/src/types/docs.ts +31 -19
  82. package/src/types/document_ai.ts +401 -287
  83. package/src/types/docx.ts +492 -438
  84. package/src/types/drive.ts +1266 -1213
  85. package/src/types/ehr.ts +71 -53
  86. package/src/types/event.ts +19 -7
  87. package/src/types/helpdesk.ts +930 -840
  88. package/src/types/hire.ts +4453 -4019
  89. package/src/types/human_authentication.ts +35 -23
  90. package/src/types/im.ts +1626 -1476
  91. package/src/types/index.ts +1532 -346
  92. package/src/types/lingo.ts +299 -263
  93. package/src/types/mail.ts +1231 -779
  94. package/src/types/mdm.ts +122 -39
  95. package/src/types/minutes.ts +88 -28
  96. package/src/types/moments.ts +26 -14
  97. package/src/types/okr.ts +286 -238
  98. package/src/types/optical_char_recognition.ts +25 -13
  99. package/src/types/passport.ts +62 -50
  100. package/src/types/payroll.ts +254 -57
  101. package/src/types/performance.ts +528 -467
  102. package/src/types/personal_settings.ts +101 -89
  103. package/src/types/report.ts +86 -62
  104. package/src/types/search.ts +285 -249
  105. package/src/types/security_and_compliance.ts +33 -21
  106. package/src/types/sheets.ts +421 -379
  107. package/src/types/speech_to_text.ts +48 -36
  108. package/src/types/task.ts +1152 -1260
  109. package/src/types/tenant.ts +29 -17
  110. package/src/types/translation.ts +46 -34
  111. package/src/types/trust_party.ts +110 -0
  112. package/src/types/vc.ts +1397 -1283
  113. package/src/types/verification.ts +13 -7
  114. package/src/types/wiki.ts +293 -251
  115. package/src/types/workplace.ts +65 -41
  116. package/src/utils.ts +3 -3
@@ -1,296 +1,336 @@
1
- import { AdminDeptStat, AdminUserStat, AuditInfo, Badge, Grant, I18n, Password, RuleDetail } from '.';
2
- import { Pagination } from '../internal';
1
+ import * as Lark from '.';
2
+ import { Paginated, Pagination } from '../internal';
3
3
  declare module '../internal' {
4
4
  interface Internal {
5
- /**
6
- * 重置用户的企业邮箱密码
7
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/password/reset
8
- */
9
- resetAdminPassword(body: ResetAdminPasswordRequest, query?: ResetAdminPasswordQuery): Promise<void>;
10
- /**
11
- * 获取部门维度的用户活跃和功能使用数据
12
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list
13
- */
14
- listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery): Paginated<AdminDeptStat>;
15
- /**
16
- * 获取用户维度的用户活跃和功能使用数据
17
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list
18
- */
19
- listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery): Paginated<AdminUserStat>;
20
- /**
21
- * 创建勋章
22
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create
23
- */
24
- createAdminBadge(body: CreateAdminBadgeRequest): Promise<CreateAdminBadgeResponse>;
25
- /**
26
- * 修改勋章信息
27
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/update
28
- */
29
- updateAdminBadge(badge_id: string, body: UpdateAdminBadgeRequest): Promise<UpdateAdminBadgeResponse>;
30
- /**
31
- * 上传勋章图片
32
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge_image/create
33
- */
34
- createAdminBadgeImage(form: CreateAdminBadgeImageForm): Promise<CreateAdminBadgeImageResponse>;
35
- /**
36
- * 获取勋章列表
37
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list
38
- */
39
- listAdminBadge(query?: ListAdminBadgeQuery): Paginated<Badge, 'badges'>;
40
- /**
41
- * 获取勋章详情
42
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get
43
- */
44
- getAdminBadge(badge_id: string): Promise<GetAdminBadgeResponse>;
45
- /**
46
- * 创建授予名单
47
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/create
48
- */
49
- createAdminBadgeGrant(badge_id: string, body: CreateAdminBadgeGrantRequest, query?: CreateAdminBadgeGrantQuery): Promise<CreateAdminBadgeGrantResponse>;
50
- /**
51
- * 删除授予名单
52
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/delete
53
- */
54
- deleteAdminBadgeGrant(badge_id: string, grant_id: string): Promise<void>;
55
- /**
56
- * 修改授予名单
57
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/update
58
- */
59
- updateAdminBadgeGrant(badge_id: string, grant_id: string, body: UpdateAdminBadgeGrantRequest, query?: UpdateAdminBadgeGrantQuery): Promise<UpdateAdminBadgeGrantResponse>;
60
- /**
61
- * 获取授予名单列表
62
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list
63
- */
64
- listAdminBadgeGrant(badge_id: string, query?: ListAdminBadgeGrantQuery): Paginated<Grant, 'grants'>;
65
- /**
66
- * 获取授予名单详情
67
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get
68
- */
69
- getAdminBadgeGrant(badge_id: string, grant_id: string, query?: GetAdminBadgeGrantQuery): Promise<GetAdminBadgeGrantResponse>;
70
- /**
71
- * 获取行为审计日志数据
72
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get
73
- */
74
- listAdminAuditInfo(query?: ListAdminAuditInfoQuery): Paginated<AuditInfo>;
5
+ admin: Admin.Methods;
75
6
  }
76
7
  }
77
- export interface ResetAdminPasswordRequest {
78
- /** 需要重置的密码参数,不少于8个字符,字母、数字和符号,至少三选二 */
79
- password: Password;
80
- /** 待修改密码的用户ID,只针对邮箱登录凭证与企业邮箱(包括别名)相等的用户生效 */
81
- user_id: string;
82
- }
83
- export interface ResetAdminPasswordQuery {
84
- /** 用户ID类型 */
85
- user_id_type: 'open_id' | 'union_id' | 'user_id';
86
- }
87
- export interface ListAdminAdminDeptStatQuery extends Pagination {
88
- /** 部门ID类型 */
89
- department_id_type: 'department_id' | 'open_department_id';
90
- /** 起始日期(包含),格式是YYYY-mm-dd */
91
- start_date: string;
92
- /** 终止日期(包含),格式是YYYY-mm-dd,起止日期之间相差不能超过91天(包含91天) */
93
- end_date: string;
94
- /** 部门的 ID,取决于department_id_type,仅支持根部门及其下前4级子部门 */
95
- department_id: string;
96
- /** 是否包含子部门,如果该值为false,则只查出本部门直属用户活跃和功能使用数据;如果该值为true,则查出该部门以及其子部门(子部门层级最多不超过根部门下的前4级)的用户活跃和功能使用数据 */
97
- contains_child_dept: boolean;
98
- /** 跨域访问的geo */
99
- target_geo?: string;
100
- /** 是否返回分产品版本数据 */
101
- with_product_version?: boolean;
102
- }
103
- export interface ListAdminAdminUserStatQuery extends Pagination {
104
- /** 此次调用中使用的用户ID的类型 */
105
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
106
- /** 部门ID类型 */
107
- department_id_type?: 'department_id' | 'open_department_id';
108
- /** 起始日期(包含),格式是YYYY-mm-dd */
109
- start_date: string;
110
- /** 终止日期(包含),格式是YYYY-mm-dd。起止日期之间相差不能超过31天(包含31天) */
111
- end_date: string;
112
- /** 部门的 ID,取决于department_id_type */
113
- department_id?: string;
114
- /** 用户的open_id,user_id或者union_id,取决于user_id_type */
115
- user_id?: string;
116
- /** 跨域访问的geo */
117
- target_geo?: string;
118
- }
119
- export interface CreateAdminBadgeRequest {
120
- /** 租户内唯一的勋章名称,最多30个字符。 */
121
- name: string;
122
- /** 勋章的描述文案,最多100个字符。 */
123
- explanation?: string;
124
- /** 企业勋章的详情图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
125
- detail_image: string;
126
- /** 企业勋章的头像挂饰图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
127
- show_image: string;
128
- /** 勋章的多语言名称,同name字段限制,最多30个字符。 */
129
- i18n_name?: I18n;
130
- /** 勋章的多语言描述文案,同explanation字段限制,最多100个字符。 */
131
- i18n_explanation?: I18n;
132
- }
133
- export interface CreateAdminBadgeResponse {
134
- /** 勋章的信息 */
135
- badge?: Badge;
136
- }
137
- export interface UpdateAdminBadgeRequest {
138
- /** 租户内唯一的勋章名称,最多30个字符。 */
139
- name: string;
140
- /** 勋章的描述文案,最多100个字符。 */
141
- explanation?: string;
142
- /** 企业勋章的详情图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
143
- detail_image: string;
144
- /** 企业勋章的头像挂饰图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
145
- show_image: string;
146
- /** 勋章的多语言名称,同name字段限制,最多30个字符。 */
147
- i18n_name?: I18n;
148
- /** 勋章的多语言描述文案,同explanation字段限制,最多100个字符。 */
149
- i18n_explanation?: I18n;
150
- }
151
- export interface UpdateAdminBadgeResponse {
152
- /** 勋章信息 */
153
- badge?: Badge;
154
- }
155
- export declare const enum CreateAdminBadgeImageFormImageType {
156
- /** 勋章详情图 */
157
- Detail = 1,
158
- /** 勋章挂饰图 */
159
- Show = 2
160
- }
161
- export interface CreateAdminBadgeImageForm {
162
- /** 勋章图片的文件,仅支持 PNG 格式,320 x 320 像素,大小不超过 1024 KB。 */
163
- image_file: Blob;
164
- /** 图片的类型 */
165
- image_type: CreateAdminBadgeImageFormImageType;
166
- }
167
- export interface CreateAdminBadgeImageResponse {
168
- /** 图片的key */
169
- image_key?: string;
170
- }
171
- export interface ListAdminBadgeQuery extends Pagination {
172
- /** 租户内唯一的勋章名称,精确匹配。 */
173
- name?: string;
174
- }
175
- export interface GetAdminBadgeResponse {
176
- /** 勋章信息 */
177
- badge?: Badge;
178
- }
179
- export declare const enum CreateAdminBadgeGrantRequestGrantType {
180
- /** 手动选择有效期 */
181
- Manual = 0,
182
- /** 匹配系统入职时间 */
183
- JoinTime = 1
184
- }
185
- export interface CreateAdminBadgeGrantRequest {
186
- /** 授予名单名称,最多100个字符。 */
187
- name: string;
188
- /** 勋章下唯一的授予事项 */
189
- grant_type: CreateAdminBadgeGrantRequestGrantType;
190
- /** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */
191
- time_zone: string;
192
- /** 规则详情 */
193
- rule_detail: RuleDetail;
194
- /** 是否授予给全员。1.为false时,需要关联1~500个用户群体。2.为true时,不可关联用户、用户组、部门。 */
195
- is_grant_all: boolean;
196
- /** 授予的用户ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
197
- user_ids?: string[];
198
- /** 授予的部门ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
199
- department_ids?: string[];
200
- /** 授予的用户组ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
201
- group_ids?: string[];
202
- }
203
- export interface CreateAdminBadgeGrantQuery {
204
- /** 用户 ID 类型 */
205
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
206
- /** 此次调用中使用的部门ID的类型。 */
207
- department_id_type?: 'department_id' | 'open_department_id';
208
- }
209
- export interface CreateAdminBadgeGrantResponse {
210
- /** 授予名单的信息 */
211
- grant?: Grant;
212
- }
213
- export declare const enum UpdateAdminBadgeGrantRequestGrantType {
214
- /** 手动选择有效期 */
215
- Manual = 0,
216
- /** 匹配系统入职时间 */
217
- JoinTime = 1
218
- }
219
- export interface UpdateAdminBadgeGrantRequest {
220
- /** 授予名单名称,最多100个字符。 */
221
- name: string;
222
- /** 勋章下唯一的授予事项 */
223
- grant_type: UpdateAdminBadgeGrantRequestGrantType;
224
- /** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */
225
- time_zone: string;
226
- /** 规则详情 */
227
- rule_detail: RuleDetail;
228
- /** 是否授予给全员。1.为false时,需要关联1~500个用户群体。2.为true时,不可关联用户、用户组、部门。 */
229
- is_grant_all: boolean;
230
- /** 授予的用户ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
231
- user_ids?: string[];
232
- /** 授予的部门ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
233
- department_ids?: string[];
234
- /** 授予的用户组ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
235
- group_ids?: string[];
236
- }
237
- export interface UpdateAdminBadgeGrantQuery {
238
- /** 用户 ID 类型 */
239
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
240
- /** 此次调用中使用的部门ID的类型。 */
241
- department_id_type?: 'department_id' | 'open_department_id';
242
- }
243
- export interface UpdateAdminBadgeGrantResponse {
244
- /** 授予名单 */
245
- grant?: Grant;
246
- }
247
- export interface ListAdminBadgeGrantQuery extends Pagination {
248
- /** 用户 ID 类型 */
249
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
250
- /** 此次调用中使用的部门ID的类型。 */
251
- department_id_type?: 'department_id' | 'open_department_id';
252
- /** 授予名单名称,精确匹配。 */
253
- name?: string;
254
- }
255
- export interface GetAdminBadgeGrantQuery {
256
- /** 用户 ID 类型 */
257
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
258
- /** 此次调用中使用的部门ID的类型。 */
259
- department_id_type?: 'department_id' | 'open_department_id';
260
- }
261
- export interface GetAdminBadgeGrantResponse {
262
- /** 授予名单信息 */
263
- grant?: Grant;
264
- }
265
- export declare const enum ListAdminAuditInfoQueryUserType {
266
- /** 互联网上的任何人 */
267
- All = 0,
268
- /** 组织内成员 */
269
- NormalUser = 1,
270
- /** 组织外成员 */
271
- ExternalUser = 2
272
- }
273
- export interface ListAdminAuditInfoQuery extends Pagination {
274
- /** 此次调用中使用的用户ID的类型 */
275
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
276
- /** 日志时间范围: 结束时间. 格式: 秒级时间戳. 默认值: 此刻 */
277
- latest?: number;
278
- /** 日志时间范围: 起始时间. 格式: 秒级时间戳. 默认值: 30日前此刻 */
279
- oldest?: number;
280
- /** 事件名称 */
281
- event_name?: string;
282
- /** 过滤操作者: 操作者类型. 与 operator_value 配合使用 */
283
- operator_type?: 'user' | 'bot';
284
- /** 过滤操作者: 操作者ID. 与 operator_type 配合使用 */
285
- operator_value?: string;
286
- /** 过滤模块 */
287
- event_module?: number;
288
- /** 过滤用户类型. 仅当 operator_type=user 时生效 */
289
- user_type?: ListAdminAuditInfoQueryUserType;
290
- /** 过滤操作对象: 操作对象类型. 与object_value配合使用 */
291
- object_type?: number;
292
- /** 过滤操作对象: 操作对象ID. 与object_type配合使用 */
293
- object_value?: string;
294
- /** 增强过滤操作对象: 操作对象ID,支持云文档侧泛token过滤。会覆盖object_type和object_value查询条件 */
295
- ext_filter_object_by_ccm_token?: string;
8
+ export declare namespace Admin {
9
+ interface Methods {
10
+ password: Password.Methods;
11
+ adminDeptStat: AdminDeptStat.Methods;
12
+ adminUserStat: AdminUserStat.Methods;
13
+ badge: Badge.Methods;
14
+ badgeImage: BadgeImage.Methods;
15
+ auditInfo: AuditInfo.Methods;
16
+ }
17
+ namespace Password {
18
+ interface Methods {
19
+ /**
20
+ * 重置用户的企业邮箱密码
21
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/password/reset
22
+ */
23
+ reset(body: ResetRequest, query?: ResetQuery): Promise<void>;
24
+ }
25
+ interface ResetRequest {
26
+ /** 需要重置的密码参数,不少于8个字符,字母、数字和符号,至少三选二 */
27
+ password: Lark.Password;
28
+ /** 待修改密码的用户ID,只针对邮箱登录凭证与企业邮箱(包括别名)相等的用户生效 */
29
+ user_id: string;
30
+ }
31
+ interface ResetQuery {
32
+ /** 用户ID类型 */
33
+ user_id_type: 'open_id' | 'union_id' | 'user_id';
34
+ }
35
+ }
36
+ namespace AdminDeptStat {
37
+ interface Methods {
38
+ /**
39
+ * 获取部门维度的用户活跃和功能使用数据
40
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list
41
+ */
42
+ list(query?: ListQuery): Paginated<Lark.AdminDeptStat>;
43
+ }
44
+ interface ListQuery extends Pagination {
45
+ /** 部门ID类型 */
46
+ department_id_type: 'department_id' | 'open_department_id';
47
+ /** 起始日期(包含),格式是YYYY-mm-dd */
48
+ start_date: string;
49
+ /** 终止日期(包含),格式是YYYY-mm-dd,起止日期之间相差不能超过91天(包含91天) */
50
+ end_date: string;
51
+ /** 部门的 ID,取决于department_id_type,仅支持根部门及其下前4级子部门 */
52
+ department_id: string;
53
+ /** 是否包含子部门,如果该值为false,则只查出本部门直属用户活跃和功能使用数据;如果该值为true,则查出该部门以及其子部门(子部门层级最多不超过根部门下的前4级)的用户活跃和功能使用数据 */
54
+ contains_child_dept: boolean;
55
+ /** 跨域访问的geo */
56
+ target_geo?: string;
57
+ /** 是否返回分产品版本数据 */
58
+ with_product_version?: boolean;
59
+ }
60
+ }
61
+ namespace AdminUserStat {
62
+ interface Methods {
63
+ /**
64
+ * 获取用户维度的用户活跃和功能使用数据
65
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list
66
+ */
67
+ list(query?: ListQuery): Paginated<Lark.AdminUserStat>;
68
+ }
69
+ interface ListQuery extends Pagination {
70
+ /** 此次调用中使用的用户ID的类型 */
71
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
72
+ /** 部门ID类型 */
73
+ department_id_type?: 'department_id' | 'open_department_id';
74
+ /** 起始日期(包含),格式是YYYY-mm-dd */
75
+ start_date: string;
76
+ /** 终止日期(包含),格式是YYYY-mm-dd。起止日期之间相差不能超过31天(包含31天) */
77
+ end_date: string;
78
+ /** 部门的 ID,取决于department_id_type */
79
+ department_id?: string;
80
+ /** 用户的open_id,user_id或者union_id,取决于user_id_type */
81
+ user_id?: string;
82
+ /** 跨域访问的geo */
83
+ target_geo?: string;
84
+ }
85
+ }
86
+ namespace Badge {
87
+ interface Methods {
88
+ grant: Grant.Methods;
89
+ /**
90
+ * 创建勋章
91
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create
92
+ */
93
+ create(body: CreateRequest): Promise<CreateResponse>;
94
+ /**
95
+ * 修改勋章信息
96
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/update
97
+ */
98
+ update(badge_id: string, body: UpdateRequest): Promise<UpdateResponse>;
99
+ /**
100
+ * 获取勋章列表
101
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list
102
+ */
103
+ list(query?: ListQuery): Paginated<Lark.Badge, 'badges'>;
104
+ /**
105
+ * 获取勋章详情
106
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get
107
+ */
108
+ get(badge_id: string): Promise<GetResponse>;
109
+ }
110
+ interface CreateRequest {
111
+ /** 租户内唯一的勋章名称,最多30个字符。 */
112
+ name: string;
113
+ /** 勋章的描述文案,最多100个字符。 */
114
+ explanation?: string;
115
+ /** 企业勋章的详情图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
116
+ detail_image: string;
117
+ /** 企业勋章的头像挂饰图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
118
+ show_image: string;
119
+ /** 勋章的多语言名称,同name字段限制,最多30个字符。 */
120
+ i18n_name?: Lark.I18n;
121
+ /** 勋章的多语言描述文案,同explanation字段限制,最多100个字符。 */
122
+ i18n_explanation?: Lark.I18n;
123
+ }
124
+ interface CreateResponse {
125
+ /** 勋章的信息 */
126
+ badge?: Lark.Badge;
127
+ }
128
+ interface UpdateRequest {
129
+ /** 租户内唯一的勋章名称,最多30个字符。 */
130
+ name: string;
131
+ /** 勋章的描述文案,最多100个字符。 */
132
+ explanation?: string;
133
+ /** 企业勋章的详情图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
134
+ detail_image: string;
135
+ /** 企业勋章的头像挂饰图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
136
+ show_image: string;
137
+ /** 勋章的多语言名称,同name字段限制,最多30个字符。 */
138
+ i18n_name?: Lark.I18n;
139
+ /** 勋章的多语言描述文案,同explanation字段限制,最多100个字符。 */
140
+ i18n_explanation?: Lark.I18n;
141
+ }
142
+ interface UpdateResponse {
143
+ /** 勋章信息 */
144
+ badge?: Lark.Badge;
145
+ }
146
+ interface ListQuery extends Pagination {
147
+ /** 租户内唯一的勋章名称,精确匹配。 */
148
+ name?: string;
149
+ }
150
+ interface GetResponse {
151
+ /** 勋章信息 */
152
+ badge?: Lark.Badge;
153
+ }
154
+ namespace Grant {
155
+ interface Methods {
156
+ /**
157
+ * 创建授予名单
158
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/create
159
+ */
160
+ create(badge_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
161
+ /**
162
+ * 删除授予名单
163
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/delete
164
+ */
165
+ delete(badge_id: string, grant_id: string): Promise<void>;
166
+ /**
167
+ * 修改授予名单
168
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/update
169
+ */
170
+ update(badge_id: string, grant_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
171
+ /**
172
+ * 获取授予名单列表
173
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list
174
+ */
175
+ list(badge_id: string, query?: ListQuery): Paginated<Lark.Grant, 'grants'>;
176
+ /**
177
+ * 获取授予名单详情
178
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get
179
+ */
180
+ get(badge_id: string, grant_id: string, query?: GetQuery): Promise<GetResponse>;
181
+ }
182
+ const enum CreateRequestGrantType {
183
+ /** 手动选择有效期 */
184
+ Manual = 0,
185
+ /** 匹配系统入职时间 */
186
+ JoinTime = 1
187
+ }
188
+ interface CreateRequest {
189
+ /** 授予名单名称,最多100个字符。 */
190
+ name: string;
191
+ /** 勋章下唯一的授予事项 */
192
+ grant_type: CreateRequestGrantType;
193
+ /** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */
194
+ time_zone: string;
195
+ /** 规则详情 */
196
+ rule_detail: Lark.RuleDetail;
197
+ /** 是否授予给全员。1.为false时,需要关联1~500个用户群体。2.为true时,不可关联用户、用户组、部门。 */
198
+ is_grant_all: boolean;
199
+ /** 授予的用户ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
200
+ user_ids?: string[];
201
+ /** 授予的部门ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
202
+ department_ids?: string[];
203
+ /** 授予的用户组ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
204
+ group_ids?: string[];
205
+ }
206
+ interface CreateQuery {
207
+ /** 用户 ID 类型 */
208
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
209
+ /** 此次调用中使用的部门ID的类型。 */
210
+ department_id_type?: 'department_id' | 'open_department_id';
211
+ }
212
+ interface CreateResponse {
213
+ /** 授予名单的信息 */
214
+ grant?: Lark.Grant;
215
+ }
216
+ const enum UpdateRequestGrantType {
217
+ /** 手动选择有效期 */
218
+ Manual = 0,
219
+ /** 匹配系统入职时间 */
220
+ JoinTime = 1
221
+ }
222
+ interface UpdateRequest {
223
+ /** 授予名单名称,最多100个字符。 */
224
+ name: string;
225
+ /** 勋章下唯一的授予事项 */
226
+ grant_type: UpdateRequestGrantType;
227
+ /** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */
228
+ time_zone: string;
229
+ /** 规则详情 */
230
+ rule_detail: Lark.RuleDetail;
231
+ /** 是否授予给全员。1.为false时,需要关联1~500个用户群体。2.为true时,不可关联用户、用户组、部门。 */
232
+ is_grant_all: boolean;
233
+ /** 授予的用户ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
234
+ user_ids?: string[];
235
+ /** 授予的部门ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
236
+ department_ids?: string[];
237
+ /** 授予的用户组ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
238
+ group_ids?: string[];
239
+ }
240
+ interface UpdateQuery {
241
+ /** 用户 ID 类型 */
242
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
243
+ /** 此次调用中使用的部门ID的类型。 */
244
+ department_id_type?: 'department_id' | 'open_department_id';
245
+ }
246
+ interface UpdateResponse {
247
+ /** 授予名单 */
248
+ grant?: Lark.Grant;
249
+ }
250
+ interface ListQuery extends Pagination {
251
+ /** 用户 ID 类型 */
252
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
253
+ /** 此次调用中使用的部门ID的类型。 */
254
+ department_id_type?: 'department_id' | 'open_department_id';
255
+ /** 授予名单名称,精确匹配。 */
256
+ name?: string;
257
+ }
258
+ interface GetQuery {
259
+ /** 用户 ID 类型 */
260
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
261
+ /** 此次调用中使用的部门ID的类型。 */
262
+ department_id_type?: 'department_id' | 'open_department_id';
263
+ }
264
+ interface GetResponse {
265
+ /** 授予名单信息 */
266
+ grant?: Lark.Grant;
267
+ }
268
+ }
269
+ }
270
+ namespace BadgeImage {
271
+ interface Methods {
272
+ /**
273
+ * 上传勋章图片
274
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge_image/create
275
+ */
276
+ create(form: CreateForm): Promise<CreateResponse>;
277
+ }
278
+ const enum CreateFormImageType {
279
+ /** 勋章详情图 */
280
+ Detail = 1,
281
+ /** 勋章挂饰图 */
282
+ Show = 2
283
+ }
284
+ interface CreateForm {
285
+ /** 勋章图片的文件,仅支持 PNG 格式,320 x 320 像素,大小不超过 1024 KB。 */
286
+ image_file: Blob;
287
+ /** 图片的类型 */
288
+ image_type: CreateFormImageType;
289
+ }
290
+ interface CreateResponse {
291
+ /** 图片的key */
292
+ image_key?: string;
293
+ }
294
+ }
295
+ namespace AuditInfo {
296
+ interface Methods {
297
+ /**
298
+ * 获取行为审计日志数据
299
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get
300
+ */
301
+ list(query?: ListQuery): Paginated<Lark.AuditInfo>;
302
+ }
303
+ const enum ListQueryUserType {
304
+ /** 互联网上的任何人 */
305
+ All = 0,
306
+ /** 组织内成员 */
307
+ NormalUser = 1,
308
+ /** 组织外成员 */
309
+ ExternalUser = 2
310
+ }
311
+ interface ListQuery extends Pagination {
312
+ /** 此次调用中使用的用户ID的类型 */
313
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
314
+ /** 日志时间范围: 结束时间. 格式: 秒级时间戳. 默认值: 此刻 */
315
+ latest?: number;
316
+ /** 日志时间范围: 起始时间. 格式: 秒级时间戳. 默认值: 30日前此刻 */
317
+ oldest?: number;
318
+ /** 事件名称 */
319
+ event_name?: string;
320
+ /** 过滤操作者: 操作者类型. 与 operator_value 配合使用 */
321
+ operator_type?: 'user' | 'bot';
322
+ /** 过滤操作者: 操作者ID. 与 operator_type 配合使用 */
323
+ operator_value?: string;
324
+ /** 过滤模块 */
325
+ event_module?: number;
326
+ /** 过滤用户类型. 仅当 operator_type=user 时生效 */
327
+ user_type?: ListQueryUserType;
328
+ /** 过滤操作对象: 操作对象类型. 与object_value配合使用 */
329
+ object_type?: number;
330
+ /** 过滤操作对象: 操作对象ID. 与object_type配合使用 */
331
+ object_value?: string;
332
+ /** 增强过滤操作对象: 操作对象ID,支持云文档侧泛token过滤。会覆盖object_type和object_value查询条件 */
333
+ ext_filter_object_by_ccm_token?: string;
334
+ }
335
+ }
296
336
  }