@satorijs/adapter-lark 3.9.0 → 3.9.2

package/lib/types/wiki.d.ts

@@ -92,6 +92,10 @@ export interface GetWikiSpaceQuery {
     /** 当查询个人文档库时，指定返回的文档库名称展示语言。可选值有：zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */
     lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW';
 }
+export interface GetWikiSpaceResponse {
+    /** 知识空间 */
+    space?: Space;
+}
 export interface CreateWikiSpaceRequest {
     /** 知识空间名称 */
     name?: string;
@@ -100,6 +104,10 @@ export interface CreateWikiSpaceRequest {
     /** 表示知识空间的分享状态 */
     open_sharing?: 'open' | 'closed';
 }
+export interface CreateWikiSpaceResponse {
+    /** 知识空间信息 */
+    space?: Space;
+}
 export interface CreateWikiSpaceMemberRequest {
     /** 知识库协作者 ID 类型 */
     member_type: string;
@@ -112,6 +120,10 @@ export interface CreateWikiSpaceMemberQuery {
     /** 添加权限后是否通知对方 */
     need_notification?: boolean;
 }
+export interface CreateWikiSpaceMemberResponse {
+    /** 知识库协作者 */
+    member?: Member;
+}
 export interface DeleteWikiSpaceMemberRequest {
     /** 知识库协作者 ID 类型 */
     member_type: string;
@@ -120,6 +132,10 @@ export interface DeleteWikiSpaceMemberRequest {
     /** 知识库协作者类型 */
     type?: 'user' | 'chat' | 'department';
 }
+export interface DeleteWikiSpaceMemberResponse {
+    /** 成员信息 */
+    member: Member;
+}
 export interface UpdateWikiSpaceSettingRequest {
     /** 谁可以创建空间的一级页面： "admin_and_member" = 管理员和成员 "admin"  - 仅管理员 */
     create_setting?: string;
@@ -128,6 +144,10 @@ export interface UpdateWikiSpaceSettingRequest {
     /** 可阅读用户可否评论： "allow" - 允许 "not_allow" - 不允许 */
     comment_setting?: string;
 }
+export interface UpdateWikiSpaceSettingResponse {
+    /** 空间设置 */
+    setting?: Setting;
+}
 export interface CreateWikiSpaceNodeRequest {
     /** 文档类型，对于快捷方式，该字段是对应的实体的obj_type。 */
     obj_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'docx' | 'slides';
@@ -140,12 +160,20 @@ export interface CreateWikiSpaceNodeRequest {
     /** 文档标题 */
     title?: string;
 }
+export interface CreateWikiSpaceNodeResponse {
+    /** 节点 */
+    node?: Node;
+}
 export interface GetNodeWikiSpaceQuery {
     /** 文档的wiki token */
     token: string;
     /** 文档类型 */
     obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki';
 }
+export interface GetNodeWikiSpaceResponse {
+    /** 节点信息 */
+    node?: Node;
+}
 export interface ListWikiSpaceNodeQuery extends Pagination {
     /** 父节点token */
     parent_node_token?: string;
@@ -156,6 +184,10 @@ export interface MoveWikiSpaceNodeRequest {
     /** 移动到的知识空间ID */
     target_space_id?: string;
 }
+export interface MoveWikiSpaceNodeResponse {
+    /** 移动后的节点信息 */
+    node?: Node;
+}
 export interface UpdateTitleWikiSpaceNodeRequest {
     /** 节点新标题 */
     title: string;
@@ -168,6 +200,10 @@ export interface CopyWikiSpaceNodeRequest {
     /** 复制后的新标题。如果填空，则新标题为空。如果不填，则使用原节点标题。 */
     title?: string;
 }
+export interface CopyWikiSpaceNodeResponse {
+    /** copy后的节点 */
+    node: Node;
+}
 export interface MoveDocsToWikiWikiSpaceNodeRequest {
     /** 节点的父亲token */
     parent_wiki_token?: string;
@@ -178,54 +214,6 @@ export interface MoveDocsToWikiWikiSpaceNodeRequest {
     /** 没有权限时，是否申请迁入文档 */
     apply?: boolean;
 }
-export interface GetWikiTaskQuery {
-    /** 任务类型 */
-    task_type: 'move';
-}
-export interface SearchWikiNodeRequest {
-    /** 搜索关键词 */
-    query: string;
-    /** 文档所属的知识空间ID，为空搜索所有 wiki */
-    space_id?: string;
-    /** wiki token，不为空搜索该节点及其所有子节点，为空搜索所有 wiki（根据 space_id 选择 space） */
-    node_id?: string;
-}
-export interface GetWikiSpaceResponse {
-    /** 知识空间 */
-    space?: Space;
-}
-export interface CreateWikiSpaceResponse {
-    /** 知识空间信息 */
-    space?: Space;
-}
-export interface CreateWikiSpaceMemberResponse {
-    /** 知识库协作者 */
-    member?: Member;
-}
-export interface DeleteWikiSpaceMemberResponse {
-    /** 成员信息 */
-    member: Member;
-}
-export interface UpdateWikiSpaceSettingResponse {
-    /** 空间设置 */
-    setting?: Setting;
-}
-export interface CreateWikiSpaceNodeResponse {
-    /** 节点 */
-    node?: Node;
-}
-export interface GetNodeWikiSpaceResponse {
-    /** 节点信息 */
-    node?: Node;
-}
-export interface MoveWikiSpaceNodeResponse {
-    /** 移动后的节点信息 */
-    node?: Node;
-}
-export interface CopyWikiSpaceNodeResponse {
-    /** copy后的节点 */
-    node: Node;
-}
 export interface MoveDocsToWikiWikiSpaceNodeResponse {
     /** 移动后的知识库token */
     wiki_token?: string;
@@ -234,7 +222,19 @@ export interface MoveDocsToWikiWikiSpaceNodeResponse {
     /** 是否提交了文档迁入申请 */
     applied?: boolean;
 }
+export interface GetWikiTaskQuery {
+    /** 任务类型 */
+    task_type: 'move';
+}
 export interface GetWikiTaskResponse {
     /** 任务结果 */
     task: TaskResult;
 }
+export interface SearchWikiNodeRequest {
+    /** 搜索关键词 */
+    query: string;
+    /** 文档所属的知识空间ID，为空搜索所有 wiki */
+    space_id?: string;
+    /** wiki token，不为空搜索该节点及其所有子节点，为空搜索所有 wiki（根据 space_id 选择 space） */
+    node_id?: string;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@satorijs/adapter-lark",
   "description": "Lark (飞书) Adapter for Satorijs",
-  "version": "3.9.0",
+  "version": "3.9.2",
   "type": "module",
   "main": "lib/index.cjs",
   "types": "lib/index.d.ts",

package/src/internal.ts

@@ -10,11 +10,10 @@ export interface BaseResponse {
   msg: string
 }
 
-export type Paginated<T = any, ItemsKey extends string = 'items', TokenKey extends string = 'page_token'> =
+export type Paginated<T = any, ItemsKey extends string = 'items'> =
   & Promise<
     & { [K in ItemsKey]: T[] }
-    & { [K in TokenKey]?: string }
-    & { has_more: boolean }
+    & { page_token?: string; has_more: boolean }
   >
   & AsyncIterableIterator<T>
 
@@ -130,7 +129,7 @@ export class Internal {
                 iterArgs[argIndex].page_token = data[tokenKey]
                 return {
                   data: data[itemsKey],
-                  next: data.has_more ? iterArgs : undefined,
+                  next: data[tokenKey] ? iterArgs : undefined,
                 }
               }
             }

package/src/types/acs.ts

@@ -91,6 +91,11 @@ export interface GetAcsUserQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface GetAcsUserResponse {
+  /** 门禁用户信息 */
+  user?: User
+}
+
 export interface ListAcsUserQuery extends Pagination {
   /** 此次调用中使用的用户ID的类型 */
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
@@ -131,6 +136,11 @@ export interface GetAcsRuleExternalQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface GetAcsRuleExternalResponse {
+  /** 设备权限组信息 */
+  rules: Rule[]
+}
+
 export interface DeleteAcsRuleExternalQuery {
   /** 权限组id */
   rule_id: string
@@ -148,6 +158,11 @@ export interface CreateAcsRuleExternalQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface CreateAcsRuleExternalResponse {
+  /** 权限组id */
+  rule_id: string
+}
+
 export interface DeleteAcsVisitorQuery {
   /** 此次调用中使用的用户ID的类型 */
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
@@ -163,6 +178,15 @@ export interface CreateAcsVisitorQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface CreateAcsVisitorResponse {
+  /** 访客的id */
+  visitor_id: string
+}
+
+export interface ListAcsDeviceResponse {
+  items?: Device[]
+}
+
 export interface ListAcsAccessRecordQuery extends Pagination {
   /** 记录开始时间，单位秒 */
   from: number
@@ -174,30 +198,6 @@ export interface ListAcsAccessRecordQuery extends Pagination {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
-export interface GetAcsUserResponse {
-  /** 门禁用户信息 */
-  user?: User
-}
-
-export interface GetAcsRuleExternalResponse {
-  /** 设备权限组信息 */
-  rules: Rule[]
-}
-
-export interface CreateAcsRuleExternalResponse {
-  /** 权限组id */
-  rule_id: string
-}
-
-export interface CreateAcsVisitorResponse {
-  /** 访客的id */
-  visitor_id: string
-}
-
-export interface ListAcsDeviceResponse {
-  items?: Device[]
-}
-
 Internal.define({
   '/acs/v1/users/{user_id}': {
     PATCH: 'patchAcsUser',

package/src/types/admin.ts

@@ -137,6 +137,11 @@ export interface CreateAdminBadgeRequest {
   i18n_explanation?: I18n
 }
 
+export interface CreateAdminBadgeResponse {
+  /** 勋章的信息 */
+  badge?: Badge
+}
+
 export interface UpdateAdminBadgeRequest {
   /** 租户内唯一的勋章名称，最多30个字符。 */
   name: string
@@ -152,11 +157,28 @@ export interface UpdateAdminBadgeRequest {
   i18n_explanation?: I18n
 }
 
+export interface UpdateAdminBadgeResponse {
+  /** 勋章信息 */
+  badge?: Badge
+}
+
+export const enum CreateAdminBadgeImageFormImageType {
+  /** 勋章详情图 */
+  Detail = 1,
+  /** 勋章挂饰图 */
+  Show = 2,
+}
+
 export interface CreateAdminBadgeImageForm {
   /** 勋章图片的文件，仅支持 PNG 格式，320 x 320 像素，大小不超过 1024 KB。 */
   image_file: Blob
   /** 图片的类型 */
-  image_type: 1 | 2
+  image_type: CreateAdminBadgeImageFormImageType
+}
+
+export interface CreateAdminBadgeImageResponse {
+  /** 图片的key */
+  image_key?: string
 }
 
 export interface ListAdminBadgeQuery extends Pagination {
@@ -164,11 +186,23 @@ export interface ListAdminBadgeQuery extends Pagination {
   name?: string
 }
 
+export interface GetAdminBadgeResponse {
+  /** 勋章信息 */
+  badge?: Badge
+}
+
+export const enum CreateAdminBadgeGrantRequestGrantType {
+  /** 手动选择有效期 */
+  Manual = 0,
+  /** 匹配系统入职时间 */
+  JoinTime = 1,
+}
+
 export interface CreateAdminBadgeGrantRequest {
   /** 授予名单名称，最多100个字符。 */
   name: string
   /** 勋章下唯一的授予事项 */
-  grant_type: 0 | 1
+  grant_type: CreateAdminBadgeGrantRequestGrantType
   /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */
   time_zone: string
   /** 规则详情 */
@@ -190,11 +224,23 @@ export interface CreateAdminBadgeGrantQuery {
   department_id_type?: 'department_id' | 'open_department_id'
 }
 
+export interface CreateAdminBadgeGrantResponse {
+  /** 授予名单的信息 */
+  grant?: Grant
+}
+
+export const enum UpdateAdminBadgeGrantRequestGrantType {
+  /** 手动选择有效期 */
+  Manual = 0,
+  /** 匹配系统入职时间 */
+  JoinTime = 1,
+}
+
 export interface UpdateAdminBadgeGrantRequest {
   /** 授予名单名称，最多100个字符。 */
   name: string
   /** 勋章下唯一的授予事项 */
-  grant_type: 0 | 1
+  grant_type: UpdateAdminBadgeGrantRequestGrantType
   /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */
   time_zone: string
   /** 规则详情 */
@@ -216,6 +262,11 @@ export interface UpdateAdminBadgeGrantQuery {
   department_id_type?: 'department_id' | 'open_department_id'
 }
 
+export interface UpdateAdminBadgeGrantResponse {
+  /** 授予名单 */
+  grant?: Grant
+}
+
 export interface ListAdminBadgeGrantQuery extends Pagination {
   /** 用户 ID 类型 */
   user_id_type?: 'open_id' | 'union_id' | 'user_id'
@@ -232,6 +283,20 @@ export interface GetAdminBadgeGrantQuery {
   department_id_type?: 'department_id' | 'open_department_id'
 }
 
+export interface GetAdminBadgeGrantResponse {
+  /** 授予名单信息 */
+  grant?: Grant
+}
+
+export const enum ListAdminAuditInfoQueryUserType {
+  /** 互联网上的任何人 */
+  All = 0,
+  /** 组织内成员 */
+  NormalUser = 1,
+  /** 组织外成员 */
+  ExternalUser = 2,
+}
+
 export interface ListAdminAuditInfoQuery extends Pagination {
   /** 此次调用中使用的用户ID的类型 */
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
@@ -248,7 +313,7 @@ export interface ListAdminAuditInfoQuery extends Pagination {
   /** 过滤模块 */
   event_module?: number
   /** 过滤用户类型. 仅当 operator_type=user 时生效 */
-  user_type?: 0 | 1 | 2
+  user_type?: ListAdminAuditInfoQueryUserType
   /** 过滤操作对象: 操作对象类型. 与object_value配合使用 */
   object_type?: number
   /** 过滤操作对象: 操作对象ID. 与object_type配合使用 */
@@ -257,41 +322,6 @@ export interface ListAdminAuditInfoQuery extends Pagination {
   ext_filter_object_by_ccm_token?: string
 }
 
-export interface CreateAdminBadgeResponse {
-  /** 勋章的信息 */
-  badge?: Badge
-}
-
-export interface UpdateAdminBadgeResponse {
-  /** 勋章信息 */
-  badge?: Badge
-}
-
-export interface CreateAdminBadgeImageResponse {
-  /** 图片的key */
-  image_key?: string
-}
-
-export interface GetAdminBadgeResponse {
-  /** 勋章信息 */
-  badge?: Badge
-}
-
-export interface CreateAdminBadgeGrantResponse {
-  /** 授予名单的信息 */
-  grant?: Grant
-}
-
-export interface UpdateAdminBadgeGrantResponse {
-  /** 授予名单 */
-  grant?: Grant
-}
-
-export interface GetAdminBadgeGrantResponse {
-  /** 授予名单信息 */
-  grant?: Grant
-}
-
 Internal.define({
   '/admin/v1/password/reset': {
     POST: 'resetAdminPassword',

package/src/types/aily.ts

@@ -98,6 +98,11 @@ export interface CreateAilyAilySessionRequest {
   metadata?: string
 }
 
+export interface CreateAilyAilySessionResponse {
+  /** 创建的会话信息 */
+  session?: AilySession
+}
+
 export interface UpdateAilyAilySessionRequest {
   /** 渠道上下文 */
   channel_context?: string
@@ -105,6 +110,16 @@ export interface UpdateAilyAilySessionRequest {
   metadata?: string
 }
 
+export interface UpdateAilyAilySessionResponse {
+  /** 会话信息 */
+  session?: AilySession
+}
+
+export interface GetAilyAilySessionResponse {
+  /** 会话信息 */
+  session?: AilySession
+}
+
 export interface CreateAilyAilySessionAilyMessageRequest {
   /** 幂等id，同一 session 下相同的幂等 id 算一条消息，有效期72h */
   idempotent_id: string
@@ -120,6 +135,16 @@ export interface CreateAilyAilySessionAilyMessageRequest {
   mentions?: AilyMention[]
 }
 
+export interface CreateAilyAilySessionAilyMessageResponse {
+  /** 消息信息 */
+  message?: AilyMessage
+}
+
+export interface GetAilyAilySessionAilyMessageResponse {
+  /** 消息信息 */
+  message?: AilyMessage
+}
+
 export interface ListAilyAilySessionAilyMessageQuery extends Pagination {
   /** 运行 ID */
   run_id?: string
@@ -138,67 +163,6 @@ export interface CreateAilyAilySessionRunRequest {
   metadata?: string
 }
 
-export interface StartAilyAppSkillRequest {
-  /** 技能的全局变量 */
-  global_variable?: SkillGlobalVariable
-  /** 技能的自定义变量 */
-  input?: string
-}
-
-export interface AskAilyAppKnowledgeRequest {
-  /** 输入消息（当前仅支持纯文本输入） */
-  message: AilyKnowledgeMessage
-  /** 控制知识问答所依据的数据知识范围 */
-  data_asset_ids?: string[]
-  /** 控制知识问答所依据的数据知识分类范围 */
-  data_asset_tag_ids?: string[]
-}
-
-export interface ListAilyAppDataAssetQuery extends Pagination {
-  /** 模糊匹配关键词 */
-  keyword?: string
-  /** 根据数据知识 ID 进行过滤 */
-  data_asset_ids?: string[]
-  /** 根据数据知识分类 ID 进行过滤 */
-  data_asset_tag_ids?: string[]
-  /** 结果是否包含数据与知识项目 */
-  with_data_asset_item?: boolean
-  /** 结果是否包含数据连接状态 */
-  with_connect_status?: boolean
-}
-
-export interface ListAilyAppDataAssetTagQuery extends Pagination {
-  /** 模糊匹配分类名称 */
-  keyword?: string
-  /** 模糊匹配分类名称 */
-  data_asset_tag_ids?: string[]
-}
-
-export interface CreateAilyAilySessionResponse {
-  /** 创建的会话信息 */
-  session?: AilySession
-}
-
-export interface UpdateAilyAilySessionResponse {
-  /** 会话信息 */
-  session?: AilySession
-}
-
-export interface GetAilyAilySessionResponse {
-  /** 会话信息 */
-  session?: AilySession
-}
-
-export interface CreateAilyAilySessionAilyMessageResponse {
-  /** 消息信息 */
-  message?: AilyMessage
-}
-
-export interface GetAilyAilySessionAilyMessageResponse {
-  /** 消息信息 */
-  message?: AilyMessage
-}
-
 export interface CreateAilyAilySessionRunResponse {
   /** 运行信息 */
   run?: Run
@@ -214,6 +178,13 @@ export interface CancelAilyAilySessionRunResponse {
   run?: Run
 }
 
+export interface StartAilyAppSkillRequest {
+  /** 技能的全局变量 */
+  global_variable?: SkillGlobalVariable
+  /** 技能的自定义变量 */
+  input?: string
+}
+
 export interface StartAilyAppSkillResponse {
   /** 技能的输出 */
   output?: string
@@ -226,6 +197,15 @@ export interface GetAilyAppSkillResponse {
   skill?: Skill
 }
 
+export interface AskAilyAppKnowledgeRequest {
+  /** 输入消息（当前仅支持纯文本输入） */
+  message: AilyKnowledgeMessage
+  /** 控制知识问答所依据的数据知识范围 */
+  data_asset_ids?: string[]
+  /** 控制知识问答所依据的数据知识分类范围 */
+  data_asset_tag_ids?: string[]
+}
+
 export interface AskAilyAppKnowledgeResponse {
   /** 响应状态，枚举值 */
   status?: 'processing' | 'finished'
@@ -241,6 +221,26 @@ export interface AskAilyAppKnowledgeResponse {
   has_answer?: boolean
 }
 
+export interface ListAilyAppDataAssetQuery extends Pagination {
+  /** 模糊匹配关键词 */
+  keyword?: string
+  /** 根据数据知识 ID 进行过滤 */
+  data_asset_ids?: string[]
+  /** 根据数据知识分类 ID 进行过滤 */
+  data_asset_tag_ids?: string[]
+  /** 结果是否包含数据与知识项目 */
+  with_data_asset_item?: boolean
+  /** 结果是否包含数据连接状态 */
+  with_connect_status?: boolean
+}
+
+export interface ListAilyAppDataAssetTagQuery extends Pagination {
+  /** 模糊匹配分类名称 */
+  keyword?: string
+  /** 模糊匹配分类名称 */
+  data_asset_tag_ids?: string[]
+}
+
 Internal.define({
   '/aily/v1/sessions': {
     POST: 'createAilyAilySession',