@satorijs/adapter-lark 3.10.6 → 3.11.1

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 (119) hide show
  1. package/lib/content.d.ts +211 -93
  2. package/lib/index.cjs +2954 -2474
  3. package/lib/internal.d.ts +4 -4
  4. package/lib/message.d.ts +2 -3
  5. package/lib/types/acs.d.ts +212 -172
  6. package/lib/types/admin.d.ts +331 -291
  7. package/lib/types/aily.d.ts +331 -216
  8. package/lib/types/apaas.d.ts +646 -494
  9. package/lib/types/application.d.ts +559 -458
  10. package/lib/types/approval.d.ts +826 -791
  11. package/lib/types/attendance.d.ts +1094 -994
  12. package/lib/types/auth.d.ts +66 -61
  13. package/lib/types/authen.d.ts +221 -186
  14. package/lib/types/baike.d.ts +258 -233
  15. package/lib/types/base.d.ts +74 -0
  16. package/lib/types/bitable.d.ts +830 -770
  17. package/lib/types/board.d.ts +29 -14
  18. package/lib/types/calendar.d.ts +660 -605
  19. package/lib/types/cardkit.d.ts +149 -134
  20. package/lib/types/compensation.d.ts +84 -49
  21. package/lib/types/contact.d.ts +1279 -1204
  22. package/lib/types/corehr.d.ts +4982 -4526
  23. package/lib/types/directory.d.ts +447 -0
  24. package/lib/types/docs.d.ts +28 -18
  25. package/lib/types/document_ai.d.ts +347 -252
  26. package/lib/types/docx.d.ts +428 -383
  27. package/lib/types/drive.d.ts +1093 -1048
  28. package/lib/types/ehr.d.ts +66 -51
  29. package/lib/types/event.d.ts +16 -6
  30. package/lib/types/helpdesk.d.ts +816 -741
  31. package/lib/types/hire.d.ts +3955 -3589
  32. package/lib/types/human_authentication.d.ts +32 -22
  33. package/lib/types/im.d.ts +1420 -1295
  34. package/lib/types/index.d.ts +1422 -330
  35. package/lib/types/lingo.d.ts +279 -249
  36. package/lib/types/mail.d.ts +1032 -675
  37. package/lib/types/mdm.d.ts +105 -37
  38. package/lib/types/minutes.d.ts +73 -26
  39. package/lib/types/moments.d.ts +23 -13
  40. package/lib/types/okr.d.ts +266 -225
  41. package/lib/types/optical_char_recognition.d.ts +22 -12
  42. package/lib/types/passport.d.ts +58 -48
  43. package/lib/types/payroll.d.ts +210 -53
  44. package/lib/types/performance.d.ts +463 -414
  45. package/lib/types/personal_settings.d.ts +93 -82
  46. package/lib/types/report.d.ts +79 -58
  47. package/lib/types/search.d.ts +265 -235
  48. package/lib/types/security_and_compliance.d.ts +30 -19
  49. package/lib/types/sheets.d.ts +356 -321
  50. package/lib/types/speech_to_text.d.ts +44 -34
  51. package/lib/types/task.d.ts +998 -1087
  52. package/lib/types/tenant.d.ts +25 -15
  53. package/lib/types/translation.d.ts +42 -32
  54. package/lib/types/trust_party.d.ts +81 -0
  55. package/lib/types/vc.d.ts +1218 -1123
  56. package/lib/types/verification.d.ts +11 -6
  57. package/lib/types/wiki.d.ts +270 -235
  58. package/lib/types/workplace.d.ts +58 -38
  59. package/lib/utils.d.ts +2 -2
  60. package/package.json +4 -4
  61. package/src/bot.ts +15 -15
  62. package/src/content.ts +230 -107
  63. package/src/internal.ts +29 -12
  64. package/src/message.ts +82 -111
  65. package/src/types/acs.ts +234 -186
  66. package/src/types/admin.ts +353 -305
  67. package/src/types/aily.ts +375 -233
  68. package/src/types/apaas.ts +754 -568
  69. package/src/types/application.ts +633 -507
  70. package/src/types/approval.ts +914 -872
  71. package/src/types/attendance.ts +1226 -1104
  72. package/src/types/auth.ts +72 -66
  73. package/src/types/authen.ts +233 -191
  74. package/src/types/baike.ts +276 -246
  75. package/src/types/base.ts +93 -0
  76. package/src/types/bitable.ts +966 -894
  77. package/src/types/board.ts +34 -16
  78. package/src/types/calendar.ts +751 -685
  79. package/src/types/cardkit.ts +164 -146
  80. package/src/types/compensation.ts +97 -55
  81. package/src/types/contact.ts +1465 -1375
  82. package/src/types/corehr.ts +5664 -5077
  83. package/src/types/directory.ts +569 -0
  84. package/src/types/docs.ts +31 -19
  85. package/src/types/document_ai.ts +401 -287
  86. package/src/types/docx.ts +492 -438
  87. package/src/types/drive.ts +1266 -1213
  88. package/src/types/ehr.ts +71 -53
  89. package/src/types/event.ts +19 -7
  90. package/src/types/helpdesk.ts +930 -840
  91. package/src/types/hire.ts +4453 -4019
  92. package/src/types/human_authentication.ts +35 -23
  93. package/src/types/im.ts +1626 -1476
  94. package/src/types/index.ts +1532 -346
  95. package/src/types/lingo.ts +299 -263
  96. package/src/types/mail.ts +1231 -779
  97. package/src/types/mdm.ts +122 -39
  98. package/src/types/minutes.ts +88 -28
  99. package/src/types/moments.ts +26 -14
  100. package/src/types/okr.ts +286 -238
  101. package/src/types/optical_char_recognition.ts +25 -13
  102. package/src/types/passport.ts +62 -50
  103. package/src/types/payroll.ts +254 -57
  104. package/src/types/performance.ts +528 -467
  105. package/src/types/personal_settings.ts +101 -89
  106. package/src/types/report.ts +86 -62
  107. package/src/types/search.ts +285 -249
  108. package/src/types/security_and_compliance.ts +33 -21
  109. package/src/types/sheets.ts +421 -379
  110. package/src/types/speech_to_text.ts +48 -36
  111. package/src/types/task.ts +1152 -1260
  112. package/src/types/tenant.ts +29 -17
  113. package/src/types/translation.ts +46 -34
  114. package/src/types/trust_party.ts +110 -0
  115. package/src/types/vc.ts +1397 -1283
  116. package/src/types/verification.ts +13 -7
  117. package/src/types/wiki.ts +293 -251
  118. package/src/types/workplace.ts +65 -41
  119. package/src/utils.ts +3 -3
@@ -1,87 +1,98 @@
1
- import { SystemStatus, SystemStatusI18nName, SystemStatusSyncSetting, SystemStatusUserCloseResultEntity, SystemStatusUserOpenParam, SystemStatusUserOpenResultEntity } from '.';
1
+ import * as Lark from '.';
2
+ import { Paginated, Pagination } from '../internal';
2
3
  declare module '../internal' {
3
4
  interface Internal {
4
- /**
5
- * 创建系统状态
6
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/create
7
- */
8
- createPersonalSettingsSystemStatus(body: CreatePersonalSettingsSystemStatusRequest): Promise<CreatePersonalSettingsSystemStatusResponse>;
9
- /**
10
- * 删除系统状态
11
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/delete
12
- */
13
- deletePersonalSettingsSystemStatus(system_status_id: string): Promise<void>;
14
- /**
15
- * 修改系统状态
16
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/patch
17
- */
18
- patchPersonalSettingsSystemStatus(system_status_id: string, body: PatchPersonalSettingsSystemStatusRequest): Promise<PatchPersonalSettingsSystemStatusResponse>;
19
- /**
20
- * 获取系统状态
21
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list
22
- */
23
- listPersonalSettingsSystemStatus(query?: Pagination): Paginated<SystemStatus>;
24
- /**
25
- * 批量开启系统状态
26
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open
27
- */
28
- batchOpenPersonalSettingsSystemStatus(system_status_id: string, body: BatchOpenPersonalSettingsSystemStatusRequest, query?: BatchOpenPersonalSettingsSystemStatusQuery): Promise<BatchOpenPersonalSettingsSystemStatusResponse>;
29
- /**
30
- * 批量关闭系统状态
31
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_close
32
- */
33
- batchClosePersonalSettingsSystemStatus(system_status_id: string, body: BatchClosePersonalSettingsSystemStatusRequest, query?: BatchClosePersonalSettingsSystemStatusQuery): Promise<BatchClosePersonalSettingsSystemStatusResponse>;
5
+ personalSettings: PersonalSettings.Methods;
34
6
  }
35
7
  }
36
- export interface CreatePersonalSettingsSystemStatusRequest {
37
- /** 系统状态名称,名称字符数要在1到20范围内。 */
38
- title: string;
39
- /** 系统状态国际化名称,名称字符数要在1到20范围内。 */
40
- i18n_title?: SystemStatusI18nName;
41
- /** 图标 */
42
- icon_key: 'GeneralDoNotDisturb' | 'GeneralInMeetingBusy' | 'Coffee' | 'GeneralBusinessTrip' | 'GeneralWorkFromHome' | 'StatusEnjoyLife' | 'GeneralTravellingCar' | 'StatusBus' | 'StatusInFlight' | 'Typing' | 'EatingFood' | 'SICK' | 'GeneralSun' | 'GeneralMoonRest' | 'StatusReading' | 'Status_PrivateMessage' | 'StatusFlashOfInspiration' | 'GeneralVacation';
43
- /** 颜色 */
44
- color?: 'BLUE' | 'GRAY' | 'INDIGO' | 'WATHET' | 'GREEN' | 'TURQUOISE' | 'YELLOW' | 'LIME' | 'RED' | 'ORANGE' | 'PURPLE' | 'VIOLET' | 'CARMINE';
45
- /** 优先级,数值越小,客户端展示的优先级越高。不同系统状态的优先级不能一样。 */
46
- priority?: number;
47
- /** 同步设置 */
48
- sync_setting?: SystemStatusSyncSetting;
49
- }
50
- export interface CreatePersonalSettingsSystemStatusResponse {
51
- /** 系统状态 */
52
- system_status?: SystemStatus;
53
- }
54
- export interface PatchPersonalSettingsSystemStatusRequest {
55
- /** 系统状态 */
56
- system_status: SystemStatus;
57
- /** 需要更新的字段 */
58
- update_fields: ('TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING')[];
59
- }
60
- export interface PatchPersonalSettingsSystemStatusResponse {
61
- /** 系统状态 */
62
- system_status?: SystemStatus;
63
- }
64
- export interface BatchOpenPersonalSettingsSystemStatusRequest {
65
- /** 开启列表 */
66
- user_list: SystemStatusUserOpenParam[];
67
- }
68
- export interface BatchOpenPersonalSettingsSystemStatusQuery {
69
- /** 用户id类型 open_id/user_id/union_id */
70
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
71
- }
72
- export interface BatchOpenPersonalSettingsSystemStatusResponse {
73
- /** 开启结果 */
74
- result_list: SystemStatusUserOpenResultEntity[];
75
- }
76
- export interface BatchClosePersonalSettingsSystemStatusRequest {
77
- /** 成员列表 */
78
- user_list: string[];
79
- }
80
- export interface BatchClosePersonalSettingsSystemStatusQuery {
81
- /** 用户id类型 open_id/user_id/union_id */
82
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
83
- }
84
- export interface BatchClosePersonalSettingsSystemStatusResponse {
85
- /** 关闭结果 */
86
- result_list: SystemStatusUserCloseResultEntity[];
8
+ export declare namespace PersonalSettings {
9
+ interface Methods {
10
+ systemStatus: SystemStatus.Methods;
11
+ }
12
+ namespace SystemStatus {
13
+ interface Methods {
14
+ /**
15
+ * 创建系统状态
16
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/create
17
+ */
18
+ create(body: CreateRequest): Promise<CreateResponse>;
19
+ /**
20
+ * 删除系统状态
21
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/delete
22
+ */
23
+ delete(system_status_id: string): Promise<void>;
24
+ /**
25
+ * 修改系统状态
26
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/patch
27
+ */
28
+ patch(system_status_id: string, body: PatchRequest): Promise<PatchResponse>;
29
+ /**
30
+ * 获取系统状态
31
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list
32
+ */
33
+ list(query?: Pagination): Paginated<Lark.SystemStatus>;
34
+ /**
35
+ * 批量开启系统状态
36
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open
37
+ */
38
+ batchOpen(system_status_id: string, body: BatchOpenRequest, query?: BatchOpenQuery): Promise<BatchOpenResponse>;
39
+ /**
40
+ * 批量关闭系统状态
41
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_close
42
+ */
43
+ batchClose(system_status_id: string, body: BatchCloseRequest, query?: BatchCloseQuery): Promise<BatchCloseResponse>;
44
+ }
45
+ interface CreateRequest {
46
+ /** 系统状态名称,名称字符数要在1到20范围内。 */
47
+ title: string;
48
+ /** 系统状态国际化名称,名称字符数要在1到20范围内。 */
49
+ i18n_title?: Lark.SystemStatusI18nName;
50
+ /** 图标 */
51
+ icon_key: 'GeneralDoNotDisturb' | 'GeneralInMeetingBusy' | 'Coffee' | 'GeneralBusinessTrip' | 'GeneralWorkFromHome' | 'StatusEnjoyLife' | 'GeneralTravellingCar' | 'StatusBus' | 'StatusInFlight' | 'Typing' | 'EatingFood' | 'SICK' | 'GeneralSun' | 'GeneralMoonRest' | 'StatusReading' | 'Status_PrivateMessage' | 'StatusFlashOfInspiration' | 'GeneralVacation';
52
+ /** 颜色 */
53
+ color?: 'BLUE' | 'GRAY' | 'INDIGO' | 'WATHET' | 'GREEN' | 'TURQUOISE' | 'YELLOW' | 'LIME' | 'RED' | 'ORANGE' | 'PURPLE' | 'VIOLET' | 'CARMINE';
54
+ /** 优先级,数值越小,客户端展示的优先级越高。不同系统状态的优先级不能一样。 */
55
+ priority?: number;
56
+ /** 同步设置 */
57
+ sync_setting?: Lark.SystemStatusSyncSetting;
58
+ }
59
+ interface CreateResponse {
60
+ /** 系统状态 */
61
+ system_status?: Lark.SystemStatus;
62
+ }
63
+ interface PatchRequest {
64
+ /** 系统状态 */
65
+ system_status: Lark.SystemStatus;
66
+ /** 需要更新的字段 */
67
+ update_fields: ('TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING')[];
68
+ }
69
+ interface PatchResponse {
70
+ /** 系统状态 */
71
+ system_status?: Lark.SystemStatus;
72
+ }
73
+ interface BatchOpenRequest {
74
+ /** 开启列表 */
75
+ user_list: Lark.SystemStatusUserOpenParam[];
76
+ }
77
+ interface BatchOpenQuery {
78
+ /** 用户id类型 open_id/user_id/union_id */
79
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
80
+ }
81
+ interface BatchOpenResponse {
82
+ /** 开启结果 */
83
+ result_list: Lark.SystemStatusUserOpenResultEntity[];
84
+ }
85
+ interface BatchCloseRequest {
86
+ /** 成员列表 */
87
+ user_list: string[];
88
+ }
89
+ interface BatchCloseQuery {
90
+ /** 用户id类型 open_id/user_id/union_id */
91
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
92
+ }
93
+ interface BatchCloseResponse {
94
+ /** 关闭结果 */
95
+ result_list: Lark.SystemStatusUserCloseResultEntity[];
96
+ }
97
+ }
87
98
  }
@@ -1,63 +1,84 @@
1
- import { Rule, Task } from '.';
1
+ import * as Lark from '.';
2
+ import { Paginated } from '../internal';
2
3
  declare module '../internal' {
3
4
  interface Internal {
4
- /**
5
- * 查询规则
6
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule/query
7
- */
8
- queryReportRule(query?: QueryReportRuleQuery): Promise<QueryReportRuleResponse>;
9
- /**
10
- * 移除规则看板
11
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule-view/remove
12
- */
13
- removeReportRuleView(rule_id: string, body: RemoveReportRuleViewRequest, query?: RemoveReportRuleViewQuery): Promise<void>;
14
- /**
15
- * 查询任务
16
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query
17
- */
18
- queryReportTask(body: QueryReportTaskRequest, query?: QueryReportTaskQuery): Paginated<Task>;
5
+ report: Report.Methods;
19
6
  }
20
7
  }
21
- export declare const enum QueryReportRuleQueryIncludeDeleted {
22
- /** 不包括已删除 */
23
- Exclude = 0,
24
- /** 包括已删除 */
25
- Include = 1
26
- }
27
- export interface QueryReportRuleQuery {
28
- /** 规则名称 */
29
- rule_name: string;
30
- /** 是否包括已删除,默认未删除 */
31
- include_deleted?: QueryReportRuleQueryIncludeDeleted;
32
- /** 此次调用中使用的用户ID的类型 */
33
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
34
- }
35
- export interface QueryReportRuleResponse {
36
- /** 规则列表 */
37
- rules?: Rule[];
38
- }
39
- export interface RemoveReportRuleViewRequest {
40
- /** 列表为空删除规则下全用户视图,列表不为空删除指定用户视图,大小限制200。 */
41
- user_ids?: string[];
42
- }
43
- export interface RemoveReportRuleViewQuery {
44
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
45
- }
46
- export interface QueryReportTaskRequest {
47
- /** 提交开始时间时间戳 */
48
- commit_start_time: number;
49
- /** 提交结束时间时间戳 */
50
- commit_end_time: number;
51
- /** 汇报规则ID */
52
- rule_id?: string;
53
- /** 用户ID */
54
- user_id?: string;
55
- /** 分页标识符 */
56
- page_token: string;
57
- /** 单次分页返回的条数 */
58
- page_size: number;
59
- }
60
- export interface QueryReportTaskQuery {
61
- /** 此次调用中使用的用户ID的类型 */
62
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
8
+ export declare namespace Report {
9
+ interface Methods {
10
+ rule: Rule.Methods;
11
+ task: Task.Methods;
12
+ }
13
+ namespace Rule {
14
+ interface Methods {
15
+ view: View.Methods;
16
+ /**
17
+ * 查询规则
18
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule/query
19
+ */
20
+ query(query?: QueryQuery): Promise<QueryResponse>;
21
+ }
22
+ const enum QueryQueryIncludeDeleted {
23
+ /** 不包括已删除 */
24
+ Exclude = 0,
25
+ /** 包括已删除 */
26
+ Include = 1
27
+ }
28
+ interface QueryQuery {
29
+ /** 规则名称 */
30
+ rule_name: string;
31
+ /** 是否包括已删除,默认未删除 */
32
+ include_deleted?: QueryQueryIncludeDeleted;
33
+ /** 此次调用中使用的用户ID的类型 */
34
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
35
+ }
36
+ interface QueryResponse {
37
+ /** 规则列表 */
38
+ rules?: Lark.Rule[];
39
+ }
40
+ namespace View {
41
+ interface Methods {
42
+ /**
43
+ * 移除规则看板
44
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule-view/remove
45
+ */
46
+ remove(rule_id: string, body: RemoveRequest, query?: RemoveQuery): Promise<void>;
47
+ }
48
+ interface RemoveRequest {
49
+ /** 列表为空删除规则下全用户视图,列表不为空删除指定用户视图,大小限制200。 */
50
+ user_ids?: string[];
51
+ }
52
+ interface RemoveQuery {
53
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
54
+ }
55
+ }
56
+ }
57
+ namespace Task {
58
+ interface Methods {
59
+ /**
60
+ * 查询任务
61
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query
62
+ */
63
+ query(body: QueryRequest, query?: QueryQuery): Paginated<Lark.Task>;
64
+ }
65
+ interface QueryRequest {
66
+ /** 提交开始时间时间戳 */
67
+ commit_start_time: number;
68
+ /** 提交结束时间时间戳 */
69
+ commit_end_time: number;
70
+ /** 汇报规则ID */
71
+ rule_id?: string;
72
+ /** 用户ID */
73
+ user_id?: string;
74
+ /** 分页标识符 */
75
+ page_token: string;
76
+ /** 单次分页返回的条数 */
77
+ page_size: number;
78
+ }
79
+ interface QueryQuery {
80
+ /** 此次调用中使用的用户ID的类型 */
81
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
82
+ }
83
+ }
63
84
  }