@satorijs/adapter-lark 3.9.1 → 3.9.2

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