@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.
Files changed (52) hide show
  1. package/lib/bot.d.ts +5 -5
  2. package/lib/http.d.ts +6 -3
  3. package/lib/index.cjs +293 -223
  4. package/lib/types/acs.d.ts +4 -1
  5. package/lib/types/apaas.d.ts +152 -0
  6. package/lib/types/application.d.ts +20 -4
  7. package/lib/types/approval.d.ts +0 -13
  8. package/lib/types/attendance.d.ts +11 -5
  9. package/lib/types/authen.d.ts +8 -2
  10. package/lib/types/bitable.d.ts +25 -4
  11. package/lib/types/board.d.ts +17 -0
  12. package/lib/types/calendar.d.ts +16 -5
  13. package/lib/types/contact.d.ts +55 -12
  14. package/lib/types/corehr.d.ts +754 -142
  15. package/lib/types/drive.d.ts +20 -3
  16. package/lib/types/ehr.d.ts +11 -2
  17. package/lib/types/helpdesk.d.ts +15 -6
  18. package/lib/types/hire.d.ts +13 -13
  19. package/lib/types/human_authentication.d.ts +1 -1
  20. package/lib/types/im.d.ts +76 -20
  21. package/lib/types/index.d.ts +712 -115
  22. package/lib/types/mail.d.ts +106 -16
  23. package/lib/types/search.d.ts +4 -1
  24. package/lib/ws.d.ts +30 -0
  25. package/package.json +6 -3
  26. package/src/bot.ts +28 -15
  27. package/src/http.ts +10 -4
  28. package/src/types/acs.ts +4 -1
  29. package/src/types/apaas.ts +185 -0
  30. package/src/types/application.ts +20 -4
  31. package/src/types/approval.ts +0 -15
  32. package/src/types/attendance.ts +11 -5
  33. package/src/types/authen.ts +8 -2
  34. package/src/types/bitable.ts +25 -4
  35. package/src/types/board.ts +22 -0
  36. package/src/types/calendar.ts +16 -5
  37. package/src/types/contact.ts +55 -12
  38. package/src/types/corehr.ts +796 -142
  39. package/src/types/drive.ts +20 -3
  40. package/src/types/ehr.ts +11 -2
  41. package/src/types/helpdesk.ts +15 -6
  42. package/src/types/hire.ts +17 -17
  43. package/src/types/human_authentication.ts +1 -1
  44. package/src/types/im.ts +76 -20
  45. package/src/types/index.ts +738 -115
  46. package/src/types/mail.ts +106 -16
  47. package/src/types/search.ts +4 -1
  48. package/src/ws.ts +183 -0
  49. package/lib/types/api.d.ts +0 -28510
  50. package/lib/types/internal.d.ts +0 -21
  51. package/lib/types/message/content.d.ts +0 -433
  52. package/lib/types/message/index.d.ts +0 -95
@@ -2586,7 +2586,7 @@ export interface Bank {
2586
2586
  bank_name?: I18n[];
2587
2587
  /** 总行代码 */
2588
2588
  bank_code?: string;
2589
- /** 国家/地区 ID,可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询 */
2589
+ /** 国家/地区 ID,可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询 */
2590
2590
  country_region_id?: string;
2591
2591
  /** 状态 */
2592
2592
  status?: 1 | 0;
@@ -2648,7 +2648,7 @@ export interface BankBranch {
2648
2648
  bank_branch_id?: string;
2649
2649
  /** 支行名称 */
2650
2650
  bank_branch_name?: I18n[];
2651
- /** 所属银行 ID,可通过[查询银行信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search)接口查询 */
2651
+ /** 所属银行 ID,可通过[查询银行信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search)接口查询 */
2652
2652
  bank_id?: string;
2653
2653
  /** 金融分支机构编码(联行号) */
2654
2654
  code?: string;
@@ -3202,7 +3202,13 @@ export interface CalendarEvent {
3202
3202
  attachments?: Attachment[];
3203
3203
  }
3204
3204
  export interface CalendarEventAttendee {
3205
- /** 参与人类型,仅当新建参与人时可设置类型<br>type为User时,值为open_id/user_id/union_id<br>type为Chat时,值为open_chat_id<br>type为Resource时,值为open_room_id<br>type为ThirdParty时,值为third_party_email;不支持通过API新建该类型参与人 */
3205
+ /**
3206
+ * 参与人类型,仅当新建参与人时可设置类型
3207
+ * type为User时,值为open_id/user_id/union_id
3208
+ * type为Chat时,值为open_chat_id
3209
+ * type为Resource时,值为open_room_id
3210
+ * type为ThirdParty时,值为third_party_email;不支持通过API新建该类型参与人
3211
+ */
3206
3212
  type?: 'user' | 'chat' | 'resource' | 'third_party';
3207
3213
  /** 参与人是否为「可选参加」,无法编辑群参与人的此字段 */
3208
3214
  is_optional?: boolean;
@@ -3236,7 +3242,13 @@ export interface CalendarEventAttendeeChatMember {
3236
3242
  is_external?: boolean;
3237
3243
  }
3238
3244
  export interface CalendarEventAttendeeId {
3239
- /** 参与人类型,仅当新建参与人时可设置类型<br>type为User时,值为open_id/user_id/union_id<br>type为Chat时,值为open_chat_id<br>type为Resource时,值为open_room_id<br>type为ThirdParty时,值为third_party_email;不支持通过API新建该类型参与人 */
3245
+ /**
3246
+ * 参与人类型,仅当新建参与人时可设置类型
3247
+ * type为User时,值为open_id/user_id/union_id
3248
+ * type为Chat时,值为open_chat_id
3249
+ * type为Resource时,值为open_room_id
3250
+ * type为ThirdParty时,值为third_party_email;不支持通过API新建该类型参与人
3251
+ */
3240
3252
  type?: 'user' | 'chat' | 'resource' | 'third_party';
3241
3253
  /** 参与人的用户id,依赖于user_id_type返回对应的取值,当is_external为true时,此字段只会返回open_id或者union_id */
3242
3254
  user_id?: string;
@@ -3369,7 +3381,11 @@ export interface ChatMenuItem {
3369
3381
  image_key?: string;
3370
3382
  /** 名称 */
3371
3383
  name: string;
3372
- /** 国际化名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内。<br><br>**注意:**<br>1中文=2英文=2其他语言字符=2字符 */
3384
+ /**
3385
+ * 国际化名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内。
3386
+ * **注意:**
3387
+ * 1中文=2英文=2其他语言字符=2字符
3388
+ */
3373
3389
  i18n_names?: I18nNames;
3374
3390
  }
3375
3391
  export interface ChatMenuItemRedirectLink {
@@ -3462,7 +3478,7 @@ export interface City {
3462
3478
  city_id?: string;
3463
3479
  /** 城市名称 */
3464
3480
  name?: I18n[];
3465
- /** 所属省份/主要行政区 ID,详细信息可通过[查询省份/主要行政区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获得 */
3481
+ /** 所属省份/主要行政区 ID,详细信息可通过[查询省份/主要行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获得 */
3466
3482
  country_region_subdivision_id?: string;
3467
3483
  /** 城市三位字母代码 */
3468
3484
  code?: string;
@@ -3778,8 +3794,6 @@ export interface CommonSchema {
3778
3794
  is_customized?: boolean;
3779
3795
  /** 是否必填 */
3780
3796
  is_required?: boolean;
3781
- /** 是否可见 */
3782
- is_visible?: boolean;
3783
3797
  /** 是否启用 */
3784
3798
  active_status?: 1 | 2;
3785
3799
  /** 字段列表 */
@@ -3800,8 +3814,6 @@ export interface CommonSchemaChild {
3800
3814
  is_customized?: boolean;
3801
3815
  /** 是否必填 */
3802
3816
  is_required?: boolean;
3803
- /** 是否可见 */
3804
- is_visible?: boolean;
3805
3817
  /** 是否启用 */
3806
3818
  active_status?: 1 | 2;
3807
3819
  }
@@ -3821,7 +3833,7 @@ export interface CommonSchemaOption {
3821
3833
  }
3822
3834
  export interface CommonSchemaSetting {
3823
3835
  /** 字段类型 */
3824
- object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13;
3836
+ object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 13;
3825
3837
  /** 配置信息 */
3826
3838
  config?: CommonSchemaConfig;
3827
3839
  }
@@ -4382,9 +4394,9 @@ export interface CountryRegionSubdivision {
4382
4394
  country_region_subdivision_id?: string;
4383
4395
  /** 省份/主要行政区名称 */
4384
4396
  name?: I18n[];
4385
- /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4397
+ /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4386
4398
  country_region_id?: string;
4387
- /** 行政区类型,枚举值可通过飞书人事[枚举常量介绍](/ssl:ttdoc/server-docs/corehr-v1/feishu-people-enum-constant#402ea9a0)文档中行政区类型(subdivision_type)定义部分获得 */
4399
+ /** 行政区类型,枚举值可通过飞书人事[枚举常量介绍](https://open.feishu.cn/document/server-docs/corehr-v1/feishu-people-enum-constant#402ea9a0)文档中行政区类型(subdivision_type)定义部分获得 */
4388
4400
  subdivision_type?: Enum;
4389
4401
  /** 省份/主要行政区编码(ISO 3166-2) */
4390
4402
  iso_code?: string;
@@ -4598,7 +4610,7 @@ export interface Cube {
4598
4610
  export interface Currency {
4599
4611
  /** 货币 ID */
4600
4612
  currency_id?: string;
4601
- /** 货币所属国家/地区 ID 列表,详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4613
+ /** 货币所属国家/地区 ID 列表,详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4602
4614
  country_region_id_list?: string[];
4603
4615
  /** 货币名称 */
4604
4616
  currency_name?: I18n[];
@@ -5286,6 +5298,32 @@ export interface Diagram {
5286
5298
  /** 绘图类型 */
5287
5299
  diagram_type?: 1 | 2;
5288
5300
  }
5301
+ export declare const enum DiagramType {
5302
+ /** 未知 */
5303
+ UNKOWN = 0,
5304
+ /** 思维导图 */
5305
+ MIND_MAP = 1,
5306
+ /** 时序图 */
5307
+ SEQUENCE = 2,
5308
+ /** 活动图 */
5309
+ ACTIVITY = 3,
5310
+ /** 类图 */
5311
+ CLASS = 4,
5312
+ /** ER */
5313
+ ER = 5,
5314
+ /** 流程图 */
5315
+ FLOWCHART = 6,
5316
+ /** 用例图 */
5317
+ STATE = 7,
5318
+ /** 组件图 */
5319
+ COMPONENT_DIAGRAM = 8,
5320
+ /** ai流式生成流程图 */
5321
+ STREAMING_ACTIVITY = 101,
5322
+ /** ai流式生成时序图 */
5323
+ STREAMING_SEQUENCE = 102,
5324
+ /** plantUML语法补充超集GML */
5325
+ TIMELINE_GML = 201
5326
+ }
5289
5327
  export interface DiData {
5290
5328
  /** 字段值 1. 单选: "1" 2. 多选:"["1", "2"]" 3. 月份选择:"{"date":"2022-01"}" 4. 年份选择:"{"date":"2022"}" 5. 数字:"123" 6. 单行文本:"xxx " 7. 多行文本:"xxx xxxx" 8. 日期范围 "[1688140800000,1688140800000]" */
5291
5329
  value?: string;
@@ -5433,7 +5471,7 @@ export interface District {
5433
5471
  district_id?: string;
5434
5472
  /** 名称 */
5435
5473
  name?: I18n[];
5436
- /** 所属城市 ID,详细信息可通过[查询城市信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)接口获得 */
5474
+ /** 所属城市 ID,详细信息可通过[查询城市信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)接口获得 */
5437
5475
  city_id?: string;
5438
5476
  /** 行政区划代码 */
5439
5477
  subregion_code?: string;
@@ -5789,39 +5827,47 @@ export interface EmployeeOverboardInfo {
5789
5827
  export interface EmployeesAdditionalJob {
5790
5828
  /** 兼职记录ID */
5791
5829
  id?: string;
5792
- /** 人员类型 ID,可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
5830
+ /** 人员类型 ID,可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
5793
5831
  employee_type_id: string;
5794
- /** 工时制度 ID,可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
5832
+ /** 工时制度 ID,可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
5795
5833
  working_hours_type_id?: string;
5796
- /** 工作地点 ID,可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
5834
+ /** 工作地点 ID,可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
5797
5835
  work_location_id?: string;
5798
- /** 部门 ID,可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
5836
+ /** 部门 ID,可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
5799
5837
  department_id: string;
5800
- /** 职务 ID,可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
5838
+ /** 职务 ID,可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
5801
5839
  job_id?: string;
5802
- /** 职级 ID,可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
5840
+ /** 职级 ID,可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
5803
5841
  job_level_id?: string;
5804
- /** 序列 ID,可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
5842
+ /** 序列 ID,可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
5805
5843
  job_family_id?: string;
5806
- /** 雇佣 ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5844
+ /** 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5807
5845
  employment_id: string;
5808
5846
  /** 兼职开始日期 */
5809
5847
  start_date: string;
5810
5848
  /** 兼职结束日期 */
5811
5849
  end_date?: string;
5812
- /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5850
+ /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5813
5851
  direct_manager_id?: string;
5814
- /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5852
+ /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5815
5853
  dotted_line_manager_id?: string;
5816
- /** 排班类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "work_shift" */
5854
+ /**
5855
+ * 排班类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
5856
+ * - object_api_name = "job_data"
5857
+ * - custom_api_name = "work_shift"
5858
+ */
5817
5859
  work_shift?: Enum;
5818
- /** 薪资类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "compensation_type" */
5860
+ /**
5861
+ * 薪资类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
5862
+ * - object_api_name = "job_data"
5863
+ * - custom_api_name = "compensation_type"
5864
+ */
5819
5865
  compensation_type?: Enum;
5820
- /** 任职公司,可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
5866
+ /** 任职公司,可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
5821
5867
  service_company?: string;
5822
5868
  /** 周工作时长【0~168】 */
5823
5869
  weekly_working_hours?: string;
5824
- /** 工作日历ID,可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
5870
+ /** 工作日历ID,可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
5825
5871
  work_calendar_id?: string;
5826
5872
  /** 岗位 ID */
5827
5873
  position_id?: string;
@@ -5837,39 +5883,47 @@ export interface EmployeesAdditionalJobBatchReqDate {
5837
5883
  export interface EmployeesAdditionalJobWriteResp {
5838
5884
  /** 兼职记录ID */
5839
5885
  id?: string;
5840
- /** 人员类型 ID,可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
5886
+ /** 人员类型 ID,可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
5841
5887
  employee_type_id: string;
5842
- /** 工时制度 ID,可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
5888
+ /** 工时制度 ID,可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
5843
5889
  working_hours_type_id?: string;
5844
- /** 工作地点 ID,可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
5890
+ /** 工作地点 ID,可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
5845
5891
  work_location_id?: string;
5846
- /** 部门 ID,可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
5892
+ /** 部门 ID,可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
5847
5893
  department_id: string;
5848
- /** 职务 ID,可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
5894
+ /** 职务 ID,可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
5849
5895
  job_id?: string;
5850
- /** 职级 ID,可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
5896
+ /** 职级 ID,可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
5851
5897
  job_level_id?: string;
5852
- /** 序列 ID,可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
5898
+ /** 序列 ID,可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
5853
5899
  job_family_id?: string;
5854
- /** 雇佣 ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5900
+ /** 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5855
5901
  employment_id: string;
5856
5902
  /** 兼职开始日期 */
5857
5903
  start_date: string;
5858
5904
  /** 兼职结束日期 */
5859
5905
  end_date?: string;
5860
- /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5906
+ /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5861
5907
  direct_manager_id?: string;
5862
- /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5908
+ /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
5863
5909
  dotted_line_manager_id?: string;
5864
- /** 排班类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "work_shift" */
5910
+ /**
5911
+ * 排班类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
5912
+ * - object_api_name = "job_data"
5913
+ * - custom_api_name = "work_shift"
5914
+ */
5865
5915
  work_shift?: Enum;
5866
- /** 薪资类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "compensation_type" */
5916
+ /**
5917
+ * 薪资类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
5918
+ * - object_api_name = "job_data"
5919
+ * - custom_api_name = "compensation_type"
5920
+ */
5867
5921
  compensation_type?: Enum;
5868
- /** 任职公司,可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
5922
+ /** 任职公司,可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
5869
5923
  service_company?: string;
5870
5924
  /** 周工作时长【0~168】 */
5871
5925
  weekly_working_hours?: string;
5872
- /** 工作日历ID,可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
5926
+ /** 工作日历ID,可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
5873
5927
  work_calendar_id?: string;
5874
5928
  /** 岗位 ID */
5875
5929
  position_id?: string;
@@ -5877,109 +5931,267 @@ export interface EmployeesAdditionalJobWriteResp {
5877
5931
  employee_subtype_id?: string;
5878
5932
  }
5879
5933
  export interface EmployeesInternationalAssignment {
5880
- /** 外派工作地点 ID - 可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
5934
+ /**
5935
+ * 外派工作地点 ID
5936
+ * - 可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息
5937
+ */
5881
5938
  work_location_id?: string;
5882
- /** 外派任职公司 ID- 可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
5939
+ /**
5940
+ * 外派任职公司 ID
5941
+ * - 可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息
5942
+ */
5883
5943
  service_company?: string;
5884
- /** 排班类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:work_shift */
5944
+ /**
5945
+ * 排班类型
5946
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
5947
+ * - object_api_name:job_data
5948
+ * - custom_api_name:work_shift
5949
+ */
5885
5950
  work_shift?: Enum;
5886
- /** 工时制度ID- 可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
5951
+ /**
5952
+ * 工时制度ID
5953
+ * - 可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息
5954
+ */
5887
5955
  working_hours_type_id?: string;
5888
- /** 人员类型ID- 可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
5956
+ /**
5957
+ * 人员类型ID
5958
+ * - 可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息
5959
+ */
5889
5960
  employee_type_id?: string;
5890
5961
  /** 周工作时长 */
5891
5962
  weekly_working_hours_v2?: number;
5892
- /** 部门 ID- 可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息- 类型与 department_id_type 一致 */
5963
+ /**
5964
+ * 部门 ID
5965
+ * - 可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息
5966
+ * - 类型与 department_id_type 一致
5967
+ */
5893
5968
  department_id?: string;
5894
- /** 职务 ID- 可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
5969
+ /**
5970
+ * 职务 ID
5971
+ * - 可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息
5972
+ */
5895
5973
  job_id?: string;
5896
- /** 序列 ID- 可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
5974
+ /**
5975
+ * 序列 ID
5976
+ * - 可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息
5977
+ */
5897
5978
  job_family_id?: string;
5898
- /** 职级 ID- 可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
5979
+ /**
5980
+ * 职级 ID
5981
+ * - 可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息
5982
+ */
5899
5983
  job_level_id?: string;
5900
- /** 职等 ID- 可通过[【查询职等】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息 */
5984
+ /**
5985
+ * 职等 ID
5986
+ * - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息
5987
+ */
5901
5988
  job_grade_id?: string;
5902
- /** 薪资类型 - 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:compensation_type */
5989
+ /**
5990
+ * 薪资类型
5991
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
5992
+ * - object_api_name:job_data
5993
+ * - custom_api_name:compensation_type
5994
+ */
5903
5995
  compensation_type?: Enum;
5904
- /** 直属上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
5996
+ /**
5997
+ * 直属上级雇佣 ID
5998
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
5999
+ * - 类型与 user_id_type 一致
6000
+ */
5905
6001
  direct_manager_id?: string;
5906
- /** 虚线上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6002
+ /**
6003
+ * 虚线上级雇佣 ID
6004
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6005
+ * - 类型与 user_id_type 一致
6006
+ */
5907
6007
  dotted_line_manager_id?: string;
5908
- /** 工作日历 ID- 可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6008
+ /**
6009
+ * 工作日历 ID
6010
+ * - 可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息
6011
+ */
5909
6012
  work_calendar_id?: string;
5910
- /** 岗位 ID- 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) */
6013
+ /**
6014
+ * 岗位 ID
6015
+ * - 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
6016
+ */
5911
6017
  position_id?: string;
5912
- /** 雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6018
+ /**
6019
+ * 雇佣 ID
6020
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6021
+ * - 类型与 user_id_type 一致
6022
+ */
5913
6023
  employment_id?: string;
5914
- /** 自定义字段- 请参考[【自定义字段说明】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) */
6024
+ /**
6025
+ * 自定义字段
6026
+ * - 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
6027
+ */
5915
6028
  custom_fields?: ObjectFieldData[];
5916
6029
  /** 外派原因说明 */
5917
6030
  international_assignment_reason?: string;
5918
6031
  /** 备注 */
5919
6032
  description?: string;
5920
- /** 预计结束日期- 格式:yyyy-mm-dd */
6033
+ /**
6034
+ * 预计结束日期
6035
+ * - 格式:yyyy-mm-dd
6036
+ */
5921
6037
  international_assignment_expected_end_date?: string;
5922
- /** 外派状态- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_status */
6038
+ /**
6039
+ * 外派状态
6040
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6041
+ * - object_api_name:international_assignment
6042
+ * - custom_api_name:international_assignment_status
6043
+ */
5923
6044
  international_assignment_status?: Enum;
5924
- /** 外派类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_type */
6045
+ /**
6046
+ * 外派类型
6047
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6048
+ * - object_api_name:international_assignment
6049
+ * - custom_api_name:international_assignment_type
6050
+ */
5925
6051
  international_assignment_type?: Enum;
5926
- /** 开始日期- 格式:yyyy-mm-dd */
6052
+ /**
6053
+ * 开始日期
6054
+ * - 格式:yyyy-mm-dd
6055
+ */
5927
6056
  effective_time?: string;
5928
- /** 结束日期- 格式:yyyy-mm-dd- 在外派未结束时,该值默认为 9999-12-31 */
6057
+ /**
6058
+ * 结束日期
6059
+ * - 格式:yyyy-mm-dd
6060
+ * - 在外派未结束时,该值默认为 9999-12-31
6061
+ */
5929
6062
  expiration_time?: string;
5930
6063
  /** 外派ID */
5931
6064
  id?: string;
5932
6065
  }
5933
6066
  export interface EmployeesInternationalAssignmentResp {
5934
- /** 外派工作地点 ID - 可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
6067
+ /**
6068
+ * 外派工作地点 ID
6069
+ * - 可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息
6070
+ */
5935
6071
  work_location_id?: string;
5936
- /** 外派任职公司 ID- 可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
6072
+ /**
6073
+ * 外派任职公司 ID
6074
+ * - 可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息
6075
+ */
5937
6076
  service_company?: string;
5938
- /** 排班类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:work_shift */
6077
+ /**
6078
+ * 排班类型
6079
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6080
+ * - object_api_name:job_data
6081
+ * - custom_api_name:work_shift
6082
+ */
5939
6083
  work_shift?: Enum;
5940
- /** 工时制度ID- 可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
6084
+ /**
6085
+ * 工时制度ID
6086
+ * - 可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息
6087
+ */
5941
6088
  working_hours_type_id?: string;
5942
- /** 人员类型ID- 可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
6089
+ /**
6090
+ * 人员类型ID
6091
+ * - 可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息
6092
+ */
5943
6093
  employee_type_id?: string;
5944
6094
  /** 周工作时长 */
5945
6095
  weekly_working_hours_v2?: number;
5946
- /** 部门 ID- 可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息- 类型与 department_id_type 一致 */
6096
+ /**
6097
+ * 部门 ID
6098
+ * - 可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息
6099
+ * - 类型与 department_id_type 一致
6100
+ */
5947
6101
  department_id?: string;
5948
- /** 职务 ID- 可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
6102
+ /**
6103
+ * 职务 ID
6104
+ * - 可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息
6105
+ */
5949
6106
  job_id?: string;
5950
- /** 序列 ID- 可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
6107
+ /**
6108
+ * 序列 ID
6109
+ * - 可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息
6110
+ */
5951
6111
  job_family_id?: string;
5952
- /** 职级 ID- 可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
6112
+ /**
6113
+ * 职级 ID
6114
+ * - 可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息
6115
+ */
5953
6116
  job_level_id?: string;
5954
- /** 职等 ID- 可通过[【查询职等】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息 */
6117
+ /**
6118
+ * 职等 ID
6119
+ * - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息
6120
+ */
5955
6121
  job_grade_id?: string;
5956
- /** 薪资类型 - 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:compensation_type */
6122
+ /**
6123
+ * 薪资类型
6124
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6125
+ * - object_api_name:job_data
6126
+ * - custom_api_name:compensation_type
6127
+ */
5957
6128
  compensation_type?: Enum;
5958
- /** 直属上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6129
+ /**
6130
+ * 直属上级雇佣 ID
6131
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6132
+ * - 类型与 user_id_type 一致
6133
+ */
5959
6134
  direct_manager_id?: string;
5960
- /** 虚线上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6135
+ /**
6136
+ * 虚线上级雇佣 ID
6137
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6138
+ * - 类型与 user_id_type 一致
6139
+ */
5961
6140
  dotted_line_manager_id?: string;
5962
- /** 工作日历 ID- 可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6141
+ /**
6142
+ * 工作日历 ID
6143
+ * - 可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息
6144
+ */
5963
6145
  work_calendar_id?: string;
5964
- /** 岗位 ID- 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) */
6146
+ /**
6147
+ * 岗位 ID
6148
+ * - 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
6149
+ */
5965
6150
  position_id?: string;
5966
- /** 雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6151
+ /**
6152
+ * 雇佣 ID
6153
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6154
+ * - 类型与 user_id_type 一致
6155
+ */
5967
6156
  employment_id?: string;
5968
- /** 自定义字段- 请参考[【自定义字段说明】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) */
6157
+ /**
6158
+ * 自定义字段
6159
+ * - 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
6160
+ */
5969
6161
  custom_fields?: ObjectFieldData[];
5970
6162
  /** 外派原因说明 */
5971
6163
  international_assignment_reason?: string;
5972
6164
  /** 备注 */
5973
6165
  description?: string;
5974
- /** 预计结束日期- 格式:yyyy-mm-dd */
6166
+ /**
6167
+ * 预计结束日期
6168
+ * - 格式:yyyy-mm-dd
6169
+ */
5975
6170
  international_assignment_expected_end_date?: string;
5976
- /** 外派状态- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_status */
6171
+ /**
6172
+ * 外派状态
6173
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6174
+ * - object_api_name:international_assignment
6175
+ * - custom_api_name:international_assignment_status
6176
+ */
5977
6177
  international_assignment_status?: Enum;
5978
- /** 外派类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_type */
6178
+ /**
6179
+ * 外派类型
6180
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6181
+ * - object_api_name:international_assignment
6182
+ * - custom_api_name:international_assignment_type
6183
+ */
5979
6184
  international_assignment_type?: Enum;
5980
- /** 开始日期- 格式:yyyy-mm-dd */
6185
+ /**
6186
+ * 开始日期
6187
+ * - 格式:yyyy-mm-dd
6188
+ */
5981
6189
  effective_time?: string;
5982
- /** 结束日期- 格式:yyyy-mm-dd- 在外派未结束时,该值默认为 9999-12-31 */
6190
+ /**
6191
+ * 结束日期
6192
+ * - 格式:yyyy-mm-dd
6193
+ * - 在外派未结束时,该值默认为 9999-12-31
6194
+ */
5983
6195
  expiration_time?: string;
5984
6196
  /** 外派ID */
5985
6197
  id?: string;
@@ -9592,7 +9804,13 @@ export interface Mailgroup {
9592
9804
  include_external_member?: boolean;
9593
9805
  /** Value is true if all company members are in this mail group */
9594
9806
  include_all_company_member?: boolean;
9595
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
9807
+ /**
9808
+ * Who can send mail to this mail group. Possible values are:
9809
+ * - ANYONE: Any Internet user can send mail to this mail group
9810
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
9811
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
9812
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
9813
+ */
9596
9814
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
9597
9815
  }
9598
9816
  export interface MailgroupManager {
@@ -9608,7 +9826,16 @@ export interface MailgroupMember {
9608
9826
  user_id?: string;
9609
9827
  /** The member's department id. Value is valid when type is DEPARTMENT */
9610
9828
  department_id?: string;
9611
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
9829
+ /**
9830
+ * The type of member. Possible values are:
9831
+ * - USER: internal user in the team
9832
+ * - DEPARTMENT: member is a department
9833
+ * - COMPANY: member is the company
9834
+ * - EXTERNAL_USER: internet user outside the organization
9835
+ * - MAIL_GROUP: member is another mail group
9836
+ * - PUBLIC_MAILBOX: member is a public mailbox
9837
+ * - OTHER_MEMBER: other internal member
9838
+ */
9612
9839
  type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER';
9613
9840
  }
9614
9841
  export interface MailgroupPermissionMember {
@@ -9620,7 +9847,11 @@ export interface MailgroupPermissionMember {
9620
9847
  department_id?: string;
9621
9848
  /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
9622
9849
  email?: string;
9623
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
9850
+ /**
9851
+ * The type of member. Possible values are:
9852
+ * - USER: internal user in the team
9853
+ * - DEPARTMENT: member is a department
9854
+ */
9624
9855
  type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX';
9625
9856
  }
9626
9857
  export interface ManagementScope {
@@ -10325,7 +10556,7 @@ export interface NationalIdType {
10325
10556
  custom_fields?: ObjectFieldData[];
10326
10557
  }
10327
10558
  export interface Nationality {
10328
- /** 国籍 ID,对应[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)等接口返回的 `nationality_id_v2` 字段 */
10559
+ /** 国籍 ID,对应[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)等接口返回的 `nationality_id_v2` 字段 */
10329
10560
  nationality_id?: string;
10330
10561
  /** 名称 */
10331
10562
  name?: I18n[];
@@ -10335,7 +10566,7 @@ export interface Nationality {
10335
10566
  alpha_3_code?: string;
10336
10567
  /** 数字代码 */
10337
10568
  numeric_code?: number;
10338
- /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
10569
+ /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
10339
10570
  country_region_id?: string;
10340
10571
  /** 状态 */
10341
10572
  status?: 1 | 0;
@@ -10359,9 +10590,9 @@ export interface NavigateMeta {
10359
10590
  hover_image_url?: string;
10360
10591
  }
10361
10592
  export interface Node {
10362
- /** 知识空间id,[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
10593
+ /** 知识空间id,[获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
10363
10594
  space_id?: string;
10364
- /** 节点token,[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
10595
+ /** 节点token,[获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
10365
10596
  node_token?: string;
10366
10597
  /** 对应文档类型的token,可根据 obj_type 判断属于哪种文档类型。 */
10367
10598
  obj_token?: string;
@@ -11966,15 +12197,28 @@ export interface PersonName {
11966
12197
  local_primary?: string;
11967
12198
  /** 名 - 本地文字 */
11968
12199
  local_first_name?: string;
11969
- /** 国家 / 地区- 详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
12200
+ /**
12201
+ * 国家 / 地区
12202
+ * - 详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得
12203
+ */
11970
12204
  country_region_id: string;
11971
- /** 姓名类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:name_type */
12205
+ /**
12206
+ * 姓名类型
12207
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
12208
+ * - object_api_name:person_name
12209
+ * - custom_api_name:name_type
12210
+ */
11972
12211
  name_type: Enum;
11973
12212
  /** 名 - 第二本地文字 */
11974
12213
  local_first_name_2?: string;
11975
12214
  /** 姓 - 第二本地文字 */
11976
12215
  local_primary_2?: string;
11977
- /** 补充姓名类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:additional_name_type */
12216
+ /**
12217
+ * 补充姓名类型
12218
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
12219
+ * - object_api_name:person_name
12220
+ * - custom_api_name:additional_name_type
12221
+ */
11978
12222
  additional_name_type?: Enum;
11979
12223
  /** 名 */
11980
12224
  first_name?: string;
@@ -11994,9 +12238,19 @@ export interface PersonName {
11994
12238
  secondary?: string;
11995
12239
  /** 婚后姓氏 */
11996
12240
  tertiary?: string;
11997
- /** 尊称- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:social */
12241
+ /**
12242
+ * 尊称
12243
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
12244
+ * - object_api_name:person_name
12245
+ * - custom_api_name:social
12246
+ */
11998
12247
  social?: Enum;
11999
- /** 头衔- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:title */
12248
+ /**
12249
+ * 头衔
12250
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
12251
+ * - object_api_name:person_name
12252
+ * - custom_api_name:title
12253
+ */
12000
12254
  title?: Enum;
12001
12255
  /** 本地中间名 */
12002
12256
  local_middle_name?: string;
@@ -12562,21 +12816,46 @@ export interface PreHireQuery {
12562
12816
  department_id?: string;
12563
12817
  }
12564
12818
  export interface PrehireSeniorityAdjustInformation {
12565
- /** 调整值- 精确度:两位小数- 单位:年- 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值 */
12819
+ /**
12820
+ * 调整值
12821
+ * - 精确度:两位小数
12822
+ * - 单位:年
12823
+ * - 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值
12824
+ */
12566
12825
  seniority_adjustment?: number;
12567
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
12826
+ /**
12827
+ * 调整类型
12828
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
12829
+ * - object_api_name:seniority_adjust_information
12830
+ * - custom_api_name:seniority_adjustment_type
12831
+ */
12568
12832
  seniority_adjustment_type: 'decrease' | 'increase';
12569
12833
  /** 司龄调整原因 */
12570
12834
  reasons_for_seniority_adjustment?: string;
12571
- /** 开始日期- 格式: yyyy-mm-dd */
12835
+ /**
12836
+ * 开始日期
12837
+ * - 格式: yyyy-mm-dd
12838
+ */
12572
12839
  start_date?: string;
12573
- /** 结束日期- 格式: yyyy-mm-dd */
12840
+ /**
12841
+ * 结束日期
12842
+ * - 格式: yyyy-mm-dd
12843
+ */
12574
12844
  end_date?: string;
12575
12845
  }
12576
12846
  export interface PrehireSeniorityAdjustInformationQuery {
12577
- /** 调整值- 精确度:两位小数- 单位:年 */
12847
+ /**
12848
+ * 调整值
12849
+ * - 精确度:两位小数
12850
+ * - 单位:年
12851
+ */
12578
12852
  seniority_adjustment?: number;
12579
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
12853
+ /**
12854
+ * 调整类型
12855
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
12856
+ * - object_api_name:seniority_adjust_information
12857
+ * - custom_api_name:seniority_adjustment_type
12858
+ */
12580
12859
  seniority_adjustment_type?: Enum;
12581
12860
  /** 司龄调整原因 */
12582
12861
  reasons_for_seniority_adjustment?: string;
@@ -12588,15 +12867,31 @@ export interface PrehireSeniorityAdjustInformationQuery {
12588
12867
  custom_fields?: CustomFieldData[];
12589
12868
  }
12590
12869
  export interface PrehireSeniorityAdjustInformationUpdate {
12591
- /** 调整值- 精确度:两位小数- 单位:年- 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值 */
12870
+ /**
12871
+ * 调整值
12872
+ * - 精确度:两位小数
12873
+ * - 单位:年
12874
+ * - 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值
12875
+ */
12592
12876
  seniority_adjustment?: number;
12593
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
12877
+ /**
12878
+ * 调整类型
12879
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
12880
+ * - object_api_name:seniority_adjust_information
12881
+ * - custom_api_name:seniority_adjustment_type
12882
+ */
12594
12883
  seniority_adjustment_type: 'decrease' | 'increase';
12595
12884
  /** 司龄调整原因 */
12596
12885
  reasons_for_seniority_adjustment?: string;
12597
- /** 开始日期- 格式: yyyy-mm-dd */
12886
+ /**
12887
+ * 开始日期
12888
+ * - 格式: yyyy-mm-dd
12889
+ */
12598
12890
  start_date?: string;
12599
- /** 结束日期- 格式: yyyy-mm-dd */
12891
+ /**
12892
+ * 结束日期
12893
+ * - 格式: yyyy-mm-dd
12894
+ */
12600
12895
  end_date?: string;
12601
12896
  }
12602
12897
  export interface PreviewNode {
@@ -13356,7 +13651,10 @@ export interface PublicMailboxMember {
13356
13651
  member_id?: string;
13357
13652
  /** The member's user id. Value is valid when type is USER */
13358
13653
  user_id?: string;
13359
- /** The type of member. Possible values are:- USER: internal user in the team */
13654
+ /**
13655
+ * The type of member. Possible values are:
13656
+ * - USER: internal user in the team
13657
+ */
13360
13658
  type?: 'USER';
13361
13659
  }
13362
13660
  export interface PunchMember {
@@ -15083,17 +15381,35 @@ export interface Sender {
15083
15381
  tenant_key?: string;
15084
15382
  }
15085
15383
  export interface SeniorityAdjustInformationEdit {
15086
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
15384
+ /**
15385
+ * 调整类型
15386
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
15387
+ * - object_api_name:seniority_adjust_information
15388
+ * - custom_api_name:seniority_adjustment_type
15389
+ */
15087
15390
  seniority_adjustment_type: 'increase' | 'decrease';
15088
- /** 开始日期- 格式: yyyy-mm-dd */
15391
+ /**
15392
+ * 开始日期
15393
+ * - 格式: yyyy-mm-dd
15394
+ */
15089
15395
  start_date?: string;
15090
- /** 结束日期- 格式: yyyy-mm-dd */
15396
+ /**
15397
+ * 结束日期
15398
+ * - 格式: yyyy-mm-dd
15399
+ */
15091
15400
  end_date?: string;
15092
15401
  /** 调整原因 */
15093
15402
  reasons_for_seniority_adjustment?: string;
15094
- /** 调整值- 精确度:两位小数- 单位:年 */
15403
+ /**
15404
+ * 调整值
15405
+ * - 精确度:两位小数
15406
+ * - 单位:年
15407
+ */
15095
15408
  seniority_adjustment: number;
15096
- /** 自定义字段- 具体支持的对象请参考[【自定义字段说明】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) */
15409
+ /**
15410
+ * 自定义字段
15411
+ * - 具体支持的对象请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
15412
+ */
15097
15413
  custom_fields?: ProfileSettingCustomField[];
15098
15414
  }
15099
15415
  export interface Sentence {
@@ -15226,6 +15542,266 @@ export interface SignatureAttachment {
15226
15542
  /** 文件模板类型名称 */
15227
15543
  file_template_type_name?: string;
15228
15544
  }
15545
+ export interface SignatureEnumInfoLabel {
15546
+ /** zh-CN */
15547
+ zh?: string;
15548
+ /** en-US */
15549
+ en?: string;
15550
+ }
15551
+ export interface SignatureFile {
15552
+ /** 电子签文件ID */
15553
+ signature_file_id: string;
15554
+ /** 名称 */
15555
+ names?: I18n[];
15556
+ /** 创建时间 */
15557
+ create_time?: string;
15558
+ /** 更新时间 */
15559
+ update_time?: string;
15560
+ /** 雇员 id */
15561
+ employment_id?: string;
15562
+ /** 待入职 id */
15563
+ pre_hire_id?: string;
15564
+ /** 电子签文件状态,枚举值可通过文档【飞书人事枚举常量】电子签文件状态(signature_file_state)枚举定义部分获得 */
15565
+ signature_file_state?: Enum;
15566
+ /** 供应商侧的合同编号,作为幂等key */
15567
+ contract_code?: string;
15568
+ /** 电子签文件生效日期 */
15569
+ effective_date?: string;
15570
+ /** 电子签模板ID */
15571
+ template_id?: string;
15572
+ /** 签署链接 */
15573
+ sign_url?: string;
15574
+ }
15575
+ export interface SignatureMetaInfo {
15576
+ /** 元数据api_name */
15577
+ api_name?: string;
15578
+ /** wukong id */
15579
+ wk_id?: string;
15580
+ /** 多语描述 */
15581
+ label?: I18n[];
15582
+ }
15583
+ export interface SignatureNode {
15584
+ /** 电子签节点列表 */
15585
+ user_infos?: SignatureUserInfo[];
15586
+ /** 电子签文件节点状态 */
15587
+ state: string;
15588
+ /** 节点完成时间 */
15589
+ finish_time?: string;
15590
+ /** 节点最近更新时间 */
15591
+ updated_time?: string;
15592
+ /** 当前节点是否为正在处理的节点 */
15593
+ is_ongoing: boolean;
15594
+ /** 当前操作节点的角色名称 */
15595
+ role_label: SignatureEnumInfoLabel;
15596
+ /** 签署角色 */
15597
+ sign_role?: string;
15598
+ }
15599
+ export interface SignatureSignatoryLabel {
15600
+ /** 电子签模板签订人类型 */
15601
+ template_signatory_type: Enum;
15602
+ /** 中英文描述 */
15603
+ label: I18n[];
15604
+ /** 主数据apiname */
15605
+ apiname?: string;
15606
+ }
15607
+ export interface SignatureTemplate {
15608
+ /** 电子签模板id */
15609
+ id?: string;
15610
+ /** 简略信息 */
15611
+ brief_info?: SignatureTemplateBriefInfo;
15612
+ /** 模板内容信息 */
15613
+ content_info?: SignatureTemplateContentInfo;
15614
+ }
15615
+ export interface SignatureTemplateBriefInfo {
15616
+ /** id */
15617
+ id?: string;
15618
+ /** 名称 支持多语 */
15619
+ label?: I18n[];
15620
+ /** 模版类别 */
15621
+ category?: Enum;
15622
+ /** 模版用法 */
15623
+ usage?: Enum;
15624
+ /** 模版签署人标签 */
15625
+ signatory_labels?: SignatureSignatoryLabel[];
15626
+ /** 是否激活 */
15627
+ active?: boolean;
15628
+ /** 创建人 */
15629
+ create_by?: string;
15630
+ /** 修改人 */
15631
+ modify_by?: string;
15632
+ /** 适用范围 */
15633
+ applicability?: Enum;
15634
+ /** 创建方法 */
15635
+ creation_method?: string;
15636
+ /** 版本 */
15637
+ version?: string;
15638
+ /** 更新时间 */
15639
+ update_time?: string;
15640
+ /** 创建时间 */
15641
+ create_time?: string;
15642
+ /** 模板设置,包含开启骑缝章的类型等 */
15643
+ template_setting?: SignatureTemplateSetting;
15644
+ /** 模板适用区域 */
15645
+ template_region_info?: SignatureTemplateRegionInfo;
15646
+ /** 模板编码 */
15647
+ template_code?: string;
15648
+ /** 模板描述 支持多语 */
15649
+ template_desc?: I18n[];
15650
+ }
15651
+ export interface SignatureTemplateCombinationFieldInfo {
15652
+ /** total_apiname */
15653
+ total_apiname: string;
15654
+ /** apiname */
15655
+ apiname: string;
15656
+ /** 中英文描述 */
15657
+ title: I18n[];
15658
+ /** 适用区域名称 */
15659
+ contents?: SignatureTemplateCombinationSubFieldInfo[][];
15660
+ /** 电子签模板字段源类型 */
15661
+ source: Enum;
15662
+ }
15663
+ export interface SignatureTemplateCombinationFieldInfoV2 {
15664
+ /** total_apiname */
15665
+ total_apiname: string;
15666
+ /** apiname */
15667
+ apiname: string;
15668
+ /** 电子签模板字段源类型 */
15669
+ source?: Enum;
15670
+ }
15671
+ export interface SignatureTemplateCombinationSubFieldInfo {
15672
+ /** 字段类型枚举 */
15673
+ field_type: Enum;
15674
+ /** 公共字段信息 */
15675
+ info?: SignatureTemplateCommonFieldInfo;
15676
+ /** 双语描述 */
15677
+ label?: I18n[];
15678
+ }
15679
+ export interface SignatureTemplateCommonFieldInfo {
15680
+ /** 模板字段源类型;枚举值填到enum_name中,如:"System" "MainData" */
15681
+ source: Enum;
15682
+ /** 主数据apiname */
15683
+ apiname: string;
15684
+ }
15685
+ export interface SignatureTemplateContentInfo {
15686
+ /** 模版内容list */
15687
+ contents?: SignatureTemplateContentItem[];
15688
+ /** 自定义字段列表 */
15689
+ custom_fields?: SignatureTemplateCustomField[];
15690
+ /** 筛选条件列表 */
15691
+ filter_fields?: SignatureTemplateFilter[];
15692
+ /** 模板公共字段信息列表 */
15693
+ using_fields?: SignatureTemplateCommonFieldInfo[];
15694
+ /** 系统设置字段列表 */
15695
+ system_setting_fields?: SignatureTemplateField[];
15696
+ }
15697
+ export interface SignatureTemplateContentItem {
15698
+ /** 电子签模版内容的类型 */
15699
+ content_type: Enum;
15700
+ /** 显示规则左值 */
15701
+ filter_apiname?: string;
15702
+ /** 模版内容 */
15703
+ content?: string;
15704
+ /** 中英文描述 */
15705
+ label?: I18n[];
15706
+ /** 内容描述 */
15707
+ content_desc?: string;
15708
+ }
15709
+ export interface SignatureTemplateCustomField {
15710
+ /** 中英文描述 */
15711
+ label?: I18n[];
15712
+ /** 主数据apiname */
15713
+ apiname: string;
15714
+ /** 用户自定义字段类型 */
15715
+ custom_field_type: Enum;
15716
+ /** 是否使用到 */
15717
+ used: boolean;
15718
+ /** 是否需要 */
15719
+ is_required?: boolean;
15720
+ /** 自定义描述 */
15721
+ custom_desc?: string;
15722
+ /** 电子签模版公共字段信息 */
15723
+ common_info?: SignatureTemplateCommonFieldInfo;
15724
+ }
15725
+ export interface SignatureTemplateField {
15726
+ /** 模板字段值类型枚举 */
15727
+ field_type: Enum;
15728
+ /** 双语描述 */
15729
+ label?: I18n[];
15730
+ /** 通用字段信息 */
15731
+ common_info?: SignatureTemplateCommonFieldInfo;
15732
+ /** 组合字段信息 */
15733
+ combination_info?: SignatureTemplateCombinationFieldInfo;
15734
+ /** 子模板配置信息列表对应的string,避免循环引用问题 */
15735
+ children?: string;
15736
+ /** 组合字段信息v2 */
15737
+ combination_info_v2?: SignatureTemplateCombinationFieldInfoV2;
15738
+ }
15739
+ export interface SignatureTemplateFilter {
15740
+ /** 双语描述 */
15741
+ label: I18n[];
15742
+ /** 主数据apiname */
15743
+ apiname: string;
15744
+ /** 过滤条件列表 */
15745
+ filters?: SignatureTemplateFilterItem[];
15746
+ /** 多个生效条件的logic */
15747
+ logic?: Enum;
15748
+ /** 是否被校验 */
15749
+ is_checked?: boolean;
15750
+ /** 过滤条件描述 */
15751
+ filter_desc?: string;
15752
+ /** 过滤条件列表,使用string类型描述list的原因是为了避免循环引用问题,因为该list的item类型就是这个数据类型 */
15753
+ criterion_list?: string;
15754
+ }
15755
+ export interface SignatureTemplateFilterItem {
15756
+ /** 左值 */
15757
+ left: string;
15758
+ /** 右值列表 */
15759
+ rights?: string[];
15760
+ /** 操作符 */
15761
+ op: Enum;
15762
+ }
15763
+ export interface SignatureTemplateInfoWithThumbnail {
15764
+ /** id */
15765
+ id?: string;
15766
+ /** 名称 支持多语 */
15767
+ label?: I18n[];
15768
+ /** 模版类别 */
15769
+ category?: Enum;
15770
+ /** 模版用法 */
15771
+ usage?: Enum;
15772
+ /** 创建日期 */
15773
+ create_time?: string;
15774
+ /** 修改日期 */
15775
+ modify_time?: string;
15776
+ /** 创建人 */
15777
+ created_by?: SignatureUserInfo;
15778
+ /** 修改人 */
15779
+ updated_by?: SignatureUserInfo;
15780
+ /** 缩略图url */
15781
+ thumbnail_url?: string;
15782
+ /** 模版签署人标签 */
15783
+ signatory_labels?: SignatureSignatoryLabel[];
15784
+ /** 模板编码 */
15785
+ template_code?: string;
15786
+ /** 模板描述 */
15787
+ template_desc?: string;
15788
+ /** 模板适用区域 */
15789
+ template_region_info?: SignatureTemplateRegionInfo;
15790
+ }
15791
+ export interface SignatureTemplateRegionInfo {
15792
+ /** 是否全球适用 */
15793
+ is_global_scope?: string;
15794
+ /** 适用区域名称 */
15795
+ meta_infos?: SignatureMetaInfo[];
15796
+ }
15797
+ export interface SignatureTemplateSetting {
15798
+ /** 骑缝章类型 */
15799
+ page_seal_types?: string[];
15800
+ }
15801
+ export interface SignatureUserInfo {
15802
+ /** employmentID */
15803
+ id: string;
15804
+ }
15229
15805
  export interface Skill {
15230
15806
  /** 技能 ID */
15231
15807
  id?: string;
@@ -15550,6 +16126,12 @@ export interface Style {
15550
16126
  /** 边框颜色类型:0=系统颜色,取theme_border_color_code,1=自定义颜色,取border_color */
15551
16127
  border_color_type?: ColorType;
15552
16128
  }
16129
+ export declare const enum StyleType {
16130
+ /** 画板样式 */
16131
+ Board = 1,
16132
+ /** 经典样式 */
16133
+ Classic = 2
16134
+ }
15553
16135
  export interface Subdivision {
15554
16136
  /** 省份/行政区id */
15555
16137
  id: string;
@@ -15616,6 +16198,14 @@ export interface Svg {
15616
16198
  /** svg code */
15617
16199
  svg_code?: string;
15618
16200
  }
16201
+ export declare const enum SyntaxType {
16202
+ /** 未知 */
16203
+ UNKOWN = 0,
16204
+ /** Plantuml解析 */
16205
+ PLANT_UML = 1,
16206
+ /** Mermaid解析 */
16207
+ MERMAID = 2
16208
+ }
15619
16209
  export interface SystemFields {
15620
16210
  /** 中文姓名 */
15621
16211
  name?: string;
@@ -16603,6 +17193,12 @@ export interface Term {
16603
17193
  /** 译文 */
16604
17194
  to: string;
16605
17195
  }
17196
+ export interface TerminateSignatureFailIdAndReason {
17197
+ /** 终止操作失败的文件ID */
17198
+ signature_file_id: string;
17199
+ /** 终止失败的原因 */
17200
+ fail_reason: string;
17201
+ }
16606
17202
  export interface TerminationReason {
16607
17203
  /** 终止原因 ID */
16608
17204
  id?: string;
@@ -17843,6 +18439,7 @@ export interface UserViewDetail {
17843
18439
  /** 用户的最近查看时间timestamp(ms级别) */
17844
18440
  view_time?: string;
17845
18441
  }
18442
+ export type Uuid = string;
17846
18443
  export interface Value {
17847
18444
  /** 字符串值 */
17848
18445
  string_value?: string;