From 7ee766ec0a9001aef199d4cd1e6250fffc27cc95 Mon Sep 17 00:00:00 2001 From: Shigma Date: Wed, 8 Jan 2025 00:07:17 +0800 Subject: [PATCH] feat(lark): support pagination api --- adapters/lark/scripts/types.ts | 41 +- adapters/lark/src/internal.ts | 67 ++- adapters/lark/src/types/acs.ts | 20 +- adapters/lark/src/types/admin.ts | 47 +- adapters/lark/src/types/aily.ts | 43 +- adapters/lark/src/types/application.ts | 56 +-- adapters/lark/src/types/approval.ts | 38 +- adapters/lark/src/types/attendance.ts | 32 +- adapters/lark/src/types/baike.ts | 10 +- adapters/lark/src/types/bitable.ts | 113 +++-- adapters/lark/src/types/calendar.ts | 50 +- adapters/lark/src/types/compensation.ts | 48 +- adapters/lark/src/types/contact.ts | 158 ++---- adapters/lark/src/types/corehr.ts | 447 ++++------------- adapters/lark/src/types/docx.ts | 38 +- adapters/lark/src/types/drive.ts | 56 +-- adapters/lark/src/types/ehr.ts | 11 +- adapters/lark/src/types/event.ts | 9 +- adapters/lark/src/types/helpdesk.ts | 22 +- adapters/lark/src/types/hire.ts | 450 ++++-------------- adapters/lark/src/types/im.ts | 64 +-- adapters/lark/src/types/index.ts | 4 - adapters/lark/src/types/lingo.ts | 29 +- adapters/lark/src/types/mail.ts | 54 +-- adapters/lark/src/types/okr.ts | 9 +- adapters/lark/src/types/payroll.ts | 29 +- adapters/lark/src/types/performance.ts | 63 +-- adapters/lark/src/types/personal_settings.ts | 9 +- adapters/lark/src/types/report.ts | 4 +- adapters/lark/src/types/search.ts | 29 +- .../lark/src/types/security_and_compliance.ts | 4 +- adapters/lark/src/types/task.ts | 126 ++--- adapters/lark/src/types/vc.ts | 76 +-- adapters/lark/src/types/wiki.ts | 34 +- adapters/lark/src/types/workplace.ts | 29 +- package.json | 3 +- 36 files changed, 596 insertions(+), 1726 deletions(-) diff --git a/adapters/lark/scripts/types.ts b/adapters/lark/scripts/types.ts index 34c9cc8b..620597b2 100644 --- a/adapters/lark/scripts/types.ts +++ b/adapters/lark/scripts/types.ts @@ -234,8 +234,8 @@ async function start() { const apiType = capitalize(method) const args: string[] = [] const extras: string[] = [] - let returnType = `${apiType}Response` + let returnType: string let paginationRequest: { queryType?: string } | undefined for (const property of detail.request.path?.properties || []) { args.push(`${property.name}: ${formatType(property, project.imports)}`) @@ -256,9 +256,9 @@ async function start() { if (keys.includes('page_token') && keys.includes('page_size')) { const properties = detail.request.query.properties.filter(s => s.name !== 'page_token' && s.name !== 'page_size') if (properties.length) { - project.requests.push(`export interface ${queryType} {\n${generateParams(properties, project.imports)}}`) + project.internalImports.add('Pagination') + project.requests.push(`export interface ${queryType} extends Pagination {\n${generateParams(properties, project.imports)}}`) paginationRequest = { queryType } - queryType = `${queryType} & Pagination` } else { queryType = 'Pagination' paginationRequest = {} @@ -271,7 +271,7 @@ async function start() { let paginationResponse: { innerType: string; tokenKey: string; itemsKey: string } | undefined if (detail.supportFileDownload) { - returnType = 'ArrayBuffer' + returnType = 'Promise' extras.push(`type: 'binary'`) } else { const keys = (detail.response.body?.properties || []).map(v => v.name) @@ -279,12 +279,13 @@ async function start() { console.log(`unsupported response body: ${keys}, see https://open.feishu.cn${summary.fullPath}}`) return } else if (keys.length === 2) { - returnType = 'void' + returnType = 'Promise' } else if (keys.length === 3 && keys.includes('data')) { const data = detail.response.body.properties!.find(v => v.name === 'data')! if (!data.properties?.length) { - returnType = 'void' + returnType = 'Promise' } else { + const responseType = `${apiType}Response` const keys = (data.properties || []).map(v => v.name) let pagination: [string, string, Schema] | undefined if (keys.includes('has_more') && (keys.includes('page_token') || keys.includes('next_page_token')) && keys.length === 3) { @@ -298,25 +299,26 @@ async function start() { const [itemsKey, tokenKey, schema] = pagination let innerType = formatType(schema, project.imports) if (schema.type === 'object' && schema.properties && !schema.ref) { - const name = `${apiType}Item` - project.responses.push(`export interface ${name} ${innerType}`) - innerType = name + project.responses.push(`export interface ${apiType}Item ${innerType}`) + innerType = `${apiType}Item` } returnType = itemsKey === 'items' ? `Paginated<${innerType}>` : `Paginated<${innerType}, '${itemsKey}'>` - project.internalImports.add('Paginated') paginationResponse = { innerType, tokenKey, itemsKey } } else { if (detail.pagination) { console.log(`unsupported pagination (${keys.join(', ')}), see https://open.feishu.cn${summary.fullPath}}`) } - project.responses.push(`export interface ${returnType} {\n${generateParams(data.properties, project.imports)}}`) + project.responses.push(`export interface ${responseType} {\n${generateParams(data.properties, project.imports)}}`) + returnType = `Promise<${responseType}>` } } } else { + const responseType = `${apiType}Response` const properties = detail.response.body.properties!.filter(v => !['code', 'msg'].includes(v.name)) - project.responses.push(`export interface ${returnType} extends BaseResponse {\n${generateParams(properties, project.imports)}}`) + project.responses.push(`export interface ${responseType} extends BaseResponse {\n${generateParams(properties, project.imports)}}`) extras.push(`type: 'raw-json'`) project.internalImports.add('BaseResponse') + returnType = `Promise<${responseType}>` } } @@ -325,22 +327,11 @@ async function start() { * ${summary.name} * @see https://open.feishu.cn${summary.fullPath} */ - ${method}(${args.join(', ')}): Promise<${returnType}> + ${method}(${args.join(', ')}): ${returnType} `) if (paginationRequest && paginationResponse) { - const paginationArgs = args.slice(0, -1) - const argIndex = paginationArgs.length - if (paginationRequest.queryType) { - paginationArgs.push(`query?: ${paginationRequest.queryType}`) - } - project.methods.push(dedent` - /** - * ${summary.name} - * @see https://open.feishu.cn${summary.fullPath} - */ - ${method}Iter(${paginationArgs.join(', ')}): AsyncIterator<${paginationResponse.innerType}> - `) + const argIndex = args.length - 1 const props: string[] = [`argIndex: ${argIndex}`] if (paginationResponse.itemsKey !== 'items') { props.push(`itemsKey: '${paginationResponse.itemsKey}'`) diff --git a/adapters/lark/src/internal.ts b/adapters/lark/src/internal.ts index 9e2a90b9..82b43f8f 100644 --- a/adapters/lark/src/internal.ts +++ b/adapters/lark/src/internal.ts @@ -10,18 +10,19 @@ export interface BaseResponse { msg: string } +export type Paginated = + & Promise< + & { [K in ItemsKey]: T[] } + & { [K in TokenKey]?: string } + & { has_more: boolean } + > + & AsyncIterableIterator + export interface Pagination { page_size?: number page_token?: string } -export type Paginated = { - [P in K]: T[]; -} & { - has_more: boolean - page_token: string -} - export interface InternalRoute { name: string pagination?: { @@ -68,7 +69,8 @@ export class Internal { if (typeof route === 'string') { route = { name: route } } - Internal.prototype[route.name] = async function (this: Internal, ...args: any[]) { + + const impl = async function (this: Internal, ...args: any[]) { const raw = args.join(', ') const url = path.replace(/\{([^}]+)\}/g, () => { if (!args.length) throw new Error(`too few arguments for ${path}, received ${raw}`) @@ -99,26 +101,41 @@ export class Internal { } } - if (route.pagination) { - const { argIndex, itemsKey = 'items', tokenKey = 'page_token' } = route.pagination - Internal.prototype[route.name + 'Iter'] = async function (this: Internal, ...args: any[]) { - let list: Paginated - const getList = async () => { - args[argIndex] = { ...args[argIndex], page_token: list?.[tokenKey] } - list = await this[route.name](...args) + Internal.prototype[route.name] = function (this: Internal, ...args: any[]) { + let promise: Promise | undefined + const result = {} as Paginated + for (const key of ['then', 'catch', 'finally']) { + result[key] = (...args2: any[]) => { + return (promise ??= impl.apply(this, args))[key](...args2) } - return { - async next() { - if (list?.[itemsKey].length) return { done: false, value: list[itemsKey].shift() } - if (!list.has_more) return { done: true, value: undefined } - await getList() - return this.next() - }, - [Symbol.asyncIterator]() { - return this - }, + } + + if (route.pagination) { + const { argIndex, itemsKey = 'items', tokenKey = 'page_token' } = route.pagination + const iterArgs = [...args] + iterArgs[argIndex] = { ...args[argIndex] } + let pagination: { data: any[]; next?: any } | undefined + result.next = async function () { + pagination ??= await this[Symbol.for('satori.pagination')]() + if (pagination.data.length) return { done: false, value: pagination.data.shift() } + if (!pagination.next) return { done: true, value: undefined } + pagination = await this[Symbol.for('satori.pagination')]() + return this.next() + } + result[Symbol.asyncIterator] = function () { + return this + } + result[Symbol.for('satori.pagination')] = async () => { + const data = await impl.apply(this, iterArgs) + iterArgs[argIndex].page_token = data[tokenKey] + return { + data: data[itemsKey], + next: data.has_more ? iterArgs : undefined, + } } } + + return result } } } diff --git a/adapters/lark/src/types/acs.ts b/adapters/lark/src/types/acs.ts index 3c9f4845..f83920de 100644 --- a/adapters/lark/src/types/acs.ts +++ b/adapters/lark/src/types/acs.ts @@ -1,5 +1,5 @@ import { AccessRecord, Device, Feature, Rule, User, UserExternal } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -17,12 +17,7 @@ declare module '../internal' { * 获取用户列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list */ - listAcsUser(query?: ListAcsUserQuery & Pagination): Promise> - /** - * 获取用户列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list - */ - listAcsUserIter(query?: ListAcsUserQuery): AsyncIterator + listAcsUser(query?: ListAcsUserQuery): Paginated /** * 上传人脸图片 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update @@ -72,12 +67,7 @@ declare module '../internal' { * 获取门禁记录列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list */ - listAcsAccessRecord(query?: ListAcsAccessRecordQuery & Pagination): Promise> - /** - * 获取门禁记录列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list - */ - listAcsAccessRecordIter(query?: ListAcsAccessRecordQuery): AsyncIterator + listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Paginated /** * 下载开门时的人脸识别图片 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get @@ -101,7 +91,7 @@ export interface GetAcsUserQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListAcsUserQuery { +export interface ListAcsUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -173,7 +163,7 @@ export interface CreateAcsVisitorQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListAcsAccessRecordQuery { +export interface ListAcsAccessRecordQuery extends Pagination { /** 记录开始时间，单位秒 */ from: number /** 记录结束时间，单位秒，时间跨度不能超过30天 */ diff --git a/adapters/lark/src/types/admin.ts b/adapters/lark/src/types/admin.ts index 13f5cfe4..f3ddf0b1 100644 --- a/adapters/lark/src/types/admin.ts +++ b/adapters/lark/src/types/admin.ts @@ -1,5 +1,5 @@ import { AdminDeptStat, AdminUserStat, AuditInfo, Badge, Grant, I18n, Password, RuleDetail } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -12,22 +12,12 @@ declare module '../internal' { * 获取部门维度的用户活跃和功能使用数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list */ - listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery & Pagination): Promise> - /** - * 获取部门维度的用户活跃和功能使用数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list - */ - listAdminAdminDeptStatIter(query?: ListAdminAdminDeptStatQuery): AsyncIterator - /** - * 获取用户维度的用户活跃和功能使用数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list - */ - listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery & Pagination): Promise> + listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery): Paginated /** * 获取用户维度的用户活跃和功能使用数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list */ - listAdminAdminUserStatIter(query?: ListAdminAdminUserStatQuery): AsyncIterator + listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery): Paginated /** * 创建勋章 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create @@ -47,12 +37,7 @@ declare module '../internal' { * 获取勋章列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list */ - listAdminBadge(query?: ListAdminBadgeQuery & Pagination): Promise> - /** - * 获取勋章列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list - */ - listAdminBadgeIter(query?: ListAdminBadgeQuery): AsyncIterator + listAdminBadge(query?: ListAdminBadgeQuery): Paginated /** * 获取勋章详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get @@ -77,12 +62,7 @@ declare module '../internal' { * 获取授予名单列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list */ - listAdminBadgeGrant(badge_id: string, query?: ListAdminBadgeGrantQuery & Pagination): Promise> - /** - * 获取授予名单列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list - */ - listAdminBadgeGrantIter(badge_id: string, query?: ListAdminBadgeGrantQuery): AsyncIterator + listAdminBadgeGrant(badge_id: string, query?: ListAdminBadgeGrantQuery): Paginated /** * 获取授予名单详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get @@ -92,12 +72,7 @@ declare module '../internal' { * 获取行为审计日志数据 * @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get */ - listAdminAuditInfo(query?: ListAdminAuditInfoQuery & Pagination): Promise> - /** - * 获取行为审计日志数据 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get - */ - listAdminAuditInfoIter(query?: ListAdminAuditInfoQuery): AsyncIterator + listAdminAuditInfo(query?: ListAdminAuditInfoQuery): Paginated } } @@ -113,7 +88,7 @@ export interface ResetAdminPasswordQuery { user_id_type: 'open_id' | 'union_id' | 'user_id' } -export interface ListAdminAdminDeptStatQuery { +export interface ListAdminAdminDeptStatQuery extends Pagination { /** 部门ID类型 */ department_id_type: 'department_id' | 'open_department_id' /** 起始日期（包含），格式是YYYY-mm-dd */ @@ -130,7 +105,7 @@ export interface ListAdminAdminDeptStatQuery { with_product_version?: boolean } -export interface ListAdminAdminUserStatQuery { +export interface ListAdminAdminUserStatQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 部门ID类型 */ @@ -184,7 +159,7 @@ export interface CreateAdminBadgeImageForm { image_type: 1 | 2 } -export interface ListAdminBadgeQuery { +export interface ListAdminBadgeQuery extends Pagination { /** 租户内唯一的勋章名称，精确匹配。 */ name?: string } @@ -241,7 +216,7 @@ export interface UpdateAdminBadgeGrantQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListAdminBadgeGrantQuery { +export interface ListAdminBadgeGrantQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' /** 此次调用中使用的部门ID的类型。 */ @@ -257,7 +232,7 @@ export interface GetAdminBadgeGrantQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListAdminAuditInfoQuery { +export interface ListAdminAuditInfoQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 日志时间范围: 结束时间. 格式: 秒级时间戳. 默认值: 此刻 */ diff --git a/adapters/lark/src/types/aily.ts b/adapters/lark/src/types/aily.ts index 1bad7aa9..d65299b1 100644 --- a/adapters/lark/src/types/aily.ts +++ b/adapters/lark/src/types/aily.ts @@ -1,5 +1,5 @@ import { AilyKnowledgeAskProcessData, AilyKnowledgeFaq, AilyKnowledgeMessage, AilyMention, AilyMessage, AilyMessageContentType, AilySession, DataAsset, DataAssetTag, Run, Skill, SkillGlobalVariable } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,12 +37,7 @@ declare module '../internal' { * 列出智能伙伴消息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list */ - listAilyAilySessionAilyMessage(aily_session_id: string, query?: ListAilyAilySessionAilyMessageQuery & Pagination): Promise> - /** - * 列出智能伙伴消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list - */ - listAilyAilySessionAilyMessageIter(aily_session_id: string, query?: ListAilyAilySessionAilyMessageQuery): AsyncIterator + listAilyAilySessionAilyMessage(aily_session_id: string, query?: ListAilyAilySessionAilyMessageQuery): Paginated /** * 创建运行 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create @@ -57,12 +52,7 @@ declare module '../internal' { * 列出运行 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list */ - listAilyAilySessionRun(aily_session_id: string, query?: Pagination): Promise> - /** - * 列出运行 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list - */ - listAilyAilySessionRunIter(aily_session_id: string): AsyncIterator + listAilyAilySessionRun(aily_session_id: string, query?: Pagination): Paginated /** * 取消运行 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel @@ -82,12 +72,7 @@ declare module '../internal' { * 查询技能列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/list */ - listAilyAppSkill(app_id: string, query?: Pagination): Promise> - /** - * 查询技能列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/list - */ - listAilyAppSkillIter(app_id: string): AsyncIterator + listAilyAppSkill(app_id: string, query?: Pagination): Paginated /** * 执行数据知识问答 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-knowledge/ask @@ -97,22 +82,12 @@ declare module '../internal' { * 查询数据知识列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/list */ - listAilyAppDataAsset(app_id: string, query?: ListAilyAppDataAssetQuery & Pagination): Promise> - /** - * 查询数据知识列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/list - */ - listAilyAppDataAssetIter(app_id: string, query?: ListAilyAppDataAssetQuery): AsyncIterator - /** - * 获取数据知识分类列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset_tag/list - */ - listAilyAppDataAssetTag(app_id: string, query?: ListAilyAppDataAssetTagQuery & Pagination): Promise> + listAilyAppDataAsset(app_id: string, query?: ListAilyAppDataAssetQuery): Paginated /** * 获取数据知识分类列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset_tag/list */ - listAilyAppDataAssetTagIter(app_id: string, query?: ListAilyAppDataAssetTagQuery): AsyncIterator + listAilyAppDataAssetTag(app_id: string, query?: ListAilyAppDataAssetTagQuery): Paginated } } @@ -145,7 +120,7 @@ export interface CreateAilyAilySessionAilyMessageRequest { mentions?: AilyMention[] } -export interface ListAilyAilySessionAilyMessageQuery { +export interface ListAilyAilySessionAilyMessageQuery extends Pagination { /** 运行 ID */ run_id?: string /** 返回生成中的消息 */ @@ -179,7 +154,7 @@ export interface AskAilyAppKnowledgeRequest { data_asset_tag_ids?: string[] } -export interface ListAilyAppDataAssetQuery { +export interface ListAilyAppDataAssetQuery extends Pagination { /** 模糊匹配关键词 */ keyword?: string /** 根据数据知识 ID 进行过滤 */ @@ -192,7 +167,7 @@ export interface ListAilyAppDataAssetQuery { with_connect_status?: boolean } -export interface ListAilyAppDataAssetTagQuery { +export interface ListAilyAppDataAssetTagQuery extends Pagination { /** 模糊匹配分类名称 */ keyword?: string /** 模糊匹配分类名称 */ diff --git a/adapters/lark/src/types/application.ts b/adapters/lark/src/types/application.ts index 99d54eb9..ab661fa2 100644 --- a/adapters/lark/src/types/application.ts +++ b/adapters/lark/src/types/application.ts @@ -1,5 +1,5 @@ import { AppContactsRangeIdList, Application, ApplicationAppContactsRange, ApplicationAppUsage, ApplicationAppVersion, ApplicationDepartmentAppUsage, ApplicationFeedback, ApplicationVisibilityDepartmentWhiteBlackInfo, ApplicationVisibilityGroupWhiteBlackInfo, ApplicationVisibilityUserWhiteBlackInfo, AppRecommendRule, AppVisibilityIdList, ClientBadgeNum, Scope } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -17,12 +17,7 @@ declare module '../internal' { * 获取应用版本列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list */ - listApplicationApplicationAppVersion(app_id: string, query?: ListApplicationApplicationAppVersionQuery & Pagination): Promise> - /** - * 获取应用版本列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list - */ - listApplicationApplicationAppVersionIter(app_id: string, query?: ListApplicationApplicationAppVersionQuery): AsyncIterator + listApplicationApplicationAppVersion(app_id: string, query?: ListApplicationApplicationAppVersionQuery): Paginated /** * 获取应用版本中开发者申请的通讯录权限范围 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/contacts_range_suggest @@ -42,17 +37,12 @@ declare module '../internal' { * 获取企业安装的应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/list */ - listApplication(query?: ListApplicationQuery & Pagination): Promise - /** - * 查看待审核的应用列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist - */ - underauditlistApplication(query?: UnderauditlistApplicationQuery & Pagination): Promise> + listApplication(query?: ListApplicationQuery): Promise /** * 查看待审核的应用列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist */ - underauditlistApplicationIter(query?: UnderauditlistApplicationQuery): AsyncIterator + underauditlistApplication(query?: UnderauditlistApplicationQuery): Paginated /** * 更新应用审核状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/patch @@ -67,7 +57,7 @@ declare module '../internal' { * 获取应用通讯录权限范围配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration */ - contactsRangeConfigurationApplication(app_id: string, query?: ContactsRangeConfigurationApplicationQuery & Pagination): Promise + contactsRangeConfigurationApplication(app_id: string, query?: ContactsRangeConfigurationApplicationQuery): Promise /** * 更新应用通讯录权限范围配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-contacts_range/patch @@ -92,7 +82,7 @@ declare module '../internal' { * 获取多部门应用使用概览 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/department_overview */ - departmentOverviewApplicationApplicationAppUsage(app_id: string, body: DepartmentOverviewApplicationApplicationAppUsageRequest, query?: DepartmentOverviewApplicationApplicationAppUsageQuery): Promise> + departmentOverviewApplicationApplicationAppUsage(app_id: string, body: DepartmentOverviewApplicationApplicationAppUsageRequest, query?: DepartmentOverviewApplicationApplicationAppUsageQuery): Paginated /** * 获取消息推送概览 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/message_push_overview @@ -112,12 +102,7 @@ declare module '../internal' { * 获取应用反馈列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/list */ - listApplicationApplicationFeedback(app_id: string, query?: ListApplicationApplicationFeedbackQuery & Pagination): Promise> - /** - * 获取应用反馈列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/list - */ - listApplicationApplicationFeedbackIter(app_id: string, query?: ListApplicationApplicationFeedbackQuery): AsyncIterator + listApplicationApplicationFeedback(app_id: string, query?: ListApplicationApplicationFeedbackQuery): Paginated /** * 更新应用红点 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_badge/set @@ -127,22 +112,17 @@ declare module '../internal' { * 获取用户自定义常用的应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/favourite */ - favouriteApplication(query?: FavouriteApplicationQuery & Pagination): Promise + favouriteApplication(query?: FavouriteApplicationQuery): Promise /** * 获取管理员推荐的应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/recommend */ - recommendApplication(query?: RecommendApplicationQuery & Pagination): Promise - /** - * 获取当前设置的推荐规则列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list - */ - listApplicationAppRecommendRule(query?: ListApplicationAppRecommendRuleQuery & Pagination): Promise> + recommendApplication(query?: RecommendApplicationQuery): Promise /** * 获取当前设置的推荐规则列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list */ - listApplicationAppRecommendRuleIter(query?: ListApplicationAppRecommendRuleQuery): AsyncIterator + listApplicationAppRecommendRule(query?: ListApplicationAppRecommendRuleQuery): Paginated } } @@ -160,7 +140,7 @@ export interface GetApplicationApplicationAppVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListApplicationApplicationAppVersionQuery { +export interface ListApplicationApplicationAppVersionQuery extends Pagination { /** 应用信息的语言版本 */ lang: 'zh_cn' | 'en_us' | 'ja_jp' /** 0：按照时间倒序 1：按照时间正序 */ @@ -176,7 +156,7 @@ export interface ContactsRangeSuggestApplicationApplicationAppVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListApplicationQuery { +export interface ListApplicationQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: string /** 应用的图标、描述、帮助文档链接是按照应用的主语言返回；其他内容（如应用权限、应用分类）按照该参数设定返回对应的语言。可选值有： zh_cn：中文 en_us：英文 ja_jp：日文 如不填写，则按照应用的主语言返回 */ @@ -189,7 +169,7 @@ export interface ListApplicationQuery { owner_type?: 0 | 1 | 2 } -export interface UnderauditlistApplicationQuery { +export interface UnderauditlistApplicationQuery extends Pagination { /** 指定返回的语言 */ lang: 'zh_cn' | 'en_us' | 'ja_jp' /** 此次调用中使用的用户ID的类型 */ @@ -220,7 +200,7 @@ export interface PatchApplicationQuery { lang: 'zh_cn' | 'en_us' | 'ja_jp' } -export interface ContactsRangeConfigurationApplicationQuery { +export interface ContactsRangeConfigurationApplicationQuery extends Pagination { /** 返回值的部门ID的类型 */ department_id_type?: 'department_id' | 'open_department_id' /** 此次调用中使用的用户ID的类型 */ @@ -342,7 +322,7 @@ export interface PatchApplicationApplicationFeedbackQuery { operator_id: string } -export interface ListApplicationApplicationFeedbackQuery { +export interface ListApplicationApplicationFeedbackQuery extends Pagination { /** 查询的起始日期，格式为yyyy-mm-dd。不填则默认为当前日期减去180天。 */ from_date?: string /** 查询的结束日期，格式为yyyy-mm-dd。不填默认为当前日期。只能查询 180 天内的数据。 */ @@ -372,19 +352,19 @@ export interface SetApplicationAppBadgeQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface FavouriteApplicationQuery { +export interface FavouriteApplicationQuery extends Pagination { /** 应用信息的语言版本 */ language?: 'zh_cn' | 'en_us' | 'ja_jp' } -export interface RecommendApplicationQuery { +export interface RecommendApplicationQuery extends Pagination { /** 应用信息的语言版本 */ language?: 'zh_cn' | 'en_us' | 'ja_jp' /** 推荐应用类型，默认为用户不可移除的推荐应用列表 */ recommend_type?: 'user_unremovable' | 'user_removable' } -export interface ListApplicationAppRecommendRuleQuery { +export interface ListApplicationAppRecommendRuleQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } diff --git a/adapters/lark/src/types/approval.ts b/adapters/lark/src/types/approval.ts index 22e0b8a5..e892fab2 100644 --- a/adapters/lark/src/types/approval.ts +++ b/adapters/lark/src/types/approval.ts @@ -1,5 +1,5 @@ import { ApprovalConfig, ApprovalCreateExternal, ApprovalCreateViewers, ApprovalForm, ApprovalNode, ApprovalNodeInfo, ApprovalSetting, ApprovalViewerInfo, CcNode, CcSearchItem, Comment, CommentAtInfo, Count, ExteranlInstanceCheck, ExteranlInstanceCheckResponse, ExternalInstance, ExternalInstanceForm, ExternalInstanceLink, ExternalInstanceTaskNode, ExternalTaskList, I18nResource, InstanceComment, InstanceSearchItem, InstanceTask, InstanceTimeline, NodeApprover, NodeAutoApproval, NodeCc, PreviewNode, Task, TaskSearchItem, TrusteeshipInstanceCacheConfig, TrusteeshipUrls } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -42,12 +42,7 @@ declare module '../internal' { * 批量获取审批实例 ID * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list */ - listApprovalInstance(query?: ListApprovalInstanceQuery & Pagination): Promise> - /** - * 批量获取审批实例 ID - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list - */ - listApprovalInstanceIter(query?: ListApprovalInstanceQuery): AsyncIterator + listApprovalInstance(query?: ListApprovalInstanceQuery): Paginated /** * 同意审批任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve @@ -97,7 +92,7 @@ declare module '../internal' { * 获取评论 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list */ - listApprovalInstanceComment(instance_id: string, query?: ListApprovalInstanceCommentQuery & Pagination): Promise + listApprovalInstanceComment(instance_id: string, query?: ListApprovalInstanceCommentQuery): Promise /** * 创建三方审批定义 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create @@ -122,32 +117,27 @@ declare module '../internal' { * 获取三方审批任务状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list */ - listApprovalExternalTask(body: ListApprovalExternalTaskRequest, query?: Pagination): Promise> - /** - * 获取三方审批任务状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list - */ - listApprovalExternalTaskIter(body: ListApprovalExternalTaskRequest): AsyncIterator + listApprovalExternalTask(body: ListApprovalExternalTaskRequest, query?: Pagination): Paginated /** * 查询实例列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query */ - queryApprovalInstance(body: QueryApprovalInstanceRequest, query?: QueryApprovalInstanceQuery & Pagination): Promise + queryApprovalInstance(body: QueryApprovalInstanceRequest, query?: QueryApprovalInstanceQuery): Promise /** * 查询抄送列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc */ - searchCcApprovalInstance(body: SearchCcApprovalInstanceRequest, query?: SearchCcApprovalInstanceQuery & Pagination): Promise + searchCcApprovalInstance(body: SearchCcApprovalInstanceRequest, query?: SearchCcApprovalInstanceQuery): Promise /** * 查询任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search */ - searchApprovalTask(body: SearchApprovalTaskRequest, query?: SearchApprovalTaskQuery & Pagination): Promise + searchApprovalTask(body: SearchApprovalTaskRequest, query?: SearchApprovalTaskQuery): Promise /** * 查询用户的任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query */ - queryApprovalTask(query?: QueryApprovalTaskQuery & Pagination): Promise + queryApprovalTask(query?: QueryApprovalTaskQuery): Promise /** * 订阅审批事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe @@ -304,7 +294,7 @@ export interface GetApprovalInstanceQuery { user_id_type?: 'user_id' | 'open_id' | 'union_id' } -export interface ListApprovalInstanceQuery { +export interface ListApprovalInstanceQuery extends Pagination { /** 审批定义唯一标识 */ approval_code: string /** 审批实例创建时间区间（毫秒） */ @@ -466,7 +456,7 @@ export interface RemoveApprovalInstanceCommentQuery { user_id?: string } -export interface ListApprovalInstanceCommentQuery { +export interface ListApprovalInstanceCommentQuery extends Pagination { /** 用户ID类型，不填默认为open_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' /** 用户ID */ @@ -598,7 +588,7 @@ export interface QueryApprovalInstanceRequest { locale?: 'zh-CN' | 'en-US' | 'ja-JP' } -export interface QueryApprovalInstanceQuery { +export interface QueryApprovalInstanceQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -626,7 +616,7 @@ export interface SearchCcApprovalInstanceRequest { locale?: 'zh-CN' | 'en-US' | 'ja-JP' } -export interface SearchCcApprovalInstanceQuery { +export interface SearchCcApprovalInstanceQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -658,12 +648,12 @@ export interface SearchApprovalTaskRequest { order?: 0 | 1 | 2 | 3 } -export interface SearchApprovalTaskQuery { +export interface SearchApprovalTaskQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface QueryApprovalTaskQuery { +export interface QueryApprovalTaskQuery extends Pagination { /** 需要查询的 User ID */ user_id: string /** 需要查询的任务分组主题，如「待办」、「已办」等 */ diff --git a/adapters/lark/src/types/attendance.ts b/adapters/lark/src/types/attendance.ts index b408de83..44f52158 100644 --- a/adapters/lark/src/types/attendance.ts +++ b/adapters/lark/src/types/attendance.ts @@ -1,5 +1,5 @@ import { ApprovalInfo, ArchiveField, ArchiveReportData, ArchiveReportMeta, File, FlexibleRule, FreePunchCfg, Group, GroupMeta, LangText, LateOffLateOnRule, LateOffLateOnSetting, LeaveAccrualRecord, LeaveEmployExpireRecord, LeaveNeedPunchCfg, Location, Machine, MemberStatusChange, OvertimeClockCfg, OvertimeRule, PunchMember, PunchSpecialDateShift, PunchTimeRule, RestRule, RestTimeFlexibleConfig, Shift, ShiftAttendanceTimeConfig, ShiftMiddleTimeRule, UserAllowedRemedy, UserApproval, UserBase, UserDailyShift, UserFlow, UserSetting, UserStatsData, UserStatsField, UserStatsView, UserTask, UserTaskRemedy, UserTmpDailyShift } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -27,12 +27,7 @@ declare module '../internal' { * 查询所有班次 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/list */ - listAttendanceShift(query?: Pagination): Promise> - /** - * 查询所有班次 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/list - */ - listAttendanceShiftIter(): AsyncIterator + listAttendanceShift(query?: Pagination): Paginated /** * 创建或修改排班表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/batch_create @@ -52,12 +47,7 @@ declare module '../internal' { * 查询考勤组下所有成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list_user */ - listUserAttendanceGroup(group_id: string, query?: ListUserAttendanceGroupQuery & Pagination): Promise> - /** - * 查询考勤组下所有成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list_user - */ - listUserAttendanceGroupIter(group_id: string, query?: ListUserAttendanceGroupQuery): AsyncIterator + listUserAttendanceGroup(group_id: string, query?: ListUserAttendanceGroupQuery): Paginated /** * 创建或修改考勤组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/create @@ -82,12 +72,7 @@ declare module '../internal' { * 查询所有考勤组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list */ - listAttendanceGroup(query?: Pagination): Promise> - /** - * 查询所有考勤组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list - */ - listAttendanceGroupIter(): AsyncIterator + listAttendanceGroup(query?: Pagination): Paginated /** * 修改用户人脸识别信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/modify @@ -177,12 +162,7 @@ declare module '../internal' { * 查询所有归档规则 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/list */ - listAttendanceArchiveRule(query?: Pagination): Promise> - /** - * 查询所有归档规则 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/list - */ - listAttendanceArchiveRuleIter(): AsyncIterator + listAttendanceArchiveRule(query?: Pagination): Paginated /** * 导入打卡流水 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/batch_create @@ -305,7 +285,7 @@ export interface BatchCreateTempAttendanceUserDailyShiftQuery { employee_type: 'employee_id' | 'employee_no' } -export interface ListUserAttendanceGroupQuery { +export interface ListUserAttendanceGroupQuery extends Pagination { /** 用户 ID 的类型 */ employee_type: string /** 部门 ID 的类型 */ diff --git a/adapters/lark/src/types/baike.ts b/adapters/lark/src/types/baike.ts index 9ada1cd9..2e38d6e9 100644 --- a/adapters/lark/src/types/baike.ts +++ b/adapters/lark/src/types/baike.ts @@ -1,5 +1,5 @@ import { Classification, ClassificationFilter, Draft, Entity, EntityWord, MatchInfo, OuterInfo, Phrase, RelatedMeta, Term } from '.' -import { Internal } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -32,7 +32,7 @@ declare module '../internal' { * 获取词条列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list */ - listBaikeEntity(query?: ListBaikeEntityQuery & Pagination): Promise + listBaikeEntity(query?: ListBaikeEntityQuery): Promise /** * 精准搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match @@ -42,7 +42,7 @@ declare module '../internal' { * 模糊搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search */ - searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery & Pagination): Promise + searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise /** * 词条高亮 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight @@ -162,7 +162,7 @@ export interface GetBaikeEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListBaikeEntityQuery { +export interface ListBaikeEntityQuery extends Pagination { /** 相关外部系统【可用来过滤词条数据】 */ provider?: string /** 此次调用中使用的用户ID的类型 */ @@ -185,7 +185,7 @@ export interface SearchBaikeEntityRequest { creators?: string[] } -export interface SearchBaikeEntityQuery { +export interface SearchBaikeEntityQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } diff --git a/adapters/lark/src/types/bitable.ts b/adapters/lark/src/types/bitable.ts index efd22348..6c8913ba 100644 --- a/adapters/lark/src/types/bitable.ts +++ b/adapters/lark/src/types/bitable.ts @@ -1,5 +1,5 @@ import { App, AppDashboard, AppRole, AppRoleBlockRole, AppRoleMember, AppRoleMemberId, AppRoleTableRole, AppTable, AppTableField, AppTableFieldDescription, AppTableFieldForList, AppTableFieldProperty, AppTableForm, AppTableFormField, AppTableFormPatchedField, AppTableRecord, AppTableView, AppTableViewProperty, AppWorkflow, DeleteRecord, DisplayApp, DisplayAppV2, FilterInfo, ReqTable, Sort } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -67,7 +67,7 @@ declare module '../internal' { * 列出视图 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list */ - listBitableAppTableView(app_token: string, table_id: string, query?: ListBitableAppTableViewQuery & Pagination): Promise + listBitableAppTableView(app_token: string, table_id: string, query?: ListBitableAppTableViewQuery): Promise /** * 获取视图 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get @@ -92,7 +92,7 @@ declare module '../internal' { * 查询记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search */ - searchBitableAppTableRecord(app_token: string, table_id: string, body: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery & Pagination): Promise + searchBitableAppTableRecord(app_token: string, table_id: string, body: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery): Promise /** * 删除记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete @@ -132,7 +132,7 @@ declare module '../internal' { * 列出字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list */ - listBitableAppTableField(app_token: string, table_id: string, query?: ListBitableAppTableFieldQuery & Pagination): Promise + listBitableAppTableField(app_token: string, table_id: string, query?: ListBitableAppTableFieldQuery): Promise /** * 删除字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete @@ -147,12 +147,7 @@ declare module '../internal' { * 列出仪表盘 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list */ - listBitableAppDashboard(app_token: string, query?: Pagination): Promise> - /** - * 列出仪表盘 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list - */ - listBitableAppDashboardIter(app_token: string): AsyncIterator + listBitableAppDashboard(app_token: string, query?: Pagination): Paginated /** * 更新表单元数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch @@ -173,31 +168,31 @@ declare module '../internal' { * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/list */ listBitableAppTableFormField(app_token: string, table_id: string, form_id: string, query?: Pagination): Promise - /** - * 列出自定义角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list - */ - listBitableAppRole(app_token: string, query?: Pagination): Promise /** * 新增自定义角色 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create */ createBitableAppRole(app_token: string, body: CreateBitableAppRoleRequest): Promise - /** - * 删除自定义角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete - */ - deleteBitableAppRole(app_token: string, role_id: string): Promise /** * 更新自定义角色 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/update */ updateBitableAppRole(app_token: string, role_id: string, body: UpdateBitableAppRoleRequest): Promise /** - * 批量删除协作者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete + * 列出自定义角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list */ - batchDeleteBitableAppRoleMember(app_token: string, role_id: string, body: BatchDeleteBitableAppRoleMemberRequest): Promise + listBitableAppRole(app_token: string, query?: Pagination): Promise + /** + * 删除自定义角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete + */ + deleteBitableAppRole(app_token: string, role_id: string): Promise + /** + * 新增协作者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create + */ + createBitableAppRoleMember(app_token: string, role_id: string, body: CreateBitableAppRoleMemberRequest, query?: CreateBitableAppRoleMemberQuery): Promise /** * 批量新增协作者 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_create @@ -208,16 +203,16 @@ declare module '../internal' { * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list */ listBitableAppRoleMember(app_token: string, role_id: string, query?: Pagination): Promise - /** - * 新增协作者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create - */ - createBitableAppRoleMember(app_token: string, role_id: string, body: CreateBitableAppRoleMemberRequest, query?: CreateBitableAppRoleMemberQuery): Promise /** * 删除协作者 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete */ deleteBitableAppRoleMember(app_token: string, role_id: string, member_id: string, query?: DeleteBitableAppRoleMemberQuery): Promise + /** + * 批量删除协作者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete + */ + batchDeleteBitableAppRoleMember(app_token: string, role_id: string, body: BatchDeleteBitableAppRoleMemberRequest): Promise /** * 列出自动化流程 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/list @@ -237,7 +232,7 @@ declare module '../internal' { * 列出记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/list */ - listBitableAppTableRecord(app_token: string, table_id: string, query?: ListBitableAppTableRecordQuery & Pagination): Promise + listBitableAppTableRecord(app_token: string, table_id: string, query?: ListBitableAppTableRecordQuery): Promise } } @@ -307,7 +302,7 @@ export interface PatchBitableAppTableViewRequest { property?: AppTableViewProperty } -export interface ListBitableAppTableViewQuery { +export interface ListBitableAppTableViewQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -351,7 +346,7 @@ export interface SearchBitableAppTableRecordRequest { automatic_fields?: boolean } -export interface SearchBitableAppTableRecordQuery { +export interface SearchBitableAppTableRecordQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -429,7 +424,7 @@ 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 ListBitableAppTableFieldQuery { +export interface ListBitableAppTableFieldQuery extends Pagination { /** 视图 ID */ view_id?: string /** 控制字段描述（多行文本格式）数据的返回格式, true 表示以数组富文本形式返回 */ @@ -485,16 +480,6 @@ export interface UpdateBitableAppRoleRequest { block_roles?: AppRoleBlockRole[] } -export interface BatchDeleteBitableAppRoleMemberRequest { - /** 协作者列表 */ - member_list: AppRoleMemberId[] -} - -export interface BatchCreateBitableAppRoleMemberRequest { - /** 协作者列表 */ - member_list: AppRoleMemberId[] -} - export interface CreateBitableAppRoleMemberRequest { /** 协作者id */ member_id: string @@ -505,11 +490,21 @@ export interface CreateBitableAppRoleMemberQuery { member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id' } +export interface BatchCreateBitableAppRoleMemberRequest { + /** 协作者列表 */ + member_list: AppRoleMemberId[] +} + export interface DeleteBitableAppRoleMemberQuery { /** 协作者id类型，与请求体中的member_id要对应 */ member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id' } +export interface BatchDeleteBitableAppRoleMemberRequest { + /** 协作者列表 */ + member_list: AppRoleMemberId[] +} + export interface UpdateBitableAppWorkflowRequest { /** 自动化状态 */ status: string @@ -528,7 +523,7 @@ export interface GetBitableAppTableRecordQuery { automatic_fields?: boolean } -export interface ListBitableAppTableRecordQuery { +export interface ListBitableAppTableRecordQuery extends Pagination { /** 视图 id注意：如 filter 或 sort 有值，view_id 会被忽略。 */ view_id?: string /** 筛选参数注意：1.筛选记录的表达式不超过2000个字符。2.不支持对“人员”以及“关联字段”的属性进行过滤筛选，如人员的 OpenID。3.仅支持字段在页面展示字符值进行筛选。详细请参考[记录筛选开发指南](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter) */ @@ -723,6 +718,14 @@ export interface ListBitableAppTableFormFieldResponse { total: number } +export interface CreateBitableAppRoleResponse { + role?: AppRole +} + +export interface UpdateBitableAppRoleResponse { + role?: AppRole +} + export interface ListBitableAppRoleResponse { /** 角色列表 */ items?: AppRole[] @@ -734,14 +737,6 @@ export interface ListBitableAppRoleResponse { total?: number } -export interface CreateBitableAppRoleResponse { - role?: AppRole -} - -export interface UpdateBitableAppRoleResponse { - role?: AppRole -} - export interface ListBitableAppRoleMemberResponse { /** 协作者列表 */ items?: AppRoleMember[] @@ -855,26 +850,26 @@ Internal.define({ GET: 'listBitableAppTableFormField', }, '/bitable/v1/apps/{app_token}/roles': { - GET: 'listBitableAppRole', POST: 'createBitableAppRole', + GET: 'listBitableAppRole', }, '/bitable/v1/apps/{app_token}/roles/{role_id}': { - DELETE: 'deleteBitableAppRole', PUT: 'updateBitableAppRole', + DELETE: 'deleteBitableAppRole', }, - '/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_delete': { - POST: 'batchDeleteBitableAppRoleMember', + '/bitable/v1/apps/{app_token}/roles/{role_id}/members': { + POST: 'createBitableAppRoleMember', + GET: 'listBitableAppRoleMember', }, '/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_create': { POST: 'batchCreateBitableAppRoleMember', }, - '/bitable/v1/apps/{app_token}/roles/{role_id}/members': { - GET: 'listBitableAppRoleMember', - POST: 'createBitableAppRoleMember', - }, '/bitable/v1/apps/{app_token}/roles/{role_id}/members/{member_id}': { DELETE: 'deleteBitableAppRoleMember', }, + '/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_delete': { + POST: 'batchDeleteBitableAppRoleMember', + }, '/bitable/v1/apps/{app_token}/workflows': { GET: 'listBitableAppWorkflow', }, diff --git a/adapters/lark/src/types/calendar.ts b/adapters/lark/src/types/calendar.ts index bb27ab57..68a859ff 100644 --- a/adapters/lark/src/types/calendar.ts +++ b/adapters/lark/src/types/calendar.ts @@ -1,5 +1,5 @@ import { AclScope, Attachment, Calendar, CalendarAcl, CalendarEvent, CalendarEventAttendee, CalendarEventAttendeeChatMember, CalendarEventAttendeeId, EventLocation, EventSearchFilter, Freebusy, Instance, Reminder, Schema, TimeInfo, UserCalendar, Vchat } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -32,7 +32,7 @@ declare module '../internal' { * 查询日历列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list */ - listCalendar(query?: ListCalendarQuery & Pagination): Promise + listCalendar(query?: ListCalendarQuery): Promise /** * 更新日历信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/patch @@ -77,12 +77,7 @@ declare module '../internal' { * 获取访问控制列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/list */ - listCalendarCalendarAcl(calendar_id: string, query?: ListCalendarCalendarAclQuery & Pagination): Promise> - /** - * 获取访问控制列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/list - */ - listCalendarCalendarAclIter(calendar_id: string, query?: ListCalendarCalendarAclQuery): AsyncIterator + listCalendarCalendarAcl(calendar_id: string, query?: ListCalendarCalendarAclQuery): Paginated /** * 订阅日历访问控制变更事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/subscription @@ -117,12 +112,12 @@ declare module '../internal' { * 获取日程列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/list */ - listCalendarCalendarEvent(calendar_id: string, query?: ListCalendarCalendarEventQuery & Pagination): Promise + listCalendarCalendarEvent(calendar_id: string, query?: ListCalendarCalendarEventQuery): Promise /** * 搜索日程 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search */ - searchCalendarCalendarEvent(calendar_id: string, body: SearchCalendarCalendarEventRequest, query?: SearchCalendarCalendarEventQuery & Pagination): Promise + searchCalendarCalendarEvent(calendar_id: string, body: SearchCalendarCalendarEventRequest, query?: SearchCalendarCalendarEventQuery): Promise /** * 订阅日程变更事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/subscription @@ -142,12 +137,7 @@ declare module '../internal' { * 获取重复日程实例 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instances */ - instancesCalendarCalendarEvent(calendar_id: string, event_id: string, query?: InstancesCalendarCalendarEventQuery & Pagination): Promise> - /** - * 获取重复日程实例 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instances - */ - instancesCalendarCalendarEventIter(calendar_id: string, event_id: string, query?: InstancesCalendarCalendarEventQuery): AsyncIterator + instancesCalendarCalendarEvent(calendar_id: string, event_id: string, query?: InstancesCalendarCalendarEventQuery): Paginated /** * 查询日程视图 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instance_view @@ -192,22 +182,12 @@ declare module '../internal' { * 获取日程参与人列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/list */ - listCalendarCalendarEventAttendee(calendar_id: string, event_id: string, query?: ListCalendarCalendarEventAttendeeQuery & Pagination): Promise> - /** - * 获取日程参与人列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/list - */ - listCalendarCalendarEventAttendeeIter(calendar_id: string, event_id: string, query?: ListCalendarCalendarEventAttendeeQuery): AsyncIterator - /** - * 获取日程参与群成员列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list - */ - listCalendarCalendarEventAttendeeChatMember(calendar_id: string, event_id: string, attendee_id: string, query?: ListCalendarCalendarEventAttendeeChatMemberQuery & Pagination): Promise> + listCalendarCalendarEventAttendee(calendar_id: string, event_id: string, query?: ListCalendarCalendarEventAttendeeQuery): Paginated /** * 获取日程参与群成员列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list */ - listCalendarCalendarEventAttendeeChatMemberIter(calendar_id: string, event_id: string, attendee_id: string, query?: ListCalendarCalendarEventAttendeeChatMemberQuery): AsyncIterator + listCalendarCalendarEventAttendeeChatMember(calendar_id: string, event_id: string, attendee_id: string, query?: ListCalendarCalendarEventAttendeeChatMemberQuery): Paginated /** * 生成 CalDAV 配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/setting/generate_caldav_conf @@ -269,7 +249,7 @@ export interface ListCalendarFreebusyQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListCalendarQuery { +export interface ListCalendarQuery extends Pagination { /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ sync_token?: string } @@ -304,7 +284,7 @@ export interface CreateCalendarCalendarAclQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListCalendarCalendarAclQuery { +export interface ListCalendarCalendarAclQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -403,7 +383,7 @@ export interface GetCalendarCalendarEventQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListCalendarCalendarEventQuery { +export interface ListCalendarCalendarEventQuery extends Pagination { /** 拉取anchor_time之后的日程，为timestamp */ anchor_time?: string /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ @@ -423,7 +403,7 @@ export interface SearchCalendarCalendarEventRequest { filter?: EventSearchFilter } -export interface SearchCalendarCalendarEventQuery { +export interface SearchCalendarCalendarEventQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -433,7 +413,7 @@ export interface ReplyCalendarCalendarEventRequest { rsvp_status: 'accept' | 'decline' | 'tentative' } -export interface InstancesCalendarCalendarEventQuery { +export interface InstancesCalendarCalendarEventQuery extends Pagination { /** 日程实例开始Unix时间戳，单位为秒,日程的end_time的下限（不包含） */ start_time: string /** 日程实例结束Unix时间戳，单位为秒,日程的start_time上限（不包含） */ @@ -510,14 +490,14 @@ export interface BatchDeleteCalendarCalendarEventAttendeeQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListCalendarCalendarEventAttendeeQuery { +export interface ListCalendarCalendarEventAttendeeQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 是否需要会议室表单信息 */ need_resource_customization?: boolean } -export interface ListCalendarCalendarEventAttendeeChatMemberQuery { +export interface ListCalendarCalendarEventAttendeeChatMemberQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } diff --git a/adapters/lark/src/types/compensation.ts b/adapters/lark/src/types/compensation.ts index 4f10340c..378d4949 100644 --- a/adapters/lark/src/types/compensation.ts +++ b/adapters/lark/src/types/compensation.ts @@ -1,5 +1,5 @@ import { ArchiveDetail, ChangeReason, Indicator, Item, ItemCategory, PlanDetail } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,62 +7,32 @@ declare module '../internal' { * 批量查询员工薪资档案 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query */ - queryCompensationArchive(body: QueryCompensationArchiveRequest, query?: QueryCompensationArchiveQuery & Pagination): Promise> - /** - * 批量查询员工薪资档案 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query - */ - queryCompensationArchiveIter(body: QueryCompensationArchiveRequest, query?: QueryCompensationArchiveQuery): AsyncIterator - /** - * 批量查询薪资项 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list - */ - listCompensationItem(query?: ListCompensationItemQuery & Pagination): Promise> + queryCompensationArchive(body: QueryCompensationArchiveRequest, query?: QueryCompensationArchiveQuery): Paginated /** * 批量查询薪资项 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list */ - listCompensationItemIter(query?: ListCompensationItemQuery): AsyncIterator - /** - * 批量查询薪资统计指标 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list - */ - listCompensationIndicator(query?: Pagination): Promise> + listCompensationItem(query?: ListCompensationItemQuery): Paginated /** * 批量查询薪资统计指标 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list */ - listCompensationIndicatorIter(): AsyncIterator + listCompensationIndicator(query?: Pagination): Paginated /** * 批量获取薪资项分类信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item_category/list */ - listCompensationItemCategory(query?: Pagination): Promise> - /** - * 批量获取薪资项分类信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item_category/list - */ - listCompensationItemCategoryIter(): AsyncIterator - /** - * 批量查询薪资方案 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list - */ - listCompensationPlan(query?: Pagination): Promise> + listCompensationItemCategory(query?: Pagination): Paginated /** * 批量查询薪资方案 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list */ - listCompensationPlanIter(): AsyncIterator - /** - * 批量查询定调薪原因 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list - */ - listCompensationChangeReason(query?: Pagination): Promise> + listCompensationPlan(query?: Pagination): Paginated /** * 批量查询定调薪原因 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list */ - listCompensationChangeReasonIter(): AsyncIterator + listCompensationChangeReason(query?: Pagination): Paginated } } @@ -77,12 +47,12 @@ export interface QueryCompensationArchiveRequest { effective_end_date?: string } -export interface QueryCompensationArchiveQuery { +export interface QueryCompensationArchiveQuery extends Pagination { /** 用户ID类型 */ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface ListCompensationItemQuery { +export interface ListCompensationItemQuery extends Pagination { /** 薪酬项类型（不传则认为查询所有类型薪酬项） */ item_type?: 'salary' | 'bonus' | 'recurring_payment' } diff --git a/adapters/lark/src/types/contact.ts b/adapters/lark/src/types/contact.ts index 96b68261..3d2725c9 100644 --- a/adapters/lark/src/types/contact.ts +++ b/adapters/lark/src/types/contact.ts @@ -1,5 +1,5 @@ import { CustomAttr, Department, DepartmentI18nName, DepartmentLeader, EmployeeTypeEnum, FunctionalRoleMember, FunctionalRoleMemberResult, Group, I18nContent, JobFamily, JobLevel, JobTitle, Memberlist, MemberResult, ResourceAcceptor, Unit, UnitDepartment, User, UserContactInfo, UserCustomAttr, UserDepartmentInfo, UserOrder, WorkCity } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,7 +7,7 @@ declare module '../internal' { * 获取通讯录授权范围 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/scope/list */ - listContactScope(query?: ListContactScopeQuery & Pagination): Promise + listContactScope(query?: ListContactScopeQuery): Promise /** * 创建用户 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create @@ -37,12 +37,7 @@ declare module '../internal' { * 获取部门直属用户列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department */ - findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery & Pagination): Promise> - /** - * 获取部门直属用户列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department - */ - findByDepartmentContactUserIter(query?: FindByDepartmentContactUserQuery): AsyncIterator + findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery): Paginated /** * 通过手机号或邮箱获取用户 ID * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id @@ -77,22 +72,12 @@ declare module '../internal' { * 查询用户组列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist */ - simplelistContactGroup(query?: SimplelistContactGroupQuery & Pagination): Promise> - /** - * 查询用户组列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist - */ - simplelistContactGroupIter(query?: SimplelistContactGroupQuery): AsyncIterator - /** - * 查询用户所属用户组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong - */ - memberBelongContactGroup(query?: MemberBelongContactGroupQuery & Pagination): Promise> + simplelistContactGroup(query?: SimplelistContactGroupQuery): Paginated /** * 查询用户所属用户组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong */ - memberBelongContactGroupIter(query?: MemberBelongContactGroupQuery): AsyncIterator + memberBelongContactGroup(query?: MemberBelongContactGroupQuery): Paginated /** * 删除用户组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete @@ -102,12 +87,7 @@ declare module '../internal' { * 获取企业自定义用户字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list */ - listContactCustomAttr(query?: Pagination): Promise> - /** - * 获取企业自定义用户字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list - */ - listContactCustomAttrIter(): AsyncIterator + listContactCustomAttr(query?: Pagination): Paginated /** * 新增人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create @@ -122,12 +102,7 @@ declare module '../internal' { * 查询人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list */ - listContactEmployeeTypeEnum(query?: Pagination): Promise> - /** - * 查询人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list - */ - listContactEmployeeTypeEnumIter(): AsyncIterator + listContactEmployeeTypeEnum(query?: Pagination): Paginated /** * 删除人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete @@ -172,32 +147,17 @@ declare module '../internal' { * 获取子部门列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children */ - childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery & Pagination): Promise> - /** - * 获取子部门列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children - */ - childrenContactDepartmentIter(department_id: string, query?: ChildrenContactDepartmentQuery): AsyncIterator - /** - * 获取父部门信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent - */ - parentContactDepartment(query?: ParentContactDepartmentQuery & Pagination): Promise> + childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery): Paginated /** * 获取父部门信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent */ - parentContactDepartmentIter(query?: ParentContactDepartmentQuery): AsyncIterator - /** - * 搜索部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search - */ - searchContactDepartment(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery & Pagination): Promise> + parentContactDepartment(query?: ParentContactDepartmentQuery): Paginated /** * 搜索部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search */ - searchContactDepartmentIter(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): AsyncIterator + searchContactDepartment(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): Paginated /** * 删除部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete @@ -227,12 +187,7 @@ declare module '../internal' { * 获取单位绑定的部门列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department */ - listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery & Pagination): Promise> - /** - * 获取单位绑定的部门列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department - */ - listDepartmentContactUnitIter(query?: ListDepartmentContactUnitQuery): AsyncIterator + listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery): Paginated /** * 获取单位信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get @@ -242,12 +197,7 @@ declare module '../internal' { * 获取单位列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list */ - listContactUnit(query?: Pagination): Promise> - /** - * 获取单位列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list - */ - listContactUnitIter(): AsyncIterator + listContactUnit(query?: Pagination): Paginated /** * 删除单位 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete @@ -267,12 +217,7 @@ declare module '../internal' { * 查询用户组成员列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist */ - simplelistContactGroupMember(group_id: string, query?: SimplelistContactGroupMemberQuery & Pagination): Promise> - /** - * 查询用户组成员列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist - */ - simplelistContactGroupMemberIter(group_id: string, query?: SimplelistContactGroupMemberQuery): AsyncIterator + simplelistContactGroupMember(group_id: string, query?: SimplelistContactGroupMemberQuery): Paginated /** * 移除用户组成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove @@ -317,12 +262,7 @@ declare module '../internal' { * 查询角色下的所有成员信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list */ - listContactFunctionalRoleMember(role_id: string, query?: ListContactFunctionalRoleMemberQuery & Pagination): Promise> - /** - * 查询角色下的所有成员信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list - */ - listContactFunctionalRoleMemberIter(role_id: string, query?: ListContactFunctionalRoleMemberQuery): AsyncIterator + listContactFunctionalRoleMember(role_id: string, query?: ListContactFunctionalRoleMemberQuery): Paginated /** * 删除角色下的成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete @@ -347,12 +287,7 @@ declare module '../internal' { * 获取租户职级列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list */ - listContactJobLevel(query?: ListContactJobLevelQuery & Pagination): Promise> - /** - * 获取租户职级列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list - */ - listContactJobLevelIter(query?: ListContactJobLevelQuery): AsyncIterator + listContactJobLevel(query?: ListContactJobLevelQuery): Paginated /** * 删除职级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete @@ -377,12 +312,7 @@ declare module '../internal' { * 获取租户序列列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list */ - listContactJobFamily(query?: ListContactJobFamilyQuery & Pagination): Promise> - /** - * 获取租户序列列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list - */ - listContactJobFamilyIter(query?: ListContactJobFamilyQuery): AsyncIterator + listContactJobFamily(query?: ListContactJobFamilyQuery): Paginated /** * 删除序列 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete @@ -397,12 +327,7 @@ declare module '../internal' { * 获取租户职务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list */ - listContactJobTitle(query?: Pagination): Promise> - /** - * 获取租户职务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list - */ - listContactJobTitleIter(): AsyncIterator + listContactJobTitle(query?: Pagination): Paginated /** * 获取单个工作城市信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get @@ -412,22 +337,12 @@ declare module '../internal' { * 获取租户工作城市列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list */ - listContactWorkCity(query?: Pagination): Promise> - /** - * 获取租户工作城市列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list - */ - listContactWorkCityIter(): AsyncIterator - /** - * 获取用户列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list - */ - listContactUser(query?: ListContactUserQuery & Pagination): Promise> + listContactWorkCity(query?: Pagination): Paginated /** * 获取用户列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list */ - listContactUserIter(query?: ListContactUserQuery): AsyncIterator + listContactUser(query?: ListContactUserQuery): Paginated /** * 更新用户所有信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update @@ -437,16 +352,11 @@ declare module '../internal' { * 获取部门信息列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list */ - listContactDepartment(query?: ListContactDepartmentQuery & Pagination): Promise> - /** - * 获取部门信息列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list - */ - listContactDepartmentIter(query?: ListContactDepartmentQuery): AsyncIterator + listContactDepartment(query?: ListContactDepartmentQuery): Paginated } } -export interface ListContactScopeQuery { +export interface ListContactScopeQuery extends Pagination { /** 返回值的用户ID的类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' /** 返回值的部门ID的类型 */ @@ -603,7 +513,7 @@ export interface BatchContactUserQuery { department_id_type?: 'open_department_id' | 'department_id' } -export interface FindByDepartmentContactUserQuery { +export interface FindByDepartmentContactUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型部门ID类型的区别参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ @@ -705,12 +615,12 @@ export interface GetContactGroupQuery { department_id_type?: 'open_department_id' | 'department_id' } -export interface SimplelistContactGroupQuery { +export interface SimplelistContactGroupQuery extends Pagination { /** 用户组类型 */ type?: 1 | 2 } -export interface MemberBelongContactGroupQuery { +export interface MemberBelongContactGroupQuery extends Pagination { /** 成员ID */ member_id: string /** 成员ID类型 */ @@ -863,7 +773,7 @@ export interface BatchContactDepartmentQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } -export interface ChildrenContactDepartmentQuery { +export interface ChildrenContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ @@ -872,7 +782,7 @@ export interface ChildrenContactDepartmentQuery { fetch_child?: boolean } -export interface ParentContactDepartmentQuery { +export interface ParentContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ @@ -886,7 +796,7 @@ export interface SearchContactDepartmentRequest { query: string } -export interface SearchContactDepartmentQuery { +export interface SearchContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ @@ -930,7 +840,7 @@ export interface UnbindDepartmentContactUnitRequest { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListDepartmentContactUnitQuery { +export interface ListDepartmentContactUnitQuery extends Pagination { /** 单位ID */ unit_id: string /** 此次调用中预获取的部门ID的类型 */ @@ -951,7 +861,7 @@ export interface BatchAddContactGroupMemberRequest { members?: Memberlist[] } -export interface SimplelistContactGroupMemberQuery { +export interface SimplelistContactGroupMemberQuery extends Pagination { /** 欲获取成员ID类型。当member_type=user时候，member_id_type表示user_id_type，枚举值open_id, union_id和user_id。当member_type=department时候，member_id_type表示department_id_type，枚举值open_id和department_id。 */ member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'department_id' /** 欲获取的用户组成员类型。 */ @@ -1013,7 +923,7 @@ export interface GetContactFunctionalRoleMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListContactFunctionalRoleMemberQuery { +export interface ListContactFunctionalRoleMemberQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' /** 此次调用中使用的部门ID的类型 */ @@ -1060,7 +970,7 @@ export interface UpdateContactJobLevelRequest { i18n_description?: I18nContent[] } -export interface ListContactJobLevelQuery { +export interface ListContactJobLevelQuery extends Pagination { /** 传入该字段时，可查询指定职级名称对应的职级信息。 */ name?: string } @@ -1095,12 +1005,12 @@ export interface UpdateContactJobFamilyRequest { i18n_description?: I18nContent[] } -export interface ListContactJobFamilyQuery { +export interface ListContactJobFamilyQuery extends Pagination { /** 序列名称,传入该字段时，可查询指定序列名称对应的序列信息 */ name?: string } -export interface ListContactUserQuery { +export interface ListContactUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ @@ -1161,7 +1071,7 @@ export interface UpdateContactUserQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListContactDepartmentQuery { +export interface ListContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ diff --git a/adapters/lark/src/types/corehr.ts b/adapters/lark/src/types/corehr.ts index debfa234..d7c4480c 100644 --- a/adapters/lark/src/types/corehr.ts +++ b/adapters/lark/src/types/corehr.ts @@ -1,5 +1,5 @@ import { Address, ApprovalGroup, ApproverInfo, AssessmentForCreate, AssignedOrganizationWithCode, Bank, BankAccount, BankBranch, BasicInfo, BasicInfoUpdate, Bp, BpRoleOrganization, City, Company, Contract, CostCenter, CostCenterVersion, CountryRegion, CountryRegionSubdivision, CpstGrade, CreateTransferInfo, Currency, CustomField, CustomFieldData, DataengineI18n, Department, DepartmentChange, DepartmentCreate, DepartmentHrbp, DepartmentParents, DepartmentTimeline, DepartmentTree, Dependent, District, Education, EducationInfo, Email, EmergencyContact, Employee, EmployeeJobData, EmployeesAdditionalJob, EmployeesAdditionalJobBatchReqDate, EmployeesAdditionalJobWriteResp, EmployeeType, Employment, EmploymentBp, EmploymentCreate, EmploymentLeaveBalance, Enum, EnumFieldOption, FieldVariableValue, FormFieldVariable, HiberarchyCommon, Hrbp, I18n, IdInfo, Job, JobChange, JobData, JobFamily, JobGrade, JobLevel, Language, LeaveGrantingRecord, LeaveRequest, LeaveType, Location, ManagementScope, NationalId, NationalIdType, Nationality, Object, ObjectFieldData, Offboarding, OffboardingReason, OfferInfo, OfferInfoUpdate, OrganizationOpLog, Person, PersonalProfile, PersonInfo, PersonName, Phone, PhoneNumberAndAreaCode, PreHire, PreHireQuery, ProbationInfo, ProbationInfoForSubmit, ProcessAbstractItem, ProcessCcItem, ProcessCommentInfo, ProcessDoneItem, ProcessFormVariableV2, ProcessLink, ProcessSystemDoneItem, ProcessSystemTodoItem, ProcessTodoItem, ProfileSettingCareer, ProfileSettingDataAttachment, ProfileSettingEmploymentInfo, ProfileSettingPersonalInfo, ResidentTax, RoleAuthorization, SecurityGroup, Subdivision, Subregion, SupportCostCenterItem, TimeZone, TransferInfo, TransferReason, TransferType, WkCalendarDate, WkOption, WorkCalendarDetail, WorkExperience, WorkExperienceInfo, WorkforcePlan, WorkforcePlanDetail, WorkforcePlanDetailRow, WorkingHoursType } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,12 +7,7 @@ declare module '../internal' { * 获取飞书人事对象列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/list_object_api_name */ - listObjectApiNameCorehrV1CustomField(query?: Pagination): Promise> - /** - * 获取飞书人事对象列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/list_object_api_name - */ - listObjectApiNameCorehrV1CustomFieldIter(): AsyncIterator + listObjectApiNameCorehrV1CustomField(query?: Pagination): Paginated /** * 获取自定义字段列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query @@ -37,52 +32,27 @@ declare module '../internal' { * 查询国家/地区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search */ - searchCorehrV2BasicInfoCountryRegion(body: SearchCorehrV2BasicInfoCountryRegionRequest, query?: Pagination): Promise> - /** - * 查询国家/地区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search - */ - searchCorehrV2BasicInfoCountryRegionIter(body: SearchCorehrV2BasicInfoCountryRegionRequest): AsyncIterator - /** - * 查询省份/主要行政区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search - */ - searchCorehrV2BasicInfoCountryRegionSubdivision(body: SearchCorehrV2BasicInfoCountryRegionSubdivisionRequest, query?: Pagination): Promise> + searchCorehrV2BasicInfoCountryRegion(body: SearchCorehrV2BasicInfoCountryRegionRequest, query?: Pagination): Paginated /** * 查询省份/主要行政区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search */ - searchCorehrV2BasicInfoCountryRegionSubdivisionIter(body: SearchCorehrV2BasicInfoCountryRegionSubdivisionRequest): AsyncIterator - /** - * 查询城市信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search - */ - searchCorehrV2BasicInfoCity(body: SearchCorehrV2BasicInfoCityRequest, query?: Pagination): Promise> + searchCorehrV2BasicInfoCountryRegionSubdivision(body: SearchCorehrV2BasicInfoCountryRegionSubdivisionRequest, query?: Pagination): Paginated /** * 查询城市信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search */ - searchCorehrV2BasicInfoCityIter(body: SearchCorehrV2BasicInfoCityRequest): AsyncIterator - /** - * 查询区/县信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search - */ - searchCorehrV2BasicInfoDistrict(body: SearchCorehrV2BasicInfoDistrictRequest, query?: Pagination): Promise> + searchCorehrV2BasicInfoCity(body: SearchCorehrV2BasicInfoCityRequest, query?: Pagination): Paginated /** * 查询区/县信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search */ - searchCorehrV2BasicInfoDistrictIter(body: SearchCorehrV2BasicInfoDistrictRequest): AsyncIterator + searchCorehrV2BasicInfoDistrict(body: SearchCorehrV2BasicInfoDistrictRequest, query?: Pagination): Paginated /** * 查询国籍信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search */ - searchCorehrV2BasicInfoNationality(body: SearchCorehrV2BasicInfoNationalityRequest, query?: Pagination): Promise> - /** - * 查询国籍信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search - */ - searchCorehrV2BasicInfoNationalityIter(body: SearchCorehrV2BasicInfoNationalityRequest): AsyncIterator + searchCorehrV2BasicInfoNationality(body: SearchCorehrV2BasicInfoNationalityRequest, query?: Pagination): Paginated /** * 创建国家证件类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/create @@ -107,62 +77,32 @@ declare module '../internal' { * 批量查询国家证件类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/list */ - listCorehrV1NationalIdType(query?: ListCorehrV1NationalIdTypeQuery & Pagination): Promise> - /** - * 批量查询国家证件类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/list - */ - listCorehrV1NationalIdTypeIter(query?: ListCorehrV1NationalIdTypeQuery): AsyncIterator + listCorehrV1NationalIdType(query?: ListCorehrV1NationalIdTypeQuery): Paginated /** * 查询银行信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search */ - searchCorehrV2BasicInfoBank(body: SearchCorehrV2BasicInfoBankRequest, query?: Pagination): Promise> - /** - * 查询银行信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search - */ - searchCorehrV2BasicInfoBankIter(body: SearchCorehrV2BasicInfoBankRequest): AsyncIterator + searchCorehrV2BasicInfoBank(body: SearchCorehrV2BasicInfoBankRequest, query?: Pagination): Paginated /** * 查询支行信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank_branch/search */ - searchCorehrV2BasicInfoBankBranch(body: SearchCorehrV2BasicInfoBankBranchRequest, query?: Pagination): Promise> - /** - * 查询支行信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank_branch/search - */ - searchCorehrV2BasicInfoBankBranchIter(body: SearchCorehrV2BasicInfoBankBranchRequest): AsyncIterator + searchCorehrV2BasicInfoBankBranch(body: SearchCorehrV2BasicInfoBankBranchRequest, query?: Pagination): Paginated /** * 查询货币信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search */ - searchCorehrV2BasicInfoCurrency(body: SearchCorehrV2BasicInfoCurrencyRequest, query?: Pagination): Promise> - /** - * 查询货币信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search - */ - searchCorehrV2BasicInfoCurrencyIter(body: SearchCorehrV2BasicInfoCurrencyRequest): AsyncIterator - /** - * 查询时区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-time_zone/search - */ - searchCorehrV2BasicInfoTimeZone(body: SearchCorehrV2BasicInfoTimeZoneRequest, query?: Pagination): Promise> + searchCorehrV2BasicInfoCurrency(body: SearchCorehrV2BasicInfoCurrencyRequest, query?: Pagination): Paginated /** * 查询时区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-time_zone/search */ - searchCorehrV2BasicInfoTimeZoneIter(body: SearchCorehrV2BasicInfoTimeZoneRequest): AsyncIterator - /** - * 查询语言信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-language/search - */ - searchCorehrV2BasicInfoLanguage(body: SearchCorehrV2BasicInfoLanguageRequest, query?: Pagination): Promise> + searchCorehrV2BasicInfoTimeZone(body: SearchCorehrV2BasicInfoTimeZoneRequest, query?: Pagination): Paginated /** * 查询语言信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-language/search */ - searchCorehrV2BasicInfoLanguageIter(body: SearchCorehrV2BasicInfoLanguageRequest): AsyncIterator + searchCorehrV2BasicInfoLanguage(body: SearchCorehrV2BasicInfoLanguageRequest, query?: Pagination): Paginated /** * 创建人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/create @@ -187,12 +127,7 @@ declare module '../internal' { * 批量查询人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list */ - listCorehrV1EmployeeType(query?: Pagination): Promise> - /** - * 批量查询人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list - */ - listCorehrV1EmployeeTypeIter(): AsyncIterator + listCorehrV1EmployeeType(query?: Pagination): Paginated /** * 创建工时制度 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/create @@ -217,12 +152,7 @@ declare module '../internal' { * 批量查询工时制度 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list */ - listCorehrV1WorkingHoursType(query?: Pagination): Promise> - /** - * 批量查询工时制度 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list - */ - listCorehrV1WorkingHoursTypeIter(): AsyncIterator + listCorehrV1WorkingHoursType(query?: Pagination): Paginated /** * ID 转换 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-id/convert @@ -237,12 +167,7 @@ declare module '../internal' { * 搜索员工信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search */ - searchCorehrV2Employee(body: SearchCorehrV2EmployeeRequest, query?: SearchCorehrV2EmployeeQuery & Pagination): Promise> - /** - * 搜索员工信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search - */ - searchCorehrV2EmployeeIter(body: SearchCorehrV2EmployeeRequest, query?: SearchCorehrV2EmployeeQuery): AsyncIterator + searchCorehrV2Employee(body: SearchCorehrV2EmployeeRequest, query?: SearchCorehrV2EmployeeQuery): Paginated /** * 添加人员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/create @@ -307,12 +232,7 @@ declare module '../internal' { * 获取任职信息列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/query */ - queryCorehrV2EmployeesJobData(body: QueryCorehrV2EmployeesJobDataRequest, query?: QueryCorehrV2EmployeesJobDataQuery & Pagination): Promise> - /** - * 获取任职信息列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/query - */ - queryCorehrV2EmployeesJobDataIter(body: QueryCorehrV2EmployeesJobDataRequest, query?: QueryCorehrV2EmployeesJobDataQuery): AsyncIterator + queryCorehrV2EmployeesJobData(body: QueryCorehrV2EmployeesJobDataRequest, query?: QueryCorehrV2EmployeesJobDataQuery): Paginated /** * 批量查询员工任职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/batch_get @@ -322,12 +242,7 @@ declare module '../internal' { * 批量查询任职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/list */ - listCorehrV1JobData(query?: ListCorehrV1JobDataQuery & Pagination): Promise> - /** - * 批量查询任职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/list - */ - listCorehrV1JobDataIter(query?: ListCorehrV1JobDataQuery): AsyncIterator + listCorehrV1JobData(query?: ListCorehrV1JobDataQuery): Paginated /** * 查询单个任职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/get @@ -352,22 +267,12 @@ declare module '../internal' { * 批量查询兼职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/batch */ - batchCorehrV2EmployeesAdditionalJob(body: BatchCorehrV2EmployeesAdditionalJobRequest, query?: BatchCorehrV2EmployeesAdditionalJobQuery & Pagination): Promise> - /** - * 批量查询兼职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/batch - */ - batchCorehrV2EmployeesAdditionalJobIter(body: BatchCorehrV2EmployeesAdditionalJobRequest, query?: BatchCorehrV2EmployeesAdditionalJobQuery): AsyncIterator - /** - * 批量查询部门操作日志 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_operation_logs - */ - queryOperationLogsCorehrV2Department(body: QueryOperationLogsCorehrV2DepartmentRequest, query?: QueryOperationLogsCorehrV2DepartmentQuery & Pagination): Promise> + batchCorehrV2EmployeesAdditionalJob(body: BatchCorehrV2EmployeesAdditionalJobRequest, query?: BatchCorehrV2EmployeesAdditionalJobQuery): Paginated /** * 批量查询部门操作日志 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_operation_logs */ - queryOperationLogsCorehrV2DepartmentIter(body: QueryOperationLogsCorehrV2DepartmentRequest, query?: QueryOperationLogsCorehrV2DepartmentQuery): AsyncIterator + queryOperationLogsCorehrV2Department(body: QueryOperationLogsCorehrV2DepartmentRequest, query?: QueryOperationLogsCorehrV2DepartmentQuery): Paginated /** * 创建部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/create @@ -392,7 +297,7 @@ declare module '../internal' { * 查询指定时间范围内当前生效信息发生变更的部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_recent_change */ - queryRecentChangeCorehrV2Department(query?: QueryRecentChangeCorehrV2DepartmentQuery & Pagination): Promise + queryRecentChangeCorehrV2Department(query?: QueryRecentChangeCorehrV2DepartmentQuery): Promise /** * 查询指定生效日期的部门基本信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_timeline @@ -402,32 +307,17 @@ declare module '../internal' { * 查询指定生效日期的部门架构树 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/tree */ - treeCorehrV2Department(body: TreeCorehrV2DepartmentRequest, query?: TreeCorehrV2DepartmentQuery & Pagination): Promise> - /** - * 查询指定生效日期的部门架构树 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/tree - */ - treeCorehrV2DepartmentIter(body: TreeCorehrV2DepartmentRequest, query?: TreeCorehrV2DepartmentQuery): AsyncIterator - /** - * 批量查询部门版本信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_multi_timeline - */ - queryMultiTimelineCorehrV2Department(body: QueryMultiTimelineCorehrV2DepartmentRequest, query?: QueryMultiTimelineCorehrV2DepartmentQuery & Pagination): Promise> + treeCorehrV2Department(body: TreeCorehrV2DepartmentRequest, query?: TreeCorehrV2DepartmentQuery): Paginated /** * 批量查询部门版本信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_multi_timeline */ - queryMultiTimelineCorehrV2DepartmentIter(body: QueryMultiTimelineCorehrV2DepartmentRequest, query?: QueryMultiTimelineCorehrV2DepartmentQuery): AsyncIterator + queryMultiTimelineCorehrV2Department(body: QueryMultiTimelineCorehrV2DepartmentRequest, query?: QueryMultiTimelineCorehrV2DepartmentQuery): Paginated /** * 搜索部门信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search */ - searchCorehrV2Department(body: SearchCorehrV2DepartmentRequest, query?: SearchCorehrV2DepartmentQuery & Pagination): Promise> - /** - * 搜索部门信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search - */ - searchCorehrV2DepartmentIter(body: SearchCorehrV2DepartmentRequest, query?: SearchCorehrV2DepartmentQuery): AsyncIterator + searchCorehrV2Department(body: SearchCorehrV2DepartmentRequest, query?: SearchCorehrV2DepartmentQuery): Paginated /** * 删除部门 V2 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/delete @@ -452,7 +342,7 @@ declare module '../internal' { * 查询当前生效信息发生变更的地点 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/query_recent_change */ - queryRecentChangeCorehrV2Location(query?: QueryRecentChangeCorehrV2LocationQuery & Pagination): Promise + queryRecentChangeCorehrV2Location(query?: QueryRecentChangeCorehrV2LocationQuery): Promise /** * 通过地点 ID 批量获取地点信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/batch_get @@ -462,12 +352,7 @@ declare module '../internal' { * 批量分页查询地点信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list */ - listCorehrV1Location(query?: Pagination): Promise> - /** - * 批量分页查询地点信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list - */ - listCorehrV1LocationIter(): AsyncIterator + listCorehrV1Location(query?: Pagination): Paginated /** * 启用/停用地点 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/active @@ -517,17 +402,12 @@ declare module '../internal' { * 批量查询公司 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list */ - listCorehrV1Company(query?: Pagination): Promise> - /** - * 批量查询公司 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list - */ - listCorehrV1CompanyIter(): AsyncIterator + listCorehrV1Company(query?: Pagination): Paginated /** * 查询指定时间范围内当前生效信息发生变更的公司 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/query_recent_change */ - queryRecentChangeCorehrV2Company(query?: QueryRecentChangeCorehrV2CompanyQuery & Pagination): Promise + queryRecentChangeCorehrV2Company(query?: QueryRecentChangeCorehrV2CompanyQuery): Promise /** * 通过公司 ID 批量获取公司信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/batch_get @@ -552,17 +432,12 @@ declare module '../internal' { * 查询当前生效信息发生变更的成本中心 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/query_recent_change */ - queryRecentChangeCorehrV2CostCenter(query?: QueryRecentChangeCorehrV2CostCenterQuery & Pagination): Promise + queryRecentChangeCorehrV2CostCenter(query?: QueryRecentChangeCorehrV2CostCenterQuery): Promise /** * 搜索成本中心信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search */ - searchCorehrV2CostCenter(body: SearchCorehrV2CostCenterRequest, query?: SearchCorehrV2CostCenterQuery & Pagination): Promise> - /** - * 搜索成本中心信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search - */ - searchCorehrV2CostCenterIter(body: SearchCorehrV2CostCenterRequest, query?: SearchCorehrV2CostCenterQuery): AsyncIterator + searchCorehrV2CostCenter(body: SearchCorehrV2CostCenterRequest, query?: SearchCorehrV2CostCenterQuery): Paginated /** * 删除成本中心 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/delete @@ -617,17 +492,12 @@ declare module '../internal' { * 批量查询序列 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list */ - listCorehrV1JobFamily(query?: Pagination): Promise> - /** - * 批量查询序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list - */ - listCorehrV1JobFamilyIter(): AsyncIterator + listCorehrV1JobFamily(query?: Pagination): Paginated /** * 查询当前生效信息发生变更的序列 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_family/query_recent_change */ - queryRecentChangeCorehrV2JobFamily(query?: QueryRecentChangeCorehrV2JobFamilyQuery & Pagination): Promise + queryRecentChangeCorehrV2JobFamily(query?: QueryRecentChangeCorehrV2JobFamilyQuery): Promise /** * 通过序列 ID 批量获取序列信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_family/batch_get @@ -657,17 +527,12 @@ declare module '../internal' { * 批量查询职级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list */ - listCorehrV1JobLevel(query?: Pagination): Promise> - /** - * 批量查询职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list - */ - listCorehrV1JobLevelIter(): AsyncIterator + listCorehrV1JobLevel(query?: Pagination): Paginated /** * 查询当前生效信息发生变更的职级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_level/query_recent_change */ - queryRecentChangeCorehrV2JobLevel(query?: QueryRecentChangeCorehrV2JobLevelQuery & Pagination): Promise + queryRecentChangeCorehrV2JobLevel(query?: QueryRecentChangeCorehrV2JobLevelQuery): Promise /** * 通过职级 ID 批量获取职级信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_level/batch_get @@ -692,17 +557,12 @@ declare module '../internal' { * 查询职等 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query */ - queryCorehrV2JobGrade(body: QueryCorehrV2JobGradeRequest, query?: Pagination): Promise> - /** - * 查询职等 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query - */ - queryCorehrV2JobGradeIter(body: QueryCorehrV2JobGradeRequest): AsyncIterator + queryCorehrV2JobGrade(body: QueryCorehrV2JobGradeRequest, query?: Pagination): Paginated /** * 查询当前生效信息发生变更的职等 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query_recent_change */ - queryRecentChangeCorehrV2JobGrade(query?: QueryRecentChangeCorehrV2JobGradeQuery & Pagination): Promise + queryRecentChangeCorehrV2JobGrade(query?: QueryRecentChangeCorehrV2JobGradeQuery): Promise /** * 删除职等 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/delete @@ -732,12 +592,7 @@ declare module '../internal' { * 批量查询职务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list */ - listCorehrV2Job(query?: ListCorehrV2JobQuery & Pagination): Promise> - /** - * 批量查询职务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list - */ - listCorehrV2JobIter(query?: ListCorehrV2JobQuery): AsyncIterator + listCorehrV2Job(query?: ListCorehrV2JobQuery): Paginated /** * 撤销入职 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/withdraw_onboarding @@ -767,12 +622,7 @@ declare module '../internal' { * 查询待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query */ - queryCorehrV2PreHire(body: QueryCorehrV2PreHireRequest, query?: QueryCorehrV2PreHireQuery & Pagination): Promise> - /** - * 查询待入职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query - */ - queryCorehrV2PreHireIter(body: QueryCorehrV2PreHireRequest, query?: QueryCorehrV2PreHireQuery): AsyncIterator + queryCorehrV2PreHire(body: QueryCorehrV2PreHireRequest, query?: QueryCorehrV2PreHireQuery): Paginated /** * 查询单个待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/get @@ -782,22 +632,12 @@ declare module '../internal' { * 批量查询待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/list */ - listCorehrV1PreHire(query?: ListCorehrV1PreHireQuery & Pagination): Promise> - /** - * 批量查询待入职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/list - */ - listCorehrV1PreHireIter(query?: ListCorehrV1PreHireQuery): AsyncIterator - /** - * 搜索待入职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search - */ - searchCorehrV2PreHire(body: SearchCorehrV2PreHireRequest, query?: SearchCorehrV2PreHireQuery & Pagination): Promise> + listCorehrV1PreHire(query?: ListCorehrV1PreHireQuery): Paginated /** * 搜索待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search */ - searchCorehrV2PreHireIter(body: SearchCorehrV2PreHireRequest, query?: SearchCorehrV2PreHireQuery): AsyncIterator + searchCorehrV2PreHire(body: SearchCorehrV2PreHireRequest, query?: SearchCorehrV2PreHireQuery): Paginated /** * 流转入职任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/transit_task @@ -837,12 +677,7 @@ declare module '../internal' { * 搜索试用期信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search */ - searchCorehrV2Probation(body: SearchCorehrV2ProbationRequest, query?: SearchCorehrV2ProbationQuery & Pagination): Promise> - /** - * 搜索试用期信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search - */ - searchCorehrV2ProbationIter(body: SearchCorehrV2ProbationRequest, query?: SearchCorehrV2ProbationQuery): AsyncIterator + searchCorehrV2Probation(body: SearchCorehrV2ProbationRequest, query?: SearchCorehrV2ProbationQuery): Paginated /** * 删除试用期考核信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/delete @@ -877,12 +712,7 @@ declare module '../internal' { * 搜索员工异动信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search */ - searchCorehrV2JobChange(body: SearchCorehrV2JobChangeRequest, query?: SearchCorehrV2JobChangeQuery & Pagination): Promise> - /** - * 搜索员工异动信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search - */ - searchCorehrV2JobChangeIter(body: SearchCorehrV2JobChangeRequest, query?: SearchCorehrV2JobChangeQuery): AsyncIterator + searchCorehrV2JobChange(body: SearchCorehrV2JobChangeRequest, query?: SearchCorehrV2JobChangeQuery): Paginated /** * 撤销异动 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/revoke @@ -917,12 +747,7 @@ declare module '../internal' { * 搜索离职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/search */ - searchCorehrV1Offboarding(body: SearchCorehrV1OffboardingRequest, query?: SearchCorehrV1OffboardingQuery & Pagination): Promise> - /** - * 搜索离职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/search - */ - searchCorehrV1OffboardingIter(body: SearchCorehrV1OffboardingRequest, query?: SearchCorehrV1OffboardingQuery): AsyncIterator + searchCorehrV1Offboarding(body: SearchCorehrV1OffboardingRequest, query?: SearchCorehrV1OffboardingQuery): Paginated /** * 新建合同 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/create @@ -947,22 +772,12 @@ declare module '../internal' { * 批量查询合同 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list */ - listCorehrV1Contract(query?: Pagination): Promise> - /** - * 批量查询合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list - */ - listCorehrV1ContractIter(): AsyncIterator - /** - * 搜索合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/contract/search - */ - searchCorehrV2Contract(body: SearchCorehrV2ContractRequest, query?: SearchCorehrV2ContractQuery & Pagination): Promise> + listCorehrV1Contract(query?: Pagination): Paginated /** * 搜索合同 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/contract/search */ - searchCorehrV2ContractIter(body: SearchCorehrV2ContractRequest, query?: SearchCorehrV2ContractQuery): AsyncIterator + searchCorehrV2Contract(body: SearchCorehrV2ContractRequest, query?: SearchCorehrV2ContractQuery): Paginated /** * 批量创建/更新明细行 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail_row/batchSave @@ -1007,32 +822,17 @@ declare module '../internal' { * 获取假期类型列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_types */ - leaveTypesCorehrV1Leave(query?: LeaveTypesCorehrV1LeaveQuery & Pagination): Promise> - /** - * 获取假期类型列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_types - */ - leaveTypesCorehrV1LeaveIter(query?: LeaveTypesCorehrV1LeaveQuery): AsyncIterator - /** - * 批量查询员工假期余额 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_balances - */ - leaveBalancesCorehrV1Leave(query?: LeaveBalancesCorehrV1LeaveQuery & Pagination): Promise> + leaveTypesCorehrV1Leave(query?: LeaveTypesCorehrV1LeaveQuery): Paginated /** * 批量查询员工假期余额 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_balances */ - leaveBalancesCorehrV1LeaveIter(query?: LeaveBalancesCorehrV1LeaveQuery): AsyncIterator - /** - * 批量查询员工请假记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_request_history - */ - leaveRequestHistoryCorehrV1Leave(query?: LeaveRequestHistoryCorehrV1LeaveQuery & Pagination): Promise> + leaveBalancesCorehrV1Leave(query?: LeaveBalancesCorehrV1LeaveQuery): Paginated /** * 批量查询员工请假记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_request_history */ - leaveRequestHistoryCorehrV1LeaveIter(query?: LeaveRequestHistoryCorehrV1LeaveQuery): AsyncIterator + leaveRequestHistoryCorehrV1Leave(query?: LeaveRequestHistoryCorehrV1LeaveQuery): Paginated /** * 获取工作日历 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar @@ -1052,12 +852,7 @@ declare module '../internal' { * 批量查询用户授权 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/query */ - queryCorehrV1Authorization(query?: QueryCorehrV1AuthorizationQuery & Pagination): Promise> - /** - * 批量查询用户授权 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/query - */ - queryCorehrV1AuthorizationIter(query?: QueryCorehrV1AuthorizationQuery): AsyncIterator + queryCorehrV1Authorization(query?: QueryCorehrV1AuthorizationQuery): Paginated /** * 查询单个用户授权 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/get_by_param @@ -1067,12 +862,7 @@ declare module '../internal' { * 批量获取角色列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/list */ - listCorehrV1SecurityGroup(query?: Pagination): Promise> - /** - * 批量获取角色列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/list - */ - listCorehrV1SecurityGroupIter(): AsyncIterator + listCorehrV1SecurityGroup(query?: Pagination): Paginated /** * 为用户授权角色 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/add_role_assign @@ -1107,27 +897,17 @@ declare module '../internal' { * 获取 HRBP 列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/list */ - listCorehrV2Bp(query?: ListCorehrV2BpQuery & Pagination): Promise> - /** - * 获取 HRBP 列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/list - */ - listCorehrV2BpIter(query?: ListCorehrV2BpQuery): AsyncIterator + listCorehrV2Bp(query?: ListCorehrV2BpQuery): Paginated /** * 获取组织类角色授权列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/assigned_user/search */ - searchCorehrV1AssignedUser(body: SearchCorehrV1AssignedUserRequest, query?: SearchCorehrV1AssignedUserQuery): Promise> + searchCorehrV1AssignedUser(body: SearchCorehrV1AssignedUserRequest, query?: SearchCorehrV1AssignedUserQuery): Paginated /** * 查询流程实例列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/list */ - listCorehrV2Process(query?: ListCorehrV2ProcessQuery & Pagination): Promise> - /** - * 查询流程实例列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/list - */ - listCorehrV2ProcessIter(query?: ListCorehrV2ProcessQuery): AsyncIterator + listCorehrV2Process(query?: ListCorehrV2ProcessQuery): Paginated /** * 获取单个流程详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/get @@ -1152,12 +932,7 @@ declare module '../internal' { * 获取指定人员审批任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approver/list */ - listCorehrV2Approver(query?: ListCorehrV2ApproverQuery & Pagination): Promise> - /** - * 获取指定人员审批任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approver/list - */ - listCorehrV2ApproverIter(query?: ListCorehrV2ApproverQuery): AsyncIterator + listCorehrV2Approver(query?: ListCorehrV2ApproverQuery): Paginated /** * 通过/拒绝审批任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-approver/update @@ -1187,12 +962,7 @@ declare module '../internal' { * 批量查询城市/区域信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/list */ - listCorehrV1Subregion(query?: ListCorehrV1SubregionQuery & Pagination): Promise> - /** - * 批量查询城市/区域信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/list - */ - listCorehrV1SubregionIter(query?: ListCorehrV1SubregionQuery): AsyncIterator + listCorehrV1Subregion(query?: ListCorehrV1SubregionQuery): Paginated /** * 查询单条城市/区域信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/get @@ -1202,12 +972,7 @@ declare module '../internal' { * 批量查询省份/行政区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/list */ - listCorehrV1Subdivision(query?: ListCorehrV1SubdivisionQuery & Pagination): Promise> - /** - * 批量查询省份/行政区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/list - */ - listCorehrV1SubdivisionIter(query?: ListCorehrV1SubdivisionQuery): AsyncIterator + listCorehrV1Subdivision(query?: ListCorehrV1SubdivisionQuery): Paginated /** * 查询单条省份/行政区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/get @@ -1217,12 +982,7 @@ declare module '../internal' { * 批量查询国家/地区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/list */ - listCorehrV1CountryRegion(query?: Pagination): Promise> - /** - * 批量查询国家/地区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/list - */ - listCorehrV1CountryRegionIter(): AsyncIterator + listCorehrV1CountryRegion(query?: Pagination): Paginated /** * 查询单条国家/地区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/get @@ -1232,12 +992,7 @@ declare module '../internal' { * 批量查询货币信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/list */ - listCorehrV1Currency(query?: Pagination): Promise> - /** - * 批量查询货币信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/list - */ - listCorehrV1CurrencyIter(): AsyncIterator + listCorehrV1Currency(query?: Pagination): Paginated /** * 查询单个货币信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/get @@ -1267,22 +1022,12 @@ declare module '../internal' { * 批量查询职务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/list */ - listCorehrV1Job(query?: ListCorehrV1JobQuery & Pagination): Promise> - /** - * 批量查询职务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/list - */ - listCorehrV1JobIter(query?: ListCorehrV1JobQuery): AsyncIterator - /** - * 批量查询部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/list - */ - listCorehrV1Department(query?: ListCorehrV1DepartmentQuery & Pagination): Promise> + listCorehrV1Job(query?: ListCorehrV1JobQuery): Paginated /** * 批量查询部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/list */ - listCorehrV1DepartmentIter(query?: ListCorehrV1DepartmentQuery): AsyncIterator + listCorehrV1Department(query?: ListCorehrV1DepartmentQuery): Paginated /** * 更新个人信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/patch @@ -1437,7 +1182,7 @@ export interface PatchCorehrV1NationalIdTypeQuery { client_token?: string } -export interface ListCorehrV1NationalIdTypeQuery { +export interface ListCorehrV1NationalIdTypeQuery extends Pagination { /** 证件类型 */ identification_type?: string /** 证件类型编码 */ @@ -1690,7 +1435,7 @@ export interface SearchCorehrV2EmployeeRequest { archive_cpst_plan_id_list?: string[] } -export interface SearchCorehrV2EmployeeQuery { +export interface SearchCorehrV2EmployeeQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2091,7 +1836,7 @@ export interface QueryCorehrV2EmployeesJobDataRequest { assignment_start_reasons?: string[] } -export interface QueryCorehrV2EmployeesJobDataQuery { +export interface QueryCorehrV2EmployeesJobDataQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2122,7 +1867,7 @@ export interface BatchGetCorehrV2EmployeesJobDataQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface ListCorehrV1JobDataQuery { +export interface ListCorehrV1JobDataQuery extends Pagination { /** 雇佣 ID */ employment_id?: string /** 任职信息 ID 列表，最大 100 个（不传则默认查询全部任职信息） */ @@ -2259,7 +2004,7 @@ export interface BatchCorehrV2EmployeesAdditionalJobRequest { is_effective?: boolean } -export interface BatchCorehrV2EmployeesAdditionalJobQuery { +export interface BatchCorehrV2EmployeesAdditionalJobQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2275,7 +2020,7 @@ export interface QueryOperationLogsCorehrV2DepartmentRequest { end_date: string } -export interface QueryOperationLogsCorehrV2DepartmentQuery { +export interface QueryOperationLogsCorehrV2DepartmentQuery extends Pagination { /** 此次调用中使用的部门 ID 类型 */ department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } @@ -2364,7 +2109,7 @@ export interface BatchGetCorehrV2DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface QueryRecentChangeCorehrV2DepartmentQuery { +export interface QueryRecentChangeCorehrV2DepartmentQuery extends Pagination { /** 查询的开始时间，格式 "yyyy-MM-dd"，不带时分秒，包含 start_date 传入的时间, 系统会以 start_date 的 00:00:00 查询。 */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd"，不带时分秒， 查询日期小于 end_data + 1 天的 00:00:00。 */ @@ -2398,7 +2143,7 @@ export interface TreeCorehrV2DepartmentRequest { effective_date?: string } -export interface TreeCorehrV2DepartmentQuery { +export interface TreeCorehrV2DepartmentQuery extends Pagination { /** 此次调用中使用的部门 ID 类型 */ department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } @@ -2414,7 +2159,7 @@ export interface QueryMultiTimelineCorehrV2DepartmentRequest { fields?: string[] } -export interface QueryMultiTimelineCorehrV2DepartmentQuery { +export interface QueryMultiTimelineCorehrV2DepartmentQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2440,7 +2185,7 @@ export interface SearchCorehrV2DepartmentRequest { fields?: string[] } -export interface SearchCorehrV2DepartmentQuery { +export interface SearchCorehrV2DepartmentQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2506,7 +2251,7 @@ export interface PatchCorehrV2LocationQuery { client_token?: string } -export interface QueryRecentChangeCorehrV2LocationQuery { +export interface QueryRecentChangeCorehrV2LocationQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2702,7 +2447,7 @@ export interface ActiveCorehrV2CompanyRequest { operation_reason: string } -export interface QueryRecentChangeCorehrV2CompanyQuery { +export interface QueryRecentChangeCorehrV2CompanyQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2748,7 +2493,7 @@ export interface PatchCorehrV2CostCenterQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface QueryRecentChangeCorehrV2CostCenterQuery { +export interface QueryRecentChangeCorehrV2CostCenterQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2768,7 +2513,7 @@ export interface SearchCorehrV2CostCenterRequest { get_all_version?: boolean } -export interface SearchCorehrV2CostCenterQuery { +export interface SearchCorehrV2CostCenterQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } @@ -2900,7 +2645,7 @@ export interface PatchCorehrV1JobFamilyQuery { client_token?: string } -export interface QueryRecentChangeCorehrV2JobFamilyQuery { +export interface QueryRecentChangeCorehrV2JobFamilyQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2956,7 +2701,7 @@ export interface PatchCorehrV1JobLevelQuery { client_token?: string } -export interface QueryRecentChangeCorehrV2JobLevelQuery { +export interface QueryRecentChangeCorehrV2JobLevelQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -3011,7 +2756,7 @@ export interface QueryCorehrV2JobGradeRequest { active?: boolean } -export interface QueryRecentChangeCorehrV2JobGradeQuery { +export interface QueryRecentChangeCorehrV2JobGradeQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -3074,7 +2819,7 @@ export interface PatchCorehrV1JobQuery { client_token?: string } -export interface ListCorehrV2JobQuery { +export interface ListCorehrV2JobQuery extends Pagination { /** 名称 */ name?: string /** 语言 */ @@ -3130,14 +2875,14 @@ export interface QueryCorehrV2PreHireRequest { fields?: string[] } -export interface QueryCorehrV2PreHireQuery { +export interface QueryCorehrV2PreHireQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface ListCorehrV1PreHireQuery { +export interface ListCorehrV1PreHireQuery extends Pagination { /** 待入职ID列表 */ pre_hire_ids?: string[] } @@ -3179,7 +2924,7 @@ export interface SearchCorehrV2PreHireRequest { fields?: string[] } -export interface SearchCorehrV2PreHireQuery { +export interface SearchCorehrV2PreHireQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3289,7 +3034,7 @@ export interface SearchCorehrV2ProbationRequest { final_assessment_grade?: string } -export interface SearchCorehrV2ProbationQuery { +export interface SearchCorehrV2ProbationQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3395,7 +3140,7 @@ export interface SearchCorehrV2JobChangeRequest { target_department_ids?: string[] } -export interface SearchCorehrV2JobChangeQuery { +export interface SearchCorehrV2JobChangeQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3530,7 +3275,7 @@ export interface SearchCorehrV1OffboardingRequest { employee_reasons?: string[] } -export interface SearchCorehrV1OffboardingQuery { +export interface SearchCorehrV1OffboardingQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } @@ -3602,7 +3347,7 @@ export interface SearchCorehrV2ContractRequest { contract_id_list?: string[] } -export interface SearchCorehrV2ContractQuery { +export interface SearchCorehrV2ContractQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } @@ -3695,14 +3440,14 @@ export interface CreateCorehrV1LeaveGrantingRecordQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface LeaveTypesCorehrV1LeaveQuery { +export interface LeaveTypesCorehrV1LeaveQuery extends Pagination { /** 假期类型状态（不传则为全部）可选值有：- 1：已启用- 2：已停用 */ status?: string /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface LeaveBalancesCorehrV1LeaveQuery { +export interface LeaveBalancesCorehrV1LeaveQuery extends Pagination { /** 查询截止日期，即截止到某天余额数据的日期（不传则默认为当天） */ as_of_date?: string /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ @@ -3715,7 +3460,7 @@ export interface LeaveBalancesCorehrV1LeaveQuery { include_offboard?: boolean } -export interface LeaveRequestHistoryCorehrV1LeaveQuery { +export interface LeaveRequestHistoryCorehrV1LeaveQuery extends Pagination { /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ employment_id_list?: string[] /** 休假发起人 ID 列表，最大 100 个 */ @@ -3807,7 +3552,7 @@ export interface WorkCalendarDateCorehrV1LeaveRequest { ids?: string[] } -export interface QueryCorehrV1AuthorizationQuery { +export interface QueryCorehrV1AuthorizationQuery extends Pagination { /** 员工ID列表，最大100个（不传则默认查询全部员工） */ employment_id_list?: string[] /** 角色 ID 列表，最大 100 个 */ @@ -3902,7 +3647,7 @@ export interface QueryCorehrV1SecurityGroupQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface ListCorehrV2BpQuery { +export interface ListCorehrV2BpQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3927,7 +3672,7 @@ export interface SearchCorehrV1AssignedUserQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface ListCorehrV2ProcessQuery { +export interface ListCorehrV2ProcessQuery extends Pagination { /** 查询流程状态列表。 */ statuses?: number[] /** 查询开始时间（unix毫秒时间戳），闭区间，开始时间和结束时间跨度不能超过31天 */ @@ -3978,7 +3723,7 @@ export interface UpdateCorehrV2ProcessWithdrawQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' } -export interface ListCorehrV2ApproverQuery { +export interface ListCorehrV2ApproverQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 按user_id_type类型传递。如果system_approval为false，则必填。否则非必填。 */ @@ -4084,12 +3829,12 @@ export interface MatchCorehrV1CompensationStandardQuery { effective_time?: string } -export interface ListCorehrV1SubregionQuery { +export interface ListCorehrV1SubregionQuery extends Pagination { /** 省份/行政区id，填写后只查询该省份/行政区下的城市/区域 */ subdivision_id?: string } -export interface ListCorehrV1SubdivisionQuery { +export interface ListCorehrV1SubdivisionQuery extends Pagination { /** 国家/地区id，填写后只查询该国家/地区下的省份/行政区 */ country_region_id?: string } @@ -4131,14 +3876,14 @@ export interface GetCorehrV1DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface ListCorehrV1JobQuery { +export interface ListCorehrV1JobQuery extends Pagination { /** 名称 */ name?: string /** 语言 */ query_language?: string } -export interface ListCorehrV1DepartmentQuery { +export interface ListCorehrV1DepartmentQuery extends Pagination { /** 部门ID列表 */ department_id_list?: string[] /** 部门名称列表，需精确匹配 */ diff --git a/adapters/lark/src/types/docx.ts b/adapters/lark/src/types/docx.ts index c9d5ff93..d8126fa0 100644 --- a/adapters/lark/src/types/docx.ts +++ b/adapters/lark/src/types/docx.ts @@ -1,5 +1,5 @@ import { Block, BlockIdRelation, DeleteGridColumnRequest, DeleteTableColumnsRequest, DeleteTableRowsRequest, Document, InsertGridColumnRequest, InsertTableColumnRequest, InsertTableRowRequest, MergeTableCellsRequest, ReplaceFileRequest, ReplaceImageRequest, UnmergeTableCellsRequest, UpdateBlockRequest, UpdateGridColumnWidthRatioRequest, UpdateTablePropertyRequest, UpdateTaskRequest, UpdateTextElementsRequest, UpdateTextRequest, UpdateTextStyleRequest } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -12,12 +12,7 @@ declare module '../internal' { * 获取群公告所有块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/list */ - listDocxChatAnnouncementBlock(chat_id: string, query?: ListDocxChatAnnouncementBlockQuery & Pagination): Promise> - /** - * 获取群公告所有块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/list - */ - listDocxChatAnnouncementBlockIter(chat_id: string, query?: ListDocxChatAnnouncementBlockQuery): AsyncIterator + listDocxChatAnnouncementBlock(chat_id: string, query?: ListDocxChatAnnouncementBlockQuery): Paginated /** * 在群公告中创建块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/create @@ -37,12 +32,7 @@ declare module '../internal' { * 获取所有子块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/get */ - getDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockChildrenQuery & Pagination): Promise> - /** - * 获取所有子块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/get - */ - getDocxChatAnnouncementBlockChildrenIter(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockChildrenQuery): AsyncIterator + getDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockChildrenQuery): Paginated /** * 删除群公告中的块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/batch_delete @@ -67,12 +57,7 @@ declare module '../internal' { * 获取文档所有块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list */ - listDocxDocumentBlock(document_id: string, query?: ListDocxDocumentBlockQuery & Pagination): Promise> - /** - * 获取文档所有块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list - */ - listDocxDocumentBlockIter(document_id: string, query?: ListDocxDocumentBlockQuery): AsyncIterator + listDocxDocumentBlock(document_id: string, query?: ListDocxDocumentBlockQuery): Paginated /** * 创建块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/create @@ -102,12 +87,7 @@ declare module '../internal' { * 获取所有子块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/get */ - getDocxDocumentBlockChildren(document_id: string, block_id: string, query?: GetDocxDocumentBlockChildrenQuery & Pagination): Promise> - /** - * 获取所有子块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/get - */ - getDocxDocumentBlockChildrenIter(document_id: string, block_id: string, query?: GetDocxDocumentBlockChildrenQuery): AsyncIterator + getDocxDocumentBlockChildren(document_id: string, block_id: string, query?: GetDocxDocumentBlockChildrenQuery): Paginated /** * 删除块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/batch_delete @@ -121,7 +101,7 @@ export interface GetDocxChatAnnouncementQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListDocxChatAnnouncementBlockQuery { +export interface ListDocxChatAnnouncementBlockQuery extends Pagination { /** 查询的群公告版本，-1 表示群公告最新版本。群公告创建后，版本为 1。若查询的版本为群公告最新版本，则需要持有群公告的阅读权限；若查询的版本为群公告的历史版本，则需要持有群公告的编辑权限。 */ revision_id?: number /** 此次调用中使用的用户ID的类型 */ @@ -165,7 +145,7 @@ export interface GetDocxChatAnnouncementBlockQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetDocxChatAnnouncementBlockChildrenQuery { +export interface GetDocxChatAnnouncementBlockChildrenQuery extends Pagination { /** 查询的群公告版本，-1 表示群公告最新版本。群公告创建后，版本为 1。若查询的版本为群公告最新版本，则需要持有群公告的阅读权限；若查询的版本为群公告的历史版本，则需要持有群公告的更新权限。 */ revision_id?: number /** 此次调用中使用的用户ID的类型 */ @@ -198,7 +178,7 @@ export interface RawContentDocxDocumentQuery { lang?: 0 | 1 | 2 } -export interface ListDocxDocumentBlockQuery { +export interface ListDocxDocumentBlockQuery extends Pagination { /** 查询的文档版本，-1表示文档最新版本。若此时查询的版本为文档最新版本，则需要持有文档的阅读权限；若此时查询的版本为文档的历史版本，则需要持有文档的编辑权限。 */ document_revision_id?: number /** 此次调用中使用的用户ID的类型 */ @@ -304,7 +284,7 @@ export interface BatchUpdateDocxDocumentBlockQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetDocxDocumentBlockChildrenQuery { +export interface GetDocxDocumentBlockChildrenQuery extends Pagination { /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ document_revision_id?: number /** 此次调用中使用的用户ID的类型 */ diff --git a/adapters/lark/src/types/drive.ts b/adapters/lark/src/types/drive.ts index b0b6d8c7..677ddcf4 100644 --- a/adapters/lark/src/types/drive.ts +++ b/adapters/lark/src/types/drive.ts @@ -1,5 +1,5 @@ import { BaseMember, ExportTask, File, FileComment, FileCommentReply, FileLike, FileStatistics, FileViewRecord, ImportTask, ImportTaskMountPoint, Member, Meta, MetaFailed, PermissionPublic, Property, ReferEntity, ReplyContent, ReplyList, RequestDoc, TmpDownloadUrl, Version } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,12 +7,7 @@ declare module '../internal' { * 获取文件夹中的文件清单 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list */ - listDriveV1File(query?: ListDriveV1FileQuery & Pagination): Promise> - /** - * 获取文件夹中的文件清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list - */ - listDriveV1FileIter(query?: ListDriveV1FileQuery): AsyncIterator + listDriveV1File(query?: ListDriveV1FileQuery): Paginated /** * 新建文件夹 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder @@ -37,12 +32,7 @@ declare module '../internal' { * 获取文件访问记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list */ - listDriveV1FileViewRecord(file_token: string, query?: ListDriveV1FileViewRecordQuery & Pagination): Promise> - /** - * 获取文件访问记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list - */ - listDriveV1FileViewRecordIter(file_token: string, query?: ListDriveV1FileViewRecordQuery): AsyncIterator + listDriveV1FileViewRecord(file_token: string, query?: ListDriveV1FileViewRecordQuery): Paginated /** * 复制文件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy @@ -152,12 +142,7 @@ declare module '../internal' { * 获取文档版本列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list */ - listDriveV1FileVersion(file_token: string, query?: ListDriveV1FileVersionQuery & Pagination): Promise> - /** - * 获取文档版本列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list - */ - listDriveV1FileVersionIter(file_token: string, query?: ListDriveV1FileVersionQuery): AsyncIterator + listDriveV1FileVersion(file_token: string, query?: ListDriveV1FileVersionQuery): Paginated /** * 获取文档版本信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get @@ -172,12 +157,7 @@ declare module '../internal' { * 获取云文档的点赞者列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/file-like/list */ - listDriveV2FileLike(file_token: string, query?: ListDriveV2FileLikeQuery & Pagination): Promise> - /** - * 获取云文档的点赞者列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/file-like/list - */ - listDriveV2FileLikeIter(file_token: string, query?: ListDriveV2FileLikeQuery): AsyncIterator + listDriveV2FileLike(file_token: string, query?: ListDriveV2FileLikeQuery): Paginated /** * 订阅云文档事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe @@ -267,12 +247,7 @@ declare module '../internal' { * 获取云文档所有评论 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list */ - listDriveV1FileComment(file_token: string, query?: ListDriveV1FileCommentQuery & Pagination): Promise> - /** - * 获取云文档所有评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list - */ - listDriveV1FileCommentIter(file_token: string, query?: ListDriveV1FileCommentQuery): AsyncIterator + listDriveV1FileComment(file_token: string, query?: ListDriveV1FileCommentQuery): Paginated /** * 批量获取评论 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/batch_query @@ -297,12 +272,7 @@ declare module '../internal' { * 获取回复信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/list */ - listDriveV1FileCommentReply(file_token: string, comment_id: string, query?: ListDriveV1FileCommentReplyQuery & Pagination): Promise> - /** - * 获取回复信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/list - */ - listDriveV1FileCommentReplyIter(file_token: string, comment_id: string, query?: ListDriveV1FileCommentReplyQuery): AsyncIterator + listDriveV1FileCommentReply(file_token: string, comment_id: string, query?: ListDriveV1FileCommentReplyQuery): Paginated /** * 更新回复的内容 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/update @@ -331,7 +301,7 @@ declare module '../internal' { } } -export interface ListDriveV1FileQuery { +export interface ListDriveV1FileQuery extends Pagination { /** 文件夹的token（若不填写该参数或填写空字符串，则默认获取用户云空间下的清单，且不支持分页） */ folder_token?: string /** 排序规则 */ @@ -371,7 +341,7 @@ export interface GetDriveV1FileStatisticsQuery { file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx' } -export interface ListDriveV1FileViewRecordQuery { +export interface ListDriveV1FileViewRecordQuery extends Pagination { /** 文档类型 */ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file' /** 此次调用中使用的访问者 ID 的类型 */ @@ -567,7 +537,7 @@ export interface CreateDriveV1FileVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListDriveV1FileVersionQuery { +export interface ListDriveV1FileVersionQuery extends Pagination { /** 原文档类型 */ obj_type: 'docx' | 'sheet' /** 用户id类型 */ @@ -588,7 +558,7 @@ export interface DeleteDriveV1FileVersionQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } -export interface ListDriveV2FileLikeQuery { +export interface ListDriveV2FileLikeQuery extends Pagination { /** 文件类型，如果该值为空或者与文件实际类型不匹配，接口会返回失败。 */ file_type: 'doc' | 'docx' | 'file' /** 此次调用中使用的用户ID的类型 */ @@ -783,7 +753,7 @@ export interface PatchDriveV2PermissionPublicQuery { type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } -export interface ListDriveV1FileCommentQuery { +export interface ListDriveV1FileCommentQuery extends Pagination { /** 文档类型 */ file_type: 'doc' | 'sheet' | 'file' | 'docx' /** 是否全文评论 */ @@ -835,7 +805,7 @@ export interface GetDriveV1FileCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListDriveV1FileCommentReplyQuery { +export interface ListDriveV1FileCommentReplyQuery extends Pagination { /** 文档类型 */ file_type: 'doc' | 'sheet' | 'file' | 'docx' /** 此次调用中使用的用户ID的类型 */ diff --git a/adapters/lark/src/types/ehr.ts b/adapters/lark/src/types/ehr.ts index d3785f96..88f458ab 100644 --- a/adapters/lark/src/types/ehr.ts +++ b/adapters/lark/src/types/ehr.ts @@ -1,5 +1,5 @@ import { Employee } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,12 +7,7 @@ declare module '../internal' { * 批量获取员工花名册信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list */ - listEhrEmployee(query?: ListEhrEmployeeQuery & Pagination): Promise> - /** - * 批量获取员工花名册信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list - */ - listEhrEmployeeIter(query?: ListEhrEmployeeQuery): AsyncIterator + listEhrEmployee(query?: ListEhrEmployeeQuery): Paginated /** * 下载人员的附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/attachment/get @@ -21,7 +16,7 @@ declare module '../internal' { } } -export interface ListEhrEmployeeQuery { +export interface ListEhrEmployeeQuery extends Pagination { /** 返回数据类型 */ view?: 'basic' | 'full' /** 员工状态，不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录，如 status=2&status=4 */ diff --git a/adapters/lark/src/types/event.ts b/adapters/lark/src/types/event.ts index 9d8b8530..f26b7b54 100644 --- a/adapters/lark/src/types/event.ts +++ b/adapters/lark/src/types/event.ts @@ -1,4 +1,4 @@ -import { Internal, Paginated } from '../internal' +import { Internal } from '../internal' declare module '../internal' { interface Internal { @@ -6,12 +6,7 @@ declare module '../internal' { * 获取事件出口 IP * @see https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list */ - listEventOutboundIp(query?: Pagination): Promise> - /** - * 获取事件出口 IP - * @see https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list - */ - listEventOutboundIpIter(): AsyncIterator + listEventOutboundIp(query?: Pagination): Paginated } } diff --git a/adapters/lark/src/types/helpdesk.ts b/adapters/lark/src/types/helpdesk.ts index 8921d2e1..facbf1e5 100644 --- a/adapters/lark/src/types/helpdesk.ts +++ b/adapters/lark/src/types/helpdesk.ts @@ -1,5 +1,5 @@ import { AgentSchedule, AgentScheduleUpdateInfo, AgentSkill, AgentSkillRule, Category, CustomizedFieldDisplayItem, Event, Faq, FaqCreateInfo, FaqUpdateInfo, Notification, NotificationChat, NotificationDepartment, NotificationUser, Ticket, TicketCustomizedField, TicketMessage, TicketUser, UserCustomizedField, UserQueryFaqInfo } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -142,12 +142,7 @@ declare module '../internal' { * 获取全部工单自定义字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields */ - listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: Pagination): Promise> - /** - * 获取全部工单自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields - */ - listHelpdeskTicketCustomizedFieldIter(body: ListHelpdeskTicketCustomizedFieldRequest): AsyncIterator + listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: Pagination): Paginated /** * 创建知识库 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/create @@ -172,7 +167,7 @@ declare module '../internal' { * 获取全部知识库详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/list */ - listHelpdeskFaq(query?: ListHelpdeskFaqQuery & Pagination): Promise + listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise /** * 获取知识库图像 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/faq_image @@ -182,12 +177,7 @@ declare module '../internal' { * 搜索知识库 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/search */ - searchHelpdeskFaq(query?: SearchHelpdeskFaqQuery & Pagination): Promise> - /** - * 搜索知识库 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/search - */ - searchHelpdeskFaqIter(query?: SearchHelpdeskFaqQuery): AsyncIterator + searchHelpdeskFaq(query?: SearchHelpdeskFaqQuery): Paginated /** * 创建知识库分类 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/create @@ -471,7 +461,7 @@ export interface PatchHelpdeskFaqRequest { faq?: FaqUpdateInfo } -export interface ListHelpdeskFaqQuery { +export interface ListHelpdeskFaqQuery extends Pagination { /** 知识库分类ID */ category_id?: string /** 搜索条件: 知识库状态 1:在线 0:删除，可恢复 2：删除，不可恢复 */ @@ -480,7 +470,7 @@ export interface ListHelpdeskFaqQuery { search?: string } -export interface SearchHelpdeskFaqQuery { +export interface SearchHelpdeskFaqQuery extends Pagination { /** 搜索query，query内容如果不是英文，包含中文空格等有两种编码策略：1. url编码 2. base64编码，同时加上base64=true参数 */ query: string /** 是否转换为base64,输入true表示是，不填写表示否，中文需要转换为base64 */ diff --git a/adapters/lark/src/types/hire.ts b/adapters/lark/src/types/hire.ts index 89a4e9cb..2410d9d4 100644 --- a/adapters/lark/src/types/hire.ts +++ b/adapters/lark/src/types/hire.ts @@ -1,5 +1,5 @@ import { Account, Agency, AgencyAccount, AgencyProtection, AgencySupplier, Application, ApplicationDetailInfo, ApplicationOffer, Attachment, AttachmentInfo, BackgroundCheckOrder, BonusAmount, CheckFailedAccountInfo, CombinedJobObjectValueMap, CombinedJobResultDefaultJobPost, CommonFilter, CommonSchema, CompositeTalentAwardInfo, CompositeTalentBasicInfo, CompositeTalentCareerInfo, CompositeTalentCustomizedData, CompositeTalentEducationInfo, CompositeTalentInternshipInfo, CompositeTalentLanguageInfo, CompositeTalentProjectInfo, CompositeTalentSnsInfo, CompositeTalentWorksInfo, DiInfo, EcoAccountCustomFieldData, EcoBackgroundCheckCustomFieldData, EcoBackgroundCheckPackageAdditionalItem, EcoBackgroundCheckPackageData, EcoBackgroundCheckReportFile, EcoExamLoginInfo, EcoExamPaperData, EcoExamResultDetail, EcoExamResultReport, Employee, EmployeeConversionInfo, EmployeeOverboardInfo, Evaluation, EvaluationTask, ExamMarkingTask, ExternalApplication, ExternalBackgroundCheck, ExternalInterview, ExternalInterviewAssessment, ExternalInterviewAssessmentDimension, ExternalOffer, I18n, InternOfferOffboardingInfo, InternOfferOnboardingInfo, Interview, InterviewAppointmentConfig, Interviewer, InterviewExtend, InterviewFeedbackForm, InterviewRecord, InterviewRegistrationSchema, InterviewRoundType, InterviewTask, Job, JobConfigInterviewRoundConf, JobConfigResult, JobConfigRoundType, JobDetail, JobFunction, JobManager, JobProcesses, JobRecruiter2, JobRequirementCustomizedData, JobRequirementDto, JobRequirementSchema, JobRequirementUpdateOption, JobSchema, JobTypeInfo, Location, LocationDto, MentionEntity, Minutes, Mobile, Note, Offer, OfferApplyForm, OfferApplyFormInfo, OfferBasicInfo, OfferCustomFieldConfig, OfferCustomizedInfo, OfferListInfo, OfferSalaryInfo, OfferSchemaDetail, PortalJobPost, Questionnaire, Referral, ReferralInfo, RegistrationBasicInfo, RegistrationSchema, RegistrationSchemaInfo, ResumeSource, Role, RoleDetail, Subject, Talent, TalentBatchInfo, TalentBlock, TalentCombinedAwardInfo, TalentCombinedBasicInfo, TalentCombinedCareerInfo, TalentCombinedEducationInfo, TalentCombinedLanguageInfo, TalentCombinedProjectInfo, TalentCombinedSnsInfo, TalentCombinedWorkInfo, TalentCustomizedDataObjectValue, TalentExternalInfo, TalentFolder, TalentFolderForList, TalentInterview, TalentInterviewRegistrationSimple, TalentNote, TalentOperationLog, TalentPool, TalentResumeAttachment, TalentResumeSource, TalentSelfEvaluation, TalentSimilar, TalentTag, TargetMajorInfo, TerminationReason, Test, Todo, TradeDetail, TripartiteAgreementInfo, UserRole, Website, WebsiteChannelInfo, WebsiteDeliveryAttachmentIndentification, WebsiteDeliveryDto, WebsiteDeliveryResume, WebsiteJobPost, WebsiteUser } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,22 +7,12 @@ declare module '../internal' { * 查询地点列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query */ - queryHireLocation(body: QueryHireLocationRequest, query?: Pagination): Promise> - /** - * 查询地点列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query - */ - queryHireLocationIter(body: QueryHireLocationRequest): AsyncIterator + queryHireLocation(body: QueryHireLocationRequest, query?: Pagination): Paginated /** * 获取地址列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/list */ - listHireLocation(query?: ListHireLocationQuery & Pagination): Promise> - /** - * 获取地址列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/list - */ - listHireLocationIter(query?: ListHireLocationQuery): AsyncIterator + listHireLocation(query?: ListHireLocationQuery): Paginated /** * 获取角色详情 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/get @@ -32,22 +22,12 @@ declare module '../internal' { * 获取角色列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/list */ - listHireRole(query?: Pagination): Promise> - /** - * 获取角色列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/list - */ - listHireRoleIter(): AsyncIterator - /** - * 获取用户角色列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/user_role/list - */ - listHireUserRole(query?: ListHireUserRoleQuery & Pagination): Promise> + listHireRole(query?: Pagination): Paginated /** * 获取用户角色列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/user_role/list */ - listHireUserRoleIter(query?: ListHireUserRoleQuery): AsyncIterator + listHireUserRole(query?: ListHireUserRoleQuery): Paginated /** * 新建职位 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_create @@ -92,12 +72,7 @@ declare module '../internal' { * 获取职位列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/list */ - listHireJob(query?: ListHireJobQuery & Pagination): Promise> - /** - * 获取职位列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/list - */ - listHireJobIter(query?: ListHireJobQuery): AsyncIterator + listHireJob(query?: ListHireJobQuery): Paginated /** * 关闭职位 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/close @@ -112,12 +87,7 @@ declare module '../internal' { * 获取职位模板 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_schema/list */ - listHireJobSchema(query?: ListHireJobSchemaQuery & Pagination): Promise> - /** - * 获取职位模板 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_schema/list - */ - listHireJobSchemaIter(query?: ListHireJobSchemaQuery): AsyncIterator + listHireJobSchema(query?: ListHireJobSchemaQuery): Paginated /** * 发布职位广告 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/advertisement/publish @@ -127,32 +97,17 @@ declare module '../internal' { * 获取职位广告发布记录 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_publish_record/search */ - searchHireJobPublishRecord(body: SearchHireJobPublishRecordRequest, query?: SearchHireJobPublishRecordQuery & Pagination): Promise> - /** - * 获取职位广告发布记录 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_publish_record/search - */ - searchHireJobPublishRecordIter(body: SearchHireJobPublishRecordRequest, query?: SearchHireJobPublishRecordQuery): AsyncIterator + searchHireJobPublishRecord(body: SearchHireJobPublishRecordRequest, query?: SearchHireJobPublishRecordQuery): Paginated /** * 获取职能分类列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_function/list */ - listHireJobFunction(query?: Pagination): Promise> - /** - * 获取职能分类列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_function/list - */ - listHireJobFunctionIter(): AsyncIterator + listHireJobFunction(query?: Pagination): Paginated /** * 获取职位类别列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_type/list */ - listHireJobType(query?: Pagination): Promise> - /** - * 获取职位类别列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_type/list - */ - listHireJobTypeIter(): AsyncIterator + listHireJobType(query?: Pagination): Paginated /** * 创建招聘需求 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/create @@ -172,12 +127,7 @@ declare module '../internal' { * 获取招聘需求列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list */ - listHireJobRequirement(query?: ListHireJobRequirementQuery & Pagination): Promise> - /** - * 获取招聘需求列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list - */ - listHireJobRequirementIter(query?: ListHireJobRequirementQuery): AsyncIterator + listHireJobRequirement(query?: ListHireJobRequirementQuery): Paginated /** * 删除招聘需求 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/delete @@ -187,62 +137,32 @@ declare module '../internal' { * 获取招聘需求模板列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement_schema/list */ - listHireJobRequirementSchema(query?: Pagination): Promise> - /** - * 获取招聘需求模板列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement_schema/list - */ - listHireJobRequirementSchemaIter(): AsyncIterator + listHireJobRequirementSchema(query?: Pagination): Paginated /** * 获取招聘流程信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list */ - listHireJobProcess(query?: Pagination): Promise> - /** - * 获取招聘流程信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list - */ - listHireJobProcessIter(): AsyncIterator - /** - * 获取项目列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/subject/list - */ - listHireSubject(query?: ListHireSubjectQuery & Pagination): Promise> + listHireJobProcess(query?: Pagination): Paginated /** * 获取项目列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/subject/list */ - listHireSubjectIter(query?: ListHireSubjectQuery): AsyncIterator + listHireSubject(query?: ListHireSubjectQuery): Paginated /** * 获取人才标签信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list */ - listHireTalentTag(query?: ListHireTalentTagQuery & Pagination): Promise> - /** - * 获取人才标签信息列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list - */ - listHireTalentTagIter(query?: ListHireTalentTagQuery): AsyncIterator + listHireTalentTag(query?: ListHireTalentTagQuery): Paginated /** * 获取信息登记表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/registration_schema/list */ - listHireRegistrationSchema(query?: ListHireRegistrationSchemaQuery & Pagination): Promise> - /** - * 获取信息登记表列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/registration_schema/list - */ - listHireRegistrationSchemaIter(query?: ListHireRegistrationSchemaQuery): AsyncIterator - /** - * 获取面试评价表列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_feedback_form/list - */ - listHireInterviewFeedbackForm(query?: ListHireInterviewFeedbackFormQuery & Pagination): Promise> + listHireRegistrationSchema(query?: ListHireRegistrationSchemaQuery): Paginated /** * 获取面试评价表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_feedback_form/list */ - listHireInterviewFeedbackFormIter(query?: ListHireInterviewFeedbackFormQuery): AsyncIterator + listHireInterviewFeedbackForm(query?: ListHireInterviewFeedbackFormQuery): Paginated /** * 获取面试轮次类型列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_round_type/list @@ -252,22 +172,12 @@ declare module '../internal' { * 获取面试登记表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_registration_schema/list */ - listHireInterviewRegistrationSchema(query?: Pagination): Promise> - /** - * 获取面试登记表列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_registration_schema/list - */ - listHireInterviewRegistrationSchemaIter(): AsyncIterator - /** - * 查询面试官信息列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/list - */ - listHireInterviewer(query?: ListHireInterviewerQuery & Pagination): Promise> + listHireInterviewRegistrationSchema(query?: Pagination): Paginated /** * 查询面试官信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/list */ - listHireInterviewerIter(query?: ListHireInterviewerQuery): AsyncIterator + listHireInterviewer(query?: ListHireInterviewerQuery): Paginated /** * 更新面试官信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/patch @@ -287,12 +197,7 @@ declare module '../internal' { * 获取 Offer 申请表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_application_form/list */ - listHireOfferApplicationForm(query?: Pagination): Promise> - /** - * 获取 Offer 申请表列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_application_form/list - */ - listHireOfferApplicationFormIter(): AsyncIterator + listHireOfferApplicationForm(query?: Pagination): Paginated /** * 查询人才内推信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral/search @@ -302,12 +207,7 @@ declare module '../internal' { * 获取内推官网下职位广告列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/list */ - listHireReferralWebsiteJobPost(query?: ListHireReferralWebsiteJobPostQuery & Pagination): Promise> - /** - * 获取内推官网下职位广告列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/list - */ - listHireReferralWebsiteJobPostIter(query?: ListHireReferralWebsiteJobPostQuery): AsyncIterator + listHireReferralWebsiteJobPost(query?: ListHireReferralWebsiteJobPostQuery): Paginated /** * 获取内推官网下职位广告详情 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/get @@ -337,12 +237,7 @@ declare module '../internal' { * 获取招聘官网推广渠道列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list */ - listHireWebsiteChannel(website_id: string, query?: Pagination): Promise> - /** - * 获取招聘官网推广渠道列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list - */ - listHireWebsiteChannelIter(website_id: string): AsyncIterator + listHireWebsiteChannel(website_id: string, query?: Pagination): Paginated /** * 新建招聘官网用户 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-site_user/create @@ -357,22 +252,12 @@ declare module '../internal' { * 搜索招聘官网下的职位广告列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/search */ - searchHireWebsiteJobPost(website_id: string, body: SearchHireWebsiteJobPostRequest, query?: SearchHireWebsiteJobPostQuery & Pagination): Promise> - /** - * 搜索招聘官网下的职位广告列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/search - */ - searchHireWebsiteJobPostIter(website_id: string, body: SearchHireWebsiteJobPostRequest, query?: SearchHireWebsiteJobPostQuery): AsyncIterator - /** - * 获取招聘官网下的职位广告列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/list - */ - listHireWebsiteJobPost(website_id: string, query?: ListHireWebsiteJobPostQuery & Pagination): Promise> + searchHireWebsiteJobPost(website_id: string, body: SearchHireWebsiteJobPostRequest, query?: SearchHireWebsiteJobPostQuery): Paginated /** * 获取招聘官网下的职位广告列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/list */ - listHireWebsiteJobPostIter(website_id: string, query?: ListHireWebsiteJobPostQuery): AsyncIterator + listHireWebsiteJobPost(website_id: string, query?: ListHireWebsiteJobPostQuery): Paginated /** * 新建招聘官网投递 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume @@ -392,12 +277,7 @@ declare module '../internal' { * 获取招聘官网列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list */ - listHireWebsite(query?: Pagination): Promise> - /** - * 获取招聘官网列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list - */ - listHireWebsiteIter(): AsyncIterator + listHireWebsite(query?: Pagination): Paginated /** * 设置猎头保护期 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/protect @@ -422,22 +302,12 @@ declare module '../internal' { * 查询猎头供应商下猎头列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/get_agency_account */ - getAgencyAccountHireAgency(body: GetAgencyAccountHireAgencyRequest, query?: GetAgencyAccountHireAgencyQuery & Pagination): Promise> - /** - * 查询猎头供应商下猎头列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/get_agency_account - */ - getAgencyAccountHireAgencyIter(body: GetAgencyAccountHireAgencyRequest, query?: GetAgencyAccountHireAgencyQuery): AsyncIterator - /** - * 搜索猎头供应商列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/batch_query - */ - batchQueryHireAgency(body: BatchQueryHireAgencyRequest, query?: BatchQueryHireAgencyQuery & Pagination): Promise> + getAgencyAccountHireAgency(body: GetAgencyAccountHireAgencyRequest, query?: GetAgencyAccountHireAgencyQuery): Paginated /** * 搜索猎头供应商列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/batch_query */ - batchQueryHireAgencyIter(body: BatchQueryHireAgencyRequest, query?: BatchQueryHireAgencyQuery): AsyncIterator + batchQueryHireAgency(body: BatchQueryHireAgencyRequest, query?: BatchQueryHireAgencyQuery): Paginated /** * 禁用/取消禁用猎头 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/operate_agency_account @@ -467,12 +337,7 @@ declare module '../internal' { * 查询外部投递列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/list */ - listHireExternalApplication(query?: ListHireExternalApplicationQuery & Pagination): Promise> - /** - * 查询外部投递列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/list - */ - listHireExternalApplicationIter(query?: ListHireExternalApplicationQuery): AsyncIterator + listHireExternalApplication(query?: ListHireExternalApplicationQuery): Paginated /** * 删除外部投递 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/delete @@ -492,12 +357,7 @@ declare module '../internal' { * 查询外部面试列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/batch_query */ - batchQueryHireExternalInterview(body: BatchQueryHireExternalInterviewRequest, query?: BatchQueryHireExternalInterviewQuery & Pagination): Promise> - /** - * 查询外部面试列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/batch_query - */ - batchQueryHireExternalInterviewIter(body: BatchQueryHireExternalInterviewRequest, query?: BatchQueryHireExternalInterviewQuery): AsyncIterator + batchQueryHireExternalInterview(body: BatchQueryHireExternalInterviewRequest, query?: BatchQueryHireExternalInterviewQuery): Paginated /** * 删除外部面试 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/delete @@ -527,12 +387,7 @@ declare module '../internal' { * 查询外部 Offer 列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/batch_query */ - batchQueryHireExternalOffer(body: BatchQueryHireExternalOfferRequest, query?: BatchQueryHireExternalOfferQuery & Pagination): Promise> - /** - * 查询外部 Offer 列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/batch_query - */ - batchQueryHireExternalOfferIter(body: BatchQueryHireExternalOfferRequest, query?: BatchQueryHireExternalOfferQuery): AsyncIterator + batchQueryHireExternalOffer(body: BatchQueryHireExternalOfferRequest, query?: BatchQueryHireExternalOfferQuery): Paginated /** * 删除外部 Offer * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/delete @@ -552,12 +407,7 @@ declare module '../internal' { * 查询外部背调列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/batch_query */ - batchQueryHireExternalBackgroundCheck(body: BatchQueryHireExternalBackgroundCheckRequest, query?: BatchQueryHireExternalBackgroundCheckQuery & Pagination): Promise> - /** - * 查询外部背调列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/batch_query - */ - batchQueryHireExternalBackgroundCheckIter(body: BatchQueryHireExternalBackgroundCheckRequest, query?: BatchQueryHireExternalBackgroundCheckQuery): AsyncIterator + batchQueryHireExternalBackgroundCheck(body: BatchQueryHireExternalBackgroundCheckRequest, query?: BatchQueryHireExternalBackgroundCheckQuery): Paginated /** * 删除外部背调 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/delete @@ -582,12 +432,7 @@ declare module '../internal' { * 获取人才库列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/search */ - searchHireTalentPool(query?: SearchHireTalentPoolQuery & Pagination): Promise> - /** - * 获取人才库列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/search - */ - searchHireTalentPoolIter(query?: SearchHireTalentPoolQuery): AsyncIterator + searchHireTalentPool(query?: SearchHireTalentPoolQuery): Paginated /** * 将人才加入人才库 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/move_talent @@ -622,12 +467,7 @@ declare module '../internal' { * 获取人才文件夹列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_folder/list */ - listHireTalentFolder(query?: ListHireTalentFolderQuery & Pagination): Promise> - /** - * 获取人才文件夹列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_folder/list - */ - listHireTalentFolderIter(query?: ListHireTalentFolderQuery): AsyncIterator + listHireTalentFolder(query?: ListHireTalentFolderQuery): Paginated /** * 批量获取人才ID * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/batch_get_id @@ -637,12 +477,7 @@ declare module '../internal' { * 获取人才列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/list */ - listHireTalent(query?: ListHireTalentQuery & Pagination): Promise> - /** - * 获取人才列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/list - */ - listHireTalentIter(query?: ListHireTalentQuery): AsyncIterator + listHireTalent(query?: ListHireTalentQuery): Paginated /** * 获取人才字段 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query @@ -697,12 +532,7 @@ declare module '../internal' { * 获取终止投递原因 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/termination_reason/list */ - listHireTerminationReason(query?: Pagination): Promise> - /** - * 获取终止投递原因 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/termination_reason/list - */ - listHireTerminationReasonIter(): AsyncIterator + listHireTerminationReason(query?: Pagination): Paginated /** * 获取投递信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get @@ -712,12 +542,7 @@ declare module '../internal' { * 获取投递列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list */ - listHireApplication(query?: ListHireApplicationQuery & Pagination): Promise> - /** - * 获取投递列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list - */ - listHireApplicationIter(query?: ListHireApplicationQuery): AsyncIterator + listHireApplication(query?: ListHireApplicationQuery): Paginated /** * 获取申请表附加信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/diversity_inclusion/search @@ -727,12 +552,7 @@ declare module '../internal' { * 获取简历评估信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation/list */ - listHireEvaluation(query?: ListHireEvaluationQuery & Pagination): Promise> - /** - * 获取简历评估信息列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation/list - */ - listHireEvaluationIter(query?: ListHireEvaluationQuery): AsyncIterator + listHireEvaluation(query?: ListHireEvaluationQuery): Paginated /** * 添加笔试结果 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam/create @@ -742,22 +562,12 @@ declare module '../internal' { * 获取笔试列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/test/search */ - searchHireTest(body: SearchHireTestRequest, query?: SearchHireTestQuery & Pagination): Promise> - /** - * 获取笔试列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/test/search - */ - searchHireTestIter(body: SearchHireTestRequest, query?: SearchHireTestQuery): AsyncIterator + searchHireTest(body: SearchHireTestRequest, query?: SearchHireTestQuery): Paginated /** * 获取面试信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/list */ - listHireInterview(query?: ListHireInterviewQuery & Pagination): Promise> - /** - * 获取面试信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/list - */ - listHireInterviewIter(query?: ListHireInterviewQuery): AsyncIterator + listHireInterview(query?: ListHireInterviewQuery): Paginated /** * 获取人才面试信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/get_by_talent @@ -777,22 +587,12 @@ declare module '../internal' { * 批量获取面试评价详细信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record/list */ - listHireInterviewRecord(query?: ListHireInterviewRecordQuery & Pagination): Promise> - /** - * 批量获取面试评价详细信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record/list - */ - listHireInterviewRecordIter(query?: ListHireInterviewRecordQuery): AsyncIterator + listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Paginated /** * 批量获取面试评价详细信息（新版） * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/interview_record/list */ - listHireInterviewRecord(query?: ListHireInterviewRecordQuery & Pagination): Promise> - /** - * 批量获取面试评价详细信息（新版） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/interview_record/list - */ - listHireInterviewRecordIter(query?: ListHireInterviewRecordQuery): AsyncIterator + listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Paginated /** * 获取面试记录附件 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record-attachment/get @@ -802,17 +602,12 @@ declare module '../internal' { * 获取面试速记明细 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/minutes/get */ - getHireMinutes(query?: GetHireMinutesQuery & Pagination): Promise + getHireMinutes(query?: GetHireMinutesQuery): Promise /** * 获取面试满意度问卷列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/questionnaire/list */ - listHireQuestionnaire(query?: ListHireQuestionnaireQuery & Pagination): Promise> - /** - * 获取面试满意度问卷列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/questionnaire/list - */ - listHireQuestionnaireIter(query?: ListHireQuestionnaireQuery): AsyncIterator + listHireQuestionnaire(query?: ListHireQuestionnaireQuery): Paginated /** * 创建 Offer * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/create @@ -837,12 +632,7 @@ declare module '../internal' { * 获取 Offer 列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/list */ - listHireOffer(query?: ListHireOfferQuery & Pagination): Promise> - /** - * 获取 Offer 列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/list - */ - listHireOfferIter(query?: ListHireOfferQuery): AsyncIterator + listHireOffer(query?: ListHireOfferQuery): Paginated /** * 更新 Offer 状态 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/offer_status @@ -857,12 +647,7 @@ declare module '../internal' { * 获取背调信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/background_check_order/list */ - listHireBackgroundCheckOrder(query?: ListHireBackgroundCheckOrderQuery & Pagination): Promise> - /** - * 获取背调信息列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/background_check_order/list - */ - listHireBackgroundCheckOrderIter(query?: ListHireBackgroundCheckOrderQuery): AsyncIterator + listHireBackgroundCheckOrder(query?: ListHireBackgroundCheckOrderQuery): Paginated /** * 创建三方协议 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/create @@ -872,12 +657,7 @@ declare module '../internal' { * 获取三方协议 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/list */ - listHireTripartiteAgreement(query?: ListHireTripartiteAgreementQuery & Pagination): Promise> - /** - * 获取三方协议 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/list - */ - listHireTripartiteAgreementIter(query?: ListHireTripartiteAgreementQuery): AsyncIterator + listHireTripartiteAgreement(query?: ListHireTripartiteAgreementQuery): Paginated /** * 更新三方协议 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/update @@ -917,42 +697,22 @@ declare module '../internal' { * 批量获取待办事项 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/todo/list */ - listHireTodo(query?: ListHireTodoQuery & Pagination): Promise> - /** - * 批量获取待办事项 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/todo/list - */ - listHireTodoIter(query?: ListHireTodoQuery): AsyncIterator - /** - * 获取简历评估任务列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation_task/list - */ - listHireEvaluationTask(query?: ListHireEvaluationTaskQuery & Pagination): Promise> + listHireTodo(query?: ListHireTodoQuery): Paginated /** * 获取简历评估任务列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation_task/list */ - listHireEvaluationTaskIter(query?: ListHireEvaluationTaskQuery): AsyncIterator + listHireEvaluationTask(query?: ListHireEvaluationTaskQuery): Paginated /** * 获取笔试阅卷任务列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam_marking_task/list */ - listHireExamMarkingTask(query?: ListHireExamMarkingTaskQuery & Pagination): Promise> - /** - * 获取笔试阅卷任务列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam_marking_task/list - */ - listHireExamMarkingTaskIter(query?: ListHireExamMarkingTaskQuery): AsyncIterator + listHireExamMarkingTask(query?: ListHireExamMarkingTaskQuery): Paginated /** * 获取面试任务列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_task/list */ - listHireInterviewTask(query?: ListHireInterviewTaskQuery & Pagination): Promise> - /** - * 获取面试任务列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_task/list - */ - listHireInterviewTaskIter(query?: ListHireInterviewTaskQuery): AsyncIterator + listHireInterviewTask(query?: ListHireInterviewTaskQuery): Paginated /** * 创建备注 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/create @@ -972,12 +732,7 @@ declare module '../internal' { * 获取备注列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/list */ - listHireNote(query?: ListHireNoteQuery & Pagination): Promise> - /** - * 获取备注列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/list - */ - listHireNoteIter(query?: ListHireNoteQuery): AsyncIterator + listHireNote(query?: ListHireNoteQuery): Paginated /** * 删除备注 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/delete @@ -987,12 +742,7 @@ declare module '../internal' { * 获取简历来源列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/resume_source/list */ - listHireResumeSource(query?: Pagination): Promise> - /** - * 获取简历来源列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/resume_source/list - */ - listHireResumeSourceIter(): AsyncIterator + listHireResumeSource(query?: Pagination): Paginated /** * 创建账号自定义字段 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/create @@ -1127,22 +877,12 @@ declare module '../internal' { * 获取面试记录列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application-interview/list */ - listHireApplicationInterview(application_id: string, query?: ListHireApplicationInterviewQuery & Pagination): Promise> - /** - * 获取面试记录列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application-interview/list - */ - listHireApplicationInterviewIter(application_id: string, query?: ListHireApplicationInterviewQuery): AsyncIterator - /** - * 查询人才操作记录 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/talent_operation_log/search - */ - searchHireTalentOperationLog(body: SearchHireTalentOperationLogRequest, query?: SearchHireTalentOperationLogQuery & Pagination): Promise> + listHireApplicationInterview(application_id: string, query?: ListHireApplicationInterviewQuery): Paginated /** * 查询人才操作记录 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/talent_operation_log/search */ - searchHireTalentOperationLogIter(body: SearchHireTalentOperationLogRequest, query?: SearchHireTalentOperationLogQuery): AsyncIterator + searchHireTalentOperationLog(body: SearchHireTalentOperationLogRequest, query?: SearchHireTalentOperationLogQuery): Paginated /** * 获取职位上的招聘人员信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job-manager/get @@ -1163,12 +903,12 @@ export interface QueryHireLocationRequest { location_type: 1 | 2 | 3 | 4 } -export interface ListHireLocationQuery { +export interface ListHireLocationQuery extends Pagination { /** 地址类型 */ usage: 'position_location' | 'interview_location' | 'store_location' } -export interface ListHireUserRoleQuery { +export interface ListHireUserRoleQuery extends Pagination { /** 用户 ID */ user_id?: string /** 角色 ID */ @@ -1407,7 +1147,7 @@ export interface ConfigHireJobQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireJobQuery { +export interface ListHireJobQuery extends Pagination { /** 最早更新时间，毫秒级时间戳 */ update_start_time?: string /** 最晚更新时间，毫秒级时间戳 */ @@ -1429,7 +1169,7 @@ export interface OpenHireJobRequest { is_never_expired: boolean } -export interface ListHireJobSchemaQuery { +export interface ListHireJobSchemaQuery extends Pagination { /** 职位模板类型 */ scenario?: 1 | 2 } @@ -1444,7 +1184,7 @@ export interface SearchHireJobPublishRecordRequest { job_channel_id: string } -export interface SearchHireJobPublishRecordQuery { +export interface SearchHireJobPublishRecordQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1617,7 +1357,7 @@ export interface ListByIdHireJobRequirementQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireJobRequirementQuery { +export interface ListHireJobRequirementQuery extends Pagination { /** 职位ID */ job_id?: string /** 起始创建时间，传入毫秒级时间戳 */ @@ -1640,14 +1380,14 @@ export interface ListHireJobRequirementQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireSubjectQuery { +export interface ListHireSubjectQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 项目ID列表 */ subject_ids?: string[] } -export interface ListHireTalentTagQuery { +export interface ListHireTalentTagQuery extends Pagination { /** 搜索关键词 */ keyword?: string /** ID 列表 */ @@ -1658,12 +1398,12 @@ export interface ListHireTalentTagQuery { include_inactive?: boolean } -export interface ListHireRegistrationSchemaQuery { +export interface ListHireRegistrationSchemaQuery extends Pagination { /** 登记表适用场景；不填表示获取全部类型信息登记表 */ scenario?: 5 | 6 | 14 } -export interface ListHireInterviewFeedbackFormQuery { +export interface ListHireInterviewFeedbackFormQuery extends Pagination { /** 面试评价表ID列表, 如果使用此字段则会忽略其他参数 */ interview_feedback_form_ids?: string[] } @@ -1673,7 +1413,7 @@ export interface ListHireInterviewRoundTypeQuery { process_type?: 1 | 2 } -export interface ListHireInterviewerQuery { +export interface ListHireInterviewerQuery extends Pagination { /** 面试官userID列表 */ user_ids?: string[] /** 认证状态 */ @@ -1717,7 +1457,7 @@ export interface SearchHireReferralQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListHireReferralWebsiteJobPostQuery { +export interface ListHireReferralWebsiteJobPostQuery extends Pagination { /** 招聘流程类型 */ process_type?: 1 | 2 /** 用户 ID 类型 */ @@ -1797,7 +1537,7 @@ export interface SearchHireWebsiteJobPostRequest { create_end_time?: string } -export interface SearchHireWebsiteJobPostQuery { +export interface SearchHireWebsiteJobPostQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1806,7 +1546,7 @@ export interface SearchHireWebsiteJobPostQuery { job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' } -export interface ListHireWebsiteJobPostQuery { +export interface ListHireWebsiteJobPostQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1912,7 +1652,7 @@ export interface GetAgencyAccountHireAgencyRequest { role?: 0 | 1 } -export interface GetAgencyAccountHireAgencyQuery { +export interface GetAgencyAccountHireAgencyQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'union_id' | 'open_id' } @@ -1926,7 +1666,7 @@ export interface BatchQueryHireAgencyRequest { filter_list?: CommonFilter[] } -export interface BatchQueryHireAgencyQuery { +export interface BatchQueryHireAgencyQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -1996,7 +1736,7 @@ export interface UpdateHireExternalApplicationRequest { termination_type?: string } -export interface ListHireExternalApplicationQuery { +export interface ListHireExternalApplicationQuery extends Pagination { /** 人才ID */ talent_id: string } @@ -2039,7 +1779,7 @@ export interface BatchQueryHireExternalInterviewRequest { external_interview_id_list?: string[] } -export interface BatchQueryHireExternalInterviewQuery { +export interface BatchQueryHireExternalInterviewQuery extends Pagination { /** 外部投递 ID */ external_application_id?: string } @@ -2103,7 +1843,7 @@ export interface BatchQueryHireExternalOfferRequest { external_offer_id_list?: string[] } -export interface BatchQueryHireExternalOfferQuery { +export interface BatchQueryHireExternalOfferQuery extends Pagination { /** 外部投递 ID */ external_application_id?: string } @@ -2141,7 +1881,7 @@ export interface BatchQueryHireExternalBackgroundCheckRequest { external_background_check_id_list?: string[] } -export interface BatchQueryHireExternalBackgroundCheckQuery { +export interface BatchQueryHireExternalBackgroundCheckQuery extends Pagination { /** 外部投递 ID */ external_application_id?: string } @@ -2197,7 +1937,7 @@ export interface BatchChangeTalentPoolHireTalentPoolRequest { option_type: 1 | 2 } -export interface SearchHireTalentPoolQuery { +export interface SearchHireTalentPoolQuery extends Pagination { /** 人才库ID列表 */ id_list?: string[] } @@ -2314,7 +2054,7 @@ export interface RemoveToFolderHireTalentRequest { folder_id: string } -export interface ListHireTalentFolderQuery { +export interface ListHireTalentFolderQuery extends Pagination { /** 用户ID类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } @@ -2332,7 +2072,7 @@ export interface BatchGetIdHireTalentRequest { identification_number_list?: string[] } -export interface ListHireTalentQuery { +export interface ListHireTalentQuery extends Pagination { /** 搜索关键词，支持布尔语言（使用 and、or、not 连接关键词） */ keyword?: string /** 最早更新时间，毫秒级时间戳 */ @@ -2429,7 +2169,7 @@ export interface GetHireApplicationQuery { options?: ('get_latest_application_on_chain')[] } -export interface ListHireApplicationQuery { +export interface ListHireApplicationQuery extends Pagination { /** 按流程过滤，招聘流程 ID，枚举值通过接口「获取招聘流程信息」接口获取 */ process_id?: string /** 按招聘阶段过滤，招聘阶段 ID，枚举值通过「获取招聘流程信息」接口获取 */ @@ -2455,7 +2195,7 @@ export interface SearchHireDiversityInclusionRequest { application_ids?: string[] } -export interface ListHireEvaluationQuery { +export interface ListHireEvaluationQuery extends Pagination { /** 投递 ID */ application_id?: string /** 最早更新时间，毫秒级时间戳 */ @@ -2493,12 +2233,12 @@ export interface SearchHireTestRequest { test_start_time_max?: string } -export interface SearchHireTestQuery { +export interface SearchHireTestQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListHireInterviewQuery { +export interface ListHireInterviewQuery extends Pagination { /** 投递 ID */ application_id?: string /** 面试 ID */ @@ -2532,14 +2272,14 @@ export interface GetHireInterviewRecordQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListHireInterviewRecordQuery { +export interface ListHireInterviewRecordQuery extends Pagination { /** 面试评价ID列表，使用该筛选项时不会分页 */ ids?: string[] /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListHireInterviewRecordQuery { +export interface ListHireInterviewRecordQuery extends Pagination { /** 面试评价ID列表，使用该筛选项时不会分页 */ ids?: string[] /** 此次调用中使用的用户ID的类型 */ @@ -2555,12 +2295,12 @@ export interface GetHireInterviewRecordAttachmentQuery { language?: 1 | 2 } -export interface GetHireMinutesQuery { +export interface GetHireMinutesQuery extends Pagination { /** 面试ID */ interview_id: string } -export interface ListHireQuestionnaireQuery { +export interface ListHireQuestionnaireQuery extends Pagination { /** 投递 ID */ application_id?: string /** 面试 ID */ @@ -2649,7 +2389,7 @@ export interface GetHireOfferQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireOfferQuery { +export interface ListHireOfferQuery extends Pagination { /** 人才 ID */ talent_id: string /** 此次调用中使用的用户ID的类型 */ @@ -2678,7 +2418,7 @@ export interface InternOfferStatusHireOfferRequest { offboarding_info?: InternOfferOffboardingInfo } -export interface ListHireBackgroundCheckOrderQuery { +export interface ListHireBackgroundCheckOrderQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 投递 ID */ @@ -2698,7 +2438,7 @@ export interface CreateHireTripartiteAgreementRequest { create_time: string } -export interface ListHireTripartiteAgreementQuery { +export interface ListHireTripartiteAgreementQuery extends Pagination { /** 投递 ID，必填投递 id 与三方协议 ID 其中之一 */ application_id?: string /** 三方协议 ID，必填投递 id 与三方协议 ID 其中之一 */ @@ -2805,7 +2545,7 @@ export interface GetHireEmployeeQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireTodoQuery { +export interface ListHireTodoQuery extends Pagination { /** 用户 ID，当 token 为租户 token 时，必须传入该字段，当 token 为用户 token 时，不传该字段 */ user_id?: string /** 用户 ID 类型 */ @@ -2814,7 +2554,7 @@ export interface ListHireTodoQuery { type: 'evaluation' | 'offer' | 'exam' | 'interview' } -export interface ListHireEvaluationTaskQuery { +export interface ListHireEvaluationTaskQuery extends Pagination { /** 用户 ID */ user_id: string /** 任务状态 */ @@ -2823,7 +2563,7 @@ export interface ListHireEvaluationTaskQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireExamMarkingTaskQuery { +export interface ListHireExamMarkingTaskQuery extends Pagination { /** 用户 ID */ user_id: string /** 任务状态 */ @@ -2832,7 +2572,7 @@ export interface ListHireExamMarkingTaskQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireInterviewTaskQuery { +export interface ListHireInterviewTaskQuery extends Pagination { /** 用户 ID */ user_id: string /** 任务状态 */ @@ -2884,7 +2624,7 @@ export interface GetHireNoteQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireNoteQuery { +export interface ListHireNoteQuery extends Pagination { /** 人才ID */ talent_id: string /** 此次调用中使用的用户ID的类型 */ @@ -3091,7 +2831,7 @@ export interface GetHireAttachmentQuery { type?: 1 | 2 | 3 } -export interface ListHireApplicationInterviewQuery { +export interface ListHireApplicationInterviewQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' /** 此次调用中使用的「职级 ID」的类型 */ @@ -3107,7 +2847,7 @@ export interface SearchHireTalentOperationLogRequest { operation_list: number[] } -export interface SearchHireTalentOperationLogQuery { +export interface SearchHireTalentOperationLogQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } diff --git a/adapters/lark/src/types/im.ts b/adapters/lark/src/types/im.ts index 95290581..df2fc448 100644 --- a/adapters/lark/src/types/im.ts +++ b/adapters/lark/src/types/im.ts @@ -1,5 +1,5 @@ import { BatchMessageReadUser, BatchMessageRecallProgress, BatchMessageSendProgress, ChatMenuItem, ChatMenuTree, ChatTab, ChatTopNotice, CreateTag, CreateTagFailReason, Emoji, FailedReason, FollowUp, I18nNames, ListChat, ListMember, ListModerator, Mention, Message, MessageBody, MessageReaction, OpenAppFeedCard, OpenAppFeedCardButtons, OpenFailedUserAppFeedCardItem, Operator, PatchTag, PatchTagFailReason, Pin, ReadUser, RestrictedModeSetting, Sender, TagInfo, TagInfoWithBindVersion, UserOpenAppFeedCardDeleter, UserOpenAppFeedCardUpdater } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -47,22 +47,12 @@ declare module '../internal' { * 查询消息已读信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users */ - readUsersImMessage(message_id: string, query?: ReadUsersImMessageQuery & Pagination): Promise> - /** - * 查询消息已读信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users - */ - readUsersImMessageIter(message_id: string, query?: ReadUsersImMessageQuery): AsyncIterator - /** - * 获取会话历史消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list - */ - listImMessage(query?: ListImMessageQuery & Pagination): Promise> + readUsersImMessage(message_id: string, query?: ReadUsersImMessageQuery): Paginated /** * 获取会话历史消息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list */ - listImMessageIter(query?: ListImMessageQuery): AsyncIterator + listImMessage(query?: ListImMessageQuery): Paginated /** * 获取消息中的资源文件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get @@ -132,12 +122,7 @@ declare module '../internal' { * 获取消息表情回复 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list */ - listImMessageReaction(message_id: string, query?: ListImMessageReactionQuery & Pagination): Promise> - /** - * 获取消息表情回复 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list - */ - listImMessageReactionIter(message_id: string, query?: ListImMessageReactionQuery): AsyncIterator + listImMessageReaction(message_id: string, query?: ListImMessageReactionQuery): Paginated /** * 删除消息表情回复 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete @@ -157,12 +142,7 @@ declare module '../internal' { * 获取群内 Pin 消息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list */ - listImPin(query?: ListImPinQuery & Pagination): Promise> - /** - * 获取群内 Pin 消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list - */ - listImPinIter(query?: ListImPinQuery): AsyncIterator + listImPin(query?: ListImPinQuery): Paginated /** * 更新应用发送的消息卡片 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/patch @@ -212,27 +192,17 @@ declare module '../internal' { * 获取用户或机器人所在的群列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list */ - listImChat(query?: ListImChatQuery & Pagination): Promise> - /** - * 获取用户或机器人所在的群列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list - */ - listImChatIter(query?: ListImChatQuery): AsyncIterator - /** - * 搜索对用户或机器人可见的群列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search - */ - searchImChat(query?: SearchImChatQuery & Pagination): Promise> + listImChat(query?: ListImChatQuery): Paginated /** * 搜索对用户或机器人可见的群列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search */ - searchImChatIter(query?: SearchImChatQuery): AsyncIterator + searchImChat(query?: SearchImChatQuery): Paginated /** * 获取群成员发言权限 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get */ - getImChatModeration(chat_id: string, query?: GetImChatModerationQuery & Pagination): Promise + getImChatModeration(chat_id: string, query?: GetImChatModerationQuery): Promise /** * 获取群分享链接 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link @@ -267,7 +237,7 @@ declare module '../internal' { * 获取群成员列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get */ - getImChatMembers(chat_id: string, query?: GetImChatMembersQuery & Pagination): Promise + getImChatMembers(chat_id: string, query?: GetImChatMembersQuery): Promise /** * 判断用户或机器人是否在群里 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat @@ -468,12 +438,12 @@ export interface PushFollowUpImMessageRequest { follow_ups: FollowUp[] } -export interface ReadUsersImMessageQuery { +export interface ReadUsersImMessageQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type: 'user_id' | 'union_id' | 'open_id' } -export interface ListImMessageQuery { +export interface ListImMessageQuery extends Pagination { /** 容器类型 ，目前可选值仅有"chat"，包含单聊（p2p）和群聊（group） */ container_id_type: string /** 容器的id，即chat的id，详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */ @@ -549,7 +519,7 @@ export interface CreateImMessageReactionRequest { reaction_type: Emoji } -export interface ListImMessageReactionQuery { +export interface ListImMessageReactionQuery extends Pagination { /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数，表示拉取所有类型reaction */ reaction_type?: string /** 当操作人为用户时返回用户ID的类型 */ @@ -561,7 +531,7 @@ export interface CreateImPinRequest { message_id: string } -export interface ListImPinQuery { +export interface ListImPinQuery extends Pagination { /** 待获取Pin消息的Chat ID */ chat_id: string /** Pin信息的起始时间（毫秒级时间戳） */ @@ -698,21 +668,21 @@ export interface PutTopNoticeImChatTopNoticeRequest { chat_top_notice: ChatTopNotice[] } -export interface ListImChatQuery { +export interface ListImChatQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 群组排序方式 */ sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc' } -export interface SearchImChatQuery { +export interface SearchImChatQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 关键词。注意：如果query为空值将返回空的结果 */ query?: string } -export interface GetImChatModerationQuery { +export interface GetImChatModerationQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -764,7 +734,7 @@ export interface DeleteImChatMembersQuery { member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' } -export interface GetImChatMembersQuery { +export interface GetImChatMembersQuery extends Pagination { /** 群成员 用户 ID 类型，详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ member_id_type?: 'user_id' | 'union_id' | 'open_id' } diff --git a/adapters/lark/src/types/index.ts b/adapters/lark/src/types/index.ts index be1339f6..b73f779d 100644 --- a/adapters/lark/src/types/index.ts +++ b/adapters/lark/src/types/index.ts @@ -1444,8 +1444,6 @@ export interface AppRole { export interface AppRoleBlockRole { block_id: string - /** Block类型 */ - block_type?: 'dashboard' /** Block权限 */ block_perm: 0 | 1 } @@ -1511,8 +1509,6 @@ export interface AppRoleTableRoleRecRuleCondition { operator?: 'is' | 'isNot' | 'contains' | 'doesNotContain' | 'isEmpty' | 'isNotEmpty' /** 单选或多选字段的选项id */ value?: string[] - /** 字段类型 */ - field_type?: number } export interface ApprovalApproverCcer { diff --git a/adapters/lark/src/types/lingo.ts b/adapters/lark/src/types/lingo.ts index 41d7cd76..b3f9bf5e 100644 --- a/adapters/lark/src/types/lingo.ts +++ b/adapters/lark/src/types/lingo.ts @@ -1,5 +1,5 @@ import { Classification, ClassificationFilter, Draft, Entity, I18nEntryDesc, MatchInfo, OuterInfo, Phrase, RelatedMeta, Repo, Term } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,12 +37,7 @@ declare module '../internal' { * 获取词条列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/list */ - listLingoEntity(query?: ListLingoEntityQuery & Pagination): Promise> - /** - * 获取词条列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/list - */ - listLingoEntityIter(query?: ListLingoEntityQuery): AsyncIterator + listLingoEntity(query?: ListLingoEntityQuery): Paginated /** * 精准搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/match @@ -52,12 +47,7 @@ declare module '../internal' { * 模糊搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/search */ - searchLingoEntity(body: SearchLingoEntityRequest, query?: SearchLingoEntityQuery & Pagination): Promise> - /** - * 模糊搜索词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/search - */ - searchLingoEntityIter(body: SearchLingoEntityRequest, query?: SearchLingoEntityQuery): AsyncIterator + searchLingoEntity(body: SearchLingoEntityRequest, query?: SearchLingoEntityQuery): Paginated /** * 词条高亮 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/highlight @@ -67,12 +57,7 @@ declare module '../internal' { * 获取词典分类 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/classification/list */ - listLingoClassification(query?: ListLingoClassificationQuery & Pagination): Promise> - /** - * 获取词典分类 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/classification/list - */ - listLingoClassificationIter(query?: ListLingoClassificationQuery): AsyncIterator + listLingoClassification(query?: ListLingoClassificationQuery): Paginated /** * 获取词库列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/repo/list @@ -201,7 +186,7 @@ export interface GetLingoEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListLingoEntityQuery { +export interface ListLingoEntityQuery extends Pagination { /** 数据提供方【可用来过滤数据】 */ provider?: string /** 词库 id */ @@ -231,7 +216,7 @@ export interface SearchLingoEntityRequest { creators?: string[] } -export interface SearchLingoEntityQuery { +export interface SearchLingoEntityQuery extends Pagination { /** 词库ID */ repo_id?: string /** 此次调用中使用的用户ID的类型 */ @@ -243,7 +228,7 @@ export interface HighlightLingoEntityRequest { text: string } -export interface ListLingoClassificationQuery { +export interface ListLingoClassificationQuery extends Pagination { /** 词库ID */ repo_id?: string } diff --git a/adapters/lark/src/types/mail.ts b/adapters/lark/src/types/mail.ts index 71a695d6..7a8a5967 100644 --- a/adapters/lark/src/types/mail.ts +++ b/adapters/lark/src/types/mail.ts @@ -1,5 +1,5 @@ import { Attachment, EmailAlias, MailAddress, Mailgroup, MailgroupManager, MailgroupMember, MailgroupPermissionMember, PublicMailbox, PublicMailboxMember, User } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,12 +37,7 @@ declare module '../internal' { * 批量获取邮件组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list */ - listMailMailgroup(query?: ListMailMailgroupQuery & Pagination): Promise> - /** - * 批量获取邮件组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list - */ - listMailMailgroupIter(query?: ListMailMailgroupQuery): AsyncIterator + listMailMailgroup(query?: ListMailMailgroupQuery): Paginated /** * 批量创建邮件组管理员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create @@ -57,12 +52,7 @@ declare module '../internal' { * 批量获取邮件组管理员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list */ - listMailMailgroupManager(mailgroup_id: string, query?: ListMailMailgroupManagerQuery & Pagination): Promise> - /** - * 批量获取邮件组管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list - */ - listMailMailgroupManagerIter(mailgroup_id: string, query?: ListMailMailgroupManagerQuery): AsyncIterator + listMailMailgroupManager(mailgroup_id: string, query?: ListMailMailgroupManagerQuery): Paginated /** * 创建邮件组成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create @@ -82,12 +72,7 @@ declare module '../internal' { * 获取所有邮件组成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list */ - listMailMailgroupMember(mailgroup_id: string, query?: ListMailMailgroupMemberQuery & Pagination): Promise> - /** - * 获取所有邮件组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list - */ - listMailMailgroupMemberIter(mailgroup_id: string, query?: ListMailMailgroupMemberQuery): AsyncIterator + listMailMailgroupMember(mailgroup_id: string, query?: ListMailMailgroupMemberQuery): Paginated /** * 批量创建邮件组成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create @@ -132,12 +117,7 @@ declare module '../internal' { * 批量获取邮件组权限成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list */ - listMailMailgroupPermissionMember(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery & Pagination): Promise> - /** - * 批量获取邮件组权限成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list - */ - listMailMailgroupPermissionMemberIter(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery): AsyncIterator + listMailMailgroupPermissionMember(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery): Paginated /** * 批量创建邮件组权限成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create @@ -172,12 +152,7 @@ declare module '../internal' { * 查询所有公共邮箱 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list */ - listMailPublicMailbox(query?: Pagination): Promise> - /** - * 查询所有公共邮箱 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list - */ - listMailPublicMailboxIter(): AsyncIterator + listMailPublicMailbox(query?: Pagination): Paginated /** * 永久删除公共邮箱 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete @@ -207,12 +182,7 @@ declare module '../internal' { * 查询所有公共邮箱成员信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list */ - listMailPublicMailboxMember(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery & Pagination): Promise> - /** - * 查询所有公共邮箱成员信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list - */ - listMailPublicMailboxMemberIter(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery): AsyncIterator + listMailPublicMailboxMember(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery): Paginated /** * 批量添加公共邮箱成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create @@ -322,7 +292,7 @@ export interface UpdateMailMailgroupRequest { who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' } -export interface ListMailMailgroupQuery { +export interface ListMailMailgroupQuery extends Pagination { /** 邮件组管理员用户ID，用于获取该用户有管理权限的邮件组 */ manager_user_id?: string /** 此次调用中使用的用户ID的类型 */ @@ -349,7 +319,7 @@ export interface BatchDeleteMailMailgroupManagerQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListMailMailgroupManagerQuery { +export interface ListMailMailgroupManagerQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -379,7 +349,7 @@ export interface GetMailMailgroupMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListMailMailgroupMemberQuery { +export interface ListMailMailgroupMemberQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ @@ -433,7 +403,7 @@ export interface GetMailMailgroupPermissionMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListMailMailgroupPermissionMemberQuery { +export interface ListMailMailgroupPermissionMemberQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ @@ -497,7 +467,7 @@ export interface GetMailPublicMailboxMemberQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListMailPublicMailboxMemberQuery { +export interface ListMailPublicMailboxMemberQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } diff --git a/adapters/lark/src/types/okr.ts b/adapters/lark/src/types/okr.ts index d2e5ba13..2293ef18 100644 --- a/adapters/lark/src/types/okr.ts +++ b/adapters/lark/src/types/okr.ts @@ -1,5 +1,5 @@ import { ContentBlock, OkrBatch, OkrReview, Period, PeriodRule } from '.' -import { Internal, Paginated } from '../internal' +import { Internal } from '../internal' declare module '../internal' { interface Internal { @@ -17,12 +17,7 @@ declare module '../internal' { * 获取 OKR 周期列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list */ - listOkrPeriod(query?: Pagination): Promise> - /** - * 获取 OKR 周期列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list - */ - listOkrPeriodIter(): AsyncIterator + listOkrPeriod(query?: Pagination): Paginated /** * 获取 OKR 周期规则 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list diff --git a/adapters/lark/src/types/payroll.ts b/adapters/lark/src/types/payroll.ts index 2389bf9e..a51b46b3 100644 --- a/adapters/lark/src/types/payroll.ts +++ b/adapters/lark/src/types/payroll.ts @@ -1,5 +1,5 @@ import { AcctItem, CostAllocationPlan, CostAllocationReportData, I18nContent, Paygroup } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,41 +7,26 @@ declare module '../internal' { * 批量查询算薪项 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/acct_item/list */ - listPayrollAcctItem(query?: Pagination): Promise> - /** - * 批量查询算薪项 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/acct_item/list - */ - listPayrollAcctItemIter(): AsyncIterator + listPayrollAcctItem(query?: Pagination): Paginated /** * 查询成本分摊报表汇总数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_report/list */ - listPayrollCostAllocationReport(query?: ListPayrollCostAllocationReportQuery & Pagination): Promise - /** - * 批量查询成本分摊方案 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_plan/list - */ - listPayrollCostAllocationPlan(query?: ListPayrollCostAllocationPlanQuery & Pagination): Promise> + listPayrollCostAllocationReport(query?: ListPayrollCostAllocationReportQuery): Promise /** * 批量查询成本分摊方案 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_plan/list */ - listPayrollCostAllocationPlanIter(query?: ListPayrollCostAllocationPlanQuery): AsyncIterator - /** - * 获取薪资组基本信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list - */ - listPayrollPaygroup(query?: Pagination): Promise> + listPayrollCostAllocationPlan(query?: ListPayrollCostAllocationPlanQuery): Paginated /** * 获取薪资组基本信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list */ - listPayrollPaygroupIter(): AsyncIterator + listPayrollPaygroup(query?: Pagination): Paginated } } -export interface ListPayrollCostAllocationReportQuery { +export interface ListPayrollCostAllocationReportQuery extends Pagination { /** 成本分摊方案ID */ cost_allocation_plan_id: string /** 期间 */ @@ -50,7 +35,7 @@ export interface ListPayrollCostAllocationReportQuery { report_type: 0 | 1 | 2 } -export interface ListPayrollCostAllocationPlanQuery { +export interface ListPayrollCostAllocationPlanQuery extends Pagination { /** 期间 */ pay_period: string } diff --git a/adapters/lark/src/types/performance.ts b/adapters/lark/src/types/performance.ts index b62c8485..46320ab4 100644 --- a/adapters/lark/src/types/performance.ts +++ b/adapters/lark/src/types/performance.ts @@ -1,5 +1,5 @@ import { Activity, AdditionalInformation, Field, ImportedMetric, Indicator, MetricField, MetricInLibrary, MetricTag, MetricTemplate, Question, Reviewee, RevieweeMetric, ReviewProfile, ReviewTemplate, Semester, SemesterBaseInfo, StageTask, Template, Unit, WriteUserGroupScopeData } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -17,12 +17,7 @@ declare module '../internal' { * 批量查询补充信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/query */ - queryPerformanceV2AdditionalInformation(body: QueryPerformanceV2AdditionalInformationRequest, query?: QueryPerformanceV2AdditionalInformationQuery & Pagination): Promise> - /** - * 批量查询补充信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/query - */ - queryPerformanceV2AdditionalInformationIter(body: QueryPerformanceV2AdditionalInformationRequest, query?: QueryPerformanceV2AdditionalInformationQuery): AsyncIterator + queryPerformanceV2AdditionalInformation(body: QueryPerformanceV2AdditionalInformationRequest, query?: QueryPerformanceV2AdditionalInformationQuery): Paginated /** * 批量导入补充信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/import @@ -42,57 +37,32 @@ declare module '../internal' { * 获取被评估人信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/reviewee/query */ - queryPerformanceV2Reviewee(body: QueryPerformanceV2RevieweeRequest, query?: QueryPerformanceV2RevieweeQuery & Pagination): Promise - /** - * 获取评估模板配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_template/query - */ - queryPerformanceV2ReviewTemplate(body: QueryPerformanceV2ReviewTemplateRequest, query?: Pagination): Promise> + queryPerformanceV2Reviewee(body: QueryPerformanceV2RevieweeRequest, query?: QueryPerformanceV2RevieweeQuery): Promise /** * 获取评估模板配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_template/query */ - queryPerformanceV2ReviewTemplateIter(body: QueryPerformanceV2ReviewTemplateRequest): AsyncIterator + queryPerformanceV2ReviewTemplate(body: QueryPerformanceV2ReviewTemplateRequest, query?: Pagination): Paginated /** * 获取评估项列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/indicator/query */ - queryPerformanceV2Indicator(body: QueryPerformanceV2IndicatorRequest, query?: Pagination): Promise> - /** - * 获取评估项列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/indicator/query - */ - queryPerformanceV2IndicatorIter(body: QueryPerformanceV2IndicatorRequest): AsyncIterator - /** - * 获取标签填写题配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/question/query - */ - queryPerformanceV2Question(body: QueryPerformanceV2QuestionRequest, query?: Pagination): Promise> + queryPerformanceV2Indicator(body: QueryPerformanceV2IndicatorRequest, query?: Pagination): Paginated /** * 获取标签填写题配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/question/query */ - queryPerformanceV2QuestionIter(body: QueryPerformanceV2QuestionRequest): AsyncIterator + queryPerformanceV2Question(body: QueryPerformanceV2QuestionRequest, query?: Pagination): Paginated /** * 获取指标列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_lib/query */ - queryPerformanceV2MetricLib(body: QueryPerformanceV2MetricLibRequest, query?: QueryPerformanceV2MetricLibQuery & Pagination): Promise> - /** - * 获取指标列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_lib/query - */ - queryPerformanceV2MetricLibIter(body: QueryPerformanceV2MetricLibRequest, query?: QueryPerformanceV2MetricLibQuery): AsyncIterator - /** - * 获取指标模板列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_template/query - */ - queryPerformanceV2MetricTemplate(body: QueryPerformanceV2MetricTemplateRequest, query?: QueryPerformanceV2MetricTemplateQuery & Pagination): Promise> + queryPerformanceV2MetricLib(body: QueryPerformanceV2MetricLibRequest, query?: QueryPerformanceV2MetricLibQuery): Paginated /** * 获取指标模板列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_template/query */ - queryPerformanceV2MetricTemplateIter(body: QueryPerformanceV2MetricTemplateRequest, query?: QueryPerformanceV2MetricTemplateQuery): AsyncIterator + queryPerformanceV2MetricTemplate(body: QueryPerformanceV2MetricTemplateRequest, query?: QueryPerformanceV2MetricTemplateQuery): Paginated /** * 获取指标字段列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_field/query @@ -102,12 +72,7 @@ declare module '../internal' { * 获取指标标签列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_tag/list */ - listPerformanceV2MetricTag(query?: ListPerformanceV2MetricTagQuery & Pagination): Promise> - /** - * 获取指标标签列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_tag/list - */ - listPerformanceV2MetricTagIter(query?: ListPerformanceV2MetricTagQuery): AsyncIterator + listPerformanceV2MetricTag(query?: ListPerformanceV2MetricTagQuery): Paginated /** * 获取周期任务（指定用户） * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_user_list @@ -178,7 +143,7 @@ export interface QueryPerformanceV2AdditionalInformationRequest { reviewee_user_ids?: string[] } -export interface QueryPerformanceV2AdditionalInformationQuery { +export interface QueryPerformanceV2AdditionalInformationQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } @@ -233,7 +198,7 @@ export interface QueryPerformanceV2RevieweeRequest { activity_ids?: string[] } -export interface QueryPerformanceV2RevieweeQuery { +export interface QueryPerformanceV2RevieweeQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } @@ -265,7 +230,7 @@ export interface QueryPerformanceV2MetricLibRequest { scoring_setting_type?: 'score_manually' | 'score_by_formula' } -export interface QueryPerformanceV2MetricLibQuery { +export interface QueryPerformanceV2MetricLibQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } @@ -276,7 +241,7 @@ export interface QueryPerformanceV2MetricTemplateRequest { status?: 'to_be_configured' | 'to_be_activated' | 'enabled' | 'disabled' } -export interface QueryPerformanceV2MetricTemplateQuery { +export interface QueryPerformanceV2MetricTemplateQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } @@ -285,7 +250,7 @@ export interface QueryPerformanceV2MetricFieldRequest { field_ids?: string[] } -export interface ListPerformanceV2MetricTagQuery { +export interface ListPerformanceV2MetricTagQuery extends Pagination { /** 指标标签 ID 列表 */ tag_ids?: string[] } diff --git a/adapters/lark/src/types/personal_settings.ts b/adapters/lark/src/types/personal_settings.ts index 2d6bbe09..a2fdb96a 100644 --- a/adapters/lark/src/types/personal_settings.ts +++ b/adapters/lark/src/types/personal_settings.ts @@ -1,5 +1,5 @@ import { SystemStatus, SystemStatusI18nName, SystemStatusSyncSetting, SystemStatusUserCloseResultEntity, SystemStatusUserOpenParam, SystemStatusUserOpenResultEntity } from '.' -import { Internal, Paginated } from '../internal' +import { Internal } from '../internal' declare module '../internal' { interface Internal { @@ -22,12 +22,7 @@ declare module '../internal' { * 获取系统状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list */ - listPersonalSettingsSystemStatus(query?: Pagination): Promise> - /** - * 获取系统状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list - */ - listPersonalSettingsSystemStatusIter(): AsyncIterator + listPersonalSettingsSystemStatus(query?: Pagination): Paginated /** * 批量开启系统状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open diff --git a/adapters/lark/src/types/report.ts b/adapters/lark/src/types/report.ts index a19c9909..e4132daa 100644 --- a/adapters/lark/src/types/report.ts +++ b/adapters/lark/src/types/report.ts @@ -1,5 +1,5 @@ import { Rule, Task } from '.' -import { Internal, Paginated } from '../internal' +import { Internal } from '../internal' declare module '../internal' { interface Internal { @@ -17,7 +17,7 @@ declare module '../internal' { * 查询任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query */ - queryReportTask(body: QueryReportTaskRequest, query?: QueryReportTaskQuery): Promise> + queryReportTask(body: QueryReportTaskRequest, query?: QueryReportTaskQuery): Paginated } } diff --git a/adapters/lark/src/types/search.ts b/adapters/lark/src/types/search.ts index ed63155b..66cc2eba 100644 --- a/adapters/lark/src/types/search.ts +++ b/adapters/lark/src/types/search.ts @@ -1,5 +1,5 @@ import { Acl, ConnectorParam, DataSource, I18nMeta, Item, ItemContent, ItemMetadata, PatchSchemaProperty, Schema, SchemaDisplay, SchemaProperty } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,22 +7,12 @@ declare module '../internal' { * 搜索消息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/message/create */ - createSearchMessage(body: CreateSearchMessageRequest, query?: CreateSearchMessageQuery & Pagination): Promise> - /** - * 搜索消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/message/create - */ - createSearchMessageIter(body: CreateSearchMessageRequest, query?: CreateSearchMessageQuery): AsyncIterator - /** - * 搜索应用 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/app/create - */ - createSearchApp(body: CreateSearchAppRequest, query?: CreateSearchAppQuery & Pagination): Promise> + createSearchMessage(body: CreateSearchMessageRequest, query?: CreateSearchMessageQuery): Paginated /** * 搜索应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/app/create */ - createSearchAppIter(body: CreateSearchAppRequest, query?: CreateSearchAppQuery): AsyncIterator + createSearchApp(body: CreateSearchAppRequest, query?: CreateSearchAppQuery): Paginated /** * 创建数据源 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/create @@ -47,12 +37,7 @@ declare module '../internal' { * 批量获取数据源 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/list */ - listSearchDataSource(query?: ListSearchDataSourceQuery & Pagination): Promise> - /** - * 批量获取数据源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/list - */ - listSearchDataSourceIter(query?: ListSearchDataSourceQuery): AsyncIterator + listSearchDataSource(query?: ListSearchDataSourceQuery): Paginated /** * 为指定数据项创建索引 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/create @@ -112,7 +97,7 @@ export interface CreateSearchMessageRequest { end_time?: string } -export interface CreateSearchMessageQuery { +export interface CreateSearchMessageQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -122,7 +107,7 @@ export interface CreateSearchAppRequest { query: string } -export interface CreateSearchAppQuery { +export interface CreateSearchAppQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -175,7 +160,7 @@ export interface PatchSearchDataSourceRequest { enable_answer?: boolean } -export interface ListSearchDataSourceQuery { +export interface ListSearchDataSourceQuery extends Pagination { /** 回包数据格式，0-全量数据；1-摘要数据。**注**：摘要数据仅包含"id"，"name"，"state"。 */ view?: 0 | 1 } diff --git a/adapters/lark/src/types/security_and_compliance.ts b/adapters/lark/src/types/security_and_compliance.ts index 7bb11b03..0f20502a 100644 --- a/adapters/lark/src/types/security_and_compliance.ts +++ b/adapters/lark/src/types/security_and_compliance.ts @@ -1,5 +1,5 @@ import { OpenapiLog } from '.' -import { Internal, Paginated } from '../internal' +import { Internal } from '../internal' declare module '../internal' { interface Internal { @@ -7,7 +7,7 @@ declare module '../internal' { * 获取OpenAPI审计日志数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v1/openapi_log/list_data */ - listDataSecurityAndComplianceOpenapiLog(body: ListDataSecurityAndComplianceOpenapiLogRequest): Promise> + listDataSecurityAndComplianceOpenapiLog(body: ListDataSecurityAndComplianceOpenapiLogRequest): Paginated } } diff --git a/adapters/lark/src/types/task.ts b/adapters/lark/src/types/task.ts index 3e102d55..6b212f8b 100644 --- a/adapters/lark/src/types/task.ts +++ b/adapters/lark/src/types/task.ts @@ -1,5 +1,5 @@ import { Attachment, Collaborator, Comment, CustomComplete, CustomField, DatetimeSetting, DocxSource, Due, Follower, InputComment, InputCustomField, InputCustomFieldValue, InputOption, InputSection, InputTask, InputTasklist, Member, MemberSetting, NumberSetting, Option, Origin, Reminder, Section, SectionSummary, SelectSetting, Start, Task, TaskDependency, TaskInTasklistInfo, Tasklist, TasklistActivitySubscription, TaskSummary, TextSetting } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,12 +37,7 @@ declare module '../internal' { * 列取任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list */ - listTaskV2(query?: ListTaskV2Query & Pagination): Promise> - /** - * 列取任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list - */ - listTaskV2Iter(query?: ListTaskV2Query): AsyncIterator + listTaskV2(query?: ListTaskV2Query): Paginated /** * 列取任务所在清单 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/tasklists @@ -87,12 +82,7 @@ declare module '../internal' { * 获取任务的子任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list */ - listTaskV2TaskSubtask(task_guid: string, query?: ListTaskV2TaskSubtaskQuery & Pagination): Promise> - /** - * 获取任务的子任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list - */ - listTaskV2TaskSubtaskIter(task_guid: string, query?: ListTaskV2TaskSubtaskQuery): AsyncIterator + listTaskV2TaskSubtask(task_guid: string, query?: ListTaskV2TaskSubtaskQuery): Paginated /** * 创建清单 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/create @@ -127,22 +117,12 @@ declare module '../internal' { * 获取清单任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks */ - tasksTaskV2Tasklist(tasklist_guid: string, query?: TasksTaskV2TasklistQuery & Pagination): Promise> - /** - * 获取清单任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks - */ - tasksTaskV2TasklistIter(tasklist_guid: string, query?: TasksTaskV2TasklistQuery): AsyncIterator - /** - * 获取清单列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list - */ - listTaskV2Tasklist(query?: ListTaskV2TasklistQuery & Pagination): Promise> + tasksTaskV2Tasklist(tasklist_guid: string, query?: TasksTaskV2TasklistQuery): Paginated /** * 获取清单列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list */ - listTaskV2TasklistIter(query?: ListTaskV2TasklistQuery): AsyncIterator + listTaskV2Tasklist(query?: ListTaskV2TasklistQuery): Paginated /** * 创建动态订阅 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/create @@ -192,12 +172,7 @@ declare module '../internal' { * 获取评论列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list */ - listTaskV2Comment(query?: ListTaskV2CommentQuery & Pagination): Promise> - /** - * 获取评论列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list - */ - listTaskV2CommentIter(query?: ListTaskV2CommentQuery): AsyncIterator + listTaskV2Comment(query?: ListTaskV2CommentQuery): Paginated /** * 上传附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/upload @@ -207,12 +182,7 @@ declare module '../internal' { * 列取附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list */ - listTaskV2Attachment(query?: ListTaskV2AttachmentQuery & Pagination): Promise> - /** - * 列取附件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list - */ - listTaskV2AttachmentIter(query?: ListTaskV2AttachmentQuery): AsyncIterator + listTaskV2Attachment(query?: ListTaskV2AttachmentQuery): Paginated /** * 获取附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/get @@ -247,22 +217,12 @@ declare module '../internal' { * 获取自定义分组列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list */ - listTaskV2Section(query?: ListTaskV2SectionQuery & Pagination): Promise> - /** - * 获取自定义分组列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list - */ - listTaskV2SectionIter(query?: ListTaskV2SectionQuery): AsyncIterator + listTaskV2Section(query?: ListTaskV2SectionQuery): Paginated /** * 获取自定义分组任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks */ - tasksTaskV2Section(section_guid: string, query?: TasksTaskV2SectionQuery & Pagination): Promise> - /** - * 获取自定义分组任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks - */ - tasksTaskV2SectionIter(section_guid: string, query?: TasksTaskV2SectionQuery): AsyncIterator + tasksTaskV2Section(section_guid: string, query?: TasksTaskV2SectionQuery): Paginated /** * 创建自定义字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create @@ -282,12 +242,7 @@ declare module '../internal' { * 列取自定义字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list */ - listTaskV2CustomField(query?: ListTaskV2CustomFieldQuery & Pagination): Promise> - /** - * 列取自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list - */ - listTaskV2CustomFieldIter(query?: ListTaskV2CustomFieldQuery): AsyncIterator + listTaskV2CustomField(query?: ListTaskV2CustomFieldQuery): Paginated /** * 将自定义字段加入资源 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/add @@ -342,12 +297,7 @@ declare module '../internal' { * 查询所有任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/list */ - listTaskV1(query?: ListTaskV1Query & Pagination): Promise> - /** - * 查询所有任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/list - */ - listTaskV1Iter(query?: ListTaskV1Query): AsyncIterator + listTaskV1(query?: ListTaskV1Query): Paginated /** * 新增提醒时间 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/create @@ -362,12 +312,7 @@ declare module '../internal' { * 查询提醒时间列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list */ - listTaskV1TaskReminder(task_id: string, query?: Pagination): Promise> - /** - * 查询提醒时间列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list - */ - listTaskV1TaskReminderIter(task_id: string): AsyncIterator + listTaskV1TaskReminder(task_id: string, query?: Pagination): Paginated /** * 创建评论 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/create @@ -392,12 +337,7 @@ declare module '../internal' { * 获取评论列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/list */ - listTaskV1TaskComment(task_id: string, query?: ListTaskV1TaskCommentQuery & Pagination): Promise> - /** - * 获取评论列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/list - */ - listTaskV1TaskCommentIter(task_id: string, query?: ListTaskV1TaskCommentQuery): AsyncIterator + listTaskV1TaskComment(task_id: string, query?: ListTaskV1TaskCommentQuery): Paginated /** * 新增关注人 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/create @@ -417,12 +357,7 @@ declare module '../internal' { * 获取关注人列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/list */ - listTaskV1TaskFollower(task_id: string, query?: ListTaskV1TaskFollowerQuery & Pagination): Promise> - /** - * 获取关注人列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/list - */ - listTaskV1TaskFollowerIter(task_id: string, query?: ListTaskV1TaskFollowerQuery): AsyncIterator + listTaskV1TaskFollower(task_id: string, query?: ListTaskV1TaskFollowerQuery): Paginated /** * 新增执行者 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/create @@ -442,12 +377,7 @@ declare module '../internal' { * 获取执行者列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/list */ - listTaskV1TaskCollaborator(task_id: string, query?: ListTaskV1TaskCollaboratorQuery & Pagination): Promise> - /** - * 获取执行者列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/list - */ - listTaskV1TaskCollaboratorIter(task_id: string, query?: ListTaskV1TaskCollaboratorQuery): AsyncIterator + listTaskV1TaskCollaborator(task_id: string, query?: ListTaskV1TaskCollaboratorQuery): Paginated } } @@ -532,7 +462,7 @@ export interface RemoveMembersTaskV2Query { user_id_type?: string } -export interface ListTaskV2Query { +export interface ListTaskV2Query extends Pagination { /** 是否按任务完成进行过滤。不填写表示不过滤。 */ completed?: boolean /** 查询任务的范围 */ @@ -635,7 +565,7 @@ export interface CreateTaskV2TaskSubtaskQuery { user_id_type?: string } -export interface ListTaskV2TaskSubtaskQuery { +export interface ListTaskV2TaskSubtaskQuery extends Pagination { /** 表示user的ID的类型，支持open_id, user_id, union_id */ user_id_type?: string } @@ -691,7 +621,7 @@ export interface RemoveMembersTaskV2TasklistQuery { user_id_type?: string } -export interface TasksTaskV2TasklistQuery { +export interface TasksTaskV2TasklistQuery extends Pagination { /** 只查看特定完成状态的任务，不填写表示不按完成状态过滤 */ completed?: boolean /** 任务创建的起始时间戳（ms），闭区间，不填写默认为首个任务的创建时间戳 */ @@ -702,7 +632,7 @@ export interface TasksTaskV2TasklistQuery { user_id_type?: string } -export interface ListTaskV2TasklistQuery { +export interface ListTaskV2TasklistQuery extends Pagination { /** 表示user的ID的类型，支持open_id, user_id, union_id */ user_id_type?: string } @@ -780,7 +710,7 @@ export interface PatchTaskV2CommentQuery { user_id_type?: string } -export interface ListTaskV2CommentQuery { +export interface ListTaskV2CommentQuery extends Pagination { /** 要获取评论列表的资源类型 */ resource_type?: string /** 要获取评论的资源ID。例如要获取任务的评论列表，此处应该填写任务全局唯一ID */ @@ -805,7 +735,7 @@ export interface UploadTaskV2AttachmentQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } -export interface ListTaskV2AttachmentQuery { +export interface ListTaskV2AttachmentQuery extends Pagination { /** 附件归属的资源类型 */ resource_type?: string /** 附件归属资源的id，配合resource_type使用。例如希望获取任务的附件，需要设置 resource_type为task， resource_id为任务的全局唯一ID */ @@ -854,7 +784,7 @@ export interface PatchTaskV2SectionQuery { user_id_type?: string } -export interface ListTaskV2SectionQuery { +export interface ListTaskV2SectionQuery extends Pagination { /** 自定义分组所属的资源类型。支持"my_tasks"(我负责的）和"tasklist"（清单）。当使用"tasklist"时，需要用resource_id提供清单GUID。 */ resource_type: string /** 如`resource_type`为"tasklist"，这里需要填写要列取自定义分组的清单的GUID。 */ @@ -863,7 +793,7 @@ export interface ListTaskV2SectionQuery { user_id_type?: string } -export interface TasksTaskV2SectionQuery { +export interface TasksTaskV2SectionQuery extends Pagination { /** 按照任务状态过滤，如果不填写则表示不按完成状态过滤 */ completed?: boolean /** 按照创建时间筛选的起始时间戳（ms)，如不填写则为首个任务的创建时刻 */ @@ -919,7 +849,7 @@ export interface PatchTaskV2CustomFieldQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } -export interface ListTaskV2CustomFieldQuery { +export interface ListTaskV2CustomFieldQuery extends Pagination { /** 用户ID格式，支持open_id, user_id, union_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' /** 资源类型，如提供表示仅查询特定资源下的自定义字段。目前只支持tasklist。 */ @@ -1011,7 +941,7 @@ export interface GetTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1Query { +export interface ListTaskV1Query extends Pagination { /** 范围查询任务时，查询的起始时间。不填时默认起始时间为第一个任务的创建时间。 */ start_create_time?: string /** 范围查询任务时，查询的结束时间。不填时默认结束时间为最后一个任务的创建时间。 */ @@ -1060,7 +990,7 @@ export interface GetTaskV1TaskCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1TaskCommentQuery { +export interface ListTaskV1TaskCommentQuery extends Pagination { /** 评论排序标记，可按照评论时间从小到大查询，或者评论时间从大到小查询，不填默认按照从小到大 */ list_direction?: 0 | 1 /** 此次调用中使用的用户ID的类型 */ @@ -1094,7 +1024,7 @@ export interface BatchDeleteFollowerTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1TaskFollowerQuery { +export interface ListTaskV1TaskFollowerQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -1126,7 +1056,7 @@ export interface BatchDeleteCollaboratorTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1TaskCollaboratorQuery { +export interface ListTaskV1TaskCollaboratorQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } diff --git a/adapters/lark/src/types/vc.ts b/adapters/lark/src/types/vc.ts index 8d7d59c5..175a9b61 100644 --- a/adapters/lark/src/types/vc.ts +++ b/adapters/lark/src/types/vc.ts @@ -1,5 +1,5 @@ import { Alert, ApprovalConfig, Device, DisableInformConfig, Meeting, MeetingInfo, MeetingInviteStatus, MeetingParticipantResult, MeetingRecording, MeetingUser, Participant, ParticipantQuality, RecordingPermissionObject, Report, ReportTopUser, Reserve, ReserveAdminConfig, ReserveCorrectionCheckInfo, ReserveFormConfig, ReserveMeetingSetting, ReserveScopeConfig, Room, RoomConfig, RoomDigitalSignage, RoomLevel, RoomMeetingReservation, RoomStatus, ScopeConfig, TimeConfig } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -57,12 +57,7 @@ declare module '../internal' { * 获取与会议号关联的会议列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no */ - listByNoVcMeeting(query?: ListByNoVcMeetingQuery & Pagination): Promise> - /** - * 获取与会议号关联的会议列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no - */ - listByNoVcMeetingIter(query?: ListByNoVcMeetingQuery): AsyncIterator + listByNoVcMeeting(query?: ListByNoVcMeetingQuery): Paginated /** * 开始录制 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start @@ -152,12 +147,7 @@ declare module '../internal' { * 查询会议室层级列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list */ - listVcRoomLevel(query?: ListVcRoomLevelQuery & Pagination): Promise> - /** - * 查询会议室层级列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list - */ - listVcRoomLevelIter(query?: ListVcRoomLevelQuery): AsyncIterator + listVcRoomLevel(query?: ListVcRoomLevelQuery): Paginated /** * 搜索会议室层级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search @@ -192,17 +182,12 @@ declare module '../internal' { * 查询会议室列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list */ - listVcRoom(query?: ListVcRoomQuery & Pagination): Promise> - /** - * 查询会议室列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list - */ - listVcRoomIter(query?: ListVcRoomQuery): AsyncIterator + listVcRoom(query?: ListVcRoomQuery): Paginated /** * 搜索会议室 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search */ - searchVcRoom(body: SearchVcRoomRequest, query?: SearchVcRoomQuery): Promise> + searchVcRoom(body: SearchVcRoomRequest, query?: SearchVcRoomQuery): Paginated /** * 查询会议室配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get @@ -257,52 +242,27 @@ declare module '../internal' { * 查询会议明细 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get */ - getVcMeetingList(query?: GetVcMeetingListQuery & Pagination): Promise> - /** - * 查询会议明细 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get - */ - getVcMeetingListIter(query?: GetVcMeetingListQuery): AsyncIterator + getVcMeetingList(query?: GetVcMeetingListQuery): Paginated /** * 查询参会人明细 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get */ - getVcParticipantList(query?: GetVcParticipantListQuery & Pagination): Promise> - /** - * 查询参会人明细 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get - */ - getVcParticipantListIter(query?: GetVcParticipantListQuery): AsyncIterator - /** - * 查询参会人会议质量数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get - */ - getVcParticipantQualityList(query?: GetVcParticipantQualityListQuery & Pagination): Promise> + getVcParticipantList(query?: GetVcParticipantListQuery): Paginated /** * 查询参会人会议质量数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get */ - getVcParticipantQualityListIter(query?: GetVcParticipantQualityListQuery): AsyncIterator + getVcParticipantQualityList(query?: GetVcParticipantQualityListQuery): Paginated /** * 查询会议室预定数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get */ - getVcResourceReservationList(query?: GetVcResourceReservationListQuery & Pagination): Promise> - /** - * 查询会议室预定数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get - */ - getVcResourceReservationListIter(query?: GetVcResourceReservationListQuery): AsyncIterator - /** - * 获取告警记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list - */ - listVcAlert(query?: ListVcAlertQuery & Pagination): Promise> + getVcResourceReservationList(query?: GetVcResourceReservationListQuery): Paginated /** * 获取告警记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list */ - listVcAlertIter(query?: ListVcAlertQuery): AsyncIterator + listVcAlert(query?: ListVcAlertQuery): Paginated /** * 创建签到板部署码 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_checkboard_access_code @@ -405,7 +365,7 @@ export interface GetVcMeetingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListByNoVcMeetingQuery { +export interface ListByNoVcMeetingQuery extends Pagination { /** 9位会议号 */ meeting_no: string /** 查询开始时间（unix时间，单位sec） */ @@ -567,7 +527,7 @@ export interface MgetVcRoomLevelRequest { level_ids: string[] } -export interface ListVcRoomLevelQuery { +export interface ListVcRoomLevelQuery extends Pagination { /** 层级ID，不传则返回该租户下第一层级列表 */ room_level_id?: string } @@ -636,7 +596,7 @@ export interface MgetVcRoomQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListVcRoomQuery { +export interface ListVcRoomQuery extends Pagination { /** 层级ID，不传则返回该租户下的所有会议室 */ room_level_id?: string /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ @@ -768,7 +728,7 @@ export interface PatchVcReserveConfigDisableInformQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetVcMeetingListQuery { +export interface GetVcMeetingListQuery extends Pagination { /** 查询开始时间（unix时间，单位sec） */ start_time: string /** 查询结束时间（unix时间，单位sec） */ @@ -787,7 +747,7 @@ export interface GetVcMeetingListQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetVcParticipantListQuery { +export interface GetVcParticipantListQuery extends Pagination { /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */ meeting_start_time: string /** 会议结束时间（unix时间，单位sec；对于进行中会议则传0） */ @@ -804,7 +764,7 @@ export interface GetVcParticipantListQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetVcParticipantQualityListQuery { +export interface GetVcParticipantQualityListQuery extends Pagination { /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */ meeting_start_time: string /** 会议结束时间（unix时间，单位sec） */ @@ -821,7 +781,7 @@ export interface GetVcParticipantQualityListQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetVcResourceReservationListQuery { +export interface GetVcResourceReservationListQuery extends Pagination { /** 层级id */ room_level_id: string /** 是否展示会议主题 */ @@ -836,7 +796,7 @@ export interface GetVcResourceReservationListQuery { is_exclude?: boolean } -export interface ListVcAlertQuery { +export interface ListVcAlertQuery extends Pagination { /** 开始时间（unix时间，单位sec） */ start_time: string /** 结束时间（unix时间，单位sec） */ diff --git a/adapters/lark/src/types/wiki.ts b/adapters/lark/src/types/wiki.ts index d5f6b754..de5cee97 100644 --- a/adapters/lark/src/types/wiki.ts +++ b/adapters/lark/src/types/wiki.ts @@ -1,5 +1,5 @@ import { Member, Node, Setting, Space, TaskResult } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,12 +7,7 @@ declare module '../internal' { * 获取知识空间列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list */ - listWikiSpace(query?: ListWikiSpaceQuery & Pagination): Promise> - /** - * 获取知识空间列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list - */ - listWikiSpaceIter(query?: ListWikiSpaceQuery): AsyncIterator + listWikiSpace(query?: ListWikiSpaceQuery): Paginated /** * 获取知识空间信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get @@ -27,12 +22,7 @@ declare module '../internal' { * 获取知识空间成员列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list */ - listWikiSpaceMember(space_id: string, query?: Pagination): Promise> - /** - * 获取知识空间成员列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list - */ - listWikiSpaceMemberIter(space_id: string): AsyncIterator + listWikiSpaceMember(space_id: string, query?: Pagination): Paginated /** * 添加知识空间成员 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create @@ -62,12 +52,7 @@ declare module '../internal' { * 获取知识空间子节点列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list */ - listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery & Pagination): Promise> - /** - * 获取知识空间子节点列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list - */ - listWikiSpaceNodeIter(space_id: string, query?: ListWikiSpaceNodeQuery): AsyncIterator + listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery): Paginated /** * 移动知识空间节点 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move @@ -97,16 +82,11 @@ declare module '../internal' { * 搜索 Wiki * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki */ - searchWikiNode(body: SearchWikiNodeRequest, query?: Pagination): Promise> - /** - * 搜索 Wiki - * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki - */ - searchWikiNodeIter(body: SearchWikiNodeRequest): AsyncIterator + searchWikiNode(body: SearchWikiNodeRequest, query?: Pagination): Paginated } } -export interface ListWikiSpaceQuery { +export interface ListWikiSpaceQuery extends Pagination { /** 当查询个人文档库时，指定返回的文档库名称展示语言。可选值有：zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */ lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW' } @@ -177,7 +157,7 @@ export interface GetNodeWikiSpaceQuery { obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki' } -export interface ListWikiSpaceNodeQuery { +export interface ListWikiSpaceNodeQuery extends Pagination { /** 父节点token */ parent_node_token?: string } diff --git a/adapters/lark/src/types/workplace.ts b/adapters/lark/src/types/workplace.ts index ba05bb57..0c40f8d6 100644 --- a/adapters/lark/src/types/workplace.ts +++ b/adapters/lark/src/types/workplace.ts @@ -1,5 +1,5 @@ import { BlockAccessData, CustomWorkplaceAccessData, WorkplaceAccessData } from '.' -import { Internal, Paginated } from '../internal' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,43 +7,28 @@ declare module '../internal' { * 获取工作台访问数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search */ - searchWorkplaceWorkplaceAccessData(query?: SearchWorkplaceWorkplaceAccessDataQuery & Pagination): Promise> - /** - * 获取工作台访问数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search - */ - searchWorkplaceWorkplaceAccessDataIter(query?: SearchWorkplaceWorkplaceAccessDataQuery): AsyncIterator - /** - * 获取定制工作台访问数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search - */ - searchWorkplaceCustomWorkplaceAccessData(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery & Pagination): Promise> + searchWorkplaceWorkplaceAccessData(query?: SearchWorkplaceWorkplaceAccessDataQuery): Paginated /** * 获取定制工作台访问数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search */ - searchWorkplaceCustomWorkplaceAccessDataIter(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery): AsyncIterator - /** - * 获取定制工作台小组件访问数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search - */ - searchWorkplaceWorkplaceBlockAccessData(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery & Pagination): Promise> + searchWorkplaceCustomWorkplaceAccessData(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery): Paginated /** * 获取定制工作台小组件访问数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search */ - searchWorkplaceWorkplaceBlockAccessDataIter(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery): AsyncIterator + searchWorkplaceWorkplaceBlockAccessData(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery): Paginated } } -export interface SearchWorkplaceWorkplaceAccessDataQuery { +export interface SearchWorkplaceWorkplaceAccessDataQuery extends Pagination { /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ from_date: string /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ to_date: string } -export interface SearchWorkplaceCustomWorkplaceAccessDataQuery { +export interface SearchWorkplaceCustomWorkplaceAccessDataQuery extends Pagination { /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ from_date: string /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ @@ -52,7 +37,7 @@ export interface SearchWorkplaceCustomWorkplaceAccessDataQuery { custom_workplace_id?: string } -export interface SearchWorkplaceWorkplaceBlockAccessDataQuery { +export interface SearchWorkplaceWorkplaceBlockAccessDataQuery extends Pagination { /** 数据检索开始时间，精确到日。格式yyyy-MM-dd。 */ from_date: string /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ diff --git a/package.json b/package.json index f63b5782..e0e0923b 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,8 @@ "test": "yakumo test -r esbuild-register", "test:text": "shx rm -rf coverage && c8 -r text yarn test", "test:json": "shx rm -rf coverage && c8 -r json yarn test", - "test:html": "shx rm -rf coverage && c8 -r html yarn test" + "test:html": "shx rm -rf coverage && c8 -r html yarn test", + "sync:lark": "node --import tsx adapters/lark/scripts/types.ts" }, "license": "MIT", "devDependencies": {