@satorijs/adapter-lark 3.11.9 → 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 (52) hide show
  1. package/lib/bot.d.ts +5 -5
  2. package/lib/http.d.ts +6 -3
  3. package/lib/index.cjs +293 -223
  4. package/lib/types/acs.d.ts +4 -1
  5. package/lib/types/apaas.d.ts +152 -0
  6. package/lib/types/application.d.ts +20 -4
  7. package/lib/types/approval.d.ts +0 -13
  8. package/lib/types/attendance.d.ts +11 -5
  9. package/lib/types/authen.d.ts +8 -2
  10. package/lib/types/bitable.d.ts +25 -4
  11. package/lib/types/board.d.ts +17 -0
  12. package/lib/types/calendar.d.ts +16 -5
  13. package/lib/types/contact.d.ts +55 -12
  14. package/lib/types/corehr.d.ts +754 -142
  15. package/lib/types/drive.d.ts +20 -3
  16. package/lib/types/ehr.d.ts +11 -2
  17. package/lib/types/helpdesk.d.ts +15 -6
  18. package/lib/types/hire.d.ts +13 -13
  19. package/lib/types/human_authentication.d.ts +1 -1
  20. package/lib/types/im.d.ts +76 -20
  21. package/lib/types/index.d.ts +712 -115
  22. package/lib/types/mail.d.ts +106 -16
  23. package/lib/types/search.d.ts +4 -1
  24. package/lib/ws.d.ts +30 -0
  25. package/package.json +6 -3
  26. package/src/bot.ts +28 -15
  27. package/src/http.ts +10 -4
  28. package/src/types/acs.ts +4 -1
  29. package/src/types/apaas.ts +185 -0
  30. package/src/types/application.ts +20 -4
  31. package/src/types/approval.ts +0 -15
  32. package/src/types/attendance.ts +11 -5
  33. package/src/types/authen.ts +8 -2
  34. package/src/types/bitable.ts +25 -4
  35. package/src/types/board.ts +22 -0
  36. package/src/types/calendar.ts +16 -5
  37. package/src/types/contact.ts +55 -12
  38. package/src/types/corehr.ts +796 -142
  39. package/src/types/drive.ts +20 -3
  40. package/src/types/ehr.ts +11 -2
  41. package/src/types/helpdesk.ts +15 -6
  42. package/src/types/hire.ts +17 -17
  43. package/src/types/human_authentication.ts +1 -1
  44. package/src/types/im.ts +76 -20
  45. package/src/types/index.ts +738 -115
  46. package/src/types/mail.ts +106 -16
  47. package/src/types/search.ts +4 -1
  48. package/src/ws.ts +183 -0
  49. package/lib/types/api.d.ts +0 -28510
  50. package/lib/types/internal.d.ts +0 -21
  51. package/lib/types/message/content.d.ts +0 -433
  52. 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;
@@ -14,6 +14,7 @@ export declare namespace Apaas {
14
14
  userTask: UserTask.Methods;
15
15
  approvalTask: ApprovalTask.Methods;
16
16
  approvalInstance: ApprovalInstance.Methods;
17
+ workspace: Workspace.Methods;
17
18
  }
18
19
  namespace App {
19
20
  interface Methods {
@@ -658,4 +659,155 @@ export declare namespace Apaas {
658
659
  opinion: string;
659
660
  }
660
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
+ }
661
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';
@@ -37,6 +37,11 @@ export declare namespace Board {
37
37
  }
38
38
  namespace Node {
39
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>;
40
45
  /**
41
46
  * 创建节点
42
47
  * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/create
@@ -48,6 +53,18 @@ export declare namespace Board {
48
53
  */
49
54
  list(whiteboard_id: string): Promise<ListResponse>;
50
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
+ }
51
68
  interface CreateRequest {
52
69
  /** 子节点数据 */
53
70
  nodes?: Lark.WhiteboardNode[];
@@ -207,7 +207,7 @@ export declare namespace Calendar {
207
207
  time_min: string;
208
208
  /** 查询时段结束时间,需要url编码 */
209
209
  time_max: string;
210
- /** 用户user_id,输入时与 room_id 二选一。参见[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
210
+ /** 用户user_id,输入时与 room_id 二选一。参见[用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) */
211
211
  user_id?: string;
212
212
  /** 会议室room_id,输入时与 user_id 二选一 */
213
213
  room_id?: string;
@@ -574,7 +574,10 @@ export declare namespace Calendar {
574
574
  list(calendar_id: string, event_id: string, query?: ListQuery): Paginated<Lark.CalendarEventAttendee>;
575
575
  }
576
576
  interface CreateRequest {
577
- /** 新增参与人列表;<br>- 单次请求会议室的数量限制为100。 */
577
+ /**
578
+ * 新增参与人列表;
579
+ * - 单次请求会议室的数量限制为100。
580
+ */
578
581
  attendees?: Lark.CalendarEventAttendee[];
579
582
  /** 是否给参与人发送bot通知 默认为true */
580
583
  need_notification?: boolean;
@@ -594,7 +597,7 @@ export declare namespace Calendar {
594
597
  attendees?: Lark.CalendarEventAttendee[];
595
598
  }
596
599
  interface BatchDeleteRequest {
597
- /** 要移除的参与人 ID 列表。参见[参与人ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/introduction#4998889c) */
600
+ /** 要移除的参与人 ID 列表。参见[参与人ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/introduction#4998889c) */
598
601
  attendee_ids?: string[];
599
602
  /** 需要删除的参与人类型实体ID,作为attendee_ids字段的补充。 */
600
603
  delete_ids?: Lark.CalendarEventAttendeeId[];
@@ -654,7 +657,11 @@ export declare namespace Calendar {
654
657
  end_time: string;
655
658
  /** 休假日程标题,可自定义例如:"请假中(全天) / 1-Day Time Off","请假中(半天) / 0.5-Day Time Off","长期休假中 / Leave of Absence","请假中" */
656
659
  title?: string;
657
- /** 休假日程描述,可自定义,例如:"若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked." */
660
+ /**
661
+ * 休假日程描述,可自定义,例如:
662
+ * "若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。
663
+ * If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked."
664
+ */
658
665
  description?: string;
659
666
  }
660
667
  interface CreateQuery {
@@ -674,7 +681,11 @@ export declare namespace Calendar {
674
681
  end_time: string;
675
682
  /** 休假日程标题,可自定义例如:"请假中(全天) / 1-Day Time Off","请假中(半天) / 0.5-Day Time Off","长期休假中 / Leave of Absence","请假中" */
676
683
  title?: string;
677
- /** 休假日程描述,可自定义,例如:"若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked." */
684
+ /**
685
+ * 休假日程描述,可自定义,例如:
686
+ * "若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。
687
+ * If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked."
688
+ */
678
689
  description?: string;
679
690
  }
680
691
  }
@@ -172,7 +172,10 @@ export declare namespace Contact {
172
172
  interface CreateQuery {
173
173
  /** 此次调用中使用的用户ID的类型 */
174
174
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
175
- /** 此次调用中使用的部门ID的类型。不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
175
+ /**
176
+ * 此次调用中使用的部门ID的类型。
177
+ * 不同 ID 的说明参见[部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
178
+ */
176
179
  department_id_type?: 'department_id' | 'open_department_id';
177
180
  /** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
178
181
  client_token?: string;
@@ -262,7 +265,10 @@ export declare namespace Contact {
262
265
  interface GetQuery {
263
266
  /** 此次调用中使用的用户ID的类型 */
264
267
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
265
- /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
268
+ /**
269
+ * 此次调用中使用的部门ID的类型
270
+ * 不同 ID 的说明 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
271
+ */
266
272
  department_id_type?: 'department_id' | 'open_department_id';
267
273
  }
268
274
  interface GetResponse {
@@ -283,15 +289,31 @@ export declare namespace Contact {
283
289
  interface FindByDepartmentQuery extends Pagination {
284
290
  /** 此次调用中使用的用户ID的类型 */
285
291
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
286
- /** 此次调用中使用的部门ID的类型部门ID类型的区别参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
292
+ /**
293
+ * 此次调用中使用的部门ID的类型
294
+ * 部门ID类型的区别参见[部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
295
+ */
287
296
  department_id_type?: 'department_id' | 'open_department_id';
288
- /** 填写该字段表示获取该部门下用户,必填。根部门的部门ID为0。ID值与查询参数中的department_id_type 对应。不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
297
+ /**
298
+ * 填写该字段表示获取该部门下用户,必填。根部门的部门ID为0。
299
+ * ID值与查询参数中的department_id_type 对应。
300
+ * 不同 ID 的说明与department_id的获取方式参见 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
301
+ */
289
302
  department_id: string;
290
303
  }
291
304
  interface BatchGetIdRequest {
292
- /** 要查询的用户邮箱,最多 50 条。注意,emails与mobiles相互独立,每条用户邮箱返回对应的用户ID。本接口返回的用户ID数量为emails数量与mobiles数量的和。 */
305
+ /**
306
+ * 要查询的用户邮箱,最多 50 条。
307
+ * 注意,emails与mobiles相互独立,每条用户邮箱返回对应的用户ID。
308
+ * 本接口返回的用户ID数量为emails数量与mobiles数量的和。
309
+ */
293
310
  emails?: string[];
294
- /** 要查询的用户手机号,最多 50 条。注意1. emails与mobiles相互独立,每条用户手机号返回对应的用户ID。2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。 */
311
+ /**
312
+ * 要查询的用户手机号,最多 50 条。
313
+ * 注意
314
+ * 1. emails与mobiles相互独立,每条用户手机号返回对应的用户ID。
315
+ * 2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。
316
+ */
295
317
  mobiles?: string[];
296
318
  /** 查询结果包含离职员工,可查询离职用户的ID */
297
319
  include_resigned?: boolean;
@@ -459,7 +481,12 @@ export declare namespace Contact {
459
481
  description?: string;
460
482
  /** 用户组的类型。默认为1表示普通用户组 */
461
483
  type?: CreateRequestType;
462
- /** 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。自定义group_id数据校验规则:最大长度:64 字符校验规则:数字、大小写字母的组合,不能包含空格 */
484
+ /**
485
+ * 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。
486
+ * 自定义group_id数据校验规则:
487
+ * 最大长度:64 字符
488
+ * 校验规则:数字、大小写字母的组合,不能包含空格
489
+ */
463
490
  group_id?: string;
464
491
  }
465
492
  interface CreateQuery {
@@ -475,7 +502,10 @@ export declare namespace Contact {
475
502
  interface PatchRequest {
476
503
  /** 用户组的名字,企业内唯一,最大长度:100 字符 */
477
504
  name?: string;
478
- /** 用户组描述信息最大长度:500 字 */
505
+ /**
506
+ * 用户组描述信息
507
+ * 最大长度:500 字
508
+ */
479
509
  description?: string;
480
510
  }
481
511
  interface PatchQuery {
@@ -563,7 +593,11 @@ export declare namespace Contact {
563
593
  results?: Lark.MemberResult[];
564
594
  }
565
595
  interface SimplelistQuery extends Pagination {
566
- /** 欲获取成员ID类型。当member_type=user时候,member_id_type表示user_id_type,枚举值open_id, union_id和user_id。当member_type=department时候,member_id_type表示department_id_type,枚举值open_id和department_id。 */
596
+ /**
597
+ * 欲获取成员ID类型。
598
+ * 当member_type=user时候,member_id_type表示user_id_type,枚举值open_id, union_id和user_id。
599
+ * 当member_type=department时候,member_id_type表示department_id_type,枚举值open_id和department_id。
600
+ */
567
601
  member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'department_id';
568
602
  /** 欲获取的用户组成员类型。 */
569
603
  member_type?: 'user' | 'department';
@@ -754,7 +788,10 @@ export declare namespace Contact {
754
788
  interface CreateQuery {
755
789
  /** 此次调用中使用的用户ID的类型 */
756
790
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
757
- /** 此次调用中使用的部门ID的类型不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
791
+ /**
792
+ * 此次调用中使用的部门ID的类型
793
+ * 不同 ID 的说明参见[部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
794
+ */
758
795
  department_id_type?: 'department_id' | 'open_department_id';
759
796
  /** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
760
797
  client_token?: string;
@@ -837,7 +874,10 @@ export declare namespace Contact {
837
874
  interface GetQuery {
838
875
  /** 此次调用中使用的用户ID的类型 */
839
876
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
840
- /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
877
+ /**
878
+ * 此次调用中使用的部门ID的类型
879
+ * 不同 ID 的说明 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
880
+ */
841
881
  department_id_type?: 'department_id' | 'open_department_id';
842
882
  }
843
883
  interface GetResponse {
@@ -858,7 +898,10 @@ export declare namespace Contact {
858
898
  interface ChildrenQuery extends Pagination {
859
899
  /** 此次调用中使用的用户ID的类型 */
860
900
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
861
- /** 此次调用中使用的部门ID的类型不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
901
+ /**
902
+ * 此次调用中使用的部门ID的类型
903
+ * 不同 ID 的说明与department_id的获取方式参见 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)
904
+ */
862
905
  department_id_type?: 'department_id' | 'open_department_id';
863
906
  /** 是否递归获取子部门 */
864
907
  fetch_child?: boolean;