@satorijs/adapter-lark 3.11.9 → 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 +293 -223
- package/lib/types/acs.d.ts +4 -1
- package/lib/types/apaas.d.ts +152 -0
- 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 +17 -0
- package/lib/types/calendar.d.ts +16 -5
- package/lib/types/contact.d.ts +55 -12
- package/lib/types/corehr.d.ts +754 -142
- package/lib/types/drive.d.ts +20 -3
- package/lib/types/ehr.d.ts +11 -2
- package/lib/types/helpdesk.d.ts +15 -6
- package/lib/types/hire.d.ts +13 -13
- package/lib/types/human_authentication.d.ts +1 -1
- package/lib/types/im.d.ts +76 -20
- package/lib/types/index.d.ts +712 -115
- package/lib/types/mail.d.ts +106 -16
- package/lib/types/search.d.ts +4 -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/apaas.ts +185 -0
- 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 +22 -0
- package/src/types/calendar.ts +16 -5
- package/src/types/contact.ts +55 -12
- package/src/types/corehr.ts +796 -142
- package/src/types/drive.ts +20 -3
- package/src/types/ehr.ts +11 -2
- package/src/types/helpdesk.ts +15 -6
- package/src/types/hire.ts +17 -17
- package/src/types/human_authentication.ts +1 -1
- package/src/types/im.ts +76 -20
- package/src/types/index.ts +738 -115
- package/src/types/mail.ts +106 -16
- package/src/types/search.ts +4 -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/corehr.d.ts
CHANGED
|
@@ -41,6 +41,10 @@ export declare namespace Corehr {
|
|
|
41
41
|
transferType: TransferType.Methods;
|
|
42
42
|
transferReason: TransferReason.Methods;
|
|
43
43
|
offboarding: Offboarding.Methods;
|
|
44
|
+
signatureFile: SignatureFile.Methods;
|
|
45
|
+
signatureNode: SignatureNode.Methods;
|
|
46
|
+
signatureTemplate: SignatureTemplate.Methods;
|
|
47
|
+
signatureTemplateInfoWithThumbnail: SignatureTemplateInfoWithThumbnail.Methods;
|
|
44
48
|
contract: Contract.Methods;
|
|
45
49
|
workforcePlanDetailRow: WorkforcePlanDetailRow.Methods;
|
|
46
50
|
reportDetailRow: ReportDetailRow.Methods;
|
|
@@ -81,7 +85,10 @@ export declare namespace Corehr {
|
|
|
81
85
|
getByParam(query?: GetByParamQuery): Promise<GetByParamResponse>;
|
|
82
86
|
}
|
|
83
87
|
interface QueryQuery {
|
|
84
|
-
/**
|
|
88
|
+
/**
|
|
89
|
+
* 所属对象 apiname,支持一个或多个
|
|
90
|
+
* 当前数量限制为 20 个
|
|
91
|
+
*/
|
|
85
92
|
object_api_name_list: string[];
|
|
86
93
|
}
|
|
87
94
|
interface QueryResponse {
|
|
@@ -118,9 +125,9 @@ export declare namespace Corehr {
|
|
|
118
125
|
editEnumOption(body: EditEnumOptionRequest, query?: EditEnumOptionQuery): Promise<EditEnumOptionResponse>;
|
|
119
126
|
}
|
|
120
127
|
interface AddEnumOptionRequest {
|
|
121
|
-
/** 所属对象 API name,可通过[获取飞书人事对象列表](/
|
|
128
|
+
/** 所属对象 API name,可通过[获取飞书人事对象列表](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/list_object_api_name)接口中返回的 `object_api_name` 字段获取 */
|
|
122
129
|
object_api_name: string;
|
|
123
|
-
/** 枚举字段 API name,可通过[获取自定义字段列表](/
|
|
130
|
+
/** 枚举字段 API name,可通过[获取自定义字段列表](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/query)接口中返回的 `custom_api_name` 字段获取 */
|
|
124
131
|
enum_field_api_name: string;
|
|
125
132
|
/** 新增枚举选项列表 */
|
|
126
133
|
enum_field_options: Lark.EnumFieldOption[];
|
|
@@ -136,9 +143,9 @@ export declare namespace Corehr {
|
|
|
136
143
|
enum_field_options?: Lark.EnumFieldOption[];
|
|
137
144
|
}
|
|
138
145
|
interface EditEnumOptionRequest {
|
|
139
|
-
/** 所属对象 API name,可通过[获取飞书人事对象列表](/
|
|
146
|
+
/** 所属对象 API name,可通过[获取飞书人事对象列表](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/list_object_api_name)接口中返回的 `object_api_name` 字段获取 */
|
|
140
147
|
object_api_name: string;
|
|
141
|
-
/** 枚举字段 API name,可通过[获取自定义字段列表](/
|
|
148
|
+
/** 枚举字段 API name,可通过[获取自定义字段列表](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/query)接口中返回的 `custom_api_name` 字段获取 */
|
|
142
149
|
enum_field_api_name: string;
|
|
143
150
|
/** 枚举选项 */
|
|
144
151
|
enum_field_option: Lark.EnumFieldOption;
|
|
@@ -237,7 +244,7 @@ export declare namespace Corehr {
|
|
|
237
244
|
Inactive = 0
|
|
238
245
|
}
|
|
239
246
|
interface SearchRequest {
|
|
240
|
-
/** 国家/地区 ID 列表,可从[批量查询地点](/
|
|
247
|
+
/** 国家/地区 ID 列表,可从[批量查询地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.country_region_id`、[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.country_region_id` 等字段中获取 */
|
|
241
248
|
country_region_id_list?: string[];
|
|
242
249
|
/** 状态列表 */
|
|
243
250
|
status_list?: SearchRequestStatus[];
|
|
@@ -281,9 +288,9 @@ export declare namespace Corehr {
|
|
|
281
288
|
Inactive = 0
|
|
282
289
|
}
|
|
283
290
|
interface SearchRequest {
|
|
284
|
-
/** 省份/主要行政区 ID 列表,可通过[查询省份/主要行政区信息](/
|
|
291
|
+
/** 省份/主要行政区 ID 列表,可通过[查询省份/主要行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口列举,或从[批量查询地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.region_id`、[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.region_id` 等字段中获取 */
|
|
285
292
|
country_region_subdivision_id_list?: string[];
|
|
286
|
-
/** 城市 ID 列表,可从[批量查询地点](/
|
|
293
|
+
/** 城市 ID 列表,可从[批量查询地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.city_id_v2`、[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.city_id_v2` 等字段中获取 */
|
|
287
294
|
city_id_list?: string[];
|
|
288
295
|
/** 状态列表 */
|
|
289
296
|
status_list?: SearchRequestStatus[];
|
|
@@ -304,9 +311,9 @@ export declare namespace Corehr {
|
|
|
304
311
|
Inactive = 0
|
|
305
312
|
}
|
|
306
313
|
interface SearchRequest {
|
|
307
|
-
/** 所属城市 ID 列表,可通过[查询城市信息](/
|
|
314
|
+
/** 所属城市 ID 列表,可通过[查询城市信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)接口列举,或从[批量查询地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.city_v2_id`、[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.city_v2_id` 等字段中获取 */
|
|
308
315
|
city_id_list?: string[];
|
|
309
|
-
/** 区/县 ID 列表,可从[批量查询地点](/
|
|
316
|
+
/** 区/县 ID 列表,可从[批量查询地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.district_id_v2`、[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.district_id_v2` 等字段中获取 */
|
|
310
317
|
district_id_list?: string[];
|
|
311
318
|
/** 状态列表 */
|
|
312
319
|
status_list?: SearchRequestStatus[];
|
|
@@ -327,9 +334,9 @@ export declare namespace Corehr {
|
|
|
327
334
|
Inactive = 0
|
|
328
335
|
}
|
|
329
336
|
interface SearchRequest {
|
|
330
|
-
/** 国籍 ID 列表,可从[搜索员工信息](/
|
|
337
|
+
/** 国籍 ID 列表,可从[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)接口返回的 `person_info.nationality_id_v2` 等字段中获取 */
|
|
331
338
|
nationality_id_list?: string[];
|
|
332
|
-
/** 国家/地区 ID 列表,可通过[查询国家/地区信息](/
|
|
339
|
+
/** 国家/地区 ID 列表,可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口列举 */
|
|
333
340
|
country_region_id_list?: string[];
|
|
334
341
|
/** 状态列表 */
|
|
335
342
|
status_list?: SearchRequestStatus[];
|
|
@@ -350,7 +357,7 @@ export declare namespace Corehr {
|
|
|
350
357
|
Disabled = 0
|
|
351
358
|
}
|
|
352
359
|
interface SearchRequest {
|
|
353
|
-
/** 银行 ID 列表,可通过[搜索员工信息](/
|
|
360
|
+
/** 银行 ID 列表,可通过[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)、[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)等接口返回的 `person_info.bank_account_list.bank_id_v2` 字段获取 */
|
|
354
361
|
bank_id_list?: string[];
|
|
355
362
|
/** 银行名称列表,支持对银行名称精确搜索 */
|
|
356
363
|
bank_name_list?: string[];
|
|
@@ -377,9 +384,9 @@ export declare namespace Corehr {
|
|
|
377
384
|
Inactive = 0
|
|
378
385
|
}
|
|
379
386
|
interface SearchRequest {
|
|
380
|
-
/** 银行 ID 列表,可通过[查询银行信息](/
|
|
387
|
+
/** 银行 ID 列表,可通过[查询银行信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search)列举,或从[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)、[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)等接口返回的 `person_info.bank_account_list.bank_id_v2` 字段中获取 */
|
|
381
388
|
bank_id_list?: string[];
|
|
382
|
-
/** 支行 ID 列表,可通过[搜索员工信息](/
|
|
389
|
+
/** 支行 ID 列表,可通过[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)、[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)等接口返回的 `person_info.bank_account_list.bank_branch_id_v2` 字段获取 */
|
|
383
390
|
bank_branch_id_list?: string[];
|
|
384
391
|
/** 支行名称列表,支持对支行名称精确搜索 */
|
|
385
392
|
bank_branch_name_list?: string[];
|
|
@@ -408,7 +415,7 @@ export declare namespace Corehr {
|
|
|
408
415
|
Inactive = 0
|
|
409
416
|
}
|
|
410
417
|
interface SearchRequest {
|
|
411
|
-
/** 货币 ID 列表,可通过[批量查询薪资方案](/
|
|
418
|
+
/** 货币 ID 列表,可通过[批量查询薪资方案](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list)、[批量查询员工薪资档案](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query)等接口返回的 `currency_id` 字段获取 */
|
|
412
419
|
currency_id_list?: string[];
|
|
413
420
|
/** 状态列表 */
|
|
414
421
|
status_list?: SearchRequestStatus[];
|
|
@@ -781,37 +788,98 @@ export declare namespace Corehr {
|
|
|
781
788
|
additional_national_id_number_list?: string[];
|
|
782
789
|
/** 公民身份类型列表,精确匹配查询 */
|
|
783
790
|
citizenship_status_list?: string[];
|
|
784
|
-
/**
|
|
791
|
+
/**
|
|
792
|
+
* 成本中心 ID 列表
|
|
793
|
+
* - 可通过 [【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search) 获取
|
|
794
|
+
*/
|
|
785
795
|
cost_center_id_list?: string[];
|
|
786
|
-
/**
|
|
796
|
+
/**
|
|
797
|
+
* 任职公司 ID 列表
|
|
798
|
+
* - [【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取
|
|
799
|
+
*/
|
|
787
800
|
service_company_list?: string[];
|
|
788
|
-
/**
|
|
801
|
+
/**
|
|
802
|
+
* 任职公司 ID 列表(含下级)
|
|
803
|
+
* - [【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取
|
|
804
|
+
*/
|
|
789
805
|
service_company_list_include_sub?: string[];
|
|
790
|
-
/**
|
|
806
|
+
/**
|
|
807
|
+
* 序列 ID 列表
|
|
808
|
+
* - [【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取
|
|
809
|
+
*/
|
|
791
810
|
job_family_id_list?: string[];
|
|
792
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* 序列 ID 列表(含下级)
|
|
813
|
+
* - [【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取
|
|
814
|
+
*/
|
|
793
815
|
job_family_id_list_include_sub?: string[];
|
|
794
|
-
/**
|
|
816
|
+
/**
|
|
817
|
+
* 职级 ID 列表
|
|
818
|
+
* - 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取
|
|
819
|
+
* - 需要有字段读取权限
|
|
820
|
+
*/
|
|
795
821
|
job_level_id_list?: string[];
|
|
796
|
-
/**
|
|
822
|
+
/**
|
|
823
|
+
* 职等 ID 列表
|
|
824
|
+
* - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取
|
|
825
|
+
* - 需要有字段读取权限
|
|
826
|
+
*/
|
|
797
827
|
job_grade_id_list?: string[];
|
|
798
|
-
/**
|
|
828
|
+
/**
|
|
829
|
+
* 职务 ID 列表
|
|
830
|
+
* - 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取
|
|
831
|
+
* - 需要有字段读取权限
|
|
832
|
+
*/
|
|
799
833
|
job_id_list?: string[];
|
|
800
|
-
/**
|
|
834
|
+
/**
|
|
835
|
+
* 岗位 ID 列表
|
|
836
|
+
* - 功能灰度中,如有需求请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
|
837
|
+
* - 需要有字段读取权限
|
|
838
|
+
*/
|
|
801
839
|
position_id_list?: string[];
|
|
802
|
-
/**
|
|
840
|
+
/**
|
|
841
|
+
* 岗位 ID 列表(含下级)
|
|
842
|
+
* - 功能灰度中,如有需求请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
|
843
|
+
* - 需要有字段读取权限
|
|
844
|
+
*/
|
|
803
845
|
position_id_list_include_sub?: string[];
|
|
804
|
-
/**
|
|
846
|
+
/**
|
|
847
|
+
* 工时制度 ID 列表
|
|
848
|
+
* - 可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取
|
|
849
|
+
* - 需要有字段读取权限
|
|
850
|
+
*/
|
|
805
851
|
working_hours_type_id_list?: string[];
|
|
806
|
-
/**
|
|
852
|
+
/**
|
|
853
|
+
* 国籍 ID 列表
|
|
854
|
+
* - 可通过[【查询国籍信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search)获取
|
|
855
|
+
* - 需要有字段读取权限
|
|
856
|
+
*/
|
|
807
857
|
nationality_id_list?: string[];
|
|
808
|
-
/**
|
|
858
|
+
/**
|
|
859
|
+
* 员工所属薪资组 ID 列表
|
|
860
|
+
* - 可通过 [【获取薪资组基本信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list) 获取
|
|
861
|
+
* - 需要有字段读取权限
|
|
862
|
+
*/
|
|
809
863
|
pay_group_id_list?: string[];
|
|
810
|
-
/**
|
|
864
|
+
/**
|
|
865
|
+
* 员工所属外派薪资组 ID 列表
|
|
866
|
+
* - 可通过 [【获取薪资组基本信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list) 获取
|
|
867
|
+
* - 需要有字段读取权限
|
|
868
|
+
*/
|
|
811
869
|
assignment_pay_group_id_list?: string[];
|
|
812
|
-
/**
|
|
870
|
+
/**
|
|
871
|
+
* 员工当前合同类型列表
|
|
872
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)查询
|
|
873
|
+
* - object_api_name:contract
|
|
874
|
+
* - custom_api_name:contract_type
|
|
875
|
+
* - 需要有字段读取权限
|
|
876
|
+
*/
|
|
813
877
|
contract_type_list?: string[];
|
|
814
|
-
/**
|
|
878
|
+
/**
|
|
879
|
+
* 员工当前所属薪资方案 ID 列表
|
|
880
|
+
* - 可通过[【批量查询薪资方案】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list)获取
|
|
881
|
+
* - 需要有字段读取权限
|
|
882
|
+
*/
|
|
815
883
|
archive_cpst_plan_id_list?: string[];
|
|
816
884
|
}
|
|
817
885
|
interface SearchQuery extends Pagination {
|
|
@@ -833,7 +901,11 @@ export declare namespace Corehr {
|
|
|
833
901
|
interface CreateQuery {
|
|
834
902
|
/** 幂等标识,服务端会忽略client_token重复的请求 */
|
|
835
903
|
client_token?: string;
|
|
836
|
-
/**
|
|
904
|
+
/**
|
|
905
|
+
* 是否为离职重聘:
|
|
906
|
+
* false: 否,系统直接标为非离职重聘人员,不再做重复判断"
|
|
907
|
+
* true: 是,要求rehire_employment_id
|
|
908
|
+
*/
|
|
837
909
|
rehire?: boolean;
|
|
838
910
|
/** 离职重聘员工雇佣ID, rehire */
|
|
839
911
|
rehire_employment_id?: string;
|
|
@@ -1296,7 +1368,11 @@ export declare namespace Corehr {
|
|
|
1296
1368
|
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
1297
1369
|
/** 此次调用中使用的部门 ID 类型 */
|
|
1298
1370
|
department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id';
|
|
1299
|
-
/**
|
|
1371
|
+
/**
|
|
1372
|
+
* 是否强校验。值为 true 时,会对入参进行业务校验,并产生异动记录、发送异动事件。
|
|
1373
|
+
* - 默认值:false
|
|
1374
|
+
* - 仅在新增任职版本时生效,当 version_id 不为空时该字段不生效
|
|
1375
|
+
*/
|
|
1300
1376
|
strict_verify?: string;
|
|
1301
1377
|
}
|
|
1302
1378
|
interface PatchResponse {
|
|
@@ -1362,9 +1438,19 @@ export declare namespace Corehr {
|
|
|
1362
1438
|
department_id?: string;
|
|
1363
1439
|
/** 员工雇佣 ID 列表 */
|
|
1364
1440
|
employment_ids?: string[];
|
|
1365
|
-
/**
|
|
1441
|
+
/**
|
|
1442
|
+
* 是否仅查询主职
|
|
1443
|
+
* - true:仅返回 primary_job_data 为 true 的任职记录
|
|
1444
|
+
* - false:仅返回 primary_job_data 为 false 的任职记录
|
|
1445
|
+
* - 不传:返回全部
|
|
1446
|
+
*/
|
|
1366
1447
|
primary_job_data?: boolean;
|
|
1367
|
-
/**
|
|
1448
|
+
/**
|
|
1449
|
+
* 任职原因
|
|
1450
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1451
|
+
* - object_api_name:job_data
|
|
1452
|
+
* - custom_api_name:assignment_start_reason
|
|
1453
|
+
*/
|
|
1368
1454
|
assignment_start_reasons?: string[];
|
|
1369
1455
|
}
|
|
1370
1456
|
interface QueryQuery extends Pagination {
|
|
@@ -1384,9 +1470,19 @@ export declare namespace Corehr {
|
|
|
1384
1470
|
effective_date_end?: string;
|
|
1385
1471
|
/** 查看数据日期,默认为今天 */
|
|
1386
1472
|
data_date?: string;
|
|
1387
|
-
/**
|
|
1473
|
+
/**
|
|
1474
|
+
* 是否仅查询主职
|
|
1475
|
+
* - true:仅返回 primary_job_data 为 true 的任职记录
|
|
1476
|
+
* - false:仅返回 primary_job_data 为 false 的任职记录
|
|
1477
|
+
* - 不传:返回全部
|
|
1478
|
+
*/
|
|
1388
1479
|
primary_job_data?: boolean;
|
|
1389
|
-
/**
|
|
1480
|
+
/**
|
|
1481
|
+
* 任职原因
|
|
1482
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1483
|
+
* - object_api_name:job_data
|
|
1484
|
+
* - custom_api_name:assignment_start_reason
|
|
1485
|
+
*/
|
|
1390
1486
|
assignment_start_reasons?: string[];
|
|
1391
1487
|
}
|
|
1392
1488
|
interface BatchGetQuery {
|
|
@@ -1424,53 +1520,129 @@ export declare namespace Corehr {
|
|
|
1424
1520
|
delete(international_assignment_id: string): Promise<void>;
|
|
1425
1521
|
}
|
|
1426
1522
|
interface CreateRequest {
|
|
1427
|
-
/**
|
|
1523
|
+
/**
|
|
1524
|
+
* 外派工作地点 ID
|
|
1525
|
+
* - 可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)获取
|
|
1526
|
+
*/
|
|
1428
1527
|
work_location_id: string;
|
|
1429
|
-
/**
|
|
1528
|
+
/**
|
|
1529
|
+
* 外派任职公司 ID
|
|
1530
|
+
* - 可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取
|
|
1531
|
+
*/
|
|
1430
1532
|
service_company?: string;
|
|
1431
|
-
/**
|
|
1533
|
+
/**
|
|
1534
|
+
* 排班类型
|
|
1535
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1536
|
+
* - object_api_name:job_data
|
|
1537
|
+
* - custom_api_name:work_shift
|
|
1538
|
+
*/
|
|
1432
1539
|
work_shift?: string;
|
|
1433
|
-
/**
|
|
1540
|
+
/**
|
|
1541
|
+
* 周工作时长
|
|
1542
|
+
* - 限制两位小数
|
|
1543
|
+
*/
|
|
1434
1544
|
weekly_working_hours_v2?: number;
|
|
1435
|
-
/**
|
|
1545
|
+
/**
|
|
1546
|
+
* 工时制度ID
|
|
1547
|
+
* - 可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取
|
|
1548
|
+
*/
|
|
1436
1549
|
working_hours_type_id?: string;
|
|
1437
|
-
/**
|
|
1550
|
+
/**
|
|
1551
|
+
* 人员类型ID
|
|
1552
|
+
* - 可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取
|
|
1553
|
+
*/
|
|
1438
1554
|
employee_type_id?: string;
|
|
1439
|
-
/**
|
|
1555
|
+
/**
|
|
1556
|
+
* 部门 ID
|
|
1557
|
+
* - 可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)获取
|
|
1558
|
+
* - 类型与 department_id_type 一致
|
|
1559
|
+
*/
|
|
1440
1560
|
department_id?: string;
|
|
1441
|
-
/**
|
|
1561
|
+
/**
|
|
1562
|
+
* 职务 ID
|
|
1563
|
+
* - 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取
|
|
1564
|
+
*/
|
|
1442
1565
|
job_id?: string;
|
|
1443
|
-
/**
|
|
1566
|
+
/**
|
|
1567
|
+
* 序列 ID
|
|
1568
|
+
* - 可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取
|
|
1569
|
+
*/
|
|
1444
1570
|
job_family_id?: string;
|
|
1445
|
-
/**
|
|
1571
|
+
/**
|
|
1572
|
+
* 职级 ID
|
|
1573
|
+
* - 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取
|
|
1574
|
+
*/
|
|
1446
1575
|
job_level_id?: string;
|
|
1447
|
-
/**
|
|
1576
|
+
/**
|
|
1577
|
+
* 职等 ID
|
|
1578
|
+
* - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取
|
|
1579
|
+
*/
|
|
1448
1580
|
job_grade_id?: string;
|
|
1449
|
-
/**
|
|
1581
|
+
/**
|
|
1582
|
+
* 薪资类型
|
|
1583
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1584
|
+
* - object_api_name:job_data
|
|
1585
|
+
* - custom_api_name:compensation_type
|
|
1586
|
+
*/
|
|
1450
1587
|
compensation_type?: string;
|
|
1451
|
-
/**
|
|
1588
|
+
/**
|
|
1589
|
+
* 直属上级雇佣 ID
|
|
1590
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取
|
|
1591
|
+
* - 类型与 user_id_type 一致
|
|
1592
|
+
*/
|
|
1452
1593
|
direct_manager_id?: string;
|
|
1453
|
-
/**
|
|
1594
|
+
/**
|
|
1595
|
+
* 虚线上级雇佣 ID
|
|
1596
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取
|
|
1597
|
+
* - 类型与 user_id_type 一致
|
|
1598
|
+
*/
|
|
1454
1599
|
dotted_line_manager_id?: string;
|
|
1455
|
-
/**
|
|
1600
|
+
/**
|
|
1601
|
+
* 工作日历 ID
|
|
1602
|
+
* - 可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取
|
|
1603
|
+
*/
|
|
1456
1604
|
work_calendar_id?: string;
|
|
1457
|
-
/**
|
|
1605
|
+
/**
|
|
1606
|
+
* 岗位 ID
|
|
1607
|
+
* - 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
|
1608
|
+
*/
|
|
1458
1609
|
position_id?: string;
|
|
1459
|
-
/**
|
|
1610
|
+
/**
|
|
1611
|
+
* 雇佣 ID
|
|
1612
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取
|
|
1613
|
+
* - 类型与 user_id_type 一致
|
|
1614
|
+
*/
|
|
1460
1615
|
employment_id: string;
|
|
1461
|
-
/**
|
|
1616
|
+
/**
|
|
1617
|
+
* 自定义字段
|
|
1618
|
+
* - 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
|
|
1619
|
+
*/
|
|
1462
1620
|
custom_fields?: Lark.ObjectFieldData[];
|
|
1463
1621
|
/** 外派原因说明 */
|
|
1464
1622
|
international_assignment_reason?: string;
|
|
1465
1623
|
/** 备注 */
|
|
1466
1624
|
description?: string;
|
|
1467
|
-
/**
|
|
1625
|
+
/**
|
|
1626
|
+
* 预计结束日期
|
|
1627
|
+
* - 格式:yyyy-mm-dd
|
|
1628
|
+
*/
|
|
1468
1629
|
international_assignment_expected_end_date?: string;
|
|
1469
|
-
/**
|
|
1630
|
+
/**
|
|
1631
|
+
* 外派类型
|
|
1632
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1633
|
+
* - object_api_name:international_assignment
|
|
1634
|
+
* - custom_api_name:international_assignment_type
|
|
1635
|
+
*/
|
|
1470
1636
|
international_assignment_type: string;
|
|
1471
|
-
/**
|
|
1637
|
+
/**
|
|
1638
|
+
* 开始日期
|
|
1639
|
+
* - 格式:yyyy-mm-dd
|
|
1640
|
+
*/
|
|
1472
1641
|
effective_time: string;
|
|
1473
|
-
/**
|
|
1642
|
+
/**
|
|
1643
|
+
* 结束日期
|
|
1644
|
+
* - 格式:yyyy-mm-dd
|
|
1645
|
+
*/
|
|
1474
1646
|
expiration_time?: string;
|
|
1475
1647
|
}
|
|
1476
1648
|
interface CreateQuery {
|
|
@@ -1486,51 +1658,123 @@ export declare namespace Corehr {
|
|
|
1486
1658
|
international_assignment?: Lark.EmployeesInternationalAssignmentResp;
|
|
1487
1659
|
}
|
|
1488
1660
|
interface PatchRequest {
|
|
1489
|
-
/**
|
|
1661
|
+
/**
|
|
1662
|
+
* 外派工作地点 ID
|
|
1663
|
+
* - 可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)获取
|
|
1664
|
+
*/
|
|
1490
1665
|
work_location_id?: string;
|
|
1491
|
-
/**
|
|
1666
|
+
/**
|
|
1667
|
+
* 外派任职公司 ID
|
|
1668
|
+
* - 可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取
|
|
1669
|
+
*/
|
|
1492
1670
|
service_company?: string;
|
|
1493
|
-
/**
|
|
1671
|
+
/**
|
|
1672
|
+
* 排班类型
|
|
1673
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1674
|
+
* - object_api_name:job_data
|
|
1675
|
+
* - custom_api_name:work_shift
|
|
1676
|
+
*/
|
|
1494
1677
|
work_shift?: string;
|
|
1495
|
-
/**
|
|
1678
|
+
/**
|
|
1679
|
+
* 周工作时长
|
|
1680
|
+
* - 限制两位小数
|
|
1681
|
+
*/
|
|
1496
1682
|
weekly_working_hours_v2?: number;
|
|
1497
|
-
/**
|
|
1683
|
+
/**
|
|
1684
|
+
* 工时制度ID
|
|
1685
|
+
* - 可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取
|
|
1686
|
+
*/
|
|
1498
1687
|
working_hours_type_id?: string;
|
|
1499
|
-
/**
|
|
1688
|
+
/**
|
|
1689
|
+
* 人员类型ID
|
|
1690
|
+
* - 可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取
|
|
1691
|
+
*/
|
|
1500
1692
|
employee_type_id?: string;
|
|
1501
|
-
/**
|
|
1693
|
+
/**
|
|
1694
|
+
* 部门 ID
|
|
1695
|
+
* - 可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)获取
|
|
1696
|
+
* - 类型与 department_id_type 一致
|
|
1697
|
+
*/
|
|
1502
1698
|
department_id?: string;
|
|
1503
|
-
/**
|
|
1699
|
+
/**
|
|
1700
|
+
* 职务 ID
|
|
1701
|
+
* - 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取
|
|
1702
|
+
*/
|
|
1504
1703
|
job_id?: string;
|
|
1505
|
-
/**
|
|
1704
|
+
/**
|
|
1705
|
+
* 序列 ID
|
|
1706
|
+
* - 可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取
|
|
1707
|
+
*/
|
|
1506
1708
|
job_family_id?: string;
|
|
1507
|
-
/**
|
|
1709
|
+
/**
|
|
1710
|
+
* 职级 ID
|
|
1711
|
+
* - 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取
|
|
1712
|
+
*/
|
|
1508
1713
|
job_level_id?: string;
|
|
1509
|
-
/**
|
|
1714
|
+
/**
|
|
1715
|
+
* 职等 ID
|
|
1716
|
+
* - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取
|
|
1717
|
+
*/
|
|
1510
1718
|
job_grade_id?: string;
|
|
1511
|
-
/**
|
|
1719
|
+
/**
|
|
1720
|
+
* 薪资类型
|
|
1721
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1722
|
+
* - object_api_name:job_data
|
|
1723
|
+
* - custom_api_name:compensation_type
|
|
1724
|
+
*/
|
|
1512
1725
|
compensation_type?: string;
|
|
1513
|
-
/**
|
|
1726
|
+
/**
|
|
1727
|
+
* 直属上级雇佣 ID
|
|
1728
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取
|
|
1729
|
+
* - 类型与 user_id_type 一致
|
|
1730
|
+
*/
|
|
1514
1731
|
direct_manager_id?: string;
|
|
1515
|
-
/**
|
|
1732
|
+
/**
|
|
1733
|
+
* 虚线上级雇佣 ID
|
|
1734
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取
|
|
1735
|
+
* - 类型与 user_id_type 一致
|
|
1736
|
+
*/
|
|
1516
1737
|
dotted_line_manager_id?: string;
|
|
1517
|
-
/**
|
|
1738
|
+
/**
|
|
1739
|
+
* 工作日历 ID
|
|
1740
|
+
* - 可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取
|
|
1741
|
+
*/
|
|
1518
1742
|
work_calendar_id?: string;
|
|
1519
|
-
/**
|
|
1743
|
+
/**
|
|
1744
|
+
* 岗位 ID
|
|
1745
|
+
* - 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
|
1746
|
+
*/
|
|
1520
1747
|
position_id?: string;
|
|
1521
|
-
/**
|
|
1748
|
+
/**
|
|
1749
|
+
* 自定义字段
|
|
1750
|
+
* - 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
|
|
1751
|
+
*/
|
|
1522
1752
|
custom_fields?: Lark.ObjectFieldData[];
|
|
1523
1753
|
/** 外派原因说明 */
|
|
1524
1754
|
international_assignment_reason?: string;
|
|
1525
1755
|
/** 备注 */
|
|
1526
1756
|
description?: string;
|
|
1527
|
-
/**
|
|
1757
|
+
/**
|
|
1758
|
+
* 预计结束日期
|
|
1759
|
+
* - 格式:yyyy-mm-dd
|
|
1760
|
+
*/
|
|
1528
1761
|
international_assignment_expected_end_date?: string;
|
|
1529
|
-
/**
|
|
1762
|
+
/**
|
|
1763
|
+
* 外派类型
|
|
1764
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1765
|
+
* - object_api_name:international_assignment
|
|
1766
|
+
* - custom_api_name:international_assignment_type
|
|
1767
|
+
*/
|
|
1530
1768
|
international_assignment_type?: string;
|
|
1531
|
-
/**
|
|
1769
|
+
/**
|
|
1770
|
+
* 开始日期
|
|
1771
|
+
* - 格式:yyyy-mm-dd
|
|
1772
|
+
*/
|
|
1532
1773
|
effective_time?: string;
|
|
1533
|
-
/**
|
|
1774
|
+
/**
|
|
1775
|
+
* 结束日期
|
|
1776
|
+
* - 格式:yyyy-mm-dd
|
|
1777
|
+
*/
|
|
1534
1778
|
expiration_time?: string;
|
|
1535
1779
|
}
|
|
1536
1780
|
interface PatchQuery {
|
|
@@ -1550,51 +1794,164 @@ export declare namespace Corehr {
|
|
|
1550
1794
|
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
1551
1795
|
/** 此次调用中使用的部门 ID 类型 */
|
|
1552
1796
|
department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id';
|
|
1553
|
-
/**
|
|
1797
|
+
/**
|
|
1798
|
+
* 雇佣ID
|
|
1799
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
|
|
1800
|
+
* - 类型必须与 user_id_type 一致
|
|
1801
|
+
*/
|
|
1554
1802
|
employment_ids?: string[];
|
|
1555
1803
|
/** 外派 ID */
|
|
1556
1804
|
international_assignment_ids?: string[];
|
|
1557
|
-
/**
|
|
1805
|
+
/**
|
|
1806
|
+
* 外派开始日期
|
|
1807
|
+
* - 范围筛选,格式:yyyy-mm-dd~yyyy-mm-dd
|
|
1808
|
+
*/
|
|
1558
1809
|
effective_time?: string;
|
|
1559
|
-
/**
|
|
1810
|
+
/**
|
|
1811
|
+
* 外派结束日期
|
|
1812
|
+
* - 范围筛选,格式:yyyy-mm-dd~yyyy-mm-dd
|
|
1813
|
+
*/
|
|
1560
1814
|
expiration_time?: string;
|
|
1561
|
-
/**
|
|
1815
|
+
/**
|
|
1816
|
+
* 雇佣状态
|
|
1817
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1818
|
+
* - object_api_name:employment
|
|
1819
|
+
* - custom_api_name:employment_status
|
|
1820
|
+
*/
|
|
1562
1821
|
employment_status_list?: string[];
|
|
1563
|
-
/**
|
|
1822
|
+
/**
|
|
1823
|
+
* 外派工作地点
|
|
1824
|
+
* - 可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)获取
|
|
1825
|
+
* - 需要以下权限点之一:
|
|
1826
|
+
* - [读取外派地点](corehr:employment.international_assignment.work_location:read)
|
|
1827
|
+
* - [读写外派地点](corehr:employment.international_assignment.work_location:write)
|
|
1828
|
+
*/
|
|
1564
1829
|
work_location_id_list?: string[];
|
|
1565
|
-
/**
|
|
1830
|
+
/**
|
|
1831
|
+
* 外派部门
|
|
1832
|
+
* - 可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)获取
|
|
1833
|
+
* - 类型与 department_id_type 一致
|
|
1834
|
+
*/
|
|
1566
1835
|
department_id_list?: string[];
|
|
1567
|
-
/**
|
|
1836
|
+
/**
|
|
1837
|
+
* 外派直属上级
|
|
1838
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取
|
|
1839
|
+
* - 类型与 user_id_type 一致
|
|
1840
|
+
*/
|
|
1568
1841
|
direct_manager_id_list?: string[];
|
|
1569
|
-
/**
|
|
1842
|
+
/**
|
|
1843
|
+
* 外派虚线上级
|
|
1844
|
+
* - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取
|
|
1845
|
+
* - 类型与 user_id_type 一致
|
|
1846
|
+
*/
|
|
1570
1847
|
dotted_line_manager_id_list?: string[];
|
|
1571
|
-
/**
|
|
1848
|
+
/**
|
|
1849
|
+
* 外派岗位
|
|
1850
|
+
* - 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
|
1851
|
+
* - 需要以下权限点之一:
|
|
1852
|
+
* - [读取外派岗位](corehr:employment.international_assignment.position:read)
|
|
1853
|
+
* - [读写外派岗位](corehr:employment.international_assignment.position:write)
|
|
1854
|
+
*/
|
|
1572
1855
|
position_id_list?: string[];
|
|
1573
|
-
/**
|
|
1856
|
+
/**
|
|
1857
|
+
* 外派职务
|
|
1858
|
+
* - 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取
|
|
1859
|
+
* - 需要以下权限点之一:
|
|
1860
|
+
* - [读取外派职务](corehr:employment.international_assignment.job:read)
|
|
1861
|
+
* - [读写外派职务](corehr:employment.international_assignment.job:write)
|
|
1862
|
+
*/
|
|
1574
1863
|
job_id_list?: string[];
|
|
1575
|
-
/**
|
|
1864
|
+
/**
|
|
1865
|
+
* 外派序列
|
|
1866
|
+
* - 可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取
|
|
1867
|
+
*/
|
|
1576
1868
|
job_family_id_list?: string[];
|
|
1577
|
-
/**
|
|
1869
|
+
/**
|
|
1870
|
+
* 外派职级
|
|
1871
|
+
* - 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取
|
|
1872
|
+
* - 需要以下权限点之一:
|
|
1873
|
+
* - [读取外派职级](corehr:employment.international_assignment.job_level:read)
|
|
1874
|
+
* - [读写外派职级](corehr:employment.international_assignment.job_level:write)
|
|
1875
|
+
*/
|
|
1578
1876
|
job_level_id_list?: string[];
|
|
1579
|
-
/**
|
|
1877
|
+
/**
|
|
1878
|
+
* 外派职等
|
|
1879
|
+
* - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取
|
|
1880
|
+
* - 需要以下权限点之一:
|
|
1881
|
+
* - [读取外派职等](corehr:employment.international_assignment.job_grade:read)
|
|
1882
|
+
* - [读写外派职等](corehr:employment.international_assignment.job_grade:write)
|
|
1883
|
+
*/
|
|
1580
1884
|
job_grade_id_list?: string[];
|
|
1581
|
-
/**
|
|
1885
|
+
/**
|
|
1886
|
+
* 外派工时制度
|
|
1887
|
+
* - 可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取
|
|
1888
|
+
* - 需要以下权限点之一:
|
|
1889
|
+
* - [读取外派工时制度](corehr:employment.international_assignment.working_hours_type:read)
|
|
1890
|
+
* - [读写外派工时制度](corehr:employment.international_assignment.working_hours_type:write)
|
|
1891
|
+
*/
|
|
1582
1892
|
working_hours_type_id_list?: string[];
|
|
1583
|
-
/**
|
|
1893
|
+
/**
|
|
1894
|
+
* 外派任职公司
|
|
1895
|
+
* - 可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取
|
|
1896
|
+
* - 需要以下权限点之一:
|
|
1897
|
+
* - [读取外派公司](corehr:employment.international_assignment.service_company:read)
|
|
1898
|
+
* - [读写外派公司](corehr:employment.international_assignment.service_company:write)
|
|
1899
|
+
*/
|
|
1584
1900
|
service_company_list?: string[];
|
|
1585
|
-
/**
|
|
1901
|
+
/**
|
|
1902
|
+
* 外派周工作时长
|
|
1903
|
+
* - 限制两位小数
|
|
1904
|
+
* - 需要以下权限点之一:
|
|
1905
|
+
* - [读取外派周工作时长](corehr:employment.international_assignment.weekly_working_hours:read)
|
|
1906
|
+
* - [读写外派周工作时长](corehr:employment.international_assignment.weekly_working_hours:write)
|
|
1907
|
+
*/
|
|
1586
1908
|
weekly_working_hours_v2?: number;
|
|
1587
|
-
/**
|
|
1909
|
+
/**
|
|
1910
|
+
* 外派排班类型
|
|
1911
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1912
|
+
* - object_api_name:job_data
|
|
1913
|
+
* - custom_api_name:work_shift
|
|
1914
|
+
* - 需要以下权限点之一:
|
|
1915
|
+
* - [读取外派排班类型](corehr:employment.international_assignment.work_shift:read)
|
|
1916
|
+
* - [读写外派排班类型](corehr:employment.international_assignment.work_shift:write)
|
|
1917
|
+
*/
|
|
1588
1918
|
work_shift_list?: string[];
|
|
1589
|
-
/**
|
|
1919
|
+
/**
|
|
1920
|
+
* 外派薪资类型
|
|
1921
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1922
|
+
* - object_api_name:job_data
|
|
1923
|
+
* - custom_api_name:compensation_type
|
|
1924
|
+
* - 需要以下权限点之一:
|
|
1925
|
+
* - [读取外派薪资类型](corehr:employment.international_assignment.compensation_type:read)
|
|
1926
|
+
* - [读写外派薪资类型](corehr:employment.international_assignment.compensation_type:write)
|
|
1927
|
+
*/
|
|
1590
1928
|
compensation_type_list?: string[];
|
|
1591
|
-
/**
|
|
1929
|
+
/**
|
|
1930
|
+
* 外派预计结束日期
|
|
1931
|
+
* - 范围筛选,格式:yyyy-mm-dd~yyyy-mm-dd
|
|
1932
|
+
*/
|
|
1592
1933
|
international_assignment_expected_end_date?: string;
|
|
1593
|
-
/**
|
|
1934
|
+
/**
|
|
1935
|
+
* 外派状态
|
|
1936
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1937
|
+
* - object_api_name:international_assignment
|
|
1938
|
+
* - custom_api_name:international_assignment_status
|
|
1939
|
+
*/
|
|
1594
1940
|
international_assignment_status_list?: string[];
|
|
1595
|
-
/**
|
|
1941
|
+
/**
|
|
1942
|
+
* 外派类型
|
|
1943
|
+
* - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
1944
|
+
* - object_api_name:international_assignment
|
|
1945
|
+
* - custom_api_name:international_assignment_type
|
|
1946
|
+
*/
|
|
1596
1947
|
international_assignment_type_list?: string[];
|
|
1597
|
-
/**
|
|
1948
|
+
/**
|
|
1949
|
+
* 外派工作日历
|
|
1950
|
+
* - 可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息
|
|
1951
|
+
* - 需要以下权限点之一:
|
|
1952
|
+
* - [读取外派工作日历](corehr:employment.international_assignment.work_calendar:read)
|
|
1953
|
+
* - [读写外派工作日历](corehr:employment.international_assignment.work_calendar:write)
|
|
1954
|
+
*/
|
|
1598
1955
|
work_calendar_id_list?: string[];
|
|
1599
1956
|
}
|
|
1600
1957
|
interface ListResponse {
|
|
@@ -1632,39 +1989,47 @@ export declare namespace Corehr {
|
|
|
1632
1989
|
batch(body: BatchRequest, query?: BatchQuery): Paginated<Lark.EmployeesAdditionalJob>;
|
|
1633
1990
|
}
|
|
1634
1991
|
interface CreateRequest {
|
|
1635
|
-
/** 人员类型 ID,可通过[【批量查询人员类型】](/
|
|
1992
|
+
/** 人员类型 ID,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取 */
|
|
1636
1993
|
employee_type_id: string;
|
|
1637
|
-
/** 工时制度 ID,可通过[【批量查询工时制度】](/
|
|
1994
|
+
/** 工时制度 ID,可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取详细信息 */
|
|
1638
1995
|
working_hours_type_id?: string;
|
|
1639
|
-
/** 工作地点 ID,可通过[【批量查询地点】](/
|
|
1996
|
+
/** 工作地点 ID,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)获取详细信息 */
|
|
1640
1997
|
work_location_id?: string;
|
|
1641
|
-
/** 部门 ID,可通过[【批量查询部门】](/
|
|
1998
|
+
/** 部门 ID,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)获取详细信息;类型与department_id_type一致 */
|
|
1642
1999
|
department_id: string;
|
|
1643
|
-
/** 职务 ID,可通过[【批量查询职务】](/
|
|
2000
|
+
/** 职务 ID,可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取详细信息 */
|
|
1644
2001
|
job_id?: string;
|
|
1645
|
-
/** 职级 ID,可通过[【批量查询职级】](/
|
|
2002
|
+
/** 职级 ID,可通过[【批量查询职级】](https://open.feishu.cn/document//uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取详细信息 */
|
|
1646
2003
|
job_level_id?: string;
|
|
1647
|
-
/** 序列 ID,可通过[【批量查询序列】](/
|
|
2004
|
+
/** 序列 ID,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取详细信息 */
|
|
1648
2005
|
job_family_id?: string;
|
|
1649
|
-
/** 雇佣 ID,可通过[【批量查询员工信息】](/
|
|
2006
|
+
/** 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
|
|
1650
2007
|
employment_id: string;
|
|
1651
2008
|
/** 兼职开始日期 */
|
|
1652
2009
|
start_date: string;
|
|
1653
2010
|
/** 兼职结束日期,不可清空 */
|
|
1654
2011
|
end_date?: string;
|
|
1655
|
-
/** 直属上级的雇佣ID,可通过[【批量查询员工信息】](/
|
|
2012
|
+
/** 直属上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
|
|
1656
2013
|
direct_manager_id?: string;
|
|
1657
|
-
/** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](/
|
|
2014
|
+
/** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
|
|
1658
2015
|
dotted_line_manager_id?: string;
|
|
1659
|
-
/**
|
|
2016
|
+
/**
|
|
2017
|
+
* 排班类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
2018
|
+
* - object_api_name = "job_data"
|
|
2019
|
+
* - custom_api_name = "work_shift"
|
|
2020
|
+
*/
|
|
1660
2021
|
work_shift?: Lark.Enum;
|
|
1661
|
-
/**
|
|
2022
|
+
/**
|
|
2023
|
+
* 薪资类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
2024
|
+
* - object_api_name = "job_data"
|
|
2025
|
+
* - custom_api_name = "compensation_type"
|
|
2026
|
+
*/
|
|
1662
2027
|
compensation_type?: Lark.Enum;
|
|
1663
|
-
/** 任职公司,可通过[【批量查询公司】](/
|
|
2028
|
+
/** 任职公司,可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取详细信息 */
|
|
1664
2029
|
service_company?: string;
|
|
1665
2030
|
/** 周工作时长【0~168】 */
|
|
1666
2031
|
weekly_working_hours?: string;
|
|
1667
|
-
/** 工作日历ID,可通过[【查询工作日历】](/
|
|
2032
|
+
/** 工作日历ID,可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
|
|
1668
2033
|
work_calendar_id?: string;
|
|
1669
2034
|
/** 岗位 ID */
|
|
1670
2035
|
position_id?: string;
|
|
@@ -1683,37 +2048,45 @@ export declare namespace Corehr {
|
|
|
1683
2048
|
additional_job?: Lark.EmployeesAdditionalJobWriteResp;
|
|
1684
2049
|
}
|
|
1685
2050
|
interface PatchRequest {
|
|
1686
|
-
/** 人员类型 ID,可通过[【批量查询人员类型】](/
|
|
2051
|
+
/** 人员类型 ID,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取 */
|
|
1687
2052
|
employee_type_id?: string;
|
|
1688
|
-
/** 工时制度 ID,可通过[【批量查询工时制度】](/
|
|
2053
|
+
/** 工时制度 ID,可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取详细信息 */
|
|
1689
2054
|
working_hours_type_id?: string;
|
|
1690
|
-
/** 工作地点 ID,可通过[【批量查询地点】](/
|
|
2055
|
+
/** 工作地点 ID,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)获取详细信息 */
|
|
1691
2056
|
work_location_id?: string;
|
|
1692
|
-
/** 部门 ID,可通过[【批量查询部门】](/
|
|
2057
|
+
/** 部门 ID,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)获取详细信息;类型与department_id_type一致 */
|
|
1693
2058
|
department_id?: string;
|
|
1694
|
-
/** 职务 ID,可通过[【批量查询职务】](/
|
|
2059
|
+
/** 职务 ID,可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取详细信息 */
|
|
1695
2060
|
job_id?: string;
|
|
1696
|
-
/** 职级 ID,可通过[【批量查询职级】](/
|
|
2061
|
+
/** 职级 ID,可通过[【批量查询职级】](https://open.feishu.cn/document//uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取详细信息 */
|
|
1697
2062
|
job_level_id?: string;
|
|
1698
|
-
/** 序列 ID,可通过[【批量查询序列】](/
|
|
2063
|
+
/** 序列 ID,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取详细信息 */
|
|
1699
2064
|
job_family_id?: string;
|
|
1700
2065
|
/** 兼职开始日期 */
|
|
1701
2066
|
start_date?: string;
|
|
1702
2067
|
/** 兼职结束日期,不可清空 */
|
|
1703
2068
|
end_date?: string;
|
|
1704
|
-
/** 直属上级的雇佣ID,可通过[【批量查询员工信息】](/
|
|
2069
|
+
/** 直属上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
|
|
1705
2070
|
direct_manager_id?: string;
|
|
1706
|
-
/** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](/
|
|
2071
|
+
/** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
|
|
1707
2072
|
dotted_line_manager_id?: string;
|
|
1708
|
-
/**
|
|
2073
|
+
/**
|
|
2074
|
+
* 排班类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
2075
|
+
* - object_api_name = "job_data"
|
|
2076
|
+
* - custom_api_name = "work_shift"
|
|
2077
|
+
*/
|
|
1709
2078
|
work_shift?: Lark.Enum;
|
|
1710
|
-
/**
|
|
2079
|
+
/**
|
|
2080
|
+
* 薪资类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
|
|
2081
|
+
* - object_api_name = "job_data"
|
|
2082
|
+
* - custom_api_name = "compensation_type"
|
|
2083
|
+
*/
|
|
1711
2084
|
compensation_type?: Lark.Enum;
|
|
1712
|
-
/** 任职公司,可通过[【批量查询公司】](/
|
|
2085
|
+
/** 任职公司,可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取详细信息 */
|
|
1713
2086
|
service_company?: string;
|
|
1714
2087
|
/** 周工作时长【0~168】 */
|
|
1715
2088
|
weekly_working_hours?: string;
|
|
1716
|
-
/** 工作日历ID,可通过[【查询工作日历】](/
|
|
2089
|
+
/** 工作日历ID,可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
|
|
1717
2090
|
work_calendar_id?: string;
|
|
1718
2091
|
/** 岗位 ID */
|
|
1719
2092
|
position_id?: string;
|
|
@@ -2176,13 +2549,19 @@ export declare namespace Corehr {
|
|
|
2176
2549
|
active?: boolean;
|
|
2177
2550
|
/** 当通过上级部门 ID 查询时,填写 true 返回所有子部门,填写 false 只返回直接下级部门 */
|
|
2178
2551
|
get_all_children?: boolean;
|
|
2179
|
-
/**
|
|
2552
|
+
/**
|
|
2553
|
+
* manager ID 列表
|
|
2554
|
+
* **字段权限要求:按照部门负责人搜索 (corehr:department.manager.search:read)**
|
|
2555
|
+
*/
|
|
2180
2556
|
manager_list?: string[];
|
|
2181
2557
|
/** 部门 ID 列表 */
|
|
2182
2558
|
department_id_list?: string[];
|
|
2183
2559
|
/** 部门名称列表,需精确匹配 */
|
|
2184
2560
|
name_list?: string[];
|
|
2185
|
-
/**
|
|
2561
|
+
/**
|
|
2562
|
+
* 上级部门 ID ,可查询直接下级部门
|
|
2563
|
+
* **字段权限要求:按照上级部门搜索 (corehr:department.organize.search:read) **
|
|
2564
|
+
*/
|
|
2186
2565
|
parent_department_id?: string;
|
|
2187
2566
|
/** 部门 code 列表 */
|
|
2188
2567
|
code_list?: string[];
|
|
@@ -3889,11 +4268,22 @@ export declare namespace Corehr {
|
|
|
3889
4268
|
basic_info_update?: Lark.BasicInfoUpdate;
|
|
3890
4269
|
/** 更新待入职(prehire)信息 */
|
|
3891
4270
|
offer_info_update?: Lark.OfferInfoUpdate;
|
|
3892
|
-
/**
|
|
4271
|
+
/**
|
|
4272
|
+
* 指定需要更新的系统字段,只支持最多下钻一层,格式如下:
|
|
4273
|
+
* - basic_info_update字段:basic_info_update.name(对name整体进行覆盖更新);basic_info_update.emails(对邮箱整体进行更新)
|
|
4274
|
+
* - offer_info_update字段:offer_info_update.onboarding_method
|
|
4275
|
+
* - 招聘ID:ats_application_id
|
|
4276
|
+
*/
|
|
3893
4277
|
standard_update_fields?: string[];
|
|
3894
|
-
/**
|
|
4278
|
+
/**
|
|
4279
|
+
* 指定需要更新的PreHire对象上的自定义字段,格式如下:
|
|
4280
|
+
* - custom_field1__c
|
|
4281
|
+
*/
|
|
3895
4282
|
custom_update_fields?: string[];
|
|
3896
|
-
/**
|
|
4283
|
+
/**
|
|
4284
|
+
* 指定需要更新的Person对象上的自定义字段,格式如下:
|
|
4285
|
+
* - custom_field1__c
|
|
4286
|
+
*/
|
|
3897
4287
|
person_custom_update_fields?: string[];
|
|
3898
4288
|
}
|
|
3899
4289
|
interface PatchResponse {
|
|
@@ -3903,7 +4293,18 @@ export declare namespace Corehr {
|
|
|
3903
4293
|
interface QueryRequest {
|
|
3904
4294
|
/** 待入职人员 ID 列表;如果该字段非空,则不按照page_size、page_token分页方式查询 */
|
|
3905
4295
|
pre_hire_ids?: string[];
|
|
3906
|
-
/**
|
|
4296
|
+
/**
|
|
4297
|
+
* 返回数据的字段列表,填写方式:
|
|
4298
|
+
* - 为空时只返回 pre_hire_id
|
|
4299
|
+
* - 不为空时按照传入的字段返回数据,格式如下:
|
|
4300
|
+
* - person_info 字段:person_info.gender,person_info.age
|
|
4301
|
+
* - employment_info 字段:employment_info.department
|
|
4302
|
+
* - onboarding_info 字段:onboarding_info.onboarding_date
|
|
4303
|
+
* - probation_info 字段:probation_info.probation_period
|
|
4304
|
+
* - contract_info 字段:contract_info.contract_type
|
|
4305
|
+
* - 如果要返回所有下级,只用传上级结构体名称,例如 person_info
|
|
4306
|
+
* - 返回数据越多,查询接口性能越慢,请按需填写返回字段
|
|
4307
|
+
*/
|
|
3907
4308
|
fields?: string[];
|
|
3908
4309
|
}
|
|
3909
4310
|
interface QueryQuery extends Pagination {
|
|
@@ -3945,7 +4346,18 @@ export declare namespace Corehr {
|
|
|
3945
4346
|
key_word?: string;
|
|
3946
4347
|
/** 是否离职重聘 */
|
|
3947
4348
|
rehire?: 'to_be_confirmed' | 'no' | 'yes';
|
|
3948
|
-
/**
|
|
4349
|
+
/**
|
|
4350
|
+
* 返回数据的字段列表,填写方式:
|
|
4351
|
+
* - 为空时只返回 pre_hire_id
|
|
4352
|
+
* - 不为空时按照传入的字段返回数据,格式如下:
|
|
4353
|
+
* - person_info 字段:person_info.gender,person_info.age
|
|
4354
|
+
* - employment_info 字段:employment_info.department
|
|
4355
|
+
* - onboarding_info 字段:onboarding_info.onboarding_date
|
|
4356
|
+
* - probation_info 字段:probation_info.probation_period
|
|
4357
|
+
* - contract_info 字段:contract_info.contract_type
|
|
4358
|
+
* - 如果要返回所有下级,只用传上级结构体名称,例如 person_info
|
|
4359
|
+
* - 返回数据越多,查询接口性能越慢,请按需填写返回字段
|
|
4360
|
+
*/
|
|
3949
4361
|
fields?: string[];
|
|
3950
4362
|
}
|
|
3951
4363
|
interface SearchQuery extends Pagination {
|
|
@@ -4464,7 +4876,10 @@ export declare namespace Corehr {
|
|
|
4464
4876
|
employment_id: string;
|
|
4465
4877
|
/** 离职日期 */
|
|
4466
4878
|
offboarding_date: string;
|
|
4467
|
-
/**
|
|
4879
|
+
/**
|
|
4880
|
+
* 离职原因,可通过接口
|
|
4881
|
+
* [【查询员工离职原因列表】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query)获取
|
|
4882
|
+
*/
|
|
4468
4883
|
offboarding_reason_unique_identifier: string;
|
|
4469
4884
|
/** 离职原因说明,长度限制6000 */
|
|
4470
4885
|
offboarding_reason_explanation?: string;
|
|
@@ -4504,6 +4919,176 @@ export declare namespace Corehr {
|
|
|
4504
4919
|
created_time?: string;
|
|
4505
4920
|
}
|
|
4506
4921
|
}
|
|
4922
|
+
namespace SignatureFile {
|
|
4923
|
+
interface Methods {
|
|
4924
|
+
/**
|
|
4925
|
+
* 终止电子签文件
|
|
4926
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_file/terminate
|
|
4927
|
+
*/
|
|
4928
|
+
terminate(body: TerminateRequest, query?: TerminateQuery): Promise<TerminateResponse>;
|
|
4929
|
+
/**
|
|
4930
|
+
* 获取电子签文件列表
|
|
4931
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_file/list
|
|
4932
|
+
*/
|
|
4933
|
+
list(query?: ListQuery): Paginated<Lark.SignatureFile>;
|
|
4934
|
+
/**
|
|
4935
|
+
* 查询电子签文件详情
|
|
4936
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_file/query
|
|
4937
|
+
*/
|
|
4938
|
+
query(body: QueryRequest, query?: QueryQuery): Paginated<Lark.SignatureFile>;
|
|
4939
|
+
/**
|
|
4940
|
+
* 根据流程获取电子签文件信息
|
|
4941
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_file/list_by_biz_id
|
|
4942
|
+
*/
|
|
4943
|
+
listByBizId(query?: ListByBizIdQuery): Promise<ListByBizIdResponse>;
|
|
4944
|
+
/**
|
|
4945
|
+
* 下载电子签文件
|
|
4946
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_file/download
|
|
4947
|
+
*/
|
|
4948
|
+
download(signature_file_id: string): Promise<ArrayBuffer>;
|
|
4949
|
+
}
|
|
4950
|
+
interface TerminateRequest {
|
|
4951
|
+
/** 欲终止的电子签文件id列表 */
|
|
4952
|
+
ids: string[];
|
|
4953
|
+
/** 操作人ID */
|
|
4954
|
+
operator: string;
|
|
4955
|
+
/** 终止原因 */
|
|
4956
|
+
terminate_reason: string;
|
|
4957
|
+
}
|
|
4958
|
+
interface TerminateQuery {
|
|
4959
|
+
/** 用户 ID 类型 */
|
|
4960
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
4961
|
+
}
|
|
4962
|
+
interface TerminateResponse {
|
|
4963
|
+
/** 欲终止的文件总数量 */
|
|
4964
|
+
total_count?: number;
|
|
4965
|
+
/** 成功总数量 */
|
|
4966
|
+
success_count?: number;
|
|
4967
|
+
/** 失败总数量 */
|
|
4968
|
+
fail_count?: number;
|
|
4969
|
+
/** 终止成功的文件id列表 */
|
|
4970
|
+
success_file_id_list?: string[];
|
|
4971
|
+
/** 终止失败的文件id和对应的原因列表 */
|
|
4972
|
+
fail_file_id_and_reasons?: Lark.TerminateSignatureFailIdAndReason[];
|
|
4973
|
+
}
|
|
4974
|
+
interface ListQuery extends Pagination {
|
|
4975
|
+
/** 电子签文件id */
|
|
4976
|
+
signature_file_id?: string;
|
|
4977
|
+
/** 电子签文件状态状态,多个状态之间为「或」的关系 */
|
|
4978
|
+
states?: string;
|
|
4979
|
+
/** 更新时间早于等于某个时间点,按照东八区时区 */
|
|
4980
|
+
update_time_start?: string;
|
|
4981
|
+
/** 更新时间晚于等于某个时间点,按照东八区时区 */
|
|
4982
|
+
update_time_end?: string;
|
|
4983
|
+
/** 用户 ID 类型 */
|
|
4984
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
4985
|
+
/** 根据电子签模板id列表筛选电子签文件,返回的电子签文件使用的模板id在该list中 */
|
|
4986
|
+
template_ids?: string;
|
|
4987
|
+
}
|
|
4988
|
+
interface QueryRequest {
|
|
4989
|
+
/** 电子签文件状态状态列表,多个状态之间为「或」的关系 */
|
|
4990
|
+
states?: string[];
|
|
4991
|
+
/** 电子签模板ID列表,返回的电子签文件使用的模板id在该list中 */
|
|
4992
|
+
template_ids?: string[];
|
|
4993
|
+
}
|
|
4994
|
+
interface QueryQuery extends Pagination {
|
|
4995
|
+
/** 电子签文件id */
|
|
4996
|
+
signature_file_id?: string;
|
|
4997
|
+
/** 更新时间早于等于某个时间点,按照东八区时区 */
|
|
4998
|
+
update_time_start?: string;
|
|
4999
|
+
/** 更新时间晚于等于某个时间点,按照东八区时区 */
|
|
5000
|
+
update_time_end?: string;
|
|
5001
|
+
/** 用户 ID 类型 */
|
|
5002
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
5003
|
+
}
|
|
5004
|
+
interface ListByBizIdQuery {
|
|
5005
|
+
/** 业务自定义流程ID */
|
|
5006
|
+
biz_process_id: string;
|
|
5007
|
+
/** 业务类型,开放平台平应用可以传递"OpenAPI" */
|
|
5008
|
+
biz_type: string;
|
|
5009
|
+
/** 用户 ID 类型 */
|
|
5010
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
5011
|
+
/** 是否需要签署链接 */
|
|
5012
|
+
select_sign_url?: boolean;
|
|
5013
|
+
}
|
|
5014
|
+
interface ListByBizIdResponse {
|
|
5015
|
+
/** 返回的流程关联的电子签文件列表 */
|
|
5016
|
+
signature_files?: Lark.SignatureFile[];
|
|
5017
|
+
/** 批量签署链接 */
|
|
5018
|
+
batch_sign_url?: string;
|
|
5019
|
+
}
|
|
5020
|
+
}
|
|
5021
|
+
namespace SignatureNode {
|
|
5022
|
+
interface Methods {
|
|
5023
|
+
/**
|
|
5024
|
+
* 获取文件签署节点信息
|
|
5025
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_node/list_by_file_id
|
|
5026
|
+
*/
|
|
5027
|
+
listByFileId(query?: ListByFileIdQuery): Promise<ListByFileIdResponse>;
|
|
5028
|
+
}
|
|
5029
|
+
interface ListByFileIdQuery {
|
|
5030
|
+
/** 电子签文件id */
|
|
5031
|
+
file_id: string;
|
|
5032
|
+
/** 用户 ID 类型 */
|
|
5033
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
5034
|
+
}
|
|
5035
|
+
interface ListByFileIdResponse {
|
|
5036
|
+
/** 返回的电子签节点列表 */
|
|
5037
|
+
signature_nodes?: Lark.SignatureNode[];
|
|
5038
|
+
}
|
|
5039
|
+
}
|
|
5040
|
+
namespace SignatureTemplate {
|
|
5041
|
+
interface Methods {
|
|
5042
|
+
/**
|
|
5043
|
+
* 获取电子签模板内容
|
|
5044
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_template/search
|
|
5045
|
+
*/
|
|
5046
|
+
search(query?: SearchQuery): Promise<SearchResponse>;
|
|
5047
|
+
}
|
|
5048
|
+
interface SearchQuery {
|
|
5049
|
+
/** 电子签模板ids,用英文逗号分隔;如果不传 则返回所有模版信息(字节线上几百条) */
|
|
5050
|
+
template_ids?: string;
|
|
5051
|
+
/** 是否需要自定义字段,如-自定义签署方、合同变更前后公司等 */
|
|
5052
|
+
select_custom_field?: boolean;
|
|
5053
|
+
}
|
|
5054
|
+
interface SearchResponse {
|
|
5055
|
+
/** 返回的电子签模板list */
|
|
5056
|
+
signature_templates?: Lark.SignatureTemplate[];
|
|
5057
|
+
}
|
|
5058
|
+
}
|
|
5059
|
+
namespace SignatureTemplateInfoWithThumbnail {
|
|
5060
|
+
interface Methods {
|
|
5061
|
+
/**
|
|
5062
|
+
* 获取电子签模板列表
|
|
5063
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_template_info_with_thumbnail/list
|
|
5064
|
+
*/
|
|
5065
|
+
list(query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.SignatureTemplateInfoWithThumbnail>;
|
|
5066
|
+
}
|
|
5067
|
+
interface ListQuery extends Pagination {
|
|
5068
|
+
/** 模版名 */
|
|
5069
|
+
name?: string;
|
|
5070
|
+
/** 模板类别;多个类别之间使用英文,分隔 */
|
|
5071
|
+
category_apiname?: string;
|
|
5072
|
+
/** 模板用途;多个用途之间使用英文,分隔 */
|
|
5073
|
+
usage_apiname?: string;
|
|
5074
|
+
/** 是否停用 */
|
|
5075
|
+
active?: boolean;
|
|
5076
|
+
/** 是否需要模板适用区域信息;默认false,不会返回region_info信息 */
|
|
5077
|
+
need_region_info?: boolean;
|
|
5078
|
+
/** 电子签适用范围 */
|
|
5079
|
+
applicability_apinames?: string[];
|
|
5080
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
5081
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
5082
|
+
}
|
|
5083
|
+
interface ListResponse {
|
|
5084
|
+
/** 电子签模板缩略图列表 */
|
|
5085
|
+
items?: Lark.SignatureTemplateInfoWithThumbnail[];
|
|
5086
|
+
/** 查询偏移量;下次查询可以从page_token开始查询 */
|
|
5087
|
+
page_token?: number;
|
|
5088
|
+
/** 数据总数 */
|
|
5089
|
+
count?: number;
|
|
5090
|
+
}
|
|
5091
|
+
}
|
|
4507
5092
|
namespace Contract {
|
|
4508
5093
|
interface Methods {
|
|
4509
5094
|
/**
|
|
@@ -4785,7 +5370,12 @@ export declare namespace Corehr {
|
|
|
4785
5370
|
employment_id: string;
|
|
4786
5371
|
/** 授予数量 */
|
|
4787
5372
|
granting_quantity: string;
|
|
4788
|
-
/**
|
|
5373
|
+
/**
|
|
5374
|
+
* 授予时长单位
|
|
5375
|
+
* 可选值有:
|
|
5376
|
+
* - 1: 天
|
|
5377
|
+
* - 2: 小时
|
|
5378
|
+
*/
|
|
4789
5379
|
granting_unit: number;
|
|
4790
5380
|
/** 生效时间 */
|
|
4791
5381
|
effective_date: string;
|
|
@@ -4841,7 +5431,12 @@ export declare namespace Corehr {
|
|
|
4841
5431
|
workCalendarDate(body: WorkCalendarDateRequest): Promise<WorkCalendarDateResponse>;
|
|
4842
5432
|
}
|
|
4843
5433
|
interface LeaveTypesQuery extends Pagination {
|
|
4844
|
-
/**
|
|
5434
|
+
/**
|
|
5435
|
+
* 假期类型状态(不传则为全部)
|
|
5436
|
+
* 可选值有:
|
|
5437
|
+
* - 1:已启用
|
|
5438
|
+
* - 2:已停用
|
|
5439
|
+
*/
|
|
4845
5440
|
status?: string;
|
|
4846
5441
|
/** 用户 ID 类型 */
|
|
4847
5442
|
user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
|
|
@@ -4863,7 +5458,19 @@ export declare namespace Corehr {
|
|
|
4863
5458
|
employment_id_list?: string[];
|
|
4864
5459
|
/** 休假发起人 ID 列表,最大 100 个 */
|
|
4865
5460
|
initiator_id_list?: string[];
|
|
4866
|
-
/**
|
|
5461
|
+
/**
|
|
5462
|
+
* 请假记录的状态
|
|
5463
|
+
* 可选值有:
|
|
5464
|
+
* - 1:已通过
|
|
5465
|
+
* - 2:审批中
|
|
5466
|
+
* - 3:审批中(更正)
|
|
5467
|
+
* - 4:审批中(取消休假)
|
|
5468
|
+
* - 5:审批中(返岗)
|
|
5469
|
+
* - 6:已返岗
|
|
5470
|
+
* - 7:已拒绝
|
|
5471
|
+
* - 8:已取消
|
|
5472
|
+
* - 9:已撤回
|
|
5473
|
+
*/
|
|
4867
5474
|
leave_request_status?: string[];
|
|
4868
5475
|
/** 假期类型 ID 列表,枚举值可通过【获取假期类型列表】接口获取 */
|
|
4869
5476
|
leave_type_id_list?: string[];
|
|
@@ -5133,7 +5740,12 @@ export declare namespace Corehr {
|
|
|
5133
5740
|
role_id: string;
|
|
5134
5741
|
/** 管理范围信息 */
|
|
5135
5742
|
management_scope_list: Lark.ManagementScope[];
|
|
5136
|
-
/**
|
|
5743
|
+
/**
|
|
5744
|
+
* 查找方式
|
|
5745
|
+
* 可选值有:
|
|
5746
|
+
* - 1:只查找指定 部门/工作地点/公司/社保城市,如无授权信息则返回为空
|
|
5747
|
+
* - 2:当指定的 部门/工作地点/公司/社保城市 无授权信息,向上查找第一个授权记录并直接返回
|
|
5748
|
+
*/
|
|
5137
5749
|
search_method: string;
|
|
5138
5750
|
/** 页码标识,获取第一页传空,每次查询会返回下一页的page_token */
|
|
5139
5751
|
page_token?: string;
|