diff --git a/adapters/lark/package.json b/adapters/lark/package.json index 5e1079e6..dacbf555 100644 --- a/adapters/lark/package.json +++ b/adapters/lark/package.json @@ -1,7 +1,7 @@ { "name": "@satorijs/adapter-lark", "description": "Lark (飞书) Adapter for Satorijs", - "version": "3.9.0", + "version": "3.9.1", "type": "module", "main": "lib/index.cjs", "types": "lib/index.d.ts", diff --git a/adapters/lark/scripts/types.ts b/adapters/lark/scripts/types.ts index 620597b2..0afe94ed 100644 --- a/adapters/lark/scripts/types.ts +++ b/adapters/lark/scripts/types.ts @@ -1,7 +1,7 @@ /* eslint-disable no-console */ import { mkdir, readFile, writeFile } from 'node:fs/promises' -import { capitalize } from 'cosmokit' +import { camelCase, capitalize } from 'cosmokit' import pMap from 'p-map' import dedent from 'dedent' @@ -58,11 +58,15 @@ export interface Schema { required: boolean properties?: Schema[] items?: Schema - options?: { - name: string - value: string - description: string - }[] + keyType?: Schema + valueType?: Schema + options?: SchemaOption[] +} + +export interface SchemaOption { + name: string + value: string + description: string } interface ApiDetail { @@ -125,26 +129,62 @@ async function getDetail(api: Api) { return data } -function toHump(name: string) { - return name.replace(/[\_\.](\w)/g, function (all, letter) { - return letter.toUpperCase() - }) +function formatEnum(options: SchemaOption[], type: string): string { + if (!options.length) return '' + const quote = type === 'string' ? "'" : '' + return options.map((option) => { + const desc = option.description ? ` /** ${option.description.replace(/\n/g, '').trim()} */\n` : '' + return `${desc} ${capitalize(camelCase(option.name))} = ${quote}${option.value}${quote},` + }).join('\n') + '\n' } -function formatType(schema: Schema, imports: Set, inArray?: boolean) { - if (!schema.ref) return _formatType(schema, imports, inArray) - const name = capitalize(toHump(schema.ref)) - imports.add(name) - if (refs[name]) return name - refs[name] = schema.type === 'object' && schema.properties - ? `export interface ${name} ${_formatType(schema)}` - : `export type ${name} = ${_formatType(schema)}` - return name +function formatObject(properties: Schema[], parentName: string, project?: Project): string { + if (!properties.length) return '' + return properties.map((schema) => { + const name = parentName ? parentName + capitalize(camelCase(schema.name)) : undefined + const desc = schema.description ? ` /** ${schema.description.replace(/\n/g, '').trim()} */\n` : '' + return `${desc} ${schema.name}${schema.required ? '' : '?'}: ${formatType(schema, name!, project, false)}` + }).join('\n') + '\n' } -function _formatType(schema: Schema, imports = new Set(), inArray?: boolean) { +function formatType(schema: Schema, name: string, project?: Project, inArray?: boolean) { + if (schema.ref) { + name = capitalize(camelCase(schema.ref.replace(/\./g, '_'))) + project?.imports.add(name) + if (refs[name]) return name + } + let isEnum = !!((project || schema.ref) && schema.options) + if (isEnum) { + if (schema.type === 'int') { + isEnum = schema.options!.every(v => !/^\d+$/.test(v.name) && /^\w+$/.test(v.name)) + } else if (schema.type === 'string') { + isEnum = !!schema.ref + } else { + isEnum = false + } + } + if (isEnum) { + const decl = `export const enum ${name} {\n${formatEnum(schema.options!, schema.type)}}` + if (schema.ref) { + refs[name] = decl + } else { + project!.interfaces.push(decl) + } + return name + } + if (!schema.ref) { + return _formatType(schema, name, project, inArray) + } + refs[name!] = schema.type === 'object' && schema.properties + ? `export interface ${name} ${_formatType(schema, name)}` + : `export type ${name} = ${_formatType(schema, name)}` + return name! +} + +function _formatType(schema: Schema, parentName: string, project?: Project, inArray?: boolean) { if (schema.type === 'file') return 'Blob' - if (schema.type === 'int') { + if (schema.type === 'float') return 'number' + if (schema.type === 'int' || schema.type === 'int64') { if (schema.options) { const output = schema.options.map(v => v.value).join(' | ') return inArray ? `(${output})` : output @@ -152,7 +192,6 @@ function _formatType(schema: Schema, imports = new Set(), inArray?: bool return 'number' } } - if (schema.type === 'float') return 'number' if (schema.type === 'string') { if (schema.options) { const output = schema.options.map(v => `'${v.value}'`).join(' | ') @@ -164,19 +203,26 @@ function _formatType(schema: Schema, imports = new Set(), inArray?: bool if (schema.type === 'boolean') return 'boolean' if (schema.type === 'object') { if (!schema.properties) return 'unknown' - return `{\n${generateParams(schema.properties, imports)}}` - } else if (schema.type === 'list') { - return formatType(schema.items!, imports, true) + '[]' + return `{\n${formatObject(schema.properties, parentName, project)}}` } + if (schema.type === 'list') { + let name = parentName + if (name.endsWith('List')) { + name = parentName.slice(0, -4) + } + return formatType(schema.items!, name, project, true) + '[]' + } + if (schema.type === 'map') { + const key = formatType(schema.keyType!, parentName + 'Key', project) + const value = formatType(schema.valueType!, parentName + 'Value', project) + return `Record<${key}, ${value}>` + } + console.log(`unknown type: ${schema.type}`) return 'unknown' } -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') + '\n' +function createInterface(name: string, properties: Schema[], project: Project, parent?: string): string { + return `export interface ${name}${parent ? ` extends ${parent}` : ''} {\n${formatObject(properties, name, project)}}` } function getApiName(detail: ApiDetail) { @@ -185,16 +231,15 @@ function getApiName(detail: ApiDetail) { project = project + detail.version.toUpperCase() } if (detail.project === detail.resource) { - return toHump(`${detail.apiName}.${project}`) + return camelCase(`${detail.apiName}.${project}`.replace(/\./g, '_')) } else { - return toHump(`${detail.apiName}.${project}.${detail.resource}`) + return camelCase(`${detail.apiName}.${project}.${detail.resource}`.replace(/\./g, '_')) } } interface Project { methods: string[] - requests: string[] - responses: string[] + interfaces: string[] internals: string[] imports: Set internalImports: Set @@ -222,8 +267,7 @@ async function start() { const summary = data.apis[index] const project = projects[detail.project] ||= { methods: [], - requests: [], - responses: [], + interfaces: [], internals: [], imports: new Set(), internalImports: new Set(['Internal']), @@ -238,16 +282,17 @@ async function start() { let returnType: string let paginationRequest: { queryType?: string } | undefined for (const property of detail.request.path?.properties || []) { - args.push(`${property.name}: ${formatType(property, project.imports)}`) + const name = apiType + capitalize(camelCase(property.name)) + args.push(`${property.name}: ${formatType(property, name, project)}`) } 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)}}`) + project.interfaces.push(createInterface(name, detail.request.body!.properties, project)) 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)}}`) + project.interfaces.push(createInterface(name, detail.request.body.properties, project)) args.push(`body: ${name}`) } if (detail.request.query?.properties?.length) { @@ -257,14 +302,14 @@ async function start() { const properties = detail.request.query.properties.filter(s => s.name !== 'page_token' && s.name !== 'page_size') if (properties.length) { project.internalImports.add('Pagination') - project.requests.push(`export interface ${queryType} extends Pagination {\n${generateParams(properties, project.imports)}}`) + project.interfaces.push(createInterface(queryType, properties, project, 'Pagination')) paginationRequest = { queryType } } else { queryType = 'Pagination' paginationRequest = {} } } else { - project.requests.push(`export interface ${queryType} {\n${generateParams(detail.request.query.properties, project.imports)}}`) + project.interfaces.push(createInterface(queryType, detail.request.query.properties, project)) } args.push(`query?: ${queryType}`) } @@ -286,36 +331,49 @@ async function start() { returnType = 'Promise' } else { const responseType = `${apiType}Response` - const keys = (data.properties || []).map(v => v.name) + const _keys = (data.properties || []).map(v => v.name) + const keys = new Set(_keys) let pagination: [string, string, Schema] | undefined - if (keys.includes('has_more') && (keys.includes('page_token') || keys.includes('next_page_token')) && keys.length === 3) { - const list = (data.properties || []).find(v => !['has_more', 'page_token', 'next_page_token'].includes(v.name))! + const isPagination = keys.delete('page_token') || keys.delete('next_page_token') + keys.delete('has_more') + keys.delete('count') + keys.delete('total_count') + keys.delete('total') + keys.delete('page_size') + if (isPagination && keys.size === 1) { + const list = (data.properties || []).find(v => v.name === [...keys][0])! if (list.type === 'list') { - const tokenKey = keys.includes('page_token') ? 'page_token' : 'next_page_token' + const tokenKey = _keys.includes('page_token') ? 'page_token' : 'next_page_token' pagination = [list.name, tokenKey, list.items!] } } if (pagination) { const [itemsKey, tokenKey, schema] = pagination - let innerType = formatType(schema, project.imports) + let innerType = formatType(schema, apiType + 'Item', project) if (schema.type === 'object' && schema.properties && !schema.ref) { - project.responses.push(`export interface ${apiType}Item ${innerType}`) + project.interfaces.push(`export interface ${apiType}Item ${innerType}`) innerType = `${apiType}Item` } - returnType = itemsKey === 'items' ? `Paginated<${innerType}>` : `Paginated<${innerType}, '${itemsKey}'>` + // standard pagination response + if (_keys.length === 3 && _keys.includes('has_more') && _keys.includes('page_token')) { + returnType = itemsKey === 'items' ? `Paginated<${innerType}>` : `Paginated<${innerType}, '${itemsKey}'>` + } else { + returnType = `Promise<${responseType}> & AsyncIterableIterator<${innerType}>` + project.interfaces.push(createInterface(responseType, data.properties, project)) + } paginationResponse = { innerType, tokenKey, itemsKey } } else { if (detail.pagination) { - console.log(`unsupported pagination (${keys.join(', ')}), see https://open.feishu.cn${summary.fullPath}}`) + console.log(`unsupported pagination (${_keys}), see https://open.feishu.cn${summary.fullPath}}`) } - project.responses.push(`export interface ${responseType} {\n${generateParams(data.properties, project.imports)}}`) + project.interfaces.push(createInterface(responseType, data.properties, project)) returnType = `Promise<${responseType}>` } } } else { const responseType = `${apiType}Response` const properties = detail.response.body.properties!.filter(v => !['code', 'msg'].includes(v.name)) - project.responses.push(`export interface ${responseType} extends BaseResponse {\n${generateParams(properties, project.imports)}}`) + project.interfaces.push(createInterface(responseType, properties, project, 'BaseResponse')) extras.push(`type: 'raw-json'`) project.internalImports.add('BaseResponse') returnType = `Promise<${responseType}>` @@ -376,8 +434,7 @@ async function start() { } } `.replace('__METHODS__', project.methods.join('\n').split('\n').join('\n ')), - ...project.requests, - ...project.responses, + ...project.interfaces, dedent` Internal.define({ __DEFINES__ diff --git a/adapters/lark/src/internal.ts b/adapters/lark/src/internal.ts index 82b43f8f..973b2dc5 100644 --- a/adapters/lark/src/internal.ts +++ b/adapters/lark/src/internal.ts @@ -10,11 +10,10 @@ export interface BaseResponse { msg: string } -export type Paginated = +export type Paginated = & Promise< & { [K in ItemsKey]: T[] } - & { [K in TokenKey]?: string } - & { has_more: boolean } + & { page_token?: string; has_more: boolean } > & AsyncIterableIterator @@ -130,7 +129,7 @@ export class Internal { iterArgs[argIndex].page_token = data[tokenKey] return { data: data[itemsKey], - next: data.has_more ? iterArgs : undefined, + next: data[tokenKey] ? iterArgs : undefined, } } } diff --git a/adapters/lark/src/types/acs.ts b/adapters/lark/src/types/acs.ts index f83920de..649c727c 100644 --- a/adapters/lark/src/types/acs.ts +++ b/adapters/lark/src/types/acs.ts @@ -91,6 +91,11 @@ export interface GetAcsUserQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetAcsUserResponse { + /** 门禁用户信息 */ + user?: User +} + export interface ListAcsUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -131,6 +136,11 @@ export interface GetAcsRuleExternalQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetAcsRuleExternalResponse { + /** 设备权限组信息 */ + rules: Rule[] +} + export interface DeleteAcsRuleExternalQuery { /** 权限组id */ rule_id: string @@ -148,6 +158,11 @@ export interface CreateAcsRuleExternalQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateAcsRuleExternalResponse { + /** 权限组id */ + rule_id: string +} + export interface DeleteAcsVisitorQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -163,6 +178,15 @@ export interface CreateAcsVisitorQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateAcsVisitorResponse { + /** 访客的id */ + visitor_id: string +} + +export interface ListAcsDeviceResponse { + items?: Device[] +} + export interface ListAcsAccessRecordQuery extends Pagination { /** 记录开始时间,单位秒 */ from: number @@ -174,30 +198,6 @@ export interface ListAcsAccessRecordQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetAcsUserResponse { - /** 门禁用户信息 */ - user?: User -} - -export interface GetAcsRuleExternalResponse { - /** 设备权限组信息 */ - rules: Rule[] -} - -export interface CreateAcsRuleExternalResponse { - /** 权限组id */ - rule_id: string -} - -export interface CreateAcsVisitorResponse { - /** 访客的id */ - visitor_id: string -} - -export interface ListAcsDeviceResponse { - items?: Device[] -} - Internal.define({ '/acs/v1/users/{user_id}': { PATCH: 'patchAcsUser', diff --git a/adapters/lark/src/types/admin.ts b/adapters/lark/src/types/admin.ts index f3ddf0b1..72e918d6 100644 --- a/adapters/lark/src/types/admin.ts +++ b/adapters/lark/src/types/admin.ts @@ -137,6 +137,11 @@ export interface CreateAdminBadgeRequest { i18n_explanation?: I18n } +export interface CreateAdminBadgeResponse { + /** 勋章的信息 */ + badge?: Badge +} + export interface UpdateAdminBadgeRequest { /** 租户内唯一的勋章名称,最多30个字符。 */ name: string @@ -152,11 +157,28 @@ export interface UpdateAdminBadgeRequest { i18n_explanation?: I18n } +export interface UpdateAdminBadgeResponse { + /** 勋章信息 */ + badge?: Badge +} + +export const enum CreateAdminBadgeImageFormImageType { + /** 勋章详情图 */ + Detail = 1, + /** 勋章挂饰图 */ + Show = 2, +} + export interface CreateAdminBadgeImageForm { /** 勋章图片的文件,仅支持 PNG 格式,320 x 320 像素,大小不超过 1024 KB。 */ image_file: Blob /** 图片的类型 */ - image_type: 1 | 2 + image_type: CreateAdminBadgeImageFormImageType +} + +export interface CreateAdminBadgeImageResponse { + /** 图片的key */ + image_key?: string } export interface ListAdminBadgeQuery extends Pagination { @@ -164,11 +186,23 @@ export interface ListAdminBadgeQuery extends Pagination { name?: string } +export interface GetAdminBadgeResponse { + /** 勋章信息 */ + badge?: Badge +} + +export const enum CreateAdminBadgeGrantRequestGrantType { + /** 手动选择有效期 */ + Manual = 0, + /** 匹配系统入职时间 */ + JoinTime = 1, +} + export interface CreateAdminBadgeGrantRequest { /** 授予名单名称,最多100个字符。 */ name: string /** 勋章下唯一的授予事项 */ - grant_type: 0 | 1 + grant_type: CreateAdminBadgeGrantRequestGrantType /** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */ time_zone: string /** 规则详情 */ @@ -190,11 +224,23 @@ export interface CreateAdminBadgeGrantQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface CreateAdminBadgeGrantResponse { + /** 授予名单的信息 */ + grant?: Grant +} + +export const enum UpdateAdminBadgeGrantRequestGrantType { + /** 手动选择有效期 */ + Manual = 0, + /** 匹配系统入职时间 */ + JoinTime = 1, +} + export interface UpdateAdminBadgeGrantRequest { /** 授予名单名称,最多100个字符。 */ name: string /** 勋章下唯一的授予事项 */ - grant_type: 0 | 1 + grant_type: UpdateAdminBadgeGrantRequestGrantType /** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */ time_zone: string /** 规则详情 */ @@ -216,6 +262,11 @@ export interface UpdateAdminBadgeGrantQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface UpdateAdminBadgeGrantResponse { + /** 授予名单 */ + grant?: Grant +} + export interface ListAdminBadgeGrantQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' @@ -232,6 +283,20 @@ export interface GetAdminBadgeGrantQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface GetAdminBadgeGrantResponse { + /** 授予名单信息 */ + grant?: Grant +} + +export const enum ListAdminAuditInfoQueryUserType { + /** 互联网上的任何人 */ + All = 0, + /** 组织内成员 */ + NormalUser = 1, + /** 组织外成员 */ + ExternalUser = 2, +} + export interface ListAdminAuditInfoQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -248,7 +313,7 @@ export interface ListAdminAuditInfoQuery extends Pagination { /** 过滤模块 */ event_module?: number /** 过滤用户类型. 仅当 operator_type=user 时生效 */ - user_type?: 0 | 1 | 2 + user_type?: ListAdminAuditInfoQueryUserType /** 过滤操作对象: 操作对象类型. 与object_value配合使用 */ object_type?: number /** 过滤操作对象: 操作对象ID. 与object_type配合使用 */ @@ -257,41 +322,6 @@ export interface ListAdminAuditInfoQuery extends Pagination { ext_filter_object_by_ccm_token?: string } -export interface CreateAdminBadgeResponse { - /** 勋章的信息 */ - badge?: Badge -} - -export interface UpdateAdminBadgeResponse { - /** 勋章信息 */ - badge?: Badge -} - -export interface CreateAdminBadgeImageResponse { - /** 图片的key */ - image_key?: string -} - -export interface GetAdminBadgeResponse { - /** 勋章信息 */ - badge?: Badge -} - -export interface CreateAdminBadgeGrantResponse { - /** 授予名单的信息 */ - grant?: Grant -} - -export interface UpdateAdminBadgeGrantResponse { - /** 授予名单 */ - grant?: Grant -} - -export interface GetAdminBadgeGrantResponse { - /** 授予名单信息 */ - grant?: Grant -} - Internal.define({ '/admin/v1/password/reset': { POST: 'resetAdminPassword', diff --git a/adapters/lark/src/types/aily.ts b/adapters/lark/src/types/aily.ts index d65299b1..3130e540 100644 --- a/adapters/lark/src/types/aily.ts +++ b/adapters/lark/src/types/aily.ts @@ -98,6 +98,11 @@ export interface CreateAilyAilySessionRequest { metadata?: string } +export interface CreateAilyAilySessionResponse { + /** 创建的会话信息 */ + session?: AilySession +} + export interface UpdateAilyAilySessionRequest { /** 渠道上下文 */ channel_context?: string @@ -105,6 +110,16 @@ export interface UpdateAilyAilySessionRequest { metadata?: string } +export interface UpdateAilyAilySessionResponse { + /** 会话信息 */ + session?: AilySession +} + +export interface GetAilyAilySessionResponse { + /** 会话信息 */ + session?: AilySession +} + export interface CreateAilyAilySessionAilyMessageRequest { /** 幂等id,同一 session 下相同的幂等 id 算一条消息,有效期72h */ idempotent_id: string @@ -120,6 +135,16 @@ export interface CreateAilyAilySessionAilyMessageRequest { mentions?: AilyMention[] } +export interface CreateAilyAilySessionAilyMessageResponse { + /** 消息信息 */ + message?: AilyMessage +} + +export interface GetAilyAilySessionAilyMessageResponse { + /** 消息信息 */ + message?: AilyMessage +} + export interface ListAilyAilySessionAilyMessageQuery extends Pagination { /** 运行 ID */ run_id?: string @@ -138,67 +163,6 @@ export interface CreateAilyAilySessionRunRequest { metadata?: string } -export interface StartAilyAppSkillRequest { - /** 技能的全局变量 */ - global_variable?: SkillGlobalVariable - /** 技能的自定义变量 */ - input?: string -} - -export interface AskAilyAppKnowledgeRequest { - /** 输入消息(当前仅支持纯文本输入) */ - message: AilyKnowledgeMessage - /** 控制知识问答所依据的数据知识范围 */ - data_asset_ids?: string[] - /** 控制知识问答所依据的数据知识分类范围 */ - data_asset_tag_ids?: string[] -} - -export interface ListAilyAppDataAssetQuery extends Pagination { - /** 模糊匹配关键词 */ - keyword?: string - /** 根据数据知识 ID 进行过滤 */ - data_asset_ids?: string[] - /** 根据数据知识分类 ID 进行过滤 */ - data_asset_tag_ids?: string[] - /** 结果是否包含数据与知识项目 */ - with_data_asset_item?: boolean - /** 结果是否包含数据连接状态 */ - with_connect_status?: boolean -} - -export interface ListAilyAppDataAssetTagQuery extends Pagination { - /** 模糊匹配分类名称 */ - keyword?: string - /** 模糊匹配分类名称 */ - data_asset_tag_ids?: string[] -} - -export interface CreateAilyAilySessionResponse { - /** 创建的会话信息 */ - session?: AilySession -} - -export interface UpdateAilyAilySessionResponse { - /** 会话信息 */ - session?: AilySession -} - -export interface GetAilyAilySessionResponse { - /** 会话信息 */ - session?: AilySession -} - -export interface CreateAilyAilySessionAilyMessageResponse { - /** 消息信息 */ - message?: AilyMessage -} - -export interface GetAilyAilySessionAilyMessageResponse { - /** 消息信息 */ - message?: AilyMessage -} - export interface CreateAilyAilySessionRunResponse { /** 运行信息 */ run?: Run @@ -214,6 +178,13 @@ export interface CancelAilyAilySessionRunResponse { run?: Run } +export interface StartAilyAppSkillRequest { + /** 技能的全局变量 */ + global_variable?: SkillGlobalVariable + /** 技能的自定义变量 */ + input?: string +} + export interface StartAilyAppSkillResponse { /** 技能的输出 */ output?: string @@ -226,6 +197,15 @@ export interface GetAilyAppSkillResponse { skill?: Skill } +export interface AskAilyAppKnowledgeRequest { + /** 输入消息(当前仅支持纯文本输入) */ + message: AilyKnowledgeMessage + /** 控制知识问答所依据的数据知识范围 */ + data_asset_ids?: string[] + /** 控制知识问答所依据的数据知识分类范围 */ + data_asset_tag_ids?: string[] +} + export interface AskAilyAppKnowledgeResponse { /** 响应状态,枚举值 */ status?: 'processing' | 'finished' @@ -241,6 +221,26 @@ export interface AskAilyAppKnowledgeResponse { has_answer?: boolean } +export interface ListAilyAppDataAssetQuery extends Pagination { + /** 模糊匹配关键词 */ + keyword?: string + /** 根据数据知识 ID 进行过滤 */ + data_asset_ids?: string[] + /** 根据数据知识分类 ID 进行过滤 */ + data_asset_tag_ids?: string[] + /** 结果是否包含数据与知识项目 */ + with_data_asset_item?: boolean + /** 结果是否包含数据连接状态 */ + with_connect_status?: boolean +} + +export interface ListAilyAppDataAssetTagQuery extends Pagination { + /** 模糊匹配分类名称 */ + keyword?: string + /** 模糊匹配分类名称 */ + data_asset_tag_ids?: string[] +} + Internal.define({ '/aily/v1/sessions': { POST: 'createAilyAilySession', diff --git a/adapters/lark/src/types/apaas.ts b/adapters/lark/src/types/apaas.ts index 8ce0c591..bdc7d76d 100644 --- a/adapters/lark/src/types/apaas.ts +++ b/adapters/lark/src/types/apaas.ts @@ -191,11 +191,23 @@ export interface AuditLogListApaasApplicationAuditLogQuery { app_type?: string } +export interface AuditLogListApaasApplicationAuditLogResponse { + /** 审计日志查询结果列表详情信息 */ + items?: AuditLogEsField[] + /** 审计日志查询总条数 */ + total?: string +} + export interface GetApaasApplicationAuditLogQuery { /** 审计日志ID信息 */ log_id: string } +export interface GetApaasApplicationAuditLogResponse { + /** 审计日志详情信息 */ + data?: AuditLogDetail +} + export interface BatchRemoveAuthorizationApaasApplicationRoleMemberRequest { /** 需要删除的用户 ID 列表 */ user_ids?: string[] @@ -217,6 +229,11 @@ export interface GetApaasApplicationRoleMemberQuery { use_api_id?: boolean } +export interface GetApaasApplicationRoleMemberResponse { + /** 角色成员 */ + role_member?: RoleMember +} + export interface BatchRemoveAuthorizationApaasApplicationRecordPermissionMemberRequest { /** 需要删除的用户 ID 列表 */ user_ids?: string[] @@ -236,6 +253,13 @@ export interface OqlQueryApaasApplicationObjectRequest { named_args?: string } +export interface OqlQueryApaasApplicationObjectResponse { + /** 每一列的标题 */ + columns: string[] + /** 每一行的值,以「key-value」的形式返回 */ + rows: string +} + export interface SearchApaasApplicationObjectRequest { /** 搜索词 */ q?: string @@ -249,11 +273,27 @@ export interface SearchApaasApplicationObjectRequest { metadata?: 'Label' | 'SearchLayout' } +export interface SearchApaasApplicationObjectResponse { + /** 搜索结果列表 */ + records?: string + /** 是否还有更多数据 */ + has_more?: boolean + /** 分页标记,当 HasMore 为 true 时,会同时返回新的 NextPageToken */ + next_page_token?: string + /** 对象信息 */ + objects?: ObjectMeta[] +} + export interface QueryApaasApplicationObjectRecordRequest { /** 需要获取的字段,使用字段唯一标识符进行查询,关联字段可使用 . 进行下钻 */ select?: string[] } +export interface QueryApaasApplicationObjectRecordResponse { + /** 记录详情,格式为 Map */ + item: string +} + export interface PatchApaasApplicationObjectRecordRequest { /** 创建对象使用的数据,键为字段 API 名称,值为字段值,格式可参考字段值格式 */ record: string @@ -264,11 +304,21 @@ export interface CreateApaasApplicationObjectRecordRequest { record: string } +export interface CreateApaasApplicationObjectRecordResponse { + /** 记录 ID */ + id?: string +} + export interface BatchUpdateApaasApplicationObjectRecordRequest { /** 记录详情列表,格式为 List>,操作记录数上限为 500 条 */ records: string } +export interface BatchUpdateApaasApplicationObjectRecordResponse { + /** 处理结果 */ + items?: RecordResult[] +} + export interface BatchQueryApaasApplicationObjectRecordRequest { /** 需要获取的字段,使用字段唯一标识符进行查询,关联字段可使用「.」进行下钻 */ select: string[] @@ -290,21 +340,47 @@ export interface BatchQueryApaasApplicationObjectRecordRequest { need_total_count?: boolean } +export interface BatchQueryApaasApplicationObjectRecordResponse { + /** 符合条件的记录列表 */ + items: string + /** 符合条件的记录数 */ + total?: number + /** 下一页的起始位置 Token ,访问至末尾时不返回 */ + next_page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + export interface BatchDeleteApaasApplicationObjectRecordRequest { /** 记录 ID 列表,操作记录数上限为 500 */ ids: string[] } +export interface BatchDeleteApaasApplicationObjectRecordResponse { + /** 处理结果 */ + items?: RecordResult[] +} + export interface BatchCreateApaasApplicationObjectRecordRequest { /** 记录详情列表,格式为 List>,操作记录数上限为 500 条 */ records: string } +export interface BatchCreateApaasApplicationObjectRecordResponse { + /** 处理结果 */ + items?: RecordResult[] +} + export interface InvokeApaasApplicationFunctionRequest { /** 函数输入参数(JSON 序列化后的字符串) */ params?: string } +export interface InvokeApaasApplicationFunctionResponse { + /** 函数执行的返回结果(JSON 序列化后的字符串) */ + result?: string +} + export interface QueryApaasApplicationEnvironmentVariableRequest { /** 过滤条件 */ filter?: EnvironmentVariableFilter @@ -314,6 +390,18 @@ export interface QueryApaasApplicationEnvironmentVariableRequest { offset?: number } +export interface QueryApaasApplicationEnvironmentVariableResponse { + /** 环境变量列表 */ + items?: EnvironmentVariable[] + /** 符合查询条件的环境变量的总数 */ + total: number +} + +export interface GetApaasApplicationEnvironmentVariableResponse { + /** 环境变量详情 */ + item?: EnvironmentVariable +} + export interface ExecuteApaasApplicationFlowRequest { /** 是否异步执行 */ is_async?: boolean @@ -327,6 +415,19 @@ export interface ExecuteApaasApplicationFlowRequest { operator: string } +export interface ExecuteApaasApplicationFlowResponse { + /** 状态 */ + status?: string + /** 输出参数 */ + out_params?: string + /** 执行id */ + execution_id?: string + /** 错误信息 */ + error_msg?: string + /** code */ + code?: string +} + export interface QueryApaasUserTaskRequest { /** 类型 */ type?: string @@ -346,6 +447,13 @@ export interface QueryApaasUserTaskRequest { kunlun_user_id: string } +export interface QueryApaasUserTaskResponse { + /** 总任务条数 */ + count?: string + /** 任务信息 */ + tasks?: UserTask[] +} + export interface AgreeApaasApprovalTaskRequest { /** 操作人id */ user_id: string @@ -410,6 +518,11 @@ export interface RollbackPointsApaasUserTaskRequest { operator_user_id: string } +export interface RollbackPointsApaasUserTaskResponse { + /** 任务列表 */ + tasks?: AllowedRollbaclkTaskItemType[] +} + export interface RollbackApaasUserTaskRequest { /** 操作人kunlunUserID */ operator_user_id: string @@ -430,119 +543,6 @@ export interface ChatGroupApaasUserTaskRequest { chat_name?: string } -export interface AuditLogListApaasApplicationAuditLogResponse { - /** 审计日志查询结果列表详情信息 */ - items?: AuditLogEsField[] - /** 审计日志查询总条数 */ - total?: string -} - -export interface GetApaasApplicationAuditLogResponse { - /** 审计日志详情信息 */ - data?: AuditLogDetail -} - -export interface GetApaasApplicationRoleMemberResponse { - /** 角色成员 */ - role_member?: RoleMember -} - -export interface OqlQueryApaasApplicationObjectResponse { - /** 每一列的标题 */ - columns: string[] - /** 每一行的值,以「key-value」的形式返回 */ - rows: string -} - -export interface SearchApaasApplicationObjectResponse { - /** 搜索结果列表 */ - records?: string - /** 是否还有更多数据 */ - has_more?: boolean - /** 分页标记,当 HasMore 为 true 时,会同时返回新的 NextPageToken */ - next_page_token?: string - /** 对象信息 */ - objects?: ObjectMeta[] -} - -export interface QueryApaasApplicationObjectRecordResponse { - /** 记录详情,格式为 Map */ - item: string -} - -export interface CreateApaasApplicationObjectRecordResponse { - /** 记录 ID */ - id?: string -} - -export interface BatchUpdateApaasApplicationObjectRecordResponse { - /** 处理结果 */ - items?: RecordResult[] -} - -export interface BatchQueryApaasApplicationObjectRecordResponse { - /** 符合条件的记录列表 */ - items: string - /** 符合条件的记录数 */ - total?: number - /** 下一页的起始位置 Token ,访问至末尾时不返回 */ - next_page_token?: string - /** 是否还有数据 */ - has_more?: boolean -} - -export interface BatchDeleteApaasApplicationObjectRecordResponse { - /** 处理结果 */ - items?: RecordResult[] -} - -export interface BatchCreateApaasApplicationObjectRecordResponse { - /** 处理结果 */ - items?: RecordResult[] -} - -export interface InvokeApaasApplicationFunctionResponse { - /** 函数执行的返回结果(JSON 序列化后的字符串) */ - result?: string -} - -export interface QueryApaasApplicationEnvironmentVariableResponse { - /** 环境变量列表 */ - items?: EnvironmentVariable[] - /** 符合查询条件的环境变量的总数 */ - total: number -} - -export interface GetApaasApplicationEnvironmentVariableResponse { - /** 环境变量详情 */ - item?: EnvironmentVariable -} - -export interface ExecuteApaasApplicationFlowResponse { - /** 状态 */ - status?: string - /** 输出参数 */ - out_params?: string - /** 执行id */ - execution_id?: string - /** 错误信息 */ - error_msg?: string - /** code */ - code?: string -} - -export interface QueryApaasUserTaskResponse { - /** 总任务条数 */ - count?: string - /** 任务信息 */ - tasks?: UserTask[] -} - -export interface RollbackPointsApaasUserTaskResponse { - /** 任务列表 */ - tasks?: AllowedRollbaclkTaskItemType[] -} - export interface ChatGroupApaasUserTaskResponse { /** 创建的群聊ID */ chat_id?: string diff --git a/adapters/lark/src/types/application.ts b/adapters/lark/src/types/application.ts index ab661fa2..b3aa50d8 100644 --- a/adapters/lark/src/types/application.ts +++ b/adapters/lark/src/types/application.ts @@ -37,7 +37,7 @@ declare module '../internal' { * 获取企业安装的应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/list */ - listApplication(query?: ListApplicationQuery): Promise + listApplication(query?: ListApplicationQuery): Promise & AsyncIterableIterator /** * 查看待审核的应用列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist @@ -112,12 +112,12 @@ declare module '../internal' { * 获取用户自定义常用的应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/favourite */ - favouriteApplication(query?: FavouriteApplicationQuery): Promise + favouriteApplication(query?: FavouriteApplicationQuery): Promise & AsyncIterableIterator /** * 获取管理员推荐的应用 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/recommend */ - recommendApplication(query?: RecommendApplicationQuery): Promise + recommendApplication(query?: RecommendApplicationQuery): Promise & AsyncIterableIterator /** * 获取当前设置的推荐规则列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list @@ -133,6 +133,11 @@ export interface GetApplicationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetApplicationResponse { + /** 应用数据 */ + app?: Application +} + export interface GetApplicationApplicationAppVersionQuery { /** 应用信息的语言版本 */ lang: 'zh_cn' | 'en_us' | 'ja_jp' @@ -140,6 +145,10 @@ export interface GetApplicationApplicationAppVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetApplicationApplicationAppVersionResponse { + app_version?: ApplicationAppVersion +} + export interface ListApplicationApplicationAppVersionQuery extends Pagination { /** 应用信息的语言版本 */ lang: 'zh_cn' | 'en_us' | 'ja_jp' @@ -156,17 +165,61 @@ export interface ContactsRangeSuggestApplicationApplicationAppVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ContactsRangeSuggestApplicationApplicationAppVersionResponse { + contacts_range?: ApplicationAppContactsRange +} + +export interface ListApplicationScopeResponse { + scopes?: Scope[] +} + +export const enum ListApplicationQueryStatus { + /** 停用 */ + AvailabilityStopped = 0, + /** 启用 */ + AvailabilityActivated = 1, + /** 未启用 */ + AvailabilityUnactivated = 2, +} + +export const enum ListApplicationQueryPaymentType { + /** 免费 */ + Free = 0, + /** 付费 */ + Paid = 1, +} + +export const enum ListApplicationQueryOwnerType { + /** 飞书科技 */ + FeishuTechnology = 0, + /** 飞书合作伙伴 */ + FeishuThirdParty = 1, + /** 企业内成员 */ + EnterpriseMember = 2, +} + export interface ListApplicationQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: string /** 应用的图标、描述、帮助文档链接是按照应用的主语言返回;其他内容(如应用权限、应用分类)按照该参数设定返回对应的语言。可选值有: zh_cn:中文 en_us:英文 ja_jp:日文 如不填写,则按照应用的主语言返回 */ lang: string /** 不传入代表全部返回。传入则按照这种应用状态返回。应用状态可选值有:0:停用状态1:启用状态 2:未启用状态 */ - status?: 0 | 1 | 2 + status?: ListApplicationQueryStatus /** 不传入代表全部返回。传入则按照这种应用状态返回。 付费类型 可选值: 0:免费 1:付费 */ - payment_type?: 0 | 1 + payment_type?: ListApplicationQueryPaymentType /** 不传入代表全部返回。传入则按照这种应用状态返回。所有者类型,可选值: 0:飞书科技 1:飞书合作伙伴 2:企业内成员 */ - owner_type?: 0 | 1 | 2 + owner_type?: ListApplicationQueryOwnerType +} + +export interface ListApplicationResponse { + /** 应用列表 */ + app_list?: Application[] + /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean + /** 应用状态=启用的应用总数 */ + total_count?: number } export interface UnderauditlistApplicationQuery extends Pagination { @@ -176,9 +229,22 @@ export interface UnderauditlistApplicationQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum PatchApplicationApplicationAppVersionRequestStatus { + /** 未知状态 */ + Unknown = 0, + /** 审核通过 */ + Audited = 1, + /** 审核拒绝 */ + Reject = 2, + /** 审核中 */ + UnderAudit = 3, + /** 未提交审核 */ + Unaudit = 4, +} + export interface PatchApplicationApplicationAppVersionRequest { /** 版本状态 */ - status?: 0 | 1 | 2 | 3 | 4 + status?: PatchApplicationApplicationAppVersionRequestStatus } export interface PatchApplicationApplicationAppVersionQuery { @@ -207,6 +273,14 @@ export interface ContactsRangeConfigurationApplicationQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ContactsRangeConfigurationApplicationResponse { + contacts_range?: ApplicationAppContactsRange + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ + page_token?: string +} + export interface PatchApplicationApplicationContactsRangeRequest { /** 更新范围方式 */ contacts_range_type: 'equal_to_availability' | 'some' | 'all' @@ -239,6 +313,15 @@ export interface CheckWhiteBlackListApplicationApplicationVisibilityQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface CheckWhiteBlackListApplicationApplicationVisibilityResponse { + /** 用户可见性信息列表 */ + user_visibility_list?: ApplicationVisibilityUserWhiteBlackInfo[] + /** 部门可见性信息列表 */ + department_visibility_list?: ApplicationVisibilityDepartmentWhiteBlackInfo[] + /** 用户组可见性信息列表 */ + group_visibility_list?: ApplicationVisibilityGroupWhiteBlackInfo[] +} + export interface PatchApplicationApplicationVisibilityRequest { /** 添加可用人员名单 */ add_visible_list?: AppVisibilityIdList @@ -264,11 +347,20 @@ export interface UpdateApplicationApplicationManagementRequest { enable?: boolean } +export const enum DepartmentOverviewApplicationApplicationAppUsageRequestCycleType { + /** 日活 */ + Day = 1, + /** 周活, date字段应该填自然周周一的日期 */ + Week = 2, + /** 月活, date字段应该填自然月1号的日期 */ + Month = 3, +} + export interface DepartmentOverviewApplicationApplicationAppUsageRequest { /** 查询日期,格式为yyyy-mm-dd,若cycle_type为1,date可以为任何自然日;若cycle_type为2,则输入的date必须为周一; 若cycle_type为3,则输入的date必须为每月1号 */ date: string /** 活跃周期的统计类型 */ - cycle_type: 1 | 2 | 3 + cycle_type: DepartmentOverviewApplicationApplicationAppUsageRequestCycleType /** 查询的部门id,获取方法可参考[部门ID概述](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)- 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户) 以及多级子部门的使用数据。- 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。- 若不填写则返回整个租户的数据 */ department_id?: string /** 是否需要查询部门下多层子部门的数据。未设置或为0时,仅查询department_id对应的部门。设置为n时,查询department_id及其n级子部门的数据。仅在department_id参数传递时有效,最大值为4。 */ @@ -284,11 +376,20 @@ export interface DepartmentOverviewApplicationApplicationAppUsageQuery { department_id_type?: 'department_id' | 'open_department_id' } +export const enum MessagePushOverviewApplicationApplicationAppUsageRequestCycleType { + /** 日活 */ + Day = 1, + /** 周活, date字段应该填自然周周一的日期 */ + Week = 2, + /** 月活, date字段应该填自然月1号的日期 */ + Month = 3, +} + export interface MessagePushOverviewApplicationApplicationAppUsageRequest { /** 查询日期,若cycle_type为week,则输入的date必须为周一; 若cycle_type为month,则输入的date必须为每月1号 */ date: string /** 枚举值:day,week,month;week指自然周,返回当前日期所在周的数据;不满一周则从周一到当前日期算。month指自然月,返回当前日期所在月的数据。 */ - cycle_type: 1 | 2 | 3 + cycle_type: MessagePushOverviewApplicationApplicationAppUsageRequestCycleType /** 需要查询的部门id,获取方法可参考[部门ID概述](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)- 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户); - 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。返回当前部门的使用数据; 若不填写,则返回当前租户的使用数据 */ department_id?: string } @@ -298,11 +399,25 @@ export interface MessagePushOverviewApplicationApplicationAppUsageQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface MessagePushOverviewApplicationApplicationAppUsageResponse { + /** 消息推送情况 */ + items?: ApplicationAppUsage[] +} + +export const enum OverviewApplicationApplicationAppUsageRequestCycleType { + /** 日活 */ + Day = 1, + /** 周活, date字段应该填自然周周一的日期 */ + Week = 2, + /** 月活, date字段应该填自然月1号的日期 */ + Month = 3, +} + export interface OverviewApplicationApplicationAppUsageRequest { /** 查询日期,格式为yyyy-mm-dd,若cycle_type为1,date可以为任何自然日;若cycle_type为2,则输入的date必须为周一; 若cycle_type为3,则输入的date必须为每月1号 */ date: string /** 活跃周期的统计类型 */ - cycle_type: 1 | 2 | 3 + cycle_type: OverviewApplicationApplicationAppUsageRequestCycleType /** 查询的部门id,获取方法可参考[部门ID概述](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)- 若部门id为空,则返回当前租户的使用数据;若填写部门id,则返回当前部门的使用数据(包含子部门的用户); - 若路径参数中department_id_type为空或者为open_department_id,则此处应该填写部门的 open_department_id;若路径参数中department_id_type为department_id,则此处应该填写部门的 department_id。 */ department_id?: string /** 能力类型,按能力类型进行筛选,返回对应能力的活跃数据 */ @@ -314,23 +429,57 @@ export interface OverviewApplicationApplicationAppUsageQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface OverviewApplicationApplicationAppUsageResponse { + /** 员工使用应用概览数据 */ + items?: ApplicationAppUsage[] +} + +export const enum PatchApplicationApplicationFeedbackQueryStatus { + /** 反馈未处理 */ + Unmarked = 0, + /** 反馈已处理 */ + Marked = 1, + /** 反馈处理中 */ + Processing = 2, + /** 反馈已关闭 */ + Closed = 3, +} + export interface PatchApplicationApplicationFeedbackQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' /** 反馈处理状态 */ - status: 0 | 1 | 2 | 3 + status: PatchApplicationApplicationFeedbackQueryStatus /** 反馈处理人员id,租户内用户的唯一标识, ID值与查询参数中的user_id_type 对应 */ operator_id: string } +export const enum ListApplicationApplicationFeedbackQueryFeedbackType { + /** 故障反馈 */ + Fault = 1, + /** 产品建议 */ + Advice = 2, +} + +export const enum ListApplicationApplicationFeedbackQueryStatus { + /** 反馈未处理 */ + Unmarked = 0, + /** 反馈已处理 */ + Marked = 1, + /** 反馈处理中 */ + Processing = 2, + /** 反馈已关闭 */ + Closed = 3, +} + export interface ListApplicationApplicationFeedbackQuery extends Pagination { /** 查询的起始日期,格式为yyyy-mm-dd。不填则默认为当前日期减去180天。 */ from_date?: string /** 查询的结束日期,格式为yyyy-mm-dd。不填默认为当前日期。只能查询 180 天内的数据。 */ to_date?: string /** 反馈类型,不填写则表示查询所有反馈类型。 */ - feedback_type?: 1 | 2 + feedback_type?: ListApplicationApplicationFeedbackQueryFeedbackType /** 反馈处理状态,不填写则表示查询所有处理类型。 */ - status?: 0 | 1 | 2 | 3 + status?: ListApplicationApplicationFeedbackQueryStatus user_id_type?: 'open_id' | 'union_id' | 'user_id' } @@ -357,73 +506,6 @@ export interface FavouriteApplicationQuery extends Pagination { language?: 'zh_cn' | 'en_us' | 'ja_jp' } -export interface RecommendApplicationQuery extends Pagination { - /** 应用信息的语言版本 */ - language?: 'zh_cn' | 'en_us' | 'ja_jp' - /** 推荐应用类型,默认为用户不可移除的推荐应用列表 */ - recommend_type?: 'user_unremovable' | 'user_removable' -} - -export interface ListApplicationAppRecommendRuleQuery extends Pagination { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface GetApplicationResponse { - /** 应用数据 */ - app?: Application -} - -export interface GetApplicationApplicationAppVersionResponse { - app_version?: ApplicationAppVersion -} - -export interface ContactsRangeSuggestApplicationApplicationAppVersionResponse { - contacts_range?: ApplicationAppContactsRange -} - -export interface ListApplicationScopeResponse { - scopes?: Scope[] -} - -export interface ListApplicationResponse { - /** 应用列表 */ - app_list?: Application[] - /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean - /** 应用状态=启用的应用总数 */ - total_count?: number -} - -export interface ContactsRangeConfigurationApplicationResponse { - contacts_range?: ApplicationAppContactsRange - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ - page_token?: string -} - -export interface CheckWhiteBlackListApplicationApplicationVisibilityResponse { - /** 用户可见性信息列表 */ - user_visibility_list?: ApplicationVisibilityUserWhiteBlackInfo[] - /** 部门可见性信息列表 */ - department_visibility_list?: ApplicationVisibilityDepartmentWhiteBlackInfo[] - /** 用户组可见性信息列表 */ - group_visibility_list?: ApplicationVisibilityGroupWhiteBlackInfo[] -} - -export interface MessagePushOverviewApplicationApplicationAppUsageResponse { - /** 消息推送情况 */ - items?: ApplicationAppUsage[] -} - -export interface OverviewApplicationApplicationAppUsageResponse { - /** 员工使用应用概览数据 */ - items?: ApplicationAppUsage[] -} - export interface FavouriteApplicationResponse { /** 分页的token */ page_token?: string @@ -435,6 +517,13 @@ export interface FavouriteApplicationResponse { app_list?: Application[] } +export interface RecommendApplicationQuery extends Pagination { + /** 应用信息的语言版本 */ + language?: 'zh_cn' | 'en_us' | 'ja_jp' + /** 推荐应用类型,默认为用户不可移除的推荐应用列表 */ + recommend_type?: 'user_unremovable' | 'user_removable' +} + export interface RecommendApplicationResponse { /** 分页的token */ page_token?: string @@ -448,6 +537,11 @@ export interface RecommendApplicationResponse { app_list?: Application[] } +export interface ListApplicationAppRecommendRuleQuery extends Pagination { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + Internal.define({ '/application/v6/applications/{app_id}': { GET: 'getApplication', @@ -470,7 +564,7 @@ Internal.define({ GET: 'listApplicationScope', }, '/application/v6/applications': { - GET: 'listApplication', + GET: { name: 'listApplication', pagination: { argIndex: 0, itemsKey: 'app_list' } }, }, '/application/v6/applications/underauditlist': { GET: { name: 'underauditlistApplication', pagination: { argIndex: 0 } }, @@ -509,10 +603,10 @@ Internal.define({ POST: 'setApplicationAppBadge', }, '/application/v5/applications/favourite': { - GET: 'favouriteApplication', + GET: { name: 'favouriteApplication', pagination: { argIndex: 0, itemsKey: 'app_list' } }, }, '/application/v5/applications/recommend': { - GET: 'recommendApplication', + GET: { name: 'recommendApplication', pagination: { argIndex: 0, itemsKey: 'app_list' } }, }, '/application/v6/app_recommend_rules': { GET: { name: 'listApplicationAppRecommendRule', pagination: { argIndex: 0, itemsKey: 'rules' } }, diff --git a/adapters/lark/src/types/approval.ts b/adapters/lark/src/types/approval.ts index e892fab2..d4186116 100644 --- a/adapters/lark/src/types/approval.ts +++ b/adapters/lark/src/types/approval.ts @@ -122,22 +122,22 @@ declare module '../internal' { * 查询实例列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query */ - queryApprovalInstance(body: QueryApprovalInstanceRequest, query?: QueryApprovalInstanceQuery): Promise + queryApprovalInstance(body: QueryApprovalInstanceRequest, query?: QueryApprovalInstanceQuery): Promise & AsyncIterableIterator /** * 查询抄送列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc */ - searchCcApprovalInstance(body: SearchCcApprovalInstanceRequest, query?: SearchCcApprovalInstanceQuery): Promise + searchCcApprovalInstance(body: SearchCcApprovalInstanceRequest, query?: SearchCcApprovalInstanceQuery): Promise & AsyncIterableIterator /** * 查询任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search */ - searchApprovalTask(body: SearchApprovalTaskRequest, query?: SearchApprovalTaskQuery): Promise + searchApprovalTask(body: SearchApprovalTaskRequest, query?: SearchApprovalTaskQuery): Promise & AsyncIterableIterator /** * 查询用户的任务列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query */ - queryApprovalTask(query?: QueryApprovalTaskQuery): Promise + queryApprovalTask(query?: QueryApprovalTaskQuery): Promise & AsyncIterableIterator /** * 订阅审批事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe @@ -183,6 +183,13 @@ export interface CreateApprovalQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateApprovalResponse { + /** 审批定义 Code */ + approval_code?: string + /** 审批定义 id */ + approval_id?: string +} + export interface GetApprovalQuery { /** 语言可选值 */ locale?: 'zh-CN' | 'en-US' | 'ja-JP' @@ -192,6 +199,30 @@ export interface GetApprovalQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetApprovalResponse { + /** 审批名称 */ + approval_name: string + /** 审批定义状态 */ + status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'UNKNOWN' + /** 控件信息 */ + form: string + /** 节点信息 */ + node_list: ApprovalNodeInfo[] + /** 可见人列表 */ + viewers: ApprovalViewerInfo[] + /** 有数据管理权限的审批流程管理员ID */ + approval_admin_ids?: string[] + /** 组件之间值关联关系 */ + form_widget_relation?: string +} + +export const enum CreateApprovalInstanceRequestTitleDisplayMethod { + /** 如果都有title,展示approval 和instance的title,竖线分割。 */ + DisplayAll = 0, + /** 如果都有title,只展示instance的title */ + DisplayInstanceTitle = 1, +} + export interface CreateApprovalInstanceRequest { /** 审批定义 code */ approval_code: string @@ -226,11 +257,16 @@ export interface CreateApprovalInstanceRequest { /** 审批展示名称,如果填写了该字段,则审批列表中的审批名称使用该字段,如果不填该字段,则审批名称使用审批定义的名称 */ title?: string /** 详情页title展示模式 */ - title_display_method?: 0 | 1 + title_display_method?: CreateApprovalInstanceRequestTitleDisplayMethod /** 自动通过节点ID */ node_auto_approval_list?: NodeAutoApproval[] } +export interface CreateApprovalInstanceResponse { + /** 审批实例 Code */ + instance_code: string +} + export interface CancelApprovalInstanceRequest { /** 审批定义Code */ approval_code: string @@ -285,6 +321,11 @@ export interface PreviewApprovalInstanceQuery { user_id_type?: 'open_id' | 'user_id' | 'union_id' } +export interface PreviewApprovalInstanceResponse { + /** 预览节点信息 */ + preview_nodes?: PreviewNode[] +} + export interface GetApprovalInstanceQuery { /** 语言 */ locale?: 'zh-CN' | 'en-US' | 'ja-JP' @@ -294,6 +335,45 @@ export interface GetApprovalInstanceQuery { user_id_type?: 'user_id' | 'open_id' | 'union_id' } +export interface GetApprovalInstanceResponse { + /** 审批名称 */ + approval_name: string + /** 审批创建时间 */ + start_time?: string + /** 审批完成时间,未完成为 0 */ + end_time: string + /** 发起审批用户 */ + user_id: string + /** 发起审批用户 open id */ + open_id: string + /** 审批单编号 */ + serial_number: string + /** 发起审批用户所在部门 */ + department_id: string + /** 审批实例状态 */ + status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED' + /** 用户的唯一标识id */ + uuid: string + /** json字符串,控件值 */ + form: string + /** 审批任务列表 */ + task_list: InstanceTask[] + /** 评论列表 */ + comment_list: InstanceComment[] + /** 审批动态 */ + timeline: InstanceTimeline[] + /** 修改的原实例 code,仅在查询修改实例时显示该字段 */ + modified_instance_code?: string + /** 撤销的原实例 code,仅在查询撤销实例时显示该字段 */ + reverted_instance_code?: string + /** 审批定义 Code */ + approval_code: string + /** 单据是否被撤销 */ + reverted?: boolean + /** 审批实例 Code */ + instance_code: string +} + export interface ListApprovalInstanceQuery extends Pagination { /** 审批定义唯一标识 */ approval_code: string @@ -381,6 +461,24 @@ export interface SpecifiedRollbackApprovalInstanceQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum AddSignApprovalInstanceRequestAddSignType { + /** 前加签 */ + AddSignPre = 1, + /** 后加签 */ + AddSignPost = 2, + /** 并加签 */ + AddSignParallel = 3, +} + +export const enum AddSignApprovalInstanceRequestApprovalMethod { + /** 或签 */ + OrSign = 1, + /** 会签 */ + AddSign = 2, + /** 依次审批 */ + SequentialSign = 3, +} + export interface AddSignApprovalInstanceRequest { /** 操作用户id */ user_id: string @@ -395,9 +493,9 @@ export interface AddSignApprovalInstanceRequest { /** 被加签人id */ add_sign_user_ids: string[] /** 1/2/3分别代表前加签/后加签/并加签 */ - add_sign_type: 1 | 2 | 3 + add_sign_type: AddSignApprovalInstanceRequestAddSignType /** 仅在前加签、后加签时需要填写,1/2 分别代表或签/会签 */ - approval_method?: 1 | 2 | 3 + approval_method?: AddSignApprovalInstanceRequestApprovalMethod } export interface ResubmitApprovalTaskRequest { @@ -442,6 +540,11 @@ export interface CreateApprovalInstanceCommentQuery { user_id: string } +export interface CreateApprovalInstanceCommentResponse { + /** 保存成功的comment_id */ + comment_id: string +} + export interface DeleteApprovalInstanceCommentQuery { /** 用户ID类型,不填默认为open_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' @@ -449,6 +552,11 @@ export interface DeleteApprovalInstanceCommentQuery { user_id: string } +export interface DeleteApprovalInstanceCommentResponse { + /** 删除的评论ID */ + comment_id?: string +} + export interface RemoveApprovalInstanceCommentQuery { /** 用户ID类型,不填默认为open_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' @@ -456,6 +564,13 @@ export interface RemoveApprovalInstanceCommentQuery { user_id?: string } +export interface RemoveApprovalInstanceCommentResponse { + /** 审批实例code */ + instance_id?: string + /** 租户自定义审批实例ID */ + external_id?: string +} + export interface ListApprovalInstanceCommentQuery extends Pagination { /** 用户ID类型,不填默认为open_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' @@ -463,6 +578,11 @@ export interface ListApprovalInstanceCommentQuery extends Pagination { user_id: string } +export interface ListApprovalInstanceCommentResponse { + /** 评论数据列表 */ + comments: Comment[] +} + export interface CreateApprovalExternalApprovalRequest { /** 审批定义名称,创建审批定义返回的值,表示该实例属于哪个流程;该字段会影响到列表中该实例的标题,标题取自对应定义的 name 字段。 */ approval_name: string @@ -491,11 +611,37 @@ export interface CreateApprovalExternalApprovalQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateApprovalExternalApprovalResponse { + /** 审批定义 code,用户自定义,定义的唯一标识 */ + approval_code: string +} + export interface GetApprovalExternalApprovalQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetApprovalExternalApprovalResponse { + /** 审批定义名称 */ + approval_name: string + /** 审批定义code */ + approval_code: string + /** 审批定义所属分组 */ + group_code: string + /** 分组名称 */ + group_name?: string + /** 审批定义的说明 */ + description?: string + /** 三方审批定义相关 */ + external?: ApprovalCreateExternal + /** 可见人列表 */ + viewers?: ApprovalCreateViewers[] + /** 国际化文案 */ + i18n_resources?: I18nResource[] + /** 流程管理员 */ + managers?: string[] +} + export interface CreateApprovalExternalInstanceRequest { /** 审批定义 code, 创建审批定义返回的值,表示该实例属于哪个流程;该字段会影响到列表中该实例的标题,标题取自对应定义的 name 字段 */ approval_code: string @@ -549,11 +695,21 @@ export interface CreateApprovalExternalInstanceRequest { resource_region?: string } +export interface CreateApprovalExternalInstanceResponse { + /** 同步的实例数据 */ + data?: ExternalInstance +} + export interface CheckApprovalExternalInstanceRequest { /** 校验的实例信息 */ instances: ExteranlInstanceCheck[] } +export interface CheckApprovalExternalInstanceResponse { + /** 更新时间不一致的实例信息 */ + diff_instances?: ExteranlInstanceCheckResponse[] +} + export interface ListApprovalExternalTaskRequest { /** 审批定义 Code,用于指定只获取这些定义下的数据 */ approval_codes?: string[] @@ -593,6 +749,17 @@ export interface QueryApprovalInstanceQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface QueryApprovalInstanceResponse { + /** 查询返回条数 */ + count?: number + /** 审批实例列表 */ + instance_list?: InstanceSearchItem[] + /** 翻页 Token */ + page_token?: string + /** 是否有更多任务可供拉取 */ + has_more?: boolean +} + export interface SearchCcApprovalInstanceRequest { /** 根据x_user_type填写用户 id */ user_id?: string @@ -621,6 +788,28 @@ export interface SearchCcApprovalInstanceQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface SearchCcApprovalInstanceResponse { + /** 查询返回条数 */ + count?: number + /** 审批实例列表 */ + cc_list?: CcSearchItem[] + /** 翻页 Token */ + page_token?: string + /** 是否有更多任务可供拉取 */ + has_more?: boolean +} + +export const enum SearchApprovalTaskRequestOrder { + /** 按update_time倒排 */ + UpdateTimeDESC = 0, + /** 按update_time正排 */ + UpdateTimeASC = 1, + /** 按start_time倒排 */ + StartTimeDESC = 2, + /** 按start_time正排 */ + StartTimeASC = 3, +} + export interface SearchApprovalTaskRequest { /** 根据x_user_type填写用户 id */ user_id?: string @@ -645,7 +834,7 @@ export interface SearchApprovalTaskRequest { /** 可选择task_status中的多个状态,当填写此参数时,task_status失效 */ task_status_list?: string[] /** 按时间排序 */ - order?: 0 | 1 | 2 | 3 + order?: SearchApprovalTaskRequestOrder } export interface SearchApprovalTaskQuery extends Pagination { @@ -653,168 +842,6 @@ export interface SearchApprovalTaskQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface QueryApprovalTaskQuery extends Pagination { - /** 需要查询的 User ID */ - user_id: string - /** 需要查询的任务分组主题,如「待办」、「已办」等 */ - topic: '1' | '2' | '3' | '17' | '18' - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface CreateApprovalResponse { - /** 审批定义 Code */ - approval_code?: string - /** 审批定义 id */ - approval_id?: string -} - -export interface GetApprovalResponse { - /** 审批名称 */ - approval_name: string - /** 审批定义状态 */ - status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'UNKNOWN' - /** 控件信息 */ - form: string - /** 节点信息 */ - node_list: ApprovalNodeInfo[] - /** 可见人列表 */ - viewers: ApprovalViewerInfo[] - /** 有数据管理权限的审批流程管理员ID */ - approval_admin_ids?: string[] - /** 组件之间值关联关系 */ - form_widget_relation?: string -} - -export interface CreateApprovalInstanceResponse { - /** 审批实例 Code */ - instance_code: string -} - -export interface PreviewApprovalInstanceResponse { - /** 预览节点信息 */ - preview_nodes?: PreviewNode[] -} - -export interface GetApprovalInstanceResponse { - /** 审批名称 */ - approval_name: string - /** 审批创建时间 */ - start_time?: string - /** 审批完成时间,未完成为 0 */ - end_time: string - /** 发起审批用户 */ - user_id: string - /** 发起审批用户 open id */ - open_id: string - /** 审批单编号 */ - serial_number: string - /** 发起审批用户所在部门 */ - department_id: string - /** 审批实例状态 */ - status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED' - /** 用户的唯一标识id */ - uuid: string - /** json字符串,控件值 */ - form: string - /** 审批任务列表 */ - task_list: InstanceTask[] - /** 评论列表 */ - comment_list: InstanceComment[] - /** 审批动态 */ - timeline: InstanceTimeline[] - /** 修改的原实例 code,仅在查询修改实例时显示该字段 */ - modified_instance_code?: string - /** 撤销的原实例 code,仅在查询撤销实例时显示该字段 */ - reverted_instance_code?: string - /** 审批定义 Code */ - approval_code: string - /** 单据是否被撤销 */ - reverted?: boolean - /** 审批实例 Code */ - instance_code: string -} - -export interface CreateApprovalInstanceCommentResponse { - /** 保存成功的comment_id */ - comment_id: string -} - -export interface DeleteApprovalInstanceCommentResponse { - /** 删除的评论ID */ - comment_id?: string -} - -export interface RemoveApprovalInstanceCommentResponse { - /** 审批实例code */ - instance_id?: string - /** 租户自定义审批实例ID */ - external_id?: string -} - -export interface ListApprovalInstanceCommentResponse { - /** 评论数据列表 */ - comments: Comment[] -} - -export interface CreateApprovalExternalApprovalResponse { - /** 审批定义 code,用户自定义,定义的唯一标识 */ - approval_code: string -} - -export interface GetApprovalExternalApprovalResponse { - /** 审批定义名称 */ - approval_name: string - /** 审批定义code */ - approval_code: string - /** 审批定义所属分组 */ - group_code: string - /** 分组名称 */ - group_name?: string - /** 审批定义的说明 */ - description?: string - /** 三方审批定义相关 */ - external?: ApprovalCreateExternal - /** 可见人列表 */ - viewers?: ApprovalCreateViewers[] - /** 国际化文案 */ - i18n_resources?: I18nResource[] - /** 流程管理员 */ - managers?: string[] -} - -export interface CreateApprovalExternalInstanceResponse { - /** 同步的实例数据 */ - data?: ExternalInstance -} - -export interface CheckApprovalExternalInstanceResponse { - /** 更新时间不一致的实例信息 */ - diff_instances?: ExteranlInstanceCheckResponse[] -} - -export interface QueryApprovalInstanceResponse { - /** 查询返回条数 */ - count?: number - /** 审批实例列表 */ - instance_list?: InstanceSearchItem[] - /** 翻页 Token */ - page_token?: string - /** 是否有更多任务可供拉取 */ - has_more?: boolean -} - -export interface SearchCcApprovalInstanceResponse { - /** 查询返回条数 */ - count?: number - /** 审批实例列表 */ - cc_list?: CcSearchItem[] - /** 翻页 Token */ - page_token?: string - /** 是否有更多任务可供拉取 */ - has_more?: boolean -} - export interface SearchApprovalTaskResponse { /** 查询返回条数 */ count?: number @@ -826,6 +853,15 @@ export interface SearchApprovalTaskResponse { has_more?: boolean } +export interface QueryApprovalTaskQuery extends Pagination { + /** 需要查询的 User ID */ + user_id: string + /** 需要查询的任务分组主题,如「待办」、「已办」等 */ + topic: '1' | '2' | '3' | '17' | '18' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface QueryApprovalTaskResponse { /** 任务列表 */ tasks: Task[] @@ -904,16 +940,16 @@ Internal.define({ GET: { name: 'listApprovalExternalTask', pagination: { argIndex: 1, itemsKey: 'data' } }, }, '/approval/v4/instances/query': { - POST: 'queryApprovalInstance', + POST: { name: 'queryApprovalInstance', pagination: { argIndex: 1, itemsKey: 'instance_list' } }, }, '/approval/v4/instances/search_cc': { - POST: 'searchCcApprovalInstance', + POST: { name: 'searchCcApprovalInstance', pagination: { argIndex: 1, itemsKey: 'cc_list' } }, }, '/approval/v4/tasks/search': { - POST: 'searchApprovalTask', + POST: { name: 'searchApprovalTask', pagination: { argIndex: 1, itemsKey: 'task_list' } }, }, '/approval/v4/tasks/query': { - GET: 'queryApprovalTask', + GET: { name: 'queryApprovalTask', pagination: { argIndex: 0, itemsKey: 'tasks' } }, }, '/approval/v4/approvals/{approval_code}/subscribe': { POST: 'subscribeApproval', diff --git a/adapters/lark/src/types/attendance.ts b/adapters/lark/src/types/attendance.ts index 44f52158..aa907ced 100644 --- a/adapters/lark/src/types/attendance.ts +++ b/adapters/lark/src/types/attendance.ts @@ -242,412 +242,6 @@ export interface CreateAttendanceShiftQuery { employee_type?: 'employee_id' | 'employee_no' } -export interface QueryAttendanceShiftQuery { - /** 班次名称 */ - shift_name: string -} - -export interface BatchCreateAttendanceUserDailyShiftRequest { - /** 班表信息列表 */ - user_daily_shifts: UserDailyShift[] - /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */ - operator_id?: string -} - -export interface BatchCreateAttendanceUserDailyShiftQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserDailyShiftRequest { - /** employee_no 或 employee_id 列表 */ - user_ids: string[] - /** 查询的起始工作日 */ - check_date_from: number - /** 查询的结束工作日 */ - check_date_to: number -} - -export interface QueryAttendanceUserDailyShiftQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface BatchCreateTempAttendanceUserDailyShiftRequest { - /** 临时班表信息列表(数量限制50以内) */ - user_tmp_daily_shifts: UserTmpDailyShift[] - /** 操作人uid */ - operator_id?: string -} - -export interface BatchCreateTempAttendanceUserDailyShiftQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface ListUserAttendanceGroupQuery extends Pagination { - /** 用户 ID 的类型 */ - employee_type: string - /** 部门 ID 的类型 */ - dept_type: string - /** 打卡类型 */ - member_clock_type: number -} - -export interface CreateAttendanceGroupRequest { - /** 6921319402260496386 */ - group: Group - /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */ - operator_id?: string -} - -export interface CreateAttendanceGroupQuery { - /** 用户 ID 的类型 */ - employee_type: 'employee_id' | 'employee_no' - /** 部门 ID 的类型 */ - dept_type: 'open_id' -} - -export interface GetAttendanceGroupQuery { - /** 用户 ID 的类型 */ - employee_type: 'employee_id' | 'employee_no' - /** 部门 ID 的类型 */ - dept_type: 'open_id' -} - -export interface SearchAttendanceGroupRequest { - /** 考勤组名称 */ - group_name: string -} - -export interface ModifyAttendanceUserSettingRequest { - /** 用户设置 */ - user_setting?: UserSetting -} - -export interface ModifyAttendanceUserSettingQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserSettingRequest { - /** employee_no 或 employee_id 列表 */ - user_ids: string[] -} - -export interface QueryAttendanceUserSettingQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface UploadAttendanceFileForm { - /** 文件内容 */ - file?: Blob -} - -export interface UploadAttendanceFileQuery { - /** 带后缀的文件名 */ - file_name: string -} - -export interface UpdateAttendanceUserStatsViewRequest { - /** 统计设置 */ - view: UserStatsView -} - -export interface UpdateAttendanceUserStatsViewQuery { - /** 员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserStatsFieldRequest { - /** 语言类型 */ - locale: 'en' | 'ja' | 'zh' - /** 统计类型 */ - stats_type: 'daily' | 'month' - /** 开始时间 */ - start_date: number - /** 结束时间(时间间隔不超过 40 天) */ - end_date: number -} - -export interface QueryAttendanceUserStatsFieldQuery { - /** 响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserStatsViewRequest { - /** 语言类型 */ - locale: 'en' | 'ja' | 'zh' - /** 统计类型 */ - stats_type: 'daily' | 'month' - /** 查询用户id,同【查询统计数据】、【更新统计设置】user_id */ - user_id?: string -} - -export interface QueryAttendanceUserStatsViewQuery { - /** 响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserStatsDataRequest { - /** 语言类型 */ - locale: 'en' | 'ja' | 'zh' - /** 统计类型 */ - stats_type: 'daily' | 'month' - /** 开始时间 */ - start_date: number - /** 结束时间(时间间隔不超过 40 天) */ - end_date: number - /** 查询的用户 ID 列表(用户数量不超过 200) */ - user_ids?: string[] - /** 是否需要历史数据 */ - need_history?: boolean - /** 只展示当前考勤组 */ - current_group_only?: boolean - /** 查询用户id,同【更新统计设置】、【查询统计设置】user_id */ - user_id?: string -} - -export interface QueryAttendanceUserStatsDataQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserApprovalRequest { - /** employee_no 或 employee_id 列表 */ - user_ids: string[] - /** 查询的起始工作日 */ - check_date_from: number - /** 查询的结束工作日,与 check_date_from 的时间间隔不超过 30 天 */ - check_date_to: number - /** 查询依据的时间类型(不填默认依据PeriodTime) */ - check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime' - /** 查询状态(不填默认查询已通过状态) */ - status?: 0 | 1 | 2 | 3 | 4 - /** 查询的起始时间,精确到秒的时间戳 */ - check_time_from?: string - /** 查询的结束时间,精确到秒的时间戳 */ - check_time_to?: string -} - -export interface QueryAttendanceUserApprovalQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' | 'open_id' -} - -export interface CreateAttendanceUserApprovalRequest { - /** 审批信息 */ - user_approval?: UserApproval -} - -export interface CreateAttendanceUserApprovalQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' | 'open_id' -} - -export interface ProcessAttendanceApprovalInfoRequest { - /** 审批实例 ID,获取方式:1)[获取审批通过数据](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query) 2)[写入审批结果](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create) 3)[通知补卡审批发起(补卡情况下)](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create) */ - approval_id: string - /** 审批类型,leave:请假,out:外出,overtime:加班,trip:出差,remedy:补卡 */ - approval_type: string - /** 审批状态,1:不通过,2:通过,4:撤销 */ - status: number -} - -export interface CreateAttendanceUserTaskRemedyRequest { - /** 用户工号 */ - user_id: string - /** 补卡日期 */ - remedy_date: number - /** 第几次上下班,可能值0,1,2 */ - punch_no: number - /** 上班/下班,1是上班,2是下班 */ - work_type: number - /** 补卡时间 */ - remedy_time: string - /** 补卡原因 */ - reason: string - /** 补卡时间戳,精确到秒的时间戳 */ - time?: string -} - -export interface CreateAttendanceUserTaskRemedyQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyRequest { - /** 用户 ID */ - user_id: string - /** 补卡日期 */ - remedy_date: number -} - -export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserTaskRemedyRequest { - /** employee_no 或 employee_id 列表 */ - user_ids: string[] - /** 查询的起始时间,精确到秒的时间戳 */ - check_time_from: string - /** 查询的结束时间,精确到秒的时间戳 */ - check_time_to: string - /** 查询依据的时间类型(不填默认依据PeriodTime) */ - check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime' - /** 查询状态(不填默认查询已通过状态) */ - status?: 0 | 1 | 2 | 3 | 4 -} - -export interface QueryAttendanceUserTaskRemedyQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface UserStatsFieldsQueryAttendanceArchiveRuleRequest { - /** 语言类型 */ - locale?: string - /** 月份 */ - month: string - /** 归档规则id */ - archive_rule_id: string - /** 操作者id */ - operator_id: string -} - -export interface UserStatsFieldsQueryAttendanceArchiveRuleQuery { - /** 用户 ID 的类型 */ - employee_type: string -} - -export interface UploadReportAttendanceArchiveRuleRequest { - /** 月份 */ - month: string - /** 操作者ID */ - operator_id: string - /** 归档报表内容(不超过50个) */ - archive_report_datas?: ArchiveReportData[] - /** 归档规则id */ - archive_rule_id: string -} - -export interface UploadReportAttendanceArchiveRuleQuery { - /** 用户 ID 的类型 */ - employee_type: string -} - -export interface DelReportAttendanceArchiveRuleRequest { - /** 月份 */ - month: string - /** 操作者ID */ - operator_id: string - /** 归档规则id */ - archive_rule_id: string - /** 用户id */ - user_ids?: string[] -} - -export interface DelReportAttendanceArchiveRuleQuery { - /** 员工工号类型 */ - employee_type: string -} - -export interface BatchCreateAttendanceUserFlowRequest { - /** 打卡流水记录列表 */ - flow_records: UserFlow[] -} - -export interface BatchCreateAttendanceUserFlowQuery { - /** 请求体和响应体中的 user_id 和 creator_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface GetAttendanceUserFlowQuery { - /** 响应体中的 user_id 和 creator_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' -} - -export interface QueryAttendanceUserFlowRequest { - /** employee_no 或 employee_id 列表,长度不超过 50 */ - user_ids: string[] - /** 查询的起始时间,时间戳 */ - check_time_from: string - /** 查询的结束时间,时间戳 */ - check_time_to: string -} - -export interface QueryAttendanceUserFlowQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' - /** 由于新入职用户可以复用已离职用户的employee_no/employee_id。如果true,返回employee_no/employee_id对应的所有在职+离职用户数据;如果false,只返回employee_no/employee_id对应的在职或最近一个离职用户数据 */ - include_terminated_user?: boolean -} - -export interface QueryAttendanceUserTaskRequest { - /** employee_no 或 employee_id 列表 */ - user_ids: string[] - /** 查询的起始工作日 */ - check_date_from: number - /** 查询的结束工作日 */ - check_date_to: number - /** 是否需要加班班段打卡结果 */ - need_overtime_result?: boolean -} - -export interface QueryAttendanceUserTaskQuery { - /** 员工工号类型 */ - employee_type: 'employee_id' | 'employee_no' - /** 是否忽略无效和没有权限的用户。如果 true,则返回有效用户的信息,并告知无效和没有权限的用户信息;如果 false,且 user_ids 中存在无效或没有权限的用户,则返回错误 */ - ignore_invalid_users?: boolean - /** 由于新入职员工可以复用已离职员工的 employee_no/employee_id,如果 true,则返回 employee_no/employee_id 对应的所有在职 + 离职员工的数据;如果 false,则只返回 employee_no/employee_id 对应的在职或最近一个离职员工的数据 */ - include_terminated_user?: boolean -} - -export interface GetAttendanceLeaveEmployExpireRecordRequest { - /** 员工ID */ - employment_id: string - /** 假期类型ID */ - leave_type_id: string - /** 失效最早日期 2023-04-10 格式 */ - start_expiration_date: string - /** 失效最晚日期 2023-05-10 格式 */ - end_expiration_date: string - /** 时间偏移,东八区:480 8*60, 如果没有这个参数,默认东八区 */ - time_offset?: number -} - -export interface GetAttendanceLeaveEmployExpireRecordQuery { - /** 用户 ID 类型 */ - user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id' -} - -export interface PatchAttendanceLeaveAccrualRecordRequest { - /** 授予记录的唯一ID */ - leave_granting_record_id: string - /** 员工ID */ - employment_id: string - /** 假期类型ID */ - leave_type_id: string - /** 修改授予记录原因 */ - reason: LangText[] - /** 时间偏移,东八区:480 8*60 */ - time_offset?: number - /** 失效日期,格式"2020-01-01" */ - expiration_date?: string - /** 修改source 余额 */ - quantity?: string - /** 是否参与清算 */ - section_type?: number -} - -export interface PatchAttendanceLeaveAccrualRecordQuery { - /** 用户 ID 类型 */ - user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id' -} - export interface CreateAttendanceShiftResponse { /** 班次 */ shift?: Shift @@ -696,6 +290,11 @@ export interface GetAttendanceShiftResponse { rest_time_flexible_configs?: RestTimeFlexibleConfig[] } +export interface QueryAttendanceShiftQuery { + /** 班次名称 */ + shift_name: string +} + export interface QueryAttendanceShiftResponse { /** 班次Id */ shift_id: string @@ -739,25 +338,93 @@ export interface QueryAttendanceShiftResponse { rest_time_flexible_configs?: RestTimeFlexibleConfig[] } +export interface BatchCreateAttendanceUserDailyShiftRequest { + /** 班表信息列表 */ + user_daily_shifts: UserDailyShift[] + /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */ + operator_id?: string +} + +export interface BatchCreateAttendanceUserDailyShiftQuery { + /** 请求体和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface BatchCreateAttendanceUserDailyShiftResponse { /** 班表信息列表 */ user_daily_shifts?: UserDailyShift[] } +export interface QueryAttendanceUserDailyShiftRequest { + /** employee_no 或 employee_id 列表 */ + user_ids: string[] + /** 查询的起始工作日 */ + check_date_from: number + /** 查询的结束工作日 */ + check_date_to: number +} + +export interface QueryAttendanceUserDailyShiftQuery { + /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface QueryAttendanceUserDailyShiftResponse { /** 班表信息列表 */ user_daily_shifts?: UserDailyShift[] } +export interface BatchCreateTempAttendanceUserDailyShiftRequest { + /** 临时班表信息列表(数量限制50以内) */ + user_tmp_daily_shifts: UserTmpDailyShift[] + /** 操作人uid */ + operator_id?: string +} + +export interface BatchCreateTempAttendanceUserDailyShiftQuery { + /** 请求体和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface BatchCreateTempAttendanceUserDailyShiftResponse { /** 临时班表信息列表 */ user_tmp_daily_shifts?: UserTmpDailyShift[] } +export interface ListUserAttendanceGroupQuery extends Pagination { + /** 用户 ID 的类型 */ + employee_type: string + /** 部门 ID 的类型 */ + dept_type: string + /** 打卡类型 */ + member_clock_type: number +} + +export interface CreateAttendanceGroupRequest { + /** 6921319402260496386 */ + group: Group + /** 操作人uid,如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines),则此字段为必填字段 */ + operator_id?: string +} + +export interface CreateAttendanceGroupQuery { + /** 用户 ID 的类型 */ + employee_type: 'employee_id' | 'employee_no' + /** 部门 ID 的类型 */ + dept_type: 'open_id' +} + export interface CreateAttendanceGroupResponse { group?: Group } +export interface GetAttendanceGroupQuery { + /** 用户 ID 的类型 */ + employee_type: 'employee_id' | 'employee_no' + /** 部门 ID 的类型 */ + dept_type: 'open_id' +} + export interface GetAttendanceGroupResponse { /** 考勤组的Id, 需要从获取用户打卡结果信息的接口中获取groupId,修改考勤组时必填 */ group_id?: string @@ -898,43 +565,177 @@ export interface GetAttendanceGroupResponse { allow_apply_punch?: boolean } +export interface SearchAttendanceGroupRequest { + /** 考勤组名称 */ + group_name: string +} + export interface SearchAttendanceGroupResponse { /** 考勤组列表 */ group_list?: GroupMeta[] } +export interface ModifyAttendanceUserSettingRequest { + /** 用户设置 */ + user_setting?: UserSetting +} + +export interface ModifyAttendanceUserSettingQuery { + /** 请求体和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface ModifyAttendanceUserSettingResponse { /** 用户设置 */ user_setting?: UserSetting } +export interface QueryAttendanceUserSettingRequest { + /** employee_no 或 employee_id 列表 */ + user_ids: string[] +} + +export interface QueryAttendanceUserSettingQuery { + /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface QueryAttendanceUserSettingResponse { /** 用户设置信息列表 */ user_settings?: UserSetting[] } -export interface UploadAttendanceFileResponse { - file?: File +export interface UploadAttendanceFileForm { + /** 文件内容 */ + file?: Blob +} + +export interface UploadAttendanceFileQuery { + /** 带后缀的文件名 */ + file_name: string +} + +export interface UploadAttendanceFileResponse { + file?: File +} + +export interface UpdateAttendanceUserStatsViewRequest { + /** 统计设置 */ + view: UserStatsView +} + +export interface UpdateAttendanceUserStatsViewQuery { + /** 员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + +export interface UpdateAttendanceUserStatsViewResponse { + /** 视图 */ + view?: UserStatsView +} + +export interface QueryAttendanceUserStatsFieldRequest { + /** 语言类型 */ + locale: 'en' | 'ja' | 'zh' + /** 统计类型 */ + stats_type: 'daily' | 'month' + /** 开始时间 */ + start_date: number + /** 结束时间(时间间隔不超过 40 天) */ + end_date: number +} + +export interface QueryAttendanceUserStatsFieldQuery { + /** 响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + +export interface QueryAttendanceUserStatsFieldResponse { + user_stats_field?: UserStatsField +} + +export interface QueryAttendanceUserStatsViewRequest { + /** 语言类型 */ + locale: 'en' | 'ja' | 'zh' + /** 统计类型 */ + stats_type: 'daily' | 'month' + /** 查询用户id,同【查询统计数据】、【更新统计设置】user_id */ + user_id?: string +} + +export interface QueryAttendanceUserStatsViewQuery { + /** 响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + +export interface QueryAttendanceUserStatsViewResponse { + view?: UserStatsView +} + +export interface QueryAttendanceUserStatsDataRequest { + /** 语言类型 */ + locale: 'en' | 'ja' | 'zh' + /** 统计类型 */ + stats_type: 'daily' | 'month' + /** 开始时间 */ + start_date: number + /** 结束时间(时间间隔不超过 40 天) */ + end_date: number + /** 查询的用户 ID 列表(用户数量不超过 200) */ + user_ids?: string[] + /** 是否需要历史数据 */ + need_history?: boolean + /** 只展示当前考勤组 */ + current_group_only?: boolean + /** 查询用户id,同【更新统计设置】、【查询统计设置】user_id */ + user_id?: string +} + +export interface QueryAttendanceUserStatsDataQuery { + /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' } -export interface UpdateAttendanceUserStatsViewResponse { - /** 视图 */ - view?: UserStatsView +export interface QueryAttendanceUserStatsDataResponse { + /** 用户统计数据 */ + user_datas?: UserStatsData[] + /** 无权限获取的用户列表 */ + invalid_user_list?: string[] } -export interface QueryAttendanceUserStatsFieldResponse { - user_stats_field?: UserStatsField +export const enum QueryAttendanceUserApprovalRequestStatus { + /** 待审批 */ + Todo = 0, + /** 审批未通过 */ + Rejected = 1, + /** 审批通过 */ + Approved = 2, + /** 审批已取消 */ + Canceled = 3, + /** 已撤回 */ + Reverted = 4, } -export interface QueryAttendanceUserStatsViewResponse { - view?: UserStatsView +export interface QueryAttendanceUserApprovalRequest { + /** employee_no 或 employee_id 列表 */ + user_ids: string[] + /** 查询的起始工作日 */ + check_date_from: number + /** 查询的结束工作日,与 check_date_from 的时间间隔不超过 30 天 */ + check_date_to: number + /** 查询依据的时间类型(不填默认依据PeriodTime) */ + check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime' + /** 查询状态(不填默认查询已通过状态) */ + status?: QueryAttendanceUserApprovalRequestStatus + /** 查询的起始时间,精确到秒的时间戳 */ + check_time_from?: string + /** 查询的结束时间,精确到秒的时间戳 */ + check_time_to?: string } -export interface QueryAttendanceUserStatsDataResponse { - /** 用户统计数据 */ - user_datas?: UserStatsData[] - /** 无权限获取的用户列表 */ - invalid_user_list?: string[] +export interface QueryAttendanceUserApprovalQuery { + /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' | 'open_id' } export interface QueryAttendanceUserApprovalResponse { @@ -942,36 +743,152 @@ export interface QueryAttendanceUserApprovalResponse { user_approvals?: UserApproval[] } +export interface CreateAttendanceUserApprovalRequest { + /** 审批信息 */ + user_approval?: UserApproval +} + +export interface CreateAttendanceUserApprovalQuery { + /** 请求体和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' | 'open_id' +} + export interface CreateAttendanceUserApprovalResponse { /** 审批信息 */ user_approval?: UserApproval } +export interface ProcessAttendanceApprovalInfoRequest { + /** 审批实例 ID,获取方式:1)[获取审批通过数据](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query) 2)[写入审批结果](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create) 3)[通知补卡审批发起(补卡情况下)](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create) */ + approval_id: string + /** 审批类型,leave:请假,out:外出,overtime:加班,trip:出差,remedy:补卡 */ + approval_type: string + /** 审批状态,1:不通过,2:通过,4:撤销 */ + status: number +} + export interface ProcessAttendanceApprovalInfoResponse { /** 审批信息 */ approval_info?: ApprovalInfo } +export interface CreateAttendanceUserTaskRemedyRequest { + /** 用户工号 */ + user_id: string + /** 补卡日期 */ + remedy_date: number + /** 第几次上下班,可能值0,1,2 */ + punch_no: number + /** 上班/下班,1是上班,2是下班 */ + work_type: number + /** 补卡时间 */ + remedy_time: string + /** 补卡原因 */ + reason: string + /** 补卡时间戳,精确到秒的时间戳 */ + time?: string +} + +export interface CreateAttendanceUserTaskRemedyQuery { + /** 请求体和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface CreateAttendanceUserTaskRemedyResponse { /** 补卡审批信息 */ user_remedy?: UserTaskRemedy } +export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyRequest { + /** 用户 ID */ + user_id: string + /** 补卡日期 */ + remedy_date: number +} + +export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyQuery { + /** 请求体和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyResponse { /** 用户可补卡时间 */ user_allowed_remedys?: UserAllowedRemedy[] } +export const enum QueryAttendanceUserTaskRemedyRequestStatus { + /** 待审批 */ + Pending = 0, + /** 未通过 */ + Rejected = 1, + /** 已通过 */ + Pass = 2, + /** 已取消 */ + Cancel = 3, + /** 已撤回 */ + Withdraw = 4, +} + +export interface QueryAttendanceUserTaskRemedyRequest { + /** employee_no 或 employee_id 列表 */ + user_ids: string[] + /** 查询的起始时间,精确到秒的时间戳 */ + check_time_from: string + /** 查询的结束时间,精确到秒的时间戳 */ + check_time_to: string + /** 查询依据的时间类型(不填默认依据PeriodTime) */ + check_date_type?: 'PeriodTime' | 'CreateTime' | 'UpdateTime' + /** 查询状态(不填默认查询已通过状态) */ + status?: QueryAttendanceUserTaskRemedyRequestStatus +} + +export interface QueryAttendanceUserTaskRemedyQuery { + /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface QueryAttendanceUserTaskRemedyResponse { /** 补卡记录列表 */ user_remedys?: UserTaskRemedy[] } +export interface UserStatsFieldsQueryAttendanceArchiveRuleRequest { + /** 语言类型 */ + locale?: string + /** 月份 */ + month: string + /** 归档规则id */ + archive_rule_id: string + /** 操作者id */ + operator_id: string +} + +export interface UserStatsFieldsQueryAttendanceArchiveRuleQuery { + /** 用户 ID 的类型 */ + employee_type: string +} + export interface UserStatsFieldsQueryAttendanceArchiveRuleResponse { /** 统计数据表头 */ archive_report_fields?: ArchiveField[] } +export interface UploadReportAttendanceArchiveRuleRequest { + /** 月份 */ + month: string + /** 操作者ID */ + operator_id: string + /** 归档报表内容(不超过50个) */ + archive_report_datas?: ArchiveReportData[] + /** 归档规则id */ + archive_rule_id: string +} + +export interface UploadReportAttendanceArchiveRuleQuery { + /** 用户 ID 的类型 */ + employee_type: string +} + export interface UploadReportAttendanceArchiveRuleResponse { /** 无效的code */ invalid_code?: string[] @@ -979,11 +896,61 @@ export interface UploadReportAttendanceArchiveRuleResponse { invalid_member_id?: string[] } +export interface DelReportAttendanceArchiveRuleRequest { + /** 月份 */ + month: string + /** 操作者ID */ + operator_id: string + /** 归档规则id */ + archive_rule_id: string + /** 用户id */ + user_ids?: string[] +} + +export interface DelReportAttendanceArchiveRuleQuery { + /** 员工工号类型 */ + employee_type: string +} + +export interface BatchCreateAttendanceUserFlowRequest { + /** 打卡流水记录列表 */ + flow_records: UserFlow[] +} + +export interface BatchCreateAttendanceUserFlowQuery { + /** 请求体和响应体中的 user_id 和 creator_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + export interface BatchCreateAttendanceUserFlowResponse { /** 打卡流水记录列表 */ flow_records?: UserFlow[] } +export interface GetAttendanceUserFlowQuery { + /** 响应体中的 user_id 和 creator_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' +} + +export const enum GetAttendanceUserFlowResponseType { + /** 用户自己打卡 */ + Self = 0, + /** 管理员修改 */ + ManagerModification = 1, + /** 用户补卡 */ + Remedy = 2, + /** 系统自动生成 */ + System = 3, + /** 下班免打卡 */ + Free = 4, + /** 考勤机 */ + Machine = 5, + /** 极速打卡 */ + Quick = 6, + /** 考勤开放平台导入 */ + Import = 7, +} + export interface GetAttendanceUserFlowResponse { /** 用户工号 */ user_id: string @@ -1006,7 +973,7 @@ export interface GetAttendanceUserFlowResponse { /** 是否为wifi打卡 */ is_wifi?: boolean /** 记录生成方式 */ - type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 + type?: GetAttendanceUserFlowResponseType /** 打卡照片列表 */ photo_urls?: string[] /** 打卡设备ID */ @@ -1019,11 +986,47 @@ export interface GetAttendanceUserFlowResponse { idempotent_id?: string } +export interface QueryAttendanceUserFlowRequest { + /** employee_no 或 employee_id 列表,长度不超过 50 */ + user_ids: string[] + /** 查询的起始时间,时间戳 */ + check_time_from: string + /** 查询的结束时间,时间戳 */ + check_time_to: string +} + +export interface QueryAttendanceUserFlowQuery { + /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' + /** 由于新入职用户可以复用已离职用户的employee_no/employee_id。如果true,返回employee_no/employee_id对应的所有在职+离职用户数据;如果false,只返回employee_no/employee_id对应的在职或最近一个离职用户数据 */ + include_terminated_user?: boolean +} + export interface QueryAttendanceUserFlowResponse { /** 打卡记录列表 */ user_flow_results?: UserFlow[] } +export interface QueryAttendanceUserTaskRequest { + /** employee_no 或 employee_id 列表 */ + user_ids: string[] + /** 查询的起始工作日 */ + check_date_from: number + /** 查询的结束工作日 */ + check_date_to: number + /** 是否需要加班班段打卡结果 */ + need_overtime_result?: boolean +} + +export interface QueryAttendanceUserTaskQuery { + /** 员工工号类型 */ + employee_type: 'employee_id' | 'employee_no' + /** 是否忽略无效和没有权限的用户。如果 true,则返回有效用户的信息,并告知无效和没有权限的用户信息;如果 false,且 user_ids 中存在无效或没有权限的用户,则返回错误 */ + ignore_invalid_users?: boolean + /** 由于新入职员工可以复用已离职员工的 employee_no/employee_id,如果 true,则返回 employee_no/employee_id 对应的所有在职 + 离职员工的数据;如果 false,则只返回 employee_no/employee_id 对应的在职或最近一个离职员工的数据 */ + include_terminated_user?: boolean +} + export interface QueryAttendanceUserTaskResponse { /** 打卡任务列表 */ user_task_results?: UserTask[] @@ -1033,11 +1036,53 @@ export interface QueryAttendanceUserTaskResponse { unauthorized_user_ids?: string[] } +export interface GetAttendanceLeaveEmployExpireRecordRequest { + /** 员工ID */ + employment_id: string + /** 假期类型ID */ + leave_type_id: string + /** 失效最早日期 2023-04-10 格式 */ + start_expiration_date: string + /** 失效最晚日期 2023-05-10 格式 */ + end_expiration_date: string + /** 时间偏移,东八区:480 8*60, 如果没有这个参数,默认东八区 */ + time_offset?: number +} + +export interface GetAttendanceLeaveEmployExpireRecordQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id' +} + export interface GetAttendanceLeaveEmployExpireRecordResponse { /** 员工过期日期的授予记录 */ records: LeaveEmployExpireRecord[] } +export interface PatchAttendanceLeaveAccrualRecordRequest { + /** 授予记录的唯一ID */ + leave_granting_record_id: string + /** 员工ID */ + employment_id: string + /** 假期类型ID */ + leave_type_id: string + /** 修改授予记录原因 */ + reason: LangText[] + /** 时间偏移,东八区:480 8*60 */ + time_offset?: number + /** 失效日期,格式"2020-01-01" */ + expiration_date?: string + /** 修改source 余额 */ + quantity?: string + /** 是否参与清算 */ + section_type?: number +} + +export interface PatchAttendanceLeaveAccrualRecordQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'people_corehr_id' | 'union_id' | 'user_id' +} + export interface PatchAttendanceLeaveAccrualRecordResponse { /** 员工过期日期的授予记录 */ record: LeaveAccrualRecord diff --git a/adapters/lark/src/types/auth.ts b/adapters/lark/src/types/auth.ts index a4d17f23..3f6c4044 100644 --- a/adapters/lark/src/types/auth.ts +++ b/adapters/lark/src/types/auth.ts @@ -37,6 +37,13 @@ export interface TenantAccessTokenInternalAuthRequest { app_secret: string } +export interface TenantAccessTokenInternalAuthResponse extends BaseResponse { + /** 访问 token */ + tenant_access_token?: string + /** app_access_token 过期时间 */ + expire?: number +} + export interface AppAccessTokenInternalAuthRequest { /** 应用唯一标识,创建应用后获得 */ app_id: string @@ -44,6 +51,13 @@ export interface AppAccessTokenInternalAuthRequest { app_secret: string } +export interface AppAccessTokenInternalAuthResponse extends BaseResponse { + /** 访问 token */ + app_access_token?: string + /** app_access_token 过期时间 */ + expire?: number +} + export interface AppTicketResendAuthRequest { /** 应用唯一标识,创建应用后获得 */ app_id: string @@ -60,32 +74,18 @@ export interface AppAccessTokenAuthRequest { app_ticket: string } -export interface TenantAccessTokenAuthRequest { - /** 应用唯一标识,创建应用 */ - app_access_token: string - /** 应用秘钥,创建应用后获得 */ - tenant_key: string -} - -export interface TenantAccessTokenInternalAuthResponse extends BaseResponse { - /** 访问 token */ - tenant_access_token?: string - /** app_access_token 过期时间 */ - expire?: number -} - -export interface AppAccessTokenInternalAuthResponse extends BaseResponse { +export interface AppAccessTokenAuthResponse extends BaseResponse { /** 访问 token */ app_access_token?: string /** app_access_token 过期时间 */ expire?: number } -export interface AppAccessTokenAuthResponse extends BaseResponse { - /** 访问 token */ - app_access_token?: string - /** app_access_token 过期时间 */ - expire?: number +export interface TenantAccessTokenAuthRequest { + /** 应用唯一标识,创建应用 */ + app_access_token: string + /** 应用秘钥,创建应用后获得 */ + tenant_key: string } export interface TenantAccessTokenAuthResponse extends BaseResponse { diff --git a/adapters/lark/src/types/authen.ts b/adapters/lark/src/types/authen.ts index 8a646076..085c622c 100644 --- a/adapters/lark/src/types/authen.ts +++ b/adapters/lark/src/types/authen.ts @@ -30,34 +30,6 @@ declare module '../internal' { } } -export interface CreateAuthenOidcAccessTokenRequest { - /** 授权类型,**固定值** */ - grant_type: string - /** 登录预授权码 */ - code: string -} - -export interface CreateAuthenOidcRefreshAccessTokenRequest { - /** 授权类型,**固定值**: */ - grant_type: string - /** 刷新 `user_access_token` 需要的凭证
获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */ - refresh_token: string -} - -export interface CreateAuthenAccessTokenRequest { - /** 授权类型,**固定值** */ - grant_type: string - /** 登录预授权码,调用[获取登录预授权码](https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN)接口获取 */ - code: string -} - -export interface CreateAuthenRefreshAccessTokenRequest { - /** 授权类型,**固定值**: */ - grant_type: string - /** 刷新 `user_access_token` 需要的凭证
获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */ - refresh_token: string -} - export interface GetAuthenUserInfoResponse { /** 用户姓名 */ name?: string @@ -89,6 +61,13 @@ export interface GetAuthenUserInfoResponse { employee_no?: string } +export interface CreateAuthenOidcAccessTokenRequest { + /** 授权类型,**固定值** */ + grant_type: string + /** 登录预授权码 */ + code: string +} + export interface CreateAuthenOidcAccessTokenResponse { /** user_access_token,用于获取用户资源和访问某些open api */ access_token: string @@ -104,6 +83,13 @@ export interface CreateAuthenOidcAccessTokenResponse { scope?: string } +export interface CreateAuthenOidcRefreshAccessTokenRequest { + /** 授权类型,**固定值**: */ + grant_type: string + /** 刷新 `user_access_token` 需要的凭证
获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */ + refresh_token: string +} + export interface CreateAuthenOidcRefreshAccessTokenResponse { /** user_access_token,用于获取用户资源和访问某些open api */ access_token: string @@ -119,6 +105,13 @@ export interface CreateAuthenOidcRefreshAccessTokenResponse { scope?: string } +export interface CreateAuthenAccessTokenRequest { + /** 授权类型,**固定值** */ + grant_type: string + /** 登录预授权码,调用[获取登录预授权码](https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN)接口获取 */ + code: string +} + export interface CreateAuthenAccessTokenResponse { /** user_access_token,用于获取用户资源 */ access_token?: string @@ -160,6 +153,13 @@ export interface CreateAuthenAccessTokenResponse { sid?: string } +export interface CreateAuthenRefreshAccessTokenRequest { + /** 授权类型,**固定值**: */ + grant_type: string + /** 刷新 `user_access_token` 需要的凭证
获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */ + refresh_token: string +} + export interface CreateAuthenRefreshAccessTokenResponse { /** user_access_token,用于获取用户资源 */ access_token?: string diff --git a/adapters/lark/src/types/baike.ts b/adapters/lark/src/types/baike.ts index 2e38d6e9..efa1ad1f 100644 --- a/adapters/lark/src/types/baike.ts +++ b/adapters/lark/src/types/baike.ts @@ -32,7 +32,7 @@ declare module '../internal' { * 获取词条列表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list */ - listBaikeEntity(query?: ListBaikeEntityQuery): Promise + listBaikeEntity(query?: ListBaikeEntityQuery): Promise & AsyncIterableIterator /** * 精准搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match @@ -42,7 +42,7 @@ declare module '../internal' { * 模糊搜索词条 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search */ - searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise + searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise & AsyncIterableIterator /** * 词条高亮 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight @@ -57,7 +57,7 @@ declare module '../internal' { * 获取词典分类 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list */ - listBaikeClassification(query?: Pagination): Promise + listBaikeClassification(query?: Pagination): Promise & AsyncIterableIterator /** * 上传图片 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload @@ -93,6 +93,10 @@ export interface CreateBaikeDraftQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateBaikeDraftResponse { + draft?: Draft +} + export interface UpdateBaikeDraftRequest { /** 实体词 Id */ id?: string @@ -113,6 +117,10 @@ export interface UpdateBaikeDraftQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface UpdateBaikeDraftResponse { + draft?: Draft +} + export interface CreateBaikeEntityRequest { /** 词条名 */ main_keys: Term[] @@ -133,6 +141,10 @@ export interface CreateBaikeEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateBaikeEntityResponse { + entity?: Entity +} + export interface UpdateBaikeEntityRequest { /** 词条名 */ main_keys: Term[] @@ -153,6 +165,10 @@ export interface UpdateBaikeEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface UpdateBaikeEntityResponse { + entity?: Entity +} + export interface GetBaikeEntityQuery { /** 外部系统 */ provider?: string @@ -162,6 +178,11 @@ export interface GetBaikeEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetBaikeEntityResponse { + /** 实体词 */ + entity?: Entity +} + export interface ListBaikeEntityQuery extends Pagination { /** 相关外部系统【可用来过滤词条数据】 */ provider?: string @@ -169,11 +190,22 @@ export interface ListBaikeEntityQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ListBaikeEntityResponse { + entities?: Entity[] + /** 分页标记,当还有下一页时会返回新的 page_token,否则 page_token 为空 */ + page_token?: string +} + export interface MatchBaikeEntityRequest { /** 搜索关键词,将与词条名、别名进行精准匹配 */ word: string } +export interface MatchBaikeEntityResponse { + /** 匹配结果 */ + results?: MatchInfo[] +} + export interface SearchBaikeEntityRequest { /** 搜索关键词 */ query?: string @@ -190,55 +222,6 @@ export interface SearchBaikeEntityQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface HighlightBaikeEntityRequest { - /** 需要识别百科词条的内容(不超过1000字) */ - text: string -} - -export interface ExtractBaikeEntityRequest { - /** 需要被提取百科实体词的文本(不会过滤租户已成为百科词条的内容) */ - text?: string -} - -export interface UploadBaikeFileForm { - /** 文件名称,当前仅支持上传图片且图片格式为以下六种:icon、bmp、gif、png、jpeg、webp */ - name: string - /** 二进制文件内容,高宽像素在 320-4096 像素之间,大小在 3KB-10MB 的图片 */ - file: Blob -} - -export interface CreateBaikeDraftResponse { - draft?: Draft -} - -export interface UpdateBaikeDraftResponse { - draft?: Draft -} - -export interface CreateBaikeEntityResponse { - entity?: Entity -} - -export interface UpdateBaikeEntityResponse { - entity?: Entity -} - -export interface GetBaikeEntityResponse { - /** 实体词 */ - entity?: Entity -} - -export interface ListBaikeEntityResponse { - entities?: Entity[] - /** 分页标记,当还有下一页时会返回新的 page_token,否则 page_token 为空 */ - page_token?: string -} - -export interface MatchBaikeEntityResponse { - /** 匹配结果 */ - results?: MatchInfo[] -} - export interface SearchBaikeEntityResponse { /** 数据数组 */ entities?: Entity[] @@ -246,11 +229,21 @@ export interface SearchBaikeEntityResponse { page_token?: string } +export interface HighlightBaikeEntityRequest { + /** 需要识别百科词条的内容(不超过1000字) */ + text: string +} + export interface HighlightBaikeEntityResponse { /** 返回识别到的实体词信息 */ phrases?: Phrase[] } +export interface ExtractBaikeEntityRequest { + /** 需要被提取百科实体词的文本(不会过滤租户已成为百科词条的内容) */ + text?: string +} + export interface ExtractBaikeEntityResponse { /** 文本中可能的成为百科词条的实体词 */ entity_word: EntityWord[] @@ -262,6 +255,13 @@ export interface ListBaikeClassificationResponse { page_token?: string } +export interface UploadBaikeFileForm { + /** 文件名称,当前仅支持上传图片且图片格式为以下六种:icon、bmp、gif、png、jpeg、webp */ + name: string + /** 二进制文件内容,高宽像素在 320-4096 像素之间,大小在 3KB-10MB 的图片 */ + file: Blob +} + export interface UploadBaikeFileResponse { /** 文件 token */ file_token?: string @@ -276,7 +276,7 @@ Internal.define({ }, '/baike/v1/entities': { POST: 'createBaikeEntity', - GET: 'listBaikeEntity', + GET: { name: 'listBaikeEntity', pagination: { argIndex: 0, itemsKey: 'entities' } }, }, '/baike/v1/entities/{entity_id}': { PUT: 'updateBaikeEntity', @@ -286,7 +286,7 @@ Internal.define({ POST: 'matchBaikeEntity', }, '/baike/v1/entities/search': { - POST: 'searchBaikeEntity', + POST: { name: 'searchBaikeEntity', pagination: { argIndex: 1, itemsKey: 'entities' } }, }, '/baike/v1/entities/highlight': { POST: 'highlightBaikeEntity', @@ -295,7 +295,7 @@ Internal.define({ POST: 'extractBaikeEntity', }, '/baike/v1/classifications': { - GET: 'listBaikeClassification', + GET: { name: 'listBaikeClassification', pagination: { argIndex: 0 } }, }, '/baike/v1/files/upload': { POST: { name: 'uploadBaikeFile', multipart: true }, diff --git a/adapters/lark/src/types/bitable.ts b/adapters/lark/src/types/bitable.ts index 6c8913ba..c7268dd2 100644 --- a/adapters/lark/src/types/bitable.ts +++ b/adapters/lark/src/types/bitable.ts @@ -42,7 +42,7 @@ declare module '../internal' { * 列出数据表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list */ - listBitableAppTable(app_token: string, query?: Pagination): Promise + listBitableAppTable(app_token: string, query?: Pagination): Promise & AsyncIterableIterator /** * 删除一个数据表 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete @@ -67,7 +67,7 @@ declare module '../internal' { * 列出视图 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list */ - listBitableAppTableView(app_token: string, table_id: string, query?: ListBitableAppTableViewQuery): Promise + listBitableAppTableView(app_token: string, table_id: string, query?: ListBitableAppTableViewQuery): Promise & AsyncIterableIterator /** * 获取视图 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get @@ -92,7 +92,7 @@ declare module '../internal' { * 查询记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search */ - searchBitableAppTableRecord(app_token: string, table_id: string, body: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery): Promise + searchBitableAppTableRecord(app_token: string, table_id: string, body: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery): Promise & AsyncIterableIterator /** * 删除记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete @@ -132,7 +132,7 @@ declare module '../internal' { * 列出字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list */ - listBitableAppTableField(app_token: string, table_id: string, query?: ListBitableAppTableFieldQuery): Promise + listBitableAppTableField(app_token: string, table_id: string, query?: ListBitableAppTableFieldQuery): Promise & AsyncIterableIterator /** * 删除字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete @@ -167,7 +167,7 @@ declare module '../internal' { * 列出表单问题 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/list */ - listBitableAppTableFormField(app_token: string, table_id: string, form_id: string, query?: Pagination): Promise + listBitableAppTableFormField(app_token: string, table_id: string, form_id: string, query?: Pagination): Promise & AsyncIterableIterator /** * 新增自定义角色 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create @@ -182,7 +182,7 @@ declare module '../internal' { * 列出自定义角色 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list */ - listBitableAppRole(app_token: string, query?: Pagination): Promise + listBitableAppRole(app_token: string, query?: Pagination): Promise & AsyncIterableIterator /** * 删除自定义角色 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete @@ -202,7 +202,7 @@ declare module '../internal' { * 列出协作者 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list */ - listBitableAppRoleMember(app_token: string, role_id: string, query?: Pagination): Promise + listBitableAppRoleMember(app_token: string, role_id: string, query?: Pagination): Promise & AsyncIterableIterator /** * 删除协作者 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete @@ -232,7 +232,7 @@ declare module '../internal' { * 列出记录 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/list */ - listBitableAppTableRecord(app_token: string, table_id: string, query?: ListBitableAppTableRecordQuery): Promise + listBitableAppTableRecord(app_token: string, table_id: string, query?: ListBitableAppTableRecordQuery): Promise & AsyncIterableIterator } } @@ -245,6 +245,10 @@ export interface CreateBitableAppRequest { time_zone?: string } +export interface CreateBitableAppResponse { + app?: App +} + export interface CopyBitableAppRequest { /** 多维表格 App 名字 */ name?: string @@ -256,6 +260,14 @@ export interface CopyBitableAppRequest { time_zone?: string } +export interface CopyBitableAppResponse { + app?: App +} + +export interface GetBitableAppResponse { + app?: DisplayApp +} + export interface UpdateBitableAppRequest { /** 新的多维表格名字 */ name?: string @@ -263,11 +275,24 @@ export interface UpdateBitableAppRequest { is_advanced?: boolean } +export interface UpdateBitableAppResponse { + app?: DisplayAppV2 +} + export interface CreateBitableAppTableRequest { /** 数据表 */ table?: ReqTable } +export interface CreateBitableAppTableResponse { + /** 数据表的唯一标识id */ + table_id?: string + /** 默认表格视图的id,该字段仅在请求参数中填写了default_view_name或fields才会返回 */ + default_view_id?: string + /** 数据表初始字段的id列表,该字段仅在请求参数中填写了fields才会返回 */ + field_id_list?: string[] +} + export interface BatchCreateBitableAppTableRequest { /** tables */ tables?: ReqTable[] @@ -278,11 +303,30 @@ export interface BatchCreateBitableAppTableQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchCreateBitableAppTableResponse { + table_ids?: string[] +} + export interface PatchBitableAppTableRequest { /** 数据表的新名称 */ name?: string } +export interface PatchBitableAppTableResponse { + /** 数据表的名称 */ + name?: string +} + +export interface ListBitableAppTableResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 总数 */ + total?: number + items?: AppTable[] +} + export interface BatchDeleteBitableAppTableRequest { /** 删除的多条tableid列表 */ table_ids?: string[] @@ -295,6 +339,10 @@ export interface CreateBitableAppTableViewRequest { view_type?: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form' } +export interface CreateBitableAppTableViewResponse { + view?: AppTableView +} + export interface PatchBitableAppTableViewRequest { /** 视图名称 */ view_name?: string @@ -302,14 +350,33 @@ export interface PatchBitableAppTableViewRequest { property?: AppTableViewProperty } +export interface PatchBitableAppTableViewResponse { + view?: AppTableView +} + export interface ListBitableAppTableViewQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ListBitableAppTableViewResponse { + /** 视图列表 */ + items?: AppTableView[] + /** 下一页分页的token */ + page_token?: string + /** 是否有下一页数据 */ + has_more?: boolean + /** 总数 */ + total?: number +} + +export interface GetBitableAppTableViewResponse { + view?: AppTableView +} + export interface CreateBitableAppTableRecordRequest { /** 记录字段 */ - fields: unknown + fields: Record } export interface CreateBitableAppTableRecordQuery { @@ -321,9 +388,13 @@ export interface CreateBitableAppTableRecordQuery { ignore_consistency_check?: boolean } +export interface CreateBitableAppTableRecordResponse { + record?: AppTableRecord +} + export interface UpdateBitableAppTableRecordRequest { /** 记录字段 */ - fields: unknown + fields: Record } export interface UpdateBitableAppTableRecordQuery { @@ -333,6 +404,10 @@ export interface UpdateBitableAppTableRecordQuery { ignore_consistency_check?: boolean } +export interface UpdateBitableAppTableRecordResponse { + record?: AppTableRecord +} + export interface SearchBitableAppTableRecordRequest { /** 视图Id,指定视图id则按照视图的筛选排序结果返回数据 */ view_id?: string @@ -351,6 +426,24 @@ export interface SearchBitableAppTableRecordQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface SearchBitableAppTableRecordResponse { + /** record 结果 */ + items?: AppTableRecord[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 总数 */ + total?: number +} + +export interface DeleteBitableAppTableRecordResponse { + /** 是否成功删除 */ + deleted?: boolean + /** 删除的记录id */ + record_id?: string +} + export interface BatchCreateBitableAppTableRecordRequest { /** 记录 */ records: AppTableRecord[] @@ -365,6 +458,11 @@ export interface BatchCreateBitableAppTableRecordQuery { ignore_consistency_check?: boolean } +export interface BatchCreateBitableAppTableRecordResponse { + /** 本次请求新增的记录列表 */ + records?: AppTableRecord[] +} + export interface BatchUpdateBitableAppTableRecordRequest { /** 记录 */ records: AppTableRecord[] @@ -377,6 +475,11 @@ export interface BatchUpdateBitableAppTableRecordQuery { ignore_consistency_check?: boolean } +export interface BatchUpdateBitableAppTableRecordResponse { + /** 更新后的记录 */ + records?: AppTableRecord[] +} + export interface BatchGetBitableAppTableRecordRequest { /** 记录 id 列表 */ record_ids: string[] @@ -388,16 +491,73 @@ export interface BatchGetBitableAppTableRecordRequest { automatic_fields?: boolean } +export interface BatchGetBitableAppTableRecordResponse { + /** 记录列表 */ + records?: AppTableRecord[] + /** 禁止访问的记录列表(针对开启了高级权限的文档) */ + forbidden_record_ids?: string[] + /** 不存在的记录列表 */ + absent_record_ids?: string[] +} + export interface BatchDeleteBitableAppTableRecordRequest { /** 删除的多条记录id列表 */ records: string[] } +export interface BatchDeleteBitableAppTableRecordResponse { + /** 记录删除结果 */ + records?: DeleteRecord[] +} + +export const enum CreateBitableAppTableFieldRequestType { + /** 多行文本(默认值)、条码 */ + Text = 1, + /** 数字(默认值)、进度、货币、评分 */ + Number = 2, + /** 单选 */ + SingleSelect = 3, + /** 多选 */ + MultiSelect = 4, + /** 日期 */ + DateTime = 5, + /** 复选框 */ + Checkbox = 7, + /** 人员 */ + User = 11, + /** 电话号码 */ + PhoneNumber = 13, + /** 超链接 */ + Url = 15, + /** 附件 */ + Attachment = 17, + /** 单向关联 */ + Link = 18, + /** 公式 */ + Formula = 20, + /** 双向关联 */ + DuplexLink = 21, + /** 地理位置 */ + Location = 22, + /** 群组 */ + GroupChat = 23, + /** 创建时间 */ + CreatedTime = 1001, + /** 最后更新时间 */ + ModifiedTime = 1002, + /** 创建人 */ + CreatedUser = 1003, + /** 修改人 */ + ModifiedUser = 1004, + /** 自动编号 */ + AutoSerial = 1005, +} + export interface CreateBitableAppTableFieldRequest { /** 字段名 */ field_name: string /** 字段类型 */ - type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005 + type: CreateBitableAppTableFieldRequestType /** 字段属性 */ property?: AppTableFieldProperty /** 字段的描述 */ @@ -411,11 +571,58 @@ export interface CreateBitableAppTableFieldQuery { client_token?: string } +export interface CreateBitableAppTableFieldResponse { + field?: AppTableField +} + +export const enum UpdateBitableAppTableFieldRequestType { + /** 多行文本(默认值)、条码 */ + Text = 1, + /** 数字(默认值)、进度、货币、评分 */ + Number = 2, + /** 单选 */ + SingleSelect = 3, + /** 多选 */ + MultiSelect = 4, + /** 日期 */ + DateTime = 5, + /** 复选框 */ + Checkbox = 7, + /** 人员 */ + User = 11, + /** 电话号码 */ + PhoneNumber = 13, + /** 超链接 */ + Url = 15, + /** 附件 */ + Attachment = 17, + /** 单向关联 */ + Link = 18, + /** 公式 */ + Formula = 20, + /** 双向关联 */ + DuplexLink = 21, + /** 地理位置 */ + Location = 22, + /** 群组 */ + GroupChat = 23, + /** 创建时间 */ + CreatedTime = 1001, + /** 最后更新时间 */ + ModifiedTime = 1002, + /** 创建人 */ + CreatedUser = 1003, + /** 修改人 */ + ModifiedUser = 1004, + /** 自动编号 */ + AutoSerial = 1005, +} + export interface UpdateBitableAppTableFieldRequest { /** 字段名 */ field_name: string /** 字段类型 */ - type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005 + type: UpdateBitableAppTableFieldRequestType /** 字段属性 */ property?: AppTableFieldProperty /** 字段的描述 */ @@ -424,6 +631,10 @@ export interface UpdateBitableAppTableFieldRequest { ui_type?: 'Text' | 'Email' | 'Barcode' | 'Number' | 'Progress' | 'Currency' | 'Rating' | 'SingleSelect' | 'MultiSelect' | 'DateTime' | 'Checkbox' | 'User' | 'GroupChat' | 'Phone' | 'Url' | 'Attachment' | 'SingleLink' | 'Formula' | 'DuplexLink' | 'Location' | 'CreatedTime' | 'ModifiedTime' | 'CreatedUser' | 'ModifiedUser' | 'AutoNumber' } +export interface UpdateBitableAppTableFieldResponse { + field?: AppTableField +} + export interface ListBitableAppTableFieldQuery extends Pagination { /** 视图 ID */ view_id?: string @@ -431,11 +642,36 @@ export interface ListBitableAppTableFieldQuery extends Pagination { text_field_as_array?: boolean } +export interface ListBitableAppTableFieldResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 总数 */ + total?: number + /** 字段列表 */ + items?: AppTableFieldForList[] +} + +export interface DeleteBitableAppTableFieldResponse { + /** 字段唯一标识id */ + field_id?: string + /** 是否已删除 */ + deleted?: boolean +} + export interface CopyBitableAppDashboardRequest { /** 仪表盘名称 */ name: string } +export interface CopyBitableAppDashboardResponse { + /** 多维表格 block_id */ + block_id?: string + /** block 名称 */ + name?: string +} + export interface PatchBitableAppTableFormRequest { /** 表单名称 */ name?: string @@ -449,6 +685,16 @@ export interface PatchBitableAppTableFormRequest { submit_limit_once?: boolean } +export interface PatchBitableAppTableFormResponse { + /** 表单元数据信息 */ + form: AppTableForm +} + +export interface GetBitableAppTableFormResponse { + /** 表单元数据信息 */ + form: AppTableForm +} + export interface PatchBitableAppTableFormFieldRequest { /** 上一个表单问题 ID */ pre_field_id?: string @@ -462,6 +708,22 @@ export interface PatchBitableAppTableFormFieldRequest { visible?: boolean } +export interface PatchBitableAppTableFormFieldResponse { + /** 更新后的field值 */ + field?: AppTableFormPatchedField +} + +export interface ListBitableAppTableFormFieldResponse { + /** 表单内的字段列表 */ + items: AppTableFormField[] + /** 下一页分页的token */ + page_token: string + /** 是否有下一页 */ + has_more: boolean + /** 总数 */ + total: number +} + export interface CreateBitableAppRoleRequest { /** 自定义权限的名字 */ role_name: string @@ -471,6 +733,10 @@ export interface CreateBitableAppRoleRequest { block_roles?: AppRoleBlockRole[] } +export interface CreateBitableAppRoleResponse { + role?: AppRole +} + export interface UpdateBitableAppRoleRequest { /** 自定义权限的名字 */ role_name: string @@ -480,6 +746,21 @@ export interface UpdateBitableAppRoleRequest { block_roles?: AppRoleBlockRole[] } +export interface UpdateBitableAppRoleResponse { + role?: AppRole +} + +export interface ListBitableAppRoleResponse { + /** 角色列表 */ + items?: AppRole[] + /** 下一页分页的token */ + page_token?: string + /** 是否有下一页数据 */ + has_more?: boolean + /** 总数 */ + total?: number +} + export interface CreateBitableAppRoleMemberRequest { /** 协作者id */ member_id: string @@ -495,6 +776,17 @@ export interface BatchCreateBitableAppRoleMemberRequest { member_list: AppRoleMemberId[] } +export interface ListBitableAppRoleMemberResponse { + /** 协作者列表 */ + items?: AppRoleMember[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 总数 */ + total?: number +} + export interface DeleteBitableAppRoleMemberQuery { /** 协作者id类型,与请求体中的member_id要对应 */ member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id' @@ -505,6 +797,11 @@ export interface BatchDeleteBitableAppRoleMemberRequest { member_list: AppRoleMemberId[] } +export interface ListBitableAppWorkflowResponse { + /** 自动化工作流信息 */ + workflows: AppWorkflow[] +} + export interface UpdateBitableAppWorkflowRequest { /** 自动化状态 */ status: string @@ -523,6 +820,10 @@ export interface GetBitableAppTableRecordQuery { automatic_fields?: boolean } +export interface GetBitableAppTableRecordResponse { + record?: AppTableRecord +} + export interface ListBitableAppTableRecordQuery extends Pagination { /** 视图 id注意:如 filter 或 sort 有值,view_id 会被忽略。 */ view_id?: string @@ -542,221 +843,6 @@ export interface ListBitableAppTableRecordQuery extends Pagination { automatic_fields?: boolean } -export interface CreateBitableAppResponse { - app?: App -} - -export interface CopyBitableAppResponse { - app?: App -} - -export interface GetBitableAppResponse { - app?: DisplayApp -} - -export interface UpdateBitableAppResponse { - app?: DisplayAppV2 -} - -export interface CreateBitableAppTableResponse { - /** 数据表的唯一标识id */ - table_id?: string - /** 默认表格视图的id,该字段仅在请求参数中填写了default_view_name或fields才会返回 */ - default_view_id?: string - /** 数据表初始字段的id列表,该字段仅在请求参数中填写了fields才会返回 */ - field_id_list?: string[] -} - -export interface BatchCreateBitableAppTableResponse { - table_ids?: string[] -} - -export interface PatchBitableAppTableResponse { - /** 数据表的名称 */ - name?: string -} - -export interface ListBitableAppTableResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 总数 */ - total?: number - items?: AppTable[] -} - -export interface CreateBitableAppTableViewResponse { - view?: AppTableView -} - -export interface PatchBitableAppTableViewResponse { - view?: AppTableView -} - -export interface ListBitableAppTableViewResponse { - /** 视图列表 */ - items?: AppTableView[] - /** 下一页分页的token */ - page_token?: string - /** 是否有下一页数据 */ - has_more?: boolean - /** 总数 */ - total?: number -} - -export interface GetBitableAppTableViewResponse { - view?: AppTableView -} - -export interface CreateBitableAppTableRecordResponse { - record?: AppTableRecord -} - -export interface UpdateBitableAppTableRecordResponse { - record?: AppTableRecord -} - -export interface SearchBitableAppTableRecordResponse { - /** record 结果 */ - items?: AppTableRecord[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 总数 */ - total?: number -} - -export interface DeleteBitableAppTableRecordResponse { - /** 是否成功删除 */ - deleted?: boolean - /** 删除的记录id */ - record_id?: string -} - -export interface BatchCreateBitableAppTableRecordResponse { - /** 本次请求新增的记录列表 */ - records?: AppTableRecord[] -} - -export interface BatchUpdateBitableAppTableRecordResponse { - /** 更新后的记录 */ - records?: AppTableRecord[] -} - -export interface BatchGetBitableAppTableRecordResponse { - /** 记录列表 */ - records?: AppTableRecord[] - /** 禁止访问的记录列表(针对开启了高级权限的文档) */ - forbidden_record_ids?: string[] - /** 不存在的记录列表 */ - absent_record_ids?: string[] -} - -export interface BatchDeleteBitableAppTableRecordResponse { - /** 记录删除结果 */ - records?: DeleteRecord[] -} - -export interface CreateBitableAppTableFieldResponse { - field?: AppTableField -} - -export interface UpdateBitableAppTableFieldResponse { - field?: AppTableField -} - -export interface ListBitableAppTableFieldResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 总数 */ - total?: number - /** 字段列表 */ - items?: AppTableFieldForList[] -} - -export interface DeleteBitableAppTableFieldResponse { - /** 字段唯一标识id */ - field_id?: string - /** 是否已删除 */ - deleted?: boolean -} - -export interface CopyBitableAppDashboardResponse { - /** 多维表格 block_id */ - block_id?: string - /** block 名称 */ - name?: string -} - -export interface PatchBitableAppTableFormResponse { - /** 表单元数据信息 */ - form: AppTableForm -} - -export interface GetBitableAppTableFormResponse { - /** 表单元数据信息 */ - form: AppTableForm -} - -export interface PatchBitableAppTableFormFieldResponse { - /** 更新后的field值 */ - field?: AppTableFormPatchedField -} - -export interface ListBitableAppTableFormFieldResponse { - /** 表单内的字段列表 */ - items: AppTableFormField[] - /** 下一页分页的token */ - page_token: string - /** 是否有下一页 */ - has_more: boolean - /** 总数 */ - total: number -} - -export interface CreateBitableAppRoleResponse { - role?: AppRole -} - -export interface UpdateBitableAppRoleResponse { - role?: AppRole -} - -export interface ListBitableAppRoleResponse { - /** 角色列表 */ - items?: AppRole[] - /** 下一页分页的token */ - page_token?: string - /** 是否有下一页数据 */ - has_more?: boolean - /** 总数 */ - total?: number -} - -export interface ListBitableAppRoleMemberResponse { - /** 协作者列表 */ - items?: AppRoleMember[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string - /** 总数 */ - total?: number -} - -export interface ListBitableAppWorkflowResponse { - /** 自动化工作流信息 */ - workflows: AppWorkflow[] -} - -export interface GetBitableAppTableRecordResponse { - record?: AppTableRecord -} - export interface ListBitableAppTableRecordResponse { /** 是否有下一页数据 */ has_more?: boolean @@ -780,7 +866,7 @@ Internal.define({ }, '/bitable/v1/apps/{app_token}/tables': { POST: 'createBitableAppTable', - GET: 'listBitableAppTable', + GET: { name: 'listBitableAppTable', pagination: { argIndex: 1 } }, }, '/bitable/v1/apps/{app_token}/tables/batch_create': { POST: 'batchCreateBitableAppTable', @@ -794,7 +880,7 @@ Internal.define({ }, '/bitable/v1/apps/{app_token}/tables/{table_id}/views': { POST: 'createBitableAppTableView', - GET: 'listBitableAppTableView', + GET: { name: 'listBitableAppTableView', pagination: { argIndex: 2 } }, }, '/bitable/v1/apps/{app_token}/tables/{table_id}/views/{view_id}': { PATCH: 'patchBitableAppTableView', @@ -803,7 +889,7 @@ Internal.define({ }, '/bitable/v1/apps/{app_token}/tables/{table_id}/records': { POST: 'createBitableAppTableRecord', - GET: 'listBitableAppTableRecord', + GET: { name: 'listBitableAppTableRecord', pagination: { argIndex: 2 } }, }, '/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}': { PUT: 'updateBitableAppTableRecord', @@ -811,7 +897,7 @@ Internal.define({ GET: 'getBitableAppTableRecord', }, '/bitable/v1/apps/{app_token}/tables/{table_id}/records/search': { - POST: 'searchBitableAppTableRecord', + POST: { name: 'searchBitableAppTableRecord', pagination: { argIndex: 3 } }, }, '/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_create': { POST: 'batchCreateBitableAppTableRecord', @@ -827,7 +913,7 @@ Internal.define({ }, '/bitable/v1/apps/{app_token}/tables/{table_id}/fields': { POST: 'createBitableAppTableField', - GET: 'listBitableAppTableField', + GET: { name: 'listBitableAppTableField', pagination: { argIndex: 2 } }, }, '/bitable/v1/apps/{app_token}/tables/{table_id}/fields/{field_id}': { PUT: 'updateBitableAppTableField', @@ -847,11 +933,11 @@ Internal.define({ PATCH: 'patchBitableAppTableFormField', }, '/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}/fields': { - GET: 'listBitableAppTableFormField', + GET: { name: 'listBitableAppTableFormField', pagination: { argIndex: 3 } }, }, '/bitable/v1/apps/{app_token}/roles': { POST: 'createBitableAppRole', - GET: 'listBitableAppRole', + GET: { name: 'listBitableAppRole', pagination: { argIndex: 1 } }, }, '/bitable/v1/apps/{app_token}/roles/{role_id}': { PUT: 'updateBitableAppRole', @@ -859,7 +945,7 @@ Internal.define({ }, '/bitable/v1/apps/{app_token}/roles/{role_id}/members': { POST: 'createBitableAppRoleMember', - GET: 'listBitableAppRoleMember', + GET: { name: 'listBitableAppRoleMember', pagination: { argIndex: 2 } }, }, '/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_create': { POST: 'batchCreateBitableAppRoleMember', diff --git a/adapters/lark/src/types/calendar.ts b/adapters/lark/src/types/calendar.ts index 68a859ff..172ec0e3 100644 --- a/adapters/lark/src/types/calendar.ts +++ b/adapters/lark/src/types/calendar.ts @@ -42,7 +42,7 @@ declare module '../internal' { * 搜索日历 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/search */ - searchCalendar(body: SearchCalendarRequest, query?: Pagination): Promise + searchCalendar(body: SearchCalendarRequest, query?: Pagination): Promise & AsyncIterableIterator /** * 订阅日历 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscribe @@ -117,7 +117,7 @@ declare module '../internal' { * 搜索日程 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search */ - searchCalendarCalendarEvent(calendar_id: string, body: SearchCalendarCalendarEventRequest, query?: SearchCalendarCalendarEventQuery): Promise + searchCalendarCalendarEvent(calendar_id: string, body: SearchCalendarCalendarEventRequest, query?: SearchCalendarCalendarEventQuery): Promise & AsyncIterableIterator /** * 订阅日程变更事件 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/subscription @@ -224,11 +224,44 @@ export interface CreateCalendarRequest { summary_alias?: string } +export interface CreateCalendarResponse { + /** 日历信息 */ + calendar?: Calendar +} + export interface PrimaryCalendarQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface PrimaryCalendarResponse { + /** 主日历列表 */ + calendars?: UserCalendar[] +} + +export interface GetCalendarResponse { + /** 日历OpenId */ + calendar_id: string + /** 日历标题 */ + summary?: string + /** 日历描述 */ + description?: string + /** 权限 */ + permissions?: 'private' | 'show_only_free_busy' | 'public' + /** 日历颜色,颜色RGB值的int32表示。客户端展示时会映射到色板上最接近的一种颜色。仅对当前身份生效 */ + color?: number + /** 日历类型 */ + type?: 'unknown' | 'primary' | 'shared' | 'google' | 'resource' | 'exchange' + /** 日历备注名,修改或添加后仅对当前身份生效 */ + summary_alias?: string + /** 对于当前身份,日历是否已经被标记为删除 */ + is_deleted?: boolean + /** 当前日历是否是第三方数据;三方日历及日程只支持读,不支持写入 */ + is_third_party?: boolean + /** 当前身份对于该日历的访问权限 */ + role?: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner' +} + export interface ListCalendarFreebusyRequest { /** 查询时段开始时间,需要url编码 */ time_min: string @@ -249,11 +282,27 @@ export interface ListCalendarFreebusyQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ListCalendarFreebusyResponse { + /** 日历上请求时间区间内的忙闲信息 */ + freebusy_list?: Freebusy[] +} + export interface ListCalendarQuery extends Pagination { /** 上次请求Response返回的增量同步标记,分页请求未结束时为空 */ sync_token?: string } +export interface ListCalendarResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下次请求需要带上的分页标记,90 天有效期 */ + page_token?: string + /** 下次请求需要带上的增量同步标记,90 天有效期 */ + sync_token?: string + /** 分页加载的日历数据列表 */ + calendar_list?: Calendar[] +} + export interface PatchCalendarRequest { /** 标题 */ summary?: string @@ -267,11 +316,28 @@ export interface PatchCalendarRequest { summary_alias?: string } +export interface PatchCalendarResponse { + /** 日历信息 */ + calendar?: Calendar +} + export interface SearchCalendarRequest { /** 搜索关键字 */ query: string } +export interface SearchCalendarResponse { + /** 搜索命中的日历列表 */ + items?: Calendar[] + /** 下次请求需要带上的分页标记 */ + page_token?: string +} + +export interface SubscribeCalendarResponse { + /** 日历信息 */ + calendar?: Calendar +} + export interface CreateCalendarCalendarAclRequest { /** 对日历的访问权限 */ role: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner' @@ -284,6 +350,15 @@ export interface CreateCalendarCalendarAclQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateCalendarCalendarAclResponse { + /** acl资源ID */ + acl_id: string + /** 对日历的访问权限 */ + role: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner' + /** 权限范围 */ + scope: AclScope +} + export interface ListCalendarCalendarAclQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -329,6 +404,11 @@ export interface CreateCalendarCalendarEventQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateCalendarCalendarEventResponse { + /** 日程信息 */ + event?: CalendarEvent +} + export interface DeleteCalendarCalendarEventQuery { /** 删除日程是否给日程参与人发送bot通知,默认为true */ need_notification?: 'true' | 'false' @@ -372,6 +452,11 @@ export interface PatchCalendarCalendarEventQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface PatchCalendarCalendarEventResponse { + /** 日程信息 */ + event?: CalendarEvent +} + export interface GetCalendarCalendarEventQuery { /** 是否需要返回会前设置 */ need_meeting_settings?: boolean @@ -383,6 +468,11 @@ export interface GetCalendarCalendarEventQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetCalendarCalendarEventResponse { + /** 日程信息 */ + event?: CalendarEvent +} + export interface ListCalendarCalendarEventQuery extends Pagination { /** 拉取anchor_time之后的日程,为timestamp */ anchor_time?: string @@ -396,6 +486,17 @@ export interface ListCalendarCalendarEventQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ListCalendarCalendarEventResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下次请求需要带上的分页标记,90 天有效期 */ + page_token?: string + /** 下次请求需要带上的增量同步标记,90 天有效期 */ + sync_token?: string + /** 日程列表 */ + items?: CalendarEvent[] +} + export interface SearchCalendarCalendarEventRequest { /** 搜索关键字 */ query: string @@ -408,6 +509,13 @@ export interface SearchCalendarCalendarEventQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface SearchCalendarCalendarEventResponse { + /** 搜索命中的日程列表 */ + items?: CalendarEvent[] + /** 下次请求需要带上的分页标记 */ + page_token?: string +} + export interface ReplyCalendarCalendarEventRequest { /** rsvp-日程状态 */ rsvp_status: 'accept' | 'decline' | 'tentative' @@ -429,11 +537,28 @@ export interface InstanceViewCalendarCalendarEventQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface InstanceViewCalendarCalendarEventResponse { + /** 日程instance列表 */ + items?: Instance[] +} + +export interface CreateCalendarCalendarEventMeetingChatResponse { + /** 会议群ID */ + meeting_chat_id?: string + /** 群分享链接 */ + applink?: string +} + export interface DeleteCalendarCalendarEventMeetingChatQuery { /** 会议群ID */ meeting_chat_id: string } +export interface CreateCalendarCalendarEventMeetingMinuteResponse { + /** 文档URL */ + doc_url?: string +} + export interface CreateCalendarTimeoffEventRequest { /** 用户的user id */ user_id: string @@ -454,6 +579,23 @@ export interface CreateCalendarTimeoffEventQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateCalendarTimeoffEventResponse { + /** 休假申请的唯一标识id */ + timeoff_event_id: string + /** 用户的user id */ + user_id: string + /** 休假人的时区 */ + timezone: string + /** 休假开始时间(时间戳)/日期(2021-01-01),为日期时将生成全天日程,且与end_time对应,不符合将返回错误 */ + start_time: string + /** 休假结束时间(时间戳)/日期(2021-01-01),为日期时将生成全天日程,与start_time对应,不符合将返回错误 */ + end_time: string + /** 休假日程标题,可自定义例如:"请假中(全天) / 1-Day Time Off","请假中(半天) / 0.5-Day Time Off","长期休假中 / Leave of Absence","请假中" */ + title?: string + /** 休假日程描述,可自定义,例如:"若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked." */ + description?: string +} + export interface CreateCalendarCalendarEventAttendeeRequest { /** 新增参与人列表;
- 单次请求会议室的数量限制为100。 */ attendees?: CalendarEventAttendee[] @@ -472,6 +614,11 @@ export interface CreateCalendarCalendarEventAttendeeQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateCalendarCalendarEventAttendeeResponse { + /** 被添加的参与人列表 */ + attendees?: CalendarEventAttendee[] +} + export interface BatchDeleteCalendarCalendarEventAttendeeRequest { /** 要移除的参与人 ID 列表。参见[参与人ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/introduction#4998889c) */ attendee_ids?: string[] @@ -507,6 +654,17 @@ export interface GenerateCaldavConfCalendarSettingRequest { device_name?: string } +export interface GenerateCaldavConfCalendarSettingResponse { + /** caldav密码 */ + password?: string + /** caldav用户名 */ + user_name?: string + /** 服务器地址 */ + server_address?: string + /** 设备名 */ + device_name?: string +} + export interface CreateCalendarExchangeBindingRequest { /** admin账户 */ admin_account?: string @@ -521,169 +679,6 @@ export interface CreateCalendarExchangeBindingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetCalendarExchangeBindingQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface CreateCalendarResponse { - /** 日历信息 */ - calendar?: Calendar -} - -export interface PrimaryCalendarResponse { - /** 主日历列表 */ - calendars?: UserCalendar[] -} - -export interface GetCalendarResponse { - /** 日历OpenId */ - calendar_id: string - /** 日历标题 */ - summary?: string - /** 日历描述 */ - description?: string - /** 权限 */ - permissions?: 'private' | 'show_only_free_busy' | 'public' - /** 日历颜色,颜色RGB值的int32表示。客户端展示时会映射到色板上最接近的一种颜色。仅对当前身份生效 */ - color?: number - /** 日历类型 */ - type?: 'unknown' | 'primary' | 'shared' | 'google' | 'resource' | 'exchange' - /** 日历备注名,修改或添加后仅对当前身份生效 */ - summary_alias?: string - /** 对于当前身份,日历是否已经被标记为删除 */ - is_deleted?: boolean - /** 当前日历是否是第三方数据;三方日历及日程只支持读,不支持写入 */ - is_third_party?: boolean - /** 当前身份对于该日历的访问权限 */ - role?: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner' -} - -export interface ListCalendarFreebusyResponse { - /** 日历上请求时间区间内的忙闲信息 */ - freebusy_list?: Freebusy[] -} - -export interface ListCalendarResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下次请求需要带上的分页标记,90 天有效期 */ - page_token?: string - /** 下次请求需要带上的增量同步标记,90 天有效期 */ - sync_token?: string - /** 分页加载的日历数据列表 */ - calendar_list?: Calendar[] -} - -export interface PatchCalendarResponse { - /** 日历信息 */ - calendar?: Calendar -} - -export interface SearchCalendarResponse { - /** 搜索命中的日历列表 */ - items?: Calendar[] - /** 下次请求需要带上的分页标记 */ - page_token?: string -} - -export interface SubscribeCalendarResponse { - /** 日历信息 */ - calendar?: Calendar -} - -export interface CreateCalendarCalendarAclResponse { - /** acl资源ID */ - acl_id: string - /** 对日历的访问权限 */ - role: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner' - /** 权限范围 */ - scope: AclScope -} - -export interface CreateCalendarCalendarEventResponse { - /** 日程信息 */ - event?: CalendarEvent -} - -export interface PatchCalendarCalendarEventResponse { - /** 日程信息 */ - event?: CalendarEvent -} - -export interface GetCalendarCalendarEventResponse { - /** 日程信息 */ - event?: CalendarEvent -} - -export interface ListCalendarCalendarEventResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下次请求需要带上的分页标记,90 天有效期 */ - page_token?: string - /** 下次请求需要带上的增量同步标记,90 天有效期 */ - sync_token?: string - /** 日程列表 */ - items?: CalendarEvent[] -} - -export interface SearchCalendarCalendarEventResponse { - /** 搜索命中的日程列表 */ - items?: CalendarEvent[] - /** 下次请求需要带上的分页标记 */ - page_token?: string -} - -export interface InstanceViewCalendarCalendarEventResponse { - /** 日程instance列表 */ - items?: Instance[] -} - -export interface CreateCalendarCalendarEventMeetingChatResponse { - /** 会议群ID */ - meeting_chat_id?: string - /** 群分享链接 */ - applink?: string -} - -export interface CreateCalendarCalendarEventMeetingMinuteResponse { - /** 文档URL */ - doc_url?: string -} - -export interface CreateCalendarTimeoffEventResponse { - /** 休假申请的唯一标识id */ - timeoff_event_id: string - /** 用户的user id */ - user_id: string - /** 休假人的时区 */ - timezone: string - /** 休假开始时间(时间戳)/日期(2021-01-01),为日期时将生成全天日程,且与end_time对应,不符合将返回错误 */ - start_time: string - /** 休假结束时间(时间戳)/日期(2021-01-01),为日期时将生成全天日程,与start_time对应,不符合将返回错误 */ - end_time: string - /** 休假日程标题,可自定义例如:"请假中(全天) / 1-Day Time Off","请假中(半天) / 0.5-Day Time Off","长期休假中 / Leave of Absence","请假中" */ - title?: string - /** 休假日程描述,可自定义,例如:"若拒绝或删除此日程,飞书中相应的“请假”标签将自动消失,而请假系统中的休假申请不会被撤销。If the event is rejected or deleted, corresponding "On Leave" tag in Feishu will disappear, while the leave request in the time off system will not be revoked." */ - description?: string -} - -export interface CreateCalendarCalendarEventAttendeeResponse { - /** 被添加的参与人列表 */ - attendees?: CalendarEventAttendee[] -} - -export interface GenerateCaldavConfCalendarSettingResponse { - /** caldav密码 */ - password?: string - /** caldav用户名 */ - user_name?: string - /** 服务器地址 */ - server_address?: string - /** 设备名 */ - device_name?: string -} - export interface CreateCalendarExchangeBindingResponse { /** admin账户 */ admin_account?: string @@ -697,6 +692,11 @@ export interface CreateCalendarExchangeBindingResponse { exchange_binding_id: string } +export interface GetCalendarExchangeBindingQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetCalendarExchangeBindingResponse { /** admin账户 */ admin_account?: string @@ -727,7 +727,7 @@ Internal.define({ POST: 'listCalendarFreebusy', }, '/calendar/v4/calendars/search': { - POST: 'searchCalendar', + POST: { name: 'searchCalendar', pagination: { argIndex: 1 } }, }, '/calendar/v4/calendars/{calendar_id}/subscribe': { POST: 'subscribeCalendar', @@ -764,7 +764,7 @@ Internal.define({ GET: 'getCalendarCalendarEvent', }, '/calendar/v4/calendars/{calendar_id}/events/search': { - POST: 'searchCalendarCalendarEvent', + POST: { name: 'searchCalendarCalendarEvent', pagination: { argIndex: 2 } }, }, '/calendar/v4/calendars/{calendar_id}/events/subscription': { POST: 'subscriptionCalendarCalendarEvent', diff --git a/adapters/lark/src/types/cardkit.ts b/adapters/lark/src/types/cardkit.ts index a23d6896..003a7b8c 100644 --- a/adapters/lark/src/types/cardkit.ts +++ b/adapters/lark/src/types/cardkit.ts @@ -63,6 +63,11 @@ export interface CreateCardkitCardRequest { data: string } +export interface CreateCardkitCardResponse { + /** 卡片ID */ + card_id: string +} + export interface SettingsCardkitCardRequest { /** 卡片设置 */ settings: string @@ -95,6 +100,11 @@ export interface IdConvertCardkitCardRequest { message_id: string } +export interface IdConvertCardkitCardResponse { + /** 消息 ID 对应的卡片 ID */ + card_id?: string +} + export interface CreateCardkitCardElementRequest { /** 添加组件的方式 */ type: 'insert_before' | 'insert_after' | 'append' @@ -142,16 +152,6 @@ export interface DeleteCardkitCardElementRequest { sequence: number } -export interface CreateCardkitCardResponse { - /** 卡片ID */ - card_id: string -} - -export interface IdConvertCardkitCardResponse { - /** 消息 ID 对应的卡片 ID */ - card_id?: string -} - Internal.define({ '/cardkit/v1/cards': { POST: 'createCardkitCard', diff --git a/adapters/lark/src/types/contact.ts b/adapters/lark/src/types/contact.ts index 3d2725c9..7865a29f 100644 --- a/adapters/lark/src/types/contact.ts +++ b/adapters/lark/src/types/contact.ts @@ -363,6 +363,30 @@ export interface ListContactScopeQuery extends Pagination { department_id_type?: 'department_id' | 'open_department_id' } +export interface ListContactScopeResponse { + /** 已授权部门列表,授权范围为全员可见时返回的是当前企业的所有一级部门列表 */ + department_ids?: string[] + /** 已授权用户列表,应用申请了获取用户user_id 权限时返回;当授权范围为全员可见时返回的是当前企业所有顶级部门用户列表 */ + user_ids?: string[] + /** 已授权的用户组,授权范围为全员可见时返回的是当前企业所有用户组 */ + group_ids?: string[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token */ + page_token?: string +} + +export const enum CreateContactUserRequestGender { + /** 保密 */ + Unkown = 0, + /** 男 */ + Male = 1, + /** 女 */ + Female = 2, + /** 其他 */ + Others = 3, +} + export interface CreateContactUserRequest { /** 租户内用户的唯一标识 */ user_id?: string @@ -379,7 +403,7 @@ export interface CreateContactUserRequest { /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */ mobile_visible?: boolean /** 性别 */ - gender?: 0 | 1 | 2 | 3 + gender?: CreateContactUserRequestGender /** 头像的文件Key */ avatar_key?: string /** 用户所在的部门 */ @@ -427,6 +451,21 @@ export interface CreateContactUserQuery { client_token?: string } +export interface CreateContactUserResponse { + user?: User +} + +export const enum PatchContactUserRequestGender { + /** 保密 */ + Unkown = 0, + /** 男 */ + Male = 1, + /** 女 */ + Female = 2, + /** 其他 */ + Others = 3, +} + export interface PatchContactUserRequest { /** 用户名称 */ name?: string @@ -441,7 +480,7 @@ export interface PatchContactUserRequest { /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */ mobile_visible?: boolean /** 性别 */ - gender?: 0 | 1 | 2 | 3 + gender?: PatchContactUserRequestGender /** 头像的文件Key */ avatar_key?: string /** 用户所在部门ID */ @@ -487,6 +526,10 @@ export interface PatchContactUserQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface PatchContactUserResponse { + user?: User +} + export interface UpdateUserIdContactUserRequest { /** 自定义新用户ID */ new_user_id: string @@ -504,6 +547,10 @@ export interface GetContactUserQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface GetContactUserResponse { + user?: User +} + export interface BatchContactUserQuery { /** 要查询的用户ID列表 */ user_ids: string[] @@ -513,6 +560,11 @@ export interface BatchContactUserQuery { department_id_type?: 'open_department_id' | 'department_id' } +export interface BatchContactUserResponse { + /** 查询到的用户信息,其中异常的用户ID不返回结果。 */ + items?: User[] +} + export interface FindByDepartmentContactUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -536,6 +588,11 @@ export interface BatchGetIdContactUserQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface BatchGetIdContactUserResponse { + /** 手机号或者邮箱对应的用户id信息 */ + user_list?: UserContactInfo[] +} + export interface DeleteContactUserRequest { /** 部门群接收者。被删除用户为部门群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内第一个入群的人 */ department_chat_acceptor_user_id?: string @@ -576,13 +633,20 @@ export interface ResurrectContactUserQuery { department_id_type?: 'department_id' | 'open_department_id' } +export const enum CreateContactGroupRequestType { + /** 普通用户组 */ + Assign = 1, + /** 动态用户组 */ + Dynamic = 2, +} + export interface CreateContactGroupRequest { /** 用户组的名字,企业内唯一,最大长度:100 字符 */ name: string /** 用户组描述 */ description?: string /** 用户组的类型。默认为1表示普通用户组 */ - type?: 1 | 2 + type?: CreateContactGroupRequestType /** 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。自定义group_id数据校验规则:最大长度:64 字符校验规则:数字、大小写字母的组合,不能包含空格 */ group_id?: string } @@ -594,6 +658,11 @@ export interface CreateContactGroupQuery { department_id_type?: 'open_department_id' | 'department_id' } +export interface CreateContactGroupResponse { + /** 用户组ID */ + group_id: string +} + export interface PatchContactGroupRequest { /** 用户组的名字,企业内唯一,最大长度:100 字符 */ name?: string @@ -615,9 +684,28 @@ export interface GetContactGroupQuery { department_id_type?: 'open_department_id' | 'department_id' } +export interface GetContactGroupResponse { + /** 用户组详情 */ + group: Group +} + +export const enum SimplelistContactGroupQueryType { + /** 普通用户组 */ + Assign = 1, + /** 动态用户组 */ + Dynamic = 2, +} + export interface SimplelistContactGroupQuery extends Pagination { /** 用户组类型 */ - type?: 1 | 2 + type?: SimplelistContactGroupQueryType +} + +export const enum MemberBelongContactGroupQueryGroupType { + /** 普通用户组 */ + Assign = 1, + /** 动态用户组 */ + Dynamic = 2, } export interface MemberBelongContactGroupQuery extends Pagination { @@ -626,31 +714,68 @@ export interface MemberBelongContactGroupQuery extends Pagination { /** 成员ID类型 */ member_id_type?: 'open_id' | 'union_id' | 'user_id' /** 欲获取的用户组类型 */ - group_type?: 1 | 2 + group_type?: MemberBelongContactGroupQueryGroupType +} + +export const enum CreateContactEmployeeTypeEnumRequestEnumType { + /** 内置类型 */ + Defualt = 1, + /** 自定义 */ + Custom = 2, +} + +export const enum CreateContactEmployeeTypeEnumRequestEnumStatus { + /** 激活 */ + Active = 1, + /** 未激活 */ + Inactive = 2, } export interface CreateContactEmployeeTypeEnumRequest { /** 枚举内容 */ content: string /** 类型 */ - enum_type: 1 | 2 + enum_type: CreateContactEmployeeTypeEnumRequestEnumType /** 类型 */ - enum_status: 1 | 2 + enum_status: CreateContactEmployeeTypeEnumRequestEnumStatus /** i18n定义 */ i18n_content?: I18nContent[] } +export interface CreateContactEmployeeTypeEnumResponse { + /** 创建人员类型接口 */ + employee_type_enum?: EmployeeTypeEnum +} + +export const enum UpdateContactEmployeeTypeEnumRequestEnumType { + /** 内置类型 */ + Defualt = 1, + /** 自定义 */ + Custom = 2, +} + +export const enum UpdateContactEmployeeTypeEnumRequestEnumStatus { + /** 激活 */ + Active = 1, + /** 未激活 */ + Inactive = 2, +} + export interface UpdateContactEmployeeTypeEnumRequest { /** 枚举内容 */ content: string /** 类型 */ - enum_type: 1 | 2 + enum_type: UpdateContactEmployeeTypeEnumRequestEnumType /** 类型 */ - enum_status: 1 | 2 + enum_status: UpdateContactEmployeeTypeEnumRequestEnumStatus /** i18n定义 */ i18n_content?: I18nContent[] } +export interface UpdateContactEmployeeTypeEnumResponse { + employee_type_enum?: EmployeeTypeEnum +} + export interface CreateContactDepartmentRequest { /** 部门名称 */ name: string @@ -683,6 +808,10 @@ export interface CreateContactDepartmentQuery { client_token?: string } +export interface CreateContactDepartmentResponse { + department?: Department +} + export interface PatchContactDepartmentRequest { /** 部门名 */ name?: string @@ -711,6 +840,10 @@ export interface PatchContactDepartmentQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface PatchContactDepartmentResponse { + department?: Department +} + export interface UpdateContactDepartmentRequest { /** 部门名称 */ name: string @@ -737,6 +870,10 @@ export interface UpdateContactDepartmentQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface UpdateContactDepartmentResponse { + department?: Department +} + export interface UpdateDepartmentIdContactDepartmentRequest { /** 本部门的自定义部门新ID */ new_department_id: string @@ -764,6 +901,10 @@ export interface GetContactDepartmentQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface GetContactDepartmentResponse { + department?: Department +} + export interface BatchContactDepartmentQuery { /** 查询的部门ID列表,类型需要与department_id_type对应 */ department_ids: string[] @@ -773,6 +914,11 @@ export interface BatchContactDepartmentQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface BatchContactDepartmentResponse { + /** 查询到的部门信息,其中异常的部门ID不返回结果。 */ + items?: Department[] +} + export interface ChildrenContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -817,6 +963,11 @@ export interface CreateContactUnitRequest { unit_type: string } +export interface CreateContactUnitResponse { + /** 单位的自定义ID */ + unit_id: string +} + export interface PatchContactUnitRequest { /** 单位的名字 */ name?: string @@ -847,6 +998,11 @@ export interface ListDepartmentContactUnitQuery extends Pagination { department_id_type?: 'department_id' | 'open_department_id' } +export interface GetContactUnitResponse { + /** 单位信息 */ + unit: Unit +} + export interface AddContactGroupMemberRequest { /** 用户组成员的类型,取值为 user */ member_type: 'user' @@ -861,6 +1017,11 @@ export interface BatchAddContactGroupMemberRequest { members?: Memberlist[] } +export interface BatchAddContactGroupMemberResponse { + /** 成员添加操作结果 */ + results?: MemberResult[] +} + 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' @@ -887,6 +1048,11 @@ export interface CreateContactFunctionalRoleRequest { role_name: string } +export interface CreateContactFunctionalRoleResponse { + /** 角色ID,在单租户下唯一 */ + role_id: string +} + export interface UpdateContactFunctionalRoleRequest { /** 修改的角色名称,在单租户下唯一 */ role_name: string @@ -902,6 +1068,11 @@ export interface BatchCreateContactFunctionalRoleMemberQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface BatchCreateContactFunctionalRoleMemberResponse { + /** 批量新增角色成员结果集 */ + results?: FunctionalRoleMemberResult[] +} + export interface ScopesContactFunctionalRoleMemberRequest { /** 角色修改的角色成员列表(一批用户的UserID列表) */ members: string[] @@ -916,6 +1087,11 @@ export interface ScopesContactFunctionalRoleMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface ScopesContactFunctionalRoleMemberResponse { + /** 批量更新角色成员管理范围结果集 */ + results?: FunctionalRoleMemberResult[] +} + export interface GetContactFunctionalRoleMemberQuery { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' @@ -923,6 +1099,11 @@ export interface GetContactFunctionalRoleMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface GetContactFunctionalRoleMemberResponse { + /** 成员的管理范围 */ + member?: FunctionalRoleMember +} + export interface ListContactFunctionalRoleMemberQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' @@ -940,6 +1121,11 @@ export interface BatchDeleteContactFunctionalRoleMemberQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface BatchDeleteContactFunctionalRoleMemberResponse { + /** 批量新增角色成员结果集 */ + result?: FunctionalRoleMemberResult[] +} + export interface CreateContactJobLevelRequest { /** 职级名称 */ name: string @@ -955,6 +1141,11 @@ export interface CreateContactJobLevelRequest { i18n_description?: I18nContent[] } +export interface CreateContactJobLevelResponse { + /** 职级信息 */ + job_level?: JobLevel +} + export interface UpdateContactJobLevelRequest { /** 职级名称 */ name?: string @@ -970,6 +1161,16 @@ export interface UpdateContactJobLevelRequest { i18n_description?: I18nContent[] } +export interface UpdateContactJobLevelResponse { + /** 职级信息 */ + job_level?: JobLevel +} + +export interface GetContactJobLevelResponse { + /** 职级信息 */ + job_level?: JobLevel +} + export interface ListContactJobLevelQuery extends Pagination { /** 传入该字段时,可查询指定职级名称对应的职级信息。 */ name?: string @@ -990,6 +1191,11 @@ export interface CreateContactJobFamilyRequest { i18n_description?: I18nContent[] } +export interface CreateContactJobFamilyResponse { + /** 序列信息 */ + job_family?: JobFamily +} + export interface UpdateContactJobFamilyRequest { /** 序列名称。1-100字符,支持中、英文及符号 */ name?: string @@ -1005,11 +1211,31 @@ export interface UpdateContactJobFamilyRequest { i18n_description?: I18nContent[] } +export interface UpdateContactJobFamilyResponse { + /** 更新后的序列信息 */ + job_family?: JobFamily +} + +export interface GetContactJobFamilyResponse { + /** 序列信息 */ + job_family?: JobFamily +} + export interface ListContactJobFamilyQuery extends Pagination { /** 序列名称,传入该字段时,可查询指定序列名称对应的序列信息 */ name?: string } +export interface GetContactJobTitleResponse { + /** 职务信息 */ + job_title?: JobTitle +} + +export interface GetContactWorkCityResponse { + /** 工作城市信息 */ + work_city?: WorkCity +} + export interface ListContactUserQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -1019,6 +1245,17 @@ export interface ListContactUserQuery extends Pagination { department_id?: string } +export const enum UpdateContactUserRequestGender { + /** 保密 */ + Unkown = 0, + /** 男 */ + Male = 1, + /** 女 */ + Female = 2, + /** 其他 */ + Others = 3, +} + export interface UpdateContactUserRequest { /** 用户名 */ name: string @@ -1033,7 +1270,7 @@ export interface UpdateContactUserRequest { /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */ mobile_visible?: boolean /** 性别 */ - gender?: 0 | 1 | 2 | 3 + gender?: UpdateContactUserRequestGender /** 头像的文件Key */ avatar_key?: string /** 用户所在部门ID */ @@ -1071,6 +1308,10 @@ export interface UpdateContactUserQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface UpdateContactUserResponse { + user?: User +} + export interface ListContactDepartmentQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -1082,165 +1323,6 @@ export interface ListContactDepartmentQuery extends Pagination { fetch_child?: boolean } -export interface ListContactScopeResponse { - /** 已授权部门列表,授权范围为全员可见时返回的是当前企业的所有一级部门列表 */ - department_ids?: string[] - /** 已授权用户列表,应用申请了获取用户user_id 权限时返回;当授权范围为全员可见时返回的是当前企业所有顶级部门用户列表 */ - user_ids?: string[] - /** 已授权的用户组,授权范围为全员可见时返回的是当前企业所有用户组 */ - group_ids?: string[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token */ - page_token?: string -} - -export interface CreateContactUserResponse { - user?: User -} - -export interface PatchContactUserResponse { - user?: User -} - -export interface GetContactUserResponse { - user?: User -} - -export interface BatchContactUserResponse { - /** 查询到的用户信息,其中异常的用户ID不返回结果。 */ - items?: User[] -} - -export interface BatchGetIdContactUserResponse { - /** 手机号或者邮箱对应的用户id信息 */ - user_list?: UserContactInfo[] -} - -export interface CreateContactGroupResponse { - /** 用户组ID */ - group_id: string -} - -export interface GetContactGroupResponse { - /** 用户组详情 */ - group: Group -} - -export interface CreateContactEmployeeTypeEnumResponse { - /** 创建人员类型接口 */ - employee_type_enum?: EmployeeTypeEnum -} - -export interface UpdateContactEmployeeTypeEnumResponse { - employee_type_enum?: EmployeeTypeEnum -} - -export interface CreateContactDepartmentResponse { - department?: Department -} - -export interface PatchContactDepartmentResponse { - department?: Department -} - -export interface UpdateContactDepartmentResponse { - department?: Department -} - -export interface GetContactDepartmentResponse { - department?: Department -} - -export interface BatchContactDepartmentResponse { - /** 查询到的部门信息,其中异常的部门ID不返回结果。 */ - items?: Department[] -} - -export interface CreateContactUnitResponse { - /** 单位的自定义ID */ - unit_id: string -} - -export interface GetContactUnitResponse { - /** 单位信息 */ - unit: Unit -} - -export interface BatchAddContactGroupMemberResponse { - /** 成员添加操作结果 */ - results?: MemberResult[] -} - -export interface CreateContactFunctionalRoleResponse { - /** 角色ID,在单租户下唯一 */ - role_id: string -} - -export interface BatchCreateContactFunctionalRoleMemberResponse { - /** 批量新增角色成员结果集 */ - results?: FunctionalRoleMemberResult[] -} - -export interface ScopesContactFunctionalRoleMemberResponse { - /** 批量更新角色成员管理范围结果集 */ - results?: FunctionalRoleMemberResult[] -} - -export interface GetContactFunctionalRoleMemberResponse { - /** 成员的管理范围 */ - member?: FunctionalRoleMember -} - -export interface BatchDeleteContactFunctionalRoleMemberResponse { - /** 批量新增角色成员结果集 */ - result?: FunctionalRoleMemberResult[] -} - -export interface CreateContactJobLevelResponse { - /** 职级信息 */ - job_level?: JobLevel -} - -export interface UpdateContactJobLevelResponse { - /** 职级信息 */ - job_level?: JobLevel -} - -export interface GetContactJobLevelResponse { - /** 职级信息 */ - job_level?: JobLevel -} - -export interface CreateContactJobFamilyResponse { - /** 序列信息 */ - job_family?: JobFamily -} - -export interface UpdateContactJobFamilyResponse { - /** 更新后的序列信息 */ - job_family?: JobFamily -} - -export interface GetContactJobFamilyResponse { - /** 序列信息 */ - job_family?: JobFamily -} - -export interface GetContactJobTitleResponse { - /** 职务信息 */ - job_title?: JobTitle -} - -export interface GetContactWorkCityResponse { - /** 工作城市信息 */ - work_city?: WorkCity -} - -export interface UpdateContactUserResponse { - user?: User -} - Internal.define({ '/contact/v3/scopes': { GET: 'listContactScope', diff --git a/adapters/lark/src/types/corehr.ts b/adapters/lark/src/types/corehr.ts index d7c4480c..4a563638 100644 --- a/adapters/lark/src/types/corehr.ts +++ b/adapters/lark/src/types/corehr.ts @@ -272,7 +272,7 @@ declare module '../internal' { * 批量查询部门操作日志 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_operation_logs */ - queryOperationLogsCorehrV2Department(body: QueryOperationLogsCorehrV2DepartmentRequest, query?: QueryOperationLogsCorehrV2DepartmentQuery): Paginated + queryOperationLogsCorehrV2Department(body: QueryOperationLogsCorehrV2DepartmentRequest, query?: QueryOperationLogsCorehrV2DepartmentQuery): Promise & AsyncIterableIterator /** * 创建部门 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/create @@ -1056,6 +1056,11 @@ export interface QueryCorehrV1CustomFieldQuery { object_api_name_list: string[] } +export interface QueryCorehrV1CustomFieldResponse { + /** 自定义字段列表 */ + items?: CustomField[] +} + export interface GetByParamCorehrV1CustomFieldQuery { /** 所属对象 apiname */ object_api_name: string @@ -1063,6 +1068,11 @@ export interface GetByParamCorehrV1CustomFieldQuery { custom_api_name: string } +export interface GetByParamCorehrV1CustomFieldResponse { + /** 自定义字段详情 */ + data?: CustomField +} + export interface AddEnumOptionCorehrV1CommonDataMetaDataRequest { /** 所属对象 API name,可通过[获取飞书人事对象列表](/ssl:ttdoc/server-docs/corehr-v1/basic-infomation/custom_field/list_object_api_name)接口中返回的 `object_api_name` 字段获取 */ object_api_name: string @@ -1077,6 +1087,13 @@ export interface AddEnumOptionCorehrV1CommonDataMetaDataQuery { client_token?: string } +export interface AddEnumOptionCorehrV1CommonDataMetaDataResponse { + /** 枚举字段 API name */ + enum_field_api_name?: string + /** 枚举全部选项列表 */ + enum_field_options?: EnumFieldOption[] +} + export interface EditEnumOptionCorehrV1CommonDataMetaDataRequest { /** 所属对象 API name,可通过[获取飞书人事对象列表](/ssl:ttdoc/server-docs/corehr-v1/basic-infomation/custom_field/list_object_api_name)接口中返回的 `object_api_name` 字段获取 */ object_api_name: string @@ -1091,11 +1108,32 @@ export interface EditEnumOptionCorehrV1CommonDataMetaDataQuery { client_token?: string } +export interface EditEnumOptionCorehrV1CommonDataMetaDataResponse { + /** 枚举字段 API name */ + enum_field_api_name?: string + /** 枚举全部选项列表 */ + enum_field_options?: EnumFieldOption[] +} + +export const enum SearchCorehrV2BasicInfoCountryRegionRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, +} + export interface SearchCorehrV2BasicInfoCountryRegionRequest { /** 国家/地区 ID 列表,可从[批量查询地点](/ssl:ttdoc/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.country_region_id`、[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.country_region_id` 等字段中获取 */ country_region_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoCountryRegionRequestStatus[] +} + +export const enum SearchCorehrV2BasicInfoCountryRegionSubdivisionRequestStatus { + /** 生效 */ + Effective = 1, + /** 失效 */ + Expiration = 0, } export interface SearchCorehrV2BasicInfoCountryRegionSubdivisionRequest { @@ -1104,7 +1142,14 @@ export interface SearchCorehrV2BasicInfoCountryRegionSubdivisionRequest { /** 省份/行政区 ID 列表 */ country_region_subdivision_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoCountryRegionSubdivisionRequestStatus[] +} + +export const enum SearchCorehrV2BasicInfoCityRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, } export interface SearchCorehrV2BasicInfoCityRequest { @@ -1113,7 +1158,14 @@ export interface SearchCorehrV2BasicInfoCityRequest { /** 城市 ID 列表,可从[批量查询地点](/ssl:ttdoc/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.city_id_v2`、[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.city_id_v2` 等字段中获取 */ city_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoCityRequestStatus[] +} + +export const enum SearchCorehrV2BasicInfoDistrictRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, } export interface SearchCorehrV2BasicInfoDistrictRequest { @@ -1122,7 +1174,14 @@ export interface SearchCorehrV2BasicInfoDistrictRequest { /** 区/县 ID 列表,可从[批量查询地点](/ssl:ttdoc/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.district_id_v2`、[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.district_id_v2` 等字段中获取 */ district_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoDistrictRequestStatus[] +} + +export const enum SearchCorehrV2BasicInfoNationalityRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, } export interface SearchCorehrV2BasicInfoNationalityRequest { @@ -1131,7 +1190,7 @@ export interface SearchCorehrV2BasicInfoNationalityRequest { /** 国家/地区 ID 列表,可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口列举 */ country_region_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoNationalityRequestStatus[] } export interface CreateCorehrV1NationalIdTypeRequest { @@ -1158,6 +1217,10 @@ export interface CreateCorehrV1NationalIdTypeQuery { client_token?: string } +export interface CreateCorehrV1NationalIdTypeResponse { + national_id_type?: NationalIdType +} + export interface PatchCorehrV1NationalIdTypeRequest { /** 国家 / 地区 */ country_region_id?: string @@ -1182,6 +1245,15 @@ export interface PatchCorehrV1NationalIdTypeQuery { client_token?: string } +export interface PatchCorehrV1NationalIdTypeResponse { + national_id_type?: NationalIdType +} + +export interface GetCorehrV1NationalIdTypeResponse { + /** 国家证件类型信息 */ + national_id_type?: NationalIdType +} + export interface ListCorehrV1NationalIdTypeQuery extends Pagination { /** 证件类型 */ identification_type?: string @@ -1191,19 +1263,33 @@ export interface ListCorehrV1NationalIdTypeQuery extends Pagination { country_region_id?: string } +export const enum SearchCorehrV2BasicInfoBankRequestStatus { + /** 生效 */ + Enabled = 1, + /** 失效 */ + Disabled = 0, +} + export interface SearchCorehrV2BasicInfoBankRequest { /** 银行 ID 列表,可通过[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)、[批量查询员工信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)等接口返回的 `person_info.bank_account_list.bank_id_v2` 字段获取 */ bank_id_list?: string[] /** 银行名称列表,支持对银行名称精确搜索 */ bank_name_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoBankRequestStatus[] /** 最早更新时间 */ update_start_time?: string /** 最晚更新时间 */ update_end_time?: string } +export const enum SearchCorehrV2BasicInfoBankBranchRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, +} + export interface SearchCorehrV2BasicInfoBankBranchRequest { /** 银行 ID 列表,可通过[查询银行信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search)列举,或从[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)、[批量查询员工信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)等接口返回的 `person_info.bank_account_list.bank_id_v2` 字段中获取 */ bank_id_list?: string[] @@ -1214,32 +1300,53 @@ export interface SearchCorehrV2BasicInfoBankBranchRequest { /** 金融分支机构编码(联行号)列表,支持对金融分支机构编码精确搜索 */ code_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoBankBranchRequestStatus[] /** 最早更新时间 */ update_start_time?: string /** 最晚更新时间 */ update_end_time?: string } +export const enum SearchCorehrV2BasicInfoCurrencyRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, +} + export interface SearchCorehrV2BasicInfoCurrencyRequest { /** 货币 ID 列表,可通过[批量查询薪资方案](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list)、[批量查询员工薪资档案](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query)等接口返回的 `currency_id` 字段获取 */ currency_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoCurrencyRequestStatus[] +} + +export const enum SearchCorehrV2BasicInfoTimeZoneRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, } export interface SearchCorehrV2BasicInfoTimeZoneRequest { /** 时区 ID 列表 */ time_zone_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoTimeZoneRequestStatus[] +} + +export const enum SearchCorehrV2BasicInfoLanguageRequestStatus { + /** 生效 */ + Active = 1, + /** 失效 */ + Inactive = 0, } export interface SearchCorehrV2BasicInfoLanguageRequest { /** 语言 ID 列表 */ language_id_list?: string[] /** 状态列表 */ - status_list?: (1 | 0)[] + status_list?: SearchCorehrV2BasicInfoLanguageRequestStatus[] } export interface CreateCorehrV1EmployeeTypeRequest { @@ -1260,6 +1367,10 @@ export interface CreateCorehrV1EmployeeTypeQuery { client_token?: string } +export interface CreateCorehrV1EmployeeTypeResponse { + employee_type?: EmployeeType +} + export interface PatchCorehrV1EmployeeTypeRequest { /** 名称 */ name?: I18n[] @@ -1278,6 +1389,15 @@ export interface PatchCorehrV1EmployeeTypeQuery { client_token?: string } +export interface PatchCorehrV1EmployeeTypeResponse { + employee_type?: EmployeeType +} + +export interface GetCorehrV1EmployeeTypeResponse { + /** 雇员类型 */ + employee_type?: EmployeeType +} + export interface CreateCorehrV1WorkingHoursTypeRequest { /** 编码 */ code?: string @@ -1298,6 +1418,10 @@ export interface CreateCorehrV1WorkingHoursTypeQuery { client_token?: string } +export interface CreateCorehrV1WorkingHoursTypeResponse { + working_hours_type?: WorkingHoursType +} + export interface PatchCorehrV1WorkingHoursTypeRequest { /** 编码 */ code?: string @@ -1318,14 +1442,34 @@ export interface PatchCorehrV1WorkingHoursTypeQuery { client_token?: string } +export interface PatchCorehrV1WorkingHoursTypeResponse { + working_hours_type?: WorkingHoursType +} + +export interface GetCorehrV1WorkingHoursTypeResponse { + /** 工时制度信息 */ + working_hours_type?: WorkingHoursType +} + export interface ConvertCorehrV1CommonDataIdRequest { /** ID 列表(最多传入 100 个 ID,ID 长度限制 50 个字符) */ ids: string[] } +export const enum ConvertCorehrV1CommonDataIdQueryIdTransformType { + /** 飞书人事 -> 飞书通讯录 */ + CoreHR2Feishu = 1, + /** 飞书通讯录 -> 飞书人事 */ + Feishu2CoreHR = 2, + /** people admin -> 飞书人事 */ + Admin2Feishu = 3, + /** people admin -> 飞书通讯录 */ + Admin2CoreHR = 4, +} + export interface ConvertCorehrV1CommonDataIdQuery { /** ID 转换类型 */ - id_transform_type: 1 | 2 | 3 | 4 + id_transform_type: ConvertCorehrV1CommonDataIdQueryIdTransformType /** 要转换的ID类型 */ id_type: 'user_id' | 'department_id' | 'job_level_id' | 'job_family_id' | 'employee_type_id' /** 用户 ID 类型 */ @@ -1334,6 +1478,11 @@ export interface ConvertCorehrV1CommonDataIdQuery { feishu_department_id_type?: 'open_department_id' | 'department_id' } +export interface ConvertCorehrV1CommonDataIdResponse { + /** ID 信息列表 */ + items?: IdInfo[] +} + export interface BatchGetCorehrV2EmployeeRequest { /** 返回数据的字段列表,填写方式:为空时默认仅返回 ID */ fields?: string[] @@ -1352,6 +1501,11 @@ export interface BatchGetCorehrV2EmployeeQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface BatchGetCorehrV2EmployeeResponse { + /** 查询的雇佣信息 */ + items?: Employee[] +} + export interface SearchCorehrV2EmployeeRequest { /** 返回数据的字段列表,填写方式:为空时默认仅返回 ID */ fields?: string[] @@ -1466,6 +1620,15 @@ export interface CreateCorehrV2EmployeeQuery { ignore_working_hours_type_rule?: boolean } +export interface CreateCorehrV2EmployeeResponse { + /** 雇佣信息 ID */ + employment_id?: string + /** 合同 ID */ + contract_id?: string + /** 任职信息 ID */ + job_data_id?: string +} + export interface CreateCorehrV2PersonRequest { /** 姓名列表 */ name_list: PersonName[] @@ -1540,6 +1703,10 @@ export interface CreateCorehrV2PersonQuery { client_token?: string } +export interface CreateCorehrV2PersonResponse { + person?: PersonInfo +} + export interface PatchCorehrV2PersonRequest { /** 姓名列表 */ name_list?: PersonName[] @@ -1616,6 +1783,10 @@ export interface PatchCorehrV2PersonQuery { no_need_query?: boolean } +export interface PatchCorehrV2PersonResponse { + person?: PersonInfo +} + export interface UploadCorehrV1PersonForm { /** 文件二进制内容 */ file_content: Blob @@ -1623,6 +1794,11 @@ export interface UploadCorehrV1PersonForm { file_name: string } +export interface UploadCorehrV1PersonResponse { + /** 上传文件ID */ + id?: string +} + export interface CreateCorehrV1EmploymentRequest { /** 资历起算日期 */ seniority_date?: string @@ -1659,6 +1835,10 @@ export interface CreateCorehrV1EmploymentQuery { client_token?: string } +export interface CreateCorehrV1EmploymentResponse { + employment?: EmploymentCreate +} + export interface PatchCorehrV1EmploymentRequest { /** 资历起算日期 */ seniority_date?: string @@ -1689,6 +1869,10 @@ export interface PatchCorehrV1EmploymentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface PatchCorehrV1EmploymentResponse { + employment?: Employment +} + export interface DeleteCorehrV1EmploymentQuery { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' @@ -1752,6 +1936,10 @@ export interface CreateCorehrV1JobDataQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface CreateCorehrV1JobDataResponse { + job_data?: JobData +} + export interface DeleteCorehrV1JobDataQuery { /** 需要删除的任职记录版本 ID */ version_id?: string @@ -1817,6 +2005,10 @@ export interface PatchCorehrV1JobDataQuery { strict_verify?: string } +export interface PatchCorehrV1JobDataResponse { + job_data?: JobData +} + export interface QueryCorehrV2EmployeesJobDataRequest { /** 是否获取所有任职记录,true 为获取员工所有版本的任职记录,false 为仅获取当前生效的任职记录,默认为 false */ get_all_version?: boolean @@ -1867,6 +2059,11 @@ export interface BatchGetCorehrV2EmployeesJobDataQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface BatchGetCorehrV2EmployeesJobDataResponse { + /** 查询的雇佣信息 */ + items?: EmployeeJobData[] +} + export interface ListCorehrV1JobDataQuery extends Pagination { /** 雇佣 ID */ employment_id?: string @@ -1891,6 +2088,11 @@ export interface GetCorehrV1JobDataQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface GetCorehrV1JobDataResponse { + /** 任职信息 */ + job_data?: JobData +} + export interface CreateCorehrV2EmployeesAdditionalJobRequest { /** 人员类型 ID,可通过[【批量查询人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取 */ employee_type_id: string @@ -1941,6 +2143,10 @@ export interface CreateCorehrV2EmployeesAdditionalJobQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface CreateCorehrV2EmployeesAdditionalJobResponse { + additional_job?: EmployeesAdditionalJobWriteResp +} + export interface PatchCorehrV2EmployeesAdditionalJobRequest { /** 人员类型 ID,可通过[【批量查询人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取 */ employee_type_id?: string @@ -1989,6 +2195,10 @@ export interface PatchCorehrV2EmployeesAdditionalJobQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface PatchCorehrV2EmployeesAdditionalJobResponse { + additional_job?: EmployeesAdditionalJobWriteResp +} + export interface BatchCorehrV2EmployeesAdditionalJobRequest { /** 雇佣 ID */ employment_ids?: string[] @@ -2025,6 +2235,15 @@ export interface QueryOperationLogsCorehrV2DepartmentQuery extends Pagination { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface QueryOperationLogsCorehrV2DepartmentResponse { + /** 操作日志列表 */ + op_logs?: OrganizationOpLog[] + /** 下一页token */ + next_page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + export interface CreateCorehrV1DepartmentRequest { /** 子类型 */ sub_type?: Enum @@ -2053,6 +2272,10 @@ export interface CreateCorehrV1DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface CreateCorehrV1DepartmentResponse { + department?: DepartmentCreate +} + export interface PatchCorehrV2DepartmentRequest { /** 实体在CoreHR内部的唯一键 */ id?: string @@ -2093,6 +2316,11 @@ export interface ParentsCorehrV2DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface ParentsCorehrV2DepartmentResponse { + /** 父部门查询结果 */ + items?: DepartmentParents[] +} + export interface BatchGetCorehrV2DepartmentRequest { /** 部门 ID 列表 */ department_id_list?: string[] @@ -2109,6 +2337,11 @@ export interface BatchGetCorehrV2DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface BatchGetCorehrV2DepartmentResponse { + /** 查询的部门信息 */ + items?: Department[] +} + export interface QueryRecentChangeCorehrV2DepartmentQuery extends Pagination { /** 查询的开始时间,格式 "yyyy-MM-dd",不带时分秒,包含 start_date 传入的时间, 系统会以 start_date 的 00:00:00 查询。 */ start_date: string @@ -2118,6 +2351,17 @@ export interface QueryRecentChangeCorehrV2DepartmentQuery extends Pagination { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface QueryRecentChangeCorehrV2DepartmentResponse { + /** 部门 ID 列表 */ + department_ids?: string[] + /** 目标查询时间范围内被删除的部门列表 */ + deleted_department_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + export interface QueryTimelineCorehrV2DepartmentRequest { /** 部门 ID 列表 */ department_ids: string[] @@ -2134,6 +2378,11 @@ export interface QueryTimelineCorehrV2DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface QueryTimelineCorehrV2DepartmentResponse { + /** 部门信息 */ + items?: DepartmentTimeline[] +} + export interface TreeCorehrV2DepartmentRequest { /** 部门 ID,默认根部门 */ department_id?: string @@ -2221,6 +2470,10 @@ export interface CreateCorehrV1LocationQuery { client_token?: string } +export interface CreateCorehrV1LocationResponse { + location?: Location +} + export interface PatchCorehrV2LocationRequest { /** 上级地点 ID */ parent_id?: string @@ -2251,6 +2504,11 @@ export interface PatchCorehrV2LocationQuery { client_token?: string } +export interface GetCorehrV1LocationResponse { + /** 地点信息 */ + location?: Location +} + export interface QueryRecentChangeCorehrV2LocationQuery extends Pagination { /** 查询的开始时间,支持"yyyy-MM-dd HH:MM:SS" */ start_date: string @@ -2258,11 +2516,27 @@ export interface QueryRecentChangeCorehrV2LocationQuery extends Pagination { end_date: string } +export interface QueryRecentChangeCorehrV2LocationResponse { + /** 地点 ID 列表 */ + location_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的地点 ID 列表 */ + deleted_location_ids?: string[] +} + export interface BatchGetCorehrV2LocationRequest { /** 地点 ID 列表 */ location_ids: string[] } +export interface BatchGetCorehrV2LocationResponse { + /** 查询的地点信息 */ + items?: Location[] +} + export interface ActiveCorehrV2LocationRequest { /** 地点 ID */ location_id: string @@ -2358,6 +2632,11 @@ export interface CreateCorehrV2LocationAddressQuery { client_token?: string } +export interface CreateCorehrV2LocationAddressResponse { + /** 地址 ID */ + address_id?: string +} + export interface CreateCorehrV1CompanyRequest { /** 层级关系,内层字段见实体 */ hiberarchy_common: HiberarchyCommon @@ -2398,6 +2677,10 @@ export interface CreateCorehrV1CompanyQuery { client_token?: string } +export interface CreateCorehrV1CompanyResponse { + company?: Company +} + export interface PatchCorehrV1CompanyRequest { /** 层级关系,内层字段见实体 */ hiberarchy_common?: HiberarchyCommon @@ -2436,6 +2719,10 @@ export interface PatchCorehrV1CompanyQuery { client_token?: string } +export interface PatchCorehrV1CompanyResponse { + company?: Company +} + export interface ActiveCorehrV2CompanyRequest { /** 公司ID */ company_id: string @@ -2447,6 +2734,11 @@ export interface ActiveCorehrV2CompanyRequest { operation_reason: string } +export interface GetCorehrV1CompanyResponse { + /** 公司信息 */ + company?: Company +} + export interface QueryRecentChangeCorehrV2CompanyQuery extends Pagination { /** 查询的开始时间,支持"yyyy-MM-dd HH:MM:SS" */ start_date: string @@ -2454,11 +2746,27 @@ export interface QueryRecentChangeCorehrV2CompanyQuery extends Pagination { end_date: string } +export interface QueryRecentChangeCorehrV2CompanyResponse { + /** 公司 ID 列表 */ + company_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的公司 ID 列表 */ + deleted_company_ids?: string[] +} + export interface BatchGetCorehrV2CompanyRequest { /** 公司 ID 列表 */ company_ids: string[] } +export interface BatchGetCorehrV2CompanyResponse { + /** 查询的公司信息 */ + items?: Company[] +} + export interface CreateCorehrV2CostCenterRequest { /** 成本中心名称 */ name: I18n[] @@ -2479,6 +2787,10 @@ export interface CreateCorehrV2CostCenterQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface CreateCorehrV2CostCenterResponse { + cost_center?: CostCenter +} + export interface PatchCorehrV2CostCenterRequest { /** 生效时间 */ effective_time: string @@ -2493,6 +2805,10 @@ export interface PatchCorehrV2CostCenterQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface PatchCorehrV2CostCenterResponse { + cost_center?: CostCenter +} + export interface QueryRecentChangeCorehrV2CostCenterQuery extends Pagination { /** 查询的开始时间,支持"yyyy-MM-dd HH:MM:SS" */ start_date: string @@ -2500,10 +2816,21 @@ export interface QueryRecentChangeCorehrV2CostCenterQuery extends Pagination { end_date: string } -export interface SearchCorehrV2CostCenterRequest { - /** 成本中心ID 列表 */ - cost_center_id_list?: string[] - /** 成长中心名称列表,精确匹配 */ +export interface QueryRecentChangeCorehrV2CostCenterResponse { + /** 成本中心 ID 列表 */ + cost_center_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的成本中心 ID 列表 */ + deleted_cost_center_ids?: string[] +} + +export interface SearchCorehrV2CostCenterRequest { + /** 成本中心ID 列表 */ + cost_center_id_list?: string[] + /** 成长中心名称列表,精确匹配 */ name_list?: string[] /** 成本中心编码 */ code?: string @@ -2543,6 +2870,10 @@ export interface CreateCorehrV2CostCenterVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface CreateCorehrV2CostCenterVersionResponse { + version?: CostCenterVersion +} + export interface PatchCorehrV2CostCenterVersionRequest { /** 成本中心名称 */ name?: I18n[] @@ -2563,6 +2894,10 @@ export interface PatchCorehrV2CostCenterVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface PatchCorehrV2CostCenterVersionResponse { + version?: CostCenterVersion +} + export interface DeleteCorehrV2CostCenterVersionRequest { /** 操作原因 */ operation_reason: string @@ -2573,6 +2908,11 @@ export interface GetCorehrV2ApprovalGroupsQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface GetCorehrV2ApprovalGroupsResponse { + /** 组织架构调整流程信息 */ + approval_group?: ApprovalGroup +} + export interface OpenQueryDepartmentChangeListByIdsCorehrV2ApprovalGroupsRequest { /** 部门调整记录 ID List */ department_change_ids?: string[] @@ -2589,6 +2929,11 @@ export interface OpenQueryDepartmentChangeListByIdsCorehrV2ApprovalGroupsQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface OpenQueryDepartmentChangeListByIdsCorehrV2ApprovalGroupsResponse { + /** 部门调整记录信息列表 */ + department_changes?: DepartmentChange[] +} + export interface OpenQueryJobChangeListByIdsCorehrV2ApprovalGroupsRequest { /** 人员异动记录 ID List */ job_change_ids?: string[] @@ -2605,6 +2950,11 @@ export interface OpenQueryJobChangeListByIdsCorehrV2ApprovalGroupsQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface OpenQueryJobChangeListByIdsCorehrV2ApprovalGroupsResponse { + /** 人员异动记录信息列表 */ + job_changes?: JobChange[] +} + export interface CreateCorehrV1JobFamilyRequest { /** 名称 */ name: I18n[] @@ -2625,6 +2975,10 @@ export interface CreateCorehrV1JobFamilyQuery { client_token?: string } +export interface CreateCorehrV1JobFamilyResponse { + job_family?: JobFamily +} + export interface PatchCorehrV1JobFamilyRequest { /** 名称 */ name?: I18n[] @@ -2645,6 +2999,15 @@ export interface PatchCorehrV1JobFamilyQuery { client_token?: string } +export interface PatchCorehrV1JobFamilyResponse { + job_family?: JobFamily +} + +export interface GetCorehrV1JobFamilyResponse { + /** 职务序列信息 */ + job_family?: JobFamily +} + export interface QueryRecentChangeCorehrV2JobFamilyQuery extends Pagination { /** 查询的开始时间,支持"yyyy-MM-dd HH:MM:SS" */ start_date: string @@ -2652,11 +3015,27 @@ export interface QueryRecentChangeCorehrV2JobFamilyQuery extends Pagination { end_date: string } +export interface QueryRecentChangeCorehrV2JobFamilyResponse { + /** 序列 ID 列表 */ + job_family_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的序列 ID 列表 */ + deleted_job_family_ids?: string[] +} + export interface BatchGetCorehrV2JobFamilyRequest { /** 序列 ID 列表 */ job_family_ids: string[] } +export interface BatchGetCorehrV2JobFamilyResponse { + /** 查询的序列信息 */ + items?: JobFamily[] +} + export interface CreateCorehrV1JobLevelRequest { /** 职级数值 */ level_order: number @@ -2679,6 +3058,10 @@ export interface CreateCorehrV1JobLevelQuery { client_token?: string } +export interface CreateCorehrV1JobLevelResponse { + job_level?: JobLevel +} + export interface PatchCorehrV1JobLevelRequest { /** 职级数值 */ level_order?: number @@ -2701,6 +3084,15 @@ export interface PatchCorehrV1JobLevelQuery { client_token?: string } +export interface PatchCorehrV1JobLevelResponse { + job_level?: JobLevel +} + +export interface GetCorehrV1JobLevelResponse { + /** 职务级别信息 */ + job_level?: JobLevel +} + export interface QueryRecentChangeCorehrV2JobLevelQuery extends Pagination { /** 查询的开始时间,支持"yyyy-MM-dd HH:MM:SS" */ start_date: string @@ -2708,11 +3100,27 @@ export interface QueryRecentChangeCorehrV2JobLevelQuery extends Pagination { end_date: string } +export interface QueryRecentChangeCorehrV2JobLevelResponse { + /** 职级 ID 列表 */ + job_level_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的职级 ID 列表 */ + deleted_job_level_ids?: string[] +} + export interface BatchGetCorehrV2JobLevelRequest { /** 职级 ID 列表 */ job_level_ids: string[] } +export interface BatchGetCorehrV2JobLevelResponse { + /** 查询的职级信息 */ + items?: JobLevel[] +} + export interface CreateCorehrV2JobGradeRequest { /** 职等数值 */ grade_order: number @@ -2729,6 +3137,11 @@ export interface CreateCorehrV2JobGradeQuery { client_token?: string } +export interface CreateCorehrV2JobGradeResponse { + /** 职等ID */ + grade_id?: string +} + export interface PatchCorehrV2JobGradeRequest { /** 职等数值 */ grade_order?: number @@ -2763,6 +3176,17 @@ export interface QueryRecentChangeCorehrV2JobGradeQuery extends Pagination { end_date: string } +export interface QueryRecentChangeCorehrV2JobGradeResponse { + /** 职等 ID 列表 */ + job_grade_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的职等 ID 列表 */ + deleted_job_grade_ids?: string[] +} + export interface CreateCorehrV1JobRequest { /** 编码 */ code?: string @@ -2791,6 +3215,10 @@ export interface CreateCorehrV1JobQuery { client_token?: string } +export interface CreateCorehrV1JobResponse { + job?: Job +} + export interface PatchCorehrV1JobRequest { /** 编码 */ code?: string @@ -2819,6 +3247,15 @@ export interface PatchCorehrV1JobQuery { client_token?: string } +export interface PatchCorehrV1JobResponse { + job?: Job +} + +export interface GetCorehrV2JobResponse { + /** 职务信息 */ + job?: Job +} + export interface ListCorehrV2JobQuery extends Pagination { /** 名称 */ name?: string @@ -2833,6 +3270,11 @@ export interface WithdrawOnboardingCorehrV2PreHireRequest { withdraw_reason: string } +export interface WithdrawOnboardingCorehrV2PreHireResponse { + /** 是否成功撤销入职 */ + success?: boolean +} + export interface RestoreFlowInstanceCorehrV2PreHireRequest { /** 待入职ID,可从待入职列表接口获取 */ pre_hire_id: string @@ -2840,6 +3282,11 @@ export interface RestoreFlowInstanceCorehrV2PreHireRequest { confirm_workforce?: boolean } +export interface RestoreFlowInstanceCorehrV2PreHireResponse { + /** 是否成功恢复入职 */ + success?: boolean +} + export interface CreateCorehrV2PreHireRequest { /** 个人信息 */ basic_info: BasicInfo @@ -2855,6 +3302,11 @@ export interface CreateCorehrV2PreHireRequest { out_biz_id?: string } +export interface CreateCorehrV2PreHireResponse { + /** 待入职 ID */ + pre_hire_id?: string +} + export interface PatchCorehrV2PreHireRequest { /** 更新个人(person)信息 */ basic_info_update?: BasicInfoUpdate @@ -2868,6 +3320,11 @@ export interface PatchCorehrV2PreHireRequest { person_custom_update_fields?: string[] } +export interface PatchCorehrV2PreHireResponse { + /** 待入职ID */ + pre_hire_id?: string +} + export interface QueryCorehrV2PreHireRequest { /** 待入职人员 ID 列表;如果该字段非空,则不按照page_size、page_token分页方式查询 */ pre_hire_ids?: string[] @@ -2882,6 +3339,11 @@ export interface QueryCorehrV2PreHireQuery extends Pagination { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface GetCorehrV1PreHireResponse { + /** 待入职信息 */ + pre_hire?: PreHire +} + export interface ListCorehrV1PreHireQuery extends Pagination { /** 待入职ID列表 */ pre_hire_ids?: string[] @@ -2936,6 +3398,16 @@ export interface TransitTaskCorehrV2PreHireRequest { task_id: string } +export interface TransitTaskCorehrV2PreHireResponse { + /** 是否成功流转任务 */ + success?: boolean +} + +export interface CompleteCorehrV2PreHireResponse { + /** 是否成功完成入职 */ + success?: boolean +} + export interface PatchCorehrV1PreHireRequest { /** 招聘系统的候选人 ID */ ats_application_id?: string @@ -2962,6 +3434,10 @@ export interface PatchCorehrV1PreHireQuery { client_token?: string } +export interface PatchCorehrV1PreHireResponse { + pre_hire?: PreHire +} + export interface CreateCorehrV2ProbationAssessmentRequest { /** 试用期人员的雇佣 ID */ employment_id: string @@ -2976,6 +3452,11 @@ export interface CreateCorehrV2ProbationAssessmentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface CreateCorehrV2ProbationAssessmentResponse { + /** 创建的试用期考核记录 ID 列表,有序返回 */ + assessment_ids?: string[] +} + export interface EnableDisableAssessmentCorehrV2ProbationRequest { /** 启用 / 停用状态。启用后可在试用期管理页面中可见试用期考核相关的字段。 */ active: boolean @@ -3067,6 +3548,11 @@ export interface SubmitCorehrV2ProbationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface SubmitCorehrV2ProbationResponse { + /** 试用期信息 */ + probation_info?: ProbationInfoForSubmit +} + export interface WithdrawCorehrV2ProbationRequest { /** 试用期人员的雇佣 ID */ employment_id: string @@ -3079,9 +3565,16 @@ export interface WithdrawCorehrV2ProbationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export const enum CreateCorehrV2JobChangeRequestTransferMode { + /** 直接异动 */ + Type1 = 1, + /** 发起异动 */ + Type2 = 2, +} + export interface CreateCorehrV2JobChangeRequest { /** 异动方式 */ - transfer_mode: 1 | 2 + transfer_mode: CreateCorehrV2JobChangeRequestTransferMode /** 雇员id */ employment_id: string /** 异动类型唯一标识 */ @@ -3107,6 +3600,31 @@ export interface CreateCorehrV2JobChangeQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface CreateCorehrV2JobChangeResponse { + /** 异动记录 id */ + job_change_id?: string + /** 雇员 id */ + employment_id?: string + /** 异动状态 */ + status?: 'Approving' | 'Approved' | 'Transformed' | 'Rejected' | 'Cancelled' | 'NoNeedApproval' + /** 异动类型 */ + transfer_type_unique_identifier?: string + /** 异动原因 */ + transfer_reason_unique_identifier?: string + /** 异动流程 id */ + process_id?: string + /** 生效时间 */ + effective_date?: string + /** 创建时间 */ + created_time?: string + /** 异动详细信息 */ + transfer_info?: TransferInfo + /** 是否调整薪酬 */ + is_adjust_salary?: boolean + /** 异动自定义字段 */ + custom_fields?: CustomFieldData[] +} + export interface QueryCorehrV1TransferTypeQuery { /** 异动类型状态 */ active?: boolean @@ -3114,6 +3632,11 @@ export interface QueryCorehrV1TransferTypeQuery { transfer_type_unique_identifier?: string[] } +export interface QueryCorehrV1TransferTypeResponse { + /** 异动类型列表 */ + items?: TransferType[] +} + export interface QueryCorehrV1TransferReasonQuery { /** 异动原因状态 */ active?: boolean @@ -3121,6 +3644,11 @@ export interface QueryCorehrV1TransferReasonQuery { transfer_reason_unique_identifier?: string[] } +export interface QueryCorehrV1TransferReasonResponse { + /** 异动原因列表 */ + items?: TransferReason[] +} + export interface SearchCorehrV2JobChangeRequest { /** 雇员 ID 列表 */ employment_ids?: string[] @@ -3183,6 +3711,42 @@ export interface CreateCorehrV1JobChangeQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export const enum CreateCorehrV1JobChangeResponseStatus { + /** Approving 审批中 */ + Approving = 0, + /** Approved 审批通过 */ + Approved = 1, + /** Transformed 已异动 */ + Transformed = 2, + /** Rejected 已拒绝 */ + Rejected = 3, + /** Cancelled 已撤销 */ + Cancelled = 4, + /** NoNeedApproval 无需审批 */ + NoNeedApproval = 5, +} + +export interface CreateCorehrV1JobChangeResponse { + /** 异动记录 id */ + job_change_id?: string + /** 雇员 id */ + employment_id?: string + /** 异动状态 */ + status?: CreateCorehrV1JobChangeResponseStatus + /** 异动类型 */ + transfer_type_unique_identifier?: string + /** 异动原因 */ + transfer_reason_unique_identifier?: string + /** 异动流程 id */ + process_id?: string + /** 生效时间 */ + effective_date?: string + /** 创建时间 */ + created_time?: string + /** 异动详细信息 */ + transfer_info?: TransferInfo +} + export interface QueryCorehrV1OffboardingRequest { /** 是否启用 */ active?: boolean @@ -3190,9 +3754,21 @@ export interface QueryCorehrV1OffboardingRequest { offboarding_reason_unique_identifier?: string[] } +export interface QueryCorehrV1OffboardingResponse { + /** 离职原因列表 */ + items?: OffboardingReason[] +} + +export const enum SubmitV2CorehrV2OffboardingRequestOffboardingMode { + /** 直接离职 */ + TerminationOfDismissal = 1, + /** 发起离职审批 */ + OffboardingWithProcess = 2, +} + export interface SubmitV2CorehrV2OffboardingRequest { /** 离职方式 */ - offboarding_mode: 1 | 2 + offboarding_mode: SubmitV2CorehrV2OffboardingRequestOffboardingMode /** 雇员 id */ employment_id: string /** 离职日期 */ @@ -3222,21 +3798,51 @@ export interface SubmitV2CorehrV2OffboardingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface EditCorehrV2OffboardingRequest { - /** 离职记录 ID */ - offboarding_id: string - /** 操作人雇佣 ID(employment_id),为空默认为系统操作。 */ - operator_id?: string - /** 编辑字段数据信息 */ - update_data: ObjectFieldData[] -} - -export interface EditCorehrV2OffboardingQuery { - /** 用户 ID 类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' -} - -export interface RevokeCorehrV2OffboardingRequest { +export interface SubmitV2CorehrV2OffboardingResponse { + /** 离职记录 id */ + offboarding_id?: string + /** 雇员 id */ + employment_id?: string + /** 离职原因 */ + offboarding_reason_unique_identifier?: string + /** 离职日期 */ + offboarding_date?: string + /** 离职原因说明 */ + offboarding_reason_explanation?: string + /** 是否加入离职屏蔽名单 */ + add_block_list?: boolean + /** 屏蔽原因 */ + block_reason?: string + /** 屏蔽原因说明 */ + block_reason_explanation?: string + /** 创建时间 */ + created_time?: string + /** 离职是否保留飞书账号 */ + retain_account?: boolean + /** 编制随人员一起调整 */ + is_transfer_with_workforce?: boolean +} + +export interface EditCorehrV2OffboardingRequest { + /** 离职记录 ID */ + offboarding_id: string + /** 操作人雇佣 ID(employment_id),为空默认为系统操作。 */ + operator_id?: string + /** 编辑字段数据信息 */ + update_data: ObjectFieldData[] +} + +export interface EditCorehrV2OffboardingQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface EditCorehrV2OffboardingResponse { + /** 编辑字段数据信息 */ + data: ObjectFieldData[] +} + +export interface RevokeCorehrV2OffboardingRequest { /** 离职记录 ID */ offboarding_id: string /** 操作人雇佣 ID(employment_id),为空默认为系统操作。 */ @@ -3310,6 +3916,10 @@ export interface CreateCorehrV1ContractQuery { client_token?: string } +export interface CreateCorehrV1ContractResponse { + contract?: Contract +} + export interface PatchCorehrV1ContractRequest { /** 合同开始日期 */ effective_time?: string @@ -3340,6 +3950,15 @@ export interface PatchCorehrV1ContractQuery { client_token?: string } +export interface PatchCorehrV1ContractResponse { + contract?: Contract +} + +export interface GetCorehrV1ContractResponse { + /** 合同信息 */ + contract?: Contract +} + export interface SearchCorehrV2ContractRequest { /** 雇佣 ID 列表 */ employment_id_list?: string[] @@ -3391,6 +4010,13 @@ export interface ListCorehrV2WorkforcePlanQuery { active?: boolean } +export interface ListCorehrV2WorkforcePlanResponse { + /** 方案列表 */ + items?: WorkforcePlan[] + /** 方案总数 */ + total?: number +} + export interface BatchCorehrV2WorkforcePlanDetailRequest { /** 编制规划方案ID,ID及详细信息可通过获取编制规划方案列表接口查询获得。查询编制规划明细信息时,编制规划方案ID必填,是否为集中填报项目设置为false,不填写集中填报项目ID(是否填写不影响返回结果) */ workforce_plan_id?: string @@ -3414,6 +4040,19 @@ export interface BatchCorehrV2WorkforcePlanDetailRequest { cost_center_ids?: string[] } +export interface BatchCorehrV2WorkforcePlanDetailResponse { + /** 编制规划方案 ID */ + workforce_plan_id?: string + /** 集中填报项目 ID */ + centralized_reporting_project_id?: string + /** 编制规划明细信息 */ + items?: WorkforcePlanDetail[] + /** 分页标识 */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + export interface CreateCorehrV1LeaveGrantingRecordRequest { /** 假期类型 ID,枚举值可通过【获取假期类型列表】接口获取(若假期类型下存在假期子类,此处仅支持传入假期子类的 ID) */ leave_type_id: string @@ -3440,6 +4079,11 @@ export interface CreateCorehrV1LeaveGrantingRecordQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface CreateCorehrV1LeaveGrantingRecordResponse { + /** 假期授予记录 */ + leave_granting_record?: LeaveGrantingRecord +} + export interface LeaveTypesCorehrV1LeaveQuery extends Pagination { /** 假期类型状态(不传则为全部)可选值有:- 1:已启用- 2:已停用 */ status?: string @@ -3518,6 +4162,13 @@ export interface WorkCalendarCorehrV1LeaveRequest { only_enable?: boolean } +export interface WorkCalendarCorehrV1LeaveResponse { + /** 工作日历列表 */ + work_calendars?: WorkCalendarDetail[] + /** 入参count=true,则返回符合条件的工作日历总数 */ + count?: number +} + export interface CalendarByScopeCorehrV1LeaveQuery { /** 用户所属部门的ID列表 */ wk_department_id?: string @@ -3535,6 +4186,11 @@ export interface CalendarByScopeCorehrV1LeaveQuery { wk_company_id?: string } +export interface CalendarByScopeCorehrV1LeaveResponse { + /** 工作日历id */ + calendar_wk_id?: string +} + export interface WorkCalendarDateCorehrV1LeaveRequest { /** 工作日历WKID列表,最多100 */ wk_calendar_ids: string[] @@ -3552,6 +4208,11 @@ export interface WorkCalendarDateCorehrV1LeaveRequest { ids?: string[] } +export interface WorkCalendarDateCorehrV1LeaveResponse { + /** 日期类型列表 */ + calendar_dates?: WkCalendarDate[] +} + export interface QueryCorehrV1AuthorizationQuery extends Pagination { /** 员工ID列表,最大100个(不传则默认查询全部员工) */ employment_id_list?: string[] @@ -3572,6 +4233,11 @@ export interface GetByParamCorehrV1AuthorizationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface GetByParamCorehrV1AuthorizationResponse { + /** 角色授权信息 */ + role_authorization?: RoleAuthorization +} + export interface AddRoleAssignCorehrV1AuthorizationRequest { /** 授权 */ assigned_organization_items: AssignedOrganizationWithCode[][] @@ -3586,6 +4252,11 @@ export interface AddRoleAssignCorehrV1AuthorizationQuery { role_id: string } +export interface AddRoleAssignCorehrV1AuthorizationResponse { + /** 授权id */ + assign_id?: string +} + export interface UpdateRoleAssignCorehrV1AuthorizationRequest { /** 授权 */ assigned_organization_items: AssignedOrganizationWithCode[][] @@ -3600,6 +4271,11 @@ export interface UpdateRoleAssignCorehrV1AuthorizationQuery { role_id: string } +export interface UpdateRoleAssignCorehrV1AuthorizationResponse { + /** 授权id */ + assign_id?: string +} + export interface RemoveRoleAssignCorehrV1AuthorizationQuery { /** 雇员 ID */ employment_id: string @@ -3609,6 +4285,11 @@ export interface RemoveRoleAssignCorehrV1AuthorizationQuery { role_id: string } +export interface RemoveRoleAssignCorehrV1AuthorizationResponse { + /** 授权id */ + assign_id?: string +} + export interface BatchGetCorehrV2EmployeesBpRequest { /** 员工雇佣 ID */ employment_ids: string[] @@ -3621,6 +4302,13 @@ export interface BatchGetCorehrV2EmployeesBpQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export interface BatchGetCorehrV2EmployeesBpResponse { + /** 员工直属 BP 信息,当员工所在部门、属地无 BP 时,会上钻找到最近的 BP */ + employment_direct_bps?: EmploymentBp[] + /** 员工全部 BP 信息 */ + employment_all_bps?: EmploymentBp[] +} + export interface GetByDepartmentCorehrV2BpRequest { /** 部门 ID */ department_id: string @@ -3633,6 +4321,11 @@ export interface GetByDepartmentCorehrV2BpQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface GetByDepartmentCorehrV2BpResponse { + /** 部门 HRBP 信息,依次为部门及各层级上级部门 */ + items?: DepartmentHrbp[] +} + export interface QueryCorehrV1SecurityGroupRequest { /** 角色列表,一次最多支持查询 50 个 */ item_list: BpRoleOrganization[] @@ -3647,6 +4340,11 @@ export interface QueryCorehrV1SecurityGroupQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface QueryCorehrV1SecurityGroupResponse { + /** HRBP/属地 BP 信息 */ + hrbp_list?: Hrbp[] +} + export interface ListCorehrV2BpQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' @@ -3688,6 +4386,73 @@ export interface GetCorehrV2ProcessQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } +export const enum GetCorehrV2ProcessResponseStatus { + /** 进行中 */ + Running = 1, + /** 拒绝 */ + Reject = 2, + /** 撤回 */ + Withdraw = 4, + /** 撤销 */ + Revoke = 8, + /** 已完成 */ + Complete = 9, +} + +export const enum GetCorehrV2ProcessResponseProperties { + /** 普通流程 */ + Common = 1, + /** 撤销流程 */ + CheXiao = 2, + /** 更正流程 */ + Correct = 3, +} + +export interface GetCorehrV2ProcessResponse { + /** 流程实例ID */ + process_id?: string + /** 流程状态 */ + status?: GetCorehrV2ProcessResponseStatus + /** 业务类型ID */ + flow_template_id?: string + /** 业务类型名称 */ + flow_template_name?: DataengineI18n + /** 流程定义ID */ + flow_definition_id?: string + /** 流程定义名称 */ + flow_definition_name?: DataengineI18n + /** 流程发起人ID */ + initiator_id?: string + /** 流程发起人姓名 */ + initiator_name?: DataengineI18n + /** 流程发起时间,Unix毫秒时间戳 */ + create_time?: string + /** 流程结束时间,Unix毫秒时间戳 */ + complete_time?: string + /** 发起单据地址 */ + start_links?: ProcessLink + /** 流程摘要,会随着流程流转发生变化 */ + abstracts?: ProcessAbstractItem[] + /** 待办列表 */ + todos?: ProcessTodoItem[] + /** 抄送列表 */ + cc_list?: ProcessCcItem[] + /** 已办列表 */ + done_list?: ProcessDoneItem[] + /** 普通流程或撤销流程等 */ + properties?: GetCorehrV2ProcessResponseProperties + /** 系统待办列表 */ + system_todos?: ProcessSystemTodoItem[] + /** 系统已办列表 */ + system_done_list?: ProcessSystemDoneItem[] + /** 评论列表 */ + comment_infos?: ProcessCommentInfo[] + /** 更正流程原流程ID */ + original_process_id?: string + /** 是否最新的「已完成」的更正流程 */ + is_last_completed_correct_process?: boolean +} + export interface GetCorehrV2ProcessFormVariableDataQuery { /** 用户 ID 类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' @@ -3695,6 +4460,13 @@ export interface GetCorehrV2ProcessFormVariableDataQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface GetCorehrV2ProcessFormVariableDataResponse { + /** 表单数据 */ + field_variable_values?: FieldVariableValue[] + /** 流程实例id */ + process_id?: string +} + export interface UpdateCorehrV2ProcessRevokeRequest { /** 按照指定的用户ID类型传递对应的用户ID。 */ user_id?: string @@ -3732,9 +4504,16 @@ export interface ListCorehrV2ApproverQuery extends Pagination { approver_status?: -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 12 | 14 | 16 } +export const enum UpdateCorehrV2ProcessApproverRequestStatus { + /** 拒绝 */ + Approved = 2, + /** 通过 */ + Rejected = 3, +} + export interface UpdateCorehrV2ProcessApproverRequest { /** 将审批任务修改为同意/拒绝 */ - status: 2 | 3 + status: UpdateCorehrV2ProcessApproverRequestStatus /** 按user_id_type类型传递。如果system_approval为false,则必填。否则非必填。 */ user_id?: string /** true - 使用系统身份审批 */ @@ -3752,6 +4531,29 @@ export interface UpdateCorehrV2ProcessApproverQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface UpdateCorehrV2ProcessApproverResponse { + /** 错误码,非 0 表示失败 */ + code: number + /** 错误描述 */ + msg?: string +} + +export const enum UpdateCorehrV2ProcessExtraRequestExtraType { + /** 前加签 */ + PreExtra = 0, + /** 并加签 */ + CurrentExtra = 1, + /** 后加签 */ + PostExtra = 2, +} + +export const enum UpdateCorehrV2ProcessExtraRequestApprovalType { + /** 或签 */ + OR = 0, + /** 会签 */ + AND = 1, +} + export interface UpdateCorehrV2ProcessExtraRequest { /** 操作人,当system_user为true时,可以不传值 */ operator?: string @@ -3760,9 +4562,9 @@ export interface UpdateCorehrV2ProcessExtraRequest { /** 审批任务id,与node_id二选一传入,都传以node_id为准 */ approver_id?: string /** 加签方式 */ - extra_type: 0 | 1 | 2 + extra_type: UpdateCorehrV2ProcessExtraRequestExtraType /** 多人加签时的审批方式 */ - approval_type?: 0 | 1 + approval_type?: UpdateCorehrV2ProcessExtraRequestApprovalType /** 加签人员id列表 */ extra_user_ids: string[] /** 备注 */ @@ -3829,16 +4631,55 @@ export interface MatchCorehrV1CompensationStandardQuery { effective_time?: string } +export interface MatchCorehrV1CompensationStandardResponse { + /** 薪资标准表ID */ + standard_id?: string + /** 薪资等级 */ + grade?: CpstGrade + /** 生效时间 */ + effective_time?: string +} + +export interface GetCorehrV1ProcessFormVariableDataResponse { + /** 流程变量 */ + field_variable_values?: FormFieldVariable[] +} + export interface ListCorehrV1SubregionQuery extends Pagination { /** 省份/行政区id,填写后只查询该省份/行政区下的城市/区域 */ subdivision_id?: string } +export interface GetCorehrV1SubregionResponse { + /** 城市/区域信息 */ + subregion?: Subregion +} + export interface ListCorehrV1SubdivisionQuery extends Pagination { /** 国家/地区id,填写后只查询该国家/地区下的省份/行政区 */ country_region_id?: string } +export interface GetCorehrV1SubdivisionResponse { + /** 国家/地址信息 */ + subdivision?: Subdivision +} + +export interface GetCorehrV1CountryRegionResponse { + /** 国家/地址信息 */ + country_region?: CountryRegion +} + +export interface GetCorehrV1CurrencyResponse { + /** 货币信息 */ + currency?: Currency +} + +export interface GetCorehrV1JobResponse { + /** 职务信息 */ + job?: Job +} + export interface PatchCorehrV1DepartmentRequest { /** 实体在CoreHR内部的唯一键 */ id?: string @@ -3869,6 +4710,10 @@ export interface PatchCorehrV1DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface PatchCorehrV1DepartmentResponse { + department?: Department +} + export interface GetCorehrV1DepartmentQuery { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' @@ -3876,6 +4721,11 @@ export interface GetCorehrV1DepartmentQuery { department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' } +export interface GetCorehrV1DepartmentResponse { + /** 部门信息 */ + department?: Department +} + export interface ListCorehrV1JobQuery extends Pagination { /** 名称 */ name?: string @@ -3944,6 +4794,10 @@ export interface PatchCorehrV1PersonQuery { client_token?: string } +export interface PatchCorehrV1PersonResponse { + person?: Person +} + export interface CreateCorehrV1PersonRequest { /** 姓名 */ name_list: PersonName[] @@ -3994,14 +4848,28 @@ export interface CreateCorehrV1PersonQuery { client_token?: string } +export interface CreateCorehrV1PersonResponse { + person?: Person +} + export interface GetCorehrV1PersonQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'people_employee_id' } +export interface GetCorehrV1PersonResponse { + /** 个人信息 */ + person?: Person +} + +export const enum SubmitCorehrV1OffboardingRequestOffboardingMode { + /** 直接离职 */ + TerminationOfDismissal = 1, +} + export interface SubmitCorehrV1OffboardingRequest { /** 离职方式 */ - offboarding_mode: 1 + offboarding_mode: SubmitCorehrV1OffboardingRequestOffboardingMode /** 雇员 id */ employment_id: string /** 离职日期 */ @@ -4027,705 +4895,6 @@ export interface SubmitCorehrV1OffboardingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' } -export interface QueryCorehrV1CustomFieldResponse { - /** 自定义字段列表 */ - items?: CustomField[] -} - -export interface GetByParamCorehrV1CustomFieldResponse { - /** 自定义字段详情 */ - data?: CustomField -} - -export interface AddEnumOptionCorehrV1CommonDataMetaDataResponse { - /** 枚举字段 API name */ - enum_field_api_name?: string - /** 枚举全部选项列表 */ - enum_field_options?: EnumFieldOption[] -} - -export interface EditEnumOptionCorehrV1CommonDataMetaDataResponse { - /** 枚举字段 API name */ - enum_field_api_name?: string - /** 枚举全部选项列表 */ - enum_field_options?: EnumFieldOption[] -} - -export interface CreateCorehrV1NationalIdTypeResponse { - national_id_type?: NationalIdType -} - -export interface PatchCorehrV1NationalIdTypeResponse { - national_id_type?: NationalIdType -} - -export interface GetCorehrV1NationalIdTypeResponse { - /** 国家证件类型信息 */ - national_id_type?: NationalIdType -} - -export interface CreateCorehrV1EmployeeTypeResponse { - employee_type?: EmployeeType -} - -export interface PatchCorehrV1EmployeeTypeResponse { - employee_type?: EmployeeType -} - -export interface GetCorehrV1EmployeeTypeResponse { - /** 雇员类型 */ - employee_type?: EmployeeType -} - -export interface CreateCorehrV1WorkingHoursTypeResponse { - working_hours_type?: WorkingHoursType -} - -export interface PatchCorehrV1WorkingHoursTypeResponse { - working_hours_type?: WorkingHoursType -} - -export interface GetCorehrV1WorkingHoursTypeResponse { - /** 工时制度信息 */ - working_hours_type?: WorkingHoursType -} - -export interface ConvertCorehrV1CommonDataIdResponse { - /** ID 信息列表 */ - items?: IdInfo[] -} - -export interface BatchGetCorehrV2EmployeeResponse { - /** 查询的雇佣信息 */ - items?: Employee[] -} - -export interface CreateCorehrV2EmployeeResponse { - /** 雇佣信息 ID */ - employment_id?: string - /** 合同 ID */ - contract_id?: string - /** 任职信息 ID */ - job_data_id?: string -} - -export interface CreateCorehrV2PersonResponse { - person?: PersonInfo -} - -export interface PatchCorehrV2PersonResponse { - person?: PersonInfo -} - -export interface UploadCorehrV1PersonResponse { - /** 上传文件ID */ - id?: string -} - -export interface CreateCorehrV1EmploymentResponse { - employment?: EmploymentCreate -} - -export interface PatchCorehrV1EmploymentResponse { - employment?: Employment -} - -export interface CreateCorehrV1JobDataResponse { - job_data?: JobData -} - -export interface PatchCorehrV1JobDataResponse { - job_data?: JobData -} - -export interface BatchGetCorehrV2EmployeesJobDataResponse { - /** 查询的雇佣信息 */ - items?: EmployeeJobData[] -} - -export interface GetCorehrV1JobDataResponse { - /** 任职信息 */ - job_data?: JobData -} - -export interface CreateCorehrV2EmployeesAdditionalJobResponse { - additional_job?: EmployeesAdditionalJobWriteResp -} - -export interface PatchCorehrV2EmployeesAdditionalJobResponse { - additional_job?: EmployeesAdditionalJobWriteResp -} - -export interface CreateCorehrV1DepartmentResponse { - department?: DepartmentCreate -} - -export interface ParentsCorehrV2DepartmentResponse { - /** 父部门查询结果 */ - items?: DepartmentParents[] -} - -export interface BatchGetCorehrV2DepartmentResponse { - /** 查询的部门信息 */ - items?: Department[] -} - -export interface QueryRecentChangeCorehrV2DepartmentResponse { - /** 部门 ID 列表 */ - department_ids?: string[] - /** 目标查询时间范围内被删除的部门列表 */ - deleted_department_ids?: string[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean -} - -export interface QueryTimelineCorehrV2DepartmentResponse { - /** 部门信息 */ - items?: DepartmentTimeline[] -} - -export interface CreateCorehrV1LocationResponse { - location?: Location -} - -export interface GetCorehrV1LocationResponse { - /** 地点信息 */ - location?: Location -} - -export interface QueryRecentChangeCorehrV2LocationResponse { - /** 地点 ID 列表 */ - location_ids?: string[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean - /** 删除的地点 ID 列表 */ - deleted_location_ids?: string[] -} - -export interface BatchGetCorehrV2LocationResponse { - /** 查询的地点信息 */ - items?: Location[] -} - -export interface CreateCorehrV2LocationAddressResponse { - /** 地址 ID */ - address_id?: string -} - -export interface CreateCorehrV1CompanyResponse { - company?: Company -} - -export interface PatchCorehrV1CompanyResponse { - company?: Company -} - -export interface GetCorehrV1CompanyResponse { - /** 公司信息 */ - company?: Company -} - -export interface QueryRecentChangeCorehrV2CompanyResponse { - /** 公司 ID 列表 */ - company_ids?: string[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean - /** 删除的公司 ID 列表 */ - deleted_company_ids?: string[] -} - -export interface BatchGetCorehrV2CompanyResponse { - /** 查询的公司信息 */ - items?: Company[] -} - -export interface CreateCorehrV2CostCenterResponse { - cost_center?: CostCenter -} - -export interface PatchCorehrV2CostCenterResponse { - cost_center?: CostCenter -} - -export interface QueryRecentChangeCorehrV2CostCenterResponse { - /** 成本中心 ID 列表 */ - cost_center_ids?: string[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean - /** 删除的成本中心 ID 列表 */ - deleted_cost_center_ids?: string[] -} - -export interface CreateCorehrV2CostCenterVersionResponse { - version?: CostCenterVersion -} - -export interface PatchCorehrV2CostCenterVersionResponse { - version?: CostCenterVersion -} - -export interface GetCorehrV2ApprovalGroupsResponse { - /** 组织架构调整流程信息 */ - approval_group?: ApprovalGroup -} - -export interface OpenQueryDepartmentChangeListByIdsCorehrV2ApprovalGroupsResponse { - /** 部门调整记录信息列表 */ - department_changes?: DepartmentChange[] -} - -export interface OpenQueryJobChangeListByIdsCorehrV2ApprovalGroupsResponse { - /** 人员异动记录信息列表 */ - job_changes?: JobChange[] -} - -export interface CreateCorehrV1JobFamilyResponse { - job_family?: JobFamily -} - -export interface PatchCorehrV1JobFamilyResponse { - job_family?: JobFamily -} - -export interface GetCorehrV1JobFamilyResponse { - /** 职务序列信息 */ - job_family?: JobFamily -} - -export interface QueryRecentChangeCorehrV2JobFamilyResponse { - /** 序列 ID 列表 */ - job_family_ids?: string[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean - /** 删除的序列 ID 列表 */ - deleted_job_family_ids?: string[] -} - -export interface BatchGetCorehrV2JobFamilyResponse { - /** 查询的序列信息 */ - items?: JobFamily[] -} - -export interface CreateCorehrV1JobLevelResponse { - job_level?: JobLevel -} - -export interface PatchCorehrV1JobLevelResponse { - job_level?: JobLevel -} - -export interface GetCorehrV1JobLevelResponse { - /** 职务级别信息 */ - job_level?: JobLevel -} - -export interface QueryRecentChangeCorehrV2JobLevelResponse { - /** 职级 ID 列表 */ - job_level_ids?: string[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean - /** 删除的职级 ID 列表 */ - deleted_job_level_ids?: string[] -} - -export interface BatchGetCorehrV2JobLevelResponse { - /** 查询的职级信息 */ - items?: JobLevel[] -} - -export interface CreateCorehrV2JobGradeResponse { - /** 职等ID */ - grade_id?: string -} - -export interface QueryRecentChangeCorehrV2JobGradeResponse { - /** 职等 ID 列表 */ - job_grade_ids?: string[] - /** 下一页页码 */ - page_token?: string - /** 是否有下一页 */ - has_more?: boolean - /** 删除的职等 ID 列表 */ - deleted_job_grade_ids?: string[] -} - -export interface CreateCorehrV1JobResponse { - job?: Job -} - -export interface PatchCorehrV1JobResponse { - job?: Job -} - -export interface GetCorehrV2JobResponse { - /** 职务信息 */ - job?: Job -} - -export interface WithdrawOnboardingCorehrV2PreHireResponse { - /** 是否成功撤销入职 */ - success?: boolean -} - -export interface RestoreFlowInstanceCorehrV2PreHireResponse { - /** 是否成功恢复入职 */ - success?: boolean -} - -export interface CreateCorehrV2PreHireResponse { - /** 待入职 ID */ - pre_hire_id?: string -} - -export interface PatchCorehrV2PreHireResponse { - /** 待入职ID */ - pre_hire_id?: string -} - -export interface GetCorehrV1PreHireResponse { - /** 待入职信息 */ - pre_hire?: PreHire -} - -export interface TransitTaskCorehrV2PreHireResponse { - /** 是否成功流转任务 */ - success?: boolean -} - -export interface CompleteCorehrV2PreHireResponse { - /** 是否成功完成入职 */ - success?: boolean -} - -export interface PatchCorehrV1PreHireResponse { - pre_hire?: PreHire -} - -export interface CreateCorehrV2ProbationAssessmentResponse { - /** 创建的试用期考核记录 ID 列表,有序返回 */ - assessment_ids?: string[] -} - -export interface SubmitCorehrV2ProbationResponse { - /** 试用期信息 */ - probation_info?: ProbationInfoForSubmit -} - -export interface CreateCorehrV2JobChangeResponse { - /** 异动记录 id */ - job_change_id?: string - /** 雇员 id */ - employment_id?: string - /** 异动状态 */ - status?: 'Approving' | 'Approved' | 'Transformed' | 'Rejected' | 'Cancelled' | 'NoNeedApproval' - /** 异动类型 */ - transfer_type_unique_identifier?: string - /** 异动原因 */ - transfer_reason_unique_identifier?: string - /** 异动流程 id */ - process_id?: string - /** 生效时间 */ - effective_date?: string - /** 创建时间 */ - created_time?: string - /** 异动详细信息 */ - transfer_info?: TransferInfo - /** 是否调整薪酬 */ - is_adjust_salary?: boolean - /** 异动自定义字段 */ - custom_fields?: CustomFieldData[] -} - -export interface QueryCorehrV1TransferTypeResponse { - /** 异动类型列表 */ - items?: TransferType[] -} - -export interface QueryCorehrV1TransferReasonResponse { - /** 异动原因列表 */ - items?: TransferReason[] -} - -export interface CreateCorehrV1JobChangeResponse { - /** 异动记录 id */ - job_change_id?: string - /** 雇员 id */ - employment_id?: string - /** 异动状态 */ - status?: 0 | 1 | 2 | 3 | 4 | 5 - /** 异动类型 */ - transfer_type_unique_identifier?: string - /** 异动原因 */ - transfer_reason_unique_identifier?: string - /** 异动流程 id */ - process_id?: string - /** 生效时间 */ - effective_date?: string - /** 创建时间 */ - created_time?: string - /** 异动详细信息 */ - transfer_info?: TransferInfo -} - -export interface QueryCorehrV1OffboardingResponse { - /** 离职原因列表 */ - items?: OffboardingReason[] -} - -export interface SubmitV2CorehrV2OffboardingResponse { - /** 离职记录 id */ - offboarding_id?: string - /** 雇员 id */ - employment_id?: string - /** 离职原因 */ - offboarding_reason_unique_identifier?: string - /** 离职日期 */ - offboarding_date?: string - /** 离职原因说明 */ - offboarding_reason_explanation?: string - /** 是否加入离职屏蔽名单 */ - add_block_list?: boolean - /** 屏蔽原因 */ - block_reason?: string - /** 屏蔽原因说明 */ - block_reason_explanation?: string - /** 创建时间 */ - created_time?: string - /** 离职是否保留飞书账号 */ - retain_account?: boolean - /** 编制随人员一起调整 */ - is_transfer_with_workforce?: boolean -} - -export interface EditCorehrV2OffboardingResponse { - /** 编辑字段数据信息 */ - data: ObjectFieldData[] -} - -export interface CreateCorehrV1ContractResponse { - contract?: Contract -} - -export interface PatchCorehrV1ContractResponse { - contract?: Contract -} - -export interface GetCorehrV1ContractResponse { - /** 合同信息 */ - contract?: Contract -} - -export interface ListCorehrV2WorkforcePlanResponse { - /** 方案列表 */ - items?: WorkforcePlan[] - /** 方案总数 */ - total?: number -} - -export interface BatchCorehrV2WorkforcePlanDetailResponse { - /** 编制规划方案 ID */ - workforce_plan_id?: string - /** 集中填报项目 ID */ - centralized_reporting_project_id?: string - /** 编制规划明细信息 */ - items?: WorkforcePlanDetail[] - /** 分页标识 */ - page_token?: string - /** 是否还有更多项 */ - has_more?: boolean -} - -export interface CreateCorehrV1LeaveGrantingRecordResponse { - /** 假期授予记录 */ - leave_granting_record?: LeaveGrantingRecord -} - -export interface WorkCalendarCorehrV1LeaveResponse { - /** 工作日历列表 */ - work_calendars?: WorkCalendarDetail[] - /** 入参count=true,则返回符合条件的工作日历总数 */ - count?: number -} - -export interface CalendarByScopeCorehrV1LeaveResponse { - /** 工作日历id */ - calendar_wk_id?: string -} - -export interface WorkCalendarDateCorehrV1LeaveResponse { - /** 日期类型列表 */ - calendar_dates?: WkCalendarDate[] -} - -export interface GetByParamCorehrV1AuthorizationResponse { - /** 角色授权信息 */ - role_authorization?: RoleAuthorization -} - -export interface AddRoleAssignCorehrV1AuthorizationResponse { - /** 授权id */ - assign_id?: string -} - -export interface UpdateRoleAssignCorehrV1AuthorizationResponse { - /** 授权id */ - assign_id?: string -} - -export interface RemoveRoleAssignCorehrV1AuthorizationResponse { - /** 授权id */ - assign_id?: string -} - -export interface BatchGetCorehrV2EmployeesBpResponse { - /** 员工直属 BP 信息,当员工所在部门、属地无 BP 时,会上钻找到最近的 BP */ - employment_direct_bps?: EmploymentBp[] - /** 员工全部 BP 信息 */ - employment_all_bps?: EmploymentBp[] -} - -export interface GetByDepartmentCorehrV2BpResponse { - /** 部门 HRBP 信息,依次为部门及各层级上级部门 */ - items?: DepartmentHrbp[] -} - -export interface QueryCorehrV1SecurityGroupResponse { - /** HRBP/属地 BP 信息 */ - hrbp_list?: Hrbp[] -} - -export interface GetCorehrV2ProcessResponse { - /** 流程实例ID */ - process_id?: string - /** 流程状态 */ - status?: 1 | 2 | 4 | 8 | 9 - /** 业务类型ID */ - flow_template_id?: string - /** 业务类型名称 */ - flow_template_name?: DataengineI18n - /** 流程定义ID */ - flow_definition_id?: string - /** 流程定义名称 */ - flow_definition_name?: DataengineI18n - /** 流程发起人ID */ - initiator_id?: string - /** 流程发起人姓名 */ - initiator_name?: DataengineI18n - /** 流程发起时间,Unix毫秒时间戳 */ - create_time?: string - /** 流程结束时间,Unix毫秒时间戳 */ - complete_time?: string - /** 发起单据地址 */ - start_links?: ProcessLink - /** 流程摘要,会随着流程流转发生变化 */ - abstracts?: ProcessAbstractItem[] - /** 待办列表 */ - todos?: ProcessTodoItem[] - /** 抄送列表 */ - cc_list?: ProcessCcItem[] - /** 已办列表 */ - done_list?: ProcessDoneItem[] - /** 普通流程或撤销流程等 */ - properties?: 1 | 2 | 3 - /** 系统待办列表 */ - system_todos?: ProcessSystemTodoItem[] - /** 系统已办列表 */ - system_done_list?: ProcessSystemDoneItem[] - /** 评论列表 */ - comment_infos?: ProcessCommentInfo[] - /** 更正流程原流程ID */ - original_process_id?: string - /** 是否最新的「已完成」的更正流程 */ - is_last_completed_correct_process?: boolean -} - -export interface GetCorehrV2ProcessFormVariableDataResponse { - /** 表单数据 */ - field_variable_values?: FieldVariableValue[] - /** 流程实例id */ - process_id?: string -} - -export interface UpdateCorehrV2ProcessApproverResponse { - /** 错误码,非 0 表示失败 */ - code: number - /** 错误描述 */ - msg?: string -} - -export interface MatchCorehrV1CompensationStandardResponse { - /** 薪资标准表ID */ - standard_id?: string - /** 薪资等级 */ - grade?: CpstGrade - /** 生效时间 */ - effective_time?: string -} - -export interface GetCorehrV1ProcessFormVariableDataResponse { - /** 流程变量 */ - field_variable_values?: FormFieldVariable[] -} - -export interface GetCorehrV1SubregionResponse { - /** 城市/区域信息 */ - subregion?: Subregion -} - -export interface GetCorehrV1SubdivisionResponse { - /** 国家/地址信息 */ - subdivision?: Subdivision -} - -export interface GetCorehrV1CountryRegionResponse { - /** 国家/地址信息 */ - country_region?: CountryRegion -} - -export interface GetCorehrV1CurrencyResponse { - /** 货币信息 */ - currency?: Currency -} - -export interface GetCorehrV1JobResponse { - /** 职务信息 */ - job?: Job -} - -export interface PatchCorehrV1DepartmentResponse { - department?: Department -} - -export interface GetCorehrV1DepartmentResponse { - /** 部门信息 */ - department?: Department -} - -export interface PatchCorehrV1PersonResponse { - person?: Person -} - -export interface CreateCorehrV1PersonResponse { - person?: Person -} - -export interface GetCorehrV1PersonResponse { - /** 个人信息 */ - person?: Person -} - export interface SubmitCorehrV1OffboardingResponse { /** 离职记录 id */ offboarding_id?: string diff --git a/adapters/lark/src/types/document_ai.ts b/adapters/lark/src/types/document_ai.ts index 1d781f8a..7e16f67d 100644 --- a/adapters/lark/src/types/document_ai.ts +++ b/adapters/lark/src/types/document_ai.ts @@ -101,81 +101,161 @@ export interface ParseDocumentAiResumeForm { file: Blob } +export interface ParseDocumentAiResumeResponse { + /** 简历信息 */ + resumes?: Resume[] +} + export interface RecognizeDocumentAiVehicleInvoiceForm { /** 识别的机动车发票源文件 */ file: Blob } +export interface RecognizeDocumentAiVehicleInvoiceResponse { + /** 机动车发票信息 */ + vehicle_invoice?: VehicleInvoice +} + export interface RecognizeDocumentAiHealthCertificateForm { /** 识别的健康证源文件 */ file: Blob } +export interface RecognizeDocumentAiHealthCertificateResponse { + /** 健康证信息 */ + health_certificate?: HealthCertificate +} + export interface RecognizeDocumentAiHkmMainlandTravelPermitForm { /** 识别的港澳居民来往内地通行证源文件 */ file: Blob } +export interface RecognizeDocumentAiHkmMainlandTravelPermitResponse { + /** 港澳居民来往内地通行证信息 */ + hkm_mainland_travel_permit?: HkmMainlandTravelPermit +} + export interface RecognizeDocumentAiTwMainlandTravelPermitForm { /** 识别的台湾居民来往大陆通行证源文件 */ file?: Blob } +export interface RecognizeDocumentAiTwMainlandTravelPermitResponse { + /** 台湾居民来往大陆通行证信息 */ + tw_mainland_travel_permit?: TwMainlandTravelPermit +} + export interface RecognizeDocumentAiChinesePassportForm { /** 识别的中国护照源文件 */ file: Blob } +export interface RecognizeDocumentAiChinesePassportResponse { + /** 中国护照信息 */ + chinese_passport?: ChinesePassport +} + export interface RecognizeDocumentAiBankCardForm { /** 识别的银行卡源文件 */ file: Blob } +export interface RecognizeDocumentAiBankCardResponse { + /** 银行卡信息 */ + bank_card?: BankCard +} + export interface RecognizeDocumentAiVehicleLicenseForm { /** 识别的行驶证源文件 */ file: Blob } +export interface RecognizeDocumentAiVehicleLicenseResponse { + /** 行驶证信息 */ + vehicle_license?: VehicleLicense +} + export interface RecognizeDocumentAiTrainInvoiceForm { /** 识别的火车票源文件 */ file: Blob } +export interface RecognizeDocumentAiTrainInvoiceResponse { + /** 火车票信息 */ + train_invoices?: TrainInvoice[] +} + export interface RecognizeDocumentAiTaxiInvoiceForm { /** 识别的出租车票源文件 */ file: Blob } +export interface RecognizeDocumentAiTaxiInvoiceResponse { + /** 出租车票信息 */ + taxi_invoices?: TaxiInvoice[] +} + export interface RecognizeDocumentAiIdCardForm { /** 识别身份证的源文件 */ file: Blob } +export interface RecognizeDocumentAiIdCardResponse { + /** 身份证信息 */ + id_card?: IdCard +} + export interface RecognizeDocumentAiFoodProduceLicenseForm { /** 识别的食品生产许可证源文件 */ file: Blob } +export interface RecognizeDocumentAiFoodProduceLicenseResponse { + /** 食品生产许可证信息 */ + food_produce_license?: FoodProduceLicense +} + export interface RecognizeDocumentAiFoodManageLicenseForm { /** 识别的食品经营许可证源文件 */ file: Blob } +export interface RecognizeDocumentAiFoodManageLicenseResponse { + /** 食品经营许可证信息 */ + food_manage_license?: FoodManageLicense +} + export interface RecognizeDocumentAiDrivingLicenseForm { /** 识别的驾驶证源文件 */ file: Blob } +export interface RecognizeDocumentAiDrivingLicenseResponse { + /** 驾驶证信息 */ + driving_license?: DrvingLicense +} + export interface RecognizeDocumentAiVatInvoiceForm { /** 识别的增值税发票文件 */ file: Blob } +export interface RecognizeDocumentAiVatInvoiceResponse { + /** 增值税发票信息 */ + vat_invoices?: VatInvoice[] +} + export interface RecognizeDocumentAiBusinessLicenseForm { /** 识别的营业执照源文件 */ file: Blob } +export interface RecognizeDocumentAiBusinessLicenseResponse { + /** 营业执照信息 */ + business_license?: BusinessLicense +} + export interface FieldExtractionDocumentAiContractForm { /** 合同字段解析的源文件,当前只支持pdf, doc, docx三种类型的文件 */ file: Blob @@ -185,91 +265,6 @@ export interface FieldExtractionDocumentAiContractForm { ocr_mode: 'force' | 'auto' | 'unused' } -export interface RecognizeDocumentAiBusinessCardForm { - /** 识别名片的源文件(支持 JPG / PNG / PDF) */ - file: Blob -} - -export interface ParseDocumentAiResumeResponse { - /** 简历信息 */ - resumes?: Resume[] -} - -export interface RecognizeDocumentAiVehicleInvoiceResponse { - /** 机动车发票信息 */ - vehicle_invoice?: VehicleInvoice -} - -export interface RecognizeDocumentAiHealthCertificateResponse { - /** 健康证信息 */ - health_certificate?: HealthCertificate -} - -export interface RecognizeDocumentAiHkmMainlandTravelPermitResponse { - /** 港澳居民来往内地通行证信息 */ - hkm_mainland_travel_permit?: HkmMainlandTravelPermit -} - -export interface RecognizeDocumentAiTwMainlandTravelPermitResponse { - /** 台湾居民来往大陆通行证信息 */ - tw_mainland_travel_permit?: TwMainlandTravelPermit -} - -export interface RecognizeDocumentAiChinesePassportResponse { - /** 中国护照信息 */ - chinese_passport?: ChinesePassport -} - -export interface RecognizeDocumentAiBankCardResponse { - /** 银行卡信息 */ - bank_card?: BankCard -} - -export interface RecognizeDocumentAiVehicleLicenseResponse { - /** 行驶证信息 */ - vehicle_license?: VehicleLicense -} - -export interface RecognizeDocumentAiTrainInvoiceResponse { - /** 火车票信息 */ - train_invoices?: TrainInvoice[] -} - -export interface RecognizeDocumentAiTaxiInvoiceResponse { - /** 出租车票信息 */ - taxi_invoices?: TaxiInvoice[] -} - -export interface RecognizeDocumentAiIdCardResponse { - /** 身份证信息 */ - id_card?: IdCard -} - -export interface RecognizeDocumentAiFoodProduceLicenseResponse { - /** 食品生产许可证信息 */ - food_produce_license?: FoodProduceLicense -} - -export interface RecognizeDocumentAiFoodManageLicenseResponse { - /** 食品经营许可证信息 */ - food_manage_license?: FoodManageLicense -} - -export interface RecognizeDocumentAiDrivingLicenseResponse { - /** 驾驶证信息 */ - driving_license?: DrvingLicense -} - -export interface RecognizeDocumentAiVatInvoiceResponse { - /** 增值税发票信息 */ - vat_invoices?: VatInvoice[] -} - -export interface RecognizeDocumentAiBusinessLicenseResponse { - /** 营业执照信息 */ - business_license?: BusinessLicense -} - export interface FieldExtractionDocumentAiContractResponse { /** 文件的唯一id */ file_id?: string @@ -289,6 +284,11 @@ export interface FieldExtractionDocumentAiContractResponse { bank_info?: BankInfo[] } +export interface RecognizeDocumentAiBusinessCardForm { + /** 识别名片的源文件(支持 JPG / PNG / PDF) */ + file: Blob +} + export interface RecognizeDocumentAiBusinessCardResponse { /** 名片信息 */ business_cards?: RecognizedEntities[] diff --git a/adapters/lark/src/types/docx.ts b/adapters/lark/src/types/docx.ts index d8126fa0..58c5319a 100644 --- a/adapters/lark/src/types/docx.ts +++ b/adapters/lark/src/types/docx.ts @@ -101,6 +101,25 @@ export interface GetDocxChatAnnouncementQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetDocxChatAnnouncementResponse { + /** 当前版本号 */ + revision_id?: number + /** 群公告生成的时间戳(秒) */ + create_time?: string + /** 群公告更新的时间戳(秒) */ + update_time?: string + /** 群公告所有者 ID,ID 值与 owner_id_type 中的ID类型对应 */ + owner_id?: string + /** 群公告所有者的 ID 类型 */ + owner_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 群公告最新修改者 ID,ID 值与 modifier_id_type 中的ID类型对应 */ + modifier_id?: string + /** 群公告最新修改者 id 类型 */ + modifier_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 群公告类型 */ + announcement_type?: 'docx' | 'doc' +} + export interface ListDocxChatAnnouncementBlockQuery extends Pagination { /** 查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的编辑权限。 */ revision_id?: number @@ -124,6 +143,15 @@ export interface CreateDocxChatAnnouncementBlockChildrenQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateDocxChatAnnouncementBlockChildrenResponse { + /** 所添加的孩子的 Block 信息 */ + children?: Block[] + /** 当前 Block Children 创建成功后群公告的版本号 */ + revision_id?: number + /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ + client_token?: string +} + export interface BatchUpdateDocxChatAnnouncementBlockRequest { /** 批量更新 Block */ requests?: UpdateBlockRequest[] @@ -138,6 +166,15 @@ export interface BatchUpdateDocxChatAnnouncementBlockQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchUpdateDocxChatAnnouncementBlockResponse { + /** 批量更新的 Block */ + blocks?: Block[] + /** 当前更新成功后群公告的版本号 */ + revision_id?: number + /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ + client_token?: string +} + export interface GetDocxChatAnnouncementBlockQuery { /** 查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的更新权限 */ revision_id?: number @@ -145,6 +182,11 @@ export interface GetDocxChatAnnouncementBlockQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetDocxChatAnnouncementBlockResponse { + /** 查询的 Block 的信息 */ + block?: Block +} + export interface GetDocxChatAnnouncementBlockChildrenQuery extends Pagination { /** 查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的更新权限。 */ revision_id?: number @@ -166,6 +208,13 @@ export interface BatchDeleteDocxChatAnnouncementBlockChildrenQuery { client_token?: string } +export interface BatchDeleteDocxChatAnnouncementBlockChildrenResponse { + /** 当前删除操作成功后群公告的版本号 */ + revision_id?: number + /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ + client_token?: string +} + export interface CreateDocxDocumentRequest { /** 文件夹 token,获取方式见云文档接口快速入门;空表示根目录,tenant_access_token应用权限仅允许操作应用创建的目录 */ folder_token?: string @@ -173,9 +222,33 @@ export interface CreateDocxDocumentRequest { title?: string } +export interface CreateDocxDocumentResponse { + /** 新建文档的文档信息 */ + document?: Document +} + +export interface GetDocxDocumentResponse { + /** 文档信息 */ + document?: Document +} + +export const enum RawContentDocxDocumentQueryLang { + /** 中文 */ + ZH = 0, + /** 英文 */ + EN = 1, + /** 日文 */ + JP = 2, +} + export interface RawContentDocxDocumentQuery { /** 语言(用于 MentionUser 语言的选取) */ - lang?: 0 | 1 | 2 + lang?: RawContentDocxDocumentQueryLang +} + +export interface RawContentDocxDocumentResponse { + /** 文档纯文本 */ + content?: string } export interface ListDocxDocumentBlockQuery extends Pagination { @@ -201,6 +274,15 @@ export interface CreateDocxDocumentBlockChildrenQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateDocxDocumentBlockChildrenResponse { + /** 所添加的孩子的 Block 信息 */ + children?: Block[] + /** 当前 block children 创建成功后文档的版本号 */ + document_revision_id?: number + /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ + client_token: string +} + export interface CreateDocxDocumentBlockDescendantRequest { /** 添加的孩子 BlockID 列表 */ children_id: string[] @@ -219,6 +301,17 @@ export interface CreateDocxDocumentBlockDescendantQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateDocxDocumentBlockDescendantResponse { + /** 所添加的孩子的 Block 信息 */ + children?: Block[] + /** 当前提交的 Block 创建成功后文档的版本号 */ + document_revision_id?: number + /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ + client_token?: string + /** 传入的临时 BlockID 与真实 BlockID 映射关系 */ + block_id_relations?: BlockIdRelation[] +} + export interface PatchDocxDocumentBlockRequest { /** 更新文本元素请求 */ update_text_elements?: UpdateTextElementsRequest @@ -263,6 +356,15 @@ export interface PatchDocxDocumentBlockQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface PatchDocxDocumentBlockResponse { + /** 更新后的 block 信息 */ + block?: Block + /** 当前更新成功后文档的版本号 */ + document_revision_id?: number + /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ + client_token: string +} + export interface GetDocxDocumentBlockQuery { /** 查询的文档版本,-1表示文档最新版本。若此时查询的版本为文档最新版本,则需要持有文档的阅读权限;若此时查询的版本为文档的历史版本,则需要持有文档的编辑权限。 */ document_revision_id?: number @@ -270,6 +372,11 @@ export interface GetDocxDocumentBlockQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetDocxDocumentBlockResponse { + /** 查询的 Block 的信息 */ + block?: Block +} + export interface BatchUpdateDocxDocumentBlockRequest { /** 批量更新 Block */ requests: UpdateBlockRequest[] @@ -284,6 +391,15 @@ export interface BatchUpdateDocxDocumentBlockQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchUpdateDocxDocumentBlockResponse { + /** 批量更新的 Block */ + blocks?: Block[] + /** 当前更新成功后文档的版本号 */ + document_revision_id?: number + /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ + client_token: string +} + export interface GetDocxDocumentBlockChildrenQuery extends Pagination { /** 操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。 */ document_revision_id?: number @@ -305,113 +421,6 @@ export interface BatchDeleteDocxDocumentBlockChildrenQuery { client_token?: string } -export interface GetDocxChatAnnouncementResponse { - /** 当前版本号 */ - revision_id?: number - /** 群公告生成的时间戳(秒) */ - create_time?: string - /** 群公告更新的时间戳(秒) */ - update_time?: string - /** 群公告所有者 ID,ID 值与 owner_id_type 中的ID类型对应 */ - owner_id?: string - /** 群公告所有者的 ID 类型 */ - owner_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 群公告最新修改者 ID,ID 值与 modifier_id_type 中的ID类型对应 */ - modifier_id?: string - /** 群公告最新修改者 id 类型 */ - modifier_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 群公告类型 */ - announcement_type?: 'docx' | 'doc' -} - -export interface CreateDocxChatAnnouncementBlockChildrenResponse { - /** 所添加的孩子的 Block 信息 */ - children?: Block[] - /** 当前 Block Children 创建成功后群公告的版本号 */ - revision_id?: number - /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ - client_token?: string -} - -export interface BatchUpdateDocxChatAnnouncementBlockResponse { - /** 批量更新的 Block */ - blocks?: Block[] - /** 当前更新成功后群公告的版本号 */ - revision_id?: number - /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ - client_token?: string -} - -export interface GetDocxChatAnnouncementBlockResponse { - /** 查询的 Block 的信息 */ - block?: Block -} - -export interface BatchDeleteDocxChatAnnouncementBlockChildrenResponse { - /** 当前删除操作成功后群公告的版本号 */ - revision_id?: number - /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ - client_token?: string -} - -export interface CreateDocxDocumentResponse { - /** 新建文档的文档信息 */ - document?: Document -} - -export interface GetDocxDocumentResponse { - /** 文档信息 */ - document?: Document -} - -export interface RawContentDocxDocumentResponse { - /** 文档纯文本 */ - content?: string -} - -export interface CreateDocxDocumentBlockChildrenResponse { - /** 所添加的孩子的 Block 信息 */ - children?: Block[] - /** 当前 block children 创建成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ - client_token: string -} - -export interface CreateDocxDocumentBlockDescendantResponse { - /** 所添加的孩子的 Block 信息 */ - children?: Block[] - /** 当前提交的 Block 创建成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ - client_token?: string - /** 传入的临时 BlockID 与真实 BlockID 映射关系 */ - block_id_relations?: BlockIdRelation[] -} - -export interface PatchDocxDocumentBlockResponse { - /** 更新后的 block 信息 */ - block?: Block - /** 当前更新成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ - client_token: string -} - -export interface GetDocxDocumentBlockResponse { - /** 查询的 Block 的信息 */ - block?: Block -} - -export interface BatchUpdateDocxDocumentBlockResponse { - /** 批量更新的 Block */ - blocks?: Block[] - /** 当前更新成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */ - client_token: string -} - export interface BatchDeleteDocxDocumentBlockChildrenResponse { /** 当前删除操作成功后文档的版本号 */ document_revision_id?: number diff --git a/adapters/lark/src/types/drive.ts b/adapters/lark/src/types/drive.ts index 677ddcf4..62d69da7 100644 --- a/adapters/lark/src/types/drive.ts +++ b/adapters/lark/src/types/drive.ts @@ -7,7 +7,7 @@ declare module '../internal' { * 获取文件夹中的文件清单 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list */ - listDriveV1File(query?: ListDriveV1FileQuery): Paginated + listDriveV1File(query?: ListDriveV1FileQuery): Promise & AsyncIterableIterator /** * 新建文件夹 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder @@ -312,6 +312,15 @@ export interface ListDriveV1FileQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ListDriveV1FileResponse { + /** 文档详细信息 */ + files?: File[] + /** 下一页分页参数 */ + next_page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + export interface CreateFolderDriveV1FileRequest { /** 文件夹名称 */ name: string @@ -319,11 +328,23 @@ export interface CreateFolderDriveV1FileRequest { folder_token: string } +export interface CreateFolderDriveV1FileResponse { + /** 新创建的文件夹 Token */ + token?: string + /** 创建文件夹的访问 URL */ + url?: string +} + export interface TaskCheckDriveV1FileQuery { /** 文件相关异步任务id */ task_id: string } +export interface TaskCheckDriveV1FileResponse { + /** 异步任务的执行状态 */ + status?: string +} + export interface BatchQueryDriveV1MetaRequest { /** 请求文档, 一次不超过200个 */ request_docs: RequestDoc[] @@ -336,11 +357,25 @@ export interface BatchQueryDriveV1MetaQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchQueryDriveV1MetaResponse { + metas: Meta[] + failed_list?: MetaFailed[] +} + export interface GetDriveV1FileStatisticsQuery { /** 文档类型 */ file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx' } +export interface GetDriveV1FileStatisticsResponse { + /** 文档token */ + file_token?: string + /** 文档类型 */ + file_type?: string + /** 文档统计信息 */ + statistics?: FileStatistics +} + export interface ListDriveV1FileViewRecordQuery extends Pagination { /** 文档类型 */ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file' @@ -364,6 +399,11 @@ export interface CopyDriveV1FileQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CopyDriveV1FileResponse { + /** 复制后的文件资源 */ + file?: File +} + export interface MoveDriveV1FileRequest { /** 文件类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */ type?: 'file' | 'docx' | 'bitable' | 'doc' | 'sheet' | 'mindnote' | 'folder' | 'slides' @@ -371,11 +411,21 @@ export interface MoveDriveV1FileRequest { folder_token?: string } +export interface MoveDriveV1FileResponse { + /** 异步任务id,移动文件夹时返回 */ + task_id?: string +} + export interface DeleteDriveV1FileQuery { /** 被删除文件的类型 */ type: 'file' | 'docx' | 'bitable' | 'folder' | 'doc' | 'sheet' | 'mindnote' | 'shortcut' | 'slides' } +export interface DeleteDriveV1FileResponse { + /** 异步任务id,删除文件夹时返回 */ + task_id?: string +} + export interface CreateShortcutDriveV1FileRequest { /** 创建快捷方式的目标父文件夹 token */ parent_token: string @@ -388,6 +438,11 @@ export interface CreateShortcutDriveV1FileQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateShortcutDriveV1FileResponse { + /** 返回创建成功的shortcut节点 */ + succ_shortcut_node?: File +} + export interface UploadAllDriveV1FileForm { /** 文件名。 */ file_name: string @@ -403,6 +458,10 @@ export interface UploadAllDriveV1FileForm { file: Blob } +export interface UploadAllDriveV1FileResponse { + file_token?: string +} + export interface UploadPrepareDriveV1FileRequest { /** 文件名 */ file_name: string @@ -414,6 +473,15 @@ export interface UploadPrepareDriveV1FileRequest { size: number } +export interface UploadPrepareDriveV1FileResponse { + /** 分片上传事务ID */ + upload_id?: string + /** 分片大小策略 */ + block_size?: number + /** 分片数量 */ + block_num?: number +} + export interface UploadPartDriveV1FileForm { /** 分片上传事务ID。 */ upload_id: string @@ -434,6 +502,10 @@ export interface UploadFinishDriveV1FileRequest { block_num: number } +export interface UploadFinishDriveV1FileResponse { + file_token?: string +} + export interface CreateDriveV1ImportTaskRequest { /** 导入文件格式后缀 */ file_extension: string @@ -447,6 +519,16 @@ export interface CreateDriveV1ImportTaskRequest { point: ImportTaskMountPoint } +export interface CreateDriveV1ImportTaskResponse { + /** 导入任务ID */ + ticket?: string +} + +export interface GetDriveV1ImportTaskResponse { + /** 导入任务 */ + result?: ImportTask +} + export interface CreateDriveV1ExportTaskRequest { /** 导出文件扩展名 */ file_extension: 'docx' | 'pdf' | 'xlsx' | 'csv' @@ -458,11 +540,21 @@ export interface CreateDriveV1ExportTaskRequest { sub_id?: string } +export interface CreateDriveV1ExportTaskResponse { + /** 导出任务ID */ + ticket?: string +} + export interface GetDriveV1ExportTaskQuery { /** 导出文档的 token */ token: string } +export interface GetDriveV1ExportTaskResponse { + /** 导出结果 */ + result?: ExportTask +} + export interface UploadAllDriveV1MediaForm { /** 文件名。 */ file_name: string @@ -480,6 +572,10 @@ export interface UploadAllDriveV1MediaForm { file: Blob } +export interface UploadAllDriveV1MediaResponse { + file_token?: string +} + export interface UploadPrepareDriveV1MediaRequest { /** 文件名 */ file_name: string @@ -493,6 +589,15 @@ export interface UploadPrepareDriveV1MediaRequest { extra?: string } +export interface UploadPrepareDriveV1MediaResponse { + /** 分片上传事务ID */ + upload_id?: string + /** 分片大小策略 */ + block_size?: number + /** 分片数量 */ + block_num?: number +} + export interface UploadPartDriveV1MediaForm { /** 分片上传事务ID。 */ upload_id: string @@ -513,6 +618,10 @@ export interface UploadFinishDriveV1MediaRequest { block_num: number } +export interface UploadFinishDriveV1MediaResponse { + file_token?: string +} + export interface DownloadDriveV1MediaQuery { /** 扩展信息 */ extra?: string @@ -525,6 +634,11 @@ export interface BatchGetTmpDownloadUrlDriveV1MediaQuery { extra?: string } +export interface BatchGetTmpDownloadUrlDriveV1MediaResponse { + /** 临时下载列表 */ + tmp_download_urls?: TmpDownloadUrl[] +} + export interface CreateDriveV1FileVersionRequest { /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */ name?: string @@ -537,6 +651,29 @@ export interface CreateDriveV1FileVersionQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateDriveV1FileVersionResponse { + /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */ + name?: string + /** 版本文档版本号 */ + version?: string + /** 源文档token */ + parent_token?: string + /** 版本文档所有者id */ + owner_id?: string + /** 版本文档创建者id */ + creator_id?: string + /** 版本文档创建时间 */ + create_time?: string + /** 版本文档更新时间 */ + update_time?: string + /** 版本文档状态 */ + status?: '0' | '1' | '2' + /** 版本文档类型 */ + obj_type?: 'docx' | 'sheet' + /** 源文档类型 */ + parent_type?: 'docx' | 'sheet' +} + export interface ListDriveV1FileVersionQuery extends Pagination { /** 原文档类型 */ obj_type: 'docx' | 'sheet' @@ -551,6 +688,29 @@ export interface GetDriveV1FileVersionQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface GetDriveV1FileVersionResponse { + /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */ + name?: string + /** 版本文档版本号 */ + version?: string + /** 源文档token */ + parent_token?: string + /** 版本文档所有者id */ + owner_id?: string + /** 版本文档创建者id */ + creator_id?: string + /** 版本文档创建时间 */ + create_time?: string + /** 版本文档更新时间 */ + update_time?: string + /** 版本文档状态 */ + status?: '0' | '1' | '2' + /** 版本文档类型 */ + obj_type?: 'docx' | 'sheet' + /** 源文档类型 */ + parent_type?: 'docx' | 'sheet' +} + export interface DeleteDriveV1FileVersionQuery { /** 文档类型 */ obj_type: 'docx' | 'sheet' @@ -579,6 +739,11 @@ export interface GetSubscribeDriveV1FileQuery { event_type?: string } +export interface GetSubscribeDriveV1FileResponse { + /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */ + is_subscribe?: boolean +} + export interface DeleteSubscribeDriveV1FileQuery { /** 文档类型 */ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder' @@ -598,6 +763,11 @@ export interface BatchCreateDriveV1PermissionMemberQuery { need_notification?: boolean } +export interface BatchCreateDriveV1PermissionMemberResponse { + /** 协作者列表 */ + members?: BaseMember[] +} + export interface TransferOwnerDriveV1PermissionMemberRequest { /** 文档拥有者的ID类型 */ member_type: 'email' | 'openid' | 'userid' @@ -625,6 +795,11 @@ export interface AuthDriveV1PermissionMemberQuery { action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public' } +export interface AuthDriveV1PermissionMemberResponse { + /** 是否有权限 */ + auth_result: boolean +} + export interface ListDriveV1PermissionMemberQuery { /** 文件类型,需要与文件的 token 相匹配 */ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' @@ -634,6 +809,11 @@ export interface ListDriveV1PermissionMemberQuery { perm_type?: 'container' | 'single_page' } +export interface ListDriveV1PermissionMemberResponse { + /** 返回的列表数据 */ + items?: Member[] +} + export interface CreateDriveV1PermissionMemberRequest { /** 协作者ID类型 */ member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid' @@ -654,6 +834,11 @@ export interface CreateDriveV1PermissionMemberQuery { need_notification?: boolean } +export interface CreateDriveV1PermissionMemberResponse { + /** 本次添加权限的用户信息 */ + member?: BaseMember +} + export interface UpdateDriveV1PermissionMemberRequest { /** 协作者ID类型 */ member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid' @@ -672,6 +857,11 @@ export interface UpdateDriveV1PermissionMemberQuery { type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } +export interface UpdateDriveV1PermissionMemberResponse { + /** 本次更新权限的用户信息 */ + member?: BaseMember +} + export interface DeleteDriveV1PermissionMemberRequest { /** 协作者类型 */ type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor' @@ -691,11 +881,21 @@ export interface CreateDriveV1PermissionPublicPasswordQuery { type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } +export interface CreateDriveV1PermissionPublicPasswordResponse { + /** 密码 */ + password?: string +} + export interface UpdateDriveV1PermissionPublicPasswordQuery { /** 文件类型,需要与文件的 token 相匹配 */ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } +export interface UpdateDriveV1PermissionPublicPasswordResponse { + /** 密码 */ + password?: string +} + export interface DeleteDriveV1PermissionPublicPasswordQuery { /** 文件类型,需要与文件的 token 相匹配 */ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' @@ -706,6 +906,11 @@ export interface GetDriveV1PermissionPublicQuery { type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } +export interface GetDriveV1PermissionPublicResponse { + /** 返回的文档公共设置 */ + permission_public?: PermissionPublic +} + export interface PatchDriveV1PermissionPublicRequest { /** 允许内容被分享到组织外 */ external_access?: boolean @@ -726,11 +931,21 @@ export interface PatchDriveV1PermissionPublicQuery { type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } +export interface PatchDriveV1PermissionPublicResponse { + /** 本次更新后的文档公共设置 */ + permission_public?: PermissionPublic +} + export interface GetDriveV2PermissionPublicQuery { /** 文件类型,需要与文件的 token 相匹配 */ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } +export interface GetDriveV2PermissionPublicResponse { + /** 返回的文档公共设置 */ + permission_public?: PermissionPublic +} + export interface PatchDriveV2PermissionPublicRequest { /** 允许内容被分享到组织外 */ external_access_entity?: 'open' | 'closed' | 'allow_share_partner_tenant' @@ -753,6 +968,11 @@ export interface PatchDriveV2PermissionPublicQuery { type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' } +export interface PatchDriveV2PermissionPublicResponse { + /** 本次更新后文档公共设置 */ + permission_public?: PermissionPublic +} + export interface ListDriveV1FileCommentQuery extends Pagination { /** 文档类型 */ file_type: 'doc' | 'sheet' | 'file' | 'docx' @@ -776,6 +996,11 @@ export interface BatchQueryDriveV1FileCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchQueryDriveV1FileCommentResponse { + /** 评论的相关信息、回复的信息、回复分页的信息 */ + items?: FileComment[] +} + export interface PatchDriveV1FileCommentRequest { /** 评论解决标志 */ is_solved: boolean @@ -798,277 +1023,41 @@ export interface CreateDriveV1FileCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetDriveV1FileCommentQuery { - /** 文档类型 */ - file_type: 'doc' | 'sheet' | 'file' | 'docx' - /** 此次调用中使用的用户 ID 的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' +export interface CreateDriveV1FileCommentResponse { + /** 评论 ID */ + comment_id?: string + /** 用户 ID */ + user_id?: string + /** 创建时间 */ + create_time?: number + /** 更新时间 */ + update_time?: number + /** 是否已解决 */ + is_solved?: boolean + /** 解决评论时间 */ + solved_time?: number + /** 解决评论者的用户 ID */ + solver_user_id?: string + /** 是否有更多回复 */ + has_more?: boolean + /** 回复分页标记 */ + page_token?: string + /** 是否是全文评论 */ + is_whole?: boolean + /** 局部评论的引用字段 */ + quote?: string + /** 评论里的回复列表 */ + reply_list?: ReplyList } -export interface ListDriveV1FileCommentReplyQuery extends Pagination { +export interface GetDriveV1FileCommentQuery { /** 文档类型 */ file_type: 'doc' | 'sheet' | 'file' | 'docx' - /** 此次调用中使用的用户ID的类型 */ + /** 此次调用中使用的用户 ID 的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface UpdateDriveV1FileCommentReplyRequest { - /** 回复内容 */ - content: ReplyContent -} - -export interface UpdateDriveV1FileCommentReplyQuery { - /** 文档类型 */ - file_type: 'doc' | 'sheet' | 'file' | 'docx' - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface DeleteDriveV1FileCommentReplyQuery { - /** 文档类型 */ - file_type: 'doc' | 'sheet' | 'file' | 'docx' -} - -export interface GetDriveV1FileSubscriptionRequest { - /** 文档类型 */ - file_type: 'doc' | 'docx' | 'wiki' -} - -export interface CreateDriveV1FileSubscriptionRequest { - /** 订阅关系ID */ - subscription_id?: string - /** 订阅类型 */ - subscription_type: 'comment_update' - /** 是否订阅 */ - is_subcribe?: boolean - /** 文档类型 */ - file_type: 'doc' | 'docx' | 'wiki' -} - -export interface PatchDriveV1FileSubscriptionRequest { - /** 是否订阅 */ - is_subscribe: boolean - /** 文档类型 */ - file_type: 'doc' | 'docx' | 'wiki' -} - -export interface CreateFolderDriveV1FileResponse { - /** 新创建的文件夹 Token */ - token?: string - /** 创建文件夹的访问 URL */ - url?: string -} - -export interface TaskCheckDriveV1FileResponse { - /** 异步任务的执行状态 */ - status?: string -} - -export interface BatchQueryDriveV1MetaResponse { - metas: Meta[] - failed_list?: MetaFailed[] -} - -export interface GetDriveV1FileStatisticsResponse { - /** 文档token */ - file_token?: string - /** 文档类型 */ - file_type?: string - /** 文档统计信息 */ - statistics?: FileStatistics -} - -export interface CopyDriveV1FileResponse { - /** 复制后的文件资源 */ - file?: File -} - -export interface MoveDriveV1FileResponse { - /** 异步任务id,移动文件夹时返回 */ - task_id?: string -} - -export interface DeleteDriveV1FileResponse { - /** 异步任务id,删除文件夹时返回 */ - task_id?: string -} - -export interface CreateShortcutDriveV1FileResponse { - /** 返回创建成功的shortcut节点 */ - succ_shortcut_node?: File -} - -export interface UploadAllDriveV1FileResponse { - file_token?: string -} - -export interface UploadPrepareDriveV1FileResponse { - /** 分片上传事务ID */ - upload_id?: string - /** 分片大小策略 */ - block_size?: number - /** 分片数量 */ - block_num?: number -} - -export interface UploadFinishDriveV1FileResponse { - file_token?: string -} - -export interface CreateDriveV1ImportTaskResponse { - /** 导入任务ID */ - ticket?: string -} - -export interface GetDriveV1ImportTaskResponse { - /** 导入任务 */ - result?: ImportTask -} - -export interface CreateDriveV1ExportTaskResponse { - /** 导出任务ID */ - ticket?: string -} - -export interface GetDriveV1ExportTaskResponse { - /** 导出结果 */ - result?: ExportTask -} - -export interface UploadAllDriveV1MediaResponse { - file_token?: string -} - -export interface UploadPrepareDriveV1MediaResponse { - /** 分片上传事务ID */ - upload_id?: string - /** 分片大小策略 */ - block_size?: number - /** 分片数量 */ - block_num?: number -} - -export interface UploadFinishDriveV1MediaResponse { - file_token?: string -} - -export interface BatchGetTmpDownloadUrlDriveV1MediaResponse { - /** 临时下载列表 */ - tmp_download_urls?: TmpDownloadUrl[] -} - -export interface CreateDriveV1FileVersionResponse { - /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */ - name?: string - /** 版本文档版本号 */ - version?: string - /** 源文档token */ - parent_token?: string - /** 版本文档所有者id */ - owner_id?: string - /** 版本文档创建者id */ - creator_id?: string - /** 版本文档创建时间 */ - create_time?: string - /** 版本文档更新时间 */ - update_time?: string - /** 版本文档状态 */ - status?: '0' | '1' | '2' - /** 版本文档类型 */ - obj_type?: 'docx' | 'sheet' - /** 源文档类型 */ - parent_type?: 'docx' | 'sheet' -} - -export interface GetDriveV1FileVersionResponse { - /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */ - name?: string - /** 版本文档版本号 */ - version?: string - /** 源文档token */ - parent_token?: string - /** 版本文档所有者id */ - owner_id?: string - /** 版本文档创建者id */ - creator_id?: string - /** 版本文档创建时间 */ - create_time?: string - /** 版本文档更新时间 */ - update_time?: string - /** 版本文档状态 */ - status?: '0' | '1' | '2' - /** 版本文档类型 */ - obj_type?: 'docx' | 'sheet' - /** 源文档类型 */ - parent_type?: 'docx' | 'sheet' -} - -export interface GetSubscribeDriveV1FileResponse { - /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */ - is_subscribe?: boolean -} - -export interface BatchCreateDriveV1PermissionMemberResponse { - /** 协作者列表 */ - members?: BaseMember[] -} - -export interface AuthDriveV1PermissionMemberResponse { - /** 是否有权限 */ - auth_result: boolean -} - -export interface ListDriveV1PermissionMemberResponse { - /** 返回的列表数据 */ - items?: Member[] -} - -export interface CreateDriveV1PermissionMemberResponse { - /** 本次添加权限的用户信息 */ - member?: BaseMember -} - -export interface UpdateDriveV1PermissionMemberResponse { - /** 本次更新权限的用户信息 */ - member?: BaseMember -} - -export interface CreateDriveV1PermissionPublicPasswordResponse { - /** 密码 */ - password?: string -} - -export interface UpdateDriveV1PermissionPublicPasswordResponse { - /** 密码 */ - password?: string -} - -export interface GetDriveV1PermissionPublicResponse { - /** 返回的文档公共设置 */ - permission_public?: PermissionPublic -} - -export interface PatchDriveV1PermissionPublicResponse { - /** 本次更新后的文档公共设置 */ - permission_public?: PermissionPublic -} - -export interface GetDriveV2PermissionPublicResponse { - /** 返回的文档公共设置 */ - permission_public?: PermissionPublic -} - -export interface PatchDriveV2PermissionPublicResponse { - /** 本次更新后文档公共设置 */ - permission_public?: PermissionPublic -} - -export interface BatchQueryDriveV1FileCommentResponse { - /** 评论的相关信息、回复的信息、回复分页的信息 */ - items?: FileComment[] -} - -export interface CreateDriveV1FileCommentResponse { +export interface GetDriveV1FileCommentResponse { /** 评论 ID */ comment_id?: string /** 用户 ID */ @@ -1095,31 +1084,33 @@ export interface CreateDriveV1FileCommentResponse { reply_list?: ReplyList } -export interface GetDriveV1FileCommentResponse { - /** 评论 ID */ - comment_id?: string - /** 用户 ID */ - user_id?: string - /** 创建时间 */ - create_time?: number - /** 更新时间 */ - update_time?: number - /** 是否已解决 */ - is_solved?: boolean - /** 解决评论时间 */ - solved_time?: number - /** 解决评论者的用户 ID */ - solver_user_id?: string - /** 是否有更多回复 */ - has_more?: boolean - /** 回复分页标记 */ - page_token?: string - /** 是否是全文评论 */ - is_whole?: boolean - /** 局部评论的引用字段 */ - quote?: string - /** 评论里的回复列表 */ - reply_list?: ReplyList +export interface ListDriveV1FileCommentReplyQuery extends Pagination { + /** 文档类型 */ + file_type: 'doc' | 'sheet' | 'file' | 'docx' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateDriveV1FileCommentReplyRequest { + /** 回复内容 */ + content: ReplyContent +} + +export interface UpdateDriveV1FileCommentReplyQuery { + /** 文档类型 */ + file_type: 'doc' | 'sheet' | 'file' | 'docx' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteDriveV1FileCommentReplyQuery { + /** 文档类型 */ + file_type: 'doc' | 'sheet' | 'file' | 'docx' +} + +export interface GetDriveV1FileSubscriptionRequest { + /** 文档类型 */ + file_type: 'doc' | 'docx' | 'wiki' } export interface GetDriveV1FileSubscriptionResponse { @@ -1133,6 +1124,17 @@ export interface GetDriveV1FileSubscriptionResponse { file_type?: 'doc' | 'docx' | 'wiki' } +export interface CreateDriveV1FileSubscriptionRequest { + /** 订阅关系ID */ + subscription_id?: string + /** 订阅类型 */ + subscription_type: 'comment_update' + /** 是否订阅 */ + is_subcribe?: boolean + /** 文档类型 */ + file_type: 'doc' | 'docx' | 'wiki' +} + export interface CreateDriveV1FileSubscriptionResponse { /** 订阅关系ID */ subscription_id?: string @@ -1144,6 +1146,13 @@ export interface CreateDriveV1FileSubscriptionResponse { file_type?: 'doc' | 'docx' | 'wiki' } +export interface PatchDriveV1FileSubscriptionRequest { + /** 是否订阅 */ + is_subscribe: boolean + /** 文档类型 */ + file_type: 'doc' | 'docx' | 'wiki' +} + export interface PatchDriveV1FileSubscriptionResponse { /** 订阅关系ID */ subscription_id?: string diff --git a/adapters/lark/src/types/ehr.ts b/adapters/lark/src/types/ehr.ts index 88f458ab..d1402164 100644 --- a/adapters/lark/src/types/ehr.ts +++ b/adapters/lark/src/types/ehr.ts @@ -16,13 +16,39 @@ declare module '../internal' { } } +export const enum ListEhrEmployeeQueryStatus { + /** 待入职 */ + ToBeOnboarded = 1, + /** 在职 */ + Active = 2, + /** 已取消入职 */ + OnboardingCancelled = 3, + /** 待离职 */ + Offboarding = 4, + /** 已离职 */ + Offboarded = 5, +} + +export const enum ListEhrEmployeeQueryType { + /** 全职 */ + Regular = 1, + /** 实习 */ + Intern = 2, + /** 顾问 */ + Consultant = 3, + /** 外包 */ + Outsourcing = 4, + /** 劳务 */ + Contractor = 5, +} + export interface ListEhrEmployeeQuery extends Pagination { /** 返回数据类型 */ view?: 'basic' | 'full' /** 员工状态,不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录,如 status=2&status=4 */ - status?: (1 | 2 | 3 | 4 | 5)[] + status?: ListEhrEmployeeQueryStatus[] /** 雇员类型,不传代表查询所有雇员类型 */ - type?: (1 | 2 | 3 | 4 | 5)[] + type?: ListEhrEmployeeQueryType[] /** 查询开始时间(创建时间 >= 此时间) */ start_time?: string /** 查询结束时间(创建时间 <= 此时间) */ diff --git a/adapters/lark/src/types/helpdesk.ts b/adapters/lark/src/types/helpdesk.ts index facbf1e5..e5607e34 100644 --- a/adapters/lark/src/types/helpdesk.ts +++ b/adapters/lark/src/types/helpdesk.ts @@ -142,7 +142,7 @@ declare module '../internal' { * 获取全部工单自定义字段 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields */ - listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: Pagination): Paginated + listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: Pagination): Promise & AsyncIterableIterator /** * 创建知识库 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/create @@ -167,7 +167,7 @@ declare module '../internal' { * 获取全部知识库详情 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/list */ - listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise + listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise & AsyncIterableIterator /** * 获取知识库图像 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/faq_image @@ -261,6 +261,11 @@ export interface PatchHelpdeskAgentRequest { status?: number } +export interface AgentEmailHelpdeskAgentResponse { + /** agent emails */ + agents?: string +} + export interface CreateHelpdeskAgentScheduleRequest { /** 新客服日程 */ agent_schedules?: AgentScheduleUpdateInfo[] @@ -271,11 +276,21 @@ export interface PatchHelpdeskAgentSchedulesRequest { agent_schedule?: AgentScheduleUpdateInfo } +export interface GetHelpdeskAgentSchedulesResponse { + /** schedules of an agent */ + agent_schedule?: AgentSchedule +} + export interface ListHelpdeskAgentScheduleQuery { /** 筛选条件, 1 - online客服, 2 - offline(手动)客服, 3 - off duty(下班)客服, 4 - 移除客服 */ status: number[] } +export interface ListHelpdeskAgentScheduleResponse { + /** schedule of all agent */ + agent_schedules?: AgentSchedule[] +} + export interface CreateHelpdeskAgentSkillRequest { /** 技能名 */ name?: string @@ -285,11 +300,30 @@ export interface CreateHelpdeskAgentSkillRequest { agent_ids?: string[] } +export interface CreateHelpdeskAgentSkillResponse { + agent_skill_id?: string +} + export interface PatchHelpdeskAgentSkillRequest { /** 更新技能 */ agent_skill?: AgentSkill } +export interface GetHelpdeskAgentSkillResponse { + /** agent skill */ + agent_skill?: AgentSkill +} + +export interface ListHelpdeskAgentSkillResponse { + /** list of agent groups */ + agent_skills?: AgentSkill[] +} + +export interface ListHelpdeskAgentSkillRuleResponse { + /** all rules for agent skill */ + rules?: AgentSkillRule[] +} + export interface StartServiceHelpdeskTicketRequest { /** 是否直接进入人工(若appointed_agents填写了,该值为必填) */ human_service?: boolean @@ -301,6 +335,16 @@ export interface StartServiceHelpdeskTicketRequest { customized_info?: string } +export interface StartServiceHelpdeskTicketResponse { + /** chat id */ + chat_id: string +} + +export interface GetHelpdeskTicketResponse { + /** ticket detail */ + ticket?: Ticket +} + export interface UpdateHelpdeskTicketRequest { /** new status, 1: 已创建, 2: 处理中, 3: 排队中, 5: 待定, 50: 机器人关闭工单, 51: 关闭工单 */ status?: number @@ -355,6 +399,12 @@ export interface ListHelpdeskTicketQuery { update_time_end?: number } +export interface ListHelpdeskTicketResponse { + /** the total count */ + total?: number + tickets?: Ticket[] +} + export interface TicketImageHelpdeskTicketQuery { /** 工单ID */ ticket_id: string @@ -376,6 +426,13 @@ export interface CustomizedFieldsHelpdeskTicketQuery { visible_only?: boolean } +export interface CustomizedFieldsHelpdeskTicketResponse { + /** user customized fields */ + user_customized_fields?: UserCustomizedField[] + /** ticket customized fields */ + ticket_customized_fields?: TicketCustomizedField[] +} + export interface CreateHelpdeskTicketMessageRequest { /** 消息类型;text:纯文本;post:富文本 */ msg_type: string @@ -383,6 +440,11 @@ export interface CreateHelpdeskTicketMessageRequest { content: string } +export interface CreateHelpdeskTicketMessageResponse { + /** chat消息open ID */ + message_id?: string +} + export interface ListHelpdeskTicketMessageQuery { /** 起始时间 */ time_start?: number @@ -394,6 +456,13 @@ export interface ListHelpdeskTicketMessageQuery { page_size?: number } +export interface ListHelpdeskTicketMessageResponse { + /** list of ticket messages */ + messages?: TicketMessage[] + /** total number of messages */ + total?: number +} + export interface CreateHelpdeskBotMessageRequest { /** 消息类型 */ msg_type: 'text' | 'post' | 'image' | 'interactive' @@ -410,6 +479,10 @@ export interface CreateHelpdeskBotMessageQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateHelpdeskBotMessageResponse { + message_id?: string +} + export interface CreateHelpdeskTicketCustomizedFieldRequest { /** help desk id */ helpdesk_id: string @@ -446,21 +519,73 @@ export interface PatchHelpdeskTicketCustomizedFieldRequest { required?: boolean } +export interface GetHelpdeskTicketCustomizedFieldResponse { + /** ticket customized field id */ + ticket_customized_field_id: string + /** help desk id */ + helpdesk_id: string + /** key name */ + key_name: string + /** display name */ + display_name: string + /** the position of ticket customized field in the page */ + position: string + /** type of the field */ + field_type: string + /** description of the field */ + description: string + /** if the field is visible */ + visible: boolean + /** if the field is editable */ + editable: boolean + /** if the field is required */ + required: boolean + /** the time when the field is created */ + created_at?: string + /** the time when the field is updated */ + updated_at?: string + /** the user who created the ticket customized field */ + created_by?: TicketUser + /** the user who recently updated the ticket customized field */ + updated_by?: TicketUser + /** if the dropdown field supports multi-select */ + dropdown_allow_multiple?: boolean +} + export interface ListHelpdeskTicketCustomizedFieldRequest { /** 是否可见 */ visible?: boolean } +export interface ListHelpdeskTicketCustomizedFieldResponse { + /** whether there is more data */ + has_more?: boolean + /** the next page token */ + next_page_token?: string + /** all the ticket customized fields */ + items?: TicketCustomizedField[] +} + export interface CreateHelpdeskFaqRequest { /** 知识库详情 */ faq?: FaqCreateInfo } +export interface CreateHelpdeskFaqResponse { + /** faq detail */ + faq?: Faq +} + export interface PatchHelpdeskFaqRequest { /** 修改的知识库内容 */ faq?: FaqUpdateInfo } +export interface GetHelpdeskFaqResponse { + /** faq detail */ + faq?: Faq +} + export interface ListHelpdeskFaqQuery extends Pagination { /** 知识库分类ID */ category_id?: string @@ -470,6 +595,18 @@ export interface ListHelpdeskFaqQuery extends Pagination { search?: string } +export interface ListHelpdeskFaqResponse { + /** if there's next page */ + has_more?: boolean + /** the next page token */ + page_token?: string + /** the page size */ + page_size?: number + /** the total count */ + total?: number + items?: Faq[] +} + export interface SearchHelpdeskFaqQuery extends Pagination { /** 搜索query,query内容如果不是英文,包含中文空格等有两种编码策略:1. url编码 2. base64编码,同时加上base64=true参数 */ query: string @@ -486,6 +623,24 @@ export interface CreateHelpdeskCategoryRequest { language?: string } +export interface CreateHelpdeskCategoryResponse { + /** category */ + category?: Category +} + +export interface GetHelpdeskCategoryResponse { + /** category id */ + category_id: string + /** category id, for backward compatibility */ + id: string + /** category name */ + name: string + /** helpdesk id */ + helpdesk_id: string + /** category language */ + language?: string +} + export interface PatchHelpdeskCategoryRequest { /** category name */ name?: string @@ -502,6 +657,11 @@ export interface ListHelpdeskCategoryQuery { asc?: boolean } +export interface ListHelpdeskCategoryResponse { + /** list of categories */ + categories?: Category[] +} + export interface CreateHelpdeskNotificationRequest { /** 唯一ID */ id?: string @@ -550,6 +710,13 @@ export interface CreateHelpdeskNotificationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateHelpdeskNotificationResponse { + /** 创建成功后的唯一id */ + notification_id?: string + /** 当前状态 */ + status?: number +} + export interface PatchHelpdeskNotificationRequest { /** 唯一ID */ id?: string @@ -603,11 +770,23 @@ export interface GetHelpdeskNotificationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetHelpdeskNotificationResponse { + /** push任务详情 */ + notification?: Notification + /** 审批链接 */ + approval_app_link?: string +} + export interface SubmitApproveHelpdeskNotificationRequest { /** 提交审批理由 */ reason: string } +export interface SubmitApproveHelpdeskNotificationResponse { + /** 是否有权限创建或者管理审批流程 (有两种情况会导致没有权限: 1:用户没有安装服务台小程序,需要在https://app.feishu.cn/app/cli_9f9f8825d53b900d或者https://ftest.feishu.cn/admin/appCenter/manage/cli_9f9f8825d53b900d?lang=zh-CN 安装小程序 2:用户安装的服务台小程序版本过低) */ + has_access?: boolean +} + export interface ExecuteSendHelpdeskNotificationRequest { /** 发送时间戳(毫秒) */ send_at: string @@ -628,176 +807,6 @@ export interface UnsubscribeHelpdeskEventRequest { events: Event[] } -export interface AgentEmailHelpdeskAgentResponse { - /** agent emails */ - agents?: string -} - -export interface GetHelpdeskAgentSchedulesResponse { - /** schedules of an agent */ - agent_schedule?: AgentSchedule -} - -export interface ListHelpdeskAgentScheduleResponse { - /** schedule of all agent */ - agent_schedules?: AgentSchedule[] -} - -export interface CreateHelpdeskAgentSkillResponse { - agent_skill_id?: string -} - -export interface GetHelpdeskAgentSkillResponse { - /** agent skill */ - agent_skill?: AgentSkill -} - -export interface ListHelpdeskAgentSkillResponse { - /** list of agent groups */ - agent_skills?: AgentSkill[] -} - -export interface ListHelpdeskAgentSkillRuleResponse { - /** all rules for agent skill */ - rules?: AgentSkillRule[] -} - -export interface StartServiceHelpdeskTicketResponse { - /** chat id */ - chat_id: string -} - -export interface GetHelpdeskTicketResponse { - /** ticket detail */ - ticket?: Ticket -} - -export interface ListHelpdeskTicketResponse { - /** the total count */ - total?: number - tickets?: Ticket[] -} - -export interface CustomizedFieldsHelpdeskTicketResponse { - /** user customized fields */ - user_customized_fields?: UserCustomizedField[] - /** ticket customized fields */ - ticket_customized_fields?: TicketCustomizedField[] -} - -export interface CreateHelpdeskTicketMessageResponse { - /** chat消息open ID */ - message_id?: string -} - -export interface ListHelpdeskTicketMessageResponse { - /** list of ticket messages */ - messages?: TicketMessage[] - /** total number of messages */ - total?: number -} - -export interface CreateHelpdeskBotMessageResponse { - message_id?: string -} - -export interface GetHelpdeskTicketCustomizedFieldResponse { - /** ticket customized field id */ - ticket_customized_field_id: string - /** help desk id */ - helpdesk_id: string - /** key name */ - key_name: string - /** display name */ - display_name: string - /** the position of ticket customized field in the page */ - position: string - /** type of the field */ - field_type: string - /** description of the field */ - description: string - /** if the field is visible */ - visible: boolean - /** if the field is editable */ - editable: boolean - /** if the field is required */ - required: boolean - /** the time when the field is created */ - created_at?: string - /** the time when the field is updated */ - updated_at?: string - /** the user who created the ticket customized field */ - created_by?: TicketUser - /** the user who recently updated the ticket customized field */ - updated_by?: TicketUser - /** if the dropdown field supports multi-select */ - dropdown_allow_multiple?: boolean -} - -export interface CreateHelpdeskFaqResponse { - /** faq detail */ - faq?: Faq -} - -export interface GetHelpdeskFaqResponse { - /** faq detail */ - faq?: Faq -} - -export interface ListHelpdeskFaqResponse { - /** if there's next page */ - has_more?: boolean - /** the next page token */ - page_token?: string - /** the page size */ - page_size?: number - /** the total count */ - total?: number - items?: Faq[] -} - -export interface CreateHelpdeskCategoryResponse { - /** category */ - category?: Category -} - -export interface GetHelpdeskCategoryResponse { - /** category id */ - category_id: string - /** category id, for backward compatibility */ - id: string - /** category name */ - name: string - /** helpdesk id */ - helpdesk_id: string - /** category language */ - language?: string -} - -export interface ListHelpdeskCategoryResponse { - /** list of categories */ - categories?: Category[] -} - -export interface CreateHelpdeskNotificationResponse { - /** 创建成功后的唯一id */ - notification_id?: string - /** 当前状态 */ - status?: number -} - -export interface GetHelpdeskNotificationResponse { - /** push任务详情 */ - notification?: Notification - /** 审批链接 */ - approval_app_link?: string -} - -export interface SubmitApproveHelpdeskNotificationResponse { - /** 是否有权限创建或者管理审批流程 (有两种情况会导致没有权限: 1:用户没有安装服务台小程序,需要在https://app.feishu.cn/app/cli_9f9f8825d53b900d或者https://ftest.feishu.cn/admin/appCenter/manage/cli_9f9f8825d53b900d?lang=zh-CN 安装小程序 2:用户安装的服务台小程序版本过低) */ - has_access?: boolean -} - Internal.define({ '/helpdesk/v1/agents/{agent_id}': { PATCH: 'patchHelpdeskAgent', @@ -863,7 +872,7 @@ Internal.define({ }, '/helpdesk/v1/faqs': { POST: 'createHelpdeskFaq', - GET: 'listHelpdeskFaq', + GET: { name: 'listHelpdeskFaq', pagination: { argIndex: 0 } }, }, '/helpdesk/v1/faqs/{id}': { DELETE: 'deleteHelpdeskFaq', diff --git a/adapters/lark/src/types/hire.ts b/adapters/lark/src/types/hire.ts index 2410d9d4..08fcb04f 100644 --- a/adapters/lark/src/types/hire.ts +++ b/adapters/lark/src/types/hire.ts @@ -908,6 +908,11 @@ export interface ListHireLocationQuery extends Pagination { usage: 'position_location' | 'interview_location' | 'store_location' } +export interface GetHireRoleResponse { + /** 角色详情 */ + role?: RoleDetail +} + export interface ListHireUserRoleQuery extends Pagination { /** 用户 ID */ user_id?: string @@ -921,11 +926,65 @@ export interface ListHireUserRoleQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum CombinedCreateHireJobRequestExperience { + /** 不限 */ + NoLimit = 1, + /** 应届毕业生 */ + Graduate = 2, + /** 1年以下 */ + UnderOneYear = 3, + /** 1-3年 */ + OneToThreeYear = 4, + /** 3-5年 */ + ThreeToFiveYear = 5, + /** 5-7年 */ + FiveToSevenYear = 6, + /** 7-10年 */ + SevenToTenYear = 7, + /** 10年以上 */ + OverTenYear = 8, +} + +export const enum CombinedCreateHireJobRequestProcessType { + /** 社招 */ + SocialProcess = 1, + /** 校招 */ + CampusProcess = 2, +} + +export const enum CombinedCreateHireJobRequestRequiredDegree { + /** 小学及以上 */ + PrimaryEducation = 1, + /** 初中及以上 */ + JuniorMiddleSchoolEducation = 2, + /** 专职及以上 */ + Secondary = 3, + /** 高中及以上 */ + SeniorSchoolGraduates = 4, + /** 大专及以上 */ + Associate = 5, + /** 本科及以上 */ + Bachelor = 6, + /** 硕士及以上 */ + Master = 7, + /** 博士及以上 */ + Phd = 8, + /** 不限 */ + NoLimit = 20, +} + +export const enum CombinedCreateHireJobRequestJobAttribute { + /** 实体职位 */ + Concrete = 1, + /** 虚拟职位 */ + Virtual = 2, +} + export interface CombinedCreateHireJobRequest { /** 职位编号,可传入职位的「职位编号」、「职位 ID」或者「职位序号」,将以传入的参数作为职位编号,以便双方系统的数据映射 */ code?: string /** 工作年限 */ - experience?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + experience?: CombinedCreateHireJobRequestExperience /** 到期日期,请使用 */ expiry_time?: number /** 自定义字段 */ @@ -941,7 +1000,7 @@ export interface CombinedCreateHireJobRequest { /** 招聘流程,枚举通过接口「获取招聘流程信息」获取 */ job_process_id: string /** 职位流程类型 */ - process_type: 1 | 2 + process_type: CombinedCreateHireJobRequestProcessType /** 项目,枚举通过「获取项目列表」获取 */ subject_id?: string /** 职能分类,通过「获取职能分类」获取 */ @@ -967,13 +1026,13 @@ export interface CombinedCreateHireJobRequest { /** 雇佣类型 */ recruitment_type_id: string /** 学历要求 */ - required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + required_degree?: CombinedCreateHireJobRequestRequiredDegree /** 序列 */ job_category_id?: string /** 工作地点,枚举通过接口「获取地址列表」获取,选择地点用途为「职位地址」 */ address_id_list?: string[] /** 职位属性,1是实体职位,2是虚拟职位 */ - job_attribute?: 1 | 2 + job_attribute?: CombinedCreateHireJobRequestJobAttribute /** 到期日期的毫秒时间戳 */ expiry_timestamp?: string /** 面试登记表ID */ @@ -997,11 +1056,75 @@ export interface CombinedCreateHireJobQuery { job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' } +export interface CombinedCreateHireJobResponse { + /** 职位广告 */ + default_job_post?: CombinedJobResultDefaultJobPost + /** 职位 */ + job?: Job + /** 职位负责人 */ + job_manager?: JobManager + /** 面试登记表 */ + interview_registration_schema_info?: RegistrationSchemaInfo + /** 入职登记表 */ + onboard_registration_schema_info?: RegistrationSchemaInfo + /** 目标专业 */ + target_major_list?: TargetMajorInfo[] + /** 官网申请表 */ + portal_website_apply_form_schema_info?: RegistrationSchemaInfo +} + +export const enum CombinedUpdateHireJobRequestExperience { + /** 不限 */ + NoLimit = 1, + /** 应届毕业生 */ + Graduate = 2, + /** 1年以下 */ + UnderOneYear = 3, + /** 1-3年 */ + OneToThreeYear = 4, + /** 3-5年 */ + ThreeToFiveYear = 5, + /** 5-7年 */ + FiveToSevenYear = 6, + /** 7-10年 */ + SevenToTenYear = 7, + /** 10年以上 */ + OverTenYear = 8, +} + +export const enum CombinedUpdateHireJobRequestRequiredDegree { + /** 小学及以上 */ + PrimaryEducation = 1, + /** 初中及以上 */ + JuniorMiddleSchoolEducation = 2, + /** 专职及以上 */ + Secondary = 3, + /** 高中及以上 */ + SeniorSchoolGraduates = 4, + /** 大专及以上 */ + Associate = 5, + /** 本科及以上 */ + Bachelor = 6, + /** 硕士及以上 */ + Master = 7, + /** 博士及以上 */ + Phd = 8, + /** 不限 */ + NoLimit = 20, +} + +export const enum CombinedUpdateHireJobRequestJobAttribute { + /** 实体职位 */ + Concrete = 1, + /** 虚拟职位 */ + Virtual = 2, +} + export interface CombinedUpdateHireJobRequest { /** 职位 ID */ id?: string /** 工作年限 */ - experience?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + experience?: CombinedUpdateHireJobRequestExperience /** 到期日期,请使用 */ expiry_time?: number /** 自定义字段 */ @@ -1039,13 +1162,13 @@ export interface CombinedUpdateHireJobRequest { /** 最高职级,枚举通过接口「获取职级列表」获取 */ max_level_id?: string /** 学历要求 */ - required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + required_degree?: CombinedUpdateHireJobRequestRequiredDegree /** 序列 */ job_category_id?: string /** 工作地点,枚举通过接口「获取地址列表」获取,选择地点用途为「职位地址」 */ address_id_list?: string[] /** 职位属性,1是实体职位,2是虚拟职位 */ - job_attribute?: 1 | 2 + job_attribute?: CombinedUpdateHireJobRequestJobAttribute /** 到期日期的毫秒时间戳 */ expiry_timestamp?: string /** 目标专业ID List */ @@ -1063,6 +1186,17 @@ export interface CombinedUpdateHireJobQuery { job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' } +export interface CombinedUpdateHireJobResponse { + /** 职位广告 */ + default_job_post?: CombinedJobResultDefaultJobPost + /** 职位 */ + job?: Job + /** 职位负责人 */ + job_manager?: JobManager + /** 官网申请表 */ + portal_website_apply_form_schema_info?: RegistrationSchemaInfo +} + export interface UpdateConfigHireJobRequest { /** Offer 申请表,枚举通过接口「获取 Offer 申请表列表」获取 */ offer_apply_schema_id?: string @@ -1097,6 +1231,19 @@ export interface UpdateConfigHireJobQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface UpdateConfigHireJobResponse { + job_config?: JobConfigResult +} + +export const enum BatchUpdateHireJobManagerRequestUpdateOption { + /** 招聘负责人 */ + JobManager = 1, + /** 招聘协助人 */ + Assistant = 2, + /** 用人经理 */ + HireManager = 3, +} + export interface BatchUpdateHireJobManagerRequest { /** 招聘负责人 ID */ recruiter_id?: string @@ -1105,7 +1252,7 @@ export interface BatchUpdateHireJobManagerRequest { /** 用人经理 ID */ hiring_manager_id_list?: string[] /** 更新的人员类型,可选值:1=招聘负责人; 2=招聘协助人; 3=用人经理; */ - update_option_list: (1 | 2 | 3)[] + update_option_list: BatchUpdateHireJobManagerRequestUpdateOption[] /** 操作者 ID */ creator_id?: string } @@ -1115,6 +1262,11 @@ export interface BatchUpdateHireJobManagerQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchUpdateHireJobManagerResponse { + /** 职位负责人 */ + job_manager?: JobManager +} + export interface GetDetailHireJobQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' @@ -1126,6 +1278,11 @@ export interface GetDetailHireJobQuery { job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' } +export interface GetDetailHireJobResponse { + /** 职位详情数据 */ + job_detail?: JobDetail +} + export interface GetHireJobQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' @@ -1137,16 +1294,30 @@ export interface GetHireJobQuery { job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' } +export interface GetHireJobResponse { + /** 职位数据 */ + job?: Job +} + export interface RecruiterHireJobQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface RecruiterHireJobResponse { + /** 职位负责人 */ + info?: JobRecruiter2 +} + export interface ConfigHireJobQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface ConfigHireJobResponse { + job_config?: JobConfigResult +} + export interface ListHireJobQuery extends Pagination { /** 最早更新时间,毫秒级时间戳 */ update_start_time?: string @@ -1195,13 +1366,72 @@ export interface SearchHireJobPublishRecordQuery extends Pagination { job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' } +export const enum CreateHireJobRequirementRequestDisplayProgress { + /** 待启动 */ + WaitingStart = 1, + /** 进行中 */ + OnGoing = 2, + /** 已取消 */ + Canceled = 3, + /** 已暂停 */ + Suspended = 4, + /** 已完成 */ + Completed = 5, + /** 已超期 */ + Expired = 6, +} + +export const enum CreateHireJobRequirementRequestCategory { + /** 新增 */ + Addition = 1, + /** 替换 */ + Replacement = 2, +} + +export const enum CreateHireJobRequirementRequestPriority { + /** 高 */ + High = 1, + /** 中 */ + Medium = 2, + /** 低 */ + Low = 3, +} + +export const enum CreateHireJobRequirementRequestRequiredDegree { + /** 小学及以上 */ + PrimaryEducation = 1, + /** 初中及以上 */ + JuniorMiddleSchoolEducation = 2, + /** 专职及以上 */ + Secondary = 3, + /** 高中及以上 */ + SeniorSchoolGraduates = 4, + /** 大专及以上 */ + Associate = 5, + /** 本科及以上 */ + Bachelor = 6, + /** 硕士及以上 */ + Master = 7, + /** 博士及以上 */ + Phd = 8, + /** 不限 */ + NoLimit = 20, +} + +export const enum CreateHireJobRequirementRequestProcessType { + /** 社招 */ + Social = 1, + /** 校招 */ + Campus = 2, +} + export interface CreateHireJobRequirementRequest { /** 招聘需求编号 */ short_code: string /** 需求名称 */ name: string /** 需求状态 */ - display_progress: 1 | 2 | 3 | 4 | 5 | 6 + display_progress: CreateHireJobRequirementRequestDisplayProgress /** 需求人数 */ head_count: number /** 职位性质 ID */ @@ -1215,7 +1445,7 @@ export interface CreateHireJobRequirementRequest { /** 职位序列 ID */ sequence_id?: string /** 需求类型 */ - category?: 1 | 2 + category?: CreateHireJobRequirementRequestCategory /** 需求部门 ID */ department_id?: string /** 需求负责人 ID 列表 */ @@ -1229,9 +1459,9 @@ export interface CreateHireJobRequirementRequest { /** 预计完成日期,毫秒级时间戳 */ deadline?: string /** 招聘优先级 */ - priority?: 1 | 2 | 3 + priority?: CreateHireJobRequirementRequestPriority /** 学历要求 */ - required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + required_degree?: CreateHireJobRequirementRequestRequiredDegree /** 最高薪资 */ max_salary?: string /** 最低薪资 */ @@ -1243,7 +1473,7 @@ export interface CreateHireJobRequirementRequest { /** 自定义字段 */ customized_data_list?: JobRequirementCustomizedData[] /** 支持的招聘类型列表 */ - process_type?: 1 | 2 + process_type?: CreateHireJobRequirementRequestProcessType /** 招聘需求中的职位类别 */ job_type_id?: string /** 关联的职位 ID 列表 */ @@ -1267,11 +1497,74 @@ export interface CreateHireJobRequirementQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface CreateHireJobRequirementResponse { + job_requirement?: JobRequirementDto +} + +export const enum UpdateHireJobRequirementRequestDisplayProgress { + /** 待启动 */ + WaitingStart = 1, + /** 进行中 */ + OnGoing = 2, + /** 已取消 */ + Canceled = 3, + /** 已暂停 */ + Suspended = 4, + /** 已完成 */ + Completed = 5, + /** 已超期 */ + Expired = 6, +} + +export const enum UpdateHireJobRequirementRequestCategory { + /** 新增 */ + Addition = 1, + /** 替换 */ + Replacement = 2, +} + +export const enum UpdateHireJobRequirementRequestPriority { + /** 高 */ + High = 1, + /** 中 */ + Medium = 2, + /** 低 */ + Low = 3, +} + +export const enum UpdateHireJobRequirementRequestRequiredDegree { + /** 小学及以上 */ + PrimaryEducation = 1, + /** 初中及以上 */ + JuniorMiddleSchoolEducation = 2, + /** 专职及以上 */ + Secondary = 3, + /** 高中及以上 */ + SeniorSchoolGraduates = 4, + /** 大专及以上 */ + Associate = 5, + /** 本科及以上 */ + Bachelor = 6, + /** 硕士及以上 */ + Master = 7, + /** 博士及以上 */ + Phd = 8, + /** 不限 */ + NoLimit = 20, +} + +export const enum UpdateHireJobRequirementRequestProcessType { + /** 社招 */ + Social = 1, + /** 校招 */ + Campus = 2, +} + export interface UpdateHireJobRequirementRequest { /** 需求名称 */ name: string /** 需求状态 */ - display_progress: 1 | 2 | 3 | 4 | 5 | 6 + display_progress: UpdateHireJobRequirementRequestDisplayProgress /** 需求人数 */ head_count: number /** 职位性质 ID */ @@ -1285,7 +1578,7 @@ export interface UpdateHireJobRequirementRequest { /** 职位序列 ID */ sequence_id?: string /** 需求类型 */ - category?: 1 | 2 + category?: UpdateHireJobRequirementRequestCategory /** 需求部门 ID */ department_id?: string /** 需求负责人 ID 列表 */ @@ -1299,9 +1592,9 @@ export interface UpdateHireJobRequirementRequest { /** 预计完成日期,毫秒级时间戳 */ deadline?: string /** 招聘优先级 */ - priority?: 1 | 2 | 3 + priority?: UpdateHireJobRequirementRequestPriority /** 学历要求 */ - required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + required_degree?: UpdateHireJobRequirementRequestRequiredDegree /** 最高薪资 */ max_salary?: string /** 最低薪资 */ @@ -1313,7 +1606,7 @@ export interface UpdateHireJobRequirementRequest { /** 自定义字段 */ customized_data_list?: JobRequirementCustomizedData[] /** 支持的招聘类型列表 */ - process_type?: 1 | 2 + process_type?: UpdateHireJobRequirementRequestProcessType /** 招聘需求中的职位类别 */ job_type_id?: string /** 关联的职位 ID 列表 */ @@ -1357,6 +1650,11 @@ export interface ListByIdHireJobRequirementQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface ListByIdHireJobRequirementResponse { + /** 招聘需求列表 */ + items?: JobRequirementDto[] +} + export interface ListHireJobRequirementQuery extends Pagination { /** 职位ID */ job_id?: string @@ -1398,9 +1696,18 @@ export interface ListHireTalentTagQuery extends Pagination { include_inactive?: boolean } +export const enum ListHireRegistrationSchemaQueryScenario { + /** 面试登记表 */ + InterviewRegistration = 5, + /** 入职登记表 */ + OnboardRegistration = 6, + /** 人才信息登记表 */ + InfoUpdateRegistration = 14, +} + export interface ListHireRegistrationSchemaQuery extends Pagination { /** 登记表适用场景;不填表示获取全部类型信息登记表 */ - scenario?: 5 | 6 | 14 + scenario?: ListHireRegistrationSchemaQueryScenario } export interface ListHireInterviewFeedbackFormQuery extends Pagination { @@ -1413,11 +1720,23 @@ export interface ListHireInterviewRoundTypeQuery { process_type?: 1 | 2 } +export interface ListHireInterviewRoundTypeResponse { + /** 是否启用面试轮次类型 */ + active_status?: 1 | 2 + /** 列表 */ + items?: InterviewRoundType[] +} + +export const enum ListHireInterviewerQueryVerifyStatus { + NotVarified = 1, + Varified = 2, +} + export interface ListHireInterviewerQuery extends Pagination { /** 面试官userID列表 */ user_ids?: string[] /** 认证状态 */ - verify_status?: 1 | 2 + verify_status?: ListHireInterviewerQueryVerifyStatus /** 最早更新时间,毫秒时间戳 */ earliest_update_time?: string /** 最晚更新时间,毫秒时间戳 */ @@ -1436,6 +1755,11 @@ export interface PatchHireInterviewerQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface PatchHireInterviewerResponse { + /** 面试官信息 */ + interviewer?: Interviewer +} + export interface UpdateHireOfferCustomFieldRequest { /** 自定义字段名称 */ name: I18n @@ -1443,6 +1767,11 @@ export interface UpdateHireOfferCustomFieldRequest { config?: OfferCustomFieldConfig } +export interface GetHireOfferApplicationFormResponse { + /** Offer 申请表详情 */ + offer_apply_form?: OfferApplyFormInfo +} + export interface SearchHireReferralRequest { /** 人才id */ talent_id: string @@ -1457,9 +1786,21 @@ export interface SearchHireReferralQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface SearchHireReferralResponse { + /** 内推信息列表 */ + items?: ReferralInfo[] +} + +export const enum ListHireReferralWebsiteJobPostQueryProcessType { + /** 社招 */ + SocialProcess = 1, + /** 校招 */ + CampusProcess = 2, +} + export interface ListHireReferralWebsiteJobPostQuery extends Pagination { /** 招聘流程类型 */ - process_type?: 1 | 2 + process_type?: ListHireReferralWebsiteJobPostQueryProcessType /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' /** 此次调用中使用的部门 ID 的类型 */ @@ -1477,6 +1818,10 @@ export interface GetHireReferralWebsiteJobPostQuery { job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' } +export interface GetHireReferralWebsiteJobPostResponse { + job_post?: PortalJobPost +} + export interface GetByApplicationHireReferralQuery { /** 投递的 ID */ application_id: string @@ -1484,16 +1829,43 @@ export interface GetByApplicationHireReferralQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface GetByApplicationHireReferralResponse { + /** 内推信息 */ + referral?: Referral +} + export interface CreateHireWebsiteChannelRequest { /** 推广渠道名称 */ channel_name: string } +export interface CreateHireWebsiteChannelResponse { + /** 推广渠道 ID */ + id?: string + /** 推广渠道名称 */ + name?: string + /** 推广渠道链接 */ + link?: string + /** 推广渠道推广码 */ + code?: string +} + export interface UpdateHireWebsiteChannelRequest { /** 推广渠道名称 */ channel_name: string } +export interface UpdateHireWebsiteChannelResponse { + /** 推广渠道 ID */ + id?: string + /** 推广渠道名称 */ + name?: string + /** 推广渠道链接 */ + link?: string + /** 推广渠道推广码 */ + code?: string +} + export interface CreateHireWebsiteSiteUserRequest { /** 姓名 */ name?: string @@ -1507,6 +1879,10 @@ export interface CreateHireWebsiteSiteUserRequest { mobile_country_code?: string } +export interface CreateHireWebsiteSiteUserResponse { + site_user?: WebsiteUser +} + export interface GetHireWebsiteJobPostQuery { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -1516,6 +1892,10 @@ export interface GetHireWebsiteJobPostQuery { job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' } +export interface GetHireWebsiteJobPostResponse { + job_post?: WebsiteJobPost +} + export interface SearchHireWebsiteJobPostRequest { /** 职位类型列表 */ job_type_id_list?: string[] @@ -1581,6 +1961,10 @@ export interface CreateByResumeHireWebsiteDeliveryQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateByResumeHireWebsiteDeliveryResponse { + delivery?: WebsiteDeliveryDto +} + export interface CreateByAttachmentHireWebsiteDeliveryRequest { /** 职位广告 ID */ job_post_id: string @@ -1602,6 +1986,22 @@ export interface CreateByAttachmentHireWebsiteDeliveryRequest { identification?: WebsiteDeliveryAttachmentIndentification } +export interface CreateByAttachmentHireWebsiteDeliveryResponse { + /** 异步任务 ID */ + task_id?: string +} + +export interface GetHireWebsiteDeliveryTaskResponse { + /** 任务状态 */ + status?: 0 | 1 | 2 | 3 + /** 官网投递信息 */ + delivery?: WebsiteDeliveryDto + /** 状态信息,仅 status 为 3 时返回 */ + status_msg?: string + /** 附加信息,当前返回投递 ID,仅当 status 为 3 且 status_msg 标识为重复投递时,将返回重复投递的 ID */ + extra_info?: string +} + export interface ProtectHireAgencyRequest { /** 人才ID */ talent_id: string @@ -1631,11 +2031,27 @@ export interface GetHireAgencyQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface GetHireAgencyResponse { + /** 数据 */ + agency?: Agency +} + export interface ProtectSearchHireAgencyRequest { /** 人才id */ talent_id: string } +export interface ProtectSearchHireAgencyResponse { + /** 是否已入职 */ + is_onboarded?: boolean + /** 是否在猎头保护期内入职 */ + onboarded_in_protection?: boolean + /** 入职所在保护期 */ + onboarded_protection?: AgencyProtection + /** 人才保护信息 */ + protection_list?: AgencyProtection[] +} + export interface QueryHireAgencyQuery { /** 猎头供应商名称 */ name: string @@ -1643,13 +2059,33 @@ export interface QueryHireAgencyQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface QueryHireAgencyResponse { + items?: Agency[] +} + +export const enum GetAgencyAccountHireAgencyRequestStatus { + /** 正常 */ + Normal = 0, + /** 已禁用 */ + Enabled = 1, + /** 已被猎头停用 */ + DisabledBySupplier = 2, +} + +export const enum GetAgencyAccountHireAgencyRequestRole { + /** 管理员 */ + Manager = 0, + /** 顾问 */ + Consultant = 1, +} + export interface GetAgencyAccountHireAgencyRequest { /** 猎头供应商 ID */ supplier_id: string /** 猎头状态 */ - status?: 0 | 1 | 2 + status?: GetAgencyAccountHireAgencyRequestStatus /** 角色 */ - role?: 0 | 1 + role?: GetAgencyAccountHireAgencyRequestRole } export interface GetAgencyAccountHireAgencyQuery extends Pagination { @@ -1671,9 +2107,16 @@ export interface BatchQueryHireAgencyQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum OperateAgencyAccountHireAgencyRequestOption { + /** 禁用 */ + Add = 1, + /** 取消禁用 */ + Remove = 2, +} + export interface OperateAgencyAccountHireAgencyRequest { /** 操作类型 */ - option: 1 | 2 + option: OperateAgencyAccountHireAgencyRequestOption /** 猎头 ID */ id: string /** 禁用原因,仅当禁用操作时,必填 */ @@ -1685,16 +2128,44 @@ export interface CreateHireTalentExternalInfoRequest { external_create_time: string } +export interface CreateHireTalentExternalInfoResponse { + /** 人才外部信息 */ + external_info?: TalentExternalInfo +} + export interface UpdateHireTalentExternalInfoRequest { /** 人才在外部系统创建时间 */ external_create_time: string } +export interface UpdateHireTalentExternalInfoResponse { + /** 人才外部信息 */ + external_info?: TalentExternalInfo +} + +export const enum CreateHireExternalApplicationRequestJobRecruitmentType { + /** 社招 */ + SocialRecruitment = 1, + /** 校招 */ + CampusRecruitment = 2, +} + +export const enum CreateHireExternalApplicationRequestDeliveryType { + /** HR 寻访 */ + HRVisit = 1, + /** 候选人主动投递 */ + CandidateDelivery = 2, + /** 人才推荐 */ + TalentRecommend = 3, + /** 其他 */ + Others = 4, +} + export interface CreateHireExternalApplicationRequest { /** 外部系统背调主键 (仅用于幂等) */ external_id?: string /** 职位招聘类型 */ - job_recruitment_type?: 1 | 2 + job_recruitment_type?: CreateHireExternalApplicationRequestJobRecruitmentType /** 职位名称 */ job_title?: string /** 简历来源 */ @@ -1706,7 +2177,7 @@ export interface CreateHireExternalApplicationRequest { /** 终止原因 */ termination_reason?: string /** 投递类型 */ - delivery_type?: 1 | 2 | 3 | 4 + delivery_type?: CreateHireExternalApplicationRequestDeliveryType /** 更新时间,招聘系统内用作投递在外部系统终止时间 */ modify_time?: number /** 投递在外部系统创建时间 */ @@ -1715,9 +2186,31 @@ export interface CreateHireExternalApplicationRequest { termination_type?: string } +export interface CreateHireExternalApplicationResponse { + external_application?: ExternalApplication +} + +export const enum UpdateHireExternalApplicationRequestJobRecruitmentType { + /** 社招 */ + SocialRecruitment = 1, + /** 校招 */ + CampusRecruitment = 2, +} + +export const enum UpdateHireExternalApplicationRequestDeliveryType { + /** HR 寻访 */ + HRVisit = 1, + /** 候选人主动投递 */ + CandidateDelivery = 2, + /** 人才推荐 */ + TalentRecommend = 3, + /** 其他 */ + Others = 4, +} + export interface UpdateHireExternalApplicationRequest { /** 职位招聘类型 */ - job_recruitment_type?: 1 | 2 + job_recruitment_type?: UpdateHireExternalApplicationRequestJobRecruitmentType /** 职位名称 */ job_title?: string /** 简历来源 */ @@ -1727,7 +2220,7 @@ export interface UpdateHireExternalApplicationRequest { /** 终止原因 */ termination_reason?: string /** 投递类型 */ - delivery_type?: 1 | 2 | 3 | 4 + delivery_type?: UpdateHireExternalApplicationRequestDeliveryType /** 更新时间,招聘系统内用作投递在外部系统终止时间 */ modify_time?: number /** 投递在外部系统创建时间 */ @@ -1736,6 +2229,10 @@ export interface UpdateHireExternalApplicationRequest { termination_type?: string } +export interface UpdateHireExternalApplicationResponse { + external_application?: ExternalApplication +} + export interface ListHireExternalApplicationQuery extends Pagination { /** 人才ID */ talent_id: string @@ -1746,13 +2243,26 @@ export interface DeleteHireExternalApplicationQuery { talent_id?: string } +export interface DeleteHireExternalApplicationResponse { + external_application?: ExternalApplication +} + +export const enum CreateHireExternalInterviewRequestParticipateStatus { + /** 未参与 */ + NotStart = 1, + /** 参与 */ + Participated = 2, + /** 爽约 */ + NotPaticipated = 3, +} + export interface CreateHireExternalInterviewRequest { /** 外部系统面试主键 (仅用于幂等) */ external_id?: string /** 外部投递 ID */ external_application_id: string /** 参与状态 */ - participate_status?: 1 | 2 | 3 + participate_status?: CreateHireExternalInterviewRequestParticipateStatus /** 开始时间 */ begin_time?: number /** 结束时间 */ @@ -1761,11 +2271,24 @@ export interface CreateHireExternalInterviewRequest { interview_assessments?: ExternalInterviewAssessment[] } +export interface CreateHireExternalInterviewResponse { + external_interview?: ExternalInterview +} + +export const enum UpdateHireExternalInterviewRequestParticipateStatus { + /** 未参与 */ + NotStart = 1, + /** 参与 */ + Participated = 2, + /** 爽约 */ + NotPaticipated = 3, +} + export interface UpdateHireExternalInterviewRequest { /** 外部投递 ID */ external_application_id: string /** 参与状态 */ - participate_status?: 1 | 2 | 3 + participate_status?: UpdateHireExternalInterviewRequestParticipateStatus /** 开始时间 */ begin_time?: number /** 结束时间 */ @@ -1774,6 +2297,10 @@ export interface UpdateHireExternalInterviewRequest { interview_assessments?: ExternalInterviewAssessment[] } +export interface UpdateHireExternalInterviewResponse { + external_interview?: ExternalInterview +} + export interface BatchQueryHireExternalInterviewRequest { /** 外部面试 ID列表,当传递此值时,以此值为准 */ external_interview_id_list?: string[] @@ -1784,13 +2311,22 @@ export interface BatchQueryHireExternalInterviewQuery extends Pagination { external_application_id?: string } +export const enum CreateHireExternalInterviewAssessmentRequestConclusion { + /** 不通过 */ + Fail = 1, + /** 通过 */ + Pass = 2, + /** 待定 */ + ToBeDetermined = 3, +} + export interface CreateHireExternalInterviewAssessmentRequest { /** 外部系统面评主键(仅用于幂等) */ external_id?: string /** 面试官姓名 */ username?: string /** 面试结果 */ - conclusion?: 1 | 2 | 3 + conclusion?: CreateHireExternalInterviewAssessmentRequestConclusion /** 评价维度列表 */ assessment_dimension_list?: ExternalInterviewAssessmentDimension[] /** 综合记录 */ @@ -1799,17 +2335,34 @@ export interface CreateHireExternalInterviewAssessmentRequest { external_interview_id?: string } +export interface CreateHireExternalInterviewAssessmentResponse { + external_interview_assessment?: ExternalInterviewAssessment +} + +export const enum PatchHireExternalInterviewAssessmentRequestConclusion { + /** 不通过 */ + Fail = 1, + /** 通过 */ + Pass = 2, + /** 待定 */ + ToBeDetermined = 3, +} + export interface PatchHireExternalInterviewAssessmentRequest { /** 面试官姓名 */ username?: string /** 面试结果 */ - conclusion?: 1 | 2 | 3 + conclusion?: PatchHireExternalInterviewAssessmentRequestConclusion /** 评价维度列表 */ assessment_dimension_list?: ExternalInterviewAssessmentDimension[] /** 综合记录 */ content?: string } +export interface PatchHireExternalInterviewAssessmentResponse { + external_interview_assessment?: ExternalInterviewAssessment +} + export interface CreateHireExternalOfferRequest { /** 外部系统 Offer 主键(仅用于幂等) */ external_id?: string @@ -1825,6 +2378,10 @@ export interface CreateHireExternalOfferRequest { attachment_id_list?: string[] } +export interface CreateHireExternalOfferResponse { + external_offer?: ExternalOffer +} + export interface UpdateHireExternalOfferRequest { /** 外部投递 ID */ external_application_id: string @@ -1838,6 +2395,10 @@ export interface UpdateHireExternalOfferRequest { attachment_id_list?: string[] } +export interface UpdateHireExternalOfferResponse { + external_offer?: ExternalOffer +} + export interface BatchQueryHireExternalOfferRequest { /** 外部 Offer ID列表,当传递此值时,以此值为准 */ external_offer_id_list?: string[] @@ -1863,6 +2424,10 @@ export interface CreateHireExternalBackgroundCheckRequest { attachment_id_list?: string[] } +export interface CreateHireExternalBackgroundCheckResponse { + external_background_check?: ExternalBackgroundCheck +} + export interface UpdateHireExternalBackgroundCheckRequest { /** 外部投递 ID */ external_application_id: string @@ -1876,6 +2441,10 @@ export interface UpdateHireExternalBackgroundCheckRequest { attachment_id_list?: string[] } +export interface UpdateHireExternalBackgroundCheckResponse { + external_background_check?: ExternalBackgroundCheck +} + export interface BatchQueryHireExternalBackgroundCheckRequest { /** 外部背调 ID 列表,当传递此值时,以此值为准 */ external_background_check_id_list?: string[] @@ -1886,6 +2455,28 @@ export interface BatchQueryHireExternalBackgroundCheckQuery extends Pagination { external_application_id?: string } +export const enum CreateHireExternalReferralRewardRequestRuleType { + /** 入职奖励,候选人入职或转正后产生的奖励 */ + Onboard = 1, + /** 过程奖励,入职奖励外,若候选人有阶段性进展,则给予内推人对应的奖励 */ + Processe = 2, + /** 活动奖励,额外奖励,用于支持内推周期性活动 */ + Active = 3, + /** 开源奖励,若内推候选人首次进入人才库,且在被推荐后一段时间内,入职了规则内的任意职位的奖励 */ + OpenSource = 4, + /** 其他奖励,以上奖励无法覆盖的奖励 */ + Other = 5, +} + +export const enum CreateHireExternalReferralRewardRequestStage { + /** 待确认 */ + ToBeConfirmed = 1, + /** 已确认 */ + Confirmed = 2, + /** 已发放 */ + Paid = 3, +} + export interface CreateHireExternalReferralRewardRequest { /** 内推人ID */ referral_user_id: string @@ -1906,11 +2497,11 @@ export interface CreateHireExternalReferralRewardRequest { /** 奖励原因 */ reason?: string /** 导入的奖励规则类型,将展示在内推奖励明细中,管理员与内推人可见 */ - rule_type: 1 | 2 | 3 | 4 | 5 + rule_type: CreateHireExternalReferralRewardRequestRuleType /** 奖励数据 */ bonus: BonusAmount /** 导入的内推奖励状态 */ - stage: 1 | 2 | 3 + stage: CreateHireExternalReferralRewardRequestStage /** 奖励产生时间,内推奖励触发时间,若未传入,取接口传入时间 */ create_time?: string /** 奖励确认时间,若导入的「内推奖励状态」为「已确认」可传入,若未传入,取接口传入时间 */ @@ -1930,11 +2521,23 @@ export interface CreateHireExternalReferralRewardQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateHireExternalReferralRewardResponse { + /** 创建的内推奖励的id */ + id?: string +} + +export const enum BatchChangeTalentPoolHireTalentPoolRequestOptionType { + /** 加入人才库操作 */ + Add = 1, + /** 从指定人才库移除 */ + Remove = 2, +} + export interface BatchChangeTalentPoolHireTalentPoolRequest { /** 人才 ID 列表 */ talent_id_list: string[] /** 操作类型 */ - option_type: 1 | 2 + option_type: BatchChangeTalentPoolHireTalentPoolRequestOptionType } export interface SearchHireTalentPoolQuery extends Pagination { @@ -1942,11 +2545,25 @@ export interface SearchHireTalentPoolQuery extends Pagination { id_list?: string[] } +export const enum MoveTalentHireTalentPoolRequestAddType { + /** 仅加入指定人才库 */ + OnlyAdd = 1, + /** 加入指定人才库并从所有原库移除 */ + AddAndRemoveFromOrigin = 2, +} + export interface MoveTalentHireTalentPoolRequest { /** 人才ID */ talent_id: string /** 操作类型 */ - add_type: 1 | 2 + add_type: MoveTalentHireTalentPoolRequestAddType +} + +export interface MoveTalentHireTalentPoolResponse { + /** 人才库ID */ + talent_pool_id?: string + /** 人才ID */ + talent_id?: string } export interface TagHireTalentRequest { @@ -1998,6 +2615,15 @@ export interface CombinedCreateHireTalentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface CombinedCreateHireTalentResponse { + /** 人才 ID */ + talent_id?: string + /** 创建人 ID */ + creator_id?: string + /** 创建人类型 */ + creator_account_type?: 1 | 3 +} + export interface CombinedUpdateHireTalentRequest { /** 人才 ID */ talent_id: string @@ -2040,6 +2666,15 @@ export interface CombinedUpdateHireTalentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface CombinedUpdateHireTalentResponse { + /** 人才 ID */ + talent_id?: string + /** 更新人 ID */ + operator_id?: string + /** 更新人类型 */ + operator_account_type?: 1 | 3 +} + export interface AddToFolderHireTalentRequest { /** 人才 ID 列表 */ talent_id_list: string[] @@ -2047,6 +2682,13 @@ export interface AddToFolderHireTalentRequest { folder_id: string } +export interface AddToFolderHireTalentResponse { + /** 人才 ID 列表 */ + talent_id_list?: string[] + /** 文件夹 ID */ + folder_id?: string +} + export interface RemoveToFolderHireTalentRequest { /** 人才 ID 列表 */ talent_id_list: string[] @@ -2054,6 +2696,13 @@ export interface RemoveToFolderHireTalentRequest { folder_id: string } +export interface RemoveToFolderHireTalentResponse { + /** 人才 ID 列表 */ + talent_id_list?: string[] + /** 文件夹 ID */ + folder_id?: string +} + export interface ListHireTalentFolderQuery extends Pagination { /** 用户ID类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' @@ -2072,6 +2721,11 @@ export interface BatchGetIdHireTalentRequest { identification_number_list?: string[] } +export interface BatchGetIdHireTalentResponse { + /** 人才信息列表 */ + talent_list?: TalentBatchInfo[] +} + export interface ListHireTalentQuery extends Pagination { /** 搜索关键词,支持布尔语言(使用 and、or、not 连接关键词) */ keyword?: string @@ -2087,30 +2741,108 @@ export interface ListHireTalentQuery extends Pagination { query_option?: 'ignore_empty_error' } +export interface QueryHireTalentObjectResponse { + items?: CommonSchema[] +} + export interface GetHireTalentQuery { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface GetHireTalentResponse { + /** 人才信息 */ + talent?: Talent +} + export interface GetHireTalentQuery { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface GetHireTalentResponse { + /** ID */ + talent_id?: string + /** 基础信息 */ + basic_info?: CompositeTalentBasicInfo + /** 教育经历 */ + education_list?: CompositeTalentEducationInfo[] + /** 工作经历 */ + career_list?: CompositeTalentCareerInfo[] + /** 项目经历 */ + project_list?: CompositeTalentProjectInfo[] + /** 作品集 */ + works_list?: CompositeTalentWorksInfo[] + /** 获奖列表 */ + award_list?: CompositeTalentAwardInfo[] + /** 语言列表 */ + language_list?: CompositeTalentLanguageInfo[] + /** SNS列表 */ + sns_list?: CompositeTalentSnsInfo[] + /** 简历来源 */ + resume_source_list?: TalentResumeSource[] + /** 实习经历 */ + internship_list?: CompositeTalentInternshipInfo[] + /** 自定义字段 */ + customized_data_list?: CompositeTalentCustomizedData[] + /** 简历附件id列表(按照简历创建时间降序)(废弃,请使用resume_attachment_list代替) */ + resume_attachment_id_list?: string[] + /** 简历附件列表(按照简历创建时间降序) */ + resume_attachment_list?: TalentResumeAttachment[] + /** 面试登记表 */ + interview_registration_list?: TalentInterviewRegistrationSimple[] + /** 登记表列表 */ + registration_list?: RegistrationBasicInfo[] + /** 是否已入职 */ + is_onboarded?: boolean + /** 是否在猎头保护期 */ + is_in_agency_period?: boolean + /** 最高学历 参考 DegreeType 枚举 */ + top_degree?: number + /** 人才已加入的人才库列表 */ + talent_pool_id_list?: string[] + /** 文件夹列表 */ + talent_folder_ref_list_v2?: TalentFolder[] + /** 标签列表 */ + tag_list?: TalentTag[] + /** 相似人才信息 */ + similar_info_v2?: TalentSimilar + /** 人才黑名单详情 */ + block_info?: TalentBlock + /** 人才已经加入的人才库列表 */ + talent_pool_ref_list_v2?: TalentPool[] + /** 备注列表 */ + note_list_v2?: TalentNote[] +} + +export const enum OnboardStatusHireTalentRequestOperation { + /** 入职 */ + Onboard = 1, + /** 离职 */ + Overboard = 2, +} + export interface OnboardStatusHireTalentRequest { /** 操作类型 1:入职 2:离职 */ - operation: 1 | 2 + operation: OnboardStatusHireTalentRequestOperation /** 毫秒时间戳 */ onboard_time?: string /** 毫秒时间戳 */ overboard_time?: string } +export const enum ChangeTalentBlockHireTalentBlocklistRequestOption { + /** 加入屏蔽名单操作 */ + Add = 1, + /** 从屏蔽名单中移除 */ + Remove = 2, +} + export interface ChangeTalentBlockHireTalentBlocklistRequest { /** 人才 ID */ talent_id: string /** 操作类型 */ - option: 1 | 2 + option: ChangeTalentBlockHireTalentBlocklistRequestOption /** 原因,当执行加入屏蔽名单操作时必填 */ reason?: string } @@ -2130,6 +2862,11 @@ export interface GetDetailHireApplicationQuery { options?: ('with_job' | 'with_talent' | 'with_interview' | 'with_offer' | 'with_evaluation' | 'with_employee' | 'with_agency' | 'with_referral' | 'with_portal')[] } +export interface GetDetailHireApplicationResponse { + /** 投递详情 */ + application_detail?: ApplicationDetailInfo +} + export interface CreateHireApplicationRequest { /** 人才ID */ talent_id: string @@ -2148,6 +2885,11 @@ export interface CreateHireApplicationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateHireApplicationResponse { + /** 投递ID */ + id?: string +} + export interface TerminateHireApplicationRequest { /** 终止原因的类型 */ termination_type: 1 | 22 | 27 @@ -2169,6 +2911,11 @@ export interface GetHireApplicationQuery { options?: ('get_latest_application_on_chain')[] } +export interface GetHireApplicationResponse { + /** 投递数据 */ + application?: Application +} + export interface ListHireApplicationQuery extends Pagination { /** 按流程过滤,招聘流程 ID,枚举值通过接口「获取招聘流程信息」接口获取 */ process_id?: string @@ -2195,6 +2942,11 @@ export interface SearchHireDiversityInclusionRequest { application_ids?: string[] } +export interface SearchHireDiversityInclusionResponse { + /** 多元化与包容性信息列表 */ + items?: DiInfo[] +} + export interface ListHireEvaluationQuery extends Pagination { /** 投递 ID */ application_id?: string @@ -2224,6 +2976,23 @@ export interface CreateHireExamQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface CreateHireExamResponse { + /** 笔试 ID */ + exam_id?: string + /** 投递 ID */ + application_id?: string + /** 试卷名称 */ + exam_resource_name?: string + /** 笔试分数 */ + score?: number + /** 附件ID */ + uuid?: string + /** 操作人 ID */ + operator_id?: string + /** 操作时间 */ + operate_time?: string +} + export interface SearchHireTestRequest { /** 投递 ID 列表,最多 100 个,默认查询全部投递 */ application_id_list?: string[] @@ -2262,16 +3031,30 @@ export interface GetByTalentHireInterviewQuery { job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' } +export interface GetByTalentHireInterviewResponse { + /** 投递面试列表 */ + items?: TalentInterview[] +} + export interface GetHireInterviewRecordQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetHireInterviewRecordResponse { + /** 数据 */ + interview_record?: InterviewRecord +} + export interface GetHireInterviewRecordQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetHireInterviewRecordResponse { + interview_record?: InterviewRecord +} + export interface ListHireInterviewRecordQuery extends Pagination { /** 面试评价ID列表,使用该筛选项时不会分页 */ ids?: string[] @@ -2286,13 +3069,25 @@ export interface ListHireInterviewRecordQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum GetHireInterviewRecordAttachmentQueryLanguage { + /** 中文 */ + Zh = 1, + /** 英文 */ + En = 2, +} + export interface GetHireInterviewRecordAttachmentQuery { /** 投递 ID */ application_id: string /** 面试记录 ID */ interview_record_id?: string /** 面试记录语言 */ - language?: 1 | 2 + language?: GetHireInterviewRecordAttachmentQueryLanguage +} + +export interface GetHireInterviewRecordAttachmentResponse { + /** 附件信息 */ + attachment?: AttachmentInfo } export interface GetHireMinutesQuery extends Pagination { @@ -2300,6 +3095,14 @@ export interface GetHireMinutesQuery extends Pagination { interview_id: string } +export interface GetHireMinutesResponse { + minutes?: Minutes + /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ + page_token?: string + /** 对应面试是否还有更多项 */ + has_more?: boolean +} + export interface ListHireQuestionnaireQuery extends Pagination { /** 投递 ID */ application_id?: string @@ -2339,6 +3142,23 @@ export interface CreateHireOfferQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface CreateHireOfferResponse { + /** Offer ID */ + offer_id?: string + /** 投递 ID */ + application_id?: string + /** 模板 ID */ + schema_id?: string + /** Offer 类型 */ + offer_type?: 1 | 2 + /** Offer 基本信息 */ + basic_info?: OfferBasicInfo + /** Offer 薪资信息 */ + salary_info?: OfferSalaryInfo + /** 自定义信息 */ + customized_info_list?: OfferCustomizedInfo[] +} + export interface UpdateHireOfferRequest { /** 模板 ID */ schema_id: string @@ -2363,6 +3183,19 @@ export interface UpdateHireOfferQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface UpdateHireOfferResponse { + /** Offer ID */ + offer_id?: string + /** 模板 ID */ + schema_id?: string + /** Offer 基本信息 */ + basic_info?: OfferBasicInfo + /** Offer 薪资信息 */ + salary_info?: OfferSalaryInfo + /** 自定义信息 */ + customized_info_list?: OfferCustomizedInfo[] +} + export interface OfferHireApplicationQuery { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -2376,6 +3209,10 @@ export interface OfferHireApplicationQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface OfferHireApplicationResponse { + offer?: ApplicationOffer +} + export interface GetHireOfferQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' @@ -2389,6 +3226,11 @@ export interface GetHireOfferQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface GetHireOfferResponse { + /** Offer 详情 */ + offer?: Offer +} + export interface ListHireOfferQuery extends Pagination { /** 人才 ID */ talent_id: string @@ -2398,9 +3240,30 @@ export interface ListHireOfferQuery extends Pagination { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export const enum OfferStatusHireOfferRequestOfferStatus { + /** Offer 审批中 */ + Approving = 2, + /** Offer 审批已撤回 */ + Withdrawn = 3, + /** Offer 审批通过 */ + Approved = 4, + /** Offer 审批不通过 */ + Rejected = 5, + /** Offer 已发出 */ + OfferLetterSent = 6, + /** Offer 被候选人接受 */ + OfferAccepted = 7, + /** Offer 被候选人拒绝 */ + OfferRejected = 8, + /** Offer 已失效 */ + Obsolete = 9, + /** Offer 已创建 */ + NoApproval = 10, +} + export interface OfferStatusHireOfferRequest { /** offer状态 */ - offer_status: 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 + offer_status: OfferStatusHireOfferRequestOfferStatus /** offer 失效时间,当反馈状态是「offer已发出」时为必填项 */ expiration_date?: string /** 终止原因列表,当反馈状态是「候选人已拒绝」时为必填项;最多传入50个 */ @@ -2418,6 +3281,17 @@ export interface InternOfferStatusHireOfferRequest { offboarding_info?: InternOfferOffboardingInfo } +export interface InternOfferStatusHireOfferResponse { + /** Offer ID */ + offer_id?: string + /** 更新入/离职状态的操作 */ + operation: 'confirm_onboarding' | 'cancel_onboarding' | 'offboard' + /** 入职表单信息(当 operation 为 confirm_onboarding 时,该字段必填) */ + onboarding_info?: InternOfferOnboardingInfo + /** 离职表单信息(当 operation 为 offboard 时,该字段必填) */ + offboarding_info?: InternOfferOffboardingInfo +} + export interface ListHireBackgroundCheckOrderQuery extends Pagination { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -2429,15 +3303,41 @@ export interface ListHireBackgroundCheckOrderQuery extends Pagination { update_end_time?: string } +export const enum CreateHireTripartiteAgreementRequestState { + /** 未开始 */ + NotStarted = 1, + /** 已申请 */ + Applied = 2, + /** 学生处理中 */ + StudentProcessing = 3, + /** 公司处理中 */ + CompanyProcessing = 4, + /** 学校处理中 */ + SchoolProcessing = 5, + /** 已终止 */ + Ended = 6, + /** 已完成 */ + Completed = 7, + /** 解约处理中 */ + TerminationProcessing = 8, + /** 已解约 */ + Terminated = 9, +} + export interface CreateHireTripartiteAgreementRequest { /** 投递ID */ application_id: string /** 三方协议状态 */ - state: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + state: CreateHireTripartiteAgreementRequestState /** 三方协议创建时间,毫秒时间戳 */ create_time: string } +export interface CreateHireTripartiteAgreementResponse { + /** 创建的三方协议的 id */ + id?: string +} + export interface ListHireTripartiteAgreementQuery extends Pagination { /** 投递 ID,必填投递 id 与三方协议 ID 其中之一 */ application_id?: string @@ -2445,13 +3345,39 @@ export interface ListHireTripartiteAgreementQuery extends Pagination { tripartite_agreement_id?: string } +export const enum UpdateHireTripartiteAgreementRequestState { + /** 未开始 */ + NotStarted = 1, + /** 已申请 */ + Applied = 2, + /** 学生处理中 */ + StudentProcessing = 3, + /** 公司处理中 */ + CompanyProcessing = 4, + /** 学校处理中 */ + SchoolProcessing = 5, + /** 已终止 */ + Ended = 6, + /** 已完成 */ + Completed = 7, + /** 解约处理中 */ + TerminationProcessing = 8, + /** 已解约 */ + Terminated = 9, +} + export interface UpdateHireTripartiteAgreementRequest { /** 三方协议状态 */ - state: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + state: UpdateHireTripartiteAgreementRequestState /** 三方协议修改时间戳,不可小于创建时间或者当前修改时间 */ modify_time: string } +export interface UpdateHireTripartiteAgreementResponse { + /** 三方协议信息 */ + tripartite_agreement?: TripartiteAgreementInfo +} + export interface PatchHireEhrImportTaskRequest { /** 失败原因 */ fail_reason?: string @@ -2497,9 +3423,21 @@ export interface TransferOnboardHireApplicationQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface TransferOnboardHireApplicationResponse { + /** employee */ + employee?: Employee +} + +export const enum PatchHireEmployeeRequestOperation { + /** 转正 */ + Convert = 1, + /** 离职 */ + Overboard = 2, +} + export interface PatchHireEmployeeRequest { /** 修改状态操作 */ - operation: 1 | 2 + operation: PatchHireEmployeeRequestOperation conversion_info?: EmployeeConversionInfo overboard_info?: EmployeeOverboardInfo } @@ -2517,6 +3455,11 @@ export interface PatchHireEmployeeQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface PatchHireEmployeeResponse { + /** 员工信息 */ + employee?: Employee +} + export interface GetByApplicationHireEmployeeQuery { /** 投递ID */ application_id: string @@ -2532,6 +3475,11 @@ export interface GetByApplicationHireEmployeeQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface GetByApplicationHireEmployeeResponse { + /** 员工信息 */ + employee?: Employee +} + export interface GetHireEmployeeQuery { /** 用户 ID 类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -2545,6 +3493,11 @@ export interface GetHireEmployeeQuery { employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' } +export interface GetHireEmployeeResponse { + /** 员工信息 */ + employee?: Employee +} + export interface ListHireTodoQuery extends Pagination { /** 用户 ID,当 token 为租户 token 时,必须传入该字段,当 token 为用户 token 时,不传该字段 */ user_id?: string @@ -2581,6 +3534,13 @@ export interface ListHireInterviewTaskQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export const enum CreateHireNoteRequestPrivacy { + /** 私密 */ + Private = 1, + /** 公开 */ + Public = 2, +} + export interface CreateHireNoteRequest { /** 人才ID */ talent_id: string @@ -2591,7 +3551,7 @@ export interface CreateHireNoteRequest { /** 内容 */ content: string /** 备注私密属性(默认为公开) */ - privacy?: 1 | 2 + privacy?: CreateHireNoteRequestPrivacy /** 是否通知被@的用户 */ notify_mentioned_user?: boolean /** 被@用户列表 */ @@ -2603,6 +3563,10 @@ export interface CreateHireNoteQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface CreateHireNoteResponse { + note?: Note +} + export interface PatchHireNoteRequest { /** 备注内容 */ content: string @@ -2619,11 +3583,21 @@ export interface PatchHireNoteQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface PatchHireNoteResponse { + /** 备注数据 */ + note?: Note +} + export interface GetHireNoteQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface GetHireNoteResponse { + /** 备注数据 */ + note?: Note +} + export interface ListHireNoteQuery extends Pagination { /** 人才ID */ talent_id: string @@ -2786,6 +3760,11 @@ export interface EnableHireReferralAccountQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface EnableHireReferralAccountResponse { + /** 账号信息 */ + account?: Account +} + export interface GetAccountAssetsHireReferralAccountQuery { /** 账户 ID */ referral_account_id: string @@ -2793,6 +3772,11 @@ export interface GetAccountAssetsHireReferralAccountQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetAccountAssetsHireReferralAccountResponse { + /** 账户信息 */ + account?: Account +} + export interface CreateHireReferralAccountRequest { /** 电话 */ mobile?: Mobile @@ -2805,18 +3789,44 @@ export interface CreateHireReferralAccountQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateHireReferralAccountResponse { + /** 账号信息 */ + account?: Account +} + export interface DeactivateHireReferralAccountQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface DeactivateHireReferralAccountResponse { + /** 账号信息 */ + account?: Account +} + +export const enum WithdrawHireReferralAccountRequestWithdrawBonusType { + /** 积分 */ + Point = 1, + /** 现金 */ + Cash = 2, +} + export interface WithdrawHireReferralAccountRequest { /** 请求提现的奖励类型 */ - withdraw_bonus_type: (1 | 2)[] + withdraw_bonus_type: WithdrawHireReferralAccountRequestWithdrawBonusType[] /** 提现单ID,请求时由请求方提供,后续关于本次提现操作的交互都以此提现单ID为标识进行,需要保证唯一,用于保证提现的幂等性,传入重复ID会返回对应提现单提取的金额明细 */ external_order_id: string } +export interface WithdrawHireReferralAccountResponse { + /** 请求时传入的提现单ID */ + external_order_id?: string + /** 交易时间戳,需要保存,用于统一交易时间,方便对账 */ + trans_time?: string + /** 本次提现金额明细 */ + withdrawal_details?: BonusAmount +} + export interface ReconciliationHireReferralAccountRequest { /** 按时间范围进行对账时 时间段的起始交易时间 */ start_trans_time: string @@ -2826,11 +3836,31 @@ export interface ReconciliationHireReferralAccountRequest { trade_details?: TradeDetail[] } +export interface ReconciliationHireReferralAccountResponse { + /** 核对失败的信息 */ + check_failed_list?: CheckFailedAccountInfo[] +} + +export interface CreateHireAttachmentResponse { + /** 上传文件的 id */ + id?: string +} + export interface GetHireAttachmentQuery { /** 附件类型 */ type?: 1 | 2 | 3 } +export interface GetHireAttachmentResponse { + /** 附件信息 */ + attachment?: Attachment +} + +export interface PreviewHireAttachmentResponse { + /** 预览链接 */ + url: string +} + export interface ListHireApplicationInterviewQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' @@ -2857,561 +3887,21 @@ export interface GetHireJobManagerQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface GetHireRoleResponse { - /** 角色详情 */ - role?: RoleDetail -} - -export interface CombinedCreateHireJobResponse { - /** 职位广告 */ - default_job_post?: CombinedJobResultDefaultJobPost - /** 职位 */ - job?: Job - /** 职位负责人 */ - job_manager?: JobManager - /** 面试登记表 */ - interview_registration_schema_info?: RegistrationSchemaInfo - /** 入职登记表 */ - onboard_registration_schema_info?: RegistrationSchemaInfo - /** 目标专业 */ - target_major_list?: TargetMajorInfo[] - /** 官网申请表 */ - portal_website_apply_form_schema_info?: RegistrationSchemaInfo -} - -export interface CombinedUpdateHireJobResponse { - /** 职位广告 */ - default_job_post?: CombinedJobResultDefaultJobPost - /** 职位 */ - job?: Job - /** 职位负责人 */ - job_manager?: JobManager - /** 官网申请表 */ - portal_website_apply_form_schema_info?: RegistrationSchemaInfo -} - -export interface UpdateConfigHireJobResponse { - job_config?: JobConfigResult -} - -export interface BatchUpdateHireJobManagerResponse { - /** 职位负责人 */ - job_manager?: JobManager -} - -export interface GetDetailHireJobResponse { - /** 职位详情数据 */ - job_detail?: JobDetail -} - -export interface GetHireJobResponse { - /** 职位数据 */ - job?: Job -} - -export interface RecruiterHireJobResponse { +export interface GetHireJobManagerResponse { /** 职位负责人 */ - info?: JobRecruiter2 -} - -export interface ConfigHireJobResponse { - job_config?: JobConfigResult -} - -export interface CreateHireJobRequirementResponse { - job_requirement?: JobRequirementDto -} - -export interface ListByIdHireJobRequirementResponse { - /** 招聘需求列表 */ - items?: JobRequirementDto[] -} - -export interface ListHireInterviewRoundTypeResponse { - /** 是否启用面试轮次类型 */ - active_status?: 1 | 2 - /** 列表 */ - items?: InterviewRoundType[] -} - -export interface PatchHireInterviewerResponse { - /** 面试官信息 */ - interviewer?: Interviewer -} - -export interface GetHireOfferApplicationFormResponse { - /** Offer 申请表详情 */ - offer_apply_form?: OfferApplyFormInfo -} - -export interface SearchHireReferralResponse { - /** 内推信息列表 */ - items?: ReferralInfo[] -} - -export interface GetHireReferralWebsiteJobPostResponse { - job_post?: PortalJobPost -} - -export interface GetByApplicationHireReferralResponse { - /** 内推信息 */ - referral?: Referral -} - -export interface CreateHireWebsiteChannelResponse { - /** 推广渠道 ID */ - id?: string - /** 推广渠道名称 */ - name?: string - /** 推广渠道链接 */ - link?: string - /** 推广渠道推广码 */ - code?: string -} - -export interface UpdateHireWebsiteChannelResponse { - /** 推广渠道 ID */ - id?: string - /** 推广渠道名称 */ - name?: string - /** 推广渠道链接 */ - link?: string - /** 推广渠道推广码 */ - code?: string -} - -export interface CreateHireWebsiteSiteUserResponse { - site_user?: WebsiteUser -} - -export interface GetHireWebsiteJobPostResponse { - job_post?: WebsiteJobPost -} - -export interface CreateByResumeHireWebsiteDeliveryResponse { - delivery?: WebsiteDeliveryDto -} - -export interface CreateByAttachmentHireWebsiteDeliveryResponse { - /** 异步任务 ID */ - task_id?: string -} - -export interface GetHireWebsiteDeliveryTaskResponse { - /** 任务状态 */ - status?: 0 | 1 | 2 | 3 - /** 官网投递信息 */ - delivery?: WebsiteDeliveryDto - /** 状态信息,仅 status 为 3 时返回 */ - status_msg?: string - /** 附加信息,当前返回投递 ID,仅当 status 为 3 且 status_msg 标识为重复投递时,将返回重复投递的 ID */ - extra_info?: string + info?: JobManager } -export interface GetHireAgencyResponse { - /** 数据 */ - agency?: Agency -} - -export interface ProtectSearchHireAgencyResponse { - /** 是否已入职 */ - is_onboarded?: boolean - /** 是否在猎头保护期内入职 */ - onboarded_in_protection?: boolean - /** 入职所在保护期 */ - onboarded_protection?: AgencyProtection - /** 人才保护信息 */ - protection_list?: AgencyProtection[] -} - -export interface QueryHireAgencyResponse { - items?: Agency[] -} - -export interface CreateHireTalentExternalInfoResponse { - /** 人才外部信息 */ - external_info?: TalentExternalInfo -} - -export interface UpdateHireTalentExternalInfoResponse { - /** 人才外部信息 */ - external_info?: TalentExternalInfo -} - -export interface CreateHireExternalApplicationResponse { - external_application?: ExternalApplication -} - -export interface UpdateHireExternalApplicationResponse { - external_application?: ExternalApplication -} - -export interface DeleteHireExternalApplicationResponse { - external_application?: ExternalApplication -} - -export interface CreateHireExternalInterviewResponse { - external_interview?: ExternalInterview -} - -export interface UpdateHireExternalInterviewResponse { - external_interview?: ExternalInterview -} - -export interface CreateHireExternalInterviewAssessmentResponse { - external_interview_assessment?: ExternalInterviewAssessment -} - -export interface PatchHireExternalInterviewAssessmentResponse { - external_interview_assessment?: ExternalInterviewAssessment -} - -export interface CreateHireExternalOfferResponse { - external_offer?: ExternalOffer -} - -export interface UpdateHireExternalOfferResponse { - external_offer?: ExternalOffer -} - -export interface CreateHireExternalBackgroundCheckResponse { - external_background_check?: ExternalBackgroundCheck -} - -export interface UpdateHireExternalBackgroundCheckResponse { - external_background_check?: ExternalBackgroundCheck -} - -export interface CreateHireExternalReferralRewardResponse { - /** 创建的内推奖励的id */ - id?: string -} - -export interface MoveTalentHireTalentPoolResponse { - /** 人才库ID */ - talent_pool_id?: string - /** 人才ID */ - talent_id?: string -} - -export interface CombinedCreateHireTalentResponse { - /** 人才 ID */ - talent_id?: string - /** 创建人 ID */ - creator_id?: string - /** 创建人类型 */ - creator_account_type?: 1 | 3 -} - -export interface CombinedUpdateHireTalentResponse { - /** 人才 ID */ - talent_id?: string - /** 更新人 ID */ - operator_id?: string - /** 更新人类型 */ - operator_account_type?: 1 | 3 -} - -export interface AddToFolderHireTalentResponse { - /** 人才 ID 列表 */ - talent_id_list?: string[] - /** 文件夹 ID */ - folder_id?: string -} - -export interface RemoveToFolderHireTalentResponse { - /** 人才 ID 列表 */ - talent_id_list?: string[] - /** 文件夹 ID */ - folder_id?: string -} - -export interface BatchGetIdHireTalentResponse { - /** 人才信息列表 */ - talent_list?: TalentBatchInfo[] -} - -export interface QueryHireTalentObjectResponse { - items?: CommonSchema[] -} - -export interface GetHireTalentResponse { - /** 人才信息 */ - talent?: Talent -} - -export interface GetHireTalentResponse { - /** ID */ - talent_id?: string - /** 基础信息 */ - basic_info?: CompositeTalentBasicInfo - /** 教育经历 */ - education_list?: CompositeTalentEducationInfo[] - /** 工作经历 */ - career_list?: CompositeTalentCareerInfo[] - /** 项目经历 */ - project_list?: CompositeTalentProjectInfo[] - /** 作品集 */ - works_list?: CompositeTalentWorksInfo[] - /** 获奖列表 */ - award_list?: CompositeTalentAwardInfo[] - /** 语言列表 */ - language_list?: CompositeTalentLanguageInfo[] - /** SNS列表 */ - sns_list?: CompositeTalentSnsInfo[] - /** 简历来源 */ - resume_source_list?: TalentResumeSource[] - /** 实习经历 */ - internship_list?: CompositeTalentInternshipInfo[] - /** 自定义字段 */ - customized_data_list?: CompositeTalentCustomizedData[] - /** 简历附件id列表(按照简历创建时间降序)(废弃,请使用resume_attachment_list代替) */ - resume_attachment_id_list?: string[] - /** 简历附件列表(按照简历创建时间降序) */ - resume_attachment_list?: TalentResumeAttachment[] - /** 面试登记表 */ - interview_registration_list?: TalentInterviewRegistrationSimple[] - /** 登记表列表 */ - registration_list?: RegistrationBasicInfo[] - /** 是否已入职 */ - is_onboarded?: boolean - /** 是否在猎头保护期 */ - is_in_agency_period?: boolean - /** 最高学历 参考 DegreeType 枚举 */ - top_degree?: number - /** 人才已加入的人才库列表 */ - talent_pool_id_list?: string[] - /** 文件夹列表 */ - talent_folder_ref_list_v2?: TalentFolder[] - /** 标签列表 */ - tag_list?: TalentTag[] - /** 相似人才信息 */ - similar_info_v2?: TalentSimilar - /** 人才黑名单详情 */ - block_info?: TalentBlock - /** 人才已经加入的人才库列表 */ - talent_pool_ref_list_v2?: TalentPool[] - /** 备注列表 */ - note_list_v2?: TalentNote[] -} - -export interface GetDetailHireApplicationResponse { - /** 投递详情 */ - application_detail?: ApplicationDetailInfo -} - -export interface CreateHireApplicationResponse { - /** 投递ID */ - id?: string -} - -export interface GetHireApplicationResponse { - /** 投递数据 */ - application?: Application -} - -export interface SearchHireDiversityInclusionResponse { - /** 多元化与包容性信息列表 */ - items?: DiInfo[] -} - -export interface CreateHireExamResponse { - /** 笔试 ID */ - exam_id?: string - /** 投递 ID */ - application_id?: string - /** 试卷名称 */ - exam_resource_name?: string - /** 笔试分数 */ - score?: number - /** 附件ID */ - uuid?: string - /** 操作人 ID */ - operator_id?: string - /** 操作时间 */ - operate_time?: string -} - -export interface GetByTalentHireInterviewResponse { - /** 投递面试列表 */ - items?: TalentInterview[] -} - -export interface GetHireInterviewRecordResponse { - /** 数据 */ - interview_record?: InterviewRecord -} - -export interface GetHireInterviewRecordResponse { - interview_record?: InterviewRecord -} - -export interface GetHireInterviewRecordAttachmentResponse { - /** 附件信息 */ - attachment?: AttachmentInfo -} - -export interface GetHireMinutesResponse { - minutes?: Minutes - /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ - page_token?: string - /** 对应面试是否还有更多项 */ - has_more?: boolean -} - -export interface CreateHireOfferResponse { - /** Offer ID */ - offer_id?: string - /** 投递 ID */ - application_id?: string - /** 模板 ID */ - schema_id?: string - /** Offer 类型 */ - offer_type?: 1 | 2 - /** Offer 基本信息 */ - basic_info?: OfferBasicInfo - /** Offer 薪资信息 */ - salary_info?: OfferSalaryInfo - /** 自定义信息 */ - customized_info_list?: OfferCustomizedInfo[] -} - -export interface UpdateHireOfferResponse { - /** Offer ID */ - offer_id?: string - /** 模板 ID */ - schema_id?: string - /** Offer 基本信息 */ - basic_info?: OfferBasicInfo - /** Offer 薪资信息 */ - salary_info?: OfferSalaryInfo - /** 自定义信息 */ - customized_info_list?: OfferCustomizedInfo[] -} - -export interface OfferHireApplicationResponse { - offer?: ApplicationOffer -} - -export interface GetHireOfferResponse { - /** Offer 详情 */ - offer?: Offer -} - -export interface InternOfferStatusHireOfferResponse { - /** Offer ID */ - offer_id?: string - /** 更新入/离职状态的操作 */ - operation: 'confirm_onboarding' | 'cancel_onboarding' | 'offboard' - /** 入职表单信息(当 operation 为 confirm_onboarding 时,该字段必填) */ - onboarding_info?: InternOfferOnboardingInfo - /** 离职表单信息(当 operation 为 offboard 时,该字段必填) */ - offboarding_info?: InternOfferOffboardingInfo -} - -export interface CreateHireTripartiteAgreementResponse { - /** 创建的三方协议的 id */ - id?: string -} - -export interface UpdateHireTripartiteAgreementResponse { - /** 三方协议信息 */ - tripartite_agreement?: TripartiteAgreementInfo -} - -export interface TransferOnboardHireApplicationResponse { - /** employee */ - employee?: Employee -} - -export interface PatchHireEmployeeResponse { - /** 员工信息 */ - employee?: Employee -} - -export interface GetByApplicationHireEmployeeResponse { - /** 员工信息 */ - employee?: Employee -} - -export interface GetHireEmployeeResponse { - /** 员工信息 */ - employee?: Employee -} - -export interface CreateHireNoteResponse { - note?: Note -} - -export interface PatchHireNoteResponse { - /** 备注数据 */ - note?: Note -} - -export interface GetHireNoteResponse { - /** 备注数据 */ - note?: Note -} - -export interface EnableHireReferralAccountResponse { - /** 账号信息 */ - account?: Account -} - -export interface GetAccountAssetsHireReferralAccountResponse { - /** 账户信息 */ - account?: Account -} - -export interface CreateHireReferralAccountResponse { - /** 账号信息 */ - account?: Account -} - -export interface DeactivateHireReferralAccountResponse { - /** 账号信息 */ - account?: Account -} - -export interface WithdrawHireReferralAccountResponse { - /** 请求时传入的提现单ID */ - external_order_id?: string - /** 交易时间戳,需要保存,用于统一交易时间,方便对账 */ - trans_time?: string - /** 本次提现金额明细 */ - withdrawal_details?: BonusAmount -} - -export interface ReconciliationHireReferralAccountResponse { - /** 核对失败的信息 */ - check_failed_list?: CheckFailedAccountInfo[] -} - -export interface CreateHireAttachmentResponse { - /** 上传文件的 id */ - id?: string -} - -export interface GetHireAttachmentResponse { - /** 附件信息 */ - attachment?: Attachment -} - -export interface PreviewHireAttachmentResponse { - /** 预览链接 */ - url: string -} - -export interface GetHireJobManagerResponse { - /** 职位负责人 */ - info?: JobManager +export const enum GetHireOfferSchemaResponseScenario { + /** Offer审批表 */ + ApplyOffer = 1, } export interface GetHireOfferSchemaResponse { /** offer申请表ID */ id?: string /** offer申请表使用场景 */ - scenario?: 1 + scenario?: GetHireOfferSchemaResponseScenario /** 申请表版本 */ version?: number /** 字段对象信息 */ diff --git a/adapters/lark/src/types/im.ts b/adapters/lark/src/types/im.ts index df2fc448..a0da8498 100644 --- a/adapters/lark/src/types/im.ts +++ b/adapters/lark/src/types/im.ts @@ -377,527 +377,6 @@ export interface CreateImMessageQuery { receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' } -export interface ReplyImMessageRequest { - /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */ - content: string - /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */ - msg_type: string - /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */ - reply_in_thread?: boolean - /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */ - uuid?: string -} - -export interface UpdateImMessageRequest { - /** 消息的类型,仅支持文本(text)和富文本(post)类型 */ - msg_type: string - /** 消息内容,JSON 格式 */ - content: string -} - -export interface ForwardImMessageRequest { - /** 依据receive_id_type的值,填写对应的转发目标的ID */ - receive_id: string -} - -export interface ForwardImMessageQuery { - /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */ - receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id' - /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */ - uuid?: string -} - -export interface MergeForwardImMessageRequest { - /** 依据receive_id_type的值,填写对应的转发目标的ID */ - receive_id: string - /** 要转发的消息ID列表 */ - message_id_list: string[] -} - -export interface MergeForwardImMessageQuery { - /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */ - receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id' - /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */ - uuid?: string -} - -export interface ForwardImThreadRequest { - /** 依据receive_id_type的值,填写对应的转发目标的ID */ - receive_id: string -} - -export interface ForwardImThreadQuery { - /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */ - receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id' - /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */ - uuid?: string -} - -export interface PushFollowUpImMessageRequest { - /** follow up列表 */ - follow_ups: FollowUp[] -} - -export interface ReadUsersImMessageQuery extends Pagination { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: 'user_id' | 'union_id' | 'open_id' -} - -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) */ - container_id: string - /** 历史信息的起始时间(秒级时间戳) */ - start_time?: string - /** 历史信息的结束时间(秒级时间戳) */ - end_time?: string - /** 消息排序方式 */ - sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc' -} - -export interface GetImMessageResourceQuery { - /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */ - type: string -} - -export interface GetImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface CreateImImageForm { - /** 图片类型 */ - image_type: 'message' | 'avatar' - /** 图片内容 **注意:** 上传的图片大小不能超过10MB */ - image: Blob -} - -export interface CreateImFileForm { - /** 文件类型 */ - file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream' - /** 带后缀的文件名 */ - file_name: string - /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */ - duration?: number - /** 文件内容 */ - file: Blob -} - -export interface UrgentAppImMessageRequest { - /** 该字段标识目标用户的id类型 */ - user_id_list: string[] -} - -export interface UrgentAppImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: 'user_id' | 'union_id' | 'open_id' -} - -export interface UrgentSmsImMessageRequest { - /** 该字段标识目标用户的id类型 */ - user_id_list: string[] -} - -export interface UrgentSmsImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: 'user_id' | 'union_id' | 'open_id' -} - -export interface UrgentPhoneImMessageRequest { - /** 该字段标识目标用户的id类型 */ - user_id_list: string[] -} - -export interface UrgentPhoneImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: 'user_id' | 'union_id' | 'open_id' -} - -export interface CreateImMessageReactionRequest { - /** reaction资源类型 */ - reaction_type: Emoji -} - -export interface ListImMessageReactionQuery extends Pagination { - /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */ - reaction_type?: string - /** 当操作人为用户时返回用户ID的类型 */ - user_id_type?: 'open_id' | 'union_id' | 'user_id' -} - -export interface CreateImPinRequest { - /** 待Pin的消息ID */ - message_id: string -} - -export interface ListImPinQuery extends Pagination { - /** 待获取Pin消息的Chat ID */ - chat_id: string - /** Pin信息的起始时间(毫秒级时间戳) */ - start_time?: string - /** Pin信息的结束时间(毫秒级时间戳) */ - end_time?: string -} - -export interface PatchImMessageRequest { - /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */ - content: string -} - -export interface BatchUpdateImUrlPreviewRequest { - /** URL预览的token列表 */ - preview_tokens: string[] - /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */ - open_ids?: string[] -} - -export interface CreateImChatRequest { - /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */ - avatar?: string - /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */ - name?: string - /** 群描述 */ - description?: string - /** 群国际化名称 */ - i18n_names?: I18nNames - /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ - owner_id?: string - /** 创建群时邀请的群成员,id 类型为 user_id_type */ - user_id_list?: string[] - /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */ - bot_id_list?: string[] - /** 群消息模式 */ - group_message_type?: 'chat' | 'thread' - /** 群模式**可选值有**:- `group`:群组 */ - chat_mode?: string - /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */ - chat_type?: string - /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */ - join_message_visibility?: string - /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */ - leave_message_visibility?: string - /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */ - membership_approval?: string - /** 防泄密模式设置 */ - restricted_mode_setting?: RestrictedModeSetting - /** 谁可以加急 */ - urgent_setting?: 'only_owner' | 'all_members' - /** 谁可以发起视频会议 */ - video_conference_setting?: 'only_owner' | 'all_members' - /** 谁可以编辑群信息 */ - edit_permission?: 'only_owner' | 'all_members' - /** 隐藏群成员人数设置 */ - hide_member_count_setting?: 'all_members' | 'only_owner' -} - -export interface CreateImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */ - set_bot_manager?: boolean - /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */ - uuid?: string -} - -export interface UpdateImChatRequest { - /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */ - avatar?: string - /** 群名称 */ - name?: string - /** 群描述 */ - description?: string - /** 群国际化名称 */ - i18n_names?: I18nNames - /** 加 user/bot 入群权限(all_members/only_owner) */ - add_member_permission?: string - /** 群分享权限(allowed/not_allowed) */ - share_card_permission?: string - /** at 所有人权限(all_members/only_owner) */ - at_all_permission?: string - /** 群编辑权限(all_members/only_owner) */ - edit_permission?: string - /** 新群主 ID */ - owner_id?: string - /** 入群消息可见性(only_owner/all_members/not_anyone) */ - join_message_visibility?: string - /** 出群消息可见性(only_owner/all_members/not_anyone) */ - leave_message_visibility?: string - /** 加群审批(no_approval_required/approval_required) */ - membership_approval?: string - /** 防泄密模式设置 */ - restricted_mode_setting?: RestrictedModeSetting - /** 群类型 */ - chat_type?: string - /** 群消息模式 */ - group_message_type?: 'chat' | 'thread' - /** 谁可以加急 */ - urgent_setting?: 'only_owner' | 'all_members' - /** 谁可以发起视频会议 */ - video_conference_setting?: 'only_owner' | 'all_members' - /** 隐藏群成员人数设置 */ - hide_member_count_setting?: 'all_members' | 'only_owner' -} - -export interface UpdateImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface UpdateImChatModerationRequest { - /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */ - moderation_setting?: string - /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */ - moderator_added_list?: string[] - /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */ - moderator_removed_list?: string[] -} - -export interface UpdateImChatModerationQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface GetImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface PutTopNoticeImChatTopNoticeRequest { - /** 要进行发布的群置顶 */ - chat_top_notice: ChatTopNotice[] -} - -export interface ListImChatQuery extends Pagination { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 群组排序方式 */ - sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc' -} - -export interface SearchImChatQuery extends Pagination { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' - /** 关键词。注意:如果query为空值将返回空的结果 */ - query?: string -} - -export interface GetImChatModerationQuery extends Pagination { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface LinkImChatRequest { - /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */ - validity_period?: 'week' | 'year' | 'permanently' -} - -export interface AddManagersImChatManagersRequest { - /** 要增加的 manager_id */ - manager_ids?: string[] -} - -export interface AddManagersImChatManagersQuery { - /** 群成员 id 类型 open_id/user_id/union_id/app_id */ - member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' -} - -export interface DeleteManagersImChatManagersRequest { - /** 要删除的 manager_id */ - manager_ids?: string[] -} - -export interface DeleteManagersImChatManagersQuery { - /** 群成员 id 类型 open_id/user_id/union_id/app_id */ - member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' -} - -export interface CreateImChatMembersRequest { - /** 成员列表注意:每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */ - id_list?: string[] -} - -export interface CreateImChatMembersQuery { - /** 进群成员 id 类型 open_id/user_id/union_id/app_id注意:拉机器人入群请使用 ==app_id== */ - member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' - /** 出现不可用ID后的处理方式 0/1/2 */ - succeed_type?: 0 | 1 | 2 -} - -export interface DeleteImChatMembersRequest { - /** 成员列表 */ - id_list?: string[] -} - -export interface DeleteImChatMembersQuery { - /** 出群成员 id 类型 open_id/user_id/union_id/app_id */ - member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' -} - -export interface GetImChatMembersQuery extends Pagination { - /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ - member_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface PatchImChatAnnouncementRequest { - /** 文档当前版本号 int64 类型,get 接口会返回 */ - revision: string - /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */ - requests?: string[] -} - -export interface GetImChatAnnouncementQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface CreateImChatTabRequest { - /** 会话标签页 */ - chat_tabs: ChatTab[] -} - -export interface DeleteTabsImChatTabRequest { - /** 会话标签页id列表 */ - tab_ids: string[] -} - -export interface UpdateTabsImChatTabRequest { - /** 会话标签页 */ - chat_tabs?: ChatTab[] -} - -export interface SortTabsImChatTabRequest { - /** 会话标签页ID列表 */ - tab_ids?: string[] -} - -export interface CreateImChatMenuTreeRequest { - /** 要向群内追加的菜单 */ - menu_tree: ChatMenuTree -} - -export interface DeleteImChatMenuTreeRequest { - /** 要删除的一级菜单ID列表 */ - chat_menu_top_level_ids: string[] -} - -export interface PatchImChatMenuItemRequest { - /** 修改的字段 */ - update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[] - /** 元信息 */ - chat_menu_item: ChatMenuItem -} - -export interface SortImChatMenuTreeRequest { - /** 一级菜单id列表 */ - chat_menu_top_level_ids: string[] -} - -export interface CreateImAppFeedCardRequest { - /** 应用消息卡片 */ - app_feed_card?: OpenAppFeedCard - /** 用户 ID */ - user_ids?: string[] -} - -export interface CreateImAppFeedCardQuery { - /** 用户 ID 类型 */ - user_id_type?: 'open_id' | 'union_id' | 'user_id' -} - -export interface UpdateImAppFeedCardBatchRequest { - /** 应用消息卡片 */ - feed_cards?: UserOpenAppFeedCardUpdater[] -} - -export interface UpdateImAppFeedCardBatchQuery { - /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ - user_id_type?: 'open_id' | 'user_id' | 'union_id' -} - -export interface DeleteImAppFeedCardBatchRequest { - /** 应用消息卡片 */ - feed_cards?: UserOpenAppFeedCardDeleter[] -} - -export interface DeleteImAppFeedCardBatchQuery { - /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ - user_id_type?: 'open_id' | 'user_id' | 'union_id' -} - -export interface BotTimeSentiveImFeedCardRequest { - /** 临时置顶状态,true-打开,false-关闭 */ - time_sensitive: boolean - /** 用户id 列表 */ - user_ids: string[] -} - -export interface BotTimeSentiveImFeedCardQuery { - /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ - user_id_type: 'open_id' | 'user_id' | 'union_id' -} - -export interface UpdateImChatButtonRequest { - /** 用户 ID 列表 */ - user_ids?: string[] - /** 群 ID */ - chat_id: string - /** 按钮 */ - buttons?: OpenAppFeedCardButtons -} - -export interface UpdateImChatButtonQuery { - /** 用户 ID 类型 */ - user_id_type?: 'open_id' | 'union_id' | 'user_id' -} - -export interface PatchImFeedCardRequest { - /** 临时置顶状态,true-打开,false-关闭 */ - time_sensitive: boolean - /** 用户id 列表 */ - user_ids: string[] -} - -export interface PatchImFeedCardQuery { - /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ - user_id_type: 'open_id' | 'user_id' | 'union_id' -} - -export interface GetImBizEntityTagRelationQuery { - /** 业务类型 */ - tag_biz_type: 'chat' - /** 业务实体id */ - biz_entity_id: string -} - -export interface CreateImTagRequest { - /** 创建标签 */ - create_tag: CreateTag -} - -export interface PatchImTagRequest { - /** 编辑标签 */ - patch_tag?: PatchTag -} - -export interface CreateImBizEntityTagRelationRequest { - /** 业务类型 */ - tag_biz_type: 'chat' - /** 业务实体id */ - biz_entity_id: string - /** 标签id */ - tag_ids?: string[] -} - -export interface UpdateImBizEntityTagRelationRequest { - /** 业务类型 */ - tag_biz_type: 'chat' - /** 业务实体id */ - biz_entity_id: string - /** 标签id */ - tag_ids?: string[] -} - export interface CreateImMessageResponse { /** 消息id open_message_id */ message_id?: string @@ -929,6 +408,17 @@ export interface CreateImMessageResponse { upper_message_id?: string } +export interface ReplyImMessageRequest { + /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */ + content: string + /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */ + msg_type: string + /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */ + reply_in_thread?: boolean + /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */ + uuid?: string +} + export interface ReplyImMessageResponse { /** 消息id open_message_id */ message_id?: string @@ -960,6 +450,13 @@ export interface ReplyImMessageResponse { upper_message_id?: string } +export interface UpdateImMessageRequest { + /** 消息的类型,仅支持文本(text)和富文本(post)类型 */ + msg_type: string + /** 消息内容,JSON 格式 */ + content: string +} + export interface UpdateImMessageResponse { /** 消息id open_message_id */ message_id?: string @@ -991,6 +488,18 @@ export interface UpdateImMessageResponse { upper_message_id?: string } +export interface ForwardImMessageRequest { + /** 依据receive_id_type的值,填写对应的转发目标的ID */ + receive_id: string +} + +export interface ForwardImMessageQuery { + /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */ + receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id' + /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */ + uuid?: string +} + export interface ForwardImMessageResponse { /** 消息id open_message_id */ message_id?: string @@ -1022,6 +531,20 @@ export interface ForwardImMessageResponse { upper_message_id?: string } +export interface MergeForwardImMessageRequest { + /** 依据receive_id_type的值,填写对应的转发目标的ID */ + receive_id: string + /** 要转发的消息ID列表 */ + message_id_list: string[] +} + +export interface MergeForwardImMessageQuery { + /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */ + receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id' + /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */ + uuid?: string +} + export interface MergeForwardImMessageResponse { /** 合并转发生成的新消息 */ message?: Message @@ -1029,6 +552,18 @@ export interface MergeForwardImMessageResponse { invalid_message_id_list?: string[] } +export interface ForwardImThreadRequest { + /** 依据receive_id_type的值,填写对应的转发目标的ID */ + receive_id: string +} + +export interface ForwardImThreadQuery { + /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */ + receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id' + /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */ + uuid?: string +} + export interface ForwardImThreadResponse { /** 消息id open_message_id */ message_id?: string @@ -1060,6 +595,39 @@ export interface ForwardImThreadResponse { upper_message_id?: string } +export interface PushFollowUpImMessageRequest { + /** follow up列表 */ + follow_ups: FollowUp[] +} + +export interface ReadUsersImMessageQuery extends Pagination { + /** 此次调用中使用的用户ID的类型 */ + user_id_type: 'user_id' | 'union_id' | 'open_id' +} + +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) */ + container_id: string + /** 历史信息的起始时间(秒级时间戳) */ + start_time?: string + /** 历史信息的结束时间(秒级时间戳) */ + end_time?: string + /** 消息排序方式 */ + sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc' +} + +export interface GetImMessageResourceQuery { + /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */ + type: string +} + +export interface GetImMessageQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetImMessageResponse { /** message[] */ items?: Message[] @@ -1076,31 +644,84 @@ export interface GetProgressImBatchMessageResponse { batch_message_recall_progress?: BatchMessageRecallProgress } +export interface CreateImImageForm { + /** 图片类型 */ + image_type: 'message' | 'avatar' + /** 图片内容 **注意:** 上传的图片大小不能超过10MB */ + image: Blob +} + export interface CreateImImageResponse { /** 图片的key */ image_key?: string } +export interface CreateImFileForm { + /** 文件类型 */ + file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream' + /** 带后缀的文件名 */ + file_name: string + /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */ + duration?: number + /** 文件内容 */ + file: Blob +} + export interface CreateImFileResponse { /** 文件的key */ file_key?: string } +export interface UrgentAppImMessageRequest { + /** 该字段标识目标用户的id类型 */ + user_id_list: string[] +} + +export interface UrgentAppImMessageQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type: 'user_id' | 'union_id' | 'open_id' +} + export interface UrgentAppImMessageResponse { /** 无效的用户id */ invalid_user_id_list: string[] } +export interface UrgentSmsImMessageRequest { + /** 该字段标识目标用户的id类型 */ + user_id_list: string[] +} + +export interface UrgentSmsImMessageQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type: 'user_id' | 'union_id' | 'open_id' +} + export interface UrgentSmsImMessageResponse { /** 无效的用户id */ invalid_user_id_list: string[] } +export interface UrgentPhoneImMessageRequest { + /** 该字段标识目标用户的id类型 */ + user_id_list: string[] +} + +export interface UrgentPhoneImMessageQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type: 'user_id' | 'union_id' | 'open_id' +} + export interface UrgentPhoneImMessageResponse { /** 无效的用户id */ invalid_user_id_list: string[] } +export interface CreateImMessageReactionRequest { + /** reaction资源类型 */ + reaction_type: Emoji +} + export interface CreateImMessageReactionResponse { /** reaction资源ID */ reaction_id?: string @@ -1112,6 +733,13 @@ export interface CreateImMessageReactionResponse { reaction_type?: Emoji } +export interface ListImMessageReactionQuery extends Pagination { + /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */ + reaction_type?: string + /** 当操作人为用户时返回用户ID的类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + export interface DeleteImMessageReactionResponse { /** reaction资源ID */ reaction_id?: string @@ -1123,10 +751,84 @@ export interface DeleteImMessageReactionResponse { reaction_type?: Emoji } +export interface CreateImPinRequest { + /** 待Pin的消息ID */ + message_id: string +} + export interface CreateImPinResponse { pin?: Pin } +export interface ListImPinQuery extends Pagination { + /** 待获取Pin消息的Chat ID */ + chat_id: string + /** Pin信息的起始时间(毫秒级时间戳) */ + start_time?: string + /** Pin信息的结束时间(毫秒级时间戳) */ + end_time?: string +} + +export interface PatchImMessageRequest { + /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */ + content: string +} + +export interface BatchUpdateImUrlPreviewRequest { + /** URL预览的token列表 */ + preview_tokens: string[] + /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */ + open_ids?: string[] +} + +export interface CreateImChatRequest { + /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */ + avatar?: string + /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */ + name?: string + /** 群描述 */ + description?: string + /** 群国际化名称 */ + i18n_names?: I18nNames + /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ + owner_id?: string + /** 创建群时邀请的群成员,id 类型为 user_id_type */ + user_id_list?: string[] + /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */ + bot_id_list?: string[] + /** 群消息模式 */ + group_message_type?: 'chat' | 'thread' + /** 群模式**可选值有**:- `group`:群组 */ + chat_mode?: string + /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */ + chat_type?: string + /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */ + join_message_visibility?: string + /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */ + leave_message_visibility?: string + /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */ + membership_approval?: string + /** 防泄密模式设置 */ + restricted_mode_setting?: RestrictedModeSetting + /** 谁可以加急 */ + urgent_setting?: 'only_owner' | 'all_members' + /** 谁可以发起视频会议 */ + video_conference_setting?: 'only_owner' | 'all_members' + /** 谁可以编辑群信息 */ + edit_permission?: 'only_owner' | 'all_members' + /** 隐藏群成员人数设置 */ + hide_member_count_setting?: 'all_members' | 'only_owner' +} + +export interface CreateImChatQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */ + set_bot_manager?: boolean + /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */ + uuid?: string +} + export interface CreateImChatResponse { /** 群ID */ chat_id?: string @@ -1180,6 +882,69 @@ export interface CreateImChatResponse { hide_member_count_setting?: 'all_members' | 'only_owner' } +export interface UpdateImChatRequest { + /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */ + avatar?: string + /** 群名称 */ + name?: string + /** 群描述 */ + description?: string + /** 群国际化名称 */ + i18n_names?: I18nNames + /** 加 user/bot 入群权限(all_members/only_owner) */ + add_member_permission?: string + /** 群分享权限(allowed/not_allowed) */ + share_card_permission?: string + /** at 所有人权限(all_members/only_owner) */ + at_all_permission?: string + /** 群编辑权限(all_members/only_owner) */ + edit_permission?: string + /** 新群主 ID */ + owner_id?: string + /** 入群消息可见性(only_owner/all_members/not_anyone) */ + join_message_visibility?: string + /** 出群消息可见性(only_owner/all_members/not_anyone) */ + leave_message_visibility?: string + /** 加群审批(no_approval_required/approval_required) */ + membership_approval?: string + /** 防泄密模式设置 */ + restricted_mode_setting?: RestrictedModeSetting + /** 群类型 */ + chat_type?: string + /** 群消息模式 */ + group_message_type?: 'chat' | 'thread' + /** 谁可以加急 */ + urgent_setting?: 'only_owner' | 'all_members' + /** 谁可以发起视频会议 */ + video_conference_setting?: 'only_owner' | 'all_members' + /** 隐藏群成员人数设置 */ + hide_member_count_setting?: 'all_members' | 'only_owner' +} + +export interface UpdateImChatQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateImChatModerationRequest { + /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */ + moderation_setting?: string + /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */ + moderator_added_list?: string[] + /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */ + moderator_removed_list?: string[] +} + +export interface UpdateImChatModerationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetImChatQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetImChatResponse { /** 群头像URL */ avatar?: string @@ -1241,6 +1006,30 @@ export interface GetImChatResponse { chat_status?: 'normal' | 'dissolved' | 'dissolved_save' } +export interface PutTopNoticeImChatTopNoticeRequest { + /** 要进行发布的群置顶 */ + chat_top_notice: ChatTopNotice[] +} + +export interface ListImChatQuery extends Pagination { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 群组排序方式 */ + sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc' +} + +export interface SearchImChatQuery extends Pagination { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 关键词。注意:如果query为空值将返回空的结果 */ + query?: string +} + +export interface GetImChatModerationQuery extends Pagination { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetImChatModerationResponse { /** 群发言模式 */ moderation_setting?: string @@ -1252,6 +1041,11 @@ export interface GetImChatModerationResponse { items?: ListModerator[] } +export interface LinkImChatRequest { + /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */ + validity_period?: 'week' | 'year' | 'permanently' +} + export interface LinkImChatResponse { /** 群分享链接 */ share_link?: string @@ -1261,6 +1055,16 @@ export interface LinkImChatResponse { is_permanent?: boolean } +export interface AddManagersImChatManagersRequest { + /** 要增加的 manager_id */ + manager_ids?: string[] +} + +export interface AddManagersImChatManagersQuery { + /** 群成员 id 类型 open_id/user_id/union_id/app_id */ + member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' +} + export interface AddManagersImChatManagersResponse { /** 群目前的管理员id */ chat_managers?: string[] @@ -1268,6 +1072,16 @@ export interface AddManagersImChatManagersResponse { chat_bot_managers?: string[] } +export interface DeleteManagersImChatManagersRequest { + /** 要删除的 manager_id */ + manager_ids?: string[] +} + +export interface DeleteManagersImChatManagersQuery { + /** 群成员 id 类型 open_id/user_id/union_id/app_id */ + member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' +} + export interface DeleteManagersImChatManagersResponse { /** 群目前的管理员id */ chat_managers?: string[] @@ -1275,6 +1089,18 @@ export interface DeleteManagersImChatManagersResponse { chat_bot_managers?: string[] } +export interface CreateImChatMembersRequest { + /** 成员列表注意:每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */ + id_list?: string[] +} + +export interface CreateImChatMembersQuery { + /** 进群成员 id 类型 open_id/user_id/union_id/app_id注意:拉机器人入群请使用 ==app_id== */ + member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' + /** 出现不可用ID后的处理方式 0/1/2 */ + succeed_type?: 0 | 1 | 2 +} + export interface CreateImChatMembersResponse { /** ID无效的成员列表 */ invalid_id_list?: string[] @@ -1284,11 +1110,26 @@ export interface CreateImChatMembersResponse { pending_approval_id_list?: string[] } +export interface DeleteImChatMembersRequest { + /** 成员列表 */ + id_list?: string[] +} + +export interface DeleteImChatMembersQuery { + /** 出群成员 id 类型 open_id/user_id/union_id/app_id */ + member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' +} + export interface DeleteImChatMembersResponse { /** 无效成员列表 */ invalid_id_list?: string[] } +export interface GetImChatMembersQuery extends Pagination { + /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ + member_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetImChatMembersResponse { /** member列表 */ items?: ListMember[] @@ -1305,6 +1146,18 @@ export interface IsInChatImChatMembersResponse { is_in_chat?: boolean } +export interface PatchImChatAnnouncementRequest { + /** 文档当前版本号 int64 类型,get 接口会返回 */ + revision: string + /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */ + requests?: string[] +} + +export interface GetImChatAnnouncementQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetImChatAnnouncementResponse { /** CCM 文档序列化信息 */ content?: string @@ -1324,21 +1177,41 @@ export interface GetImChatAnnouncementResponse { modifier_id?: string } +export interface CreateImChatTabRequest { + /** 会话标签页 */ + chat_tabs: ChatTab[] +} + export interface CreateImChatTabResponse { /** 群标签列表 */ chat_tabs?: ChatTab[] } +export interface DeleteTabsImChatTabRequest { + /** 会话标签页id列表 */ + tab_ids: string[] +} + export interface DeleteTabsImChatTabResponse { /** 群标签列表 */ chat_tabs?: ChatTab[] } +export interface UpdateTabsImChatTabRequest { + /** 会话标签页 */ + chat_tabs?: ChatTab[] +} + export interface UpdateTabsImChatTabResponse { /** 群标签列表 */ chat_tabs?: ChatTab[] } +export interface SortTabsImChatTabRequest { + /** 会话标签页ID列表 */ + tab_ids?: string[] +} + export interface SortTabsImChatTabResponse { /** 群标签列表 */ chat_tabs?: ChatTab[] @@ -1349,20 +1222,42 @@ export interface ListTabsImChatTabResponse { chat_tabs?: ChatTab[] } +export interface CreateImChatMenuTreeRequest { + /** 要向群内追加的菜单 */ + menu_tree: ChatMenuTree +} + export interface CreateImChatMenuTreeResponse { /** 追加后群内现有菜单 */ menu_tree?: ChatMenuTree } +export interface DeleteImChatMenuTreeRequest { + /** 要删除的一级菜单ID列表 */ + chat_menu_top_level_ids: string[] +} + export interface DeleteImChatMenuTreeResponse { /** 群内现有菜单 */ menu_tree?: ChatMenuTree } +export interface PatchImChatMenuItemRequest { + /** 修改的字段 */ + update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[] + /** 元信息 */ + chat_menu_item: ChatMenuItem +} + export interface PatchImChatMenuItemResponse { chat_menu_item?: ChatMenuItem } +export interface SortImChatMenuTreeRequest { + /** 一级菜单id列表 */ + chat_menu_top_level_ids: string[] +} + export interface SortImChatMenuTreeResponse { /** 排序后群内菜单 */ menu_tree?: ChatMenuTree @@ -1373,6 +1268,18 @@ export interface GetImChatMenuTreeResponse { menu_tree?: ChatMenuTree } +export interface CreateImAppFeedCardRequest { + /** 应用消息卡片 */ + app_feed_card?: OpenAppFeedCard + /** 用户 ID */ + user_ids?: string[] +} + +export interface CreateImAppFeedCardQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + export interface CreateImAppFeedCardResponse { /** 失败的卡片 */ failed_cards?: OpenFailedUserAppFeedCardItem[] @@ -1380,36 +1287,106 @@ export interface CreateImAppFeedCardResponse { biz_id?: string } +export interface UpdateImAppFeedCardBatchRequest { + /** 应用消息卡片 */ + feed_cards?: UserOpenAppFeedCardUpdater[] +} + +export interface UpdateImAppFeedCardBatchQuery { + /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' +} + export interface UpdateImAppFeedCardBatchResponse { /** 失败的卡片 */ failed_cards?: OpenFailedUserAppFeedCardItem[] } +export interface DeleteImAppFeedCardBatchRequest { + /** 应用消息卡片 */ + feed_cards?: UserOpenAppFeedCardDeleter[] +} + +export interface DeleteImAppFeedCardBatchQuery { + /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' +} + export interface DeleteImAppFeedCardBatchResponse { /** 失败的卡片 */ failed_cards?: OpenFailedUserAppFeedCardItem[] } +export interface BotTimeSentiveImFeedCardRequest { + /** 临时置顶状态,true-打开,false-关闭 */ + time_sensitive: boolean + /** 用户id 列表 */ + user_ids: string[] +} + +export interface BotTimeSentiveImFeedCardQuery { + /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ + user_id_type: 'open_id' | 'user_id' | 'union_id' +} + export interface BotTimeSentiveImFeedCardResponse { /** 失败原因 */ failed_user_reasons?: FailedReason[] } +export interface UpdateImChatButtonRequest { + /** 用户 ID 列表 */ + user_ids?: string[] + /** 群 ID */ + chat_id: string + /** 按钮 */ + buttons?: OpenAppFeedCardButtons +} + +export interface UpdateImChatButtonQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + export interface UpdateImChatButtonResponse { /** 失败的用户 */ failed_user_reasons?: FailedReason[] } +export interface PatchImFeedCardRequest { + /** 临时置顶状态,true-打开,false-关闭 */ + time_sensitive: boolean + /** 用户id 列表 */ + user_ids: string[] +} + +export interface PatchImFeedCardQuery { + /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */ + user_id_type: 'open_id' | 'user_id' | 'union_id' +} + export interface PatchImFeedCardResponse { /** 失败原因 */ failed_user_reasons?: FailedReason[] } +export interface GetImBizEntityTagRelationQuery { + /** 业务类型 */ + tag_biz_type: 'chat' + /** 业务实体id */ + biz_entity_id: string +} + export interface GetImBizEntityTagRelationResponse { /** 标签内容及绑定时间 */ tag_info_with_bind_versions?: TagInfoWithBindVersion[] } +export interface CreateImTagRequest { + /** 创建标签 */ + create_tag: CreateTag +} + export interface CreateImTagResponse { /** 创建的tagid */ id?: string @@ -1417,6 +1394,11 @@ export interface CreateImTagResponse { create_tag_fail_reason?: CreateTagFailReason } +export interface PatchImTagRequest { + /** 编辑标签 */ + patch_tag?: PatchTag +} + export interface PatchImTagResponse { /** 编辑后的taginfo */ tag_info?: TagInfo @@ -1424,6 +1406,24 @@ export interface PatchImTagResponse { patch_tag_fail_reason?: PatchTagFailReason } +export interface CreateImBizEntityTagRelationRequest { + /** 业务类型 */ + tag_biz_type: 'chat' + /** 业务实体id */ + biz_entity_id: string + /** 标签id */ + tag_ids?: string[] +} + +export interface UpdateImBizEntityTagRelationRequest { + /** 业务类型 */ + tag_biz_type: 'chat' + /** 业务实体id */ + biz_entity_id: string + /** 标签id */ + tag_ids?: string[] +} + Internal.define({ '/im/v1/messages': { POST: 'createImMessage', diff --git a/adapters/lark/src/types/index.ts b/adapters/lark/src/types/index.ts index b73f779d..60836536 100644 --- a/adapters/lark/src/types/index.ts +++ b/adapters/lark/src/types/index.ts @@ -745,7 +745,18 @@ export interface AilyMessage { status?: AilyMessageStatus } -export type AilyMessageContentType = 'MDX' | 'TEXT' | 'CLIP' | 'SmartCard' | 'JSON' +export const enum AilyMessageContentType { + /** MDX */ + ContentTypeMDX = 'MDX', + /** TEXT */ + ContentTypeText = 'TEXT', + /** GUI 卡片 */ + ContentTypeClip = 'CLIP', + /** SmartCard */ + ContentTypeSmartCard = 'SmartCard', + /** JSON */ + ContentTypeJSON = 'JSON', +} export interface AilyMessageFile { /** 文件 ID */ @@ -769,7 +780,12 @@ export interface AilyMessageFilePreview { expired_at?: string } -export type AilyMessageStatus = 'IN_PROGRESS' | 'COMPLETED' +export const enum AilyMessageStatus { + /** 生成中 */ + MessageStatusInProgress = 'IN_PROGRESS', + /** 已完成 */ + MessageStatusCompleted = 'COMPLETED', +} export interface AilySender { /** 实体 ID */ @@ -782,7 +798,12 @@ export interface AilySender { aily_id?: string } -export type AilySenderType = 'USER' | 'ASSISTANT' +export const enum AilySenderType { + /** 用户 */ + SenderTypeUser = 'USER', + /** 应用 */ + SenderTypeAssistant = 'ASSISTANT', +} export interface AilySession { /** 会话 ID */ @@ -1486,7 +1507,7 @@ export interface AppRoleTableRole { /** 记录筛选条件,在table_perm为1或2时有意义,用于指定可编辑或可阅读某些记录 */ rec_rule?: AppRoleTableRoleRecRule /** 字段权限,仅在table_perm为2时有意义,设置字段可编辑或可阅读 */ - field_perm?: unknown + field_perm?: Record /** 新增记录权限,仅在table_perm为2时有意义,用于设置记录是否可以新增 */ allow_add_record?: boolean /** 删除记录权限,仅在table_perm为2时有意义,用于设置记录是否可以删除 */ @@ -1902,17 +1923,17 @@ export interface AppTableFormPatchedField { export interface AppTableRecord { /** 记录字段 */ - fields: unknown + fields: Record /** 记录Id */ record_id?: string /** 创建人 */ created_by?: Person /** 创建时间 */ - created_time?: unknown + created_time?: number /** 修改人 */ last_modified_by?: Person /** 最近更新时间 */ - last_modified_time?: unknown + last_modified_time?: number /** 记录分享链接(批量获取记录接口将返回该字段) */ shared_url?: string /** 记录链接(检索记录接口将返回该字段) */ @@ -4277,7 +4298,7 @@ export interface Contract { } export interface ContractCompany { - id?: unknown + id?: number name?: string } @@ -4693,9 +4714,9 @@ export interface DataAsset { /** 数据知识ID */ data_asset_id?: string /** 数据知识标题 */ - label?: unknown + label?: Record /** 数据知识描述 */ - description?: unknown + description?: Record /** 数据资源类型 */ data_source_type?: 'excel' | 'pdf' | 'pptx' | 'txt' | 'docx' | 'mysql' | 'postgresql' | 'larkbase' | 'salesforce' | 'fenxiangxiaoke' | 'qianchuan' | 'clickhouse' | 'databricks' | 'servicedesk' | 'larkbiz_wiki' | 'larkbiz_doc' | 'larkbiz_docs' | 'larkbiz_docx' | 'larkbiz_pdf' | 'larkbiz_word' | 'larkbiz_pptx' | 'larkbiz_sheets' | 'larkbiz_base' | 'larkbiz_personalfolder' | 'larkbiz_sharedfolder' | 'object' /** 数据连接状态 */ @@ -4720,9 +4741,9 @@ export interface DataAssetItem { /** 数据知识项标识 */ api_name?: string /** 数据知识项标题 */ - label?: unknown + label?: Record /** 数据知识项描述 */ - description?: unknown + description?: Record /** 数据知识资源 */ resources?: DataAssetResource[] } @@ -5426,7 +5447,9 @@ export interface EducationInfo { custom_fields?: ObjectFieldData[] } -export type EeKunlunCommonI18nI18nText = unknown +export type EeKunlunCommonI18nI18nText = Record + +export type EeKunlunCommonI18nLanguageCode = string export interface Email { /** 邮箱地址 */ @@ -7268,7 +7291,12 @@ export interface IdEntity { value?: string } -export type IdentityProvider = 'AILY' | 'FEISHU' +export const enum IdentityProvider { + /** Aily 账号体系 */ + IdentityProviderAily = 'AILY', + /** 飞书账号体系 */ + IdentityProviderFeishu = 'FEISHU', +} export interface IdInfo { /** 传入的 ID */ @@ -8088,7 +8116,7 @@ export interface JiraIssue { } export interface Job { - id?: unknown + id?: number name?: string } @@ -11105,7 +11133,7 @@ export interface OpenAppFeedCardButton { /** 按钮类型 */ button_type?: 'default' | 'primary' | 'success' /** action 字典 */ - action_map?: unknown + action_map?: Record } export interface OpenAppFeedCardButtons { @@ -14199,7 +14227,22 @@ export interface RunError { message: string } -export type RunStatus = 'QUEUED' | 'IN_PROGRESS' | 'REQUIRES_MESSAGE' | 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'EXPIRED' +export const enum RunStatus { + /** 排队中 */ + RunStatusQueued = 'QUEUED', + /** 执行中 */ + RunStatusInProgress = 'IN_PROGRESS', + /** 等待补充消息输入 */ + RunStatusRequiresMessage = 'REQUIRES_MESSAGE', + /** 已取消 */ + RunStatusCancelled = 'CANCELLED', + /** 已完成 */ + RunStatusCompleted = 'COMPLETED', + /** 已失败 */ + RunStatusFailed = 'FAILED', + /** 已过期 */ + RunStatusExpired = 'EXPIRED', +} export interface Schema { /** UI项名称 TODO文档 */ @@ -14963,9 +15006,9 @@ export interface SystemFields { /** 入职登记表状态 */ employee_form_status?: 1 | 2 | 3 /** 创建时间 */ - create_time?: unknown + create_time?: number /** 更新时间 */ - update_time?: unknown + update_time?: number } export interface SystemStatus { @@ -16052,11 +16095,11 @@ export interface Ticket { /** ticket score */ score?: number /** the time when the ticket is created */ - created_at?: unknown + created_at?: number /** the time when the ticket is updated */ - updated_at?: unknown + updated_at?: number /** the time when the ticket is closed */ - closed_at?: unknown + closed_at?: number /** 不满意原因 */ dissatisfaction_reason?: I18n /** agents of this ticket */ @@ -16074,19 +16117,19 @@ export interface Ticket { /** 客服服务时长,客服最后一次回复时间距离客服进入时间间隔,单位秒 */ agent_service_duration?: number /** 客服首次回复时间距离客服进入时间的间隔,单位秒 */ - agent_first_response_duration?: unknown + agent_first_response_duration?: number /** 机器人服务时间:客服进入时间距离工单创建时间的间隔,单位秒 */ - bot_service_duration?: unknown + bot_service_duration?: number /** 客服解决时长,关单时间距离客服进入时间的间隔,单位秒 */ - agent_resolution_time?: unknown + agent_resolution_time?: number /** 工单实际处理时间:从客服进入到关单,单位秒 */ - actual_processing_time?: unknown + actual_processing_time?: number /** 客服进入时间,单位毫秒 */ - agent_entry_time?: unknown + agent_entry_time?: number /** 客服首次回复时间,单位毫秒 */ - agent_first_response_time?: unknown + agent_first_response_time?: number /** 客服最后回复时间,单位毫秒 */ - agent_last_response_time?: unknown + agent_last_response_time?: number /** 主责客服 */ agent_owner?: TicketUser } @@ -17722,7 +17765,7 @@ export interface WorkingHoursType { } export interface WorkLocation { - id?: unknown + id?: number name?: string } diff --git a/adapters/lark/src/types/lingo.ts b/adapters/lark/src/types/lingo.ts index b3f9bf5e..660a4888 100644 --- a/adapters/lark/src/types/lingo.ts +++ b/adapters/lark/src/types/lingo.ts @@ -102,6 +102,10 @@ export interface CreateLingoDraftQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateLingoDraftResponse { + draft?: Draft +} + export interface UpdateLingoDraftRequest { /** 实体词 Id */ id?: string @@ -124,6 +128,10 @@ export interface UpdateLingoDraftQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface UpdateLingoDraftResponse { + draft?: Draft +} + export interface CreateLingoEntityRequest { /** 词条名 */ main_keys: Term[] @@ -148,6 +156,10 @@ export interface CreateLingoEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateLingoEntityResponse { + entity?: Entity +} + export interface UpdateLingoEntityRequest { /** 词条名 */ main_keys: Term[] @@ -170,6 +182,10 @@ export interface UpdateLingoEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface UpdateLingoEntityResponse { + entity?: Entity +} + export interface DeleteLingoEntityQuery { /** 数据提供方(使用时需要将路径中的词条 ID 固定为:enterprise_0,且提供 provider 和 outer_id) */ provider?: string @@ -186,6 +202,11 @@ export interface GetLingoEntityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetLingoEntityResponse { + /** 实体词 */ + entity?: Entity +} + export interface ListLingoEntityQuery extends Pagination { /** 数据提供方【可用来过滤数据】 */ provider?: string @@ -205,6 +226,11 @@ export interface MatchLingoEntityQuery { repo_id?: string } +export interface MatchLingoEntityResponse { + /** 匹配结果 */ + results?: MatchInfo[] +} + export interface SearchLingoEntityRequest { /** 搜索关键词 */ query?: string @@ -228,11 +254,21 @@ export interface HighlightLingoEntityRequest { text: string } +export interface HighlightLingoEntityResponse { + /** 返回识别到的实体词信息 */ + phrases?: Phrase[] +} + export interface ListLingoClassificationQuery extends Pagination { /** 词库ID */ repo_id?: string } +export interface ListLingoRepoResponse { + /** 词库列表 */ + items?: Repo[] +} + export interface UploadLingoFileForm { /** 文件名称,当前仅支持上传图片且图片格式为以下六种:icon、bmp、gif、png、jpeg、webp */ name: string @@ -240,42 +276,6 @@ export interface UploadLingoFileForm { file: Blob } -export interface CreateLingoDraftResponse { - draft?: Draft -} - -export interface UpdateLingoDraftResponse { - draft?: Draft -} - -export interface CreateLingoEntityResponse { - entity?: Entity -} - -export interface UpdateLingoEntityResponse { - entity?: Entity -} - -export interface GetLingoEntityResponse { - /** 实体词 */ - entity?: Entity -} - -export interface MatchLingoEntityResponse { - /** 匹配结果 */ - results?: MatchInfo[] -} - -export interface HighlightLingoEntityResponse { - /** 返回识别到的实体词信息 */ - phrases?: Phrase[] -} - -export interface ListLingoRepoResponse { - /** 词库列表 */ - items?: Repo[] -} - export interface UploadLingoFileResponse { /** 文件 token */ file_token?: string diff --git a/adapters/lark/src/types/mail.ts b/adapters/lark/src/types/mail.ts index 7a8a5967..0baccc7c 100644 --- a/adapters/lark/src/types/mail.ts +++ b/adapters/lark/src/types/mail.ts @@ -270,6 +270,25 @@ export interface CreateMailMailgroupRequest { who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' } +export interface CreateMailMailgroupResponse { + /** The unique ID of a mail group */ + mailgroup_id?: string + /** The mail group's email address */ + email?: string + /** The mail group's display name */ + name?: string + /** The mail group's description */ + description?: string + /** The number of mail group's direct members */ + direct_members_count?: string + /** Value is true if this mail group has external member */ + include_external_member?: boolean + /** Value is true if all company members are in this mail group */ + include_all_company_member?: boolean + /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ + who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' +} + export interface PatchMailMailgroupRequest { /** The public mailbox's new primary email address */ email?: string @@ -281,6 +300,25 @@ export interface PatchMailMailgroupRequest { who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' } +export interface PatchMailMailgroupResponse { + /** The unique ID of a mail group */ + mailgroup_id?: string + /** The mail group's email address */ + email?: string + /** The mail group's display name */ + name?: string + /** The mail group's description */ + description?: string + /** The number of mail group's direct members */ + direct_members_count?: string + /** Value is true if this mail group has external member */ + include_external_member?: boolean + /** Value is true if all company members are in this mail group */ + include_all_company_member?: boolean + /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ + who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' +} + export interface UpdateMailMailgroupRequest { /** The public mailbox's new primary email address */ email?: string @@ -292,6 +330,44 @@ export interface UpdateMailMailgroupRequest { who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' } +export interface UpdateMailMailgroupResponse { + /** The unique ID of a mail group */ + mailgroup_id?: string + /** The mail group's email address */ + email?: string + /** The mail group's display name */ + name?: string + /** The mail group's description */ + description?: string + /** The number of mail group's direct members */ + direct_members_count?: string + /** Value is true if this mail group has external member */ + include_external_member?: boolean + /** Value is true if all company members are in this mail group */ + include_all_company_member?: boolean + /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ + who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' +} + +export interface GetMailMailgroupResponse { + /** The unique ID of a mail group */ + mailgroup_id?: string + /** The mail group's email address */ + email?: string + /** The mail group's display name */ + name?: string + /** The mail group's description */ + description?: string + /** The number of mail group's direct members */ + direct_members_count?: string + /** Value is true if this mail group has external member */ + include_external_member?: boolean + /** Value is true if all company members are in this mail group */ + include_all_company_member?: boolean + /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ + who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' +} + export interface ListMailMailgroupQuery extends Pagination { /** 邮件组管理员用户ID,用于获取该用户有管理权限的邮件组 */ manager_user_id?: string @@ -342,6 +418,19 @@ export interface CreateMailMailgroupMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface CreateMailMailgroupMemberResponse { + /** The unique ID of a member in this mail group */ + member_id?: string + /** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */ + email?: string + /** The member's user id. Value is valid when type is USER */ + user_id?: string + /** The member's department id. Value is valid when type is DEPARTMENT */ + department_id?: string + /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */ + type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER' +} + export interface GetMailMailgroupMemberQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -349,6 +438,19 @@ export interface GetMailMailgroupMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface GetMailMailgroupMemberResponse { + /** The unique ID of a member in this mail group */ + member_id?: string + /** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */ + email?: string + /** The member's user id. Value is valid when type is USER */ + user_id?: string + /** The member's department id. Value is valid when type is DEPARTMENT */ + department_id?: string + /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */ + type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER' +} + export interface ListMailMailgroupMemberQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -368,6 +470,11 @@ export interface BatchCreateMailMailgroupMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface BatchCreateMailMailgroupMemberResponse { + /** 添加成功后的邮件组成员信息列表 */ + items?: MailgroupMember[] +} + export interface BatchDeleteMailMailgroupMemberRequest { /** 本次调用删除的成员ID列表 */ member_id_list?: string[] @@ -378,6 +485,16 @@ export interface CreateMailMailgroupAliasRequest { email_alias?: string } +export interface CreateMailMailgroupAliasResponse { + /** 邮件组别名 */ + mailgroup_alias?: EmailAlias +} + +export interface ListMailMailgroupAliasResponse { + /** 邮件组别名 */ + items?: EmailAlias[] +} + export interface CreateMailMailgroupPermissionMemberRequest { /** The member's user id. Value is valid when type is USER */ user_id?: string @@ -396,6 +513,19 @@ export interface CreateMailMailgroupPermissionMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface CreateMailMailgroupPermissionMemberResponse { + /** The unique ID of a member in this permission group */ + permission_member_id?: string + /** The member's user id. Value is valid when type is USER */ + user_id?: string + /** The member's department id. Value is valid when type is DEPARTMENT */ + department_id?: string + /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */ + email?: string + /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */ + type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' +} + export interface GetMailMailgroupPermissionMemberQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -403,6 +533,19 @@ export interface GetMailMailgroupPermissionMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface GetMailMailgroupPermissionMemberResponse { + /** The unique ID of a member in this permission group */ + permission_member_id?: string + /** The member's user id. Value is valid when type is USER */ + user_id?: string + /** The member's department id. Value is valid when type is DEPARTMENT */ + department_id?: string + /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */ + email?: string + /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */ + type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' +} + export interface ListMailMailgroupPermissionMemberQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -422,6 +565,11 @@ export interface BatchCreateMailMailgroupPermissionMemberQuery { department_id_type?: 'department_id' | 'open_department_id' } +export interface BatchCreateMailMailgroupPermissionMemberResponse { + /** 添加成功后的邮件组权限成员信息列表 */ + items?: MailgroupPermissionMember[] +} + export interface BatchDeleteMailMailgroupPermissionMemberRequest { /** 本次调用删除的权限成员ID列表 */ permission_member_id_list: string[] @@ -436,240 +584,35 @@ export interface CreateMailPublicMailboxRequest { geo?: string } -export interface PatchMailPublicMailboxRequest { - /** The public mailbox's new primary email address */ +export interface CreateMailPublicMailboxResponse { + /** The unique ID of a public mailbox */ + public_mailbox_id?: string + /** The public mailbox's email address */ email?: string /** The public mailbox's display name */ name?: string + /** 数据驻留地 */ + geo?: string } -export interface UpdateMailPublicMailboxRequest { +export interface PatchMailPublicMailboxRequest { /** The public mailbox's new primary email address */ email?: string /** The public mailbox's display name */ name?: string } -export interface CreateMailPublicMailboxMemberRequest { - /** The member's user id. Value is valid when type is USER */ - user_id?: string - /** The type of member. Possible values are:- USER: internal user in the team */ - type?: 'USER' -} - -export interface CreateMailPublicMailboxMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface GetMailPublicMailboxMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface ListMailPublicMailboxMemberQuery extends Pagination { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface BatchCreateMailPublicMailboxMemberRequest { - /** 本次调用添加的公共邮箱成员列表 */ - items: PublicMailboxMember[] -} - -export interface BatchCreateMailPublicMailboxMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface BatchDeleteMailPublicMailboxMemberRequest { - /** 本次调用删除的公共邮箱成员ID列表 */ - member_id_list: string[] -} - -export interface CreateMailPublicMailboxAliasRequest { - /** 邮箱别名 */ - email_alias?: string -} - -export interface DeleteMailUserMailboxQuery { - /** 用于接受转移的邮箱地址 */ - transfer_mailbox?: string -} - -export interface CreateMailUserMailboxAliasRequest { - /** 邮箱别名 */ - email_alias?: string -} - -export interface QueryMailUserRequest { - /** 需要查询的邮箱地址列表 */ - email_list: string[] -} - -export interface CreateMailMailgroupResponse { - /** The unique ID of a mail group */ - mailgroup_id?: string - /** The mail group's email address */ - email?: string - /** The mail group's display name */ - name?: string - /** The mail group's description */ - description?: string - /** The number of mail group's direct members */ - direct_members_count?: string - /** Value is true if this mail group has external member */ - include_external_member?: boolean - /** Value is true if all company members are in this mail group */ - include_all_company_member?: boolean - /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ - who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' -} - -export interface PatchMailMailgroupResponse { - /** The unique ID of a mail group */ - mailgroup_id?: string - /** The mail group's email address */ - email?: string - /** The mail group's display name */ - name?: string - /** The mail group's description */ - description?: string - /** The number of mail group's direct members */ - direct_members_count?: string - /** Value is true if this mail group has external member */ - include_external_member?: boolean - /** Value is true if all company members are in this mail group */ - include_all_company_member?: boolean - /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ - who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' -} - -export interface UpdateMailMailgroupResponse { - /** The unique ID of a mail group */ - mailgroup_id?: string - /** The mail group's email address */ - email?: string - /** The mail group's display name */ - name?: string - /** The mail group's description */ - description?: string - /** The number of mail group's direct members */ - direct_members_count?: string - /** Value is true if this mail group has external member */ - include_external_member?: boolean - /** Value is true if all company members are in this mail group */ - include_all_company_member?: boolean - /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ - who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' -} - -export interface GetMailMailgroupResponse { - /** The unique ID of a mail group */ - mailgroup_id?: string - /** The mail group's email address */ - email?: string - /** The mail group's display name */ - name?: string - /** The mail group's description */ - description?: string - /** The number of mail group's direct members */ - direct_members_count?: string - /** Value is true if this mail group has external member */ - include_external_member?: boolean - /** Value is true if all company members are in this mail group */ - include_all_company_member?: boolean - /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */ - who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS' -} - -export interface CreateMailMailgroupMemberResponse { - /** The unique ID of a member in this mail group */ - member_id?: string - /** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */ - email?: string - /** The member's user id. Value is valid when type is USER */ - user_id?: string - /** The member's department id. Value is valid when type is DEPARTMENT */ - department_id?: string - /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */ - type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER' -} - -export interface GetMailMailgroupMemberResponse { - /** The unique ID of a member in this mail group */ - member_id?: string - /** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */ - email?: string - /** The member's user id. Value is valid when type is USER */ - user_id?: string - /** The member's department id. Value is valid when type is DEPARTMENT */ - department_id?: string - /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */ - type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER' -} - -export interface BatchCreateMailMailgroupMemberResponse { - /** 添加成功后的邮件组成员信息列表 */ - items?: MailgroupMember[] -} - -export interface CreateMailMailgroupAliasResponse { - /** 邮件组别名 */ - mailgroup_alias?: EmailAlias -} - -export interface ListMailMailgroupAliasResponse { - /** 邮件组别名 */ - items?: EmailAlias[] -} - -export interface CreateMailMailgroupPermissionMemberResponse { - /** The unique ID of a member in this permission group */ - permission_member_id?: string - /** The member's user id. Value is valid when type is USER */ - user_id?: string - /** The member's department id. Value is valid when type is DEPARTMENT */ - department_id?: string - /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */ - email?: string - /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */ - type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' -} - -export interface GetMailMailgroupPermissionMemberResponse { - /** The unique ID of a member in this permission group */ - permission_member_id?: string - /** The member's user id. Value is valid when type is USER */ - user_id?: string - /** The member's department id. Value is valid when type is DEPARTMENT */ - department_id?: string - /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */ - email?: string - /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */ - type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' -} - -export interface BatchCreateMailMailgroupPermissionMemberResponse { - /** 添加成功后的邮件组权限成员信息列表 */ - items?: MailgroupPermissionMember[] -} - -export interface CreateMailPublicMailboxResponse { +export interface PatchMailPublicMailboxResponse { /** The unique ID of a public mailbox */ public_mailbox_id?: string /** The public mailbox's email address */ email?: string /** The public mailbox's display name */ name?: string - /** 数据驻留地 */ - geo?: string } -export interface PatchMailPublicMailboxResponse { - /** The unique ID of a public mailbox */ - public_mailbox_id?: string - /** The public mailbox's email address */ +export interface UpdateMailPublicMailboxRequest { + /** The public mailbox's new primary email address */ email?: string /** The public mailbox's display name */ name?: string @@ -695,6 +638,18 @@ export interface GetMailPublicMailboxResponse { geo?: string } +export interface CreateMailPublicMailboxMemberRequest { + /** The member's user id. Value is valid when type is USER */ + user_id?: string + /** The type of member. Possible values are:- USER: internal user in the team */ + type?: 'USER' +} + +export interface CreateMailPublicMailboxMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface CreateMailPublicMailboxMemberResponse { /** The unique ID of a member in this public mailbox */ member_id?: string @@ -704,6 +659,11 @@ export interface CreateMailPublicMailboxMemberResponse { type?: 'USER' } +export interface GetMailPublicMailboxMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetMailPublicMailboxMemberResponse { /** The unique ID of a member in this public mailbox */ member_id?: string @@ -713,11 +673,36 @@ export interface GetMailPublicMailboxMemberResponse { type?: 'USER' } +export interface ListMailPublicMailboxMemberQuery extends Pagination { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchCreateMailPublicMailboxMemberRequest { + /** 本次调用添加的公共邮箱成员列表 */ + items: PublicMailboxMember[] +} + +export interface BatchCreateMailPublicMailboxMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface BatchCreateMailPublicMailboxMemberResponse { /** 添加成功后的公共邮箱成员信息列表 */ items?: PublicMailboxMember[] } +export interface BatchDeleteMailPublicMailboxMemberRequest { + /** 本次调用删除的公共邮箱成员ID列表 */ + member_id_list: string[] +} + +export interface CreateMailPublicMailboxAliasRequest { + /** 邮箱别名 */ + email_alias?: string +} + export interface CreateMailPublicMailboxAliasResponse { /** 公共邮箱别名 */ public_mailbox_alias?: EmailAlias @@ -728,6 +713,16 @@ export interface ListMailPublicMailboxAliasResponse { items?: EmailAlias[] } +export interface DeleteMailUserMailboxQuery { + /** 用于接受转移的邮箱地址 */ + transfer_mailbox?: string +} + +export interface CreateMailUserMailboxAliasRequest { + /** 邮箱别名 */ + email_alias?: string +} + export interface CreateMailUserMailboxAliasResponse { /** 用户邮箱别名 */ user_mailbox_alias?: EmailAlias @@ -738,6 +733,11 @@ export interface ListMailUserMailboxAliasResponse { items?: EmailAlias[] } +export interface QueryMailUserRequest { + /** 需要查询的邮箱地址列表 */ + email_list: string[] +} + export interface QueryMailUserResponse { /** 邮箱地址返回 */ user_list?: User[] diff --git a/adapters/lark/src/types/minutes.ts b/adapters/lark/src/types/minutes.ts index 7ae9827e..d6e63a3f 100644 --- a/adapters/lark/src/types/minutes.ts +++ b/adapters/lark/src/types/minutes.ts @@ -21,16 +21,16 @@ export interface GetMinutesMinuteStatisticsQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetMinutesMinuteQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - export interface GetMinutesMinuteStatisticsResponse { /** 妙记浏览信息统计 */ statistics?: Statictics } +export interface GetMinutesMinuteQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + export interface GetMinutesMinuteResponse { /** 妙记基本信息 */ minute?: Minute diff --git a/adapters/lark/src/types/okr.ts b/adapters/lark/src/types/okr.ts index 2293ef18..f8397e2a 100644 --- a/adapters/lark/src/types/okr.ts +++ b/adapters/lark/src/types/okr.ts @@ -73,9 +73,48 @@ export interface CreateOkrPeriodRequest { start_month: string } +export interface CreateOkrPeriodResponse { + /** 周期id */ + period_id?: string + /** 周期起始年月 */ + start_month?: string + /** 周期结束年月 */ + end_month?: string +} + +export const enum PatchOkrPeriodRequestStatus { + /** 正常状态 */ + NormalStatus = 1, + /** 标记失效 */ + MarkInvalid = 2, + /** 隐藏周期 */ + HiddenPeriod = 3, +} + export interface PatchOkrPeriodRequest { /** 周期显示状态 */ - status: 1 | 2 | 3 + status: PatchOkrPeriodRequestStatus +} + +export const enum PatchOkrPeriodResponseStatus { + /** 正常状态 */ + NormalStatus = 1, + /** 标记失效 */ + MarkInvalid = 2, + /** 隐藏周期 */ + HiddenPeriod = 3, +} + +export interface PatchOkrPeriodResponse { + /** 周期规则id */ + period_id?: string + /** 周期显示状态 */ + status?: PatchOkrPeriodResponseStatus +} + +export interface ListOkrPeriodRuleResponse { + /** 指标库列表 */ + period_rules?: PeriodRule[] } export interface ListOkrUserOkrQuery { @@ -91,6 +130,13 @@ export interface ListOkrUserOkrQuery { period_ids?: string[] } +export interface ListOkrUserOkrResponse { + /** OKR周期总数 */ + total?: number + /** OKR 列表 */ + okr_list?: OkrBatch[] +} + export interface BatchGetOkrQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' @@ -100,6 +146,18 @@ export interface BatchGetOkrQuery { lang?: string } +export interface BatchGetOkrResponse { + /** OKR 列表 */ + okr_list?: OkrBatch[] +} + +export const enum CreateOkrProgressRecordRequestTargetType { + /** okr的O */ + Objective = 2, + /** okr的KR */ + KeyResult = 3, +} + export interface CreateOkrProgressRecordRequest { /** 进展来源 */ source_title: string @@ -108,7 +166,7 @@ export interface CreateOkrProgressRecordRequest { /** 目标id,与target_type对应 */ target_id: string /** 目标类型 */ - target_type: 2 | 3 + target_type: CreateOkrProgressRecordRequestTargetType /** 进展详情 富文本格式 */ content: ContentBlock /** pc进展来源链接 */ @@ -122,6 +180,15 @@ export interface CreateOkrProgressRecordQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateOkrProgressRecordResponse { + /** OKR 进展ID */ + progress_id?: string + /** 进展更新时间 毫秒 */ + modify_time?: string + /** 进展 对应的 Content 详细内容 */ + content?: ContentBlock +} + export interface UpdateOkrProgressRecordRequest { /** 进展详情 富文本格式 */ content: ContentBlock @@ -132,63 +199,7 @@ export interface UpdateOkrProgressRecordQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface GetOkrProgressRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface UploadOkrImageForm { - /** 图片 */ - data: Blob - /** 图片的目标ID */ - target_id: string - /** 图片使用的目标类型 */ - target_type: 2 | 3 -} - -export interface QueryOkrReviewQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' - /** 目标用户id列表,最多5个 */ - user_ids: string[] - /** period_id列表,最多5个 */ - period_ids: string[] -} - -export interface CreateOkrPeriodResponse { - /** 周期id */ - period_id?: string - /** 周期起始年月 */ - start_month?: string - /** 周期结束年月 */ - end_month?: string -} - -export interface PatchOkrPeriodResponse { - /** 周期规则id */ - period_id?: string - /** 周期显示状态 */ - status?: 1 | 2 | 3 -} - -export interface ListOkrPeriodRuleResponse { - /** 指标库列表 */ - period_rules?: PeriodRule[] -} - -export interface ListOkrUserOkrResponse { - /** OKR周期总数 */ - total?: number - /** OKR 列表 */ - okr_list?: OkrBatch[] -} - -export interface BatchGetOkrResponse { - /** OKR 列表 */ - okr_list?: OkrBatch[] -} - -export interface CreateOkrProgressRecordResponse { +export interface UpdateOkrProgressRecordResponse { /** OKR 进展ID */ progress_id?: string /** 进展更新时间 毫秒 */ @@ -197,13 +208,9 @@ export interface CreateOkrProgressRecordResponse { content?: ContentBlock } -export interface UpdateOkrProgressRecordResponse { - /** OKR 进展ID */ - progress_id?: string - /** 进展更新时间 毫秒 */ - modify_time?: string - /** 进展 对应的 Content 详细内容 */ - content?: ContentBlock +export interface GetOkrProgressRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' } export interface GetOkrProgressRecordResponse { @@ -215,6 +222,22 @@ export interface GetOkrProgressRecordResponse { content?: ContentBlock } +export const enum UploadOkrImageFormTargetType { + /** okr的O */ + Objective = 2, + /** okr的KR */ + KeyResult = 3, +} + +export interface UploadOkrImageForm { + /** 图片 */ + data: Blob + /** 图片的目标ID */ + target_id: string + /** 图片使用的目标类型 */ + target_type: UploadOkrImageFormTargetType +} + export interface UploadOkrImageResponse { /** 图片token */ file_token?: string @@ -222,6 +245,15 @@ export interface UploadOkrImageResponse { url?: string } +export interface QueryOkrReviewQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 目标用户id列表,最多5个 */ + user_ids: string[] + /** period_id列表,最多5个 */ + period_ids: string[] +} + export interface QueryOkrReviewResponse { /** OKR复盘 列表 */ review_list?: OkrReview[] diff --git a/adapters/lark/src/types/passport.ts b/adapters/lark/src/types/passport.ts index 88e15c0d..341235fc 100644 --- a/adapters/lark/src/types/passport.ts +++ b/adapters/lark/src/types/passport.ts @@ -26,11 +26,25 @@ export interface QueryPassportSessionQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface QueryPassportSessionResponse { + /** session信息 */ + mask_sessions?: MaskSession[] +} + +export const enum LogoutPassportSessionRequestLogoutType { + /** UserID */ + UserID = 1, + /** IdpCredentialID */ + IdpCredentialID = 2, + /** Session 标识符 */ + SessionUUID = 3, +} + export interface LogoutPassportSessionRequest { /** idp 侧的唯一标识 */ idp_credential_id?: string /** 登出的方式 */ - logout_type: 1 | 2 | 3 + logout_type: LogoutPassportSessionRequestLogoutType /** 登出的客户端类型,默认全部登出,1-桌面端,2-网页端,3-安卓移动端,4-Apple移动端 5-服务端 6-旧版小程序端 8-其他移动端 */ terminal_type?: number[] /** user_id */ @@ -46,11 +60,6 @@ export interface LogoutPassportSessionQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } -export interface QueryPassportSessionResponse { - /** session信息 */ - mask_sessions?: MaskSession[] -} - Internal.define({ '/passport/v1/sessions/query': { POST: 'queryPassportSession', diff --git a/adapters/lark/src/types/payroll.ts b/adapters/lark/src/types/payroll.ts index a51b46b3..4ff6f01c 100644 --- a/adapters/lark/src/types/payroll.ts +++ b/adapters/lark/src/types/payroll.ts @@ -26,18 +26,22 @@ declare module '../internal' { } } +export const enum ListPayrollCostAllocationReportQueryReportType { + /** 默认 */ + Default = 0, + /** 计提 */ + Accrued = 1, + /** 实发 */ + Paid = 2, +} + export interface ListPayrollCostAllocationReportQuery extends Pagination { /** 成本分摊方案ID */ cost_allocation_plan_id: string /** 期间 */ pay_period: string /** 报表类型 */ - report_type: 0 | 1 | 2 -} - -export interface ListPayrollCostAllocationPlanQuery extends Pagination { - /** 期间 */ - pay_period: string + report_type: ListPayrollCostAllocationReportQueryReportType } export interface ListPayrollCostAllocationReportResponse { @@ -53,6 +57,11 @@ export interface ListPayrollCostAllocationReportResponse { cost_allocation_report_datas?: CostAllocationReportData[] } +export interface ListPayrollCostAllocationPlanQuery extends Pagination { + /** 期间 */ + pay_period: string +} + Internal.define({ '/payroll/v1/acct_items': { GET: { name: 'listPayrollAcctItem', pagination: { argIndex: 0 } }, diff --git a/adapters/lark/src/types/performance.ts b/adapters/lark/src/types/performance.ts index 46320ab4..ac323e7c 100644 --- a/adapters/lark/src/types/performance.ts +++ b/adapters/lark/src/types/performance.ts @@ -121,6 +121,11 @@ export interface ListPerformanceV1SemesterQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ListPerformanceV1SemesterResponse { + /** 周期meta信息列表 */ + items?: Semester[] +} + export interface QueryPerformanceV2ActivityRequest { /** 评估周期 ID 列表,获取指定评估周期的项目 ID,semester_id 可通过【获取周期】接口获得 */ semester_ids?: string[] @@ -132,6 +137,11 @@ export interface QueryPerformanceV2ActivityQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface QueryPerformanceV2ActivityResponse { + /** 绩效评估项目列表。 */ + activities?: Activity[] +} + export interface QueryPerformanceV2AdditionalInformationRequest { /** 评估周期 ID 列表,semester_id 可通过【获取周期】接口获得 */ semester_id: string @@ -162,6 +172,13 @@ export interface ImportPerformanceV2AdditionalInformationQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface ImportPerformanceV2AdditionalInformationResponse { + /** 导入记录 ID */ + import_record_id?: string + /** 成功导入后的补充信息列表 */ + additional_informations?: AdditionalInformation[] +} + export interface DeletePerformanceV2AdditionalInformationsBatchRequest { /** 评估周期 ID 列表,semester_id 可通过【获取周期】接口获得 */ semester_id: string @@ -173,11 +190,23 @@ export interface DeletePerformanceV2AdditionalInformationsBatchQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface DeletePerformanceV2AdditionalInformationsBatchResponse { + /** 被删除的补充信息列表 */ + additional_informations?: string[] +} + +export const enum WritePerformanceV2UserGroupUserRelRequestScopeVisibleSetting { + /** 无限制 */ + NotLimit = 0, + /** 后台管理员不可见 */ + BackendAdminNotVisible = 1, +} + export interface WritePerformanceV2UserGroupUserRelRequest { /** 分组id key */ group_id?: string /** 人员组查看人员名单可见性配置 */ - scope_visible_setting?: 0 | 1 + scope_visible_setting?: WritePerformanceV2UserGroupUserRelRequestScopeVisibleSetting /** 人员列表 */ user_ids?: string[] } @@ -189,6 +218,11 @@ export interface WritePerformanceV2UserGroupUserRelQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface WritePerformanceV2UserGroupUserRelResponse { + /** 写入员工范围响应 */ + data?: WriteUserGroupScopeData +} + export interface QueryPerformanceV2RevieweeRequest { /** 周期 ID,1 次只允许查询 1 个周期,semester_id 可通过【获取周期】接口获得 */ semester_id: string @@ -202,6 +236,17 @@ export interface QueryPerformanceV2RevieweeQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface QueryPerformanceV2RevieweeResponse { + /** 周期ID */ + semester_id?: string + /** 被评估人列表 */ + reviewees?: Reviewee[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ + page_token?: string +} + export interface QueryPerformanceV2ReviewTemplateRequest { /** 评估模板 ID 列表,获取指定评估模板的配置数据。如果不传则返回所有 */ review_template_ids?: string[] @@ -250,6 +295,11 @@ export interface QueryPerformanceV2MetricFieldRequest { field_ids?: string[] } +export interface QueryPerformanceV2MetricFieldResponse { + /** 指标字段信息 */ + items?: MetricField[] +} + export interface ListPerformanceV2MetricTagQuery extends Pagination { /** 指标标签 ID 列表 */ tag_ids?: string[] @@ -273,6 +323,13 @@ export interface FindByUserListPerformanceV1StageTaskQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface FindByUserListPerformanceV1StageTaskResponse { + /** 周期基础信息 */ + base?: SemesterBaseInfo + /** 周期环节信息列表 */ + items?: StageTask[] +} + export interface FindByPagePerformanceV1StageTaskRequest { /** 周期ID,可以通过「查询周期」接口获得 */ semester_id: string @@ -293,6 +350,17 @@ export interface FindByPagePerformanceV1StageTaskQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface FindByPagePerformanceV1StageTaskResponse { + /** 周期基础信息 */ + base?: SemesterBaseInfo + /** 周期环节信息列表 */ + items?: StageTask[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string +} + export interface QueryPerformanceV2MetricDetailRequest { /** 周期 ID,1 次只允许查询 1 个周期,semester_id 可通过【获取周期】接口获得 */ semester_id: string @@ -304,6 +372,13 @@ export interface QueryPerformanceV2MetricDetailQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface QueryPerformanceV2MetricDetailResponse { + /** 周期ID */ + semester_id?: string + /** 指标明细列表 */ + reviewee_metrics?: RevieweeMetric[] +} + export interface ImportPerformanceV2MetricDetailRequest { /** 周期 ID,semester_id 可通过【获取周期】接口获得 */ semester_id: string @@ -320,6 +395,11 @@ export interface ImportPerformanceV2MetricDetailQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface ImportPerformanceV2MetricDetailResponse { + /** 成功时返回导入记录 ID,失败时则为 null */ + import_record_id?: string +} + export interface QueryPerformanceV1ReviewDataRequest { /** 查询范围的开始日期,毫秒级时间戳,开始日期不能晚于截止日期 */ start_time: string @@ -342,6 +422,23 @@ export interface QueryPerformanceV1ReviewDataQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } +export interface QueryPerformanceV1ReviewDataResponse { + /** 绩效评估周期列表 */ + semesters?: Semester[] + /** 绩效评估项目列表 */ + activities?: Activity[] + /** 评估项列表 */ + indicators?: Indicator[] + /** 评估模板列表 */ + templates?: Template[] + /** 评估内容列表 */ + units?: Unit[] + /** 填写项列表 */ + fields?: Field[] + /** 评估数据列表 */ + datas?: ReviewProfile[] +} + export interface QueryPerformanceV2ReviewDataRequest { /** 评估周期 ID 列表,semester_id 可通过【获取周期】 */ semester_ids: string[] @@ -365,96 +462,6 @@ export interface QueryPerformanceV2ReviewDataQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' } -export interface ListPerformanceV1SemesterResponse { - /** 周期meta信息列表 */ - items?: Semester[] -} - -export interface QueryPerformanceV2ActivityResponse { - /** 绩效评估项目列表。 */ - activities?: Activity[] -} - -export interface ImportPerformanceV2AdditionalInformationResponse { - /** 导入记录 ID */ - import_record_id?: string - /** 成功导入后的补充信息列表 */ - additional_informations?: AdditionalInformation[] -} - -export interface DeletePerformanceV2AdditionalInformationsBatchResponse { - /** 被删除的补充信息列表 */ - additional_informations?: string[] -} - -export interface WritePerformanceV2UserGroupUserRelResponse { - /** 写入员工范围响应 */ - data?: WriteUserGroupScopeData -} - -export interface QueryPerformanceV2RevieweeResponse { - /** 周期ID */ - semester_id?: string - /** 被评估人列表 */ - reviewees?: Reviewee[] - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */ - page_token?: string -} - -export interface QueryPerformanceV2MetricFieldResponse { - /** 指标字段信息 */ - items?: MetricField[] -} - -export interface FindByUserListPerformanceV1StageTaskResponse { - /** 周期基础信息 */ - base?: SemesterBaseInfo - /** 周期环节信息列表 */ - items?: StageTask[] -} - -export interface FindByPagePerformanceV1StageTaskResponse { - /** 周期基础信息 */ - base?: SemesterBaseInfo - /** 周期环节信息列表 */ - items?: StageTask[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string -} - -export interface QueryPerformanceV2MetricDetailResponse { - /** 周期ID */ - semester_id?: string - /** 指标明细列表 */ - reviewee_metrics?: RevieweeMetric[] -} - -export interface ImportPerformanceV2MetricDetailResponse { - /** 成功时返回导入记录 ID,失败时则为 null */ - import_record_id?: string -} - -export interface QueryPerformanceV1ReviewDataResponse { - /** 绩效评估周期列表 */ - semesters?: Semester[] - /** 绩效评估项目列表 */ - activities?: Activity[] - /** 评估项列表 */ - indicators?: Indicator[] - /** 评估模板列表 */ - templates?: Template[] - /** 评估内容列表 */ - units?: Unit[] - /** 填写项列表 */ - fields?: Field[] - /** 评估数据列表 */ - datas?: ReviewProfile[] -} - export interface QueryPerformanceV2ReviewDataResponse { /** 评估数据列表 */ datas?: ReviewProfile[] diff --git a/adapters/lark/src/types/personal_settings.ts b/adapters/lark/src/types/personal_settings.ts index a2fdb96a..5d2a4ee8 100644 --- a/adapters/lark/src/types/personal_settings.ts +++ b/adapters/lark/src/types/personal_settings.ts @@ -51,6 +51,11 @@ export interface CreatePersonalSettingsSystemStatusRequest { sync_setting?: SystemStatusSyncSetting } +export interface CreatePersonalSettingsSystemStatusResponse { + /** 系统状态 */ + system_status?: SystemStatus +} + export interface PatchPersonalSettingsSystemStatusRequest { /** 系统状态 */ system_status: SystemStatus @@ -58,6 +63,11 @@ export interface PatchPersonalSettingsSystemStatusRequest { update_fields: ('TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING')[] } +export interface PatchPersonalSettingsSystemStatusResponse { + /** 系统状态 */ + system_status?: SystemStatus +} + export interface BatchOpenPersonalSettingsSystemStatusRequest { /** 开启列表 */ user_list: SystemStatusUserOpenParam[] @@ -68,6 +78,11 @@ export interface BatchOpenPersonalSettingsSystemStatusQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchOpenPersonalSettingsSystemStatusResponse { + /** 开启结果 */ + result_list: SystemStatusUserOpenResultEntity[] +} + export interface BatchClosePersonalSettingsSystemStatusRequest { /** 成员列表 */ user_list: string[] @@ -78,21 +93,6 @@ export interface BatchClosePersonalSettingsSystemStatusQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface CreatePersonalSettingsSystemStatusResponse { - /** 系统状态 */ - system_status?: SystemStatus -} - -export interface PatchPersonalSettingsSystemStatusResponse { - /** 系统状态 */ - system_status?: SystemStatus -} - -export interface BatchOpenPersonalSettingsSystemStatusResponse { - /** 开启结果 */ - result_list: SystemStatusUserOpenResultEntity[] -} - export interface BatchClosePersonalSettingsSystemStatusResponse { /** 关闭结果 */ result_list: SystemStatusUserCloseResultEntity[] diff --git a/adapters/lark/src/types/report.ts b/adapters/lark/src/types/report.ts index e4132daa..bca29b98 100644 --- a/adapters/lark/src/types/report.ts +++ b/adapters/lark/src/types/report.ts @@ -21,15 +21,27 @@ declare module '../internal' { } } +export const enum QueryReportRuleQueryIncludeDeleted { + /** 不包括已删除 */ + Exclude = 0, + /** 包括已删除 */ + Include = 1, +} + export interface QueryReportRuleQuery { /** 规则名称 */ rule_name: string /** 是否包括已删除,默认未删除 */ - include_deleted?: 0 | 1 + include_deleted?: QueryReportRuleQueryIncludeDeleted /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface QueryReportRuleResponse { + /** 规则列表 */ + rules?: Rule[] +} + export interface RemoveReportRuleViewRequest { /** 列表为空删除规则下全用户视图,列表不为空删除指定用户视图,大小限制200。 */ user_ids?: string[] @@ -59,11 +71,6 @@ export interface QueryReportTaskQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface QueryReportRuleResponse { - /** 规则列表 */ - rules?: Rule[] -} - Internal.define({ '/report/v1/rules/query': { GET: 'queryReportRule', diff --git a/adapters/lark/src/types/search.ts b/adapters/lark/src/types/search.ts index 66cc2eba..49ce2458 100644 --- a/adapters/lark/src/types/search.ts +++ b/adapters/lark/src/types/search.ts @@ -112,11 +112,25 @@ export interface CreateSearchAppQuery extends Pagination { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum CreateSearchDataSourceRequestState { + /** 已上线 */ + Online = 0, + /** 未上线 */ + Offline = 1, +} + +export const enum CreateSearchDataSourceRequestConnectType { + /** 调用搜索请求时,使用的是飞书搜索接口 */ + Default = 0, + /** 调用搜索请求时,使用的是自定义回调函数的Uri */ + Callback = 1, +} + export interface CreateSearchDataSourceRequest { /** data_source的展示名称 */ name: string /** 数据源状态,0-已上线,1-未上线 */ - state?: 0 | 1 + state?: CreateSearchDataSourceRequestState /** 对于数据源的描述 */ description?: string /** 数据源在 search tab 上的展示图标路径 */ @@ -134,18 +148,30 @@ export interface CreateSearchDataSourceRequest { /** datasource对应的开放平台应用id */ app_id?: string /** 搜索请求的接入方式 */ - connect_type?: 0 | 1 + connect_type?: CreateSearchDataSourceRequestConnectType /** 根据连接器类型不同所需要提供的相关参数 */ connector_param?: ConnectorParam /** 是否使用问答服务 */ enable_answer?: boolean } +export interface CreateSearchDataSourceResponse { + /** 数据源实例 */ + data_source?: DataSource +} + +export const enum PatchSearchDataSourceRequestState { + /** 已上线 */ + Online = 0, + /** 未上线 */ + Offline = 1, +} + export interface PatchSearchDataSourceRequest { /** 数据源的展示名称 */ name?: string /** 数据源状态,0-已上线,1-未上线 */ - state?: 0 | 1 + state?: PatchSearchDataSourceRequestState /** 对于数据源的描述 */ description?: string /** 数据源在 search tab 上的展示图标路径 */ @@ -160,9 +186,26 @@ export interface PatchSearchDataSourceRequest { enable_answer?: boolean } +export interface PatchSearchDataSourceResponse { + /** 数据源 */ + data_source?: DataSource +} + +export interface GetSearchDataSourceResponse { + /** 数据源实例 */ + data_source?: DataSource +} + +export const enum ListSearchDataSourceQueryView { + /** 全量数据 */ + FULL = 0, + /** 摘要数据 */ + BASIC = 1, +} + export interface ListSearchDataSourceQuery extends Pagination { /** 回包数据格式,0-全量数据;1-摘要数据。**注**:摘要数据仅包含"id","name","state"。 */ - view?: 0 | 1 + view?: ListSearchDataSourceQueryView } export interface CreateSearchDataSourceItemRequest { @@ -178,6 +221,11 @@ export interface CreateSearchDataSourceItemRequest { content?: ItemContent } +export interface GetSearchDataSourceItemResponse { + /** 数据项实例 */ + item: Item +} + export interface CreateSearchSchemaRequest { /** 数据范式的属性定义 */ properties: SchemaProperty[] @@ -192,6 +240,11 @@ export interface CreateSearchSchemaQuery { validate_only?: boolean } +export interface CreateSearchSchemaResponse { + /** 数据范式实例 */ + schema?: Schema +} + export interface PatchSearchSchemaRequest { /** 数据展示相关配置 */ display?: SchemaDisplay @@ -199,31 +252,6 @@ export interface PatchSearchSchemaRequest { properties?: PatchSchemaProperty[] } -export interface CreateSearchDataSourceResponse { - /** 数据源实例 */ - data_source?: DataSource -} - -export interface PatchSearchDataSourceResponse { - /** 数据源 */ - data_source?: DataSource -} - -export interface GetSearchDataSourceResponse { - /** 数据源实例 */ - data_source?: DataSource -} - -export interface GetSearchDataSourceItemResponse { - /** 数据项实例 */ - item: Item -} - -export interface CreateSearchSchemaResponse { - /** 数据范式实例 */ - schema?: Schema -} - export interface PatchSearchSchemaResponse { /** 数据范式实例 */ schema?: Schema diff --git a/adapters/lark/src/types/sheets.ts b/adapters/lark/src/types/sheets.ts index 02cdc78d..faa8d82d 100644 --- a/adapters/lark/src/types/sheets.ts +++ b/adapters/lark/src/types/sheets.ts @@ -148,6 +148,11 @@ export interface CreateSheetsSpreadsheetRequest { folder_token?: string } +export interface CreateSheetsSpreadsheetResponse { + /** 表格信息 */ + spreadsheet?: Spreadsheet +} + export interface PatchSheetsSpreadsheetRequest { /** 表格标题 */ title?: string @@ -158,6 +163,21 @@ export interface GetSheetsSpreadsheetQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetSheetsSpreadsheetResponse { + /** 表格 */ + spreadsheet?: GetSpreadsheet +} + +export interface QuerySheetsSpreadsheetSheetResponse { + /** 工作表信息 */ + sheets?: Sheet[] +} + +export interface GetSheetsSpreadsheetSheetResponse { + /** 工作表 */ + sheet?: Sheet +} + export interface MoveDimensionSheetsSpreadsheetSheetRequest { /** 移动源位置参数 */ source?: Dimension @@ -172,6 +192,11 @@ export interface FindSheetsSpreadsheetSheetRequest { find: string } +export interface FindSheetsSpreadsheetSheetResponse { + /** 查找返回符合条件的信息 */ + find_result?: FindReplaceResult +} + export interface ReplaceSheetsSpreadsheetSheetRequest { /** 查找条件 */ find_condition: FindCondition @@ -181,6 +206,11 @@ export interface ReplaceSheetsSpreadsheetSheetRequest { replacement: string } +export interface ReplaceSheetsSpreadsheetSheetResponse { + /** 符合查找条件并替换的单元格信息 */ + replace_result?: FindReplaceResult +} + export interface CreateSheetsSpreadsheetSheetFilterRequest { /** 筛选应用范围 */ range: string @@ -197,6 +227,11 @@ export interface UpdateSheetsSpreadsheetSheetFilterRequest { condition: Condition } +export interface GetSheetsSpreadsheetSheetFilterResponse { + /** 筛选信息 */ + sheet_filter_info?: SheetFilterInfo +} + export interface CreateSheetsSpreadsheetSheetFilterViewRequest { /** 筛选视图 id */ filter_view_id?: string @@ -206,6 +241,11 @@ export interface CreateSheetsSpreadsheetSheetFilterViewRequest { range?: string } +export interface CreateSheetsSpreadsheetSheetFilterViewResponse { + /** 创建的筛选视图的 id 、name、range */ + filter_view?: FilterView +} + export interface PatchSheetsSpreadsheetSheetFilterViewRequest { /** 筛选视图名字 */ filter_view_name?: string @@ -213,6 +253,21 @@ export interface PatchSheetsSpreadsheetSheetFilterViewRequest { range?: string } +export interface PatchSheetsSpreadsheetSheetFilterViewResponse { + /** 更新后的筛选视图的 id 、name、range */ + filter_view?: FilterView +} + +export interface QuerySheetsSpreadsheetSheetFilterViewResponse { + /** 子表的所有筛选视图信息,id、name、range */ + items?: FilterView[] +} + +export interface GetSheetsSpreadsheetSheetFilterViewResponse { + /** 筛选视图信息,包括 id、name、range */ + filter_view?: FilterView +} + export interface CreateSheetsSpreadsheetSheetFilterViewConditionRequest { /** 设置筛选条件的列,使用字母号 */ condition_id?: string @@ -224,6 +279,11 @@ export interface CreateSheetsSpreadsheetSheetFilterViewConditionRequest { expected?: string[] } +export interface CreateSheetsSpreadsheetSheetFilterViewConditionResponse { + /** 创建的筛选条件 */ + condition?: FilterViewCondition +} + export interface UpdateSheetsSpreadsheetSheetFilterViewConditionRequest { /** 筛选类型 */ filter_type?: string @@ -233,6 +293,21 @@ export interface UpdateSheetsSpreadsheetSheetFilterViewConditionRequest { expected?: string[] } +export interface UpdateSheetsSpreadsheetSheetFilterViewConditionResponse { + /** 更新后的筛选条件 */ + condition?: FilterViewCondition +} + +export interface QuerySheetsSpreadsheetSheetFilterViewConditionResponse { + /** 筛选视图设置的所有筛选条件 */ + items?: FilterViewCondition[] +} + +export interface GetSheetsSpreadsheetSheetFilterViewConditionResponse { + /** 筛选的条件 */ + condition?: FilterViewCondition +} + export interface CreateSheetsSpreadsheetSheetFloatImageRequest { /** 浮动图片 id */ float_image_id?: string @@ -250,6 +325,11 @@ export interface CreateSheetsSpreadsheetSheetFloatImageRequest { offset_y?: number } +export interface CreateSheetsSpreadsheetSheetFloatImageResponse { + /** 浮动图片 */ + float_image?: FloatImage +} + export interface PatchSheetsSpreadsheetSheetFloatImageRequest { /** 浮动图片 token,需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */ float_image_token?: string @@ -265,86 +345,6 @@ export interface PatchSheetsSpreadsheetSheetFloatImageRequest { offset_y?: number } -export interface CreateSheetsSpreadsheetResponse { - /** 表格信息 */ - spreadsheet?: Spreadsheet -} - -export interface GetSheetsSpreadsheetResponse { - /** 表格 */ - spreadsheet?: GetSpreadsheet -} - -export interface QuerySheetsSpreadsheetSheetResponse { - /** 工作表信息 */ - sheets?: Sheet[] -} - -export interface GetSheetsSpreadsheetSheetResponse { - /** 工作表 */ - sheet?: Sheet -} - -export interface FindSheetsSpreadsheetSheetResponse { - /** 查找返回符合条件的信息 */ - find_result?: FindReplaceResult -} - -export interface ReplaceSheetsSpreadsheetSheetResponse { - /** 符合查找条件并替换的单元格信息 */ - replace_result?: FindReplaceResult -} - -export interface GetSheetsSpreadsheetSheetFilterResponse { - /** 筛选信息 */ - sheet_filter_info?: SheetFilterInfo -} - -export interface CreateSheetsSpreadsheetSheetFilterViewResponse { - /** 创建的筛选视图的 id 、name、range */ - filter_view?: FilterView -} - -export interface PatchSheetsSpreadsheetSheetFilterViewResponse { - /** 更新后的筛选视图的 id 、name、range */ - filter_view?: FilterView -} - -export interface QuerySheetsSpreadsheetSheetFilterViewResponse { - /** 子表的所有筛选视图信息,id、name、range */ - items?: FilterView[] -} - -export interface GetSheetsSpreadsheetSheetFilterViewResponse { - /** 筛选视图信息,包括 id、name、range */ - filter_view?: FilterView -} - -export interface CreateSheetsSpreadsheetSheetFilterViewConditionResponse { - /** 创建的筛选条件 */ - condition?: FilterViewCondition -} - -export interface UpdateSheetsSpreadsheetSheetFilterViewConditionResponse { - /** 更新后的筛选条件 */ - condition?: FilterViewCondition -} - -export interface QuerySheetsSpreadsheetSheetFilterViewConditionResponse { - /** 筛选视图设置的所有筛选条件 */ - items?: FilterViewCondition[] -} - -export interface GetSheetsSpreadsheetSheetFilterViewConditionResponse { - /** 筛选的条件 */ - condition?: FilterViewCondition -} - -export interface CreateSheetsSpreadsheetSheetFloatImageResponse { - /** 浮动图片 */ - float_image?: FloatImage -} - export interface PatchSheetsSpreadsheetSheetFloatImageResponse { /** 浮动图片 */ float_image?: FloatImage diff --git a/adapters/lark/src/types/speech_to_text.ts b/adapters/lark/src/types/speech_to_text.ts index 9cecd52a..d8ef2f44 100644 --- a/adapters/lark/src/types/speech_to_text.ts +++ b/adapters/lark/src/types/speech_to_text.ts @@ -23,6 +23,11 @@ export interface FileRecognizeSpeechToTextSpeechRequest { config: FileConfig } +export interface FileRecognizeSpeechToTextSpeechResponse { + /** 语音识别后的文本信息 */ + recognition_text: string +} + export interface StreamRecognizeSpeechToTextSpeechRequest { /** 语音资源 */ speech: Speech @@ -30,11 +35,6 @@ export interface StreamRecognizeSpeechToTextSpeechRequest { config: StreamConfig } -export interface FileRecognizeSpeechToTextSpeechResponse { - /** 语音识别后的文本信息 */ - recognition_text: string -} - export interface StreamRecognizeSpeechToTextSpeechResponse { /** 16 位 String 随机串作为同一数据流的标识 */ stream_id: string diff --git a/adapters/lark/src/types/task.ts b/adapters/lark/src/types/task.ts index 6b212f8b..3e00040d 100644 --- a/adapters/lark/src/types/task.ts +++ b/adapters/lark/src/types/task.ts @@ -423,11 +423,21 @@ export interface CreateTaskV2Query { user_id_type?: string } +export interface CreateTaskV2Response { + /** 产生的任务 */ + task?: Task +} + export interface GetTaskV2Query { /** 表示user的ID的类型,支持open_id, user_id, union_id */ user_id_type?: string } +export interface GetTaskV2Response { + /** 获得的任务实体 */ + task?: Task +} + export interface PatchTaskV2Request { /** 要更新的任务数据,只需要写明要更新的字段 */ task?: InputTask @@ -440,6 +450,11 @@ export interface PatchTaskV2Query { user_id_type?: string } +export interface PatchTaskV2Response { + /** 更新后的任务 */ + task?: Task +} + export interface AddMembersTaskV2Request { /** 要添加的members列表 */ members: Member[] @@ -452,6 +467,11 @@ export interface AddMembersTaskV2Query { user_id_type?: string } +export interface AddMembersTaskV2Response { + /** 更新完成后的任务实体数据 */ + task?: Task +} + export interface RemoveMembersTaskV2Request { /** 要移除的member列表 */ members: Member[] @@ -462,6 +482,11 @@ export interface RemoveMembersTaskV2Query { user_id_type?: string } +export interface RemoveMembersTaskV2Response { + /** 移除成员后的任务数据 */ + task?: Task +} + export interface ListTaskV2Query extends Pagination { /** 是否按任务完成进行过滤。不填写表示不过滤。 */ completed?: boolean @@ -471,6 +496,11 @@ export interface ListTaskV2Query extends Pagination { user_id_type?: string } +export interface TasklistsTaskV2Response { + /** 任务所在清单的摘要信息 */ + tasklists?: TaskInTasklistInfo[] +} + export interface AddTasklistTaskV2Request { /** 要添加到的清单的全局唯一ID */ tasklist_guid: string @@ -483,6 +513,11 @@ export interface AddTasklistTaskV2Query { user_id_type?: string } +export interface AddTasklistTaskV2Response { + /** 添加后的任务详情 */ + task?: Task +} + export interface RemoveTasklistTaskV2Request { /** 要移除的清单的全局唯一ID */ tasklist_guid: string @@ -493,6 +528,11 @@ export interface RemoveTasklistTaskV2Query { user_id_type?: string } +export interface RemoveTasklistTaskV2Response { + /** 添加后的任务详情 */ + task?: Task +} + export interface AddRemindersTaskV2Request { /** 要添加的reminder的列表 */ reminders: Reminder[] @@ -503,6 +543,11 @@ export interface AddRemindersTaskV2Query { user_id_type?: string } +export interface AddRemindersTaskV2Response { + /** 更新完成后的任务实体 */ + task?: Task +} + export interface RemoveRemindersTaskV2Request { /** 要移除的reminder的id列表 */ reminder_ids: string[] @@ -513,16 +558,31 @@ export interface RemoveRemindersTaskV2Query { user_id_type?: string } +export interface RemoveRemindersTaskV2Response { + /** 移除提醒后的任务详情 */ + task?: Task +} + export interface AddDependenciesTaskV2Request { /** 要添加的依赖 */ dependencies?: TaskDependency[] } +export interface AddDependenciesTaskV2Response { + /** 被添加后任务的所有依赖 */ + dependencies?: TaskDependency[] +} + export interface RemoveDependenciesTaskV2Request { /** 要移除的依赖 */ dependencies: TaskDependency[] } +export interface RemoveDependenciesTaskV2Response { + /** 移除之后的任务GUID */ + dependencies?: TaskDependency[] +} + export interface CreateTaskV2TaskSubtaskRequest { /** 任务标题 */ summary: string @@ -565,6 +625,11 @@ export interface CreateTaskV2TaskSubtaskQuery { user_id_type?: string } +export interface CreateTaskV2TaskSubtaskResponse { + /** 创建的任务 */ + subtask?: Task +} + export interface ListTaskV2TaskSubtaskQuery extends Pagination { /** 表示user的ID的类型,支持open_id, user_id, union_id */ user_id_type?: string @@ -582,11 +647,21 @@ export interface CreateTaskV2TasklistQuery { user_id_type?: string } +export interface CreateTaskV2TasklistResponse { + /** 创建的清单数据 */ + tasklist?: Tasklist +} + export interface GetTaskV2TasklistQuery { /** 表示user的ID的类型,支持open_id, user_id, union_id */ user_id_type?: string } +export interface GetTaskV2TasklistResponse { + /** 清单详情 */ + tasklist?: Tasklist +} + export interface PatchTaskV2TasklistRequest { /** 要更新清单的数据 */ tasklist: InputTasklist @@ -601,6 +676,11 @@ export interface PatchTaskV2TasklistQuery { user_id_type?: string } +export interface PatchTaskV2TasklistResponse { + /** 修改后的任务清单 */ + tasklist?: Tasklist +} + export interface AddMembersTaskV2TasklistRequest { /** 要添加的成员列表 */ members: Member[] @@ -611,6 +691,11 @@ export interface AddMembersTaskV2TasklistQuery { user_id_type?: string } +export interface AddMembersTaskV2TasklistResponse { + /** 完成更新后的清单实体 */ + tasklist?: Tasklist +} + export interface RemoveMembersTaskV2TasklistRequest { /** 要移除的member列表 */ members: Member[] @@ -621,6 +706,11 @@ export interface RemoveMembersTaskV2TasklistQuery { user_id_type?: string } +export interface RemoveMembersTaskV2TasklistResponse { + /** 修改完成后的清单实体 */ + tasklist?: Tasklist +} + export interface TasksTaskV2TasklistQuery extends Pagination { /** 只查看特定完成状态的任务,不填写表示不按完成状态过滤 */ completed?: boolean @@ -653,11 +743,21 @@ export interface CreateTaskV2TasklistActivitySubscriptionQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface CreateTaskV2TasklistActivitySubscriptionResponse { + /** 清单动态订阅 */ + activity_subscription?: TasklistActivitySubscription +} + export interface GetTaskV2TasklistActivitySubscriptionQuery { /** 用户ID类型 */ user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface GetTaskV2TasklistActivitySubscriptionResponse { + /** 订阅详情 */ + activity_subscription?: TasklistActivitySubscription +} + export interface ListTaskV2TasklistActivitySubscriptionQuery { /** 返回结果的最大数量 */ limit?: number @@ -665,6 +765,11 @@ export interface ListTaskV2TasklistActivitySubscriptionQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface ListTaskV2TasklistActivitySubscriptionResponse { + /** 清单的动态订阅数据 */ + items?: TasklistActivitySubscription[] +} + export interface PatchTaskV2TasklistActivitySubscriptionRequest { /** 要更新的订阅数据 */ activity_subscription: TasklistActivitySubscription @@ -677,6 +782,11 @@ export interface PatchTaskV2TasklistActivitySubscriptionQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface PatchTaskV2TasklistActivitySubscriptionResponse { + /** 更新后的订阅 */ + activity_subscription?: TasklistActivitySubscription +} + export interface CreateTaskV2CommentRequest { /** 评论内容 */ content: string @@ -693,11 +803,21 @@ export interface CreateTaskV2CommentQuery { user_id_type?: string } +export interface CreateTaskV2CommentResponse { + /** 创建的评论详情 */ + comment?: Comment +} + export interface GetTaskV2CommentQuery { /** 表示user的ID的类型,支持open_id, user_id, union_id */ user_id_type?: string } +export interface GetTaskV2CommentResponse { + /** 评论详情 */ + comment?: Comment +} + export interface PatchTaskV2CommentRequest { /** 要更新的评论数据,支持更新content, md_content */ comment: InputComment @@ -710,6 +830,11 @@ export interface PatchTaskV2CommentQuery { user_id_type?: string } +export interface PatchTaskV2CommentResponse { + /** 更新后的评论 */ + comment?: Comment +} + export interface ListTaskV2CommentQuery extends Pagination { /** 要获取评论列表的资源类型 */ resource_type?: string @@ -735,6 +860,11 @@ export interface UploadTaskV2AttachmentQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface UploadTaskV2AttachmentResponse { + /** 上传的附件列表 */ + items?: Attachment[] +} + export interface ListTaskV2AttachmentQuery extends Pagination { /** 附件归属的资源类型 */ resource_type?: string @@ -749,6 +879,11 @@ export interface GetTaskV2AttachmentQuery { user_id_type?: string } +export interface GetTaskV2AttachmentResponse { + /** 附件详情 */ + attachment?: Attachment +} + export interface CreateTaskV2SectionRequest { /** 自定义分组名称 */ name: string @@ -767,11 +902,21 @@ export interface CreateTaskV2SectionQuery { user_id_type?: string } +export interface CreateTaskV2SectionResponse { + /** 创建的自定义分组数据 */ + section?: Section +} + export interface GetTaskV2SectionQuery { /** 表示user的ID的类型,支持open_id, user_id, union_id */ user_id_type?: string } +export interface GetTaskV2SectionResponse { + /** 获取的自定义分组详情 */ + section?: Section +} + export interface PatchTaskV2SectionRequest { /** 要更新的自定义分组的数据,仅支持name, insert_after, insert_before */ section: InputSection @@ -784,6 +929,11 @@ export interface PatchTaskV2SectionQuery { user_id_type?: string } +export interface PatchTaskV2SectionResponse { + /** 更新后的自定义分组 */ + section?: Section +} + export interface ListTaskV2SectionQuery extends Pagination { /** 自定义分组所属的资源类型。支持"my_tasks"(我负责的)和"tasklist"(清单)。当使用"tasklist"时,需要用resource_id提供清单GUID。 */ resource_type: string @@ -832,11 +982,21 @@ export interface CreateTaskV2CustomFieldQuery { user_id_type?: 'open_id' | 'user_id' | 'union_id' } +export interface CreateTaskV2CustomFieldResponse { + /** 创建的自定义字段 */ + custom_field?: CustomField +} + export interface GetTaskV2CustomFieldQuery { /** 表示user的ID的类型,支持open_id, user_id, union_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' } +export interface GetTaskV2CustomFieldResponse { + /** 获取的自定义字段数据 */ + custom_field?: CustomField +} + export interface PatchTaskV2CustomFieldRequest { /** 要修改的自定义字段数据 */ custom_field?: InputCustomField @@ -849,6 +1009,11 @@ export interface PatchTaskV2CustomFieldQuery { user_id_type?: 'open_id' | 'union_id' | 'user_id' } +export interface PatchTaskV2CustomFieldResponse { + /** 修改后的自定义字段设置 */ + custom_field?: CustomField +} + export interface ListTaskV2CustomFieldQuery extends Pagination { /** 用户ID格式,支持open_id, user_id, union_id */ user_id_type?: 'open_id' | 'user_id' | 'union_id' @@ -885,6 +1050,11 @@ export interface CreateTaskV2CustomFieldOptionRequest { is_hidden?: boolean } +export interface CreateTaskV2CustomFieldOptionResponse { + /** 创建的选项 */ + option?: Option +} + export interface PatchTaskV2CustomFieldOptionRequest { /** 要更新的option数据 */ option?: InputOption @@ -892,6 +1062,11 @@ export interface PatchTaskV2CustomFieldOptionRequest { update_fields?: string[] } +export interface PatchTaskV2CustomFieldOptionResponse { + /** 更新后的option数据 */ + option?: Option +} + export interface CreateTaskV1Request { /** 任务标题。创建任务时,如果没有标题填充,将其视为无主题的任务。 */ summary?: string @@ -924,6 +1099,11 @@ export interface CreateTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateTaskV1Response { + /** 返回创建好的任务 */ + task?: Task +} + export interface PatchTaskV1Request { /** 被更新的任务实体基础信息 */ task: Task @@ -936,11 +1116,21 @@ export interface PatchTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface PatchTaskV1Response { + /** 返回修改后的任务详情 */ + task?: Task +} + export interface GetTaskV1Query { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetTaskV1Response { + /** 返回任务资源详情 */ + task?: Task +} + export interface ListTaskV1Query extends Pagination { /** 范围查询任务时,查询的起始时间。不填时默认起始时间为第一个任务的创建时间。 */ start_create_time?: string @@ -957,6 +1147,11 @@ export interface CreateTaskV1TaskReminderRequest { relative_fire_minute: number } +export interface CreateTaskV1TaskReminderResponse { + /** 返回创建成功的提醒时间 */ + reminder?: Reminder +} + export interface CreateTaskV1TaskCommentRequest { /** 评论内容 */ content?: string @@ -973,6 +1168,11 @@ export interface CreateTaskV1TaskCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateTaskV1TaskCommentResponse { + /** 返回创建好的任务评论 */ + comment?: Comment +} + export interface UpdateTaskV1TaskCommentRequest { /** 新的评论内容 */ content?: string @@ -985,14 +1185,31 @@ export interface UpdateTaskV1TaskCommentQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface UpdateTaskV1TaskCommentResponse { + /** 返回修改后的任务评论详情 */ + comment?: Comment +} + export interface GetTaskV1TaskCommentQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetTaskV1TaskCommentResponse { + /** 返回新的任务评论详情 */ + comment?: Comment +} + +export const enum ListTaskV1TaskCommentQueryListDirection { + /** 按照回复时间从小到大查询 */ + Down = 0, + /** 按照回复时间从大到小查询 */ + Up = 1, +} + export interface ListTaskV1TaskCommentQuery extends Pagination { /** 评论排序标记,可按照评论时间从小到大查询,或者评论时间从大到小查询,不填默认按照从小到大 */ - list_direction?: 0 | 1 + list_direction?: ListTaskV1TaskCommentQueryListDirection /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } @@ -1009,6 +1226,11 @@ export interface CreateTaskV1TaskFollowerQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateTaskV1TaskFollowerResponse { + /** 创建后的任务关注者 */ + follower: Follower +} + export interface DeleteTaskV1TaskFollowerQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -1024,6 +1246,11 @@ export interface BatchDeleteFollowerTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface BatchDeleteFollowerTaskV1Response { + /** 实际删除的关注人用户ID列表 */ + followers?: string[] +} + export interface ListTaskV1TaskFollowerQuery extends Pagination { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -1041,6 +1268,11 @@ export interface CreateTaskV1TaskCollaboratorQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateTaskV1TaskCollaboratorResponse { + /** 返回创建成功后的任务协作者 */ + collaborator: Collaborator +} + export interface DeleteTaskV1TaskCollaboratorQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' @@ -1056,241 +1288,16 @@ export interface BatchDeleteCollaboratorTaskV1Query { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ListTaskV1TaskCollaboratorQuery extends Pagination { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 'user_id' | 'union_id' | 'open_id' -} - -export interface CreateTaskV2Response { - /** 产生的任务 */ - task?: Task -} - -export interface GetTaskV2Response { - /** 获得的任务实体 */ - task?: Task -} - -export interface PatchTaskV2Response { - /** 更新后的任务 */ - task?: Task -} - -export interface AddMembersTaskV2Response { - /** 更新完成后的任务实体数据 */ - task?: Task -} - -export interface RemoveMembersTaskV2Response { - /** 移除成员后的任务数据 */ - task?: Task -} - -export interface TasklistsTaskV2Response { - /** 任务所在清单的摘要信息 */ - tasklists?: TaskInTasklistInfo[] -} - -export interface AddTasklistTaskV2Response { - /** 添加后的任务详情 */ - task?: Task -} - -export interface RemoveTasklistTaskV2Response { - /** 添加后的任务详情 */ - task?: Task -} - -export interface AddRemindersTaskV2Response { - /** 更新完成后的任务实体 */ - task?: Task -} - -export interface RemoveRemindersTaskV2Response { - /** 移除提醒后的任务详情 */ - task?: Task -} - -export interface AddDependenciesTaskV2Response { - /** 被添加后任务的所有依赖 */ - dependencies?: TaskDependency[] -} - -export interface RemoveDependenciesTaskV2Response { - /** 移除之后的任务GUID */ - dependencies?: TaskDependency[] -} - -export interface CreateTaskV2TaskSubtaskResponse { - /** 创建的任务 */ - subtask?: Task -} - -export interface CreateTaskV2TasklistResponse { - /** 创建的清单数据 */ - tasklist?: Tasklist -} - -export interface GetTaskV2TasklistResponse { - /** 清单详情 */ - tasklist?: Tasklist -} - -export interface PatchTaskV2TasklistResponse { - /** 修改后的任务清单 */ - tasklist?: Tasklist -} - -export interface AddMembersTaskV2TasklistResponse { - /** 完成更新后的清单实体 */ - tasklist?: Tasklist -} - -export interface RemoveMembersTaskV2TasklistResponse { - /** 修改完成后的清单实体 */ - tasklist?: Tasklist -} - -export interface CreateTaskV2TasklistActivitySubscriptionResponse { - /** 清单动态订阅 */ - activity_subscription?: TasklistActivitySubscription -} - -export interface GetTaskV2TasklistActivitySubscriptionResponse { - /** 订阅详情 */ - activity_subscription?: TasklistActivitySubscription -} - -export interface ListTaskV2TasklistActivitySubscriptionResponse { - /** 清单的动态订阅数据 */ - items?: TasklistActivitySubscription[] -} - -export interface PatchTaskV2TasklistActivitySubscriptionResponse { - /** 更新后的订阅 */ - activity_subscription?: TasklistActivitySubscription -} - -export interface CreateTaskV2CommentResponse { - /** 创建的评论详情 */ - comment?: Comment -} - -export interface GetTaskV2CommentResponse { - /** 评论详情 */ - comment?: Comment -} - -export interface PatchTaskV2CommentResponse { - /** 更新后的评论 */ - comment?: Comment -} - -export interface UploadTaskV2AttachmentResponse { - /** 上传的附件列表 */ - items?: Attachment[] -} - -export interface GetTaskV2AttachmentResponse { - /** 附件详情 */ - attachment?: Attachment -} - -export interface CreateTaskV2SectionResponse { - /** 创建的自定义分组数据 */ - section?: Section -} - -export interface GetTaskV2SectionResponse { - /** 获取的自定义分组详情 */ - section?: Section -} - -export interface PatchTaskV2SectionResponse { - /** 更新后的自定义分组 */ - section?: Section -} - -export interface CreateTaskV2CustomFieldResponse { - /** 创建的自定义字段 */ - custom_field?: CustomField -} - -export interface GetTaskV2CustomFieldResponse { - /** 获取的自定义字段数据 */ - custom_field?: CustomField -} - -export interface PatchTaskV2CustomFieldResponse { - /** 修改后的自定义字段设置 */ - custom_field?: CustomField -} - -export interface CreateTaskV2CustomFieldOptionResponse { - /** 创建的选项 */ - option?: Option -} - -export interface PatchTaskV2CustomFieldOptionResponse { - /** 更新后的option数据 */ - option?: Option -} - -export interface CreateTaskV1Response { - /** 返回创建好的任务 */ - task?: Task -} - -export interface PatchTaskV1Response { - /** 返回修改后的任务详情 */ - task?: Task -} - -export interface GetTaskV1Response { - /** 返回任务资源详情 */ - task?: Task -} - -export interface CreateTaskV1TaskReminderResponse { - /** 返回创建成功的提醒时间 */ - reminder?: Reminder -} - -export interface CreateTaskV1TaskCommentResponse { - /** 返回创建好的任务评论 */ - comment?: Comment -} - -export interface UpdateTaskV1TaskCommentResponse { - /** 返回修改后的任务评论详情 */ - comment?: Comment -} - -export interface GetTaskV1TaskCommentResponse { - /** 返回新的任务评论详情 */ - comment?: Comment -} - -export interface CreateTaskV1TaskFollowerResponse { - /** 创建后的任务关注者 */ - follower: Follower -} - -export interface BatchDeleteFollowerTaskV1Response { - /** 实际删除的关注人用户ID列表 */ - followers?: string[] -} - -export interface CreateTaskV1TaskCollaboratorResponse { - /** 返回创建成功后的任务协作者 */ - collaborator: Collaborator -} - export interface BatchDeleteCollaboratorTaskV1Response { /** 实际删除的执行人用户ID列表 */ collaborators?: string[] } +export interface ListTaskV1TaskCollaboratorQuery extends Pagination { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + Internal.define({ '/task/v2/tasks': { POST: 'createTaskV2', diff --git a/adapters/lark/src/types/translation.ts b/adapters/lark/src/types/translation.ts index 5ae081b7..b29dae21 100644 --- a/adapters/lark/src/types/translation.ts +++ b/adapters/lark/src/types/translation.ts @@ -21,6 +21,11 @@ export interface DetectTranslationTextRequest { text: string } +export interface DetectTranslationTextResponse { + /** 识别的文本语种,返回符合 ISO 693-1 标准 */ + language: string +} + export interface TranslateTranslationTextRequest { /** 源语言 */ source_language: string @@ -32,11 +37,6 @@ export interface TranslateTranslationTextRequest { glossary?: Term[] } -export interface DetectTranslationTextResponse { - /** 识别的文本语种,返回符合 ISO 693-1 标准 */ - language: string -} - export interface TranslateTranslationTextResponse { /** 翻译后的文本 */ text: string diff --git a/adapters/lark/src/types/vc.ts b/adapters/lark/src/types/vc.ts index 175a9b61..52ea0151 100644 --- a/adapters/lark/src/types/vc.ts +++ b/adapters/lark/src/types/vc.ts @@ -300,6 +300,11 @@ export interface ApplyVcReserveQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ApplyVcReserveResponse { + reserve?: Reserve + reserve_correction_check_info?: ReserveCorrectionCheckInfo +} + export interface UpdateVcReserveRequest { /** 预约到期时间(unix时间,单位sec) */ end_time?: string @@ -312,11 +317,20 @@ export interface UpdateVcReserveQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface UpdateVcReserveResponse { + reserve?: Reserve + reserve_correction_check_info?: ReserveCorrectionCheckInfo +} + export interface GetVcReserveQuery { /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetVcReserveResponse { + reserve?: Reserve +} + export interface GetActiveMeetingVcReserveQuery { /** 是否需要参会人列表,默认为false */ with_participants?: boolean @@ -324,6 +338,10 @@ export interface GetActiveMeetingVcReserveQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetActiveMeetingVcReserveResponse { + meeting?: Meeting +} + export interface InviteVcMeetingRequest { /** 被邀请的用户列表 */ invitees: MeetingUser[] @@ -334,6 +352,11 @@ export interface InviteVcMeetingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface InviteVcMeetingResponse { + /** 邀请结果 */ + invite_results?: MeetingInviteStatus[] +} + export interface KickoutVcMeetingRequest { /** 需踢出的用户列表 */ kickout_users: MeetingUser[] @@ -344,6 +367,11 @@ export interface KickoutVcMeetingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface KickoutVcMeetingResponse { + /** 踢出结果 */ + kickout_results?: MeetingParticipantResult[] +} + export interface SetHostVcMeetingRequest { /** 将要设置的主持人 */ host_user: MeetingUser @@ -356,6 +384,11 @@ export interface SetHostVcMeetingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface SetHostVcMeetingResponse { + /** 会中当前主持人 */ + host_user?: MeetingUser +} + export interface GetVcMeetingQuery { /** 是否需要参会人列表 */ with_participants?: boolean @@ -365,6 +398,10 @@ export interface GetVcMeetingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetVcMeetingResponse { + meeting?: Meeting +} + export interface ListByNoVcMeetingQuery extends Pagination { /** 9位会议号 */ meeting_no: string @@ -379,11 +416,22 @@ export interface StartVcMeetingRecordingRequest { timezone?: number } +export interface GetVcMeetingRecordingResponse { + recording?: MeetingRecording +} + +export const enum SetPermissionVcMeetingRecordingRequestActionType { + /** 授权 */ + Authorize = 0, + /** 取消授权 */ + Revoke = 1, +} + export interface SetPermissionVcMeetingRecordingRequest { /** 授权对象列表 */ permission_objects: RecordingPermissionObject[] /** 授权或者取消授权,默认授权 */ - action_type?: 0 | 1 + action_type?: SetPermissionVcMeetingRecordingRequestActionType } export interface SetPermissionVcMeetingRecordingQuery { @@ -391,13 +439,47 @@ export interface SetPermissionVcMeetingRecordingQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum GetDailyVcReportQueryUnit { + /** 中国大陆 */ + CN = 0, + /** 美国 */ + VA = 1, + /** 新加坡 */ + SG = 2, + /** 日本 */ + JP = 3, +} + export interface GetDailyVcReportQuery { /** 开始时间(unix时间,单位sec) */ start_time: string /** 结束时间(unix时间,单位sec) */ end_time: string /** 数据驻留地 */ - unit?: 0 | 1 | 2 | 3 + unit?: GetDailyVcReportQueryUnit +} + +export interface GetDailyVcReportResponse { + /** 会议报告 */ + meeting_report?: Report +} + +export const enum GetTopUserVcReportQueryOrderBy { + /** 会议数量 */ + MeetingCount = 1, + /** 会议时长 */ + MeetingDuration = 2, +} + +export const enum GetTopUserVcReportQueryUnit { + /** 中国大陆 */ + CN = 0, + /** 美国 */ + VA = 1, + /** 新加坡 */ + SG = 2, + /** 日本 */ + JP = 3, } export interface GetTopUserVcReportQuery { @@ -408,20 +490,43 @@ export interface GetTopUserVcReportQuery { /** 取前多少位 */ limit: number /** 排序依据(降序) */ - order_by: 1 | 2 + order_by: GetTopUserVcReportQueryOrderBy /** 数据驻留地 */ - unit?: 0 | 1 | 2 | 3 + unit?: GetTopUserVcReportQueryUnit /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetTopUserVcReportResponse { + /** top用户列表 */ + top_user_report?: ReportTopUser[] +} + +export const enum MeetingListVcExportRequestMeetingStatus { + /** 进行中 */ + Ongoing = 1, + /** 已结束 */ + Past = 2, + /** 待召开 */ + Future = 3, +} + +export const enum MeetingListVcExportRequestMeetingType { + /** 全部类型(默认) */ + All = 1, + /** 视频会议 */ + Meeting = 2, + /** 本地投屏 */ + ShareScreen = 3, +} + export interface MeetingListVcExportRequest { /** 查询开始时间(unix时间,单位sec) */ start_time: string /** 查询结束时间(unix时间,单位sec) */ end_time: string /** 会议状态(不传默认为已结束会议) */ - meeting_status?: 1 | 2 | 3 + meeting_status?: MeetingListVcExportRequestMeetingStatus /** 按9位会议号筛选(最多一个筛选条件) */ meeting_no?: string /** 按参会Lark用户筛选(最多一个筛选条件) */ @@ -429,7 +534,7 @@ export interface MeetingListVcExportRequest { /** 按参会Rooms筛选(最多一个筛选条件) */ room_id?: string /** 按会议类型筛选(最多一个筛选条件) */ - meeting_type?: 1 | 2 | 3 + meeting_type?: MeetingListVcExportRequestMeetingType } export interface MeetingListVcExportQuery { @@ -437,13 +542,27 @@ export interface MeetingListVcExportQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface MeetingListVcExportResponse { + /** 任务id */ + task_id?: string +} + +export const enum ParticipantListVcExportRequestMeetingStatus { + /** 进行中 */ + Ongoing = 1, + /** 已结束 */ + Past = 2, + /** 待召开 */ + Future = 3, +} + export interface ParticipantListVcExportRequest { /** 会议开始时间(unix时间,单位sec) */ meeting_start_time: string /** 会议结束时间(unix时间,单位sec) */ meeting_end_time: string /** 会议状态(不传默认为已结束会议) */ - meeting_status?: 1 | 2 | 3 + meeting_status?: ParticipantListVcExportRequestMeetingStatus /** 9位会议号 */ meeting_no: string /** 按参会Lark用户筛选(最多一个筛选条件) */ @@ -457,6 +576,11 @@ export interface ParticipantListVcExportQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ParticipantListVcExportResponse { + /** 任务id */ + task_id?: string +} + export interface ParticipantQualityListVcExportRequest { /** 会议开始时间(unix时间,单位sec) */ meeting_start_time: string @@ -477,6 +601,11 @@ export interface ParticipantQualityListVcExportQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ParticipantQualityListVcExportResponse { + /** 任务id */ + task_id?: string +} + export interface ResourceReservationListVcExportRequest { /** 层级id */ room_level_id: string @@ -492,6 +621,31 @@ export interface ResourceReservationListVcExportRequest { is_exclude?: boolean } +export interface ResourceReservationListVcExportResponse { + /** 任务id */ + task_id?: string +} + +export const enum GetVcExportResponseStatus { + /** 处理中 */ + InProgress = 1, + /** 失败 */ + Failed = 2, + /** 完成 */ + Done = 3, +} + +export interface GetVcExportResponse { + /** 任务状态 */ + status: GetVcExportResponseStatus + /** 文件下载地址 */ + url?: string + /** 文件token */ + file_token?: string + /** 失败信息 */ + fail_msg?: string +} + export interface DownloadVcExportQuery { /** 文档token */ file_token: string @@ -506,6 +660,10 @@ export interface CreateVcRoomLevelRequest { custom_group_id?: string } +export interface CreateVcRoomLevelResponse { + room_level?: RoomLevel +} + export interface DelVcRoomLevelRequest { /** 层级ID */ room_level_id: string @@ -522,11 +680,20 @@ export interface PatchVcRoomLevelRequest { custom_group_id?: string } +export interface GetVcRoomLevelResponse { + room_level?: RoomLevel +} + export interface MgetVcRoomLevelRequest { /** 层级id列表 */ level_ids: string[] } +export interface MgetVcRoomLevelResponse { + /** 层级列表 */ + items?: RoomLevel[] +} + export interface ListVcRoomLevelQuery extends Pagination { /** 层级ID,不传则返回该租户下第一层级列表 */ room_level_id?: string @@ -537,6 +704,11 @@ export interface SearchVcRoomLevelQuery { custom_level_ids: string } +export interface SearchVcRoomLevelResponse { + /** 层级id列表 */ + level_ids?: string[] +} + export interface CreateVcRoomRequest { /** 会议室名称 */ name: string @@ -559,6 +731,10 @@ export interface CreateVcRoomQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface CreateVcRoomResponse { + room?: Room +} + export interface PatchVcRoomRequest { /** 会议室名称 */ name?: string @@ -586,6 +762,10 @@ export interface GetVcRoomQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetVcRoomResponse { + room?: Room +} + export interface MgetVcRoomRequest { /** 会议室id列表 */ room_ids: string[] @@ -596,6 +776,11 @@ export interface MgetVcRoomQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface MgetVcRoomResponse { + /** 会议室列表 */ + items?: Room[] +} + export interface ListVcRoomQuery extends Pagination { /** 层级ID,不传则返回该租户下的所有会议室 */ room_level_id?: string @@ -623,18 +808,39 @@ export interface SearchVcRoomQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum GetVcScopeConfigQueryScopeType { + /** 会议室层级 */ + RoomLevel = 1, + /** 会议室 */ + Room = 2, +} + export interface GetVcScopeConfigQuery { /** 查询节点范围 */ - scope_type: 1 | 2 + scope_type: GetVcScopeConfigQueryScopeType /** 查询节点ID:如果scope_type为1,则为层级ID,如果scope_type为2,则为会议室ID */ scope_id: string /** 此次调用中使用的用户ID的类型,默认使用open_id可不填 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetVcScopeConfigResponse { + /** 当前节点的配置,根据层级顺序从底向上进行合并计算后的结果;如果当前节点某个值已配置,则取该节点的值,否则会从该节点的父层级节点获取,如果父节点依然未配置,则继续向上递归获取;若所有节点均未配置,则该值返回为空 */ + current_config?: ScopeConfig + /** 所有节点的原始配置,按照层级顺序从底向上返回;如果某节点某个值未配置,则该值返回为空 */ + origin_configs?: ScopeConfig[] +} + +export const enum CreateVcScopeConfigRequestScopeType { + /** 会议室层级 */ + RoomLevel = 1, + /** 会议室 */ + Room = 2, +} + export interface CreateVcScopeConfigRequest { /** 查询节点范围 */ - scope_type: 1 | 2 + scope_type: CreateVcScopeConfigRequestScopeType /** 查询节点ID:如果scope_type为1,则为层级ID,如果scope_type为2,则为会议室ID */ scope_id: string /** 节点配置 */ @@ -655,6 +861,15 @@ export interface ReserveScopeVcReserveConfigQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface ReserveScopeVcReserveConfigResponse { + /** 预定审批设置 */ + approve_config?: ApprovalConfig + /** 预定时间设置 */ + time_config?: TimeConfig + /** 预定范围设置 */ + reserve_scope_config?: ReserveScopeConfig +} + export interface PatchVcReserveConfigRequest { /** 1代表层级,2代表会议室 */ scope_type: string @@ -678,6 +893,11 @@ export interface GetVcReserveConfigFormQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetVcReserveConfigFormResponse { + /** 预定表单 */ + reserve_form_config: ReserveFormConfig +} + export interface PatchVcReserveConfigFormRequest { /** 1代表层级,2代表会议室 */ scope_type: number @@ -697,6 +917,11 @@ export interface GetVcReserveConfigAdminQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetVcReserveConfigAdminResponse { + /** 预定管理员/部门 */ + reserve_admin_config: ReserveAdminConfig +} + export interface PatchVcReserveConfigAdminRequest { /** 1代表层级,2代表会议室 */ scope_type: number @@ -716,6 +941,11 @@ export interface GetVcReserveConfigDisableInformQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface GetVcReserveConfigDisableInformResponse { + /** 会议室禁用通知配置 */ + disable_inform?: DisableInformConfig +} + export interface PatchVcReserveConfigDisableInformRequest { /** 1表示会议室层级,2表示会议室 */ scope_type: number @@ -728,13 +958,31 @@ export interface PatchVcReserveConfigDisableInformQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum GetVcMeetingListQueryMeetingStatus { + /** 进行中 */ + Ongoing = 1, + /** 已结束 */ + Past = 2, + /** 待召开 */ + Future = 3, +} + +export const enum GetVcMeetingListQueryMeetingType { + /** 全部类型(默认) */ + All = 1, + /** 视频会议 */ + Meeting = 2, + /** 本地投屏 */ + ShareScreen = 3, +} + export interface GetVcMeetingListQuery extends Pagination { /** 查询开始时间(unix时间,单位sec) */ start_time: string /** 查询结束时间(unix时间,单位sec) */ end_time: string /** 会议状态 */ - meeting_status?: 1 | 2 | 3 + meeting_status?: GetVcMeetingListQueryMeetingStatus /** 按9位会议号筛选(最多一个筛选条件) */ meeting_no?: string /** 按参会Lark用户筛选(最多一个筛选条件) */ @@ -742,18 +990,27 @@ export interface GetVcMeetingListQuery extends Pagination { /** 按参会Rooms筛选(最多一个筛选条件) */ room_id?: string /** 按会议类型筛选(最多一个筛选条件) */ - meeting_type?: 1 | 2 | 3 + meeting_type?: GetVcMeetingListQueryMeetingType /** 此次调用中使用的用户ID的类型 */ user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export const enum GetVcParticipantListQueryMeetingStatus { + /** 进行中 */ + Ongoing = 1, + /** 已结束 */ + Past = 2, + /** 待召开 */ + Future = 3, +} + export interface GetVcParticipantListQuery extends Pagination { /** 会议开始时间(需要精确到一分钟,unix时间,单位sec) */ meeting_start_time: string /** 会议结束时间(unix时间,单位sec;对于进行中会议则传0) */ meeting_end_time: string /** 会议状态(不传默认为已结束会议) */ - meeting_status?: 1 | 2 | 3 + meeting_status?: GetVcParticipantListQueryMeetingStatus /** 9位会议号 */ meeting_no: string /** 按参会Lark用户筛选(最多一个筛选条件) */ @@ -796,20 +1053,53 @@ export interface GetVcResourceReservationListQuery extends Pagination { is_exclude?: boolean } +export const enum ListVcAlertQueryQueryType { + /** 会议室 */ + Room = 1, + /** erc */ + Erc = 2, + /** SIP会议室系统 */ + Sip = 3, +} + export interface ListVcAlertQuery extends Pagination { /** 开始时间(unix时间,单位sec) */ start_time: string /** 结束时间(unix时间,单位sec) */ end_time: string /** 查询对象类型 */ - query_type?: 1 | 2 | 3 + query_type?: ListVcAlertQueryQueryType /** 查询对象ID */ query_value?: string } +export const enum SetCheckboardAccessCodeVcRoomConfigRequestScope { + /** 租户 */ + Tenant = 1, + /** 国家/地区 */ + CountryDistrict = 2, + /** 城市 */ + City = 3, + /** 建筑 */ + Building = 4, + /** 楼层 */ + Floor = 5, + /** 会议室 */ + Room = 6, +} + +export const enum SetCheckboardAccessCodeVcRoomConfigRequestValidDay { + /** 1天 */ + Day = 1, + /** 7天 */ + Week = 7, + /** 30天 */ + Month = 30, +} + export interface SetCheckboardAccessCodeVcRoomConfigRequest { /** 设置节点范围 */ - scope: 1 | 2 | 3 | 4 | 5 | 6 + scope: SetCheckboardAccessCodeVcRoomConfigRequestScope /** 国家/地区ID scope为2,3时需要此参数 */ country_id?: string /** 城市ID scope为3时需要此参数 */ @@ -821,12 +1111,41 @@ export interface SetCheckboardAccessCodeVcRoomConfigRequest { /** 会议室ID scope为6时需要此参数 */ room_id?: string /** 有效天数 */ - valid_day: 1 | 7 | 30 + valid_day: SetCheckboardAccessCodeVcRoomConfigRequestValidDay +} + +export interface SetCheckboardAccessCodeVcRoomConfigResponse { + /** 部署访问码 */ + access_code?: string +} + +export const enum SetRoomAccessCodeVcRoomConfigRequestScope { + /** 租户 */ + Tenant = 1, + /** 国家/地区 */ + CountryDistrict = 2, + /** 城市 */ + City = 3, + /** 建筑 */ + Building = 4, + /** 楼层 */ + Floor = 5, + /** 会议室 */ + Room = 6, +} + +export const enum SetRoomAccessCodeVcRoomConfigRequestValidDay { + /** 1天 */ + Day = 1, + /** 7天 */ + Week = 7, + /** 30天 */ + Month = 30, } export interface SetRoomAccessCodeVcRoomConfigRequest { /** 设置节点范围 */ - scope: 1 | 2 | 3 | 4 | 5 | 6 + scope: SetRoomAccessCodeVcRoomConfigRequestScope /** 国家/地区ID scope为2,3时需要此参数 */ country_id?: string /** 城市ID scope为3时需要此参数 */ @@ -838,12 +1157,32 @@ export interface SetRoomAccessCodeVcRoomConfigRequest { /** 会议室ID scope为6时需要此参数 */ room_id?: string /** 有效天数 */ - valid_day: 1 | 7 | 30 + valid_day: SetRoomAccessCodeVcRoomConfigRequestValidDay +} + +export interface SetRoomAccessCodeVcRoomConfigResponse { + /** 部署访问码 */ + access_code?: string +} + +export const enum QueryVcRoomConfigQueryScope { + /** 租户 */ + Tenant = 1, + /** 国家/地区 */ + CountryDistrict = 2, + /** 城市 */ + City = 3, + /** 建筑 */ + Building = 4, + /** 楼层 */ + Floor = 5, + /** 会议室 */ + Room = 6, } export interface QueryVcRoomConfigQuery { /** 查询节点范围 */ - scope: 1 | 2 | 3 | 4 | 5 | 6 + scope: QueryVcRoomConfigQueryScope /** 国家/地区ID scope为2,3时需要此参数 */ country_id?: string /** 城市ID scope为3时需要此参数 */ @@ -858,9 +1197,37 @@ export interface QueryVcRoomConfigQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } +export interface QueryVcRoomConfigResponse { + /** 飞书会议室背景图 */ + room_background?: string + /** 飞书签到板背景图 */ + display_background?: string + /** 飞书会议室数字标牌 */ + digital_signage?: RoomDigitalSignage + /** 飞书投屏盒子数字标牌 */ + room_box_digital_signage?: RoomDigitalSignage + /** 会议室状态 */ + room_status?: RoomStatus +} + +export const enum SetVcRoomConfigRequestScope { + /** 租户 */ + Tenant = 1, + /** 国家/地区 */ + CountryDistrict = 2, + /** 城市 */ + City = 3, + /** 建筑 */ + Building = 4, + /** 楼层 */ + Floor = 5, + /** 会议室 */ + Room = 6, +} + export interface SetVcRoomConfigRequest { /** 设置节点范围 */ - scope: 1 | 2 | 3 | 4 | 5 | 6 + scope: SetVcRoomConfigRequestScope /** 国家/地区ID scope为2,3时需要此参数 */ country_id?: string /** 城市ID scope为3时需要此参数 */ @@ -880,173 +1247,6 @@ export interface SetVcRoomConfigQuery { user_id_type?: 'user_id' | 'union_id' | 'open_id' } -export interface ApplyVcReserveResponse { - reserve?: Reserve - reserve_correction_check_info?: ReserveCorrectionCheckInfo -} - -export interface UpdateVcReserveResponse { - reserve?: Reserve - reserve_correction_check_info?: ReserveCorrectionCheckInfo -} - -export interface GetVcReserveResponse { - reserve?: Reserve -} - -export interface GetActiveMeetingVcReserveResponse { - meeting?: Meeting -} - -export interface InviteVcMeetingResponse { - /** 邀请结果 */ - invite_results?: MeetingInviteStatus[] -} - -export interface KickoutVcMeetingResponse { - /** 踢出结果 */ - kickout_results?: MeetingParticipantResult[] -} - -export interface SetHostVcMeetingResponse { - /** 会中当前主持人 */ - host_user?: MeetingUser -} - -export interface GetVcMeetingResponse { - meeting?: Meeting -} - -export interface GetVcMeetingRecordingResponse { - recording?: MeetingRecording -} - -export interface GetDailyVcReportResponse { - /** 会议报告 */ - meeting_report?: Report -} - -export interface GetTopUserVcReportResponse { - /** top用户列表 */ - top_user_report?: ReportTopUser[] -} - -export interface MeetingListVcExportResponse { - /** 任务id */ - task_id?: string -} - -export interface ParticipantListVcExportResponse { - /** 任务id */ - task_id?: string -} - -export interface ParticipantQualityListVcExportResponse { - /** 任务id */ - task_id?: string -} - -export interface ResourceReservationListVcExportResponse { - /** 任务id */ - task_id?: string -} - -export interface GetVcExportResponse { - /** 任务状态 */ - status: 1 | 2 | 3 - /** 文件下载地址 */ - url?: string - /** 文件token */ - file_token?: string - /** 失败信息 */ - fail_msg?: string -} - -export interface CreateVcRoomLevelResponse { - room_level?: RoomLevel -} - -export interface GetVcRoomLevelResponse { - room_level?: RoomLevel -} - -export interface MgetVcRoomLevelResponse { - /** 层级列表 */ - items?: RoomLevel[] -} - -export interface SearchVcRoomLevelResponse { - /** 层级id列表 */ - level_ids?: string[] -} - -export interface CreateVcRoomResponse { - room?: Room -} - -export interface GetVcRoomResponse { - room?: Room -} - -export interface MgetVcRoomResponse { - /** 会议室列表 */ - items?: Room[] -} - -export interface GetVcScopeConfigResponse { - /** 当前节点的配置,根据层级顺序从底向上进行合并计算后的结果;如果当前节点某个值已配置,则取该节点的值,否则会从该节点的父层级节点获取,如果父节点依然未配置,则继续向上递归获取;若所有节点均未配置,则该值返回为空 */ - current_config?: ScopeConfig - /** 所有节点的原始配置,按照层级顺序从底向上返回;如果某节点某个值未配置,则该值返回为空 */ - origin_configs?: ScopeConfig[] -} - -export interface ReserveScopeVcReserveConfigResponse { - /** 预定审批设置 */ - approve_config?: ApprovalConfig - /** 预定时间设置 */ - time_config?: TimeConfig - /** 预定范围设置 */ - reserve_scope_config?: ReserveScopeConfig -} - -export interface GetVcReserveConfigFormResponse { - /** 预定表单 */ - reserve_form_config: ReserveFormConfig -} - -export interface GetVcReserveConfigAdminResponse { - /** 预定管理员/部门 */ - reserve_admin_config: ReserveAdminConfig -} - -export interface GetVcReserveConfigDisableInformResponse { - /** 会议室禁用通知配置 */ - disable_inform?: DisableInformConfig -} - -export interface SetCheckboardAccessCodeVcRoomConfigResponse { - /** 部署访问码 */ - access_code?: string -} - -export interface SetRoomAccessCodeVcRoomConfigResponse { - /** 部署访问码 */ - access_code?: string -} - -export interface QueryVcRoomConfigResponse { - /** 飞书会议室背景图 */ - room_background?: string - /** 飞书签到板背景图 */ - display_background?: string - /** 飞书会议室数字标牌 */ - digital_signage?: RoomDigitalSignage - /** 飞书投屏盒子数字标牌 */ - room_box_digital_signage?: RoomDigitalSignage - /** 会议室状态 */ - room_status?: RoomStatus -} - Internal.define({ '/vc/v1/reserves/apply': { POST: 'applyVcReserve', diff --git a/adapters/lark/src/types/wiki.ts b/adapters/lark/src/types/wiki.ts index de5cee97..918f10f7 100644 --- a/adapters/lark/src/types/wiki.ts +++ b/adapters/lark/src/types/wiki.ts @@ -96,6 +96,11 @@ export interface GetWikiSpaceQuery { lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW' } +export interface GetWikiSpaceResponse { + /** 知识空间 */ + space?: Space +} + export interface CreateWikiSpaceRequest { /** 知识空间名称 */ name?: string @@ -105,6 +110,11 @@ export interface CreateWikiSpaceRequest { open_sharing?: 'open' | 'closed' } +export interface CreateWikiSpaceResponse { + /** 知识空间信息 */ + space?: Space +} + export interface CreateWikiSpaceMemberRequest { /** 知识库协作者 ID 类型 */ member_type: string @@ -119,6 +129,11 @@ export interface CreateWikiSpaceMemberQuery { need_notification?: boolean } +export interface CreateWikiSpaceMemberResponse { + /** 知识库协作者 */ + member?: Member +} + export interface DeleteWikiSpaceMemberRequest { /** 知识库协作者 ID 类型 */ member_type: string @@ -128,6 +143,11 @@ export interface DeleteWikiSpaceMemberRequest { type?: 'user' | 'chat' | 'department' } +export interface DeleteWikiSpaceMemberResponse { + /** 成员信息 */ + member: Member +} + export interface UpdateWikiSpaceSettingRequest { /** 谁可以创建空间的一级页面: "admin_and_member" = 管理员和成员 "admin" - 仅管理员 */ create_setting?: string @@ -137,6 +157,11 @@ export interface UpdateWikiSpaceSettingRequest { comment_setting?: string } +export interface UpdateWikiSpaceSettingResponse { + /** 空间设置 */ + setting?: Setting +} + export interface CreateWikiSpaceNodeRequest { /** 文档类型,对于快捷方式,该字段是对应的实体的obj_type。 */ obj_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'docx' | 'slides' @@ -150,6 +175,11 @@ export interface CreateWikiSpaceNodeRequest { title?: string } +export interface CreateWikiSpaceNodeResponse { + /** 节点 */ + node?: Node +} + export interface GetNodeWikiSpaceQuery { /** 文档的wiki token */ token: string @@ -157,6 +187,11 @@ export interface GetNodeWikiSpaceQuery { obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki' } +export interface GetNodeWikiSpaceResponse { + /** 节点信息 */ + node?: Node +} + export interface ListWikiSpaceNodeQuery extends Pagination { /** 父节点token */ parent_node_token?: string @@ -169,6 +204,11 @@ export interface MoveWikiSpaceNodeRequest { target_space_id?: string } +export interface MoveWikiSpaceNodeResponse { + /** 移动后的节点信息 */ + node?: Node +} + export interface UpdateTitleWikiSpaceNodeRequest { /** 节点新标题 */ title: string @@ -183,6 +223,11 @@ export interface CopyWikiSpaceNodeRequest { title?: string } +export interface CopyWikiSpaceNodeResponse { + /** copy后的节点 */ + node: Node +} + export interface MoveDocsToWikiWikiSpaceNodeRequest { /** 节点的父亲token */ parent_wiki_token?: string @@ -194,65 +239,6 @@ export interface MoveDocsToWikiWikiSpaceNodeRequest { apply?: boolean } -export interface GetWikiTaskQuery { - /** 任务类型 */ - task_type: 'move' -} - -export interface SearchWikiNodeRequest { - /** 搜索关键词 */ - query: string - /** 文档所属的知识空间ID,为空搜索所有 wiki */ - space_id?: string - /** wiki token,不为空搜索该节点及其所有子节点,为空搜索所有 wiki(根据 space_id 选择 space) */ - node_id?: string -} - -export interface GetWikiSpaceResponse { - /** 知识空间 */ - space?: Space -} - -export interface CreateWikiSpaceResponse { - /** 知识空间信息 */ - space?: Space -} - -export interface CreateWikiSpaceMemberResponse { - /** 知识库协作者 */ - member?: Member -} - -export interface DeleteWikiSpaceMemberResponse { - /** 成员信息 */ - member: Member -} - -export interface UpdateWikiSpaceSettingResponse { - /** 空间设置 */ - setting?: Setting -} - -export interface CreateWikiSpaceNodeResponse { - /** 节点 */ - node?: Node -} - -export interface GetNodeWikiSpaceResponse { - /** 节点信息 */ - node?: Node -} - -export interface MoveWikiSpaceNodeResponse { - /** 移动后的节点信息 */ - node?: Node -} - -export interface CopyWikiSpaceNodeResponse { - /** copy后的节点 */ - node: Node -} - export interface MoveDocsToWikiWikiSpaceNodeResponse { /** 移动后的知识库token */ wiki_token?: string @@ -262,11 +248,25 @@ export interface MoveDocsToWikiWikiSpaceNodeResponse { applied?: boolean } +export interface GetWikiTaskQuery { + /** 任务类型 */ + task_type: 'move' +} + export interface GetWikiTaskResponse { /** 任务结果 */ task: TaskResult } +export interface SearchWikiNodeRequest { + /** 搜索关键词 */ + query: string + /** 文档所属的知识空间ID,为空搜索所有 wiki */ + space_id?: string + /** wiki token,不为空搜索该节点及其所有子节点,为空搜索所有 wiki(根据 space_id 选择 space) */ + node_id?: string +} + Internal.define({ '/wiki/v2/spaces': { GET: { name: 'listWikiSpace', pagination: { argIndex: 0 } },