@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
@@ -416,7 +416,13 @@ export declare namespace Mail {
416
416
  name?: string;
417
417
  /** The mail group's description */
418
418
  description?: string;
419
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
419
+ /**
420
+ * Who can send mail to this mail group. Possible values are:
421
+ * - ANYONE: Any Internet user can send mail to this mail group
422
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
423
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
424
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
425
+ */
420
426
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
421
427
  }
422
428
  interface CreateResponse {
@@ -434,7 +440,13 @@ export declare namespace Mail {
434
440
  include_external_member?: boolean;
435
441
  /** Value is true if all company members are in this mail group */
436
442
  include_all_company_member?: boolean;
437
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
443
+ /**
444
+ * Who can send mail to this mail group. Possible values are:
445
+ * - ANYONE: Any Internet user can send mail to this mail group
446
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
447
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
448
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
449
+ */
438
450
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
439
451
  }
440
452
  interface PatchRequest {
@@ -444,7 +456,13 @@ export declare namespace Mail {
444
456
  name?: string;
445
457
  /** The mail group's description */
446
458
  description?: string;
447
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
459
+ /**
460
+ * Who can send mail to this mail group. Possible values are:
461
+ * - ANYONE: Any Internet user can send mail to this mail group
462
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
463
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
464
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
465
+ */
448
466
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
449
467
  }
450
468
  interface PatchResponse {
@@ -462,7 +480,13 @@ export declare namespace Mail {
462
480
  include_external_member?: boolean;
463
481
  /** Value is true if all company members are in this mail group */
464
482
  include_all_company_member?: boolean;
465
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
483
+ /**
484
+ * Who can send mail to this mail group. Possible values are:
485
+ * - ANYONE: Any Internet user can send mail to this mail group
486
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
487
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
488
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
489
+ */
466
490
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
467
491
  }
468
492
  interface UpdateRequest {
@@ -472,7 +496,13 @@ export declare namespace Mail {
472
496
  name?: string;
473
497
  /** The mail group's description */
474
498
  description?: string;
475
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
499
+ /**
500
+ * Who can send mail to this mail group. Possible values are:
501
+ * - ANYONE: Any Internet user can send mail to this mail group
502
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
503
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
504
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
505
+ */
476
506
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
477
507
  }
478
508
  interface UpdateResponse {
@@ -490,7 +520,13 @@ export declare namespace Mail {
490
520
  include_external_member?: boolean;
491
521
  /** Value is true if all company members are in this mail group */
492
522
  include_all_company_member?: boolean;
493
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
523
+ /**
524
+ * Who can send mail to this mail group. Possible values are:
525
+ * - ANYONE: Any Internet user can send mail to this mail group
526
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
527
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
528
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
529
+ */
494
530
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
495
531
  }
496
532
  interface GetResponse {
@@ -508,7 +544,13 @@ export declare namespace Mail {
508
544
  include_external_member?: boolean;
509
545
  /** Value is true if all company members are in this mail group */
510
546
  include_all_company_member?: boolean;
511
- /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
547
+ /**
548
+ * Who can send mail to this mail group. Possible values are:
549
+ * - ANYONE: Any Internet user can send mail to this mail group
550
+ * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
551
+ * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
552
+ * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
553
+ */
512
554
  who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
513
555
  }
514
556
  interface ListQuery extends Pagination {
@@ -596,7 +638,16 @@ export declare namespace Mail {
596
638
  user_id?: string;
597
639
  /** The member's department id. Value is valid when type is DEPARTMENT */
598
640
  department_id?: string;
599
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
641
+ /**
642
+ * The type of member. Possible values are:
643
+ * - USER: internal user in the team
644
+ * - DEPARTMENT: member is a department
645
+ * - COMPANY: member is the company
646
+ * - EXTERNAL_USER: internet user outside the organization
647
+ * - MAIL_GROUP: member is another mail group
648
+ * - PUBLIC_MAILBOX: member is a public mailbox
649
+ * - OTHER_MEMBER: other internal member
650
+ */
600
651
  type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER';
601
652
  }
602
653
  interface CreateQuery {
@@ -614,7 +665,16 @@ export declare namespace Mail {
614
665
  user_id?: string;
615
666
  /** The member's department id. Value is valid when type is DEPARTMENT */
616
667
  department_id?: string;
617
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
668
+ /**
669
+ * The type of member. Possible values are:
670
+ * - USER: internal user in the team
671
+ * - DEPARTMENT: member is a department
672
+ * - COMPANY: member is the company
673
+ * - EXTERNAL_USER: internet user outside the organization
674
+ * - MAIL_GROUP: member is another mail group
675
+ * - PUBLIC_MAILBOX: member is a public mailbox
676
+ * - OTHER_MEMBER: other internal member
677
+ */
618
678
  type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER';
619
679
  }
620
680
  interface GetQuery {
@@ -632,7 +692,16 @@ export declare namespace Mail {
632
692
  user_id?: string;
633
693
  /** The member's department id. Value is valid when type is DEPARTMENT */
634
694
  department_id?: string;
635
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
695
+ /**
696
+ * The type of member. Possible values are:
697
+ * - USER: internal user in the team
698
+ * - DEPARTMENT: member is a department
699
+ * - COMPANY: member is the company
700
+ * - EXTERNAL_USER: internet user outside the organization
701
+ * - MAIL_GROUP: member is another mail group
702
+ * - PUBLIC_MAILBOX: member is a public mailbox
703
+ * - OTHER_MEMBER: other internal member
704
+ */
636
705
  type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER';
637
706
  }
638
707
  interface ListQuery extends Pagination {
@@ -731,7 +800,11 @@ export declare namespace Mail {
731
800
  department_id?: string;
732
801
  /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
733
802
  email?: string;
734
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
803
+ /**
804
+ * The type of member. Possible values are:
805
+ * - USER: internal user in the team
806
+ * - DEPARTMENT: member is a department
807
+ */
735
808
  type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX';
736
809
  }
737
810
  interface CreateQuery {
@@ -749,7 +822,11 @@ export declare namespace Mail {
749
822
  department_id?: string;
750
823
  /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
751
824
  email?: string;
752
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
825
+ /**
826
+ * The type of member. Possible values are:
827
+ * - USER: internal user in the team
828
+ * - DEPARTMENT: member is a department
829
+ */
753
830
  type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX';
754
831
  }
755
832
  interface GetQuery {
@@ -767,7 +844,11 @@ export declare namespace Mail {
767
844
  department_id?: string;
768
845
  /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
769
846
  email?: string;
770
- /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
847
+ /**
848
+ * The type of member. Possible values are:
849
+ * - USER: internal user in the team
850
+ * - DEPARTMENT: member is a department
851
+ */
771
852
  type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX';
772
853
  }
773
854
  interface ListQuery extends Pagination {
@@ -937,7 +1018,10 @@ export declare namespace Mail {
937
1018
  interface CreateRequest {
938
1019
  /** The member's user id. Value is valid when type is USER */
939
1020
  user_id?: string;
940
- /** The type of member. Possible values are:- USER: internal user in the team */
1021
+ /**
1022
+ * The type of member. Possible values are:
1023
+ * - USER: internal user in the team
1024
+ */
941
1025
  type?: 'USER';
942
1026
  }
943
1027
  interface CreateQuery {
@@ -949,7 +1033,10 @@ export declare namespace Mail {
949
1033
  member_id?: string;
950
1034
  /** The member's user id. Value is valid when type is USER */
951
1035
  user_id?: string;
952
- /** The type of member. Possible values are:- USER: internal user in the team */
1036
+ /**
1037
+ * The type of member. Possible values are:
1038
+ * - USER: internal user in the team
1039
+ */
953
1040
  type?: 'USER';
954
1041
  }
955
1042
  interface GetQuery {
@@ -961,7 +1048,10 @@ export declare namespace Mail {
961
1048
  member_id?: string;
962
1049
  /** The member's user id. Value is valid when type is USER */
963
1050
  user_id?: string;
964
- /** The type of member. Possible values are:- USER: internal user in the team */
1051
+ /**
1052
+ * The type of member. Possible values are:
1053
+ * - USER: internal user in the team
1054
+ */
965
1055
  type?: 'USER';
966
1056
  }
967
1057
  interface ListQuery extends Pagination {
@@ -7,15 +7,101 @@ declare module '../internal' {
7
7
  }
8
8
  export declare namespace Payroll {
9
9
  interface Methods {
10
+ acctItem: AcctItem.Methods;
11
+ paygroup: Paygroup.Methods;
12
+ datasource: Datasource.Methods;
13
+ datasourceRecord: DatasourceRecord.Methods;
14
+ paymentActivity: PaymentActivity.Methods;
10
15
  paymentActivityDetail: PaymentActivityDetail.Methods;
11
16
  paymentDetail: PaymentDetail.Methods;
12
- paymentActivity: PaymentActivity.Methods;
13
- datasourceRecord: DatasourceRecord.Methods;
14
- datasource: Datasource.Methods;
15
- acctItem: AcctItem.Methods;
17
+ costAllocationDetail: CostAllocationDetail.Methods;
16
18
  costAllocationReport: CostAllocationReport.Methods;
17
19
  costAllocationPlan: CostAllocationPlan.Methods;
18
- paygroup: Paygroup.Methods;
20
+ }
21
+ namespace AcctItem {
22
+ interface Methods {
23
+ /**
24
+ * 批量查询算薪项
25
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/acct_item/list
26
+ */
27
+ list(query?: Pagination): Paginated<Lark.AcctItem>;
28
+ }
29
+ }
30
+ namespace Paygroup {
31
+ interface Methods {
32
+ /**
33
+ * 获取薪资组基本信息
34
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list
35
+ */
36
+ list(query?: Pagination): Paginated<Lark.Paygroup>;
37
+ }
38
+ }
39
+ namespace Datasource {
40
+ interface Methods {
41
+ /**
42
+ * 获取外部数据源配置信息
43
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource/list
44
+ */
45
+ list(query?: Pagination): Paginated<Lark.Datasource, 'datasources'>;
46
+ }
47
+ }
48
+ namespace DatasourceRecord {
49
+ interface Methods {
50
+ /**
51
+ * 创建 / 更新外部算薪数据
52
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource_record/save
53
+ */
54
+ save(body: SaveRequest): Promise<SaveResponse>;
55
+ /**
56
+ * 批量查询外部算薪数据记录
57
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource_record/query
58
+ */
59
+ query(body: QueryRequest, query?: Pagination): Paginated<Lark.DatasourceRecord, 'records'>;
60
+ }
61
+ interface SaveRequest {
62
+ /** 数据源code */
63
+ source_code: string;
64
+ /** 需保存的记录列表 */
65
+ records: Lark.DatasourceRecord[];
66
+ }
67
+ interface SaveResponse {
68
+ /** 更新的记录条数 */
69
+ affect_counts: string;
70
+ }
71
+ interface QueryRequest {
72
+ /** 数据源编码 */
73
+ source_code: string;
74
+ /** 指定查询的数据源字段。如不传,默认返回所有数据源字段 */
75
+ selected_fields?: string[];
76
+ /** 查询过滤器列表,多个过滤器之间为And关系。本期员工月维度汇总类型数据源,只支持employment_id、payroll_period fieldKey的查询,其中payroll_period必传 */
77
+ field_filters?: Lark.DatasourceRecordFieldFilter[];
78
+ }
79
+ }
80
+ namespace PaymentActivity {
81
+ interface Methods {
82
+ /**
83
+ * 封存发薪活动
84
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/payment_activity/archive
85
+ */
86
+ archive(body: ArchiveRequest): Promise<void>;
87
+ /**
88
+ * 查询发薪活动列表
89
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/payment_activity/list
90
+ */
91
+ list(query?: ListQuery): Paginated<Lark.PaymentActivity, 'payment_activitys'>;
92
+ }
93
+ interface ArchiveRequest {
94
+ /** 发薪活动ID */
95
+ activity_id: string;
96
+ }
97
+ interface ListQuery extends Pagination {
98
+ /** 发薪日开始时间,格式:YYYY-MM-dd,[pay_period_start_date, pay_period_end_date] 是一个左闭右闭区间。 */
99
+ pay_period_start_date: string;
100
+ /** 发薪日结束时间,格式:YYYY-MM-dd,[pay_period_start_date, pay_period_end_date] 是一个左闭右闭区间。 */
101
+ pay_period_end_date: string;
102
+ /** 发薪活动审批状态列表,其中:100-待确认发薪名单;150-待提交审批;200-审批中;300-审批被拒绝;350-审批被撤回;360-审批被撤销;375-审批通过;400-已封存。 */
103
+ statuses?: number[];
104
+ }
19
105
  }
20
106
  namespace PaymentActivityDetail {
21
107
  interface Methods {
@@ -77,80 +163,39 @@ export declare namespace Payroll {
77
163
  total?: number;
78
164
  }
79
165
  }
80
- namespace PaymentActivity {
166
+ namespace CostAllocationDetail {
81
167
  interface Methods {
82
168
  /**
83
- * 封存发薪活动
84
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/payment_activity/archive
85
- */
86
- archive(body: ArchiveRequest): Promise<void>;
87
- /**
88
- * 查询发薪活动列表
89
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/payment_activity/list
169
+ * 查询成本分摊报表明细
170
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_detail/list
90
171
  */
91
- list(query?: ListQuery): Paginated<Lark.PaymentActivity, 'payment_activitys'>;
172
+ list(query?: ListQuery): Promise<ListResponse>;
92
173
  }
93
- interface ArchiveRequest {
94
- /** 发薪活动ID */
95
- activity_id: string;
174
+ const enum ListQueryReportType {
175
+ /** 默认 */
176
+ Default = 0,
177
+ /** 计提 */
178
+ Accrued = 1,
179
+ /** 实发 */
180
+ Paid = 2
96
181
  }
97
182
  interface ListQuery extends Pagination {
98
- /** 发薪日开始时间,格式:YYYY-MM-dd,[pay_period_start_date, pay_period_end_date] 是一个左闭右闭区间。 */
99
- pay_period_start_date: string;
100
- /** 发薪日结束时间,格式:YYYY-MM-dd,[pay_period_start_date, pay_period_end_date] 是一个左闭右闭区间。 */
101
- pay_period_end_date: string;
102
- /** 发薪活动审批状态列表,其中:100-待确认发薪名单;150-待提交审批;200-审批中;300-审批被拒绝;350-审批被撤回;360-审批被撤销;375-审批通过;400-已封存。 */
103
- statuses?: number[];
104
- }
105
- }
106
- namespace DatasourceRecord {
107
- interface Methods {
108
- /**
109
- * 创建 / 更新外部算薪数据
110
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource_record/save
111
- */
112
- save(body: SaveRequest): Promise<SaveResponse>;
113
- /**
114
- * 批量查询外部算薪数据记录
115
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource_record/query
116
- */
117
- query(body: QueryRequest, query?: Pagination): Paginated<Lark.DatasourceRecord, 'records'>;
118
- }
119
- interface SaveRequest {
120
- /** 数据源code */
121
- source_code: string;
122
- /** 需保存的记录列表 */
123
- records: Lark.DatasourceRecord[];
124
- }
125
- interface SaveResponse {
126
- /** 更新的记录条数 */
127
- affect_counts: string;
128
- }
129
- interface QueryRequest {
130
- /** 数据源编码 */
131
- source_code: string;
132
- /** 指定查询的数据源字段。如不传,默认返回所有数据源字段 */
133
- selected_fields?: string[];
134
- /** 查询过滤器列表,多个过滤器之间为And关系。本期员工月维度汇总类型数据源,只支持employment_id、payroll_period fieldKey的查询,其中payroll_period必传 */
135
- field_filters?: Lark.DatasourceRecordFieldFilter[];
136
- }
137
- }
138
- namespace Datasource {
139
- interface Methods {
140
- /**
141
- * 获取外部数据源配置信息
142
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource/list
143
- */
144
- list(query?: Pagination): Paginated<Lark.Datasource, 'datasources'>;
183
+ /** 成本分摊方案ID */
184
+ cost_allocation_plan_id: string;
185
+ /** 期间 */
186
+ pay_period: string;
187
+ /** 报表类型 */
188
+ report_type: ListQueryReportType;
145
189
  }
146
- }
147
- namespace AcctItem {
148
- interface Methods {
149
- /**
150
- * 批量查询算薪项
151
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/acct_item/list
152
- */
153
- list(query?: Pagination): Paginated<Lark.AcctItem>;
190
+ interface ListResponse {
191
+ /** 报表明细数据 */
192
+ cost_allocation_report_datas?: Lark.CostAllocationReportData[];
193
+ /** 报表名称 */
194
+ cost_allocation_report_names?: Lark.I18nContent[];
195
+ /** 期间 */
196
+ pay_period?: string;
197
+ page_token?: string;
198
+ has_more?: boolean;
154
199
  }
155
200
  }
156
201
  namespace CostAllocationReport {
@@ -203,13 +248,4 @@ export declare namespace Payroll {
203
248
  pay_period: string;
204
249
  }
205
250
  }
206
- namespace Paygroup {
207
- interface Methods {
208
- /**
209
- * 获取薪资组基本信息
210
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list
211
- */
212
- list(query?: Pagination): Paginated<Lark.Paygroup>;
213
- }
214
- }
215
251
  }
@@ -212,7 +212,7 @@ export declare namespace Performance {
212
212
  namespace ReviewTemplate {
213
213
  interface Methods {
214
214
  /**
215
- * 获取评估模板配置
215
+ * 获取绩效模板配置
216
216
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_template/query
217
217
  */
218
218
  query(body: QueryRequest, query?: Pagination): Paginated<Lark.ReviewTemplate, 'review_templates'>;
@@ -174,7 +174,10 @@ export declare namespace Search {
174
174
  BASIC = 1
175
175
  }
176
176
  interface ListQuery extends Pagination {
177
- /** 回包数据格式,0-全量数据;1-摘要数据。**注**:摘要数据仅包含"id","name","state"。 */
177
+ /**
178
+ * 回包数据格式,0-全量数据;1-摘要数据。
179
+ * **注**:摘要数据仅包含"id","name","state"。
180
+ */
178
181
  view?: ListQueryView;
179
182
  }
180
183
  namespace Item {