@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/directory.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ export declare namespace Directory {
|
|
|
21
21
|
*/
|
|
22
22
|
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* 更新员工信息
|
|
25
25
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/patch
|
|
26
26
|
*/
|
|
27
27
|
patch(employee_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
|
|
@@ -56,15 +56,10 @@ export declare namespace Directory {
|
|
|
56
56
|
*/
|
|
57
57
|
filter(body: FilterRequest, query?: FilterQuery): Promise<FilterResponse>;
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* 搜索员工信息
|
|
60
60
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/search
|
|
61
61
|
*/
|
|
62
62
|
search(body: SearchRequest, query?: SearchQuery): Promise<SearchResponse>;
|
|
63
|
-
/**
|
|
64
|
-
* 转换员工 ID
|
|
65
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/idconvert
|
|
66
|
-
*/
|
|
67
|
-
idconvert(body: IdconvertRequest, query?: IdconvertQuery): Promise<IdconvertResponse>;
|
|
68
63
|
}
|
|
69
64
|
interface CreateRequest {
|
|
70
65
|
/** 创建员工对象 */
|
|
@@ -190,20 +185,6 @@ export declare namespace Directory {
|
|
|
190
185
|
/** 字段异常信息 */
|
|
191
186
|
abnormals?: Lark.AbnormalRecord[];
|
|
192
187
|
}
|
|
193
|
-
interface IdconvertRequest {
|
|
194
|
-
/** 用户ID列表 */
|
|
195
|
-
employee_ids: string[];
|
|
196
|
-
}
|
|
197
|
-
interface IdconvertQuery {
|
|
198
|
-
/** 员工ID类型 */
|
|
199
|
-
employee_id_type?: 'open_id' | 'union_id' | 'employee_id';
|
|
200
|
-
}
|
|
201
|
-
interface IdconvertResponse {
|
|
202
|
-
/** id转换结果列表 */
|
|
203
|
-
id_convert_results?: Lark.EmployeeIdConvertResult[];
|
|
204
|
-
/** 异常信息列表 */
|
|
205
|
-
abnormals?: Lark.AbnormalRecord[];
|
|
206
|
-
}
|
|
207
188
|
}
|
|
208
189
|
namespace Department {
|
|
209
190
|
interface Methods {
|
|
@@ -228,7 +209,7 @@ export declare namespace Directory {
|
|
|
228
209
|
*/
|
|
229
210
|
mget(body: MgetRequest, query?: MgetQuery): Promise<MgetResponse>;
|
|
230
211
|
/**
|
|
231
|
-
*
|
|
212
|
+
* 获取部门列表
|
|
232
213
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/filter
|
|
233
214
|
*/
|
|
234
215
|
filter(body: FilterRequest, query?: FilterQuery): Promise<FilterResponse>;
|
|
@@ -237,11 +218,6 @@ export declare namespace Directory {
|
|
|
237
218
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/search
|
|
238
219
|
*/
|
|
239
220
|
search(body: SearchRequest, query?: SearchQuery): Promise<SearchResponse>;
|
|
240
|
-
/**
|
|
241
|
-
* 转换部门 ID
|
|
242
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/idconvert
|
|
243
|
-
*/
|
|
244
|
-
idconvert(body: IdconvertRequest, query?: IdconvertQuery): Promise<IdconvertResponse>;
|
|
245
221
|
}
|
|
246
222
|
interface CreateRequest {
|
|
247
223
|
/** 创建部门 */
|
|
@@ -333,20 +309,6 @@ export declare namespace Directory {
|
|
|
333
309
|
/** 字段异常信息 */
|
|
334
310
|
abnormals?: Lark.AbnormalRecord[];
|
|
335
311
|
}
|
|
336
|
-
interface IdconvertRequest {
|
|
337
|
-
/** 部门ID列表 */
|
|
338
|
-
department_ids: string[];
|
|
339
|
-
}
|
|
340
|
-
interface IdconvertQuery {
|
|
341
|
-
/** 部门ID类型 */
|
|
342
|
-
department_id_type?: 'department_id' | 'open_department_id';
|
|
343
|
-
}
|
|
344
|
-
interface IdconvertResponse {
|
|
345
|
-
/** id转换结果列表 */
|
|
346
|
-
id_convert_results?: Lark.DepartmentIdConvertResult[];
|
|
347
|
-
/** 异常信息列表 */
|
|
348
|
-
abnormals?: Lark.AbnormalRecord[];
|
|
349
|
-
}
|
|
350
312
|
}
|
|
351
313
|
namespace CollborationShareEntity {
|
|
352
314
|
interface Methods {
|
package/lib/types/docx.d.ts
CHANGED
|
@@ -186,6 +186,11 @@ export declare namespace Docx {
|
|
|
186
186
|
* @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/raw_content
|
|
187
187
|
*/
|
|
188
188
|
rawContent(document_id: string, query?: RawContentQuery): Promise<RawContentResponse>;
|
|
189
|
+
/**
|
|
190
|
+
* Markdown/HTML 内容转换为文档块
|
|
191
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/convert
|
|
192
|
+
*/
|
|
193
|
+
convert(body: ConvertRequest, query?: ConvertQuery): Promise<ConvertResponse>;
|
|
189
194
|
}
|
|
190
195
|
interface CreateRequest {
|
|
191
196
|
/** 文件夹 token,获取方式见云文档接口快速入门;空表示根目录,tenant_access_token应用权限仅允许操作应用创建的目录 */
|
|
@@ -217,6 +222,24 @@ export declare namespace Docx {
|
|
|
217
222
|
/** 文档纯文本 */
|
|
218
223
|
content?: string;
|
|
219
224
|
}
|
|
225
|
+
interface ConvertRequest {
|
|
226
|
+
/** 内容类型 */
|
|
227
|
+
content_type: 'markdown' | 'html';
|
|
228
|
+
/** 文本内容 */
|
|
229
|
+
content: string;
|
|
230
|
+
}
|
|
231
|
+
interface ConvertQuery {
|
|
232
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
233
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
234
|
+
}
|
|
235
|
+
interface ConvertResponse {
|
|
236
|
+
/** 第一级 Block 对应的临时 ID 列表, index 代表了 Block 的顺序 */
|
|
237
|
+
first_level_block_ids?: string[];
|
|
238
|
+
/** 带有父子关系的 Block 列表 */
|
|
239
|
+
blocks?: Lark.Block[];
|
|
240
|
+
/** 如果要转换的内容中带有图片,这里记录了临时 Block ID 和 Image URL 的对应关系 */
|
|
241
|
+
block_id_to_image_urls?: Lark.BlockIdToImageUrl[];
|
|
242
|
+
}
|
|
220
243
|
namespace Block {
|
|
221
244
|
interface Methods {
|
|
222
245
|
children: Children.Methods;
|
package/lib/types/drive.d.ts
CHANGED
|
@@ -191,7 +191,10 @@ export declare namespace Drive {
|
|
|
191
191
|
file_name: string;
|
|
192
192
|
/** 上传点类型。 */
|
|
193
193
|
parent_type: 'explorer';
|
|
194
|
-
/**
|
|
194
|
+
/**
|
|
195
|
+
* 文件夹token,
|
|
196
|
+
* 获取方式见 [概述](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction)
|
|
197
|
+
*/
|
|
195
198
|
parent_node: string;
|
|
196
199
|
/** 文件大小(以字节为单位)。 */
|
|
197
200
|
size: number;
|
|
@@ -863,95 +866,41 @@ export declare namespace Drive {
|
|
|
863
866
|
}
|
|
864
867
|
namespace Member {
|
|
865
868
|
interface Methods {
|
|
869
|
+
/**
|
|
870
|
+
* 增加协作者权限
|
|
871
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create
|
|
872
|
+
*/
|
|
873
|
+
create(token: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
866
874
|
/**
|
|
867
875
|
* 批量增加协作者权限
|
|
868
876
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/batch_create
|
|
869
877
|
*/
|
|
870
878
|
batchCreate(token: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>;
|
|
871
879
|
/**
|
|
872
|
-
*
|
|
873
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/
|
|
874
|
-
*/
|
|
875
|
-
transferOwner(token: string, body: TransferOwnerRequest, query?: TransferOwnerQuery): Promise<void>;
|
|
876
|
-
/**
|
|
877
|
-
* 判断当前用户是否有某权限
|
|
878
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth
|
|
880
|
+
* 更新协作者权限
|
|
881
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update
|
|
879
882
|
*/
|
|
880
|
-
|
|
883
|
+
update(token: string, member_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
|
|
881
884
|
/**
|
|
882
|
-
*
|
|
885
|
+
* 获取云文档协作者
|
|
883
886
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list
|
|
884
887
|
*/
|
|
885
888
|
list(token: string, query?: ListQuery): Promise<ListResponse>;
|
|
886
889
|
/**
|
|
887
|
-
*
|
|
888
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/
|
|
890
|
+
* 移除云文档协作者权限
|
|
891
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete
|
|
889
892
|
*/
|
|
890
|
-
|
|
893
|
+
delete(token: string, member_id: string, body: DeleteRequest, query?: DeleteQuery): Promise<void>;
|
|
891
894
|
/**
|
|
892
|
-
*
|
|
893
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/
|
|
895
|
+
* 转移云文档所有者
|
|
896
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner
|
|
894
897
|
*/
|
|
895
|
-
|
|
898
|
+
transferOwner(token: string, body: TransferOwnerRequest, query?: TransferOwnerQuery): Promise<void>;
|
|
896
899
|
/**
|
|
897
|
-
*
|
|
898
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/
|
|
900
|
+
* 判断用户云文档权限
|
|
901
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth
|
|
899
902
|
*/
|
|
900
|
-
|
|
901
|
-
}
|
|
902
|
-
interface BatchCreateRequest {
|
|
903
|
-
/** 协作者列表 */
|
|
904
|
-
members: Lark.BaseMember[];
|
|
905
|
-
}
|
|
906
|
-
interface BatchCreateQuery {
|
|
907
|
-
/** 文件的类型 */
|
|
908
|
-
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
|
|
909
|
-
/** 添加权限后是否通知对方 */
|
|
910
|
-
need_notification?: boolean;
|
|
911
|
-
}
|
|
912
|
-
interface BatchCreateResponse {
|
|
913
|
-
/** 协作者列表 */
|
|
914
|
-
members?: Lark.BaseMember[];
|
|
915
|
-
}
|
|
916
|
-
interface TransferOwnerRequest {
|
|
917
|
-
/** 文档拥有者的ID类型 */
|
|
918
|
-
member_type: 'email' | 'openid' | 'userid';
|
|
919
|
-
/** 文档拥有者的ID,与文档拥有者的ID类型需要对应 */
|
|
920
|
-
member_id: string;
|
|
921
|
-
}
|
|
922
|
-
interface TransferOwnerQuery {
|
|
923
|
-
/** 文件类型,需要与文件的 token 相匹配 */
|
|
924
|
-
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' | 'folder';
|
|
925
|
-
/** 是否需要通知新 Owner */
|
|
926
|
-
need_notification?: boolean;
|
|
927
|
-
/** 转移后是否需要移除原 Owner 的权限 */
|
|
928
|
-
remove_old_owner?: boolean;
|
|
929
|
-
/** 仅当内容不在共享文件夹中,此参数才会生效。如果设为false,系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true,则留在原位置。 */
|
|
930
|
-
stay_put?: boolean;
|
|
931
|
-
/** 仅当 remove_old_owner = false 时,此参数才会生效 保留原文件所有者指定的权限角色 */
|
|
932
|
-
old_owner_perm?: string;
|
|
933
|
-
}
|
|
934
|
-
interface AuthQuery {
|
|
935
|
-
/** 文件类型,需要与文件的 token 相匹配 */
|
|
936
|
-
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
|
|
937
|
-
/** 需要判断的权限 */
|
|
938
|
-
action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public';
|
|
939
|
-
}
|
|
940
|
-
interface AuthResponse {
|
|
941
|
-
/** 是否有权限 */
|
|
942
|
-
auth_result: boolean;
|
|
943
|
-
}
|
|
944
|
-
interface ListQuery {
|
|
945
|
-
/** 文件类型,需要与文件的 token 相匹配 */
|
|
946
|
-
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
|
|
947
|
-
/** 指定返回的协作者字段信息,如无指定则默认不返回**可选值有:** - `name`:协作者名- `type`:协作者类型- `avatar`:头像- `external_label`:外部标签**注意:** - 你可以使用特殊值`*`指定返回目前支持的所有字段- 你可以使用`,`分隔若干个你想指定返回的字段,如:`name,avatar`- 按需指定返回字段接口性能更好 */
|
|
948
|
-
fields?: string;
|
|
949
|
-
/** 协作者的权限角色类型 */
|
|
950
|
-
perm_type?: 'container' | 'single_page';
|
|
951
|
-
}
|
|
952
|
-
interface ListResponse {
|
|
953
|
-
/** 返回的列表数据 */
|
|
954
|
-
items?: Lark.Member[];
|
|
903
|
+
auth(token: string, query?: AuthQuery): Promise<AuthResponse>;
|
|
955
904
|
}
|
|
956
905
|
interface CreateRequest {
|
|
957
906
|
/** 协作者ID类型 */
|
|
@@ -975,6 +924,20 @@ export declare namespace Drive {
|
|
|
975
924
|
/** 本次添加权限的用户信息 */
|
|
976
925
|
member?: Lark.BaseMember;
|
|
977
926
|
}
|
|
927
|
+
interface BatchCreateRequest {
|
|
928
|
+
/** 协作者列表 */
|
|
929
|
+
members: Lark.BaseMember[];
|
|
930
|
+
}
|
|
931
|
+
interface BatchCreateQuery {
|
|
932
|
+
/** 文件的类型 */
|
|
933
|
+
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
|
|
934
|
+
/** 添加权限后是否通知对方 */
|
|
935
|
+
need_notification?: boolean;
|
|
936
|
+
}
|
|
937
|
+
interface BatchCreateResponse {
|
|
938
|
+
/** 协作者列表 */
|
|
939
|
+
members?: Lark.BaseMember[];
|
|
940
|
+
}
|
|
978
941
|
interface UpdateRequest {
|
|
979
942
|
/** 协作者ID类型 */
|
|
980
943
|
member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid';
|
|
@@ -986,7 +949,10 @@ export declare namespace Drive {
|
|
|
986
949
|
type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
|
|
987
950
|
}
|
|
988
951
|
interface UpdateQuery {
|
|
989
|
-
/**
|
|
952
|
+
/**
|
|
953
|
+
* 更新权限后是否通知对方
|
|
954
|
+
* **注意:** 使用`tenant_access_token`访问不支持该参数
|
|
955
|
+
*/
|
|
990
956
|
need_notification?: boolean;
|
|
991
957
|
/** 文件类型,放于query参数中,如:`?type=doc` */
|
|
992
958
|
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
|
|
@@ -995,6 +961,29 @@ export declare namespace Drive {
|
|
|
995
961
|
/** 本次更新权限的用户信息 */
|
|
996
962
|
member?: Lark.BaseMember;
|
|
997
963
|
}
|
|
964
|
+
interface ListQuery {
|
|
965
|
+
/** 文件类型,需要与文件的 token 相匹配 */
|
|
966
|
+
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
|
|
967
|
+
/**
|
|
968
|
+
* 指定返回的协作者字段信息,如无指定则默认不返回
|
|
969
|
+
* **可选值有:**
|
|
970
|
+
* - `name`:协作者名
|
|
971
|
+
* - `type`:协作者类型
|
|
972
|
+
* - `avatar`:头像
|
|
973
|
+
* - `external_label`:外部标签
|
|
974
|
+
* **注意:**
|
|
975
|
+
* - 你可以使用特殊值`*`指定返回目前支持的所有字段
|
|
976
|
+
* - 你可以使用`,`分隔若干个你想指定返回的字段,如:`name,avatar`
|
|
977
|
+
* - 按需指定返回字段接口性能更好
|
|
978
|
+
*/
|
|
979
|
+
fields?: string;
|
|
980
|
+
/** 协作者的权限角色类型 */
|
|
981
|
+
perm_type?: 'container' | 'single_page';
|
|
982
|
+
}
|
|
983
|
+
interface ListResponse {
|
|
984
|
+
/** 返回的列表数据 */
|
|
985
|
+
items?: Lark.Member[];
|
|
986
|
+
}
|
|
998
987
|
interface DeleteRequest {
|
|
999
988
|
/** 协作者类型 */
|
|
1000
989
|
type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
|
|
@@ -1007,28 +996,48 @@ export declare namespace Drive {
|
|
|
1007
996
|
/** 权限成员类型,放于query参数中,如:`?member_type=openid` */
|
|
1008
997
|
member_type: 'email' | 'openid' | 'openchat' | 'opendepartmentid' | 'userid' | 'unionid' | 'groupid' | 'wikispaceid';
|
|
1009
998
|
}
|
|
999
|
+
interface TransferOwnerRequest {
|
|
1000
|
+
/** 文档拥有者的ID类型 */
|
|
1001
|
+
member_type: 'email' | 'openid' | 'userid';
|
|
1002
|
+
/** 文档拥有者的ID,与文档拥有者的ID类型需要对应 */
|
|
1003
|
+
member_id: string;
|
|
1004
|
+
}
|
|
1005
|
+
interface TransferOwnerQuery {
|
|
1006
|
+
/** 文件类型,需要与文件的 token 相匹配 */
|
|
1007
|
+
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' | 'folder';
|
|
1008
|
+
/** 是否需要通知新 Owner */
|
|
1009
|
+
need_notification?: boolean;
|
|
1010
|
+
/** 转移后是否需要移除原 Owner 的权限 */
|
|
1011
|
+
remove_old_owner?: boolean;
|
|
1012
|
+
/** 仅当内容不在共享文件夹中,此参数才会生效。如果设为false,系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true,则留在原位置。 */
|
|
1013
|
+
stay_put?: boolean;
|
|
1014
|
+
/** 仅当 remove_old_owner = false 时,此参数才会生效 保留原文件所有者指定的权限角色 */
|
|
1015
|
+
old_owner_perm?: string;
|
|
1016
|
+
}
|
|
1017
|
+
interface AuthQuery {
|
|
1018
|
+
/** 文件类型,需要与文件的 token 相匹配 */
|
|
1019
|
+
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
|
|
1020
|
+
/** 需要判断的权限 */
|
|
1021
|
+
action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public';
|
|
1022
|
+
}
|
|
1023
|
+
interface AuthResponse {
|
|
1024
|
+
/** 是否有权限 */
|
|
1025
|
+
auth_result: boolean;
|
|
1026
|
+
}
|
|
1010
1027
|
}
|
|
1011
1028
|
namespace Public {
|
|
1012
1029
|
interface Methods {
|
|
1013
1030
|
password: Password.Methods;
|
|
1014
|
-
/**
|
|
1015
|
-
* 获取云文档权限设置
|
|
1016
|
-
* @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get
|
|
1017
|
-
*/
|
|
1018
|
-
get(token: string, query?: GetQuery): Promise<GetResponse>;
|
|
1019
1031
|
/**
|
|
1020
1032
|
* 更新云文档权限设置
|
|
1021
1033
|
* @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch
|
|
1022
1034
|
*/
|
|
1023
1035
|
patch(token: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
interface GetResponse {
|
|
1030
|
-
/** 返回的文档公共设置 */
|
|
1031
|
-
permission_public?: Lark.PermissionPublic;
|
|
1036
|
+
/**
|
|
1037
|
+
* 获取云文档权限设置
|
|
1038
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get
|
|
1039
|
+
*/
|
|
1040
|
+
get(token: string, query?: GetQuery): Promise<GetResponse>;
|
|
1032
1041
|
}
|
|
1033
1042
|
interface PatchRequest {
|
|
1034
1043
|
/** 允许内容被分享到组织外 */
|
|
@@ -1054,20 +1063,28 @@ export declare namespace Drive {
|
|
|
1054
1063
|
/** 本次更新后文档公共设置 */
|
|
1055
1064
|
permission_public?: Lark.PermissionPublic;
|
|
1056
1065
|
}
|
|
1066
|
+
interface GetQuery {
|
|
1067
|
+
/** 文件类型,需要与文件的 token 相匹配 */
|
|
1068
|
+
type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
|
|
1069
|
+
}
|
|
1070
|
+
interface GetResponse {
|
|
1071
|
+
/** 返回的文档公共设置 */
|
|
1072
|
+
permission_public?: Lark.PermissionPublic;
|
|
1073
|
+
}
|
|
1057
1074
|
namespace Password {
|
|
1058
1075
|
interface Methods {
|
|
1059
1076
|
/**
|
|
1060
|
-
*
|
|
1077
|
+
* 启用云文档密码
|
|
1061
1078
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create
|
|
1062
1079
|
*/
|
|
1063
1080
|
create(token: string, query?: CreateQuery): Promise<CreateResponse>;
|
|
1064
1081
|
/**
|
|
1065
|
-
*
|
|
1082
|
+
* 刷新云文档密码
|
|
1066
1083
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update
|
|
1067
1084
|
*/
|
|
1068
1085
|
update(token: string, query?: UpdateQuery): Promise<UpdateResponse>;
|
|
1069
1086
|
/**
|
|
1070
|
-
*
|
|
1087
|
+
* 停用云文档密码
|
|
1071
1088
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete
|
|
1072
1089
|
*/
|
|
1073
1090
|
delete(token: string, query?: DeleteQuery): Promise<void>;
|
package/lib/types/ehr.d.ts
CHANGED
|
@@ -45,7 +45,11 @@ export declare namespace Ehr {
|
|
|
45
45
|
interface ListQuery extends Pagination {
|
|
46
46
|
/** 返回数据类型 */
|
|
47
47
|
view?: 'basic' | 'full';
|
|
48
|
-
/**
|
|
48
|
+
/**
|
|
49
|
+
* 员工状态,不传代表查询所有员工状态
|
|
50
|
+
* 实际在职 = 2&4
|
|
51
|
+
* 可同时查询多个状态的记录,如 status=2&status=4
|
|
52
|
+
*/
|
|
49
53
|
status?: ListQueryStatus[];
|
|
50
54
|
/** 雇员类型,不传代表查询所有雇员类型 */
|
|
51
55
|
type?: ListQueryType[];
|
|
@@ -55,7 +59,12 @@ export declare namespace Ehr {
|
|
|
55
59
|
end_time?: string;
|
|
56
60
|
/** 此次调用中使用的用户ID的类型 */
|
|
57
61
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
58
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* user_id、open_id 或 union_id,默认为 open_id。
|
|
64
|
+
* 如果传入的值不是 open_id,需要一并传入 user_id_type 参数。
|
|
65
|
+
* 可一次查询多个 id 的用户,例如:user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde
|
|
66
|
+
* [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)
|
|
67
|
+
*/
|
|
59
68
|
user_ids?: string[];
|
|
60
69
|
}
|
|
61
70
|
}
|
package/lib/types/helpdesk.d.ts
CHANGED
|
@@ -202,11 +202,11 @@ export declare namespace Helpdesk {
|
|
|
202
202
|
interface StartServiceRequest {
|
|
203
203
|
/** 是否直接进入人工(若appointed_agents填写了,该值为必填) */
|
|
204
204
|
human_service?: boolean;
|
|
205
|
-
/** 客服 open ids (获取方式参考[获取单个用户信息](/
|
|
205
|
+
/** 客服 open ids (获取方式参考[获取单个用户信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)),human_service需要为true */
|
|
206
206
|
appointed_agents?: string[];
|
|
207
|
-
/** 用户 open id,(获取方式参考[获取单个用户信息](/
|
|
207
|
+
/** 用户 open id,(获取方式参考[获取单个用户信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */
|
|
208
208
|
open_id: string;
|
|
209
|
-
/** 工单来源自定义信息,长度限制1024字符,如设置,[获取工单详情](/
|
|
209
|
+
/** 工单来源自定义信息,长度限制1024字符,如设置,[获取工单详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */
|
|
210
210
|
customized_info?: string;
|
|
211
211
|
}
|
|
212
212
|
interface StartServiceResponse {
|
|
@@ -277,7 +277,10 @@ export declare namespace Helpdesk {
|
|
|
277
277
|
interface TicketImageQuery {
|
|
278
278
|
/** 工单ID */
|
|
279
279
|
ticket_id: string;
|
|
280
|
-
/**
|
|
280
|
+
/**
|
|
281
|
+
* 消息ID
|
|
282
|
+
* [查询消息ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list)
|
|
283
|
+
*/
|
|
281
284
|
msg_id: string;
|
|
282
285
|
/** index,当消息类型为post时,需指定图片index,index从0开始。当消息类型为img时,无需index */
|
|
283
286
|
index?: number;
|
|
@@ -314,7 +317,10 @@ export declare namespace Helpdesk {
|
|
|
314
317
|
interface CreateRequest {
|
|
315
318
|
/** 消息类型;text:纯文本;post:富文本 */
|
|
316
319
|
msg_type: string;
|
|
317
|
-
/**
|
|
320
|
+
/**
|
|
321
|
+
* - 纯文本,参考[发送文本消息](https://open.feishu.cn/document/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content;
|
|
322
|
+
* - 富文本,参考[发送富文本消息](https://open.feishu.cn/document/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content
|
|
323
|
+
*/
|
|
318
324
|
content: string;
|
|
319
325
|
}
|
|
320
326
|
interface CreateResponse {
|
|
@@ -551,7 +557,10 @@ export declare namespace Helpdesk {
|
|
|
551
557
|
items?: Lark.Faq[];
|
|
552
558
|
}
|
|
553
559
|
interface SearchQuery extends Pagination {
|
|
554
|
-
/**
|
|
560
|
+
/**
|
|
561
|
+
* 搜索query
|
|
562
|
+
* ,query内容如果不是英文,包含中文空格等有两种编码策略:1. url编码 2. base64编码,同时加上base64=true参数
|
|
563
|
+
*/
|
|
555
564
|
query: string;
|
|
556
565
|
/** 是否转换为base64,输入true表示是,不填写表示否,中文需要转换为base64 */
|
|
557
566
|
base64?: string;
|
package/lib/types/hire.d.ts
CHANGED
|
@@ -26,10 +26,12 @@ export declare namespace Hire {
|
|
|
26
26
|
interviewRoundType: InterviewRoundType.Methods;
|
|
27
27
|
interviewRegistrationSchema: InterviewRegistrationSchema.Methods;
|
|
28
28
|
interviewer: Interviewer.Methods;
|
|
29
|
+
offerApprovalTemplate: OfferApprovalTemplate.Methods;
|
|
29
30
|
offerCustomField: OfferCustomField.Methods;
|
|
30
31
|
offerApplicationForm: OfferApplicationForm.Methods;
|
|
31
32
|
referral: Referral.Methods;
|
|
32
33
|
referralWebsite: ReferralWebsite.Methods;
|
|
34
|
+
portalApplySchema: PortalApplySchema.Methods;
|
|
33
35
|
website: Website.Methods;
|
|
34
36
|
agency: Agency.Methods;
|
|
35
37
|
talent: Talent.Methods;
|
|
@@ -1144,6 +1146,19 @@ export declare namespace Hire {
|
|
|
1144
1146
|
interviewer?: Lark.Interviewer;
|
|
1145
1147
|
}
|
|
1146
1148
|
}
|
|
1149
|
+
namespace OfferApprovalTemplate {
|
|
1150
|
+
interface Methods {
|
|
1151
|
+
/**
|
|
1152
|
+
* 获取 Offer 审批流列表
|
|
1153
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_approval_template/list
|
|
1154
|
+
*/
|
|
1155
|
+
list(query?: ListQuery): Paginated<Lark.OfferApprovalTemplate>;
|
|
1156
|
+
}
|
|
1157
|
+
interface ListQuery extends Pagination {
|
|
1158
|
+
/** 此次调用中使用的部门 ID 的类型 */
|
|
1159
|
+
department_id_type?: 'open_department_id' | 'department_id' | 'people_admin_department_id';
|
|
1160
|
+
}
|
|
1161
|
+
}
|
|
1147
1162
|
namespace OfferCustomField {
|
|
1148
1163
|
interface Methods {
|
|
1149
1164
|
/**
|
|
@@ -1263,6 +1278,15 @@ export declare namespace Hire {
|
|
|
1263
1278
|
}
|
|
1264
1279
|
}
|
|
1265
1280
|
}
|
|
1281
|
+
namespace PortalApplySchema {
|
|
1282
|
+
interface Methods {
|
|
1283
|
+
/**
|
|
1284
|
+
* 获取申请表模板列表
|
|
1285
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/portal_apply_schema/list
|
|
1286
|
+
*/
|
|
1287
|
+
list(query?: Pagination): Paginated<Lark.RegistrationSchema>;
|
|
1288
|
+
}
|
|
1289
|
+
}
|
|
1266
1290
|
namespace Website {
|
|
1267
1291
|
interface Methods {
|
|
1268
1292
|
channel: Channel.Methods;
|
|
@@ -1703,7 +1727,7 @@ export declare namespace Hire {
|
|
|
1703
1727
|
tag_id_list: string[];
|
|
1704
1728
|
}
|
|
1705
1729
|
interface CombinedCreateRequest {
|
|
1706
|
-
/** 简历来源 ID,可通过[获取简历来源列表](/
|
|
1730
|
+
/** 简历来源 ID,可通过[获取简历来源列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */
|
|
1707
1731
|
init_source_id?: string;
|
|
1708
1732
|
/** 简历来源 ID */
|
|
1709
1733
|
resume_source_id?: string;
|
|
@@ -1753,7 +1777,7 @@ export declare namespace Hire {
|
|
|
1753
1777
|
interface CombinedUpdateRequest {
|
|
1754
1778
|
/** 人才 ID */
|
|
1755
1779
|
talent_id: string;
|
|
1756
|
-
/** 简历来源 ID,可通过[获取简历来源列表](/
|
|
1780
|
+
/** 简历来源 ID,可通过[获取简历来源列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */
|
|
1757
1781
|
init_source_id?: string;
|
|
1758
1782
|
/** 文件夹 ID 列表 */
|
|
1759
1783
|
folder_id_list?: string[];
|
|
@@ -2792,7 +2816,7 @@ export declare namespace Hire {
|
|
|
2792
2816
|
exam_resource_name: string;
|
|
2793
2817
|
/** 笔试分数 */
|
|
2794
2818
|
score: number;
|
|
2795
|
-
/** 报告附件,使用[创建附件](/
|
|
2819
|
+
/** 报告附件,使用[创建附件](https://open.feishu.cn/document/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment)上传,获取附件ID,支持的文件格式:JPG、JPEG、PNG、PDF,不超过 100MB。 */
|
|
2796
2820
|
uuid?: string;
|
|
2797
2821
|
/** 添加人 ID */
|
|
2798
2822
|
operator_id: string;
|
|
@@ -3162,6 +3186,11 @@ export declare namespace Hire {
|
|
|
3162
3186
|
* @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/background_check_order/list
|
|
3163
3187
|
*/
|
|
3164
3188
|
list(query?: ListQuery): Paginated<Lark.BackgroundCheckOrder>;
|
|
3189
|
+
/**
|
|
3190
|
+
* 查询背调信息列表
|
|
3191
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/background_check_order/batch_query
|
|
3192
|
+
*/
|
|
3193
|
+
batchQuery(body: BatchQueryRequest, query?: BatchQueryQuery): Paginated<Lark.BackgroundCheckOrder>;
|
|
3165
3194
|
}
|
|
3166
3195
|
interface ListQuery extends Pagination {
|
|
3167
3196
|
/** 用户 ID 类型 */
|
|
@@ -3173,6 +3202,26 @@ export declare namespace Hire {
|
|
|
3173
3202
|
/** 最晚更新时间,毫秒级时间戳 */
|
|
3174
3203
|
update_end_time?: string;
|
|
3175
3204
|
}
|
|
3205
|
+
interface BatchQueryRequest {
|
|
3206
|
+
/** 背调订单 ID 列表 */
|
|
3207
|
+
background_check_order_id_list?: string[];
|
|
3208
|
+
/** 最早更新时间,毫秒级时间戳 */
|
|
3209
|
+
update_start_time?: string;
|
|
3210
|
+
/** 最晚更新时间,毫秒级时间戳 */
|
|
3211
|
+
update_end_time?: string;
|
|
3212
|
+
/** 最早创建时间,毫秒级时间戳 */
|
|
3213
|
+
begin_start_time?: string;
|
|
3214
|
+
/** 最晚创建时间,毫秒级时间戳 */
|
|
3215
|
+
begin_end_time?: string;
|
|
3216
|
+
/** 投递 ID */
|
|
3217
|
+
application_id?: string;
|
|
3218
|
+
/** 订单状态 */
|
|
3219
|
+
order_status?: '2' | '3' | '4' | '5' | '6' | '8' | '9';
|
|
3220
|
+
}
|
|
3221
|
+
interface BatchQueryQuery extends Pagination {
|
|
3222
|
+
/** 用户 ID 类型 */
|
|
3223
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
3224
|
+
}
|
|
3176
3225
|
}
|
|
3177
3226
|
namespace TripartiteAgreement {
|
|
3178
3227
|
interface Methods {
|
|
@@ -24,7 +24,7 @@ export declare namespace HumanAuthentication {
|
|
|
24
24
|
mobile?: string;
|
|
25
25
|
}
|
|
26
26
|
interface CreateQuery {
|
|
27
|
-
/** 用户的唯一标识(使用的ID类型见下一参数描述,不同ID类型的区别和获取,参考文档:[如何获得 User ID、Open ID 和 Union ID?](/
|
|
27
|
+
/** 用户的唯一标识(使用的ID类型见下一参数描述,不同ID类型的区别和获取,参考文档:[如何获得 User ID、Open ID 和 Union ID?](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get)) */
|
|
28
28
|
user_id: string;
|
|
29
29
|
/** 用户ID类型 open_id/user_id/union_id */
|
|
30
30
|
user_id_type?: 'open_id' | 'user_id' | 'union_id';
|