@satorijs/adapter-lark 3.8.5 → 3.9.0

package/lib/types/auth.d.ts

@@ -0,0 +1,86 @@
+import { BaseResponse } from '../internal';
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 自建应用获取 tenant_access_token
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal
+         */
+        tenantAccessTokenInternalAuth(body: TenantAccessTokenInternalAuthRequest): Promise<TenantAccessTokenInternalAuthResponse>;
+        /**
+         * 自建应用获取 app_access_token
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token_internal
+         */
+        appAccessTokenInternalAuth(body: AppAccessTokenInternalAuthRequest): Promise<AppAccessTokenInternalAuthResponse>;
+        /**
+         * 重新获取 app_ticket
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_ticket_resend
+         */
+        appTicketResendAuth(body: AppTicketResendAuthRequest): Promise<void>;
+        /**
+         * 商店应用获取 app_access_token
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token
+         */
+        appAccessTokenAuth(body: AppAccessTokenAuthRequest): Promise<AppAccessTokenAuthResponse>;
+        /**
+         * 商店应用获取 tenant_access_token
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token
+         */
+        tenantAccessTokenAuth(body: TenantAccessTokenAuthRequest): Promise<TenantAccessTokenAuthResponse>;
+    }
+}
+export interface TenantAccessTokenInternalAuthRequest {
+    /** 应用唯一标识，创建应用后获得 */
+    app_id: string;
+    /** 应用秘钥，创建应用后获得 */
+    app_secret: string;
+}
+export interface AppAccessTokenInternalAuthRequest {
+    /** 应用唯一标识，创建应用后获得 */
+    app_id: string;
+    /** 应用秘钥，创建应用后获得 */
+    app_secret: string;
+}
+export interface AppTicketResendAuthRequest {
+    /** 应用唯一标识，创建应用后获得 */
+    app_id: string;
+    /** 应用秘钥，创建应用后获得 */
+    app_secret: string;
+}
+export interface AppAccessTokenAuthRequest {
+    /** 应用唯一标识，创建应用后获得 */
+    app_id: string;
+    /** 应用秘钥，创建应用后获得 */
+    app_secret: string;
+    /** 平台定时推送给应用的临时凭证，通过事件监听机制获得 */
+    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 {
+    /** 访问 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 TenantAccessTokenAuthResponse extends BaseResponse {
+    /** 访问 token */
+    tenant_access_token?: string;
+    /** app_access_token 过期时间 */
+    expire?: number;
+}

package/lib/types/authen.d.ts

@@ -0,0 +1,191 @@
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 获取用户信息
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/user_info/get
+         */
+        getAuthenUserInfo(): Promise<GetAuthenUserInfoResponse>;
+        /**
+         * 获取 user_access_token
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create
+         */
+        createAuthenOidcAccessToken(body: CreateAuthenOidcAccessTokenRequest): Promise<CreateAuthenOidcAccessTokenResponse>;
+        /**
+         * 刷新 user_access_token
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-refresh_access_token/create
+         */
+        createAuthenOidcRefreshAccessToken(body: CreateAuthenOidcRefreshAccessTokenRequest): Promise<CreateAuthenOidcRefreshAccessTokenResponse>;
+        /**
+         * 获取 user_access_token（v1 版本）
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/access_token/create
+         */
+        createAuthenAccessToken(body: CreateAuthenAccessTokenRequest): Promise<CreateAuthenAccessTokenResponse>;
+        /**
+         * 刷新 user_access_token（v1 版本）
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/refresh_access_token/create
+         */
+        createAuthenRefreshAccessToken(body: CreateAuthenRefreshAccessTokenRequest): Promise<CreateAuthenRefreshAccessTokenResponse>;
+    }
+}
+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;
+    /** 用户英文名称 */
+    en_name?: string;
+    /** 用户头像 */
+    avatar_url?: string;
+    /** 用户头像 72x72 */
+    avatar_thumb?: string;
+    /** 用户头像 240x240 */
+    avatar_middle?: string;
+    /** 用户头像 640x640 */
+    avatar_big?: string;
+    /** 用户在应用内的唯一标识 */
+    open_id?: string;
+    /** 用户统一ID */
+    union_id?: string;
+    /** 用户邮箱 */
+    email?: string;
+    /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */
+    enterprise_email?: string;
+    /** 用户 user_id */
+    user_id?: string;
+    /** 用户手机号 */
+    mobile?: string;
+    /** 当前企业标识 */
+    tenant_key?: string;
+    /** 用户工号 */
+    employee_no?: string;
+}
+export interface CreateAuthenOidcAccessTokenResponse {
+    /** user_access_token，用于获取用户资源和访问某些open api */
+    access_token: string;
+    /** 刷新用户 `access_token` 时使用的 token */
+    refresh_token?: string;
+    /** token 类型，固定值 */
+    token_type: string;
+    /** `access_token`的有效期，单位: 秒，一般是两个小时左右，需要以返回结果为准 */
+    expires_in?: number;
+    /** `refresh_token` 的有效期，单位: 秒，一般是30天左右，需要以返回结果为准 */
+    refresh_expires_in?: number;
+    /** 用户授予app的权限全集 */
+    scope?: string;
+}
+export interface CreateAuthenOidcRefreshAccessTokenResponse {
+    /** user_access_token，用于获取用户资源和访问某些open api */
+    access_token: string;
+    /** 刷新用户 `access_token` 时使用的 token */
+    refresh_token?: string;
+    /** token 类型，固定值 */
+    token_type: string;
+    /** `access_token`的有效期，单位: 秒，一般是两个小时左右，需要以返回结果为准 */
+    expires_in?: number;
+    /** `refresh_token` 的有效期，单位: 秒，一般是30天左右，需要以返回结果为准 */
+    refresh_expires_in?: number;
+    /** 用户授予app的权限全集 */
+    scope?: string;
+}
+export interface CreateAuthenAccessTokenResponse {
+    /** user_access_token，用于获取用户资源 */
+    access_token?: string;
+    /** token 类型 */
+    token_type?: string;
+    /** `access_token`的有效期，单位: 秒 */
+    expires_in?: number;
+    /** 用户姓名 */
+    name?: string;
+    /** 用户英文名称 */
+    en_name?: string;
+    /** 用户头像 */
+    avatar_url?: string;
+    /** 用户头像 72x72 */
+    avatar_thumb?: string;
+    /** 用户头像 240x240 */
+    avatar_middle?: string;
+    /** 用户头像 640x640 */
+    avatar_big?: string;
+    /** 用户在应用内的唯一标识 */
+    open_id?: string;
+    /** 用户统一ID */
+    union_id?: string;
+    /** 用户邮箱 */
+    email?: string;
+    /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */
+    enterprise_email?: string;
+    /** 用户 user_id */
+    user_id?: string;
+    /** 用户手机号 */
+    mobile?: string;
+    /** 当前企业标识 */
+    tenant_key?: string;
+    /** `refresh_token` 的有效期，单位: 秒 */
+    refresh_expires_in?: number;
+    /** 刷新用户 `access_token` 时使用的 token */
+    refresh_token?: string;
+    /** 用户当前登录态session的唯一标识，为空则不返回 */
+    sid?: string;
+}
+export interface CreateAuthenRefreshAccessTokenResponse {
+    /** user_access_token，用于获取用户资源 */
+    access_token?: string;
+    /** token 类型 */
+    token_type?: string;
+    /** `access_token`的有效期，单位: 秒 */
+    expires_in?: number;
+    /** 用户姓名 */
+    name?: string;
+    /** 用户英文名称 */
+    en_name?: string;
+    /** 用户头像 */
+    avatar_url?: string;
+    /** 用户头像 72x72 */
+    avatar_thumb?: string;
+    /** 用户头像 240x240 */
+    avatar_middle?: string;
+    /** 用户头像 640x640 */
+    avatar_big?: string;
+    /** 用户在应用内的唯一标识 */
+    open_id?: string;
+    /** 用户统一ID */
+    union_id?: string;
+    /** 用户邮箱 */
+    email?: string;
+    /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */
+    enterprise_email?: string;
+    /** 用户 user_id */
+    user_id?: string;
+    /** 用户手机号 */
+    mobile?: string;
+    /** 当前企业标识 */
+    tenant_key?: string;
+    /** `refresh_token` 的有效期，单位: 秒 */
+    refresh_expires_in?: number;
+    /** 刷新用户 `access_token` 时使用的 token */
+    refresh_token?: string;
+    /** 用户当前登录态session的唯一标识，为空则不返回 */
+    sid?: string;
+}

package/lib/types/baike.d.ts

@@ -0,0 +1,239 @@
+import { Classification, ClassificationFilter, Draft, Entity, EntityWord, MatchInfo, OuterInfo, Phrase, RelatedMeta, Term } 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>;
+        /**
+         * 精准搜索词条
+         * @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>;
+        /**
+         * 词条高亮
+         * @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>;
+        /**
+         * 上传图片
+         * @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>;
+    }
+}
+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 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 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 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 GetBaikeEntityQuery {
+    /** 外部系统 */
+    provider?: string;
+    /** 词条在外部系统中对应的唯一 ID */
+    outer_id?: string;
+    /** 此次调用中使用的用户ID的类型 */
+    user_id_type?: 'user_id' | 'union_id' | 'open_id';
+}
+export interface ListBaikeEntityQuery extends Pagination {
+    /** 相关外部系统【可用来过滤词条数据】 */
+    provider?: string;
+    /** 此次调用中使用的用户ID的类型 */
+    user_id_type?: 'user_id' | 'union_id' | 'open_id';
+}
+export interface MatchBaikeEntityRequest {
+    /** 搜索关键词，将与词条名、别名进行精准匹配 */
+    word: string;
+}
+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 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[];
+    /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
+    page_token?: string;
+}
+export interface HighlightBaikeEntityResponse {
+    /** 返回识别到的实体词信息 */
+    phrases?: Phrase[];
+}
+export interface ExtractBaikeEntityResponse {
+    /** 文本中可能的成为百科词条的实体词 */
+    entity_word: EntityWord[];
+}
+export interface ListBaikeClassificationResponse {
+    items?: Classification[];
+    /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */
+    page_token?: string;
+}
+export interface UploadBaikeFileResponse {
+    /** 文件 token */
+    file_token?: string;
+}