@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
package/lib/internal.d.ts CHANGED
@@ -29,9 +29,9 @@ export interface InternalRoute {
29
29
  type?: 'raw-json' | 'binary';
30
30
  }
31
31
  export declare class Internal<C extends Context = Context> {
32
- private bot;
33
- constructor(bot: LarkBot<C>);
34
- private _assertResponse;
35
- private _buildData;
32
+ constructor(bot: LarkBot<C>, tree?: Dict);
33
+ private static _assertResponse;
34
+ private static _buildData;
35
+ private static _tree;
36
36
  static define(routes: Dict<Partial<Record<HTTP.Method, string | InternalRoute>>>): void;
37
37
  }
@@ -1,177 +1,217 @@
1
- import { AccessRecord, Device, Feature, Rule, User, UserExternal } 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/acs-v1/user/patch
8
- */
9
- patchAcsUser(user_id: string, body: PatchAcsUserRequest, query?: PatchAcsUserQuery): Promise<void>;
10
- /**
11
- * 获取单个用户信息
12
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get
13
- */
14
- getAcsUser(user_id: string, query?: GetAcsUserQuery): Promise<GetAcsUserResponse>;
15
- /**
16
- * 获取用户列表
17
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list
18
- */
19
- listAcsUser(query?: ListAcsUserQuery): Paginated<User>;
20
- /**
21
- * 上传人脸图片
22
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update
23
- */
24
- updateAcsUserFace(user_id: string, form: UpdateAcsUserFaceForm, query?: UpdateAcsUserFaceQuery): Promise<void>;
25
- /**
26
- * 下载人脸图片
27
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get
28
- */
29
- getAcsUserFace(user_id: string, query?: GetAcsUserFaceQuery): Promise<ArrayBuffer>;
30
- /**
31
- * 设备绑定权限组
32
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind
33
- */
34
- deviceBindAcsRuleExternal(body: DeviceBindAcsRuleExternalRequest): Promise<void>;
35
- /**
36
- * 获取权限组信息
37
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get
38
- */
39
- getAcsRuleExternal(query?: GetAcsRuleExternalQuery): Promise<GetAcsRuleExternalResponse>;
40
- /**
41
- * 删除权限组
42
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete
43
- */
44
- deleteAcsRuleExternal(query?: DeleteAcsRuleExternalQuery): Promise<void>;
45
- /**
46
- * 创建或更新权限组
47
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create
48
- */
49
- createAcsRuleExternal(body: CreateAcsRuleExternalRequest, query?: CreateAcsRuleExternalQuery): Promise<CreateAcsRuleExternalResponse>;
50
- /**
51
- * 删除访客
52
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete
53
- */
54
- deleteAcsVisitor(visitor_id: string, query?: DeleteAcsVisitorQuery): Promise<void>;
55
- /**
56
- * 添加访客
57
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create
58
- */
59
- createAcsVisitor(body: CreateAcsVisitorRequest, query?: CreateAcsVisitorQuery): Promise<CreateAcsVisitorResponse>;
60
- /**
61
- * 获取门禁设备列表
62
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list
63
- */
64
- listAcsDevice(): Promise<ListAcsDeviceResponse>;
65
- /**
66
- * 获取门禁记录列表
67
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list
68
- */
69
- listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Paginated<AccessRecord>;
70
- /**
71
- * 下载开门时的人脸识别图片
72
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get
73
- */
74
- getAcsAccessRecordAccessPhoto(access_record_id: string): Promise<ArrayBuffer>;
5
+ acs: Acs.Methods;
75
6
  }
76
7
  }
77
- export interface PatchAcsUserRequest {
78
- /** 用户特征 */
79
- feature?: Feature;
80
- }
81
- export interface PatchAcsUserQuery {
82
- /** 此次调用中使用的用户ID的类型 */
83
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
84
- }
85
- export interface GetAcsUserQuery {
86
- /** 此次调用中使用的用户ID的类型 */
87
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
88
- }
89
- export interface GetAcsUserResponse {
90
- /** 门禁用户信息 */
91
- user?: User;
92
- }
93
- export interface ListAcsUserQuery extends Pagination {
94
- /** 此次调用中使用的用户ID的类型 */
95
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
96
- }
97
- export interface UpdateAcsUserFaceForm {
98
- /** 人脸图片内容 */
99
- files: Blob;
100
- /** 文件类型,可选的类型有jpg,png */
101
- file_type: string;
102
- /** 带后缀的文件名 */
103
- file_name: string;
104
- }
105
- export interface UpdateAcsUserFaceQuery {
106
- /** 此次调用中使用的用户ID的类型 */
107
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
108
- }
109
- export interface GetAcsUserFaceQuery {
110
- /** 裁剪图 */
111
- is_cropped?: boolean;
112
- /** 此次调用中使用的用户ID的类型 */
113
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
114
- }
115
- export interface DeviceBindAcsRuleExternalRequest {
116
- /** 设备id */
117
- device_id: string;
118
- /** 权限组id列表 */
119
- rule_ids: string[];
120
- }
121
- export interface GetAcsRuleExternalQuery {
122
- /** 设备id */
123
- device_id?: string;
124
- /** 此次调用中使用的用户ID的类型 */
125
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
126
- }
127
- export interface GetAcsRuleExternalResponse {
128
- /** 设备权限组信息 */
129
- rules: Rule[];
130
- }
131
- export interface DeleteAcsRuleExternalQuery {
132
- /** 权限组id */
133
- rule_id: string;
134
- }
135
- export interface CreateAcsRuleExternalRequest {
136
- /** 权限组信息 */
137
- rule: Rule;
138
- }
139
- export interface CreateAcsRuleExternalQuery {
140
- /** 权限组id-为空创建,不为空则更新 */
141
- rule_id?: string;
142
- /** 此次调用中使用的用户ID的类型 */
143
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
144
- }
145
- export interface CreateAcsRuleExternalResponse {
146
- /** 权限组id */
147
- rule_id: string;
148
- }
149
- export interface DeleteAcsVisitorQuery {
150
- /** 此次调用中使用的用户ID的类型 */
151
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
152
- }
153
- export interface CreateAcsVisitorRequest {
154
- /** 访客信息 */
155
- user: UserExternal;
156
- }
157
- export interface CreateAcsVisitorQuery {
158
- /** 此次调用中使用的用户ID的类型 */
159
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
160
- }
161
- export interface CreateAcsVisitorResponse {
162
- /** 访客的id */
163
- visitor_id: string;
164
- }
165
- export interface ListAcsDeviceResponse {
166
- items?: Device[];
167
- }
168
- export interface ListAcsAccessRecordQuery extends Pagination {
169
- /** 记录开始时间,单位秒 */
170
- from: number;
171
- /** 记录结束时间,单位秒,时间跨度不能超过30天 */
172
- to: number;
173
- /** 门禁设备 ID */
174
- device_id?: string;
175
- /** 此次调用中使用的用户ID的类型 */
176
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
8
+ export declare namespace Acs {
9
+ interface Methods {
10
+ user: User.Methods;
11
+ ruleExternal: RuleExternal.Methods;
12
+ visitor: Visitor.Methods;
13
+ device: Device.Methods;
14
+ accessRecord: AccessRecord.Methods;
15
+ }
16
+ namespace User {
17
+ interface Methods {
18
+ face: Face.Methods;
19
+ /**
20
+ * 修改用户部分信息
21
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch
22
+ */
23
+ patch(user_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
24
+ /**
25
+ * 获取单个用户信息
26
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get
27
+ */
28
+ get(user_id: string, query?: GetQuery): Promise<GetResponse>;
29
+ /**
30
+ * 获取用户列表
31
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list
32
+ */
33
+ list(query?: ListQuery): Paginated<Lark.User>;
34
+ }
35
+ interface PatchRequest {
36
+ /** 用户特征 */
37
+ feature?: Lark.Feature;
38
+ }
39
+ interface PatchQuery {
40
+ /** 此次调用中使用的用户ID的类型 */
41
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
42
+ }
43
+ interface GetQuery {
44
+ /** 此次调用中使用的用户ID的类型 */
45
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
46
+ }
47
+ interface GetResponse {
48
+ /** 门禁用户信息 */
49
+ user?: Lark.User;
50
+ }
51
+ interface ListQuery extends Pagination {
52
+ /** 此次调用中使用的用户ID的类型 */
53
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
54
+ }
55
+ namespace Face {
56
+ interface Methods {
57
+ /**
58
+ * 上传人脸图片
59
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update
60
+ */
61
+ update(user_id: string, form: UpdateForm, query?: UpdateQuery): Promise<void>;
62
+ /**
63
+ * 下载人脸图片
64
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get
65
+ */
66
+ get(user_id: string, query?: GetQuery): Promise<ArrayBuffer>;
67
+ }
68
+ interface UpdateForm {
69
+ /** 人脸图片内容 */
70
+ files: Blob;
71
+ /** 文件类型,可选的类型有jpg,png */
72
+ file_type: string;
73
+ /** 带后缀的文件名 */
74
+ file_name: string;
75
+ }
76
+ interface UpdateQuery {
77
+ /** 此次调用中使用的用户ID的类型 */
78
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
79
+ }
80
+ interface GetQuery {
81
+ /** 裁剪图 */
82
+ is_cropped?: boolean;
83
+ /** 此次调用中使用的用户ID的类型 */
84
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
85
+ }
86
+ }
87
+ }
88
+ namespace RuleExternal {
89
+ interface Methods {
90
+ /**
91
+ * 设备绑定权限组
92
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind
93
+ */
94
+ deviceBind(body: DeviceBindRequest): Promise<void>;
95
+ /**
96
+ * 获取权限组信息
97
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get
98
+ */
99
+ get(query?: GetQuery): Promise<GetResponse>;
100
+ /**
101
+ * 删除权限组
102
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete
103
+ */
104
+ delete(query?: DeleteQuery): Promise<void>;
105
+ /**
106
+ * 创建或更新权限组
107
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create
108
+ */
109
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
110
+ }
111
+ interface DeviceBindRequest {
112
+ /** 设备id */
113
+ device_id: string;
114
+ /** 权限组id列表 */
115
+ rule_ids: string[];
116
+ }
117
+ interface GetQuery {
118
+ /** 设备id */
119
+ device_id?: string;
120
+ /** 此次调用中使用的用户ID的类型 */
121
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
122
+ }
123
+ interface GetResponse {
124
+ /** 设备权限组信息 */
125
+ rules: Lark.Rule[];
126
+ }
127
+ interface DeleteQuery {
128
+ /** 权限组id */
129
+ rule_id: string;
130
+ }
131
+ interface CreateRequest {
132
+ /** 权限组信息 */
133
+ rule: Lark.Rule;
134
+ }
135
+ interface CreateQuery {
136
+ /** 权限组id-为空创建,不为空则更新 */
137
+ rule_id?: string;
138
+ /** 此次调用中使用的用户ID的类型 */
139
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
140
+ }
141
+ interface CreateResponse {
142
+ /** 权限组id */
143
+ rule_id: string;
144
+ }
145
+ }
146
+ namespace Visitor {
147
+ interface Methods {
148
+ /**
149
+ * 删除访客
150
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete
151
+ */
152
+ delete(visitor_id: string, query?: DeleteQuery): Promise<void>;
153
+ /**
154
+ * 添加访客
155
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create
156
+ */
157
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
158
+ }
159
+ interface DeleteQuery {
160
+ /** 此次调用中使用的用户ID的类型 */
161
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
162
+ }
163
+ interface CreateRequest {
164
+ /** 访客信息 */
165
+ user: Lark.UserExternal;
166
+ }
167
+ interface CreateQuery {
168
+ /** 此次调用中使用的用户ID的类型 */
169
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
170
+ }
171
+ interface CreateResponse {
172
+ /** 访客的id */
173
+ visitor_id: string;
174
+ }
175
+ }
176
+ namespace Device {
177
+ interface Methods {
178
+ /**
179
+ * 获取门禁设备列表
180
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list
181
+ */
182
+ list(): Promise<ListResponse>;
183
+ }
184
+ interface ListResponse {
185
+ items?: Lark.Device[];
186
+ }
187
+ }
188
+ namespace AccessRecord {
189
+ interface Methods {
190
+ accessPhoto: AccessPhoto.Methods;
191
+ /**
192
+ * 获取门禁记录列表
193
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list
194
+ */
195
+ list(query?: ListQuery): Paginated<Lark.AccessRecord>;
196
+ }
197
+ interface ListQuery extends Pagination {
198
+ /** 记录开始时间,单位秒 */
199
+ from: number;
200
+ /** 记录结束时间,单位秒,时间跨度不能超过30天 */
201
+ to: number;
202
+ /** 门禁设备 ID */
203
+ device_id?: string;
204
+ /** 此次调用中使用的用户ID的类型 */
205
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
206
+ }
207
+ namespace AccessPhoto {
208
+ interface Methods {
209
+ /**
210
+ * 下载开门时的人脸识别图片
211
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get
212
+ */
213
+ get(access_record_id: string): Promise<ArrayBuffer>;
214
+ }
215
+ }
216
+ }
177
217
  }