@satorijs/adapter-lark 3.9.1 → 3.9.3

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 (82) hide show
  1. package/lib/index.cjs +1078 -14
  2. package/lib/types/acs.d.ts +19 -19
  3. package/lib/types/admin.d.ts +58 -32
  4. package/lib/types/aily.d.ts +52 -52
  5. package/lib/types/apaas.d.ts +96 -96
  6. package/lib/types/application.d.ts +151 -67
  7. package/lib/types/approval.d.ts +182 -150
  8. package/lib/types/attendance.d.ts +395 -353
  9. package/lib/types/auth.d.ts +18 -18
  10. package/lib/types/authen.d.ts +24 -24
  11. package/lib/types/baike.d.ts +42 -42
  12. package/lib/types/bitable.d.ts +268 -184
  13. package/lib/types/calendar.d.ts +144 -144
  14. package/lib/types/cardkit.d.ts +8 -8
  15. package/lib/types/contact.d.ts +209 -137
  16. package/lib/types/corehr.d.ts +760 -620
  17. package/lib/types/document_ai.d.ts +68 -68
  18. package/lib/types/docx.d.ts +103 -95
  19. package/lib/types/drive.d.ts +236 -236
  20. package/lib/types/ehr.d.ts +26 -2
  21. package/lib/types/helpdesk.d.ts +155 -155
  22. package/lib/types/hire.d.ts +954 -510
  23. package/lib/types/im.d.ts +446 -446
  24. package/lib/types/index.d.ts +72 -30
  25. package/lib/types/lingo.d.ts +28 -28
  26. package/lib/types/mail.d.ts +192 -192
  27. package/lib/types/minutes.d.ts +4 -4
  28. package/lib/types/okr.d.ts +86 -58
  29. package/lib/types/passport.d.ts +13 -5
  30. package/lib/types/payroll.d.ts +13 -5
  31. package/lib/types/performance.d.ts +85 -79
  32. package/lib/types/personal_settings.d.ts +12 -12
  33. package/lib/types/report.d.ts +11 -5
  34. package/lib/types/search.d.ts +48 -24
  35. package/lib/types/sheets.d.ts +64 -64
  36. package/lib/types/speech_to_text.d.ts +4 -4
  37. package/lib/types/task.d.ts +191 -185
  38. package/lib/types/translation.d.ts +4 -4
  39. package/lib/types/vc.d.ts +335 -155
  40. package/lib/types/wiki.d.ts +48 -48
  41. package/package.json +1 -1
  42. package/src/internal.ts +1 -1
  43. package/src/types/acs.ts +24 -24
  44. package/src/types/admin.ts +69 -39
  45. package/src/types/aily.ts +61 -61
  46. package/src/types/apaas.ts +113 -113
  47. package/src/types/application.ts +173 -79
  48. package/src/types/approval.ts +202 -166
  49. package/src/types/attendance.ts +466 -421
  50. package/src/types/auth.ts +20 -20
  51. package/src/types/authen.ts +28 -28
  52. package/src/types/baike.ts +55 -55
  53. package/src/types/bitable.ts +305 -219
  54. package/src/types/calendar.ts +167 -167
  55. package/src/types/cardkit.ts +10 -10
  56. package/src/types/contact.ts +251 -169
  57. package/src/types/corehr.ts +903 -743
  58. package/src/types/document_ai.ts +85 -85
  59. package/src/types/docx.ts +117 -108
  60. package/src/types/drive.ts +298 -298
  61. package/src/types/ehr.ts +28 -2
  62. package/src/types/helpdesk.ts +181 -181
  63. package/src/types/hire.ts +1081 -591
  64. package/src/types/im.ts +521 -521
  65. package/src/types/index.ts +73 -30
  66. package/src/types/lingo.ts +36 -36
  67. package/src/types/mail.ts +215 -215
  68. package/src/types/minutes.ts +5 -5
  69. package/src/types/okr.ts +98 -66
  70. package/src/types/passport.ts +15 -6
  71. package/src/types/payroll.ts +15 -6
  72. package/src/types/performance.ts +98 -91
  73. package/src/types/personal_settings.ts +15 -15
  74. package/src/types/report.ts +13 -6
  75. package/src/types/search.ts +57 -29
  76. package/src/types/sheets.ts +80 -80
  77. package/src/types/speech_to_text.ts +5 -5
  78. package/src/types/task.ts +238 -231
  79. package/src/types/translation.ts +5 -5
  80. package/src/types/vc.ts +386 -186
  81. package/src/types/wiki.ts +59 -59
  82. package/src/utils.ts +12 -7
@@ -238,358 +238,6 @@ export interface CreateAttendanceShiftQuery {
238
238
  /** 用户 ID 的类型 不提供则用户相关字段无效 */
239
239
  employee_type?: 'employee_id' | 'employee_no';
240
240
  }
241
- export interface QueryAttendanceShiftQuery {
242
- /** 班次名称 */
243
- shift_name: string;
244
- }
245
- export interface BatchCreateAttendanceUserDailyShiftRequest {
246
- /** 班表信息列表 */
247
- user_daily_shifts: UserDailyShift[];
248
- /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
249
- operator_id?: string;
250
- }
251
- export interface BatchCreateAttendanceUserDailyShiftQuery {
252
- /** 请求体和响应体中的 user_id 的员工工号类型 */
253
- employee_type: 'employee_id' | 'employee_no';
254
- }
255
- export interface QueryAttendanceUserDailyShiftRequest {
256
- /** employee_no 或 employee_id 列表 */
257
- user_ids: string[];
258
- /** 查询的起始工作日 */
259
- check_date_from: number;
260
- /** 查询的结束工作日 */
261
- check_date_to: number;
262
- }
263
- export interface QueryAttendanceUserDailyShiftQuery {
264
- /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
265
- employee_type: 'employee_id' | 'employee_no';
266
- }
267
- export interface BatchCreateTempAttendanceUserDailyShiftRequest {
268
- /** 临时班表信息列表(数量限制50以内) */
269
- user_tmp_daily_shifts: UserTmpDailyShift[];
270
- /** 操作人uid */
271
- operator_id?: string;
272
- }
273
- export interface BatchCreateTempAttendanceUserDailyShiftQuery {
274
- /** 请求体和响应体中的 user_id 的员工工号类型 */
275
- employee_type: 'employee_id' | 'employee_no';
276
- }
277
- export interface ListUserAttendanceGroupQuery extends Pagination {
278
- /** 用户 ID 的类型 */
279
- employee_type: string;
280
- /** 部门 ID 的类型 */
281
- dept_type: string;
282
- /** 打卡类型 */
283
- member_clock_type: number;
284
- }
285
- export interface CreateAttendanceGroupRequest {
286
- /** 6921319402260496386 */
287
- group: Group;
288
- /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
289
- operator_id?: string;
290
- }
291
- export interface CreateAttendanceGroupQuery {
292
- /** 用户 ID 的类型 */
293
- employee_type: 'employee_id' | 'employee_no';
294
- /** 部门 ID 的类型 */
295
- dept_type: 'open_id';
296
- }
297
- export interface GetAttendanceGroupQuery {
298
- /** 用户 ID 的类型 */
299
- employee_type: 'employee_id' | 'employee_no';
300
- /** 部门 ID 的类型 */
301
- dept_type: 'open_id';
302
- }
303
- export interface SearchAttendanceGroupRequest {
304
- /** 考勤组名称 */
305
- group_name: string;
306
- }
307
- export interface ModifyAttendanceUserSettingRequest {
308
- /** 用户设置 */
309
- user_setting?: UserSetting;
310
- }
311
- export interface ModifyAttendanceUserSettingQuery {
312
- /** 请求体和响应体中的 user_id 的员工工号类型 */
313
- employee_type: 'employee_id' | 'employee_no';
314
- }
315
- export interface QueryAttendanceUserSettingRequest {
316
- /** employee_no 或 employee_id 列表 */
317
- user_ids: string[];
318
- }
319
- export interface QueryAttendanceUserSettingQuery {
320
- /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
321
- employee_type: 'employee_id' | 'employee_no';
322
- }
323
- export interface UploadAttendanceFileForm {
324
- /** 文件内容 */
325
- file?: Blob;
326
- }
327
- export interface UploadAttendanceFileQuery {
328
- /** 带后缀的文件名 */
329
- file_name: string;
330
- }
331
- export interface UpdateAttendanceUserStatsViewRequest {
332
- /** 统计设置 */
333
- view: UserStatsView;
334
- }
335
- export interface UpdateAttendanceUserStatsViewQuery {
336
- /** 员工工号类型 */
337
- employee_type: 'employee_id' | 'employee_no';
338
- }
339
- export interface QueryAttendanceUserStatsFieldRequest {
340
- /** 语言类型 */
341
- locale: 'en' | 'ja' | 'zh';
342
- /** 统计类型 */
343
- stats_type: 'daily' | 'month';
344
- /** 开始时间 */
345
- start_date: number;
346
- /** 结束时间(时间间隔不超过 40 天) */
347
- end_date: number;
348
- }
349
- export interface QueryAttendanceUserStatsFieldQuery {
350
- /** 响应体中的 user_id 的员工工号类型 */
351
- employee_type: 'employee_id' | 'employee_no';
352
- }
353
- export interface QueryAttendanceUserStatsViewRequest {
354
- /** 语言类型 */
355
- locale: 'en' | 'ja' | 'zh';
356
- /** 统计类型 */
357
- stats_type: 'daily' | 'month';
358
- /** 查询用户id,同【查询统计数据】、【更新统计设置】user_id */
359
- user_id?: string;
360
- }
361
- export interface QueryAttendanceUserStatsViewQuery {
362
- /** 响应体中的 user_id 的员工工号类型 */
363
- employee_type: 'employee_id' | 'employee_no';
364
- }
365
- export interface QueryAttendanceUserStatsDataRequest {
366
- /** 语言类型 */
367
- locale: 'en' | 'ja' | 'zh';
368
- /** 统计类型 */
369
- stats_type: 'daily' | 'month';
370
- /** 开始时间 */
371
- start_date: number;
372
- /** 结束时间(时间间隔不超过 40 天) */
373
- end_date: number;
374
- /** 查询的用户 ID 列表(用户数量不超过 200) */
375
- user_ids?: string[];
376
- /** 是否需要历史数据 */
377
- need_history?: boolean;
378
- /** 只展示当前考勤组 */
379
- current_group_only?: boolean;
380
- /** 查询用户id,同【更新统计设置】、【查询统计设置】user_id */
381
- user_id?: string;
382
- }
383
- export interface QueryAttendanceUserStatsDataQuery {
384
- /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
385
- employee_type: 'employee_id' | 'employee_no';
386
- }
387
- export interface QueryAttendanceUserApprovalRequest {
388
- /** employee_no 或 employee_id 列表 */
389
- user_ids: string[];
390
- /** 查询的起始工作日 */
391
- check_date_from: number;
392
- /** 查询的结束工作日,与 check_date_from 的时间间隔不超过 30 天 */
393
- check_date_to: number;
394
- /** 查询依据的时间类型(不填默认依据PeriodTime) */
395
- check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime';
396
- /** 查询状态(不填默认查询已通过状态) */
397
- status?: 0 | 1 | 2 | 3 | 4;
398
- /** 查询的起始时间,精确到秒的时间戳 */
399
- check_time_from?: string;
400
- /** 查询的结束时间,精确到秒的时间戳 */
401
- check_time_to?: string;
402
- }
403
- export interface QueryAttendanceUserApprovalQuery {
404
- /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
405
- employee_type: 'employee_id' | 'employee_no' | 'open_id';
406
- }
407
- export interface CreateAttendanceUserApprovalRequest {
408
- /** 审批信息 */
409
- user_approval?: UserApproval;
410
- }
411
- export interface CreateAttendanceUserApprovalQuery {
412
- /** 请求体和响应体中的 user_id 的员工工号类型 */
413
- employee_type: 'employee_id' | 'employee_no' | 'open_id';
414
- }
415
- export interface ProcessAttendanceApprovalInfoRequest {
416
- /** 审批实例 ID,获取方式:1)[获取审批通过数据](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query) 2)[写入审批结果](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create) 3)[通知补卡审批发起(补卡情况下)](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create) */
417
- approval_id: string;
418
- /** 审批类型,leave:请假,out:外出,overtime:加班,trip:出差,remedy:补卡 */
419
- approval_type: string;
420
- /** 审批状态,1:不通过,2:通过,4:撤销 */
421
- status: number;
422
- }
423
- export interface CreateAttendanceUserTaskRemedyRequest {
424
- /** 用户工号 */
425
- user_id: string;
426
- /** 补卡日期 */
427
- remedy_date: number;
428
- /** 第几次上下班,可能值0,1,2 */
429
- punch_no: number;
430
- /** 上班/下班,1是上班,2是下班 */
431
- work_type: number;
432
- /** 补卡时间 */
433
- remedy_time: string;
434
- /** 补卡原因 */
435
- reason: string;
436
- /** 补卡时间戳,精确到秒的时间戳 */
437
- time?: string;
438
- }
439
- export interface CreateAttendanceUserTaskRemedyQuery {
440
- /** 请求体和响应体中的 user_id 的员工工号类型 */
441
- employee_type: 'employee_id' | 'employee_no';
442
- }
443
- export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyRequest {
444
- /** 用户 ID */
445
- user_id: string;
446
- /** 补卡日期 */
447
- remedy_date: number;
448
- }
449
- export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyQuery {
450
- /** 请求体和响应体中的 user_id 的员工工号类型 */
451
- employee_type: 'employee_id' | 'employee_no';
452
- }
453
- export interface QueryAttendanceUserTaskRemedyRequest {
454
- /** employee_no 或 employee_id 列表 */
455
- user_ids: string[];
456
- /** 查询的起始时间,精确到秒的时间戳 */
457
- check_time_from: string;
458
- /** 查询的结束时间,精确到秒的时间戳 */
459
- check_time_to: string;
460
- /** 查询依据的时间类型(不填默认依据PeriodTime) */
461
- check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime';
462
- /** 查询状态(不填默认查询已通过状态) */
463
- status?: 0 | 1 | 2 | 3 | 4;
464
- }
465
- export interface QueryAttendanceUserTaskRemedyQuery {
466
- /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
467
- employee_type: 'employee_id' | 'employee_no';
468
- }
469
- export interface UserStatsFieldsQueryAttendanceArchiveRuleRequest {
470
- /** 语言类型 */
471
- locale?: string;
472
- /** 月份 */
473
- month: string;
474
- /** 归档规则id */
475
- archive_rule_id: string;
476
- /** 操作者id */
477
- operator_id: string;
478
- }
479
- export interface UserStatsFieldsQueryAttendanceArchiveRuleQuery {
480
- /** 用户 ID 的类型 */
481
- employee_type: string;
482
- }
483
- export interface UploadReportAttendanceArchiveRuleRequest {
484
- /** 月份 */
485
- month: string;
486
- /** 操作者ID */
487
- operator_id: string;
488
- /** 归档报表内容(不超过50个) */
489
- archive_report_datas?: ArchiveReportData[];
490
- /** 归档规则id */
491
- archive_rule_id: string;
492
- }
493
- export interface UploadReportAttendanceArchiveRuleQuery {
494
- /** 用户 ID 的类型 */
495
- employee_type: string;
496
- }
497
- export interface DelReportAttendanceArchiveRuleRequest {
498
- /** 月份 */
499
- month: string;
500
- /** 操作者ID */
501
- operator_id: string;
502
- /** 归档规则id */
503
- archive_rule_id: string;
504
- /** 用户id */
505
- user_ids?: string[];
506
- }
507
- export interface DelReportAttendanceArchiveRuleQuery {
508
- /** 员工工号类型 */
509
- employee_type: string;
510
- }
511
- export interface BatchCreateAttendanceUserFlowRequest {
512
- /** 打卡流水记录列表 */
513
- flow_records: UserFlow[];
514
- }
515
- export interface BatchCreateAttendanceUserFlowQuery {
516
- /** 请求体和响应体中的 user_id 和 creator_id 的员工工号类型 */
517
- employee_type: 'employee_id' | 'employee_no';
518
- }
519
- export interface GetAttendanceUserFlowQuery {
520
- /** 响应体中的 user_id 和 creator_id 的员工工号类型 */
521
- employee_type: 'employee_id' | 'employee_no';
522
- }
523
- export interface QueryAttendanceUserFlowRequest {
524
- /** employee_no 或 employee_id 列表,长度不超过 50 */
525
- user_ids: string[];
526
- /** 查询的起始时间,时间戳 */
527
- check_time_from: string;
528
- /** 查询的结束时间,时间戳 */
529
- check_time_to: string;
530
- }
531
- export interface QueryAttendanceUserFlowQuery {
532
- /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
533
- employee_type: 'employee_id' | 'employee_no';
534
- /** 由于新入职用户可以复用已离职用户的employee_no/employee_id。如果true,返回employee_no/employee_id对应的所有在职+离职用户数据;如果false,只返回employee_no/employee_id对应的在职或最近一个离职用户数据 */
535
- include_terminated_user?: boolean;
536
- }
537
- export interface QueryAttendanceUserTaskRequest {
538
- /** employee_no 或 employee_id 列表 */
539
- user_ids: string[];
540
- /** 查询的起始工作日 */
541
- check_date_from: number;
542
- /** 查询的结束工作日 */
543
- check_date_to: number;
544
- /** 是否需要加班班段打卡结果 */
545
- need_overtime_result?: boolean;
546
- }
547
- export interface QueryAttendanceUserTaskQuery {
548
- /** 员工工号类型 */
549
- employee_type: 'employee_id' | 'employee_no';
550
- /** 是否忽略无效和没有权限的用户。如果 true,则返回有效用户的信息,并告知无效和没有权限的用户信息;如果 false,且 user_ids 中存在无效或没有权限的用户,则返回错误 */
551
- ignore_invalid_users?: boolean;
552
- /** 由于新入职员工可以复用已离职员工的 employee_no/employee_id,如果 true,则返回 employee_no/employee_id 对应的所有在职 + 离职员工的数据;如果 false,则只返回 employee_no/employee_id 对应的在职或最近一个离职员工的数据 */
553
- include_terminated_user?: boolean;
554
- }
555
- export interface GetAttendanceLeaveEmployExpireRecordRequest {
556
- /** 员工ID */
557
- employment_id: string;
558
- /** 假期类型ID */
559
- leave_type_id: string;
560
- /** 失效最早日期 2023-04-10 格式 */
561
- start_expiration_date: string;
562
- /** 失效最晚日期 2023-05-10 格式 */
563
- end_expiration_date: string;
564
- /** 时间偏移,东八区:480 8*60, 如果没有这个参数,默认东八区 */
565
- time_offset?: number;
566
- }
567
- export interface GetAttendanceLeaveEmployExpireRecordQuery {
568
- /** 用户 ID 类型 */
569
- user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id';
570
- }
571
- export interface PatchAttendanceLeaveAccrualRecordRequest {
572
- /** 授予记录的唯一ID */
573
- leave_granting_record_id: string;
574
- /** 员工ID */
575
- employment_id: string;
576
- /** 假期类型ID */
577
- leave_type_id: string;
578
- /** 修改授予记录原因 */
579
- reason: LangText[];
580
- /** 时间偏移,东八区:480 8*60 */
581
- time_offset?: number;
582
- /** 失效日期,格式"2020-01-01" */
583
- expiration_date?: string;
584
- /** 修改source 余额 */
585
- quantity?: string;
586
- /** 是否参与清算 */
587
- section_type?: number;
588
- }
589
- export interface PatchAttendanceLeaveAccrualRecordQuery {
590
- /** 用户 ID 类型 */
591
- user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id';
592
- }
593
241
  export interface CreateAttendanceShiftResponse {
594
242
  /** 班次 */
595
243
  shift?: Shift;
@@ -636,6 +284,10 @@ export interface GetAttendanceShiftResponse {
636
284
  /** 休息弹性设置 */
637
285
  rest_time_flexible_configs?: RestTimeFlexibleConfig[];
638
286
  }
287
+ export interface QueryAttendanceShiftQuery {
288
+ /** 班次名称 */
289
+ shift_name: string;
290
+ }
639
291
  export interface QueryAttendanceShiftResponse {
640
292
  /** 班次Id */
641
293
  shift_id: string;
@@ -678,21 +330,79 @@ export interface QueryAttendanceShiftResponse {
678
330
  /** 休息弹性设置 */
679
331
  rest_time_flexible_configs?: RestTimeFlexibleConfig[];
680
332
  }
333
+ export interface BatchCreateAttendanceUserDailyShiftRequest {
334
+ /** 班表信息列表 */
335
+ user_daily_shifts: UserDailyShift[];
336
+ /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
337
+ operator_id?: string;
338
+ }
339
+ export interface BatchCreateAttendanceUserDailyShiftQuery {
340
+ /** 请求体和响应体中的 user_id 的员工工号类型 */
341
+ employee_type: 'employee_id' | 'employee_no';
342
+ }
681
343
  export interface BatchCreateAttendanceUserDailyShiftResponse {
682
344
  /** 班表信息列表 */
683
345
  user_daily_shifts?: UserDailyShift[];
684
346
  }
347
+ export interface QueryAttendanceUserDailyShiftRequest {
348
+ /** employee_no 或 employee_id 列表 */
349
+ user_ids: string[];
350
+ /** 查询的起始工作日 */
351
+ check_date_from: number;
352
+ /** 查询的结束工作日 */
353
+ check_date_to: number;
354
+ }
355
+ export interface QueryAttendanceUserDailyShiftQuery {
356
+ /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
357
+ employee_type: 'employee_id' | 'employee_no';
358
+ }
685
359
  export interface QueryAttendanceUserDailyShiftResponse {
686
360
  /** 班表信息列表 */
687
361
  user_daily_shifts?: UserDailyShift[];
688
362
  }
363
+ export interface BatchCreateTempAttendanceUserDailyShiftRequest {
364
+ /** 临时班表信息列表(数量限制50以内) */
365
+ user_tmp_daily_shifts: UserTmpDailyShift[];
366
+ /** 操作人uid */
367
+ operator_id?: string;
368
+ }
369
+ export interface BatchCreateTempAttendanceUserDailyShiftQuery {
370
+ /** 请求体和响应体中的 user_id 的员工工号类型 */
371
+ employee_type: 'employee_id' | 'employee_no';
372
+ }
689
373
  export interface BatchCreateTempAttendanceUserDailyShiftResponse {
690
374
  /** 临时班表信息列表 */
691
375
  user_tmp_daily_shifts?: UserTmpDailyShift[];
692
376
  }
377
+ export interface ListUserAttendanceGroupQuery extends Pagination {
378
+ /** 用户 ID 的类型 */
379
+ employee_type: string;
380
+ /** 部门 ID 的类型 */
381
+ dept_type: string;
382
+ /** 打卡类型 */
383
+ member_clock_type: number;
384
+ }
385
+ export interface CreateAttendanceGroupRequest {
386
+ /** 6921319402260496386 */
387
+ group: Group;
388
+ /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
389
+ operator_id?: string;
390
+ }
391
+ export interface CreateAttendanceGroupQuery {
392
+ /** 用户 ID 的类型 */
393
+ employee_type: 'employee_id' | 'employee_no';
394
+ /** 部门 ID 的类型 */
395
+ dept_type: 'open_id';
396
+ }
693
397
  export interface CreateAttendanceGroupResponse {
694
398
  group?: Group;
695
399
  }
400
+ export interface GetAttendanceGroupQuery {
401
+ /** 用户 ID 的类型 */
402
+ employee_type: 'employee_id' | 'employee_no';
403
+ /** 部门 ID 的类型 */
404
+ dept_type: 'open_id';
405
+ }
696
406
  export interface GetAttendanceGroupResponse {
697
407
  /** 考勤组的Id, 需要从获取用户打卡结果信息的接口中获取groupId,修改考勤组时必填 */
698
408
  group_id?: string;
@@ -832,75 +542,337 @@ export interface GetAttendanceGroupResponse {
832
542
  /** 定位不准时是否允许申请打卡 */
833
543
  allow_apply_punch?: boolean;
834
544
  }
545
+ export interface SearchAttendanceGroupRequest {
546
+ /** 考勤组名称 */
547
+ group_name: string;
548
+ }
835
549
  export interface SearchAttendanceGroupResponse {
836
550
  /** 考勤组列表 */
837
551
  group_list?: GroupMeta[];
838
552
  }
553
+ export interface ModifyAttendanceUserSettingRequest {
554
+ /** 用户设置 */
555
+ user_setting?: UserSetting;
556
+ }
557
+ export interface ModifyAttendanceUserSettingQuery {
558
+ /** 请求体和响应体中的 user_id 的员工工号类型 */
559
+ employee_type: 'employee_id' | 'employee_no';
560
+ }
839
561
  export interface ModifyAttendanceUserSettingResponse {
840
562
  /** 用户设置 */
841
563
  user_setting?: UserSetting;
842
564
  }
565
+ export interface QueryAttendanceUserSettingRequest {
566
+ /** employee_no 或 employee_id 列表 */
567
+ user_ids: string[];
568
+ }
569
+ export interface QueryAttendanceUserSettingQuery {
570
+ /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
571
+ employee_type: 'employee_id' | 'employee_no';
572
+ }
843
573
  export interface QueryAttendanceUserSettingResponse {
844
574
  /** 用户设置信息列表 */
845
575
  user_settings?: UserSetting[];
846
576
  }
577
+ export interface UploadAttendanceFileForm {
578
+ /** 文件内容 */
579
+ file?: Blob;
580
+ }
581
+ export interface UploadAttendanceFileQuery {
582
+ /** 带后缀的文件名 */
583
+ file_name: string;
584
+ }
847
585
  export interface UploadAttendanceFileResponse {
848
586
  file?: File;
849
587
  }
588
+ export interface UpdateAttendanceUserStatsViewRequest {
589
+ /** 统计设置 */
590
+ view: UserStatsView;
591
+ }
592
+ export interface UpdateAttendanceUserStatsViewQuery {
593
+ /** 员工工号类型 */
594
+ employee_type: 'employee_id' | 'employee_no';
595
+ }
850
596
  export interface UpdateAttendanceUserStatsViewResponse {
851
597
  /** 视图 */
852
598
  view?: UserStatsView;
853
599
  }
600
+ export interface QueryAttendanceUserStatsFieldRequest {
601
+ /** 语言类型 */
602
+ locale: 'en' | 'ja' | 'zh';
603
+ /** 统计类型 */
604
+ stats_type: 'daily' | 'month';
605
+ /** 开始时间 */
606
+ start_date: number;
607
+ /** 结束时间(时间间隔不超过 40 天) */
608
+ end_date: number;
609
+ }
610
+ export interface QueryAttendanceUserStatsFieldQuery {
611
+ /** 响应体中的 user_id 的员工工号类型 */
612
+ employee_type: 'employee_id' | 'employee_no';
613
+ }
854
614
  export interface QueryAttendanceUserStatsFieldResponse {
855
615
  user_stats_field?: UserStatsField;
856
616
  }
617
+ export interface QueryAttendanceUserStatsViewRequest {
618
+ /** 语言类型 */
619
+ locale: 'en' | 'ja' | 'zh';
620
+ /** 统计类型 */
621
+ stats_type: 'daily' | 'month';
622
+ /** 查询用户id,同【查询统计数据】、【更新统计设置】user_id */
623
+ user_id?: string;
624
+ }
625
+ export interface QueryAttendanceUserStatsViewQuery {
626
+ /** 响应体中的 user_id 的员工工号类型 */
627
+ employee_type: 'employee_id' | 'employee_no';
628
+ }
857
629
  export interface QueryAttendanceUserStatsViewResponse {
858
630
  view?: UserStatsView;
859
631
  }
632
+ export interface QueryAttendanceUserStatsDataRequest {
633
+ /** 语言类型 */
634
+ locale: 'en' | 'ja' | 'zh';
635
+ /** 统计类型 */
636
+ stats_type: 'daily' | 'month';
637
+ /** 开始时间 */
638
+ start_date: number;
639
+ /** 结束时间(时间间隔不超过 40 天) */
640
+ end_date: number;
641
+ /** 查询的用户 ID 列表(用户数量不超过 200) */
642
+ user_ids?: string[];
643
+ /** 是否需要历史数据 */
644
+ need_history?: boolean;
645
+ /** 只展示当前考勤组 */
646
+ current_group_only?: boolean;
647
+ /** 查询用户id,同【更新统计设置】、【查询统计设置】user_id */
648
+ user_id?: string;
649
+ }
650
+ export interface QueryAttendanceUserStatsDataQuery {
651
+ /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
652
+ employee_type: 'employee_id' | 'employee_no';
653
+ }
860
654
  export interface QueryAttendanceUserStatsDataResponse {
861
655
  /** 用户统计数据 */
862
656
  user_datas?: UserStatsData[];
863
657
  /** 无权限获取的用户列表 */
864
658
  invalid_user_list?: string[];
865
659
  }
660
+ export declare const enum QueryAttendanceUserApprovalRequestStatus {
661
+ /** 待审批 */
662
+ Todo = 0,
663
+ /** 审批未通过 */
664
+ Rejected = 1,
665
+ /** 审批通过 */
666
+ Approved = 2,
667
+ /** 审批已取消 */
668
+ Canceled = 3,
669
+ /** 已撤回 */
670
+ Reverted = 4
671
+ }
672
+ export interface QueryAttendanceUserApprovalRequest {
673
+ /** employee_no 或 employee_id 列表 */
674
+ user_ids: string[];
675
+ /** 查询的起始工作日 */
676
+ check_date_from: number;
677
+ /** 查询的结束工作日,与 check_date_from 的时间间隔不超过 30 天 */
678
+ check_date_to: number;
679
+ /** 查询依据的时间类型(不填默认依据PeriodTime) */
680
+ check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime';
681
+ /** 查询状态(不填默认查询已通过状态) */
682
+ status?: QueryAttendanceUserApprovalRequestStatus;
683
+ /** 查询的起始时间,精确到秒的时间戳 */
684
+ check_time_from?: string;
685
+ /** 查询的结束时间,精确到秒的时间戳 */
686
+ check_time_to?: string;
687
+ }
688
+ export interface QueryAttendanceUserApprovalQuery {
689
+ /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
690
+ employee_type: 'employee_id' | 'employee_no' | 'open_id';
691
+ }
866
692
  export interface QueryAttendanceUserApprovalResponse {
867
693
  /** 审批结果列表 */
868
694
  user_approvals?: UserApproval[];
869
695
  }
696
+ export interface CreateAttendanceUserApprovalRequest {
697
+ /** 审批信息 */
698
+ user_approval?: UserApproval;
699
+ }
700
+ export interface CreateAttendanceUserApprovalQuery {
701
+ /** 请求体和响应体中的 user_id 的员工工号类型 */
702
+ employee_type: 'employee_id' | 'employee_no' | 'open_id';
703
+ }
870
704
  export interface CreateAttendanceUserApprovalResponse {
871
705
  /** 审批信息 */
872
706
  user_approval?: UserApproval;
873
707
  }
708
+ export interface ProcessAttendanceApprovalInfoRequest {
709
+ /** 审批实例 ID,获取方式:1)[获取审批通过数据](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query) 2)[写入审批结果](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create) 3)[通知补卡审批发起(补卡情况下)](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create) */
710
+ approval_id: string;
711
+ /** 审批类型,leave:请假,out:外出,overtime:加班,trip:出差,remedy:补卡 */
712
+ approval_type: string;
713
+ /** 审批状态,1:不通过,2:通过,4:撤销 */
714
+ status: number;
715
+ }
874
716
  export interface ProcessAttendanceApprovalInfoResponse {
875
717
  /** 审批信息 */
876
718
  approval_info?: ApprovalInfo;
877
719
  }
720
+ export interface CreateAttendanceUserTaskRemedyRequest {
721
+ /** 用户工号 */
722
+ user_id: string;
723
+ /** 补卡日期 */
724
+ remedy_date: number;
725
+ /** 第几次上下班,可能值0,1,2 */
726
+ punch_no: number;
727
+ /** 上班/下班,1是上班,2是下班 */
728
+ work_type: number;
729
+ /** 补卡时间 */
730
+ remedy_time: string;
731
+ /** 补卡原因 */
732
+ reason: string;
733
+ /** 补卡时间戳,精确到秒的时间戳 */
734
+ time?: string;
735
+ }
736
+ export interface CreateAttendanceUserTaskRemedyQuery {
737
+ /** 请求体和响应体中的 user_id 的员工工号类型 */
738
+ employee_type: 'employee_id' | 'employee_no';
739
+ }
878
740
  export interface CreateAttendanceUserTaskRemedyResponse {
879
741
  /** 补卡审批信息 */
880
742
  user_remedy?: UserTaskRemedy;
881
743
  }
744
+ export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyRequest {
745
+ /** 用户 ID */
746
+ user_id: string;
747
+ /** 补卡日期 */
748
+ remedy_date: number;
749
+ }
750
+ export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyQuery {
751
+ /** 请求体和响应体中的 user_id 的员工工号类型 */
752
+ employee_type: 'employee_id' | 'employee_no';
753
+ }
882
754
  export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyResponse {
883
755
  /** 用户可补卡时间 */
884
756
  user_allowed_remedys?: UserAllowedRemedy[];
885
757
  }
758
+ export declare const enum QueryAttendanceUserTaskRemedyRequestStatus {
759
+ /** 待审批 */
760
+ Pending = 0,
761
+ /** 未通过 */
762
+ Rejected = 1,
763
+ /** 已通过 */
764
+ Pass = 2,
765
+ /** 已取消 */
766
+ Cancel = 3,
767
+ /** 已撤回 */
768
+ Withdraw = 4
769
+ }
770
+ export interface QueryAttendanceUserTaskRemedyRequest {
771
+ /** employee_no 或 employee_id 列表 */
772
+ user_ids: string[];
773
+ /** 查询的起始时间,精确到秒的时间戳 */
774
+ check_time_from: string;
775
+ /** 查询的结束时间,精确到秒的时间戳 */
776
+ check_time_to: string;
777
+ /** 查询依据的时间类型(不填默认依据PeriodTime) */
778
+ check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime';
779
+ /** 查询状态(不填默认查询已通过状态) */
780
+ status?: QueryAttendanceUserTaskRemedyRequestStatus;
781
+ }
782
+ export interface QueryAttendanceUserTaskRemedyQuery {
783
+ /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
784
+ employee_type: 'employee_id' | 'employee_no';
785
+ }
886
786
  export interface QueryAttendanceUserTaskRemedyResponse {
887
787
  /** 补卡记录列表 */
888
788
  user_remedys?: UserTaskRemedy[];
889
789
  }
790
+ export interface UserStatsFieldsQueryAttendanceArchiveRuleRequest {
791
+ /** 语言类型 */
792
+ locale?: string;
793
+ /** 月份 */
794
+ month: string;
795
+ /** 归档规则id */
796
+ archive_rule_id: string;
797
+ /** 操作者id */
798
+ operator_id: string;
799
+ }
800
+ export interface UserStatsFieldsQueryAttendanceArchiveRuleQuery {
801
+ /** 用户 ID 的类型 */
802
+ employee_type: string;
803
+ }
890
804
  export interface UserStatsFieldsQueryAttendanceArchiveRuleResponse {
891
805
  /** 统计数据表头 */
892
806
  archive_report_fields?: ArchiveField[];
893
807
  }
808
+ export interface UploadReportAttendanceArchiveRuleRequest {
809
+ /** 月份 */
810
+ month: string;
811
+ /** 操作者ID */
812
+ operator_id: string;
813
+ /** 归档报表内容(不超过50个) */
814
+ archive_report_datas?: ArchiveReportData[];
815
+ /** 归档规则id */
816
+ archive_rule_id: string;
817
+ }
818
+ export interface UploadReportAttendanceArchiveRuleQuery {
819
+ /** 用户 ID 的类型 */
820
+ employee_type: string;
821
+ }
894
822
  export interface UploadReportAttendanceArchiveRuleResponse {
895
823
  /** 无效的code */
896
824
  invalid_code?: string[];
897
825
  /** 无效的member_id */
898
826
  invalid_member_id?: string[];
899
827
  }
828
+ export interface DelReportAttendanceArchiveRuleRequest {
829
+ /** 月份 */
830
+ month: string;
831
+ /** 操作者ID */
832
+ operator_id: string;
833
+ /** 归档规则id */
834
+ archive_rule_id: string;
835
+ /** 用户id */
836
+ user_ids?: string[];
837
+ }
838
+ export interface DelReportAttendanceArchiveRuleQuery {
839
+ /** 员工工号类型 */
840
+ employee_type: string;
841
+ }
842
+ export interface BatchCreateAttendanceUserFlowRequest {
843
+ /** 打卡流水记录列表 */
844
+ flow_records: UserFlow[];
845
+ }
846
+ export interface BatchCreateAttendanceUserFlowQuery {
847
+ /** 请求体和响应体中的 user_id 和 creator_id 的员工工号类型 */
848
+ employee_type: 'employee_id' | 'employee_no';
849
+ }
900
850
  export interface BatchCreateAttendanceUserFlowResponse {
901
851
  /** 打卡流水记录列表 */
902
852
  flow_records?: UserFlow[];
903
853
  }
854
+ export interface GetAttendanceUserFlowQuery {
855
+ /** 响应体中的 user_id 和 creator_id 的员工工号类型 */
856
+ employee_type: 'employee_id' | 'employee_no';
857
+ }
858
+ export declare const enum GetAttendanceUserFlowResponseType {
859
+ /** 用户自己打卡 */
860
+ Self = 0,
861
+ /** 管理员修改 */
862
+ ManagerModification = 1,
863
+ /** 用户补卡 */
864
+ Remedy = 2,
865
+ /** 系统自动生成 */
866
+ System = 3,
867
+ /** 下班免打卡 */
868
+ Free = 4,
869
+ /** 考勤机 */
870
+ Machine = 5,
871
+ /** 极速打卡 */
872
+ Quick = 6,
873
+ /** 考勤开放平台导入 */
874
+ Import = 7
875
+ }
904
876
  export interface GetAttendanceUserFlowResponse {
905
877
  /** 用户工号 */
906
878
  user_id: string;
@@ -923,7 +895,7 @@ export interface GetAttendanceUserFlowResponse {
923
895
  /** 是否为wifi打卡 */
924
896
  is_wifi?: boolean;
925
897
  /** 记录生成方式 */
926
- type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
898
+ type?: GetAttendanceUserFlowResponseType;
927
899
  /** 打卡照片列表 */
928
900
  photo_urls?: string[];
929
901
  /** 打卡设备ID */
@@ -935,10 +907,42 @@ export interface GetAttendanceUserFlowResponse {
935
907
  /** 唯一幂等键 */
936
908
  idempotent_id?: string;
937
909
  }
910
+ export interface QueryAttendanceUserFlowRequest {
911
+ /** employee_no 或 employee_id 列表,长度不超过 50 */
912
+ user_ids: string[];
913
+ /** 查询的起始时间,时间戳 */
914
+ check_time_from: string;
915
+ /** 查询的结束时间,时间戳 */
916
+ check_time_to: string;
917
+ }
918
+ export interface QueryAttendanceUserFlowQuery {
919
+ /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */
920
+ employee_type: 'employee_id' | 'employee_no';
921
+ /** 由于新入职用户可以复用已离职用户的employee_no/employee_id。如果true,返回employee_no/employee_id对应的所有在职+离职用户数据;如果false,只返回employee_no/employee_id对应的在职或最近一个离职用户数据 */
922
+ include_terminated_user?: boolean;
923
+ }
938
924
  export interface QueryAttendanceUserFlowResponse {
939
925
  /** 打卡记录列表 */
940
926
  user_flow_results?: UserFlow[];
941
927
  }
928
+ export interface QueryAttendanceUserTaskRequest {
929
+ /** employee_no 或 employee_id 列表 */
930
+ user_ids: string[];
931
+ /** 查询的起始工作日 */
932
+ check_date_from: number;
933
+ /** 查询的结束工作日 */
934
+ check_date_to: number;
935
+ /** 是否需要加班班段打卡结果 */
936
+ need_overtime_result?: boolean;
937
+ }
938
+ export interface QueryAttendanceUserTaskQuery {
939
+ /** 员工工号类型 */
940
+ employee_type: 'employee_id' | 'employee_no';
941
+ /** 是否忽略无效和没有权限的用户。如果 true,则返回有效用户的信息,并告知无效和没有权限的用户信息;如果 false,且 user_ids 中存在无效或没有权限的用户,则返回错误 */
942
+ ignore_invalid_users?: boolean;
943
+ /** 由于新入职员工可以复用已离职员工的 employee_no/employee_id,如果 true,则返回 employee_no/employee_id 对应的所有在职 + 离职员工的数据;如果 false,则只返回 employee_no/employee_id 对应的在职或最近一个离职员工的数据 */
944
+ include_terminated_user?: boolean;
945
+ }
942
946
  export interface QueryAttendanceUserTaskResponse {
943
947
  /** 打卡任务列表 */
944
948
  user_task_results?: UserTask[];
@@ -947,10 +951,48 @@ export interface QueryAttendanceUserTaskResponse {
947
951
  /** 没有权限用户工号列表 */
948
952
  unauthorized_user_ids?: string[];
949
953
  }
954
+ export interface GetAttendanceLeaveEmployExpireRecordRequest {
955
+ /** 员工ID */
956
+ employment_id: string;
957
+ /** 假期类型ID */
958
+ leave_type_id: string;
959
+ /** 失效最早日期 2023-04-10 格式 */
960
+ start_expiration_date: string;
961
+ /** 失效最晚日期 2023-05-10 格式 */
962
+ end_expiration_date: string;
963
+ /** 时间偏移,东八区:480 8*60, 如果没有这个参数,默认东八区 */
964
+ time_offset?: number;
965
+ }
966
+ export interface GetAttendanceLeaveEmployExpireRecordQuery {
967
+ /** 用户 ID 类型 */
968
+ user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id';
969
+ }
950
970
  export interface GetAttendanceLeaveEmployExpireRecordResponse {
951
971
  /** 员工过期日期的授予记录 */
952
972
  records: LeaveEmployExpireRecord[];
953
973
  }
974
+ export interface PatchAttendanceLeaveAccrualRecordRequest {
975
+ /** 授予记录的唯一ID */
976
+ leave_granting_record_id: string;
977
+ /** 员工ID */
978
+ employment_id: string;
979
+ /** 假期类型ID */
980
+ leave_type_id: string;
981
+ /** 修改授予记录原因 */
982
+ reason: LangText[];
983
+ /** 时间偏移,东八区:480 8*60 */
984
+ time_offset?: number;
985
+ /** 失效日期,格式"2020-01-01" */
986
+ expiration_date?: string;
987
+ /** 修改source 余额 */
988
+ quantity?: string;
989
+ /** 是否参与清算 */
990
+ section_type?: number;
991
+ }
992
+ export interface PatchAttendanceLeaveAccrualRecordQuery {
993
+ /** 用户 ID 类型 */
994
+ user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id';
995
+ }
954
996
  export interface PatchAttendanceLeaveAccrualRecordResponse {
955
997
  /** 员工过期日期的授予记录 */
956
998
  record: LeaveAccrualRecord;