@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
@@ -2774,7 +2774,7 @@ export interface Bank {
2774
2774
  bank_name?: I18n[]
2775
2775
  /** 总行代码 */
2776
2776
  bank_code?: string
2777
- /** 国家/地区 ID,可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询 */
2777
+ /** 国家/地区 ID,可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询 */
2778
2778
  country_region_id?: string
2779
2779
  /** 状态 */
2780
2780
  status?: 1 | 0
@@ -2839,7 +2839,7 @@ export interface BankBranch {
2839
2839
  bank_branch_id?: string
2840
2840
  /** 支行名称 */
2841
2841
  bank_branch_name?: I18n[]
2842
- /** 所属银行 ID,可通过[查询银行信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search)接口查询 */
2842
+ /** 所属银行 ID,可通过[查询银行信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search)接口查询 */
2843
2843
  bank_id?: string
2844
2844
  /** 金融分支机构编码(联行号) */
2845
2845
  code?: string
@@ -3435,7 +3435,13 @@ export interface CalendarEvent {
3435
3435
  }
3436
3436
 
3437
3437
  export interface CalendarEventAttendee {
3438
- /** 参与人类型,仅当新建参与人时可设置类型<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新建该类型参与人 */
3438
+ /**
3439
+ * 参与人类型,仅当新建参与人时可设置类型
3440
+ * type为User时,值为open_id/user_id/union_id
3441
+ * type为Chat时,值为open_chat_id
3442
+ * type为Resource时,值为open_room_id
3443
+ * type为ThirdParty时,值为third_party_email;不支持通过API新建该类型参与人
3444
+ */
3439
3445
  type?: 'user' | 'chat' | 'resource' | 'third_party'
3440
3446
  /** 参与人是否为「可选参加」,无法编辑群参与人的此字段 */
3441
3447
  is_optional?: boolean
@@ -3471,7 +3477,13 @@ export interface CalendarEventAttendeeChatMember {
3471
3477
  }
3472
3478
 
3473
3479
  export interface CalendarEventAttendeeId {
3474
- /** 参与人类型,仅当新建参与人时可设置类型<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新建该类型参与人 */
3480
+ /**
3481
+ * 参与人类型,仅当新建参与人时可设置类型
3482
+ * type为User时,值为open_id/user_id/union_id
3483
+ * type为Chat时,值为open_chat_id
3484
+ * type为Resource时,值为open_room_id
3485
+ * type为ThirdParty时,值为third_party_email;不支持通过API新建该类型参与人
3486
+ */
3475
3487
  type?: 'user' | 'chat' | 'resource' | 'third_party'
3476
3488
  /** 参与人的用户id,依赖于user_id_type返回对应的取值,当is_external为true时,此字段只会返回open_id或者union_id */
3477
3489
  user_id?: string
@@ -3617,7 +3629,11 @@ export interface ChatMenuItem {
3617
3629
  image_key?: string
3618
3630
  /** 名称 */
3619
3631
  name: string
3620
- /** 国际化名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内。<br><br>**注意:**<br>1中文=2英文=2其他语言字符=2字符 */
3632
+ /**
3633
+ * 国际化名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内。
3634
+ * **注意:**
3635
+ * 1中文=2英文=2其他语言字符=2字符
3636
+ */
3621
3637
  i18n_names?: I18nNames
3622
3638
  }
3623
3639
 
@@ -3724,7 +3740,7 @@ export interface City {
3724
3740
  city_id?: string
3725
3741
  /** 城市名称 */
3726
3742
  name?: I18n[]
3727
- /** 所属省份/主要行政区 ID,详细信息可通过[查询省份/主要行政区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获得 */
3743
+ /** 所属省份/主要行政区 ID,详细信息可通过[查询省份/主要行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获得 */
3728
3744
  country_region_subdivision_id?: string
3729
3745
  /** 城市三位字母代码 */
3730
3746
  code?: string
@@ -4066,8 +4082,6 @@ export interface CommonSchema {
4066
4082
  is_customized?: boolean
4067
4083
  /** 是否必填 */
4068
4084
  is_required?: boolean
4069
- /** 是否可见 */
4070
- is_visible?: boolean
4071
4085
  /** 是否启用 */
4072
4086
  active_status?: 1 | 2
4073
4087
  /** 字段列表 */
@@ -4089,8 +4103,6 @@ export interface CommonSchemaChild {
4089
4103
  is_customized?: boolean
4090
4104
  /** 是否必填 */
4091
4105
  is_required?: boolean
4092
- /** 是否可见 */
4093
- is_visible?: boolean
4094
4106
  /** 是否启用 */
4095
4107
  active_status?: 1 | 2
4096
4108
  }
@@ -4113,7 +4125,7 @@ export interface CommonSchemaOption {
4113
4125
 
4114
4126
  export interface CommonSchemaSetting {
4115
4127
  /** 字段类型 */
4116
- object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
4128
+ object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 13
4117
4129
  /** 配置信息 */
4118
4130
  config?: CommonSchemaConfig
4119
4131
  }
@@ -4725,9 +4737,9 @@ export interface CountryRegionSubdivision {
4725
4737
  country_region_subdivision_id?: string
4726
4738
  /** 省份/主要行政区名称 */
4727
4739
  name?: I18n[]
4728
- /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4740
+ /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4729
4741
  country_region_id?: string
4730
- /** 行政区类型,枚举值可通过飞书人事[枚举常量介绍](/ssl:ttdoc/server-docs/corehr-v1/feishu-people-enum-constant#402ea9a0)文档中行政区类型(subdivision_type)定义部分获得 */
4742
+ /** 行政区类型,枚举值可通过飞书人事[枚举常量介绍](https://open.feishu.cn/document/server-docs/corehr-v1/feishu-people-enum-constant#402ea9a0)文档中行政区类型(subdivision_type)定义部分获得 */
4731
4743
  subdivision_type?: Enum
4732
4744
  /** 省份/主要行政区编码(ISO 3166-2) */
4733
4745
  iso_code?: string
@@ -4957,7 +4969,7 @@ export interface Cube {
4957
4969
  export interface Currency {
4958
4970
  /** 货币 ID */
4959
4971
  currency_id?: string
4960
- /** 货币所属国家/地区 ID 列表,详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4972
+ /** 货币所属国家/地区 ID 列表,详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
4961
4973
  country_region_id_list?: string[]
4962
4974
  /** 货币名称 */
4963
4975
  currency_name?: I18n[]
@@ -5708,6 +5720,33 @@ export interface Diagram {
5708
5720
  diagram_type?: 1 | 2
5709
5721
  }
5710
5722
 
5723
+ export const enum DiagramType {
5724
+ /** 未知 */
5725
+ UNKOWN = 0,
5726
+ /** 思维导图 */
5727
+ MIND_MAP = 1,
5728
+ /** 时序图 */
5729
+ SEQUENCE = 2,
5730
+ /** 活动图 */
5731
+ ACTIVITY = 3,
5732
+ /** 类图 */
5733
+ CLASS = 4,
5734
+ /** ER */
5735
+ ER = 5,
5736
+ /** 流程图 */
5737
+ FLOWCHART = 6,
5738
+ /** 用例图 */
5739
+ STATE = 7,
5740
+ /** 组件图 */
5741
+ COMPONENT_DIAGRAM = 8,
5742
+ /** ai流式生成流程图 */
5743
+ STREAMING_ACTIVITY = 101,
5744
+ /** ai流式生成时序图 */
5745
+ STREAMING_SEQUENCE = 102,
5746
+ /** plantUML语法补充超集GML */
5747
+ TIMELINE_GML = 201,
5748
+ }
5749
+
5711
5750
  export interface DiData {
5712
5751
  /** 字段值 1. 单选: "1" 2. 多选:"["1", "2"]" 3. 月份选择:"{"date":"2022-01"}" 4. 年份选择:"{"date":"2022"}" 5. 数字:"123" 6. 单行文本:"xxx " 7. 多行文本:"xxx xxxx" 8. 日期范围 "[1688140800000,1688140800000]" */
5713
5752
  value?: string
@@ -5870,7 +5909,7 @@ export interface District {
5870
5909
  district_id?: string
5871
5910
  /** 名称 */
5872
5911
  name?: I18n[]
5873
- /** 所属城市 ID,详细信息可通过[查询城市信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)接口获得 */
5912
+ /** 所属城市 ID,详细信息可通过[查询城市信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)接口获得 */
5874
5913
  city_id?: string
5875
5914
  /** 行政区划代码 */
5876
5915
  subregion_code?: string
@@ -6267,39 +6306,47 @@ export interface EmployeeOverboardInfo {
6267
6306
  export interface EmployeesAdditionalJob {
6268
6307
  /** 兼职记录ID */
6269
6308
  id?: string
6270
- /** 人员类型 ID,可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
6309
+ /** 人员类型 ID,可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
6271
6310
  employee_type_id: string
6272
- /** 工时制度 ID,可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
6311
+ /** 工时制度 ID,可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
6273
6312
  working_hours_type_id?: string
6274
- /** 工作地点 ID,可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
6313
+ /** 工作地点 ID,可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
6275
6314
  work_location_id?: string
6276
- /** 部门 ID,可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
6315
+ /** 部门 ID,可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
6277
6316
  department_id: string
6278
- /** 职务 ID,可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
6317
+ /** 职务 ID,可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
6279
6318
  job_id?: string
6280
- /** 职级 ID,可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
6319
+ /** 职级 ID,可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
6281
6320
  job_level_id?: string
6282
- /** 序列 ID,可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
6321
+ /** 序列 ID,可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
6283
6322
  job_family_id?: string
6284
- /** 雇佣 ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6323
+ /** 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6285
6324
  employment_id: string
6286
6325
  /** 兼职开始日期 */
6287
6326
  start_date: string
6288
6327
  /** 兼职结束日期 */
6289
6328
  end_date?: string
6290
- /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6329
+ /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6291
6330
  direct_manager_id?: string
6292
- /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6331
+ /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6293
6332
  dotted_line_manager_id?: string
6294
- /** 排班类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "work_shift" */
6333
+ /**
6334
+ * 排班类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6335
+ * - object_api_name = "job_data"
6336
+ * - custom_api_name = "work_shift"
6337
+ */
6295
6338
  work_shift?: Enum
6296
- /** 薪资类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "compensation_type" */
6339
+ /**
6340
+ * 薪资类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6341
+ * - object_api_name = "job_data"
6342
+ * - custom_api_name = "compensation_type"
6343
+ */
6297
6344
  compensation_type?: Enum
6298
- /** 任职公司,可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
6345
+ /** 任职公司,可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
6299
6346
  service_company?: string
6300
6347
  /** 周工作时长【0~168】 */
6301
6348
  weekly_working_hours?: string
6302
- /** 工作日历ID,可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6349
+ /** 工作日历ID,可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6303
6350
  work_calendar_id?: string
6304
6351
  /** 岗位 ID */
6305
6352
  position_id?: string
@@ -6317,39 +6364,47 @@ export interface EmployeesAdditionalJobBatchReqDate {
6317
6364
  export interface EmployeesAdditionalJobWriteResp {
6318
6365
  /** 兼职记录ID */
6319
6366
  id?: string
6320
- /** 人员类型 ID,可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
6367
+ /** 人员类型 ID,可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
6321
6368
  employee_type_id: string
6322
- /** 工时制度 ID,可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
6369
+ /** 工时制度 ID,可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
6323
6370
  working_hours_type_id?: string
6324
- /** 工作地点 ID,可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
6371
+ /** 工作地点 ID,可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
6325
6372
  work_location_id?: string
6326
- /** 部门 ID,可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
6373
+ /** 部门 ID,可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息;类型与department_id_type一致 */
6327
6374
  department_id: string
6328
- /** 职务 ID,可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
6375
+ /** 职务 ID,可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
6329
6376
  job_id?: string
6330
- /** 职级 ID,可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
6377
+ /** 职级 ID,可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
6331
6378
  job_level_id?: string
6332
- /** 序列 ID,可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
6379
+ /** 序列 ID,可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
6333
6380
  job_family_id?: string
6334
- /** 雇佣 ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6381
+ /** 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6335
6382
  employment_id: string
6336
6383
  /** 兼职开始日期 */
6337
6384
  start_date: string
6338
6385
  /** 兼职结束日期 */
6339
6386
  end_date?: string
6340
- /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6387
+ /** 直属上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6341
6388
  direct_manager_id?: string
6342
- /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6389
+ /** 虚线上级的雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息;类型与user_id_type一致 */
6343
6390
  dotted_line_manager_id?: string
6344
- /** 排班类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "work_shift" */
6391
+ /**
6392
+ * 排班类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6393
+ * - object_api_name = "job_data"
6394
+ * - custom_api_name = "work_shift"
6395
+ */
6345
6396
  work_shift?: Enum
6346
- /** 薪资类型,可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:- object_api_name = "job_data"- custom_api_name = "compensation_type" */
6397
+ /**
6398
+ * 薪资类型,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6399
+ * - object_api_name = "job_data"
6400
+ * - custom_api_name = "compensation_type"
6401
+ */
6347
6402
  compensation_type?: Enum
6348
- /** 任职公司,可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
6403
+ /** 任职公司,可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
6349
6404
  service_company?: string
6350
6405
  /** 周工作时长【0~168】 */
6351
6406
  weekly_working_hours?: string
6352
- /** 工作日历ID,可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6407
+ /** 工作日历ID,可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6353
6408
  work_calendar_id?: string
6354
6409
  /** 岗位 ID */
6355
6410
  position_id?: string
@@ -6358,110 +6413,268 @@ export interface EmployeesAdditionalJobWriteResp {
6358
6413
  }
6359
6414
 
6360
6415
  export interface EmployeesInternationalAssignment {
6361
- /** 外派工作地点 ID - 可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
6416
+ /**
6417
+ * 外派工作地点 ID
6418
+ * - 可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息
6419
+ */
6362
6420
  work_location_id?: string
6363
- /** 外派任职公司 ID- 可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
6421
+ /**
6422
+ * 外派任职公司 ID
6423
+ * - 可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息
6424
+ */
6364
6425
  service_company?: string
6365
- /** 排班类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:work_shift */
6426
+ /**
6427
+ * 排班类型
6428
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6429
+ * - object_api_name:job_data
6430
+ * - custom_api_name:work_shift
6431
+ */
6366
6432
  work_shift?: Enum
6367
- /** 工时制度ID- 可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
6433
+ /**
6434
+ * 工时制度ID
6435
+ * - 可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息
6436
+ */
6368
6437
  working_hours_type_id?: string
6369
- /** 人员类型ID- 可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
6438
+ /**
6439
+ * 人员类型ID
6440
+ * - 可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息
6441
+ */
6370
6442
  employee_type_id?: string
6371
6443
  /** 周工作时长 */
6372
6444
  weekly_working_hours_v2?: number
6373
- /** 部门 ID- 可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息- 类型与 department_id_type 一致 */
6445
+ /**
6446
+ * 部门 ID
6447
+ * - 可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息
6448
+ * - 类型与 department_id_type 一致
6449
+ */
6374
6450
  department_id?: string
6375
- /** 职务 ID- 可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
6451
+ /**
6452
+ * 职务 ID
6453
+ * - 可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息
6454
+ */
6376
6455
  job_id?: string
6377
- /** 序列 ID- 可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
6456
+ /**
6457
+ * 序列 ID
6458
+ * - 可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息
6459
+ */
6378
6460
  job_family_id?: string
6379
- /** 职级 ID- 可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
6461
+ /**
6462
+ * 职级 ID
6463
+ * - 可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息
6464
+ */
6380
6465
  job_level_id?: string
6381
- /** 职等 ID- 可通过[【查询职等】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息 */
6466
+ /**
6467
+ * 职等 ID
6468
+ * - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息
6469
+ */
6382
6470
  job_grade_id?: string
6383
- /** 薪资类型 - 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:compensation_type */
6471
+ /**
6472
+ * 薪资类型
6473
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6474
+ * - object_api_name:job_data
6475
+ * - custom_api_name:compensation_type
6476
+ */
6384
6477
  compensation_type?: Enum
6385
- /** 直属上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6478
+ /**
6479
+ * 直属上级雇佣 ID
6480
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6481
+ * - 类型与 user_id_type 一致
6482
+ */
6386
6483
  direct_manager_id?: string
6387
- /** 虚线上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6484
+ /**
6485
+ * 虚线上级雇佣 ID
6486
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6487
+ * - 类型与 user_id_type 一致
6488
+ */
6388
6489
  dotted_line_manager_id?: string
6389
- /** 工作日历 ID- 可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6490
+ /**
6491
+ * 工作日历 ID
6492
+ * - 可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息
6493
+ */
6390
6494
  work_calendar_id?: string
6391
- /** 岗位 ID- 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) */
6495
+ /**
6496
+ * 岗位 ID
6497
+ * - 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
6498
+ */
6392
6499
  position_id?: string
6393
- /** 雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6500
+ /**
6501
+ * 雇佣 ID
6502
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6503
+ * - 类型与 user_id_type 一致
6504
+ */
6394
6505
  employment_id?: string
6395
- /** 自定义字段- 请参考[【自定义字段说明】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) */
6506
+ /**
6507
+ * 自定义字段
6508
+ * - 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
6509
+ */
6396
6510
  custom_fields?: ObjectFieldData[]
6397
6511
  /** 外派原因说明 */
6398
6512
  international_assignment_reason?: string
6399
6513
  /** 备注 */
6400
6514
  description?: string
6401
- /** 预计结束日期- 格式:yyyy-mm-dd */
6515
+ /**
6516
+ * 预计结束日期
6517
+ * - 格式:yyyy-mm-dd
6518
+ */
6402
6519
  international_assignment_expected_end_date?: string
6403
- /** 外派状态- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_status */
6520
+ /**
6521
+ * 外派状态
6522
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6523
+ * - object_api_name:international_assignment
6524
+ * - custom_api_name:international_assignment_status
6525
+ */
6404
6526
  international_assignment_status?: Enum
6405
- /** 外派类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_type */
6527
+ /**
6528
+ * 外派类型
6529
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6530
+ * - object_api_name:international_assignment
6531
+ * - custom_api_name:international_assignment_type
6532
+ */
6406
6533
  international_assignment_type?: Enum
6407
- /** 开始日期- 格式:yyyy-mm-dd */
6534
+ /**
6535
+ * 开始日期
6536
+ * - 格式:yyyy-mm-dd
6537
+ */
6408
6538
  effective_time?: string
6409
- /** 结束日期- 格式:yyyy-mm-dd- 在外派未结束时,该值默认为 9999-12-31 */
6539
+ /**
6540
+ * 结束日期
6541
+ * - 格式:yyyy-mm-dd
6542
+ * - 在外派未结束时,该值默认为 9999-12-31
6543
+ */
6410
6544
  expiration_time?: string
6411
6545
  /** 外派ID */
6412
6546
  id?: string
6413
6547
  }
6414
6548
 
6415
6549
  export interface EmployeesInternationalAssignmentResp {
6416
- /** 外派工作地点 ID - 可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */
6550
+ /**
6551
+ * 外派工作地点 ID
6552
+ * - 可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息
6553
+ */
6417
6554
  work_location_id?: string
6418
- /** 外派任职公司 ID- 可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */
6555
+ /**
6556
+ * 外派任职公司 ID
6557
+ * - 可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息
6558
+ */
6419
6559
  service_company?: string
6420
- /** 排班类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:work_shift */
6560
+ /**
6561
+ * 排班类型
6562
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6563
+ * - object_api_name:job_data
6564
+ * - custom_api_name:work_shift
6565
+ */
6421
6566
  work_shift?: Enum
6422
- /** 工时制度ID- 可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */
6567
+ /**
6568
+ * 工时制度ID
6569
+ * - 可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息
6570
+ */
6423
6571
  working_hours_type_id?: string
6424
- /** 人员类型ID- 可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */
6572
+ /**
6573
+ * 人员类型ID
6574
+ * - 可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息
6575
+ */
6425
6576
  employee_type_id?: string
6426
6577
  /** 周工作时长 */
6427
6578
  weekly_working_hours_v2?: number
6428
- /** 部门 ID- 可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息- 类型与 department_id_type 一致 */
6579
+ /**
6580
+ * 部门 ID
6581
+ * - 可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息
6582
+ * - 类型与 department_id_type 一致
6583
+ */
6429
6584
  department_id?: string
6430
- /** 职务 ID- 可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */
6585
+ /**
6586
+ * 职务 ID
6587
+ * - 可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息
6588
+ */
6431
6589
  job_id?: string
6432
- /** 序列 ID- 可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */
6590
+ /**
6591
+ * 序列 ID
6592
+ * - 可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息
6593
+ */
6433
6594
  job_family_id?: string
6434
- /** 职级 ID- 可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */
6595
+ /**
6596
+ * 职级 ID
6597
+ * - 可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息
6598
+ */
6435
6599
  job_level_id?: string
6436
- /** 职等 ID- 可通过[【查询职等】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息 */
6600
+ /**
6601
+ * 职等 ID
6602
+ * - 可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息
6603
+ */
6437
6604
  job_grade_id?: string
6438
- /** 薪资类型 - 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:job_data - custom_api_name:compensation_type */
6605
+ /**
6606
+ * 薪资类型
6607
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6608
+ * - object_api_name:job_data
6609
+ * - custom_api_name:compensation_type
6610
+ */
6439
6611
  compensation_type?: Enum
6440
- /** 直属上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6612
+ /**
6613
+ * 直属上级雇佣 ID
6614
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6615
+ * - 类型与 user_id_type 一致
6616
+ */
6441
6617
  direct_manager_id?: string
6442
- /** 虚线上级雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6618
+ /**
6619
+ * 虚线上级雇佣 ID
6620
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6621
+ * - 类型与 user_id_type 一致
6622
+ */
6443
6623
  dotted_line_manager_id?: string
6444
- /** 工作日历 ID- 可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */
6624
+ /**
6625
+ * 工作日历 ID
6626
+ * - 可通过[【查询工作日历】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息
6627
+ */
6445
6628
  work_calendar_id?: string
6446
- /** 岗位 ID- 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) */
6629
+ /**
6630
+ * 岗位 ID
6631
+ * - 功能灰度中,请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
6632
+ */
6447
6633
  position_id?: string
6448
- /** 雇佣 ID- 可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息- 类型与 user_id_type 一致 */
6634
+ /**
6635
+ * 雇佣 ID
6636
+ * - 可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息
6637
+ * - 类型与 user_id_type 一致
6638
+ */
6449
6639
  employment_id?: string
6450
- /** 自定义字段- 请参考[【自定义字段说明】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) */
6640
+ /**
6641
+ * 自定义字段
6642
+ * - 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
6643
+ */
6451
6644
  custom_fields?: ObjectFieldData[]
6452
6645
  /** 外派原因说明 */
6453
6646
  international_assignment_reason?: string
6454
6647
  /** 备注 */
6455
6648
  description?: string
6456
- /** 预计结束日期- 格式:yyyy-mm-dd */
6649
+ /**
6650
+ * 预计结束日期
6651
+ * - 格式:yyyy-mm-dd
6652
+ */
6457
6653
  international_assignment_expected_end_date?: string
6458
- /** 外派状态- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_status */
6654
+ /**
6655
+ * 外派状态
6656
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6657
+ * - object_api_name:international_assignment
6658
+ * - custom_api_name:international_assignment_status
6659
+ */
6459
6660
  international_assignment_status?: Enum
6460
- /** 外派类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:international_assignment - custom_api_name:international_assignment_type */
6661
+ /**
6662
+ * 外派类型
6663
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
6664
+ * - object_api_name:international_assignment
6665
+ * - custom_api_name:international_assignment_type
6666
+ */
6461
6667
  international_assignment_type?: Enum
6462
- /** 开始日期- 格式:yyyy-mm-dd */
6668
+ /**
6669
+ * 开始日期
6670
+ * - 格式:yyyy-mm-dd
6671
+ */
6463
6672
  effective_time?: string
6464
- /** 结束日期- 格式:yyyy-mm-dd- 在外派未结束时,该值默认为 9999-12-31 */
6673
+ /**
6674
+ * 结束日期
6675
+ * - 格式:yyyy-mm-dd
6676
+ * - 在外派未结束时,该值默认为 9999-12-31
6677
+ */
6465
6678
  expiration_time?: string
6466
6679
  /** 外派ID */
6467
6680
  id?: string
@@ -10366,7 +10579,13 @@ export interface Mailgroup {
10366
10579
  include_external_member?: boolean
10367
10580
  /** Value is true if all company members are in this mail group */
10368
10581
  include_all_company_member?: boolean
10369
- /** 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 */
10582
+ /**
10583
+ * Who can send mail to this mail group. Possible values are:
10584
+ * - ANYONE: Any Internet user can send mail to this mail group
10585
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
10586
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
10587
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
10588
+ */
10370
10589
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
10371
10590
  }
10372
10591
 
@@ -10384,7 +10603,16 @@ export interface MailgroupMember {
10384
10603
  user_id?: string
10385
10604
  /** The member's department id. Value is valid when type is DEPARTMENT */
10386
10605
  department_id?: string
10387
- /** 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 */
10606
+ /**
10607
+ * The type of member. Possible values are:
10608
+ * - USER: internal user in the team
10609
+ * - DEPARTMENT: member is a department
10610
+ * - COMPANY: member is the company
10611
+ * - EXTERNAL_USER: internet user outside the organization
10612
+ * - MAIL_GROUP: member is another mail group
10613
+ * - PUBLIC_MAILBOX: member is a public mailbox
10614
+ * - OTHER_MEMBER: other internal member
10615
+ */
10388
10616
  type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
10389
10617
  }
10390
10618
 
@@ -10397,7 +10625,11 @@ export interface MailgroupPermissionMember {
10397
10625
  department_id?: string
10398
10626
  /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
10399
10627
  email?: string
10400
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
10628
+ /**
10629
+ * The type of member. Possible values are:
10630
+ * - USER: internal user in the team
10631
+ * - DEPARTMENT: member is a department
10632
+ */
10401
10633
  type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
10402
10634
  }
10403
10635
 
@@ -11164,7 +11396,7 @@ export interface NationalIdType {
11164
11396
  }
11165
11397
 
11166
11398
  export interface Nationality {
11167
- /** 国籍 ID,对应[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)等接口返回的 `nationality_id_v2` 字段 */
11399
+ /** 国籍 ID,对应[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)等接口返回的 `nationality_id_v2` 字段 */
11168
11400
  nationality_id?: string
11169
11401
  /** 名称 */
11170
11402
  name?: I18n[]
@@ -11174,7 +11406,7 @@ export interface Nationality {
11174
11406
  alpha_3_code?: string
11175
11407
  /** 数字代码 */
11176
11408
  numeric_code?: number
11177
- /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
11409
+ /** 所属国家/地区 ID,详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
11178
11410
  country_region_id?: string
11179
11411
  /** 状态 */
11180
11412
  status?: 1 | 0
@@ -11202,9 +11434,9 @@ export interface NavigateMeta {
11202
11434
  }
11203
11435
 
11204
11436
  export interface Node {
11205
- /** 知识空间id,[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
11437
+ /** 知识空间id,[获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
11206
11438
  space_id?: string
11207
- /** 节点token,[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
11439
+ /** 节点token,[获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */
11208
11440
  node_token?: string
11209
11441
  /** 对应文档类型的token,可根据 obj_type 判断属于哪种文档类型。 */
11210
11442
  obj_token?: string
@@ -12931,15 +13163,28 @@ export interface PersonName {
12931
13163
  local_primary?: string
12932
13164
  /** 名 - 本地文字 */
12933
13165
  local_first_name?: string
12934
- /** 国家 / 地区- 详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */
13166
+ /**
13167
+ * 国家 / 地区
13168
+ * - 详细信息可通过[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得
13169
+ */
12935
13170
  country_region_id: string
12936
- /** 姓名类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:name_type */
13171
+ /**
13172
+ * 姓名类型
13173
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
13174
+ * - object_api_name:person_name
13175
+ * - custom_api_name:name_type
13176
+ */
12937
13177
  name_type: Enum
12938
13178
  /** 名 - 第二本地文字 */
12939
13179
  local_first_name_2?: string
12940
13180
  /** 姓 - 第二本地文字 */
12941
13181
  local_primary_2?: string
12942
- /** 补充姓名类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:additional_name_type */
13182
+ /**
13183
+ * 补充姓名类型
13184
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
13185
+ * - object_api_name:person_name
13186
+ * - custom_api_name:additional_name_type
13187
+ */
12943
13188
  additional_name_type?: Enum
12944
13189
  /** 名 */
12945
13190
  first_name?: string
@@ -12959,9 +13204,19 @@ export interface PersonName {
12959
13204
  secondary?: string
12960
13205
  /** 婚后姓氏 */
12961
13206
  tertiary?: string
12962
- /** 尊称- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:social */
13207
+ /**
13208
+ * 尊称
13209
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
13210
+ * - object_api_name:person_name
13211
+ * - custom_api_name:social
13212
+ */
12963
13213
  social?: Enum
12964
- /** 头衔- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:title */
13214
+ /**
13215
+ * 头衔
13216
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
13217
+ * - object_api_name:person_name
13218
+ * - custom_api_name:title
13219
+ */
12965
13220
  title?: Enum
12966
13221
  /** 本地中间名 */
12967
13222
  local_middle_name?: string
@@ -13555,22 +13810,47 @@ export interface PreHireQuery {
13555
13810
  }
13556
13811
 
13557
13812
  export interface PrehireSeniorityAdjustInformation {
13558
- /** 调整值- 精确度:两位小数- 单位:年- 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值 */
13813
+ /**
13814
+ * 调整值
13815
+ * - 精确度:两位小数
13816
+ * - 单位:年
13817
+ * - 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值
13818
+ */
13559
13819
  seniority_adjustment?: number
13560
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
13820
+ /**
13821
+ * 调整类型
13822
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
13823
+ * - object_api_name:seniority_adjust_information
13824
+ * - custom_api_name:seniority_adjustment_type
13825
+ */
13561
13826
  seniority_adjustment_type: 'decrease' | 'increase'
13562
13827
  /** 司龄调整原因 */
13563
13828
  reasons_for_seniority_adjustment?: string
13564
- /** 开始日期- 格式: yyyy-mm-dd */
13829
+ /**
13830
+ * 开始日期
13831
+ * - 格式: yyyy-mm-dd
13832
+ */
13565
13833
  start_date?: string
13566
- /** 结束日期- 格式: yyyy-mm-dd */
13834
+ /**
13835
+ * 结束日期
13836
+ * - 格式: yyyy-mm-dd
13837
+ */
13567
13838
  end_date?: string
13568
13839
  }
13569
13840
 
13570
13841
  export interface PrehireSeniorityAdjustInformationQuery {
13571
- /** 调整值- 精确度:两位小数- 单位:年 */
13842
+ /**
13843
+ * 调整值
13844
+ * - 精确度:两位小数
13845
+ * - 单位:年
13846
+ */
13572
13847
  seniority_adjustment?: number
13573
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
13848
+ /**
13849
+ * 调整类型
13850
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
13851
+ * - object_api_name:seniority_adjust_information
13852
+ * - custom_api_name:seniority_adjustment_type
13853
+ */
13574
13854
  seniority_adjustment_type?: Enum
13575
13855
  /** 司龄调整原因 */
13576
13856
  reasons_for_seniority_adjustment?: string
@@ -13583,15 +13863,31 @@ export interface PrehireSeniorityAdjustInformationQuery {
13583
13863
  }
13584
13864
 
13585
13865
  export interface PrehireSeniorityAdjustInformationUpdate {
13586
- /** 调整值- 精确度:两位小数- 单位:年- 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值 */
13866
+ /**
13867
+ * 调整值
13868
+ * - 精确度:两位小数
13869
+ * - 单位:年
13870
+ * - 自动计算逻辑:如果这个值为空,司龄调整的开始日期和结束日期均不为空,会自动计算出调整值
13871
+ */
13587
13872
  seniority_adjustment?: number
13588
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
13873
+ /**
13874
+ * 调整类型
13875
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
13876
+ * - object_api_name:seniority_adjust_information
13877
+ * - custom_api_name:seniority_adjustment_type
13878
+ */
13589
13879
  seniority_adjustment_type: 'decrease' | 'increase'
13590
13880
  /** 司龄调整原因 */
13591
13881
  reasons_for_seniority_adjustment?: string
13592
- /** 开始日期- 格式: yyyy-mm-dd */
13882
+ /**
13883
+ * 开始日期
13884
+ * - 格式: yyyy-mm-dd
13885
+ */
13593
13886
  start_date?: string
13594
- /** 结束日期- 格式: yyyy-mm-dd */
13887
+ /**
13888
+ * 结束日期
13889
+ * - 格式: yyyy-mm-dd
13890
+ */
13595
13891
  end_date?: string
13596
13892
  }
13597
13893
 
@@ -14398,7 +14694,10 @@ export interface PublicMailboxMember {
14398
14694
  member_id?: string
14399
14695
  /** The member's user id. Value is valid when type is USER */
14400
14696
  user_id?: string
14401
- /** The type of member. Possible values are:- USER: internal user in the team */
14697
+ /**
14698
+ * The type of member. Possible values are:
14699
+ * - USER: internal user in the team
14700
+ */
14402
14701
  type?: 'USER'
14403
14702
  }
14404
14703
 
@@ -16277,17 +16576,35 @@ export interface Sender {
16277
16576
  }
16278
16577
 
16279
16578
  export interface SeniorityAdjustInformationEdit {
16280
- /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下: - object_api_name:seniority_adjust_information - custom_api_name:seniority_adjustment_type */
16579
+ /**
16580
+ * 调整类型
16581
+ * - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询,查询参数如下:
16582
+ * - object_api_name:seniority_adjust_information
16583
+ * - custom_api_name:seniority_adjustment_type
16584
+ */
16281
16585
  seniority_adjustment_type: 'increase' | 'decrease'
16282
- /** 开始日期- 格式: yyyy-mm-dd */
16586
+ /**
16587
+ * 开始日期
16588
+ * - 格式: yyyy-mm-dd
16589
+ */
16283
16590
  start_date?: string
16284
- /** 结束日期- 格式: yyyy-mm-dd */
16591
+ /**
16592
+ * 结束日期
16593
+ * - 格式: yyyy-mm-dd
16594
+ */
16285
16595
  end_date?: string
16286
16596
  /** 调整原因 */
16287
16597
  reasons_for_seniority_adjustment?: string
16288
- /** 调整值- 精确度:两位小数- 单位:年 */
16598
+ /**
16599
+ * 调整值
16600
+ * - 精确度:两位小数
16601
+ * - 单位:年
16602
+ */
16289
16603
  seniority_adjustment: number
16290
- /** 自定义字段- 具体支持的对象请参考[【自定义字段说明】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) */
16604
+ /**
16605
+ * 自定义字段
16606
+ * - 具体支持的对象请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide)
16607
+ */
16291
16608
  custom_fields?: ProfileSettingCustomField[]
16292
16609
  }
16293
16610
 
@@ -16433,6 +16750,287 @@ export interface SignatureAttachment {
16433
16750
  file_template_type_name?: string
16434
16751
  }
16435
16752
 
16753
+ export interface SignatureEnumInfoLabel {
16754
+ /** zh-CN */
16755
+ zh?: string
16756
+ /** en-US */
16757
+ en?: string
16758
+ }
16759
+
16760
+ export interface SignatureFile {
16761
+ /** 电子签文件ID */
16762
+ signature_file_id: string
16763
+ /** 名称 */
16764
+ names?: I18n[]
16765
+ /** 创建时间 */
16766
+ create_time?: string
16767
+ /** 更新时间 */
16768
+ update_time?: string
16769
+ /** 雇员 id */
16770
+ employment_id?: string
16771
+ /** 待入职 id */
16772
+ pre_hire_id?: string
16773
+ /** 电子签文件状态,枚举值可通过文档【飞书人事枚举常量】电子签文件状态(signature_file_state)枚举定义部分获得 */
16774
+ signature_file_state?: Enum
16775
+ /** 供应商侧的合同编号,作为幂等key */
16776
+ contract_code?: string
16777
+ /** 电子签文件生效日期 */
16778
+ effective_date?: string
16779
+ /** 电子签模板ID */
16780
+ template_id?: string
16781
+ /** 签署链接 */
16782
+ sign_url?: string
16783
+ }
16784
+
16785
+ export interface SignatureMetaInfo {
16786
+ /** 元数据api_name */
16787
+ api_name?: string
16788
+ /** wukong id */
16789
+ wk_id?: string
16790
+ /** 多语描述 */
16791
+ label?: I18n[]
16792
+ }
16793
+
16794
+ export interface SignatureNode {
16795
+ /** 电子签节点列表 */
16796
+ user_infos?: SignatureUserInfo[]
16797
+ /** 电子签文件节点状态 */
16798
+ state: string
16799
+ /** 节点完成时间 */
16800
+ finish_time?: string
16801
+ /** 节点最近更新时间 */
16802
+ updated_time?: string
16803
+ /** 当前节点是否为正在处理的节点 */
16804
+ is_ongoing: boolean
16805
+ /** 当前操作节点的角色名称 */
16806
+ role_label: SignatureEnumInfoLabel
16807
+ /** 签署角色 */
16808
+ sign_role?: string
16809
+ }
16810
+
16811
+ export interface SignatureSignatoryLabel {
16812
+ /** 电子签模板签订人类型 */
16813
+ template_signatory_type: Enum
16814
+ /** 中英文描述 */
16815
+ label: I18n[]
16816
+ /** 主数据apiname */
16817
+ apiname?: string
16818
+ }
16819
+
16820
+ export interface SignatureTemplate {
16821
+ /** 电子签模板id */
16822
+ id?: string
16823
+ /** 简略信息 */
16824
+ brief_info?: SignatureTemplateBriefInfo
16825
+ /** 模板内容信息 */
16826
+ content_info?: SignatureTemplateContentInfo
16827
+ }
16828
+
16829
+ export interface SignatureTemplateBriefInfo {
16830
+ /** id */
16831
+ id?: string
16832
+ /** 名称 支持多语 */
16833
+ label?: I18n[]
16834
+ /** 模版类别 */
16835
+ category?: Enum
16836
+ /** 模版用法 */
16837
+ usage?: Enum
16838
+ /** 模版签署人标签 */
16839
+ signatory_labels?: SignatureSignatoryLabel[]
16840
+ /** 是否激活 */
16841
+ active?: boolean
16842
+ /** 创建人 */
16843
+ create_by?: string
16844
+ /** 修改人 */
16845
+ modify_by?: string
16846
+ /** 适用范围 */
16847
+ applicability?: Enum
16848
+ /** 创建方法 */
16849
+ creation_method?: string
16850
+ /** 版本 */
16851
+ version?: string
16852
+ /** 更新时间 */
16853
+ update_time?: string
16854
+ /** 创建时间 */
16855
+ create_time?: string
16856
+ /** 模板设置,包含开启骑缝章的类型等 */
16857
+ template_setting?: SignatureTemplateSetting
16858
+ /** 模板适用区域 */
16859
+ template_region_info?: SignatureTemplateRegionInfo
16860
+ /** 模板编码 */
16861
+ template_code?: string
16862
+ /** 模板描述 支持多语 */
16863
+ template_desc?: I18n[]
16864
+ }
16865
+
16866
+ export interface SignatureTemplateCombinationFieldInfo {
16867
+ /** total_apiname */
16868
+ total_apiname: string
16869
+ /** apiname */
16870
+ apiname: string
16871
+ /** 中英文描述 */
16872
+ title: I18n[]
16873
+ /** 适用区域名称 */
16874
+ contents?: SignatureTemplateCombinationSubFieldInfo[][]
16875
+ /** 电子签模板字段源类型 */
16876
+ source: Enum
16877
+ }
16878
+
16879
+ export interface SignatureTemplateCombinationFieldInfoV2 {
16880
+ /** total_apiname */
16881
+ total_apiname: string
16882
+ /** apiname */
16883
+ apiname: string
16884
+ /** 电子签模板字段源类型 */
16885
+ source?: Enum
16886
+ }
16887
+
16888
+ export interface SignatureTemplateCombinationSubFieldInfo {
16889
+ /** 字段类型枚举 */
16890
+ field_type: Enum
16891
+ /** 公共字段信息 */
16892
+ info?: SignatureTemplateCommonFieldInfo
16893
+ /** 双语描述 */
16894
+ label?: I18n[]
16895
+ }
16896
+
16897
+ export interface SignatureTemplateCommonFieldInfo {
16898
+ /** 模板字段源类型;枚举值填到enum_name中,如:"System" "MainData" */
16899
+ source: Enum
16900
+ /** 主数据apiname */
16901
+ apiname: string
16902
+ }
16903
+
16904
+ export interface SignatureTemplateContentInfo {
16905
+ /** 模版内容list */
16906
+ contents?: SignatureTemplateContentItem[]
16907
+ /** 自定义字段列表 */
16908
+ custom_fields?: SignatureTemplateCustomField[]
16909
+ /** 筛选条件列表 */
16910
+ filter_fields?: SignatureTemplateFilter[]
16911
+ /** 模板公共字段信息列表 */
16912
+ using_fields?: SignatureTemplateCommonFieldInfo[]
16913
+ /** 系统设置字段列表 */
16914
+ system_setting_fields?: SignatureTemplateField[]
16915
+ }
16916
+
16917
+ export interface SignatureTemplateContentItem {
16918
+ /** 电子签模版内容的类型 */
16919
+ content_type: Enum
16920
+ /** 显示规则左值 */
16921
+ filter_apiname?: string
16922
+ /** 模版内容 */
16923
+ content?: string
16924
+ /** 中英文描述 */
16925
+ label?: I18n[]
16926
+ /** 内容描述 */
16927
+ content_desc?: string
16928
+ }
16929
+
16930
+ export interface SignatureTemplateCustomField {
16931
+ /** 中英文描述 */
16932
+ label?: I18n[]
16933
+ /** 主数据apiname */
16934
+ apiname: string
16935
+ /** 用户自定义字段类型 */
16936
+ custom_field_type: Enum
16937
+ /** 是否使用到 */
16938
+ used: boolean
16939
+ /** 是否需要 */
16940
+ is_required?: boolean
16941
+ /** 自定义描述 */
16942
+ custom_desc?: string
16943
+ /** 电子签模版公共字段信息 */
16944
+ common_info?: SignatureTemplateCommonFieldInfo
16945
+ }
16946
+
16947
+ export interface SignatureTemplateField {
16948
+ /** 模板字段值类型枚举 */
16949
+ field_type: Enum
16950
+ /** 双语描述 */
16951
+ label?: I18n[]
16952
+ /** 通用字段信息 */
16953
+ common_info?: SignatureTemplateCommonFieldInfo
16954
+ /** 组合字段信息 */
16955
+ combination_info?: SignatureTemplateCombinationFieldInfo
16956
+ /** 子模板配置信息列表对应的string,避免循环引用问题 */
16957
+ children?: string
16958
+ /** 组合字段信息v2 */
16959
+ combination_info_v2?: SignatureTemplateCombinationFieldInfoV2
16960
+ }
16961
+
16962
+ export interface SignatureTemplateFilter {
16963
+ /** 双语描述 */
16964
+ label: I18n[]
16965
+ /** 主数据apiname */
16966
+ apiname: string
16967
+ /** 过滤条件列表 */
16968
+ filters?: SignatureTemplateFilterItem[]
16969
+ /** 多个生效条件的logic */
16970
+ logic?: Enum
16971
+ /** 是否被校验 */
16972
+ is_checked?: boolean
16973
+ /** 过滤条件描述 */
16974
+ filter_desc?: string
16975
+ /** 过滤条件列表,使用string类型描述list的原因是为了避免循环引用问题,因为该list的item类型就是这个数据类型 */
16976
+ criterion_list?: string
16977
+ }
16978
+
16979
+ export interface SignatureTemplateFilterItem {
16980
+ /** 左值 */
16981
+ left: string
16982
+ /** 右值列表 */
16983
+ rights?: string[]
16984
+ /** 操作符 */
16985
+ op: Enum
16986
+ }
16987
+
16988
+ export interface SignatureTemplateInfoWithThumbnail {
16989
+ /** id */
16990
+ id?: string
16991
+ /** 名称 支持多语 */
16992
+ label?: I18n[]
16993
+ /** 模版类别 */
16994
+ category?: Enum
16995
+ /** 模版用法 */
16996
+ usage?: Enum
16997
+ /** 创建日期 */
16998
+ create_time?: string
16999
+ /** 修改日期 */
17000
+ modify_time?: string
17001
+ /** 创建人 */
17002
+ created_by?: SignatureUserInfo
17003
+ /** 修改人 */
17004
+ updated_by?: SignatureUserInfo
17005
+ /** 缩略图url */
17006
+ thumbnail_url?: string
17007
+ /** 模版签署人标签 */
17008
+ signatory_labels?: SignatureSignatoryLabel[]
17009
+ /** 模板编码 */
17010
+ template_code?: string
17011
+ /** 模板描述 */
17012
+ template_desc?: string
17013
+ /** 模板适用区域 */
17014
+ template_region_info?: SignatureTemplateRegionInfo
17015
+ }
17016
+
17017
+ export interface SignatureTemplateRegionInfo {
17018
+ /** 是否全球适用 */
17019
+ is_global_scope?: string
17020
+ /** 适用区域名称 */
17021
+ meta_infos?: SignatureMetaInfo[]
17022
+ }
17023
+
17024
+ export interface SignatureTemplateSetting {
17025
+ /** 骑缝章类型 */
17026
+ page_seal_types?: string[]
17027
+ }
17028
+
17029
+ export interface SignatureUserInfo {
17030
+ /** employmentID */
17031
+ id: string
17032
+ }
17033
+
16436
17034
  export interface Skill {
16437
17035
  /** 技能 ID */
16438
17036
  id?: string
@@ -16786,6 +17384,13 @@ export interface Style {
16786
17384
  border_color_type?: ColorType
16787
17385
  }
16788
17386
 
17387
+ export const enum StyleType {
17388
+ /** 画板样式 */
17389
+ Board = 1,
17390
+ /** 经典样式 */
17391
+ Classic = 2,
17392
+ }
17393
+
16789
17394
  export interface Subdivision {
16790
17395
  /** 省份/行政区id */
16791
17396
  id: string
@@ -16860,6 +17465,15 @@ export interface Svg {
16860
17465
  svg_code?: string
16861
17466
  }
16862
17467
 
17468
+ export const enum SyntaxType {
17469
+ /** 未知 */
17470
+ UNKOWN = 0,
17471
+ /** Plantuml解析 */
17472
+ PLANT_UML = 1,
17473
+ /** Mermaid解析 */
17474
+ MERMAID = 2,
17475
+ }
17476
+
16863
17477
  export interface SystemFields {
16864
17478
  /** 中文姓名 */
16865
17479
  name?: string
@@ -17924,6 +18538,13 @@ export interface Term {
17924
18538
  to: string
17925
18539
  }
17926
18540
 
18541
+ export interface TerminateSignatureFailIdAndReason {
18542
+ /** 终止操作失败的文件ID */
18543
+ signature_file_id: string
18544
+ /** 终止失败的原因 */
18545
+ fail_reason: string
18546
+ }
18547
+
17927
18548
  export interface TerminationReason {
17928
18549
  /** 终止原因 ID */
17929
18550
  id?: string
@@ -19255,6 +19876,8 @@ export interface UserViewDetail {
19255
19876
  view_time?: string
19256
19877
  }
19257
19878
 
19879
+ export type Uuid = string
19880
+
19258
19881
  export interface Value {
19259
19882
  /** 字符串值 */
19260
19883
  string_value?: string