@satorijs/adapter-lark 3.10.6 → 3.11.0

package/lib/types/cardkit.d.ts

@@ -1,139 +1,154 @@
-import { Card } from '.';
+import * as Lark from '.';
 declare module '../internal' {
     interface Internal {
-        /**
-         * 创建卡片实体
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/create
-         */
-        createCardkitCard(body: CreateCardkitCardRequest): Promise<CreateCardkitCardResponse>;
-        /**
-         * 更新卡片配置
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings
-         */
-        settingsCardkitCard(card_id: string, body: SettingsCardkitCardRequest): Promise<void>;
-        /**
-         * 批量更新卡片实体
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update
-         */
-        batchUpdateCardkitCard(card_id: string, body: BatchUpdateCardkitCardRequest): Promise<void>;
-        /**
-         * 全量更新卡片实体
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/update
-         */
-        updateCardkitCard(card_id: string, body: UpdateCardkitCardRequest): Promise<void>;
-        /**
-         * 转换 ID
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/id_convert
-         */
-        idConvertCardkitCard(body: IdConvertCardkitCardRequest): Promise<IdConvertCardkitCardResponse>;
-        /**
-         * 新增组件
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/create
-         */
-        createCardkitCardElement(card_id: string, body: CreateCardkitCardElementRequest): Promise<void>;
-        /**
-         * 更新组件
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/update
-         */
-        updateCardkitCardElement(card_id: string, element_id: string, body: UpdateCardkitCardElementRequest): Promise<void>;
-        /**
-         * 更新组件属性
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/patch
-         */
-        patchCardkitCardElement(card_id: string, element_id: string, body: PatchCardkitCardElementRequest): Promise<void>;
-        /**
-         * 流式更新文本
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/content
-         */
-        contentCardkitCardElement(card_id: string, element_id: string, body: ContentCardkitCardElementRequest): Promise<void>;
-        /**
-         * 删除组件
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/delete
-         */
-        deleteCardkitCardElement(card_id: string, element_id: string, body: DeleteCardkitCardElementRequest): Promise<void>;
+        cardkit: Cardkit.Methods;
     }
 }
-export interface CreateCardkitCardRequest {
-    /** 卡片数据的类型 */
-    type: string;
-    /** 卡片数据内容，与卡片数据的类型相对应 */
-    data: string;
-}
-export interface CreateCardkitCardResponse {
-    /** 卡片ID */
-    card_id: string;
-}
-export interface SettingsCardkitCardRequest {
-    /** 卡片设置 */
-    settings: string;
-    /** UUID */
-    uuid?: string;
-    /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
-    sequence: number;
-}
-export interface BatchUpdateCardkitCardRequest {
-    /** 幂等 id，最大长度为 64。可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
-    uuid?: string;
-    /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
-    sequence: number;
-    /** 操作列表，可选值有： partial_update_setting：更新卡片设置，此时 parmas 结构参考更新卡片设置接口请求体的 settings 字段 ；add_elements，此时 parmas 结构参考添加组件接口请求体的 type、target_element_id、elements 字段 ； delete_elements，此时 parmas 结构内仅支持 element_ids 参数，参数值为组件 ID 数组 ； partial_update_element，此时 parmas 结构包括参考局部更新组件接口的路径参数 element_id 和请求体 partial_element 字段 ; update_element，此时 parmas 结构参考全量更新组件接口的路径参数 element_id 和请求体 element 字段 */
-    actions: string;
-}
-export interface UpdateCardkitCardRequest {
-    /** 卡片内容 */
-    card: Card;
-    /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
-    uuid?: string;
-    /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
-    sequence: number;
-}
-export interface IdConvertCardkitCardRequest {
-    /** 消息ID */
-    message_id: string;
-}
-export interface IdConvertCardkitCardResponse {
-    /** 消息 ID 对应的卡片 ID */
-    card_id?: string;
-}
-export interface CreateCardkitCardElementRequest {
-    /** 添加组件的方式 */
-    type: 'insert_before' | 'insert_after' | 'append';
-    /** 目标组件的 ID。 当 type 为 insert_before、insert_after 时，为用于定位的目标组件。 当 type 为 append 时，该字段仅支持容器类组件，为用于指定末尾添加的目标组件，未填写默认为在卡片 body 末尾添加。 */
-    target_element_id?: string;
-    /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
-    uuid?: string;
-    /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
-    sequence: number;
-    /** 组件列表 */
-    elements: string;
-}
-export interface UpdateCardkitCardElementRequest {
-    /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
-    uuid?: string;
-    /** 新的组件 */
-    element: string;
-    /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
-    sequence: number;
-}
-export interface PatchCardkitCardElementRequest {
-    /** 要更改的组件部分配置内容，传入 id 参数后将对原有组件的 id 进行更新，不支持修改 tag 参数。 */
-    partial_element: string;
-    /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
-    uuid?: string;
-    /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
-    sequence: number;
-}
-export interface ContentCardkitCardElementRequest {
-    /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
-    uuid?: string;
-    /** 更新后的文本内容 */
-    content: string;
-    /** 顺序序号，用于保证更新文本内容的时序性。在卡片的单次 streaming 模式周期中（steaming 状态从开始到停止），该值需为递增的正整数，否则将报错。 */
-    sequence: number;
-}
-export interface DeleteCardkitCardElementRequest {
-    /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
-    uuid?: string;
-    /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
-    sequence: number;
+export declare namespace Cardkit {
+    interface Methods {
+        card: Card.Methods;
+    }
+    namespace Card {
+        interface Methods {
+            element: Element.Methods;
+            /**
+             * 创建卡片实体
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/create
+             */
+            create(body: CreateRequest): Promise<CreateResponse>;
+            /**
+             * 更新卡片配置
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings
+             */
+            settings(card_id: string, body: SettingsRequest): Promise<void>;
+            /**
+             * 批量更新卡片实体
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update
+             */
+            batchUpdate(card_id: string, body: BatchUpdateRequest): Promise<void>;
+            /**
+             * 全量更新卡片实体
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/update
+             */
+            update(card_id: string, body: UpdateRequest): Promise<void>;
+            /**
+             * 转换 ID
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/id_convert
+             */
+            idConvert(body: IdConvertRequest): Promise<IdConvertResponse>;
+        }
+        interface CreateRequest {
+            /** 卡片数据的类型 */
+            type: string;
+            /** 卡片数据内容，与卡片数据的类型相对应 */
+            data: string;
+        }
+        interface CreateResponse {
+            /** 卡片ID */
+            card_id: string;
+        }
+        interface SettingsRequest {
+            /** 卡片设置 */
+            settings: string;
+            /** UUID */
+            uuid?: string;
+            /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
+            sequence: number;
+        }
+        interface BatchUpdateRequest {
+            /** 幂等 id，最大长度为 64。可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
+            uuid?: string;
+            /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
+            sequence: number;
+            /** 操作列表，可选值有： partial_update_setting：更新卡片设置，此时 parmas 结构参考更新卡片设置接口请求体的 settings 字段 ；add_elements，此时 parmas 结构参考添加组件接口请求体的 type、target_element_id、elements 字段 ； delete_elements，此时 parmas 结构内仅支持 element_ids 参数，参数值为组件 ID 数组 ； partial_update_element，此时 parmas 结构包括参考局部更新组件接口的路径参数 element_id 和请求体 partial_element 字段 ; update_element，此时 parmas 结构参考全量更新组件接口的路径参数 element_id 和请求体 element 字段 */
+            actions: string;
+        }
+        interface UpdateRequest {
+            /** 卡片内容 */
+            card: Lark.Card;
+            /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
+            uuid?: string;
+            /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
+            sequence: number;
+        }
+        interface IdConvertRequest {
+            /** 消息ID */
+            message_id: string;
+        }
+        interface IdConvertResponse {
+            /** 消息 ID 对应的卡片 ID */
+            card_id?: string;
+        }
+        namespace Element {
+            interface Methods {
+                /**
+                 * 新增组件
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/create
+                 */
+                create(card_id: string, body: CreateRequest): Promise<void>;
+                /**
+                 * 更新组件
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/update
+                 */
+                update(card_id: string, element_id: string, body: UpdateRequest): Promise<void>;
+                /**
+                 * 更新组件属性
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/patch
+                 */
+                patch(card_id: string, element_id: string, body: PatchRequest): Promise<void>;
+                /**
+                 * 流式更新文本
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/content
+                 */
+                content(card_id: string, element_id: string, body: ContentRequest): Promise<void>;
+                /**
+                 * 删除组件
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/delete
+                 */
+                delete(card_id: string, element_id: string, body: DeleteRequest): Promise<void>;
+            }
+            interface CreateRequest {
+                /** 添加组件的方式 */
+                type: 'insert_before' | 'insert_after' | 'append';
+                /** 目标组件的 ID。 当 type 为 insert_before、insert_after 时，为用于定位的目标组件。 当 type 为 append 时，该字段仅支持容器类组件，为用于指定末尾添加的目标组件，未填写默认为在卡片 body 末尾添加。 */
+                target_element_id?: string;
+                /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
+                uuid?: string;
+                /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
+                sequence: number;
+                /** 组件列表 */
+                elements: string;
+            }
+            interface UpdateRequest {
+                /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
+                uuid?: string;
+                /** 新的组件 */
+                element: string;
+                /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
+                sequence: number;
+            }
+            interface PatchRequest {
+                /** 要更改的组件部分配置内容，传入 id 参数后将对原有组件的 id 进行更新，不支持修改 tag 参数。 */
+                partial_element: string;
+                /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
+                uuid?: string;
+                /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
+                sequence: number;
+            }
+            interface ContentRequest {
+                /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
+                uuid?: string;
+                /** 更新后的文本内容 */
+                content: string;
+                /** 顺序序号，用于保证更新文本内容的时序性。在卡片的单次 streaming 模式周期中（steaming 状态从开始到停止），该值需为递增的正整数，否则将报错。 */
+                sequence: number;
+            }
+            interface DeleteRequest {
+                /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */
+                uuid?: string;
+                /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */
+                sequence: number;
+            }
+        }
+    }
 }

package/lib/types/compensation.d.ts

@@ -1,54 +1,89 @@
-import { ArchiveDetail, ChangeReason, Indicator, Item, ItemCategory, PlanDetail } from '.';
-import { Pagination } from '../internal';
+import * as Lark from '.';
+import { Paginated, Pagination } from '../internal';
 declare module '../internal' {
     interface Internal {
-        /**
-         * 批量查询员工薪资档案
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query
-         */
-        queryCompensationArchive(body: QueryCompensationArchiveRequest, query?: QueryCompensationArchiveQuery): Paginated<ArchiveDetail>;
-        /**
-         * 批量查询薪资项
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list
-         */
-        listCompensationItem(query?: ListCompensationItemQuery): Paginated<Item>;
-        /**
-         * 批量查询薪资统计指标
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list
-         */
-        listCompensationIndicator(query?: Pagination): Paginated<Indicator>;
-        /**
-         * 批量获取薪资项分类信息
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item_category/list
-         */
-        listCompensationItemCategory(query?: Pagination): Paginated<ItemCategory>;
-        /**
-         * 批量查询薪资方案
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list
-         */
-        listCompensationPlan(query?: Pagination): Paginated<PlanDetail>;
-        /**
-         * 批量查询定调薪原因
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list
-         */
-        listCompensationChangeReason(query?: Pagination): Paginated<ChangeReason>;
+        compensation: Compensation.Methods;
     }
 }
-export interface QueryCompensationArchiveRequest {
-    /** 用户ID列表 */
-    user_id_list: string[];
-    /** 档案Tid列表 */
-    tid_list?: string[];
-    /** 生效开始时间 */
-    effective_start_date?: string;
-    /** 生效结束时间 */
-    effective_end_date?: string;
-}
-export interface QueryCompensationArchiveQuery extends Pagination {
-    /** 用户ID类型 */
-    user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
-}
-export interface ListCompensationItemQuery extends Pagination {
-    /** 薪酬项类型（不传则认为查询所有类型薪酬项） */
-    item_type?: 'salary' | 'bonus' | 'recurring_payment';
+export declare namespace Compensation {
+    interface Methods {
+        archive: Archive.Methods;
+        item: Item.Methods;
+        indicator: Indicator.Methods;
+        itemCategory: ItemCategory.Methods;
+        plan: Plan.Methods;
+        changeReason: ChangeReason.Methods;
+    }
+    namespace Archive {
+        interface Methods {
+            /**
+             * 批量查询员工薪资档案
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query
+             */
+            query(body: QueryRequest, query?: QueryQuery): Paginated<Lark.ArchiveDetail>;
+        }
+        interface QueryRequest {
+            /** 用户ID列表 */
+            user_id_list: string[];
+            /** 档案Tid列表 */
+            tid_list?: string[];
+            /** 生效开始时间 */
+            effective_start_date?: string;
+            /** 生效结束时间 */
+            effective_end_date?: string;
+        }
+        interface QueryQuery extends Pagination {
+            /** 用户ID类型 */
+            user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id';
+        }
+    }
+    namespace Item {
+        interface Methods {
+            /**
+             * 批量查询薪资项
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list
+             */
+            list(query?: ListQuery): Paginated<Lark.Item>;
+        }
+        interface ListQuery extends Pagination {
+            /** 薪酬项类型（不传则认为查询所有类型薪酬项） */
+            item_type?: 'salary' | 'bonus' | 'recurring_payment';
+        }
+    }
+    namespace Indicator {
+        interface Methods {
+            /**
+             * 批量查询薪资统计指标
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list
+             */
+            list(query?: Pagination): Paginated<Lark.Indicator>;
+        }
+    }
+    namespace ItemCategory {
+        interface Methods {
+            /**
+             * 批量获取薪资项分类信息
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item_category/list
+             */
+            list(query?: Pagination): Paginated<Lark.ItemCategory>;
+        }
+    }
+    namespace Plan {
+        interface Methods {
+            /**
+             * 批量查询薪资方案
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list
+             */
+            list(query?: Pagination): Paginated<Lark.PlanDetail>;
+        }
+    }
+    namespace ChangeReason {
+        interface Methods {
+            /**
+             * 批量查询定调薪原因
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list
+             */
+            list(query?: Pagination): Paginated<Lark.ChangeReason>;
+        }
+    }
 }