From fc6087495a08b61b0233383fe5371763679aed2e Mon Sep 17 00:00:00 2001 From: Shigma Date: Tue, 7 Jan 2025 00:21:07 +0800 Subject: [PATCH] refa(lark): add paginated typings --- adapters/lark/scripts/types.ts | 54 +- adapters/lark/src/internal.ts | 12 + adapters/lark/src/types/acs.ts | 34 +- adapters/lark/src/types/admin.ts | 87 +- adapters/lark/src/types/aily.ts | 87 +- adapters/lark/src/types/apaas.ts | 2 +- adapters/lark/src/types/application.ts | 105 +- adapters/lark/src/types/approval.ts | 66 +- adapters/lark/src/types/attendance.ts | 70 +- adapters/lark/src/types/baike.ts | 20 +- adapters/lark/src/types/bitable.ts | 73 +- adapters/lark/src/types/board.ts | 2 +- adapters/lark/src/types/calendar.ts | 92 +- adapters/lark/src/types/cardkit.ts | 2 +- adapters/lark/src/types/compensation.ts | 104 +- adapters/lark/src/types/contact.ts | 312 +----- adapters/lark/src/types/corehr.ts | 899 +++--------------- adapters/lark/src/types/document_ai.ts | 2 +- adapters/lark/src/types/docx.ts | 70 +- adapters/lark/src/types/drive.ts | 89 +- adapters/lark/src/types/ehr.ts | 18 +- adapters/lark/src/types/event.ts | 19 +- adapters/lark/src/types/helpdesk.ts | 30 +- adapters/lark/src/types/hire.ts | 863 +++-------------- adapters/lark/src/types/im.ts | 116 +-- adapters/lark/src/types/lingo.ts | 53 +- adapters/lark/src/types/mail.ts | 106 +-- adapters/lark/src/types/minutes.ts | 2 +- adapters/lark/src/types/moments.ts | 2 +- adapters/lark/src/types/okr.ts | 19 +- adapters/lark/src/types/passport.ts | 2 +- adapters/lark/src/types/payroll.ts | 59 +- adapters/lark/src/types/performance.ts | 127 +-- adapters/lark/src/types/personal_settings.ts | 19 +- adapters/lark/src/types/report.ts | 13 +- adapters/lark/src/types/search.ts | 53 +- .../lark/src/types/security_and_compliance.ts | 13 +- adapters/lark/src/types/sheets.ts | 2 +- adapters/lark/src/types/speech_to_text.ts | 2 +- adapters/lark/src/types/task.ts | 240 +---- adapters/lark/src/types/tenant.ts | 2 +- adapters/lark/src/types/translation.ts | 2 +- adapters/lark/src/types/vc.ts | 147 +-- adapters/lark/src/types/verification.ts | 2 +- adapters/lark/src/types/wiki.ts | 70 +- adapters/lark/src/types/workplace.ts | 53 +- package.json | 1 + 47 files changed, 597 insertions(+), 3620 deletions(-) diff --git a/adapters/lark/scripts/types.ts b/adapters/lark/scripts/types.ts index 32ed68a1..999460c9 100644 --- a/adapters/lark/scripts/types.ts +++ b/adapters/lark/scripts/types.ts @@ -162,7 +162,7 @@ function _formatType(schema: Schema, imports = new Set()) { if (schema.type === 'boolean') return 'boolean' if (schema.type === 'object') { if (!schema.properties) return 'unknown' - return `{\n${generateParams(schema.properties, imports)}\n}` + return `{\n${generateParams(schema.properties, imports)}}` } else if (schema.type === 'list') { return formatType(schema.items!, imports) + '[]' } @@ -170,10 +170,11 @@ function _formatType(schema: Schema, imports = new Set()) { } function generateParams(properties: Schema[], imports: Set): string { + if (!properties.length) return '' const getDesc = (v: Schema) => v.description ? ` /** ${v.description.replace(/\n/g, '').trim()} */\n` : '' return properties.map((schema: Schema) => { return `${getDesc(schema)} ${schema.name}${schema.required ? '' : '?'}: ${formatType(schema, imports)}` - }).join('\n') + }).join('\n') + '\n' } function getApiName(detail: ApiDetail) { @@ -194,6 +195,7 @@ interface Project { responses: string[] internals: string[] imports: Set + internalImports: Set defines: Record> } @@ -216,6 +218,7 @@ async function start() { responses: [], internals: [], imports: new Set(), + internalImports: new Set(['Internal']), defines: {}, } @@ -224,7 +227,6 @@ async function start() { const args: string[] = [] const extras: string[] = [] let returnType = `${apiType}Response` - // if (api.pagination) console.log(apiName, 'pagination') for (const property of detail.request.path?.properties || []) { args.push(`${property.name}: ${formatType(property, project.imports)}`) @@ -232,16 +234,23 @@ async function start() { if (detail.supportFileUpload && detail.request.body?.properties?.length) { const name = `${apiType}Form` args.push(`form: ${name}`) - project.requests.push(`export interface ${name} {\n${generateParams(detail.request.body!.properties, project.imports)}\n}`) + project.requests.push(`export interface ${name} {\n${generateParams(detail.request.body!.properties, project.imports)}}`) extras.push(`multipart: true`) } else if (detail.request.body?.properties?.length) { const name = `${apiType}Request` - project.requests.push(`export interface ${name} {\n${generateParams(detail.request.body.properties, project.imports)}\n}`) + project.requests.push(`export interface ${name} {\n${generateParams(detail.request.body.properties, project.imports)}}`) args.push(`body: ${name}`) } if (detail.request.query?.properties?.length) { const name = `${apiType}Query` - project.requests.push(`export interface ${name} {\n${generateParams(detail.request.query.properties, project.imports)}\n}`) + const keys = detail.request.query.properties.map(s => s.name) + 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') + project.requests.push(`export interface ${name} extends Pagination {\n${generateParams(properties, project.imports)}}`) + project.internalImports.add('Pagination') + } else { + project.requests.push(`export interface ${name} {\n${generateParams(detail.request.query.properties, project.imports)}}`) + } args.push(`query?: ${name}`) } @@ -252,7 +261,7 @@ async function start() { } else { const keys = (detail.response.body?.properties || []).map(v => v.name) if (!keys.includes('code') || !keys.includes('msg')) { - console.log(`unknown response body keys: ${keys}, see https://open.feishu.cn${summary.fullPath}}`) + console.log(`unsupported response body: ${keys}, see https://open.feishu.cn${summary.fullPath}}`) return } else if (keys.length === 2) { returnType = 'void' @@ -261,10 +270,33 @@ async function start() { if (!data.properties?.length) { returnType = 'void' } else { - project.responses.push(`export interface ${returnType} {\n${generateParams(data.properties, project.imports)}\n}`) + const keys = (data.properties || []).map(v => v.name) + let pagination: [string, Schema] | undefined + if (keys.includes('has_more') && keys.includes('page_token') && keys.length === 3) { + const list = (data.properties || []).find(v => v.name !== 'has_more' && v.name !== 'page_token')! + if (list.type === 'list') { + pagination = [list.name, list.items!] + } + } + if (pagination) { + const [key, item] = pagination + let inner = formatType(item, project.imports) + if (item.type === 'object' && item.properties && !item.ref) { + const name = `${apiType}Item` + project.responses.push(`export interface ${name} ${inner}`) + inner = name + } + returnType = key === 'items' ? `Paginated<${inner}>` : `Paginated<${inner}, '${key}'>` + project.internalImports.add('Paginated') + } 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)}}`) + } } } else { - project.responses.push(`export interface ${returnType} extends BaseResponse {\n${generateParams(detail.response.body.properties!, project.imports)}\n}`) + project.responses.push(`export interface ${returnType} extends BaseResponse {\n${generateParams(detail.response.body.properties!, project.imports)}}`) extras.push(`type: 'raw-json'`) } } @@ -292,9 +324,9 @@ async function start() { }).join('\n') return `'${path}': {\n${content}\n },` }).join('\n ') - const imports = [`import { Internal } from '../internal'`] + const imports = [`import { ${[...project.internalImports].sort().join(', ')} } from '../internal'`] if (project.imports.size) { - imports.push(`import { ${[...project.imports].sort().join(', ')} } from '.'`) + imports.unshift(`import { ${[...project.imports].sort().join(', ')} } from '.'`) } await writeFile(path, [ imports.join('\n'), diff --git a/adapters/lark/src/internal.ts b/adapters/lark/src/internal.ts index 366fd052..8861dadc 100644 --- a/adapters/lark/src/internal.ts +++ b/adapters/lark/src/internal.ts @@ -10,6 +10,18 @@ export interface BaseResponse { msg: string } +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 multipart?: boolean diff --git a/adapters/lark/src/types/acs.ts b/adapters/lark/src/types/acs.ts index 45060934..a9bb16f9 100644 --- a/adapters/lark/src/types/acs.ts +++ b/adapters/lark/src/types/acs.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { AccessRecord, Device, Feature, Rule, User, UserExternal } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -17,7 +17,7 @@ declare module '../internal' { * 获取用户列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list */ - listAcsUser(query?: ListAcsUserQuery): Promise + listAcsUser(query?: ListAcsUserQuery): Promise> /** * 上传人脸图片 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update @@ -67,7 +67,7 @@ declare module '../internal' { * 获取门禁记录列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list */ - listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Promise + listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Promise> /** * 下载开门时的人脸识别图片 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get @@ -91,11 +91,7 @@ export interface GetAcsUserQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListAcsUserQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListAcsUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -167,11 +163,7 @@ export interface CreateAcsVisitorQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListAcsAccessRecordQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListAcsAccessRecordQuery extends Pagination { /** 记录开始时间，单位秒 */ from: number /** 记录结束时间，单位秒，时间跨度不能超过30天 */ @@ -187,14 +179,6 @@ export interface GetAcsUserResponse { user?: User } -export interface ListAcsUserResponse { - items?: User[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface GetAcsRuleExternalResponse { /** 设备权限组信息 */ rules: Rule[] @@ -214,14 +198,6 @@ export interface ListAcsDeviceResponse { items?: Device[] } -export interface ListAcsAccessRecordResponse { - items?: AccessRecord[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - Internal.define({ '/open-apis/acs/v1/users/{user_id}': { PATCH: 'patchAcsUser', diff --git a/adapters/lark/src/types/admin.ts b/adapters/lark/src/types/admin.ts index c0bd7898..f20e31f0 100644 --- a/adapters/lark/src/types/admin.ts +++ b/adapters/lark/src/types/admin.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { AdminDeptStat, AdminUserStat, AuditInfo, Badge, Grant, I18n, Password, RuleDetail } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -12,12 +12,12 @@ declare module '../internal' { * 获取部门维度的用户活跃和功能使用数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list */ - listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery): Promise + listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery): Promise> /** * 获取用户维度的用户活跃和功能使用数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list */ - listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery): Promise + listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery): Promise> /** * 创建勋章 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create @@ -37,7 +37,7 @@ declare module '../internal' { * 获取勋章列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list */ - listAdminBadge(query?: ListAdminBadgeQuery): Promise + listAdminBadge(query?: ListAdminBadgeQuery): Promise> /** * 获取勋章详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get @@ -62,7 +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): Promise + listAdminBadgeGrant(badge_id: string, query?: ListAdminBadgeGrantQuery): Promise> /** * 获取授予名单详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get @@ -72,7 +72,7 @@ declare module '../internal' { * 获取行为审计日志数据 * @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get */ - listAdminAuditInfo(query?: ListAdminAuditInfoQuery): Promise + listAdminAuditInfo(query?: ListAdminAuditInfoQuery): Promise> } } @@ -88,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 */ @@ -99,17 +99,13 @@ export interface ListAdminAdminDeptStatQuery { department_id: string /** 是否包含子部门，如果该值为false，则只查出本部门直属用户活跃和功能使用数据；如果该值为true，则查出该部门以及其子部门（子部门层级最多不超过根部门下的前4级）的用户活跃和功能使用数据 */ contains_child_dept: boolean - /** 分页大小，默认是10 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ - page_token?: string /** 跨域访问的geo */ target_geo?: string /** 是否返回分产品版本数据 */ with_product_version?: boolean } -export interface ListAdminAdminUserStatQuery { +export interface ListAdminAdminUserStatQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 部门ID类型 */ @@ -122,10 +118,6 @@ export interface ListAdminAdminUserStatQuery { department_id?: string /** 用户的open_id，user_id或者union_id，取决于user_id_type */ user_id?: string - /** 分页大小，默认是10 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ - page_token?: string /** 跨域访问的geo */ target_geo?: string } @@ -167,11 +159,7 @@ export interface CreateAdminBadgeImageForm { image_type: 1 | 2 } -export interface ListAdminBadgeQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListAdminBadgeQuery extends Pagination { /** 租户内唯一的勋章名称，精确匹配。 */ name?: string } @@ -228,11 +216,7 @@ export interface UpdateAdminBadgeGrantQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListAdminBadgeGrantQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListAdminBadgeGrantQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' /** 此次调用中使用的部门ID的类型。 */ @@ -248,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' /** 日志时间范围: 结束时间. 格式: 秒级时间戳. 默认值: 此刻 */ @@ -263,10 +247,6 @@ export interface ListAdminAuditInfoQuery { operator_value?: string /** 过滤模块 */ event_module?: number - /** 下一页分页的token */ - page_token?: string - /** 分页参数 */ - page_size?: number /** 过滤用户类型. 仅当 operator_type=user 时生效 */ user_type?: 0 | 1 | 2 /** 过滤操作对象: 操作对象类型. 与object_value配合使用 */ @@ -277,24 +257,6 @@ export interface ListAdminAuditInfoQuery { ext_filter_object_by_ccm_token?: string } -export interface ListAdminAdminDeptStatResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 部门统计值 */ - items?: AdminDeptStat[] -} - -export interface ListAdminAdminUserStatResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 数据报表 */ - items?: AdminUserStat[] -} - export interface CreateAdminBadgeResponse { /** 勋章的信息 */ badge?: Badge @@ -310,15 +272,6 @@ export interface CreateAdminBadgeImageResponse { image_key?: string } -export interface ListAdminBadgeResponse { - /** 勋章列表 */ - badges?: Badge[] - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否已经遍历完，表示本次页面请求已经拿到所有列表数据 */ - has_more?: boolean -} - export interface GetAdminBadgeResponse { /** 勋章信息 */ badge?: Badge @@ -334,29 +287,11 @@ export interface UpdateAdminBadgeGrantResponse { grant?: Grant } -export interface ListAdminBadgeGrantResponse { - /** 授予名单列表 */ - grants?: Grant[] - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否已经遍历完，表示本次页面请求已经拿到所有列表数据 */ - has_more?: boolean -} - export interface GetAdminBadgeGrantResponse { /** 授予名单信息 */ grant?: Grant } -export interface ListAdminAuditInfoResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 返回的具体数据内容 */ - items?: AuditInfo[] -} - Internal.define({ '/open-apis/admin/v1/password/reset': { POST: 'resetAdminPassword', diff --git a/adapters/lark/src/types/aily.ts b/adapters/lark/src/types/aily.ts index ebe16dee..ef236717 100644 --- a/adapters/lark/src/types/aily.ts +++ b/adapters/lark/src/types/aily.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { AilyKnowledgeAskProcessData, AilyKnowledgeFaq, AilyKnowledgeMessage, AilyMention, AilyMessage, AilyMessageContentType, AilySession, DataAsset, DataAssetTag, Run, Skill, SkillGlobalVariable } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,7 +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): Promise + listAilyAilySessionAilyMessage(aily_session_id: string, query?: ListAilyAilySessionAilyMessageQuery): Promise> /** * 创建运行 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create @@ -52,7 +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?: ListAilyAilySessionRunQuery): Promise + listAilyAilySessionRun(aily_session_id: string, query?: ListAilyAilySessionRunQuery): Promise> /** * 取消运行 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel @@ -72,7 +72,7 @@ declare module '../internal' { * 查询技能列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/list */ - listAilyAppSkill(app_id: string, query?: ListAilyAppSkillQuery): Promise + listAilyAppSkill(app_id: string, query?: ListAilyAppSkillQuery): Promise> /** * 执行数据知识问答 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-knowledge/ask @@ -82,12 +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): Promise + listAilyAppDataAsset(app_id: string, query?: ListAilyAppDataAssetQuery): Promise> /** * 获取数据知识分类列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset_tag/list */ - listAilyAppDataAssetTag(app_id: string, query?: ListAilyAppDataAssetTagQuery): Promise + listAilyAppDataAssetTag(app_id: string, query?: ListAilyAppDataAssetTagQuery): Promise> } } @@ -120,11 +120,7 @@ export interface CreateAilyAilySessionAilyMessageRequest { mentions?: AilyMention[] } -export interface ListAilyAilySessionAilyMessageQuery { - /** 页面大小 */ - page_size?: number - /** 分页偏移量 */ - page_token?: string +export interface ListAilyAilySessionAilyMessageQuery extends Pagination { /** 运行 ID */ run_id?: string /** 返回生成中的消息 */ @@ -142,11 +138,7 @@ export interface CreateAilyAilySessionRunRequest { metadata?: string } -export interface ListAilyAilySessionRunQuery { - /** 页面大小 */ - page_size?: number - /** 分页偏移量 */ - page_token?: string +export interface ListAilyAilySessionRunQuery extends Pagination { } export interface StartAilyAppSkillRequest { @@ -156,11 +148,7 @@ export interface StartAilyAppSkillRequest { input?: string } -export interface ListAilyAppSkillQuery { - /** 页面大小 */ - page_size?: number - /** 分页偏移量 */ - page_token?: string +export interface ListAilyAppSkillQuery extends Pagination { } export interface AskAilyAppKnowledgeRequest { @@ -172,11 +160,7 @@ export interface AskAilyAppKnowledgeRequest { data_asset_tag_ids?: string[] } -export interface ListAilyAppDataAssetQuery { - /** 分页参数：分页大小，默认：20，最大：100 */ - page_size?: number - /** 分页参数：分页起始位置，为空表示首页 */ - page_token?: string +export interface ListAilyAppDataAssetQuery extends Pagination { /** 模糊匹配关键词 */ keyword?: string /** 根据数据知识 ID 进行过滤 */ @@ -189,11 +173,7 @@ export interface ListAilyAppDataAssetQuery { with_connect_status?: boolean } -export interface ListAilyAppDataAssetTagQuery { - /** 分页参数：分页大小，默认：20，最大：100 */ - page_size?: number - /** 分页参数：分页起始位置，为空表示首页 */ - page_token?: string +export interface ListAilyAppDataAssetTagQuery extends Pagination { /** 模糊匹配分类名称 */ keyword?: string /** 模糊匹配分类名称 */ @@ -225,15 +205,6 @@ export interface GetAilyAilySessionAilyMessageResponse { message?: AilyMessage } -export interface ListAilyAilySessionAilyMessageResponse { - /** 消息列表 */ - messages?: AilyMessage[] - /** 下一页的起始偏移量 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - export interface CreateAilyAilySessionRunResponse { /** 运行信息 */ run?: Run @@ -244,15 +215,6 @@ export interface GetAilyAilySessionRunResponse { run?: Run } -export interface ListAilyAilySessionRunResponse { - /** 运行列表 */ - runs?: Run[] - /** 下一页的起始偏移量 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - export interface CancelAilyAilySessionRunResponse { /** 运行信息 */ run?: Run @@ -270,15 +232,6 @@ export interface GetAilyAppSkillResponse { skill?: Skill } -export interface ListAilyAppSkillResponse { - /** 技能列表 */ - skills?: Skill[] - /** 下一页的起始偏移量 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - export interface AskAilyAppKnowledgeResponse { /** 响应状态，枚举值 */ status?: 'processing' | 'finished' @@ -294,24 +247,6 @@ export interface AskAilyAppKnowledgeResponse { has_answer?: boolean } -export interface ListAilyAppDataAssetResponse { - /** 数据知识列表 */ - items?: DataAsset[] - /** has_more=true，可使用page_token继续查询 */ - page_token?: string - /** 是否有更多 */ - has_more?: boolean -} - -export interface ListAilyAppDataAssetTagResponse { - /** 数据知识分类列表 */ - items?: DataAssetTag[] - /** has_more=true，可使用 page_token继续查询 */ - page_token?: string - /** 是否有更多 */ - has_more?: boolean -} - Internal.define({ '/open-apis/aily/v1/sessions': { POST: 'createAilyAilySession', diff --git a/adapters/lark/src/types/apaas.ts b/adapters/lark/src/types/apaas.ts index 098283ff..e3a5f5c7 100644 --- a/adapters/lark/src/types/apaas.ts +++ b/adapters/lark/src/types/apaas.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { AllowedRollbaclkTaskItemType, AuditLogDetail, AuditLogEsField, Criterion, EnvironmentVariable, EnvironmentVariableFilter, ObjectMeta, RecordGroupByItem, RecordResult, RoleMember, SearchObjectParam, Sort, UserTask } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/application.ts b/adapters/lark/src/types/application.ts index c58ec0c8..a6549b3d 100644 --- a/adapters/lark/src/types/application.ts +++ b/adapters/lark/src/types/application.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { AppContactsRangeIdList, AppRecommendRule, AppVisibilityIdList, Application, ApplicationAppContactsRange, ApplicationAppUsage, ApplicationAppVersion, ApplicationDepartmentAppUsage, ApplicationFeedback, ApplicationVisibilityDepartmentWhiteBlackInfo, ApplicationVisibilityGroupWhiteBlackInfo, ApplicationVisibilityUserWhiteBlackInfo, ClientBadgeNum, Scope } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -17,7 +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): Promise + listApplicationApplicationAppVersion(app_id: string, query?: ListApplicationApplicationAppVersionQuery): Promise> /** * 获取应用版本中开发者申请的通讯录权限范围 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/contacts_range_suggest @@ -42,7 +42,7 @@ declare module '../internal' { * 查看待审核的应用列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist */ - underauditlistApplication(query?: UnderauditlistApplicationQuery): Promise + underauditlistApplication(query?: UnderauditlistApplicationQuery): Promise> /** * 更新应用审核状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/patch @@ -82,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): Promise> /** * 获取消息推送概览 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/message_push_overview @@ -102,7 +102,7 @@ declare module '../internal' { * 获取应用反馈列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/list */ - listApplicationApplicationFeedback(app_id: string, query?: ListApplicationApplicationFeedbackQuery): Promise + listApplicationApplicationFeedback(app_id: string, query?: ListApplicationApplicationFeedbackQuery): Promise> /** * 更新应用红点 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_badge/set @@ -122,7 +122,7 @@ declare module '../internal' { * 获取当前设置的推荐规则列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list */ - listApplicationAppRecommendRule(query?: ListApplicationAppRecommendRuleQuery): Promise + listApplicationAppRecommendRule(query?: ListApplicationAppRecommendRuleQuery): Promise> } } @@ -140,13 +140,9 @@ 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' - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string /** 0：按照时间倒序 1：按照时间正序 */ order?: number /** 此次调用中使用的用户ID的类型 */ @@ -160,11 +156,7 @@ export interface ContactsRangeSuggestApplicationApplicationAppVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListApplicationQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListApplicationQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: string /** 应用的图标、描述、帮助文档链接是按照应用的主语言返回；其他内容（如应用权限、应用分类）按照该参数设定返回对应的语言。可选值有： zh_cn：中文 en_us：英文 ja_jp：日文 如不填写，则按照应用的主语言返回 */ @@ -177,13 +169,9 @@ export interface ListApplicationQuery { owner_type?: 0 | 1 | 2 } -export interface UnderauditlistApplicationQuery { +export interface UnderauditlistApplicationQuery extends Pagination { /** 指定返回的语言 */ lang: 'zh_cn' | 'en_us' | 'ja_jp' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -212,11 +200,7 @@ export interface PatchApplicationQuery { lang: 'zh_cn' | 'en_us' | 'ja_jp' } -export interface ContactsRangeConfigurationApplicationQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ContactsRangeConfigurationApplicationQuery extends Pagination { /** 返回值的部门ID的类型 */ department_id_type?: 'department_id' | 'open_department_id' /** 此次调用中使用的用户ID的类型 */ @@ -338,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 天内的数据。 */ @@ -348,10 +332,6 @@ export interface ListApplicationApplicationFeedbackQuery { /** 反馈处理状态，不填写则表示查询所有处理类型。 */ status?: 0 | 1 | 2 | 3 user_id_type?: 'open_id' | 'union_id' | 'user_id' - /** 分页拉取反馈列表起始位置标示，不填表示从头开始 */ - page_token?: string - /** 本次拉取反馈列表最大个数 */ - page_size?: number } export interface SetApplicationAppBadgeRequest { @@ -372,31 +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' - /** 分页标记,不填表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 单页需求最大个数（最大 100），不传默认10个 */ - page_size?: number } -export interface RecommendApplicationQuery { +export interface RecommendApplicationQuery extends Pagination { /** 应用信息的语言版本 */ language?: 'zh_cn' | 'en_us' | 'ja_jp' /** 推荐应用类型，默认为用户不可移除的推荐应用列表 */ recommend_type?: 'user_unremovable' | 'user_removable' - /** 分页标记,不填表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 单页需求最大个数（最大 100），不传默认10个 */ - page_size?: number } -export interface ListApplicationAppRecommendRuleQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListApplicationAppRecommendRuleQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -410,15 +378,6 @@ export interface GetApplicationApplicationAppVersionResponse { app_version?: ApplicationAppVersion } -export interface ListApplicationApplicationAppVersionResponse { - /** 应用版本列表 */ - items?: ApplicationAppVersion[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface ContactsRangeSuggestApplicationApplicationAppVersionResponse { contacts_range?: ApplicationAppContactsRange } @@ -438,15 +397,6 @@ export interface ListApplicationResponse { total_count?: number } -export interface UnderauditlistApplicationResponse { - /** 待审核应用列表 */ - items: Application[] - /** 是否有下一页数据 */ - has_more: boolean - /** 下一页分页的token */ - page_token?: string -} - export interface ContactsRangeConfigurationApplicationResponse { contacts_range?: ApplicationAppContactsRange /** 是否还有更多项 */ @@ -464,15 +414,6 @@ export interface CheckWhiteBlackListApplicationApplicationVisibilityResponse { group_visibility_list?: ApplicationVisibilityGroupWhiteBlackInfo[] } -export interface DepartmentOverviewApplicationApplicationAppUsageResponse { - /** 分页查询时返回，代表是否还有更多数据 */ - has_more?: boolean - /** 分页标记，下一页分页的token */ - page_token?: string - /** 部门内员工使用应用的概览数据 */ - items?: ApplicationDepartmentAppUsage[] -} - export interface MessagePushOverviewApplicationApplicationAppUsageResponse { /** 消息推送情况 */ items?: ApplicationAppUsage[] @@ -483,15 +424,6 @@ export interface OverviewApplicationApplicationAppUsageResponse { items?: ApplicationAppUsage[] } -export interface ListApplicationApplicationFeedbackResponse { - /** 应用的反馈列表 */ - feedback_list?: ApplicationFeedback[] - /** 是否还有更多用户反馈列表，true：是，false：否 */ - has_more: boolean - /** 拉取下一页应用反馈列表时使用的 page_token */ - page_token?: string -} - export interface FavouriteApplicationResponse { /** 分页的token */ page_token?: string @@ -516,15 +448,6 @@ export interface RecommendApplicationResponse { app_list?: Application[] } -export interface ListApplicationAppRecommendRuleResponse { - /** 推荐规则列表 */ - rules?: AppRecommendRule[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - Internal.define({ '/open-apis/application/v6/applications/{app_id}': { GET: 'getApplication', diff --git a/adapters/lark/src/types/approval.ts b/adapters/lark/src/types/approval.ts index 96c267a5..7662d705 100644 --- a/adapters/lark/src/types/approval.ts +++ b/adapters/lark/src/types/approval.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -42,7 +42,7 @@ declare module '../internal' { * 批量获取审批实例 ID * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list */ - listApprovalInstance(query?: ListApprovalInstanceQuery): Promise + listApprovalInstance(query?: ListApprovalInstanceQuery): Promise> /** * 同意审批任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve @@ -117,7 +117,7 @@ declare module '../internal' { * 获取三方审批任务状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list */ - listApprovalExternalTask(body: ListApprovalExternalTaskRequest, query?: ListApprovalExternalTaskQuery): Promise + listApprovalExternalTask(body: ListApprovalExternalTaskRequest, query?: ListApprovalExternalTaskQuery): Promise> /** * 查询实例列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query @@ -294,11 +294,7 @@ export interface GetApprovalInstanceQuery { user_id_type?: 'user_id' | 'open_id' | 'union_id' } -export interface ListApprovalInstanceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListApprovalInstanceQuery extends Pagination { /** 审批定义唯一标识 */ approval_code: string /** 审批实例创建时间区间（毫秒） */ @@ -460,15 +456,11 @@ 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 */ user_id: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface CreateApprovalExternalApprovalRequest { @@ -573,11 +565,7 @@ export interface ListApprovalExternalTaskRequest { status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE' } -export interface ListApprovalExternalTaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListApprovalExternalTaskQuery extends Pagination { } export interface QueryApprovalInstanceRequest { @@ -603,11 +591,7 @@ export interface QueryApprovalInstanceRequest { locale?: 'zh-CN' | 'en-US' | 'ja-JP' } -export interface QueryApprovalInstanceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryApprovalInstanceQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -635,11 +619,7 @@ export interface SearchCcApprovalInstanceRequest { locale?: 'zh-CN' | 'en-US' | 'ja-JP' } -export interface SearchCcApprovalInstanceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCcApprovalInstanceQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -671,20 +651,12 @@ export interface SearchApprovalTaskRequest { order?: 0 | 1 | 2 | 3 } -export interface SearchApprovalTaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchApprovalTaskQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface QueryApprovalTaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryApprovalTaskQuery extends Pagination { /** 需要查询的 User ID */ user_id: string /** 需要查询的任务分组主题，如「待办」、「已办」等 */ @@ -766,15 +738,6 @@ export interface GetApprovalInstanceResponse { instance_code: string } -export interface ListApprovalInstanceResponse { - /** 审批实例 Code */ - instance_code_list: string[] - /** 翻页 Token */ - page_token: string - /** 是否有更多任务可供拉取 */ - has_more: boolean -} - export interface CreateApprovalInstanceCommentResponse { /** 保存成功的comment_id */ comment_id: string @@ -833,15 +796,6 @@ export interface CheckApprovalExternalInstanceResponse { diff_instances?: ExteranlInstanceCheckResponse[] } -export interface ListApprovalExternalTaskResponse { - /** 任务列表 */ - data?: ExternalTaskList[] - /** 翻页 Token */ - page_token?: string - /** 是否有更多任务可供拉取 */ - has_more?: boolean -} - export interface QueryApprovalInstanceResponse { /** 查询返回条数 */ count?: number diff --git a/adapters/lark/src/types/attendance.ts b/adapters/lark/src/types/attendance.ts index e21c32f2..affbceaa 100644 --- a/adapters/lark/src/types/attendance.ts +++ b/adapters/lark/src/types/attendance.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -27,7 +27,7 @@ declare module '../internal' { * 查询所有班次 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/list */ - listAttendanceShift(query?: ListAttendanceShiftQuery): Promise + listAttendanceShift(query?: ListAttendanceShiftQuery): Promise> /** * 创建或修改排班表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/batch_create @@ -47,7 +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): Promise + listUserAttendanceGroup(group_id: string, query?: ListUserAttendanceGroupQuery): Promise> /** * 创建或修改考勤组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/create @@ -72,7 +72,7 @@ declare module '../internal' { * 查询所有考勤组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list */ - listAttendanceGroup(query?: ListAttendanceGroupQuery): Promise + listAttendanceGroup(query?: ListAttendanceGroupQuery): Promise> /** * 修改用户人脸识别信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/modify @@ -162,7 +162,7 @@ declare module '../internal' { * 查询所有归档规则 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/list */ - listAttendanceArchiveRule(query?: ListAttendanceArchiveRuleQuery): Promise + listAttendanceArchiveRule(query?: ListAttendanceArchiveRuleQuery): Promise> /** * 导入打卡流水 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/batch_create @@ -247,11 +247,7 @@ export interface QueryAttendanceShiftQuery { shift_name: string } -export interface ListAttendanceShiftQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListAttendanceShiftQuery extends Pagination { } export interface BatchCreateAttendanceUserDailyShiftRequest { @@ -292,15 +288,11 @@ export interface BatchCreateTempAttendanceUserDailyShiftQuery { employee_type: 'employee_id' | 'employee_no' } -export interface ListUserAttendanceGroupQuery { +export interface ListUserAttendanceGroupQuery extends Pagination { /** 用户 ID 的类型 */ employee_type: string /** 部门 ID 的类型 */ dept_type: string - /** 分页大小 */ - page_size?: number - /** 第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string /** 打卡类型 */ member_clock_type: number } @@ -331,11 +323,7 @@ export interface SearchAttendanceGroupRequest { group_name: string } -export interface ListAttendanceGroupQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListAttendanceGroupQuery extends Pagination { } export interface ModifyAttendanceUserSettingRequest { @@ -573,11 +561,7 @@ export interface DelReportAttendanceArchiveRuleQuery { employee_type: string } -export interface ListAttendanceArchiveRuleQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListAttendanceArchiveRuleQuery extends Pagination { } export interface BatchCreateAttendanceUserFlowRequest { @@ -764,15 +748,6 @@ export interface QueryAttendanceShiftResponse { rest_time_flexible_configs?: RestTimeFlexibleConfig[] } -export interface ListAttendanceShiftResponse { - /** 班次列表 */ - shift_list?: Shift[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface BatchCreateAttendanceUserDailyShiftResponse { /** 班表信息列表 */ user_daily_shifts?: UserDailyShift[] @@ -788,15 +763,6 @@ export interface BatchCreateTempAttendanceUserDailyShiftResponse { user_tmp_daily_shifts?: UserTmpDailyShift[] } -export interface ListUserAttendanceGroupResponse { - /** 考勤组成员列表 */ - users?: UserBase[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface CreateAttendanceGroupResponse { group?: Group } @@ -946,15 +912,6 @@ export interface SearchAttendanceGroupResponse { group_list?: GroupMeta[] } -export interface ListAttendanceGroupResponse { - /** 考勤组列表 */ - group_list?: GroupMeta[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface ModifyAttendanceUserSettingResponse { /** 用户设置 */ user_setting?: UserSetting @@ -1031,15 +988,6 @@ export interface UploadReportAttendanceArchiveRuleResponse { invalid_member_id?: string[] } -export interface ListAttendanceArchiveRuleResponse { - /** 分页查询结果项 */ - items?: ArchiveReportMeta[] - /** 分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否有更多项 */ - has_more?: boolean -} - export interface BatchCreateAttendanceUserFlowResponse { /** 打卡流水记录列表 */ flow_records?: UserFlow[] diff --git a/adapters/lark/src/types/baike.ts b/adapters/lark/src/types/baike.ts index eed4a366..c38e5d5d 100644 --- a/adapters/lark/src/types/baike.ts +++ b/adapters/lark/src/types/baike.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Classification, ClassificationFilter, Draft, Entity, EntityWord, MatchInfo, OuterInfo, Phrase, RelatedMeta, Term } from '.' +import { Internal, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -162,11 +162,7 @@ export interface GetBaikeEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListBaikeEntityQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListBaikeEntityQuery extends Pagination { /** 相关外部系统【可用来过滤词条数据】 */ provider?: string /** 此次调用中使用的用户ID的类型 */ @@ -189,11 +185,7 @@ export interface SearchBaikeEntityRequest { creators?: string[] } -export interface SearchBaikeEntityQuery { - /** 每页返回的词条量 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchBaikeEntityQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -208,11 +200,7 @@ export interface ExtractBaikeEntityRequest { text?: string } -export interface ListBaikeClassificationQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListBaikeClassificationQuery extends Pagination { } export interface UploadBaikeFileForm { diff --git a/adapters/lark/src/types/bitable.ts b/adapters/lark/src/types/bitable.ts index 75c94d62..e306b6e9 100644 --- a/adapters/lark/src/types/bitable.ts +++ b/adapters/lark/src/types/bitable.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -147,7 +147,7 @@ declare module '../internal' { * 列出仪表盘 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list */ - listBitableAppDashboard(app_token: string, query?: ListBitableAppDashboardQuery): Promise + listBitableAppDashboard(app_token: string, query?: ListBitableAppDashboardQuery): Promise> /** * 更新表单元数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch @@ -283,11 +283,7 @@ export interface PatchBitableAppTableRequest { name?: string } -export interface ListBitableAppTableQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface ListBitableAppTableQuery extends Pagination { } export interface BatchDeleteBitableAppTableRequest { @@ -309,11 +305,7 @@ export interface PatchBitableAppTableViewRequest { property?: AppTableViewProperty } -export interface ListBitableAppTableViewQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListBitableAppTableViewQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -357,13 +349,9 @@ export interface SearchBitableAppTableRecordRequest { automatic_fields?: boolean } -export interface SearchBitableAppTableRecordQuery { +export interface SearchBitableAppTableRecordQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface BatchCreateBitableAppTableRecordRequest { @@ -439,15 +427,11 @@ 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 表示以数组富文本形式返回 */ text_field_as_array?: boolean - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface CopyBitableAppDashboardRequest { @@ -455,11 +439,7 @@ export interface CopyBitableAppDashboardRequest { name: string } -export interface ListBitableAppDashboardQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListBitableAppDashboardQuery extends Pagination { } export interface PatchBitableAppTableFormRequest { @@ -488,18 +468,10 @@ export interface PatchBitableAppTableFormFieldRequest { visible?: boolean } -export interface ListBitableAppTableFormFieldQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListBitableAppTableFormFieldQuery extends Pagination { } -export interface ListBitableAppRoleQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListBitableAppRoleQuery extends Pagination { } export interface CreateBitableAppRoleRequest { @@ -530,11 +502,7 @@ export interface BatchCreateBitableAppRoleMemberRequest { member_list: AppRoleMemberId[] } -export interface ListBitableAppRoleMemberQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListBitableAppRoleMemberQuery extends Pagination { } export interface CreateBitableAppRoleMemberRequest { @@ -552,11 +520,7 @@ export interface DeleteBitableAppRoleMemberQuery { member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id' } -export interface ListBitableAppWorkflowQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface ListBitableAppWorkflowQuery extends Pagination { } export interface UpdateBitableAppWorkflowRequest { @@ -577,7 +541,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) */ @@ -594,10 +558,6 @@ export interface ListBitableAppTableRecordQuery { display_formula_ref?: boolean /** 控制是否返回自动计算的字段，例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`，true 表示返回 */ automatic_fields?: boolean - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface CreateBitableAppResponse { @@ -750,15 +710,6 @@ export interface CopyBitableAppDashboardResponse { name?: string } -export interface ListBitableAppDashboardResponse { - /** 仪表盘信息 */ - dashboards: AppDashboard[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token: string - /** 是否还有更多项 */ - has_more: boolean -} - export interface PatchBitableAppTableFormResponse { /** 表单元数据信息 */ form: AppTableForm diff --git a/adapters/lark/src/types/board.ts b/adapters/lark/src/types/board.ts index 03c76cc1..3bad34b5 100644 --- a/adapters/lark/src/types/board.ts +++ b/adapters/lark/src/types/board.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { WhiteboardNode } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/calendar.ts b/adapters/lark/src/types/calendar.ts index a54a4ed5..55d16721 100644 --- a/adapters/lark/src/types/calendar.ts +++ b/adapters/lark/src/types/calendar.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { AclScope, Attachment, Calendar, CalendarAcl, CalendarEvent, CalendarEventAttendee, CalendarEventAttendeeChatMember, CalendarEventAttendeeId, EventLocation, EventSearchFilter, Freebusy, Instance, Reminder, Schema, TimeInfo, UserCalendar, Vchat } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -77,7 +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): Promise + listCalendarCalendarAcl(calendar_id: string, query?: ListCalendarCalendarAclQuery): Promise> /** * 订阅日历访问控制变更事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/subscription @@ -137,7 +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): Promise + instancesCalendarCalendarEvent(calendar_id: string, event_id: string, query?: InstancesCalendarCalendarEventQuery): Promise> /** * 查询日程视图 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instance_view @@ -182,12 +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): Promise + listCalendarCalendarEventAttendee(calendar_id: string, event_id: string, query?: ListCalendarCalendarEventAttendeeQuery): Promise> /** * 获取日程参与群成员列表 * @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): Promise + listCalendarCalendarEventAttendeeChatMember(calendar_id: string, event_id: string, attendee_id: string, query?: ListCalendarCalendarEventAttendeeChatMemberQuery): Promise> /** * 生成 CalDAV 配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/setting/generate_caldav_conf @@ -249,11 +249,7 @@ export interface ListCalendarFreebusyQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListCalendarQuery { - /** 一次请求要求返回最大数量，默认500，取值范围为[50. 1000] */ - page_size?: number - /** 上次请求Response返回的分页标记，首次请求时为空 */ - page_token?: string +export interface ListCalendarQuery extends Pagination { /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ sync_token?: string } @@ -276,11 +272,7 @@ export interface SearchCalendarRequest { query: string } -export interface SearchCalendarQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface SearchCalendarQuery extends Pagination { } export interface CreateCalendarCalendarAclRequest { @@ -295,13 +287,9 @@ 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' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface CreateCalendarCalendarEventRequest { @@ -398,13 +386,9 @@ export interface GetCalendarCalendarEventQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListCalendarCalendarEventQuery { - /** 一次请求要求返回最大数量，默认500，取值范围为[50, 1000] */ - page_size?: number +export interface ListCalendarCalendarEventQuery extends Pagination { /** 拉取anchor_time之后的日程，为timestamp */ anchor_time?: string - /** 上次请求Response返回的分页标记，首次请求时为空 */ - page_token?: string /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ sync_token?: string /** 日程开始Unix时间戳，单位为秒 */ @@ -422,13 +406,9 @@ export interface SearchCalendarCalendarEventRequest { filter?: EventSearchFilter } -export interface SearchCalendarCalendarEventQuery { +export interface SearchCalendarCalendarEventQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface ReplyCalendarCalendarEventRequest { @@ -436,15 +416,11 @@ 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上限（不包含） */ end_time: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface InstanceViewCalendarCalendarEventQuery { @@ -517,22 +493,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 - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } -export interface ListCalendarCalendarEventAttendeeChatMemberQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface ListCalendarCalendarEventAttendeeChatMemberQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -636,15 +604,6 @@ export interface CreateCalendarCalendarAclResponse { scope: AclScope } -export interface ListCalendarCalendarAclResponse { - /** 入参日历对应的acl列表 */ - acls?: CalendarAcl[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下次请求需要带上的分页标记，90 天有效期 */ - page_token?: string -} - export interface CreateCalendarCalendarEventResponse { /** 日程信息 */ event?: CalendarEvent @@ -678,13 +637,6 @@ export interface SearchCalendarCalendarEventResponse { page_token?: string } -export interface InstancesCalendarCalendarEventResponse { - /** instances实例 */ - items?: Instance[] - page_token?: string - has_more?: boolean -} - export interface InstanceViewCalendarCalendarEventResponse { /** 日程instance列表 */ items?: Instance[] @@ -724,24 +676,6 @@ export interface CreateCalendarCalendarEventAttendeeResponse { attendees?: CalendarEventAttendee[] } -export interface ListCalendarCalendarEventAttendeeResponse { - /** 日程的参与者列表 */ - items?: CalendarEventAttendee[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下次请求需要带上的分页标记，90 天有效期 */ - page_token?: string -} - -export interface ListCalendarCalendarEventAttendeeChatMemberResponse { - /** chat类型的参与人的群成员列表 */ - items?: CalendarEventAttendeeChatMember[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下次请求需要带上的分页标记 */ - page_token?: string -} - export interface GenerateCaldavConfCalendarSettingResponse { /** caldav密码 */ password?: string diff --git a/adapters/lark/src/types/cardkit.ts b/adapters/lark/src/types/cardkit.ts index 5a15a401..9138477f 100644 --- a/adapters/lark/src/types/cardkit.ts +++ b/adapters/lark/src/types/cardkit.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Card } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/compensation.ts b/adapters/lark/src/types/compensation.ts index c79ebbf6..474784db 100644 --- a/adapters/lark/src/types/compensation.ts +++ b/adapters/lark/src/types/compensation.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { ArchiveDetail, ChangeReason, Indicator, Item, ItemCategory, PlanDetail } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,32 +7,32 @@ declare module '../internal' { * 批量查询员工薪资档案 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query */ - queryCompensationArchive(body: QueryCompensationArchiveRequest, query?: QueryCompensationArchiveQuery): Promise + queryCompensationArchive(body: QueryCompensationArchiveRequest, query?: QueryCompensationArchiveQuery): Promise> /** * 批量查询薪资项 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list */ - listCompensationItem(query?: ListCompensationItemQuery): Promise + listCompensationItem(query?: ListCompensationItemQuery): Promise> /** * 批量查询薪资统计指标 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list */ - listCompensationIndicator(query?: ListCompensationIndicatorQuery): Promise + listCompensationIndicator(query?: ListCompensationIndicatorQuery): Promise> /** * 批量获取薪资项分类信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item_category/list */ - listCompensationItemCategory(query?: ListCompensationItemCategoryQuery): Promise + listCompensationItemCategory(query?: ListCompensationItemCategoryQuery): Promise> /** * 批量查询薪资方案 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list */ - listCompensationPlan(query?: ListCompensationPlanQuery): Promise + listCompensationPlan(query?: ListCompensationPlanQuery): Promise> /** * 批量查询定调薪原因 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list */ - listCompensationChangeReason(query?: ListCompensationChangeReasonQuery): Promise + listCompensationChangeReason(query?: ListCompensationChangeReasonQuery): Promise> } } @@ -47,104 +47,26 @@ export interface QueryCompensationArchiveRequest { effective_end_date?: string } -export interface QueryCompensationArchiveQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryCompensationArchiveQuery extends Pagination { /** 用户ID类型 */ user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface ListCompensationItemQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListCompensationItemQuery extends Pagination { /** 薪酬项类型（不传则认为查询所有类型薪酬项） */ item_type?: 'salary' | 'bonus' | 'recurring_payment' } -export interface ListCompensationIndicatorQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListCompensationIndicatorQuery extends Pagination { } -export interface ListCompensationItemCategoryQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListCompensationItemCategoryQuery extends Pagination { } -export interface ListCompensationPlanQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListCompensationPlanQuery extends Pagination { } -export interface ListCompensationChangeReasonQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} - -export interface QueryCompensationArchiveResponse { - /** 档案信息列表 */ - items: ArchiveDetail[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more: boolean -} - -export interface ListCompensationItemResponse { - /** 薪酬项信息列表 */ - items: Item[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more: boolean -} - -export interface ListCompensationIndicatorResponse { - /** 薪资统计指标信息列表 */ - items: Indicator[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - -export interface ListCompensationItemCategoryResponse { - /** 薪酬项分类信息列表 */ - items?: ItemCategory[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - -export interface ListCompensationPlanResponse { - /** 薪资方案信息列表 */ - items: PlanDetail[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more: boolean -} - -export interface ListCompensationChangeReasonResponse { - /** 调薪原因信息列表 */ - items: ChangeReason[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more: boolean +export interface ListCompensationChangeReasonQuery extends Pagination { } Internal.define({ diff --git a/adapters/lark/src/types/contact.ts b/adapters/lark/src/types/contact.ts index 4a6e8053..41473114 100644 --- a/adapters/lark/src/types/contact.ts +++ b/adapters/lark/src/types/contact.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { CustomAttr, Department, DepartmentI18nName, DepartmentLeader, EmployeeTypeEnum, FunctionalRoleMember, FunctionalRoleMemberResult, Group, I18nContent, JobFamily, JobLevel, JobTitle, MemberResult, Memberlist, ResourceAcceptor, Unit, UnitDepartment, User, UserContactInfo, UserCustomAttr, UserDepartmentInfo, UserOrder, WorkCity } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,7 +37,7 @@ declare module '../internal' { * 获取部门直属用户列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department */ - findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery): Promise + findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery): Promise> /** * 通过手机号或邮箱获取用户 ID * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id @@ -72,12 +72,12 @@ declare module '../internal' { * 查询用户组列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist */ - simplelistContactGroup(query?: SimplelistContactGroupQuery): Promise + simplelistContactGroup(query?: SimplelistContactGroupQuery): Promise> /** * 查询用户所属用户组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong */ - memberBelongContactGroup(query?: MemberBelongContactGroupQuery): Promise + memberBelongContactGroup(query?: MemberBelongContactGroupQuery): Promise> /** * 删除用户组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete @@ -87,7 +87,7 @@ declare module '../internal' { * 获取企业自定义用户字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list */ - listContactCustomAttr(query?: ListContactCustomAttrQuery): Promise + listContactCustomAttr(query?: ListContactCustomAttrQuery): Promise> /** * 新增人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create @@ -102,7 +102,7 @@ declare module '../internal' { * 查询人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list */ - listContactEmployeeTypeEnum(query?: ListContactEmployeeTypeEnumQuery): Promise + listContactEmployeeTypeEnum(query?: ListContactEmployeeTypeEnumQuery): Promise> /** * 删除人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete @@ -147,17 +147,17 @@ declare module '../internal' { * 获取子部门列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children */ - childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery): Promise + childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery): Promise> /** * 获取父部门信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent */ - parentContactDepartment(query?: ParentContactDepartmentQuery): Promise + parentContactDepartment(query?: ParentContactDepartmentQuery): Promise> /** * 搜索部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search */ - searchContactDepartment(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): Promise + searchContactDepartment(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): Promise> /** * 删除部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete @@ -187,7 +187,7 @@ declare module '../internal' { * 获取单位绑定的部门列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department */ - listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery): Promise + listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery): Promise> /** * 获取单位信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get @@ -197,7 +197,7 @@ declare module '../internal' { * 获取单位列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list */ - listContactUnit(query?: ListContactUnitQuery): Promise + listContactUnit(query?: ListContactUnitQuery): Promise> /** * 删除单位 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete @@ -217,7 +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): Promise + simplelistContactGroupMember(group_id: string, query?: SimplelistContactGroupMemberQuery): Promise> /** * 移除用户组成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove @@ -262,7 +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): Promise + listContactFunctionalRoleMember(role_id: string, query?: ListContactFunctionalRoleMemberQuery): Promise> /** * 删除角色下的成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete @@ -287,7 +287,7 @@ declare module '../internal' { * 获取租户职级列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list */ - listContactJobLevel(query?: ListContactJobLevelQuery): Promise + listContactJobLevel(query?: ListContactJobLevelQuery): Promise> /** * 删除职级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete @@ -312,7 +312,7 @@ declare module '../internal' { * 获取租户序列列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list */ - listContactJobFamily(query?: ListContactJobFamilyQuery): Promise + listContactJobFamily(query?: ListContactJobFamilyQuery): Promise> /** * 删除序列 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete @@ -327,7 +327,7 @@ declare module '../internal' { * 获取租户职务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list */ - listContactJobTitle(query?: ListContactJobTitleQuery): Promise + listContactJobTitle(query?: ListContactJobTitleQuery): Promise> /** * 获取单个工作城市信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get @@ -337,12 +337,12 @@ declare module '../internal' { * 获取租户工作城市列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list */ - listContactWorkCity(query?: ListContactWorkCityQuery): Promise + listContactWorkCity(query?: ListContactWorkCityQuery): Promise> /** * 获取用户列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list */ - listContactUser(query?: ListContactUserQuery): Promise + listContactUser(query?: ListContactUserQuery): Promise> /** * 更新用户所有信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update @@ -352,19 +352,15 @@ declare module '../internal' { * 获取部门信息列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list */ - listContactDepartment(query?: ListContactDepartmentQuery): Promise + listContactDepartment(query?: ListContactDepartmentQuery): Promise> } } -export interface ListContactScopeQuery { +export interface ListContactScopeQuery extends Pagination { /** 返回值的用户ID的类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' /** 返回值的部门ID的类型 */ department_id_type?: 'department_id' | 'open_department_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小，返回值所有列表长度之和不超过这个值 */ - page_size?: number } export interface CreateContactUserRequest { @@ -517,17 +513,13 @@ 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) */ department_id_type?: 'department_id' | 'open_department_id' /** 填写该字段表示获取该部门下用户，必填。根部门的部门ID为0。ID值与查询参数中的department_id_type 对应。不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ department_id: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string } export interface BatchGetIdContactUserRequest { @@ -623,33 +615,21 @@ export interface GetContactGroupQuery { department_id_type?: 'open_department_id' | 'department_id' } -export interface SimplelistContactGroupQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SimplelistContactGroupQuery extends Pagination { /** 用户组类型 */ type?: 1 | 2 } -export interface MemberBelongContactGroupQuery { +export interface MemberBelongContactGroupQuery extends Pagination { /** 成员ID */ member_id: string /** 成员ID类型 */ member_id_type?: 'open_id' | 'union_id' | 'user_id' /** 欲获取的用户组类型 */ group_type?: 1 | 2 - /** 分页查询大小 */ - page_size?: number - /** 分页查询Token */ - page_token?: string } -export interface ListContactCustomAttrQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListContactCustomAttrQuery extends Pagination { } export interface CreateContactEmployeeTypeEnumRequest { @@ -674,11 +654,7 @@ export interface UpdateContactEmployeeTypeEnumRequest { i18n_content?: I18nContent[] } -export interface ListContactEmployeeTypeEnumQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface ListContactEmployeeTypeEnumQuery extends Pagination { } export interface CreateContactDepartmentRequest { @@ -803,30 +779,22 @@ 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) */ department_id_type?: 'department_id' | 'open_department_id' /** 是否递归获取子部门 */ fetch_child?: boolean - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string } -export interface ParentContactDepartmentQuery { +export interface ParentContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ department_id_type?: 'department_id' | 'open_department_id' /** 部门ID */ department_id: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface SearchContactDepartmentRequest { @@ -834,15 +802,11 @@ export interface SearchContactDepartmentRequest { query: string } -export interface SearchContactDepartmentQuery { +export interface SearchContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ department_id_type?: 'department_id' | 'open_department_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface DeleteContactDepartmentQuery { @@ -882,22 +846,14 @@ export interface UnbindDepartmentContactUnitRequest { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListDepartmentContactUnitQuery { +export interface ListDepartmentContactUnitQuery extends Pagination { /** 单位ID */ unit_id: string /** 此次调用中预获取的部门ID的类型 */ department_id_type?: 'department_id' | 'open_department_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } -export interface ListContactUnitQuery { - /** 分页大小，默认50，取值范围 1-100 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListContactUnitQuery extends Pagination { } export interface AddContactGroupMemberRequest { @@ -914,11 +870,7 @@ export interface BatchAddContactGroupMemberRequest { members?: Memberlist[] } -export interface SimplelistContactGroupMemberQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +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' /** 欲获取的用户组成员类型。 */ @@ -980,11 +932,7 @@ export interface GetContactFunctionalRoleMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } -export interface ListContactFunctionalRoleMemberQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListContactFunctionalRoleMemberQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' /** 此次调用中使用的部门ID的类型 */ @@ -1031,11 +979,7 @@ export interface UpdateContactJobLevelRequest { i18n_description?: I18nContent[] } -export interface ListContactJobLevelQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListContactJobLevelQuery extends Pagination { /** 传入该字段时，可查询指定职级名称对应的职级信息。 */ name?: string } @@ -1070,40 +1014,24 @@ export interface UpdateContactJobFamilyRequest { i18n_description?: I18nContent[] } -export interface ListContactJobFamilyQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListContactJobFamilyQuery extends Pagination { /** 序列名称,传入该字段时，可查询指定序列名称对应的序列信息 */ name?: string } -export interface ListContactJobTitleQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListContactJobTitleQuery extends Pagination { } -export interface ListContactWorkCityQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListContactWorkCityQuery extends Pagination { } -export interface ListContactUserQuery { +export interface ListContactUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门ID的类型 */ department_id_type?: 'department_id' | 'open_department_id' /** 填写该字段表示获取部门下所有用户，选填。 */ department_id?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface UpdateContactUserRequest { @@ -1158,7 +1086,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的类型 */ @@ -1167,10 +1095,6 @@ export interface ListContactDepartmentQuery { parent_department_id?: string /** 是否递归获取子部门 */ fetch_child?: boolean - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string } export interface ListContactScopeResponse { @@ -1203,15 +1127,6 @@ export interface BatchContactUserResponse { items?: User[] } -export interface FindByDepartmentContactUserResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 用户列表 */ - items?: User[] -} - export interface BatchGetIdContactUserResponse { /** 手机号或者邮箱对应的用户id信息 */ user_list?: UserContactInfo[] @@ -1227,33 +1142,6 @@ export interface GetContactGroupResponse { group: Group } -export interface SimplelistContactGroupResponse { - /** 用户组列表 */ - grouplist: Group[] - /** 下次分页获取的page_token */ - page_token: string - /** 是否还需要分页获取 */ - has_more: boolean -} - -export interface MemberBelongContactGroupResponse { - /** 用户组ID列表 */ - group_list?: string[] - /** 分页查询Token */ - page_token?: string - /** 是否有更多结果 */ - has_more?: boolean -} - -export interface ListContactCustomAttrResponse { - /** 自定义字段定义 */ - items?: CustomAttr[] - /** 分页标记 */ - page_token?: string - /** 是否还有下一页 */ - has_more?: boolean -} - export interface CreateContactEmployeeTypeEnumResponse { /** 创建人员类型接口 */ employee_type_enum?: EmployeeTypeEnum @@ -1263,15 +1151,6 @@ export interface UpdateContactEmployeeTypeEnumResponse { employee_type_enum?: EmployeeTypeEnum } -export interface ListContactEmployeeTypeEnumResponse { - /** 雇员类型列表 */ - items?: EmployeeTypeEnum[] - /** 是否下一页 */ - has_more?: boolean - /** 分页token */ - page_token?: string -} - export interface CreateContactDepartmentResponse { department?: Department } @@ -1293,75 +1172,21 @@ export interface BatchContactDepartmentResponse { items?: Department[] } -export interface ChildrenContactDepartmentResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 部门列表 */ - items?: Department[] -} - -export interface ParentContactDepartmentResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 部门列表 */ - items?: Department[] -} - -export interface SearchContactDepartmentResponse { - /** 部门列表 */ - items?: Department[] - /** 翻页 token，传入返回下一页，首页不需要传入 */ - page_token?: string - /** 是否还有下一页 */ - has_more: boolean -} - export interface CreateContactUnitResponse { /** 单位的自定义ID */ unit_id: string } -export interface ListDepartmentContactUnitResponse { - /** 单位绑定的部门列表 */ - departmentlist: UnitDepartment[] - /** 是否还有分页数据 */ - has_more: boolean - /** 下次分页请求标记 */ - page_token: string -} - export interface GetContactUnitResponse { /** 单位信息 */ unit: Unit } -export interface ListContactUnitResponse { - /** 单位列表 */ - unitlist: Unit[] - /** 是否还有分页数据 */ - has_more: boolean - /** 分页下次调用的page_token值 */ - page_token: string -} - export interface BatchAddContactGroupMemberResponse { /** 成员添加操作结果 */ results?: MemberResult[] } -export interface SimplelistContactGroupMemberResponse { - /** 成员列表 */ - memberlist: Memberlist[] - /** 下次分页获取的page_token */ - page_token: string - /** 是否还需要分页获取 */ - has_more: boolean -} - export interface CreateContactFunctionalRoleResponse { /** 角色ID，在单租户下唯一 */ role_id: string @@ -1382,15 +1207,6 @@ export interface GetContactFunctionalRoleMemberResponse { member?: FunctionalRoleMember } -export interface ListContactFunctionalRoleMemberResponse { - /** 角色成员列表 */ - members?: FunctionalRoleMember[] - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否还有值 */ - has_more?: boolean -} - export interface BatchDeleteContactFunctionalRoleMemberResponse { /** 批量新增角色成员结果集 */ result?: FunctionalRoleMemberResult[] @@ -1411,15 +1227,6 @@ export interface GetContactJobLevelResponse { job_level?: JobLevel } -export interface ListContactJobLevelResponse { - /** 职级列表 */ - items?: JobLevel[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface CreateContactJobFamilyResponse { /** 序列信息 */ job_family?: JobFamily @@ -1435,63 +1242,20 @@ export interface GetContactJobFamilyResponse { job_family?: JobFamily } -export interface ListContactJobFamilyResponse { - /** 序列信息 */ - items?: JobFamily[] - /** 下一页分页的token */ - page_token?: string - /** 是否有下一页数据 */ - has_more?: boolean -} - export interface GetContactJobTitleResponse { /** 职务信息 */ job_title?: JobTitle } -export interface ListContactJobTitleResponse { - /** 职务列表 */ - items?: JobTitle[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface GetContactWorkCityResponse { /** 工作城市信息 */ work_city?: WorkCity } -export interface ListContactWorkCityResponse { - /** 工作城市列表 */ - items?: WorkCity[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - -export interface ListContactUserResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - items?: User[] -} - export interface UpdateContactUserResponse { user?: User } -export interface ListContactDepartmentResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - items?: Department[] -} - Internal.define({ '/open-apis/contact/v3/scopes': { GET: 'listContactScope', diff --git a/adapters/lark/src/types/corehr.ts b/adapters/lark/src/types/corehr.ts index 3861ea62..4f0db7a6 100644 --- a/adapters/lark/src/types/corehr.ts +++ b/adapters/lark/src/types/corehr.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, EmployeeType, EmployeesAdditionalJob, EmployeesAdditionalJobBatchReqDate, EmployeesAdditionalJobWriteResp, 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, PersonInfo, PersonName, PersonalProfile, 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,7 +7,7 @@ declare module '../internal' { * 获取飞书人事对象列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/list_object_api_name */ - listObjectApiNameCorehrCustomField(query?: ListObjectApiNameCorehrCustomFieldQuery): Promise + listObjectApiNameCorehrCustomField(query?: ListObjectApiNameCorehrCustomFieldQuery): Promise> /** * 获取自定义字段列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query @@ -32,27 +32,27 @@ declare module '../internal' { * 查询国家/地区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search */ - searchCorehrBasicInfoCountryRegion(body: SearchCorehrBasicInfoCountryRegionRequest, query?: SearchCorehrBasicInfoCountryRegionQuery): Promise + searchCorehrBasicInfoCountryRegion(body: SearchCorehrBasicInfoCountryRegionRequest, query?: SearchCorehrBasicInfoCountryRegionQuery): Promise> /** * 查询省份/主要行政区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search */ - searchCorehrBasicInfoCountryRegionSubdivision(body: SearchCorehrBasicInfoCountryRegionSubdivisionRequest, query?: SearchCorehrBasicInfoCountryRegionSubdivisionQuery): Promise + searchCorehrBasicInfoCountryRegionSubdivision(body: SearchCorehrBasicInfoCountryRegionSubdivisionRequest, query?: SearchCorehrBasicInfoCountryRegionSubdivisionQuery): Promise> /** * 查询城市信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search */ - searchCorehrBasicInfoCity(body: SearchCorehrBasicInfoCityRequest, query?: SearchCorehrBasicInfoCityQuery): Promise + searchCorehrBasicInfoCity(body: SearchCorehrBasicInfoCityRequest, query?: SearchCorehrBasicInfoCityQuery): Promise> /** * 查询区/县信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search */ - searchCorehrBasicInfoDistrict(body: SearchCorehrBasicInfoDistrictRequest, query?: SearchCorehrBasicInfoDistrictQuery): Promise + searchCorehrBasicInfoDistrict(body: SearchCorehrBasicInfoDistrictRequest, query?: SearchCorehrBasicInfoDistrictQuery): Promise> /** * 查询国籍信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search */ - searchCorehrBasicInfoNationality(body: SearchCorehrBasicInfoNationalityRequest, query?: SearchCorehrBasicInfoNationalityQuery): Promise + searchCorehrBasicInfoNationality(body: SearchCorehrBasicInfoNationalityRequest, query?: SearchCorehrBasicInfoNationalityQuery): Promise> /** * 创建国家证件类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/create @@ -77,32 +77,32 @@ declare module '../internal' { * 批量查询国家证件类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/list */ - listCorehrNationalIdType(query?: ListCorehrNationalIdTypeQuery): Promise + listCorehrNationalIdType(query?: ListCorehrNationalIdTypeQuery): Promise> /** * 查询银行信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search */ - searchCorehrBasicInfoBank(body: SearchCorehrBasicInfoBankRequest, query?: SearchCorehrBasicInfoBankQuery): Promise + searchCorehrBasicInfoBank(body: SearchCorehrBasicInfoBankRequest, query?: SearchCorehrBasicInfoBankQuery): Promise> /** * 查询支行信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank_branch/search */ - searchCorehrBasicInfoBankBranch(body: SearchCorehrBasicInfoBankBranchRequest, query?: SearchCorehrBasicInfoBankBranchQuery): Promise + searchCorehrBasicInfoBankBranch(body: SearchCorehrBasicInfoBankBranchRequest, query?: SearchCorehrBasicInfoBankBranchQuery): Promise> /** * 查询货币信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search */ - searchCorehrBasicInfoCurrency(body: SearchCorehrBasicInfoCurrencyRequest, query?: SearchCorehrBasicInfoCurrencyQuery): Promise + searchCorehrBasicInfoCurrency(body: SearchCorehrBasicInfoCurrencyRequest, query?: SearchCorehrBasicInfoCurrencyQuery): Promise> /** * 查询时区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-time_zone/search */ - searchCorehrBasicInfoTimeZone(body: SearchCorehrBasicInfoTimeZoneRequest, query?: SearchCorehrBasicInfoTimeZoneQuery): Promise + searchCorehrBasicInfoTimeZone(body: SearchCorehrBasicInfoTimeZoneRequest, query?: SearchCorehrBasicInfoTimeZoneQuery): Promise> /** * 查询语言信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-language/search */ - searchCorehrBasicInfoLanguage(body: SearchCorehrBasicInfoLanguageRequest, query?: SearchCorehrBasicInfoLanguageQuery): Promise + searchCorehrBasicInfoLanguage(body: SearchCorehrBasicInfoLanguageRequest, query?: SearchCorehrBasicInfoLanguageQuery): Promise> /** * 创建人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/create @@ -127,7 +127,7 @@ declare module '../internal' { * 批量查询人员类型 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list */ - listCorehrEmployeeType(query?: ListCorehrEmployeeTypeQuery): Promise + listCorehrEmployeeType(query?: ListCorehrEmployeeTypeQuery): Promise> /** * 创建工时制度 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/create @@ -152,7 +152,7 @@ declare module '../internal' { * 批量查询工时制度 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list */ - listCorehrWorkingHoursType(query?: ListCorehrWorkingHoursTypeQuery): Promise + listCorehrWorkingHoursType(query?: ListCorehrWorkingHoursTypeQuery): Promise> /** * ID 转换 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-id/convert @@ -167,7 +167,7 @@ declare module '../internal' { * 搜索员工信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search */ - searchCorehrEmployee(body: SearchCorehrEmployeeRequest, query?: SearchCorehrEmployeeQuery): Promise + searchCorehrEmployee(body: SearchCorehrEmployeeRequest, query?: SearchCorehrEmployeeQuery): Promise> /** * 添加人员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/create @@ -232,7 +232,7 @@ declare module '../internal' { * 获取任职信息列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/query */ - queryCorehrEmployeesJobData(body: QueryCorehrEmployeesJobDataRequest, query?: QueryCorehrEmployeesJobDataQuery): Promise + queryCorehrEmployeesJobData(body: QueryCorehrEmployeesJobDataRequest, query?: QueryCorehrEmployeesJobDataQuery): Promise> /** * 批量查询员工任职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/batch_get @@ -242,7 +242,7 @@ declare module '../internal' { * 批量查询任职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/list */ - listCorehrJobData(query?: ListCorehrJobDataQuery): Promise + listCorehrJobData(query?: ListCorehrJobDataQuery): Promise> /** * 查询单个任职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/get @@ -267,7 +267,7 @@ declare module '../internal' { * 批量查询兼职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/batch */ - batchCorehrEmployeesAdditionalJob(body: BatchCorehrEmployeesAdditionalJobRequest, query?: BatchCorehrEmployeesAdditionalJobQuery): Promise + batchCorehrEmployeesAdditionalJob(body: BatchCorehrEmployeesAdditionalJobRequest, query?: BatchCorehrEmployeesAdditionalJobQuery): Promise> /** * 批量查询部门操作日志 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_operation_logs @@ -307,17 +307,17 @@ declare module '../internal' { * 查询指定生效日期的部门架构树 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/tree */ - treeCorehrDepartment(body: TreeCorehrDepartmentRequest, query?: TreeCorehrDepartmentQuery): Promise + treeCorehrDepartment(body: TreeCorehrDepartmentRequest, query?: TreeCorehrDepartmentQuery): Promise> /** * 批量查询部门版本信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_multi_timeline */ - queryMultiTimelineCorehrDepartment(body: QueryMultiTimelineCorehrDepartmentRequest, query?: QueryMultiTimelineCorehrDepartmentQuery): Promise + queryMultiTimelineCorehrDepartment(body: QueryMultiTimelineCorehrDepartmentRequest, query?: QueryMultiTimelineCorehrDepartmentQuery): Promise> /** * 搜索部门信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search */ - searchCorehrDepartment(body: SearchCorehrDepartmentRequest, query?: SearchCorehrDepartmentQuery): Promise + searchCorehrDepartment(body: SearchCorehrDepartmentRequest, query?: SearchCorehrDepartmentQuery): Promise> /** * 删除部门 V2 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/delete @@ -352,7 +352,7 @@ declare module '../internal' { * 批量分页查询地点信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list */ - listCorehrLocation(query?: ListCorehrLocationQuery): Promise + listCorehrLocation(query?: ListCorehrLocationQuery): Promise> /** * 启用/停用地点 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/active @@ -402,7 +402,7 @@ declare module '../internal' { * 批量查询公司 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list */ - listCorehrCompany(query?: ListCorehrCompanyQuery): Promise + listCorehrCompany(query?: ListCorehrCompanyQuery): Promise> /** * 查询指定时间范围内当前生效信息发生变更的公司 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/query_recent_change @@ -437,7 +437,7 @@ declare module '../internal' { * 搜索成本中心信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search */ - searchCorehrCostCenter(body: SearchCorehrCostCenterRequest, query?: SearchCorehrCostCenterQuery): Promise + searchCorehrCostCenter(body: SearchCorehrCostCenterRequest, query?: SearchCorehrCostCenterQuery): Promise> /** * 删除成本中心 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/delete @@ -492,7 +492,7 @@ declare module '../internal' { * 批量查询序列 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list */ - listCorehrJobFamily(query?: ListCorehrJobFamilyQuery): Promise + listCorehrJobFamily(query?: ListCorehrJobFamilyQuery): Promise> /** * 查询当前生效信息发生变更的序列 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_family/query_recent_change @@ -527,7 +527,7 @@ declare module '../internal' { * 批量查询职级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list */ - listCorehrJobLevel(query?: ListCorehrJobLevelQuery): Promise + listCorehrJobLevel(query?: ListCorehrJobLevelQuery): Promise> /** * 查询当前生效信息发生变更的职级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_level/query_recent_change @@ -557,7 +557,7 @@ declare module '../internal' { * 查询职等 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query */ - queryCorehrJobGrade(body: QueryCorehrJobGradeRequest, query?: QueryCorehrJobGradeQuery): Promise + queryCorehrJobGrade(body: QueryCorehrJobGradeRequest, query?: QueryCorehrJobGradeQuery): Promise> /** * 查询当前生效信息发生变更的职等 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query_recent_change @@ -592,7 +592,7 @@ declare module '../internal' { * 批量查询职务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list */ - listCorehrJob(query?: ListCorehrJobQuery): Promise + listCorehrJob(query?: ListCorehrJobQuery): Promise> /** * 撤销入职 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/withdraw_onboarding @@ -622,7 +622,7 @@ declare module '../internal' { * 查询待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query */ - queryCorehrPreHire(body: QueryCorehrPreHireRequest, query?: QueryCorehrPreHireQuery): Promise + queryCorehrPreHire(body: QueryCorehrPreHireRequest, query?: QueryCorehrPreHireQuery): Promise> /** * 查询单个待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/get @@ -632,12 +632,12 @@ declare module '../internal' { * 批量查询待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/list */ - listCorehrPreHire(query?: ListCorehrPreHireQuery): Promise + listCorehrPreHire(query?: ListCorehrPreHireQuery): Promise> /** * 搜索待入职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search */ - searchCorehrPreHire(body: SearchCorehrPreHireRequest, query?: SearchCorehrPreHireQuery): Promise + searchCorehrPreHire(body: SearchCorehrPreHireRequest, query?: SearchCorehrPreHireQuery): Promise> /** * 流转入职任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/transit_task @@ -677,7 +677,7 @@ declare module '../internal' { * 搜索试用期信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search */ - searchCorehrProbation(body: SearchCorehrProbationRequest, query?: SearchCorehrProbationQuery): Promise + searchCorehrProbation(body: SearchCorehrProbationRequest, query?: SearchCorehrProbationQuery): Promise> /** * 删除试用期考核信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/delete @@ -712,7 +712,7 @@ declare module '../internal' { * 搜索员工异动信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search */ - searchCorehrJobChange(body: SearchCorehrJobChangeRequest, query?: SearchCorehrJobChangeQuery): Promise + searchCorehrJobChange(body: SearchCorehrJobChangeRequest, query?: SearchCorehrJobChangeQuery): Promise> /** * 撤销异动 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/revoke @@ -747,7 +747,7 @@ declare module '../internal' { * 搜索离职信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/search */ - searchCorehrOffboarding(body: SearchCorehrOffboardingRequest, query?: SearchCorehrOffboardingQuery): Promise + searchCorehrOffboarding(body: SearchCorehrOffboardingRequest, query?: SearchCorehrOffboardingQuery): Promise> /** * 新建合同 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/create @@ -772,12 +772,12 @@ declare module '../internal' { * 批量查询合同 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list */ - listCorehrContract(query?: ListCorehrContractQuery): Promise + listCorehrContract(query?: ListCorehrContractQuery): Promise> /** * 搜索合同 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/contract/search */ - searchCorehrContract(body: SearchCorehrContractRequest, query?: SearchCorehrContractQuery): Promise + searchCorehrContract(body: SearchCorehrContractRequest, query?: SearchCorehrContractQuery): Promise> /** * 批量创建/更新明细行 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail_row/batchSave @@ -822,17 +822,17 @@ declare module '../internal' { * 获取假期类型列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_types */ - leaveTypesCorehrLeave(query?: LeaveTypesCorehrLeaveQuery): Promise + leaveTypesCorehrLeave(query?: LeaveTypesCorehrLeaveQuery): Promise> /** * 批量查询员工假期余额 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_balances */ - leaveBalancesCorehrLeave(query?: LeaveBalancesCorehrLeaveQuery): Promise + leaveBalancesCorehrLeave(query?: LeaveBalancesCorehrLeaveQuery): Promise> /** * 批量查询员工请假记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_request_history */ - leaveRequestHistoryCorehrLeave(query?: LeaveRequestHistoryCorehrLeaveQuery): Promise + leaveRequestHistoryCorehrLeave(query?: LeaveRequestHistoryCorehrLeaveQuery): Promise> /** * 获取工作日历 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar @@ -852,7 +852,7 @@ declare module '../internal' { * 批量查询用户授权 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/query */ - queryCorehrAuthorization(query?: QueryCorehrAuthorizationQuery): Promise + queryCorehrAuthorization(query?: QueryCorehrAuthorizationQuery): Promise> /** * 查询单个用户授权 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/get_by_param @@ -862,7 +862,7 @@ declare module '../internal' { * 批量获取角色列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/list */ - listCorehrSecurityGroup(query?: ListCorehrSecurityGroupQuery): Promise + listCorehrSecurityGroup(query?: ListCorehrSecurityGroupQuery): Promise> /** * 为用户授权角色 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/add_role_assign @@ -897,17 +897,17 @@ declare module '../internal' { * 获取 HRBP 列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/list */ - listCorehrBp(query?: ListCorehrBpQuery): Promise + listCorehrBp(query?: ListCorehrBpQuery): Promise> /** * 获取组织类角色授权列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/assigned_user/search */ - searchCorehrAssignedUser(body: SearchCorehrAssignedUserRequest, query?: SearchCorehrAssignedUserQuery): Promise + searchCorehrAssignedUser(body: SearchCorehrAssignedUserRequest, query?: SearchCorehrAssignedUserQuery): Promise> /** * 查询流程实例列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/list */ - listCorehrProcess(query?: ListCorehrProcessQuery): Promise + listCorehrProcess(query?: ListCorehrProcessQuery): Promise> /** * 获取单个流程详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/get @@ -932,7 +932,7 @@ declare module '../internal' { * 获取指定人员审批任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approver/list */ - listCorehrApprover(query?: ListCorehrApproverQuery): Promise + listCorehrApprover(query?: ListCorehrApproverQuery): Promise> /** * 通过/拒绝审批任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-approver/update @@ -962,7 +962,7 @@ declare module '../internal' { * 批量查询城市/区域信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/list */ - listCorehrSubregion(query?: ListCorehrSubregionQuery): Promise + listCorehrSubregion(query?: ListCorehrSubregionQuery): Promise> /** * 查询单条城市/区域信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/get @@ -972,7 +972,7 @@ declare module '../internal' { * 批量查询省份/行政区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/list */ - listCorehrSubdivision(query?: ListCorehrSubdivisionQuery): Promise + listCorehrSubdivision(query?: ListCorehrSubdivisionQuery): Promise> /** * 查询单条省份/行政区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/get @@ -982,7 +982,7 @@ declare module '../internal' { * 批量查询国家/地区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/list */ - listCorehrCountryRegion(query?: ListCorehrCountryRegionQuery): Promise + listCorehrCountryRegion(query?: ListCorehrCountryRegionQuery): Promise> /** * 查询单条国家/地区信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/get @@ -992,7 +992,7 @@ declare module '../internal' { * 批量查询货币信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/list */ - listCorehrCurrency(query?: ListCorehrCurrencyQuery): Promise + listCorehrCurrency(query?: ListCorehrCurrencyQuery): Promise> /** * 查询单个货币信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/get @@ -1022,12 +1022,12 @@ declare module '../internal' { * 批量查询职务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/list */ - listCorehrJob(query?: ListCorehrJobQuery): Promise + listCorehrJob(query?: ListCorehrJobQuery): Promise> /** * 批量查询部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/list */ - listCorehrDepartment(query?: ListCorehrDepartmentQuery): Promise + listCorehrDepartment(query?: ListCorehrDepartmentQuery): Promise> /** * 更新个人信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/patch @@ -1051,11 +1051,7 @@ declare module '../internal' { } } -export interface ListObjectApiNameCorehrCustomFieldQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListObjectApiNameCorehrCustomFieldQuery extends Pagination { } export interface QueryCorehrCustomFieldQuery { @@ -1105,11 +1101,7 @@ export interface SearchCorehrBasicInfoCountryRegionRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoCountryRegionQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoCountryRegionQuery extends Pagination { } export interface SearchCorehrBasicInfoCountryRegionSubdivisionRequest { @@ -1121,11 +1113,7 @@ export interface SearchCorehrBasicInfoCountryRegionSubdivisionRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoCountryRegionSubdivisionQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoCountryRegionSubdivisionQuery extends Pagination { } export interface SearchCorehrBasicInfoCityRequest { @@ -1137,11 +1125,7 @@ export interface SearchCorehrBasicInfoCityRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoCityQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoCityQuery extends Pagination { } export interface SearchCorehrBasicInfoDistrictRequest { @@ -1153,11 +1137,7 @@ export interface SearchCorehrBasicInfoDistrictRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoDistrictQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoDistrictQuery extends Pagination { } export interface SearchCorehrBasicInfoNationalityRequest { @@ -1169,11 +1149,7 @@ export interface SearchCorehrBasicInfoNationalityRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoNationalityQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoNationalityQuery extends Pagination { } export interface CreateCorehrNationalIdTypeRequest { @@ -1224,11 +1200,7 @@ export interface PatchCorehrNationalIdTypeQuery { client_token?: string } -export interface ListCorehrNationalIdTypeQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrNationalIdTypeQuery extends Pagination { /** 证件类型 */ identification_type?: string /** 证件类型编码 */ @@ -1250,11 +1222,7 @@ export interface SearchCorehrBasicInfoBankRequest { update_end_time?: string } -export interface SearchCorehrBasicInfoBankQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoBankQuery extends Pagination { } export interface SearchCorehrBasicInfoBankBranchRequest { @@ -1274,11 +1242,7 @@ export interface SearchCorehrBasicInfoBankBranchRequest { update_end_time?: string } -export interface SearchCorehrBasicInfoBankBranchQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoBankBranchQuery extends Pagination { } export interface SearchCorehrBasicInfoCurrencyRequest { @@ -1288,11 +1252,7 @@ export interface SearchCorehrBasicInfoCurrencyRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoCurrencyQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoCurrencyQuery extends Pagination { } export interface SearchCorehrBasicInfoTimeZoneRequest { @@ -1302,11 +1262,7 @@ export interface SearchCorehrBasicInfoTimeZoneRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoTimeZoneQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoTimeZoneQuery extends Pagination { } export interface SearchCorehrBasicInfoLanguageRequest { @@ -1316,11 +1272,7 @@ export interface SearchCorehrBasicInfoLanguageRequest { status_list?: 1 | 0[] } -export interface SearchCorehrBasicInfoLanguageQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrBasicInfoLanguageQuery extends Pagination { } export interface CreateCorehrEmployeeTypeRequest { @@ -1359,11 +1311,7 @@ export interface PatchCorehrEmployeeTypeQuery { client_token?: string } -export interface ListCorehrEmployeeTypeQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrEmployeeTypeQuery extends Pagination { } export interface CreateCorehrWorkingHoursTypeRequest { @@ -1406,11 +1354,7 @@ export interface PatchCorehrWorkingHoursTypeQuery { client_token?: string } -export interface ListCorehrWorkingHoursTypeQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrWorkingHoursTypeQuery extends Pagination { } export interface ConvertCorehrCommonDataIdRequest { @@ -1530,11 +1474,7 @@ export interface SearchCorehrEmployeeRequest { archive_cpst_plan_id_list?: string[] } -export interface SearchCorehrEmployeeQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrEmployeeQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -1935,11 +1875,7 @@ export interface QueryCorehrEmployeesJobDataRequest { assignment_start_reasons?: string[] } -export interface QueryCorehrEmployeesJobDataQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryCorehrEmployeesJobDataQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -1970,11 +1906,7 @@ export interface BatchGetCorehrEmployeesJobDataQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface ListCorehrJobDataQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrJobDataQuery extends Pagination { /** 雇佣 ID */ employment_id?: string /** 任职信息 ID 列表，最大 100 个（不传则默认查询全部任职信息） */ @@ -2111,11 +2043,7 @@ export interface BatchCorehrEmployeesAdditionalJobRequest { is_effective?: boolean } -export interface BatchCorehrEmployeesAdditionalJobQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface BatchCorehrEmployeesAdditionalJobQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2131,11 +2059,7 @@ export interface QueryOperationLogsCorehrDepartmentRequest { end_date: string } -export interface QueryOperationLogsCorehrDepartmentQuery { - /** 分页大小，最大 1000 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryOperationLogsCorehrDepartmentQuery extends Pagination { /** 此次调用中使用的部门 ID 类型 */ department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } @@ -2224,11 +2148,7 @@ export interface BatchGetCorehrDepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface QueryRecentChangeCorehrDepartmentQuery { - /** 分页大小，最大 2000 */ - page_size: number - /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryRecentChangeCorehrDepartmentQuery extends Pagination { /** 查询的开始时间，格式 "yyyy-MM-dd"，不带时分秒，包含 start_date 传入的时间, 系统会以 start_date 的 00:00:00 查询。 */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd"，不带时分秒， 查询日期小于 end_data + 1 天的 00:00:00。 */ @@ -2262,11 +2182,7 @@ export interface TreeCorehrDepartmentRequest { effective_date?: string } -export interface TreeCorehrDepartmentQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface TreeCorehrDepartmentQuery extends Pagination { /** 此次调用中使用的部门 ID 类型 */ department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } @@ -2282,11 +2198,7 @@ export interface QueryMultiTimelineCorehrDepartmentRequest { fields?: string[] } -export interface QueryMultiTimelineCorehrDepartmentQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryMultiTimelineCorehrDepartmentQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2312,11 +2224,7 @@ export interface SearchCorehrDepartmentRequest { fields?: string[] } -export interface SearchCorehrDepartmentQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrDepartmentQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -2382,11 +2290,7 @@ export interface PatchCorehrLocationQuery { client_token?: string } -export interface QueryRecentChangeCorehrLocationQuery { - /** 分页大小，最大 2000 */ - page_size: number - /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryRecentChangeCorehrLocationQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2398,11 +2302,7 @@ export interface BatchGetCorehrLocationRequest { location_ids: string[] } -export interface ListCorehrLocationQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrLocationQuery extends Pagination { } export interface ActiveCorehrLocationRequest { @@ -2589,18 +2489,10 @@ export interface ActiveCorehrCompanyRequest { operation_reason: string } -export interface ListCorehrCompanyQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrCompanyQuery extends Pagination { } -export interface QueryRecentChangeCorehrCompanyQuery { - /** 分页大小，最大 2000 */ - page_size: number - /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryRecentChangeCorehrCompanyQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2646,11 +2538,7 @@ export interface PatchCorehrCostCenterQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface QueryRecentChangeCorehrCostCenterQuery { - /** 分页大小，最大 2000 */ - page_size: number - /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryRecentChangeCorehrCostCenterQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2670,11 +2558,7 @@ export interface SearchCorehrCostCenterRequest { get_all_version?: boolean } -export interface SearchCorehrCostCenterQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrCostCenterQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } @@ -2806,18 +2690,10 @@ export interface PatchCorehrJobFamilyQuery { client_token?: string } -export interface ListCorehrJobFamilyQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrJobFamilyQuery extends Pagination { } -export interface QueryRecentChangeCorehrJobFamilyQuery { - /** 分页大小，最大 2000 */ - page_size: number - /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryRecentChangeCorehrJobFamilyQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2873,18 +2749,10 @@ export interface PatchCorehrJobLevelQuery { client_token?: string } -export interface ListCorehrJobLevelQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrJobLevelQuery extends Pagination { } -export interface QueryRecentChangeCorehrJobLevelQuery { - /** 分页大小，最大 2000 */ - page_size: number - /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryRecentChangeCorehrJobLevelQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -2939,18 +2807,10 @@ export interface QueryCorehrJobGradeRequest { active?: boolean } -export interface QueryCorehrJobGradeQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryCorehrJobGradeQuery extends Pagination { } -export interface QueryRecentChangeCorehrJobGradeQuery { - /** 分页大小，最大 2000 */ - page_size: number - /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryRecentChangeCorehrJobGradeQuery extends Pagination { /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ start_date: string /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ @@ -3013,11 +2873,7 @@ export interface PatchCorehrJobQuery { client_token?: string } -export interface ListCorehrJobQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrJobQuery extends Pagination { /** 名称 */ name?: string /** 语言 */ @@ -3073,22 +2929,14 @@ export interface QueryCorehrPreHireRequest { fields?: string[] } -export interface QueryCorehrPreHireQuery { - /** 分页大小，最大 10 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface QueryCorehrPreHireQuery 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 ListCorehrPreHireQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrPreHireQuery extends Pagination { /** 待入职ID列表 */ pre_hire_ids?: string[] } @@ -3130,11 +2978,7 @@ export interface SearchCorehrPreHireRequest { fields?: string[] } -export interface SearchCorehrPreHireQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrPreHireQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3244,11 +3088,7 @@ export interface SearchCorehrProbationRequest { final_assessment_grade?: string } -export interface SearchCorehrProbationQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrProbationQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3354,11 +3194,7 @@ export interface SearchCorehrJobChangeRequest { target_department_ids?: string[] } -export interface SearchCorehrJobChangeQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrJobChangeQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3493,11 +3329,7 @@ export interface SearchCorehrOffboardingRequest { employee_reasons?: string[] } -export interface SearchCorehrOffboardingQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrOffboardingQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } @@ -3562,11 +3394,7 @@ export interface PatchCorehrContractQuery { client_token?: string } -export interface ListCorehrContractQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrContractQuery extends Pagination { } export interface SearchCorehrContractRequest { @@ -3576,11 +3404,7 @@ export interface SearchCorehrContractRequest { contract_id_list?: string[] } -export interface SearchCorehrContractQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchCorehrContractQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } @@ -3647,11 +3471,7 @@ export interface BatchCorehrWorkforcePlanDetailRequest { cost_center_ids?: string[] } -export interface BatchCorehrWorkforcePlanDetailQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface BatchCorehrWorkforcePlanDetailQuery extends Pagination { } export interface CreateCorehrLeaveGrantingRecordRequest { @@ -3680,22 +3500,14 @@ export interface CreateCorehrLeaveGrantingRecordQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface LeaveTypesCorehrLeaveQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface LeaveTypesCorehrLeaveQuery extends Pagination { /** 假期类型状态（不传则为全部）可选值有：- 1：已启用- 2：已停用 */ status?: string /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface LeaveBalancesCorehrLeaveQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大20 */ - page_size: string +export interface LeaveBalancesCorehrLeaveQuery extends Pagination { /** 查询截止日期，即截止到某天余额数据的日期（不传则默认为当天） */ as_of_date?: string /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ @@ -3708,11 +3520,7 @@ export interface LeaveBalancesCorehrLeaveQuery { include_offboard?: boolean } -export interface LeaveRequestHistoryCorehrLeaveQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface LeaveRequestHistoryCorehrLeaveQuery extends Pagination { /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ employment_id_list?: string[] /** 休假发起人 ID 列表，最大 100 个 */ @@ -3804,15 +3612,11 @@ export interface WorkCalendarDateCorehrLeaveRequest { ids?: string[] } -export interface QueryCorehrAuthorizationQuery { +export interface QueryCorehrAuthorizationQuery extends Pagination { /** 员工ID列表，最大100个（不传则默认查询全部员工） */ employment_id_list?: string[] /** 角色 ID 列表，最大 100 个 */ role_id_list?: string[] - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大20 */ - page_size?: string /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 授权时间大于 */ @@ -3828,11 +3632,7 @@ export interface GetByParamCorehrAuthorizationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface ListCorehrSecurityGroupQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrSecurityGroupQuery extends Pagination { } export interface AddRoleAssignCorehrAuthorizationRequest { @@ -3910,11 +3710,7 @@ export interface QueryCorehrSecurityGroupQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface ListCorehrBpQuery { - /** 分页大小，最大 500 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListCorehrBpQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 此次调用中使用的部门 ID 类型 */ @@ -3939,13 +3735,9 @@ export interface SearchCorehrAssignedUserQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface ListCorehrProcessQuery { +export interface ListCorehrProcessQuery extends Pagination { /** 查询流程状态列表。 */ statuses?: number[] - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size: number /** 查询开始时间（unix毫秒时间戳），闭区间，开始时间和结束时间跨度不能超过31天 */ modify_time_from: string /** 1. 任务查询结束时间，闭区间 2. 单位：ms。从1970年1月1日(UTC/GMT的午夜) 开始经过的毫秒数 3. 注意：开始时间和结束时间跨度不能超过31天 4. 示例值：1719549169735 */ @@ -3994,11 +3786,7 @@ export interface UpdateCorehrProcessWithdrawQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' } -export interface ListCorehrApproverQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListCorehrApproverQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' /** 按user_id_type类型传递。如果system_approval为false，则必填。否则非必填。 */ @@ -4104,36 +3892,20 @@ export interface MatchCorehrCompensationStandardQuery { effective_time?: string } -export interface ListCorehrSubregionQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrSubregionQuery extends Pagination { /** 省份/行政区id，填写后只查询该省份/行政区下的城市/区域 */ subdivision_id?: string } -export interface ListCorehrSubdivisionQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrSubdivisionQuery extends Pagination { /** 国家/地区id，填写后只查询该国家/地区下的省份/行政区 */ country_region_id?: string } -export interface ListCorehrCountryRegionQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrCountryRegionQuery extends Pagination { } -export interface ListCorehrCurrencyQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrCurrencyQuery extends Pagination { } export interface PatchCorehrDepartmentRequest { @@ -4173,22 +3945,14 @@ export interface GetCorehrDepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } -export interface ListCorehrJobQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrJobQuery extends Pagination { /** 名称 */ name?: string /** 语言 */ query_language?: string } -export interface ListCorehrDepartmentQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string +export interface ListCorehrDepartmentQuery extends Pagination { /** 部门ID列表 */ department_id_list?: string[] /** 部门名称列表，需精确匹配 */ @@ -4332,15 +4096,6 @@ export interface SubmitCorehrOffboardingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface ListObjectApiNameCorehrCustomFieldResponse { - /** 对象列表 */ - items?: Object[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface QueryCorehrCustomFieldResponse { /** 自定义字段列表 */ items?: CustomField[] @@ -4365,43 +4120,6 @@ export interface EditEnumOptionCorehrCommonDataMetaDataResponse { enum_field_options?: EnumFieldOption[] } -export interface SearchCorehrBasicInfoCountryRegionResponse { - /** 查询到的国家/地区列表 */ - items?: CountryRegion[] - page_token?: string - has_more?: boolean -} - -export interface SearchCorehrBasicInfoCountryRegionSubdivisionResponse { - /** 查询的省份/行政区信息 */ - items?: CountryRegionSubdivision[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - -export interface SearchCorehrBasicInfoCityResponse { - /** 查询到的城市列表 */ - items?: City[] - page_token?: string - has_more?: boolean -} - -export interface SearchCorehrBasicInfoDistrictResponse { - /** 查询到的区/县列表 */ - items?: District[] - page_token?: string - has_more?: boolean -} - -export interface SearchCorehrBasicInfoNationalityResponse { - /** 查询到的国籍列表 */ - items?: Nationality[] - page_token?: string - has_more?: boolean -} - export interface CreateCorehrNationalIdTypeResponse { national_id_type?: NationalIdType } @@ -4415,50 +4133,6 @@ export interface GetCorehrNationalIdTypeResponse { national_id_type?: NationalIdType } -export interface ListCorehrNationalIdTypeResponse { - /** 查询的国家证件类型信息 */ - items?: NationalIdType[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface SearchCorehrBasicInfoBankResponse { - /** 查询到的银行列表 */ - items?: Bank[] - page_token?: string - has_more?: boolean -} - -export interface SearchCorehrBasicInfoBankBranchResponse { - /** 查询到的支行列表 */ - items?: BankBranch[] - page_token?: string - has_more?: boolean -} - -export interface SearchCorehrBasicInfoCurrencyResponse { - /** 查询到的货币信息列表 */ - items?: Currency[] - page_token?: string - has_more?: boolean -} - -export interface SearchCorehrBasicInfoTimeZoneResponse { - /** 查询到的时区列表 */ - items?: TimeZone[] - page_token?: string - has_more?: boolean -} - -export interface SearchCorehrBasicInfoLanguageResponse { - /** 查询到的语言列表 */ - items?: Language[] - page_token?: string - has_more?: boolean -} - export interface CreateCorehrEmployeeTypeResponse { employee_type?: EmployeeType } @@ -4472,15 +4146,6 @@ export interface GetCorehrEmployeeTypeResponse { employee_type?: EmployeeType } -export interface ListCorehrEmployeeTypeResponse { - /** 查询的雇员类型信息 */ - items?: EmployeeType[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface CreateCorehrWorkingHoursTypeResponse { working_hours_type?: WorkingHoursType } @@ -4494,15 +4159,6 @@ export interface GetCorehrWorkingHoursTypeResponse { working_hours_type?: WorkingHoursType } -export interface ListCorehrWorkingHoursTypeResponse { - /** 查询的工时制度信息 */ - items?: WorkingHoursType[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface ConvertCorehrCommonDataIdResponse { /** ID 信息列表 */ items?: IdInfo[] @@ -4513,15 +4169,6 @@ export interface BatchGetCorehrEmployeeResponse { items?: Employee[] } -export interface SearchCorehrEmployeeResponse { - /** 查询的雇佣信息 */ - items?: Employee[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface CreateCorehrEmployeeResponse { /** 雇佣信息 ID */ employment_id?: string @@ -4560,29 +4207,11 @@ export interface PatchCorehrJobDataResponse { job_data?: JobData } -export interface QueryCorehrEmployeesJobDataResponse { - /** 任职信息 */ - items?: EmployeeJobData[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface BatchGetCorehrEmployeesJobDataResponse { /** 查询的雇佣信息 */ items?: EmployeeJobData[] } -export interface ListCorehrJobDataResponse { - /** 查询的任职信息 */ - items?: JobData[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetCorehrJobDataResponse { /** 任职信息 */ job_data?: JobData @@ -4596,15 +4225,6 @@ export interface PatchCorehrEmployeesAdditionalJobResponse { additional_job?: EmployeesAdditionalJobWriteResp } -export interface BatchCorehrEmployeesAdditionalJobResponse { - /** 兼职记录 */ - items?: EmployeesAdditionalJob[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface QueryOperationLogsCorehrDepartmentResponse { /** 操作日志列表 */ op_logs?: OrganizationOpLog[] @@ -4644,33 +4264,6 @@ export interface QueryTimelineCorehrDepartmentResponse { items?: DepartmentTimeline[] } -export interface TreeCorehrDepartmentResponse { - /** 部门树节点 */ - items?: DepartmentTree[] - /** 下一页token */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - -export interface QueryMultiTimelineCorehrDepartmentResponse { - /** 部门信息 */ - items?: DepartmentTimeline[] - /** 下一页token */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - -export interface SearchCorehrDepartmentResponse { - /** 查询的部门信息 */ - items?: Department[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface CreateCorehrLocationResponse { location?: Location } @@ -4696,15 +4289,6 @@ export interface BatchGetCorehrLocationResponse { items?: Location[] } -export interface ListCorehrLocationResponse { - /** 查询的地点信息 */ - items?: Location[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface CreateCorehrLocationAddressResponse { /** 地址 ID */ address_id?: string @@ -4723,15 +4307,6 @@ export interface GetCorehrCompanyResponse { company?: Company } -export interface ListCorehrCompanyResponse { - /** 查询的公司信息 */ - items?: Company[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface QueryRecentChangeCorehrCompanyResponse { /** 公司 ID 列表 */ company_ids?: string[] @@ -4767,15 +4342,6 @@ export interface QueryRecentChangeCorehrCostCenterResponse { deleted_cost_center_ids?: string[] } -export interface SearchCorehrCostCenterResponse { - /** 成本中心信息 */ - items?: CostCenterVersion[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface CreateCorehrCostCenterVersionResponse { version?: CostCenterVersion } @@ -4812,15 +4378,6 @@ export interface GetCorehrJobFamilyResponse { job_family?: JobFamily } -export interface ListCorehrJobFamilyResponse { - /** 查询的职务序列信息 */ - items?: JobFamily[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface QueryRecentChangeCorehrJobFamilyResponse { /** 序列 ID 列表 */ job_family_ids?: string[] @@ -4850,15 +4407,6 @@ export interface GetCorehrJobLevelResponse { job_level?: JobLevel } -export interface ListCorehrJobLevelResponse { - /** 查询的职务级别信息 */ - items?: JobLevel[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface QueryRecentChangeCorehrJobLevelResponse { /** 职级 ID 列表 */ job_level_ids?: string[] @@ -4880,15 +4428,6 @@ export interface CreateCorehrJobGradeResponse { grade_id?: string } -export interface QueryCorehrJobGradeResponse { - /** 职等信息列表 */ - items?: JobGrade[] - /** 下一页token */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface QueryRecentChangeCorehrJobGradeResponse { /** 职等 ID 列表 */ job_grade_ids?: string[] @@ -4913,15 +4452,6 @@ export interface GetCorehrJobResponse { job?: Job } -export interface ListCorehrJobResponse { - /** 查询的职务信息 */ - items?: Job[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface WithdrawOnboardingCorehrPreHireResponse { /** 是否成功撤销入职 */ success?: boolean @@ -4942,38 +4472,11 @@ export interface PatchCorehrPreHireResponse { pre_hire_id?: string } -export interface QueryCorehrPreHireResponse { - /** 查询待入职的信息 */ - items?: PreHire[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface GetCorehrPreHireResponse { /** 待入职信息 */ pre_hire?: PreHire } -export interface ListCorehrPreHireResponse { - /** 查询的待入职信息 */ - items?: PreHireQuery[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface SearchCorehrPreHireResponse { - /** 查询的部门信息 */ - items?: PreHire[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface TransitTaskCorehrPreHireResponse { /** 是否成功流转任务 */ success?: boolean @@ -4993,15 +4496,6 @@ export interface CreateCorehrProbationAssessmentResponse { assessment_ids?: string[] } -export interface SearchCorehrProbationResponse { - /** 查询的试用期信息 */ - items?: ProbationInfo[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface SubmitCorehrProbationResponse { /** 试用期信息 */ probation_info?: ProbationInfoForSubmit @@ -5042,15 +4536,6 @@ export interface QueryCorehrTransferReasonResponse { items?: TransferReason[] } -export interface SearchCorehrJobChangeResponse { - /** 员工异动列表 */ - items?: JobChange[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface CreateCorehrJobChangeResponse { /** 异动记录 id */ job_change_id?: string @@ -5107,15 +4592,6 @@ export interface EditCorehrOffboardingResponse { data: ObjectFieldData[] } -export interface SearchCorehrOffboardingResponse { - /** 查询的员工离职信息 */ - items?: Offboarding[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface CreateCorehrContractResponse { contract?: Contract } @@ -5129,24 +4605,6 @@ export interface GetCorehrContractResponse { contract?: Contract } -export interface ListCorehrContractResponse { - /** 查询的合同信息 */ - items?: Contract[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface SearchCorehrContractResponse { - /** 查询的合同信息 */ - items?: Contract[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface ListCorehrWorkforcePlanResponse { /** 方案列表 */ items?: WorkforcePlan[] @@ -5172,33 +4630,6 @@ export interface CreateCorehrLeaveGrantingRecordResponse { leave_granting_record?: LeaveGrantingRecord } -export interface LeaveTypesCorehrLeaveResponse { - /** 假期类型列表 */ - leave_type_list?: LeaveType[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface LeaveBalancesCorehrLeaveResponse { - /** 员工假期余额信息列表 */ - employment_leave_balance_list?: EmploymentLeaveBalance[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface LeaveRequestHistoryCorehrLeaveResponse { - /** 请假记录信息列表 */ - leave_request_list?: LeaveRequest[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface WorkCalendarCorehrLeaveResponse { /** 工作日历列表 */ work_calendars?: WorkCalendarDetail[] @@ -5216,29 +4647,11 @@ export interface WorkCalendarDateCorehrLeaveResponse { calendar_dates?: WkCalendarDate[] } -export interface QueryCorehrAuthorizationResponse { - /** 查询的用户授权信息 */ - items?: RoleAuthorization[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetByParamCorehrAuthorizationResponse { /** 角色授权信息 */ role_authorization?: RoleAuthorization } -export interface ListCorehrSecurityGroupResponse { - /** 查询的用户角色信息 */ - items?: SecurityGroup[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface AddRoleAssignCorehrAuthorizationResponse { /** 授权id */ assign_id?: string @@ -5271,33 +4684,6 @@ export interface QueryCorehrSecurityGroupResponse { hrbp_list?: Hrbp[] } -export interface ListCorehrBpResponse { - /** HRBP 信息 */ - items?: Bp[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - -export interface SearchCorehrAssignedUserResponse { - /** 用户授权信息 */ - items?: RoleAuthorization[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListCorehrProcessResponse { - /** 流程实例ID列表 */ - process_ids?: string[] - /** 是否还有更多项 */ - has_more?: boolean - /** 有更多项时的分页键 */ - page_token?: string -} - export interface GetCorehrProcessResponse { /** 流程实例ID */ process_id?: string @@ -5350,15 +4736,6 @@ export interface GetCorehrProcessFormVariableDataResponse { process_id?: string } -export interface ListCorehrApproverResponse { - /** 分页键 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean - /** 审批任务列表 */ - approver_list?: ApproverInfo[] -} - export interface UpdateCorehrProcessApproverResponse { /** 错误码，非 0 表示失败 */ code: number @@ -5380,57 +4757,21 @@ export interface GetCorehrProcessFormVariableDataResponse { field_variable_values?: FormFieldVariable[] } -export interface ListCorehrSubregionResponse { - /** 城市/区域信息 */ - items?: Subregion[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetCorehrSubregionResponse { /** 城市/区域信息 */ subregion?: Subregion } -export interface ListCorehrSubdivisionResponse { - /** 省份/行政区信息 */ - items?: Subdivision[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetCorehrSubdivisionResponse { /** 国家/地址信息 */ subdivision?: Subdivision } -export interface ListCorehrCountryRegionResponse { - /** 国家/地址信息 */ - items?: CountryRegion[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetCorehrCountryRegionResponse { /** 国家/地址信息 */ country_region?: CountryRegion } -export interface ListCorehrCurrencyResponse { - /** 货币信息 */ - items?: Currency[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetCorehrCurrencyResponse { /** 货币信息 */ currency?: Currency @@ -5450,24 +4791,6 @@ export interface GetCorehrDepartmentResponse { department?: Department } -export interface ListCorehrJobResponse { - /** 查询的职务信息 */ - items?: Job[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListCorehrDepartmentResponse { - /** 查询的部门信息 */ - items?: Department[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface PatchCorehrPersonResponse { person?: Person } diff --git a/adapters/lark/src/types/document_ai.ts b/adapters/lark/src/types/document_ai.ts index b3b1136e..fbe09c41 100644 --- a/adapters/lark/src/types/document_ai.ts +++ b/adapters/lark/src/types/document_ai.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { BankCard, BankInfo, BodyInfo, BusinessLicense, ChinesePassport, DrvingLicense, ExtractCopy, ExtractCurrency, ExtractPrice, ExtractTime, FoodManageLicense, FoodProduceLicense, HealthCertificate, HkmMainlandTravelPermit, IdCard, RecognizedEntities, Resume, TaxiInvoice, TrainInvoice, TwMainlandTravelPermit, VatInvoice, VehicleInvoice, VehicleLicense } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/docx.ts b/adapters/lark/src/types/docx.ts index bf0a03bd..470c0d38 100644 --- a/adapters/lark/src/types/docx.ts +++ b/adapters/lark/src/types/docx.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -12,7 +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): Promise + listDocxChatAnnouncementBlock(chat_id: string, query?: ListDocxChatAnnouncementBlockQuery): Promise> /** * 在群公告中创建块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/create @@ -32,7 +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): Promise + getDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockChildrenQuery): Promise> /** * 删除群公告中的块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/batch_delete @@ -57,7 +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): Promise + listDocxDocumentBlock(document_id: string, query?: ListDocxDocumentBlockQuery): Promise> /** * 创建块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/create @@ -87,7 +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): Promise + getDocxDocumentBlockChildren(document_id: string, block_id: string, query?: GetDocxDocumentBlockChildrenQuery): Promise> /** * 删除块 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/batch_delete @@ -101,11 +101,7 @@ export interface GetDocxChatAnnouncementQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListDocxChatAnnouncementBlockQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListDocxChatAnnouncementBlockQuery extends Pagination { /** 查询的群公告版本，-1 表示群公告最新版本。群公告创建后，版本为 1。若查询的版本为群公告最新版本，则需要持有群公告的阅读权限；若查询的版本为群公告的历史版本，则需要持有群公告的编辑权限。 */ revision_id?: number /** 此次调用中使用的用户ID的类型 */ @@ -149,13 +145,9 @@ 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 - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -186,11 +178,7 @@ export interface RawContentDocxDocumentQuery { lang?: 0 | 1 | 2 } -export interface ListDocxDocumentBlockQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListDocxDocumentBlockQuery extends Pagination { /** 查询的文档版本，-1表示文档最新版本。若此时查询的版本为文档最新版本，则需要持有文档的阅读权限；若此时查询的版本为文档的历史版本，则需要持有文档的编辑权限。 */ document_revision_id?: number /** 此次调用中使用的用户ID的类型 */ @@ -296,13 +284,9 @@ 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 - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -340,15 +324,6 @@ export interface GetDocxChatAnnouncementResponse { announcement_type?: 'docx' | 'doc' } -export interface ListDocxChatAnnouncementBlockResponse { - /** 群公告的 Block 信息 */ - items?: Block[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface CreateDocxChatAnnouncementBlockChildrenResponse { /** 所添加的孩子的 Block 信息 */ children?: Block[] @@ -372,15 +347,6 @@ export interface GetDocxChatAnnouncementBlockResponse { block?: Block } -export interface GetDocxChatAnnouncementBlockChildrenResponse { - /** Block 的 Children 列表 */ - items?: Block[] - /** 下一个分页的分页标记 */ - page_token?: string - /** 是否还有下一个分页 */ - has_more?: boolean -} - export interface BatchDeleteDocxChatAnnouncementBlockChildrenResponse { /** 当前删除操作成功后群公告的版本号 */ revision_id?: number @@ -403,15 +369,6 @@ export interface RawContentDocxDocumentResponse { content?: string } -export interface ListDocxDocumentBlockResponse { - /** 文档的 Block 信息 */ - items?: Block[] - /** 下一个分页的分页标记 */ - page_token?: string - /** 是否还有下一个分页 */ - has_more?: boolean -} - export interface CreateDocxDocumentBlockChildrenResponse { /** 所添加的孩子的 Block 信息 */ children?: Block[] @@ -455,15 +412,6 @@ export interface BatchUpdateDocxDocumentBlockResponse { client_token: string } -export interface GetDocxDocumentBlockChildrenResponse { - /** block 的 children 列表 */ - items?: Block[] - /** 下一个分页的分页标记 */ - page_token?: string - /** 是否还有下一个分页 */ - has_more?: boolean -} - export interface BatchDeleteDocxDocumentBlockChildrenResponse { /** 当前删除操作成功后文档的版本号 */ document_revision_id?: number diff --git a/adapters/lark/src/types/drive.ts b/adapters/lark/src/types/drive.ts index a018fbe5..8b51d81a 100644 --- a/adapters/lark/src/types/drive.ts +++ b/adapters/lark/src/types/drive.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -32,7 +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): Promise + listDriveV1FileViewRecord(file_token: string, query?: ListDriveV1FileViewRecordQuery): Promise> /** * 复制文件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy @@ -142,7 +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): Promise + listDriveV1FileVersion(file_token: string, query?: ListDriveV1FileVersionQuery): Promise> /** * 获取文档版本信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get @@ -157,7 +157,7 @@ declare module '../internal' { * 获取云文档的点赞者列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/file-like/list */ - listDriveV2FileLike(file_token: string, query?: ListDriveV2FileLikeQuery): Promise + listDriveV2FileLike(file_token: string, query?: ListDriveV2FileLikeQuery): Promise> /** * 订阅云文档事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe @@ -247,7 +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): Promise + listDriveV1FileComment(file_token: string, query?: ListDriveV1FileCommentQuery): Promise> /** * 批量获取评论 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/batch_query @@ -272,7 +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): Promise + listDriveV1FileCommentReply(file_token: string, comment_id: string, query?: ListDriveV1FileCommentReplyQuery): Promise> /** * 更新回复的内容 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/update @@ -301,11 +301,7 @@ declare module '../internal' { } } -export interface ListDriveV1FileQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListDriveV1FileQuery extends Pagination { /** 文件夹的token（若不填写该参数或填写空字符串，则默认获取用户云空间下的清单，且不支持分页） */ folder_token?: string /** 排序规则 */ @@ -345,11 +341,7 @@ export interface GetDriveV1FileStatisticsQuery { file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx' } -export interface ListDriveV1FileViewRecordQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListDriveV1FileViewRecordQuery extends Pagination { /** 文档类型 */ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file' /** 此次调用中使用的访问者 ID 的类型 */ @@ -545,11 +537,7 @@ export interface CreateDriveV1FileVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListDriveV1FileVersionQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListDriveV1FileVersionQuery extends Pagination { /** 原文档类型 */ obj_type: 'docx' | 'sheet' /** 用户id类型 */ @@ -570,13 +558,9 @@ 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' - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -769,17 +753,13 @@ 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' /** 是否全文评论 */ is_whole?: boolean /** 是否已解决（可选） */ is_solved?: boolean - /** 评论分页参数 */ - page_token?: string - /** 获取满足 commen_id > page_token 的评论数量 */ - page_size?: number /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -825,11 +805,7 @@ export interface GetDriveV1FileCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListDriveV1FileCommentReplyQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListDriveV1FileCommentReplyQuery extends Pagination { /** 文档类型 */ file_type: 'doc' | 'sheet' | 'file' | 'docx' /** 此次调用中使用的用户ID的类型 */ @@ -911,15 +887,6 @@ export interface GetDriveV1FileStatisticsResponse { statistics?: FileStatistics } -export interface ListDriveV1FileViewRecordResponse { - /** 访问记录列表 */ - items?: FileViewRecord[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - export interface CopyDriveV1FileResponse { /** 复制后的文件资源 */ file?: File @@ -1022,15 +989,6 @@ export interface CreateDriveV1FileVersionResponse { parent_type?: 'docx' | 'sheet' } -export interface ListDriveV1FileVersionResponse { - /** 版本文档列表 */ - items?: Version[] - /** 下一页请求token */ - page_token?: string - /** 是否有下一页数据 */ - has_more?: boolean -} - export interface GetDriveV1FileVersionResponse { /** 版本文档标题，最大长度 1024 个Unicode 码点。通常情况下，一个英文或中文字符对应一个码点，但是某些特殊符号可能会对应多个码点。例如，家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */ name?: string @@ -1054,15 +1012,6 @@ export interface GetDriveV1FileVersionResponse { parent_type?: 'docx' | 'sheet' } -export interface ListDriveV2FileLikeResponse { - /** 文件的点赞者列表 */ - items?: FileLike[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多点赞记录 */ - has_more?: boolean -} - export interface GetSubscribeDriveV1FileResponse { /** 是否有订阅，取值 true 表示已订阅；false 表示未订阅 */ is_subscribe?: boolean @@ -1123,14 +1072,6 @@ export interface PatchDriveV2PermissionPublicResponse { permission_public?: PermissionPublic } -export interface ListDriveV1FileCommentResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的 Token */ - page_token?: string - items?: FileComment[] -} - export interface BatchQueryDriveV1FileCommentResponse { /** 评论的相关信息、回复的信息、回复分页的信息 */ items?: FileComment[] @@ -1190,12 +1131,6 @@ export interface GetDriveV1FileCommentResponse { reply_list?: ReplyList } -export interface ListDriveV1FileCommentReplyResponse { - items?: FileCommentReply[] - page_token?: string - has_more: boolean -} - export interface GetDriveV1FileSubscriptionResponse { /** 订阅关系ID */ subscription_id: string diff --git a/adapters/lark/src/types/ehr.ts b/adapters/lark/src/types/ehr.ts index e410d434..f18fbdc5 100644 --- a/adapters/lark/src/types/ehr.ts +++ b/adapters/lark/src/types/ehr.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Employee } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,7 +7,7 @@ declare module '../internal' { * 批量获取员工花名册信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list */ - listEhrEmployee(query?: ListEhrEmployeeQuery): Promise + listEhrEmployee(query?: ListEhrEmployeeQuery): Promise> /** * 下载人员的附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/attachment/get @@ -16,7 +16,7 @@ declare module '../internal' { } } -export interface ListEhrEmployeeQuery { +export interface ListEhrEmployeeQuery extends Pagination { /** 返回数据类型 */ view?: 'basic' | 'full' /** 员工状态，不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录，如 status=2&status=4 */ @@ -31,18 +31,6 @@ export interface ListEhrEmployeeQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' /** user_id、open_id 或 union_id，默认为 open_id。如果传入的值不是 open_id，需要一并传入 user_id_type 参数。可一次查询多个 id 的用户，例如：user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ user_ids?: string[] - /** 分页标记，第一次请求可以不填，表示从头开始遍历；分页查询返回结果has_more 为 true 时会同时返回新的 page_token, 下次遍历可使用该返回的 page_token 获取更多信息。 */ - page_token?: string - /** 分页大小，取值范围 1~100，默认 10 */ - page_size?: number -} - -export interface ListEhrEmployeeResponse { - items?: Employee[] - /** 下次请求需要带上的分页标记 */ - page_token?: string - /** 是否有下一页数据 */ - has_more?: boolean } Internal.define({ diff --git a/adapters/lark/src/types/event.ts b/adapters/lark/src/types/event.ts index da44c9c8..900f75c1 100644 --- a/adapters/lark/src/types/event.ts +++ b/adapters/lark/src/types/event.ts @@ -1,4 +1,4 @@ -import { Internal } from '../internal' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -6,24 +6,11 @@ declare module '../internal' { * 获取事件出口 IP * @see https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list */ - listEventOutboundIp(query?: ListEventOutboundIpQuery): Promise + listEventOutboundIp(query?: ListEventOutboundIpQuery): Promise> } } -export interface ListEventOutboundIpQuery { - /** 分页大小，默认10，取值范围 10-50 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} - -export interface ListEventOutboundIpResponse { - /** outbound ip */ - ip_list?: string[] - /** 分页下次调用的page_token值 */ - page_token?: string - /** 是否还有分页数据 */ - has_more?: boolean +export interface ListEventOutboundIpQuery extends Pagination { } Internal.define({ diff --git a/adapters/lark/src/types/helpdesk.ts b/adapters/lark/src/types/helpdesk.ts index 35e06099..fb6341f5 100644 --- a/adapters/lark/src/types/helpdesk.ts +++ b/adapters/lark/src/types/helpdesk.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -177,7 +177,7 @@ declare module '../internal' { * 搜索知识库 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/search */ - searchHelpdeskFaq(query?: SearchHelpdeskFaqQuery): Promise + searchHelpdeskFaq(query?: SearchHelpdeskFaqQuery): Promise> /** * 创建知识库分类 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/create @@ -451,11 +451,7 @@ export interface ListHelpdeskTicketCustomizedFieldRequest { visible?: boolean } -export interface ListHelpdeskTicketCustomizedFieldQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface ListHelpdeskTicketCustomizedFieldQuery extends Pagination { } export interface CreateHelpdeskFaqRequest { @@ -468,28 +464,20 @@ export interface PatchHelpdeskFaqRequest { faq?: FaqUpdateInfo } -export interface ListHelpdeskFaqQuery { +export interface ListHelpdeskFaqQuery extends Pagination { /** 知识库分类ID */ category_id?: string /** 搜索条件: 知识库状态 1:在线 0:删除，可恢复 2：删除，不可恢复 */ status?: string /** 搜索条件: 关键词，匹配问题标题，问题关键字，用户姓名 */ search?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } -export interface SearchHelpdeskFaqQuery { +export interface SearchHelpdeskFaqQuery extends Pagination { /** 搜索query，query内容如果不是英文，包含中文空格等有两种编码策略：1. url编码 2. base64编码，同时加上base64=true参数 */ query: string /** 是否转换为base64,输入true表示是，不填写表示否，中文需要转换为base64 */ base64?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface CreateHelpdeskCategoryRequest { @@ -780,14 +768,6 @@ export interface ListHelpdeskFaqResponse { items?: Faq[] } -export interface SearchHelpdeskFaqResponse { - /** if there's next page */ - has_more?: boolean - /** the next page token */ - page_token?: string - items?: Faq[] -} - export interface CreateHelpdeskCategoryResponse { /** category */ category?: Category diff --git a/adapters/lark/src/types/hire.ts b/adapters/lark/src/types/hire.ts index 8dd4e812..3dfb41b0 100644 --- a/adapters/lark/src/types/hire.ts +++ b/adapters/lark/src/types/hire.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, InterviewExtend, InterviewFeedbackForm, InterviewRecord, InterviewRegistrationSchema, InterviewRoundType, InterviewTask, Interviewer, 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,12 +7,12 @@ declare module '../internal' { * 查询地点列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query */ - queryHireLocation(body: QueryHireLocationRequest, query?: QueryHireLocationQuery): Promise + queryHireLocation(body: QueryHireLocationRequest, query?: QueryHireLocationQuery): Promise> /** * 获取地址列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/list */ - listHireLocation(query?: ListHireLocationQuery): Promise + listHireLocation(query?: ListHireLocationQuery): Promise> /** * 获取角色详情 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/get @@ -22,12 +22,12 @@ declare module '../internal' { * 获取角色列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/list */ - listHireRole(query?: ListHireRoleQuery): Promise + listHireRole(query?: ListHireRoleQuery): Promise> /** * 获取用户角色列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/user_role/list */ - listHireUserRole(query?: ListHireUserRoleQuery): Promise + listHireUserRole(query?: ListHireUserRoleQuery): Promise> /** * 新建职位 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_create @@ -72,7 +72,7 @@ declare module '../internal' { * 获取职位列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/list */ - listHireJob(query?: ListHireJobQuery): Promise + listHireJob(query?: ListHireJobQuery): Promise> /** * 关闭职位 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/close @@ -87,7 +87,7 @@ declare module '../internal' { * 获取职位模板 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_schema/list */ - listHireJobSchema(query?: ListHireJobSchemaQuery): Promise + listHireJobSchema(query?: ListHireJobSchemaQuery): Promise> /** * 发布职位广告 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/advertisement/publish @@ -97,17 +97,17 @@ declare module '../internal' { * 获取职位广告发布记录 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_publish_record/search */ - searchHireJobPublishRecord(body: SearchHireJobPublishRecordRequest, query?: SearchHireJobPublishRecordQuery): Promise + searchHireJobPublishRecord(body: SearchHireJobPublishRecordRequest, query?: SearchHireJobPublishRecordQuery): Promise> /** * 获取职能分类列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_function/list */ - listHireJobFunction(query?: ListHireJobFunctionQuery): Promise + listHireJobFunction(query?: ListHireJobFunctionQuery): Promise> /** * 获取职位类别列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_type/list */ - listHireJobType(query?: ListHireJobTypeQuery): Promise + listHireJobType(query?: ListHireJobTypeQuery): Promise> /** * 创建招聘需求 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/create @@ -127,7 +127,7 @@ declare module '../internal' { * 获取招聘需求列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list */ - listHireJobRequirement(query?: ListHireJobRequirementQuery): Promise + listHireJobRequirement(query?: ListHireJobRequirementQuery): Promise> /** * 删除招聘需求 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/delete @@ -137,32 +137,32 @@ declare module '../internal' { * 获取招聘需求模板列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement_schema/list */ - listHireJobRequirementSchema(query?: ListHireJobRequirementSchemaQuery): Promise + listHireJobRequirementSchema(query?: ListHireJobRequirementSchemaQuery): Promise> /** * 获取招聘流程信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list */ - listHireJobProcess(query?: ListHireJobProcessQuery): Promise + listHireJobProcess(query?: ListHireJobProcessQuery): Promise> /** * 获取项目列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/subject/list */ - listHireSubject(query?: ListHireSubjectQuery): Promise + listHireSubject(query?: ListHireSubjectQuery): Promise> /** * 获取人才标签信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list */ - listHireTalentTag(query?: ListHireTalentTagQuery): Promise + listHireTalentTag(query?: ListHireTalentTagQuery): Promise> /** * 获取信息登记表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/registration_schema/list */ - listHireRegistrationSchema(query?: ListHireRegistrationSchemaQuery): Promise + listHireRegistrationSchema(query?: ListHireRegistrationSchemaQuery): Promise> /** * 获取面试评价表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_feedback_form/list */ - listHireInterviewFeedbackForm(query?: ListHireInterviewFeedbackFormQuery): Promise + listHireInterviewFeedbackForm(query?: ListHireInterviewFeedbackFormQuery): Promise> /** * 获取面试轮次类型列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_round_type/list @@ -172,12 +172,12 @@ declare module '../internal' { * 获取面试登记表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_registration_schema/list */ - listHireInterviewRegistrationSchema(query?: ListHireInterviewRegistrationSchemaQuery): Promise + listHireInterviewRegistrationSchema(query?: ListHireInterviewRegistrationSchemaQuery): Promise> /** * 查询面试官信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/list */ - listHireInterviewer(query?: ListHireInterviewerQuery): Promise + listHireInterviewer(query?: ListHireInterviewerQuery): Promise> /** * 更新面试官信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/patch @@ -197,7 +197,7 @@ declare module '../internal' { * 获取 Offer 申请表列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_application_form/list */ - listHireOfferApplicationForm(query?: ListHireOfferApplicationFormQuery): Promise + listHireOfferApplicationForm(query?: ListHireOfferApplicationFormQuery): Promise> /** * 查询人才内推信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral/search @@ -207,7 +207,7 @@ declare module '../internal' { * 获取内推官网下职位广告列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/list */ - listHireReferralWebsiteJobPost(query?: ListHireReferralWebsiteJobPostQuery): Promise + listHireReferralWebsiteJobPost(query?: ListHireReferralWebsiteJobPostQuery): Promise> /** * 获取内推官网下职位广告详情 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/get @@ -237,7 +237,7 @@ declare module '../internal' { * 获取招聘官网推广渠道列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list */ - listHireWebsiteChannel(website_id: string, query?: ListHireWebsiteChannelQuery): Promise + listHireWebsiteChannel(website_id: string, query?: ListHireWebsiteChannelQuery): Promise> /** * 新建招聘官网用户 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-site_user/create @@ -252,12 +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): Promise + searchHireWebsiteJobPost(website_id: string, body: SearchHireWebsiteJobPostRequest, query?: SearchHireWebsiteJobPostQuery): Promise> /** * 获取招聘官网下的职位广告列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/list */ - listHireWebsiteJobPost(website_id: string, query?: ListHireWebsiteJobPostQuery): Promise + listHireWebsiteJobPost(website_id: string, query?: ListHireWebsiteJobPostQuery): Promise> /** * 新建招聘官网投递 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume @@ -277,7 +277,7 @@ declare module '../internal' { * 获取招聘官网列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list */ - listHireWebsite(query?: ListHireWebsiteQuery): Promise + listHireWebsite(query?: ListHireWebsiteQuery): Promise> /** * 设置猎头保护期 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/protect @@ -302,12 +302,12 @@ declare module '../internal' { * 查询猎头供应商下猎头列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/get_agency_account */ - getAgencyAccountHireAgency(body: GetAgencyAccountHireAgencyRequest, query?: GetAgencyAccountHireAgencyQuery): Promise + getAgencyAccountHireAgency(body: GetAgencyAccountHireAgencyRequest, query?: GetAgencyAccountHireAgencyQuery): Promise> /** * 搜索猎头供应商列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/batch_query */ - batchQueryHireAgency(body: BatchQueryHireAgencyRequest, query?: BatchQueryHireAgencyQuery): Promise + batchQueryHireAgency(body: BatchQueryHireAgencyRequest, query?: BatchQueryHireAgencyQuery): Promise> /** * 禁用/取消禁用猎头 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/operate_agency_account @@ -337,7 +337,7 @@ declare module '../internal' { * 查询外部投递列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/list */ - listHireExternalApplication(query?: ListHireExternalApplicationQuery): Promise + listHireExternalApplication(query?: ListHireExternalApplicationQuery): Promise> /** * 删除外部投递 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/delete @@ -357,7 +357,7 @@ declare module '../internal' { * 查询外部面试列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/batch_query */ - batchQueryHireExternalInterview(body: BatchQueryHireExternalInterviewRequest, query?: BatchQueryHireExternalInterviewQuery): Promise + batchQueryHireExternalInterview(body: BatchQueryHireExternalInterviewRequest, query?: BatchQueryHireExternalInterviewQuery): Promise> /** * 删除外部面试 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/delete @@ -387,7 +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): Promise + batchQueryHireExternalOffer(body: BatchQueryHireExternalOfferRequest, query?: BatchQueryHireExternalOfferQuery): Promise> /** * 删除外部 Offer * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/delete @@ -407,7 +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): Promise + batchQueryHireExternalBackgroundCheck(body: BatchQueryHireExternalBackgroundCheckRequest, query?: BatchQueryHireExternalBackgroundCheckQuery): Promise> /** * 删除外部背调 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/delete @@ -432,7 +432,7 @@ declare module '../internal' { * 获取人才库列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/search */ - searchHireTalentPool(query?: SearchHireTalentPoolQuery): Promise + searchHireTalentPool(query?: SearchHireTalentPoolQuery): Promise> /** * 将人才加入人才库 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/move_talent @@ -467,7 +467,7 @@ declare module '../internal' { * 获取人才文件夹列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_folder/list */ - listHireTalentFolder(query?: ListHireTalentFolderQuery): Promise + listHireTalentFolder(query?: ListHireTalentFolderQuery): Promise> /** * 批量获取人才ID * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/batch_get_id @@ -477,7 +477,7 @@ declare module '../internal' { * 获取人才列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/list */ - listHireTalent(query?: ListHireTalentQuery): Promise + listHireTalent(query?: ListHireTalentQuery): Promise> /** * 获取人才字段 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query @@ -532,7 +532,7 @@ declare module '../internal' { * 获取终止投递原因 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/termination_reason/list */ - listHireTerminationReason(query?: ListHireTerminationReasonQuery): Promise + listHireTerminationReason(query?: ListHireTerminationReasonQuery): Promise> /** * 获取投递信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get @@ -542,7 +542,7 @@ declare module '../internal' { * 获取投递列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list */ - listHireApplication(query?: ListHireApplicationQuery): Promise + listHireApplication(query?: ListHireApplicationQuery): Promise> /** * 获取申请表附加信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/diversity_inclusion/search @@ -552,7 +552,7 @@ declare module '../internal' { * 获取简历评估信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation/list */ - listHireEvaluation(query?: ListHireEvaluationQuery): Promise + listHireEvaluation(query?: ListHireEvaluationQuery): Promise> /** * 添加笔试结果 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam/create @@ -562,12 +562,12 @@ declare module '../internal' { * 获取笔试列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/test/search */ - searchHireTest(body: SearchHireTestRequest, query?: SearchHireTestQuery): Promise + searchHireTest(body: SearchHireTestRequest, query?: SearchHireTestQuery): Promise> /** * 获取面试信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/list */ - listHireInterview(query?: ListHireInterviewQuery): Promise + listHireInterview(query?: ListHireInterviewQuery): Promise> /** * 获取人才面试信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/get_by_talent @@ -587,12 +587,12 @@ declare module '../internal' { * 批量获取面试评价详细信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record/list */ - listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Promise + listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Promise> /** * 批量获取面试评价详细信息（新版） * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/interview_record/list */ - listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Promise + listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Promise> /** * 获取面试记录附件 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record-attachment/get @@ -607,7 +607,7 @@ declare module '../internal' { * 获取面试满意度问卷列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/questionnaire/list */ - listHireQuestionnaire(query?: ListHireQuestionnaireQuery): Promise + listHireQuestionnaire(query?: ListHireQuestionnaireQuery): Promise> /** * 创建 Offer * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/create @@ -632,7 +632,7 @@ declare module '../internal' { * 获取 Offer 列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/list */ - listHireOffer(query?: ListHireOfferQuery): Promise + listHireOffer(query?: ListHireOfferQuery): Promise> /** * 更新 Offer 状态 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/offer_status @@ -647,7 +647,7 @@ declare module '../internal' { * 获取背调信息列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/background_check_order/list */ - listHireBackgroundCheckOrder(query?: ListHireBackgroundCheckOrderQuery): Promise + listHireBackgroundCheckOrder(query?: ListHireBackgroundCheckOrderQuery): Promise> /** * 创建三方协议 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/create @@ -657,7 +657,7 @@ declare module '../internal' { * 获取三方协议 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/list */ - listHireTripartiteAgreement(query?: ListHireTripartiteAgreementQuery): Promise + listHireTripartiteAgreement(query?: ListHireTripartiteAgreementQuery): Promise> /** * 更新三方协议 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/update @@ -697,22 +697,22 @@ declare module '../internal' { * 批量获取待办事项 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/todo/list */ - listHireTodo(query?: ListHireTodoQuery): Promise + listHireTodo(query?: ListHireTodoQuery): Promise> /** * 获取简历评估任务列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation_task/list */ - listHireEvaluationTask(query?: ListHireEvaluationTaskQuery): Promise + listHireEvaluationTask(query?: ListHireEvaluationTaskQuery): Promise> /** * 获取笔试阅卷任务列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam_marking_task/list */ - listHireExamMarkingTask(query?: ListHireExamMarkingTaskQuery): Promise + listHireExamMarkingTask(query?: ListHireExamMarkingTaskQuery): Promise> /** * 获取面试任务列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_task/list */ - listHireInterviewTask(query?: ListHireInterviewTaskQuery): Promise + listHireInterviewTask(query?: ListHireInterviewTaskQuery): Promise> /** * 创建备注 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/create @@ -732,7 +732,7 @@ declare module '../internal' { * 获取备注列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/list */ - listHireNote(query?: ListHireNoteQuery): Promise + listHireNote(query?: ListHireNoteQuery): Promise> /** * 删除备注 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/delete @@ -742,7 +742,7 @@ declare module '../internal' { * 获取简历来源列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/resume_source/list */ - listHireResumeSource(query?: ListHireResumeSourceQuery): Promise + listHireResumeSource(query?: ListHireResumeSourceQuery): Promise> /** * 创建账号自定义字段 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/create @@ -877,12 +877,12 @@ declare module '../internal' { * 获取面试记录列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application-interview/list */ - listHireApplicationInterview(application_id: string, query?: ListHireApplicationInterviewQuery): Promise + listHireApplicationInterview(application_id: string, query?: ListHireApplicationInterviewQuery): Promise> /** * 查询人才操作记录 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/talent_operation_log/search */ - searchHireTalentOperationLog(body: SearchHireTalentOperationLogRequest, query?: SearchHireTalentOperationLogQuery): Promise + searchHireTalentOperationLog(body: SearchHireTalentOperationLogRequest, query?: SearchHireTalentOperationLogQuery): Promise> /** * 获取职位上的招聘人员信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job-manager/get @@ -903,34 +903,18 @@ export interface QueryHireLocationRequest { location_type: 1 | 2 | 3 | 4 } -export interface QueryHireLocationQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 每页限制, 数据校验规则 1-100 */ - page_size: number +export interface QueryHireLocationQuery extends Pagination { } -export interface ListHireLocationQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireLocationQuery extends Pagination { /** 地址类型 */ usage: 'position_location' | 'interview_location' | 'store_location' } -export interface ListHireRoleQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量 */ - page_size?: number +export interface ListHireRoleQuery extends Pagination { } -export interface ListHireUserRoleQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大10 */ - page_size?: number +export interface ListHireUserRoleQuery extends Pagination { /** 用户 ID */ user_id?: string /** 角色 ID */ @@ -1169,15 +1153,11 @@ 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 /** 最晚更新时间，毫秒级时间戳 */ update_end_time?: string - /** 分页大小, 不能超过 20 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1195,11 +1175,7 @@ export interface OpenHireJobRequest { is_never_expired: boolean } -export interface ListHireJobSchemaQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireJobSchemaQuery extends Pagination { /** 职位模板类型 */ scenario?: 1 | 2 } @@ -1214,11 +1190,7 @@ export interface SearchHireJobPublishRecordRequest { job_channel_id: string } -export interface SearchHireJobPublishRecordQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface SearchHireJobPublishRecordQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1229,18 +1201,10 @@ export interface SearchHireJobPublishRecordQuery { job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' } -export interface ListHireJobFunctionQuery { - /** 分页大小, 不能超过 50 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireJobFunctionQuery extends Pagination { } -export interface ListHireJobTypeQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireJobTypeQuery extends Pagination { } export interface CreateHireJobRequirementRequest { @@ -1405,11 +1369,7 @@ export interface ListByIdHireJobRequirementQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireJobRequirementQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireJobRequirementQuery extends Pagination { /** 职位ID */ job_id?: string /** 起始创建时间，传入毫秒级时间戳 */ @@ -1432,32 +1392,20 @@ export interface ListHireJobRequirementQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireJobRequirementSchemaQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireJobRequirementSchemaQuery extends Pagination { } -export interface ListHireJobProcessQuery { - /** 分页大小, 不能超过 100 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireJobProcessQuery extends Pagination { } -export interface ListHireSubjectQuery { +export interface ListHireSubjectQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 项目ID列表 */ subject_ids?: string[] - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number } -export interface ListHireTalentTagQuery { +export interface ListHireTalentTagQuery extends Pagination { /** 搜索关键词 */ keyword?: string /** ID 列表 */ @@ -1466,28 +1414,16 @@ export interface ListHireTalentTagQuery { type?: 1 | 2 /** 包含停用 */ include_inactive?: boolean - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } -export interface ListHireRegistrationSchemaQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireRegistrationSchemaQuery extends Pagination { /** 登记表适用场景；不填表示获取全部类型信息登记表 */ scenario?: 5 | 6 | 14 } -export interface ListHireInterviewFeedbackFormQuery { +export interface ListHireInterviewFeedbackFormQuery extends Pagination { /** 面试评价表ID列表, 如果使用此字段则会忽略其他参数 */ interview_feedback_form_ids?: string[] - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface ListHireInterviewRoundTypeQuery { @@ -1495,18 +1431,10 @@ export interface ListHireInterviewRoundTypeQuery { process_type?: 1 | 2 } -export interface ListHireInterviewRegistrationSchemaQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireInterviewRegistrationSchemaQuery extends Pagination { } -export interface ListHireInterviewerQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireInterviewerQuery extends Pagination { /** 面试官userID列表 */ user_ids?: string[] /** 认证状态 */ @@ -1536,11 +1464,7 @@ export interface UpdateHireOfferCustomFieldRequest { config?: OfferCustomFieldConfig } -export interface ListHireOfferApplicationFormQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireOfferApplicationFormQuery extends Pagination { } export interface SearchHireReferralRequest { @@ -1557,13 +1481,9 @@ export interface SearchHireReferralQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListHireReferralWebsiteJobPostQuery { +export interface ListHireReferralWebsiteJobPostQuery extends Pagination { /** 招聘流程类型 */ process_type?: 1 | 2 - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大10 */ - page_size?: number /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1598,11 +1518,7 @@ export interface UpdateHireWebsiteChannelRequest { channel_name: string } -export interface ListHireWebsiteChannelQuery { - /** 每页获取记录最大数量，最大100 */ - page_size?: string - /** 页码标识，获取第一页传空，每次查询会返回下一页的 page_token */ - page_token?: string +export interface ListHireWebsiteChannelQuery extends Pagination { } export interface CreateHireWebsiteSiteUserRequest { @@ -1648,11 +1564,7 @@ export interface SearchHireWebsiteJobPostRequest { create_end_time?: string } -export interface SearchHireWebsiteJobPostQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大10 */ - page_size?: number +export interface SearchHireWebsiteJobPostQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1661,11 +1573,7 @@ export interface SearchHireWebsiteJobPostQuery { job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' } -export interface ListHireWebsiteJobPostQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大10 */ - page_size?: number +export interface ListHireWebsiteJobPostQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1721,11 +1629,7 @@ export interface CreateByAttachmentHireWebsiteDeliveryRequest { identification?: WebsiteDeliveryAttachmentIndentification } -export interface ListHireWebsiteQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大10 */ - page_size?: number +export interface ListHireWebsiteQuery extends Pagination { } export interface ProtectHireAgencyRequest { @@ -1778,13 +1682,9 @@ export interface GetAgencyAccountHireAgencyRequest { role?: 0 | 1 } -export interface GetAgencyAccountHireAgencyQuery { +export interface GetAgencyAccountHireAgencyQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'union_id' | 'open_id' - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量 */ - page_size?: number } export interface BatchQueryHireAgencyRequest { @@ -1796,13 +1696,9 @@ export interface BatchQueryHireAgencyRequest { filter_list?: CommonFilter[] } -export interface BatchQueryHireAgencyQuery { +export interface BatchQueryHireAgencyQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量 */ - page_size?: number } export interface OperateAgencyAccountHireAgencyRequest { @@ -1870,13 +1766,9 @@ export interface UpdateHireExternalApplicationRequest { termination_type?: string } -export interface ListHireExternalApplicationQuery { +export interface ListHireExternalApplicationQuery extends Pagination { /** 人才ID */ talent_id: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface DeleteHireExternalApplicationQuery { @@ -1917,13 +1809,9 @@ export interface BatchQueryHireExternalInterviewRequest { external_interview_id_list?: string[] } -export interface BatchQueryHireExternalInterviewQuery { +export interface BatchQueryHireExternalInterviewQuery extends Pagination { /** 外部投递 ID */ external_application_id?: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface CreateHireExternalInterviewAssessmentRequest { @@ -1985,13 +1873,9 @@ export interface BatchQueryHireExternalOfferRequest { external_offer_id_list?: string[] } -export interface BatchQueryHireExternalOfferQuery { +export interface BatchQueryHireExternalOfferQuery extends Pagination { /** 外部投递 ID */ external_application_id?: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface CreateHireExternalBackgroundCheckRequest { @@ -2027,13 +1911,9 @@ export interface BatchQueryHireExternalBackgroundCheckRequest { external_background_check_id_list?: string[] } -export interface BatchQueryHireExternalBackgroundCheckQuery { +export interface BatchQueryHireExternalBackgroundCheckQuery extends Pagination { /** 外部投递 ID */ external_application_id?: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface CreateHireExternalReferralRewardRequest { @@ -2087,11 +1967,7 @@ export interface BatchChangeTalentPoolHireTalentPoolRequest { option_type: 1 | 2 } -export interface SearchHireTalentPoolQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchHireTalentPoolQuery extends Pagination { /** 人才库ID列表 */ id_list?: string[] } @@ -2208,11 +2084,7 @@ export interface RemoveToFolderHireTalentRequest { folder_id: string } -export interface ListHireTalentFolderQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireTalentFolderQuery extends Pagination { /** 用户ID类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } @@ -2230,19 +2102,15 @@ export interface BatchGetIdHireTalentRequest { identification_number_list?: string[] } -export interface ListHireTalentQuery { +export interface ListHireTalentQuery extends Pagination { /** 搜索关键词，支持布尔语言（使用 and、or、not 连接关键词） */ keyword?: string /** 最早更新时间，毫秒级时间戳 */ update_start_time?: string /** 最晚更新时间，毫秒级时间戳 */ update_end_time?: string - /** 分页大小, 不能超过 20 */ - page_size?: number /** 排序规则 */ sort_by?: 1 | 2 | 3 | 4 - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' /** 请求控制参数 */ @@ -2324,11 +2192,7 @@ export interface TransferStageHireApplicationRequest { stage_id: string } -export interface ListHireTerminationReasonQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大10 */ - page_size?: number +export interface ListHireTerminationReasonQuery extends Pagination { } export interface GetHireApplicationQuery { @@ -2338,7 +2202,7 @@ export interface GetHireApplicationQuery { options?: 'get_latest_application_on_chain'[] } -export interface ListHireApplicationQuery { +export interface ListHireApplicationQuery extends Pagination { /** 按流程过滤，招聘流程 ID，枚举值通过接口「获取招聘流程信息」接口获取 */ process_id?: string /** 按招聘阶段过滤，招聘阶段 ID，枚举值通过「获取招聘流程信息」接口获取 */ @@ -2351,10 +2215,6 @@ export interface ListHireApplicationQuery { job_id?: string /** 锁定状态 */ lock_status?: 1 | 2 | 3[] - /** 查询游标, 由上一页结果返回, 第一页不传 */ - page_token?: string - /** 每页限制, 每页最大不超过100 */ - page_size?: number /** 最早更新时间，毫秒级时间戳 */ update_start_time?: string /** 最晚更新时间，毫秒级时间戳 */ @@ -2368,11 +2228,7 @@ export interface SearchHireDiversityInclusionRequest { application_ids?: string[] } -export interface ListHireEvaluationQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireEvaluationQuery extends Pagination { /** 投递 ID */ application_id?: string /** 最早更新时间，毫秒级时间戳 */ @@ -2410,20 +2266,12 @@ export interface SearchHireTestRequest { test_start_time_max?: string } -export interface SearchHireTestQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface SearchHireTestQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListHireInterviewQuery { - /** 分页大小，不能超过 100 */ - page_size?: number - /** 查询游标, 由上一页结果返回, 第一页不传 */ - page_token?: string +export interface ListHireInterviewQuery extends Pagination { /** 投递 ID */ application_id?: string /** 面试 ID */ @@ -2457,24 +2305,16 @@ export interface GetHireInterviewRecordQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListHireInterviewRecordQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +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[] - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -2488,20 +2328,12 @@ export interface GetHireInterviewRecordAttachmentQuery { language?: 1 | 2 } -export interface GetHireMinutesQuery { +export interface GetHireMinutesQuery extends Pagination { /** 面试ID */ interview_id: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token获取查询结果 */ - page_token?: string - /** 分页大小，表示本次请求获取的速记中的语句的最大数量 */ - page_size?: number } -export interface ListHireQuestionnaireQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireQuestionnaireQuery extends Pagination { /** 投递 ID */ application_id?: string /** 面试 ID */ @@ -2590,11 +2422,7 @@ export interface GetHireOfferQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireOfferQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface ListHireOfferQuery extends Pagination { /** 人才 ID */ talent_id: string /** 此次调用中使用的用户ID的类型 */ @@ -2623,13 +2451,9 @@ export interface InternOfferStatusHireOfferRequest { offboarding_info?: InternOfferOffboardingInfo } -export interface ListHireBackgroundCheckOrderQuery { +export interface ListHireBackgroundCheckOrderQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number /** 投递 ID */ application_id?: string /** 最早更新时间，毫秒级时间戳 */ @@ -2647,11 +2471,7 @@ export interface CreateHireTripartiteAgreementRequest { create_time: string } -export interface ListHireTripartiteAgreementQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireTripartiteAgreementQuery extends Pagination { /** 投递 ID，必填投递 id 与三方协议 ID 其中之一 */ application_id?: string /** 三方协议 ID，必填投递 id 与三方协议 ID 其中之一 */ @@ -2758,11 +2578,7 @@ export interface GetHireEmployeeQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } -export interface ListHireTodoQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: string +export interface ListHireTodoQuery extends Pagination { /** 用户 ID，当 token 为租户 token 时，必须传入该字段，当 token 为用户 token 时，不传该字段 */ user_id?: string /** 用户 ID 类型 */ @@ -2771,11 +2587,7 @@ export interface ListHireTodoQuery { type: 'evaluation' | 'offer' | 'exam' | 'interview' } -export interface ListHireEvaluationTaskQuery { - /** 分页大小, 默认10，不能超过 20 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireEvaluationTaskQuery extends Pagination { /** 用户 ID */ user_id: string /** 任务状态 */ @@ -2784,11 +2596,7 @@ export interface ListHireEvaluationTaskQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireExamMarkingTaskQuery { - /** 分页大小, 默认10，不能超过 20 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireExamMarkingTaskQuery extends Pagination { /** 用户 ID */ user_id: string /** 任务状态 */ @@ -2797,11 +2605,7 @@ export interface ListHireExamMarkingTaskQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireInterviewTaskQuery { - /** 分页大小, 默认10，不能超过 20 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireInterviewTaskQuery extends Pagination { /** 用户 ID */ user_id: string /** 任务状态 */ @@ -2853,22 +2657,14 @@ export interface GetHireNoteQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireNoteQuery { - /** 每页限制, 每页最大不超过100 */ - page_size?: number - /** 查询游标, 由上一页结果返回, 第一页不传 */ - page_token?: string +export interface ListHireNoteQuery extends Pagination { /** 人才ID */ talent_id: string /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListHireResumeSourceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireResumeSourceQuery extends Pagination { } export interface CreateHireEcoAccountCustomFieldRequest { @@ -3071,11 +2867,7 @@ export interface GetHireAttachmentQuery { type?: 1 | 2 | 3 } -export interface ListHireApplicationInterviewQuery { - /** 分页大小，不能超过 50 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListHireApplicationInterviewQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' /** 此次调用中使用的「职级 ID」的类型 */ @@ -3091,11 +2883,7 @@ export interface SearchHireTalentOperationLogRequest { operation_list: number[] } -export interface SearchHireTalentOperationLogQuery { - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number +export interface SearchHireTalentOperationLogQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -3105,47 +2893,11 @@ export interface GetHireJobManagerQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface QueryHireLocationResponse { - /** 地址数据列表 */ - items?: LocationDto[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token,否则不返回 page_token */ - page_token?: string -} - -export interface ListHireLocationResponse { - /** 列表 */ - items?: Location[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetHireRoleResponse { /** 角色详情 */ role?: RoleDetail } -export interface ListHireRoleResponse { - /** 角色列表 */ - items?: Role[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListHireUserRoleResponse { - /** 用户角色列表 */ - items?: UserRole[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface CombinedCreateHireJobResponse { /** 职位广告 */ default_job_post?: CombinedJobResultDefaultJobPost @@ -3202,49 +2954,6 @@ export interface ConfigHireJobResponse { job_config?: JobConfigResult } -export interface ListHireJobResponse { - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 列表 */ - items?: Job[] -} - -export interface ListHireJobSchemaResponse { - /** 数据列表 */ - items?: JobSchema[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface SearchHireJobPublishRecordResponse { - /** 列表 */ - items?: WebsiteJobPost[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListHireJobFunctionResponse { - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 列表 */ - items?: JobFunction[] -} - -export interface ListHireJobTypeResponse { - /** 职位类别列表 */ - items?: JobTypeInfo[] - page_token?: string - has_more?: boolean -} - export interface CreateHireJobRequirementResponse { job_requirement?: JobRequirementDto } @@ -3254,66 +2963,6 @@ export interface ListByIdHireJobRequirementResponse { items?: JobRequirementDto[] } -export interface ListHireJobRequirementResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** 查询的招聘需求信息 */ - items?: JobRequirementDto[] -} - -export interface ListHireJobRequirementSchemaResponse { - /** 列表 */ - items?: JobRequirementSchema[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListHireJobProcessResponse { - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 列表 */ - items?: JobProcesses[] -} - -export interface ListHireSubjectResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** 项目列表 */ - items?: Subject[] -} - -export interface ListHireTalentTagResponse { - /** 标签列表 */ - items?: TalentTag[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - -export interface ListHireRegistrationSchemaResponse { - /** 信息登记表列表 */ - items?: RegistrationSchema[] - /** 分页标记 */ - page_token?: string - /** 是否仍有数据 */ - has_more?: boolean -} - -export interface ListHireInterviewFeedbackFormResponse { - items?: InterviewFeedbackForm[] - page_token?: string - has_more?: boolean -} - export interface ListHireInterviewRoundTypeResponse { /** 是否启用面试轮次类型 */ active_status?: 1 | 2 @@ -3321,21 +2970,6 @@ export interface ListHireInterviewRoundTypeResponse { items?: InterviewRoundType[] } -export interface ListHireInterviewRegistrationSchemaResponse { - /** 列表 */ - items?: InterviewRegistrationSchema[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListHireInterviewerResponse { - items?: Interviewer[] - page_token?: string - has_more?: boolean -} - export interface PatchHireInterviewerResponse { /** 面试官信息 */ interviewer?: Interviewer @@ -3346,29 +2980,11 @@ export interface GetHireOfferApplicationFormResponse { offer_apply_form?: OfferApplyFormInfo } -export interface ListHireOfferApplicationFormResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** Offer 申请表列表 */ - items?: OfferApplyForm[] -} - export interface SearchHireReferralResponse { /** 内推信息列表 */ items?: ReferralInfo[] } -export interface ListHireReferralWebsiteJobPostResponse { - /** 列表 */ - items?: PortalJobPost[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetHireReferralWebsiteJobPostResponse { job_post?: PortalJobPost } @@ -3400,15 +3016,6 @@ export interface UpdateHireWebsiteChannelResponse { code?: string } -export interface ListHireWebsiteChannelResponse { - /** 是否有更多数据 */ - has_more?: boolean - /** 分页token */ - page_token?: string - /** 官网推广渠道列表 */ - website_channel_list?: WebsiteChannelInfo[] -} - export interface CreateHireWebsiteSiteUserResponse { site_user?: WebsiteUser } @@ -3417,24 +3024,6 @@ export interface GetHireWebsiteJobPostResponse { job_post?: WebsiteJobPost } -export interface SearchHireWebsiteJobPostResponse { - /** 列表 */ - items?: WebsiteJobPost[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListHireWebsiteJobPostResponse { - /** 列表 */ - items?: WebsiteJobPost[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface CreateByResumeHireWebsiteDeliveryResponse { delivery?: WebsiteDeliveryDto } @@ -3455,15 +3044,6 @@ export interface GetHireWebsiteDeliveryTaskResponse { extra_info?: string } -export interface ListHireWebsiteResponse { - /** 列表 */ - items?: Website[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetHireAgencyResponse { /** 数据 */ agency?: Agency @@ -3484,22 +3064,6 @@ export interface QueryHireAgencyResponse { items?: Agency[] } -export interface GetAgencyAccountHireAgencyResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - items?: AgencyAccount[] -} - -export interface BatchQueryHireAgencyResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - items?: AgencySupplier[] -} - export interface CreateHireTalentExternalInfoResponse { /** 人才外部信息 */ external_info?: TalentExternalInfo @@ -3518,15 +3082,6 @@ export interface UpdateHireExternalApplicationResponse { external_application?: ExternalApplication } -export interface ListHireExternalApplicationResponse { - /** 外部投递列表 */ - items?: ExternalApplication[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - export interface DeleteHireExternalApplicationResponse { external_application?: ExternalApplication } @@ -3539,12 +3094,6 @@ export interface UpdateHireExternalInterviewResponse { external_interview?: ExternalInterview } -export interface BatchQueryHireExternalInterviewResponse { - items?: ExternalInterview[] - page_token?: string - has_more?: boolean -} - export interface CreateHireExternalInterviewAssessmentResponse { external_interview_assessment?: ExternalInterviewAssessment } @@ -3561,12 +3110,6 @@ export interface UpdateHireExternalOfferResponse { external_offer?: ExternalOffer } -export interface BatchQueryHireExternalOfferResponse { - items?: ExternalOffer[] - page_token?: string - has_more?: boolean -} - export interface CreateHireExternalBackgroundCheckResponse { external_background_check?: ExternalBackgroundCheck } @@ -3575,26 +3118,11 @@ export interface UpdateHireExternalBackgroundCheckResponse { external_background_check?: ExternalBackgroundCheck } -export interface BatchQueryHireExternalBackgroundCheckResponse { - items?: ExternalBackgroundCheck[] - page_token?: string - has_more?: boolean -} - export interface CreateHireExternalReferralRewardResponse { /** 创建的内推奖励的id */ id?: string } -export interface SearchHireTalentPoolResponse { - /** 人才库列表 */ - items?: TalentPool[] - /** 分页标记 */ - page_token?: string - /** 是否有剩余数据 */ - has_more?: boolean -} - export interface MoveTalentHireTalentPoolResponse { /** 人才库ID */ talent_pool_id?: string @@ -3634,29 +3162,11 @@ export interface RemoveToFolderHireTalentResponse { folder_id?: string } -export interface ListHireTalentFolderResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** 文件夹列表 */ - items?: TalentFolderForList[] -} - export interface BatchGetIdHireTalentResponse { /** 人才信息列表 */ talent_list?: TalentBatchInfo[] } -export interface ListHireTalentResponse { - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 列表 */ - items?: Talent[] -} - export interface QueryHireTalentObjectResponse { items?: CommonSchema[] } @@ -3731,43 +3241,16 @@ export interface CreateHireApplicationResponse { id?: string } -export interface ListHireTerminationReasonResponse { - /** 列表 */ - items?: TerminationReason[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetHireApplicationResponse { /** 投递数据 */ application?: Application } -export interface ListHireApplicationResponse { - /** 投递数据列表 */ - items?: string[] - /** 游标, 翻下一页数据时使用 */ - page_token?: string - /** 是否还有下一页数据 */ - has_more?: boolean -} - export interface SearchHireDiversityInclusionResponse { /** 多元化与包容性信息列表 */ items?: DiInfo[] } -export interface ListHireEvaluationResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** 简历评估信息列表 */ - items?: Evaluation[] -} - export interface CreateHireExamResponse { /** 笔试 ID */ exam_id?: string @@ -3785,24 +3268,6 @@ export interface CreateHireExamResponse { operate_time?: string } -export interface SearchHireTestResponse { - /** 笔试列表 */ - items?: Test[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListHireInterviewResponse { - /** 面试列表 */ - items?: InterviewExtend[] - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetByTalentHireInterviewResponse { /** 投递面试列表 */ items?: TalentInterview[] @@ -3817,20 +3282,6 @@ export interface GetHireInterviewRecordResponse { interview_record?: InterviewRecord } -export interface ListHireInterviewRecordResponse { - /** 面试评价详细信息列表 */ - items?: InterviewRecord[] - page_token?: string - has_more?: boolean -} - -export interface ListHireInterviewRecordResponse { - /** 面试评价详细信息列表 */ - items?: InterviewRecord[] - page_token?: string - has_more?: boolean -} - export interface GetHireInterviewRecordAttachmentResponse { /** 附件信息 */ attachment?: AttachmentInfo @@ -3844,15 +3295,6 @@ export interface GetHireMinutesResponse { has_more?: boolean } -export interface ListHireQuestionnaireResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** 满意度评价列表 */ - items?: Questionnaire[] -} - export interface CreateHireOfferResponse { /** Offer ID */ offer_id?: string @@ -3892,15 +3334,6 @@ export interface GetHireOfferResponse { offer?: Offer } -export interface ListHireOfferResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** Offer 列表 */ - items?: OfferListInfo[] -} - export interface InternOfferStatusHireOfferResponse { /** Offer ID */ offer_id?: string @@ -3912,26 +3345,11 @@ export interface InternOfferStatusHireOfferResponse { offboarding_info?: InternOfferOffboardingInfo } -export interface ListHireBackgroundCheckOrderResponse { - /** 是否有下一页 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string - /** 背调信息列表 */ - items?: BackgroundCheckOrder[] -} - export interface CreateHireTripartiteAgreementResponse { /** 创建的三方协议的 id */ id?: string } -export interface ListHireTripartiteAgreementResponse { - items?: TripartiteAgreementInfo[] - page_token?: string - has_more?: boolean -} - export interface UpdateHireTripartiteAgreementResponse { /** 三方协议信息 */ tripartite_agreement?: TripartiteAgreementInfo @@ -3957,42 +3375,6 @@ export interface GetHireEmployeeResponse { employee?: Employee } -export interface ListHireTodoResponse { - /** 待办信息 */ - items?: Todo[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - -export interface ListHireEvaluationTaskResponse { - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 列表 */ - items?: EvaluationTask[] -} - -export interface ListHireExamMarkingTaskResponse { - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 列表 */ - items?: ExamMarkingTask[] -} - -export interface ListHireInterviewTaskResponse { - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 列表 */ - items?: InterviewTask[] -} - export interface CreateHireNoteResponse { note?: Note } @@ -4007,21 +3389,6 @@ export interface GetHireNoteResponse { note?: Note } -export interface ListHireNoteResponse { - /** 备注数据列表 */ - items?: Note[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 游标, 翻下一页数据时使用 */ - page_token?: string -} - -export interface ListHireResumeSourceResponse { - items?: ResumeSource[] - page_token?: string - has_more?: boolean -} - export interface EnableHireReferralAccountResponse { /** 账号信息 */ account?: Account @@ -4071,24 +3438,6 @@ export interface PreviewHireAttachmentResponse { url: string } -export interface ListHireApplicationInterviewResponse { - /** 分页标志 */ - page_token?: string - /** 是否有更多 */ - has_more?: boolean - /** 面试列表 */ - items?: Interview[] -} - -export interface SearchHireTalentOperationLogResponse { - /** 列表 */ - items?: TalentOperationLog[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 下一页页码 */ - page_token?: string -} - export interface GetHireJobManagerResponse { /** 职位负责人 */ info?: JobManager diff --git a/adapters/lark/src/types/im.ts b/adapters/lark/src/types/im.ts index 4c06cacf..9353bb0b 100644 --- a/adapters/lark/src/types/im.ts +++ b/adapters/lark/src/types/im.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -47,12 +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): Promise + readUsersImMessage(message_id: string, query?: ReadUsersImMessageQuery): Promise> /** * 获取会话历史消息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list */ - listImMessage(query?: ListImMessageQuery): Promise + listImMessage(query?: ListImMessageQuery): Promise> /** * 获取消息中的资源文件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get @@ -122,7 +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): Promise + listImMessageReaction(message_id: string, query?: ListImMessageReactionQuery): Promise> /** * 删除消息表情回复 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete @@ -142,7 +142,7 @@ declare module '../internal' { * 获取群内 Pin 消息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list */ - listImPin(query?: ListImPinQuery): Promise + listImPin(query?: ListImPinQuery): Promise> /** * 更新应用发送的消息卡片 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/patch @@ -192,12 +192,12 @@ declare module '../internal' { * 获取用户或机器人所在的群列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list */ - listImChat(query?: ListImChatQuery): Promise + listImChat(query?: ListImChatQuery): Promise> /** * 搜索对用户或机器人可见的群列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search */ - searchImChat(query?: SearchImChatQuery): Promise + searchImChat(query?: SearchImChatQuery): Promise> /** * 获取群成员发言权限 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get @@ -438,16 +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' - /** 此次调用中使用的分页的大小 */ - page_size?: number - /** 下一页分页的token */ - page_token?: string } -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) */ @@ -458,10 +454,6 @@ export interface ListImMessageQuery { end_time?: string /** 消息排序方式 */ sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc' - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string } export interface GetImMessageResourceQuery { @@ -527,13 +519,9 @@ 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 - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时，会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number /** 当操作人为用户时返回用户ID的类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' } @@ -543,17 +531,13 @@ export interface CreateImPinRequest { message_id: string } -export interface ListImPinQuery { +export interface ListImPinQuery extends Pagination { /** 待获取Pin消息的Chat ID */ chat_id: string /** Pin信息的起始时间（毫秒级时间戳） */ start_time?: string /** Pin信息的结束时间（毫秒级时间戳） */ end_time?: string - /** 此次调用中使用的分页的大小 */ - page_size?: number - /** 下一页分页的token */ - page_token?: string } export interface PatchImMessageRequest { @@ -684,35 +668,23 @@ 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' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } -export interface SearchImChatQuery { +export interface SearchImChatQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 关键词。注意：如果query为空值将返回空的结果 */ query?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } -export interface GetImChatModerationQuery { +export interface GetImChatModerationQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface LinkImChatRequest { @@ -762,13 +734,9 @@ 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' - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface PatchImChatAnnouncementRequest { @@ -1092,24 +1060,6 @@ export interface ForwardImThreadResponse { upper_message_id?: string } -export interface ReadUsersImMessageResponse { - /** read_user[] */ - items?: ReadUser[] - /** 是否还有下一页 */ - has_more: boolean - /** 下一页分页的token */ - page_token?: string -} - -export interface ListImMessageResponse { - /** 是否还有后续翻页 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** message[] */ - items?: Message[] -} - export interface GetImMessageResponse { /** message[] */ items?: Message[] @@ -1162,15 +1112,6 @@ export interface CreateImMessageReactionResponse { reaction_type?: Emoji } -export interface ListImMessageReactionResponse { - /** 查询指定reaction_type返回的reaction列表 */ - items: MessageReaction[] - /** 是否还有后续翻页 */ - has_more: boolean - /** 下一页分页的token */ - page_token: string -} - export interface DeleteImMessageReactionResponse { /** reaction资源ID */ reaction_id?: string @@ -1186,15 +1127,6 @@ export interface CreateImPinResponse { pin?: Pin } -export interface ListImPinResponse { - /** Pin的操作信息 */ - items?: Pin[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - export interface CreateImChatResponse { /** 群ID */ chat_id?: string @@ -1309,24 +1241,6 @@ export interface GetImChatResponse { chat_status?: 'normal' | 'dissolved' | 'dissolved_save' } -export interface ListImChatResponse { - /** chat列表 */ - items?: ListChat[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - -export interface SearchImChatResponse { - /** chat列表 */ - items?: ListChat[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多群组 */ - has_more?: boolean -} - export interface GetImChatModerationResponse { /** 群发言模式 */ moderation_setting?: string diff --git a/adapters/lark/src/types/lingo.ts b/adapters/lark/src/types/lingo.ts index 4e499f85..c9d33ab5 100644 --- a/adapters/lark/src/types/lingo.ts +++ b/adapters/lark/src/types/lingo.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Classification, ClassificationFilter, Draft, Entity, I18nEntryDesc, MatchInfo, OuterInfo, Phrase, RelatedMeta, Repo, Term } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,7 +37,7 @@ declare module '../internal' { * 获取词条列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/list */ - listLingoEntity(query?: ListLingoEntityQuery): Promise + listLingoEntity(query?: ListLingoEntityQuery): Promise> /** * 精准搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/match @@ -47,7 +47,7 @@ declare module '../internal' { * 模糊搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/search */ - searchLingoEntity(body: SearchLingoEntityRequest, query?: SearchLingoEntityQuery): Promise + searchLingoEntity(body: SearchLingoEntityRequest, query?: SearchLingoEntityQuery): Promise> /** * 词条高亮 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/highlight @@ -57,7 +57,7 @@ declare module '../internal' { * 获取词典分类 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/classification/list */ - listLingoClassification(query?: ListLingoClassificationQuery): Promise + listLingoClassification(query?: ListLingoClassificationQuery): Promise> /** * 获取词库列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/repo/list @@ -186,11 +186,7 @@ export interface GetLingoEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListLingoEntityQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListLingoEntityQuery extends Pagination { /** 数据提供方【可用来过滤数据】 */ provider?: string /** 词库 id */ @@ -220,11 +216,7 @@ export interface SearchLingoEntityRequest { creators?: string[] } -export interface SearchLingoEntityQuery { - /** 每页返回的词条量 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface SearchLingoEntityQuery extends Pagination { /** 词库ID */ repo_id?: string /** 此次调用中使用的用户ID的类型 */ @@ -236,11 +228,7 @@ export interface HighlightLingoEntityRequest { text: string } -export interface ListLingoClassificationQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListLingoClassificationQuery extends Pagination { /** 词库ID */ repo_id?: string } @@ -273,43 +261,16 @@ export interface GetLingoEntityResponse { entity?: Entity } -export interface ListLingoEntityResponse { - /** 词条列表 */ - entities?: Entity[] - /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface MatchLingoEntityResponse { /** 匹配结果 */ results?: MatchInfo[] } -export interface SearchLingoEntityResponse { - /** 数据数组 */ - entities?: Entity[] - /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface HighlightLingoEntityResponse { /** 返回识别到的实体词信息 */ phrases?: Phrase[] } -export interface ListLingoClassificationResponse { - /** 分类list */ - items?: Classification[] - /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface ListLingoRepoResponse { /** 词库列表 */ items?: Repo[] diff --git a/adapters/lark/src/types/mail.ts b/adapters/lark/src/types/mail.ts index 853d6616..eba6687d 100644 --- a/adapters/lark/src/types/mail.ts +++ b/adapters/lark/src/types/mail.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Attachment, EmailAlias, MailAddress, Mailgroup, MailgroupManager, MailgroupMember, MailgroupPermissionMember, PublicMailbox, PublicMailboxMember, User } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,7 +37,7 @@ declare module '../internal' { * 批量获取邮件组 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list */ - listMailMailgroup(query?: ListMailMailgroupQuery): Promise + listMailMailgroup(query?: ListMailMailgroupQuery): Promise> /** * 批量创建邮件组管理员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create @@ -52,7 +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): Promise + listMailMailgroupManager(mailgroup_id: string, query?: ListMailMailgroupManagerQuery): Promise> /** * 创建邮件组成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create @@ -72,7 +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): Promise + listMailMailgroupMember(mailgroup_id: string, query?: ListMailMailgroupMemberQuery): Promise> /** * 批量创建邮件组成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create @@ -117,7 +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): Promise + listMailMailgroupPermissionMember(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery): Promise> /** * 批量创建邮件组权限成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create @@ -152,7 +152,7 @@ declare module '../internal' { * 查询所有公共邮箱 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list */ - listMailPublicMailbox(query?: ListMailPublicMailboxQuery): Promise + listMailPublicMailbox(query?: ListMailPublicMailboxQuery): Promise> /** * 永久删除公共邮箱 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete @@ -182,7 +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): Promise + listMailPublicMailboxMember(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery): Promise> /** * 批量添加公共邮箱成员 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create @@ -292,15 +292,11 @@ 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的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface BatchCreateMailMailgroupManagerRequest { @@ -323,11 +319,7 @@ export interface BatchDeleteMailMailgroupManagerQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListMailMailgroupManagerQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListMailMailgroupManagerQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -357,15 +349,11 @@ 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的类型 */ department_id_type?: 'department_id' | 'open_department_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface BatchCreateMailMailgroupMemberRequest { @@ -415,15 +403,11 @@ 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的类型 */ department_id_type?: 'department_id' | 'open_department_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface BatchCreateMailMailgroupPermissionMemberRequest { @@ -466,11 +450,7 @@ export interface UpdateMailPublicMailboxRequest { name?: string } -export interface ListMailPublicMailboxQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface ListMailPublicMailboxQuery extends Pagination { } export interface CreateMailPublicMailboxMemberRequest { @@ -490,13 +470,9 @@ 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' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface BatchCreateMailPublicMailboxMemberRequest { @@ -529,11 +505,7 @@ export interface CreateMailUserMailboxAliasRequest { email_alias?: string } -export interface ListMailUserMailboxAliasQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface ListMailUserMailboxAliasQuery extends Pagination { } export interface QueryMailUserRequest { @@ -617,23 +589,6 @@ export interface GetMailMailgroupResponse { who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' } -export interface ListMailMailgroupResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - items?: Mailgroup[] -} - -export interface ListMailMailgroupManagerResponse { - /** 邮件组管理员列表 */ - items?: MailgroupManager[] - /** 分页标识 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - export interface CreateMailMailgroupMemberResponse { /** The unique ID of a member in this mail group */ member_id?: string @@ -660,14 +615,6 @@ export interface GetMailMailgroupMemberResponse { type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER' } -export interface ListMailMailgroupMemberResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - items?: MailgroupMember[] -} - export interface BatchCreateMailMailgroupMemberResponse { /** 添加成功后的邮件组成员信息列表 */ items?: MailgroupMember[] @@ -709,14 +656,6 @@ export interface GetMailMailgroupPermissionMemberResponse { type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' } -export interface ListMailMailgroupPermissionMemberResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - items?: MailgroupPermissionMember[] -} - export interface BatchCreateMailMailgroupPermissionMemberResponse { /** 添加成功后的邮件组权限成员信息列表 */ items?: MailgroupPermissionMember[] @@ -762,15 +701,6 @@ export interface GetMailPublicMailboxResponse { geo?: string } -export interface ListMailPublicMailboxResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 邮箱列表 */ - items?: PublicMailbox[] -} - export interface CreateMailPublicMailboxMemberResponse { /** The unique ID of a member in this public mailbox */ member_id?: string @@ -789,14 +719,6 @@ export interface GetMailPublicMailboxMemberResponse { type?: 'USER' } -export interface ListMailPublicMailboxMemberResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - items?: PublicMailboxMember[] -} - export interface BatchCreateMailPublicMailboxMemberResponse { /** 添加成功后的公共邮箱成员信息列表 */ items?: PublicMailboxMember[] diff --git a/adapters/lark/src/types/minutes.ts b/adapters/lark/src/types/minutes.ts index b97944a5..3337e571 100644 --- a/adapters/lark/src/types/minutes.ts +++ b/adapters/lark/src/types/minutes.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Minute, Statictics } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/moments.ts b/adapters/lark/src/types/moments.ts index 03c8d4c0..861694df 100644 --- a/adapters/lark/src/types/moments.ts +++ b/adapters/lark/src/types/moments.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Post } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/okr.ts b/adapters/lark/src/types/okr.ts index 903518fd..7d43339b 100644 --- a/adapters/lark/src/types/okr.ts +++ b/adapters/lark/src/types/okr.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { ContentBlock, OkrBatch, OkrReview, Period, PeriodRule } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -17,7 +17,7 @@ declare module '../internal' { * 获取 OKR 周期列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list */ - listOkrPeriod(query?: ListOkrPeriodQuery): Promise + listOkrPeriod(query?: ListOkrPeriodQuery): Promise> /** * 获取 OKR 周期规则 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list @@ -78,11 +78,7 @@ export interface PatchOkrPeriodRequest { status: 1 | 2 | 3 } -export interface ListOkrPeriodQuery { - /** 分页标志page_token */ - page_token?: string - /** 分页大小，默认10 */ - page_size?: number +export interface ListOkrPeriodQuery extends Pagination { } export interface ListOkrUserOkrQuery { @@ -178,15 +174,6 @@ export interface PatchOkrPeriodResponse { status?: 1 | 2 | 3 } -export interface ListOkrPeriodResponse { - /** 分页标志 */ - page_token?: string - /** 是否有更多 */ - has_more?: boolean - /** 数据项 */ - items?: Period[] -} - export interface ListOkrPeriodRuleResponse { /** 指标库列表 */ period_rules?: PeriodRule[] diff --git a/adapters/lark/src/types/passport.ts b/adapters/lark/src/types/passport.ts index 5294952b..501a835e 100644 --- a/adapters/lark/src/types/passport.ts +++ b/adapters/lark/src/types/passport.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { MaskSession } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/payroll.ts b/adapters/lark/src/types/payroll.ts index ceb2de82..f30c3639 100644 --- a/adapters/lark/src/types/payroll.ts +++ b/adapters/lark/src/types/payroll.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { AcctItem, CostAllocationPlan, CostAllocationReportData, I18nContent, Paygroup } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,7 +7,7 @@ declare module '../internal' { * 批量查询算薪项 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/acct_item/list */ - listPayrollAcctItem(query?: ListPayrollAcctItemQuery): Promise + listPayrollAcctItem(query?: ListPayrollAcctItemQuery): Promise> /** * 查询成本分摊报表汇总数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_report/list @@ -17,27 +17,19 @@ declare module '../internal' { * 批量查询成本分摊方案 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_plan/list */ - listPayrollCostAllocationPlan(query?: ListPayrollCostAllocationPlanQuery): Promise + listPayrollCostAllocationPlan(query?: ListPayrollCostAllocationPlanQuery): Promise> /** * 获取薪资组基本信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list */ - listPayrollPaygroup(query?: ListPayrollPaygroupQuery): Promise + listPayrollPaygroup(query?: ListPayrollPaygroupQuery): Promise> } } -export interface ListPayrollAcctItemQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListPayrollAcctItemQuery extends Pagination { } -export interface ListPayrollCostAllocationReportQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListPayrollCostAllocationReportQuery extends Pagination { /** 成本分摊方案ID */ cost_allocation_plan_id: string /** 期间 */ @@ -46,29 +38,12 @@ export interface ListPayrollCostAllocationReportQuery { report_type: 0 | 1 | 2 } -export interface ListPayrollCostAllocationPlanQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListPayrollCostAllocationPlanQuery extends Pagination { /** 期间 */ pay_period: string } -export interface ListPayrollPaygroupQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} - -export interface ListPayrollAcctItemResponse { - /** 算薪项列表 */ - items?: AcctItem[] - /** 下一页开始 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean +export interface ListPayrollPaygroupQuery extends Pagination { } export interface ListPayrollCostAllocationReportResponse { @@ -84,24 +59,6 @@ export interface ListPayrollCostAllocationReportResponse { cost_allocation_report_datas?: CostAllocationReportData[] } -export interface ListPayrollCostAllocationPlanResponse { - /** 方案 */ - items?: CostAllocationPlan[] - /** 下一页开始 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - -export interface ListPayrollPaygroupResponse { - /** 薪资组列表 */ - items?: Paygroup[] - /** 分页标识符 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - Internal.define({ '/open-apis/payroll/v1/acct_items': { GET: 'listPayrollAcctItem', diff --git a/adapters/lark/src/types/performance.ts b/adapters/lark/src/types/performance.ts index 0cda7086..42b97924 100644 --- a/adapters/lark/src/types/performance.ts +++ b/adapters/lark/src/types/performance.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Activity, AdditionalInformation, Field, ImportedMetric, Indicator, MetricField, MetricInLibrary, MetricTag, MetricTemplate, Question, ReviewProfile, ReviewTemplate, Reviewee, RevieweeMetric, Semester, SemesterBaseInfo, StageTask, Template, Unit, WriteUserGroupScopeData } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -17,7 +17,7 @@ declare module '../internal' { * 批量查询补充信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/query */ - queryPerformanceAdditionalInformation(body: QueryPerformanceAdditionalInformationRequest, query?: QueryPerformanceAdditionalInformationQuery): Promise + queryPerformanceAdditionalInformation(body: QueryPerformanceAdditionalInformationRequest, query?: QueryPerformanceAdditionalInformationQuery): Promise> /** * 批量导入补充信息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/import @@ -42,27 +42,27 @@ declare module '../internal' { * 获取评估模板配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_template/query */ - queryPerformanceReviewTemplate(body: QueryPerformanceReviewTemplateRequest, query?: QueryPerformanceReviewTemplateQuery): Promise + queryPerformanceReviewTemplate(body: QueryPerformanceReviewTemplateRequest, query?: QueryPerformanceReviewTemplateQuery): Promise> /** * 获取评估项列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/indicator/query */ - queryPerformanceIndicator(body: QueryPerformanceIndicatorRequest, query?: QueryPerformanceIndicatorQuery): Promise + queryPerformanceIndicator(body: QueryPerformanceIndicatorRequest, query?: QueryPerformanceIndicatorQuery): Promise> /** * 获取标签填写题配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/question/query */ - queryPerformanceQuestion(body: QueryPerformanceQuestionRequest, query?: QueryPerformanceQuestionQuery): Promise + queryPerformanceQuestion(body: QueryPerformanceQuestionRequest, query?: QueryPerformanceQuestionQuery): Promise> /** * 获取指标列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_lib/query */ - queryPerformanceMetricLib(body: QueryPerformanceMetricLibRequest, query?: QueryPerformanceMetricLibQuery): Promise + queryPerformanceMetricLib(body: QueryPerformanceMetricLibRequest, query?: QueryPerformanceMetricLibQuery): Promise> /** * 获取指标模板列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_template/query */ - queryPerformanceMetricTemplate(body: QueryPerformanceMetricTemplateRequest, query?: QueryPerformanceMetricTemplateQuery): Promise + queryPerformanceMetricTemplate(body: QueryPerformanceMetricTemplateRequest, query?: QueryPerformanceMetricTemplateQuery): Promise> /** * 获取指标字段列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_field/query @@ -72,7 +72,7 @@ declare module '../internal' { * 获取指标标签列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_tag/list */ - listPerformanceMetricTag(query?: ListPerformanceMetricTagQuery): Promise + listPerformanceMetricTag(query?: ListPerformanceMetricTagQuery): Promise> /** * 获取周期任务（指定用户） * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_user_list @@ -143,12 +143,8 @@ export interface QueryPerformanceAdditionalInformationRequest { reviewee_user_ids?: string[] } -export interface QueryPerformanceAdditionalInformationQuery { +export interface QueryPerformanceAdditionalInformationQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 示例值：30 默认值：20 数据校验规则：最大值：50 */ - page_size?: number } export interface ImportPerformanceAdditionalInformationRequest { @@ -202,12 +198,8 @@ export interface QueryPerformanceRevieweeRequest { activity_ids?: string[] } -export interface QueryPerformanceRevieweeQuery { +export interface QueryPerformanceRevieweeQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface QueryPerformanceReviewTemplateRequest { @@ -215,11 +207,7 @@ export interface QueryPerformanceReviewTemplateRequest { review_template_ids?: string[] } -export interface QueryPerformanceReviewTemplateQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface QueryPerformanceReviewTemplateQuery extends Pagination { } export interface QueryPerformanceIndicatorRequest { @@ -227,11 +215,7 @@ export interface QueryPerformanceIndicatorRequest { indicator_ids?: string[] } -export interface QueryPerformanceIndicatorQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface QueryPerformanceIndicatorQuery extends Pagination { } export interface QueryPerformanceQuestionRequest { @@ -239,11 +223,7 @@ export interface QueryPerformanceQuestionRequest { tag_based_question_ids?: string[] } -export interface QueryPerformanceQuestionQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number +export interface QueryPerformanceQuestionQuery extends Pagination { } export interface QueryPerformanceMetricLibRequest { @@ -259,12 +239,8 @@ export interface QueryPerformanceMetricLibRequest { scoring_setting_type?: 'score_manually' | 'score_by_formula' } -export interface QueryPerformanceMetricLibQuery { +export interface QueryPerformanceMetricLibQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface QueryPerformanceMetricTemplateRequest { @@ -274,12 +250,8 @@ export interface QueryPerformanceMetricTemplateRequest { status?: 'to_be_configured' | 'to_be_activated' | 'enabled' | 'disabled' } -export interface QueryPerformanceMetricTemplateQuery { +export interface QueryPerformanceMetricTemplateQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface QueryPerformanceMetricFieldRequest { @@ -287,11 +259,7 @@ export interface QueryPerformanceMetricFieldRequest { field_ids?: string[] } -export interface ListPerformanceMetricTagQuery { - /** 分页大小 */ - page_size?: number - /** 分页 Token */ - page_token?: string +export interface ListPerformanceMetricTagQuery extends Pagination { /** 指标标签 ID 列表 */ tag_ids?: string[] } @@ -416,15 +384,6 @@ export interface QueryPerformanceActivityResponse { activities?: Activity[] } -export interface QueryPerformanceAdditionalInformationResponse { - /** 补充信息列表 */ - additional_informations?: AdditionalInformation[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - export interface ImportPerformanceAdditionalInformationResponse { /** 导入记录 ID */ import_record_id?: string @@ -453,65 +412,11 @@ export interface QueryPerformanceRevieweeResponse { page_token?: string } -export interface QueryPerformanceReviewTemplateResponse { - /** 评估模板信息 */ - review_templates?: ReviewTemplate[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - -export interface QueryPerformanceIndicatorResponse { - /** 评估项列表 */ - indicators?: Indicator[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - -export interface QueryPerformanceQuestionResponse { - /** 标签填写题 */ - tag_based_questions?: Question[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - -export interface QueryPerformanceMetricLibResponse { - /** 指标信息 */ - items?: MetricInLibrary[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - -export interface QueryPerformanceMetricTemplateResponse { - /** 指标模板信息 */ - items?: MetricTemplate[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} - export interface QueryPerformanceMetricFieldResponse { /** 指标字段信息 */ items?: MetricField[] } -export interface ListPerformanceMetricTagResponse { - /** 指标标签列表 */ - items?: MetricTag[] - /** 分页 Token */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - export interface FindByUserListPerformanceStageTaskResponse { /** 周期基础信息 */ base?: SemesterBaseInfo diff --git a/adapters/lark/src/types/personal_settings.ts b/adapters/lark/src/types/personal_settings.ts index da641fac..e7ca7ce0 100644 --- a/adapters/lark/src/types/personal_settings.ts +++ b/adapters/lark/src/types/personal_settings.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { SystemStatus, SystemStatusI18nName, SystemStatusSyncSetting, SystemStatusUserCloseResultEntity, SystemStatusUserOpenParam, SystemStatusUserOpenResultEntity } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -22,7 +22,7 @@ declare module '../internal' { * 获取系统状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list */ - listPersonalSettingsSystemStatus(query?: ListPersonalSettingsSystemStatusQuery): Promise + listPersonalSettingsSystemStatus(query?: ListPersonalSettingsSystemStatusQuery): Promise> /** * 批量开启系统状态 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open @@ -58,11 +58,7 @@ export interface PatchPersonalSettingsSystemStatusRequest { update_fields: 'TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING'[] } -export interface ListPersonalSettingsSystemStatusQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListPersonalSettingsSystemStatusQuery extends Pagination { } export interface BatchOpenPersonalSettingsSystemStatusRequest { @@ -95,15 +91,6 @@ export interface PatchPersonalSettingsSystemStatusResponse { system_status?: SystemStatus } -export interface ListPersonalSettingsSystemStatusResponse { - /** 租户系统状态 */ - items?: SystemStatus[] - /** 分页token */ - page_token?: string - /** 是否存在更多 */ - has_more?: boolean -} - export interface BatchOpenPersonalSettingsSystemStatusResponse { /** 开启结果 */ result_list: SystemStatusUserOpenResultEntity[] diff --git a/adapters/lark/src/types/report.ts b/adapters/lark/src/types/report.ts index 37e76745..9011cec6 100644 --- a/adapters/lark/src/types/report.ts +++ b/adapters/lark/src/types/report.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Rule, Task } from '.' +import { Internal, Paginated } 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): Promise> } } @@ -64,15 +64,6 @@ export interface QueryReportRuleResponse { rules?: Rule[] } -export interface QueryReportTaskResponse { - /** 任务列表 */ - items?: Task[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string -} - Internal.define({ '/open-apis/report/v1/rules/query': { GET: 'queryReportRule', diff --git a/adapters/lark/src/types/search.ts b/adapters/lark/src/types/search.ts index 50bc1850..37bd6a72 100644 --- a/adapters/lark/src/types/search.ts +++ b/adapters/lark/src/types/search.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Acl, ConnectorParam, DataSource, I18nMeta, Item, ItemContent, ItemMetadata, PatchSchemaProperty, Schema, SchemaDisplay, SchemaProperty } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,12 +7,12 @@ declare module '../internal' { * 搜索消息 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/message/create */ - createSearchMessage(body: CreateSearchMessageRequest, query?: CreateSearchMessageQuery): Promise + createSearchMessage(body: CreateSearchMessageRequest, query?: CreateSearchMessageQuery): Promise> /** * 搜索应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/app/create */ - createSearchApp(body: CreateSearchAppRequest, query?: CreateSearchAppQuery): Promise + createSearchApp(body: CreateSearchAppRequest, query?: CreateSearchAppQuery): Promise> /** * 创建数据源 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/create @@ -37,7 +37,7 @@ declare module '../internal' { * 批量获取数据源 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/list */ - listSearchDataSource(query?: ListSearchDataSourceQuery): Promise + listSearchDataSource(query?: ListSearchDataSourceQuery): Promise> /** * 为指定数据项创建索引 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/create @@ -97,13 +97,9 @@ export interface CreateSearchMessageRequest { end_time?: string } -export interface CreateSearchMessageQuery { +export interface CreateSearchMessageQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 分页大小 */ - page_size?: number - /** 分页token */ - page_token?: string } export interface CreateSearchAppRequest { @@ -111,13 +107,9 @@ export interface CreateSearchAppRequest { query: string } -export interface CreateSearchAppQuery { +export interface CreateSearchAppQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 分页大小 */ - page_size?: number - /** 分页token */ - page_token?: string } export interface CreateSearchDataSourceRequest { @@ -168,13 +160,9 @@ export interface PatchSearchDataSourceRequest { enable_answer?: boolean } -export interface ListSearchDataSourceQuery { +export interface ListSearchDataSourceQuery extends Pagination { /** 回包数据格式，0-全量数据；1-摘要数据。**注**：摘要数据仅包含"id"，"name"，"state"。 */ view?: 0 | 1 - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface CreateSearchDataSourceItemRequest { @@ -211,24 +199,6 @@ export interface PatchSearchSchemaRequest { properties?: PatchSchemaProperty[] } -export interface CreateSearchMessageResponse { - /** 消息id列表 */ - items?: string[] - /** 翻页 token，传入返回下一页，首页不需要传入 */ - page_token?: string - /** 是否还有下一页 */ - has_more?: boolean -} - -export interface CreateSearchAppResponse { - /** app_id列表 */ - items?: string[] - /** 翻页 token，传入返回下一页，首页不需要传入 */ - page_token?: string - /** 是否还有下一页 */ - has_more?: boolean -} - export interface CreateSearchDataSourceResponse { /** 数据源实例 */ data_source?: DataSource @@ -244,15 +214,6 @@ export interface GetSearchDataSourceResponse { data_source?: DataSource } -export interface ListSearchDataSourceResponse { - /** 是否有更多数据 */ - has_more?: boolean - /** 取数据的凭证 */ - page_token?: string - /** 返回的数据 */ - items?: DataSource[] -} - export interface GetSearchDataSourceItemResponse { /** 数据项实例 */ item: Item diff --git a/adapters/lark/src/types/security_and_compliance.ts b/adapters/lark/src/types/security_and_compliance.ts index 82d7186f..8bd9b6c3 100644 --- a/adapters/lark/src/types/security_and_compliance.ts +++ b/adapters/lark/src/types/security_and_compliance.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { OpenapiLog } from '.' +import { Internal, Paginated } 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): Promise> } } @@ -26,15 +26,6 @@ export interface ListDataSecurityAndComplianceOpenapiLogRequest { page_token?: string } -export interface ListDataSecurityAndComplianceOpenapiLogResponse { - /** openapi日志列表 */ - items?: OpenapiLog[] - /** 分页标记 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - Internal.define({ '/open-apis/security_and_compliance/v1/openapi_logs/list_data': { POST: 'listDataSecurityAndComplianceOpenapiLog', diff --git a/adapters/lark/src/types/sheets.ts b/adapters/lark/src/types/sheets.ts index 98f082b8..2f95b640 100644 --- a/adapters/lark/src/types/sheets.ts +++ b/adapters/lark/src/types/sheets.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Condition, Dimension, FilterView, FilterViewCondition, FindCondition, FindReplaceResult, FloatImage, GetSpreadsheet, Sheet, SheetFilterInfo, Spreadsheet } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/speech_to_text.ts b/adapters/lark/src/types/speech_to_text.ts index fa1a0e3f..71909394 100644 --- a/adapters/lark/src/types/speech_to_text.ts +++ b/adapters/lark/src/types/speech_to_text.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { FileConfig, Speech, StreamConfig } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/task.ts b/adapters/lark/src/types/task.ts index 54e32c03..8b4f448a 100644 --- a/adapters/lark/src/types/task.ts +++ b/adapters/lark/src/types/task.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, TaskSummary, Tasklist, TasklistActivitySubscription, TextSetting } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -37,7 +37,7 @@ declare module '../internal' { * 列取任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list */ - listTaskV2(query?: ListTaskV2Query): Promise + listTaskV2(query?: ListTaskV2Query): Promise> /** * 列取任务所在清单 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/tasklists @@ -82,7 +82,7 @@ declare module '../internal' { * 获取任务的子任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list */ - listTaskV2TaskSubtask(task_guid: string, query?: ListTaskV2TaskSubtaskQuery): Promise + listTaskV2TaskSubtask(task_guid: string, query?: ListTaskV2TaskSubtaskQuery): Promise> /** * 创建清单 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/create @@ -117,12 +117,12 @@ declare module '../internal' { * 获取清单任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks */ - tasksTaskV2Tasklist(tasklist_guid: string, query?: TasksTaskV2TasklistQuery): Promise + tasksTaskV2Tasklist(tasklist_guid: string, query?: TasksTaskV2TasklistQuery): Promise> /** * 获取清单列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list */ - listTaskV2Tasklist(query?: ListTaskV2TasklistQuery): Promise + listTaskV2Tasklist(query?: ListTaskV2TasklistQuery): Promise> /** * 创建动态订阅 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/create @@ -172,7 +172,7 @@ declare module '../internal' { * 获取评论列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list */ - listTaskV2Comment(query?: ListTaskV2CommentQuery): Promise + listTaskV2Comment(query?: ListTaskV2CommentQuery): Promise> /** * 上传附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/upload @@ -182,7 +182,7 @@ declare module '../internal' { * 列取附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list */ - listTaskV2Attachment(query?: ListTaskV2AttachmentQuery): Promise + listTaskV2Attachment(query?: ListTaskV2AttachmentQuery): Promise> /** * 获取附件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/get @@ -217,12 +217,12 @@ declare module '../internal' { * 获取自定义分组列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list */ - listTaskV2Section(query?: ListTaskV2SectionQuery): Promise + listTaskV2Section(query?: ListTaskV2SectionQuery): Promise> /** * 获取自定义分组任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks */ - tasksTaskV2Section(section_guid: string, query?: TasksTaskV2SectionQuery): Promise + tasksTaskV2Section(section_guid: string, query?: TasksTaskV2SectionQuery): Promise> /** * 创建自定义字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create @@ -242,7 +242,7 @@ declare module '../internal' { * 列取自定义字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list */ - listTaskV2CustomField(query?: ListTaskV2CustomFieldQuery): Promise + listTaskV2CustomField(query?: ListTaskV2CustomFieldQuery): Promise> /** * 将自定义字段加入资源 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/add @@ -297,7 +297,7 @@ declare module '../internal' { * 查询所有任务 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/list */ - listTaskV1(query?: ListTaskV1Query): Promise + listTaskV1(query?: ListTaskV1Query): Promise> /** * 新增提醒时间 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/create @@ -312,7 +312,7 @@ declare module '../internal' { * 查询提醒时间列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list */ - listTaskV1TaskReminder(task_id: string, query?: ListTaskV1TaskReminderQuery): Promise + listTaskV1TaskReminder(task_id: string, query?: ListTaskV1TaskReminderQuery): Promise> /** * 创建评论 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/create @@ -337,7 +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): Promise + listTaskV1TaskComment(task_id: string, query?: ListTaskV1TaskCommentQuery): Promise> /** * 新增关注人 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/create @@ -357,7 +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): Promise + listTaskV1TaskFollower(task_id: string, query?: ListTaskV1TaskFollowerQuery): Promise> /** * 新增执行者 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/create @@ -377,7 +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): Promise + listTaskV1TaskCollaborator(task_id: string, query?: ListTaskV1TaskCollaboratorQuery): Promise> } } @@ -462,11 +462,7 @@ export interface RemoveMembersTaskV2Query { user_id_type?: string } -export interface ListTaskV2Query { - /** 每页的任务数量 */ - page_size?: number - /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ - page_token?: string +export interface ListTaskV2Query extends Pagination { /** 是否按任务完成进行过滤。不填写表示不过滤。 */ completed?: boolean /** 查询任务的范围 */ @@ -569,11 +565,7 @@ export interface CreateTaskV2TaskSubtaskQuery { user_id_type?: string } -export interface ListTaskV2TaskSubtaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV2TaskSubtaskQuery extends Pagination { /** 表示user的ID的类型，支持open_id, user_id, union_id */ user_id_type?: string } @@ -629,11 +621,7 @@ export interface RemoveMembersTaskV2TasklistQuery { user_id_type?: string } -export interface TasksTaskV2TasklistQuery { - /** 每页返回的任务数量 */ - page_size?: number - /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ - page_token?: string +export interface TasksTaskV2TasklistQuery extends Pagination { /** 只查看特定完成状态的任务，不填写表示不按完成状态过滤 */ completed?: boolean /** 任务创建的起始时间戳（ms），闭区间，不填写默认为首个任务的创建时间戳 */ @@ -644,11 +632,7 @@ export interface TasksTaskV2TasklistQuery { user_id_type?: string } -export interface ListTaskV2TasklistQuery { - /** 每页返回的清单数量 */ - page_size?: number - /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ - page_token?: string +export interface ListTaskV2TasklistQuery extends Pagination { /** 表示user的ID的类型，支持open_id, user_id, union_id */ user_id_type?: string } @@ -726,11 +710,7 @@ export interface PatchTaskV2CommentQuery { user_id_type?: string } -export interface ListTaskV2CommentQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV2CommentQuery extends Pagination { /** 要获取评论列表的资源类型 */ resource_type?: string /** 要获取评论的资源ID。例如要获取任务的评论列表，此处应该填写任务全局唯一ID */ @@ -755,11 +735,7 @@ export interface UploadTaskV2AttachmentQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } -export interface ListTaskV2AttachmentQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV2AttachmentQuery extends Pagination { /** 附件归属的资源类型 */ resource_type?: string /** 附件归属资源的id，配合resource_type使用。例如希望获取任务的附件，需要设置 resource_type为task， resource_id为任务的全局唯一ID */ @@ -808,11 +784,7 @@ export interface PatchTaskV2SectionQuery { user_id_type?: string } -export interface ListTaskV2SectionQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV2SectionQuery extends Pagination { /** 自定义分组所属的资源类型。支持"my_tasks"(我负责的）和"tasklist"（清单）。当使用"tasklist"时，需要用resource_id提供清单GUID。 */ resource_type: string /** 如`resource_type`为"tasklist"，这里需要填写要列取自定义分组的清单的GUID。 */ @@ -821,11 +793,7 @@ export interface ListTaskV2SectionQuery { user_id_type?: string } -export interface TasksTaskV2SectionQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记 */ - page_token?: string +export interface TasksTaskV2SectionQuery extends Pagination { /** 按照任务状态过滤，如果不填写则表示不按完成状态过滤 */ completed?: boolean /** 按照创建时间筛选的起始时间戳（ms)，如不填写则为首个任务的创建时刻 */ @@ -881,11 +849,7 @@ export interface PatchTaskV2CustomFieldQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } -export interface ListTaskV2CustomFieldQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV2CustomFieldQuery extends Pagination { /** 用户ID格式，支持open_id, user_id, union_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' /** 资源类型，如提供表示仅查询特定资源下的自定义字段。目前只支持tasklist。 */ @@ -977,11 +941,7 @@ export interface GetTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1Query { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV1Query extends Pagination { /** 范围查询任务时，查询的起始时间。不填时默认起始时间为第一个任务的创建时间。 */ start_create_time?: string /** 范围查询任务时，查询的结束时间。不填时默认结束时间为最后一个任务的创建时间。 */ @@ -997,11 +957,7 @@ export interface CreateTaskV1TaskReminderRequest { relative_fire_minute: number } -export interface ListTaskV1TaskReminderQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV1TaskReminderQuery extends Pagination { } export interface CreateTaskV1TaskCommentRequest { @@ -1037,11 +993,7 @@ export interface GetTaskV1TaskCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1TaskCommentQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token获取查询结果 */ - page_token?: string +export interface ListTaskV1TaskCommentQuery extends Pagination { /** 评论排序标记，可按照评论时间从小到大查询，或者评论时间从大到小查询，不填默认按照从小到大 */ list_direction?: 0 | 1 /** 此次调用中使用的用户ID的类型 */ @@ -1075,11 +1027,7 @@ export interface BatchDeleteFollowerTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1TaskFollowerQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV1TaskFollowerQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -1111,11 +1059,7 @@ export interface BatchDeleteCollaboratorTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1TaskCollaboratorQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListTaskV1TaskCollaboratorQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -1145,15 +1089,6 @@ export interface RemoveMembersTaskV2Response { task?: Task } -export interface ListTaskV2Response { - /** 返回的任务列表 */ - items?: Task[] - /** 获取下一次分页的分页标记 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - export interface TasklistsTaskV2Response { /** 任务所在清单的摘要信息 */ tasklists?: TaskInTasklistInfo[] @@ -1194,15 +1129,6 @@ export interface CreateTaskV2TaskSubtaskResponse { subtask?: Task } -export interface ListTaskV2TaskSubtaskResponse { - /** 子任务列表 */ - items?: Task[] - /** 用于返回下一个分页的token */ - page_token?: string - /** 是否还有下一页数据。 */ - has_more?: boolean -} - export interface CreateTaskV2TasklistResponse { /** 创建的清单数据 */ tasklist?: Tasklist @@ -1228,24 +1154,6 @@ export interface RemoveMembersTaskV2TasklistResponse { tasklist?: Tasklist } -export interface TasksTaskV2TasklistResponse { - /** 任务摘要数据 */ - items?: TaskSummary[] - /** 用于获取下一页的分页标记，最后一页时发返回空 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - -export interface ListTaskV2TasklistResponse { - /** 清单数据列表 */ - items?: Tasklist[] - /** 用于获取下一页的分页标记 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - export interface CreateTaskV2TasklistActivitySubscriptionResponse { /** 清单动态订阅 */ activity_subscription?: TasklistActivitySubscription @@ -1281,29 +1189,11 @@ export interface PatchTaskV2CommentResponse { comment?: Comment } -export interface ListTaskV2CommentResponse { - /** 评论列表数据 */ - items?: Comment[] - /** 用于获取下一页的分页标记，当has_more为false时为空 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - export interface UploadTaskV2AttachmentResponse { /** 上传的附件列表 */ items?: Attachment[] } -export interface ListTaskV2AttachmentResponse { - /** 附件列表 */ - items?: Attachment[] - /** 获取下一页的分页标记，无更多数据时返回空 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - export interface GetTaskV2AttachmentResponse { /** 附件详情 */ attachment?: Attachment @@ -1324,24 +1214,6 @@ export interface PatchTaskV2SectionResponse { section?: Section } -export interface ListTaskV2SectionResponse { - /** 自定义分组的摘要列表 */ - items?: SectionSummary[] - /** 获取下一页数据的分页标记，没有更多数据时返回空 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - -export interface TasksTaskV2SectionResponse { - /** 任务摘要信息 */ - items?: TaskSummary[] - /** 获取下一页的分页标记，无更多数据时返回空 */ - page_token?: string - /** 是否有更多数据 */ - has_more?: boolean -} - export interface CreateTaskV2CustomFieldResponse { /** 创建的自定义字段 */ custom_field?: CustomField @@ -1357,15 +1229,6 @@ export interface PatchTaskV2CustomFieldResponse { custom_field?: CustomField } -export interface ListTaskV2CustomFieldResponse { - /** 返回的自定义字段列表 */ - items?: CustomField[] - /** 用于获取下一页数据的page_token */ - page_token?: string - /** 是否有下一页的数据 */ - has_more?: boolean -} - export interface CreateTaskV2CustomFieldOptionResponse { /** 创建的选项 */ option?: Option @@ -1391,29 +1254,11 @@ export interface GetTaskV1Response { task?: Task } -export interface ListTaskV1Response { - /** 任务列表 */ - items?: Task[] - /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** true */ - has_more?: boolean -} - export interface CreateTaskV1TaskReminderResponse { /** 返回创建成功的提醒时间 */ reminder?: Reminder } -export interface ListTaskV1TaskReminderResponse { - /** 返回提醒时间设置列表 */ - items?: Reminder[] - /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - export interface CreateTaskV1TaskCommentResponse { /** 返回创建好的任务评论 */ comment?: Comment @@ -1429,15 +1274,6 @@ export interface GetTaskV1TaskCommentResponse { comment?: Comment } -export interface ListTaskV1TaskCommentResponse { - /** 返回的评论列表 */ - items?: Comment[] - /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - export interface CreateTaskV1TaskFollowerResponse { /** 创建后的任务关注者 */ follower: Follower @@ -1448,15 +1284,6 @@ export interface BatchDeleteFollowerTaskV1Response { followers?: string[] } -export interface ListTaskV1TaskFollowerResponse { - /** 返回的关注者列表 */ - items?: Follower[] - /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - export interface CreateTaskV1TaskCollaboratorResponse { /** 返回创建成功后的任务协作者 */ collaborator: Collaborator @@ -1467,15 +1294,6 @@ export interface BatchDeleteCollaboratorTaskV1Response { collaborators?: string[] } -export interface ListTaskV1TaskCollaboratorResponse { - /** 返回的协作者列表 */ - items?: Collaborator[] - /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 是否还有更多数据 */ - has_more?: boolean -} - Internal.define({ '/open-apis/task/v2/tasks': { POST: 'createTaskV2', diff --git a/adapters/lark/src/types/tenant.ts b/adapters/lark/src/types/tenant.ts index 11d972a5..15c8a81f 100644 --- a/adapters/lark/src/types/tenant.ts +++ b/adapters/lark/src/types/tenant.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Tenant, TenantAssignInfo } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/translation.ts b/adapters/lark/src/types/translation.ts index b3b1e529..333efcfe 100644 --- a/adapters/lark/src/types/translation.ts +++ b/adapters/lark/src/types/translation.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Term } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/vc.ts b/adapters/lark/src/types/vc.ts index f2280d6b..0cccdfe3 100644 --- a/adapters/lark/src/types/vc.ts +++ b/adapters/lark/src/types/vc.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' 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, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -57,7 +57,7 @@ declare module '../internal' { * 获取与会议号关联的会议列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no */ - listByNoVcMeeting(query?: ListByNoVcMeetingQuery): Promise + listByNoVcMeeting(query?: ListByNoVcMeetingQuery): Promise> /** * 开始录制 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start @@ -147,7 +147,7 @@ declare module '../internal' { * 查询会议室层级列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list */ - listVcRoomLevel(query?: ListVcRoomLevelQuery): Promise + listVcRoomLevel(query?: ListVcRoomLevelQuery): Promise> /** * 搜索会议室层级 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search @@ -182,12 +182,12 @@ declare module '../internal' { * 查询会议室列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list */ - listVcRoom(query?: ListVcRoomQuery): Promise + listVcRoom(query?: ListVcRoomQuery): Promise> /** * 搜索会议室 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search */ - searchVcRoom(body: SearchVcRoomRequest, query?: SearchVcRoomQuery): Promise + searchVcRoom(body: SearchVcRoomRequest, query?: SearchVcRoomQuery): Promise> /** * 查询会议室配置 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get @@ -242,27 +242,27 @@ declare module '../internal' { * 查询会议明细 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get */ - getVcMeetingList(query?: GetVcMeetingListQuery): Promise + getVcMeetingList(query?: GetVcMeetingListQuery): Promise> /** * 查询参会人明细 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get */ - getVcParticipantList(query?: GetVcParticipantListQuery): Promise + getVcParticipantList(query?: GetVcParticipantListQuery): Promise> /** * 查询参会人会议质量数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get */ - getVcParticipantQualityList(query?: GetVcParticipantQualityListQuery): Promise + getVcParticipantQualityList(query?: GetVcParticipantQualityListQuery): Promise> /** * 查询会议室预定数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get */ - getVcResourceReservationList(query?: GetVcResourceReservationListQuery): Promise + getVcResourceReservationList(query?: GetVcResourceReservationListQuery): Promise> /** * 获取告警记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list */ - listVcAlert(query?: ListVcAlertQuery): Promise + listVcAlert(query?: ListVcAlertQuery): Promise> /** * 创建签到板部署码 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_checkboard_access_code @@ -365,17 +365,13 @@ 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） */ start_time: string /** 查询结束时间（unix时间，单位sec） */ end_time: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number } export interface StartVcMeetingRecordingRequest { @@ -531,13 +527,9 @@ export interface MgetVcRoomLevelRequest { level_ids: string[] } -export interface ListVcRoomLevelQuery { +export interface ListVcRoomLevelQuery extends Pagination { /** 层级ID，不传则返回该租户下第一层级列表 */ room_level_id?: string - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string } export interface SearchVcRoomLevelQuery { @@ -604,11 +596,7 @@ export interface MgetVcRoomQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListVcRoomQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListVcRoomQuery extends Pagination { /** 层级ID，不传则返回该租户下的所有会议室 */ room_level_id?: string /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ @@ -740,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） */ @@ -755,15 +743,11 @@ export interface GetVcMeetingListQuery { room_id?: string /** 按会议类型筛选（最多一个筛选条件） */ meeting_type?: 1 | 2 | 3 - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string /** 此次调用中使用的用户ID的类型 */ 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） */ @@ -776,15 +760,11 @@ export interface GetVcParticipantListQuery { user_id?: string /** 按参会Rooms筛选（最多一个筛选条件） */ room_id?: string - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string /** 此次调用中使用的用户ID的类型 */ 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） */ @@ -797,15 +777,11 @@ export interface GetVcParticipantQualityListQuery { user_id?: string /** 参会人为Rooms时填入 */ room_id?: string - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetVcResourceReservationListQuery { +export interface GetVcResourceReservationListQuery extends Pagination { /** 层级id */ room_level_id: string /** 是否展示会议主题 */ @@ -818,13 +794,9 @@ export interface GetVcResourceReservationListQuery { room_ids: string[] /** 若为true表示导出room_ids范围外的会议室，默认为false */ is_exclude?: boolean - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string } -export interface ListVcAlertQuery { +export interface ListVcAlertQuery extends Pagination { /** 开始时间（unix时间，单位sec） */ start_time: string /** 结束时间（unix时间，单位sec） */ @@ -833,10 +805,6 @@ export interface ListVcAlertQuery { query_type?: 1 | 2 | 3 /** 查询对象ID */ query_value?: string - /** 请求期望返回的告警记录数量，不足则返回全部，该值默认为 100，最大为 1000 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string } export interface SetCheckboardAccessCodeVcRoomConfigRequest { @@ -949,15 +917,6 @@ export interface GetVcMeetingResponse { meeting?: Meeting } -export interface ListByNoVcMeetingResponse { - /** 是否还有数据 */ - has_more?: boolean - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 会议简要信息列表 */ - meeting_briefs?: Meeting[] -} - export interface GetVcMeetingRecordingResponse { recording?: MeetingRecording } @@ -1016,13 +975,6 @@ export interface MgetVcRoomLevelResponse { items?: RoomLevel[] } -export interface ListVcRoomLevelResponse { - /** 层级列表 */ - items?: RoomLevel[] - page_token?: string - has_more?: boolean -} - export interface SearchVcRoomLevelResponse { /** 层级id列表 */ level_ids?: string[] @@ -1041,24 +993,6 @@ export interface MgetVcRoomResponse { items?: Room[] } -export interface ListVcRoomResponse { - /** 会议室列表 */ - rooms?: Room[] - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - -export interface SearchVcRoomResponse { - /** 会议室列表 */ - rooms?: Room[] - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - export interface GetVcScopeConfigResponse { /** 当前节点的配置，根据层级顺序从底向上进行合并计算后的结果；如果当前节点某个值已配置，则取该节点的值，否则会从该节点的父层级节点获取，如果父节点依然未配置，则继续向上递归获取；若所有节点均未配置，则该值返回为空 */ current_config?: ScopeConfig @@ -1090,51 +1024,6 @@ export interface GetVcReserveConfigDisableInformResponse { disable_inform?: DisableInformConfig } -export interface GetVcMeetingListResponse { - /** 会议列表 */ - meeting_list?: MeetingInfo[] - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - -export interface GetVcParticipantListResponse { - /** 参会人列表 */ - participants?: Participant[] - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - -export interface GetVcParticipantQualityListResponse { - /** 参会人参会质量列表 */ - participant_quality_list?: ParticipantQuality[] - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - -export interface GetVcResourceReservationListResponse { - /** 会议室预定列表 */ - room_reservation_list?: RoomMeetingReservation[] - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - -export interface ListVcAlertResponse { - /** 是否还有数据 */ - has_more?: boolean - /** 下一页分页的token，下次请求时传入 */ - page_token?: string - /** 告警记录 */ - items?: Alert[] -} - export interface SetCheckboardAccessCodeVcRoomConfigResponse { /** 部署访问码 */ access_code?: string diff --git a/adapters/lark/src/types/verification.ts b/adapters/lark/src/types/verification.ts index 3ae4e36d..076de960 100644 --- a/adapters/lark/src/types/verification.ts +++ b/adapters/lark/src/types/verification.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Verification } from '.' +import { Internal } from '../internal' declare module '../internal' { interface Internal { diff --git a/adapters/lark/src/types/wiki.ts b/adapters/lark/src/types/wiki.ts index cdba7a5b..1192252e 100644 --- a/adapters/lark/src/types/wiki.ts +++ b/adapters/lark/src/types/wiki.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { Member, Node, Setting, Space, TaskResult } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,7 +7,7 @@ declare module '../internal' { * 获取知识空间列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list */ - listWikiSpace(query?: ListWikiSpaceQuery): Promise + listWikiSpace(query?: ListWikiSpaceQuery): Promise> /** * 获取知识空间信息 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get @@ -22,7 +22,7 @@ declare module '../internal' { * 获取知识空间成员列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list */ - listWikiSpaceMember(space_id: string, query?: ListWikiSpaceMemberQuery): Promise + listWikiSpaceMember(space_id: string, query?: ListWikiSpaceMemberQuery): Promise> /** * 添加知识空间成员 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create @@ -52,7 +52,7 @@ declare module '../internal' { * 获取知识空间子节点列表 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list */ - listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery): Promise + listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery): Promise> /** * 移动知识空间节点 * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move @@ -82,15 +82,11 @@ declare module '../internal' { * 搜索 Wiki * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki */ - searchWikiNode(body: SearchWikiNodeRequest, query?: SearchWikiNodeQuery): Promise + searchWikiNode(body: SearchWikiNodeRequest, query?: SearchWikiNodeQuery): Promise> } } -export interface ListWikiSpaceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +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' } @@ -109,11 +105,7 @@ export interface CreateWikiSpaceRequest { open_sharing?: 'open' | 'closed' } -export interface ListWikiSpaceMemberQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListWikiSpaceMemberQuery extends Pagination { } export interface CreateWikiSpaceMemberRequest { @@ -168,11 +160,7 @@ export interface GetNodeWikiSpaceQuery { obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki' } -export interface ListWikiSpaceNodeQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string +export interface ListWikiSpaceNodeQuery extends Pagination { /** 父节点token */ parent_node_token?: string } @@ -223,20 +211,7 @@ export interface SearchWikiNodeRequest { node_id?: string } -export interface SearchWikiNodeQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} - -export interface ListWikiSpaceResponse { - /** 知识空间列表 */ - items?: Space[] - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean +export interface SearchWikiNodeQuery extends Pagination { } export interface GetWikiSpaceResponse { @@ -249,15 +224,6 @@ export interface CreateWikiSpaceResponse { space?: Space } -export interface ListWikiSpaceMemberResponse { - /** 空间成员列表 */ - members?: Member[] - /** 分页标记 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - export interface CreateWikiSpaceMemberResponse { /** 知识库协作者 */ member?: Member @@ -283,15 +249,6 @@ export interface GetNodeWikiSpaceResponse { node?: Node } -export interface ListWikiSpaceNodeResponse { - /** 知识空间节点信息 */ - items?: Node[] - /** 分页Token */ - page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - export interface MoveWikiSpaceNodeResponse { /** 移动后的节点信息 */ node?: Node @@ -316,15 +273,6 @@ export interface GetWikiTaskResponse { task: TaskResult } -export interface SearchWikiNodeResponse { - /** 搜索到 wiki */ - items: Node[] - /** 翻页 token，传入返回下一页，首页不需要传入 */ - page_token?: string - /** 是否还有下一页 */ - has_more: boolean -} - Internal.define({ '/open-apis/wiki/v2/spaces': { GET: 'listWikiSpace', diff --git a/adapters/lark/src/types/workplace.ts b/adapters/lark/src/types/workplace.ts index 73a1aacb..c024c2dc 100644 --- a/adapters/lark/src/types/workplace.ts +++ b/adapters/lark/src/types/workplace.ts @@ -1,5 +1,5 @@ -import { Internal } from '../internal' import { BlockAccessData, CustomWorkplaceAccessData, WorkplaceAccessData } from '.' +import { Internal, Paginated, Pagination } from '../internal' declare module '../internal' { interface Internal { @@ -7,84 +7,45 @@ declare module '../internal' { * 获取工作台访问数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search */ - searchWorkplaceWorkplaceAccessData(query?: SearchWorkplaceWorkplaceAccessDataQuery): Promise + searchWorkplaceWorkplaceAccessData(query?: SearchWorkplaceWorkplaceAccessDataQuery): Promise> /** * 获取定制工作台访问数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search */ - searchWorkplaceCustomWorkplaceAccessData(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery): Promise + searchWorkplaceCustomWorkplaceAccessData(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery): Promise> /** * 获取定制工作台小组件访问数据 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search */ - searchWorkplaceWorkplaceBlockAccessData(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery): Promise + searchWorkplaceWorkplaceBlockAccessData(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery): Promise> } } -export interface SearchWorkplaceWorkplaceAccessDataQuery { +export interface SearchWorkplaceWorkplaceAccessDataQuery extends Pagination { /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ from_date: string /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ to_date: string - /** 分页大小，最小为 1，最大为 200，默认为 20。 */ - page_size: number - /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ - page_token?: string } -export interface SearchWorkplaceCustomWorkplaceAccessDataQuery { +export interface SearchWorkplaceCustomWorkplaceAccessDataQuery extends Pagination { /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ from_date: string /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ to_date: string - /** 分页大小，最小为 1，最大为 200，默认为 20。 */ - page_size: number - /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ - page_token?: string /** 定制化工作台id.非必填,不填的时候,返回所有定制化工作台数据。 */ custom_workplace_id?: string } -export interface SearchWorkplaceWorkplaceBlockAccessDataQuery { +export interface SearchWorkplaceWorkplaceBlockAccessDataQuery extends Pagination { /** 数据检索开始时间，精确到日。格式yyyy-MM-dd。 */ from_date: string /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ to_date: string - /** 分页大小，最小为 1，最大为 200，默认为 20。 */ - page_size: number - /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ - page_token?: string /** 小组件id */ block_id?: string } -export interface SearchWorkplaceWorkplaceAccessDataResponse { - /** 工作台访问数据 */ - items?: WorkplaceAccessData[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 分页标记，存在下一页时返回。 */ - page_token?: string -} - -export interface SearchWorkplaceCustomWorkplaceAccessDataResponse { - /** 定制工作台访问数据 */ - items?: CustomWorkplaceAccessData[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 分页标记，存在下一页时返回 */ - page_token?: string -} - -export interface SearchWorkplaceWorkplaceBlockAccessDataResponse { - /** 工作台中block的访问数据 */ - items?: BlockAccessData[] - /** 是否还有下一页数据 */ - has_more?: boolean - /** 分页标记，存在下一页时返回 */ - page_token?: string -} - Internal.define({ '/open-apis/workplace/v1/workplace_access_data/search': { POST: 'searchWorkplaceWorkplaceAccessData', diff --git a/package.json b/package.json index eb61a9fd..f63b5782 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,7 @@ "esbuild-register": "^3.5.0", "eslint": "^8.57.0", "shx": "^0.3.4", + "tsx": "^4.19.2", "typescript": "^5.6.2", "yakumo": "^1.0.0-beta.18", "yakumo-esbuild": "^1.0.0-beta.7",