@satorijs/adapter-lark 3.11.9 → 3.12.0

package/lib/types/drive.d.ts

@@ -191,7 +191,10 @@ export declare namespace Drive {
             file_name: string;
             /** 上传点类型。 */
             parent_type: 'explorer';
-            /** 文件夹token，获取方式见 [概述](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction) */
+            /**
+             * 文件夹token，
+             * 获取方式见 [概述](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction)
+             */
             parent_node: string;
             /** 文件大小（以字节为单位）。 */
             size: number;
@@ -946,7 +949,10 @@ export declare namespace Drive {
                 type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
             }
             interface UpdateQuery {
-                /** 更新权限后是否通知对方**注意：** 使用`tenant_access_token`访问不支持该参数 */
+                /**
+                 * 更新权限后是否通知对方
+                 * **注意：** 使用`tenant_access_token`访问不支持该参数
+                 */
                 need_notification?: boolean;
                 /** 文件类型，放于query参数中，如：`?type=doc` */
                 type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
@@ -958,7 +964,18 @@ export declare namespace Drive {
             interface ListQuery {
                 /** 文件类型，需要与文件的 token 相匹配 */
                 type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
-                /** 指定返回的协作者字段信息，如无指定则默认不返回**可选值有：** - `name`：协作者名- `type`：协作者类型- `avatar`：头像- `external_label`：外部标签**注意：** - 你可以使用特殊值`*`指定返回目前支持的所有字段- 你可以使用`,`分隔若干个你想指定返回的字段，如：`name,avatar`- 按需指定返回字段接口性能更好 */
+                /**
+                 * 指定返回的协作者字段信息，如无指定则默认不返回
+                 * **可选值有：**
+                 * - `name`：协作者名
+                 * - `type`：协作者类型
+                 * - `avatar`：头像
+                 * - `external_label`：外部标签
+                 * **注意：**
+                 * - 你可以使用特殊值`*`指定返回目前支持的所有字段
+                 * - 你可以使用`,`分隔若干个你想指定返回的字段，如：`name,avatar`
+                 * - 按需指定返回字段接口性能更好
+                 */
                 fields?: string;
                 /** 协作者的权限角色类型 */
                 perm_type?: 'container' | 'single_page';

package/lib/types/ehr.d.ts

@@ -45,7 +45,11 @@ export declare namespace Ehr {
         interface ListQuery extends Pagination {
             /** 返回数据类型 */
             view?: 'basic' | 'full';
-            /** 员工状态，不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录，如 status=2&status=4 */
+            /**
+             * 员工状态，不传代表查询所有员工状态
+             * 实际在职 = 2&4
+             * 可同时查询多个状态的记录，如 status=2&status=4
+             */
             status?: ListQueryStatus[];
             /** 雇员类型，不传代表查询所有雇员类型 */
             type?: ListQueryType[];
@@ -55,7 +59,12 @@ export declare namespace Ehr {
             end_time?: string;
             /** 此次调用中使用的用户ID的类型 */
             user_id_type?: 'user_id' | 'union_id' | 'open_id';
-            /** user_id、open_id 或 union_id，默认为 open_id。如果传入的值不是 open_id，需要一并传入 user_id_type 参数。可一次查询多个 id 的用户，例如：user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
+            /**
+             * user_id、open_id 或 union_id，默认为 open_id。
+             * 如果传入的值不是 open_id，需要一并传入 user_id_type 参数。
+             * 可一次查询多个 id 的用户，例如：user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde
+             * [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)
+             */
             user_ids?: string[];
         }
     }

package/lib/types/helpdesk.d.ts

@@ -202,11 +202,11 @@ export declare namespace Helpdesk {
         interface StartServiceRequest {
             /** 是否直接进入人工(若appointed_agents填写了，该值为必填) */
             human_service?: boolean;
-            /** 客服 open ids (获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get))，human_service需要为true */
+            /** 客服 open ids (获取方式参考[获取单个用户信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get))，human_service需要为true */
             appointed_agents?: string[];
-            /** 用户 open id,(获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */
+            /** 用户 open id,(获取方式参考[获取单个用户信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */
             open_id: string;
-            /** 工单来源自定义信息，长度限制1024字符，如设置，[获取工单详情](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */
+            /** 工单来源自定义信息，长度限制1024字符，如设置，[获取工单详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */
             customized_info?: string;
         }
         interface StartServiceResponse {
@@ -277,7 +277,10 @@ export declare namespace Helpdesk {
         interface TicketImageQuery {
             /** 工单ID */
             ticket_id: string;
-            /** 消息ID[查询消息ID](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list) */
+            /**
+             * 消息ID
+             * [查询消息ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list)
+             */
             msg_id: string;
             /** index，当消息类型为post时，需指定图片index，index从0开始。当消息类型为img时，无需index */
             index?: number;
@@ -314,7 +317,10 @@ export declare namespace Helpdesk {
             interface CreateRequest {
                 /** 消息类型；text：纯文本；post：富文本 */
                 msg_type: string;
-                /** - 纯文本，参考[发送文本消息](/ssl:ttdoc/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content；- 富文本，参考[发送富文本消息](/ssl:ttdoc/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content */
+                /**
+                 * - 纯文本，参考[发送文本消息](https://open.feishu.cn/document/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content；
+                 * - 富文本，参考[发送富文本消息](https://open.feishu.cn/document/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content
+                 */
                 content: string;
             }
             interface CreateResponse {
@@ -551,7 +557,10 @@ export declare namespace Helpdesk {
             items?: Lark.Faq[];
         }
         interface SearchQuery extends Pagination {
-            /** 搜索query，query内容如果不是英文，包含中文空格等有两种编码策略：1. url编码 2. base64编码，同时加上base64=true参数 */
+            /**
+             * 搜索query
+             * ，query内容如果不是英文，包含中文空格等有两种编码策略：1. url编码 2. base64编码，同时加上base64=true参数
+             */
             query: string;
             /** 是否转换为base64,输入true表示是，不填写表示否，中文需要转换为base64 */
             base64?: string;

package/lib/types/hire.d.ts

@@ -7,7 +7,6 @@ declare module '../internal' {
 }
 export declare namespace Hire {
     interface Methods {
-        portalApplySchema: PortalApplySchema.Methods;
         location: Location.Methods;
         role: Role.Methods;
         userRole: UserRole.Methods;
@@ -32,6 +31,7 @@ export declare namespace Hire {
         offerApplicationForm: OfferApplicationForm.Methods;
         referral: Referral.Methods;
         referralWebsite: ReferralWebsite.Methods;
+        portalApplySchema: PortalApplySchema.Methods;
         website: Website.Methods;
         agency: Agency.Methods;
         talent: Talent.Methods;
@@ -77,15 +77,6 @@ export declare namespace Hire {
         talentOperationLog: TalentOperationLog.Methods;
         offerSchema: OfferSchema.Methods;
     }
-    namespace PortalApplySchema {
-        interface Methods {
-            /**
-             * 获取申请表模板列表
-             * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/portal_apply_schema/list
-             */
-            list(query?: Pagination): Paginated<Lark.RegistrationSchema>;
-        }
-    }
     namespace Location {
         interface Methods {
             /**
@@ -1287,6 +1278,15 @@ export declare namespace Hire {
             }
         }
     }
+    namespace PortalApplySchema {
+        interface Methods {
+            /**
+             * 获取申请表模板列表
+             * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/portal_apply_schema/list
+             */
+            list(query?: Pagination): Paginated<Lark.RegistrationSchema>;
+        }
+    }
     namespace Website {
         interface Methods {
             channel: Channel.Methods;
@@ -1727,7 +1727,7 @@ export declare namespace Hire {
             tag_id_list: string[];
         }
         interface CombinedCreateRequest {
-            /** 简历来源 ID，可通过[获取简历来源列表](/ssl:ttdoc/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */
+            /** 简历来源 ID，可通过[获取简历来源列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */
             init_source_id?: string;
             /** 简历来源 ID */
             resume_source_id?: string;
@@ -1777,7 +1777,7 @@ export declare namespace Hire {
         interface CombinedUpdateRequest {
             /** 人才 ID */
             talent_id: string;
-            /** 简历来源 ID，可通过[获取简历来源列表](/ssl:ttdoc/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */
+            /** 简历来源 ID，可通过[获取简历来源列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */
             init_source_id?: string;
             /** 文件夹 ID 列表 */
             folder_id_list?: string[];
@@ -2816,7 +2816,7 @@ export declare namespace Hire {
             exam_resource_name: string;
             /** 笔试分数 */
             score: number;
-            /** 报告附件，使用[创建附件](/ssl:ttdoc/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment)上传，获取附件ID，支持的文件格式：JPG、JPEG、PNG、PDF，不超过 100MB。 */
+            /** 报告附件，使用[创建附件](https://open.feishu.cn/document/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment)上传，获取附件ID，支持的文件格式：JPG、JPEG、PNG、PDF，不超过 100MB。 */
             uuid?: string;
             /** 添加人 ID */
             operator_id: string;

package/lib/types/human_authentication.d.ts

@@ -24,7 +24,7 @@ export declare namespace HumanAuthentication {
             mobile?: string;
         }
         interface CreateQuery {
-            /** 用户的唯一标识（使用的ID类型见下一参数描述，不同ID类型的区别和获取，参考文档：[如何获得 User ID、Open ID 和 Union ID？](/ssl:ttdoc/home/user-identity-introduction/how-to-get)） */
+            /** 用户的唯一标识（使用的ID类型见下一参数描述，不同ID类型的区别和获取，参考文档：[如何获得 User ID、Open ID 和 Union ID？](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get)） */
             user_id: string;
             /** 用户ID类型 open_id/user_id/union_id */
             user_id_type?: 'open_id' | 'user_id' | 'union_id';

package/lib/types/im.d.ts

@@ -99,9 +99,14 @@ export declare namespace Im {
         interface CreateRequest {
             /** 依据receive_id_type的值，填写对应的消息接收者id */
             receive_id: string;
-            /** 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，类型定义请参考[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
+            /** 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，类型定义请参考[发送消息content说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
             msg_type: string;
-            /** 消息内容，json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，具体格式说明参考：[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)<b>请求体大小限制</b>：- 文本消息请求体最大不能超过150KB- 卡片及富文本消息请求体最大不能超过30KB */
+            /**
+             * 消息内容，json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，具体格式说明参考：[发送消息content说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)
+             * <b>请求体大小限制</b>：
+             * - 文本消息请求体最大不能超过150KB
+             * - 卡片及富文本消息请求体最大不能超过30KB
+             */
             content: string;
             /** 由开发者生成的唯一字符串序列，用于发送消息请求去重；持有相同uuid的请求1小时内至多成功执行一次 */
             uuid?: string;
@@ -141,7 +146,7 @@ export declare namespace Im {
             upper_message_id?: string;
         }
         interface ReplyRequest {
-            /** 消息内容 json 格式，格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
+            /** 消息内容 json 格式，格式说明参考: [发送消息content说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
             content: string;
             /** 消息类型，包括：text、post、image、file、audio、media、sticker、interactive、share_card、share_user */
             msg_type: string;
@@ -285,7 +290,7 @@ export declare namespace Im {
         interface ListQuery extends Pagination {
             /** 容器类型 ，目前可选值仅有"chat"，包含单聊（p2p）和群聊（group） */
             container_id_type: string;
-            /** 容器的id，即chat的id，详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
+            /** 容器的id，即chat的id，详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
             container_id: string;
             /** 历史信息的起始时间（秒级时间戳） */
             start_time?: string;
@@ -339,7 +344,7 @@ export declare namespace Im {
             invalid_user_id_list: string[];
         }
         interface PatchRequest {
-            /** 消息内容 json 格式，[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)，参考文档中的卡片格式 */
+            /** 消息内容 json 格式，[发送消息 content 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)，参考文档中的卡片格式 */
             content: string;
         }
         namespace Resource {
@@ -388,7 +393,10 @@ export declare namespace Im {
                 reaction_type?: Lark.Emoji;
             }
             interface ListQuery extends Pagination {
-                /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数，表示拉取所有类型reaction */
+                /**
+                 * 待查询消息reaction的类型[emoji类型列举](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。
+                 * - 不传入该参数，表示拉取所有类型reaction
+                 */
                 reaction_type?: string;
                 /** 当操作人为用户时返回用户ID的类型 */
                 user_id_type?: 'open_id' | 'union_id' | 'user_id';
@@ -498,7 +506,10 @@ export declare namespace Im {
         interface CreateForm {
             /** 图片类型 */
             image_type: 'message' | 'avatar';
-            /** 图片内容 **注意：** 上传的图片大小不能超过10MB */
+            /**
+             * 图片内容
+             * **注意：** 上传的图片大小不能超过10MB
+             */
             image: Blob;
         }
         interface CreateResponse {
@@ -630,31 +641,67 @@ export declare namespace Im {
             link(chat_id: string, body: LinkRequest): Promise<LinkResponse>;
         }
         interface CreateRequest {
-            /** 群头像对应的 Image Key，可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取（注意：上传图片的 ==image_type== 需要指定为 ==avatar==） */
+            /** 群头像对应的 Image Key，可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取（注意：上传图片的 ==image_type== 需要指定为 ==avatar==） */
             avatar?: string;
-            /** 群名称 **注意：** 公开群名称的长度不得少于2个字符 */
+            /**
+             * 群名称
+             * **注意：** 公开群名称的长度不得少于2个字符
+             */
             name?: string;
             /** 群描述 */
             description?: string;
             /** 群国际化名称 */
             i18n_names?: Lark.I18nNames;
-            /** 创建群时指定的群主，不填时指定建群的机器人为群主。群主 ID，ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
+            /**
+             * 创建群时指定的群主，不填时指定建群的机器人为群主。
+             * 群主 ID，ID值与查询参数中的 user_id_type 对应。
+             * 不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)
+             */
             owner_id?: string;
             /** 创建群时邀请的群成员，id 类型为 user_id_type */
             user_id_list?: string[];
-            /** 创建群时邀请的群机器人 **注意：** 拉机器人入群请使用 ==app_id== */
+            /**
+             * 创建群时邀请的群机器人
+             * **注意：** 拉机器人入群请使用 ==app_id==
+             */
             bot_id_list?: string[];
             /** 群消息模式 */
             group_message_type?: 'chat' | 'thread';
-            /** 群模式**可选值有**：- `group`：群组 */
+            /**
+             * 群模式
+             * **可选值有**：
+             * - `group`：群组
+             */
             chat_mode?: string;
-            /** 群类型**可选值有**：- `private`：私有群- `public`：公开群 */
+            /**
+             * 群类型
+             * **可选值有**：
+             * - `private`：私有群
+             * - `public`：公开群
+             */
             chat_type?: string;
-            /** 入群消息可见性**可选值有**：- `only_owner`：仅群主和管理员可见- `all_members`：所有成员可见- `not_anyone`：任何人均不可见 */
+            /**
+             * 入群消息可见性
+             * **可选值有**：
+             * - `only_owner`：仅群主和管理员可见
+             * - `all_members`：所有成员可见
+             * - `not_anyone`：任何人均不可见
+             */
             join_message_visibility?: string;
-            /** 退群消息可见性**可选值有**：- `only_owner`：仅群主和管理员可见- `all_members`：所有成员可见- `not_anyone`：任何人均不可见 */
+            /**
+             * 退群消息可见性
+             * **可选值有**：
+             * - `only_owner`：仅群主和管理员可见
+             * - `all_members`：所有成员可见
+             * - `not_anyone`：任何人均不可见
+             */
             leave_message_visibility?: string;
-            /** 加群审批**可选值有**：- `no_approval_required`：无需审批- `approval_required`：需要审批 */
+            /**
+             * 加群审批
+             * **可选值有**：
+             * - `no_approval_required`：无需审批
+             * - `approval_required`：需要审批
+             */
             membership_approval?: string;
             /** 防泄密模式设置 */
             restricted_mode_setting?: Lark.RestrictedModeSetting;
@@ -986,11 +1033,17 @@ export declare namespace Im {
                 isInChat(chat_id: string): Promise<IsInChatResponse>;
             }
             interface CreateRequest {
-                /** 成员列表<b>注意：</b>每次请求，最多拉50个用户或者5个机器人，并且群组最多容纳15个机器人 */
+                /**
+                 * 成员列表
+                 * <b>注意：</b>每次请求，最多拉50个用户或者5个机器人，并且群组最多容纳15个机器人
+                 */
                 id_list?: string[];
             }
             interface CreateQuery {
-                /** 进群成员 id 类型 open_id/user_id/union_id/app_id<b>注意：</b>拉机器人入群请使用 ==app_id== */
+                /**
+                 * 进群成员 id 类型 open_id/user_id/union_id/app_id
+                 * <b>注意：</b>拉机器人入群请使用 ==app_id==
+                 */
                 member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
                 /** 出现不可用ID后的处理方式 0/1/2 */
                 succeed_type?: 0 | 1 | 2;
@@ -1016,7 +1069,7 @@ export declare namespace Im {
                 invalid_id_list?: string[];
             }
             interface GetQuery extends Pagination {
-                /** 群成员 用户 ID 类型，详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
+                /** 群成员 用户 ID 类型，详情参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction) */
                 member_id_type?: 'user_id' | 'union_id' | 'open_id';
             }
             interface GetResponse {
@@ -1050,7 +1103,10 @@ export declare namespace Im {
             interface PatchRequest {
                 /** 文档当前版本号 int64 类型，get 接口会返回 */
                 revision: string;
-                /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */
+                /**
+                 * 修改文档请求的序列化字段
+                 * 更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同
+                 */
                 requests?: string[];
             }
             interface GetQuery {