@satorijs/adapter-lark 3.11.8 → 3.12.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.
- package/lib/bot.d.ts +5 -5
- package/lib/http.d.ts +6 -3
- package/lib/index.cjs +634 -261
- package/lib/types/acs.d.ts +4 -1
- package/lib/types/aily.d.ts +3 -3
- package/lib/types/apaas.d.ts +190 -28
- package/lib/types/application.d.ts +20 -4
- package/lib/types/approval.d.ts +0 -13
- package/lib/types/attendance.d.ts +11 -5
- package/lib/types/authen.d.ts +8 -2
- package/lib/types/bitable.d.ts +25 -4
- package/lib/types/board.d.ts +56 -0
- package/lib/types/calendar.d.ts +71 -5
- package/lib/types/cardkit.d.ts +2 -2
- package/lib/types/compensation.d.ts +400 -0
- package/lib/types/contact.d.ts +55 -12
- package/lib/types/corehr.d.ts +1287 -79
- package/lib/types/directory.d.ts +3 -41
- package/lib/types/docx.d.ts +23 -0
- package/lib/types/drive.d.ts +107 -90
- package/lib/types/ehr.d.ts +11 -2
- package/lib/types/helpdesk.d.ts +15 -6
- package/lib/types/hire.d.ts +52 -3
- package/lib/types/human_authentication.d.ts +1 -1
- package/lib/types/im.d.ts +77 -21
- package/lib/types/index.d.ts +1670 -105
- package/lib/types/mail.d.ts +106 -16
- package/lib/types/payroll.d.ts +117 -81
- package/lib/types/performance.d.ts +1 -1
- package/lib/types/search.d.ts +4 -1
- package/lib/types/security_and_compliance.d.ts +254 -1
- package/lib/ws.d.ts +30 -0
- package/package.json +6 -3
- package/src/bot.ts +28 -15
- package/src/http.ts +10 -4
- package/src/types/acs.ts +4 -1
- package/src/types/aily.ts +3 -3
- package/src/types/apaas.ts +237 -38
- package/src/types/application.ts +20 -4
- package/src/types/approval.ts +0 -15
- package/src/types/attendance.ts +11 -5
- package/src/types/authen.ts +8 -2
- package/src/types/bitable.ts +25 -4
- package/src/types/board.ts +75 -2
- package/src/types/calendar.ts +88 -5
- package/src/types/cardkit.ts +2 -2
- package/src/types/compensation.ts +485 -0
- package/src/types/contact.ts +55 -12
- package/src/types/corehr.ts +1480 -123
- package/src/types/directory.ts +3 -53
- package/src/types/docx.ts +29 -0
- package/src/types/drive.ts +129 -112
- package/src/types/ehr.ts +11 -2
- package/src/types/helpdesk.ts +15 -6
- package/src/types/hire.ts +66 -3
- package/src/types/human_authentication.ts +1 -1
- package/src/types/im.ts +77 -21
- package/src/types/index.ts +1751 -107
- package/src/types/mail.ts +106 -16
- package/src/types/payroll.ts +146 -103
- package/src/types/performance.ts +1 -1
- package/src/types/search.ts +4 -1
- package/src/types/security_and_compliance.ts +292 -1
- package/src/ws.ts +183 -0
- package/lib/types/api.d.ts +0 -28510
- package/lib/types/internal.d.ts +0 -21
- package/lib/types/message/content.d.ts +0 -433
- package/lib/types/message/index.d.ts +0 -95
package/lib/types/contact.d.ts
CHANGED
|
@@ -172,7 +172,10 @@ export declare namespace Contact {
|
|
|
172
172
|
interface CreateQuery {
|
|
173
173
|
/** 此次调用中使用的用户ID的类型 */
|
|
174
174
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
175
|
-
/**
|
|
175
|
+
/**
|
|
176
|
+
* 此次调用中使用的部门ID的类型。
|
|
177
|
+
* 不同 ID 的说明参见[部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
|
|
178
|
+
*/
|
|
176
179
|
department_id_type?: 'department_id' | 'open_department_id';
|
|
177
180
|
/** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
|
|
178
181
|
client_token?: string;
|
|
@@ -262,7 +265,10 @@ export declare namespace Contact {
|
|
|
262
265
|
interface GetQuery {
|
|
263
266
|
/** 此次调用中使用的用户ID的类型 */
|
|
264
267
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
265
|
-
/**
|
|
268
|
+
/**
|
|
269
|
+
* 此次调用中使用的部门ID的类型
|
|
270
|
+
* 不同 ID 的说明 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
|
|
271
|
+
*/
|
|
266
272
|
department_id_type?: 'department_id' | 'open_department_id';
|
|
267
273
|
}
|
|
268
274
|
interface GetResponse {
|
|
@@ -283,15 +289,31 @@ export declare namespace Contact {
|
|
|
283
289
|
interface FindByDepartmentQuery extends Pagination {
|
|
284
290
|
/** 此次调用中使用的用户ID的类型 */
|
|
285
291
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
286
|
-
/**
|
|
292
|
+
/**
|
|
293
|
+
* 此次调用中使用的部门ID的类型
|
|
294
|
+
* 部门ID类型的区别参见[部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
|
|
295
|
+
*/
|
|
287
296
|
department_id_type?: 'department_id' | 'open_department_id';
|
|
288
|
-
/**
|
|
297
|
+
/**
|
|
298
|
+
* 填写该字段表示获取该部门下用户,必填。根部门的部门ID为0。
|
|
299
|
+
* ID值与查询参数中的department_id_type 对应。
|
|
300
|
+
* 不同 ID 的说明与department_id的获取方式参见 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
|
|
301
|
+
*/
|
|
289
302
|
department_id: string;
|
|
290
303
|
}
|
|
291
304
|
interface BatchGetIdRequest {
|
|
292
|
-
/**
|
|
305
|
+
/**
|
|
306
|
+
* 要查询的用户邮箱,最多 50 条。
|
|
307
|
+
* 注意,emails与mobiles相互独立,每条用户邮箱返回对应的用户ID。
|
|
308
|
+
* 本接口返回的用户ID数量为emails数量与mobiles数量的和。
|
|
309
|
+
*/
|
|
293
310
|
emails?: string[];
|
|
294
|
-
/**
|
|
311
|
+
/**
|
|
312
|
+
* 要查询的用户手机号,最多 50 条。
|
|
313
|
+
* 注意
|
|
314
|
+
* 1. emails与mobiles相互独立,每条用户手机号返回对应的用户ID。
|
|
315
|
+
* 2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。
|
|
316
|
+
*/
|
|
295
317
|
mobiles?: string[];
|
|
296
318
|
/** 查询结果包含离职员工,可查询离职用户的ID */
|
|
297
319
|
include_resigned?: boolean;
|
|
@@ -459,7 +481,12 @@ export declare namespace Contact {
|
|
|
459
481
|
description?: string;
|
|
460
482
|
/** 用户组的类型。默认为1表示普通用户组 */
|
|
461
483
|
type?: CreateRequestType;
|
|
462
|
-
/**
|
|
484
|
+
/**
|
|
485
|
+
* 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。
|
|
486
|
+
* 自定义group_id数据校验规则:
|
|
487
|
+
* 最大长度:64 字符
|
|
488
|
+
* 校验规则:数字、大小写字母的组合,不能包含空格
|
|
489
|
+
*/
|
|
463
490
|
group_id?: string;
|
|
464
491
|
}
|
|
465
492
|
interface CreateQuery {
|
|
@@ -475,7 +502,10 @@ export declare namespace Contact {
|
|
|
475
502
|
interface PatchRequest {
|
|
476
503
|
/** 用户组的名字,企业内唯一,最大长度:100 字符 */
|
|
477
504
|
name?: string;
|
|
478
|
-
/**
|
|
505
|
+
/**
|
|
506
|
+
* 用户组描述信息
|
|
507
|
+
* 最大长度:500 字
|
|
508
|
+
*/
|
|
479
509
|
description?: string;
|
|
480
510
|
}
|
|
481
511
|
interface PatchQuery {
|
|
@@ -563,7 +593,11 @@ export declare namespace Contact {
|
|
|
563
593
|
results?: Lark.MemberResult[];
|
|
564
594
|
}
|
|
565
595
|
interface SimplelistQuery extends Pagination {
|
|
566
|
-
/**
|
|
596
|
+
/**
|
|
597
|
+
* 欲获取成员ID类型。
|
|
598
|
+
* 当member_type=user时候,member_id_type表示user_id_type,枚举值open_id, union_id和user_id。
|
|
599
|
+
* 当member_type=department时候,member_id_type表示department_id_type,枚举值open_id和department_id。
|
|
600
|
+
*/
|
|
567
601
|
member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'department_id';
|
|
568
602
|
/** 欲获取的用户组成员类型。 */
|
|
569
603
|
member_type?: 'user' | 'department';
|
|
@@ -754,7 +788,10 @@ export declare namespace Contact {
|
|
|
754
788
|
interface CreateQuery {
|
|
755
789
|
/** 此次调用中使用的用户ID的类型 */
|
|
756
790
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
757
|
-
/**
|
|
791
|
+
/**
|
|
792
|
+
* 此次调用中使用的部门ID的类型
|
|
793
|
+
* 不同 ID 的说明参见[部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
|
|
794
|
+
*/
|
|
758
795
|
department_id_type?: 'department_id' | 'open_department_id';
|
|
759
796
|
/** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
|
|
760
797
|
client_token?: string;
|
|
@@ -837,7 +874,10 @@ export declare namespace Contact {
|
|
|
837
874
|
interface GetQuery {
|
|
838
875
|
/** 此次调用中使用的用户ID的类型 */
|
|
839
876
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
840
|
-
/**
|
|
877
|
+
/**
|
|
878
|
+
* 此次调用中使用的部门ID的类型
|
|
879
|
+
* 不同 ID 的说明 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
|
|
880
|
+
*/
|
|
841
881
|
department_id_type?: 'department_id' | 'open_department_id';
|
|
842
882
|
}
|
|
843
883
|
interface GetResponse {
|
|
@@ -858,7 +898,10 @@ export declare namespace Contact {
|
|
|
858
898
|
interface ChildrenQuery extends Pagination {
|
|
859
899
|
/** 此次调用中使用的用户ID的类型 */
|
|
860
900
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
861
|
-
/**
|
|
901
|
+
/**
|
|
902
|
+
* 此次调用中使用的部门ID的类型
|
|
903
|
+
* 不同 ID 的说明与department_id的获取方式参见 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
|
|
904
|
+
*/
|
|
862
905
|
department_id_type?: 'department_id' | 'open_department_id';
|
|
863
906
|
/** 是否递归获取子部门 */
|
|
864
907
|
fetch_child?: boolean;
|