@satorijs/adapter-lark 3.11.8 → 3.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/lib/bot.d.ts +5 -5
  2. package/lib/http.d.ts +6 -3
  3. package/lib/index.cjs +634 -261
  4. package/lib/types/acs.d.ts +4 -1
  5. package/lib/types/aily.d.ts +3 -3
  6. package/lib/types/apaas.d.ts +190 -28
  7. package/lib/types/application.d.ts +20 -4
  8. package/lib/types/approval.d.ts +0 -13
  9. package/lib/types/attendance.d.ts +11 -5
  10. package/lib/types/authen.d.ts +8 -2
  11. package/lib/types/bitable.d.ts +25 -4
  12. package/lib/types/board.d.ts +56 -0
  13. package/lib/types/calendar.d.ts +71 -5
  14. package/lib/types/cardkit.d.ts +2 -2
  15. package/lib/types/compensation.d.ts +400 -0
  16. package/lib/types/contact.d.ts +55 -12
  17. package/lib/types/corehr.d.ts +1287 -79
  18. package/lib/types/directory.d.ts +3 -41
  19. package/lib/types/docx.d.ts +23 -0
  20. package/lib/types/drive.d.ts +107 -90
  21. package/lib/types/ehr.d.ts +11 -2
  22. package/lib/types/helpdesk.d.ts +15 -6
  23. package/lib/types/hire.d.ts +52 -3
  24. package/lib/types/human_authentication.d.ts +1 -1
  25. package/lib/types/im.d.ts +77 -21
  26. package/lib/types/index.d.ts +1670 -105
  27. package/lib/types/mail.d.ts +106 -16
  28. package/lib/types/payroll.d.ts +117 -81
  29. package/lib/types/performance.d.ts +1 -1
  30. package/lib/types/search.d.ts +4 -1
  31. package/lib/types/security_and_compliance.d.ts +254 -1
  32. package/lib/ws.d.ts +30 -0
  33. package/package.json +6 -3
  34. package/src/bot.ts +28 -15
  35. package/src/http.ts +10 -4
  36. package/src/types/acs.ts +4 -1
  37. package/src/types/aily.ts +3 -3
  38. package/src/types/apaas.ts +237 -38
  39. package/src/types/application.ts +20 -4
  40. package/src/types/approval.ts +0 -15
  41. package/src/types/attendance.ts +11 -5
  42. package/src/types/authen.ts +8 -2
  43. package/src/types/bitable.ts +25 -4
  44. package/src/types/board.ts +75 -2
  45. package/src/types/calendar.ts +88 -5
  46. package/src/types/cardkit.ts +2 -2
  47. package/src/types/compensation.ts +485 -0
  48. package/src/types/contact.ts +55 -12
  49. package/src/types/corehr.ts +1480 -123
  50. package/src/types/directory.ts +3 -53
  51. package/src/types/docx.ts +29 -0
  52. package/src/types/drive.ts +129 -112
  53. package/src/types/ehr.ts +11 -2
  54. package/src/types/helpdesk.ts +15 -6
  55. package/src/types/hire.ts +66 -3
  56. package/src/types/human_authentication.ts +1 -1
  57. package/src/types/im.ts +77 -21
  58. package/src/types/index.ts +1751 -107
  59. package/src/types/mail.ts +106 -16
  60. package/src/types/payroll.ts +146 -103
  61. package/src/types/performance.ts +1 -1
  62. package/src/types/search.ts +4 -1
  63. package/src/types/security_and_compliance.ts +292 -1
  64. package/src/ws.ts +183 -0
  65. package/lib/types/api.d.ts +0 -28510
  66. package/lib/types/internal.d.ts +0 -21
  67. package/lib/types/message/content.d.ts +0 -433
  68. package/lib/types/message/index.d.ts +0 -95
@@ -28,11 +28,21 @@ export declare namespace Calendar {
28
28
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary
29
29
  */
30
30
  primary(query?: PrimaryQuery): Promise<PrimaryResponse>;
31
+ /**
32
+ * 批量获取主日历信息
33
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primarys
34
+ */
35
+ primarys(body: PrimarysRequest, query?: PrimarysQuery): Promise<PrimarysResponse>;
31
36
  /**
32
37
  * 查询日历信息
33
38
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get
34
39
  */
35
40
  get(calendar_id: string): Promise<GetResponse>;
41
+ /**
42
+ * 批量查询日历信息
43
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/mget
44
+ */
45
+ mget(body: MgetRequest): Promise<MgetResponse>;
36
46
  /**
37
47
  * 查询日历列表
38
48
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list
@@ -93,6 +103,18 @@ export declare namespace Calendar {
93
103
  /** 主日历列表 */
94
104
  calendars?: Lark.UserCalendar[];
95
105
  }
106
+ interface PrimarysRequest {
107
+ /** 用户ID列表 */
108
+ user_ids: string[];
109
+ }
110
+ interface PrimarysQuery {
111
+ /** 此次调用中使用的用户ID的类型 */
112
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
113
+ }
114
+ interface PrimarysResponse {
115
+ /** 主日历列表 */
116
+ calendars?: Lark.UserCalendar[];
117
+ }
96
118
  interface GetResponse {
97
119
  /** 日历OpenId */
98
120
  calendar_id: string;
@@ -115,6 +137,14 @@ export declare namespace Calendar {
115
137
  /** 当前身份对于该日历的访问权限 */
116
138
  role?: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner';
117
139
  }
140
+ interface MgetRequest {
141
+ /** 日历ID列表 */
142
+ calendar_ids: string[];
143
+ }
144
+ interface MgetResponse {
145
+ /** 日历列表 */
146
+ calendars?: Lark.Calendar[];
147
+ }
118
148
  interface ListQuery extends Pagination {
119
149
  /** 上次请求Response返回的增量同步标记,分页请求未结束时为空 */
120
150
  sync_token?: string;
@@ -166,13 +196,18 @@ export declare namespace Calendar {
166
196
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/list
167
197
  */
168
198
  list(body: ListRequest, query?: ListQuery): Promise<ListResponse>;
199
+ /**
200
+ * 批量查询主日历日程忙闲信息
201
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/batch
202
+ */
203
+ batch(body: BatchRequest, query?: BatchQuery): Promise<BatchResponse>;
169
204
  }
170
205
  interface ListRequest {
171
206
  /** 查询时段开始时间,需要url编码 */
172
207
  time_min: string;
173
208
  /** 查询时段结束时间,需要url编码 */
174
209
  time_max: string;
175
- /** 用户user_id,输入时与 room_id 二选一。参见[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
210
+ /** 用户user_id,输入时与 room_id 二选一。参见[用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) */
176
211
  user_id?: string;
177
212
  /** 会议室room_id,输入时与 user_id 二选一 */
178
213
  room_id?: string;
@@ -189,6 +224,26 @@ export declare namespace Calendar {
189
224
  /** 日历上请求时间区间内的忙闲信息 */
190
225
  freebusy_list?: Lark.Freebusy[];
191
226
  }
227
+ interface BatchRequest {
228
+ /** 获取忙闲信息的开始时间,RFC3339 date_time格式;time_min与time_max的时间区间不能超过3个月。 */
229
+ time_min: string;
230
+ /** 获取忙闲信息的开始时间,RFC3339 date_time格式;time_min与time_max的时间区间不能超过3个月。 */
231
+ time_max: string;
232
+ /** 用户ID列表 */
233
+ user_ids: string[];
234
+ /** 是否包含绑定的三方日历中的日程,不传默认为true,即包含。 */
235
+ include_external_calendar?: boolean;
236
+ /** 是否包含标记为空闲的日程,不传默认为true,即包含空闲日程。 */
237
+ only_busy?: boolean;
238
+ }
239
+ interface BatchQuery {
240
+ /** 此次调用中使用的用户ID的类型 */
241
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
242
+ }
243
+ interface BatchResponse {
244
+ /** 用户忙闲信息列表 */
245
+ freebusy_lists?: Lark.UserFreebusy[];
246
+ }
192
247
  }
193
248
  namespace Acl {
194
249
  interface Methods {
@@ -519,7 +574,10 @@ export declare namespace Calendar {
519
574
  list(calendar_id: string, event_id: string, query?: ListQuery): Paginated<Lark.CalendarEventAttendee>;
520
575
  }
521
576
  interface CreateRequest {
522
- /** 新增参与人列表;<br>- 单次请求会议室的数量限制为100。 */
577
+ /**
578
+ * 新增参与人列表;
579
+ * - 单次请求会议室的数量限制为100。
580
+ */
523
581
  attendees?: Lark.CalendarEventAttendee[];
524
582
  /** 是否给参与人发送bot通知 默认为true */
525
583
  need_notification?: boolean;
@@ -539,7 +597,7 @@ export declare namespace Calendar {
539
597
  attendees?: Lark.CalendarEventAttendee[];
540
598
  }
541
599
  interface BatchDeleteRequest {
542
- /** 要移除的参与人 ID 列表。参见[参与人ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/introduction#4998889c) */
600
+ /** 要移除的参与人 ID 列表。参见[参与人ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/introduction#4998889c) */
543
601
  attendee_ids?: string[];
544
602
  /** 需要删除的参与人类型实体ID,作为attendee_ids字段的补充。 */
545
603
  delete_ids?: Lark.CalendarEventAttendeeId[];
@@ -599,7 +657,11 @@ export declare namespace Calendar {
599
657
  end_time: string;
600
658
  /** 休假日程标题,可自定义例如:"请假中(全天) / 1-Day Time Off","请假中(半天) / 0.5-Day Time Off","长期休假中 / Leave of Absence","请假中" */
601
659
  title?: string;
602
- /** 休假日程描述,可自定义,例如:"若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked." */
660
+ /**
661
+ * 休假日程描述,可自定义,例如:
662
+ * "若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。
663
+ * If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked."
664
+ */
603
665
  description?: string;
604
666
  }
605
667
  interface CreateQuery {
@@ -619,7 +681,11 @@ export declare namespace Calendar {
619
681
  end_time: string;
620
682
  /** 休假日程标题,可自定义例如:"请假中(全天) / 1-Day Time Off","请假中(半天) / 0.5-Day Time Off","长期休假中 / Leave of Absence","请假中" */
621
683
  title?: string;
622
- /** 休假日程描述,可自定义,例如:"若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked." */
684
+ /**
685
+ * 休假日程描述,可自定义,例如:
686
+ * "若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。
687
+ * If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked."
688
+ */
623
689
  description?: string;
624
690
  }
625
691
  }
@@ -17,12 +17,12 @@ export declare namespace Cardkit {
17
17
  */
18
18
  create(body: CreateRequest): Promise<CreateResponse>;
19
19
  /**
20
- * 更新卡片配置
20
+ * 更新卡片实体配置
21
21
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings
22
22
  */
23
23
  settings(card_id: string, body: SettingsRequest): Promise<void>;
24
24
  /**
25
- * 批量更新卡片实体
25
+ * 局部更新卡片实体
26
26
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update
27
27
  */
28
28
  batchUpdate(card_id: string, body: BatchUpdateRequest): Promise<void>;
@@ -13,15 +13,59 @@ export declare namespace Compensation {
13
13
  itemCategory: ItemCategory.Methods;
14
14
  plan: Plan.Methods;
15
15
  changeReason: ChangeReason.Methods;
16
+ socialInsurance: SocialInsurance.Methods;
17
+ socialPlan: SocialPlan.Methods;
18
+ socialArchiveAdjustRecord: SocialArchiveAdjustRecord.Methods;
19
+ socialArchive: SocialArchive.Methods;
20
+ lumpSumPayment: LumpSumPayment.Methods;
21
+ recurringPayment: RecurringPayment.Methods;
16
22
  }
17
23
  namespace Archive {
18
24
  interface Methods {
25
+ /**
26
+ * 创建薪资档案
27
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/create
28
+ */
29
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
19
30
  /**
20
31
  * 批量查询员工薪资档案
21
32
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query
22
33
  */
23
34
  query(body: QueryRequest, query?: QueryQuery): Paginated<Lark.ArchiveDetail>;
24
35
  }
36
+ interface CreateRequest {
37
+ /** 外部幂等id,表示操作的唯一标识,避免重复发起,格式为标准的UUIDV4, */
38
+ unique_id: string;
39
+ /** 操作人ID,具体类型由入参中的 user_id_type 指定,选择应用身份鉴权时,该参数不能为空 */
40
+ operator_id?: string;
41
+ /** 员工id,具体类型由入参中的 user_id_type 指定 */
42
+ user_id: string;
43
+ /** 生效时间,日期格式 */
44
+ effective_time: string;
45
+ /** 币种ID,获取来源https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search?appId=cli_a63f5fc01866100c */
46
+ currency_id: string;
47
+ /** 薪资方案ID,获取来源:https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list */
48
+ plan_id: string;
49
+ /** 薪资方案TID,获取来源:https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list */
50
+ plan_tid: string;
51
+ /** 调薪原因ID,获取来源:https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list */
52
+ change_reason_id: string;
53
+ /** 薪资项值集合 */
54
+ item_value_lists: Lark.ArchiveItemValue[];
55
+ /** 调薪说明 */
56
+ description?: string;
57
+ /** 更正说明,当员工在当天存在调薪记录时,该字段即为更正调薪的说明 */
58
+ edit_remark?: string;
59
+ }
60
+ interface CreateQuery {
61
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
62
+ }
63
+ interface CreateResponse {
64
+ /** 定调薪任务创建的唯一ID */
65
+ unique_id?: string;
66
+ /** 薪档案的TID */
67
+ archive_tid?: string;
68
+ }
25
69
  interface QueryRequest {
26
70
  /** 用户ID列表 */
27
71
  user_id_list: string[];
@@ -86,4 +130,360 @@ export declare namespace Compensation {
86
130
  list(query?: Pagination): Paginated<Lark.ChangeReason>;
87
131
  }
88
132
  }
133
+ namespace SocialInsurance {
134
+ interface Methods {
135
+ /**
136
+ * 获取险种配置列表
137
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/social_insurance/list
138
+ */
139
+ list(): Promise<ListResponse>;
140
+ }
141
+ interface ListResponse {
142
+ /** 险种列表 */
143
+ items?: Lark.SocialInsurance[];
144
+ }
145
+ }
146
+ namespace SocialPlan {
147
+ interface Methods {
148
+ /**
149
+ * 根据方案ID和生效日期批量查询参保方案
150
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/social_plan/query
151
+ */
152
+ query(body: QueryRequest): Promise<QueryResponse>;
153
+ /**
154
+ * 根据生效日期分页查询参保方案
155
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/social_plan/list
156
+ */
157
+ list(query?: ListQuery): Paginated<Lark.SocialPlan, 'plans'>;
158
+ }
159
+ interface QueryRequest {
160
+ /** 参保方案ID列表,最大200 */
161
+ plan_ids: string[];
162
+ /** 生效日期,查询在该日期生效的参保方案数据 */
163
+ effective_date: string;
164
+ }
165
+ interface QueryResponse {
166
+ /** 方案列表 */
167
+ plans?: Lark.SocialPlan[];
168
+ }
169
+ interface ListQuery extends Pagination {
170
+ /** 生效日期,查询在该日期生效的参保方案数据 */
171
+ effective_date: string;
172
+ /** 社保方案/公积金方案 */
173
+ insurance_type?: 'social_insurance' | 'provident_fund';
174
+ }
175
+ }
176
+ namespace SocialArchiveAdjustRecord {
177
+ interface Methods {
178
+ /**
179
+ * 通过员工ID批量获取社保增减员记录
180
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/social_archive_adjust_record/query
181
+ */
182
+ query(body: QueryRequest, query?: QueryQuery): Promise<QueryResponse>;
183
+ }
184
+ interface QueryRequest {
185
+ /** lark_user_id列表,用户ID列表,获取方式可参考查询参数中的「user_id_type」字段。最大200个。 */
186
+ user_id_list: string[];
187
+ /** 增减员类型, increase: 增员; attrtion: 减员 */
188
+ record_type: 'increase' | 'attrition';
189
+ }
190
+ interface QueryQuery {
191
+ /** 用户ID类型 */
192
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
193
+ }
194
+ interface QueryResponse {
195
+ /** 待增/减员记录 */
196
+ records?: Lark.SocialArchiveAdjustRecord[];
197
+ }
198
+ }
199
+ namespace SocialArchive {
200
+ interface Methods {
201
+ /**
202
+ * 批量获取员工参保档案
203
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/social_archive/query
204
+ */
205
+ query(body: QueryRequest, query?: QueryQuery): Promise<QueryResponse>;
206
+ }
207
+ interface QueryRequest {
208
+ /** lark_user_id列表,用户ID列表,获取方式可参考查询参数中的「user_id_type」字段。最大200个。 */
209
+ user_id_list: string[];
210
+ /** 生效日志,查询在该日期生效的社保档案 */
211
+ effective_date: string;
212
+ }
213
+ interface QueryQuery {
214
+ /** 用户ID类型 */
215
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
216
+ }
217
+ interface QueryResponse {
218
+ /** 参保档案列表 */
219
+ archives: Lark.SocialArchive[];
220
+ }
221
+ }
222
+ namespace LumpSumPayment {
223
+ interface Methods {
224
+ /**
225
+ * 批量创建一次性支付记录
226
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/lump_sum_payment/batch_create
227
+ */
228
+ batchCreate(body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>;
229
+ /**
230
+ * 批量更正一次性支付记录
231
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/lump_sum_payment/batch_update
232
+ */
233
+ batchUpdate(body: BatchUpdateRequest): Promise<BatchUpdateResponse>;
234
+ /**
235
+ * 查询一次性支付授予记录
236
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/lump_sum_payment/query
237
+ */
238
+ query(body: QueryRequest, query?: QueryQuery): Paginated<Lark.LumpSumPayment, 'records'>;
239
+ /**
240
+ * 查询一次性支付授予明细
241
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/lump_sum_payment/query_detail
242
+ */
243
+ queryDetail(body: QueryDetailRequest, query?: QueryDetailQuery): Paginated<Lark.LumpSumPaymentDetail, 'records'>;
244
+ /**
245
+ * 批量删除一次性支付记录
246
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/lump_sum_payment/batch_remove
247
+ */
248
+ batchRemove(body: BatchRemoveRequest): Promise<BatchRemoveResponse>;
249
+ }
250
+ interface BatchCreateRequest {
251
+ /** 要创建的一次性支付信息 */
252
+ records?: Lark.LumpSumPaymentForCreate[];
253
+ }
254
+ interface BatchCreateQuery {
255
+ /** 用户ID类型 */
256
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
257
+ }
258
+ interface BatchCreateResponse {
259
+ /** 每条记录的操作结果。对于创建成功的记录,会返回创建后的一次性支付记录id */
260
+ operate_results?: Lark.LumpSumPaymentOperateResult[];
261
+ }
262
+ interface BatchUpdateRequest {
263
+ /** 要更正的一次性支付记录列表 */
264
+ records?: Lark.LumpSumPaymentForUpdate[];
265
+ }
266
+ interface BatchUpdateResponse {
267
+ /** 每条记录的操作结果 */
268
+ operate_results?: Lark.LumpSumPaymentOperateResult[];
269
+ }
270
+ interface QueryRequest {
271
+ /** id属于 */
272
+ ids?: string[];
273
+ /** unique_id属于 */
274
+ unique_ids?: string[];
275
+ /** 员工id属于 */
276
+ user_ids?: string[];
277
+ /** 薪酬项id属于 */
278
+ item_ids?: string[];
279
+ /** 创建时间大于等于(东八区) */
280
+ create_time_gte?: string;
281
+ /** 创建时间小于等于(东八区) */
282
+ create_time_lte?: string;
283
+ /** 更新时间大于等于(东八区) */
284
+ modify_time_gte?: string;
285
+ /** 更新时间小于等于(东八区) */
286
+ modify_time_lte?: string;
287
+ /** 合同主体id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/company/list 接口进行查询) */
288
+ company_ids?: string[];
289
+ /** 任职公司id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/company/list 接口进行查询) */
290
+ service_company_ids?: string[];
291
+ /** 部门id属于(可通过 https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get 接口进行查询) */
292
+ department_ids?: string[];
293
+ /** 序列id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/job-management/job_family/list 接口进行查询) */
294
+ job_family_ids?: string[];
295
+ /** 职级id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/job-management/job_level/list 接口进行查询) */
296
+ job_level_ids?: string[];
297
+ /** 工作地点id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/location/list 接口进行查询) */
298
+ work_location_ids?: string[];
299
+ /** 员工类型id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/basic-infomation/employee_type/list 接口进行查询) */
300
+ employee_type_ids?: string[];
301
+ /** 入职日期大于等于 */
302
+ onboard_date_gte?: string;
303
+ /** 入职日期小于等于 */
304
+ onboard_date_lte?: string;
305
+ /** 离职日期大于等于 */
306
+ offboard_date_gte?: string;
307
+ /** 离职日期小于等于 */
308
+ offboard_date_lte?: string;
309
+ }
310
+ interface QueryQuery extends Pagination {
311
+ /** 用户ID类型 */
312
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
313
+ }
314
+ interface QueryDetailRequest {
315
+ /** id属于 */
316
+ ids?: string[];
317
+ /** 一次性支付记录id */
318
+ record_ids?: string[];
319
+ /** 一次性支付记录unique id */
320
+ record_unique_ids?: string[];
321
+ /** 发放方式 */
322
+ issuance_ways?: ('with_salary' | 'with_cash' | 'with_physical_distribution' | 'with_year_end_bonus')[];
323
+ /** 发放状态 */
324
+ issuance_statuses?: ('to_be_issued' | 'not_issued')[];
325
+ /** 员工id属于 */
326
+ user_ids?: string[];
327
+ /** 薪酬项id属于 */
328
+ item_ids?: string[];
329
+ /** 发放时间大于等于 */
330
+ issuance_date_gte?: string;
331
+ /** 发放时间小于等于 */
332
+ issuance_date_lte?: string;
333
+ /** 创建时间大于等于(东八区) */
334
+ create_time_gte?: string;
335
+ /** 创建时间小于等于(东八区) */
336
+ create_time_lte?: string;
337
+ /** 更新时间大于等于(东八区) */
338
+ modify_time_gte?: string;
339
+ /** 更新时间小于等于(东八区) */
340
+ modify_time_lte?: string;
341
+ /** 合同主体id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/company/list 接口进行查询) */
342
+ company_ids?: string[];
343
+ /** 任职公司id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/company/list 接口进行查询) */
344
+ service_company_ids?: string[];
345
+ /** 部门id属于(可通过 https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get 接口进行查询) */
346
+ department_ids?: string[];
347
+ /** 序列id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/job-management/job_family/list 接口进行查询) */
348
+ job_family_ids?: string[];
349
+ /** 职级id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/job-management/job_level/list 接口进行查询) */
350
+ job_level_ids?: string[];
351
+ /** 工作地点id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/location/list 接口进行查询) */
352
+ work_location_ids?: string[];
353
+ /** 员工类型id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/basic-infomation/employee_type/list 接口进行查询) */
354
+ employee_type_ids?: string[];
355
+ /** 入职日期大于等于 */
356
+ onboard_date_gte?: string;
357
+ /** 入职日期小于等于 */
358
+ onboard_date_lte?: string;
359
+ /** 离职日期大于等于 */
360
+ offboard_date_gte?: string;
361
+ /** 离职日期小于等于 */
362
+ offboard_date_lte?: string;
363
+ }
364
+ interface QueryDetailQuery extends Pagination {
365
+ /** 用户ID类型 */
366
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
367
+ }
368
+ interface BatchRemoveRequest {
369
+ /** 要删除的一次性支付记录id */
370
+ record_ids?: string[];
371
+ /** 删除原因 */
372
+ reason?: string;
373
+ }
374
+ interface BatchRemoveResponse {
375
+ /** 每条记录的操作结果 */
376
+ operate_results?: Lark.LumpSumPaymentOperateResult[];
377
+ }
378
+ }
379
+ namespace RecurringPayment {
380
+ interface Methods {
381
+ /**
382
+ * 查询经常性支付记录
383
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/recurring_payment/query
384
+ */
385
+ query(body: QueryRequest, query?: QueryQuery): Paginated<Lark.RecurringPayment, 'records'>;
386
+ /**
387
+ * 批量更正经常性支付记录
388
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/recurring_payment/batch_update
389
+ */
390
+ batchUpdate(body: BatchUpdateRequest, query?: BatchUpdateQuery): Promise<BatchUpdateResponse>;
391
+ /**
392
+ * 批量删除经常性支付记录
393
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/recurring_payment/batch_remove
394
+ */
395
+ batchRemove(body: BatchRemoveRequest): Promise<BatchRemoveResponse>;
396
+ /**
397
+ * 批量创建经常性支付记录
398
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/recurring_payment/batch_create
399
+ */
400
+ batchCreate(body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>;
401
+ }
402
+ interface QueryRequest {
403
+ /** id属于 */
404
+ ids?: string[];
405
+ /** unique_id属于 */
406
+ unique_ids?: string[];
407
+ /** 员工id属于 */
408
+ user_ids?: string[];
409
+ /** 薪酬项id属于 */
410
+ item_ids?: string[];
411
+ /** 发放开始日期大于等于 */
412
+ start_date_gte?: string;
413
+ /** 发放开始日期小于等于 */
414
+ start_date_lte?: string;
415
+ /** 发放结束日期大于等于 */
416
+ end_date_gte?: string;
417
+ /** 发放结束日期小于等于 */
418
+ end_date_lte?: string;
419
+ /** 创建时间大于等于(东八区) */
420
+ create_time_gte?: string;
421
+ /** 创建时间小于等于(东八区) */
422
+ create_time_lte?: string;
423
+ /** 更新时间大于等于(东八区) */
424
+ modify_time_gte?: string;
425
+ /** 更新时间小于等于(东八区) */
426
+ modify_time_lte?: string;
427
+ /** 合同主体id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/company/list 接口进行查询) */
428
+ company_ids?: string[];
429
+ /** 任职公司id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/company/list 接口进行查询) */
430
+ service_company_ids?: string[];
431
+ /** 部门id属于(可通过 https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get 接口进行查询) */
432
+ department_ids?: string[];
433
+ /** 序列id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/job-management/job_family/list 接口进行查询) */
434
+ job_family_ids?: string[];
435
+ /** 职级id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/job-management/job_level/list 接口进行查询) */
436
+ job_level_ids?: string[];
437
+ /** 工作地点id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/organization-management/location/list 接口进行查询) */
438
+ work_location_ids?: string[];
439
+ /** 员工类型id属于(可通过 https://open.larkoffice.com/document/server-docs/corehr-v1/basic-infomation/employee_type/list 接口进行查询) */
440
+ employee_type_ids?: string[];
441
+ /** 入职日期大于等于 */
442
+ onboard_date_gte?: string;
443
+ /** 入职日期小于等于 */
444
+ onboard_date_lte?: string;
445
+ /** 离职日期大于等于 */
446
+ offboard_date_gte?: string;
447
+ /** 离职日期小于等于 */
448
+ offboard_date_lte?: string;
449
+ }
450
+ interface QueryQuery extends Pagination {
451
+ /** 用户ID类型 */
452
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
453
+ }
454
+ interface BatchUpdateRequest {
455
+ /** 需更正的经常性支付记录 */
456
+ records?: Lark.RecurringPaymentForUpdate[];
457
+ }
458
+ interface BatchUpdateQuery {
459
+ /** 用户ID类型 */
460
+ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
461
+ }
462
+ interface BatchUpdateResponse {
463
+ /** 每条记录的操作结果 */
464
+ operate_results?: Lark.RecurringPaymentOperateResult[];
465
+ }
466
+ interface BatchRemoveRequest {
467
+ /** 需要删除的记录ID */
468
+ record_ids: string[];
469
+ /** 原因 */
470
+ reason?: string;
471
+ }
472
+ interface BatchRemoveResponse {
473
+ /** 每条记录的操作结果 */
474
+ operate_results?: Lark.RecurringPaymentOperateResult[];
475
+ }
476
+ interface BatchCreateRequest {
477
+ /** 要创建的经常性支付记录 */
478
+ records?: Lark.RecurringPaymentForCreate[];
479
+ }
480
+ interface BatchCreateQuery {
481
+ /** 用户ID类型 */
482
+ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
483
+ }
484
+ interface BatchCreateResponse {
485
+ /** 每条记录的操作结果。对于创建成功的记录,会返回创建后的经常性支付记录id */
486
+ operate_results?: Lark.RecurringPaymentOperateResult[];
487
+ }
488
+ }
89
489
  }