@satorijs/adapter-lark 3.12.3 → 3.12.5

package/src/types/apaas.ts

@@ -737,6 +737,7 @@ export namespace Apaas {
     export interface Methods {
       table: Table.Methods
       view: View.Methods
+      enum: Enum.Methods
       /**
        * 执行SQL
        * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace/sql_commands
@@ -756,6 +757,16 @@ export namespace Apaas {
 
     export namespace Table {
       export interface Methods {
+        /**
+         * 获取工作空间下的数据表列表
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/list
+         */
+        list(workspace_id: string, query?: Pagination): Paginated<Lark.WorkspaceDataTable>
+        /**
+         * 获取数据表详细信息
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/table_get
+         */
+        tableGet(workspace_id: string, table_name: string): Promise<TableGetResponse>
         /**
          * 查询数据表数据记录
          * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-table/records_get
@@ -783,6 +794,15 @@ export namespace Apaas {
         recordsDelete(workspace_id: string, table_name: string, query?: RecordsDeleteQuery): Promise<void>
       }
 
+      export interface TableGetResponse {
+        /** 数据表名，如 student */
+        name: string
+        /** 数据表描述 */
+        description: string
+        /** 数据表列 */
+        columns: Lark.WorkspaceDataTableColumnInfo[]
+      }
+
       export interface RecordsGetQuery extends Pagination {
         /**
          * 返回的列，默认为 *，即返回所有列。
@@ -900,6 +920,34 @@ export namespace Apaas {
         items: string
       }
     }
+
+    export namespace Enum {
+      export interface Methods {
+        /**
+         * 获取工作空间下的自定义枚举列表
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-enum/list
+         */
+        list(workspace_id: string, query?: Pagination): Paginated<Lark.WorkspaceEnum>
+        /**
+         * 获取自定义枚举详细信息
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/workspace-enum/enum_get
+         */
+        enumGet(workspace_id: string, enum_name: string): Promise<EnumGetResponse>
+      }
+
+      export interface EnumGetResponse {
+        /** 枚举名称 */
+        name: string
+        /** 枚举描述 */
+        description: string
+        /** 枚举值列表 */
+        options: string[]
+        /** 创建时间，毫秒时间戳 */
+        created_at: string
+        /** 创建人 */
+        created_by: Lark.WorkspaceUserInfo
+      }
+    }
   }
 }
 
@@ -1013,6 +1061,12 @@ Internal.define({
   '/apaas/v1/user_tasks/{task_id}/chat_group': {
     POST: 'apaas.userTask.chatGroup',
   },
+  '/apaas/v1/workspaces/{workspace_id}/tables': {
+    GET: { name: 'apaas.workspace.table.list', pagination: { argIndex: 1 } },
+  },
+  '/apaas/v1/workspaces/{workspace_id}/tables/{table_name}': {
+    GET: 'apaas.workspace.table.tableGet',
+  },
   '/apaas/v1/workspaces/{workspace_id}/tables/{table_name}/records': {
     GET: 'apaas.workspace.table.recordsGet',
     POST: 'apaas.workspace.table.recordsPost',
@@ -1025,6 +1079,12 @@ Internal.define({
   '/apaas/v1/workspaces/{workspace_id}/views/{view_name}/records': {
     GET: 'apaas.workspace.view.viewsGet',
   },
+  '/apaas/v1/workspaces/{workspace_id}/enums': {
+    GET: { name: 'apaas.workspace.enum.list', pagination: { argIndex: 1 } },
+  },
+  '/apaas/v1/workspaces/{workspace_id}/enums/{enum_name}': {
+    GET: 'apaas.workspace.enum.enumGet',
+  },
   '/apaas/v1/workspaces/{workspace_id}/sql_commands': {
     POST: 'apaas.workspace.sqlCommands',
   },

package/src/types/application.ts

@@ -9,8 +9,13 @@ declare module '../internal' {
 
 export namespace Application {
   export interface Methods {
+    appAvatar: AppAvatar.Methods
     owner: Owner.Methods
     collaborators: Collaborators.Methods
+    base: Base.Methods
+    ability: Ability.Methods
+    config: Config.Methods
+    publish: Publish.Methods
     appVersion: AppVersion.Methods
     scope: Scope.Methods
     contactsRange: ContactsRange.Methods
@@ -186,6 +191,32 @@ export namespace Application {
     app_list?: Lark.Application[]
   }
 
+  export namespace AppAvatar {
+    export interface Methods {
+      upload: Upload.Methods
+    }
+
+    export namespace Upload {
+      export interface Methods {
+        /**
+         * 上传应用图标
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v7/application-v7/app_avatar-upload/create
+         */
+        create(form: CreateForm): Promise<CreateResponse>
+      }
+
+      export interface CreateForm {
+        /** 图片 */
+        avatar: Blob
+      }
+
+      export interface CreateResponse {
+        /** 图片 URL，给创建/更新应用使用 */
+        url?: string
+      }
+    }
+  }
+
   export namespace Owner {
     export interface Methods {
       /**
@@ -243,6 +274,106 @@ export namespace Application {
     }
   }
 
+  export namespace Base {
+    export interface Methods {
+      /**
+       * 更新应用基础信息配置
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v7/application-v7/application-base/patch
+       */
+      patch(app_id: string, body: PatchRequest): Promise<void>
+    }
+
+    export interface PatchRequest {
+      /** 应用名称描述多语种 */
+      i18ns?: Lark.AppI18nInfo[]
+      /** 应用icon图片链接 */
+      avatar_url?: string
+      /** 应用管理后台url链接 */
+      homepage_url?: string
+    }
+  }
+
+  export namespace Ability {
+    export interface Methods {
+      /**
+       * 更新应用能力配置
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v7/application-v7/application-ability/patch
+       */
+      patch(app_id: string, body: PatchRequest): Promise<void>
+    }
+
+    export interface PatchRequest {
+      /** 网页应用 */
+      web_app?: Lark.AppAbilityWeb
+      /** 机器人 */
+      bot?: Lark.AppAbilityBot
+    }
+  }
+
+  export namespace Config {
+    export interface Methods {
+      /**
+       * 更新应用开发配置
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v7/application-v7/application-config/patch
+       */
+      patch(app_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>
+    }
+
+    export interface PatchRequest {
+      /** 权限配置 */
+      scope?: Lark.AppConfigScope
+      /** 事件配置 */
+      event?: Lark.AppConfigEvent
+      /** 安全配置 */
+      security?: Lark.AppConfigSecurity
+      /** 可见性范围配置 */
+      visibility?: Lark.AppConfigVisibility
+      /** 通讯录权限范围配置 */
+      contacts?: Lark.AppConfigContactsRange
+      /** 事件与回调加密策略 */
+      event_and_callback_encrypt_strategy?: Lark.EventAndCallbackEncryptStrategy
+      /** 回调配置 */
+      callback?: Lark.AppConfigCallback
+    }
+
+    export interface PatchQuery {
+      /** 部门id 类型 */
+      department_id_type?: 'open_department_id' | 'department_id'
+      /** open_id 类型 */
+      user_id_type?: 'open_id' | 'user_id' | 'union_id'
+    }
+  }
+
+  export namespace Publish {
+    export interface Methods {
+      /**
+       * 提交发布自建应用
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v7/application-v7/application-publish/create
+       */
+      create(app_id: string, body: CreateRequest): Promise<CreateResponse>
+    }
+
+    export interface CreateRequest {
+      /** 移动端默认能力 */
+      mobile_default_ability?: 'gadget' | 'web_app' | 'bot'
+      /** PC端默认能力 */
+      pc_default_ability?: 'gadget' | 'web_app' | 'bot'
+      /** 申请理由 */
+      remark: string
+      /** 更新描述 */
+      changelog: string
+      /** 应用版本号 */
+      version?: string
+    }
+
+    export interface CreateResponse {
+      /** 应用版本ID */
+      version_id?: string
+      /** 应用版本号 */
+      version?: string
+    }
+  }
+
   export namespace AppVersion {
     export interface Methods {
       /**
@@ -678,6 +809,9 @@ export namespace Application {
 }
 
 Internal.define({
+  '/application/v7/app_avatar/upload': {
+    POST: { name: 'application.appAvatar.upload.create', multipart: true },
+  },
   '/application/v6/applications/{app_id}/owner': {
     PUT: 'application.owner.update',
   },
@@ -685,6 +819,18 @@ Internal.define({
     PUT: 'application.collaborators.update',
     GET: 'application.collaborators.get',
   },
+  '/application/v7/applications/{app_id}/base': {
+    PATCH: 'application.base.patch',
+  },
+  '/application/v7/applications/{app_id}/ability': {
+    PATCH: 'application.ability.patch',
+  },
+  '/application/v7/applications/{app_id}/config': {
+    PATCH: 'application.config.patch',
+  },
+  '/application/v7/applications/{app_id}/publish': {
+    POST: 'application.publish.create',
+  },
   '/application/v6/applications/{app_id}': {
     GET: 'application.get',
     PATCH: 'application.patch',

package/src/types/approval.ts

@@ -14,6 +14,7 @@ export namespace Approval {
     externalApproval: ExternalApproval.Methods
     externalInstance: ExternalInstance.Methods
     externalTask: ExternalTask.Methods
+    district: District.Methods
     /**
      * 创建审批定义
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create
@@ -129,6 +130,11 @@ export namespace Approval {
        * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get
        */
       get(instance_id: string, query?: GetQuery): Promise<GetResponse>
+      /**
+       * 批量获取审批实例 ID
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list
+       */
+      list(query?: ListQuery): Paginated<string, 'instance_code_list'>
       /**
        * 退回审批任务
        * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback
@@ -309,6 +315,15 @@ export namespace Approval {
       instance_code: string
     }
 
+    export interface ListQuery extends Pagination {
+      /** 审批定义唯一标识 */
+      approval_code: string
+      /** 审批实例创建时间区间（毫秒） */
+      start_time: string
+      /** 审批实例创建时间区间（毫秒） */
+      end_time: string
+    }
+
     export interface SpecifiedRollbackRequest {
       /** 用户ID */
       user_id: string
@@ -899,6 +914,56 @@ export namespace Approval {
       status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE'
     }
   }
+
+  export namespace District {
+    export interface Methods {
+      /**
+       * 查询地理库信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/district/list
+       */
+      list(query?: ListQuery): Promise<ListResponse>
+      /**
+       * 搜索地理库信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/district/search
+       */
+      search(body: SearchRequest, query?: SearchQuery): Promise<SearchResponse>
+    }
+
+    export interface ListQuery extends Pagination {
+      /** 指定根节点，仅遍历该节点下的数据，默认遍历根节点，返回值内容与list_type 参数有关 */
+      root_district_id?: string
+      /** 遍历类型，不同的类型内容会有差异 */
+      list_type?: 'sub_level' | 'leaf_level'
+      /** 返回指定语言的内容，默认返回英文数据 */
+      locale?: 'zh-CN' | 'en-US'
+    }
+
+    export interface ListResponse {
+      /** 地理库的版本，地理库更新时版本会同步更新，如果应用将地理数据存在本地，需要定时判断版本，在变化以及时更新本地数据 */
+      version?: string
+      has_more?: boolean
+      page_token?: string
+      /** 区域列表 */
+      items?: Lark.District[]
+    }
+
+    export interface SearchRequest {
+      /** 根据ID查询指定区域的信息 */
+      district_ids?: string[]
+      /** 关键字，用于模糊查询符合条件的地址信息 */
+      keyword?: string
+    }
+
+    export interface SearchQuery {
+      /** 语言 */
+      locale?: 'zh-CN' | 'en-US'
+    }
+
+    export interface SearchResponse {
+      /** 区域列表 */
+      items?: Lark.District[]
+    }
+  }
 }
 
 Internal.define({
@@ -910,6 +975,7 @@ Internal.define({
   },
   '/approval/v4/instances': {
     POST: 'approval.instance.create',
+    GET: { name: 'approval.instance.list', pagination: { argIndex: 0, itemsKey: 'instance_code_list' } },
   },
   '/approval/v4/instances/cancel': {
     POST: 'approval.instance.cancel',
@@ -984,4 +1050,10 @@ Internal.define({
   '/approval/v4/approvals/{approval_code}/unsubscribe': {
     POST: 'approval.unsubscribe',
   },
+  '/approval/v4/districts': {
+    GET: 'approval.district.list',
+  },
+  '/approval/v4/districts/search': {
+    POST: 'approval.district.search',
+  },
 })

package/src/types/bitable.ts

@@ -18,6 +18,7 @@ export namespace Bitable {
       dashboard: Dashboard.Methods
       role: Role.Methods
       workflow: Workflow.Methods
+      blockWorkflow: BlockWorkflow.Methods
       /**
        * 创建多维表格
        * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create
@@ -88,6 +89,7 @@ export namespace Bitable {
         view: View.Methods
         record: Record.Methods
         field: Field.Methods
+        fieldGroup: FieldGroup.Methods
         form: Form.Methods
         /**
          * 新增一个数据表
@@ -679,9 +681,34 @@ export namespace Bitable {
         }
       }
 
+      export namespace FieldGroup {
+        export interface Methods {
+          /**
+           * 创建字段编组
+           * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field_group/create
+           */
+          create(app_token: string, table_id: string, body: CreateRequest): Promise<CreateResponse>
+        }
+
+        export interface CreateRequest {
+          /** 要新增字段编组列表 */
+          field_groups: Lark.FieldGroup[]
+        }
+
+        export interface CreateResponse {
+          /** 字段编组的内容 */
+          field_groups?: string
+        }
+      }
+
       export namespace Form {
         export interface Methods {
           field: Field.Methods
+          /**
+           * 升级表单
+           * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/upgrade
+           */
+          upgrade(app_token: string, table_id: string, form_id: string, body: UpgradeRequest): Promise<UpgradeResponse>
           /**
            * 更新表单元数据
            * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch
@@ -694,6 +721,22 @@ export namespace Bitable {
           get(app_token: string, table_id: string, form_id: string): Promise<GetResponse>
         }
 
+        export interface UpgradeRequest {
+          /** 升级后的表单名称 */
+          form_name: string
+          /**
+           * 表单布局模式。可选值
+           * - traditional：传统布局
+           * - one_question_per_page：一页一题布局:
+           */
+          display_mode: Lark.FormDisplayMode
+        }
+
+        export interface UpgradeResponse {
+          /** 升级后的表单 */
+          form?: Lark.UpgradedForm
+        }
+
         export interface PatchRequest {
           /** 表单名称 */
           name?: string
@@ -943,6 +986,21 @@ export namespace Bitable {
         status: string
       }
     }
+
+    export namespace BlockWorkflow {
+      export interface Methods {
+        /**
+         * 列出工作流
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-block_workflow/list
+         */
+        list(app_token: string): Promise<ListResponse>
+      }
+
+      export interface ListResponse {
+        /** 工作流列表 */
+        workflows?: Lark.BlockWorkflow[]
+      }
+    }
   }
 }
 
@@ -1012,12 +1070,18 @@ Internal.define({
     PUT: 'bitable.app.table.field.update',
     DELETE: 'bitable.app.table.field.delete',
   },
+  '/bitable/v1/apps/{app_token}/tables/{table_id}/field_groups': {
+    POST: 'bitable.app.table.fieldGroup.create',
+  },
   '/bitable/v1/apps/{app_token}/dashboards/{block_id}/copy': {
     POST: 'bitable.app.dashboard.copy',
   },
   '/bitable/v1/apps/{app_token}/dashboards': {
     GET: { name: 'bitable.app.dashboard.list', pagination: { argIndex: 1, itemsKey: 'dashboards' } },
   },
+  '/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}/upgrade': {
+    POST: 'bitable.app.table.form.upgrade',
+  },
   '/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}': {
     PATCH: 'bitable.app.table.form.patch',
     GET: 'bitable.app.table.form.get',
@@ -1051,6 +1115,9 @@ Internal.define({
   '/bitable/v1/apps/{app_token}/workflows/{workflow_id}': {
     PUT: 'bitable.app.workflow.update',
   },
+  '/bitable/v1/apps/{app_token}/block_workflows': {
+    GET: 'bitable.app.blockWorkflow.list',
+  },
   '/bitable/v1/apps/{app_token}/roles': {
     POST: 'bitable.app.role.create',
     GET: { name: 'bitable.app.role.list', pagination: { argIndex: 1 } },

package/src/types/contact.ts

@@ -75,6 +75,11 @@ export namespace Contact {
        * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get
        */
       get(user_id: string, query?: GetQuery): Promise<GetResponse>
+      /**
+       * 通过 ID 获取用户姓名
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/basic_batch
+       */
+      basicBatch(body: BasicBatchRequest, query?: BasicBatchQuery): Promise<BasicBatchResponse>
       /**
        * 批量获取用户信息
        * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch
@@ -293,6 +298,21 @@ export namespace Contact {
       user?: Lark.User
     }
 
+    export interface BasicBatchRequest {
+      /** 用户ID */
+      user_ids: string[]
+    }
+
+    export interface BasicBatchQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+
+    export interface BasicBatchResponse {
+      /** 用户信息 */
+      users?: Lark.BasicUser[]
+    }
+
     export interface BatchQuery {
       /** 要查询的用户ID列表 */
       user_ids: string[]
@@ -1473,6 +1493,9 @@ Internal.define({
   '/contact/v3/users/{user_id}/update_user_id': {
     PATCH: 'contact.user.updateUserId',
   },
+  '/contact/v3/users/basic_batch': {
+    POST: 'contact.user.basicBatch',
+  },
   '/contact/v3/users/batch': {
     GET: 'contact.user.batch',
   },