@satorijs/adapter-lark 3.9.1 → 3.9.3

package/lib/types/bitable.d.ts

@@ -242,6 +242,9 @@ export interface CreateBitableAppRequest {
     /** 文档时区，说明见：https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
     time_zone?: string;
 }
+export interface CreateBitableAppResponse {
+    app?: App;
+}
 export interface CopyBitableAppRequest {
     /** 多维表格 App 名字 */
     name?: string;
@@ -252,16 +255,33 @@ export interface CopyBitableAppRequest {
     /** 文档时区，说明见：https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
     time_zone?: string;
 }
+export interface CopyBitableAppResponse {
+    app?: App;
+}
+export interface GetBitableAppResponse {
+    app?: DisplayApp;
+}
 export interface UpdateBitableAppRequest {
     /** 新的多维表格名字 */
     name?: string;
     /** 多维表格是否开启高级权限 */
     is_advanced?: boolean;
 }
+export interface UpdateBitableAppResponse {
+    app?: DisplayAppV2;
+}
 export interface CreateBitableAppTableRequest {
     /** 数据表 */
     table?: ReqTable;
 }
+export interface CreateBitableAppTableResponse {
+    /** 数据表的唯一标识id */
+    table_id?: string;
+    /** 默认表格视图的id，该字段仅在请求参数中填写了default_view_name或fields才会返回 */
+    default_view_id?: string;
+    /** 数据表初始字段的id列表，该字段仅在请求参数中填写了fields才会返回 */
+    field_id_list?: string[];
+}
 export interface BatchCreateBitableAppTableRequest {
     /** tables */
     tables?: ReqTable[];
@@ -270,10 +290,26 @@ export interface BatchCreateBitableAppTableQuery {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface BatchCreateBitableAppTableResponse {
+    table_ids?: string[];
+}
 export interface PatchBitableAppTableRequest {
     /** 数据表的新名称 */
     name?: string;
 }
+export interface PatchBitableAppTableResponse {
+    /** 数据表的名称 */
+    name?: string;
+}
+export interface ListBitableAppTableResponse {
+    /** 是否有下一页数据 */
+    has_more?: boolean;
+    /** 下一页分页的token */
+    page_token?: string;
+    /** 总数 */
+    total?: number;
+    items?: AppTable[];
+}
 export interface BatchDeleteBitableAppTableRequest {
     /** 删除的多条tableid列表 */
     table_ids?: string[];
@@ -284,19 +320,38 @@ export interface CreateBitableAppTableViewRequest {
     /** 视图类型 */
     view_type?: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form';
 }
+export interface CreateBitableAppTableViewResponse {
+    view?: AppTableView;
+}
 export interface PatchBitableAppTableViewRequest {
     /** 视图名称 */
     view_name?: string;
     /** 视图属性 */
     property?: AppTableViewProperty;
 }
+export interface PatchBitableAppTableViewResponse {
+    view?: AppTableView;
+}
 export interface ListBitableAppTableViewQuery extends Pagination {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface ListBitableAppTableViewResponse {
+    /** 视图列表 */
+    items?: AppTableView[];
+    /** 下一页分页的token */
+    page_token?: string;
+    /** 是否有下一页数据 */
+    has_more?: boolean;
+    /** 总数 */
+    total?: number;
+}
+export interface GetBitableAppTableViewResponse {
+    view?: AppTableView;
+}
 export interface CreateBitableAppTableRecordRequest {
     /** 记录字段 */
-    fields: unknown;
+    fields: Record<string, unknown>;
 }
 export interface CreateBitableAppTableRecordQuery {
     /** 此次调用中使用的用户ID的类型 */
@@ -306,9 +361,12 @@ export interface CreateBitableAppTableRecordQuery {
     /** 用于控制一致性读写，默认开启检查 */
     ignore_consistency_check?: boolean;
 }
+export interface CreateBitableAppTableRecordResponse {
+    record?: AppTableRecord;
+}
 export interface UpdateBitableAppTableRecordRequest {
     /** 记录字段 */
-    fields: unknown;
+    fields: Record<string, unknown>;
 }
 export interface UpdateBitableAppTableRecordQuery {
     /** 此次调用中使用的用户ID的类型 */
@@ -316,6 +374,9 @@ export interface UpdateBitableAppTableRecordQuery {
     /** 用于控制一致性读写，默认开启检查 */
     ignore_consistency_check?: boolean;
 }
+export interface UpdateBitableAppTableRecordResponse {
+    record?: AppTableRecord;
+}
 export interface SearchBitableAppTableRecordRequest {
     /** 视图Id,指定视图id则按照视图的筛选排序结果返回数据 */
     view_id?: string;
@@ -332,6 +393,22 @@ export interface SearchBitableAppTableRecordQuery extends Pagination {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface SearchBitableAppTableRecordResponse {
+    /** record 结果 */
+    items?: AppTableRecord[];
+    /** 是否有下一页数据 */
+    has_more?: boolean;
+    /** 下一页分页的token */
+    page_token?: string;
+    /** 总数 */
+    total?: number;
+}
+export interface DeleteBitableAppTableRecordResponse {
+    /** 是否成功删除 */
+    deleted?: boolean;
+    /** 删除的记录id */
+    record_id?: string;
+}
 export interface BatchCreateBitableAppTableRecordRequest {
     /** 记录 */
     records: AppTableRecord[];
@@ -344,6 +421,10 @@ export interface BatchCreateBitableAppTableRecordQuery {
     /** 用于控制一致性读写，默认开启检查 */
     ignore_consistency_check?: boolean;
 }
+export interface BatchCreateBitableAppTableRecordResponse {
+    /** 本次请求新增的记录列表 */
+    records?: AppTableRecord[];
+}
 export interface BatchUpdateBitableAppTableRecordRequest {
     /** 记录 */
     records: AppTableRecord[];
@@ -354,6 +435,10 @@ export interface BatchUpdateBitableAppTableRecordQuery {
     /** 用于控制一致性读写，默认开启检查 */
     ignore_consistency_check?: boolean;
 }
+export interface BatchUpdateBitableAppTableRecordResponse {
+    /** 更新后的记录 */
+    records?: AppTableRecord[];
+}
 export interface BatchGetBitableAppTableRecordRequest {
     /** 记录 id 列表 */
     record_ids: string[];
@@ -364,15 +449,69 @@ export interface BatchGetBitableAppTableRecordRequest {
     /** 控制是否返回自动计算的字段，true 表示返回 */
     automatic_fields?: boolean;
 }
+export interface BatchGetBitableAppTableRecordResponse {
+    /** 记录列表 */
+    records?: AppTableRecord[];
+    /** 禁止访问的记录列表(针对开启了高级权限的文档) */
+    forbidden_record_ids?: string[];
+    /** 不存在的记录列表 */
+    absent_record_ids?: string[];
+}
 export interface BatchDeleteBitableAppTableRecordRequest {
     /** 删除的多条记录id列表 */
     records: string[];
 }
+export interface BatchDeleteBitableAppTableRecordResponse {
+    /** 记录删除结果 */
+    records?: DeleteRecord[];
+}
+export declare const enum CreateBitableAppTableFieldRequestType {
+    /** 多行文本（默认值）、条码 */
+    Text = 1,
+    /** 数字（默认值）、进度、货币、评分 */
+    Number = 2,
+    /** 单选 */
+    SingleSelect = 3,
+    /** 多选 */
+    MultiSelect = 4,
+    /** 日期 */
+    DateTime = 5,
+    /** 复选框 */
+    Checkbox = 7,
+    /** 人员 */
+    User = 11,
+    /** 电话号码 */
+    PhoneNumber = 13,
+    /** 超链接 */
+    Url = 15,
+    /** 附件 */
+    Attachment = 17,
+    /** 单向关联 */
+    Link = 18,
+    /** 公式 */
+    Formula = 20,
+    /** 双向关联 */
+    DuplexLink = 21,
+    /** 地理位置 */
+    Location = 22,
+    /** 群组 */
+    GroupChat = 23,
+    /** 创建时间 */
+    CreatedTime = 1001,
+    /** 最后更新时间 */
+    ModifiedTime = 1002,
+    /** 创建人 */
+    CreatedUser = 1003,
+    /** 修改人 */
+    ModifiedUser = 1004,
+    /** 自动编号 */
+    AutoSerial = 1005
+}
 export interface CreateBitableAppTableFieldRequest {
     /** 字段名 */
     field_name: string;
     /** 字段类型 */
-    type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005;
+    type: CreateBitableAppTableFieldRequestType;
     /** 字段属性 */
     property?: AppTableFieldProperty;
     /** 字段的描述 */
@@ -384,11 +523,56 @@ export interface CreateBitableAppTableFieldQuery {
     /** 格式为标准的 uuid，操作的唯一标识，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */
     client_token?: string;
 }
+export interface CreateBitableAppTableFieldResponse {
+    field?: AppTableField;
+}
+export declare const enum UpdateBitableAppTableFieldRequestType {
+    /** 多行文本（默认值）、条码 */
+    Text = 1,
+    /** 数字（默认值）、进度、货币、评分 */
+    Number = 2,
+    /** 单选 */
+    SingleSelect = 3,
+    /** 多选 */
+    MultiSelect = 4,
+    /** 日期 */
+    DateTime = 5,
+    /** 复选框 */
+    Checkbox = 7,
+    /** 人员 */
+    User = 11,
+    /** 电话号码 */
+    PhoneNumber = 13,
+    /** 超链接 */
+    Url = 15,
+    /** 附件 */
+    Attachment = 17,
+    /** 单向关联 */
+    Link = 18,
+    /** 公式 */
+    Formula = 20,
+    /** 双向关联 */
+    DuplexLink = 21,
+    /** 地理位置 */
+    Location = 22,
+    /** 群组 */
+    GroupChat = 23,
+    /** 创建时间 */
+    CreatedTime = 1001,
+    /** 最后更新时间 */
+    ModifiedTime = 1002,
+    /** 创建人 */
+    CreatedUser = 1003,
+    /** 修改人 */
+    ModifiedUser = 1004,
+    /** 自动编号 */
+    AutoSerial = 1005
+}
 export interface UpdateBitableAppTableFieldRequest {
     /** 字段名 */
     field_name: string;
     /** 字段类型 */
-    type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005;
+    type: UpdateBitableAppTableFieldRequestType;
     /** 字段属性 */
     property?: AppTableFieldProperty;
     /** 字段的描述 */
@@ -396,16 +580,41 @@ export interface UpdateBitableAppTableFieldRequest {
     /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */
     ui_type?: 'Text' | 'Email' | 'Barcode' | 'Number' | 'Progress' | 'Currency' | 'Rating' | 'SingleSelect' | 'MultiSelect' | 'DateTime' | 'Checkbox' | 'User' | 'GroupChat' | 'Phone' | 'Url' | 'Attachment' | 'SingleLink' | 'Formula' | 'DuplexLink' | 'Location' | 'CreatedTime' | 'ModifiedTime' | 'CreatedUser' | 'ModifiedUser' | 'AutoNumber';
 }
+export interface UpdateBitableAppTableFieldResponse {
+    field?: AppTableField;
+}
 export interface ListBitableAppTableFieldQuery extends Pagination {
     /** 视图 ID */
     view_id?: string;
     /** 控制字段描述（多行文本格式）数据的返回格式, true 表示以数组富文本形式返回 */
     text_field_as_array?: boolean;
 }
+export interface ListBitableAppTableFieldResponse {
+    /** 是否有下一页数据 */
+    has_more?: boolean;
+    /** 下一页分页的token */
+    page_token?: string;
+    /** 总数 */
+    total?: number;
+    /** 字段列表 */
+    items?: AppTableFieldForList[];
+}
+export interface DeleteBitableAppTableFieldResponse {
+    /** 字段唯一标识id */
+    field_id?: string;
+    /** 是否已删除 */
+    deleted?: boolean;
+}
 export interface CopyBitableAppDashboardRequest {
     /** 仪表盘名称 */
     name: string;
 }
+export interface CopyBitableAppDashboardResponse {
+    /** 多维表格 block_id */
+    block_id?: string;
+    /** block 名称 */
+    name?: string;
+}
 export interface PatchBitableAppTableFormRequest {
     /** 表单名称 */
     name?: string;
@@ -418,6 +627,14 @@ export interface PatchBitableAppTableFormRequest {
     /** 填写次数限制一次 */
     submit_limit_once?: boolean;
 }
+export interface PatchBitableAppTableFormResponse {
+    /** 表单元数据信息 */
+    form: AppTableForm;
+}
+export interface GetBitableAppTableFormResponse {
+    /** 表单元数据信息 */
+    form: AppTableForm;
+}
 export interface PatchBitableAppTableFormFieldRequest {
     /** 上一个表单问题 ID */
     pre_field_id?: string;
@@ -430,6 +647,20 @@ export interface PatchBitableAppTableFormFieldRequest {
     /** 是否可见 */
     visible?: boolean;
 }
+export interface PatchBitableAppTableFormFieldResponse {
+    /** 更新后的field值 */
+    field?: AppTableFormPatchedField;
+}
+export interface ListBitableAppTableFormFieldResponse {
+    /** 表单内的字段列表 */
+    items: AppTableFormField[];
+    /** 下一页分页的token */
+    page_token: string;
+    /** 是否有下一页 */
+    has_more: boolean;
+    /** 总数 */
+    total: number;
+}
 export interface CreateBitableAppRoleRequest {
     /** 自定义权限的名字 */
     role_name: string;
@@ -438,6 +669,9 @@ export interface CreateBitableAppRoleRequest {
     /** block权限 */
     block_roles?: AppRoleBlockRole[];
 }
+export interface CreateBitableAppRoleResponse {
+    role?: AppRole;
+}
 export interface UpdateBitableAppRoleRequest {
     /** 自定义权限的名字 */
     role_name: string;
@@ -446,6 +680,19 @@ export interface UpdateBitableAppRoleRequest {
     /** block权限 */
     block_roles?: AppRoleBlockRole[];
 }
+export interface UpdateBitableAppRoleResponse {
+    role?: AppRole;
+}
+export interface ListBitableAppRoleResponse {
+    /** 角色列表 */
+    items?: AppRole[];
+    /** 下一页分页的token */
+    page_token?: string;
+    /** 是否有下一页数据 */
+    has_more?: boolean;
+    /** 总数 */
+    total?: number;
+}
 export interface CreateBitableAppRoleMemberRequest {
     /** 协作者id */
     member_id: string;
@@ -458,6 +705,16 @@ export interface BatchCreateBitableAppRoleMemberRequest {
     /** 协作者列表 */
     member_list: AppRoleMemberId[];
 }
+export interface ListBitableAppRoleMemberResponse {
+    /** 协作者列表 */
+    items?: AppRoleMember[];
+    /** 是否有下一页数据 */
+    has_more?: boolean;
+    /** 下一页分页的token */
+    page_token?: string;
+    /** 总数 */
+    total?: number;
+}
 export interface DeleteBitableAppRoleMemberQuery {
     /** 协作者id类型，与请求体中的member_id要对应 */
     member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id';
@@ -466,6 +723,10 @@ export interface BatchDeleteBitableAppRoleMemberRequest {
     /** 协作者列表 */
     member_list: AppRoleMemberId[];
 }
+export interface ListBitableAppWorkflowResponse {
+    /** 自动化工作流信息 */
+    workflows: AppWorkflow[];
+}
 export interface UpdateBitableAppWorkflowRequest {
     /** 自动化状态 */
     status: string;
@@ -482,6 +743,9 @@ export interface GetBitableAppTableRecordQuery {
     /** 控制是否返回自动计算的字段，例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`，true 表示返回 */
     automatic_fields?: boolean;
 }
+export interface GetBitableAppTableRecordResponse {
+    record?: AppTableRecord;
+}
 export interface ListBitableAppTableRecordQuery extends Pagination {
     /** 视图 id注意：如 filter 或 sort 有值，view_id 会被忽略。 */
     view_id?: string;
@@ -500,186 +764,6 @@ export interface ListBitableAppTableRecordQuery extends Pagination {
     /** 控制是否返回自动计算的字段，例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`，true 表示返回 */
     automatic_fields?: boolean;
 }
-export interface CreateBitableAppResponse {
-    app?: App;
-}
-export interface CopyBitableAppResponse {
-    app?: App;
-}
-export interface GetBitableAppResponse {
-    app?: DisplayApp;
-}
-export interface UpdateBitableAppResponse {
-    app?: DisplayAppV2;
-}
-export interface CreateBitableAppTableResponse {
-    /** 数据表的唯一标识id */
-    table_id?: string;
-    /** 默认表格视图的id，该字段仅在请求参数中填写了default_view_name或fields才会返回 */
-    default_view_id?: string;
-    /** 数据表初始字段的id列表，该字段仅在请求参数中填写了fields才会返回 */
-    field_id_list?: string[];
-}
-export interface BatchCreateBitableAppTableResponse {
-    table_ids?: string[];
-}
-export interface PatchBitableAppTableResponse {
-    /** 数据表的名称 */
-    name?: string;
-}
-export interface ListBitableAppTableResponse {
-    /** 是否有下一页数据 */
-    has_more?: boolean;
-    /** 下一页分页的token */
-    page_token?: string;
-    /** 总数 */
-    total?: number;
-    items?: AppTable[];
-}
-export interface CreateBitableAppTableViewResponse {
-    view?: AppTableView;
-}
-export interface PatchBitableAppTableViewResponse {
-    view?: AppTableView;
-}
-export interface ListBitableAppTableViewResponse {
-    /** 视图列表 */
-    items?: AppTableView[];
-    /** 下一页分页的token */
-    page_token?: string;
-    /** 是否有下一页数据 */
-    has_more?: boolean;
-    /** 总数 */
-    total?: number;
-}
-export interface GetBitableAppTableViewResponse {
-    view?: AppTableView;
-}
-export interface CreateBitableAppTableRecordResponse {
-    record?: AppTableRecord;
-}
-export interface UpdateBitableAppTableRecordResponse {
-    record?: AppTableRecord;
-}
-export interface SearchBitableAppTableRecordResponse {
-    /** record 结果 */
-    items?: AppTableRecord[];
-    /** 是否有下一页数据 */
-    has_more?: boolean;
-    /** 下一页分页的token */
-    page_token?: string;
-    /** 总数 */
-    total?: number;
-}
-export interface DeleteBitableAppTableRecordResponse {
-    /** 是否成功删除 */
-    deleted?: boolean;
-    /** 删除的记录id */
-    record_id?: string;
-}
-export interface BatchCreateBitableAppTableRecordResponse {
-    /** 本次请求新增的记录列表 */
-    records?: AppTableRecord[];
-}
-export interface BatchUpdateBitableAppTableRecordResponse {
-    /** 更新后的记录 */
-    records?: AppTableRecord[];
-}
-export interface BatchGetBitableAppTableRecordResponse {
-    /** 记录列表 */
-    records?: AppTableRecord[];
-    /** 禁止访问的记录列表(针对开启了高级权限的文档) */
-    forbidden_record_ids?: string[];
-    /** 不存在的记录列表 */
-    absent_record_ids?: string[];
-}
-export interface BatchDeleteBitableAppTableRecordResponse {
-    /** 记录删除结果 */
-    records?: DeleteRecord[];
-}
-export interface CreateBitableAppTableFieldResponse {
-    field?: AppTableField;
-}
-export interface UpdateBitableAppTableFieldResponse {
-    field?: AppTableField;
-}
-export interface ListBitableAppTableFieldResponse {
-    /** 是否有下一页数据 */
-    has_more?: boolean;
-    /** 下一页分页的token */
-    page_token?: string;
-    /** 总数 */
-    total?: number;
-    /** 字段列表 */
-    items?: AppTableFieldForList[];
-}
-export interface DeleteBitableAppTableFieldResponse {
-    /** 字段唯一标识id */
-    field_id?: string;
-    /** 是否已删除 */
-    deleted?: boolean;
-}
-export interface CopyBitableAppDashboardResponse {
-    /** 多维表格 block_id */
-    block_id?: string;
-    /** block 名称 */
-    name?: string;
-}
-export interface PatchBitableAppTableFormResponse {
-    /** 表单元数据信息 */
-    form: AppTableForm;
-}
-export interface GetBitableAppTableFormResponse {
-    /** 表单元数据信息 */
-    form: AppTableForm;
-}
-export interface PatchBitableAppTableFormFieldResponse {
-    /** 更新后的field值 */
-    field?: AppTableFormPatchedField;
-}
-export interface ListBitableAppTableFormFieldResponse {
-    /** 表单内的字段列表 */
-    items: AppTableFormField[];
-    /** 下一页分页的token */
-    page_token: string;
-    /** 是否有下一页 */
-    has_more: boolean;
-    /** 总数 */
-    total: number;
-}
-export interface CreateBitableAppRoleResponse {
-    role?: AppRole;
-}
-export interface UpdateBitableAppRoleResponse {
-    role?: AppRole;
-}
-export interface ListBitableAppRoleResponse {
-    /** 角色列表 */
-    items?: AppRole[];
-    /** 下一页分页的token */
-    page_token?: string;
-    /** 是否有下一页数据 */
-    has_more?: boolean;
-    /** 总数 */
-    total?: number;
-}
-export interface ListBitableAppRoleMemberResponse {
-    /** 协作者列表 */
-    items?: AppRoleMember[];
-    /** 是否有下一页数据 */
-    has_more?: boolean;
-    /** 下一页分页的token */
-    page_token?: string;
-    /** 总数 */
-    total?: number;
-}
-export interface ListBitableAppWorkflowResponse {
-    /** 自动化工作流信息 */
-    workflows: AppWorkflow[];
-}
-export interface GetBitableAppTableRecordResponse {
-    record?: AppTableRecord;
-}
 export interface ListBitableAppTableRecordResponse {
     /** 是否有下一页数据 */
     has_more?: boolean;