@satorijs/adapter-lark 3.10.6 → 3.11.0

package/lib/types/baike.d.ts

@@ -1,239 +1,264 @@
-import { Classification, ClassificationFilter, Draft, Entity, EntityWord, MatchInfo, OuterInfo, Phrase, RelatedMeta, Term } from '.';
+import * as Lark from '.';
 import { Pagination } from '../internal';
 declare module '../internal' {
     interface Internal {
-        /**
-         * 创建草稿
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/create
-         */
-        createBaikeDraft(body: CreateBaikeDraftRequest, query?: CreateBaikeDraftQuery): Promise<CreateBaikeDraftResponse>;
-        /**
-         * 更新草稿
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/update
-         */
-        updateBaikeDraft(draft_id: string, body: UpdateBaikeDraftRequest, query?: UpdateBaikeDraftQuery): Promise<UpdateBaikeDraftResponse>;
-        /**
-         * 创建免审词条
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create
-         */
-        createBaikeEntity(body: CreateBaikeEntityRequest, query?: CreateBaikeEntityQuery): Promise<CreateBaikeEntityResponse>;
-        /**
-         * 更新免审词条
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update
-         */
-        updateBaikeEntity(entity_id: string, body: UpdateBaikeEntityRequest, query?: UpdateBaikeEntityQuery): Promise<UpdateBaikeEntityResponse>;
-        /**
-         * 获取词条详情
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get
-         */
-        getBaikeEntity(entity_id: string, query?: GetBaikeEntityQuery): Promise<GetBaikeEntityResponse>;
-        /**
-         * 获取词条列表
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list
-         */
-        listBaikeEntity(query?: ListBaikeEntityQuery): Promise<ListBaikeEntityResponse> & AsyncIterableIterator<Entity>;
-        /**
-         * 精准搜索词条
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match
-         */
-        matchBaikeEntity(body: MatchBaikeEntityRequest): Promise<MatchBaikeEntityResponse>;
-        /**
-         * 模糊搜索词条
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search
-         */
-        searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise<SearchBaikeEntityResponse> & AsyncIterableIterator<Entity>;
-        /**
-         * 词条高亮
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight
-         */
-        highlightBaikeEntity(body: HighlightBaikeEntityRequest): Promise<HighlightBaikeEntityResponse>;
-        /**
-         * 提取潜在的词条
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract
-         */
-        extractBaikeEntity(body: ExtractBaikeEntityRequest): Promise<ExtractBaikeEntityResponse>;
-        /**
-         * 获取词典分类
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list
-         */
-        listBaikeClassification(query?: Pagination): Promise<ListBaikeClassificationResponse> & AsyncIterableIterator<Classification>;
-        /**
-         * 上传图片
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload
-         */
-        uploadBaikeFile(form: UploadBaikeFileForm): Promise<UploadBaikeFileResponse>;
-        /**
-         * 下载图片
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/download
-         */
-        downloadBaikeFile(file_token: string): Promise<ArrayBuffer>;
+        baike: Baike.Methods;
     }
 }
-export interface CreateBaikeDraftRequest {
-    /** 实体词 Id */
-    id?: string;
-    /** 词条名 */
-    main_keys: Term[];
-    /** 别名 */
-    aliases?: Term[];
-    /** 详情描述 */
-    description?: string;
-    /** 相关数据 */
-    related_meta?: RelatedMeta;
-    /** 外部 id 关联数据 */
-    outer_info?: OuterInfo;
-    /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
-    rich_text?: string;
-}
-export interface CreateBaikeDraftQuery {
-    /** 此次调用中使用的用户ID的类型 */
-    user_id_type?: 'user_id' | 'union_id' | 'open_id';
-}
-export interface CreateBaikeDraftResponse {
-    draft?: Draft;
-}
-export interface UpdateBaikeDraftRequest {
-    /** 实体词 Id */
-    id?: string;
-    /** 词条名 */
-    main_keys: Term[];
-    /** 别名 */
-    aliases?: Term[];
-    /** 详情描述 */
-    description?: string;
-    /** 相关数据 */
-    related_meta?: RelatedMeta;
-    /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
-    rich_text?: string;
-}
-export interface UpdateBaikeDraftQuery {
-    /** 此次调用中使用的用户ID的类型 */
-    user_id_type?: 'user_id' | 'union_id' | 'open_id';
-}
-export interface UpdateBaikeDraftResponse {
-    draft?: Draft;
-}
-export interface CreateBaikeEntityRequest {
-    /** 词条名 */
-    main_keys: Term[];
-    /** 别名 */
-    aliases?: Term[];
-    /** 详情描述 */
-    description?: string;
-    /** 相关数据 */
-    related_meta?: RelatedMeta;
-    /** 外部 id 关联数据 */
-    outer_info?: OuterInfo;
-    /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
-    rich_text?: string;
-}
-export interface CreateBaikeEntityQuery {
-    /** 此次调用中使用的用户ID的类型 */
-    user_id_type?: 'user_id' | 'union_id' | 'open_id';
-}
-export interface CreateBaikeEntityResponse {
-    entity?: Entity;
-}
-export interface UpdateBaikeEntityRequest {
-    /** 词条名 */
-    main_keys: Term[];
-    /** 别名 */
-    aliases?: Term[];
-    /** 详情描述 */
-    description?: string;
-    /** 相关数据 */
-    related_meta?: RelatedMeta;
-    /** 外部 id 关联数据 */
-    outer_info?: OuterInfo;
-    /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
-    rich_text?: string;
-}
-export interface UpdateBaikeEntityQuery {
-    /** 此次调用中使用的用户ID的类型 */
-    user_id_type?: 'user_id' | 'union_id' | 'open_id';
-}
-export interface UpdateBaikeEntityResponse {
-    entity?: Entity;
-}
-export interface GetBaikeEntityQuery {
-    /** 外部系统 */
-    provider?: string;
-    /** 词条在外部系统中对应的唯一 ID */
-    outer_id?: string;
-    /** 此次调用中使用的用户ID的类型 */
-    user_id_type?: 'user_id' | 'union_id' | 'open_id';
-}
-export interface GetBaikeEntityResponse {
-    /** 实体词 */
-    entity?: Entity;
-}
-export interface ListBaikeEntityQuery extends Pagination {
-    /** 相关外部系统【可用来过滤词条数据】 */
-    provider?: string;
-    /** 此次调用中使用的用户ID的类型 */
-    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;
-    /** 分类筛选 */
-    classification_filter?: ClassificationFilter;
-    /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */
-    sources?: number[];
-    /** 创建者 */
-    creators?: string[];
-}
-export interface SearchBaikeEntityQuery extends Pagination {
-    /** 此次调用中使用的用户ID的类型 */
-    user_id_type?: 'user_id' | 'union_id' | 'open_id';
-}
-export interface SearchBaikeEntityResponse {
-    /** 数据数组 */
-    entities?: Entity[];
-    /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
-    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[];
-}
-export interface ListBaikeClassificationResponse {
-    items?: Classification[];
-    /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
-    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;
+export declare namespace Baike {
+    interface Methods {
+        draft: Draft.Methods;
+        entity: Entity.Methods;
+        classification: Classification.Methods;
+        file: File.Methods;
+    }
+    namespace Draft {
+        interface Methods {
+            /**
+             * 创建草稿
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/create
+             */
+            create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
+            /**
+             * 更新草稿
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/update
+             */
+            update(draft_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
+        }
+        interface CreateRequest {
+            /** 实体词 Id */
+            id?: string;
+            /** 词条名 */
+            main_keys: Lark.Term[];
+            /** 别名 */
+            aliases?: Lark.Term[];
+            /** 详情描述 */
+            description?: string;
+            /** 相关数据 */
+            related_meta?: Lark.RelatedMeta;
+            /** 外部 id 关联数据 */
+            outer_info?: Lark.OuterInfo;
+            /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
+            rich_text?: string;
+        }
+        interface CreateQuery {
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface CreateResponse {
+            draft?: Lark.Draft;
+        }
+        interface UpdateRequest {
+            /** 实体词 Id */
+            id?: string;
+            /** 词条名 */
+            main_keys: Lark.Term[];
+            /** 别名 */
+            aliases?: Lark.Term[];
+            /** 详情描述 */
+            description?: string;
+            /** 相关数据 */
+            related_meta?: Lark.RelatedMeta;
+            /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
+            rich_text?: string;
+        }
+        interface UpdateQuery {
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface UpdateResponse {
+            draft?: Lark.Draft;
+        }
+    }
+    namespace Entity {
+        interface Methods {
+            /**
+             * 创建免审词条
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create
+             */
+            create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
+            /**
+             * 更新免审词条
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update
+             */
+            update(entity_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
+            /**
+             * 获取词条详情
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get
+             */
+            get(entity_id: string, query?: GetQuery): Promise<GetResponse>;
+            /**
+             * 获取词条列表
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list
+             */
+            list(query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.Entity>;
+            /**
+             * 精准搜索词条
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match
+             */
+            match(body: MatchRequest): Promise<MatchResponse>;
+            /**
+             * 模糊搜索词条
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search
+             */
+            search(body: SearchRequest, query?: SearchQuery): Promise<SearchResponse> & AsyncIterableIterator<Lark.Entity>;
+            /**
+             * 词条高亮
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight
+             */
+            highlight(body: HighlightRequest): Promise<HighlightResponse>;
+            /**
+             * 提取潜在的词条
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract
+             */
+            extract(body: ExtractRequest): Promise<ExtractResponse>;
+        }
+        interface CreateRequest {
+            /** 词条名 */
+            main_keys: Lark.Term[];
+            /** 别名 */
+            aliases?: Lark.Term[];
+            /** 详情描述 */
+            description?: string;
+            /** 相关数据 */
+            related_meta?: Lark.RelatedMeta;
+            /** 外部 id 关联数据 */
+            outer_info?: Lark.OuterInfo;
+            /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
+            rich_text?: string;
+        }
+        interface CreateQuery {
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface CreateResponse {
+            entity?: Lark.Entity;
+        }
+        interface UpdateRequest {
+            /** 词条名 */
+            main_keys: Lark.Term[];
+            /** 别名 */
+            aliases?: Lark.Term[];
+            /** 详情描述 */
+            description?: string;
+            /** 相关数据 */
+            related_meta?: Lark.RelatedMeta;
+            /** 外部 id 关联数据 */
+            outer_info?: Lark.OuterInfo;
+            /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
+            rich_text?: string;
+        }
+        interface UpdateQuery {
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface UpdateResponse {
+            entity?: Lark.Entity;
+        }
+        interface GetQuery {
+            /** 外部系统 */
+            provider?: string;
+            /** 词条在外部系统中对应的唯一 ID */
+            outer_id?: string;
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface GetResponse {
+            /** 实体词 */
+            entity?: Lark.Entity;
+        }
+        interface ListQuery extends Pagination {
+            /** 相关外部系统【可用来过滤词条数据】 */
+            provider?: string;
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface ListResponse {
+            entities?: Lark.Entity[];
+            /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
+            page_token?: string;
+        }
+        interface MatchRequest {
+            /** 搜索关键词，将与词条名、别名进行精准匹配 */
+            word: string;
+        }
+        interface MatchResponse {
+            /** 匹配结果 */
+            results?: Lark.MatchInfo[];
+        }
+        interface SearchRequest {
+            /** 搜索关键词 */
+            query?: string;
+            /** 分类筛选 */
+            classification_filter?: Lark.ClassificationFilter;
+            /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */
+            sources?: number[];
+            /** 创建者 */
+            creators?: string[];
+        }
+        interface SearchQuery extends Pagination {
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface SearchResponse {
+            /** 数据数组 */
+            entities?: Lark.Entity[];
+            /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
+            page_token?: string;
+        }
+        interface HighlightRequest {
+            /** 需要识别百科词条的内容（不超过1000字） */
+            text: string;
+        }
+        interface HighlightResponse {
+            /** 返回识别到的实体词信息 */
+            phrases?: Lark.Phrase[];
+        }
+        interface ExtractRequest {
+            /** 需要被提取百科实体词的文本（不会过滤租户已成为百科词条的内容） */
+            text?: string;
+        }
+        interface ExtractResponse {
+            /** 文本中可能的成为百科词条的实体词 */
+            entity_word: Lark.EntityWord[];
+        }
+    }
+    namespace Classification {
+        interface Methods {
+            /**
+             * 获取词典分类
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list
+             */
+            list(query?: Pagination): Promise<ListResponse> & AsyncIterableIterator<Lark.Classification>;
+        }
+        interface ListResponse {
+            items?: Lark.Classification[];
+            /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
+            page_token?: string;
+        }
+    }
+    namespace File {
+        interface Methods {
+            /**
+             * 上传图片
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload
+             */
+            upload(form: UploadForm): Promise<UploadResponse>;
+            /**
+             * 下载图片
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/download
+             */
+            download(file_token: string): Promise<ArrayBuffer>;
+        }
+        interface UploadForm {
+            /** 文件名称，当前仅支持上传图片且图片格式为以下六种：icon、bmp、gif、png、jpeg、webp */
+            name: string;
+            /** 二进制文件内容，高宽像素在 320-4096 像素之间，大小在 3KB-10MB 的图片 */
+            file: Blob;
+        }
+        interface UploadResponse {
+            /** 文件 token */
+            file_token?: string;
+        }
+    }
 }

package/lib/types/base.d.ts

@@ -0,0 +1,74 @@
+import * as Lark from '.';
+import { Pagination } from '../internal';
+declare module '../internal' {
+    interface Internal {
+        base: Base.Methods;
+    }
+}
+export declare namespace Base {
+    interface Methods {
+        app: App.Methods;
+    }
+    namespace App {
+        interface Methods {
+            role: Role.Methods;
+        }
+        namespace Role {
+            interface Methods {
+                /**
+                 * 新增自定义角色
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/advanced-permission/base-v2/app-role/create
+                 */
+                create(app_token: string, body: CreateRequest): Promise<CreateResponse>;
+                /**
+                 * 更新自定义角色
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/advanced-permission/base-v2/app-role/update
+                 */
+                update(app_token: string, role_id: string, body: UpdateRequest): Promise<UpdateResponse>;
+                /**
+                 * 列出自定义角色
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/advanced-permission/base-v2/app-role/list
+                 */
+                list(app_token: string, query?: Pagination): Promise<ListResponse> & AsyncIterableIterator<Lark.Role>;
+            }
+            interface CreateRequest {
+                /** 自定义权限的名字 */
+                role_name: string;
+                /** 数据表权限 */
+                table_roles: Lark.TableRole[];
+                /** block权限 */
+                block_roles?: Lark.BlockRole[];
+                /** base权限 */
+                base_rule?: Record<string, number>;
+            }
+            interface CreateResponse {
+                /** 自定义权限 */
+                role?: Lark.Role;
+            }
+            interface UpdateRequest {
+                /** 自定义权限的名字 */
+                role_name: string;
+                /** 数据表权限 */
+                table_roles: Lark.TableRole[];
+                /** block权限 */
+                block_roles?: Lark.BlockRole[];
+                /** base权限 */
+                base_rule?: Record<string, number>;
+            }
+            interface UpdateResponse {
+                /** 自定义角色 */
+                role?: Lark.Role;
+            }
+            interface ListResponse {
+                /** 自定义角色列表 */
+                items?: Lark.Role[];
+                /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */
+                page_token?: string;
+                /** 是否还有更多项 */
+                has_more?: boolean;
+                /** 总数 */
+                total?: number;
+            }
+        }
+    }
+}