@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
@@ -197,7 +197,10 @@ export declare namespace Acs {
197
197
  interface ListQuery extends Pagination {
198
198
  /** 记录开始时间,单位秒 */
199
199
  from: number;
200
- /** 记录结束时间,单位秒,时间跨度不能超过30天 */
200
+ /**
201
+ * 记录结束时间,单位秒,
202
+ * 时间跨度不能超过30天
203
+ */
201
204
  to: number;
202
205
  /** 门禁设备 ID */
203
206
  device_id?: string;
@@ -62,17 +62,17 @@ export declare namespace Aily {
62
62
  namespace AilyMessage {
63
63
  interface Methods {
64
64
  /**
65
- * 发送智能伙伴消息
65
+ * 发送 Aily 消息
66
66
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create
67
67
  */
68
68
  create(aily_session_id: string, body: CreateRequest): Promise<CreateResponse>;
69
69
  /**
70
- * 获取智能伙伴消息
70
+ * 获取 Aily 消息
71
71
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get
72
72
  */
73
73
  get(aily_session_id: string, aily_message_id: string): Promise<GetResponse>;
74
74
  /**
75
- * 列出智能伙伴消息
75
+ * 列出 Aily 消息
76
76
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list
77
77
  */
78
78
  list(aily_session_id: string, query?: ListQuery): Paginated<Lark.AilyMessage, 'messages'>;
@@ -7,12 +7,23 @@ declare module '../internal' {
7
7
  }
8
8
  export declare namespace Apaas {
9
9
  interface Methods {
10
+ app: App.Methods;
10
11
  seatAssignment: SeatAssignment.Methods;
11
12
  seatActivity: SeatActivity.Methods;
12
13
  application: Application.Methods;
13
14
  userTask: UserTask.Methods;
14
15
  approvalTask: ApprovalTask.Methods;
15
16
  approvalInstance: ApprovalInstance.Methods;
17
+ workspace: Workspace.Methods;
18
+ }
19
+ namespace App {
20
+ interface Methods {
21
+ /**
22
+ * 查看应用基本信息
23
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/app/list
24
+ */
25
+ list(query?: Pagination): Paginated<Lark.App>;
26
+ }
16
27
  }
17
28
  namespace SeatAssignment {
18
29
  interface Methods {
@@ -43,8 +54,8 @@ export declare namespace Apaas {
43
54
  namespace Application {
44
55
  interface Methods {
45
56
  auditLog: AuditLog.Methods;
46
- role: Role.Methods;
47
57
  recordPermission: RecordPermission.Methods;
58
+ role: Role.Methods;
48
59
  object: Object.Methods;
49
60
  function: Function.Methods;
50
61
  environmentVariable: EnvironmentVariable.Methods;
@@ -150,6 +161,33 @@ export declare namespace Apaas {
150
161
  data?: Lark.AuditLogDetail;
151
162
  }
152
163
  }
164
+ namespace RecordPermission {
165
+ interface Methods {
166
+ member: Member.Methods;
167
+ }
168
+ namespace Member {
169
+ interface Methods {
170
+ /**
171
+ * 批量删除记录权限用户授权
172
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_remove_authorization
173
+ */
174
+ batchRemoveAuthorization(namespace: string, record_permission_api_name: string, body: BatchRemoveAuthorizationRequest): Promise<void>;
175
+ /**
176
+ * 批量创建记录权限用户授权
177
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_create_authorization
178
+ */
179
+ batchCreateAuthorization(namespace: string, record_permission_api_name: string, body: BatchCreateAuthorizationRequest): Promise<void>;
180
+ }
181
+ interface BatchRemoveAuthorizationRequest {
182
+ /** 需要删除的用户 ID 列表 */
183
+ user_ids?: string[];
184
+ }
185
+ interface BatchCreateAuthorizationRequest {
186
+ /** 需要新增的用户 ID 列表 */
187
+ user_ids?: string[];
188
+ }
189
+ }
190
+ }
153
191
  namespace Role {
154
192
  interface Methods {
155
193
  member: Member.Methods;
@@ -196,33 +234,6 @@ export declare namespace Apaas {
196
234
  }
197
235
  }
198
236
  }
199
- namespace RecordPermission {
200
- interface Methods {
201
- member: Member.Methods;
202
- }
203
- namespace Member {
204
- interface Methods {
205
- /**
206
- * 批量删除记录权限用户授权
207
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_remove_authorization
208
- */
209
- batchRemoveAuthorization(namespace: string, record_permission_api_name: string, body: BatchRemoveAuthorizationRequest): Promise<void>;
210
- /**
211
- * 批量创建记录权限用户授权
212
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_create_authorization
213
- */
214
- batchCreateAuthorization(namespace: string, record_permission_api_name: string, body: BatchCreateAuthorizationRequest): Promise<void>;
215
- }
216
- interface BatchRemoveAuthorizationRequest {
217
- /** 需要删除的用户 ID 列表 */
218
- user_ids?: string[];
219
- }
220
- interface BatchCreateAuthorizationRequest {
221
- /** 需要新增的用户 ID 列表 */
222
- user_ids?: string[];
223
- }
224
- }
225
- }
226
237
  namespace Object {
227
238
  interface Methods {
228
239
  record: Record.Methods;
@@ -648,4 +659,155 @@ export declare namespace Apaas {
648
659
  opinion: string;
649
660
  }
650
661
  }
662
+ namespace Workspace {
663
+ interface Methods {
664
+ table: Table.Methods;
665
+ view: View.Methods;
666
+ /**
667
+ * 执行SQL
668
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace/sql_commands
669
+ */
670
+ sqlCommands(workspace_id: string, body: SqlCommandsRequest): Promise<SqlCommandsResponse>;
671
+ }
672
+ interface SqlCommandsRequest {
673
+ /** 要执行的 SQL 语句 */
674
+ sql: string;
675
+ }
676
+ interface SqlCommandsResponse {
677
+ /** 如果是 SELECT 命令,返回的是查询结果的 JSON 序列化字符串。如果是其他无返回的命令,如 DELETE 等,result 为空。 */
678
+ result: string;
679
+ }
680
+ namespace Table {
681
+ interface Methods {
682
+ /**
683
+ * 查询数据表数据记录
684
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/records_get
685
+ */
686
+ recordsGet(workspace_id: string, table_name: string, query?: RecordsGetQuery): Promise<RecordsGetResponse>;
687
+ /**
688
+ * 向数据表中添加或更新记录
689
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/records_post
690
+ */
691
+ recordsPost(workspace_id: string, table_name: string, body: RecordsPostRequest, query?: RecordsPostQuery): Promise<RecordsPostResponse>;
692
+ /**
693
+ * 按条件更新数据表中的记录
694
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/records_patch
695
+ */
696
+ recordsPatch(workspace_id: string, table_name: string, body: RecordsPatchRequest, query?: RecordsPatchQuery): Promise<RecordsPatchResponse>;
697
+ /**
698
+ * 批量更新数据表中的记录
699
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/records_batch_update
700
+ */
701
+ recordsBatchUpdate(workspace_id: string, table_name: string, body: RecordsBatchUpdateRequest): Promise<RecordsBatchUpdateResponse>;
702
+ /**
703
+ * 删除数据表中的记录
704
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/records_delete
705
+ */
706
+ recordsDelete(workspace_id: string, table_name: string, query?: RecordsDeleteQuery): Promise<void>;
707
+ }
708
+ interface RecordsGetQuery extends Pagination {
709
+ /**
710
+ * 返回的列,默认为 *,即返回所有列。
711
+ * 遵循 PostgREST 语法,详情可查看 https://docs.postgrest.org/en/v13/references/api/tables_views.html#vertical-filtering
712
+ */
713
+ select?: string;
714
+ /** 筛选条件,尊许 PostgREST 语法,详情可查看 https://docs.postgrest.org/en/v13/references/api/tables_views.html#horizontal-filtering */
715
+ filter?: string;
716
+ /**
717
+ * 排序条件,如果没指定 asc/desc,默认为 asc,null 值可排在最前或最后。
718
+ * 尊许 PostgREST 语法,详情可查看
719
+ * https://docs.postgrest.org/en/v13/references/api/tables_views.html#ordering
720
+ */
721
+ order?: string;
722
+ }
723
+ interface RecordsGetResponse {
724
+ /** 是否还有更多项 */
725
+ has_more: boolean;
726
+ /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */
727
+ page_token: string;
728
+ /** 符合条件的记录总数 */
729
+ total: number;
730
+ /** 数据记录列表,格式为数组序列化后的 JSONString */
731
+ items: string;
732
+ }
733
+ interface RecordsPostRequest {
734
+ /** 要插入的数据记录列表,单次支持最多 500 条 */
735
+ records: string;
736
+ }
737
+ interface RecordsPostQuery {
738
+ /** UPSERT 时使用,指定列,多列英文逗号拼接 */
739
+ columns?: string;
740
+ /**
741
+ * UPSERT 时使用,指定使用哪一个或多个具有唯一约束的字段作为冲突判断依据,默认为表主键。
742
+ * 假设 user_products 表有一个由 user_id 和 product_id 组成的复合唯一约束。
743
+ */
744
+ on_conflict?: string;
745
+ }
746
+ interface RecordsPostResponse {
747
+ /** 按照记录顺序创建或更新的记录 ID 列表 */
748
+ record_ids: Lark.Uuid[];
749
+ }
750
+ interface RecordsPatchRequest {
751
+ /** 要更新的数据记录信息 */
752
+ record: string;
753
+ }
754
+ interface RecordsPatchQuery {
755
+ /** 筛选条件,尊许 PostgREST 语法,详情可查看 https://docs.postgrest.org/en/v13/references/api/tables_views.html#horizontal-filtering */
756
+ filter: string;
757
+ }
758
+ interface RecordsPatchResponse {
759
+ /** 更新的记录唯一ID列表 */
760
+ record_ids: Lark.Uuid[];
761
+ }
762
+ interface RecordsBatchUpdateRequest {
763
+ /** 要更新的数据记录列表,单次支持最多 500条,每行 record 都必须包含主键 _id,且不同行要更新的字段需保持一致 */
764
+ records: string;
765
+ }
766
+ interface RecordsBatchUpdateResponse {
767
+ /** 更新的记录唯一ID列表 */
768
+ record_ids: Lark.Uuid[];
769
+ }
770
+ interface RecordsDeleteQuery {
771
+ /**
772
+ * 筛选条件,尊许 PostgREST 语法,详情可查看 https://docs.postgrest.org/en/v13/references/api/tables_views.html#horizontal-filtering
773
+ * 此处用法和查询数据记录一致
774
+ */
775
+ filter: string;
776
+ }
777
+ }
778
+ namespace View {
779
+ interface Methods {
780
+ /**
781
+ * 查询视图数据记录
782
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-view/views_get
783
+ */
784
+ viewsGet(workspace_id: string, view_name: string, query?: ViewsGetQuery): Promise<ViewsGetResponse>;
785
+ }
786
+ interface ViewsGetQuery extends Pagination {
787
+ /**
788
+ * 返回的列,默认为 *,即返回所有列。
789
+ * 遵循 PostgREST 语法,详情可查看 https://docs.postgrest.org/en/v13/references/api/tables_views.html#vertical-filtering
790
+ */
791
+ select?: string;
792
+ /** 筛选条件,尊许 PostgREST 语法,详情可查看 https://docs.postgrest.org/en/v13/references/api/tables_views.html#horizontal-filtering */
793
+ filter?: string;
794
+ /**
795
+ * 排序条件,如果没指定 asc/desc,默认为 asc,null 值可排在最前或最后。
796
+ * 尊许 PostgREST 语法,详情可查看
797
+ * https://docs.postgrest.org/en/v13/references/api/tables_views.html#ordering
798
+ */
799
+ order?: string;
800
+ }
801
+ interface ViewsGetResponse {
802
+ /** 是否还有更多项 */
803
+ has_more: boolean;
804
+ /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */
805
+ page_token: string;
806
+ /** 符合条件的记录总数 */
807
+ total: number;
808
+ /** 数据记录列表,格式为数组序列化后的 JSONString */
809
+ items: string;
810
+ }
811
+ }
812
+ }
651
813
  }
@@ -428,7 +428,12 @@ export declare namespace Application {
428
428
  date: string;
429
429
  /** 活跃周期的统计类型 */
430
430
  cycle_type: DepartmentOverviewRequestCycleType;
431
- /** 查询的部门id,获取方法可参考[部门ID概述](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)- 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户) 以及多级子部门的使用数据。- 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。- 若不填写则返回整个租户的数据 */
431
+ /**
432
+ * 查询的部门id,获取方法可参考[部门ID概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)
433
+ * - 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户) 以及多级子部门的使用数据。
434
+ * - 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。
435
+ * - 若不填写则返回整个租户的数据
436
+ */
432
437
  department_id?: string;
433
438
  /** 是否需要查询部门下多层子部门的数据。未设置或为0时,仅查询department_id对应的部门。设置为n时,查询department_id及其n级子部门的数据。仅在department_id参数传递时有效,最大值为4。 */
434
439
  recursion?: number;
@@ -454,7 +459,11 @@ export declare namespace Application {
454
459
  date: string;
455
460
  /** 枚举值:day,week,month;week指自然周,返回当前日期所在周的数据;不满一周则从周一到当前日期算。month指自然月,返回当前日期所在月的数据。 */
456
461
  cycle_type: MessagePushOverviewRequestCycleType;
457
- /** 需要查询的部门id,获取方法可参考[部门ID概述](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)- 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户); - 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。返回当前部门的使用数据; 若不填写,则返回当前租户的使用数据 */
462
+ /**
463
+ * 需要查询的部门id,获取方法可参考[部门ID概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)
464
+ * - 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户);
465
+ * - 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。返回当前部门的使用数据; 若不填写,则返回当前租户的使用数据
466
+ */
458
467
  department_id?: string;
459
468
  }
460
469
  interface MessagePushOverviewQuery {
@@ -478,7 +487,11 @@ export declare namespace Application {
478
487
  date: string;
479
488
  /** 活跃周期的统计类型 */
480
489
  cycle_type: OverviewRequestCycleType;
481
- /** 查询的部门id,获取方法可参考[部门ID概述](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)- 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户); - 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。 */
490
+ /**
491
+ * 查询的部门id,获取方法可参考[部门ID概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)
492
+ * - 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户);
493
+ * - 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。
494
+ */
482
495
  department_id?: string;
483
496
  /** 能力类型,按能力类型进行筛选,返回对应能力的活跃数据 */
484
497
  ability: 'app' | 'mp' | 'h5' | 'bot';
@@ -541,7 +554,10 @@ export declare namespace Application {
541
554
  interface ListQuery extends Pagination {
542
555
  /** 查询的起始日期,格式为yyyy-mm-dd。不填则默认为当前日期减去180天。 */
543
556
  from_date?: string;
544
- /** 查询的结束日期,格式为yyyy-mm-dd。不填默认为当前日期。只能查询 180 天内的数据。 */
557
+ /**
558
+ * 查询的结束日期,格式为yyyy-mm-dd。不填默认为当前日期。
559
+ * 只能查询 180 天内的数据。
560
+ */
545
561
  to_date?: string;
546
562
  /** 反馈类型,不填写则表示查询所有反馈类型。 */
547
563
  feedback_type?: ListQueryFeedbackType;
@@ -121,11 +121,6 @@ export declare namespace Approval {
121
121
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get
122
122
  */
123
123
  get(instance_id: string, query?: GetQuery): Promise<GetResponse>;
124
- /**
125
- * 批量获取审批实例 ID
126
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list
127
- */
128
- list(query?: ListQuery): Paginated<string, 'instance_code_list'>;
129
124
  /**
130
125
  * 退回审批任务
131
126
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback
@@ -293,14 +288,6 @@ export declare namespace Approval {
293
288
  /** 审批实例 Code */
294
289
  instance_code: string;
295
290
  }
296
- interface ListQuery extends Pagination {
297
- /** 审批定义唯一标识 */
298
- approval_code: string;
299
- /** 审批实例创建时间区间(毫秒) */
300
- start_time: string;
301
- /** 审批实例创建时间区间(毫秒) */
302
- end_time: string;
303
- }
304
291
  interface SpecifiedRollbackRequest {
305
292
  /** 用户ID */
306
293
  user_id: string;
@@ -210,7 +210,7 @@ export declare namespace Attendance {
210
210
  interface BatchCreateRequest {
211
211
  /** 班表信息列表 */
212
212
  user_daily_shifts: Lark.UserDailyShift[];
213
- /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
213
+ /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
214
214
  operator_id?: string;
215
215
  }
216
216
  interface BatchCreateQuery {
@@ -296,7 +296,7 @@ export declare namespace Attendance {
296
296
  interface CreateRequest {
297
297
  /** 6921319402260496386 */
298
298
  group: Lark.Group;
299
- /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
299
+ /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */
300
300
  operator_id?: string;
301
301
  }
302
302
  interface CreateQuery {
@@ -607,9 +607,15 @@ export declare namespace Attendance {
607
607
  stats_type: 'daily' | 'month';
608
608
  /** 开始时间 */
609
609
  start_date: number;
610
- /** 结束时间(时间间隔不超过 40 天) */
610
+ /**
611
+ * 结束时间
612
+ * (时间间隔不超过 40 天)
613
+ */
611
614
  end_date: number;
612
- /** 查询的用户 ID 列表(用户数量不超过 200) */
615
+ /**
616
+ * 查询的用户 ID 列表
617
+ * (用户数量不超过 200)
618
+ */
613
619
  user_ids?: string[];
614
620
  /** 是否需要历史数据 */
615
621
  need_history?: boolean;
@@ -700,7 +706,7 @@ export declare namespace Attendance {
700
706
  process(body: ProcessRequest): Promise<ProcessResponse>;
701
707
  }
702
708
  interface ProcessRequest {
703
- /** 审批实例 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) */
709
+ /** 审批实例 ID,获取方式:1)[获取审批通过数据](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query) 2)[写入审批结果](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create) 3)[通知补卡审批发起(补卡情况下)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create) */
704
710
  approval_id: string;
705
711
  /** 审批类型,leave:请假,out:外出,overtime:加班,trip:出差,remedy:补卡 */
706
712
  approval_type: string;
@@ -94,7 +94,10 @@ export declare namespace Authen {
94
94
  interface CreateRequest {
95
95
  /** 授权类型,**固定值**: */
96
96
  grant_type: string;
97
- /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */
97
+ /**
98
+ * 刷新 `user_access_token` 需要的凭证
99
+ * 获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`**
100
+ */
98
101
  refresh_token: string;
99
102
  }
100
103
  interface CreateResponse {
@@ -179,7 +182,10 @@ export declare namespace Authen {
179
182
  interface CreateRequest {
180
183
  /** 授权类型,**固定值**: */
181
184
  grant_type: string;
182
- /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */
185
+ /**
186
+ * 刷新 `user_access_token` 需要的凭证
187
+ * 获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`**
188
+ */
183
189
  refresh_token: string;
184
190
  }
185
191
  interface CreateResponse {
@@ -402,15 +402,36 @@ export declare namespace Bitable {
402
402
  record?: Lark.AppTableRecord;
403
403
  }
404
404
  interface ListQuery extends Pagination {
405
- /** 视图 id注意:如 filter 或 sort 有值,view_id 会被忽略。 */
405
+ /**
406
+ * 视图 id
407
+ * 注意:如 filter 或 sort 有值,view_id 会被忽略。
408
+ */
406
409
  view_id?: string;
407
- /** 筛选参数注意:1.筛选记录的表达式不超过2000个字符。2.不支持对“人员”以及“关联字段”的属性进行过滤筛选,如人员的 OpenID。3.仅支持字段在页面展示字符值进行筛选。详细请参考[记录筛选开发指南](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter) */
410
+ /**
411
+ * 筛选参数
412
+ * 注意:
413
+ * 1.筛选记录的表达式不超过2000个字符。
414
+ * 2.不支持对“人员”以及“关联字段”的属性进行过滤筛选,如人员的 OpenID。
415
+ * 3.仅支持字段在页面展示字符值进行筛选。
416
+ * 详细请参考[记录筛选开发指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter)
417
+ */
408
418
  filter?: string;
409
- /** 排序参数注意:1.表达式需要不超过1000字符。2.不支持对带“公式”和“关联字段”的表的使用。3.使用引号将字段名称和顺序逆序连接起来。 */
419
+ /**
420
+ * 排序参数
421
+ * 注意:
422
+ * 1.表达式需要不超过1000字符。
423
+ * 2.不支持对带“公式”和“关联字段”的表的使用。
424
+ * 3.使用引号将字段名称和顺序逆序连接起来。
425
+ */
410
426
  sort?: string;
411
427
  /** 字段名称 */
412
428
  field_names?: string;
413
- /** 控制多行文本字段数据的返回格式,true 表示以数组形式返回。注意:1.多行文本中如果有超链接部分,则会返回链接的 URL。2.目前可以返回多行文本中 URL 类型为多维表格链接、飞书 doc、飞书 sheet的URL类型以及@人员的数据结构。 */
429
+ /**
430
+ * 控制多行文本字段数据的返回格式,true 表示以数组形式返回。
431
+ * 注意:
432
+ * 1.多行文本中如果有超链接部分,则会返回链接的 URL。
433
+ * 2.目前可以返回多行文本中 URL 类型为多维表格链接、飞书 doc、飞书 sheet的URL类型以及@人员的数据结构。
434
+ */
414
435
  text_field_as_array?: boolean;
415
436
  /** 此次调用中使用的用户ID的类型 */
416
437
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
@@ -11,20 +11,76 @@ export declare namespace Board {
11
11
  namespace Whiteboard {
12
12
  interface Methods {
13
13
  node: Node.Methods;
14
+ /**
15
+ * 获取画板主题
16
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/theme
17
+ */
18
+ theme(whiteboard_id: string): Promise<ThemeResponse>;
19
+ /**
20
+ * 更新画板主题
21
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/update_theme
22
+ */
23
+ updateTheme(whiteboard_id: string, body: UpdateThemeRequest): Promise<void>;
14
24
  /**
15
25
  * 获取画板缩略图片
16
26
  * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/download_as_image
17
27
  */
18
28
  downloadAsImage(whiteboard_id: string): Promise<ArrayBuffer>;
19
29
  }
30
+ interface ThemeResponse {
31
+ /** 主题 */
32
+ theme: 'classic' | 'minimalist_gray' | 'retro' | 'vibrant_color' | 'minimalist_blue' | 'default';
33
+ }
34
+ interface UpdateThemeRequest {
35
+ /** 主题名称 */
36
+ theme?: string;
37
+ }
20
38
  namespace Node {
21
39
  interface Methods {
40
+ /**
41
+ * 解析画板语法
42
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/create_plantuml
43
+ */
44
+ createPlantuml(whiteboard_id: string, body: CreatePlantumlRequest): Promise<CreatePlantumlResponse>;
45
+ /**
46
+ * 创建节点
47
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/create
48
+ */
49
+ create(whiteboard_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
22
50
  /**
23
51
  * 获取所有节点
24
52
  * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/list
25
53
  */
26
54
  list(whiteboard_id: string): Promise<ListResponse>;
27
55
  }
56
+ interface CreatePlantumlRequest {
57
+ /** plant uml 代码 */
58
+ plant_uml_code: string;
59
+ style_type?: Lark.StyleType;
60
+ /** 语法类型 */
61
+ syntax_type?: Lark.SyntaxType;
62
+ diagram_type?: Lark.DiagramType;
63
+ }
64
+ interface CreatePlantumlResponse {
65
+ /** 创建生成的plant uml节点id */
66
+ node_id?: string;
67
+ }
68
+ interface CreateRequest {
69
+ /** 子节点数据 */
70
+ nodes?: Lark.WhiteboardNode[];
71
+ }
72
+ interface CreateQuery {
73
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作 */
74
+ client_token?: string;
75
+ /** 此次调用中使用的用户ID的类型 */
76
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
77
+ }
78
+ interface CreateResponse {
79
+ /** 所创建的节点 id 列表 */
80
+ ids: string[];
81
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
82
+ client_token?: string;
83
+ }
28
84
  interface ListResponse {
29
85
  /** 查询结果 */
30
86
  nodes?: Lark.WhiteboardNode[];