@satorijs/adapter-lark 3.9.0 → 3.9.2

package/src/types/auth.ts

@@ -37,6 +37,13 @@ export interface TenantAccessTokenInternalAuthRequest {
   app_secret: string
 }
 
+export interface TenantAccessTokenInternalAuthResponse extends BaseResponse {
+  /** 访问 token */
+  tenant_access_token?: string
+  /** app_access_token 过期时间 */
+  expire?: number
+}
+
 export interface AppAccessTokenInternalAuthRequest {
   /** 应用唯一标识，创建应用后获得 */
   app_id: string
@@ -44,6 +51,13 @@ export interface AppAccessTokenInternalAuthRequest {
   app_secret: string
 }
 
+export interface AppAccessTokenInternalAuthResponse extends BaseResponse {
+  /** 访问 token */
+  app_access_token?: string
+  /** app_access_token 过期时间 */
+  expire?: number
+}
+
 export interface AppTicketResendAuthRequest {
   /** 应用唯一标识，创建应用后获得 */
   app_id: string
@@ -60,32 +74,18 @@ export interface AppAccessTokenAuthRequest {
   app_ticket: string
 }
 
-export interface TenantAccessTokenAuthRequest {
-  /** 应用唯一标识，创建应用 */
-  app_access_token: string
-  /** 应用秘钥，创建应用后获得 */
-  tenant_key: string
-}
-
-export interface TenantAccessTokenInternalAuthResponse extends BaseResponse {
-  /** 访问 token */
-  tenant_access_token?: string
-  /** app_access_token 过期时间 */
-  expire?: number
-}
-
-export interface AppAccessTokenInternalAuthResponse extends BaseResponse {
+export interface AppAccessTokenAuthResponse extends BaseResponse {
   /** 访问 token */
   app_access_token?: string
   /** app_access_token 过期时间 */
   expire?: number
 }
 
-export interface AppAccessTokenAuthResponse extends BaseResponse {
-  /** 访问 token */
-  app_access_token?: string
-  /** app_access_token 过期时间 */
-  expire?: number
+export interface TenantAccessTokenAuthRequest {
+  /** 应用唯一标识，创建应用 */
+  app_access_token: string
+  /** 应用秘钥，创建应用后获得 */
+  tenant_key: string
 }
 
 export interface TenantAccessTokenAuthResponse extends BaseResponse {

package/src/types/authen.ts

@@ -30,34 +30,6 @@ declare module '../internal' {
   }
 }
 
-export interface CreateAuthenOidcAccessTokenRequest {
-  /** 授权类型，**固定值** */
-  grant_type: string
-  /** 登录预授权码 */
-  code: string
-}
-
-export interface CreateAuthenOidcRefreshAccessTokenRequest {
-  /** 授权类型，**固定值**： */
-  grant_type: string
-  /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`，**每次请求，请注意使用最新获取到的`refresh_token`** */
-  refresh_token: string
-}
-
-export interface CreateAuthenAccessTokenRequest {
-  /** 授权类型，**固定值** */
-  grant_type: string
-  /** 登录预授权码，调用[获取登录预授权码](https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN)接口获取 */
-  code: string
-}
-
-export interface CreateAuthenRefreshAccessTokenRequest {
-  /** 授权类型，**固定值**： */
-  grant_type: string
-  /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`，**每次请求，请注意使用最新获取到的`refresh_token`** */
-  refresh_token: string
-}
-
 export interface GetAuthenUserInfoResponse {
   /** 用户姓名 */
   name?: string
@@ -89,6 +61,13 @@ export interface GetAuthenUserInfoResponse {
   employee_no?: string
 }
 
+export interface CreateAuthenOidcAccessTokenRequest {
+  /** 授权类型，**固定值** */
+  grant_type: string
+  /** 登录预授权码 */
+  code: string
+}
+
 export interface CreateAuthenOidcAccessTokenResponse {
   /** user_access_token，用于获取用户资源和访问某些open api */
   access_token: string
@@ -104,6 +83,13 @@ export interface CreateAuthenOidcAccessTokenResponse {
   scope?: string
 }
 
+export interface CreateAuthenOidcRefreshAccessTokenRequest {
+  /** 授权类型，**固定值**： */
+  grant_type: string
+  /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`，**每次请求，请注意使用最新获取到的`refresh_token`** */
+  refresh_token: string
+}
+
 export interface CreateAuthenOidcRefreshAccessTokenResponse {
   /** user_access_token，用于获取用户资源和访问某些open api */
   access_token: string
@@ -119,6 +105,13 @@ export interface CreateAuthenOidcRefreshAccessTokenResponse {
   scope?: string
 }
 
+export interface CreateAuthenAccessTokenRequest {
+  /** 授权类型，**固定值** */
+  grant_type: string
+  /** 登录预授权码，调用[获取登录预授权码](https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN)接口获取 */
+  code: string
+}
+
 export interface CreateAuthenAccessTokenResponse {
   /** user_access_token，用于获取用户资源 */
   access_token?: string
@@ -160,6 +153,13 @@ export interface CreateAuthenAccessTokenResponse {
   sid?: string
 }
 
+export interface CreateAuthenRefreshAccessTokenRequest {
+  /** 授权类型，**固定值**： */
+  grant_type: string
+  /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`，**每次请求，请注意使用最新获取到的`refresh_token`** */
+  refresh_token: string
+}
+
 export interface CreateAuthenRefreshAccessTokenResponse {
   /** user_access_token，用于获取用户资源 */
   access_token?: string

package/src/types/baike.ts

@@ -32,7 +32,7 @@ declare module '../internal' {
      * 获取词条列表
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list
      */
-    listBaikeEntity(query?: ListBaikeEntityQuery): Promise<ListBaikeEntityResponse>
+    listBaikeEntity(query?: ListBaikeEntityQuery): Promise<ListBaikeEntityResponse> & AsyncIterableIterator<Entity>
     /**
      * 精准搜索词条
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match
@@ -42,7 +42,7 @@ declare module '../internal' {
      * 模糊搜索词条
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search
      */
-    searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise<SearchBaikeEntityResponse>
+    searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise<SearchBaikeEntityResponse> & AsyncIterableIterator<Entity>
     /**
      * 词条高亮
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight
@@ -57,7 +57,7 @@ declare module '../internal' {
      * 获取词典分类
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list
      */
-    listBaikeClassification(query?: Pagination): Promise<ListBaikeClassificationResponse>
+    listBaikeClassification(query?: Pagination): Promise<ListBaikeClassificationResponse> & AsyncIterableIterator<Classification>
     /**
      * 上传图片
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload
@@ -93,6 +93,10 @@ export interface CreateBaikeDraftQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface CreateBaikeDraftResponse {
+  draft?: Draft
+}
+
 export interface UpdateBaikeDraftRequest {
   /** 实体词 Id */
   id?: string
@@ -113,6 +117,10 @@ export interface UpdateBaikeDraftQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface UpdateBaikeDraftResponse {
+  draft?: Draft
+}
+
 export interface CreateBaikeEntityRequest {
   /** 词条名 */
   main_keys: Term[]
@@ -133,6 +141,10 @@ export interface CreateBaikeEntityQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface CreateBaikeEntityResponse {
+  entity?: Entity
+}
+
 export interface UpdateBaikeEntityRequest {
   /** 词条名 */
   main_keys: Term[]
@@ -153,6 +165,10 @@ export interface UpdateBaikeEntityQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface UpdateBaikeEntityResponse {
+  entity?: Entity
+}
+
 export interface GetBaikeEntityQuery {
   /** 外部系统 */
   provider?: string
@@ -162,6 +178,11 @@ export interface GetBaikeEntityQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface GetBaikeEntityResponse {
+  /** 实体词 */
+  entity?: Entity
+}
+
 export interface ListBaikeEntityQuery extends Pagination {
   /** 相关外部系统【可用来过滤词条数据】 */
   provider?: string
@@ -169,11 +190,22 @@ export interface ListBaikeEntityQuery extends Pagination {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface ListBaikeEntityResponse {
+  entities?: Entity[]
+  /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
+  page_token?: string
+}
+
 export interface MatchBaikeEntityRequest {
   /** 搜索关键词，将与词条名、别名进行精准匹配 */
   word: string
 }
 
+export interface MatchBaikeEntityResponse {
+  /** 匹配结果 */
+  results?: MatchInfo[]
+}
+
 export interface SearchBaikeEntityRequest {
   /** 搜索关键词 */
   query?: string
@@ -190,55 +222,6 @@ export interface SearchBaikeEntityQuery extends Pagination {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
-export interface HighlightBaikeEntityRequest {
-  /** 需要识别百科词条的内容（不超过1000字） */
-  text: string
-}
-
-export interface ExtractBaikeEntityRequest {
-  /** 需要被提取百科实体词的文本（不会过滤租户已成为百科词条的内容） */
-  text?: string
-}
-
-export interface UploadBaikeFileForm {
-  /** 文件名称，当前仅支持上传图片且图片格式为以下六种：icon、bmp、gif、png、jpeg、webp */
-  name: string
-  /** 二进制文件内容，高宽像素在 320-4096 像素之间，大小在 3KB-10MB 的图片 */
-  file: Blob
-}
-
-export interface CreateBaikeDraftResponse {
-  draft?: Draft
-}
-
-export interface UpdateBaikeDraftResponse {
-  draft?: Draft
-}
-
-export interface CreateBaikeEntityResponse {
-  entity?: Entity
-}
-
-export interface UpdateBaikeEntityResponse {
-  entity?: Entity
-}
-
-export interface GetBaikeEntityResponse {
-  /** 实体词 */
-  entity?: Entity
-}
-
-export interface ListBaikeEntityResponse {
-  entities?: Entity[]
-  /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
-  page_token?: string
-}
-
-export interface MatchBaikeEntityResponse {
-  /** 匹配结果 */
-  results?: MatchInfo[]
-}
-
 export interface SearchBaikeEntityResponse {
   /** 数据数组 */
   entities?: Entity[]
@@ -246,11 +229,21 @@ export interface SearchBaikeEntityResponse {
   page_token?: string
 }
 
+export interface HighlightBaikeEntityRequest {
+  /** 需要识别百科词条的内容（不超过1000字） */
+  text: string
+}
+
 export interface HighlightBaikeEntityResponse {
   /** 返回识别到的实体词信息 */
   phrases?: Phrase[]
 }
 
+export interface ExtractBaikeEntityRequest {
+  /** 需要被提取百科实体词的文本（不会过滤租户已成为百科词条的内容） */
+  text?: string
+}
+
 export interface ExtractBaikeEntityResponse {
   /** 文本中可能的成为百科词条的实体词 */
   entity_word: EntityWord[]
@@ -262,6 +255,13 @@ export interface ListBaikeClassificationResponse {
   page_token?: string
 }
 
+export interface UploadBaikeFileForm {
+  /** 文件名称，当前仅支持上传图片且图片格式为以下六种：icon、bmp、gif、png、jpeg、webp */
+  name: string
+  /** 二进制文件内容，高宽像素在 320-4096 像素之间，大小在 3KB-10MB 的图片 */
+  file: Blob
+}
+
 export interface UploadBaikeFileResponse {
   /** 文件 token */
   file_token?: string
@@ -276,7 +276,7 @@ Internal.define({
   },
   '/baike/v1/entities': {
     POST: 'createBaikeEntity',
-    GET: 'listBaikeEntity',
+    GET: { name: 'listBaikeEntity', pagination: { argIndex: 0, itemsKey: 'entities' } },
   },
   '/baike/v1/entities/{entity_id}': {
     PUT: 'updateBaikeEntity',
@@ -286,7 +286,7 @@ Internal.define({
     POST: 'matchBaikeEntity',
   },
   '/baike/v1/entities/search': {
-    POST: 'searchBaikeEntity',
+    POST: { name: 'searchBaikeEntity', pagination: { argIndex: 1, itemsKey: 'entities' } },
   },
   '/baike/v1/entities/highlight': {
     POST: 'highlightBaikeEntity',
@@ -295,7 +295,7 @@ Internal.define({
     POST: 'extractBaikeEntity',
   },
   '/baike/v1/classifications': {
-    GET: 'listBaikeClassification',
+    GET: { name: 'listBaikeClassification', pagination: { argIndex: 0 } },
   },
   '/baike/v1/files/upload': {
     POST: { name: 'uploadBaikeFile', multipart: true },