From 9531b30a251df530e8cf7568f28648441f90411d Mon Sep 17 00:00:00 2001 From: Shigma Date: Mon, 6 Jan 2025 23:45:24 +0800 Subject: [PATCH] refa(lark): re-generate all the types --- adapters/lark/package.json | 4 +- adapters/lark/scripts/types.ts | 329 + adapters/lark/src/bot.ts | 22 +- .../lark/src/{types/message => }/content.ts | 1 + adapters/lark/src/http.ts | 4 +- adapters/lark/src/index.ts | 6 +- adapters/lark/src/{types => }/internal.ts | 26 +- adapters/lark/src/message.ts | 9 +- adapters/lark/src/types/acs.ts | 260 + adapters/lark/src/types/admin.ts | 393 + adapters/lark/src/types/aily.ts | 359 + adapters/lark/src/types/apaas.ts | 646 + adapters/lark/src/types/api.ts | 30455 ---------------- adapters/lark/src/types/application.ts | 597 + adapters/lark/src/types/approval.ts | 973 + adapters/lark/src/types/attendance.ts | 1214 + adapters/lark/src/types/auth.ts | 122 + adapters/lark/src/types/authen.ts | 220 + adapters/lark/src/types/baike.ts | 321 + adapters/lark/src/types/bitable.ts | 946 + adapters/lark/src/types/board.ts | 31 + adapters/lark/src/types/calendar.ts | 886 + adapters/lark/src/types/cardkit.ts | 182 + adapters/lark/src/types/compensation.ts | 169 + adapters/lark/src/types/contact.ts | 1662 + adapters/lark/src/types/corehr.ts | 6043 +++ adapters/lark/src/types/docs.ts | 33 + adapters/lark/src/types/document_ai.ts | 352 + adapters/lark/src/types/docx.ts | 523 + adapters/lark/src/types/drive.ts | 1386 + adapters/lark/src/types/ehr.ts | 55 + adapters/lark/src/types/event.ts | 49 +- adapters/lark/src/types/helpdesk.ts | 948 + adapters/lark/src/types/hire.ts | 4605 +++ .../lark/src/types/human_authentication.ts | 38 + adapters/lark/src/types/im.ts | 1691 + adapters/lark/src/types/index.ts | 17797 ++++++++- adapters/lark/src/types/lingo.ts | 360 + adapters/lark/src/types/mail.ts | 935 + adapters/lark/src/types/mdm.ts | 57 + adapters/lark/src/types/message/index.ts | 97 - adapters/lark/src/types/minutes.ts | 46 + adapters/lark/src/types/moments.ts | 28 + adapters/lark/src/types/okr.ts | 277 + .../src/types/optical_char_recognition.ts | 27 + adapters/lark/src/types/passport.ts | 61 + adapters/lark/src/types/payroll.ts | 118 + adapters/lark/src/types/performance.ts | 628 + adapters/lark/src/types/personal_settings.ts | 132 + adapters/lark/src/types/report.ts | 86 + adapters/lark/src/types/search.ts | 307 + .../lark/src/types/security_and_compliance.ts | 42 + adapters/lark/src/types/sheets.ts | 425 + adapters/lark/src/types/speech_to_text.ts | 54 + adapters/lark/src/types/task.ts | 1649 + adapters/lark/src/types/tenant.ts | 36 + adapters/lark/src/types/translation.ts | 52 + adapters/lark/src/types/vc.ts | 1308 + adapters/lark/src/types/verification.ts | 23 + adapters/lark/src/types/wiki.ts | 371 + adapters/lark/src/types/workplace.ts | 98 + adapters/lark/src/utils.ts | 160 +- 62 files changed, 50093 insertions(+), 30641 deletions(-) create mode 100644 adapters/lark/scripts/types.ts rename adapters/lark/src/{types/message => }/content.ts (99%) rename adapters/lark/src/{types => }/internal.ts (76%) create mode 100644 adapters/lark/src/types/acs.ts create mode 100644 adapters/lark/src/types/admin.ts create mode 100644 adapters/lark/src/types/aily.ts create mode 100644 adapters/lark/src/types/apaas.ts delete mode 100644 adapters/lark/src/types/api.ts create mode 100644 adapters/lark/src/types/application.ts create mode 100644 adapters/lark/src/types/approval.ts create mode 100644 adapters/lark/src/types/attendance.ts create mode 100644 adapters/lark/src/types/auth.ts create mode 100644 adapters/lark/src/types/authen.ts create mode 100644 adapters/lark/src/types/baike.ts create mode 100644 adapters/lark/src/types/bitable.ts create mode 100644 adapters/lark/src/types/board.ts create mode 100644 adapters/lark/src/types/calendar.ts create mode 100644 adapters/lark/src/types/cardkit.ts create mode 100644 adapters/lark/src/types/compensation.ts create mode 100644 adapters/lark/src/types/contact.ts create mode 100644 adapters/lark/src/types/corehr.ts create mode 100644 adapters/lark/src/types/docs.ts create mode 100644 adapters/lark/src/types/document_ai.ts create mode 100644 adapters/lark/src/types/docx.ts create mode 100644 adapters/lark/src/types/drive.ts create mode 100644 adapters/lark/src/types/ehr.ts create mode 100644 adapters/lark/src/types/helpdesk.ts create mode 100644 adapters/lark/src/types/hire.ts create mode 100644 adapters/lark/src/types/human_authentication.ts create mode 100644 adapters/lark/src/types/im.ts create mode 100644 adapters/lark/src/types/lingo.ts create mode 100644 adapters/lark/src/types/mail.ts create mode 100644 adapters/lark/src/types/mdm.ts delete mode 100644 adapters/lark/src/types/message/index.ts create mode 100644 adapters/lark/src/types/minutes.ts create mode 100644 adapters/lark/src/types/moments.ts create mode 100644 adapters/lark/src/types/okr.ts create mode 100644 adapters/lark/src/types/optical_char_recognition.ts create mode 100644 adapters/lark/src/types/passport.ts create mode 100644 adapters/lark/src/types/payroll.ts create mode 100644 adapters/lark/src/types/performance.ts create mode 100644 adapters/lark/src/types/personal_settings.ts create mode 100644 adapters/lark/src/types/report.ts create mode 100644 adapters/lark/src/types/search.ts create mode 100644 adapters/lark/src/types/security_and_compliance.ts create mode 100644 adapters/lark/src/types/sheets.ts create mode 100644 adapters/lark/src/types/speech_to_text.ts create mode 100644 adapters/lark/src/types/task.ts create mode 100644 adapters/lark/src/types/tenant.ts create mode 100644 adapters/lark/src/types/translation.ts create mode 100644 adapters/lark/src/types/vc.ts create mode 100644 adapters/lark/src/types/verification.ts create mode 100644 adapters/lark/src/types/wiki.ts create mode 100644 adapters/lark/src/types/workplace.ts diff --git a/adapters/lark/package.json b/adapters/lark/package.json index 2392090d..879d31ec 100644 --- a/adapters/lark/package.json +++ b/adapters/lark/package.json @@ -36,7 +36,9 @@ "devDependencies": { "@cordisjs/plugin-server": "^0.2.5", "@satorijs/core": "^4.4.2", - "cordis": "^3.18.1" + "cordis": "^3.18.1", + "cosmokit": "^1.6.3", + "dedent": "^1.5.3" }, "peerDependencies": { "@satorijs/core": "^4.4.2" diff --git a/adapters/lark/scripts/types.ts b/adapters/lark/scripts/types.ts new file mode 100644 index 00000000..32ed68a1 --- /dev/null +++ b/adapters/lark/scripts/types.ts @@ -0,0 +1,329 @@ +/* eslint-disable no-console */ + +import { mkdir, readFile, writeFile } from 'node:fs/promises' +import { capitalize } from 'cosmokit' +import pMap from 'p-map' +import dedent from 'dedent' + +interface Response { + code: number + msg: string + data: T +} + +export interface ApiMeta { + Name: string + Project: string + Resource: string + Type: 1 + Version: string +} + +interface Api { + bizTag: string + chargingMethod: 'none' | 'basic' + detail: string + fullDose: boolean + fullPath: string + id: string + isCharge: boolean + meta: ApiMeta + name: string + orderMark: string + supportAppTypes: string[] + tags: string[] + updateTime: number + url: string +} + +interface BizInfo { + desc: string + name: string +} + +interface ApiList { + apis: Api[] + bizInfos: BizInfo[] +} + +export interface Schema { + name: string + type: string + format: string + description: string + example: string + idTypes: {} // ? + defaultValue: string + ref: string // ? + required: boolean + properties?: Schema[] + items?: Schema + options?: { + name: string + value: string + description: string + }[] +} + +interface ApiDetail { + request: { + query: Schema + body?: Schema + path?: Schema + contentType: '' + } + response: { + body: Schema + contentType: string + } + project: string + apiName: string + scopesOfFieldRequired: [] // ? + pagination: boolean + supportFileDownload: boolean + supportFileUpload: boolean + resource: string + apiPath: string + description: string + scopesOfDebugRequired: string[] + errorMappings: { + msg: string + httpCode: number + code: number + }[] + httpMethod: string + version: string + accessTokens: 'tenant'[] + basicRateLimit: { + tier: number + } +} + +const refs: Record = {} +const projects: Record = {} + +async function request(url: string) { + const response = await fetch(url) + const body: Response = await response.json() + if (body.code) throw new Error(`${body.msg}, url: ${url}`) + return body.data +} + +async function getDetail(api: Api) { + const path = new URL(`../temp/api/${api.id}.json`, import.meta.url) + try { + return JSON.parse(await readFile(path, 'utf8')) as ApiDetail + } catch {} + const params = new URLSearchParams({ + apiName: api.meta.Name, + project: api.meta.Project, + resource: api.meta.Resource, + version: api.meta.Version, + }) + const data = await request(`https://open.feishu.cn/api_explorer/v1/api_definition?${params}`) + await writeFile(path, JSON.stringify(data)) + return data +} + +function toHump(name: string) { + return name.replace(/[\_\.](\w)/g, function (all, letter) { + return letter.toUpperCase() + }) +} + +function formatType(schema: Schema, imports: Set) { + if (!schema.ref) return _formatType(schema, imports) + 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 _formatType(schema: Schema, imports = new Set()) { + if (schema.type === 'file') return 'Blob' + if (schema.type === 'int') { + if (schema.options) { + return schema.options.map(v => v.value).join(' | ') + } else { + return 'number' + } + } + if (schema.type === 'float') return 'number' + if (schema.type === 'string') { + if (schema.options) { + return schema.options.map(v => `'${v.value}'`).join(' | ') + } else { + return 'string' + } + } + if (schema.type === 'boolean') return 'boolean' + if (schema.type === 'object') { + if (!schema.properties) return 'unknown' + return `{\n${generateParams(schema.properties, imports)}\n}` + } else if (schema.type === 'list') { + return formatType(schema.items!, imports) + '[]' + } + return 'unknown' +} + +function generateParams(properties: Schema[], imports: Set): string { + 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') +} + +function getApiName(detail: ApiDetail) { + let project = detail.project + if (project === 'task' || project === 'drive') { + project = project + detail.version.toUpperCase() + } + if (detail.project === detail.resource) { + return toHump(`${detail.apiName}.${project}`) + } else { + return toHump(`${detail.apiName}.${project}.${detail.resource}`) + } +} + +interface Project { + methods: string[] + requests: string[] + responses: string[] + internals: string[] + imports: Set + defines: Record> +} + +async function start() { + await mkdir(new URL('../temp/api', import.meta.url), { recursive: true }) + await mkdir(new URL('../src/types', import.meta.url), { recursive: true }) + // https://open.feishu.cn/document/server-docs/api-call-guide/server-api-list + const data = await request('https://open.feishu.cn/api/tools/server-side-api/list') + data.apis = data.apis.filter(api => api.meta.Version !== 'old') + await writeFile(new URL('../temp/apis.json', import.meta.url), JSON.stringify(data)) + const details = await pMap(data.apis, getDetail, { + concurrency: 10, + }) + + details.forEach((detail, index) => { + const summary = data.apis[index] + const project = projects[detail.project] ||= { + methods: [], + requests: [], + responses: [], + internals: [], + imports: new Set(), + defines: {}, + } + + const method = getApiName(detail) + const apiType = capitalize(method) + const args: string[] = [] + const extras: string[] = [] + let returnType = `${apiType}Response` + // if (api.pagination) console.log(apiName, 'pagination') + + for (const property of detail.request.path?.properties || []) { + args.push(`${property.name}: ${formatType(property, project.imports)}`) + } + if (detail.supportFileUpload && detail.request.body?.properties?.length) { + const name = `${apiType}Form` + args.push(`form: ${name}`) + project.requests.push(`export interface ${name} {\n${generateParams(detail.request.body!.properties, project.imports)}\n}`) + extras.push(`multipart: true`) + } else if (detail.request.body?.properties?.length) { + const name = `${apiType}Request` + project.requests.push(`export interface ${name} {\n${generateParams(detail.request.body.properties, project.imports)}\n}`) + args.push(`body: ${name}`) + } + if (detail.request.query?.properties?.length) { + const name = `${apiType}Query` + project.requests.push(`export interface ${name} {\n${generateParams(detail.request.query.properties, project.imports)}\n}`) + args.push(`query?: ${name}`) + } + + if (detail.supportFileDownload) { + // detail.response.contentType === '' + returnType = 'ArrayBuffer' + extras.push(`type: 'binary'`) + } else { + const keys = (detail.response.body?.properties || []).map(v => v.name) + if (!keys.includes('code') || !keys.includes('msg')) { + console.log(`unknown response body keys: ${keys}, see https://open.feishu.cn${summary.fullPath}}`) + return + } else if (keys.length === 2) { + returnType = 'void' + } else if (keys.length === 3 && keys.includes('data')) { + const data = detail.response.body.properties!.find(v => v.name === 'data')! + if (!data.properties?.length) { + returnType = 'void' + } else { + project.responses.push(`export interface ${returnType} {\n${generateParams(data.properties, project.imports)}\n}`) + } + } else { + project.responses.push(`export interface ${returnType} extends BaseResponse {\n${generateParams(detail.response.body.properties!, project.imports)}\n}`) + extras.push(`type: 'raw-json'`) + } + } + + project.methods.push(dedent` + /** + * ${summary.name} + * @see https://open.feishu.cn${summary.fullPath} + */ + ${method}(${args.join(', ')}): Promise<${returnType}> + `) + + const path = detail.apiPath.replace(/:([0-9a-zA-Z_]+)/g, '{$1}') + project.defines[path] ||= {} + project.defines[path][detail.httpMethod] = extras.length + ? `{ name: '${method}', ${extras.join(', ')} }` + : `'${method}'` + }) + + await Promise.all(Object.entries(projects).map(async ([name, project]) => { + const path = new URL(`../src/types/${name}.ts`, import.meta.url) + const defines = Object.entries(project.defines).map(([path, methods]) => { + const content = Object.entries(methods).map(([method, value]) => { + return ` ${method}: ${value},` + }).join('\n') + return `'${path}': {\n${content}\n },` + }).join('\n ') + const imports = [`import { Internal } from '../internal'`] + if (project.imports.size) { + imports.push(`import { ${[...project.imports].sort().join(', ')} } from '.'`) + } + await writeFile(path, [ + imports.join('\n'), + dedent` + declare module '../internal' { + interface Internal { + __METHODS__ + } + } + `.replace('__METHODS__', project.methods.join('\n').split('\n').join('\n ')), + ...project.requests, + ...project.responses, + dedent` + Internal.define({ + __DEFINES__ + }) + `.replace('__DEFINES__', defines), + ].join('\n\n') + '\n') + })) + + await writeFile(new URL('../src/types/index.ts', import.meta.url), [ + Object.entries(projects) + .sort(([a], [b]) => a.localeCompare(b)) + .map(([name]) => `export * from './${name}'`) + .join('\n'), + ...Object.entries(refs) + .sort(([a], [b]) => a.localeCompare(b)) + .map(([_, value]) => value), + ].join('\n\n') + '\n') +} + +start() diff --git a/adapters/lark/src/bot.ts b/adapters/lark/src/bot.ts index d4c0c643..08b22f7c 100644 --- a/adapters/lark/src/bot.ts +++ b/adapters/lark/src/bot.ts @@ -1,10 +1,19 @@ import { Bot, Context, h, HTTP, Schema, Time, Universal } from '@satorijs/core' - +import { CreateImFileForm } from './types' import { HttpServer } from './http' import { LarkMessageEncoder } from './message' -import { Internal } from './types' +import { Internal } from './internal' import * as Utils from './utils' +const fileTypeMap: Record, string[]> = { + opus: ['audio/opus'], + mp4: ['video/mp4'], + pdf: ['application/pdf'], + doc: ['application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'], + xls: ['application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'], + ppt: ['application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation'], +} + export class LarkBot extends Bot { static inject = ['server', 'http'] static MessageEncoder = LarkMessageEncoder @@ -145,9 +154,16 @@ export class LarkBot extends Bot async createUpload(...uploads: Universal.Upload[]): Promise { return await Promise.all(uploads.map(async (upload) => { + let type: CreateImFileForm['file_type'] = 'stream' + for (const [key, value] of Object.entries(fileTypeMap)) { + if (value.includes(upload.type)) { + type = key as CreateImFileForm['file_type'] + break + } + } const response = await this.internal.createImFile({ file_name: upload.filename, - file_type: upload.type, + file_type: type, file: new Blob([upload.data]), }) return this.getInternalUrl(`/im/v1/files/${response.file_key}`) diff --git a/adapters/lark/src/types/message/content.ts b/adapters/lark/src/content.ts similarity index 99% rename from adapters/lark/src/types/message/content.ts rename to adapters/lark/src/content.ts index 9aee5a26..8b52b920 100644 --- a/adapters/lark/src/types/message/content.ts +++ b/adapters/lark/src/content.ts @@ -1,3 +1,4 @@ +/* eslint-disable max-len */ // https://open.larksuite.com/document/server-docs/im-v1/message-content-description/create_json declare global { diff --git a/adapters/lark/src/http.ts b/adapters/lark/src/http.ts index 317c63a9..ebfd5261 100644 --- a/adapters/lark/src/http.ts +++ b/adapters/lark/src/http.ts @@ -1,9 +1,7 @@ import { Adapter, Context, Logger, Schema } from '@satorijs/core' import {} from '@cordisjs/plugin-server' - import { LarkBot } from './bot' -import { EventPayload } from './types' -import { adaptSession, Cipher } from './utils' +import { adaptSession, Cipher, EventPayload } from './utils' export class HttpServer extends Adapter> { static inject = ['server'] diff --git a/adapters/lark/src/index.ts b/adapters/lark/src/index.ts index 80d3a4ef..4dd13720 100644 --- a/adapters/lark/src/index.ts +++ b/adapters/lark/src/index.ts @@ -1,4 +1,6 @@ import { LarkBot } from './bot' +import { Internal } from './internal' +import { EventPayload } from './utils' import * as Lark from './types' export * from './bot' @@ -9,7 +11,7 @@ export default LarkBot declare module '@satorijs/core' { interface Session { - feishu: Lark.Internal & Lark.EventPayload - lark: Lark.Internal & Lark.EventPayload + feishu: Internal & EventPayload + lark: Internal & EventPayload } } diff --git a/adapters/lark/src/types/internal.ts b/adapters/lark/src/internal.ts similarity index 76% rename from adapters/lark/src/types/internal.ts rename to adapters/lark/src/internal.ts index 2fb9d856..366fd052 100644 --- a/adapters/lark/src/types/internal.ts +++ b/adapters/lark/src/internal.ts @@ -1,5 +1,5 @@ import { Dict, HTTP, makeArray } from '@satorijs/core' -import { LarkBot } from '../bot' +import { LarkBot } from './bot' export interface Internal {} @@ -10,9 +10,10 @@ export interface BaseResponse { msg: string } -export interface InternalConfig { +export interface InternalRoute { + name: string multipart?: boolean - type?: 'json-body' | 'binary' + type?: 'raw-json' | 'binary' } export class Internal { @@ -26,7 +27,7 @@ export class Internal { throw error } - private _buildData(arg: object, options: InternalConfig) { + private _buildData(arg: object, options: InternalRoute) { if (options.multipart) { const form = new FormData() for (const [key, value] of Object.entries(arg)) { @@ -42,12 +43,15 @@ export class Internal { } } - static define(routes: Dict>>, options: InternalConfig = {}) { + static define(routes: Dict>>) { for (const path in routes) { for (const key in routes[path]) { const method = key as HTTP.Method - for (const name of makeArray(routes[path][method])) { - Internal.prototype[name] = async function (this: Internal, ...args: any[]) { + for (let route of makeArray(routes[path][method])) { + if (typeof route === 'string') { + route = { name: route } + } + Internal.prototype[route.name] = async function (this: Internal, ...args: any[]) { const raw = args.join(', ') const url = path.replace(/\{([^}]+)\}/g, () => { if (!args.length) throw new Error(`too few arguments for ${path}, received ${raw}`) @@ -58,20 +62,20 @@ export class Internal { if (method === 'GET' || method === 'DELETE') { config.params = args[0] } else { - config.data = this._buildData(args[0], options) + config.data = this._buildData(args[0], route) } } else if (args.length === 2 && method !== 'GET' && method !== 'DELETE') { - config.data = this._buildData(args[0], options) + config.data = this._buildData(args[0], route) config.params = args[1] } else if (args.length > 1) { throw new Error(`too many arguments for ${path}, received ${raw}`) } - if (options.type === 'binary') { + if (route.type === 'binary') { config.responseType = 'arraybuffer' } const response = await this.bot.http(method, url, config) this._assertResponse(response) - if (options.type === 'json-body' || options.type === 'binary') { + if (route.type === 'raw-json' || route.type === 'binary') { return response.data } else { return response.data.data diff --git a/adapters/lark/src/message.ts b/adapters/lark/src/message.ts index d7b54cb6..56f9c80f 100644 --- a/adapters/lark/src/message.ts +++ b/adapters/lark/src/message.ts @@ -1,7 +1,8 @@ import { Context, Dict, h, MessageEncoder } from '@satorijs/core' import { LarkBot } from './bot' -import { CreateImFileForm, EventPayload, Lark, MessageContent } from './types' -import { extractIdType } from './utils' +import { CreateImFileForm, Message } from './types' +import { EventPayload, extractIdType } from './utils' +import { MessageContent } from './content' export class LarkMessageEncoder extends MessageEncoder> { declare referrer?: EventPayload @@ -17,7 +18,7 @@ export class LarkMessageEncoder extends MessageEnco async post(data?: any) { try { - let resp: Lark.Message + let resp: Message let quote = this.quote if (!quote && this.referrer) { if (this.referrer.type === 'im.message.receive_v1' && this.referrer.event.message.thread_id) { @@ -157,7 +158,7 @@ export class LarkMessageEncoder extends MessageEnco } else { const ext = filename.split('.').pop() if (['doc', 'xls', 'ppt', 'pdf'].includes(ext)) { - file_type = ext + file_type = ext as any } else { file_type = 'stream' } diff --git a/adapters/lark/src/types/acs.ts b/adapters/lark/src/types/acs.ts new file mode 100644 index 00000000..45060934 --- /dev/null +++ b/adapters/lark/src/types/acs.ts @@ -0,0 +1,260 @@ +import { Internal } from '../internal' +import { AccessRecord, Device, Feature, Rule, User, UserExternal } from '.' + +declare module '../internal' { + interface Internal { + /** + * 修改用户部分信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch + */ + patchAcsUser(user_id: string, body: PatchAcsUserRequest, query?: PatchAcsUserQuery): Promise + /** + * 获取单个用户信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get + */ + getAcsUser(user_id: string, query?: GetAcsUserQuery): Promise + /** + * 获取用户列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list + */ + listAcsUser(query?: ListAcsUserQuery): Promise + /** + * 上传人脸图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update + */ + updateAcsUserFace(user_id: string, form: UpdateAcsUserFaceForm, query?: UpdateAcsUserFaceQuery): Promise + /** + * 下载人脸图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get + */ + getAcsUserFace(user_id: string, query?: GetAcsUserFaceQuery): Promise + /** + * 设备绑定权限组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind + */ + deviceBindAcsRuleExternal(body: DeviceBindAcsRuleExternalRequest): Promise + /** + * 获取权限组信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get + */ + getAcsRuleExternal(query?: GetAcsRuleExternalQuery): Promise + /** + * 删除权限组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete + */ + deleteAcsRuleExternal(query?: DeleteAcsRuleExternalQuery): Promise + /** + * 创建或更新权限组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create + */ + createAcsRuleExternal(body: CreateAcsRuleExternalRequest, query?: CreateAcsRuleExternalQuery): Promise + /** + * 删除访客 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete + */ + deleteAcsVisitor(visitor_id: string, query?: DeleteAcsVisitorQuery): Promise + /** + * 添加访客 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create + */ + createAcsVisitor(body: CreateAcsVisitorRequest, query?: CreateAcsVisitorQuery): Promise + /** + * 获取门禁设备列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list + */ + listAcsDevice(): Promise + /** + * 获取门禁记录列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list + */ + listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Promise + /** + * 下载开门时的人脸识别图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get + */ + getAcsAccessRecordAccessPhoto(access_record_id: string): Promise + } +} + +export interface PatchAcsUserRequest { + /** 用户特征 */ + feature?: Feature +} + +export interface PatchAcsUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetAcsUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListAcsUserQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateAcsUserFaceForm { + /** 人脸图片内容 */ + files: Blob + /** 文件类型,可选的类型有jpg,png */ + file_type: string + /** 带后缀的文件名 */ + file_name: string +} + +export interface UpdateAcsUserFaceQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetAcsUserFaceQuery { + /** 裁剪图 */ + is_cropped?: boolean + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeviceBindAcsRuleExternalRequest { + /** 设备id */ + device_id: string + /** 权限组id列表 */ + rule_ids: string[] +} + +export interface GetAcsRuleExternalQuery { + /** 设备id */ + device_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteAcsRuleExternalQuery { + /** 权限组id */ + rule_id: string +} + +export interface CreateAcsRuleExternalRequest { + /** 权限组信息 */ + rule: Rule +} + +export interface CreateAcsRuleExternalQuery { + /** 权限组id-为空创建,不为空则更新 */ + rule_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteAcsVisitorQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateAcsVisitorRequest { + /** 访客信息 */ + user: UserExternal +} + +export interface CreateAcsVisitorQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListAcsAccessRecordQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 记录开始时间，单位秒 */ + from: number + /** 记录结束时间，单位秒，时间跨度不能超过30天 */ + to: number + /** 门禁设备 ID */ + device_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetAcsUserResponse { + /** 门禁用户信息 */ + user?: User +} + +export interface ListAcsUserResponse { + items?: User[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface GetAcsRuleExternalResponse { + /** 设备权限组信息 */ + rules: Rule[] +} + +export interface CreateAcsRuleExternalResponse { + /** 权限组id */ + rule_id: string +} + +export interface CreateAcsVisitorResponse { + /** 访客的id */ + visitor_id: string +} + +export interface ListAcsDeviceResponse { + items?: Device[] +} + +export interface ListAcsAccessRecordResponse { + items?: AccessRecord[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +Internal.define({ + '/open-apis/acs/v1/users/{user_id}': { + PATCH: 'patchAcsUser', + GET: 'getAcsUser', + }, + '/open-apis/acs/v1/users': { + GET: 'listAcsUser', + }, + '/open-apis/acs/v1/users/{user_id}/face': { + PUT: { name: 'updateAcsUserFace', multipart: true }, + GET: { name: 'getAcsUserFace', type: 'binary' }, + }, + '/open-apis/acs/v1/rule_external/device_bind': { + POST: 'deviceBindAcsRuleExternal', + }, + '/open-apis/acs/v1/rule_external': { + GET: 'getAcsRuleExternal', + DELETE: 'deleteAcsRuleExternal', + POST: 'createAcsRuleExternal', + }, + '/open-apis/acs/v1/visitors/{visitor_id}': { + DELETE: 'deleteAcsVisitor', + }, + '/open-apis/acs/v1/visitors': { + POST: 'createAcsVisitor', + }, + '/open-apis/acs/v1/devices': { + GET: 'listAcsDevice', + }, + '/open-apis/acs/v1/access_records': { + GET: 'listAcsAccessRecord', + }, + '/open-apis/acs/v1/access_records/{access_record_id}/access_photo': { + GET: { name: 'getAcsAccessRecordAccessPhoto', type: 'binary' }, + }, +}) diff --git a/adapters/lark/src/types/admin.ts b/adapters/lark/src/types/admin.ts new file mode 100644 index 00000000..c0bd7898 --- /dev/null +++ b/adapters/lark/src/types/admin.ts @@ -0,0 +1,393 @@ +import { Internal } from '../internal' +import { AdminDeptStat, AdminUserStat, AuditInfo, Badge, Grant, I18n, Password, RuleDetail } from '.' + +declare module '../internal' { + interface Internal { + /** + * 重置用户的企业邮箱密码 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/password/reset + */ + resetAdminPassword(body: ResetAdminPasswordRequest, query?: ResetAdminPasswordQuery): Promise + /** + * 获取部门维度的用户活跃和功能使用数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list + */ + listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery): Promise + /** + * 获取用户维度的用户活跃和功能使用数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list + */ + listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery): Promise + /** + * 创建勋章 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create + */ + createAdminBadge(body: CreateAdminBadgeRequest): Promise + /** + * 修改勋章信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/update + */ + updateAdminBadge(badge_id: string, body: UpdateAdminBadgeRequest): Promise + /** + * 上传勋章图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge_image/create + */ + createAdminBadgeImage(form: CreateAdminBadgeImageForm): Promise + /** + * 获取勋章列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list + */ + listAdminBadge(query?: ListAdminBadgeQuery): Promise + /** + * 获取勋章详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get + */ + getAdminBadge(badge_id: string): Promise + /** + * 创建授予名单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/create + */ + createAdminBadgeGrant(badge_id: string, body: CreateAdminBadgeGrantRequest, query?: CreateAdminBadgeGrantQuery): Promise + /** + * 删除授予名单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/delete + */ + deleteAdminBadgeGrant(badge_id: string, grant_id: string): Promise + /** + * 修改授予名单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/update + */ + updateAdminBadgeGrant(badge_id: string, grant_id: string, body: UpdateAdminBadgeGrantRequest, query?: UpdateAdminBadgeGrantQuery): Promise + /** + * 获取授予名单列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list + */ + listAdminBadgeGrant(badge_id: string, query?: ListAdminBadgeGrantQuery): Promise + /** + * 获取授予名单详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get + */ + getAdminBadgeGrant(badge_id: string, grant_id: string, query?: GetAdminBadgeGrantQuery): Promise + /** + * 获取行为审计日志数据 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get + */ + listAdminAuditInfo(query?: ListAdminAuditInfoQuery): Promise + } +} + +export interface ResetAdminPasswordRequest { + /** 需要重置的密码参数，不少于8个字符，字母、数字和符号，至少三选二 */ + password: Password + /** 待修改密码的用户ID，只针对邮箱登录凭证与企业邮箱(包括别名)相等的用户生效 */ + user_id: string +} + +export interface ResetAdminPasswordQuery { + /** 用户ID类型 */ + user_id_type: 'open_id' | 'union_id' | 'user_id' +} + +export interface ListAdminAdminDeptStatQuery { + /** 部门ID类型 */ + department_id_type: 'department_id' | 'open_department_id' + /** 起始日期（包含），格式是YYYY-mm-dd */ + start_date: string + /** 终止日期（包含），格式是YYYY-mm-dd，起止日期之间相差不能超过91天（包含91天） */ + end_date: string + /** 部门的 ID，取决于department_id_type，仅支持根部门及其下前4级子部门 */ + department_id: string + /** 是否包含子部门，如果该值为false，则只查出本部门直属用户活跃和功能使用数据；如果该值为true，则查出该部门以及其子部门（子部门层级最多不超过根部门下的前4级）的用户活跃和功能使用数据 */ + contains_child_dept: boolean + /** 分页大小，默认是10 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ + page_token?: string + /** 跨域访问的geo */ + target_geo?: string + /** 是否返回分产品版本数据 */ + with_product_version?: boolean +} + +export interface ListAdminAdminUserStatQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 部门ID类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 起始日期（包含），格式是YYYY-mm-dd */ + start_date: string + /** 终止日期（包含），格式是YYYY-mm-dd。起止日期之间相差不能超过31天（包含31天） */ + end_date: string + /** 部门的 ID，取决于department_id_type */ + department_id?: string + /** 用户的open_id，user_id或者union_id，取决于user_id_type */ + user_id?: string + /** 分页大小，默认是10 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ + page_token?: string + /** 跨域访问的geo */ + target_geo?: string +} + +export interface CreateAdminBadgeRequest { + /** 租户内唯一的勋章名称，最多30个字符。 */ + name: string + /** 勋章的描述文案，最多100个字符。 */ + explanation?: string + /** 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ + detail_image: string + /** 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ + show_image: string + /** 勋章的多语言名称，同name字段限制，最多30个字符。 */ + i18n_name?: I18n + /** 勋章的多语言描述文案，同explanation字段限制，最多100个字符。 */ + i18n_explanation?: I18n +} + +export interface UpdateAdminBadgeRequest { + /** 租户内唯一的勋章名称，最多30个字符。 */ + name: string + /** 勋章的描述文案，最多100个字符。 */ + explanation?: string + /** 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ + detail_image: string + /** 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ + show_image: string + /** 勋章的多语言名称，同name字段限制，最多30个字符。 */ + i18n_name?: I18n + /** 勋章的多语言描述文案，同explanation字段限制，最多100个字符。 */ + i18n_explanation?: I18n +} + +export interface CreateAdminBadgeImageForm { + /** 勋章图片的文件，仅支持 PNG 格式，320 x 320 像素，大小不超过 1024 KB。 */ + image_file: Blob + /** 图片的类型 */ + image_type: 1 | 2 +} + +export interface ListAdminBadgeQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 租户内唯一的勋章名称，精确匹配。 */ + name?: string +} + +export interface CreateAdminBadgeGrantRequest { + /** 授予名单名称，最多100个字符。 */ + name: string + /** 勋章下唯一的授予事项 */ + grant_type: 0 | 1 + /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */ + time_zone: string + /** 规则详情 */ + rule_detail: RuleDetail + /** 是否授予给全员。1.为false时，需要关联1~500个用户群体。2.为true时，不可关联用户、用户组、部门。 */ + is_grant_all: boolean + /** 授予的用户ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + user_ids?: string[] + /** 授予的部门ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + department_ids?: string[] + /** 授予的用户组ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + group_ids?: string[] +} + +export interface CreateAdminBadgeGrantQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 此次调用中使用的部门ID的类型。 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface UpdateAdminBadgeGrantRequest { + /** 授予名单名称，最多100个字符。 */ + name: string + /** 勋章下唯一的授予事项 */ + grant_type: 0 | 1 + /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */ + time_zone: string + /** 规则详情 */ + rule_detail: RuleDetail + /** 是否授予给全员。1.为false时，需要关联1~500个用户群体。2.为true时，不可关联用户、用户组、部门。 */ + is_grant_all: boolean + /** 授予的用户ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + user_ids?: string[] + /** 授予的部门ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + department_ids?: string[] + /** 授予的用户组ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + group_ids?: string[] +} + +export interface UpdateAdminBadgeGrantQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 此次调用中使用的部门ID的类型。 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface ListAdminBadgeGrantQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 此次调用中使用的部门ID的类型。 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 授予名单名称，精确匹配。 */ + name?: string +} + +export interface GetAdminBadgeGrantQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 此次调用中使用的部门ID的类型。 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface ListAdminAuditInfoQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 日志时间范围: 结束时间. 格式: 秒级时间戳. 默认值: 此刻 */ + latest?: number + /** 日志时间范围: 起始时间. 格式: 秒级时间戳. 默认值: 30日前此刻 */ + oldest?: number + /** 事件名称 */ + event_name?: string + /** 过滤操作者: 操作者类型. 与 operator_value 配合使用 */ + operator_type?: 'user' | 'bot' + /** 过滤操作者: 操作者ID. 与 operator_type 配合使用 */ + operator_value?: string + /** 过滤模块 */ + event_module?: number + /** 下一页分页的token */ + page_token?: string + /** 分页参数 */ + page_size?: number + /** 过滤用户类型. 仅当 operator_type=user 时生效 */ + user_type?: 0 | 1 | 2 + /** 过滤操作对象: 操作对象类型. 与object_value配合使用 */ + object_type?: number + /** 过滤操作对象: 操作对象ID. 与object_type配合使用 */ + object_value?: string + /** 增强过滤操作对象: 操作对象ID，支持云文档侧泛token过滤。会覆盖object_type和object_value查询条件 */ + ext_filter_object_by_ccm_token?: string +} + +export interface ListAdminAdminDeptStatResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 部门统计值 */ + items?: AdminDeptStat[] +} + +export interface ListAdminAdminUserStatResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 数据报表 */ + items?: AdminUserStat[] +} + +export interface CreateAdminBadgeResponse { + /** 勋章的信息 */ + badge?: Badge +} + +export interface UpdateAdminBadgeResponse { + /** 勋章信息 */ + badge?: Badge +} + +export interface CreateAdminBadgeImageResponse { + /** 图片的key */ + image_key?: string +} + +export interface ListAdminBadgeResponse { + /** 勋章列表 */ + badges?: Badge[] + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否已经遍历完，表示本次页面请求已经拿到所有列表数据 */ + has_more?: boolean +} + +export interface GetAdminBadgeResponse { + /** 勋章信息 */ + badge?: Badge +} + +export interface CreateAdminBadgeGrantResponse { + /** 授予名单的信息 */ + grant?: Grant +} + +export interface UpdateAdminBadgeGrantResponse { + /** 授予名单 */ + grant?: Grant +} + +export interface ListAdminBadgeGrantResponse { + /** 授予名单列表 */ + grants?: Grant[] + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否已经遍历完，表示本次页面请求已经拿到所有列表数据 */ + has_more?: boolean +} + +export interface GetAdminBadgeGrantResponse { + /** 授予名单信息 */ + grant?: Grant +} + +export interface ListAdminAuditInfoResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 返回的具体数据内容 */ + items?: AuditInfo[] +} + +Internal.define({ + '/open-apis/admin/v1/password/reset': { + POST: 'resetAdminPassword', + }, + '/open-apis/admin/v1/admin_dept_stats': { + GET: 'listAdminAdminDeptStat', + }, + '/open-apis/admin/v1/admin_user_stats': { + GET: 'listAdminAdminUserStat', + }, + '/open-apis/admin/v1/badges': { + POST: 'createAdminBadge', + GET: 'listAdminBadge', + }, + '/open-apis/admin/v1/badges/{badge_id}': { + PUT: 'updateAdminBadge', + GET: 'getAdminBadge', + }, + '/open-apis/admin/v1/badge_images': { + POST: { name: 'createAdminBadgeImage', multipart: true }, + }, + '/open-apis/admin/v1/badges/{badge_id}/grants': { + POST: 'createAdminBadgeGrant', + GET: 'listAdminBadgeGrant', + }, + '/open-apis/admin/v1/badges/{badge_id}/grants/{grant_id}': { + DELETE: 'deleteAdminBadgeGrant', + PUT: 'updateAdminBadgeGrant', + GET: 'getAdminBadgeGrant', + }, + '/open-apis/admin/v1/audit_infos': { + GET: 'listAdminAuditInfo', + }, +}) diff --git a/adapters/lark/src/types/aily.ts b/adapters/lark/src/types/aily.ts new file mode 100644 index 00000000..ebe16dee --- /dev/null +++ b/adapters/lark/src/types/aily.ts @@ -0,0 +1,359 @@ +import { Internal } from '../internal' +import { AilyKnowledgeAskProcessData, AilyKnowledgeFaq, AilyKnowledgeMessage, AilyMention, AilyMessage, AilyMessageContentType, AilySession, DataAsset, DataAssetTag, Run, Skill, SkillGlobalVariable } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建会话 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create + */ + createAilyAilySession(body: CreateAilyAilySessionRequest): Promise + /** + * 更新会话 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/update + */ + updateAilyAilySession(aily_session_id: string, body: UpdateAilyAilySessionRequest): Promise + /** + * 获取会话 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/get + */ + getAilyAilySession(aily_session_id: string): Promise + /** + * 删除会话 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/delete + */ + deleteAilyAilySession(aily_session_id: string): Promise + /** + * 发送智能伙伴消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create + */ + createAilyAilySessionAilyMessage(aily_session_id: string, body: CreateAilyAilySessionAilyMessageRequest): Promise + /** + * 获取智能伙伴消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get + */ + getAilyAilySessionAilyMessage(aily_session_id: string, aily_message_id: string): Promise + /** + * 列出智能伙伴消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list + */ + listAilyAilySessionAilyMessage(aily_session_id: string, query?: ListAilyAilySessionAilyMessageQuery): Promise + /** + * 创建运行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create + */ + createAilyAilySessionRun(aily_session_id: string, body: CreateAilyAilySessionRunRequest): Promise + /** + * 获取运行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/get + */ + getAilyAilySessionRun(aily_session_id: string, run_id: string): Promise + /** + * 列出运行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list + */ + listAilyAilySessionRun(aily_session_id: string, query?: ListAilyAilySessionRunQuery): Promise + /** + * 取消运行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel + */ + cancelAilyAilySessionRun(aily_session_id: string, run_id: string): Promise + /** + * 调用技能 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/start + */ + startAilyAppSkill(app_id: string, skill_id: string, body: StartAilyAppSkillRequest): Promise + /** + * 获取技能信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/get + */ + getAilyAppSkill(app_id: string, skill_id: string): Promise + /** + * 查询技能列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/list + */ + listAilyAppSkill(app_id: string, query?: ListAilyAppSkillQuery): Promise + /** + * 执行数据知识问答 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-knowledge/ask + */ + askAilyAppKnowledge(app_id: string, body: AskAilyAppKnowledgeRequest): Promise + /** + * 查询数据知识列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/list + */ + listAilyAppDataAsset(app_id: string, query?: ListAilyAppDataAssetQuery): Promise + /** + * 获取数据知识分类列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset_tag/list + */ + listAilyAppDataAssetTag(app_id: string, query?: ListAilyAppDataAssetTagQuery): Promise + } +} + +export interface CreateAilyAilySessionRequest { + /** 渠道上下文 */ + channel_context?: string + /** 其他透传信息 */ + metadata?: string +} + +export interface UpdateAilyAilySessionRequest { + /** 渠道上下文 */ + channel_context?: string + /** 其他透传信息 */ + metadata?: string +} + +export interface CreateAilyAilySessionAilyMessageRequest { + /** 幂等id，同一 session 下相同的幂等 id 算一条消息，有效期72h */ + idempotent_id: string + /** 消息内容类型 */ + content_type: AilyMessageContentType + /** 消息内容 */ + content: string + /** 消息中包含的文件 ID 列表 */ + file_ids?: string[] + /** 引用的消息 ID */ + quote_message_id?: string + /** 被@的实体 */ + mentions?: AilyMention[] +} + +export interface ListAilyAilySessionAilyMessageQuery { + /** 页面大小 */ + page_size?: number + /** 分页偏移量 */ + page_token?: string + /** 运行 ID */ + run_id?: string + /** 返回生成中的消息 */ + with_partial_message?: boolean +} + +export interface CreateAilyAilySessionRunRequest { + /** 应用 ID */ + app_id: string + /** 技能 ID */ + skill_id?: string + /** 指定技能 ID 时可以同时指定技能输入 */ + skill_input?: string + /** 其他透传信息 */ + metadata?: string +} + +export interface ListAilyAilySessionRunQuery { + /** 页面大小 */ + page_size?: number + /** 分页偏移量 */ + page_token?: string +} + +export interface StartAilyAppSkillRequest { + /** 技能的全局变量 */ + global_variable?: SkillGlobalVariable + /** 技能的自定义变量 */ + input?: string +} + +export interface ListAilyAppSkillQuery { + /** 页面大小 */ + page_size?: number + /** 分页偏移量 */ + page_token?: string +} + +export interface AskAilyAppKnowledgeRequest { + /** 输入消息（当前仅支持纯文本输入） */ + message: AilyKnowledgeMessage + /** 控制知识问答所依据的数据知识范围 */ + data_asset_ids?: string[] + /** 控制知识问答所依据的数据知识分类范围 */ + data_asset_tag_ids?: string[] +} + +export interface ListAilyAppDataAssetQuery { + /** 分页参数：分页大小，默认：20，最大：100 */ + page_size?: number + /** 分页参数：分页起始位置，为空表示首页 */ + page_token?: string + /** 模糊匹配关键词 */ + 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 { + /** 分页参数：分页大小，默认：20，最大：100 */ + page_size?: number + /** 分页参数：分页起始位置，为空表示首页 */ + page_token?: string + /** 模糊匹配分类名称 */ + 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 ListAilyAilySessionAilyMessageResponse { + /** 消息列表 */ + messages?: AilyMessage[] + /** 下一页的起始偏移量 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface CreateAilyAilySessionRunResponse { + /** 运行信息 */ + run?: Run +} + +export interface GetAilyAilySessionRunResponse { + /** 运行信息 */ + run?: Run +} + +export interface ListAilyAilySessionRunResponse { + /** 运行列表 */ + runs?: Run[] + /** 下一页的起始偏移量 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface CancelAilyAilySessionRunResponse { + /** 运行信息 */ + run?: Run +} + +export interface StartAilyAppSkillResponse { + /** 技能的输出 */ + output?: string + /** 技能的执行状态 */ + status?: string +} + +export interface GetAilyAppSkillResponse { + /** 技能信息 */ + skill?: Skill +} + +export interface ListAilyAppSkillResponse { + /** 技能列表 */ + skills?: Skill[] + /** 下一页的起始偏移量 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface AskAilyAppKnowledgeResponse { + /** 响应状态，枚举值 */ + status?: 'processing' | 'finished' + /** 结束类型，枚举值 */ + finish_type?: 'qa' | 'faq' + /** 响应消息 */ + message?: AilyKnowledgeMessage + /** 知识问答运行过程结构化数据，status=finished 且 finish_type=qa 时返回 */ + process_data?: AilyKnowledgeAskProcessData + /** 匹配标准问答对结果，status=finished 且 finish_type=faq时返回 */ + faq_result?: AilyKnowledgeFaq + /** 是否有结果，true 则 代表 message 中的内容是通过配置知识而生成的 */ + has_answer?: boolean +} + +export interface ListAilyAppDataAssetResponse { + /** 数据知识列表 */ + items?: DataAsset[] + /** has_more=true，可使用page_token继续查询 */ + page_token?: string + /** 是否有更多 */ + has_more?: boolean +} + +export interface ListAilyAppDataAssetTagResponse { + /** 数据知识分类列表 */ + items?: DataAssetTag[] + /** has_more=true，可使用 page_token继续查询 */ + page_token?: string + /** 是否有更多 */ + has_more?: boolean +} + +Internal.define({ + '/open-apis/aily/v1/sessions': { + POST: 'createAilyAilySession', + }, + '/open-apis/aily/v1/sessions/{aily_session_id}': { + PUT: 'updateAilyAilySession', + GET: 'getAilyAilySession', + DELETE: 'deleteAilyAilySession', + }, + '/open-apis/aily/v1/sessions/{aily_session_id}/messages': { + POST: 'createAilyAilySessionAilyMessage', + GET: 'listAilyAilySessionAilyMessage', + }, + '/open-apis/aily/v1/sessions/{aily_session_id}/messages/{aily_message_id}': { + GET: 'getAilyAilySessionAilyMessage', + }, + '/open-apis/aily/v1/sessions/{aily_session_id}/runs': { + POST: 'createAilyAilySessionRun', + GET: 'listAilyAilySessionRun', + }, + '/open-apis/aily/v1/sessions/{aily_session_id}/runs/{run_id}': { + GET: 'getAilyAilySessionRun', + }, + '/open-apis/aily/v1/sessions/{aily_session_id}/runs/{run_id}/cancel': { + POST: 'cancelAilyAilySessionRun', + }, + '/open-apis/aily/v1/apps/{app_id}/skills/{skill_id}/start': { + POST: 'startAilyAppSkill', + }, + '/open-apis/aily/v1/apps/{app_id}/skills/{skill_id}': { + GET: 'getAilyAppSkill', + }, + '/open-apis/aily/v1/apps/{app_id}/skills': { + GET: 'listAilyAppSkill', + }, + '/open-apis/aily/v1/apps/{app_id}/knowledges/ask': { + POST: 'askAilyAppKnowledge', + }, + '/open-apis/aily/v1/apps/{app_id}/data_assets': { + GET: 'listAilyAppDataAsset', + }, + '/open-apis/aily/v1/apps/{app_id}/data_asset_tags': { + GET: 'listAilyAppDataAssetTag', + }, +}) diff --git a/adapters/lark/src/types/apaas.ts b/adapters/lark/src/types/apaas.ts new file mode 100644 index 00000000..098283ff --- /dev/null +++ b/adapters/lark/src/types/apaas.ts @@ -0,0 +1,646 @@ +import { Internal } from '../internal' +import { AllowedRollbaclkTaskItemType, AuditLogDetail, AuditLogEsField, Criterion, EnvironmentVariable, EnvironmentVariableFilter, ObjectMeta, RecordGroupByItem, RecordResult, RoleMember, SearchObjectParam, Sort, UserTask } from '.' + +declare module '../internal' { + interface Internal { + /** + * 查询审计日志列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/audit_log_list + */ + auditLogListApaasApplicationAuditLog(namespace: string, query?: AuditLogListApaasApplicationAuditLogQuery): Promise + /** + * 查询审计日志详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/get + */ + getApaasApplicationAuditLog(namespace: string, query?: GetApaasApplicationAuditLogQuery): Promise + /** + * 批量删除角色成员授权 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_remove_authorization + */ + batchRemoveAuthorizationApaasApplicationRoleMember(namespace: string, role_api_name: string, body: BatchRemoveAuthorizationApaasApplicationRoleMemberRequest): Promise + /** + * 批量创建角色成员授权 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_create_authorization + */ + batchCreateAuthorizationApaasApplicationRoleMember(namespace: string, role_api_name: string, body: BatchCreateAuthorizationApaasApplicationRoleMemberRequest): Promise + /** + * 查询角色成员信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/get + */ + getApaasApplicationRoleMember(namespace: string, role_api_name: string, query?: GetApaasApplicationRoleMemberQuery): Promise + /** + * 批量删除记录权限用户授权 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_remove_authorization + */ + batchRemoveAuthorizationApaasApplicationRecordPermissionMember(namespace: string, record_permission_api_name: string, body: BatchRemoveAuthorizationApaasApplicationRecordPermissionMemberRequest): Promise + /** + * 批量创建记录权限用户授权 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_create_authorization + */ + batchCreateAuthorizationApaasApplicationRecordPermissionMember(namespace: string, record_permission_api_name: string, body: BatchCreateAuthorizationApaasApplicationRecordPermissionMemberRequest): Promise + /** + * 执行 OQL + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/oql_query + */ + oqlQueryApaasApplicationObject(namespace: string, body: OqlQueryApaasApplicationObjectRequest): Promise + /** + * 搜索记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/search + */ + searchApaasApplicationObject(namespace: string, body: SearchApaasApplicationObjectRequest): Promise + /** + * 获取记录详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/query + */ + queryApaasApplicationObjectRecord(namespace: string, object_api_name: string, id: string, body: QueryApaasApplicationObjectRecordRequest): Promise + /** + * 编辑记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/patch + */ + patchApaasApplicationObjectRecord(namespace: string, object_api_name: string, id: string, body: PatchApaasApplicationObjectRecordRequest): Promise + /** + * 删除记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/delete + */ + deleteApaasApplicationObjectRecord(namespace: string, object_api_name: string, id: string): Promise + /** + * 新建记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/create + */ + createApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: CreateApaasApplicationObjectRecordRequest): Promise + /** + * 批量编辑记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_update + */ + batchUpdateApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchUpdateApaasApplicationObjectRecordRequest): Promise + /** + * 查询记录列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_query + */ + batchQueryApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchQueryApaasApplicationObjectRecordRequest): Promise + /** + * 批量删除记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_delete + */ + batchDeleteApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchDeleteApaasApplicationObjectRecordRequest): Promise + /** + * 批量新建记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_create + */ + batchCreateApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchCreateApaasApplicationObjectRecordRequest): Promise + /** + * 执行函数 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-function/invoke + */ + invokeApaasApplicationFunction(namespace: string, function_api_name: string, body: InvokeApaasApplicationFunctionRequest): Promise + /** + * 查询环境变量列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/query + */ + queryApaasApplicationEnvironmentVariable(namespace: string, body: QueryApaasApplicationEnvironmentVariableRequest): Promise + /** + * 查询环境变量详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/get + */ + getApaasApplicationEnvironmentVariable(namespace: string, environment_variable_api_name: string): Promise + /** + * 发起流程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-flow/execute + */ + executeApaasApplicationFlow(namespace: string, flow_id: string, body: ExecuteApaasApplicationFlowRequest): Promise + /** + * 查询人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/query + */ + queryApaasUserTask(body: QueryApaasUserTaskRequest): Promise + /** + * 同意人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/agree + */ + agreeApaasApprovalTask(approval_task_id: string, body: AgreeApaasApprovalTaskRequest): Promise + /** + * 拒绝人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/reject + */ + rejectApaasApprovalTask(approval_task_id: string, body: RejectApaasApprovalTaskRequest): Promise + /** + * 转交人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/transfer + */ + transferApaasApprovalTask(approval_task_id: string, body: TransferApaasApprovalTaskRequest): Promise + /** + * 人工任务加签 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/add_assignee + */ + addAssigneeApaasApprovalTask(approval_task_id: string, body: AddAssigneeApaasApprovalTaskRequest): Promise + /** + * 抄送人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/cc + */ + ccApaasUserTask(task_id: string, body: CcApaasUserTaskRequest): Promise + /** + * 催办人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/expediting + */ + expeditingApaasUserTask(task_id: string, body: ExpeditingApaasUserTaskRequest): Promise + /** + * 撤销人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_instance/cancel + */ + cancelApaasApprovalInstance(approval_instance_id: string, body: CancelApaasApprovalInstanceRequest): Promise + /** + * 查询人工任务可退回的位置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback_points + */ + rollbackPointsApaasUserTask(task_id: string, body: RollbackPointsApaasUserTaskRequest): Promise + /** + * 退回人工任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback + */ + rollbackApaasUserTask(task_id: string, body: RollbackApaasUserTaskRequest): Promise + /** + * 基于人工任务发起群聊 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/chat_group + */ + chatGroupApaasUserTask(task_id: string, body: ChatGroupApaasUserTaskRequest): Promise + } +} + +export interface AuditLogListApaasApplicationAuditLogQuery { + /** 分页大小 */ + page_size: string + /** 翻页数量 */ + offset: string + /** 模糊查询 */ + quick_query?: string + /** 查询时间范围：开始时间 */ + from: string + /** 查询时间范围：结束时间 */ + to: string + /** 日志类型：10001-企业管理日志，10003-应用管理日志，10002-登录日志 */ + log_type: string + /** 日志查询：筛选能力 */ + filter?: string + /** 日志列表：选择展示行信息，例如["opTime","appName","eventName","clientIP","operator","status"] */ + columns?: string[] + /** 查询排序字段：可选项为操作时间（opTime） */ + sort_by?: string + /** 查询排序：按时间从小到大使用 asc */ + sort_order?: string + /** 应用类型，0为apaas类型，1为aily类型 */ + app_type?: string +} + +export interface GetApaasApplicationAuditLogQuery { + /** 审计日志ID信息 */ + log_id: string +} + +export interface BatchRemoveAuthorizationApaasApplicationRoleMemberRequest { + /** 需要删除的用户 ID 列表 */ + user_ids?: string[] + /** 需要删除的部门 ID 列表 */ + department_ids?: string[] +} + +export interface BatchCreateAuthorizationApaasApplicationRoleMemberRequest { + /** 需要新增的用户 ID 列表 */ + user_ids?: string[] + /** 需要新增的部门 ID 列表 */ + department_ids?: string[] +} + +export interface GetApaasApplicationRoleMemberQuery { + /** 是否需要公式的展示名称，便于前端展示 */ + need_display_name?: boolean + /** 是否使用 APIID字段作为出入参，默认值为 false */ + use_api_id?: boolean +} + +export interface BatchRemoveAuthorizationApaasApplicationRecordPermissionMemberRequest { + /** 需要删除的用户 ID 列表 */ + user_ids?: string[] +} + +export interface BatchCreateAuthorizationApaasApplicationRecordPermissionMemberRequest { + /** 需要新增的用户 ID 列表 */ + user_ids?: string[] +} + +export interface OqlQueryApaasApplicationObjectRequest { + /** 待执行的 OQL 语句（关于支持的关键词及操作符，详见查看） */ + query: string + /** 用于指定 OQL 语句中匿名参数的具体值 */ + args?: string + /** 用于指定 OQL 语句中具名参数的具体值 */ + named_args?: string +} + +export interface SearchApaasApplicationObjectRequest { + /** 搜索词 */ + q?: string + /** 搜索对象范围 */ + search_objects?: SearchObjectParam[] + /** 分页参数，第一次搜索时为空，需要分页查询时使用 SearchRecordsResponse 中的结果 */ + page_token?: string + /** 返回数量，默认为50，最大不超过2000 */ + page_size?: string + /** 返回元数据枚举值 */ + metadata?: 'Label' | 'SearchLayout' +} + +export interface QueryApaasApplicationObjectRecordRequest { + /** 需要获取的字段，使用字段唯一标识符进行查询，关联字段可使用 . 进行下钻 */ + select?: string[] +} + +export interface PatchApaasApplicationObjectRecordRequest { + /** 创建对象使用的数据，键为字段 API 名称，值为字段值，格式可参考字段值格式 */ + record: string +} + +export interface CreateApaasApplicationObjectRecordRequest { + /** 创建对象使用的数据，键为字段 API 名称，值为字段值，格式可参考字段值格式 */ + record: string +} + +export interface BatchUpdateApaasApplicationObjectRecordRequest { + /** 记录详情列表，格式为 List>，操作记录数上限为 500 条 */ + records: string +} + +export interface BatchQueryApaasApplicationObjectRecordRequest { + /** 需要获取的字段，使用字段唯一标识符进行查询，关联字段可使用「.」进行下钻 */ + select: string[] + /** 筛选条件，通过 JSON 格式指定条件 */ + filter?: Criterion + /** 排序参数，通过 JSON 格式指定条件。其中， field 为参与排序字段，direction 为排序方向，多个条件按其在数组中的顺序生效。 */ + order_by?: Sort[] + /** 聚合参数，通过 JSON 格式指定条件。其中， field 为参与聚合的字段。 */ + group_by?: RecordGroupByItem[] + /** 分页的 Token 值，由服务端生成，可从 Response 中的 next_page_token 参数中获取。注意：第一页需填写空字符串 ""，且不能与 OFFSET 一起使用。 */ + page_token?: string + /** 是否使用 page_token 功能。为 True 时将使用 page_token 的值作为起始位置查询记录，并且会在 Response 中返回 next_page_token 。默认为 False 。 */ + use_page_token?: boolean + /** 期望服务端返回的记录条数，上限 500 条。不填则取默认值，默认值为 500。 */ + page_size?: number + /** 返回记录的偏移量，默认为 0 ，即从查询到的第一条记录开始返回。offset 较大时查询性能较差，可能引起接口响应超时，拉取全部记录时建议使用 ID 游标分页，具体见 ID 游标分页说明 */ + offset?: number + /** 是否返回符合条件的记录总数（Total）。默认为 False，不返回记录总数。 */ + need_total_count?: boolean +} + +export interface BatchDeleteApaasApplicationObjectRecordRequest { + /** 记录 ID 列表，操作记录数上限为 500 */ + ids: string[] +} + +export interface BatchCreateApaasApplicationObjectRecordRequest { + /** 记录详情列表，格式为 List>，操作记录数上限为 500 条 */ + records: string +} + +export interface InvokeApaasApplicationFunctionRequest { + /** 函数输入参数（JSON 序列化后的字符串） */ + params?: string +} + +export interface QueryApaasApplicationEnvironmentVariableRequest { + /** 过滤条件 */ + filter?: EnvironmentVariableFilter + /** 限制的条数，默认为 500，不可超过 500 */ + limit?: number + /** 返回记录的偏移量，默认为 0，即从查询到的第一个记录开始返回 */ + offset?: number +} + +export interface ExecuteApaasApplicationFlowRequest { + /** 是否异步执行 */ + is_async?: boolean + /** 幂等信息 */ + idempotent_key?: string + /** 循环信息 */ + loop_masks?: string[] + /** 流程入参 */ + params?: string + /** 操作人 */ + operator: string +} + +export interface QueryApaasUserTaskRequest { + /** 类型 */ + type?: string + /** 来源 */ + source?: string + /** 获取条数 */ + limit?: string + /** 起始位置 */ + offset?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 流程apiid列表 */ + api_ids?: string[] + /** kunlunUserID */ + kunlun_user_id: string +} + +export interface AgreeApaasApprovalTaskRequest { + /** 操作人id */ + user_id: string + /** 审批意见 */ + opinion?: string +} + +export interface RejectApaasApprovalTaskRequest { + /** 操作用户id */ + user_id: string + /** 审批意见 */ + opinion?: string +} + +export interface TransferApaasApprovalTaskRequest { + /** 操作人id */ + user_id: string + /** 原审批人id */ + from_user_ids?: string[] + /** 新审批人id */ + to_user_ids?: string[] + /** 审批意见 */ + opinion?: string +} + +export interface AddAssigneeApaasApprovalTaskRequest { + /** 操作人id */ + user_id: string + /** 审批人列表 */ + approvers?: string[] + /** 加签类型 */ + add_assignee_type?: string + /** 加签原因 */ + opinion?: string +} + +export interface CcApaasUserTaskRequest { + /** 抄送人的kunlunID列表 */ + cc_user_ids: string[] + /** 操作人kunlunUserID */ + operator_user_id: string +} + +export interface ExpeditingApaasUserTaskRequest { + /** 操作人kunlunUserID */ + operator_user_id: string + /** 催办人的kunlunID列表 */ + expediting_user_ids: string[] + /** 催办理由 */ + opinion?: string +} + +export interface CancelApaasApprovalInstanceRequest { + /** 操作用户id */ + user_id: string + /** 撤销原因 */ + opinion: string +} + +export interface RollbackPointsApaasUserTaskRequest { + /** 操作人kunlunUserID */ + operator_user_id: string +} + +export interface RollbackApaasUserTaskRequest { + /** 操作人kunlunUserID */ + operator_user_id: string + /** 退回到的任务ID */ + to_task_id: string + /** 退回原因 */ + opinion: string +} + +export interface ChatGroupApaasUserTaskRequest { + /** 操作人kunlunUserID */ + operator_user_id: string + /** 要邀请进群用户ID列表 */ + invite_user_ids?: string[] + /** 要拉入的群ID，为空则新建群 */ + chat_id?: string + /** 要加入的群名称，当chat_id为空时用该名称创建群聊 */ + 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 +} + +Internal.define({ + '/open-apis/apaas/v1/applications/{namespace}/audit_log/audit_log_list': { + GET: 'auditLogListApaasApplicationAuditLog', + }, + '/open-apis/apaas/v1/applications/{namespace}/audit_log': { + GET: 'getApaasApplicationAuditLog', + }, + '/open-apis/apaas/v1/applications/{namespace}/roles/{role_api_name}/member/batch_remove_authorization': { + POST: 'batchRemoveAuthorizationApaasApplicationRoleMember', + }, + '/open-apis/apaas/v1/applications/{namespace}/roles/{role_api_name}/member/batch_create_authorization': { + POST: 'batchCreateAuthorizationApaasApplicationRoleMember', + }, + '/open-apis/apaas/v1/applications/{namespace}/roles/{role_api_name}/member': { + GET: 'getApaasApplicationRoleMember', + }, + '/open-apis/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_remove_authorization': { + POST: 'batchRemoveAuthorizationApaasApplicationRecordPermissionMember', + }, + '/open-apis/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_create_authorization': { + POST: 'batchCreateAuthorizationApaasApplicationRecordPermissionMember', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/oql_query': { + POST: 'oqlQueryApaasApplicationObject', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/search': { + POST: 'searchApaasApplicationObject', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/{id}/query': { + POST: 'queryApaasApplicationObjectRecord', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/{id}': { + PATCH: 'patchApaasApplicationObjectRecord', + DELETE: 'deleteApaasApplicationObjectRecord', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/{object_api_name}/records': { + POST: 'createApaasApplicationObjectRecord', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_update': { + PATCH: 'batchUpdateApaasApplicationObjectRecord', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_query': { + POST: 'batchQueryApaasApplicationObjectRecord', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_delete': { + DELETE: 'batchDeleteApaasApplicationObjectRecord', + }, + '/open-apis/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_create': { + POST: 'batchCreateApaasApplicationObjectRecord', + }, + '/open-apis/apaas/v1/applications/{namespace}/functions/{function_api_name}/invoke': { + POST: 'invokeApaasApplicationFunction', + }, + '/open-apis/apaas/v1/applications/{namespace}/environment_variables/query': { + POST: 'queryApaasApplicationEnvironmentVariable', + }, + '/open-apis/apaas/v1/applications/{namespace}/environment_variables/{environment_variable_api_name}': { + GET: 'getApaasApplicationEnvironmentVariable', + }, + '/open-apis/apaas/v1/applications/{namespace}/flows/{flow_id}/execute': { + POST: 'executeApaasApplicationFlow', + }, + '/open-apis/apaas/v1/user_task/query': { + POST: 'queryApaasUserTask', + }, + '/open-apis/apaas/v1/approval_tasks/{approval_task_id}/agree': { + POST: 'agreeApaasApprovalTask', + }, + '/open-apis/apaas/v1/approval_tasks/{approval_task_id}/reject': { + POST: 'rejectApaasApprovalTask', + }, + '/open-apis/apaas/v1/approval_tasks/{approval_task_id}/transfer': { + POST: 'transferApaasApprovalTask', + }, + '/open-apis/apaas/v1/approval_tasks/{approval_task_id}/add_assignee': { + POST: 'addAssigneeApaasApprovalTask', + }, + '/open-apis/apaas/v1/user_tasks/{task_id}/cc': { + POST: 'ccApaasUserTask', + }, + '/open-apis/apaas/v1/user_tasks/{task_id}/expediting': { + POST: 'expeditingApaasUserTask', + }, + '/open-apis/apaas/v1/approval_instances/{approval_instance_id}/cancel': { + POST: 'cancelApaasApprovalInstance', + }, + '/open-apis/apaas/v1/user_tasks/{task_id}/rollback_points': { + POST: 'rollbackPointsApaasUserTask', + }, + '/open-apis/apaas/v1/user_tasks/{task_id}/rollback': { + POST: 'rollbackApaasUserTask', + }, + '/open-apis/apaas/v1/user_tasks/{task_id}/chat_group': { + POST: 'chatGroupApaasUserTask', + }, +}) diff --git a/adapters/lark/src/types/api.ts b/adapters/lark/src/types/api.ts deleted file mode 100644 index 66dfe9b5..00000000 --- a/adapters/lark/src/types/api.ts +++ /dev/null @@ -1,30455 +0,0 @@ -import { BaseResponse, Internal } from './internal' -import { Lark } from '.' - -export type Pagination = T & { page_size?: number; page_token?: string } - -export type Paginated = { - [K in ItemsKey]: T[]; -} & { - has_more: boolean - page_token: string -} - -declare module './internal' { - interface Internal { - /** - * 获取事件出口 IP - * @see https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list - */ - listEventOutboundIp(query?: ListEventOutboundIpQuery): Promise - /** - * 自建应用获取 tenant_access_token - * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal - */ - tenantAccessTokenInternalAuth(params: TenantAccessTokenInternalAuthRequest): Promise - /** - * 自建应用获取 app_access_token - * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token_internal - */ - appAccessTokenInternalAuth(params: AppAccessTokenInternalAuthRequest): Promise - /** - * 商店应用获取 app_access_token - * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token - */ - appAccessTokenAuth(params: AppAccessTokenAuthRequest): Promise - /** - * 商店应用获取 tenant_access_token - * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token - */ - tenantAccessTokenAuth(params: TenantAccessTokenAuthRequest): Promise - /** - * 获取 user_access_token - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create - */ - createAuthenOidcAccessToken(params: CreateAuthenOidcAccessTokenRequest): Promise - /** - * 刷新 user_access_token - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-refresh_access_token/create - */ - createAuthenOidcRefreshAccessToken(params: CreateAuthenOidcRefreshAccessTokenRequest): Promise - /** - * 重新获取 app_ticket - * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_ticket_resend - */ - appTicketResendAuth(params: AppTicketResendAuthRequest): Promise - /** - * 获取登录用户信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/user_info/get - */ - getAuthenUserInfo(): Promise - /** - * 批量获取脱敏的用户登录信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/query - */ - queryPassportSession(params: QueryPassportSessionRequest, query?: QueryPassportSessionQuery): Promise - /** - * 获取通讯录授权范围 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/scope/list - */ - listContactScope(query?: ListContactScopeQuery): Promise - /** - * 创建用户 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create - */ - createContactUser(params: CreateContactUserRequest, query?: CreateContactUserQuery): Promise - /** - * 删除用户 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete - */ - deleteContactUser(user_id: string, params: DeleteContactUserRequest, query?: DeleteContactUserQuery): Promise - /** - * 恢复已删除用户 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/resurrect - */ - resurrectContactUser(user_id: string, params: ResurrectContactUserRequest, query?: ResurrectContactUserQuery): Promise - /** - * 修改用户部分信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch - */ - patchContactUser(user_id: string, params: PatchContactUserRequest, query?: PatchContactUserQuery): Promise - /** - * 获取单个用户信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get - */ - getContactUser(user_id: string, query?: GetContactUserQuery): Promise - /** - * 批量获取用户信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch - */ - batchContactUser(query?: BatchContactUserQuery): Promise - /** - * 获取部门直属用户列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department - */ - findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery): Promise - /** - * 通过手机号或邮箱获取用户 ID - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id - */ - batchGetIdContactUser(params: BatchGetIdContactUserRequest, query?: BatchGetIdContactUserQuery): Promise - /** - * 更新用户ID - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update_user_id - */ - updateUserIdContactUser(user_id: string, params: UpdateUserIdContactUserRequest, query?: UpdateUserIdContactUserQuery): Promise - /** - * 创建用户组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/create - */ - createContactGroup(params: CreateContactGroupRequest, query?: CreateContactGroupQuery): Promise - /** - * 删除用户组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete - */ - deleteContactGroup(group_id: string): Promise - /** - * 更新用户组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/patch - */ - patchContactGroup(group_id: string, params: PatchContactGroupRequest, query?: PatchContactGroupQuery): Promise - /** - * 查询指定用户组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/get - */ - getContactGroup(group_id: string, query?: GetContactGroupQuery): Promise - /** - * 查询用户组列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist - */ - simplelistContactGroup(query?: SimplelistContactGroupQuery): Promise - /** - * 查询用户所属用户组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong - */ - memberBelongContactGroup(query?: MemberBelongContactGroupQuery): Promise - /** - * 获取企业自定义用户字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list - */ - listContactCustomAttr(query?: ListContactCustomAttrQuery): Promise - /** - * 新增人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create - */ - createContactEmployeeTypeEnum(params: CreateContactEmployeeTypeEnumRequest): Promise - /** - * 删除人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete - */ - deleteContactEmployeeTypeEnum(enum_id: string): Promise - /** - * 更新人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/update - */ - updateContactEmployeeTypeEnum(enum_id: string, params: UpdateContactEmployeeTypeEnumRequest): Promise - /** - * 查询人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list - */ - listContactEmployeeTypeEnum(query?: ListContactEmployeeTypeEnumQuery): Promise - /** - * 创建部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create - */ - createContactDepartment(params: CreateContactDepartmentRequest, query?: CreateContactDepartmentQuery): Promise - /** - * 删除部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete - */ - deleteContactDepartment(department_id: string, query?: DeleteContactDepartmentQuery): Promise - /** - * 修改部门部分信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch - */ - patchContactDepartment(department_id: string, params: PatchContactDepartmentRequest, query?: PatchContactDepartmentQuery): Promise - /** - * 更新部门所有信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update - */ - updateContactDepartment(department_id: string, params: UpdateContactDepartmentRequest, query?: UpdateContactDepartmentQuery): Promise - /** - * 部门群转为普通群 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat - */ - unbindDepartmentChatContactDepartment(params: UnbindDepartmentChatContactDepartmentRequest, query?: UnbindDepartmentChatContactDepartmentQuery): Promise - /** - * 获取单个部门信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get - */ - getContactDepartment(department_id: string, query?: GetContactDepartmentQuery): Promise - /** - * 批量获取部门信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/batch - */ - batchContactDepartment(query?: BatchContactDepartmentQuery): Promise - /** - * 获取子部门列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children - */ - childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery): Promise - /** - * 获取父部门信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent - */ - parentContactDepartment(query?: ParentContactDepartmentQuery): Promise - /** - * 搜索部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search - */ - searchContactDepartment(params: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): Promise - /** - * 更新部门ID - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update_department_id - */ - updateDepartmentIdContactDepartment(department_id: string, params: UpdateDepartmentIdContactDepartmentRequest, query?: UpdateDepartmentIdContactDepartmentQuery): Promise - /** - * 创建单位 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/create - */ - createContactUnit(params: CreateContactUnitRequest): Promise - /** - * 删除单位 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete - */ - deleteContactUnit(unit_id: string): Promise - /** - * 修改单位信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/patch - */ - patchContactUnit(unit_id: string, params: PatchContactUnitRequest): Promise - /** - * 建立部门与单位的绑定关系 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/bind_department - */ - bindDepartmentContactUnit(params: BindDepartmentContactUnitRequest): Promise - /** - * 解除部门与单位的绑定关系 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/unbind_department - */ - unbindDepartmentContactUnit(params: UnbindDepartmentContactUnitRequest): Promise - /** - * 获取单位绑定的部门列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department - */ - listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery): Promise - /** - * 获取单位信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get - */ - getContactUnit(unit_id: string): Promise - /** - * 获取单位列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list - */ - listContactUnit(query?: ListContactUnitQuery): Promise - /** - * 添加用户组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/add - */ - addContactGroupMember(group_id: string, params: AddContactGroupMemberRequest): Promise - /** - * 批量添加用户组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_add - */ - batchAddContactGroupMember(group_id: string, params: BatchAddContactGroupMemberRequest): Promise - /** - * 移除用户组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove - */ - removeContactGroupMember(group_id: string, params: RemoveContactGroupMemberRequest): Promise - /** - * 批量移除用户组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_remove - */ - batchRemoveContactGroupMember(group_id: string, params: BatchRemoveContactGroupMemberRequest): Promise - /** - * 查询用户组成员列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist - */ - simplelistContactGroupMember(group_id: string, query?: SimplelistContactGroupMemberQuery): Promise - /** - * 创建角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/create - */ - createContactFunctionalRole(params: CreateContactFunctionalRoleRequest): Promise - /** - * 删除角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/delete - */ - deleteContactFunctionalRole(role_id: string): Promise - /** - * 修改角色名称 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/update - */ - updateContactFunctionalRole(role_id: string, params: UpdateContactFunctionalRoleRequest): Promise - /** - * 批量添加角色成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_create - */ - batchCreateContactFunctionalRoleMember(role_id: string, params: BatchCreateContactFunctionalRoleMemberRequest, query?: BatchCreateContactFunctionalRoleMemberQuery): Promise - /** - * 删除角色下的成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete - */ - batchDeleteContactFunctionalRoleMember(role_id: string, params: BatchDeleteContactFunctionalRoleMemberRequest, query?: BatchDeleteContactFunctionalRoleMemberQuery): Promise - /** - * 批量设置角色成员管理范围 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/scopes - */ - scopesContactFunctionalRoleMember(role_id: string, params: ScopesContactFunctionalRoleMemberRequest, query?: ScopesContactFunctionalRoleMemberQuery): Promise - /** - * 查询角色下某个成员的管理范围 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/get - */ - getContactFunctionalRoleMember(role_id: string, member_id: string, query?: GetContactFunctionalRoleMemberQuery): Promise - /** - * 查询角色下的所有成员信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list - */ - listContactFunctionalRoleMember(role_id: string, query?: ListContactFunctionalRoleMemberQuery): Promise - /** - * 创建职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/create - */ - createContactJobLevel(params: CreateContactJobLevelRequest): Promise - /** - * 删除职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete - */ - deleteContactJobLevel(job_level_id: string): Promise - /** - * 更新职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/update - */ - updateContactJobLevel(job_level_id: string, params: UpdateContactJobLevelRequest): Promise - /** - * 获取单个职级信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/get - */ - getContactJobLevel(job_level_id: string): Promise - /** - * 获取租户职级列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list - */ - listContactJobLevel(query?: ListContactJobLevelQuery): Promise - /** - * 创建序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/create - */ - createContactJobFamily(params: CreateContactJobFamilyRequest): Promise - /** - * 删除序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete - */ - deleteContactJobFamily(job_family_id: string): Promise - /** - * 更新序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/update - */ - updateContactJobFamily(job_family_id: string, params: UpdateContactJobFamilyRequest): Promise - /** - * 获取单个序列信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/get - */ - getContactJobFamily(job_family_id: string): Promise - /** - * 获取租户序列列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list - */ - listContactJobFamily(query?: ListContactJobFamilyQuery): Promise - /** - * 获取单个职务信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/get - */ - getContactJobTitle(job_title_id: string): Promise - /** - * 获取租户职务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list - */ - listContactJobTitle(query?: ListContactJobTitleQuery): Promise - /** - * 获取单个工作城市信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get - */ - getContactWorkCity(work_city_id: string): Promise - /** - * 获取租户工作城市列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list - */ - listContactWorkCity(query?: ListContactWorkCityQuery): Promise - /** - * 发送消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create - */ - createImMessage(params: CreateImMessageRequest, query?: CreateImMessageQuery): Promise - /** - * 回复消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/reply - */ - replyImMessage(message_id: string, params: ReplyImMessageRequest): Promise - /** - * 编辑消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/update - */ - updateImMessage(message_id: string, params: UpdateImMessageRequest): Promise - /** - * 撤回消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete - */ - deleteImMessage(message_id: string): Promise - /** - * 转发消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/forward - */ - forwardImMessage(message_id: string, params: ForwardImMessageRequest, query?: ForwardImMessageQuery): Promise - /** - * 合并转发消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/merge_forward - */ - mergeForwardImMessage(params: MergeForwardImMessageRequest, query?: MergeForwardImMessageQuery): Promise - /** - * 转发话题 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/thread/forward - */ - forwardImThread(thread_id: string, params: ForwardImThreadRequest, query?: ForwardImThreadQuery): Promise - /** - * 查询消息已读信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users - */ - readUsersImMessage(message_id: string, query?: ReadUsersImMessageQuery): Promise - /** - * 获取会话历史消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list - */ - listImMessage(query?: ListImMessageQuery): Promise - /** - * 获取消息中的资源文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get - */ - getImMessageResource(message_id: string, file_key: string, query?: GetImMessageResourceQuery): Promise - /** - * 获取指定消息的内容 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/get - */ - getImMessage(message_id: string, query?: GetImMessageQuery): Promise - /** - * 发送应用内加急 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_app - */ - urgentAppImMessage(message_id: string, params: UrgentAppImMessageRequest, query?: UrgentAppImMessageQuery): Promise - /** - * 发送短信加急 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_sms - */ - urgentSmsImMessage(message_id: string, params: UrgentSmsImMessageRequest, query?: UrgentSmsImMessageQuery): Promise - /** - * 发送电话加急 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_phone - */ - urgentPhoneImMessage(message_id: string, params: UrgentPhoneImMessageRequest, query?: UrgentPhoneImMessageQuery): Promise - /** - * 批量撤回消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete - */ - deleteImBatchMessage(batch_message_id: string): Promise - /** - * 查询批量消息推送和阅读人数 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user - */ - readUserImBatchMessage(batch_message_id: string): Promise - /** - * 查询批量消息整体进度 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/get_progress - */ - getProgressImBatchMessage(batch_message_id: string): Promise - /** - * 上传图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create - */ - createImImage(form: CreateImImageForm): Promise - /** - * 下载图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get - */ - getImImage(image_key: string): Promise - /** - * 上传文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/create - */ - createImFile(form: CreateImFileForm): Promise - /** - * 下载文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/get - */ - getImFile(file_key: string): Promise - /** - * 更新应用发送的消息卡片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/patch - */ - patchImMessage(message_id: string, params: PatchImMessageRequest): Promise - /** - * 添加消息表情回复 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create - */ - createImMessageReaction(message_id: string, params: CreateImMessageReactionRequest): Promise - /** - * 删除消息表情回复 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete - */ - deleteImMessageReaction(message_id: string, reaction_id: string): Promise - /** - * 获取消息表情回复 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list - */ - listImMessageReaction(message_id: string, query?: ListImMessageReactionQuery): Promise - /** - * Pin 消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/create - */ - createImPin(params: CreateImPinRequest): Promise - /** - * 移除 Pin 消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/delete - */ - deleteImPin(message_id: string): Promise - /** - * 获取群内 Pin 消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list - */ - listImPin(query?: ListImPinQuery): Promise - /** - * 创建群 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create - */ - createImChat(params: CreateImChatRequest, query?: CreateImChatQuery): Promise - /** - * 解散群 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete - */ - deleteImChat(chat_id: string): Promise - /** - * 更新群信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update - */ - updateImChat(chat_id: string, params: UpdateImChatRequest, query?: UpdateImChatQuery): Promise - /** - * 更新群发言权限 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/update - */ - updateImChatModeration(chat_id: string, params: UpdateImChatModerationRequest, query?: UpdateImChatModerationQuery): Promise - /** - * 获取群信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get - */ - getImChat(chat_id: string, query?: GetImChatQuery): Promise - /** - * 更新群置顶 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/put_top_notice - */ - putTopNoticeImChatTopNotice(chat_id: string, params: PutTopNoticeImChatTopNoticeRequest): Promise - /** - * 撤销群置顶 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/delete_top_notice - */ - deleteTopNoticeImChatTopNotice(chat_id: string): Promise - /** - * 获取用户或机器人所在的群列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list - */ - listImChat(query?: ListImChatQuery): Promise - /** - * 搜索对用户或机器人可见的群列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search - */ - searchImChat(query?: SearchImChatQuery): Promise - /** - * 获取群成员发言权限 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get - */ - getImChatModeration(chat_id: string, query?: GetImChatModerationQuery): Promise - /** - * 获取群分享链接 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link - */ - linkImChat(chat_id: string, params: LinkImChatRequest): Promise - /** - * 指定群管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/add_managers - */ - addManagersImChatManagers(chat_id: string, params: AddManagersImChatManagersRequest, query?: AddManagersImChatManagersQuery): Promise - /** - * 删除群管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/delete_managers - */ - deleteManagersImChatManagers(chat_id: string, params: DeleteManagersImChatManagersRequest, query?: DeleteManagersImChatManagersQuery): Promise - /** - * 将用户或机器人拉入群聊 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create - */ - createImChatMembers(chat_id: string, params: CreateImChatMembersRequest, query?: CreateImChatMembersQuery): Promise - /** - * 用户或机器人主动加入群聊 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join - */ - meJoinImChatMembers(chat_id: string): Promise - /** - * 将用户或机器人移出群聊 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete - */ - deleteImChatMembers(chat_id: string, params: DeleteImChatMembersRequest, query?: DeleteImChatMembersQuery): Promise - /** - * 获取群成员列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get - */ - getImChatMembers(chat_id: string, query?: GetImChatMembersQuery): Promise - /** - * 判断用户或机器人是否在群里 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat - */ - isInChatImChatMembers(chat_id: string): Promise - /** - * 更新群公告信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/patch - */ - patchImChatAnnouncement(chat_id: string, params: PatchImChatAnnouncementRequest): Promise - /** - * 获取群公告信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get - */ - getImChatAnnouncement(chat_id: string, query?: GetImChatAnnouncementQuery): Promise - /** - * 添加会话标签页 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create - */ - createImChatTab(chat_id: string, params: CreateImChatTabRequest): Promise - /** - * 删除会话标签页 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/delete_tabs - */ - deleteTabsImChatTab(chat_id: string, params: DeleteTabsImChatTabRequest): Promise - /** - * 更新会话标签页 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/update_tabs - */ - updateTabsImChatTab(chat_id: string, params: UpdateTabsImChatTabRequest): Promise - /** - * 会话标签页排序 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/sort_tabs - */ - sortTabsImChatTab(chat_id: string, params: SortTabsImChatTabRequest): Promise - /** - * 拉取会话标签页 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs - */ - listTabsImChatTab(chat_id: string): Promise - /** - * 添加群菜单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/create - */ - createImChatMenuTree(chat_id: string, params: CreateImChatMenuTreeRequest): Promise - /** - * 删除群菜单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/delete - */ - deleteImChatMenuTree(chat_id: string, params: DeleteImChatMenuTreeRequest): Promise - /** - * 修改群菜单元信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_item/patch - */ - patchImChatMenuItem(chat_id: string, menu_item_id: string, params: PatchImChatMenuItemRequest): Promise - /** - * 排序群菜单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/sort - */ - sortImChatMenuTree(chat_id: string, params: SortImChatMenuTreeRequest): Promise - /** - * 获取群菜单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get - */ - getImChatMenuTree(chat_id: string): Promise - /** - * 获取文件夹下的清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list - */ - listDrivev1File(query?: ListDrivev1FileQuery): Promise - /** - * 新建文件夹 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder - */ - createFolderDrivev1File(params: CreateFolderDrivev1FileRequest): Promise - /** - * 获取文档元数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/meta/batch_query - */ - batchQueryDrivev1Meta(params: BatchQueryDrivev1MetaRequest, query?: BatchQueryDrivev1MetaQuery): Promise - /** - * 获取文档统计信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-statistics/get - */ - getDrivev1FileStatistics(file_token: string, query?: GetDrivev1FileStatisticsQuery): Promise - /** - * 复制文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy - */ - copyDrivev1File(file_token: string, params: CopyDrivev1FileRequest, query?: CopyDrivev1FileQuery): Promise - /** - * 移动文件/文件夹 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/move - */ - moveDrivev1File(file_token: string, params: MoveDrivev1FileRequest): Promise - /** - * 删除文件/文件夹 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete - */ - deleteDrivev1File(file_token: string, query?: DeleteDrivev1FileQuery): Promise - /** - * 创建文件快捷方式 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_shortcut - */ - createShortcutDrivev1File(params: CreateShortcutDrivev1FileRequest, query?: CreateShortcutDrivev1FileQuery): Promise - /** - * 查询异步任务状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check - */ - taskCheckDrivev1File(query?: TaskCheckDrivev1FileQuery): Promise - /** - * 上传素材 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_all - */ - uploadAllDrivev1Media(form: UploadAllDrivev1MediaForm): Promise - /** - * 下载素材 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/download - */ - downloadDrivev1Media(file_token: string, query?: DownloadDrivev1MediaQuery): Promise - /** - * 获取素材临时下载链接 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/batch_get_tmp_download_url - */ - batchGetTmpDownloadUrlDrivev1Media(query?: BatchGetTmpDownloadUrlDrivev1MediaQuery): Promise - /** - * 分片上传素材（预上传） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_prepare - */ - uploadPrepareDrivev1Media(params: UploadPrepareDrivev1MediaRequest): Promise - /** - * 分片上传素材（上传分片） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_part - */ - uploadPartDrivev1Media(form: UploadPartDrivev1MediaForm): Promise - /** - * 分片上传素材（完成上传） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_finish - */ - uploadFinishDrivev1Media(params: UploadFinishDrivev1MediaRequest): Promise - /** - * 订阅云文档事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe - */ - subscribeDrivev1File(file_token: string, query?: SubscribeDrivev1FileQuery): Promise - /** - * 取消云文档事件订阅 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete_subscribe - */ - deleteSubscribeDrivev1File(file_token: string, query?: DeleteSubscribeDrivev1FileQuery): Promise - /** - * 查询云文档事件订阅状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/get_subscribe - */ - getSubscribeDrivev1File(file_token: string, query?: GetSubscribeDrivev1FileQuery): Promise - /** - * 上传文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_all - */ - uploadAllDrivev1File(form: UploadAllDrivev1FileForm): Promise - /** - * 分片上传文件（预上传） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare - */ - uploadPrepareDrivev1File(params: UploadPrepareDrivev1FileRequest): Promise - /** - * 分片上传文件（上传分片） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part - */ - uploadPartDrivev1File(form: UploadPartDrivev1FileForm): Promise - /** - * 分片上传文件（完成上传） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_finish - */ - uploadFinishDrivev1File(params: UploadFinishDrivev1FileRequest): Promise - /** - * 下载文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/download - */ - downloadDrivev1File(file_token: string): Promise - /** - * 创建导入任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/create - */ - createDrivev1ImportTask(params: CreateDrivev1ImportTaskRequest): Promise - /** - * 查询导入任务结果 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/get - */ - getDrivev1ImportTask(ticket: string): Promise - /** - * 创建导出任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/create - */ - createDrivev1ExportTask(params: CreateDrivev1ExportTaskRequest): Promise - /** - * 查询导出任务结果 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/get - */ - getDrivev1ExportTask(ticket: string, query?: GetDrivev1ExportTaskQuery): Promise - /** - * 获取文档访问记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list - */ - listDrivev1FileViewRecord(file_token: string, query?: ListDrivev1FileViewRecordQuery): Promise - /** - * 创建文档版本 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/create - */ - createDrivev1FileVersion(file_token: string, params: CreateDrivev1FileVersionRequest, query?: CreateDrivev1FileVersionQuery): Promise - /** - * 删除文档版本 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/delete - */ - deleteDrivev1FileVersion(file_token: string, version_id: string, query?: DeleteDrivev1FileVersionQuery): Promise - /** - * 获取文档版本 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get - */ - getDrivev1FileVersion(file_token: string, version_id: string, query?: GetDrivev1FileVersionQuery): Promise - /** - * 获取文档版本列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list - */ - listDrivev1FileVersion(file_token: string, query?: ListDrivev1FileVersionQuery): Promise - /** - * 转移所有者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner - */ - transferOwnerDrivev1PermissionMember(token: string, params: TransferOwnerDrivev1PermissionMemberRequest, query?: TransferOwnerDrivev1PermissionMemberQuery): Promise - /** - * 判断当前用户是否有某权限 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth - */ - authDrivev1PermissionMember(token: string, query?: AuthDrivev1PermissionMemberQuery): Promise - /** - * 获取协作者列表（新版本） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list - */ - listDrivev1PermissionMember(token: string, query?: ListDrivev1PermissionMemberQuery): Promise - /** - * 增加协作者权限 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create - */ - createDrivev1PermissionMember(token: string, params: CreateDrivev1PermissionMemberRequest, query?: CreateDrivev1PermissionMemberQuery): Promise - /** - * 更新协作者权限 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update - */ - updateDrivev1PermissionMember(token: string, member_id: string, params: UpdateDrivev1PermissionMemberRequest, query?: UpdateDrivev1PermissionMemberQuery): Promise - /** - * 移除协作者权限 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete - */ - deleteDrivev1PermissionMember(token: string, member_id: string, query?: DeleteDrivev1PermissionMemberQuery): Promise - /** - * 开启密码 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create - */ - createDrivev1PermissionPublicPassword(token: string, query?: CreateDrivev1PermissionPublicPasswordQuery): Promise - /** - * 刷新密码 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update - */ - updateDrivev1PermissionPublicPassword(token: string, query?: UpdateDrivev1PermissionPublicPasswordQuery): Promise - /** - * 关闭密码 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete - */ - deleteDrivev1PermissionPublicPassword(token: string, query?: DeleteDrivev1PermissionPublicPasswordQuery): Promise - /** - * 获取云文档权限设置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/get - */ - getDrivev1PermissionPublic(token: string, query?: GetDrivev1PermissionPublicQuery): Promise - /** - * 更新云文档权限设置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/patch - */ - patchDrivev1PermissionPublic(token: string, params: PatchDrivev1PermissionPublicRequest, query?: PatchDrivev1PermissionPublicQuery): Promise - /** - * 获取云文档权限设置 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get - */ - getDrivev2PermissionPublic(token: string, query?: GetDrivev2PermissionPublicQuery): Promise - /** - * 更新云文档权限设置 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch - */ - patchDrivev2PermissionPublic(token: string, params: PatchDrivev2PermissionPublicRequest, query?: PatchDrivev2PermissionPublicQuery): Promise - /** - * 获取云文档所有评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list - */ - listDrivev1FileComment(file_token: string, query?: ListDrivev1FileCommentQuery): Promise - /** - * 批量获取评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/batch_query - */ - batchQueryDrivev1FileComment(file_token: string, params: BatchQueryDrivev1FileCommentRequest, query?: BatchQueryDrivev1FileCommentQuery): Promise - /** - * 解决/恢复评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/patch - */ - patchDrivev1FileComment(file_token: string, comment_id: string, params: PatchDrivev1FileCommentRequest, query?: PatchDrivev1FileCommentQuery): Promise - /** - * 添加全文评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/create - */ - createDrivev1FileComment(file_token: string, params: CreateDrivev1FileCommentRequest, query?: CreateDrivev1FileCommentQuery): Promise - /** - * 获取全文评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/get - */ - getDrivev1FileComment(file_token: string, comment_id: string, query?: GetDrivev1FileCommentQuery): Promise - /** - * 获取回复信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/list - */ - listDrivev1FileCommentReply(file_token: string, comment_id: string, query?: ListDrivev1FileCommentReplyQuery): Promise - /** - * 更新回复的内容 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/update - */ - updateDrivev1FileCommentReply(file_token: string, comment_id: string, reply_id: string, params: UpdateDrivev1FileCommentReplyRequest, query?: UpdateDrivev1FileCommentReplyQuery): Promise - /** - * 删除回复 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/delete - */ - deleteDrivev1FileCommentReply(file_token: string, comment_id: string, reply_id: string, query?: DeleteDrivev1FileCommentReplyQuery): Promise - /** - * 获取文档基本信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/get - */ - getDocxDocument(document_id: string): Promise - /** - * 获取文档纯文本内容 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/raw_content - */ - rawContentDocxDocument(document_id: string, query?: RawContentDocxDocumentQuery): Promise - /** - * 获取文档所有块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list - */ - listDocxDocumentBlock(document_id: string, query?: ListDocxDocumentBlockQuery): Promise - /** - * 创建文档 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/create - */ - createDocxDocument(params: CreateDocxDocumentRequest): Promise - /** - * 获取块的内容 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/get - */ - getDocxDocumentBlock(document_id: string, block_id: string, query?: GetDocxDocumentBlockQuery): Promise - /** - * 获取所有子块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/get - */ - getDocxDocumentBlockChildren(document_id: string, block_id: string, query?: GetDocxDocumentBlockChildrenQuery): Promise - /** - * 创建块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/create - */ - createDocxDocumentBlockChildren(document_id: string, block_id: string, params: CreateDocxDocumentBlockChildrenRequest, query?: CreateDocxDocumentBlockChildrenQuery): Promise - /** - * 更新块的内容 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/patch - */ - patchDocxDocumentBlock(document_id: string, block_id: string, params: PatchDocxDocumentBlockRequest, query?: PatchDocxDocumentBlockQuery): Promise - /** - * 批量更新块的内容 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/batch_update - */ - batchUpdateDocxDocumentBlock(document_id: string, params: BatchUpdateDocxDocumentBlockRequest, query?: BatchUpdateDocxDocumentBlockQuery): Promise - /** - * 删除块 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/batch_delete - */ - batchDeleteDocxDocumentBlockChildren(document_id: string, block_id: string, params: BatchDeleteDocxDocumentBlockChildrenRequest, query?: BatchDeleteDocxDocumentBlockChildrenQuery): Promise - /** - * 获取所有节点 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/list - */ - listBoardWhiteboardNode(whiteboard_id: string): Promise - /** - * 修改电子表格属性 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/patch - */ - patchSheetsSpreadsheet(spreadsheet_token: string, params: PatchSheetsSpreadsheetRequest): Promise - /** - * 获取电子表格信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/get - */ - getSheetsSpreadsheet(spreadsheet_token: string, query?: GetSheetsSpreadsheetQuery): Promise - /** - * 创建表格 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/create - */ - createSheetsSpreadsheet(params: CreateSheetsSpreadsheetRequest): Promise - /** - * 查询工作表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/get - */ - getSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string): Promise - /** - * 获取工作表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query - */ - querySheetsSpreadsheetSheet(spreadsheet_token: string): Promise - /** - * 移动行列 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/move_dimension - */ - moveDimensionSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, params: MoveDimensionSheetsSpreadsheetSheetRequest): Promise - /** - * 查找单元格 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/find - */ - findSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, params: FindSheetsSpreadsheetSheetRequest): Promise - /** - * 替换单元格 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/replace - */ - replaceSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, params: ReplaceSheetsSpreadsheetSheetRequest): Promise - /** - * 获取筛选 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/get - */ - getSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string): Promise - /** - * 创建筛选 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/create - */ - createSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string, params: CreateSheetsSpreadsheetSheetFilterRequest): Promise - /** - * 更新筛选 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/update - */ - updateSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string, params: UpdateSheetsSpreadsheetSheetFilterRequest): Promise - /** - * 删除筛选 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/delete - */ - deleteSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string): Promise - /** - * 获取筛选视图 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/get - */ - getSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise - /** - * 查询筛选视图 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/query - */ - querySheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string): Promise - /** - * 创建筛选视图 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/create - */ - createSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, params: CreateSheetsSpreadsheetSheetFilterViewRequest): Promise - /** - * 更新筛选视图 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/patch - */ - patchSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string, params: PatchSheetsSpreadsheetSheetFilterViewRequest): Promise - /** - * 删除筛选视图 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/delete - */ - deleteSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise - /** - * 获取筛选条件 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/get - */ - getSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise - /** - * 查询筛选条件 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/query - */ - querySheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise - /** - * 创建筛选条件 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/create - */ - createSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, params: CreateSheetsSpreadsheetSheetFilterViewConditionRequest): Promise - /** - * 更新筛选条件 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/update - */ - updateSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string, params: UpdateSheetsSpreadsheetSheetFilterViewConditionRequest): Promise - /** - * 删除筛选条件 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/delete - */ - deleteSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise - /** - * 获取浮动图片 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/get - */ - getSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise - /** - * 查询浮动图片 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/query - */ - querySheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string): Promise - /** - * 创建浮动图片 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/create - */ - createSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, params: CreateSheetsSpreadsheetSheetFloatImageRequest): Promise - /** - * 更新浮动图片 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/patch - */ - patchSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string, params: PatchSheetsSpreadsheetSheetFloatImageRequest): Promise - /** - * 删除浮动图片 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/delete - */ - deleteSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise - /** - * 复制多维表格 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy - */ - copyBitableApp(app_token: string, params: CopyBitableAppRequest): Promise - /** - * 创建多维表格 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create - */ - createBitableApp(params: CreateBitableAppRequest): Promise - /** - * 获取多维表格元数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get - */ - getBitableApp(app_token: string): Promise - /** - * 更新多维表格元数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update - */ - updateBitableApp(app_token: string, params: UpdateBitableAppRequest): Promise - /** - * 新增一个数据表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create - */ - createBitableAppTable(app_token: string, params: CreateBitableAppTableRequest): Promise - /** - * 新增多个数据表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create - */ - batchCreateBitableAppTable(app_token: string, params: BatchCreateBitableAppTableRequest, query?: BatchCreateBitableAppTableQuery): Promise - /** - * 删除一个数据表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete - */ - deleteBitableAppTable(app_token: string, table_id: string): Promise - /** - * 删除多个数据表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete - */ - batchDeleteBitableAppTable(app_token: string, params: BatchDeleteBitableAppTableRequest): Promise - /** - * 更新数据表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/patch - */ - patchBitableAppTable(app_token: string, table_id: string, params: PatchBitableAppTableRequest): Promise - /** - * 列出数据表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list - */ - listBitableAppTable(app_token: string, query?: ListBitableAppTableQuery): Promise - /** - * 复制仪表盘 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/copy - */ - copyBitableAppDashboard(app_token: string, block_id: string, params: CopyBitableAppDashboardRequest): Promise - /** - * 列出仪表盘 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list - */ - listBitableAppDashboard(app_token: string, query?: ListBitableAppDashboardQuery): Promise - /** - * 更新视图 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch - */ - patchBitableAppTableView(app_token: string, table_id: string, view_id: string, params: PatchBitableAppTableViewRequest): Promise - /** - * 检索视图 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get - */ - getBitableAppTableView(app_token: string, table_id: string, view_id: string): Promise - /** - * 列出视图 - * @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 - /** - * 新增视图 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create - */ - createBitableAppTableView(app_token: string, table_id: string, params: CreateBitableAppTableViewRequest): Promise - /** - * 删除视图 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete - */ - deleteBitableAppTableView(app_token: string, table_id: string, view_id: string): Promise - /** - * 更新表单元数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch - */ - patchBitableAppTableForm(app_token: string, table_id: string, form_id: string, params: PatchBitableAppTableFormRequest): Promise - /** - * 获取表单元数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/get - */ - getBitableAppTableForm(app_token: string, table_id: string, form_id: string): Promise - /** - * 更新表单问题 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/patch - */ - patchBitableAppTableFormField(app_token: string, table_id: string, form_id: string, field_id: string, params: PatchBitableAppTableFormFieldRequest): Promise - /** - * 列出表单问题 - * @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?: ListBitableAppTableFormFieldQuery): Promise - /** - * 检索记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/get - */ - getBitableAppTableRecord(app_token: string, table_id: string, record_id: string, query?: GetBitableAppTableRecordQuery): Promise - /** - * 查询记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search - */ - searchBitableAppTableRecord(app_token: string, table_id: string, params: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery): Promise - /** - * 新增记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create - */ - createBitableAppTableRecord(app_token: string, table_id: string, params: CreateBitableAppTableRecordRequest, query?: CreateBitableAppTableRecordQuery): Promise - /** - * 更新记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/update - */ - updateBitableAppTableRecord(app_token: string, table_id: string, record_id: string, params: UpdateBitableAppTableRecordRequest, query?: UpdateBitableAppTableRecordQuery): Promise - /** - * 删除记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete - */ - deleteBitableAppTableRecord(app_token: string, table_id: string, record_id: string): Promise - /** - * 新增多条记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_create - */ - batchCreateBitableAppTableRecord(app_token: string, table_id: string, params: BatchCreateBitableAppTableRecordRequest, query?: BatchCreateBitableAppTableRecordQuery): Promise - /** - * 更新多条记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_update - */ - batchUpdateBitableAppTableRecord(app_token: string, table_id: string, params: BatchUpdateBitableAppTableRecordRequest, query?: BatchUpdateBitableAppTableRecordQuery): Promise - /** - * 删除多条记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_delete - */ - batchDeleteBitableAppTableRecord(app_token: string, table_id: string, params: BatchDeleteBitableAppTableRecordRequest): Promise - /** - * 列出字段 - * @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 - /** - * 新增字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/create - */ - createBitableAppTableField(app_token: string, table_id: string, params: CreateBitableAppTableFieldRequest, query?: CreateBitableAppTableFieldQuery): Promise - /** - * 更新字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/update - */ - updateBitableAppTableField(app_token: string, table_id: string, field_id: string, params: UpdateBitableAppTableFieldRequest): Promise - /** - * 删除字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete - */ - deleteBitableAppTableField(app_token: string, table_id: string, field_id: string): Promise - /** - * 列出自定义角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list - */ - listBitableAppRole(app_token: string, query?: ListBitableAppRoleQuery): Promise - /** - * 新增自定义角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create - */ - createBitableAppRole(app_token: string, params: CreateBitableAppRoleRequest): Promise - /** - * 删除自定义角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete - */ - deleteBitableAppRole(app_token: string, role_id: string): Promise - /** - * 更新自定义角色 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/update - */ - updateBitableAppRole(app_token: string, role_id: string, params: UpdateBitableAppRoleRequest): Promise - /** - * 批量删除协作者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete - */ - batchDeleteBitableAppRoleMember(app_token: string, role_id: string, params: BatchDeleteBitableAppRoleMemberRequest): Promise - /** - * 批量新增协作者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_create - */ - batchCreateBitableAppRoleMember(app_token: string, role_id: string, params: BatchCreateBitableAppRoleMemberRequest): Promise - /** - * 列出协作者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list - */ - listBitableAppRoleMember(app_token: string, role_id: string, query?: ListBitableAppRoleMemberQuery): Promise - /** - * 新增协作者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create - */ - createBitableAppRoleMember(app_token: string, role_id: string, params: CreateBitableAppRoleMemberRequest, query?: CreateBitableAppRoleMemberQuery): Promise - /** - * 删除协作者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete - */ - deleteBitableAppRoleMember(app_token: string, role_id: string, member_id: string, query?: DeleteBitableAppRoleMemberQuery): Promise - /** - * 获取知识空间列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list - */ - listWikiSpace(query?: ListWikiSpaceQuery): Promise - /** - * 获取知识空间信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get - */ - getWikiSpace(space_id: string): Promise - /** - * 创建知识空间 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/create - */ - createWikiSpace(params: CreateWikiSpaceRequest): Promise - /** - * 添加知识空间成员 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create - */ - createWikiSpaceMember(space_id: string, params: CreateWikiSpaceMemberRequest, query?: CreateWikiSpaceMemberQuery): Promise - /** - * 删除知识空间成员 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/delete - */ - deleteWikiSpaceMember(space_id: string, member_id: string, params: DeleteWikiSpaceMemberRequest): Promise - /** - * 更新知识空间设置 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-setting/update - */ - updateWikiSpaceSetting(space_id: string, params: UpdateWikiSpaceSettingRequest): Promise - /** - * 创建知识空间节点 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/create - */ - createWikiSpaceNode(space_id: string, params: CreateWikiSpaceNodeRequest): Promise - /** - * 获取知识空间节点信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node - */ - getNodeWikiSpace(query?: GetNodeWikiSpaceQuery): Promise - /** - * 获取知识空间子节点列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list - */ - listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery): Promise - /** - * 移动知识空间节点 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move - */ - moveWikiSpaceNode(space_id: string, node_token: string, params: MoveWikiSpaceNodeRequest): Promise - /** - * 更新知识空间节点标题 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/update_title - */ - updateTitleWikiSpaceNode(space_id: string, node_token: string, params: UpdateTitleWikiSpaceNodeRequest): Promise - /** - * 创建知识空间节点副本 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/copy - */ - copyWikiSpaceNode(space_id: string, node_token: string, params: CopyWikiSpaceNodeRequest): Promise - /** - * 移动云空间文档至知识空间 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move_docs_to_wiki - */ - moveDocsToWikiWikiSpaceNode(space_id: string, params: MoveDocsToWikiWikiSpaceNodeRequest): Promise - /** - * 获取任务结果 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/task/get - */ - getWikiTask(task_id: string, query?: GetWikiTaskQuery): Promise - /** - * 搜索 Wiki - * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki - */ - searchWikiNode(params: SearchWikiNodeRequest, query?: SearchWikiNodeQuery): Promise - /** - * 获取订阅状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/get - */ - getDrivev1FileSubscription(file_token: string, subscription_id: string, params: GetDrivev1FileSubscriptionRequest): Promise - /** - * 创建订阅 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/create - */ - createDrivev1FileSubscription(file_token: string, params: CreateDrivev1FileSubscriptionRequest): Promise - /** - * 更新订阅状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/patch - */ - patchDrivev1FileSubscription(file_token: string, subscription_id: string, params: PatchDrivev1FileSubscriptionRequest): Promise - /** - * 创建共享日历 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/create - */ - createCalendar(params: CreateCalendarRequest): Promise - /** - * 删除共享日历 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/delete - */ - deleteCalendar(calendar_id: string): Promise - /** - * 查询主日历信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary - */ - primaryCalendar(query?: PrimaryCalendarQuery): Promise - /** - * 查询日历信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get - */ - getCalendar(calendar_id: string): Promise - /** - * 查询主日历日程忙闲信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/list - */ - listCalendarFreebusy(params: ListCalendarFreebusyRequest, query?: ListCalendarFreebusyQuery): Promise - /** - * 查询日历列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list - */ - listCalendar(query?: ListCalendarQuery): Promise - /** - * 更新日历信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/patch - */ - patchCalendar(calendar_id: string, params: PatchCalendarRequest): Promise - /** - * 搜索日历 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/search - */ - searchCalendar(params: SearchCalendarRequest, query?: SearchCalendarQuery): Promise - /** - * 订阅日历 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscribe - */ - subscribeCalendar(calendar_id: string): Promise - /** - * 取消订阅日历 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscribe - */ - unsubscribeCalendar(calendar_id: string): Promise - /** - * 订阅日历变更事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscription - */ - subscriptionCalendar(): Promise - /** - * 取消订阅日历变更事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscription - */ - unsubscriptionCalendar(): Promise - /** - * 创建访问控制 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/create - */ - createCalendarCalendarAcl(calendar_id: string, params: CreateCalendarCalendarAclRequest, query?: CreateCalendarCalendarAclQuery): Promise - /** - * 删除访问控制 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/delete - */ - deleteCalendarCalendarAcl(calendar_id: string, acl_id: string): Promise - /** - * 获取访问控制列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/list - */ - listCalendarCalendarAcl(calendar_id: string, query?: ListCalendarCalendarAclQuery): Promise - /** - * 订阅日历访问控制变更事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/subscription - */ - subscriptionCalendarCalendarAcl(calendar_id: string): Promise - /** - * 取消订阅日历访问控制变更事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/unsubscription - */ - unsubscriptionCalendarCalendarAcl(calendar_id: string): Promise - /** - * 创建日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/create - */ - createCalendarCalendarEvent(calendar_id: string, params: CreateCalendarCalendarEventRequest, query?: CreateCalendarCalendarEventQuery): Promise - /** - * 删除日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/delete - */ - deleteCalendarCalendarEvent(calendar_id: string, event_id: string, query?: DeleteCalendarCalendarEventQuery): Promise - /** - * 更新日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/patch - */ - patchCalendarCalendarEvent(calendar_id: string, event_id: string, params: PatchCalendarCalendarEventRequest, query?: PatchCalendarCalendarEventQuery): Promise - /** - * 获取日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/get - */ - getCalendarCalendarEvent(calendar_id: string, event_id: string, query?: GetCalendarCalendarEventQuery): Promise - /** - * 获取日程列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/list - */ - listCalendarCalendarEvent(calendar_id: string, query?: ListCalendarCalendarEventQuery): Promise - /** - * 搜索日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search - */ - searchCalendarCalendarEvent(calendar_id: string, params: SearchCalendarCalendarEventRequest, query?: SearchCalendarCalendarEventQuery): Promise - /** - * 订阅日程变更事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/subscription - */ - subscriptionCalendarCalendarEvent(calendar_id: string): Promise - /** - * 取消订阅日程变更事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/unsubscription - */ - unsubscriptionCalendarCalendarEvent(calendar_id: string): Promise - /** - * 回复日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/reply - */ - replyCalendarCalendarEvent(calendar_id: string, event_id: string, params: ReplyCalendarCalendarEventRequest): Promise - /** - * 获取重复日程实例 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instances - */ - instancesCalendarCalendarEvent(calendar_id: string, event_id: string, query?: InstancesCalendarCalendarEventQuery): Promise - /** - * 查询日程视图 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instance_view - */ - instanceViewCalendarCalendarEvent(calendar_id: string, query?: InstanceViewCalendarCalendarEventQuery): Promise - /** - * 创建会议群 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_chat/create - */ - createCalendarCalendarEventMeetingChat(calendar_id: string, event_id: string): Promise - /** - * 解绑会议群 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_chat/delete - */ - deleteCalendarCalendarEventMeetingChat(calendar_id: string, event_id: string, query?: DeleteCalendarCalendarEventMeetingChatQuery): Promise - /** - * 创建请假日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/timeoff_event/create - */ - createCalendarTimeoffEvent(params: CreateCalendarTimeoffEventRequest, query?: CreateCalendarTimeoffEventQuery): Promise - /** - * 删除请假日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/timeoff_event/delete - */ - deleteCalendarTimeoffEvent(timeoff_event_id: string): Promise - /** - * 添加日程参与人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/create - */ - createCalendarCalendarEventAttendee(calendar_id: string, event_id: string, params: CreateCalendarCalendarEventAttendeeRequest, query?: CreateCalendarCalendarEventAttendeeQuery): Promise - /** - * 删除日程参与人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/batch_delete - */ - batchDeleteCalendarCalendarEventAttendee(calendar_id: string, event_id: string, params: BatchDeleteCalendarCalendarEventAttendeeRequest, query?: BatchDeleteCalendarCalendarEventAttendeeQuery): Promise - /** - * 获取日程参与人列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/list - */ - listCalendarCalendarEventAttendee(calendar_id: string, event_id: string, query?: ListCalendarCalendarEventAttendeeQuery): Promise - /** - * 获取日程参与群成员列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list - */ - listCalendarCalendarEventAttendeeChatMember(calendar_id: string, event_id: string, attendee_id: string, query?: ListCalendarCalendarEventAttendeeChatMemberQuery): Promise - /** - * 生成 CalDAV 配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/setting/generate_caldav_conf - */ - generateCaldavConfCalendarSetting(params: GenerateCaldavConfCalendarSettingRequest): Promise - /** - * 将 Exchange 账户绑定到飞书账户 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/create - */ - createCalendarExchangeBinding(params: CreateCalendarExchangeBindingRequest, query?: CreateCalendarExchangeBindingQuery): Promise - /** - * 解除 Exchange 账户绑定 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/delete - */ - deleteCalendarExchangeBinding(exchange_binding_id: string): Promise - /** - * 查询 Exchange 账户的绑定状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/get - */ - getCalendarExchangeBinding(exchange_binding_id: string, query?: GetCalendarExchangeBindingQuery): Promise - /** - * 预约会议 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply - */ - applyVcReserve(params: ApplyVcReserveRequest, query?: ApplyVcReserveQuery): Promise - /** - * 删除预约 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete - */ - deleteVcReserve(reserve_id: string): Promise - /** - * 更新预约 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update - */ - updateVcReserve(reserve_id: string, params: UpdateVcReserveRequest, query?: UpdateVcReserveQuery): Promise - /** - * 获取预约 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get - */ - getVcReserve(reserve_id: string, query?: GetVcReserveQuery): Promise - /** - * 获取活跃会议 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get_active_meeting - */ - getActiveMeetingVcReserve(reserve_id: string, query?: GetActiveMeetingVcReserveQuery): Promise - /** - * 邀请参会人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/invite - */ - inviteVcMeeting(meeting_id: string, params: InviteVcMeetingRequest, query?: InviteVcMeetingQuery): Promise - /** - * 移除参会人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/kickout - */ - kickoutVcMeeting(meeting_id: string, params: KickoutVcMeetingRequest, query?: KickoutVcMeetingQuery): Promise - /** - * 设置主持人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/set_host - */ - setHostVcMeeting(meeting_id: string, params: SetHostVcMeetingRequest, query?: SetHostVcMeetingQuery): Promise - /** - * 结束会议 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/end - */ - endVcMeeting(meeting_id: string): Promise - /** - * 获取会议详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get - */ - getVcMeeting(meeting_id: string, query?: GetVcMeetingQuery): Promise - /** - * 获取与会议号关联的会议列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no - */ - listByNoVcMeeting(query?: ListByNoVcMeetingQuery): Promise - /** - * 开始录制 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start - */ - startVcMeetingRecording(meeting_id: string, params: StartVcMeetingRecordingRequest): Promise - /** - * 停止录制 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/stop - */ - stopVcMeetingRecording(meeting_id: string): Promise - /** - * 获取录制文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/get - */ - getVcMeetingRecording(meeting_id: string): Promise - /** - * 授权录制文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/set_permission - */ - setPermissionVcMeetingRecording(meeting_id: string, params: SetPermissionVcMeetingRecordingRequest, query?: SetPermissionVcMeetingRecordingQuery): Promise - /** - * 获取会议报告 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_daily - */ - getDailyVcReport(query?: GetDailyVcReportQuery): Promise - /** - * 获取 Top 用户列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_top_user - */ - getTopUserVcReport(query?: GetTopUserVcReportQuery): Promise - /** - * 导出会议明细 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/meeting_list - */ - meetingListVcExport(params: MeetingListVcExportRequest, query?: MeetingListVcExportQuery): Promise - /** - * 导出参会人明细 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_list - */ - participantListVcExport(params: ParticipantListVcExportRequest, query?: ParticipantListVcExportQuery): Promise - /** - * 导出参会人会议质量数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_quality_list - */ - participantQualityListVcExport(params: ParticipantQualityListVcExportRequest, query?: ParticipantQualityListVcExportQuery): Promise - /** - * 导出会议室预定数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list - */ - resourceReservationListVcExport(params: ResourceReservationListVcExportRequest): Promise - /** - * 查询导出任务结果 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/get - */ - getVcExport(task_id: string): Promise - /** - * 下载导出文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/download - */ - downloadVcExport(query?: DownloadVcExportQuery): Promise - /** - * 创建会议室层级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/create - */ - createVcRoomLevel(params: CreateVcRoomLevelRequest): Promise - /** - * 删除会议室层级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/del - */ - delVcRoomLevel(params: DelVcRoomLevelRequest): Promise - /** - * 更新会议室层级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/patch - */ - patchVcRoomLevel(room_level_id: string, params: PatchVcRoomLevelRequest): Promise - /** - * 查询会议室层级详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/get - */ - getVcRoomLevel(room_level_id: string): Promise - /** - * 批量查询会议室层级详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/mget - */ - mgetVcRoomLevel(params: MgetVcRoomLevelRequest): Promise - /** - * 查询会议室层级列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list - */ - listVcRoomLevel(query?: ListVcRoomLevelQuery): Promise - /** - * 搜索会议室层级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search - */ - searchVcRoomLevel(query?: SearchVcRoomLevelQuery): Promise - /** - * 创建会议室 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/create - */ - createVcRoom(params: CreateVcRoomRequest, query?: CreateVcRoomQuery): Promise - /** - * 删除会议室 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/delete - */ - deleteVcRoom(room_id: string): Promise - /** - * 更新会议室 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/patch - */ - patchVcRoom(room_id: string, params: PatchVcRoomRequest, query?: PatchVcRoomQuery): Promise - /** - * 查询会议室详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/get - */ - getVcRoom(room_id: string, query?: GetVcRoomQuery): Promise - /** - * 批量查询会议室详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/mget - */ - mgetVcRoom(params: MgetVcRoomRequest, query?: MgetVcRoomQuery): Promise - /** - * 查询会议室列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list - */ - listVcRoom(query?: ListVcRoomQuery): Promise - /** - * 搜索会议室 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search - */ - searchVcRoom(params: SearchVcRoomRequest, query?: SearchVcRoomQuery): Promise - /** - * 查询会议室配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get - */ - getVcScopeConfig(query?: GetVcScopeConfigQuery): Promise - /** - * 设置会议室配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/create - */ - createVcScopeConfig(params: CreateVcScopeConfigRequest, query?: CreateVcScopeConfigQuery): Promise - /** - * 查询会议室预定限制 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/reserve_scope - */ - reserveScopeVcReserveConfig(query?: ReserveScopeVcReserveConfigQuery): Promise - /** - * 更新会议室预定限制 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/patch - */ - patchVcReserveConfig(reserve_config_id: string, params: PatchVcReserveConfigRequest, query?: PatchVcReserveConfigQuery): Promise - /** - * 查询会议室预定表单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/get - */ - getVcReserveConfigForm(reserve_config_id: string, query?: GetVcReserveConfigFormQuery): Promise - /** - * 更新会议室预定表单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/patch - */ - patchVcReserveConfigForm(reserve_config_id: string, params: PatchVcReserveConfigFormRequest, query?: PatchVcReserveConfigFormQuery): Promise - /** - * 查询会议室预定管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/get - */ - getVcReserveConfigAdmin(reserve_config_id: string, query?: GetVcReserveConfigAdminQuery): Promise - /** - * 更新会议室预定管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/patch - */ - patchVcReserveConfigAdmin(reserve_config_id: string, params: PatchVcReserveConfigAdminRequest, query?: PatchVcReserveConfigAdminQuery): Promise - /** - * 查询禁用状态变更通知 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/get - */ - getVcReserveConfigDisableInform(reserve_config_id: string, query?: GetVcReserveConfigDisableInformQuery): Promise - /** - * 更新禁用状态变更通知 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/patch - */ - patchVcReserveConfigDisableInform(reserve_config_id: string, params: PatchVcReserveConfigDisableInformRequest, query?: PatchVcReserveConfigDisableInformQuery): Promise - /** - * 查询会议明细 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get - */ - getVcMeetingList(query?: GetVcMeetingListQuery): Promise - /** - * 查询参会人明细 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get - */ - getVcParticipantList(query?: GetVcParticipantListQuery): Promise - /** - * 查询参会人会议质量数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get - */ - getVcParticipantQualityList(query?: GetVcParticipantQualityListQuery): Promise - /** - * 查询会议室预定数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get - */ - getVcResourceReservationList(query?: GetVcResourceReservationListQuery): Promise - /** - * 获取告警记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list - */ - listVcAlert(query?: ListVcAlertQuery): Promise - /** - * 创建班次 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/create - */ - createAttendanceShift(params: CreateAttendanceShiftRequest): Promise - /** - * 删除班次 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/delete - */ - deleteAttendanceShift(shift_id: string): Promise - /** - * 按 ID 查询班次 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/get - */ - getAttendanceShift(shift_id: string): Promise - /** - * 按名称查询班次 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/query - */ - queryAttendanceShift(query?: QueryAttendanceShiftQuery): Promise - /** - * 查询所有班次 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/list - */ - listAttendanceShift(query?: ListAttendanceShiftQuery): Promise - /** - * 创建或修改考勤组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/create - */ - createAttendanceGroup(params: CreateAttendanceGroupRequest, query?: CreateAttendanceGroupQuery): Promise - /** - * 删除考勤组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/delete - */ - deleteAttendanceGroup(group_id: string): Promise - /** - * 按 ID 查询考勤组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/get - */ - getAttendanceGroup(group_id: string, query?: GetAttendanceGroupQuery): Promise - /** - * 按名称查询考勤组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/search - */ - searchAttendanceGroup(params: SearchAttendanceGroupRequest): Promise - /** - * 查询所有考勤组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list - */ - listAttendanceGroup(query?: ListAttendanceGroupQuery): Promise - /** - * 创建或修改排班表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/batch_create - */ - batchCreateAttendanceUserDailyShift(params: BatchCreateAttendanceUserDailyShiftRequest, query?: BatchCreateAttendanceUserDailyShiftQuery): Promise - /** - * 查询排班表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/query - */ - queryAttendanceUserDailyShift(params: QueryAttendanceUserDailyShiftRequest, query?: QueryAttendanceUserDailyShiftQuery): Promise - /** - * 更新统计设置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_view/update - */ - updateAttendanceUserStatsView(user_stats_view_id: string, params: UpdateAttendanceUserStatsViewRequest, query?: UpdateAttendanceUserStatsViewQuery): Promise - /** - * 查询统计表头 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_field/query - */ - queryAttendanceUserStatsField(params: QueryAttendanceUserStatsFieldRequest, query?: QueryAttendanceUserStatsFieldQuery): Promise - /** - * 查询统计设置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_view/query - */ - queryAttendanceUserStatsView(params: QueryAttendanceUserStatsViewRequest, query?: QueryAttendanceUserStatsViewQuery): Promise - /** - * 查询统计数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_data/query - */ - queryAttendanceUserStatsData(params: QueryAttendanceUserStatsDataRequest, query?: QueryAttendanceUserStatsDataQuery): Promise - /** - * 获取审批通过数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query - */ - queryAttendanceUserApproval(params: QueryAttendanceUserApprovalRequest, query?: QueryAttendanceUserApprovalQuery): Promise - /** - * 写入审批结果 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create - */ - createAttendanceUserApproval(params: CreateAttendanceUserApprovalRequest, query?: CreateAttendanceUserApprovalQuery): Promise - /** - * 通知审批状态更新 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/approval_info/process - */ - processAttendanceApprovalInfo(params: ProcessAttendanceApprovalInfoRequest): Promise - /** - * 通知补卡审批发起 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create - */ - createAttendanceUserTaskRemedy(params: CreateAttendanceUserTaskRemedyRequest, query?: CreateAttendanceUserTaskRemedyQuery): Promise - /** - * 获取可补卡时间 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/query_user_allowed_remedys - */ - queryUserAllowedRemedysAttendanceUserTaskRemedy(params: QueryUserAllowedRemedysAttendanceUserTaskRemedyRequest, query?: QueryUserAllowedRemedysAttendanceUserTaskRemedyQuery): Promise - /** - * 获取补卡记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/query - */ - queryAttendanceUserTaskRemedy(params: QueryAttendanceUserTaskRemedyRequest, query?: QueryAttendanceUserTaskRemedyQuery): Promise - /** - * 导入打卡流水 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/batch_create - */ - batchCreateAttendanceUserFlow(params: BatchCreateAttendanceUserFlowRequest, query?: BatchCreateAttendanceUserFlowQuery): Promise - /** - * 查询打卡流水 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/get - */ - getAttendanceUserFlow(user_flow_id: string, query?: GetAttendanceUserFlowQuery): Promise - /** - * 批量查询打卡流水 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/query - */ - queryAttendanceUserFlow(params: QueryAttendanceUserFlowRequest, query?: QueryAttendanceUserFlowQuery): Promise - /** - * 查询打卡结果 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task/query - */ - queryAttendanceUserTask(params: QueryAttendanceUserTaskRequest, query?: QueryAttendanceUserTaskQuery): Promise - /** - * 修改用户人脸识别信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/modify - */ - modifyAttendanceUserSetting(params: ModifyAttendanceUserSettingRequest, query?: ModifyAttendanceUserSettingQuery): Promise - /** - * 批量查询用户人脸识别信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/query - */ - queryAttendanceUserSetting(params: QueryAttendanceUserSettingRequest, query?: QueryAttendanceUserSettingQuery): Promise - /** - * 上传用户人脸识别照片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/upload - */ - uploadAttendanceFile(form: UploadAttendanceFileForm, query?: UploadAttendanceFileQuery): Promise - /** - * 下载用户人脸识别照片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/download - */ - downloadAttendanceFile(file_id: string): Promise - /** - * 通过过期时间获取发放记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/leave_employ_expire_record/get - */ - getAttendanceLeaveEmployExpireRecord(leave_id: string, params: GetAttendanceLeaveEmployExpireRecordRequest, query?: GetAttendanceLeaveEmployExpireRecordQuery): Promise - /** - * 修改发放记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/leave_accrual_record/patch - */ - patchAttendanceLeaveAccrualRecord(leave_id: string, params: PatchAttendanceLeaveAccrualRecordRequest, query?: PatchAttendanceLeaveAccrualRecordQuery): Promise - /** - * 创建审批定义 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create - */ - createApproval(params: CreateApprovalRequest, query?: CreateApprovalQuery): Promise - /** - * 创建审批实例 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/create - */ - createApprovalInstance(params: CreateApprovalInstanceRequest): Promise - /** - * 撤回审批实例 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cancel - */ - cancelApprovalInstance(params: CancelApprovalInstanceRequest, query?: CancelApprovalInstanceQuery): Promise - /** - * 抄送审批实例 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cc - */ - ccApprovalInstance(params: CcApprovalInstanceRequest, query?: CcApprovalInstanceQuery): Promise - /** - * 预览审批流程 - * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview - */ - previewApprovalInstance(params: PreviewApprovalInstanceRequest, query?: PreviewApprovalInstanceQuery): Promise - /** - * 获取单个审批实例详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get - */ - getApprovalInstance(instance_id: string, query?: GetApprovalInstanceQuery): Promise - /** - * 批量获取审批实例 ID - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list - */ - listApprovalInstance(query?: ListApprovalInstanceQuery): Promise - /** - * 同意审批任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve - */ - approveApprovalTask(params: ApproveApprovalTaskRequest, query?: ApproveApprovalTaskQuery): Promise - /** - * 拒绝审批任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/reject - */ - rejectApprovalTask(params: RejectApprovalTaskRequest, query?: RejectApprovalTaskQuery): Promise - /** - * 转交审批任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/transfer - */ - transferApprovalTask(params: TransferApprovalTaskRequest, query?: TransferApprovalTaskQuery): Promise - /** - * 退回审批任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback - */ - specifiedRollbackApprovalInstance(params: SpecifiedRollbackApprovalInstanceRequest, query?: SpecifiedRollbackApprovalInstanceQuery): Promise - /** - * 审批任务加签 - * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign - */ - addSignApprovalInstance(params: AddSignApprovalInstanceRequest): Promise - /** - * 重新提交审批任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/resubmit - */ - resubmitApprovalTask(params: ResubmitApprovalTaskRequest, query?: ResubmitApprovalTaskQuery): Promise - /** - * 创建评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/create - */ - createApprovalInstanceComment(instance_id: string, params: CreateApprovalInstanceCommentRequest, query?: CreateApprovalInstanceCommentQuery): Promise - /** - * 删除评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/delete - */ - deleteApprovalInstanceComment(instance_id: string, comment_id: string, query?: DeleteApprovalInstanceCommentQuery): Promise - /** - * 清空评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/remove - */ - removeApprovalInstanceComment(instance_id: string, query?: RemoveApprovalInstanceCommentQuery): Promise - /** - * 获取评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list - */ - listApprovalInstanceComment(instance_id: string, query?: ListApprovalInstanceCommentQuery): Promise - /** - * 创建三方审批定义 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create - */ - createApprovalExternalApproval(params: CreateApprovalExternalApprovalRequest, query?: CreateApprovalExternalApprovalQuery): Promise - /** - * 查看指定三方审批定义 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/get - */ - getApprovalExternalApproval(approval_code: string, query?: GetApprovalExternalApprovalQuery): Promise - /** - * 同步三方审批实例 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create - */ - createApprovalExternalInstance(params: CreateApprovalExternalInstanceRequest): Promise - /** - * 校验三方审批实例 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/check - */ - checkApprovalExternalInstance(params: CheckApprovalExternalInstanceRequest): Promise - /** - * 获取三方审批任务状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list - */ - listApprovalExternalTask(params: ListApprovalExternalTaskRequest, query?: ListApprovalExternalTaskQuery): Promise - /** - * 查询实例列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query - */ - queryApprovalInstance(params: QueryApprovalInstanceRequest, query?: QueryApprovalInstanceQuery): Promise - /** - * 查询抄送列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc - */ - searchCcApprovalInstance(params: SearchCcApprovalInstanceRequest, query?: SearchCcApprovalInstanceQuery): Promise - /** - * 查询任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search - */ - searchApprovalTask(params: SearchApprovalTaskRequest, query?: SearchApprovalTaskQuery): Promise - /** - * 查询用户的任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query - */ - queryApprovalTask(query?: QueryApprovalTaskQuery): Promise - /** - * 订阅审批事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe - */ - subscribeApproval(approval_code: string): Promise - /** - * 取消订阅审批事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/unsubscribe - */ - unsubscribeApproval(approval_code: string): Promise - /** - * 更新客服信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent/patch - */ - patchHelpdeskAgent(agent_id: string, params: PatchHelpdeskAgentRequest): Promise - /** - * 获取客服邮箱 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent/agent_email - */ - agentEmailHelpdeskAgent(): Promise - /** - * 创建客服工作日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/create - */ - createHelpdeskAgentSchedule(params: CreateHelpdeskAgentScheduleRequest): Promise - /** - * 删除客服工作日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/delete - */ - deleteHelpdeskAgentSchedules(agent_id: string): Promise - /** - * 更新客服工作日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/patch - */ - patchHelpdeskAgentSchedules(agent_id: string, params: PatchHelpdeskAgentSchedulesRequest): Promise - /** - * 查询指定客服工作日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/get - */ - getHelpdeskAgentSchedules(agent_id: string): Promise - /** - * 查询全部客服工作日程 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/list - */ - listHelpdeskAgentSchedule(query?: ListHelpdeskAgentScheduleQuery): Promise - /** - * 创建客服技能 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/create - */ - createHelpdeskAgentSkill(params: CreateHelpdeskAgentSkillRequest): Promise - /** - * 删除客服技能 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/delete - */ - deleteHelpdeskAgentSkill(agent_skill_id: string): Promise - /** - * 更新客服技能 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/patch - */ - patchHelpdeskAgentSkill(agent_skill_id: string, params: PatchHelpdeskAgentSkillRequest): Promise - /** - * 查询指定客服技能 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/get - */ - getHelpdeskAgentSkill(agent_skill_id: string): Promise - /** - * 查询全部客服技能 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/list - */ - listHelpdeskAgentSkill(): Promise - /** - * 获取客服技能列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill_rule/list - */ - listHelpdeskAgentSkillRule(): Promise - /** - * 创建服务台对话 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/start_service - */ - startServiceHelpdeskTicket(params: StartServiceHelpdeskTicketRequest): Promise - /** - * 查询指定工单详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get - */ - getHelpdeskTicket(ticket_id: string): Promise - /** - * 更新工单详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/update - */ - updateHelpdeskTicket(ticket_id: string, params: UpdateHelpdeskTicketRequest): Promise - /** - * 查询全部工单详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/list - */ - listHelpdeskTicket(query?: ListHelpdeskTicketQuery): Promise - /** - * 获取工单内图像 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/ticket_image - */ - ticketImageHelpdeskTicket(query?: TicketImageHelpdeskTicketQuery): Promise - /** - * 回复用户在工单里的提问 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/answer_user_query - */ - answerUserQueryHelpdeskTicket(ticket_id: string, params: AnswerUserQueryHelpdeskTicketRequest): Promise - /** - * 获取服务台自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/customized_fields - */ - customizedFieldsHelpdeskTicket(query?: CustomizedFieldsHelpdeskTicketQuery): Promise - /** - * 发送工单消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/create - */ - createHelpdeskTicketMessage(ticket_id: string, params: CreateHelpdeskTicketMessageRequest): Promise - /** - * 获取工单消息详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list - */ - listHelpdeskTicketMessage(ticket_id: string, query?: ListHelpdeskTicketMessageQuery): Promise - /** - * 服务台机器人向工单绑定的群内发送消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/bot-message/create - */ - createHelpdeskBotMessage(params: CreateHelpdeskBotMessageRequest, query?: CreateHelpdeskBotMessageQuery): Promise - /** - * 创建工单自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/create-ticket-customized-field - */ - createHelpdeskTicketCustomizedField(params: CreateHelpdeskTicketCustomizedFieldRequest): Promise - /** - * 删除工单自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/delete - */ - deleteHelpdeskTicketCustomizedField(ticket_customized_field_id: string): Promise - /** - * 更新工单自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/update-ticket-customized-field - */ - patchHelpdeskTicketCustomizedField(ticket_customized_field_id: string, params: PatchHelpdeskTicketCustomizedFieldRequest): Promise - /** - * 获取指定工单自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/get-ticket-customized-field - */ - getHelpdeskTicketCustomizedField(ticket_customized_field_id: string): Promise - /** - * 获取全部工单自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields - */ - listHelpdeskTicketCustomizedField(params: ListHelpdeskTicketCustomizedFieldRequest, query?: ListHelpdeskTicketCustomizedFieldQuery): Promise - /** - * 创建知识库 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/create - */ - createHelpdeskFaq(params: CreateHelpdeskFaqRequest): Promise - /** - * 删除知识库 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/delete - */ - deleteHelpdeskFaq(id: string): Promise - /** - * 修改知识库 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/patch - */ - patchHelpdeskFaq(id: string, params: PatchHelpdeskFaqRequest): Promise - /** - * 获取指定知识库详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/get - */ - getHelpdeskFaq(id: string): Promise - /** - * 获取全部知识库详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/list - */ - listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise - /** - * 获取知识库图像 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/faq_image - */ - faqImageHelpdeskFaq(id: string, image_key: string): Promise - /** - * 搜索知识库 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/search - */ - searchHelpdeskFaq(query?: SearchHelpdeskFaqQuery): Promise - /** - * 创建知识库分类 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/create - */ - createHelpdeskCategory(params: CreateHelpdeskCategoryRequest): Promise - /** - * 获取知识库分类 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/get - */ - getHelpdeskCategory(id: string): Promise - /** - * 更新知识库分类详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/patch - */ - patchHelpdeskCategory(id: string, params: PatchHelpdeskCategoryRequest): Promise - /** - * 删除知识库分类详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/delete - */ - deleteHelpdeskCategory(id: string): Promise - /** - * 获取全部知识库分类 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/list-categories - */ - listHelpdeskCategory(query?: ListHelpdeskCategoryQuery): Promise - /** - * 创建推送 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/create - */ - createHelpdeskNotification(params: CreateHelpdeskNotificationRequest, query?: CreateHelpdeskNotificationQuery): Promise - /** - * 更新推送 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/patch - */ - patchHelpdeskNotification(notification_id: string, params: PatchHelpdeskNotificationRequest, query?: PatchHelpdeskNotificationQuery): Promise - /** - * 查询推送 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/get - */ - getHelpdeskNotification(notification_id: string, query?: GetHelpdeskNotificationQuery): Promise - /** - * 预览推送 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/preview - */ - previewHelpdeskNotification(notification_id: string): Promise - /** - * 提交审核 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/submit_approve - */ - submitApproveHelpdeskNotification(notification_id: string, params: SubmitApproveHelpdeskNotificationRequest): Promise - /** - * 取消审核 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_approve - */ - cancelApproveHelpdeskNotification(notification_id: string): Promise - /** - * 执行推送 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/execute_send - */ - executeSendHelpdeskNotification(notification_id: string, params: ExecuteSendHelpdeskNotificationRequest): Promise - /** - * 取消推送 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_send - */ - cancelSendHelpdeskNotification(notification_id: string, params: CancelSendHelpdeskNotificationRequest): Promise - /** - * 订阅服务台事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/subscribe - */ - subscribeHelpdeskEvent(params: SubscribeHelpdeskEventRequest): Promise - /** - * 取消订阅服务台事件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/unsubscribe - */ - unsubscribeHelpdeskEvent(params: UnsubscribeHelpdeskEventRequest): Promise - /** - * 创建任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/create - */ - createTaskv1(params: CreateTaskv1Request, query?: CreateTaskv1Query): Promise - /** - * 删除任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/delete - */ - deleteTaskv1(task_id: string): Promise - /** - * 更新任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/patch - */ - patchTaskv1(task_id: string, params: PatchTaskv1Request, query?: PatchTaskv1Query): Promise - /** - * 完成任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/complete - */ - completeTaskv1(task_id: string): Promise - /** - * 取消完成任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/uncomplete - */ - uncompleteTaskv1(task_id: string): Promise - /** - * 查询指定任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/get - */ - getTaskv1(task_id: string, query?: GetTaskv1Query): Promise - /** - * 查询所有任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/list - */ - listTaskv1(query?: ListTaskv1Query): Promise - /** - * 新增提醒时间 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/create - */ - createTaskv1TaskReminder(task_id: string, params: CreateTaskv1TaskReminderRequest): Promise - /** - * 删除提醒时间 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/delete - */ - deleteTaskv1TaskReminder(task_id: string, reminder_id: string): Promise - /** - * 查询提醒时间列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list - */ - listTaskv1TaskReminder(task_id: string, query?: ListTaskv1TaskReminderQuery): Promise - /** - * 创建评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/create - */ - createTaskv1TaskComment(task_id: string, params: CreateTaskv1TaskCommentRequest, query?: CreateTaskv1TaskCommentQuery): Promise - /** - * 删除评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/delete - */ - deleteTaskv1TaskComment(task_id: string, comment_id: string): Promise - /** - * 更新评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/update - */ - updateTaskv1TaskComment(task_id: string, comment_id: string, params: UpdateTaskv1TaskCommentRequest, query?: UpdateTaskv1TaskCommentQuery): Promise - /** - * 获取评论详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/get - */ - getTaskv1TaskComment(task_id: string, comment_id: string, query?: GetTaskv1TaskCommentQuery): Promise - /** - * 获取评论列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/list - */ - listTaskv1TaskComment(task_id: string, query?: ListTaskv1TaskCommentQuery): Promise - /** - * 新增关注人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/create - */ - createTaskv1TaskFollower(task_id: string, params: CreateTaskv1TaskFollowerRequest, query?: CreateTaskv1TaskFollowerQuery): Promise - /** - * 删除指定关注人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/delete - */ - deleteTaskv1TaskFollower(task_id: string, follower_id: string, query?: DeleteTaskv1TaskFollowerQuery): Promise - /** - * 批量删除关注人 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_follower - */ - batchDeleteFollowerTaskv1(task_id: string, params: BatchDeleteFollowerTaskv1Request, query?: BatchDeleteFollowerTaskv1Query): Promise - /** - * 获取关注人列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/list - */ - listTaskv1TaskFollower(task_id: string, query?: ListTaskv1TaskFollowerQuery): Promise - /** - * 新增执行者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/create - */ - createTaskv1TaskCollaborator(task_id: string, params: CreateTaskv1TaskCollaboratorRequest, query?: CreateTaskv1TaskCollaboratorQuery): Promise - /** - * 删除指定执行者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/delete - */ - deleteTaskv1TaskCollaborator(task_id: string, collaborator_id: string, query?: DeleteTaskv1TaskCollaboratorQuery): Promise - /** - * 批量删除执行者 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_collaborator - */ - batchDeleteCollaboratorTaskv1(task_id: string, params: BatchDeleteCollaboratorTaskv1Request, query?: BatchDeleteCollaboratorTaskv1Query): Promise - /** - * 获取执行者列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/list - */ - listTaskv1TaskCollaborator(task_id: string, query?: ListTaskv1TaskCollaboratorQuery): Promise - /** - * 创建任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/create - */ - createTaskv2(params: CreateTaskv2Request, query?: CreateTaskv2Query): Promise - /** - * 获取任务详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/get - */ - getTaskv2(task_guid: string, query?: GetTaskv2Query): Promise - /** - * 更新任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/patch - */ - patchTaskv2(task_guid: string, params: PatchTaskv2Request, query?: PatchTaskv2Query): Promise - /** - * 删除任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/delete - */ - deleteTaskv2(task_guid: string): Promise - /** - * 添加任务成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_members - */ - addMembersTaskv2(task_guid: string, params: AddMembersTaskv2Request, query?: AddMembersTaskv2Query): Promise - /** - * 移除任务成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_members - */ - removeMembersTaskv2(task_guid: string, params: RemoveMembersTaskv2Request, query?: RemoveMembersTaskv2Query): Promise - /** - * 列取任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list - */ - listTaskv2(query?: ListTaskv2Query): Promise - /** - * 列取任务所在清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/tasklists - */ - tasklistsTaskv2(task_guid: string): Promise - /** - * 任务加入清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_tasklist - */ - addTasklistTaskv2(task_guid: string, params: AddTasklistTaskv2Request, query?: AddTasklistTaskv2Query): Promise - /** - * 任务移出清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_tasklist - */ - removeTasklistTaskv2(task_guid: string, params: RemoveTasklistTaskv2Request, query?: RemoveTasklistTaskv2Query): Promise - /** - * 添加任务提醒 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_reminders - */ - addRemindersTaskv2(task_guid: string, params: AddRemindersTaskv2Request, query?: AddRemindersTaskv2Query): Promise - /** - * 移除任务提醒 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_reminders - */ - removeRemindersTaskv2(task_guid: string, params: RemoveRemindersTaskv2Request, query?: RemoveRemindersTaskv2Query): Promise - /** - * 添加依赖 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_dependencies - */ - addDependenciesTaskv2(task_guid: string, params: AddDependenciesTaskv2Request): Promise - /** - * 移除依赖 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_dependencies - */ - removeDependenciesTaskv2(task_guid: string, params: RemoveDependenciesTaskv2Request): Promise - /** - * 创建子任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/create - */ - createTaskv2TaskSubtask(task_guid: string, params: CreateTaskv2TaskSubtaskRequest, query?: CreateTaskv2TaskSubtaskQuery): Promise - /** - * 获取任务的子任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list - */ - listTaskv2TaskSubtask(task_guid: string, query?: ListTaskv2TaskSubtaskQuery): Promise - /** - * 创建清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/create - */ - createTaskv2Tasklist(params: CreateTaskv2TasklistRequest, query?: CreateTaskv2TasklistQuery): Promise - /** - * 获取清单详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/get - */ - getTaskv2Tasklist(tasklist_guid: string, query?: GetTaskv2TasklistQuery): Promise - /** - * 更新清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/patch - */ - patchTaskv2Tasklist(tasklist_guid: string, params: PatchTaskv2TasklistRequest, query?: PatchTaskv2TasklistQuery): Promise - /** - * 删除清单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/delete - */ - deleteTaskv2Tasklist(tasklist_guid: string): Promise - /** - * 添加清单成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/add_members - */ - addMembersTaskv2Tasklist(tasklist_guid: string, params: AddMembersTaskv2TasklistRequest, query?: AddMembersTaskv2TasklistQuery): Promise - /** - * 移除清单成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/remove_members - */ - removeMembersTaskv2Tasklist(tasklist_guid: string, params: RemoveMembersTaskv2TasklistRequest, query?: RemoveMembersTaskv2TasklistQuery): Promise - /** - * 获取清单任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks - */ - tasksTaskv2Tasklist(tasklist_guid: string, query?: TasksTaskv2TasklistQuery): Promise - /** - * 获取清单列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list - */ - listTaskv2Tasklist(query?: ListTaskv2TasklistQuery): Promise - /** - * 创建动态订阅 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/create - */ - createTaskv2TasklistActivitySubscription(tasklist_guid: string, params: CreateTaskv2TasklistActivitySubscriptionRequest, query?: CreateTaskv2TasklistActivitySubscriptionQuery): Promise - /** - * 获取动态订阅 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/get - */ - getTaskv2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string, query?: GetTaskv2TasklistActivitySubscriptionQuery): Promise - /** - * 列取动态订阅 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/list - */ - listTaskv2TasklistActivitySubscription(tasklist_guid: string, query?: ListTaskv2TasklistActivitySubscriptionQuery): Promise - /** - * 更新动态订阅 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/patch - */ - patchTaskv2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string, params: PatchTaskv2TasklistActivitySubscriptionRequest, query?: PatchTaskv2TasklistActivitySubscriptionQuery): Promise - /** - * 删除动态订阅 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/delete - */ - deleteTaskv2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string): Promise - /** - * 创建评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/create - */ - createTaskv2Comment(params: CreateTaskv2CommentRequest, query?: CreateTaskv2CommentQuery): Promise - /** - * 获取评论详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/get - */ - getTaskv2Comment(comment_id: string, query?: GetTaskv2CommentQuery): Promise - /** - * 更新评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/patch - */ - patchTaskv2Comment(comment_id: string, params: PatchTaskv2CommentRequest, query?: PatchTaskv2CommentQuery): Promise - /** - * 删除评论 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/delete - */ - deleteTaskv2Comment(comment_id: string): Promise - /** - * 获取评论列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list - */ - listTaskv2Comment(query?: ListTaskv2CommentQuery): Promise - /** - * 上传附件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/upload - */ - uploadTaskv2Attachment(form: UploadTaskv2AttachmentForm, query?: UploadTaskv2AttachmentQuery): Promise - /** - * 列取附件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list - */ - listTaskv2Attachment(query?: ListTaskv2AttachmentQuery): Promise - /** - * 获取附件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/get - */ - getTaskv2Attachment(attachment_guid: string, query?: GetTaskv2AttachmentQuery): Promise - /** - * 删除附件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/delete - */ - deleteTaskv2Attachment(attachment_guid: string): Promise - /** - * 创建自定义分组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/create - */ - createTaskv2Section(params: CreateTaskv2SectionRequest, query?: CreateTaskv2SectionQuery): Promise - /** - * 获取自定义分组详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/get - */ - getTaskv2Section(section_guid: string, query?: GetTaskv2SectionQuery): Promise - /** - * 更新自定义分组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/patch - */ - patchTaskv2Section(section_guid: string, params: PatchTaskv2SectionRequest, query?: PatchTaskv2SectionQuery): Promise - /** - * 删除自定义分组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/delete - */ - deleteTaskv2Section(section_guid: string): Promise - /** - * 获取自定义分组列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list - */ - listTaskv2Section(query?: ListTaskv2SectionQuery): Promise - /** - * 获取自定义分组任务列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks - */ - tasksTaskv2Section(section_guid: string, query?: TasksTaskv2SectionQuery): Promise - /** - * 创建自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create - */ - createTaskv2CustomField(params: CreateTaskv2CustomFieldRequest, query?: CreateTaskv2CustomFieldQuery): Promise - /** - * 获取自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/get - */ - getTaskv2CustomField(custom_field_guid: string, query?: GetTaskv2CustomFieldQuery): Promise - /** - * 更新自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/patch - */ - patchTaskv2CustomField(custom_field_guid: string, params: PatchTaskv2CustomFieldRequest, query?: PatchTaskv2CustomFieldQuery): Promise - /** - * 列取自定义字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list - */ - listTaskv2CustomField(query?: ListTaskv2CustomFieldQuery): Promise - /** - * 将自定义字段加入资源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/add - */ - addTaskv2CustomField(custom_field_guid: string, params: AddTaskv2CustomFieldRequest): Promise - /** - * 将自定义字段移出资源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/remove - */ - removeTaskv2CustomField(custom_field_guid: string, params: RemoveTaskv2CustomFieldRequest): Promise - /** - * 创建自定义任务选项 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/create - */ - createTaskv2CustomFieldOption(custom_field_guid: string, params: CreateTaskv2CustomFieldOptionRequest): Promise - /** - * 更新自定义字段选项 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/patch - */ - patchTaskv2CustomFieldOption(custom_field_guid: string, option_guid: string, params: PatchTaskv2CustomFieldOptionRequest): Promise - /** - * 创建邮件组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/create - */ - createMailMailgroup(params: CreateMailMailgroupRequest): Promise - /** - * 删除邮件组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/delete - */ - deleteMailMailgroup(mailgroup_id: string): Promise - /** - * 修改邮件组部分信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/patch - */ - patchMailMailgroup(mailgroup_id: string, params: PatchMailMailgroupRequest): Promise - /** - * 修改邮件组全部信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/update - */ - updateMailMailgroup(mailgroup_id: string, params: UpdateMailMailgroupRequest): Promise - /** - * 查询指定邮件组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/get - */ - getMailMailgroup(mailgroup_id: string): Promise - /** - * 批量获取邮件组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list - */ - listMailMailgroup(query?: ListMailMailgroupQuery): Promise - /** - * 批量创建邮件组管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create - */ - batchCreateMailMailgroupManager(mailgroup_id: string, params: BatchCreateMailMailgroupManagerRequest, query?: BatchCreateMailMailgroupManagerQuery): Promise - /** - * 批量删除邮件组管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_delete - */ - batchDeleteMailMailgroupManager(mailgroup_id: string, params: BatchDeleteMailMailgroupManagerRequest, query?: BatchDeleteMailMailgroupManagerQuery): Promise - /** - * 批量获取邮件组管理员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list - */ - listMailMailgroupManager(mailgroup_id: string, query?: ListMailMailgroupManagerQuery): Promise - /** - * 创建邮件组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create - */ - createMailMailgroupMember(mailgroup_id: string, params: CreateMailMailgroupMemberRequest, query?: CreateMailMailgroupMemberQuery): Promise - /** - * 删除邮件组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/delete - */ - deleteMailMailgroupMember(mailgroup_id: string, member_id: string): Promise - /** - * 查询指定邮件组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/get - */ - getMailMailgroupMember(mailgroup_id: string, member_id: string, query?: GetMailMailgroupMemberQuery): Promise - /** - * 获取所有邮件组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list - */ - listMailMailgroupMember(mailgroup_id: string, query?: ListMailMailgroupMemberQuery): Promise - /** - * 批量创建邮件组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create - */ - batchCreateMailMailgroupMember(mailgroup_id: string, params: BatchCreateMailMailgroupMemberRequest, query?: BatchCreateMailMailgroupMemberQuery): Promise - /** - * 批量删除邮件组成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_delete - */ - batchDeleteMailMailgroupMember(mailgroup_id: string, params: BatchDeleteMailMailgroupMemberRequest): Promise - /** - * 创建邮件组别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/create - */ - createMailMailgroupAlias(mailgroup_id: string, params: CreateMailMailgroupAliasRequest): Promise - /** - * 删除邮件组别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/delete - */ - deleteMailMailgroupAlias(mailgroup_id: string, alias_id: string): Promise - /** - * 获取邮件组所有别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/list - */ - listMailMailgroupAlias(mailgroup_id: string): Promise - /** - * 创建邮件组权限成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/create - */ - createMailMailgroupPermissionMember(mailgroup_id: string, params: CreateMailMailgroupPermissionMemberRequest, query?: CreateMailMailgroupPermissionMemberQuery): Promise - /** - * 删除邮件组权限成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/delete - */ - deleteMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string): Promise - /** - * 获取邮件组权限成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/get - */ - getMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string, query?: GetMailMailgroupPermissionMemberQuery): Promise - /** - * 批量获取邮件组权限成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list - */ - listMailMailgroupPermissionMember(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery): Promise - /** - * 批量创建邮件组权限成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create - */ - batchCreateMailMailgroupPermissionMember(mailgroup_id: string, params: BatchCreateMailMailgroupPermissionMemberRequest, query?: BatchCreateMailMailgroupPermissionMemberQuery): Promise - /** - * 批量删除邮件组权限成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_delete - */ - batchDeleteMailMailgroupPermissionMember(mailgroup_id: string, params: BatchDeleteMailMailgroupPermissionMemberRequest): Promise - /** - * 创建公共邮箱 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/create - */ - createMailPublicMailbox(params: CreateMailPublicMailboxRequest): Promise - /** - * 修改公共邮箱部分信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/patch - */ - patchMailPublicMailbox(public_mailbox_id: string, params: PatchMailPublicMailboxRequest): Promise - /** - * 修改公共邮箱全部信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/update - */ - updateMailPublicMailbox(public_mailbox_id: string, params: UpdateMailPublicMailboxRequest): Promise - /** - * 查询指定公共邮箱 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/get - */ - getMailPublicMailbox(public_mailbox_id: string): Promise - /** - * 查询所有公共邮箱 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list - */ - listMailPublicMailbox(query?: ListMailPublicMailboxQuery): Promise - /** - * 永久删除公共邮箱 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete - */ - deleteMailPublicMailbox(public_mailbox_id: string): Promise - /** - * 添加公共邮箱成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/create - */ - createMailPublicMailboxMember(public_mailbox_id: string, params: CreateMailPublicMailboxMemberRequest, query?: CreateMailPublicMailboxMemberQuery): Promise - /** - * 删除公共邮箱单个成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/delete - */ - deleteMailPublicMailboxMember(public_mailbox_id: string, member_id: string): Promise - /** - * 删除公共邮箱所有成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/clear - */ - clearMailPublicMailboxMember(public_mailbox_id: string): Promise - /** - * 查询指定公共邮箱成员信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/get - */ - getMailPublicMailboxMember(public_mailbox_id: string, member_id: string, query?: GetMailPublicMailboxMemberQuery): Promise - /** - * 查询所有公共邮箱成员信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list - */ - listMailPublicMailboxMember(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery): Promise - /** - * 批量添加公共邮箱成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create - */ - batchCreateMailPublicMailboxMember(public_mailbox_id: string, params: BatchCreateMailPublicMailboxMemberRequest, query?: BatchCreateMailPublicMailboxMemberQuery): Promise - /** - * 批量删除公共邮箱成员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_delete - */ - batchDeleteMailPublicMailboxMember(public_mailbox_id: string, params: BatchDeleteMailPublicMailboxMemberRequest): Promise - /** - * 创建公共邮箱别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/create - */ - createMailPublicMailboxAlias(public_mailbox_id: string, params: CreateMailPublicMailboxAliasRequest): Promise - /** - * 删除公共邮箱别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/delete - */ - deleteMailPublicMailboxAlias(public_mailbox_id: string, alias_id: string): Promise - /** - * 查询公共邮箱的所有别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/list - */ - listMailPublicMailboxAlias(public_mailbox_id: string): Promise - /** - * 从回收站删除用户邮箱地址 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox/delete - */ - deleteMailUserMailbox(user_mailbox_id: string, query?: DeleteMailUserMailboxQuery): Promise - /** - * 创建用户邮箱别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/create - */ - createMailUserMailboxAlias(user_mailbox_id: string, params: CreateMailUserMailboxAliasRequest): Promise - /** - * 删除用户邮箱别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/delete - */ - deleteMailUserMailboxAlias(user_mailbox_id: string, alias_id: string): Promise - /** - * 获取用户邮箱所有别名 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/list - */ - listMailUserMailboxAlias(user_mailbox_id: string, query?: ListMailUserMailboxAliasQuery): Promise - /** - * 查询邮箱地址状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user/query - */ - queryMailUser(params: QueryMailUserRequest): Promise - /** - * 获取应用信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/get - */ - getApplication(app_id: string, query?: GetApplicationQuery): Promise - /** - * 获取应用版本信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/get - */ - getApplicationApplicationAppVersion(app_id: string, version_id: string, query?: GetApplicationApplicationAppVersionQuery): Promise - /** - * 获取应用版本列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list - */ - listApplicationApplicationAppVersion(app_id: string, query?: ListApplicationApplicationAppVersionQuery): Promise - /** - * 获取应用版本中开发者申请的通讯录权限范围 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/contacts_range_suggest - */ - contactsRangeSuggestApplicationApplicationAppVersion(app_id: string, version_id: string, query?: ContactsRangeSuggestApplicationApplicationAppVersionQuery): Promise - /** - * 查看待审核的应用列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist - */ - underauditlistApplication(query?: UnderauditlistApplicationQuery): Promise - /** - * 更新应用审核状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/patch - */ - patchApplicationApplicationAppVersion(app_id: string, version_id: string, params: PatchApplicationApplicationAppVersionRequest, query?: PatchApplicationApplicationAppVersionQuery): Promise - /** - * 更新应用分组信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/patch - */ - patchApplication(app_id: string, params: PatchApplicationRequest, query?: PatchApplicationQuery): Promise - /** - * 获取应用通讯录权限范围配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration - */ - contactsRangeConfigurationApplication(app_id: string, query?: ContactsRangeConfigurationApplicationQuery): Promise - /** - * 更新应用通讯录权限范围配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-contacts_range/patch - */ - patchApplicationApplicationContactsRange(app_id: string, params: PatchApplicationApplicationContactsRangeRequest, query?: PatchApplicationApplicationContactsRangeQuery): Promise - /** - * 查询用户或部门是否在应用的可用或禁用名单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/check_white_black_list - */ - checkWhiteBlackListApplicationApplicationVisibility(app_id: string, params: CheckWhiteBlackListApplicationApplicationVisibilityRequest, query?: CheckWhiteBlackListApplicationApplicationVisibilityQuery): Promise - /** - * 更新应用可用范围 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/patch - */ - patchApplicationApplicationVisibility(app_id: string, params: PatchApplicationApplicationVisibilityRequest, query?: PatchApplicationApplicationVisibilityQuery): Promise - /** - * 启停用应用 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-management/update - */ - updateApplicationApplicationManagement(app_id: string, params: UpdateApplicationApplicationManagementRequest): Promise - /** - * 获取多部门应用使用概览 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/department_overview - */ - departmentOverviewApplicationApplicationAppUsage(app_id: string, params: DepartmentOverviewApplicationApplicationAppUsageRequest, query?: DepartmentOverviewApplicationApplicationAppUsageQuery): Promise - /** - * 获取应用使用概览 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/overview - */ - overviewApplicationApplicationAppUsage(app_id: string, params: OverviewApplicationApplicationAppUsageRequest, query?: OverviewApplicationApplicationAppUsageQuery): Promise - /** - * 更新应用反馈 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/patch - */ - patchApplicationApplicationFeedback(app_id: string, feedback_id: string, query?: PatchApplicationApplicationFeedbackQuery): Promise - /** - * 获取应用反馈列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/list - */ - listApplicationApplicationFeedback(app_id: string, query?: ListApplicationApplicationFeedbackQuery): Promise - /** - * 更新应用红点 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_badge/set - */ - setApplicationAppBadge(params: SetApplicationAppBadgeRequest, query?: SetApplicationAppBadgeQuery): Promise - /** - * 获取企业席位信息接口 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/tenant-v2/tenant-product_assign_info/query - */ - queryTenantTenantProductAssignInfo(): Promise - /** - * 获取企业信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/tenant-v2/tenant/query - */ - queryTenant(): Promise - /** - * 获取认证信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/verification-v1/verification/get - */ - getVerification(): Promise - /** - * 创建系统状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/create - */ - createPersonalSettingsSystemStatus(params: CreatePersonalSettingsSystemStatusRequest): Promise - /** - * 删除系统状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/delete - */ - deletePersonalSettingsSystemStatus(system_status_id: string): Promise - /** - * 修改系统状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/patch - */ - patchPersonalSettingsSystemStatus(system_status_id: string, params: PatchPersonalSettingsSystemStatusRequest): Promise - /** - * 获取系统状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list - */ - listPersonalSettingsSystemStatus(query?: ListPersonalSettingsSystemStatusQuery): Promise - /** - * 批量开启系统状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open - */ - batchOpenPersonalSettingsSystemStatus(system_status_id: string, params: BatchOpenPersonalSettingsSystemStatusRequest, query?: BatchOpenPersonalSettingsSystemStatusQuery): Promise - /** - * 批量关闭系统状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_close - */ - batchClosePersonalSettingsSystemStatus(system_status_id: string, params: BatchClosePersonalSettingsSystemStatusRequest, query?: BatchClosePersonalSettingsSystemStatusQuery): Promise - /** - * 搜索消息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/message/create - */ - createSearchMessage(params: CreateSearchMessageRequest, query?: CreateSearchMessageQuery): Promise - /** - * 搜索应用 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/app/create - */ - createSearchApp(params: CreateSearchAppRequest, query?: CreateSearchAppQuery): Promise - /** - * 创建数据源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/create - */ - createSearchDataSource(params: CreateSearchDataSourceRequest): Promise - /** - * 删除数据源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/delete - */ - deleteSearchDataSource(data_source_id: string): Promise - /** - * 修改数据源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/patch - */ - patchSearchDataSource(data_source_id: string, params: PatchSearchDataSourceRequest): Promise - /** - * 获取数据源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/get - */ - getSearchDataSource(data_source_id: string): Promise - /** - * 批量获取数据源 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/list - */ - listSearchDataSource(query?: ListSearchDataSourceQuery): Promise - /** - * 为指定数据项创建索引 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/create - */ - createSearchDataSourceItem(data_source_id: string, params: CreateSearchDataSourceItemRequest): Promise - /** - * 删除数据项 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/delete - */ - deleteSearchDataSourceItem(data_source_id: string, item_id: string): Promise - /** - * 查询指定数据项 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/get - */ - getSearchDataSourceItem(data_source_id: string, item_id: string): Promise - /** - * 创建数据范式 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/create - */ - createSearchSchema(params: CreateSearchSchemaRequest, query?: CreateSearchSchemaQuery): Promise - /** - * 删除数据范式 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/delete - */ - deleteSearchSchema(schema_id: string): Promise - /** - * 修改数据范式 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/patch - */ - patchSearchSchema(schema_id: string, params: PatchSearchSchemaRequest): Promise - /** - * 获取数据范式 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/get - */ - getSearchSchema(schema_id: string): Promise - /** - * 识别文件中的简历信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/resume/parse - */ - parseDocumentAiResume(form: ParseDocumentAiResumeForm): Promise - /** - * 识别文件中的机动车发票 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vehicle_invoice/recognize - */ - recognizeDocumentAiVehicleInvoice(form: RecognizeDocumentAiVehicleInvoiceForm): Promise - /** - * 识别文件中的健康证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/health_certificate/recognize - */ - recognizeDocumentAiHealthCertificate(form: RecognizeDocumentAiHealthCertificateForm): Promise - /** - * 识别文件中的港澳居民来往内地通行证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/hkm_mainland_travel_permit/recognize - */ - recognizeDocumentAiHkmMainlandTravelPermit(form: RecognizeDocumentAiHkmMainlandTravelPermitForm): Promise - /** - * 识别文件中的台湾居民来往大陆通行证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/tw_mainland_travel_permit/recognize - */ - recognizeDocumentAiTwMainlandTravelPermit(form: RecognizeDocumentAiTwMainlandTravelPermitForm): Promise - /** - * 识别文件中的中国护照 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/chinese_passport/recognize - */ - recognizeDocumentAiChinesePassport(form: RecognizeDocumentAiChinesePassportForm): Promise - /** - * 识别文件中的银行卡 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/bank_card/recognize - */ - recognizeDocumentAiBankCard(form: RecognizeDocumentAiBankCardForm): Promise - /** - * 识别文件中的行驶证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vehicle_license/recognize - */ - recognizeDocumentAiVehicleLicense(form: RecognizeDocumentAiVehicleLicenseForm): Promise - /** - * 识别文件中的火车票 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/train_invoice/recognize - */ - recognizeDocumentAiTrainInvoice(form: RecognizeDocumentAiTrainInvoiceForm): Promise - /** - * 识别文件中的出租车发票 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/taxi_invoice/recognize - */ - recognizeDocumentAiTaxiInvoice(form: RecognizeDocumentAiTaxiInvoiceForm): Promise - /** - * 识别文件中的身份证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/id_card/recognize - */ - recognizeDocumentAiIdCard(form: RecognizeDocumentAiIdCardForm): Promise - /** - * 识别文件中的食品生产许可证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/food_produce_license/recognize - */ - recognizeDocumentAiFoodProduceLicense(form: RecognizeDocumentAiFoodProduceLicenseForm): Promise - /** - * 识别文件中的食品经营许可证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/food_manage_license/recognize - */ - recognizeDocumentAiFoodManageLicense(form: RecognizeDocumentAiFoodManageLicenseForm): Promise - /** - * 识别文件中的驾驶证 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/driving_license/recognize - */ - recognizeDocumentAiDrivingLicense(form: RecognizeDocumentAiDrivingLicenseForm): Promise - /** - * 识别文件中的增值税发票 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vat_invoice/recognize - */ - recognizeDocumentAiVatInvoice(form: RecognizeDocumentAiVatInvoiceForm): Promise - /** - * 识别文件中的营业执照 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/business_license/recognize - */ - recognizeDocumentAiBusinessLicense(form: RecognizeDocumentAiBusinessLicenseForm): Promise - /** - * 提取文件中的合同字段 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/contract/field_extraction - */ - fieldExtractionDocumentAiContract(form: FieldExtractionDocumentAiContractForm): Promise - /** - * 识别文件中的名片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/business_card/recognize - */ - recognizeDocumentAiBusinessCard(form: RecognizeDocumentAiBusinessCardForm): Promise - /** - * 识别图片中的文字 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize - */ - basicRecognizeOpticalCharRecognitionImage(params: BasicRecognizeOpticalCharRecognitionImageRequest): Promise - /** - * 识别语音文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/file_recognize - */ - fileRecognizeSpeechToTextSpeech(params: FileRecognizeSpeechToTextSpeechRequest): Promise - /** - * 识别流式语音 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/stream_recognize - */ - streamRecognizeSpeechToTextSpeech(params: StreamRecognizeSpeechToTextSpeechRequest): Promise - /** - * 识别文本语种 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/detect - */ - detectTranslationText(params: DetectTranslationTextRequest): Promise - /** - * 翻译文本 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/translate - */ - translateTranslationText(params: TranslateTranslationTextRequest): Promise - /** - * 同意人工任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/agree - */ - agreeApaasApprovalTask(approval_task_id: string, params: AgreeApaasApprovalTaskRequest): Promise - /** - * 拒绝人工任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/reject - */ - rejectApaasApprovalTask(approval_task_id: string, params: RejectApaasApprovalTaskRequest): Promise - /** - * 转交人工任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/transfer - */ - transferApaasApprovalTask(approval_task_id: string, params: TransferApaasApprovalTaskRequest): Promise - /** - * 人工任务加签 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/add_assignee - */ - addAssigneeApaasApprovalTask(approval_task_id: string, params: AddAssigneeApaasApprovalTaskRequest): Promise - /** - * 重置用户的企业邮箱密码 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/password/reset - */ - resetAdminPassword(params: ResetAdminPasswordRequest, query?: ResetAdminPasswordQuery): Promise - /** - * 获取部门维度的用户活跃和功能使用数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list - */ - listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery): Promise - /** - * 获取用户维度的用户活跃和功能使用数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list - */ - listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery): Promise - /** - * 创建勋章 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create - */ - createAdminBadge(params: CreateAdminBadgeRequest): Promise - /** - * 修改勋章信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/update - */ - updateAdminBadge(badge_id: string, params: UpdateAdminBadgeRequest): Promise - /** - * 上传勋章图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge_image/create - */ - createAdminBadgeImage(form: CreateAdminBadgeImageForm): Promise - /** - * 获取勋章列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list - */ - listAdminBadge(query?: ListAdminBadgeQuery): Promise - /** - * 获取勋章详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get - */ - getAdminBadge(badge_id: string): Promise - /** - * 创建授予名单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/create - */ - createAdminBadgeGrant(badge_id: string, params: CreateAdminBadgeGrantRequest, query?: CreateAdminBadgeGrantQuery): Promise - /** - * 删除授予名单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/delete - */ - deleteAdminBadgeGrant(badge_id: string, grant_id: string): Promise - /** - * 修改授予名单 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/update - */ - updateAdminBadgeGrant(badge_id: string, grant_id: string, params: UpdateAdminBadgeGrantRequest, query?: UpdateAdminBadgeGrantQuery): Promise - /** - * 获取授予名单列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list - */ - listAdminBadgeGrant(badge_id: string, query?: ListAdminBadgeGrantQuery): Promise - /** - * 获取授予名单详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get - */ - getAdminBadgeGrant(badge_id: string, grant_id: string, query?: GetAdminBadgeGrantQuery): Promise - /** - * 批量获取员工花名册信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list - */ - listEhrEmployee(query?: ListEhrEmployeeQuery): Promise - /** - * 下载人员的附件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/attachment/get - */ - getEhrAttachment(token: string): Promise - /** - * 查询国籍信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search - */ - searchCorehrBasicInfoNationality(params: SearchCorehrBasicInfoNationalityRequest, query?: SearchCorehrBasicInfoNationalityQuery): Promise - /** - * 查询银行信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search - */ - searchCorehrBasicInfoBank(params: SearchCorehrBasicInfoBankRequest, query?: SearchCorehrBasicInfoBankQuery): Promise - /** - * 查询支行信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank_branch/search - */ - searchCorehrBasicInfoBankBranch(params: SearchCorehrBasicInfoBankBranchRequest, query?: SearchCorehrBasicInfoBankBranchQuery): Promise - /** - * 获取字段详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param - */ - getByParamCorehrCustomField(query?: GetByParamCorehrCustomFieldQuery): Promise - /** - * 获取自定义字段列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query - */ - queryCorehrCustomField(query?: QueryCorehrCustomFieldQuery): Promise - /** - * 获取飞书人事对象列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/list_object_api_name - */ - listObjectApiNameCorehrCustomField(query?: ListObjectApiNameCorehrCustomFieldQuery): Promise - /** - * 查询国家/地区信息v2 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search - */ - searchCorehrBasicInfoCountryRegion(params: SearchCorehrBasicInfoCountryRegionRequest, query?: SearchCorehrBasicInfoCountryRegionQuery): Promise - /** - * 查询省份/行政区信息v2 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search - */ - searchCorehrBasicInfoCountryRegionSubdivision(params: SearchCorehrBasicInfoCountryRegionSubdivisionRequest, query?: SearchCorehrBasicInfoCountryRegionSubdivisionQuery): Promise - /** - * 查询城市信息v2 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search - */ - searchCorehrBasicInfoCity(params: SearchCorehrBasicInfoCityRequest, query?: SearchCorehrBasicInfoCityQuery): Promise - /** - * 查询区/县信息v2 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search - */ - searchCorehrBasicInfoDistrict(params: SearchCorehrBasicInfoDistrictRequest, query?: SearchCorehrBasicInfoDistrictQuery): Promise - /** - * 创建人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/create - */ - createCorehrEmployeeType(params: CreateCorehrEmployeeTypeRequest, query?: CreateCorehrEmployeeTypeQuery): Promise - /** - * 删除人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/delete - */ - deleteCorehrEmployeeType(employee_type_id: string): Promise - /** - * 更新人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/patch - */ - patchCorehrEmployeeType(employee_type_id: string, params: PatchCorehrEmployeeTypeRequest, query?: PatchCorehrEmployeeTypeQuery): Promise - /** - * 查询单个人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get - */ - getCorehrEmployeeType(employee_type_id: string): Promise - /** - * 批量查询人员类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list - */ - listCorehrEmployeeType(query?: ListCorehrEmployeeTypeQuery): Promise - /** - * 创建国家证件类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/create - */ - createCorehrNationalIdType(params: CreateCorehrNationalIdTypeRequest, query?: CreateCorehrNationalIdTypeQuery): Promise - /** - * 删除国家证件类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/delete - */ - deleteCorehrNationalIdType(national_id_type_id: string): Promise - /** - * 更新国家证件类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/patch - */ - patchCorehrNationalIdType(national_id_type_id: string, params: PatchCorehrNationalIdTypeRequest, query?: PatchCorehrNationalIdTypeQuery): Promise - /** - * 查询单个国家证件类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/get - */ - getCorehrNationalIdType(national_id_type_id: string): Promise - /** - * 批量查询国家证件类型 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/list - */ - listCorehrNationalIdType(query?: ListCorehrNationalIdTypeQuery): Promise - /** - * 创建工时制度 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/create - */ - createCorehrWorkingHoursType(params: CreateCorehrWorkingHoursTypeRequest, query?: CreateCorehrWorkingHoursTypeQuery): Promise - /** - * 删除工时制度 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/delete - */ - deleteCorehrWorkingHoursType(working_hours_type_id: string): Promise - /** - * 更新工时制度 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/patch - */ - patchCorehrWorkingHoursType(working_hours_type_id: string, params: PatchCorehrWorkingHoursTypeRequest, query?: PatchCorehrWorkingHoursTypeQuery): Promise - /** - * 查询单个工时制度 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get - */ - getCorehrWorkingHoursType(working_hours_type_id: string): Promise - /** - * 批量查询工时制度 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list - */ - listCorehrWorkingHoursType(query?: ListCorehrWorkingHoursTypeQuery): Promise - /** - * 查询货币信息v2 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search - */ - searchCorehrBasicInfoCurrency(params: SearchCorehrBasicInfoCurrencyRequest, query?: SearchCorehrBasicInfoCurrencyQuery): Promise - /** - * 批量查询员工信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get - */ - batchGetCorehrEmployee(params: BatchGetCorehrEmployeeRequest, query?: BatchGetCorehrEmployeeQuery): Promise - /** - * 搜索员工信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search - */ - searchCorehrEmployee(params: SearchCorehrEmployeeRequest, query?: SearchCorehrEmployeeQuery): Promise - /** - * 创建雇佣信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/create - */ - createCorehrEmployment(params: CreateCorehrEmploymentRequest, query?: CreateCorehrEmploymentQuery): Promise - /** - * 更新雇佣信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/patch - */ - patchCorehrEmployment(employment_id: string, params: PatchCorehrEmploymentRequest, query?: PatchCorehrEmploymentQuery): Promise - /** - * 删除雇佣信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/delete - */ - deleteCorehrEmployment(employment_id: string, query?: DeleteCorehrEmploymentQuery): Promise - /** - * 创建个人信息（V2） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/create - */ - createCorehrPerson(params: CreateCorehrPersonRequest, query?: CreateCorehrPersonQuery): Promise - /** - * 更新个人信息（V2） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/patch - */ - patchCorehrPerson(person_id: string, params: PatchCorehrPersonRequest, query?: PatchCorehrPersonQuery): Promise - /** - * 删除个人信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/delete - */ - deleteCorehrPerson(person_id: string): Promise - /** - * 上传文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/upload - */ - uploadCorehrPerson(form: UploadCorehrPersonForm): Promise - /** - * 下载文件 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/file/get - */ - getCorehrFile(id: string): Promise - /** - * 创建任职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/create - */ - createCorehrJobData(params: CreateCorehrJobDataRequest, query?: CreateCorehrJobDataQuery): Promise - /** - * 删除任职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/delete - */ - deleteCorehrJobData(job_data_id: string): Promise - /** - * 更新任职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/patch - */ - patchCorehrJobData(job_data_id: string, params: PatchCorehrJobDataRequest, query?: PatchCorehrJobDataQuery): Promise - /** - * 查询单个任职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/get - */ - getCorehrJobData(job_data_id: string, query?: GetCorehrJobDataQuery): Promise - /** - * 获取任职信息列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/query - */ - queryCorehrEmployeesJobData(params: QueryCorehrEmployeesJobDataRequest, query?: QueryCorehrEmployeesJobDataQuery): Promise - /** - * 批量查询员工任职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/batch_get - */ - batchGetCorehrEmployeesJobData(params: BatchGetCorehrEmployeesJobDataRequest, query?: BatchGetCorehrEmployeesJobDataQuery): Promise - /** - * 批量查询任职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/list - */ - listCorehrJobData(query?: ListCorehrJobDataQuery): Promise - /** - * 获取父部门信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/parents - */ - parentsCorehrDepartment(params: ParentsCorehrDepartmentRequest, query?: ParentsCorehrDepartmentQuery): Promise - /** - * 搜索部门信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search - */ - searchCorehrDepartment(params: SearchCorehrDepartmentRequest, query?: SearchCorehrDepartmentQuery): Promise - /** - * 创建部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/create - */ - createCorehrDepartment(params: CreateCorehrDepartmentRequest, query?: CreateCorehrDepartmentQuery): Promise - /** - * 更新部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/patch - */ - patchCorehrDepartment(department_id: string, params: PatchCorehrDepartmentRequest, query?: PatchCorehrDepartmentQuery): Promise - /** - * 删除部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/delete - */ - deleteCorehrDepartment(department_id: string): Promise - /** - * 查询单个部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get - */ - getCorehrDepartment(department_id: string, query?: GetCorehrDepartmentQuery): Promise - /** - * 批量查询部门（ V2） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get - */ - batchGetCorehrDepartment(params: BatchGetCorehrDepartmentRequest, query?: BatchGetCorehrDepartmentQuery): Promise - /** - * 批量查询部门 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/list - */ - listCorehrDepartment(query?: ListCorehrDepartmentQuery): Promise - /** - * 通过地点 ID 批量获取地点信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/batch_get - */ - batchGetCorehrLocation(params: BatchGetCorehrLocationRequest): Promise - /** - * 创建地点 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create - */ - createCorehrLocation(params: CreateCorehrLocationRequest, query?: CreateCorehrLocationQuery): Promise - /** - * 删除地点 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/delete - */ - deleteCorehrLocation(location_id: string): Promise - /** - * 查询单个地点 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get - */ - getCorehrLocation(location_id: string): Promise - /** - * 批量查询地点 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list - */ - listCorehrLocation(query?: ListCorehrLocationQuery): Promise - /** - * 查询单个公司 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get - */ - getCorehrCompany(company_id: string): Promise - /** - * 批量查询公司 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list - */ - listCorehrCompany(query?: ListCorehrCompanyQuery): Promise - /** - * 通过公司 ID 批量获取公司信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/batch_get - */ - batchGetCorehrCompany(params: BatchGetCorehrCompanyRequest): Promise - /** - * 创建公司 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/create - */ - createCorehrCompany(params: CreateCorehrCompanyRequest, query?: CreateCorehrCompanyQuery): Promise - /** - * 更新公司 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/patch - */ - patchCorehrCompany(company_id: string, params: PatchCorehrCompanyRequest, query?: PatchCorehrCompanyQuery): Promise - /** - * 删除公司 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/delete - */ - deleteCorehrCompany(company_id: string): Promise - /** - * 创建成本中心 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/create - */ - createCorehrCostCenter(params: CreateCorehrCostCenterRequest, query?: CreateCorehrCostCenterQuery): Promise - /** - * 启用 / 停用成本中心 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/patch - */ - patchCorehrCostCenter(cost_center_id: string, params: PatchCorehrCostCenterRequest, query?: PatchCorehrCostCenterQuery): Promise - /** - * 删除成本中心 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/delete - */ - deleteCorehrCostCenter(cost_center_id: string, params: DeleteCorehrCostCenterRequest): Promise - /** - * 搜索成本中心信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search - */ - searchCorehrCostCenter(params: SearchCorehrCostCenterRequest, query?: SearchCorehrCostCenterQuery): Promise - /** - * 创建成本中心版本 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/create - */ - createCorehrCostCenterVersion(cost_center_id: string, params: CreateCorehrCostCenterVersionRequest, query?: CreateCorehrCostCenterVersionQuery): Promise - /** - * 更新成本中心版本 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/patch - */ - patchCorehrCostCenterVersion(cost_center_id: string, version_id: string, params: PatchCorehrCostCenterVersionRequest, query?: PatchCorehrCostCenterVersionQuery): Promise - /** - * 删除成本中心版本 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/delete - */ - deleteCorehrCostCenterVersion(cost_center_id: string, version_id: string, params: DeleteCorehrCostCenterVersionRequest): Promise - /** - * 通过职级 ID 批量获取职级信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_level/batch_get - */ - batchGetCorehrJobLevel(params: BatchGetCorehrJobLevelRequest): Promise - /** - * 创建职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/create - */ - createCorehrJobLevel(params: CreateCorehrJobLevelRequest, query?: CreateCorehrJobLevelQuery): Promise - /** - * 删除职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/delete - */ - deleteCorehrJobLevel(job_level_id: string): Promise - /** - * 更新职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/patch - */ - patchCorehrJobLevel(job_level_id: string, params: PatchCorehrJobLevelRequest, query?: PatchCorehrJobLevelQuery): Promise - /** - * 查询单个职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get - */ - getCorehrJobLevel(job_level_id: string): Promise - /** - * 批量查询职级 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list - */ - listCorehrJobLevel(query?: ListCorehrJobLevelQuery): Promise - /** - * 通过序列 ID 批量获取序列信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_family/batch_get - */ - batchGetCorehrJobFamily(params: BatchGetCorehrJobFamilyRequest): Promise - /** - * 创建序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/create - */ - createCorehrJobFamily(params: CreateCorehrJobFamilyRequest, query?: CreateCorehrJobFamilyQuery): Promise - /** - * 删除序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/delete - */ - deleteCorehrJobFamily(job_family_id: string): Promise - /** - * 更新序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/patch - */ - patchCorehrJobFamily(job_family_id: string, params: PatchCorehrJobFamilyRequest, query?: PatchCorehrJobFamilyQuery): Promise - /** - * 查询单个序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get - */ - getCorehrJobFamily(job_family_id: string): Promise - /** - * 批量查询序列 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list - */ - listCorehrJobFamily(query?: ListCorehrJobFamilyQuery): Promise - /** - * 创建职务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/create - */ - createCorehrJob(params: CreateCorehrJobRequest, query?: CreateCorehrJobQuery): Promise - /** - * 删除职务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/delete - */ - deleteCorehrJob(job_id: string): Promise - /** - * 更新职务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/patch - */ - patchCorehrJob(job_id: string, params: PatchCorehrJobRequest, query?: PatchCorehrJobQuery): Promise - /** - * 查询单个职务（V2） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/get - */ - getCorehrJob(job_id: string): Promise - /** - * 批量查询职务（V2) - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list - */ - listCorehrJob(query?: ListCorehrJobQuery): Promise - /** - * 查询单个职务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get - */ - getCorehrJob(job_id: string): Promise - /** - * 批量查询职务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/list - */ - listCorehrJob(query?: ListCorehrJobQuery): Promise - /** - * 创建待入职人员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/create - */ - createCorehrPreHire(params: CreateCorehrPreHireRequest): Promise - /** - * 更新待入职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/patch - */ - patchCorehrPreHire(pre_hire_id: string, params: PatchCorehrPreHireRequest, query?: PatchCorehrPreHireQuery): Promise - /** - * 删除待入职人员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/delete - */ - deleteCorehrPreHire(pre_hire_id: string): Promise - /** - * 查询单个待入职人员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/get - */ - getCorehrPreHire(pre_hire_id: string): Promise - /** - * 批量查询待入职人员 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/list - */ - listCorehrPreHire(query?: ListCorehrPreHireQuery): Promise - /** - * 搜索合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/contract/search - */ - searchCorehrContract(params: SearchCorehrContractRequest, query?: SearchCorehrContractQuery): Promise - /** - * 创建合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/create - */ - createCorehrContract(params: CreateCorehrContractRequest, query?: CreateCorehrContractQuery): Promise - /** - * 删除合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/delete - */ - deleteCorehrContract(contract_id: string): Promise - /** - * 更新合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/patch - */ - patchCorehrContract(contract_id: string, params: PatchCorehrContractRequest, query?: PatchCorehrContractQuery): Promise - /** - * 查询单个合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/get - */ - getCorehrContract(contract_id: string): Promise - /** - * 批量查询合同 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list - */ - listCorehrContract(query?: ListCorehrContractQuery): Promise - /** - * 搜索试用期信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search - */ - searchCorehrProbation(params: SearchCorehrProbationRequest, query?: SearchCorehrProbationQuery): Promise - /** - * 启用/停用试用期考核功能 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/enable_disable_assessment - */ - enableDisableAssessmentCorehrProbation(params: EnableDisableAssessmentCorehrProbationRequest): Promise - /** - * 新增试用期考核信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/create - */ - createCorehrProbationAssessment(params: CreateCorehrProbationAssessmentRequest, query?: CreateCorehrProbationAssessmentQuery): Promise - /** - * 更新试用期考核信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/patch - */ - patchCorehrProbationAssessment(assessment_id: string, params: PatchCorehrProbationAssessmentRequest, query?: PatchCorehrProbationAssessmentQuery): Promise - /** - * 删除试用期考核信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/delete - */ - deleteCorehrProbationAssessment(assessment_id: string): Promise - /** - * 获取异动原因列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_reason/query - */ - queryCorehrTransferReason(query?: QueryCorehrTransferReasonQuery): Promise - /** - * 获取异动类型列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query - */ - queryCorehrTransferType(query?: QueryCorehrTransferTypeQuery): Promise - /** - * 发起员工异动 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/create - */ - createCorehrJobChange(params: CreateCorehrJobChangeRequest, query?: CreateCorehrJobChangeQuery): Promise - /** - * 搜索员工异动信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search - */ - searchCorehrJobChange(params: SearchCorehrJobChangeRequest, query?: SearchCorehrJobChangeQuery): Promise - /** - * 查询员工离职原因列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query - */ - queryCorehrOffboarding(params: QueryCorehrOffboardingRequest): Promise - /** - * 操作员工离职 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/submit - */ - submitCorehrOffboarding(params: SubmitCorehrOffboardingRequest, query?: SubmitCorehrOffboardingQuery): Promise - /** - * 搜索离职信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/search - */ - searchCorehrOffboarding(params: SearchCorehrOffboardingRequest, query?: SearchCorehrOffboardingQuery): Promise - /** - * 创建假期发放记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave_granting_record/create - */ - createCorehrLeaveGrantingRecord(params: CreateCorehrLeaveGrantingRecordRequest, query?: CreateCorehrLeaveGrantingRecordQuery): Promise - /** - * 删除假期发放记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave_granting_record/delete - */ - deleteCorehrLeaveGrantingRecord(leave_granting_record_id: string): Promise - /** - * 获取假期类型列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_types - */ - leaveTypesCorehrLeave(query?: LeaveTypesCorehrLeaveQuery): Promise - /** - * 批量查询员工假期余额 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_balances - */ - leaveBalancesCorehrLeave(query?: LeaveBalancesCorehrLeaveQuery): Promise - /** - * 批量查询员工请假记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_request_history - */ - leaveRequestHistoryCorehrLeave(query?: LeaveRequestHistoryCorehrLeaveQuery): Promise - /** - * 查询员工 HRBP / 属地 BP - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-bp/batch_get - */ - batchGetCorehrEmployeesBp(params: BatchGetCorehrEmployeesBpRequest, query?: BatchGetCorehrEmployeesBpQuery): Promise - /** - * 查询部门 HRBP - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/get_by_department - */ - getByDepartmentCorehrBp(params: GetByDepartmentCorehrBpRequest, query?: GetByDepartmentCorehrBpQuery): Promise - /** - * 获取 HRBP 列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/list - */ - listCorehrBp(query?: ListCorehrBpQuery): Promise - /** - * 查询部门 / 地点的 HRBP / 属地 BP - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/query - */ - queryCorehrSecurityGroup(params: QueryCorehrSecurityGroupRequest, query?: QueryCorehrSecurityGroupQuery): Promise - /** - * 获取组织类角色授权列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/assigned_user/search - */ - searchCorehrAssignedUser(params: SearchCorehrAssignedUserRequest, query?: SearchCorehrAssignedUserQuery): Promise - /** - * 批量获取角色列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/list - */ - listCorehrSecurityGroup(query?: ListCorehrSecurityGroupQuery): Promise - /** - * 查询流程实例列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/list - */ - listCorehrProcess(query?: ListCorehrProcessQuery): Promise - /** - * 获取单个流程详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/get - */ - getCorehrProcess(process_id: string, query?: GetCorehrProcessQuery): Promise - /** - * 获取流程表单数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/process-form_variable_data/get - */ - getCorehrProcessFormVariableData(process_id: string): Promise - /** - * 获取员工薪资标准 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/compensation_standard/match - */ - matchCorehrCompensationStandard(query?: MatchCorehrCompensationStandardQuery): Promise - /** - * 新建职位 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_create - */ - combinedCreateHireJob(params: CombinedCreateHireJobRequest, query?: CombinedCreateHireJobQuery): Promise - /** - * 获取职位信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/get - */ - getHireJob(job_id: string, query?: GetHireJobQuery): Promise - /** - * 获取职位设置 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/config - */ - configHireJob(job_id: string, query?: ConfigHireJobQuery): Promise - /** - * 获取职位列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/list - */ - listHireJob(query?: ListHireJobQuery): Promise - /** - * 更新职位 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_update - */ - combinedUpdateHireJob(job_id: string, params: CombinedUpdateHireJobRequest, query?: CombinedUpdateHireJobQuery): Promise - /** - * 更新职位设置 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/update_config - */ - updateConfigHireJob(job_id: string, params: UpdateConfigHireJobRequest, query?: UpdateConfigHireJobQuery): Promise - /** - * 获取职位类别列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_type/list - */ - listHireJobType(query?: ListHireJobTypeQuery): Promise - /** - * 获取职位上的招聘人员信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/recruiter - */ - recruiterHireJob(job_id: string, query?: RecruiterHireJobQuery): Promise - /** - * 创建招聘需求 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/create - */ - createHireJobRequirement(params: CreateHireJobRequirementRequest, query?: CreateHireJobRequirementQuery): Promise - /** - * 获取招聘需求列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list - */ - listHireJobRequirement(query?: ListHireJobRequirementQuery): Promise - /** - * 更新招聘需求 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/update - */ - updateHireJobRequirement(job_requirement_id: string, params: UpdateHireJobRequirementRequest, query?: UpdateHireJobRequirementQuery): Promise - /** - * 删除招聘需求 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/delete - */ - deleteHireJobRequirement(job_requirement_id: string): Promise - /** - * 获取招聘需求模板 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement_schema/list - */ - listHireJobRequirementSchema(query?: ListHireJobRequirementSchemaQuery): Promise - /** - * 获取招聘流程信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list - */ - listHireJobProcess(query?: ListHireJobProcessQuery): Promise - /** - * 获取信息登记表模板列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/registration_schema/list - */ - listHireRegistrationSchema(query?: ListHireRegistrationSchemaQuery): Promise - /** - * 获取内推官网下的职位列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/list - */ - listHireReferralWebsiteJobPost(query?: ListHireReferralWebsiteJobPostQuery): Promise - /** - * 获取内推官网下职位广告详情 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/get - */ - getHireReferralWebsiteJobPost(job_post_id: string, query?: GetHireReferralWebsiteJobPostQuery): Promise - /** - * 获取内推信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral/get_by_application - */ - getByApplicationHireReferral(query?: GetByApplicationHireReferralQuery): Promise - /** - * 创建外部投递 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/create - */ - createHireExternalApplication(params: CreateHireExternalApplicationRequest): Promise - /** - * 更新外部投递 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/update - */ - updateHireExternalApplication(external_application_id: string, params: UpdateHireExternalApplicationRequest): Promise - /** - * 删除外部投递 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/delete - */ - deleteHireExternalApplication(external_application_id: string, query?: DeleteHireExternalApplicationQuery): Promise - /** - * 创建外部面试 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/create - */ - createHireExternalInterview(params: CreateHireExternalInterviewRequest): Promise - /** - * 创建外部面评 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview_assessment/create - */ - createHireExternalInterviewAssessment(params: CreateHireExternalInterviewAssessmentRequest): Promise - /** - * 创建外部背调 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/create - */ - createHireExternalBackgroundCheck(params: CreateHireExternalBackgroundCheckRequest): Promise - /** - * 将人才加入指定文件夹 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/add_to_folder - */ - addToFolderHireTalent(params: AddToFolderHireTalentRequest): Promise - /** - * 获取人才文件夹信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_folder/list - */ - listHireTalentFolder(query?: ListHireTalentFolderQuery): Promise - /** - * 通过手机号或邮箱获取人才 ID - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/batch_get_id - */ - batchGetIdHireTalent(params: BatchGetIdHireTalentRequest): Promise - /** - * 获取人才列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/list - */ - listHireTalent(query?: ListHireTalentQuery): Promise - /** - * 获取人才字段 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query - */ - queryHireTalentObject(): Promise - /** - * 获取人才信息 V1 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/get - */ - getHireTalent(talent_id: string, query?: GetHireTalentQuery): Promise - /** - * 创建投递 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/create - */ - createHireApplication(params: CreateHireApplicationRequest): Promise - /** - * 终止投递 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/terminate - */ - terminateHireApplication(application_id: string, params: TerminateHireApplicationRequest): Promise - /** - * 获取投递信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get - */ - getHireApplication(application_id: string): Promise - /** - * 获取投递列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list - */ - listHireApplication(query?: ListHireApplicationQuery): Promise - /** - * 获取简历评估信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation/list - */ - listHireEvaluation(query?: ListHireEvaluationQuery): Promise - /** - * 获取面试满意度问卷列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/questionnaire/list - */ - listHireQuestionnaire(query?: ListHireQuestionnaireQuery): Promise - /** - * 获取面试信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/list - */ - listHireInterview(query?: ListHireInterviewQuery): Promise - /** - * 创建 Offer - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/create - */ - createHireOffer(params: CreateHireOfferRequest, query?: CreateHireOfferQuery): Promise - /** - * 更新 Offer 信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/update - */ - updateHireOffer(offer_id: string, params: UpdateHireOfferRequest, query?: UpdateHireOfferQuery): Promise - /** - * 获取 Offer 信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/offer - */ - offerHireApplication(application_id: string, query?: OfferHireApplicationQuery): Promise - /** - * 获取 Offer 详情 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/get - */ - getHireOffer(offer_id: string, query?: GetHireOfferQuery): Promise - /** - * 获取 Offer 列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/list - */ - listHireOffer(query?: ListHireOfferQuery): Promise - /** - * 更新 Offer 状态 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/offer_status - */ - offerStatusHireOffer(offer_id: string, params: OfferStatusHireOfferRequest): Promise - /** - * 更新实习 Offer 入/离职状态 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/intern_offer_status - */ - internOfferStatusHireOffer(offer_id: string, params: InternOfferStatusHireOfferRequest): Promise - /** - * 更新 e-HR 导入任务结果 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/ehr_import_task/patch - */ - patchHireEhrImportTask(ehr_import_task_id: string, params: PatchHireEhrImportTaskRequest): Promise - /** - * 操作候选人入职 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/transfer_onboard - */ - transferOnboardHireApplication(application_id: string, params: TransferOnboardHireApplicationRequest, query?: TransferOnboardHireApplicationQuery): Promise - /** - * 更新入职状态 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/patch - */ - patchHireEmployee(employee_id: string, params: PatchHireEmployeeRequest, query?: PatchHireEmployeeQuery): Promise - /** - * 通过投递 ID 获取入职信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get_by_application - */ - getByApplicationHireEmployee(query?: GetByApplicationHireEmployeeQuery): Promise - /** - * 通过员工 ID 获取入职信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get - */ - getHireEmployee(employee_id: string, query?: GetHireEmployeeQuery): Promise - /** - * 创建备注 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/create - */ - createHireNote(params: CreateHireNoteRequest, query?: CreateHireNoteQuery): Promise - /** - * 更新备注 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/patch - */ - patchHireNote(note_id: string, params: PatchHireNoteRequest, query?: PatchHireNoteQuery): Promise - /** - * 获取备注 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/get - */ - getHireNote(note_id: string, query?: GetHireNoteQuery): Promise - /** - * 获取备注列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/list - */ - listHireNote(query?: ListHireNoteQuery): Promise - /** - * 获取简历来源列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/resume_source/list - */ - listHireResumeSource(query?: ListHireResumeSourceQuery): Promise - /** - * 创建账号自定义字段 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/create - */ - createHireEcoAccountCustomField(params: CreateHireEcoAccountCustomFieldRequest): Promise - /** - * 更新账号自定义字段 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/batch_update - */ - batchUpdateHireEcoAccountCustomField(params: BatchUpdateHireEcoAccountCustomFieldRequest): Promise - /** - * 删除账号自定义字段 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/batch_delete - */ - batchDeleteHireEcoAccountCustomField(params: BatchDeleteHireEcoAccountCustomFieldRequest): Promise - /** - * 推送背调自定义字段 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/create - */ - createHireEcoBackgroundCheckCustomField(params: CreateHireEcoBackgroundCheckCustomFieldRequest): Promise - /** - * 更新背调自定义字段 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/batch_update - */ - batchUpdateHireEcoBackgroundCheckCustomField(params: BatchUpdateHireEcoBackgroundCheckCustomFieldRequest): Promise - /** - * 删除背调自定义字段 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/batch_delete - */ - batchDeleteHireEcoBackgroundCheckCustomField(params: BatchDeleteHireEcoBackgroundCheckCustomFieldRequest): Promise - /** - * 创建背调套餐和附加调查项 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/create - */ - createHireEcoBackgroundCheckPackage(params: CreateHireEcoBackgroundCheckPackageRequest): Promise - /** - * 更新背调套餐和附加调查项 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/batch_update - */ - batchUpdateHireEcoBackgroundCheckPackage(params: BatchUpdateHireEcoBackgroundCheckPackageRequest): Promise - /** - * 删除背调套餐和附加调查项 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/batch_delete - */ - batchDeleteHireEcoBackgroundCheckPackage(params: BatchDeleteHireEcoBackgroundCheckPackageRequest): Promise - /** - * 更新背调订单进度 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_progress - */ - updateProgressHireEcoBackgroundCheck(params: UpdateProgressHireEcoBackgroundCheckRequest): Promise - /** - * 回传背调订单的最终结果 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_result - */ - updateResultHireEcoBackgroundCheck(params: UpdateResultHireEcoBackgroundCheckRequest): Promise - /** - * 终止背调订单 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/cancel - */ - cancelHireEcoBackgroundCheck(params: CancelHireEcoBackgroundCheckRequest): Promise - /** - * 推送试卷列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/create - */ - createHireEcoExamPaper(params: CreateHireEcoExamPaperRequest): Promise - /** - * 更新试卷 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/batch_update - */ - batchUpdateHireEcoExamPaper(params: BatchUpdateHireEcoExamPaperRequest): Promise - /** - * 删除试卷 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/batch_delete - */ - batchDeleteHireEcoExamPaper(params: BatchDeleteHireEcoExamPaperRequest): Promise - /** - * 回传笔试安排结果 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam/login_info - */ - loginInfoHireEcoExam(exam_id: string, params: LoginInfoHireEcoExamRequest): Promise - /** - * 回传笔试结果 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam/update_result - */ - updateResultHireEcoExam(exam_id: string, params: UpdateResultHireEcoExamRequest): Promise - /** - * 注册外部系统内推账户 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/create - */ - createHireReferralAccount(params: CreateHireReferralAccountRequest): Promise - /** - * 停用外部系统内推账户 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/deactivate - */ - deactivateHireReferralAccount(referral_account_id: string): Promise - /** - * 全额提取内推账号余额 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/withdraw - */ - withdrawHireReferralAccount(referral_account_id: string, params: WithdrawHireReferralAccountRequest): Promise - /** - * 内推账号提现对账接口 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/reconciliation - */ - reconciliationHireReferralAccount(params: ReconciliationHireReferralAccountRequest): Promise - /** - * 获取附件信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/attachment/get - */ - getHireAttachment(attachment_id: string, query?: GetHireAttachmentQuery): Promise - /** - * 获取附件预览信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/attachment/preview - */ - previewHireAttachment(attachment_id: string): Promise - /** - * 创建 OKR 周期 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create - */ - createOkrPeriod(params: CreateOkrPeriodRequest): Promise - /** - * 修改 OKR 周期状态 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch - */ - patchOkrPeriod(period_id: string, params: PatchOkrPeriodRequest): Promise - /** - * 获取 OKR 周期列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list - */ - listOkrPeriod(query?: ListOkrPeriodQuery): Promise - /** - * 获取 OKR 周期规则 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list - */ - listOkrPeriodRule(): Promise - /** - * 获取用户的 OKR 列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list - */ - listOkrUserOkr(user_id: string, query?: ListOkrUserOkrQuery): Promise - /** - * 批量获取 OKR - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/okr/batch_get - */ - batchGetOkr(query?: BatchGetOkrQuery): Promise - /** - * 创建 OKR 进展记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create - */ - createOkrProgressRecord(params: CreateOkrProgressRecordRequest, query?: CreateOkrProgressRecordQuery): Promise - /** - * 删除 OKR 进展记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete - */ - deleteOkrProgressRecord(progress_id: string): Promise - /** - * 更新 OKR 进展记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update - */ - updateOkrProgressRecord(progress_id: string, params: UpdateOkrProgressRecordRequest, query?: UpdateOkrProgressRecordQuery): Promise - /** - * 获取 OKR 进展记录 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get - */ - getOkrProgressRecord(progress_id: string, query?: GetOkrProgressRecordQuery): Promise - /** - * 上传进展记录图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload - */ - uploadOkrImage(form: UploadOkrImageForm): Promise - /** - * 录入身份信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/human_authentication-v1/identity/create - */ - createHumanAuthenticationIdentity(params: CreateHumanAuthenticationIdentityRequest, query?: CreateHumanAuthenticationIdentityQuery): Promise - /** - * 删除访客 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete - */ - deleteAcsVisitor(visitor_id: string, query?: DeleteAcsVisitorQuery): Promise - /** - * 添加访客 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create - */ - createAcsVisitor(params: CreateAcsVisitorRequest, query?: CreateAcsVisitorQuery): Promise - /** - * 设备绑定权限组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind - */ - deviceBindAcsRuleExternal(params: DeviceBindAcsRuleExternalRequest): Promise - /** - * 获取权限组信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get - */ - getAcsRuleExternal(query?: GetAcsRuleExternalQuery): Promise - /** - * 删除权限组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete - */ - deleteAcsRuleExternal(query?: DeleteAcsRuleExternalQuery): Promise - /** - * 创建或更新权限组 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create - */ - createAcsRuleExternal(params: CreateAcsRuleExternalRequest, query?: CreateAcsRuleExternalQuery): Promise - /** - * 修改用户部分信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch - */ - patchAcsUser(user_id: string, params: PatchAcsUserRequest, query?: PatchAcsUserQuery): Promise - /** - * 获取单个用户信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get - */ - getAcsUser(user_id: string, query?: GetAcsUserQuery): Promise - /** - * 获取用户列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list - */ - listAcsUser(query?: ListAcsUserQuery): Promise - /** - * 上传人脸图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update - */ - updateAcsUserFace(user_id: string, form: FormData, query?: UpdateAcsUserFaceQuery): Promise - /** - * 下载人脸图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get - */ - getAcsUserFace(user_id: string, query?: GetAcsUserFaceQuery): Promise - /** - * 获取门禁设备列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list - */ - listAcsDevice(): Promise - /** - * 获取门禁记录列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list - */ - listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Promise - /** - * 下载开门时的人脸识别图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get - */ - getAcsAccessRecordAccessPhoto(access_record_id: string): Promise - /** - * 获取周期 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/semester/list - */ - listPerformanceSemester(query?: ListPerformanceSemesterQuery): Promise - /** - * 获取周期任务（指定用户） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_user_list - */ - findByUserListPerformanceStageTask(params: FindByUserListPerformanceStageTaskRequest, query?: FindByUserListPerformanceStageTaskQuery): Promise - /** - * 获取周期任务（全部用户） - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_page - */ - findByPagePerformanceStageTask(params: FindByPagePerformanceStageTaskRequest, query?: FindByPagePerformanceStageTaskQuery): Promise - /** - * 获取绩效结果 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/review_data/query - */ - queryPerformanceReviewData(params: QueryPerformanceReviewDataRequest, query?: QueryPerformanceReviewDataQuery): Promise - /** - * 创建草稿 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/draft/create - */ - createLingoDraft(params: CreateLingoDraftRequest, query?: CreateLingoDraftQuery): Promise - /** - * 更新草稿 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/draft/update - */ - updateLingoDraft(draft_id: string, params: UpdateLingoDraftRequest, query?: UpdateLingoDraftQuery): Promise - /** - * 创建免审词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/create - */ - createLingoEntity(params: CreateLingoEntityRequest, query?: CreateLingoEntityQuery): Promise - /** - * 更新免审词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/update - */ - updateLingoEntity(entity_id: string, params: UpdateLingoEntityRequest, query?: UpdateLingoEntityQuery): Promise - /** - * 删除免审词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/delete - */ - deleteLingoEntity(entity_id: string, query?: DeleteLingoEntityQuery): Promise - /** - * 获取词条详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/get - */ - getLingoEntity(entity_id: string, query?: GetLingoEntityQuery): Promise - /** - * 获取词条列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/list - */ - listLingoEntity(query?: ListLingoEntityQuery): Promise - /** - * 精准搜索词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/match - */ - matchLingoEntity(params: MatchLingoEntityRequest, query?: MatchLingoEntityQuery): Promise - /** - * 模糊搜索词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/search - */ - searchLingoEntity(params: SearchLingoEntityRequest, query?: SearchLingoEntityQuery): Promise - /** - * 词条高亮 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/highlight - */ - highlightLingoEntity(params: HighlightLingoEntityRequest): Promise - /** - * 获取词典分类 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/classification/list - */ - listLingoClassification(query?: ListLingoClassificationQuery): Promise - /** - * 获取词库列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/repo/list - */ - listLingoRepo(): Promise - /** - * 上传图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/file/upload - */ - uploadLingoFile(form: UploadLingoFileForm): Promise - /** - * 下载图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/file/download - */ - downloadLingoFile(file_token: string): Promise - /** - * 获取OpenAPI审计日志数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v1/openapi_log/list_data - */ - listDataSecurityAndComplianceOpenapiLog(params: ListDataSecurityAndComplianceOpenapiLogRequest): Promise - /** - * 获取行为审计日志数据 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get - */ - listAdminAuditInfo(query?: ListAdminAuditInfoQuery): Promise - /** - * 获取妙记统计数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-statistics/get - */ - getMinutesMinuteStatistics(minute_token: string, query?: GetMinutesMinuteStatisticsQuery): Promise - /** - * 获取妙记信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute/get - */ - getMinutesMinute(minute_token: string, query?: GetMinutesMinuteQuery): Promise - /** - * 获取工作台访问数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search - */ - searchWorkplaceWorkplaceAccessData(query?: SearchWorkplaceWorkplaceAccessDataQuery): Promise - /** - * 获取定制工作台访问数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search - */ - searchWorkplaceCustomWorkplaceAccessData(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery): Promise - /** - * 获取定制工作台小组件访问数据 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search - */ - searchWorkplaceWorkplaceBlockAccessData(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery): Promise - /** - * 获取用户自定义常用的应用 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/favourite - */ - favouriteApplication(query?: FavouriteApplicationQuery): Promise - /** - * 获取管理员推荐的应用 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/recommend - */ - recommendApplication(query?: RecommendApplicationQuery): Promise - /** - * 获取当前设置的推荐规则列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list - */ - listApplicationAppRecommendRule(query?: ListApplicationAppRecommendRuleQuery): Promise - /** - * 用户数据维度绑定 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/bind - */ - bindMdmUserAuthDataRelation(params: BindMdmUserAuthDataRelationRequest, query?: BindMdmUserAuthDataRelationQuery): Promise - /** - * 用户数据维度解绑 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/unbind - */ - unbindMdmUserAuthDataRelation(params: UnbindMdmUserAuthDataRelationRequest, query?: UnbindMdmUserAuthDataRelationQuery): Promise - /** - * 查询规则 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule/query - */ - queryReportRule(query?: QueryReportRuleQuery): Promise - /** - * 移除规则看板 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule-view/remove - */ - removeReportRuleView(rule_id: string, params: RemoveReportRuleViewRequest, query?: RemoveReportRuleViewQuery): Promise - /** - * 查询任务 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query - */ - queryReportTask(params: QueryReportTaskRequest, query?: QueryReportTaskQuery): Promise - /** - * 获取 user_access_token - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/access_token/create - */ - createAuthenAccessToken(params: CreateAuthenAccessTokenRequest): Promise - /** - * 刷新 user_access_token - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/refresh_access_token/create - */ - createAuthenRefreshAccessToken(params: CreateAuthenRefreshAccessTokenRequest): Promise - /** - * 创建草稿 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/create - */ - createBaikeDraft(params: CreateBaikeDraftRequest, query?: CreateBaikeDraftQuery): Promise - /** - * 更新草稿 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/update - */ - updateBaikeDraft(draft_id: string, params: UpdateBaikeDraftRequest, query?: UpdateBaikeDraftQuery): Promise - /** - * 创建免审词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create - */ - createBaikeEntity(params: CreateBaikeEntityRequest, query?: CreateBaikeEntityQuery): Promise - /** - * 更新免审词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update - */ - updateBaikeEntity(entity_id: string, params: UpdateBaikeEntityRequest, query?: UpdateBaikeEntityQuery): Promise - /** - * 获取词条详情 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get - */ - getBaikeEntity(entity_id: string, query?: GetBaikeEntityQuery): Promise - /** - * 获取词条列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list - */ - listBaikeEntity(query?: ListBaikeEntityQuery): Promise - /** - * 精准搜索词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match - */ - matchBaikeEntity(params: MatchBaikeEntityRequest): Promise - /** - * 模糊搜索词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search - */ - searchBaikeEntity(params: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise - /** - * 词条高亮 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight - */ - highlightBaikeEntity(params: HighlightBaikeEntityRequest): Promise - /** - * 提取潜在的词条 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract - */ - extractBaikeEntity(params: ExtractBaikeEntityRequest): Promise - /** - * 获取词典分类 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list - */ - listBaikeClassification(query?: ListBaikeClassificationQuery): Promise - /** - * 上传图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload - */ - uploadBaikeFile(form: UploadBaikeFileForm): Promise - /** - * 下载图片 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/download - */ - downloadBaikeFile(file_token: string): Promise - /** - * 获取用户列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list - */ - listContactUser(query?: ListContactUserQuery): Promise - /** - * 更新用户所有信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update - */ - updateContactUser(user_id: string, params: UpdateContactUserRequest, query?: UpdateContactUserQuery): Promise - /** - * 获取部门信息列表 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list - */ - listContactDepartment(query?: ListContactDepartmentQuery): Promise - /** - * 列出记录 - * @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 - /** - * 获取面试记录列表 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application-interview/list - */ - listHireApplicationInterview(application_id: string, query?: ListHireApplicationInterviewQuery): Promise - /** - * 获取职位上的招聘人员信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job-manager/get - */ - getHireJobManager(job_id: string, manager_id: string, query?: GetHireJobManagerQuery): Promise - /** - * 获取 Offer 申请表详细信息 - * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_schema/get - */ - getHireOfferSchema(offer_schema_id: string): Promise - /** - * 批量查询城市/区域信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/list - */ - listCorehrSubregion(query?: ListCorehrSubregionQuery): Promise - /** - * 查询单条城市/区域信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/get - */ - getCorehrSubregion(subregion_id: string): Promise - /** - * 批量查询省份/行政区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/list - */ - listCorehrSubdivision(query?: ListCorehrSubdivisionQuery): Promise - /** - * 查询单条省份/行政区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/get - */ - getCorehrSubdivision(subdivision_id: string): Promise - /** - * 批量查询国家/地区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/list - */ - listCorehrCountryRegion(query?: ListCorehrCountryRegionQuery): Promise - /** - * 查询单条国家/地区信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/get - */ - getCorehrCountryRegion(country_region_id: string): Promise - /** - * 批量查询货币信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/list - */ - listCorehrCurrency(query?: ListCorehrCurrencyQuery): Promise - /** - * 查询单个货币信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/get - */ - getCorehrCurrency(currency_id: string): Promise - /** - * 查询单个个人信息 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/get - */ - getCorehrPerson(person_id: string, query?: GetCorehrPersonQuery): Promise - /** - * 创建签到板部署码 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_checkboard_access_code - */ - setCheckboardAccessCodeVcRoomConfig(params: SetCheckboardAccessCodeVcRoomConfigRequest): Promise - /** - * 创建会议室部署码 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_room_access_code - */ - setRoomAccessCodeVcRoomConfig(params: SetRoomAccessCodeVcRoomConfigRequest): Promise - /** - * 查询会议室配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/query - */ - queryVcRoomConfig(query?: QueryVcRoomConfigQuery): Promise - /** - * 设置会议室配置 - * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set - */ - setVcRoomConfig(params: SetVcRoomConfigRequest, query?: SetVcRoomConfigQuery): Promise - - } -} - -declare module '.' { - export namespace Lark { - export type TokenInfo = { - /** user_access_token，用于获取用户资源和访问某些open api */ - access_token: string - /** 刷新用户 `access_token` 时使用的 token */ - refresh_token?: string - /** token 类型，固定值 */ - token_type: string - /** `access_token`的有效期，单位: 秒，一般是两个小时左右，需要以返回结果为准 */ - expires_in?: number - /** `refresh_token` 的有效期，单位: 秒，一般是30天左右，需要以返回结果为准 */ - refresh_expires_in?: number - /** 用户授予app的权限全集 */ - scope?: string - } - export type UserInfo = { - /** 用户姓名 */ - name?: string - /** 用户英文名称 */ - en_name?: string - /** 用户头像 */ - avatar_url?: string - /** 用户头像 72x72 */ - avatar_thumb?: string - /** 用户头像 240x240 */ - avatar_middle?: string - /** 用户头像 640x640 */ - avatar_big?: string - /** 用户在应用内的唯一标识 */ - open_id?: string - /** 用户统一ID */ - union_id?: string - /** 用户邮箱 */ - email?: string - /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */ - enterprise_email?: string - /** 用户 user_id */ - user_id?: string - /** 用户手机号 */ - mobile?: string - /** 当前企业标识 */ - tenant_key?: string - /** 用户工号 */ - employee_no?: string - } - export type MaskSession = { - /** 创建时间 */ - create_time?: string - /** 客户端类型 */ - terminal_type?: number - /** 用户ID */ - user_id?: string - } - export type UserOrder = { - /** 排序信息对应的部门ID */ - department_id?: string - /** 用户在部门内的排序 */ - user_order?: number - /** 用户的部门间的排序 */ - department_order?: number - /** 是否为用户主部门 */ - is_primary_dept?: boolean - } - export type CustomAttrGenericUser = { - /** 用户id */ - id: string - /** 用户类型 1 User 2 Bot 11 Mail */ - type: number - } - export type UserCustomAttrValue = { - /** 属性文本 */ - text?: string - /** URL */ - url?: string - /** PC上的URL */ - pc_url?: string - /** 选项id，自定义选项和图片此项必填 */ - option_id?: string - /** 用户信息 */ - generic_user?: Lark.CustomAttrGenericUser - } - export type UserCustomAttr = { - /** 自定义属性类型 */ - type?: string - /** 自定义属性ID */ - id?: string - /** 自定义属性取值 */ - value?: Lark.UserCustomAttrValue - } - export type AvatarInfo = { - /** 72*72像素头像链接 */ - avatar_72?: string - /** 240*240像素头像链接 */ - avatar_240?: string - /** 640*640像素头像链接 */ - avatar_640?: string - /** 原始头像链接 */ - avatar_origin?: string - } - export type UserStatus = { - /** 是否冻结 */ - is_frozen?: boolean - /** 是否离职 */ - is_resigned?: boolean - /** 是否激活 */ - is_activated?: boolean - /** 是否主动退出，主动退出一段时间后用户会自动转为已离职 */ - is_exited?: boolean - /** 是否未加入，需要用户自主确认才能加入团队 */ - is_unjoin?: boolean - } - export type User = { - /** 用户的union_id */ - union_id?: string - /** 租户内用户的唯一标识 */ - user_id?: string - /** 用户的open_id */ - open_id?: string - /** 用户名 */ - name: string - /** 英文名 */ - en_name?: string - /** 别名 */ - nickname?: string - /** 邮箱 */ - email?: string - /** 手机号 */ - mobile: string - /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ - mobile_visible?: boolean - /** 性别 */ - gender?: number - /** 头像的文件Key */ - avatar_key?: string - /** 用户头像信息 */ - avatar?: Lark.AvatarInfo - /** 用户状态 */ - status?: Lark.UserStatus - /** 用户所属部门的ID列表 */ - department_ids?: string[] - /** 用户的直接主管的用户ID */ - leader_user_id?: string - /** 城市 */ - city?: string - /** 国家 */ - country?: string - /** 工位 */ - work_station?: string - /** 入职时间 */ - join_time?: number - /** 是否是租户超级管理员 */ - is_tenant_manager?: boolean - /** 工号 */ - employee_no?: string - /** 员工类型 */ - employee_type?: number - /** 用户排序信息 */ - orders?: Lark.UserOrder[] - /** 自定义属性 */ - custom_attrs?: Lark.UserCustomAttr[] - /** 企业邮箱 */ - enterprise_email?: string - /** 职务 */ - job_title?: string - /** 是否冻结用户 */ - is_frozen?: boolean - /** 数据驻留地 */ - geo?: string - /** 职级ID */ - job_level_id?: string - /** 序列ID */ - job_family_id?: string - /** 虚线上级ID */ - dotted_line_leader_user_ids?: string[] - } - export type ResourceAcceptor = { - /** 资源处理类型 */ - processing_type: string - /** 转移资源时，资源接收者 */ - acceptor_user_id?: string - } - export type UserDepartmentInfo = { - /** 对应的部门ID */ - department_id: string - /** 用户在部门内的排序 */ - user_order?: number - /** 用户的部门间的排序 */ - department_order?: number - } - export type ProductI18nName = { - /** 席位中文名 */ - zh_cn?: string - /** 席位日文名 */ - ja_jp?: string - /** 席位英文名 */ - en_us?: string - } - export type UserAssignInfo = { - /** 席位id */ - subscription_id?: string - /** license_plan_key */ - license_plan_key?: string - /** 席位名称 */ - product_name?: string - /** 国际化名称 */ - i18n_name?: Lark.ProductI18nName - /** 席位起始时间 */ - start_time?: string - /** 席位结束时间 */ - end_time?: string - } - export type DepartmentI18nName = { - /** 部门的中文名 */ - zh_cn?: string - /** 部门的日文名 */ - ja_jp?: string - /** 部门的英文名 */ - en_us?: string - } - export type DepartmentPathName = { - /** 部门名 */ - name?: string - /** 部门国际化名 */ - i18n_name?: Lark.DepartmentI18nName - } - export type DepartmentPath = { - /** 部门路径IDs */ - department_ids?: string[] - /** 部门路径名字 */ - department_path_name?: Lark.DepartmentPathName - } - export type DepartmentDetail = { - /** 部门ID */ - department_id?: string - /** 部门名 */ - department_name?: Lark.DepartmentPathName - /** 部门路径 */ - department_path?: Lark.DepartmentPath - } - export type UserContactInfo = { - /** 用户id，值为user_id_type所指定的类型。如果查询的手机号、邮箱不存在，或者无权限查看对应的用户，则此项为空。 */ - user_id?: string - /** 手机号 */ - mobile?: string - /** 邮箱 */ - email?: string - } - export type Group = { - /** 用户组ID */ - id: string - /** 用户组名字 */ - name: string - /** 用户组描述 */ - description?: string - /** 用户组成员中用户的数量 */ - member_user_count?: number - /** 用户组成员中部门的数量 */ - member_department_count?: number - /** 用户组的类型 */ - type?: number - } - export type CustomAttrOption = { - /** 枚举类型选项id */ - id: string - /** 枚举选项值 */ - value: string - /** 名称 */ - name?: string - } - export type CustomAttrOptions = { - /** 默认选项id */ - default_option_id?: string - /** 选项类型 */ - option_type: string - /** 选项列表 */ - options: Lark.CustomAttrOption[] - } - export type I18nContent = { - /** 语言 */ - locale?: string - /** i18n内容 */ - value?: string - } - export type CustomAttr = { - /** 自定义字段id */ - id: string - /** 自定义字段类型 */ - type: string - /** 选项定义，当type为ENUMERATION或者PICTURE_ENUM时此项有值，列举所有可选项 */ - options?: Lark.CustomAttrOptions - /** 多语言名称 */ - i18n_name?: Lark.I18nContent[] - } - export type EmployeeTypeEnum = { - /** 枚举值id */ - enum_id?: string - /** 枚举值 */ - enum_value?: string - /** 枚举内容 */ - content: string - /** 类型 */ - enum_type: number - /** 类型 */ - enum_status: number - /** i18n定义 */ - i18n_content?: Lark.I18nContent[] - } - export type DepartmentLeader = { - /** 负责人类型 */ - leaderType: number - /** 负责人ID */ - leaderID: string - } - export type DepartmentStatus = { - /** 是否被删除 */ - is_deleted?: boolean - } - export type Department = { - /** 部门名称 */ - name: string - /** 国际化的部门名称 */ - i18n_name?: Lark.DepartmentI18nName - /** 父部门的部门ID */ - parent_department_id: string - /** 本部门的自定义部门ID */ - department_id?: string - /** 部门的open_id */ - open_department_id?: string - /** 部门主管用户ID */ - leader_user_id?: string - /** 部门群ID */ - chat_id?: string - /** 部门的排序 */ - order?: string - /** 部门单位自定义ID列表，当前只支持一个 */ - unit_ids?: string[] - /** 部门下用户的个数 */ - member_count?: number - /** 部门状态 */ - status?: Lark.DepartmentStatus - /** 部门负责人 */ - leaders?: Lark.DepartmentLeader[] - /** 部门群雇员类型限制 */ - group_chat_employee_types?: number[] - /** 部门HRBP */ - department_hrbps?: string[] - /** 部门下主属用户的个数 */ - primary_member_count?: number - } - export type UnitDepartment = { - /** 单位ID */ - unit_id: string - /** 部门ID */ - department_id: string - } - export type Unit = { - /** 单位的自定义ID */ - unit_id: string - /** 单位的名字 */ - name: string - /** 单位的类型 */ - unit_type: string - } - export type Memberlist = { - /** 成员ID */ - member_id: string - /** 用户组成员的类型，目前取值为 user。未来将支持department */ - member_type: string - /** 成员ID类别，仅请求参数中有效 */ - member_id_type?: string - } - export type MemberResult = { - /** 成员ID */ - member_id: string - /** 结果响应码，0表示成功 */ - code: number - } - export type FunctionalRoleMemberResult = { - /** 用户ID */ - user_id: string - /** 成员处理结果 */ - reason: number - } - export type FunctionalRoleMember = { - /** 成员ID */ - user_id?: string - /** 管理范围的类型 */ - scope_type?: string - /** 表示该角色成员的管理范围，scope_type为“指定范围”时，返回该值 */ - department_ids?: string[] - } - export type JobLevel = { - /** 职级名称 */ - name?: string - /** 职级描述 */ - description?: string - /** 职级的排序，可填入自然数100-100000的数值，系统按照数值大小从小到大排序。不填写该字段时，默认新增排序在当前职级列表中最后位（最大值） */ - order?: number - /** 是否启用 */ - status?: boolean - /** 职级ID */ - job_level_id?: string - /** 多语言名称 */ - i18n_name?: Lark.I18nContent[] - /** 多语言描述 */ - i18n_description?: Lark.I18nContent[] - } - export type JobFamily = { - /** 序列名称。1-100字符，支持中、英文及符号 */ - name?: string - /** 序列描述，描述序列详情信息 */ - description?: string - /** 上级序列ID。需是该租户的序列ID列表中的值，对应唯一的序列名称。 */ - parent_job_family_id?: string - /** 是否启用 */ - status?: boolean - /** 多语言序列名称 */ - i18n_name?: Lark.I18nContent[] - /** 多语言描述 */ - i18n_description?: Lark.I18nContent[] - /** 职级序列ID */ - job_family_id?: string - } - export type JobTitle = { - /** 职务ID */ - job_title_id?: string - /** 职务名称。1-100字符，支持中、英文及符号 */ - name?: string - /** 多语言职务名称 */ - i18n_name?: Lark.I18nContent[] - /** 是否启用 */ - status?: boolean - } - export type WorkCity = { - /** 工作城市ID */ - work_city_id?: string - /** 工作城市名称。1-100字符，支持中、英文及符号 */ - name?: string - /** 多语言工作城市 */ - i18n_name?: Lark.I18nContent[] - /** 是否启用 */ - status?: boolean - } - export type Sender = { - /** 该字段标识发送者的id */ - id: string - /** 该字段标识发送者的id类型 */ - id_type: string - /** 该字段标识发送者的类型 */ - sender_type: string - /** tenant key */ - tenant_key?: string - } - export type MessageBody = { - /** 消息jsonContent */ - content: string - } - export type Mention = { - /** mention key */ - key: string - /** 用户open id */ - id: string - /** id 可以是open_id，user_id或者union_id */ - id_type: string - /** 被at用户的姓名 */ - name: string - /** tenant key */ - tenant_key?: string - } - export type Message = { - /** 消息id open_message_id */ - message_id?: string - /** 根消息id open_message_id */ - root_id?: string - /** 父消息的id open_message_id */ - parent_id?: string - /** 消息所属的话题 ID */ - thread_id?: string - /** 消息类型 text post card image等等 */ - msg_type?: string - /** 消息生成的时间戳(毫秒) */ - create_time?: string - /** 消息更新的时间戳 */ - update_time?: string - /** 消息是否被撤回 */ - deleted?: boolean - /** 消息是否被更新 */ - updated?: boolean - /** 所属的群 */ - chat_id?: string - /** 发送者，可以是用户或应用 */ - sender?: Lark.Sender - /** 消息内容,json结构 */ - body?: Lark.MessageBody - /** 被艾特的人或应用的id */ - mentions?: Lark.Mention[] - /** 合并消息的上一层级消息id open_message_id */ - upper_message_id?: string - } - export type ReadUser = { - /** 用户id类型 */ - user_id_type: string - /** 用户id */ - user_id: string - /** 阅读时间 */ - timestamp: string - /** tenant key */ - tenant_key?: string - } - export type BatchMessageReadUser = { - /** 已读人数 */ - read_count: string - /** 总人数 */ - total_count: string - } - export type BatchMessageSendProgress = { - /** 批量请求中有效的userid数量(包含机器人不可见用户) */ - valid_user_ids_count?: number - /** 已经成功给用户发送成功的消息数量 */ - success_user_ids_count?: number - /** 已读信息用户数量 */ - read_user_ids_count?: number - } - export type BatchMessageRecallProgress = { - /** 该条批量消息是否被执行过撤回操作 */ - recall?: boolean - /** 已经成功撤回的消息数量 */ - recall_count?: number - } - export type Emoji = { - /** emoji类型 */ - emoji_type: string - } - export type Operator = { - /** 操作人ID */ - operator_id: string - /** 操作人身份，用户或应用 */ - operator_type: string - } - export type MessageReaction = { - /** reaction资源ID */ - reaction_id?: string - /** 添加reaction的操作人 */ - operator?: Lark.Operator - /** reaction动作的的unix timestamp(单位:ms) */ - action_time?: string - /** reaction资源类型 */ - reaction_type?: Lark.Emoji - } - export type Pin = { - /** Pin的消息ID */ - message_id: string - /** Pin消息所在的群聊ID */ - chat_id?: string - /** Pin的操作人ID */ - operator_id?: string - /** Pin的操作人ID类型 */ - operator_id_type?: string - /** Pin的创建时间（毫秒级时间戳） */ - create_time?: string - } - export type I18nNames = { - /** 中文名 */ - zh_cn?: string - /** 英文名 */ - en_us?: string - /** 日文名 */ - ja_jp?: string - } - export type RestrictedModeSetting = { - /** 防泄密模式是否开启 */ - status?: boolean - /** 允许截屏录屏 */ - screenshot_has_permission_setting?: string - /** 允许下载消息中图片、视频和文件 */ - download_has_permission_setting?: string - /** 允许复制和转发消息 */ - message_has_permission_setting?: string - } - export type ChatTopNotice = { - /** 置顶的类型 */ - action_type?: string - /** 消息ID */ - message_id?: string - } - export type ListChat = { - /** 群组ID */ - chat_id?: string - /** 群头像URL */ - avatar?: string - /** 群名称 */ - name?: string - /** 群描述 */ - description?: string - /** 群主ID */ - owner_id?: string - /** 群主ID类型 */ - owner_id_type?: string - /** 是否是外部群 */ - external?: boolean - /** tenant key */ - tenant_key?: string - } - export type ListModerator = { - /** 可发言用户 ID 类型 */ - user_id_type?: string - /** 可发言用户 ID */ - user_id?: string - /** tenant key */ - tenant_key?: string - } - export type ListMember = { - /** member id类型 */ - member_id_type?: string - /** member id */ - member_id?: string - /** 名字 */ - name?: string - /** tenant key */ - tenant_key?: string - } - export type ChatTabContent = { - /** URL类型 */ - url?: string - /** Doc链接 */ - doc?: string - /** 会议纪要 */ - meeting_minute?: string - } - export type ChatTabConfig = { - /** 群Tab图标 */ - icon_key?: string - /** 群tab是否App内嵌打开 */ - is_built_in?: boolean - } - export type ChatTab = { - /** Tab名称 */ - tab_name?: string - /** Tab类型 */ - tab_type: string - /** Tab内容 */ - tab_content?: Lark.ChatTabContent - /** Tab的配置 */ - tab_config?: Lark.ChatTabConfig - } - export type ChatMenuItemRedirectLink = { - common_url?: string - ios_url?: string - android_url?: string - pc_url?: string - web_url?: string - } - export type ChatMenuItem = { - /** 菜单类型 */ - action_type: string - /** 跳转链接 */ - redirect_link?: Lark.ChatMenuItemRedirectLink - /** image_key */ - image_key?: string - /** 名称 */ - name: string - /** 国际化名称，一级菜单名称字符数要在1到8范围内，二级菜单名称字符数要在1到24范围内。

**注意：**
1中文=2英文=2其他语言字符=2字符 */ - i18n_names?: Lark.I18nNames - } - export type ChatMenuSecondLevel = { - /** 二级菜单信息 */ - chat_menu_item?: Lark.ChatMenuItem - } - export type ChatMenuTopLevel = { - /** 一级菜单信息 */ - chat_menu_item: Lark.ChatMenuItem - /** 二级菜单列表 */ - children?: Lark.ChatMenuSecondLevel[] - } - export type ChatMenuTree = { - /** 一级菜单列表 */ - chat_menu_top_levels: Lark.ChatMenuTopLevel[] - } - export type ShortcutInfo = { - /** 快捷方式指向的原文件类型 */ - target_type: string - /** 快捷方式指向的原文件token */ - target_token: string - } - export type File = { - /** 文件标识符 */ - token: string - /** 文件名 */ - name: string - /** 文件类型 */ - type: string - /** 父文件夹标识 */ - parent_token?: string - /** 在浏览器中查看的链接 */ - url?: string - /** 快捷方式文件信息 */ - shortcut_info?: Lark.ShortcutInfo - /** 文件创建时间 */ - created_time?: string - /** 文件最近修改时间 */ - modified_time?: string - /** 文件所有者 */ - owner_id?: string - } - export type RequestDoc = { - /** 文件的 token，获取方式见[概述](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction) */ - doc_token: string - /** 文件类型 */ - doc_type: string - } - export type Meta = { - /** 文件token */ - doc_token: string - /** 文件类型 */ - doc_type: string - /** 标题 */ - title: string - /** 文件所有者 */ - owner_id: string - /** 创建时间（Unix时间戳） */ - create_time: string - /** 最后编辑者 */ - latest_modify_user: string - /** 最后编辑时间（Unix时间戳） */ - latest_modify_time: string - /** 文档链接 */ - url: string - /** 文档密级标签名称 */ - sec_label_name?: string - } - export type MetaFailed = { - /** 获取元数据失败的文档token */ - token: string - /** 获取元数据失败的错误码 */ - code: number - } - export type FileStatistics = { - /** 文档历史访问人数，同一人多次访问按一次计算。 */ - uv?: number - /** 文档历史访问次数，同一人多次访问按多次计算。（注：同一人相邻两次访问间隔在半小时内视为一次访问） */ - pv?: number - /** 文档历史点赞总数 */ - like_count?: number - /** 时间戳（秒） */ - timestamp?: number - } - export type Property = { - /** 自定义属性键对象 */ - key: string - /** 自定义属性值对象 */ - value: string - } - export type ReferEntity = { - /** 快捷方式指向的文档token */ - refer_token: string - /** 快捷方式指向的文档类型 */ - refer_type: string - } - export type TmpDownloadUrl = { - /** 文件标识符 */ - file_token: string - /** 文件临时下载链接 */ - tmp_download_url: string - } - export type ImportTaskMountPoint = { - /** 挂载类型 */ - mount_type: number - /** 挂载位置,对于mount_type=1, 云空间目录token，空表示根目录 */ - mount_key: string - } - export type ImportTask = { - /** 任务ID */ - ticket?: string - /** 导入目标云文档格式 */ - type: string - /** 任务状态 */ - job_status?: number - /** 任务失败原因 */ - job_error_msg?: string - /** 导入云文档Token */ - token?: string - /** 导入云文档URL */ - url?: string - /** 任务成功后的提示信息 */ - extra?: string[] - } - export type ExportTask = { - /** 导出文件扩展名 */ - file_extension: string - /** 导出文档类型 */ - type: string - /** 导出文件名 */ - file_name?: string - /** 导出文件 drive token */ - file_token?: string - /** 导出文件大小 */ - file_size?: number - /** 任务失败原因 */ - job_error_msg?: string - /** 任务状态 */ - job_status?: number - } - export type FileViewRecord = { - /** 访问者 ID */ - viewer_id?: string - /** 访问者名称 */ - name?: string - /** 访问者头像 URL */ - avatar_url?: string - /** 最近访问时间，秒级时间戳 */ - last_view_time?: string - } - export type Version = { - /** 版本文档标题 */ - name?: string - /** 版本文档版本号 */ - version?: string - /** 源文档token */ - parent_token?: string - /** 版本文档所有者id */ - owner_id?: string - /** 版本文档创建者id */ - creator_id?: string - /** 版本文档创建时间 */ - create_time?: string - /** 版本文档更新时间 */ - update_time?: string - /** 版本文档状态 */ - status?: string - /** 版本文档类型 */ - obj_type?: string - /** 源文档类型 */ - parent_type?: string - } - export type Member = { - /** 协作者ID类型 */ - member_type: string - /** 协作者ID，与协作者ID类型需要对应 */ - member_id: string - /** 需要增加的权限角色 */ - perm: string - /** 协作者的类型 */ - type?: string - /** 协作者的名字 */ - name?: string - /** 协作者的头像 */ - avatar?: string - /** 协作者的外部标签 */ - external_label?: boolean - } - export type BaseMember = { - /** 协作者ID类型 */ - member_type: string - /** 协作者ID，与协作者ID类型需要对应 */ - member_id: string - /** 需要增加的权限角色 */ - perm: string - } - export type PermissionPublic = { - /** 允许内容被分享到组织外 */ - external_access?: boolean - /** 谁可以复制内容、创建副本、打印、下载 */ - security_entity?: string - /** 谁可以评论 */ - comment_entity?: string - /** 谁可以添加和管理协作者 */ - share_entity?: string - /** 链接分享设置 */ - link_share_entity?: string - /** 允许非「可管理权限」的人分享到组织外（仅share_entity=“same_tenant”时有效） */ - invite_external?: boolean - /** 节点是否已加锁 */ - lock_switch?: boolean - } - export type TextRun = { - /** 回复 普通文本 */ - text: string - } - export type DocsLink = { - /** 回复 at云文档 */ - url: string - } - export type Person = { - /** 回复 at联系人 */ - user_id: string - } - export type ReplyElement = { - /** 回复的内容元素 */ - type: string - /** 文本内容 */ - text_run?: Lark.TextRun - /** 文本内容 */ - docs_link?: Lark.DocsLink - /** 文本内容 */ - person?: Lark.Person - } - export type ReplyContent = { - /** 回复的内容 */ - elements: Lark.ReplyElement[] - } - export type ReplyExtra = { - image_list?: string[] - } - export type FileCommentReply = { - /** 回复ID */ - reply_id?: string - /** 用户ID */ - user_id?: string - /** 创建时间 */ - create_time?: number - /** 更新时间 */ - update_time?: number - /** 回复内容 */ - content: Lark.ReplyContent - /** 回复的其他内容，图片token等 */ - extra?: Lark.ReplyExtra - } - export type ReplyList = { - replies: Lark.FileCommentReply[] - } - export type FileComment = { - /** 评论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?: Lark.ReplyList - } - export type Document = { - /** 文档唯一标识 */ - document_id?: string - /** 文档版本 ID */ - revision_id?: number - /** 文档标题 */ - title?: string - } - export type TextStyle = { - /** 对齐方式 */ - align?: number - /** todo 的完成状态 */ - done?: boolean - /** 文本的折叠状态 */ - folded?: boolean - /** 代码块语言 */ - language?: number - /** 代码块是否自动换行 */ - wrap?: boolean - } - export type Link = { - /** 超链接指向的 url (需要 url_encode) */ - url: string - } - export type TextElementStyle = { - /** 加粗 */ - bold?: boolean - /** 斜体 */ - italic?: boolean - /** 删除线 */ - strikethrough?: boolean - /** 下划线 */ - underline?: boolean - /** inline 代码 */ - inline_code?: boolean - /** 背景色 */ - background_color?: number - /** 字体颜色 */ - text_color?: number - /** 链接 */ - link?: Lark.Link - /** 评论 id 列表 */ - comment_ids?: string[] - } - export type MentionUser = { - /** 用户 OpenID */ - user_id: string - /** 文本局部样式 */ - text_element_style?: Lark.TextElementStyle - } - export type MentionDoc = { - /** 云文档 token */ - token: string - /** 云文档类型 */ - obj_type: number - /** 云文档链接（需要 url_encode) */ - url: string - /** 文档标题，只读属性 */ - title?: string - /** 文本局部样式 */ - text_element_style?: Lark.TextElementStyle - } - export type Reminder = { - /** 创建者用户 ID */ - create_user_id: string - /** 是否通知 */ - is_notify?: boolean - /** 是日期还是整点小时 */ - is_whole_day?: boolean - /** 事件发生的时间（毫秒级事件戳） */ - expire_time: string - /** 触发通知的时间（毫秒级时间戳） */ - notify_time: string - /** 文本局部样式 */ - text_element_style?: Lark.TextElementStyle - } - export type InlineFile = { - /** 附件 token */ - file_token?: string - /** 当前文档中该附件所处的 block 的 id */ - source_block_id?: string - /** 文本局部样式 */ - text_element_style?: Lark.TextElementStyle - } - export type UndefinedElement = { - - } - export type InlineBlock = { - /** 关联的内联状态的 block 的 block_id */ - block_id: string - /** 文本局部样式 */ - text_element_style?: Lark.TextElementStyle - } - export type Equation = { - /** 符合 KaTeX 语法的公式内容，语法规则请参考：https://katex.org/docs/supported.html */ - content: string - /** 文本局部样式 */ - text_element_style?: Lark.TextElementStyle - } - export type TextElement = { - /** 文字 */ - text_run?: Lark.TextRun - /** @用户 */ - mention_user?: Lark.MentionUser - /** @文档 */ - mention_doc?: Lark.MentionDoc - /** 日期提醒 */ - reminder?: Lark.Reminder - /** 内联附件 */ - file?: Lark.InlineFile - /** 未支持的 TextElement */ - undefined?: Lark.UndefinedElement - /** 内联 block */ - inline_block?: Lark.InlineBlock - /** 公式 */ - equation?: Lark.Equation - } - export type Text = { - /** 文本样式 */ - style?: Lark.TextStyle - /** 文本元素 */ - elements: Lark.TextElement[] - } - export type Bitable = { - /** 多维表格文档 Token。格式为 {BitableToken}_{TableID}，其中 BitableToken 是一篇多维表格的唯一标识，TableID 是一张数据表的唯一标识，使用时请注意拆分。 */ - token?: string - } - export type Callout = { - background_color?: number - border_color?: number - text_color?: number - /** 高亮块图标 */ - emoji_id?: string - } - export type ChatCard = { - /** 群聊天会话 ID */ - chat_id: string - /** 对齐方式 */ - align?: number - } - export type Diagram = { - /** 绘图类型 */ - diagram_type?: number - } - export type Divider = { - - } - export type Grid = { - /** 分栏列数量 */ - column_size: number - } - export type GridColumn = { - /** 当前分栏列占整个分栏的比例 */ - width_ratio?: number - } - export type IframeComponent = { - /** iframe 类型 */ - iframe_type?: number - /** iframe 目标 url（需要进行 url_encode） */ - url: string - } - export type Iframe = { - /** iframe 的组成元素 */ - component: Lark.IframeComponent - } - export type Image = { - /** 宽度，单位 px */ - width?: number - /** 高度，单位 px */ - height?: number - /** 图片 Token */ - token?: string - /** 对齐方式 */ - align?: number - } - export type Isv = { - /** 团队互动应用唯一ID */ - component_id?: string - /** 团队互动应用类型，比如信息收集"blk_5f992038c64240015d280958" */ - component_type_id?: string - } - export type AddOns = { - /** 团队互动应用唯一ID */ - component_id?: string - /** 团队互动应用类型，比如问答互动"blk_636a0a6657db8001c8df5488" */ - component_type_id: string - /** 文档小组件内容数据，JSON 字符串 */ - record?: string - } - export type Mindnote = { - /** 思维导图 token */ - token?: string - } - export type Sheet = { - /** 电子表格文档 Token。格式为 {SpreadsheetToken}_{SheetID}，其中 SpreadsheetToken 是一篇电子表格的唯一标识，SheetID 是一张工作表的唯一标识，使用时请注意拆分。 */ - token?: string - } - export type TableMergeInfo = { - /** 从当前行索引起被合并的连续行数 */ - row_span?: number - /** 从当前列索引起被合并的连续列数 */ - col_span?: number - } - export type TableProperty = { - /** 行数 */ - row_size: number - /** 列数 */ - column_size: number - /** 列宽，单位px */ - column_width?: number[] - /** 单元格合并信息 */ - merge_info?: Lark.TableMergeInfo[] - /** 设置首行为标题行 */ - header_row?: boolean - /** 设置首列为标题列 */ - header_column?: boolean - } - export type Table = { - /** 单元格数组，数组元素为 Table Cell Block 的 ID */ - cells?: string[] - /** 表格属性 */ - property: Lark.TableProperty - } - export type TableCell = { - - } - export type View = { - /** 视图类型 */ - view_type?: number - } - export type Undefined = { - - } - export type QuoteContainer = { - - } - export type Task = { - /** 任务 ID，查询具体任务详情见 https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/create */ - task_id: string - } - export type OkrVisibleSetting = { - /** 进展编辑区域是否可见 */ - progress_fill_area_visible?: boolean - /** 状态是否可见 */ - progress_status_visible?: boolean - /** 分数是否可见 */ - score_visible?: boolean - } - export type Okr = { - /** OKR ID */ - okr_id?: string - /** 周期的状态 */ - period_display_status?: string - /** 周期名 - 中文 */ - period_name_zh?: string - /** 周期名 - 英文 */ - period_name_en?: string - /** OKR 所属的用户 ID */ - user_id?: string - /** 可见性设置 */ - visible_setting?: Lark.OkrVisibleSetting - } - export type OkrProgressRate = { - /** 状态模式 */ - mode?: string - /** 当前进度 */ - current?: number - /** 当前进度百分比，simple mode 下使用 */ - percent?: number - /** 进展状态 */ - progress_status?: string - /** 进度起始值，advanced模式使用 */ - start?: number - /** 状态类型 */ - status_type?: string - /** 进度目标值，advanced模式使用 */ - target?: number - } - export type OkrObjective = { - /** objective ID */ - objective_id?: string - /** 是否设置过私密权限 */ - confidential?: boolean - /** objective 的位置编号，对应 Block 中 O1、O2 的 1、2 */ - position?: number - /** 打分信息 */ - score?: number - /** OKR Block 中是否展示该 objective */ - visible?: boolean - /** objective 的权重 */ - weight?: number - /** 进展信息 */ - progress_rate?: Lark.OkrProgressRate - /** objective 的文本内容 */ - content?: Lark.Text - } - export type OkrKeyResult = { - /** key result 的 ID */ - kr_id?: string - /** 是否设置过私密权限 */ - confidential?: boolean - /** key result 的位置编号，对应 Block 中 KR1、KR2 的 1、2。 */ - position?: number - /** 打分信息 */ - score?: number - /** OKR Block 中此 key result 是否可见 */ - visible?: boolean - /** key result 的权重 */ - weight?: number - /** 进展信息 */ - progress_rate?: Lark.OkrProgressRate - /** key result 的文本内容 */ - content?: Lark.Text - } - export type OkrProgress = { - - } - export type JiraIssue = { - /** Jira issue ID */ - id?: string - /** Jira issue key */ - key?: string - } - export type WikiCatalog = { - /** 知识库 token */ - wiki_token?: string - } - export type Block = { - /** Block 唯一标识 */ - block_id?: string - /** block 的父亲 id */ - parent_id?: string - /** block 的孩子 id 列表 */ - children?: string[] - /** block 类型 */ - block_type: number - /** 文档 Block */ - page?: Lark.Text - /** 文本 Block */ - text?: Lark.Text - /** 一级标题 Block */ - heading1?: Lark.Text - /** 二级标题 Block */ - heading2?: Lark.Text - /** 三级标题 Block */ - heading3?: Lark.Text - /** 四级标题 Block */ - heading4?: Lark.Text - /** 五级标题 Block */ - heading5?: Lark.Text - /** 六级标题 Block */ - heading6?: Lark.Text - /** 七级标题 Block */ - heading7?: Lark.Text - /** 八级标题 Block */ - heading8?: Lark.Text - /** 九级标题 Block */ - heading9?: Lark.Text - /** 无序列表 Block */ - bullet?: Lark.Text - /** 有序列表 Block */ - ordered?: Lark.Text - /** 代码块 Block */ - code?: Lark.Text - /** 引用 Block */ - quote?: Lark.Text - /** 公式 Block */ - equation?: Lark.Text - /** 任务 Block */ - todo?: Lark.Text - /** 多维表格 Block */ - bitable?: Lark.Bitable - /** 高亮块 Block */ - callout?: Lark.Callout - /** 群聊卡片 Block */ - chat_card?: Lark.ChatCard - /** 流程图/UML Block */ - diagram?: Lark.Diagram - /** 分割线 Block */ - divider?: Lark.Divider - /** 文件 Block */ - file?: Lark.File - /** 分栏 Block */ - grid?: Lark.Grid - /** 分栏列 Block */ - grid_column?: Lark.GridColumn - /** 内嵌 Block */ - iframe?: Lark.Iframe - /** 图片 Block */ - image?: Lark.Image - /** 三方 Block */ - isv?: Lark.Isv - /** Add-ons */ - add_ons?: Lark.AddOns - /** 思维笔记 Block */ - mindnote?: Lark.Mindnote - /** 电子表格 Block */ - sheet?: Lark.Sheet - /** 表格 Block */ - table?: Lark.Table - /** 单元格 Block */ - table_cell?: Lark.TableCell - /** 视图 Block */ - view?: Lark.View - /** 未支持 Block */ - undefined?: Lark.Undefined - /** 引用容器 Block */ - quote_container?: Lark.QuoteContainer - /** 任务 Block */ - task?: Lark.Task - /** OKR Block */ - okr?: Lark.Okr - /** OKR Objective */ - okr_objective?: Lark.OkrObjective - /** OKR Key Result */ - okr_key_result?: Lark.OkrKeyResult - /** OKR 进展信息 */ - okr_progress?: Lark.OkrProgress - /** 评论 id 列表 */ - comment_ids?: string[] - /** Jira Issue */ - jira_issue?: Lark.JiraIssue - /** Wiki 子目录 Block */ - wiki_catalog?: Lark.WikiCatalog - } - export type ObjectiveIdWithKrId = { - /** okr 中 objective 的 ID */ - objective_id?: string - /** key result 的 ID 列表，此值为空时插入当前 objective 下的所有 key result */ - kr_ids?: string[] - } - export type UpdateTextElementsRequest = { - /** 更新的文本元素列表，单次更新中 reminder 上限 30 个，mention_doc 上限 50 个，mention_user 上限 100 个 */ - elements: Lark.TextElement[] - } - export type UpdateTextStyleRequest = { - style: Lark.TextStyle - /** 应更新的字段，必须至少指定一个字段。例如，要调整 Block 对齐方式，请设置 fields 为 [1]。 */ - fields: number[] - } - export type UpdateTablePropertyRequest = { - /** 表格列宽 */ - column_width?: number - /** 需要修改列宽的表格列的索引（修改表格列宽时必填） */ - column_index?: number - /** 设置首行为标题行 */ - header_row?: boolean - /** 设置首列为标题列 */ - header_column?: boolean - } - export type InsertTableRowRequest = { - /** 插入的行在表格中的索引。（-1表示在表格末尾插入一行） */ - row_index: number - } - export type InsertTableColumnRequest = { - /** 插入的列在表格中的索引。（-1表示在表格末尾插入一列） */ - column_index: number - } - export type DeleteTableRowsRequest = { - /** 行开始索引（区间左闭右开） */ - row_start_index: number - /** 行结束索引（区间左闭右开） */ - row_end_index: number - } - export type DeleteTableColumnsRequest = { - /** 列开始索引（区间左闭右开） */ - column_start_index: number - /** 列结束索引（区间左闭右开） */ - column_end_index: number - } - export type MergeTableCellsRequest = { - /** 行起始索引（区间左闭右开） */ - row_start_index: number - /** 行结束索引（区间左闭右开） */ - row_end_index: number - /** 列起始索引（区间左闭右开） */ - column_start_index: number - /** 列结束索引（区间左闭右开） */ - column_end_index: number - } - export type UnmergeTableCellsRequest = { - /** table 行索引 */ - row_index: number - /** table 列索引 */ - column_index: number - } - export type InsertGridColumnRequest = { - /** 插入列索引，从 1 开始，如 1 表示在第一列后插入，注意不允许传 0（-1表示在最后一列后插入） */ - column_index: number - } - export type DeleteGridColumnRequest = { - /** 删除列索引，从 0 开始，如 0 表示删除第一列（-1表示删除最后一列） */ - column_index: number - } - export type UpdateGridColumnWidthRatioRequest = { - /** 更新列宽比例时，需要传入所有列宽占比 */ - width_ratios: number[] - } - export type ReplaceImageRequest = { - /** 图片 token */ - token: string - /** 图片宽度，单位 px */ - width?: number - /** 图片高度，单位 px */ - height?: number - /** 对齐方式 */ - align?: number - } - export type ReplaceFileRequest = { - /** 附件 token */ - token: string - } - export type UpdateTextRequest = { - /** 更新的文本元素列表，单次更新中 reminder 上限 30 个，mention_doc 上限 50 个，mention_user 上限 100 个 */ - elements: Lark.TextElement[] - /** 更新的文本样式 */ - style: Lark.TextStyle - /** 文本样式中应更新的字段，必须至少指定一个字段。例如，要调整 Block 对齐方式，请设置 fields 为 [1]。 */ - fields: number[] - } - export type UpdateBlockRequest = { - /** 更新文本元素请求 */ - update_text_elements?: Lark.UpdateTextElementsRequest - /** 更新文本样式请求 */ - update_text_style?: Lark.UpdateTextStyleRequest - /** 更新表格属性请求 */ - update_table_property?: Lark.UpdateTablePropertyRequest - /** 表格插入新行请求 */ - insert_table_row?: Lark.InsertTableRowRequest - /** 表格插入新列请求 */ - insert_table_column?: Lark.InsertTableColumnRequest - /** 表格批量删除行请求 */ - delete_table_rows?: Lark.DeleteTableRowsRequest - /** 表格批量删除列请求 */ - delete_table_columns?: Lark.DeleteTableColumnsRequest - /** 表格合并单元格请求 */ - merge_table_cells?: Lark.MergeTableCellsRequest - /** 表格取消单元格合并状态请求 */ - unmerge_table_cells?: Lark.UnmergeTableCellsRequest - /** 分栏插入新的分栏列请求 */ - insert_grid_column?: Lark.InsertGridColumnRequest - /** 分栏删除列请求 */ - delete_grid_column?: Lark.DeleteGridColumnRequest - /** 更新分栏列宽比例请求 */ - update_grid_column_width_ratio?: Lark.UpdateGridColumnWidthRatioRequest - /** 替换图片请求 */ - replace_image?: Lark.ReplaceImageRequest - /** 替换附件请求 */ - replace_file?: Lark.ReplaceFileRequest - /** Block 唯一标识 */ - block_id?: string - /** 更新文本元素及样式请求 */ - update_text?: Lark.UpdateTextRequest - } - export type Style = { - /** 填充透明度 */ - fill_opacity?: number - /** 边框样式 */ - border_style?: string - /** 边框宽度 */ - border_width?: string - /** 边框透明度 */ - border_opacity?: number - /** 水平翻折 */ - h_flip?: boolean - /** 垂直翻折 */ - v_flip?: boolean - } - export type CompositeShape = { - /** 基础图形的具体类型 */ - type: string - } - export type ConnectorAttachedObject = { - /** 连接图形的 id */ - id?: string - } - export type ConnectorCaption = { - /** 文本 */ - data?: Lark.Text[] - } - export type Connector = { - /** 连线连接的起点图形 */ - start_object?: Lark.ConnectorAttachedObject - /** 连线连接的终点图形 */ - end_object?: Lark.ConnectorAttachedObject - /** 连线文本 */ - captions?: Lark.ConnectorCaption - } - export type Section = { - /** 分区标题 */ - title?: string - } - export type TableMeta = { - /** 行数 */ - row_num: number - /** 列数 */ - col_num: number - } - export type TableCellMergeInfo = { - /** 从当前行索引起被合并的连续行数 */ - row_span: number - /** 从当前列索引起被合并的连续列数 */ - col_span: number - } - export type MindMap = { - /** 思维导图父节点 id ，为空表示是思维导图的根节点 */ - parent_id?: string - } - export type WhiteboardNode = { - /** 节点 id */ - id: string - /** 节点图形类型，目前创建节点仅支持创建图片、文本、基础图形等类型，读取到不支持创建的图形时只返回一些基础信息，如 id、type、text、style 等 */ - type: string - /** 父节点 id */ - parent_id?: string - /** 子节点 */ - children?: string[] - /** 图形相对画布的 x 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px */ - x?: number - /** 图形相对画布的 y 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px */ - y?: number - /** 图形旋转角度 */ - angle?: number - /** 图形宽度，单位为 px */ - width?: number - /** 图形高度，单位为 px */ - height?: number - /** 图形内文字 */ - text?: Lark.Text - /** 图形样式 */ - style?: Lark.Style - /** 图片 */ - image?: Lark.Image - /** 基础图形属性 */ - composite_shape?: Lark.CompositeShape - /** 连线属性 */ - connector?: Lark.Connector - /** 分区属性 */ - section?: Lark.Section - /** 表格属性 */ - table?: Lark.Table - /** 思维导图属性 */ - mind_map?: Lark.MindMap - } - export type GetSpreadsheet = { - /** 电子表格标题 */ - title?: string - /** 电子表格owner */ - owner_id?: string - /** 电子表格token */ - token?: string - /** 电子表格url */ - url?: string - } - export type Spreadsheet = { - /** 表格标题 */ - title?: string - /** 文件夹token */ - folder_token?: string - /** 表格 URL */ - url?: string - /** 表格token */ - spreadsheet_token?: string - } - export type GridProperties = { - /** 冻结的行数量 */ - frozen_row_count?: number - /** 冻结的列数量 */ - frozen_column_count?: number - /** 工作表的行数 */ - row_count?: number - /** 工作表的列数量 */ - column_count?: number - } - export type MergeRange = { - /** 起始行 */ - start_row_index?: number - /** 结束行 */ - end_row_index?: number - /** 起始列 */ - start_column_index?: number - /** 结束列 */ - end_column_index?: number - } - export type Dimension = { - /** 操作行还是列，取值：ROWS、COLUMNS */ - major_dimension?: string - /** 起始行或者列号 */ - start_index?: number - /** 结束行或者列号 */ - end_index?: number - } - export type FindCondition = { - /** 查找范围 */ - range: string - /** 大小写是否敏感 */ - match_case?: boolean - /** 是否匹配整个单元格 */ - match_entire_cell?: boolean - /** 是否为正则匹配 */ - search_by_regex?: boolean - /** 是否搜索公式内容 */ - include_formulas?: boolean - } - export type FindReplaceResult = { - /** 符合查找条件的单元格数组，不包含公式，例如["A1", "A2"...] */ - matched_cells?: string[] - /** 符合查找条件的含有公式的单元格数组，例如["B3", "H7"...] */ - matched_formula_cells?: string[] - /** 符合查找条件的总行数 */ - rows_count?: number - } - export type Condition = { - /** 筛选类型 */ - filter_type: string - /** 比较类型 */ - compare_type?: string - /** 筛选参数 */ - expected: string[] - } - export type FilterInfo = { - /** 设置了筛选条件的列 */ - col: string - /** 筛选条件 */ - conditions: Lark.Condition[] - } - export type SheetFilterInfo = { - /** 筛选应用范围 */ - range: string - /** 筛选出来的行 */ - filtered_out_rows: number[] - /** sheet的筛选条件 */ - filter_infos: Lark.FilterInfo[] - } - export type FilterView = { - /** 筛选视图 id */ - filter_view_id?: string - /** 筛选视图名字 */ - filter_view_name?: string - /** 筛选视图的筛选范围 */ - range?: string - } - export type FilterViewCondition = { - /** 设置筛选条件的列，使用字母号 */ - condition_id?: string - /** 筛选类型 */ - filter_type?: string - /** 比较类型 */ - compare_type?: string - /** 筛选参数 */ - expected?: string[] - } - export type FloatImage = { - /** 浮动图片 id */ - float_image_id?: string - /** 浮动图片 token，需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */ - float_image_token?: string - /** 浮动图片的左上角单元格定位，只支持一个单元格 */ - range?: string - /** 浮动图片的宽度，大于等于 20px */ - width?: number - /** 浮动图片的高度，大于等于 20px */ - height?: number - /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移，大于等于0且小于所在单元格的宽度 */ - offset_x?: number - /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移，大于等于0且小于所在单元格的高度 */ - offset_y?: number - } - export type App = { - /** 多维表格 app token */ - app_token?: string - /** 多维表格 App 名字 */ - name?: string - /** 多维表格 App 归属文件夹 */ - folder_token?: string - /** 多维表格 App URL */ - url?: string - } - export type DisplayApp = { - /** 多维表格 app token */ - app_token?: string - /** 多维表格 App 名字 */ - name?: string - /** 多维表格 App 版本号 */ - revision?: number - /** 多维表格是否已开启高级权限 */ - is_advanced?: boolean - } - export type DisplayAppV2 = { - /** 多维表格 app token */ - app_token?: string - /** 多维表格 App 名字 */ - name?: string - /** 多维表格是否已开启高级权限 */ - is_advanced?: boolean - } - export type AppTableFieldPropertyOption = { - /** 选项名 */ - name?: string - /** 选项id */ - id?: string - /** 选项颜色 */ - color?: number - } - export type AppFieldPropertyAutoSerialOptions = { - /** 自动编号的可选规则项类型 */ - type: string - /** 与类型相对应的取值 */ - value: string - } - export type AppFieldPropertyAutoSerial = { - /** 自动编号类型 */ - type: string - /** 自动编号规则列表 */ - options?: Lark.AppFieldPropertyAutoSerialOptions[] - } - export type AppFieldPropertyLocation = { - /** 地理位置输入限制 */ - input_type: string - } - export type AllowedEditModes = { - /** 是否允许手动录入 */ - manual?: boolean - /** 是否允许移动端录入 */ - scan?: boolean - } - export type Rating = { - /** 评分字段的符号展示 */ - symbol?: string - } - export type AppTableFieldProperty = { - /** 单选、多选字段的选项信息 */ - options?: Lark.AppTableFieldPropertyOption[] - /** 数字、公式字段的显示格式 */ - formatter?: string - /** 日期、创建时间、最后更新时间字段的显示格式 */ - date_formatter?: string - /** 日期字段中新纪录自动填写创建时间 */ - auto_fill?: boolean - /** 人员、群组字段中允许添加多个成员，单向关联、双向关联中允许添加多个记录 */ - multiple?: boolean - /** 单向关联、双向关联字段中关联的数据表的id */ - table_id?: string - /** 单向关联、双向关联字段中关联的数据表的名字 */ - table_name?: string - /** 双向关联字段中关联的数据表中对应的双向关联字段的名字 */ - back_field_name?: string - /** 自动编号类型 */ - auto_serial?: Lark.AppFieldPropertyAutoSerial - /** 地理位置输入方式 */ - location?: Lark.AppFieldPropertyLocation - /** 公式字段的表达式 */ - formula_expression?: string - /** 字段支持的编辑模式 */ - allowed_edit_modes?: Lark.AllowedEditModes - /** 进度、评分等字段的数据范围最小值 */ - min?: number - /** 进度、评分等字段的数据范围最大值 */ - max?: number - /** 进度等字段是否支持自定义范围 */ - range_customize?: boolean - /** 货币币种 */ - currency_code?: string - /** 评分字段的相关设置 */ - rating?: Lark.Rating - } - export type AppTableFieldDescription = { - /** 是否禁止同步，如果为true，表示禁止同步该描述内容到表单的问题描述 */ - disable_sync?: boolean - /** 字段描述内容，支持换行 - */ - text?: string - } - export type AppTableCreateHeader = { - /** 字段名 */ - field_name: string - /** 字段类型 */ - type: number - /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ - ui_type?: string - /** 字段属性 */ - property?: Lark.AppTableFieldProperty - /** 字段的描述 */ - description?: Lark.AppTableFieldDescription - } - export type ReqTable = { - /** 数据表 名字 */ - name?: string - /** 默认表格视图的名称 */ - default_view_name?: string - /** 允许设置数据表的初始字段,默认第一个字段为索引列 */ - fields?: Lark.AppTableCreateHeader[] - } - export type AppTable = { - /** 表格Id */ - table_id?: string - /** 数据表 版本号 */ - revision?: number - /** 数据表 名字 */ - name?: string - } - export type AppDashboard = { - /** 仪表盘 ID */ - block_id: string - /** 仪表盘名字 */ - name: string - } - export type AppTableViewPropertyFilterInfoCondition = { - /** 用于过滤的字段唯一ID */ - field_id: string - /** 过滤操作的类型 */ - operator: string - /** 筛选值 */ - value?: string - } - export type AppTableViewPropertyFilterInfo = { - /** 多个筛选条件的关系 */ - conjunction: string - /** 筛选条件 */ - conditions: Lark.AppTableViewPropertyFilterInfoCondition[] - } - export type AppTableViewPropertyHierarchyConfig = { - /** 层级结构的关联列id */ - field_id?: string - } - export type AppTableViewProperty = { - /** 过滤条件 */ - filter_info?: Lark.AppTableViewPropertyFilterInfo - /** 隐藏字段ID列表 */ - hidden_fields?: string[] - /** 表格视图层级结构设置 */ - hierarchy_config?: Lark.AppTableViewPropertyHierarchyConfig - } - export type AppTableView = { - /** 视图Id */ - view_id?: string - /** 视图名字 */ - view_name?: string - /** 视图类型 */ - view_type?: string - /** 视图属性 */ - property?: Lark.AppTableViewProperty - } - export type AppTableForm = { - /** 表单名称 */ - name?: string - /** 表单描述 */ - description?: string - /** 是否开启共享 */ - shared?: boolean - /** 分享 URL */ - shared_url?: string - /** 分享范围限制 */ - shared_limit?: string - /** 填写次数限制一次 */ - submit_limit_once?: boolean - } - export type AppTableFormPatchedField = { - /** 上一个表单问题 ID */ - pre_field_id?: string - /** 表单问题 */ - title?: string - /** 问题描述 */ - description?: string - /** 是否必填 */ - required?: boolean - /** 是否可见 */ - visible?: boolean - } - export type AppTableFormField = { - /** 表单问题 ID */ - field_id?: string - /** 表单问题 */ - title?: string - /** 问题描述 */ - description?: string - /** 是否必填 */ - required?: boolean - /** 是否可见 */ - visible?: boolean - } - export type AppTableRecord = { - /** 记录字段 */ - fields: unknown - /** 记录Id */ - record_id?: string - /** 创建人 */ - created_by?: Lark.Person - /** 创建时间 */ - created_time?: number - /** 修改人 */ - last_modified_by?: Lark.Person - /** 最近更新时间 */ - last_modified_time?: number - } - export type Sort = { - /** 字段名称 */ - field_name?: string - /** 是否倒序排序 */ - desc?: boolean - } - export type DeleteRecord = { - /** 是否成功删除 */ - deleted?: boolean - /** 删除的记录id */ - record_id?: string - } - export type AppTableFieldForList = { - /** 字段名 */ - field_name: string - /** 字段类型 */ - type: number - /** 字段属性 */ - property?: Lark.AppTableFieldProperty - /** 字段的描述, text_field_as_array为false时值为字符串，为true则是对象数组 */ - description?: unknown - /** 是否是索引列 */ - is_primary?: boolean - /** 字段Id */ - field_id?: string - /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ - ui_type?: string - /** 是否是隐藏字段 */ - is_hidden?: boolean - } - export type AppTableField = { - /** 字段名 */ - field_name: string - /** 字段类型 */ - type: number - /** 字段属性 */ - property?: Lark.AppTableFieldProperty - /** 字段的描述 */ - description?: Lark.AppTableFieldDescription - /** 是否是索引列 */ - is_primary?: boolean - /** 字段Id */ - field_id?: string - /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ - ui_type?: string - /** 是否是隐藏字段 */ - is_hidden?: boolean - } - export type AppRoleTableRoleRecRuleCondition = { - /** 字段名 */ - field_name: string - /** 运算符 */ - operator?: string - /** 单选或多选字段的选项id */ - value?: string[] - /** 字段类型 */ - field_type?: number - } - export type AppRoleTableRoleRecRule = { - /** 记录筛选条件 */ - conditions: Lark.AppRoleTableRoleRecRuleCondition[] - /** 多个筛选条件的关系 */ - conjunction?: string - /** 其他记录权限，仅在table_perm为2时有效 */ - other_perm?: number - } - export type AppRoleTableRole = { - /** 数据表权限 */ - table_perm: number - /** 数据表名 */ - table_name?: string - /** 数据表ID */ - table_id?: string - /** 记录筛选条件，在table_perm为1或2时有意义，用于指定可编辑或可阅读某些记录 */ - rec_rule?: Lark.AppRoleTableRoleRecRule - /** 字段权限，仅在table_perm为2时有意义，设置字段可编辑或可阅读 */ - field_perm?: unknown - /** 新增记录权限，仅在table_perm为2时有意义，用于设置记录是否可以新增 */ - allow_add_record?: boolean - /** 删除记录权限，仅在table_perm为2时有意义，用于设置记录是否可以删除 */ - allow_delete_record?: boolean - } - export type AppRoleBlockRole = { - block_id: string - /** Block类型 */ - block_type?: string - /** Block权限 */ - block_perm: number - } - export type AppRole = { - /** 自定义权限的名字 */ - role_name: string - /** 自定义权限的id */ - role_id?: string - /** 数据表权限 */ - table_roles: Lark.AppRoleTableRole[] - /** block权限 */ - block_roles?: Lark.AppRoleBlockRole[] - } - export type AppRoleMemberId = { - /** 协作者 ID 类型 */ - type?: string - /** 协作者 ID */ - id: string - } - export type AppRoleMember = { - /** 用户的open_id */ - open_id?: string - /** 用户的union_id */ - union_id?: string - /** 用户的user_id */ - user_id?: string - /** 群聊的chat_id */ - chat_id?: string - /** 部门的department_id */ - department_id?: string - /** 部门的open_department_id */ - open_department_id?: string - /** 协作者名字 */ - member_name?: string - /** 协作者英文名 */ - member_en_name?: string - /** 协作者类型 */ - member_type?: string - } - export type Space = { - /** 知识空间名称 */ - name?: string - /** 知识空间描述 */ - description?: string - /** 知识空间id */ - space_id?: string - /** 表示知识空间类型（团队空间 或 个人空间） */ - space_type?: string - /** 表示知识空间可见性（公开空间 或 私有空间） */ - visibility?: string - } - export type Setting = { - /** 谁可以创建空间的一级页面： "admin_and_member" = 管理员和成员 "admin" - 仅管理员 */ - create_setting?: string - /** 可阅读用户可否创建副本/打印/导出/复制： "allow" - 允许 "not_allow" - 不允许 */ - security_setting?: string - /** 可阅读用户可否评论： "allow" - 允许 "not_allow" - 不允许 */ - comment_setting?: string - } - export type Node = { - /** 知识空间id，[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */ - space_id?: string - /** 节点token，[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */ - node_token?: string - /** 对应文档类型的token，可根据 obj_type 判断属于哪种文档类型。 */ - obj_token?: string - /** 文档类型，对于快捷方式，该字段是对应的实体的obj_type。 */ - obj_type: string - /** 父节点 token。若当前节点为一级节点，父节点 token 为空。 */ - parent_node_token?: string - /** 节点类型 */ - node_type: string - /** 快捷方式对应的实体node_token，当节点为快捷方式时，该值不为空。 */ - origin_node_token?: string - /** 快捷方式对应的实体所在的spaceid */ - origin_space_id?: string - /** 是否有子节点 */ - has_child?: boolean - /** 文档标题 */ - title?: string - /** 文档创建时间 */ - obj_create_time?: string - /** 文档最近编辑时间 */ - obj_edit_time?: string - /** 节点创建时间 */ - node_create_time?: string - /** 节点创建者 */ - creator?: string - /** 节点所有者 */ - owner?: string - } - export type MoveResult = { - /** 移动完成的节点信息 */ - node: Lark.Node - /** 节点移动状态码 */ - status: number - /** 节点移动状态信息 */ - status_msg: string - } - export type TaskResult = { - /** 任务id */ - task_id: string - /** MoveDocsToWiki任务结果 */ - move_result?: Lark.MoveResult[] - } - export type FileSubscription = { - /** 订阅关系ID */ - subscription_id?: string - /** 是否订阅 */ - subscription_type?: string - /** 是否订阅 */ - is_subcribe?: boolean - /** 文档类型 */ - file_type: string - } - export type Calendar = { - /** 日历OpenId */ - calendar_id: string - /** 日历标题 */ - summary?: string - /** 日历描述 */ - description?: string - permissions?: string - /** 日历颜色，颜色RGB值的int32表示。客户端展示时会映射到色板上最接近的一种颜色。仅对当前身份生效 */ - color?: number - /** 日历类型 */ - type?: string - /** 日历备注名，修改或添加后仅对当前身份生效 */ - summary_alias?: string - /** 对于当前身份，日历是否已经被标记为删除 */ - is_deleted?: boolean - /** 当前日历是否是第三方数据；三方日历及日程只支持读，不支持写入 */ - is_third_party?: boolean - /** 当前身份对于该日历的访问权限 */ - role?: string - } - export type UserCalendar = { - /** 日历实体信息 */ - calendar?: Lark.Calendar - /** 日历的创建者user ID */ - user_id?: string - } - export type Freebusy = { - /** 忙闲信息开始时间，RFC3339 date_time格式 */ - start_time: string - /** 忙闲信息结束时间，RFC3339 date_time格式 */ - end_time: string - } - export type AclScope = { - /** 权限类型，当type为User时，值为open_id/user_id/union_id */ - type: string - /** 用户ID */ - user_id?: string - } - export type CalendarAcl = { - /** acl资源ID */ - acl_id: string - /** 对日历的访问权限 */ - role: string - /** 权限范围 */ - scope: Lark.AclScope - } - export type TimeInfo = { - /** 仅全天日程使用该字段，如2018-09-01。需满足 RFC3339 格式。不能与 time_stamp 同时指定 */ - date?: string - /** 秒级时间戳，如1602504000(表示2020/10/12 20:0:00 +8时区) */ - timestamp?: string - /** 时区名称，使用IANA Time Zone Database标准，如Asia/Shanghai；全天日程时区固定为UTC，非全天日程时区默认为Asia/Shanghai */ - timezone?: string - } - export type MeetingSettings = { - /** 设置会议 owner */ - owner_id?: string - /** 设置入会范围 */ - join_meeting_permission?: string - /** 指定主持人 */ - assign_hosts?: string[] - /** 设置自动录制 */ - auto_record?: boolean - /** 开启等候室 */ - open_lobby?: boolean - /** 允许日程参与者发起会议 */ - allow_attendees_start?: boolean - } - export type Vchat = { - /** 视频会议类型 */ - vc_type?: string - /** 第三方视频会议icon类型 */ - icon_type?: string - /** 第三方视频会议文案，可以为空，为空展示默认文案 */ - description?: string - /** 视频会议URL */ - meeting_url?: string - /** VC视频会议的会前设置 */ - meeting_settings?: Lark.MeetingSettings - } - export type EventLocation = { - /** 地点名称 */ - name?: string - /** 地点地址 */ - address?: string - /** 地点坐标纬度信息，对于国内的地点，采用GCJ-02标准，海外地点采用WGS84标准 */ - latitude?: number - /** 地点坐标经度信息，对于国内的地点，采用GCJ-02标准，海外地点采用WGS84标准 */ - longitude?: number - } - export type Schema = { - /** UI项名称 TODO文档 */ - ui_name?: string - /** UI项自定义状态 */ - ui_status?: string - /** 按钮点击后跳转的链接 */ - app_link?: string - } - export type CalendarEvent = { - /** 日程ID */ - event_id: string - /** 日程组织者日历ID */ - organizer_calendar_id?: string - /** 日程标题 */ - summary?: string - /** 日程描述 */ - description?: string - /** 是否发送通知消息 */ - need_notification?: boolean - /** 日程开始时间 */ - start_time: Lark.TimeInfo - /** 日程结束时间 */ - end_time: Lark.TimeInfo - /** 视频会议信息，仅当日程至少有一位attendee时生效 */ - vchat?: Lark.Vchat - /** 日程公开范围，新建日程默认为Default；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ - visibility?: string - /** 参与人权限 */ - attendee_ability?: string - /** 日程占用的忙闲状态，新建日程默认为Busy；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ - free_busy_status?: string - /** 日程地点 */ - location?: Lark.EventLocation - /** 日程颜色，颜色RGB值的int32表示。仅对当前身份生效；客户端展示时会映射到色板上最接近的一种颜色；值为0或-1时默认跟随日历颜色。 */ - color?: number - /** 日程提醒列表 */ - reminders?: Lark.Reminder[] - /** 重复日程的重复性规则 */ - recurrence?: string - /** 日程状态 */ - status?: string - /** 日程是否是一个重复日程的例外日程 */ - is_exception?: boolean - /** 例外日程的原重复日程的event_id */ - recurring_event_id?: string - /** 日程的创建时间戳 */ - create_time?: string - /** 日程自定义信息 */ - schemas?: Lark.Schema[] - } - export type EventSearchFilter = { - /** 搜索过滤项，日程搜索区间的开始时间，被搜索日程的事件必须与搜索区间有交集 */ - start_time?: Lark.TimeInfo - /** 搜索过滤项，日程搜索区间的结束时间，被搜索日程的事件必须与搜索区间有交集 */ - end_time?: Lark.TimeInfo - /** 搜索过滤项，参与人的用户ID列表，被搜索日程中必须包含至少一个其中的参与人 */ - user_ids?: string[] - /** 搜索过滤项，会议室ID列表，被搜索日程中必须包含至少一个其中的会议室 */ - room_ids?: string[] - /** 搜索过滤项，群ID列表，被搜索日程的参与人中必须包含至少一个其中的群 */ - chat_ids?: string[] - } - export type Instance = { - /** 日程实例ID */ - event_id: string - /** 日程主题 */ - summary?: string - /** 日程描述 */ - description?: string - /** 开始时间 */ - start_time?: Lark.TimeInfo - /** 结束时间 */ - end_time?: Lark.TimeInfo - /** 日程状态 */ - status?: string - /** 是否是例外日程实例 */ - is_exception?: boolean - /** 日程的app_link,跳转到具体的某个日程 */ - app_link?: string - /** 日程地点 */ - location?: Lark.EventLocation - } - export type EventOrganizer = { - /** 日程组织者user ID */ - user_id?: string - /** 日程组织者姓名 */ - display_name?: string - } - export type AttendeeChatMember = { - /** 参与人RSVP状态 */ - rsvp_status?: string - /** 参与人是否为「可选参加」 */ - is_optional?: boolean - /** 参与人名称 */ - display_name?: string - /** 参与人是否为日程组织者 */ - is_organizer?: boolean - /** 参与人是否为外部参与人 */ - is_external?: boolean - } - export type CustomizationOption = { - /** the option unique key */ - option_key?: string - /** should be filled if the option is others option */ - others_content?: string - } - export type CalendarAttendeeResourceCustomization = { - /** the unique key of customization option */ - index_key: string - /** should be filled when the type of customization is input */ - input_content?: string - options?: Lark.CustomizationOption[] - } - export type CalendarEventAttendee = { - /** 参与人类型，仅当新建参与人时可设置类型
- type为User时，值为open_id/user_id/union_id
- type为Chat时，值为open_chat_id
- type为Resource时，值为open_room_id
- type为ThirdParty时，值为third_party_email；不支持通过API新建该类型参与人 */ - type?: string - /** 参与人ID */ - attendee_id?: string - /** 参与人RSVP状态 */ - rsvp_status?: string - /** 参与人是否为「可选参加」，无法编辑群参与人的此字段 */ - is_optional?: boolean - /** 参与人是否为日程组织者 */ - is_organizer?: boolean - /** 参与人是否为外部参与人；外部参与人不支持编辑 */ - is_external?: boolean - /** 参与人名称 */ - display_name?: string - /** 群中的群成员，当type为Chat时有效；群成员不支持编辑 */ - chat_members?: Lark.AttendeeChatMember[] - /** 参与人的用户id，依赖于user_id_type返回对应的取值，当is_external为true时，此字段只会返回open_id或者union_id */ - user_id?: string - /** chat类型参与人的群组chat_id */ - chat_id?: string - /** resource类型参与人的会议室room_id */ - room_id?: string - /** third_party类型参与人的邮箱 */ - third_party_email?: string - /** bot身份操作时，为预定的会议室指定实际预定人 */ - operate_id?: string - /** 会议室的个性化配置 */ - resource_customization?: Lark.CalendarAttendeeResourceCustomization[] - /** 会议室审批原因 */ - approval_reason?: string - } - export type TimeoffEvent = { - /** 休假申请的唯一标识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 type CalendarEventAttendeeId = { - /** 参与人类型，仅当新建参与人时可设置类型
- type为User时，值为open_id/user_id/union_id
- type为Chat时，值为open_chat_id
- type为Resource时，值为open_room_id
- type为ThirdParty时，值为third_party_email；不支持通过API新建该类型参与人 */ - type?: string - /** 参与人的用户id，依赖于user_id_type返回对应的取值，当is_external为true时，此字段只会返回open_id或者union_id */ - user_id?: string - /** chat类型参与人的群组chat_id */ - chat_id?: string - /** resource类型参与人的会议室room_id */ - room_id?: string - /** third_party类型参与人的邮箱 */ - third_party_email?: string - } - export type CalendarEventAttendeeChatMember = { - /** 参与人RSVP状态 */ - rsvp_status?: string - /** 参与人是否为「可选参加」 */ - is_optional?: boolean - /** 参与人名称 */ - display_name?: string - /** 用户open_id */ - open_id?: string - /** 参与人是否为日程组织者 */ - is_organizer?: boolean - /** 参与人是否为外部参与人 */ - is_external?: boolean - } - export type ExchangeBinding = { - /** admin账户 */ - admin_account?: string - /** 用户绑定的Exchange账户 */ - exchange_account?: string - /** Exchange账户绑定user唯一标识id */ - user_id?: string - /** Exchange账户同步状态 */ - status?: string - /** exchange绑定唯一标识id */ - exchange_binding_id: string - } - export type ReservePermissionChecker = { - /** 检查字段类型 */ - check_field: number - /** 检查方式 */ - check_mode: number - /** 检查字段列表 */ - check_list: string[] - } - export type ReserveActionPermission = { - /** 权限项 */ - permission: number - /** 权限检查器列表，权限检查器之间为"逻辑或"的关系（即 有一个为true则拥有该权限） */ - permission_checkers: Lark.ReservePermissionChecker[] - } - export type PstnSipInfo = { - /** 给pstn/sip用户设置的临时昵称 */ - nickname?: string - /** pstn/sip主机号 */ - main_address: string - } - export type ReserveCallee = { - /** 用户ID */ - id?: string - /** 用户类型 */ - user_type: number - /** pstn/sip信息 */ - pstn_sip_info?: Lark.PstnSipInfo - } - export type ReserveCallSetting = { - /** 被呼叫的用户 */ - callee: Lark.ReserveCallee - } - export type ReserveAssignHost = { - /** 用户类型，仅支持设置同租户下的 Lark 用户 */ - user_type?: number - /** 用户ID */ - id?: string - } - export type ReserveMeetingSetting = { - /** 会议主题 */ - topic?: string - /** 会议权限配置列表，如果存在相同的权限配置项则它们之间为"逻辑或"的关系（即 有一个为true则拥有该权限） */ - action_permissions?: Lark.ReserveActionPermission[] - /** 会议初始类型 */ - meeting_initial_type?: number - /** 1v1呼叫相关参数 */ - call_setting?: Lark.ReserveCallSetting - /** 使用飞书视频会议时，是否开启自动录制，默认false */ - auto_record?: boolean - /** 指定主持人列表 */ - assign_host_list?: Lark.ReserveAssignHost[] - } - export type Reserve = { - /** 预约ID */ - id?: string - /** 9位会议号 */ - meeting_no?: string - /** 会议链接 */ - url?: string - /** APPLink用于唤起飞书APP入会。"{?}"为占位符，用于配置入会参数，使用时需替换具体值：0表示关闭，1表示打开。preview为入会前的设置页，mic为麦克风，speaker为扬声器，camera为摄像头 */ - app_link?: string - /** 直播链接 */ - live_link?: string - /** 预约到期时间（unix时间，单位sec） */ - end_time?: string - } - export type ReserveCorrectionCheckInfo = { - /** 指定主持人无效id列表 */ - invalid_host_id_list?: string[] - } - export type MeetingUser = { - /** 用户ID */ - id?: string - /** 用户类型 */ - user_type?: number - } - export type MeetingParticipant = { - /** 用户ID */ - id?: string - /** 首次入会时间，秒级Unix时间戳 */ - first_join_time?: string - /** 最终离会时间，秒级Unix时间戳 */ - final_leave_time?: string - /** 累计在会中时间，时间单位：秒 */ - in_meeting_duration?: string - /** 用户类型 */ - user_type?: number - /** 是否为主持人 */ - is_host?: boolean - /** 是否为联席主持人 */ - is_cohost?: boolean - /** 是否为外部参会人 */ - is_external?: boolean - /** 参会人状态 */ - status?: number - } - export type MeetingAbility = { - /** 是否使用视频 */ - use_video?: boolean - /** 是否使用音频 */ - use_audio?: boolean - /** 是否使用共享屏幕 */ - use_share_screen?: boolean - /** 是否使用妙享（magic share） */ - use_follow_screen?: boolean - /** 是否使用录制 */ - use_recording?: boolean - /** 是否使用PSTN */ - use_pstn?: boolean - } - export type Meeting = { - /** 会议ID */ - id?: string - /** 会议主题 */ - topic?: string - /** 会议链接 */ - url?: string - /** 会议号 */ - meeting_no?: string - /** 会议创建时间（unix时间，单位sec） */ - create_time?: string - /** 会议开始时间（unix时间，单位sec） */ - start_time?: string - /** 会议结束时间（unix时间，单位sec） */ - end_time?: string - /** 主持人 */ - host_user?: Lark.MeetingUser - /** 会议状态 */ - status?: number - /** 峰值参会人数 */ - participant_count?: string - /** 累计参会人数 */ - participant_count_accumulated?: string - /** 参会人列表 */ - participants?: Lark.MeetingParticipant[] - /** 会中使用的能力 */ - ability?: Lark.MeetingAbility - } - export type MeetingInviteStatus = { - /** 用户ID */ - id?: string - /** 用户类型 */ - user_type?: number - /** 邀请结果 */ - status?: number - } - export type MeetingParticipantResult = { - /** 用户ID */ - id?: string - /** 用户类型 */ - user_type?: number - /** 结果 */ - result?: number - } - export type MeetingRecording = { - /** 录制文件URL */ - url?: string - /** 录制总时长（单位msec） */ - duration?: string - } - export type RecordingPermissionObject = { - /** 授权对象ID */ - id?: string - /** 授权对象类型 */ - type: number - /** 授予权限 */ - permission: number - } - export type ReportMeetingDaily = { - /** 日期（unix时间，单位sec） */ - date?: string - /** 会议数量 */ - meeting_count?: string - /** 会议时长（单位sec） */ - meeting_duration?: string - /** 参会人数 */ - participant_count?: string - } - export type Report = { - /** 总会议数量 */ - total_meeting_count?: string - /** 总会议时长（单位sec） */ - total_meeting_duration?: string - /** 总参会人数 */ - total_participant_count?: string - /** 每日会议报告列表 */ - daily_report?: Lark.ReportMeetingDaily[] - } - export type ReportTopUser = { - /** 用户ID */ - id?: string - /** 用户名 */ - name?: string - /** 用户类型 */ - user_type?: number - /** 会议数量 */ - meeting_count?: string - /** 会议时长（单位sec） */ - meeting_duration?: string - } - export type RoomLevel = { - /** 层级ID */ - room_level_id?: string - /** 层级名称 */ - name?: string - /** 父层级ID */ - parent_id?: string - /** 层级路径 */ - path?: string[] - /** 是否有子层级 */ - has_child?: boolean - /** 自定义层级id */ - custom_group_id?: string - } - export type RoomStatus = { - /** 是否启用会议室 */ - status: boolean - /** 会议室未来状态为启用或禁用 */ - schedule_status?: boolean - /** 禁用开始时间（unix时间，单位sec） */ - disable_start_time?: string - /** 禁用结束时间（unix时间，单位sec，数值0表示永久禁用） */ - disable_end_time?: string - /** 禁用原因 */ - disable_reason?: string - /** 联系人列表，id类型由user_id_type参数决定 */ - contact_ids?: string[] - /** 是否在禁用时发送通知给预定了该会议室的员工 */ - disable_notice?: boolean - /** 是否在恢复启用时发送通知给预定了该会议室的员工 */ - resume_notice?: boolean - } - export type Device = { - /** 设施名称 */ - name: string - } - export type Room = { - /** 会议室ID */ - room_id?: string - /** 会议室名称 */ - name?: string - /** 会议室能容纳的人数 */ - capacity?: number - /** 会议室的相关描述 */ - description?: string - /** 会议室的展示ID */ - display_id?: string - /** 自定义的会议室ID */ - custom_room_id?: string - /** 层级ID */ - room_level_id?: string - /** 层级路径 */ - path?: string[] - /** 会议室状态 */ - room_status?: Lark.RoomStatus - /** 设施信息列表 */ - device?: Lark.Device[] - } - export type RoomDigitalSignageMaterial = { - /** 素材ID */ - id?: string - /** 素材名称 */ - name?: string - /** 素材类型 */ - material_type?: number - /** 素材url */ - url?: string - /** 播放时长（单位sec） */ - duration?: number - /** 素材封面url */ - cover?: string - /** 素材文件md5 */ - md5?: string - /** 素材文件vid */ - vid?: string - /** 素材文件大小（单位byte） */ - size?: string - } - export type RoomDigitalSignage = { - /** 是否覆盖子层级及会议室 */ - if_cover_child_scope?: boolean - /** 是否开启数字标牌功能 */ - enable?: boolean - /** 是否静音播放 */ - mute?: boolean - /** 日程会议开始前n分钟结束播放 */ - start_display?: number - /** 会议结束后n分钟开始播放 */ - stop_display?: number - /** 素材列表 */ - materials?: Lark.RoomDigitalSignageMaterial[] - } - export type RoomConfig = { - /** 飞书会议室背景图 */ - room_background?: string - /** 飞书签到板背景图 */ - display_background?: string - /** 飞书会议室数字标牌 */ - digital_signage?: Lark.RoomDigitalSignage - /** 飞书投屏盒子数字标牌 */ - room_box_digital_signage?: Lark.RoomDigitalSignage - /** 会议室状态 */ - room_status?: Lark.RoomStatus - } - export type ScopeConfig = { - /** 查询节点范围 */ - scope_type: number - /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */ - scope_id: string - /** 节点配置 */ - scope_config?: Lark.RoomConfig - } - export type SubscribeUser = { - /** 预订人id */ - user_id: string - } - export type ApprovalConfig = { - /** 预定审批开关，0关闭，1打开 */ - approval_switch?: number - /** 预定审批条件，0所有预定需要审批，1满足条件需审批 */ - approval_condition?: number - /** 超过 meeting_duration小时需要审批 */ - meeting_duration?: number - /** 审批人列表 */ - approvers?: Lark.SubscribeUser[] - } - export type TimeConfig = { - /** 是否覆盖子层级及会议室 */ - if_cover_child_scope?: boolean - /** 预定时间开关，0关闭，1开启 */ - time_switch: number - /** 最早可提前#{days_in_advance}天预定会议室，以天为单位 */ - days_in_advance?: number - /** 开放当天可于#{opening_hour} 开始预定，以秒为单位 */ - opening_hour?: string - /** 每日可预定时间范围开始时间，以秒为单位 */ - start_time?: string - /** 每日可预定时间范围结束时间，以秒为单位 */ - end_time?: string - /** 单次可预定时长上限,以小时为单位 */ - max_duration?: number - } - export type SubscribeDepartment = { - /** 预定部门id */ - department_id: string - } - export type ReserveScopeConfig = { - /** 是否覆盖子层级及会议室 */ - if_cover_child_scope?: boolean - /** 可预定成员范围，0部分成员，1全部成员 */ - allow_all_users?: number - /** 可预定成员列表 */ - allow_users?: Lark.SubscribeUser[] - /** 可预定部门列表 */ - allow_depts?: Lark.SubscribeDepartment[] - } - export type ReserveFormConfig = { - /** 是否覆盖子层级及会议室 */ - if_cover_child_scope?: boolean - /** 预定表单开关 */ - reserve_form: boolean - /** 通知人列表 */ - notified_users?: Lark.SubscribeUser[] - /** 最晚于会议开始前 notified_time收到通知(单位:分/时/天) */ - notified_time?: number - /** 时间单位,1为分钟;2为小时;3为天，默认为天 */ - time_unit?: number - } - export type ReserveAdminConfig = { - /** 预定管理部门 */ - depts?: Lark.SubscribeDepartment[] - /** 预定管理用户 */ - users?: Lark.SubscribeUser[] - } - export type DisableInformConfig = { - /** 是否覆盖子层级及会议室 */ - if_cover_child_scope?: boolean - /** 禁用状态变更通知开关 */ - if_inform: boolean - /** 通知成员列表 */ - informed_users?: Lark.SubscribeUser[] - /** 通知部门列表 */ - informed_depts?: Lark.SubscribeDepartment[] - } - export type MeetingInfo = { - /** 9位会议号 */ - meeting_id?: string - /** 会议主题 */ - meeting_topic?: string - /** 组织者 */ - organizer?: string - /** 部门 */ - department?: string - /** 用户ID */ - user_id?: string - /** 工号 */ - employee_id?: string - /** 邮箱 */ - email?: string - /** 手机 */ - mobile?: string - /** 会议开始时间 */ - meeting_start_time?: string - /** 会议结束时间 */ - meeting_end_time?: string - /** 会议持续时间 */ - meeting_duration?: string - /** 参会人数 */ - number_of_participants?: string - /** 音频 */ - audio?: boolean - /** 视频 */ - video?: boolean - /** 共享 */ - sharing?: boolean - /** 录制 */ - recording?: boolean - /** 电话 */ - telephone?: boolean - } - export type Participant = { - /** 参会者 */ - participant_name?: string - /** 部门 */ - department?: string - /** 用户ID */ - user_id?: string - /** 工号 */ - employee_id?: string - /** 电话 */ - phone?: string - /** 邮箱 */ - email?: string - /** 设备 */ - device?: string - /** 客户端版本 */ - app_version?: string - /** 公网IP */ - public_ip?: string - /** 内网IP */ - internal_ip?: string - /** 代理服务 */ - use_rtc_proxy?: boolean - /** 位置 */ - location?: string - /** 网络类型 */ - network_type?: string - /** 连接类型 */ - protocol?: string - /** 麦克风 */ - microphone?: string - /** 扬声器 */ - speaker?: string - /** 摄像头 */ - camera?: string - /** 音频 */ - audio?: boolean - /** 视频 */ - video?: boolean - /** 共享 */ - sharing?: boolean - /** 入会时间 */ - join_time?: string - /** 离会时间 */ - leave_time?: string - /** 参会时长 */ - time_in_meeting?: string - /** 离会原因 */ - leave_reason?: string - } - export type QualityNetwork = { - /** 时间 */ - time?: string - /** 网络延迟 */ - network_delay?: string - /** 码率（接收） */ - bitrate_received?: string - /** 丢包 - 平均（接收） */ - packet_loss_avg_received?: string - /** 丢包 - 最大（接收） */ - packet_loss_max_received?: string - /** 码率（发送） */ - bitrate_sent?: string - /** 丢包 - 平均（发送） */ - packet_loss_avg_sent?: string - /** 丢包 - 最大（发送） */ - packet_loss_max_sent?: string - } - export type QualityAudio = { - /** 时间 */ - time?: string - /** 麦克风采集音量 */ - mic_input_volume?: string - /** 扬声器播放音量 */ - speaker_volume?: string - /** 码率（接收） */ - bitrate_received?: string - /** 延迟（接收） */ - latency_received?: string - /** 抖动（接收） */ - jitter_received?: string - /** 码率（发送） */ - bitrate_sent?: string - /** 延迟（发送） */ - latency_sent?: string - /** 抖动（发送） */ - jitter_sent?: string - } - export type QualityVideoSharing = { - /** 时间 */ - time?: string - /** 码率（接收） */ - bitrate_received?: string - /** 延迟（接收） */ - latency_received?: string - /** 抖动（接收） */ - jitter_received?: string - /** 最大分辨率（接收） */ - maximum_resolution_received?: string - /** 帧率（接收） */ - framerate_received?: string - /** 码率（发送） */ - bitrate_sent?: string - /** 延迟（发送） */ - latency_sent?: string - /** 抖动（发送） */ - jitter_sent?: string - /** 最大分辨率（发送） */ - maximum_resolution_sent?: string - /** 帧率（发送） */ - framerate_sent?: string - } - export type QualityCpuUsage = { - /** 时间 */ - time?: string - /** 客户端平均 CPU 占用 */ - client_avg_cpu_usage?: string - /** 客户端最大 CPU 占用 */ - client_max_cpu_usage?: string - /** 系统平均 CPU 占用 */ - system_avg_cpu_usage?: string - /** 系统最大 CPU 占用 */ - system_max_cpu_usage?: string - } - export type ParticipantQuality = { - /** 网络 */ - network?: Lark.QualityNetwork - /** 音频 */ - audio?: Lark.QualityAudio - /** 视频 */ - video?: Lark.QualityVideoSharing - /** 共享屏幕 */ - screen_sharing?: Lark.QualityVideoSharing - /** Cpu使用量 */ - cpu_usage?: Lark.QualityCpuUsage - } - export type RoomMeetingReservation = { - /** 会议室ID */ - room_id?: string - /** 会议室名称 */ - room_name?: string - /** 会议标题 */ - event_title?: string - /** 预定人 */ - reserver?: string - /** 预定人所属部门 */ - department_of_reserver?: string - /** 邀约人数 */ - guests_number?: string - /** 接受人数 */ - accepted_number?: string - /** 会议开始时间 */ - event_start_time?: string - /** 会议结束时间 */ - event_end_time?: string - /** 会议时长 */ - event_duration?: string - /** 会议室预定状态 */ - reservation_status?: string - /** 签到设备 */ - check_in_device?: string - /** 会议室签到状态 */ - room_check_in_status?: string - /** 会议室签到时间 */ - check_in_time?: string - /** 是否提前释放 */ - is_release_early?: string - /** 释放人 */ - releasing_person?: string - /** 释放时间 */ - releasing_time?: string - } - export type Contact = { - contact_type?: number - /** 联系人名 */ - contact_name?: string - } - export type Alert = { - /** 告警ID */ - alert_id?: string - /** 触发告警规则的会议室/服务器具体的名称 */ - resource_scope?: string - /** 触发告警规则的监控对象 */ - monitor_target?: number - /** 告警规则的规则描述 */ - alert_strategy?: string - /** 告警通知发生时间（unix时间，单位sec） */ - alert_time?: string - /** 告警等级：严重/警告/提醒 */ - alert_level?: number - /** 告警联系人 */ - contacts?: Lark.Contact[] - /** 通知方式 */ - notifyMethods?: number[] - /** 规则名称 */ - alertRule?: string - /** 处理时间 */ - process_time?: string - /** 恢复时间 */ - recover_time?: string - /** 处理状态：待处理/处理中/已恢复 */ - process_status?: number - } - export type FlexibleRule = { - /** 下班最多可早走（上班早到几分钟，下班可早走几分钟） */ - flexible_early_minutes: number - /** 上班最多可晚到（上班晚到几分钟，下班须晚走几分钟） */ - flexible_late_minutes: number - } - export type PunchTimeRule = { - /** 上班时间 */ - on_time: string - /** 下班时间 */ - off_time: string - /** 晚到多久记为迟到 */ - late_minutes_as_late: number - /** 晚到多久记为缺卡 */ - late_minutes_as_lack: number - /** 最早多久可打上班卡 */ - on_advance_minutes: number - /** 早退多久记为早退 */ - early_minutes_as_early: number - /** 早退多久记为缺卡 */ - early_minutes_as_lack: number - /** 最晚多久可打下班卡 */ - off_delay_minutes: number - /** 晚到多久记为严重迟到 */ - late_minutes_as_serious_late?: number - } - export type LateOffLateOnRule = { - /** 晚走多久 */ - late_off_minutes: number - /** 晚到多久 */ - late_on_minutes: number - } - export type RestRule = { - /** 休息开始 */ - rest_begin_time: string - /** 休息结束 */ - rest_end_time: string - } - export type OvertimeRule = { - /** 上班时间 */ - on_overtime: string - /** 下班时间 */ - off_overtime: string - } - export type Shift = { - /** 班次Id */ - shift_id: string - /** 班次名称 */ - shift_name: string - /** 打卡次数 */ - punch_times: number - /** 排班组子负责人id列表 */ - sub_shift_leader_ids?: string[] - /** 是否弹性打卡 */ - is_flexible?: boolean - /** 弹性打卡时间，设置【上班最多可晚到】与【下班最多可早走】时间，如果不设置flexible_rule则生效 */ - flexible_minutes?: number - /** 弹性打卡时间设置 */ - flexible_rule?: Lark.FlexibleRule[] - /** 不需要打下班卡 */ - no_need_off?: boolean - /** 打卡规则 */ - punch_time_rule: Lark.PunchTimeRule[] - /** 晚走晚到规则 */ - late_off_late_on_rule?: Lark.LateOffLateOnRule[] - /** 休息规则 */ - rest_time_rule?: Lark.RestRule[] - /** 打卡规则 */ - overtime_rule?: Lark.OvertimeRule[] - /** 是否允许在非打卡时段申请打卡 */ - allow_punch_approval?: boolean - } - export type Machine = { - /** 考勤机序列号 */ - machine_sn: string - /** 考勤机名称 */ - machine_name: string - } - export type Location = { - /** 地址名称 */ - location_name: string - /** 地址类型，GPS地址，1；WiFi的Mac地址，2；IP地址。8 */ - location_type: number - /** 地址维度 */ - latitude?: number - /** 地址经度 */ - longitude?: number - /** WiFi名称 */ - ssid?: string - /** WiFi的Mac地址 */ - bssid?: string - /** 地图类型，1：高德， 2：谷歌 */ - map_type?: number - /** 地址名称 */ - address?: string - /** IP地址 */ - ip?: string - /** 额外信息，例如运营商信息 */ - feature?: string - /** 距离范围 */ - gps_range?: number - } - export type FreePunchCfg = { - /** 自由打卡开始时间 */ - free_start_time: string - /** 自由打卡结束时间 */ - free_end_time: string - /** 打卡的时间，一共7位，每一位代表一天，周一到周日，0是不上班，1是上班 */ - punch_day: number - /** 工作日不打卡即为缺卡 */ - work_day_no_punch_as_lack?: boolean - /** 工作日出勤是否需满足时长要求 */ - work_hours_demand?: boolean - /** 每日工作时长（分钟),范围[0,1440] */ - work_hours?: number - } - export type PunchSpecialDateShift = { - /** 打卡日期 */ - punch_day: number - /** 班次 ID */ - shift_id: string - } - export type MemberStatusChange = { - /** 是否入职日上班无需打卡 */ - onboarding_on_no_need_punch?: boolean - /** 是否入职日下班无需打卡 */ - onboarding_off_no_need_punch?: boolean - /** 是否离职日上班无需打卡 */ - offboarding_on_no_need_punch?: boolean - /** 是否离职日下班无需打卡 */ - offboarding_off_no_need_punch?: boolean - } - export type LeaveNeedPunchCfg = { - /** 晚到超过多久记为迟到 */ - late_minutes_as_late?: number - /** 晚到超过多久记为缺卡 */ - late_minutes_as_lack?: number - /** 早走超过多久记为早退 */ - early_minutes_as_early?: number - /** 早走超过多久记为缺卡 */ - early_minutes_as_lack?: number - } - export type ScopeValue = { - /** 标识Key */ - key?: string - /** 名称 */ - name?: string - } - export type ScopeGroup = { - /** 类型： 1: 部门 2：人员 3:国家地区 4:员工类型 5:工作城市 6:职级 7:序列 8:职务（企业版）9:工时制度（企业版） 100:自定义字段（企业版） */ - scope_value_type?: number - /** 范围类型（是否包含） */ - operation_type?: number - /** 如果是人员/部门类型 不需要使用该字段 */ - right?: Lark.ScopeValue[] - /** 部门/人员id列表（具体类型根据scope_value_type判断） */ - member_ids?: string[] - /** 企业版自定义字段唯一键 ID, 需要从飞书人事那边获取 */ - custom_field_ID?: string - /** 企业版自定义字段对象类型 "employment":主数据对象，员工雇佣信息 , "person":主数据对象，个人 */ - custom_field_obj_type?: string - } - export type PunchMember = { - /** 圈人方式：0 无 1全部 2自定义 */ - rule_scope_type?: number - /** 圈人规则列表 */ - scope_group_list?: Lark.ScopeGroup - } - export type GroupMeta = { - /** 考勤组id */ - group_id: string - /** 考勤组名称 */ - group_name: string - } - export type UserDailyShift = { - /** 考勤组ID */ - group_id: string - /** 班次ID */ - shift_id: string - /** 月份 */ - month: number - /** 用户工号 */ - user_id: string - /** 日期 */ - day_no: number - } - export type ChildItem = { - /** 二级表头code */ - code: string - /** 值 */ - value: string - } - export type Item = { - /** 用户统计设置一级项 */ - code: string - /** 用户统计设置二级项 */ - child_items?: Lark.ChildItem[] - } - export type UserStatsView = { - /** 视图id */ - view_id: string - /** 视图类型 */ - stats_type: string - /** 用户id */ - user_id: string - /** 用户设置字段 */ - items?: Lark.Item[] - } - export type ChildField = { - /** 统计数据子字段code */ - code: string - /** 统计数据子字段名称 */ - title: string - /** 时间单位 */ - time_unit?: string - } - export type Field = { - /** 统计数据父字段code */ - code: string - /** 统计数据父字段名称 */ - title: string - /** 统计数据子字段 */ - child_fields?: Lark.ChildField[] - } - export type UserStatsField = { - /** 视图类型 */ - stats_type: string - /** 用户id */ - user_id: string - /** 字段名称 */ - fields: Lark.Field[] - } - export type UserStatsDataFeature = { - /** 统计数据列附加属性的名称 */ - key: string - /** 统计数据列附加属性的值 */ - value: string - } - export type UserStatsDataCell = { - /** code */ - code: string - /** value */ - value: string - /** 属性 */ - features?: Lark.UserStatsDataFeature[] - /** title */ - title?: string - } - export type UserStatsData = { - /** 用户姓名 */ - name: string - /** 用户id */ - user_id: string - /** 用户的统计数据 */ - datas?: Lark.UserStatsDataCell[] - } - export type UserOut = { - /** 审批实例id */ - approval_id?: string - /** 外出类型唯一ID，代表一种假期类型，长度小于14 */ - uniq_id: string - /** 外出时长单位。可用值：1：上半天；2：下半天；3：全天；4：小时。 */ - unit: number - /** 外出时长（单位秒） */ - interval: number - /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - start_time: string - /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - end_time: string - /** 外出多语言展示，格式为map，key为["ch"、"en"、"ja"]，其中ch代表中文，en 代表英文、ja代表日文 */ - i18n_names: Lark.I18nNames - /** 默认语言类型，由于飞书客户端支持中、英、日三种语言，如果用户切换语言时，假期名称没有对应语言的名称，会使用默认语言的名称 */ - default_locale: string - /** 外出理由 */ - reason: string - /** 审批通过时间 */ - approve_pass_time?: string - /** 审批申请时间 */ - approve_apply_time?: string - } - export type UserLeave = { - /** 审批实例id */ - approval_id?: string - /** 假期类型唯一ID，代表一种假期类型，长度小于14 */ - uniq_id?: string - /** 假期时长单位。可用值：1：天；2：小时；3：半天；4：半小时。 */ - unit: number - /** 假期时长（单位秒） */ - interval: number - /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - start_time: string - /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - end_time: string - /** 假期多语言展示，格式为map，key为["ch"、"en"、"ja"]，其中ch代表中文，en 代表英文、ja代表日文 */ - i18n_names: Lark.I18nNames - /** 默认语言类型，由于飞书客户端支持中、英、日三种语言，如果用户切换语言时，假期名称没有对应语言的名称，会使用默认语言的名称 */ - default_locale: string - /** 请假理由 */ - reason: string - /** 审批通过时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - approve_pass_time?: string - /** 审批申请时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - approve_apply_time?: string - } - export type UserOvertimeWork = { - /** 审批实例id */ - approval_id?: string - /** 加班时长 */ - duration: number - /** 加班时长单位。可用值：1：天；2：小时。 */ - unit: number - /** 加班类型 */ - category: number - /** 加班规则类型 */ - type: number - /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - start_time: string - /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - end_time: string - } - export type UserTrip = { - /** 审批实例id */ - approval_id?: string - /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - start_time: string - /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - end_time: string - /** 出差理由 */ - reason: string - /** 审批通过时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - approve_pass_time: string - /** 审批申请时间，时间格式为 yyyy-MM-dd HH:mm:ss */ - approve_apply_time: string - } - export type UserApproval = { - /** 审批用户工号 */ - user_id: string - /** 审批作用日期 */ - date: string - /** 外出的信息 */ - outs?: Lark.UserOut[] - /** 请假的信息 */ - leaves?: Lark.UserLeave[] - /** 加班的信息 */ - overtime_works?: Lark.UserOvertimeWork[] - /** 出差 */ - trips?: Lark.UserTrip[] - /** 计算时间所用的时区信息，为空是0时区 */ - time_zone?: string - } - export type ApprovalInfo = { - /** 审批实例id */ - approval_id: string - /** 审批类型，remedy为补卡 */ - approval_type: string - /** 审批状态，1为不通过，2为通过，4为撤销 */ - status: number - } - export type UserTaskRemedy = { - /** 用户工号 */ - user_id: string - /** 补卡日期 */ - remedy_date: number - /** 第几次上下班，可能值0，1，2 */ - punch_no: number - /** 上班/下班，1是上班，2是下班 */ - work_type: number - /** 审批id */ - approval_id?: string - /** 补卡时间 */ - remedy_time: string - /** 补卡状态 */ - status?: number - /** 补卡原因 */ - reason: string - /** 补卡时间戳，精确到秒的时间戳 */ - time?: string - /** 补卡时考勤组时区 */ - time_zone?: string - /** 补卡发起时间，精确到秒的时间戳 */ - create_time?: string - /** 补卡状态更新时间，精确到秒的时间戳 */ - update_time?: string - } - export type UserAllowedRemedy = { - /** 用户id */ - user_id: string - /** 补卡日期 */ - remedy_date: number - /** 是否为自由班次 */ - is_free_punch?: boolean - /** 第几次上下班，可能值0，1，2 */ - punch_no?: number - /** 上班/下班，1是上班，2是下班 */ - work_type?: number - /** 打卡状态，可用值：Early（早退），Late（迟到），Lack（缺卡） */ - punch_status?: string - /** 正常应打卡时间 */ - normal_punch_time?: string - /** 可选补卡时间的最小值 */ - remedy_start_time?: string - /** 可选补卡时间的最大值 */ - remedy_end_time?: string - } - export type UserFlow = { - /** 用户工号 */ - user_id: string - /** 记录创建者的工号 */ - creator_id: string - /** 打卡位置名称信息 */ - location_name: string - /** 打卡时间，精确到秒的时间戳 */ - check_time: string - /** 打卡备注 */ - comment: string - /** 打卡记录ID */ - record_id?: string - /** 打卡wifi ssid */ - ssid?: string - /** 打卡wifi MAC地址 */ - bssid?: string - /** 是否为外勤打卡 */ - is_field?: boolean - /** 是否为wifi打卡 */ - is_wifi?: boolean - /** 记录生成方式 */ - type?: number - /** 打卡照片列表 */ - photo_urls?: string[] - /** 打卡结果 */ - check_result?: string - } - export type UserTask = { - /** 打卡记录ID */ - result_id: string - /** 用户工号 */ - user_id: string - /** 用户姓名 */ - employee_name: string - /** 日期 */ - day: number - /** 考勤组ID */ - group_id: string - /** 班次ID */ - shift_id: string - /** 用户考勤记录 */ - records: Lark.TaskResult[] - } - export type UserSetting = { - /** 用户id */ - user_id: string - /** 人脸Key */ - face_key: string - /** 人脸照片更新时间 */ - face_key_update_time?: string - } - export type LangText = { - /** 语言码 */ - lang: string - /** 语言码对应的文本 */ - value: string - } - export type LeaveEmployExpireRecord = { - /** record id */ - id: string - /** 员工ID */ - employment_id: string - /** 假期类型ID */ - leave_type_id: string - /** 授予余额数量 */ - granting_quantity: string - /** 授予数量 扣减完后的授予数量 */ - left_granting_quantity: string - /** 授予单位，1表示天，2表示小时 */ - granting_unit: number - /** 生效日期，格式"2020-01-01" */ - effective_date: string - /** 失效日期，格式"2020-01-01" */ - expiration_date: string - /** 授予原因 */ - reason: Lark.LangText[] - /** 是否已经被外部系统更改过 */ - is_update_by_external: boolean - /** 授予来源 */ - accrual_source: number - /** 假期子类型id */ - leave_sub_type_id: string - } - export type LeaveAccrualRecord = { - /** 授予记录唯一ID */ - id: string - /** 员工ID */ - employment_id: string - /** 假期类型ID */ - leave_type_id: string - /** 授予数量 */ - granting_quantity: string - /** 授予单位，1表示天，2表示小时 */ - granting_unit: number - /** 生效日期，格式"2020-01-01" */ - effective_date: string - /** 失效日期，格式"2020-01-01" */ - expiration_date: string - /** 授予来源，1：系统授予；2：手动授予；3：外部系统授予 */ - granted_by: number - /** 授予原因 */ - reason: Lark.LangText[] - /** 授予记录的创建时间，unix时间戳 */ - created_at: string - /** 授予记录的创建人的ID */ - created_by: string - /** 授予记录的更新时间，unix时间戳 */ - updated_at: string - /** 授予记录的更新人的ID */ - updated_by: string - } - export type ApprovalCreateViewers = { - /** 可见人类型，如果 viewer_type 是 TENANT 和 NONE, viewer_user_id， viewer_department_id可不填 */ - viewer_type?: string - /** 当 viewer_type 是 USER，根据user_id_type填写用户id */ - viewer_user_id?: string - /** 当 view_type 为DEPARTMENT，根据department_id_type填写部门id */ - viewer_department_id?: string - } - export type ApprovalForm = { - /** 审批定义表单内容，json 数组 */ - form_content: string - /** 控件之间数据条件约束表达式 */ - widget_relation?: string - } - export type ApprovalApproverCcer = { - /** 审批节点上的审批人，1.当 type 为 Supervisor、SupervisorTopDown、DepartmentManager 、DepartmentManagerTopDown 这 4 种时，需要在 level 中填写对应的级数，例如：由下往上三级主管审批，level = 3；2.当 type 为 Personal 时，需要根据x_user_id填写user_id，用于指定用户；3.当 approver 为 Free 发起人自选时，不需要指定 user_id ；ccer不支持 Free 发起人自选 */ - type: string - /** 用户id，根据user_id_type填写 */ - user_id?: string - /** 审批级数，当 type 为 Supervisor、SupervisorTopDown、DepartmentManager 、DepartmentManagerTopDown 这 4 种时，需要在 level 中填写对应的级数，例如：由下往上三级主管审批，level = 3 */ - level?: string - } - export type FieldGroup = { - /** 可写权限的表单项的 id列表 */ - writable: string[] - /** 可读权限的表单项的 id列表 */ - readable: string[] - } - export type ApproverRange = { - /** 审批人类型 */ - type?: string - /** 审批人id */ - id_list?: string[] - } - export type ApprovalNode = { - /** 节点 ID，开始节点的 ID 为 START，结束节点的 ID 为 END，开始和结束节点不需要指定 name、node_type 以及 approver */ - id: string - /** 节点名称的国际化文案 Key，以 @i18n@ 开头，长度不得少于 9 个字符 */ - name?: string - /** 审批类型枚举,当 node_type 为依次审批时，审批人必须为『发起人自选』 */ - node_type?: string - /** 审批人列表 */ - approver?: Lark.ApprovalApproverCcer[] - /** 抄送人列表 */ - ccer?: Lark.ApprovalApproverCcer[] - /** 表单项的控件权限 */ - privilege_field?: Lark.FieldGroup - /** 自选审批人是否允许多选 */ - approver_chosen_multi?: boolean - /** 自选审批人选择范围 */ - approver_chosen_range?: Lark.ApproverRange[] - /** 审批人为提交人时的操作 */ - starter_assignee?: string - } - export type ApprovalSetting = { - /** 审批实例通过后允许撤回的时间，以秒为单位，默认 31 天，0 为不可撤回 */ - revert_interval?: number - /** 是否支持审批通过第一个节点后撤回，默认为1，0为不支持 */ - revert_option?: number - /** 拒绝设置 */ - reject_option?: number - /** 快捷审批配置项，开启后可在卡片上直接审批。默认值1为启用， 0为禁用 */ - quick_approval_option?: number - } - export type I18nResourceText = { - key: string - value: string - } - export type I18nResource = { - /** 语言可选值有： zh-CN：中文 en-US：英文 ja-JP：日文 */ - locale: string - /** 文案 key, value, i18n key 以 @i18n@ 开头； 该字段主要用于做国际化，语序用户同时传多个语言的文案，审批中心会根据用户当前的语音环境使用对应的文案，如果没有传用户当前的语音环境文案，则会使用默认的语言文案。 */ - texts: Lark.I18nResourceText[] - /** 是否默认语言，默认语言需要包含所有key，非默认语言如果key不存在会使用默认语言代替 */ - is_default: boolean - } - export type NodeApprover = { - /** node id 或 custom node id */ - key?: string - /** 通过 查看审批定义 获取 value: 审批人列表 */ - value?: string[] - } - export type NodeCc = { - /** node id 或 custom node id */ - key?: string - /** 通过 查看审批定义 获取 value: 审批人列表 */ - value?: string[] - } - export type PreviewNode = { - /** 节点id */ - node_id?: string - /** 节点名称 */ - node_name?: string - /** 节点类型 “AND":会签 “OR”:或签 */ - node_type?: string - /** 节点描述 */ - comments?: string[] - /** 租户节点id */ - custom_node_id?: string - /** 审批人id列表 */ - user_id_list?: string[] - /** 节点结束抄送人id列表 */ - end_cc_id_list?: string[] - /** 审批人是否为空 */ - is_empty_logic?: boolean - /** 是否是发起人自选类型 */ - is_approver_type_free?: boolean - /** 是否包含抄送人自选类型 */ - has_cc_type_free?: boolean - } - export type InstanceTask = { - /** task id */ - id: string - /** 审批人的用户id，自动通过、自动拒绝 时为空 */ - user_id: string - /** 审批人 open id */ - open_id?: string - status: string - /** task 所属节点 id */ - node_id?: string - /** task 所属节点名称 */ - node_name?: string - /** task 所属节点自定义 id, 如果没设置自定义 id, 则不返回该字段 */ - custom_node_id?: string - /** 审批方式 */ - type?: string - /** task 开始时间 */ - start_time: string - /** task 完成时间, 未完成为 0 */ - end_time?: string - } - export type InstanceComment = { - /** 评论 id */ - id: string - /** 发表评论用户 */ - user_id: string - /** 发表评论用户 open id */ - open_id: string - /** 评论内容 */ - comment: string - /** 1564590532967 */ - create_time: string - /** 评论附件 */ - files?: Lark.File[] - } - export type InstanceCcUser = { - /** 抄送人 user id */ - user_id?: string - /** 审批实例内抄送唯一标识 */ - cc_id?: string - /** 抄送人 open id */ - open_id?: string - } - export type InstanceTimeline = { - /** 动态类型，不同类型 ext 内的 user_id_list 含义不一样 */ - type: string - /** 发生时间 */ - create_time: string - /** 动态产生用户 */ - user_id?: string - /** 动态产生用户 open id */ - open_id?: string - /** 被抄送人列表 */ - user_id_list?: string[] - /** 被抄送人列表 */ - open_id_list?: string[] - /** 产生动态关联的task_id */ - task_id?: string - /** 理由 */ - comment?: string - /** 抄送人列表 */ - cc_user_list?: Lark.InstanceCcUser[] - /** 动态其他信息，json格式，目前包括 user_id_list, user_id，open_id_list，open_id */ - ext: string - /** 产生task的节点key */ - node_key?: string - /** 审批附件 */ - files?: Lark.File[] - } - export type CommentAtInfo = { - /** 被艾特人的ID */ - user_id: string - /** 被艾特人的姓名 */ - name: string - /** 被艾特人在评论中的位置，从0开始 */ - offset: string - } - export type CommentReply = { - /** 评论ID */ - id: string - /** 评论内容 */ - content: string - /** 评论创建时间 */ - create_time?: string - /** 评论更新时间 */ - update_time?: string - /** 是否删除，0:未删除，1:已删除 */ - is_delete: number - /** 评论中艾特人信息 */ - at_info_list?: Lark.CommentAtInfo[] - /** 评论创建人 */ - commentator: string - /** 附加字段 */ - extra?: string - } - export type Comment = { - /** 评论ID */ - id: string - /** 评论内容 */ - content: string - /** 评论创建时间 */ - create_time: string - /** 评论更新时间 */ - update_time: string - /** 是否删除，0:未删除，1:已删除 */ - is_delete: number - /** 评论的回复 */ - replies?: Lark.CommentReply[] - /** 评论中艾特人信息 */ - at_info_list?: Lark.CommentAtInfo[] - /** 评论创建人 */ - commentator: string - /** 附加字段 */ - extra?: string - } - export type ApprovalCreateExternal = { - /** 列表中用于提示审批来自哪里，i18n key， 注意不需要“来自”前缀，审批中心会拼上前缀 */ - biz_name?: string - /** 审批定义业务类别 */ - biz_type?: string - /** 移动端发起链接，如果设置了该链接，则会在移动端审批发起页展示该审批，用户点击后会跳转到该链接进行发起； 如果不填，则在mobile端不显示该审批 */ - create_link_mobile?: string - /** PC端发起链接，如果设置了该链接，则会在PC端审批发起页展示该审批，用户点击后会跳转到该链接进行发起； 如果不填，则在PC端不显示该审批； */ - create_link_pc?: string - /** 审批实例、审批任务、审批抄送是否要在PC端展示，如果为 true，则PC端列表会展示该定义下的实例信息，否则，不展示 */ - support_pc?: boolean - /** 审批实例、审批任务、审批抄送是否要在移动端展示，如果为 true，则移动端列表会展示该定义下的实例信息，否则，不展示； support_pc和support_mobile不可都为false，否则不展示 */ - support_mobile?: boolean - /** 是否支持批量已读 */ - support_batch_read?: boolean - /** 是否支持标注可读 */ - enable_mark_readed?: boolean - /** 是否支持快速操作 */ - enable_quick_operate?: boolean - /** 三方系统的操作回调 url，【待审批】列表的任务审批人点同意或拒绝操作后，审批中心调用该地址通知三方系统，回调地址相关信息可参见：https://open.feishu.cn/document/ukTMukTMukTM/ukjNyYjL5YjM24SO2IjN/quick-approval-callback */ - action_callback_url?: string - /** 回调时带的 token， 用于业务系统验证请求来自审批,具体参考 https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM */ - action_callback_token?: string - /** 请求参数加密密钥，如果配置了该参数，则会对请求参数进行加密，业务需要对请求进行解密，加解密算法参考 https://open.feishu.cn/document/ukTMukTMukTM/uADM4QjLwADO04CMwgDN */ - action_callback_key?: string - /** 是否支持批量审批 */ - allow_batch_operate?: boolean - /** 审批流程数据是否不纳入效率统计 */ - exclude_efficiency_statistics?: boolean - } - export type ExternalInstanceLink = { - /** pc 端的跳转链接，当用户使用飞书 pc 端时，使用该字段进行跳转 */ - pc_link: string - /** 移动端 跳转链接，当用户使用飞书 移动端时，使用该字段进行跳转 */ - mobile_link?: string - } - export type ExternalInstanceForm = { - /** 表单字段名称 */ - name?: string - /** 表单值 */ - value?: string - } - export type ActionConfig = { - /** 操作类型，每个任务都可以配置2个操作，会展示审批列表中，当用户操作时，回调请求会带上该字段，表示用户进行了同意操作还是拒绝操作。APPROVE - 同意 REJECT - 拒绝 {KEY} - 任意字符串，如果使用任意字符串，则需要提供 action_name */ - action_type: string - /** 操作名称，i18n key 用于前台展示，如果 action_type 不是 APPROVAL和REJECT，则必须提供该字段，用于展示特定的操作名称 */ - action_name?: string - /** 是否需要意见, 如果为true,则用户操作时，会跳转到 意见填写页面 */ - is_need_reason?: boolean - /** 审批意见是否必填 */ - is_reason_required?: boolean - /** 意见是否支持上传附件 */ - is_need_attachment?: boolean - } - export type ExternalInstanceTaskNode = { - /** 审批实例内的唯一标识，用于更新审批任务时定位数据 */ - task_id: string - /** 审批人 user_id，该任务会出现在审批人的【待审批】或【已审批】列表中 */ - user_id?: string - /** 审批人 open id，和 user id 二选一 */ - open_id?: string - /** 审批任务名称 */ - title?: string - /** 【待审批】或【已审批】中使用的跳转链接，用于跳转回三方系统pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ - links: Lark.ExternalInstanceLink - /** 任务状态 */ - status: string - /** 扩展 json */ - extra?: string - /** 任务创建时间，Unix 毫秒时间戳 */ - create_time: string - /** 任务完成时间：未结束的审批为 0，Unix 毫秒时间戳 */ - end_time: string - /** task最近更新时间，用于推送数据版本控制； 更新策略同 instance 中的 update_time */ - update_time?: string - /** 操作上下文，当用户操作时，回调请求中带上该参数，用于传递该任务的上下文数据 */ - action_context?: string - /** 任务级别操作配置,快捷审批目前支持移动端操作 */ - action_configs?: Lark.ActionConfig[] - /** 列表页打开审批任务的方式 */ - display_method?: string - /** 三方任务支持不纳入效率统计 */ - exclude_statistics?: boolean - /** 节点id */ - node_id?: string - /** 节点名称，示例：i18n@name。需要在i18n_resources中传该名称对应的国际化文案 */ - node_name?: string - } - export type CcNode = { - /** 审批实例内唯一标识 */ - cc_id: string - /** 抄送人 employee id */ - user_id?: string - /** 抄送人 open id，和user id 二选一 */ - open_id?: string - /** 跳转链接，用于【抄送我的】列表中的跳转pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ - links: Lark.ExternalInstanceLink - /** 阅读状态，空值表示不支持已读未读： */ - read_status: string - /** 扩展 json */ - extra?: string - /** 抄送任务名称 */ - title?: string - /** 抄送发起时间，Unix 毫秒时间戳 */ - create_time: string - /** 抄送最近更新时间，用于推送数据版本控制更新策略同 instance 的update_time */ - update_time: string - /** 列表页打开审批任务的方式 */ - display_method?: string - } - export type TrusteeshipUrls = { - /** 获取表单schema相关数据的url地址 */ - form_detail_url?: string - /** 表示获取审批操作区数据的url地址 */ - action_definition_url?: string - /** 获取审批记录相关数据的url地址 */ - approval_node_url?: string - /** 进行审批操作时回调的url地址 */ - action_callback_url?: string - /** 获取托管动态数据URL,使用该接口时必须要保证历史托管单据的数据中都同步了该接口地址,如果历史单据中没有该接口需要重新同步历史托管单据的数据来更新该URL */ - pull_business_data_url?: string - } - export type TrusteeshipInstanceCacheConfig = { - /** 托管预缓存策略 */ - form_policy?: string - /** 表单是否随国际化改变 */ - form_vary_with_locale?: boolean - /** 当前使用的表单版本号，保证表单改变后，版本号增加，实际值为int64整数 */ - form_version?: string - } - export type ExternalInstance = { - /** 审批定义 code， 创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段 */ - approval_code: string - /** 审批实例状态 */ - status: string - /** 审批实例扩展 JSON */ - extra?: string - /** 审批实例唯一标识，用户自定义，需确保证租户、应用下唯一 */ - instance_id: string - /** 审批实例链接集合 ，用于【已发起】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ - links: Lark.ExternalInstanceLink - /** 审批展示名称，如果填写了该字段，则审批列表中的审批名称使用该字段，如果不填该字段，则审批名称使用审批定义的名称 */ - title?: string - /** 用户提交审批时填写的表单数据，用于所有审批列表中展示。可传多个值，但审批中心pc展示前2个,移动端展示前3个,长度不超过2048字符 */ - form?: Lark.ExternalInstanceForm[] - /** 审批发起人 user_id，发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】，【已审批】【抄送我】列表中，该字段展示审批是谁发起的。审批发起人 open id，和 user id 二选一。 */ - user_id?: string - /** 审批发起人 用户名，如果发起人不是真实的用户（例如是某个部门），没有 user_id，则可以使用该字段传名称 */ - user_name?: string - /** 审批发起人 open id，和 user id 二选一 */ - open_id?: string - /** 发起人部门，用于列表中展示发起人所属部门。不传则不展示。如果用户没加入任何部门，传 ""，将展示租户名称传 department_name 展示部门名称 */ - department_id?: string - /** 审批发起人 部门，如果发起人不是真实的用户（例如是某个部门），没有 department_id，则可以使用该字段传名称 */ - department_name?: string - /** 审批发起时间，Unix毫秒时间戳 */ - start_time: string - /** 审批实例结束时间：未结束的审批为 0，Unix毫秒时间戳 */ - end_time: string - /** 审批实例最近更新时间；用于推送数据版本控制如果 update_mode 值为 UPDATE，则只有传过来的 update_time 有变化时（变大），才会更新审批中心中的审批实例信息。使用该字段主要用来避免并发时老的数据更新了新的数据 */ - update_time: string - /** 列表页打开审批实例的方式 */ - display_method?: string - /** 更新方式， 当 update_mode=REPLACE时，每次都以当前推送的数据为最终数据，会删掉审批中心中多余的任务、抄送数据（不在这次推送的数据中）; 当 update_mode=UPDATE时，则不会删除审批中心的数据，而只是进行新增和更新实例、任务数据 */ - update_mode?: string - /** 任务列表 */ - task_list?: Lark.ExternalInstanceTaskNode[] - /** 抄送列表 */ - cc_list?: Lark.CcNode[] - /** 国际化文案 */ - i18n_resources: Lark.I18nResource[] - /** 单据托管认证token，托管回调会附带此token，帮助业务方认证 */ - trusteeship_url_token?: string - /** 用户的类型，会影响请求参数用户标识域的选择，包括加签操作回传的目标用户， 目前仅支持 "user_id" */ - trusteeship_user_id_type?: string - /** 单据托管回调接入方的接口的URL地址 */ - trusteeship_urls?: Lark.TrusteeshipUrls - /** 托管预缓存策略 */ - trusteeship_cache_config?: Lark.TrusteeshipInstanceCacheConfig - } - export type ExternalInstanceTask = { - /** 任务 id */ - task_id: string - /** 任务最近更新时间 */ - update_time: string - } - export type ExteranlInstanceCheck = { - /** 审批实例 id */ - instance_id: string - /** 审批实例最近更新时间 */ - update_time: string - /** 任务信息 */ - tasks: Lark.ExternalInstanceTask[] - } - export type ExteranlInstanceCheckResponse = { - /** 审批实例 id */ - instance_id: string - /** 任务最近更新时间 */ - update_time?: string - /** 任务信息 */ - tasks?: Lark.ExternalInstanceTask[] - } - export type ExternalTaskItem = { - /** 审批任务 ID */ - id: string - /** 审批任务状态 */ - status: string - /** 审批任务最后更新时间，单位 毫秒 */ - update_time: string - } - export type ExternalTaskList = { - /** 审批实例 ID */ - instance_id: string - /** 审批的id */ - approval_id: string - /** 审批对应的 approval_code */ - approval_code: string - /** 审批实例当前的状态 */ - status: string - /** 审批实例最后更新时间，单位 毫秒 */ - update_time: string - /** 审批实例下的审批任务 */ - tasks?: Lark.ExternalTaskItem[] - } - export type InstanceSearchApprovalExternal = { - /** 是否支持批量读 */ - batch_cc_read?: boolean - } - export type InstanceSearchApproval = { - /** 审批定义 code */ - code?: string - /** 审批定义名称 */ - name?: string - /** 是否为第三方审批 */ - is_external?: boolean - /** 第三方审批信息 */ - external?: Lark.InstanceSearchApprovalExternal - /** 审批定义Id */ - approval_id?: string - /** 审批定义图标信息 */ - icon?: string - } - export type InstanceSearchGroup = { - /** 审批定义分组外部 id */ - external_id?: string - /** 审批定义分组名称 */ - name?: string - } - export type InstanceSearchLink = { - /** 审批实例 pc 端链接 */ - pc_link?: string - /** 审批实例移动端链接 */ - mobile_link?: string - } - export type InstanceSearchNode = { - /** 审批实例 code */ - code?: string - /** 审批实例外部 id */ - external_id?: string - /** 审批实例发起人 id */ - user_id?: string - /** 审批实例开始时间 */ - start_time?: string - /** 审批实例结束时间 */ - end_time?: string - /** 审批实例状态 */ - status?: string - /** 审批实例名称（只有第三方审批有） */ - title?: string - /** 审批实例扩展字段，string型json */ - extra?: string - /** 审批流水号 */ - serial_id?: string - /** 审批实例链接（只有第三方审批有） */ - link?: Lark.InstanceSearchLink - } - export type InstanceSearchItem = { - /** 审批定义 */ - approval?: Lark.InstanceSearchApproval - /** 审批定义分组 */ - group?: Lark.InstanceSearchGroup - /** 审批实例信息 */ - instance?: Lark.InstanceSearchNode - } - export type CcSearchNode = { - /** 审批实例发起人 id */ - user_id?: string - /** 审批实例开始时间 */ - create_time?: string - /** 审批实例状态 */ - read_status?: string - /** 审批实例名称（只有第三方审批有） */ - title?: string - /** 审批实例扩展字段，string型json */ - extra?: string - /** 审批实例链接（只有第三方审批有） */ - link?: Lark.InstanceSearchLink - } - export type CcSearchItem = { - /** 审批定义 */ - approval?: Lark.InstanceSearchApproval - /** 审批定义分组 */ - group?: Lark.InstanceSearchGroup - /** 审批实例信息 */ - instance?: Lark.InstanceSearchNode - /** 审批任务 */ - cc?: Lark.CcSearchNode - } - export type TaskSearchNode = { - /** 审批任务发起人 id */ - user_id?: string - /** 审批任务开始时间 */ - start_time?: string - /** 审批任务结束时间 */ - end_time?: string - /** 审批任务状态 */ - status?: string - /** 审批实例名称（只有第三方审批有） */ - title?: string - /** 审批任务扩展字段，string型json */ - extra?: string - /** 审批任务链接（只有第三方审批有） */ - link?: Lark.InstanceSearchLink - /** 任务id */ - task_id?: string - /** 审批任务更新时间 */ - update_time?: string - /** 三方审批扩展 ID */ - task_external_id?: string - } - export type TaskSearchItem = { - /** 审批定义 */ - approval?: Lark.InstanceSearchApproval - /** 审批定义分组 */ - group?: Lark.InstanceSearchGroup - /** 审批实例信息 */ - instance?: Lark.InstanceSearchNode - /** 审批任务 */ - task?: Lark.TaskSearchNode - } - export type TaskUrls = { - /** 帮助服务台 URL */ - helpdesk?: string - /** 移动端 URL */ - mobile?: string - /** PC 端 URL */ - pc?: string - } - export type WeekdaySchedule = { - /** 开始时间, format 00:00 - 23:59 */ - start_time?: string - /** 结束时间, format 00:00 - 23:59 */ - end_time?: string - /** 星期几, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, 6 - Saturday, 7 - Sunday, 9 - Everday, 10 - Weekday, 11 - Weekend */ - weekday?: number - } - export type AgentScheduleUpdateInfo = { - /** agent id */ - agent_id?: string - /** schedule listing */ - schedule?: Lark.WeekdaySchedule[] - /** skill ids */ - agent_skill_ids?: string[] - } - export type AgentUser = { - /** user id */ - id?: string - /** user avartal url */ - avatar_url?: string - /** user name */ - name?: string - /** user email */ - email?: string - /** user department */ - department?: string - /** company */ - company_name?: string - } - export type AgentSkillLessInfo = { - /** skill id */ - id?: string - /** name of agent skill */ - name?: string - /** is default group type */ - is_default?: boolean - } - export type AgentSchedule = { - /** status of agent */ - status?: number - /** agent info */ - agent?: Lark.AgentUser - /** day schedule */ - schedule?: Lark.WeekdaySchedule[] - /** agent skills */ - agent_skills?: Lark.AgentSkillLessInfo[] - } - export type AgentSkillRule = { - /** attribute id */ - id?: string - /** selected operator, 2 for GreaterEqual, 3 for LessEqual, 4 for RangeValue, 5 for In, 6 for NotIn, 7 for MultiSelectExcludeAll, 8 for MultiSelectContainAny, 9 for ContainAny, 10 for ExcludeAll, 11 for ContainAll, 12 for MultiSelectContainAll */ - selected_operator?: number - /** operand value based on selected_operator */ - operand?: string - /** 1 for FAQ, 2 for Ticket, 3 for User, 4 for PreInquiryForm */ - category?: number - } - export type AgentSkill = { - /** name of agent skill */ - name?: string - /** rules for group */ - rules?: Lark.AgentSkillRule[] - /** agent ids in this group */ - agent_ids?: string[] - } - export type Agent = { - /** user id */ - id?: string - /** user avatar url */ - avatar_url?: string - /** user name */ - name?: string - } - export type TicketUser = { - /** user id */ - id?: string - /** user avartal url */ - avatar_url?: string - /** user name */ - name?: string - /** user email */ - email?: string - /** user department */ - department?: string - /** 城市 */ - city?: string - /** 国家代号(CountryCode)，参考：http://www.mamicode.com/info-detail-2186501.html */ - country?: string - } - export type Comments = { - /** 备注 */ - content?: string - /** 备注时间，单位毫秒 */ - created_at?: number - /** 备注ID */ - id?: number - /** 备注人头像 */ - user_avatar_url?: string - /** 备注人姓名 */ - user_name?: string - /** 备注人ID */ - user_id?: number - } - export type I18n = { - /** 中文描述 */ - zh_cn?: string - /** 英文描述 */ - en_us?: string - /** 日文描述 */ - ja_jp?: string - } - export type CustomizedFieldDisplayItem = { - /** id */ - id?: string - /** value */ - value?: string - /** key name */ - key_name?: string - /** display name */ - display_name?: string - /** position */ - position?: number - /** required */ - required?: boolean - /** editable */ - editable?: boolean - } - export type Ticket = { - /** ticket id */ - ticket_id: string - /** helpdesk id */ - helpdesk_id?: string - /** guest of this ticket */ - guest?: Lark.TicketUser - /** 备注 */ - comments?: Lark.Comments - /** ticket type */ - ticket_type?: number - /** ticket status */ - status?: number - /** ticket score */ - score?: number - /** the time when the ticket is created */ - created_at?: unknown - /** the time when the ticket is updated */ - updated_at?: unknown - /** the time when the ticket is closed */ - closed_at?: unknown - /** 不满意原因 */ - dissatisfaction_reason?: Lark.I18n - /** agents of this ticket */ - agents?: Lark.TicketUser[] - /** the ticket channel */ - channel?: number - /** if ticket is solved */ - solve?: number - /** closed user of this ticket */ - closed_by?: Lark.TicketUser - /** collaborators of this ticket */ - collaborators?: Lark.TicketUser[] - /** ticket customized fields */ - customized_fields?: Lark.CustomizedFieldDisplayItem[] - /** 客服服务时长，客服最后一次回复时间距离客服进入时间间隔，单位秒 */ - agent_service_duration?: number - /** 客服首次回复时间距离客服进入时间的间隔，单位秒 */ - agent_first_response_duration?: unknown - /** 机器人服务时间：客服进入时间距离工单创建时间的间隔，单位秒 */ - bot_service_duration?: unknown - /** 客服解决时长，关单时间距离客服进入时间的间隔，单位秒 */ - agent_resolution_time?: unknown - /** 工单实际处理时间：从客服进入到关单，单位秒 */ - actual_processing_time?: unknown - /** 客服进入时间，单位毫秒 */ - agent_entry_time?: unknown - /** 客服首次回复时间，单位毫秒 */ - agent_first_response_time?: unknown - /** 客服最后回复时间，单位毫秒 */ - agent_last_response_time?: unknown - /** 主责客服 */ - agent_owner?: Lark.TicketUser - } - export type UserQueryFaqInfo = { - /** faq id */ - id?: string - /** faq match score */ - score?: number - } - export type UserCustomizedField = { - /** user customized field id */ - user_customized_field_id?: string - /** user customized field id, for backward compatibility */ - id?: string - /** help desk id */ - helpdesk_id?: string - /** key name */ - key_name?: string - /** display name */ - display_name?: string - /** the position of user 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 - } - export type TicketCustomizedField = { - /** 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?: Lark.TicketUser - /** the user who recently updated the ticket customized field */ - updated_by?: Lark.TicketUser - /** if the dropdown field supports multi-select */ - dropdown_allow_multiple?: boolean - } - export type TicketMessage = { - /** message id in helpdesk */ - id?: string - /** open message id */ - message_id?: string - /** message type, text is the only supported type */ - message_type: string - /** create time */ - created_at?: number - /** message content */ - content: string - /** user name */ - user_name?: string - /** avatar url */ - avatar_url?: string - /** user id */ - user_id?: string - } - export type FaqUpdateInfo = { - /** faq category id */ - category_id?: string - /** faq question */ - question: string - /** faq answer */ - answer?: string - /** faq answer in richtext */ - answer_richtext?: string - /** faq tags */ - tags?: string[] - } - export type Richtext = { - /** 内容 */ - content?: string - /** 类型 */ - type?: string - } - export type Category = { - /** category id */ - category_id: string - /** category id, for backward compatibility */ - id: string - /** category name */ - name: string - /** parent category id, if any */ - parent_id: string - /** helpdesk id */ - helpdesk_id: string - /** category language */ - language?: string - } - export type Faq = { - /** faq id */ - faq_id?: string - /** faq id, for backward compatibility */ - id?: string - /** helpdesk id */ - helpdesk_id?: string - /** faq question */ - question?: string - /** faq answer in plain text format */ - answer?: string - /** faq answer in richtext format, if any */ - answer_richtext?: Lark.Richtext[] - /** create time */ - create_time?: number - /** update time */ - update_time?: number - /** list of categories that faq belongs to */ - categories?: Lark.Category[] - /** faq tags */ - tags?: string[] - /** expire time */ - expire_time?: number - /** update user */ - update_user?: Lark.TicketUser - /** create user */ - create_user?: Lark.TicketUser - } - export type NotificationUser = { - /** 用户id */ - user_id?: string - /** 头像地址 */ - avatar_url?: string - /** 用户名称 */ - name?: string - } - export type NotificationDepartment = { - /** 部门ID */ - department_id?: string - /** 部门名称 */ - name?: string - } - export type NotificationChat = { - /** 会话ID */ - chat_id?: string - /** 会话名称 */ - name?: string - } - export type Notification = { - /** 唯一ID */ - id?: string - /** 任务名称 */ - job_name?: string - /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */ - status?: number - /** 创建人 */ - create_user?: Lark.NotificationUser - /** 创建时间（毫秒时间戳） */ - created_at?: string - /** 更新用户 */ - update_user?: Lark.NotificationUser - /** 更新时间（毫秒时间戳） */ - updated_at?: string - /** 目标推送用户 */ - target_user_count?: number - /** 已推送用户总数 */ - sent_user_count?: number - /** 已读用户总数 */ - read_user_count?: number - /** 推送任务触发时间（毫秒时间戳） */ - send_at?: string - /** 推送内容，详见：https://open.feishu.cn/tool/cardbuilder?from=howtoguide */ - push_content?: string - /** 0（定时推送：push_scope不能等于3） 1（新人入职推送：push_scope必须等于1或者3；new_staff_scope_type不能为空） */ - push_type?: number - /** 推送范围（服务台私信） 0：组织内全部成员（user_list和department_list必须为空） 1：不推送任何成员（user_list和department_list必须为空，chat_list不可为空） 2：推送到部分成员（user_list或department_list不能为空） 3：入职新人 以上四种状态，chat_list都相对独立，只有在推送范围为1时，必须需要设置chat_list */ - push_scope_type?: number - /** 新人入职范围类型（push_type为1时生效） 0：组织内所有新人 1：组织内特定的部门（new_staff_scope_department_list 字段不能为空） */ - new_staff_scope_type?: number - /** 新人入职生效部门列表 */ - new_staff_scope_department_list?: Lark.NotificationDepartment[] - /** push推送到成员列表 */ - user_list?: Lark.NotificationUser[] - /** push推送到的部门信息列表 */ - department_list?: Lark.NotificationDepartment[] - /** push推送到的会话列表(群) */ - chat_list?: Lark.NotificationChat[] - /** 预留扩展字段 */ - ext?: string - } - export type Event = { - /** event type */ - type: string - /** event subtype */ - subtype: string - } - export type Due = { - /** 截止时间的时间戳（单位为秒） */ - time?: string - /** 截止时间对应的时区，完整的时区名称列表可参考：https://docs.aws.amazon.com/zh_cn/redshift/latest/dg/time-zone-names.html */ - timezone?: string - /** 标记任务是否为全天任务（全天任务的截止时间为当天 UTC 时间的 0 点） */ - is_all_day?: boolean - } - export type Href = { - /** 具体链接地址 */ - url?: string - /** 链接对应的标题 */ - title?: string - } - export type Origin = { - /** 任务导入来源的名称，用于在任务中心详情页展示。请提供一个字典，多种语言名称映射。支持的各地区语言名：it_it, th_th, ko_kr, es_es, ja_jp, zh_cn, id_id, zh_hk, pt_br, de_de, fr_fr, zh_tw, ru_ru, en_us, hi_in, vi_vn */ - platform_i18n_name: string - /** 任务关联的来源平台详情页链接 */ - href?: Lark.Href - } - export type Follower = { - /** 任务关注者 ID */ - id?: string - /** 要添加为关注人的user_id */ - id_list?: string[] - } - export type Collaborator = { - /** 任务协作者的 ID */ - id?: string - /** 协作人的用户ID列表 */ - id_list?: string[] - } - export type I18nText = { - /** 英文 */ - en_us?: string - /** 中文 */ - zh_cn?: string - /** 中文（香港地区） */ - zh_hk?: string - /** 中文（台湾地区） */ - zh_tw?: string - /** 日语 */ - ja_jp?: string - /** 法语 */ - fr_fr?: string - /** 意大利语 */ - it_it?: string - /** 德语 */ - de_de?: string - /** 俄语 */ - ru_ru?: string - /** 泰语 */ - th_th?: string - /** 西班牙语 */ - es_es?: string - /** 韩语 */ - ko_kr?: string - } - export type CustomCompleteItem = { - /** 自定义完成的跳转url */ - href?: string - /** 自定义完成的弹出提示为 */ - tip?: Lark.I18nText - } - export type CustomComplete = { - /** pc客户端自定义完成配置（含mac和windows） */ - pc?: Lark.CustomCompleteItem - /** ios端的自定义完成配置 */ - ios?: Lark.CustomCompleteItem - /** android端的自定义完成配置 */ - android?: Lark.CustomCompleteItem - } - export type TaskInTasklistInfo = { - /** 任务所在清单的guid */ - tasklist_guid?: string - /** 任务所在清单的自定义分组guid */ - section_guid?: string - } - export type Start = { - /** 开始时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果开始时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true */ - timestamp?: string - /** 是否开始于一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。 */ - is_all_day?: boolean - } - export type InputCustomFieldValue = { - /** 自定义字段guid */ - guid: string - /** 数字类型的自定义字段值，填写一个合法数字的字符串表示，空字符串表示设为空。 */ - number_value?: string - /** 人员类型的自定义字段值。可以设置1个或多个用户的id（遵循member格式，只支持user类型）。当字段设为只不能多选时只能输入一个值。设为空数组表示设为空。 */ - member_value?: Lark.Member[] - /** 日期类型自定义字段值，可以输入一个表示日期的以毫秒为单位的字符串。设为空字符串表示设为空。 */ - datetime_value?: string - /** 单选类型字段值，填写一个字段选项的option_guid。设置为空字符串表示设为空。 */ - single_select_value?: string - /** 多选类型字段值，可以填写一个或多个本字段的option_guid。设为空数组表示设为空。 */ - multi_select_value?: string[] - } - export type Resource = { - /** 资源类型 */ - type?: string - /** 资源ID */ - id?: string - } - export type Attachment = { - /** 附件guid */ - guid?: string - /** 附件在云文档系统中的token */ - file_token?: string - /** 附件名 */ - name?: string - /** 附件的字节大小 */ - size?: number - /** 附件归属的资源 */ - resource?: Lark.Resource - /** 附件上传者 */ - uploader?: Lark.Member - /** 是否是封面图 */ - is_cover?: boolean - /** 上传时间戳(ms) */ - uploaded_at?: string - } - export type CustomFieldValue = { - /** 字段GUID */ - guid?: string - /** 自定义字段类型，支持"member", "datetime", "number", "single_select", "multi_select"五种类型 */ - type?: string - /** 数字类型的自定义字段值，填写一个合法数字的字符串表示，空字符串表示设为空。 */ - number_value?: string - /** 日期类型自定义字段值。可以输入一个表示日期的以毫秒为单位的字符串。设为空字符串表示设为空。 */ - datetime_value?: string - /** 人员类型的自定义字段值，可以设置1个或多个用户的id（遵循member格式，只支持user类型）。当该字段的设置为“不能多选”时只能输入一个值。设为空数组表示设为空。 */ - member_value?: Lark.Member[] - /** 单选类型字段值，填写一个字段选项的option_guid。设置为空字符串表示设为空。 */ - single_select_value?: string - /** 多选类型字段值，可以填写一个或多个本字段的option_guid。设为空数组表示设为空。 */ - multi_select_value?: string[] - /** 自定义字段名 */ - name?: string - } - export type InputTask = { - /** 任务标题 */ - summary?: string - /** 任务描述 */ - description?: string - /** 任务截止时间戳(ms)，截止时间戳和截止日期选择一个填写。 */ - due?: Lark.Due - /** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */ - extra?: string - /** 任务的完成时刻时间戳(ms) */ - completed_at?: string - /** 如果设置，则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */ - repeat_rule?: string - /** 如果设置，则将任务设计为“自定义完成”。用户在任务中心点击“完成”时，不会直接完成任务，而是跳转到第三方配置好的地址或者现实自定义提示。 */ - custom_complete?: Lark.CustomComplete - /** 任务的开始时间(ms) */ - start?: Lark.Start - /** 任务的完成模式。1 - 会签任务；2 - 或签任务 */ - mode?: number - /** 是否是里程碑任务 */ - is_milestone?: boolean - /** 自定义字段值 */ - custom_fields?: Lark.InputCustomFieldValue[] - } - export type TaskDependency = { - /** 依赖类型 */ - type: string - /** 依赖任务的GUID */ - task_guid: string - } - export type Tasklist = { - /** 清单的全局唯一ID */ - guid?: string - /** 清单名 */ - name?: string - /** 清单创建者 */ - creator?: Lark.Member - /** 清单负责人 */ - owner?: Lark.Member - /** 清单协作人 */ - members?: Lark.Member[] - /** 该清单分享的applink */ - url?: string - /** 清单创建时间戳(ms) */ - created_at?: string - /** 清单最后一次更新时间戳（ms) */ - updated_at?: string - } - export type InputTasklist = { - /** 清单名称 */ - name?: string - /** 清单所有者 */ - owner?: Lark.Member - } - export type TaskSummary = { - /** 任务GUID */ - guid?: string - /** 任务的标题 */ - summary?: string - /** 任务完成的时间戳(ms)，为0表示未完成 */ - completed_at?: string - /** 任务开始时间 */ - start?: Lark.Start - /** 任务截止时间 */ - due?: Lark.Due - /** 任务成员列表 */ - members?: Lark.Member[] - /** 子任务的个数 */ - subtask_count?: number - } - export type TasklistActivitySubscription = { - /** 订阅guid */ - guid?: string - /** 订阅名称 */ - name?: string - /** 订阅者 */ - subscribers?: Lark.Member[] - /** 要订阅的清单动态类型 */ - include_keys?: number[] - /** 该订阅是否为停用 */ - disabled?: boolean - } - export type InputComment = { - /** 评论内容 */ - content?: string - } - export type TasklistSummary = { - /** 清单的全局唯一ID */ - guid?: string - /** 清单名字 */ - name?: string - } - export type InputSection = { - /** 自定义分组名 */ - name?: string - /** 要将新分组插入到自定义分分组的前面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ - insert_before?: string - /** 要将新分组插入到自定义分分组的后面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ - insert_after?: string - } - export type SectionSummary = { - /** 自定义分组的全局唯一ID */ - guid?: string - /** 自定义分组的名称 */ - name?: string - /** 是否是默认分组 */ - is_default?: boolean - } - export type NumberSetting = { - /** 数字展示的格式 */ - format?: string - /** 自定义符号。只有`format`设为custom时才会生效。 */ - custom_symbol?: string - /** 自定义符号显示的位置。 */ - custom_symbol_position?: string - /** 分隔符样式 */ - separator?: string - /** 保留小数位数。输入的数字值的小数位数如果比该设置多，多余的位数将被四舍五入后舍弃。如果`format`为"percentage"，表示变为百分数之后的小数位数。 */ - decimal_count?: number - } - export type MemberSetting = { - /** 是否支持多选 */ - multi?: boolean - } - export type DatetimeSetting = { - /** 日期显示格式 */ - format?: string - } - export type Option = { - /** 选项名称，不能为空，最大50个字符 */ - name: string - /** 选项的颜色索引值，可以是0～54中的一个数字。如果不填写则会随机选一个。 */ - color_index?: number - /** 选项是否隐藏。隐藏后的选项在界面不可见，也不可以再通过openapi将字段值设为该选项。 */ - is_hidden?: boolean - } - export type SelectSetting = { - /** 单选选项 */ - options?: Lark.Option[] - } - export type TextSetting = { - - } - export type CustomField = { - /** 自定义字段的GUID */ - guid?: string - /** 自定义字段名称 */ - name?: string - /** 自定义字段类型 */ - type?: string - /** 数字类型的字段设置 */ - number_setting?: Lark.NumberSetting - /** 人员类型的字段设置 */ - member_setting?: Lark.MemberSetting - /** 时间日期类型的字段设置 */ - datetime_setting?: Lark.DatetimeSetting - /** 单选类型的字段设置 */ - single_select_setting?: Lark.SelectSetting - /** 多选类型的字段设置 */ - multi_select_setting?: Lark.SelectSetting - /** 创建人 */ - creator?: Lark.Member - /** 自定义字段创建的时间戳(ms) */ - created_at?: string - /** 自定义字段的更新时间戳(ms) */ - updated_at?: string - /** 文本字段配置 */ - text_setting?: Lark.TextSetting - } - export type InputCustomField = { - /** 字段名称 */ - name?: string - /** 数字类型的字段设置 */ - number_setting?: Lark.NumberSetting - /** 人员类型的字段设置 */ - member_setting?: Lark.MemberSetting - /** 时间日期类型的字段设置 */ - datetime_setting?: Lark.DatetimeSetting - /** 单选设置 */ - single_select_setting?: Lark.SelectSetting - /** 多选设置 */ - multi_select_setting?: Lark.SelectSetting - /** 文本类型 */ - text_setting?: Lark.TextSetting - } - export type InputOption = { - /** 选项名称 */ - name?: string - /** 颜色索引值，支持0～54中的一个数字。如果不填写，则会随机选一个。 */ - color_index?: number - /** 要放到某个option之前的option_guid */ - insert_before?: string - /** 要放到某个option之后的option_guid */ - insert_after?: string - /** 是否隐藏 */ - is_hidden?: boolean - } - export type Mailgroup = { - /** 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?: string - } - export type MailgroupManager = { - /** 管理员用户ID */ - user_id?: string - } - export type MailgroupMember = { - /** 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?: string - } - export type EmailAlias = { - /** 主邮箱地址 */ - primary_email?: string - /** 邮箱别名 */ - email_alias?: string - } - export type MailgroupPermissionMember = { - /** 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?: string - } - export type PublicMailbox = { - /** 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 - } - export type PublicMailboxMember = { - /** The unique ID of a member in this public mailbox */ - member_id?: string - /** 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?: string - } - export type AppScope = { - /** 应用权限 */ - scope: string - /** 应用权限的国际化描述 */ - description?: string - /** 权限等级描述 */ - level?: number - } - export type AppI18nInfo = { - /** 国际化语言的 key */ - i18n_key: string - /** 应用国际化名称 */ - name?: string - /** 应用国际化描述（副标题） */ - description?: string - /** 帮助国际化文档链接 */ - help_use?: string - } - export type ApplicationOwner = { - /** 应用所有者类型 */ - type: number - /** 应用所有者ID */ - owner_id?: string - /** 应用开发商名称(仅商店应用返回) */ - name?: string - /** 应用开发商服务台链接(仅商店应用返回) */ - help_desk?: string - /** 应用开发商的邮箱(仅商店应用返回) */ - email?: string - /** 应用开发商的手机号(仅商店应用返回) */ - phone?: string - } - export type Application = { - /** 应用的 id */ - app_id: string - /** 应用创建者（所有者） */ - creator_id?: string - /** 应用状态 */ - status?: number - /** 应用类型 */ - scene_type?: number - /** 付费类型 */ - payment_type?: number - /** 安全设置中的重定向 URL */ - redirect_urls?: string[] - /** 发布在线上的应用版本 */ - online_version_id?: string - /** 在审核中的版本号信息，若没有则为空 */ - unaudit_version_id?: string - /** 应用默认名称，如果没有对应语言下的名称，则返回默认语言下的名称 */ - app_name?: string - /** 应用图标链接 */ - avatar_url?: string - /** 应用默认描述 */ - description?: string - /** 应用权限列表 */ - scopes?: Lark.AppScope[] - /** 后台主页地址 */ - back_home_url?: string - /** 应用的国际化信息列表 */ - i18n?: Lark.AppI18nInfo[] - /** 应用主语言 */ - primary_language?: string - /** 应用分类的国际化描述 */ - common_categories?: string[] - /** 应用的所有者信息 */ - owner?: Lark.ApplicationOwner - } - export type Gadget = { - /** pc 支持的小程序模式，bit 位表示 */ - enable_pc_mode?: number - /** schema url 列表 */ - schema_urls?: string[] - /** pc 端是否使用小程序版本 */ - pc_use_mobile_pkg?: boolean - /** pc 的小程序版本号 */ - pc_version?: string - /** 移动端小程序版本号 */ - mobile_version?: string - /** 移动端兼容的最低飞书版本 */ - mobile_min_lark_version?: string - /** pc 端兼容的最低飞书版本 */ - pc_min_lark_version?: string - } - export type WebApp = { - /** pc 端 url */ - pc_url?: string - /** 移动端 url */ - mobile_url?: string - } - export type Bot = { - /** 消息卡片回调地址 */ - card_request_url?: string - } - export type WorkplaceWidget = { - /** 最低兼容 lark 版本号 */ - min_lark_version?: string - } - export type NavigateMeta = { - /** 主导航小程序版本号 */ - version?: string - /** 默认图片 url */ - image_url?: string - /** 选中态图片 url */ - hover_image_url?: string - } - export type Navigate = { - /** pc 端主导航信息 */ - pc?: Lark.NavigateMeta - /** 移动端主导航信息 */ - mobile?: Lark.NavigateMeta - } - export type CloudDocI18nInfo = { - /** 国际化语言的 key */ - i18n_key: string - /** 云文档国际化名称 */ - name?: string - /** 云文档国际化读权限说明 */ - read_description?: string - /** 云文档国际化写权限说明 */ - write_description?: string - } - export type CloudDoc = { - /** 云空间重定向 url */ - space_url?: string - /** 国际化信息 */ - i18n?: Lark.CloudDocI18nInfo[] - /** 图标链接 */ - icon_url?: string - /** 云文档支持模式 */ - mode?: number - } - export type BlockI18nInfo = { - /** 国际化语言的 key */ - i18n_key?: string - /** 名称 */ - name?: string - } - export type DocsBlock = { - /** BlockTypeID */ - block_type_id?: string - /** block 的国际化信息 */ - i18n?: Lark.BlockI18nInfo[] - /** 移动端 icon 链接 */ - mobile_icon_url?: string - /** pc 端口 icon 链接 */ - pc_icon_url?: string - } - export type MessageActionI18nInfo = { - /** 国际化语言的 key */ - i18n_key?: string - /** 国际化名称 */ - name?: string - } - export type MessageAction = { - /** pc 端链接 */ - pc_app_link?: string - /** 移动端链接 */ - mobile_app_link?: string - /** 国际化信息 */ - i18n?: Lark.MessageActionI18nInfo[] - } - export type PlusMenu = { - /** pc 端链接 */ - pc_app_link?: string - /** 移动端链接 */ - mobile_app_link?: string - } - export type AppAbility = { - /** 小程序能力 */ - gadget?: Lark.Gadget - /** 网页能力 */ - web_app?: Lark.WebApp - /** 机器人能力 */ - bot?: Lark.Bot - /** 小组件能力 */ - workplace_widgets?: Lark.WorkplaceWidget[] - /** 主导航小程序 */ - navigate?: Lark.Navigate - /** 云文档应用 */ - cloud_doc?: Lark.CloudDoc - /** 云文档小组件 */ - docs_blocks?: Lark.DocsBlock[] - /** 消息快捷操作 */ - message_action?: Lark.MessageAction - /** 加号菜单 */ - plus_menu?: Lark.PlusMenu - } - export type AppVisibleList = { - /** 可见性成员 open_id 列表 */ - open_ids?: string[] - /** 可见性部门的 id 列表 */ - department_ids?: string[] - /** 可见性成员 group_id 列表 */ - group_ids?: string[] - } - export type AppVisibility = { - /** 是否全员可见 */ - is_all?: boolean - /** 可见名单 */ - visible_list?: Lark.AppVisibleList - /** 不可见名单 */ - invisible_list?: Lark.AppVisibleList - } - export type AppVersionRemark = { - /** 备注说明 */ - remark?: string - /** 更新说明 */ - update_remark?: string - /** 可见性名单 */ - visibility?: Lark.AppVisibility - } - export type ApplicationAppVersion = { - /** 应用 id */ - app_id: string - /** 开发者填入的应用版本 ID */ - version?: string - /** 唯一标识应用版本的 ID */ - version_id: string - /** 应用默认名称 */ - app_name?: string - /** 应用头像 url */ - avatar_url?: string - /** 应用默认描述 */ - description?: string - /** 应用权限列表 */ - scopes?: Lark.AppScope[] - /** 后台主页地址 */ - back_home_url?: string - /** 应用的国际化信息列表 */ - i18n?: Lark.AppI18nInfo[] - /** 应用分类的国际化描述 */ - common_categories?: string[] - /** 应用已订阅开放平台事件列表 */ - events?: string[] - /** 版本状态 */ - status?: number - /** 版本创建时间（单位：s） */ - create_time?: string - /** 版本发布时间（单位：s） */ - publish_time?: string - /** 当前版本下应用开启的能力 */ - ability?: Lark.AppAbility - /** 跟随应用版本的信息 */ - remark?: Lark.AppVersionRemark - } - export type ApplicationAppContactsRange = { - /** 通讯录可见性类型 */ - contacts_scope_type?: string - /** 可用名单 */ - visible_list?: Lark.AppVisibleList - } - export type AppContactsRangeIdList = { - /** 成员id列表 */ - user_ids?: string[] - /** 部门id列表 */ - department_ids?: string[] - /** 用户组列表 */ - group_ids?: string[] - } - export type ApplicationVisibilityUserWhiteBlackInfo = { - /** 用户ID */ - user_id?: string - /** 是否在白名单中 */ - in_white_list?: boolean - /** 是否在黑名单中 */ - in_black_list?: boolean - /** 是否在付费名单中 */ - in_paid_list?: boolean - } - export type ApplicationVisibilityDepartmentWhiteBlackInfo = { - /** 部门ID */ - department_id?: string - /** 是否在白名单中 */ - in_white_list?: boolean - /** 是否在黑名单中 */ - in_black_list?: boolean - } - export type ApplicationVisibilityGroupWhiteBlackInfo = { - /** 用户组ID */ - group_id?: string - /** 是否在白名单中 */ - in_white_list?: boolean - /** 是否在黑名单中 */ - in_black_list?: boolean - } - export type AppVisibilityIdList = { - /** 成员id列表(open_id/union_id/user_id) */ - user_ids?: string[] - /** 部门id列表(自定义部门id/open_department_id) */ - department_ids?: string[] - /** 用户组id */ - group_ids?: string[] - } - export type ApplicationAppUsage = { - /** 指标名称 */ - metric_name: string - /** 指标值 */ - metric_value: number - } - export type ApplicationDepartmentAppUsage = { - /** 租户内部门的唯一标识，ID值与查询参数中的department_id_type 对应。 */ - department_id?: string - /** 应用整体使用情况。指标名称， uv：活跃用户数， total_users：累计用户数， new_users：新增用户数。 */ - app?: Lark.ApplicationAppUsage[] - /** 小程序使用情况，没有小程序形态时为null。 */ - gadget?: Lark.ApplicationAppUsage[] - /** 网页应用使用情况，没有网页应用形态时为null */ - webapp?: Lark.ApplicationAppUsage[] - /** 机器人使用情况，没有机器人形态时为null */ - bot?: Lark.ApplicationAppUsage[] - } - export type ApplicationFeedback = { - /** 应用反馈 ID，应用反馈记录唯一标识 */ - feedback_id: string - /** 被反馈应用ID */ - app_id: string - /** 反馈提交时间，格式为yyyy-mm-dd hh:mm:ss */ - feedback_time: string - /** 反馈用户的租户名， 查询 isv 应用时反馈数据时返回 */ - tenant_name?: string - /** 反馈类型 */ - feedback_type: number - /** 反馈处理状态 */ - status: number - /** 故障类型：1: 黑屏 2: 白屏 3: 无法打开小程序 4: 卡顿 5: 小程序闪退 6: 页面加载慢 7: 死机 8: 其他异常） 只在故障反馈时返回 */ - fault_type?: number[] - /** 故障时间，格式为yyyy-mm-dd hh:mm:ss */ - fault_time?: string - /** 反馈来源：1： 小程序 2：网页应用 3：机器人 4：webSDK */ - source?: number - /** 用户联系方式，只有用户填写联系方式后返回 */ - contact?: string - /** 反馈处理时间，格式为yyyy-mm-dd hh:mm:ss */ - update_time?: string - /** 反馈问题描述 */ - description: string - /** 反馈用户id，租户内用户的唯一标识 ，ID值与查询参数中的user_id_type对应，应用为 isv 应用时不返回 */ - user_id?: string - /** 操作者id，租户内用户的唯一标识， ID值与查询参数中的user_id_type 对应 反馈未被处理时该值为 nil */ - operator_id?: string - /** 反馈图片url列表，url 过期时间三天 */ - images?: string[] - /** 反馈页面路径 */ - feedback_path?: string - } - export type ClientBadgeNum = { - /** h5能力的badge数量 */ - web_app?: number - /** 小程序能力的badge数量 */ - gadget?: number - } - export type TenantAssignInfo = { - /** 席位id */ - subscription_id?: string - /** license_plan_key */ - license_plan_key?: string - /** 商业化产品名称 */ - product_name?: string - /** 国际化名称 */ - i18n_name?: Lark.ProductI18nName - /** 席位总数 */ - total_seats?: string - /** 已分配席位数 */ - assigned_seats?: string - /** 席位起始时间 */ - start_time?: string - /** 席位结束时间 */ - end_time?: string - } - export type Avatar = { - /** 企业头像 */ - avatar_origin?: string - /** 企业头像 72x72 */ - avatar_72?: string - /** 企业头像 240x240 */ - avatar_240?: string - /** 企业头像 640x640 */ - avatar_640?: string - } - export type Tenant = { - /** 企业名称 */ - name: string - /** 企业编号 */ - display_id: string - /** 个人版/团队版标志 */ - tenant_tag: number - /** 企业标识 */ - tenant_key: string - /** 企业头像 */ - avatar: Lark.Avatar - } - export type Verification = { - /** 企业主体名称 */ - name: string - /** 企业是否完成认证； true 表示已经完成认证，false 表示未认证 */ - has_verification: boolean - } - export type SystemStatusI18nName = { - /** 中文名 */ - zh_cn?: string - /** 英文名 */ - en_us?: string - /** 日文名 */ - ja_jp?: string - } - export type SystemStatusSyncI18nName = { - /** 中文名 */ - zh_cn?: string - /** 英文名 */ - en_us?: string - /** 日文名 */ - ja_jp?: string - } - export type SystemStatusSyncI18nExplain = { - /** 中文名 */ - zh_cn?: string - /** 英文名 */ - en_us?: string - /** 日文名 */ - ja_jp?: string - } - export type SystemStatusSyncSetting = { - /** 是否默认开启 */ - is_open_by_default?: boolean - /** 同步设置名称，名称字符数要在1到30范围内。 */ - title?: string - /** 同步设置国际化名称，名称字符数要在1到30范围内。 */ - i18n_title?: Lark.SystemStatusSyncI18nName - /** 同步设置解释文案，解释字符数要在1到60范围内。 */ - explain?: string - /** 同步设置国际化解释文案，解释字符数要在1到60范围内。 */ - i18n_explain?: Lark.SystemStatusSyncI18nExplain - } - export type SystemStatus = { - /** 系统状态ID */ - system_status_id?: string - /** 系统状态名称，名称字符数要在1到20范围内。 */ - title: string - /** 系统状态国际化名称，名称字符数要在1到20范围内。 */ - i18n_title?: Lark.SystemStatusI18nName - /** 图标 */ - icon_key: string - /** 颜色 */ - color?: string - /** 优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。 */ - priority?: number - /** 同步设置 */ - sync_setting?: Lark.SystemStatusSyncSetting - } - export type SystemStatusUserOpenParam = { - /** 用户ID */ - user_id: string - /** 结束时间，传入的应为秒单位的时间戳，距当前的时间跨度不能超过365天。 */ - end_time: string - } - export type SystemStatusUserOpenResultEntity = { - /** 用户ID */ - user_id: string - /** 结束时间，传入的应为秒单位的时间戳，距当前的时间跨度不能超过365天。 */ - end_time: string - /** 开启结果 */ - result?: string - } - export type SystemStatusUserCloseResultEntity = { - /** 用户ID */ - user_id?: string - /** 关闭结果 */ - result?: string - } - export type I18nMeta = { - /** 国际化字段：中文 */ - zh_cn?: string - /** 国际化字段：英文 */ - en_us?: string - /** 国际化字段：日文 */ - ja_jp?: string - } - export type DataSource = { - /** 数据源的唯一标识 */ - id?: string - /** data_source的展示名称 */ - name: string - /** 数据源状态，0-已上线，1-未上线 */ - state?: number - /** 对于数据源的描述 */ - description?: string - /** 创建时间，采用 Unix 时间戳 */ - create_time?: string - /** 更新时间，采用 Unix 时间戳 */ - update_time?: string - /** 是否超限 */ - is_exceed_quota?: boolean - /** 数据源在 search tab 上的展示图标路径 */ - icon_url?: string - /** 数据源采用的展示模版名称 */ - template?: string - /** 描述哪些字段可以被搜索 */ - searchable_fields?: string[] - /** 数据源的国际化展示名称 */ - i18n_name?: Lark.I18nMeta - /** 数据源的国际化描述 */ - i18n_description?: Lark.I18nMeta - /** 数据源关联的 schema 标识 */ - schema_id?: string - /** datasource对应的开放平台应用id */ - app_id?: string - } - export type Acl = { - /** 权限类型，优先级：Deny > Allow */ - access?: string - /** 设置的权限值，依赖 type 描述 */ - value?: string - /** 权限值类型 */ - type?: string - } - export type ItemMetadata = { - /** 数据项标题 */ - title: string - /** 搜索命中的跳转地址 */ - source_url: string - /** 数据项的创建时间，采用 Unix 时间戳 */ - create_time?: number - /** 数据项的更新时间，采用 Unix 时间戳 */ - update_time?: number - /** 移动端搜索命中的跳转地址。如果您PC端和移动端有不同的跳转地址，可以在这里写入移动端专用的url，我们会在搜索时为您选择合适的地址 */ - source_url_mobile?: string - } - export type ItemContent = { - /** 内容的格式 */ - format?: string - /** 全文数据 */ - content_data?: string - } - export type SchemaSortOptions = { - /** 排序的优先级，可选范围为 0~4，0为最高优先级。如果优先级相同，则随机进行排序。默认为0 */ - priority?: number - /** 排序的顺序。默认为 desc */ - order?: string - } - export type SchemaTagOptions = { - /** tag 对应的枚举值名称 */ - name: string - /** 标签对应的颜色 */ - color: string - /** 标签中展示的文本 */ - text: string - } - export type SchemaUserIdsOption = { - /** 用户身份类型 */ - id_type: string - } - export type SchemaTypeDefinitions = { - /** 标签类型的定义 */ - tag?: Lark.SchemaTagOptions[] - /** 用户身份标识 */ - user_ids?: Lark.SchemaUserIdsOption - } - export type SchemaSearchOptions = { - /** 是否支持语义切词召回。默认不支持（推荐使用在长文本的场景） */ - enable_semantic_match?: boolean - /** 是否支持精确匹配。默认不支持（推荐使用在短文本、需要精确查找的场景） */ - enable_exact_match?: boolean - /** 是否支持前缀匹配（短文本的默认的分词/召回策略。前缀长度为 1-12） */ - enable_prefix_match?: boolean - /** 是否支持数据后缀匹配。默认不支持（推荐使用在短文本、有数字后缀查找的场景。后缀长度为3-12） */ - enable_number_suffix_match?: boolean - /** 是否支持驼峰英文匹配。默认不支持（推荐使用在短文本，且包含驼峰形式英文的查找场景） */ - enable_camel_match?: boolean - } - export type SchemaPredefineEnumStruct = { - /** 枚举值的标识。在多枚举值定义中保持唯一 */ - name: string - /** 枚举值展示文案 */ - text: string - } - export type SchemaFilterOptions = { - /** 筛选器展示名称 */ - display_name: string - /** 筛选器展示名称国际化字段 */ - i18n_display_name?: Lark.I18nMeta - /** 指明该筛选器支持单选或多选，默认单选 */ - option_mode?: string - /** 关联的综合筛选器。只有 filter_type 为"user"和"time"时可以关联。"user" -> "from"；"time" -> "date"。 */ - associated_smart_filter?: string - /** 筛选器类型 */ - filter_type?: string - /** 预定义的展示枚举值。在 filter_type 为 "predefine_enum" 时必须填写 */ - predefine_enum_values?: Lark.SchemaPredefineEnumStruct[] - /** 是否开启客户端筛选器 */ - enable_client_filter?: boolean - } - export type SchemaProperty = { - /** 属性名 */ - name: string - /** 属性类型 */ - type: string - /** 该属性是否可用作搜索，默认为 false */ - is_searchable?: boolean - /** 该属性是否可用作搜索结果排序，默认为 false。如果为 true，需要再配置 sortOptions */ - is_sortable?: boolean - /** 该属性是否可用作返回字段，为 false 时，该字段不会被召回和展示。默认为 false */ - is_returnable?: boolean - /** 属性排序的可选配置，当 is_sortable 为 true 时，该字段为必填字段 */ - sort_options?: Lark.SchemaSortOptions - /** 相关类型数据的定义和约束 */ - type_definitions?: Lark.SchemaTypeDefinitions - /** 属性搜索的可选配置，当 is_searchable 为 true 时，该字段为必填参数 */ - search_options?: Lark.SchemaSearchOptions - /** 该属性是否可用作返回字段，为 false 时，该字段不会被筛选。默认为 false */ - is_filterable?: boolean - /** 属性筛选的可选配置，当 is_searchable 为 true 时，该字段为必填参数 */ - filter_options?: Lark.SchemaFilterOptions - } - export type SchemaDisplayFieldMapping = { - /** 展示字段名称，与 card_key 有关，每个模版能展示的字段不同。该字段不能重复 */ - display_field: string - /** 数据字段的名称。需要确保该字段对应在 schema 属性定义中的 is_returnable 为 true，否则无法展示。需要使用 ${xxx} 的规则来描述 */ - data_field: string - } - export type SchemaDisplay = { - /** 搜索数据的展示卡片 */ - card_key: string - /** 数据字段名称和展示字段名称的映射关系。如果没有设置，则只会展示 与展示字段名称同名的 数据字段 */ - fields_mapping?: Lark.SchemaDisplayFieldMapping[] - } - export type ResumeEducation = { - /** 学校名称 */ - school?: string - /** 开始时间,格式：YYYY-MM-DD */ - start_date?: string - /** 开始时间,格式：YYYY-MM-DD,跟start_date值一样 */ - start_time?: string - /** 结束时间,格式：YYYY-MM-DD */ - end_date?: string - /** 结束时间,格式：YYYY-MM-DD 或 “至今”，当值为“至今”时，end_date=="",值为其他时，end_date==end_time */ - end_time?: string - /** 专业 */ - major?: string - /** 学历——小学、初中、中职、高中、专科、本科、硕士、博士、其他 */ - degree?: string - /** 学历对应ID */ - qualification?: number - } - export type ResumeCareer = { - /** 公司名称 */ - company?: string - /** 开始时间,格式：YYYY-MM-DD */ - start_date?: string - /** 始时间,格式：YYYY-MM-DD,跟start_date值一样 */ - start_time?: string - /** 结束时间,格式：YYYY-MM-DD */ - end_date?: string - /** 结束时间,格式：YYYY-MM-DD 或 “至今”，当值为“至今”时，end_date=="",值为其他时，end_date==end_time */ - end_time?: string - /** 职位 */ - title?: string - /** 工作类型 */ - type?: number - /** 工作类型——'实习'、'全职' */ - type_str?: string - /** 工作描述 */ - job_description?: string - } - export type ResumeProject = { - /** 项目名称 */ - name?: string - /** 项目岗位 */ - title?: string - /** 开始时间,格式：YYYY-MM-DD */ - start_date?: string - /** 开始时间,格式：YYYY-MM-DD,跟start_date值一样 */ - start_time?: string - /** 结束时间,格式：YYYY-MM-DD */ - end_date?: string - /** 结束时间,格式：YYYY-MM-DD 或 “至今”，当值为“至今”时，end_date=="",值 */ - end_time?: string - /** 项目描述 */ - description?: string - } - export type ResumeLanguage = { - /** 语言等级 */ - level?: number - /** 语言描述 */ - description?: string - } - export type ResumeAward = { - /** 奖项 */ - award?: string - /** 获奖时间，格式：YYYY */ - date?: string - /** 描述 */ - description?: string - } - export type ResumeCertificate = { - /** 证书名称 */ - name?: string - /** 描述 */ - desc?: string - } - export type ResumeCompetition = { - /** 竞赛名称 */ - name?: string - /** 描述 */ - desc?: string - } - export type Resume = { - /** 文件标识ID，依据文件内容自动生成 */ - file_md5?: string - /** 文本内容，当接口返回成功时，该字段才存在 */ - content?: string - /** 经过排序后的文本内容，当接口返回成功时，该字段才存在 */ - new_content?: string - /** 名称 */ - name?: string - /** 邮箱 */ - email?: string - /** 手机号码 */ - mobile?: string - /** 手机号码是否虚拟号码 */ - mobile_is_virtual?: boolean - /** 手机号码国家编码 */ - country_code?: string - /** 教育经历 */ - educations?: Lark.ResumeEducation[] - /** 职业经历 */ - careers?: Lark.ResumeCareer[] - /** 项目经历 */ - projects?: Lark.ResumeProject[] - /** 工作年限，为空表示工作年限未知，数字单位为年，整数 */ - work_year?: number - /** 生日，格式YYYY-MM-DD */ - date_of_birth?: string - /** 性别 */ - gender?: number - /** 希望获得的职位列表 */ - willing_positions?: string[] - /** 当前工作地点(城市) */ - current_location?: string - /** 希望工作地点列表 */ - willing_locations?: string[] - /** 家乡(城市) */ - home_location?: string - /** 语言 */ - languages?: Lark.ResumeLanguage[] - /** 获奖 */ - awards?: Lark.ResumeAward[] - /** 证书 */ - certificates?: Lark.ResumeCertificate[] - /** 竞赛 */ - competitions?: Lark.ResumeCompetition[] - /** 自我评价 */ - self_evaluation?: string - /** 链接列表 */ - urls?: string[] - /** 社交链接 */ - social_links?: string[] - } - export type VehicleInvoiceEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type VehicleInvoice = { - /** 识别出的实体类型 */ - entities?: Lark.VehicleInvoiceEntity[] - } - export type HealthCertificateEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type HealthCertificate = { - /** 识别出的实体类型 */ - entities?: Lark.HealthCertificateEntity[] - } - export type HkmMainlandTravelPermitEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type HkmMainlandTravelPermit = { - /** 识别出的实体类型 */ - entities?: Lark.HkmMainlandTravelPermitEntity[] - } - export type TwMainlandTravelPermitEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type TwMainlandTravelPermit = { - /** 识别出的实体类型 */ - entities?: Lark.TwMainlandTravelPermitEntity[] - } - export type ChinesePassportEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type ChinesePassport = { - /** 识别出的实体类型 */ - entities?: Lark.ChinesePassportEntity[] - } - export type BankCardEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type BankCard = { - /** 识别出的实体类型 */ - entities?: Lark.BankCardEntity[] - } - export type VehicleEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type VehicleLicense = { - /** 识别出的实体类型 */ - entities?: Lark.VehicleEntity[] - } - export type TrainEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type TrainInvoice = { - /** 识别出的实体列表 */ - entities?: Lark.TrainEntity[] - } - export type TaxiEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type TaxiInvoice = { - /** 识别出的实体类型 */ - entities?: Lark.TaxiEntity[] - } - export type IdEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type IdCard = { - /** 识别的实体列表 */ - entities?: Lark.IdEntity[] - /** 正反面，1为身份证-姓名页，0为身份证-国徽页 */ - side?: number - /** 四角坐标[x0,y0,x1,y1,x2,y2,x3,y3] */ - conners?: number[] - } - export type FoodProduceEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type FoodProduceLicense = { - /** 识别出的实体列表 */ - entities?: Lark.FoodProduceEntity[] - } - export type FoodManageEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type FoodManageLicense = { - /** 识别出的实体列表 */ - entities?: Lark.FoodManageEntity[] - } - export type DrivingEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type DrvingLicense = { - /** 识别出的实体类型 */ - entities?: Lark.DrivingEntity[] - } - export type VatEntity = { - /** 识别的实体类型 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type VatInvoice = { - /** 识别出的实体列表 */ - entities?: Lark.VatEntity[] - } - export type BusinessEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type BusinessLicense = { - /** 识别出的实体类型 */ - entities?: Lark.BusinessEntity[] - } - export type ExtractPrice = { - /** 交易金额 */ - contract_price?: number - /** 从原文中抽取的交易金额 */ - contract_price_original?: string - /** 原文中描述交易金额的文字 */ - text?: string - } - export type ExtractTerm = { - /** 合同持续时长 */ - initial_time?: string - /** 持续时长单位 */ - initial_unit?: string - } - export type ExtractTime = { - /** 开始时间 */ - time_start?: string - /** 结束时间 */ - time_end?: string - /** 原文中抽取出的开始时间 */ - original_time_start?: string - /** 原文中抽取出的结束时间 */ - original_time_end?: string - /** 原文中关于开始时间的描述 */ - text_start?: string - /** 原文中关于结束时间的描述 */ - text_end?: string - /** 合同持续时长 */ - initial_term?: Lark.ExtractTerm - /** 原文中关于持续时间的描述 */ - text_initial_term?: string - } - export type ExtractCopy = { - /** 盖章份数 */ - copy_num?: number - /** 从原文中抽取的盖章份数 */ - original_copy?: string - /** 盖章文件类型 */ - key?: string - /** 原文有关盖章份数的描述 */ - text?: string - } - export type ExtractCurrency = { - /** 币种名称 */ - currency_name?: string - /** 币种符号 */ - currency_text?: string - } - export type BodyEntity = { - /** 地址 */ - address?: string - /** 联系人 */ - contacts?: string - /** 邮箱 */ - email?: string - /** 电话 */ - phone?: string - /** ID */ - id_number?: string - /** 法人代表 */ - legal_representative?: string - /** 当事人 */ - party?: string - } - export type BodyInfo = { - /** 主体类型 */ - body_type?: string - /** 值 */ - value?: Lark.BodyEntity - } - export type BankEntity = { - /** 账户名 */ - account_name?: string - /** 银行名称 */ - bank_name?: string - /** 账户ID */ - account_number?: string - /** 电话 */ - phone?: string - /** 联系人 */ - contacts?: string - /** 传真号码 */ - tax_number?: string - /** 联系地址 */ - address?: string - /** id号 */ - id_number?: string - /** 邮箱 */ - email?: string - } - export type BankInfo = { - /** 甲乙方信息类型 */ - bank_type?: string - /** 值 */ - value?: Lark.BankEntity - } - export type RecognizedEntity = { - /** 识别的字段种类 */ - type?: string - /** 识别出字段的文本信息 */ - value?: string - } - export type RecognizedEntities = { - /** 识别的实体列表 */ - entities?: Lark.RecognizedEntity[] - } - export type Speech = { - /** 语音资源 */ - speech?: string - } - export type FileConfig = { - /** 仅包含字母数字和下划线的 16 位字符串作为文件的标识，用户生成 */ - file_id: string - /** 语音格式，目前仅支持：pcm */ - format: string - /** 引擎类型，目前仅支持：16k_auto 中英混合 */ - engine_type: string - } - export type StreamConfig = { - /** 仅包含字母数字和下划线的 16 位字符串作为同一数据流的标识，用户生成 */ - stream_id: string - /** 数据流分片的序号，序号从 0 开始，每次请求递增 1 */ - sequence_id: number - /** 数据流标记：1 首包，2 正常结束，等待结果返回，3 中断数据流不返回最终结果 */ - action: number - /** 语音格式，目前仅支持：pcm */ - format: string - /** 引擎类型，目前仅支持：16k_auto 中英混合 */ - engine_type: string - } - export type Term = { - /** 原文 */ - from: string - /** 译文 */ - to: string - } - export type Password = { - /** 企业邮箱密码 */ - ent_email_password: string - } - export type AdminDeptStat = { - /** 日期 */ - date?: string - /** 部门ID */ - department_id?: string - /** 部门名 */ - department_name?: string - /** 部门路径 */ - department_path?: string - /** 部门总人数 */ - total_user_num?: number - /** 激活人数 */ - active_user_num?: number - /** 激活率 */ - active_user_rate?: string - /** 活跃人数 */ - suite_dau?: number - /** 活跃率 */ - suite_active_rate?: string - /** 新用户数 */ - new_user_num?: number - /** 新激活数 */ - new_active_num?: number - /** 离职人数 */ - resign_user_num?: number - /** 消息活跃人数 */ - im_dau?: number - /** 发送消息人数 */ - send_messenger_user_num?: number - /** 发送消息数 */ - send_messenger_num?: number - /** 人均发送消息数 */ - avg_send_messenger_num?: string - /** 云文档活跃人数 */ - docs_dau?: number - /** 创建文件人数 */ - create_docs_user_num?: number - /** 创建文件数 */ - create_docs_num?: number - /** 人均创建文件数 */ - avg_create_docs_num?: string - /** 日历活跃人数 */ - cal_dau?: number - /** 创建日程人数 */ - create_cal_user_num?: number - /** 创建日程数 */ - create_cal_num?: number - /** 人均创建日程数 */ - avg_create_cal_num?: string - /** 音视频会议活跃人数 */ - vc_dau?: number - /** 会议时长（分钟） */ - vc_duration?: number - /** 人均会议时长（分钟） */ - avg_vc_duration?: string - /** 人均飞书使用时长（分钟） */ - avg_duration?: string - /** 任务活跃人数 */ - task_dau?: number - /** 创建任务人数 */ - create_task_user_num?: number - /** 创建任务数 */ - create_task_num?: number - /** 人均创建任务数 */ - avg_create_task_num?: string - /** 邮件总发件量 */ - email_send_count?: string - /** 邮件总收件量 */ - email_receive_count?: string - /** 对外发件数 */ - email_send_ext_count?: string - /** 来自外部收件数 */ - email_receive_ext_count?: string - /** 对内发件数 */ - email_send_in_count?: string - /** 来自内部收件数 */ - email_receive_in_count?: string - } - export type AdminUserStat = { - /** 日期 */ - date?: string - /** 用户ID */ - user_id?: string - /** 用户名 */ - user_name?: string - /** 部门名 */ - department_name?: string - /** 部门路径 */ - department_path?: string - /** 添加时间 */ - create_time?: string - /** 用户激活状态 */ - user_active_flag?: number - /** 激活时间 */ - register_time?: string - /** 用户活跃状态 */ - suite_active_flag?: number - /** 最近活跃时间 */ - last_active_time?: string - /** 用户消息活跃状态 */ - im_active_flag?: number - /** 发送消息数 */ - send_messenger_num?: number - /** 用户云文档活跃状态 */ - docs_active_flag?: number - /** 创建文件数 */ - create_docs_num?: number - /** 用户日历活跃状态 */ - cal_active_flag?: number - /** 创建日程数 */ - create_cal_num?: number - /** 用户音视频会议活跃状态 */ - vc_active_flag?: number - /** 会议时长 */ - vc_duration?: number - /** 活跃设备 */ - active_os?: string - /** 创建任务数 */ - create_task_num?: number - /** 会议数 */ - vc_num?: number - /** 飞书的应用类型名称 */ - app_package_type?: string - /** 操作系统名称 */ - os_name?: string - /** 邮件总发件量 */ - email_send_count?: string - /** 邮件总收件量 */ - email_receive_count?: string - /** 对外发件数 */ - email_send_ext_count?: string - /** 来自外部收件数 */ - email_receive_ext_count?: string - /** 对内发件数 */ - email_send_in_count?: string - /** 来自内部收件数 */ - email_receive_in_count?: string - } - export type Badge = { - /** 租户内勋章的唯一标识，该值由系统随机生成。 */ - id?: string - /** 租户内唯一的勋章名称，最多30个字符。 */ - name: string - /** 勋章的描述文案，最多100个字符。 */ - explanation?: string - /** 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ - detail_image: string - /** 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ - show_image: string - /** 勋章的多语言名称，同name字段限制，最多30个字符。 */ - i18n_name?: Lark.I18n - /** 勋章的多语言描述文案，同explanation字段限制，最多100个字符。 */ - i18n_explanation?: Lark.I18n - } - export type RuleDetail = { - /** 开始生效的时间戳。1.手动设置有效期类型勋章，配置有效期限需要配置该字段；2.时间戳必须是所在时区当天的零点时间戳，如时区为Asia/Shanghai时区时的1649606400 */ - effective_time?: string - /** 结束生效的时间戳。1.手动设置有效期类型勋章，配置有效期限需要配置该字段；2.最大值：不得超过effective_time+100 年；3.非永久有效：时间戳必须是所在时区当天的23:59:59时间戳，如时区为Asia/Shanghai时区时的1649692799；4.永久有效：传值为0即可 */ - expiration_time?: string - /** 入职周年日。根据入职时间发放类型勋章，需要配置该字段。 */ - anniversary?: number - /** 有效期限。根据入职时间发放类型勋章，需要配置该字段。 */ - effective_period?: number - } - export type Grant = { - /** 租户内授予名单的唯一标识，该值由系统随机生成。 */ - id?: string - /** 企业勋章的唯一ID */ - badge_id?: string - /** 授予名单名称，最多100个字符。 */ - name: string - /** 勋章下唯一的授予事项 */ - grant_type: number - /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */ - time_zone: string - /** 规则详情 */ - rule_detail: Lark.RuleDetail - /** 是否授予给全员。1.为false时，需要关联1~500个用户群体。2.为true时，不可关联用户、用户组、部门。 */ - is_grant_all: boolean - /** 授予的用户ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - user_ids?: string[] - /** 授予的部门ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - department_ids?: string[] - /** 授予的用户组ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - group_ids?: string[] - } - export type Manager = { - user_id?: string - name?: string - en_name?: string - } - export type Job = { - id?: unknown - name?: string - } - export type WorkLocation = { - id?: unknown - name?: string - } - export type NativeRegion = { - iso_code?: string - name?: string - } - export type ContractCompany = { - id?: unknown - name?: string - } - export type EmergencyContact = { - name?: string - relationship?: number - mobile?: string - } - export type Education = { - level?: number - school?: string - major?: string - degree?: number - start?: string - end?: string - } - export type WorkExperience = { - company?: string - department?: string - job?: string - start?: string - end?: string - description?: string - } - export type SystemFields = { - /** 中文姓名 */ - name?: string - /** 英文姓名 */ - en_name?: string - /** 邮箱 */ - email?: string - /** 手机号码 */ - mobile?: string - /** 部门id */ - department_id?: string - /** 上级 */ - manager?: Lark.Manager - /** 职位 */ - job?: Lark.Job - /** 职级 */ - job_level?: Lark.JobLevel - /** 工作地点 */ - work_location?: Lark.WorkLocation - /** 性别 */ - gender?: number - /** 生日 */ - birthday?: string - /** 籍贯 */ - native_region?: Lark.NativeRegion - /** 民族 */ - ethnicity?: number - /** 婚姻状况 */ - marital_status?: number - /** 政治面貌 */ - political_status?: number - /** 参加工作日期 */ - entered_workforce_date?: string - /** 证件类型 */ - id_type?: number - /** 证件号 */ - id_number?: string - /** 户口类型 */ - hukou_type?: number - /** 户口所在地 */ - hukou_location?: string - /** 银行卡号 */ - bank_account_number?: string - /** 开户行 */ - bank_name?: string - /** 社保账号 */ - social_security_account?: string - /** 公积金账号 */ - provident_fund_account?: string - /** 工号 */ - employee_no?: string - /** 雇员类型 */ - employee_type?: number - /** 员工状态 */ - status?: number - /** 入职日期 */ - hire_date?: string - /** 试用期（月） */ - probation_months?: number - /** 转正日期 */ - conversion_date?: string - /** 转正申请 */ - application?: number - /** 转正状态 */ - application_status?: number - /** 离职日期 */ - last_day?: string - /** 离职类型 */ - departure_type?: number - /** 离职原因 */ - departure_reason?: number - /** 离职备注 */ - departure_notes?: string - /** 合同公司 */ - contract_company?: Lark.ContractCompany - /** 合同类型 */ - contract_type?: number - /** 合同开始日期 */ - contract_start_date?: string - /** 合同到期日期 */ - contract_expiration_date?: string - /** 劳动合同签订次数 */ - contract_sign_times?: number - /** 个人邮箱 */ - personal_email?: string - /** 家庭地址 */ - family_address?: string - /** 主要紧急联系人 */ - primary_emergency_contact?: Lark.EmergencyContact - /** 紧急联系人 */ - emergency_contact?: Lark.EmergencyContact[] - /** 最高学历 */ - highest_level_of_edu?: Lark.Education - /** 教育经历 */ - education?: Lark.Education[] - /** 前工作经历 */ - former_work_exp?: Lark.WorkExperience - /** 工作经历 */ - work_exp?: Lark.WorkExperience[] - /** 身份证照片（人像面） */ - id_photo_po_side?: Lark.Attachment[] - /** 身份证照片（国徽面） */ - id_photo_em_side?: Lark.Attachment[] - /** 证件照 */ - id_photo?: Lark.Attachment[] - /** 学位证书 */ - diploma_photo?: Lark.Attachment[] - /** 毕业证书 */ - graduation_cert?: Lark.Attachment[] - /** 奖励证明 */ - cert_of_merit?: Lark.Attachment[] - /** 离职证明 */ - offboarding_file?: Lark.Attachment[] - /** 取消入职原因 */ - cancel_onboarding_reason?: number - /** 取消入职备注 */ - cancel_onboarding_notes?: string - /** 入职登记表状态 */ - employee_form_status?: number - /** 创建时间 */ - create_time?: unknown - /** 更新时间 */ - update_time?: unknown - } - export type CustomFields = { - key?: string - label?: string - type?: string - /** 根据type不同，结构不同，不同type对应的数据结构在type的枚举值中有描述 */ - value?: string - } - export type Employee = { - /** user_id转换 */ - user_id?: string - /** 系统字段 */ - system_fields?: Lark.SystemFields - /** 自定义字段 */ - custom_fields?: Lark.CustomFields[] - } - export type Nationality = { - /** 国籍 ID（对应其他查询结果的 nationality_id_v2 字段） */ - nationality_id?: string - /** 名称 */ - name?: Lark.I18n[] - /** 二字码 */ - alpha_2_code?: string - /** 三字码 */ - alpha_3_code?: string - /** 数字代码 */ - numeric_code?: number - /** 国家 / 地区 ID ，可通过【查询单条国家/地区信息】 接口查询 */ - country_region_id?: string - /** 状态 */ - status?: number - } - export type Bank = { - /** 银行 ID */ - bank_id?: string - /** 银行名称 */ - bank_name?: Lark.I18n[] - /** 总行代码 */ - bank_code?: string - /** 国家 / 地区 ID ，可通过【查询单条国家/地区信息】 接口查询 */ - country_region_id?: string - /** 状态 */ - status?: number - } - export type BankBranch = { - /** 支行 ID */ - bank_branch_id?: string - /** 支行名称 */ - bank_branch_name?: Lark.I18n[] - /** 所属银行 ID，可通过【查询银行信息】接口查询 */ - bank_id?: string - /** 金融分支机构编码 */ - code?: string - /** 银行代码 */ - swift_code?: string - /** 状态 */ - status?: number - } - export type Name = { - /** 中文 */ - zh_cn?: string - /** 英文 */ - en_us?: string - } - export type TextFieldSetting = { - /** 是否多语言 */ - is_multilingual?: boolean - /** 是否多行 */ - is_multiline?: boolean - /** 最大长度 */ - max_length: number - /** 是否是URL类型 */ - is_url_type?: boolean - } - export type NumberFieldSetting = { - /** 数字类型 */ - number_field_type?: number - /** 小数部分位数（浮点数整数部分和小数部分分别最大30位） */ - decimal_places?: number - /** 四舍五入规则 */ - round_type?: number - /** 整数+小数总位数 */ - decimal_total_places?: number - } - export type CommonSchemaOption = { - /** 选项 api_name */ - api_name?: string - /** 选项名称 */ - name?: Lark.Name - /** 选项描述 */ - description?: Lark.Name - } - export type EnumFieldSetting = { - /** 枚举选项信息 */ - enum_field_option_list?: Lark.CommonSchemaOption[] - /** 是否为多选 */ - is_multiple?: boolean - } - export type LookupFieldSetting = { - /** 查找字段对应的对象 apiname，可通过【获取自定义字段列表】接口获取这个对象中定义的自定义字段 */ - lookup_obj_api_name?: string - /** 是否为多值 */ - is_multiple?: boolean - } - export type DateTimeFieldSetting = { - /** 时间类型 */ - date_time_type?: number - } - export type AttachmentFieldSetting = { - /** 是否支持多个文件 */ - is_multiple?: boolean - /** 文件类型 */ - file_type?: number - } - export type ImageFieldSetting = { - /** 图片类型 */ - image_type?: number - /** 显示样式 */ - display_style?: number - } - export type CommonSchemaConfig = { - /** 文本配置信息 */ - text_field_setting?: Lark.TextFieldSetting - /** 数字配置信息 */ - number_field_setting?: Lark.NumberFieldSetting - /** 枚举配置信息 */ - enum_field_setting?: Lark.EnumFieldSetting - /** 查找字段配置信息 */ - lookup_field_setting?: Lark.LookupFieldSetting - /** 日期时间配置信息 */ - date_time_field_setting?: Lark.DateTimeFieldSetting - /** 附件配置信息 */ - attachment_field_setting?: Lark.AttachmentFieldSetting - /** 图片配置信息 */ - image_field_setting?: Lark.ImageFieldSetting - } - export type Object = { - /** 对象 apiname */ - object_api_name?: string - /** 对象名称 */ - name?: Lark.Name - /** 是否启用 */ - is_open?: boolean - /** 创建时间 */ - create_time?: string - /** 更新时间 */ - update_time?: string - } - export type CountryRegion = { - /** 国家/地区 ID */ - country_region_id?: string - /** 国家/地区名称 */ - name?: Lark.I18n[] - /** 国家/地区全称 */ - full_name?: Lark.I18n[] - /** 国家地区二字码 */ - alpha_2_code?: string - /** 国家地区三字码 */ - alpha_3_code?: string - /** 国际电话区号 */ - global_code?: string - /** 状态 */ - status?: number - } - export type Enum = { - /** 枚举值 */ - enum_name: string - /** 枚举多语展示 */ - display?: Lark.I18n[] - } - export type CountryRegionSubdivision = { - /** 省份/行政区 ID */ - country_region_subdivision_id?: string - /** 省份/行政区名称 */ - name?: Lark.I18n[] - /** 所属国家/地区 ID，详细信息可通过【查询国家/地区信息】接口查询获得 */ - country_region_id?: string - /** 行政区类型，枚举值可通过文档【飞书人事枚举常量】行政区类型（subdivision_type）枚举定义部分获得 */ - subdivision_type?: Lark.Enum - /** 省份/行政区三字码 */ - iso_code?: string - /** 状态 */ - status?: number - } - export type City = { - /** 城市 ID */ - city_id?: string - /** 城市名称 */ - name?: Lark.I18n[] - /** 所属国家/地区 ID，详细信息可通过【查询国家/地区信息】接口查询获得 */ - country_region_subdivision_id?: string - /** 城市三字码 */ - code?: string - /** 状态 */ - status?: number - } - export type District = { - /** 区/县 ID */ - district_id?: string - /** 名称 */ - name?: Lark.I18n[] - /** 所属城市 ID */ - city_id?: string - /** 状态 */ - status?: number - } - export type ObjectFieldData = { - /** 字段名 */ - field_name: string - /** 字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(123, 123.23, true, [\"id1\",\"id2\], 2006-01-02 15:04:05]) */ - value: string - } - export type EmployeeType = { - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 名称 */ - name: Lark.I18n[] - /** 默认雇员类型 */ - default_employee_type: boolean - /** 启用 */ - active: boolean - /** 编码 */ - code?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - } - export type NationalIdType = { - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 国家 / 地区 */ - country_region_id: string - /** 名称 */ - name: Lark.I18n[] - /** 启用 */ - active: boolean - /** 校验规则 */ - validation_rule: string - /** 校验规则描述 */ - validation_rule_description?: Lark.I18n[] - /** 编码 */ - code: string - /** 证件类型 */ - identification_type: Lark.Enum - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - } - export type WorkingHoursType = { - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 编码 */ - code?: string - /** 名称 */ - name: Lark.I18n[] - /** 国家/地区 */ - country_region_id_list?: string[] - /** 职务默认值 */ - default_for_job: boolean - /** 启用 */ - active: boolean - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - } - export type Currency = { - /** 货币 ID */ - currency_id?: string - /** 货币所属国家/地区 ID，详细信息可通过【查询国家/地区信息】接口查询获得 */ - country_region_id?: string - /** 货币名称 */ - currency_name?: Lark.I18n[] - /** 数字代码 */ - numeric_code?: number - /** 三位字母代码 */ - currency_alpha_3_code?: string - /** 状态 */ - status?: number - } - export type CustomName = { - /** 中文 */ - zh_cn?: string - /** 英文 */ - en_us?: string - } - export type CustomFieldData = { - /** 自定义字段 apiname，即自定义字段的唯一标识 */ - custom_api_name: string - /** 自定义字段名称 */ - name?: Lark.CustomName - /** 自定义字段类型 */ - type?: number - /** 字段值，是 json 转义后的字符串，根据元数据定义不同，字段格式不同（如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05"） */ - value: string - } - export type WorkEmail = { - /** 邮箱地址 */ - email: string - /** 邮箱用途，枚举值可通过文档【飞书人事枚举常量】邮箱用途（email_usage）枚举定义获得 */ - email_usage?: Lark.Enum - } - export type JobDataCostCenter = { - /** 成本中心 ID，可以通过【查询单个成本中心信息】接口获取对应的成本中心信息 */ - cost_center_id?: string - /** 分摊比例 */ - rate?: number - } - export type PersonName = { - /** 姓 - 本地文字 */ - local_primary?: string - /** 名 - 本地文字 */ - local_first_name?: string - /** 国家 / 地区 */ - country_region_id: string - /** 姓名类型 */ - name_type: Lark.Enum - /** 名 - 第二本地文字 */ - local_first_name_2?: string - /** 姓 - 第二本地文字 */ - local_primary_2?: string - /** 补充姓名类型 */ - additional_name_type?: Lark.Enum - /** 名 */ - first_name?: string - /** 全名 */ - full_name?: string - /** 姓氏称谓 */ - hereditary?: string - /** 自定义姓名（未传入时，姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接） */ - custom_name?: string - /** 本地文字的自定义姓名（未传入时，本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接） */ - custom_local_name?: string - /** 中间名 */ - middle_name?: string - /** 姓 */ - name_primary?: string - /** 第二姓氏 */ - secondary?: string - /** 尊称 */ - social?: Lark.Enum - /** 婚后姓氏 */ - tertiary?: string - /** 头衔 */ - title?: Lark.Enum - /** 本地中间名 */ - local_middle_name?: string - /** 第二姓氏 - 本地文字 */ - local_secondary?: string - /** 展示姓名（本地和西方文字） */ - display_name_local_and_western_script?: string - /** 展示姓名（本地文字） */ - display_name_local_script?: string - /** 展示姓名（西方文字） */ - display_name_western_script?: string - } - export type Phone = { - /** 国家区号 */ - international_area_code?: Lark.Enum - /** 电话号码 */ - phone_number: string - /** 完整电话号码 */ - formatted_phone_number?: string - /** 设备类型 */ - device_type?: Lark.Enum - /** 电话用途 */ - phone_usage?: Lark.Enum - /** 主要电话 */ - is_primary?: boolean - /** 公开电话 */ - is_public?: boolean - } - export type Address = { - /** 完整地址（本地文字） */ - full_address_local_script?: string - /** 完整地址（西方文字） */ - full_address_western_script?: string - /** 地址 ID */ - address_id?: string - /** 国家 / 地区 */ - country_region_id: string - /** 主要行政区 */ - region_id?: string - /** 城市 */ - city_id_v2?: string - /** 区/县 */ - district_id_v2?: string - /** 地址行 1（非拉丁语系的本地文字） */ - local_address_line1?: string - /** 地址行 2（非拉丁语系的本地文字） */ - local_address_line2?: string - /** 地址行 3（非拉丁语系的本地文字） */ - local_address_line3?: string - /** 地址行 4（非拉丁语系的本地文字） */ - local_address_line4?: string - /** 地址行 5（非拉丁语系的本地文字） */ - local_address_line5?: string - /** 地址行 6（非拉丁语系的本地文字） */ - local_address_line6?: string - /** 地址行 7（非拉丁语系的本地文字） */ - local_address_line7?: string - /** 地址行 8（非拉丁语系的本地文字） */ - local_address_line8?: string - /** 地址行 9（非拉丁语系的本地文字） */ - local_address_line9?: string - /** 邮政编码 */ - postal_code?: string - /** 地址类型 */ - address_type_list: Lark.Enum[] - /** 主要地址 */ - is_primary: boolean - /** 公开地址 */ - is_public: boolean - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - } - export type Email = { - /** 邮箱地址 */ - email: string - /** 是否为主要邮箱 */ - is_primary?: boolean - /** 是否为公开邮箱 */ - is_public?: boolean - /** 邮箱用途，枚举值可通过文档【飞书人事枚举常量】邮箱用途（email_usage）枚举定义获得 */ - email_usage?: Lark.Enum - } - export type WorkExperienceInfo = { - /** 公司 / 组织 */ - company_organization?: Lark.I18n[] - /** 部门 */ - department?: Lark.I18n[] - /** 岗位 */ - job?: Lark.I18n[] - /** 工作描述 */ - description?: Lark.I18n[] - /** 开始日期 */ - start_date?: string - /** 结束日期 */ - end_date?: string - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - } - export type BankAccount = { - /** 银行名称 */ - bank_name?: string - /** 银行账号 */ - bank_account_number: string - /** 开户人姓名 */ - account_holder: string - /** 支行名称 */ - branch_name?: string - /** 银行 ID，详细信息可通过【查询银行信息】接口查询获得 */ - bank_id_v2?: string - /** 支行 ID，要求必须为填入银行的支行，详细信息可通过【查询支行信息】接口查询获得 */ - branch_id_v2?: string - /** 国家/地区 ID，详细信息可通过【查询国家/地区信息】接口查询获得 */ - country_region_id?: string - /** 银行卡用途，枚举值可通过文档【飞书人事枚举常量】银行卡用途（Bank Account Usage）枚举定义部分获得 */ - bank_account_usage?: Lark.Enum[] - /** 银行卡类型，枚举值可通过文档【飞书人事枚举常量】银行卡类型（Bank Account Type）枚举定义部分获得 */ - bank_account_type?: Lark.Enum - /** 货币id */ - currency_id?: string - /** 国际银行账号 */ - IBAN?: string - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - } - export type NationalId = { - /** 国家证件类型 */ - national_id_type_id: string - /** 证件号码 */ - national_id_number: string - /** 证件签发日期 */ - issue_date?: string - /** 证件到期日期 */ - expiration_date?: string - /** 国家 / 地区 */ - country_region_id: string - /** 证件签发机构 */ - issued_by?: string - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - } - export type Dependent = { - /** 姓名 */ - name?: Lark.PersonName - /** 关系 */ - relationship: Lark.Enum - /** 性别 */ - gender?: Lark.Enum - /** 生日 */ - date_of_birth?: string - /** 国籍 ID，可通过【查询国籍信息】接口查询 */ - nationality_id_v2?: string - /** 证件号码 */ - national_id_list?: Lark.NationalId[] - /** 配偶工作状态 */ - spouses_working_status?: Lark.Enum - /** 包含家属医疗保险 */ - is_this_person_covered_by_health_insurance?: boolean - /** 允许家属抵扣税款 */ - is_this_person_allowed_for_tax_deduction?: boolean - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - /** 家庭成员姓名 */ - dependent_name?: string - /** 工作单位 */ - employer?: string - /** 岗位 */ - job?: string - /** 电话 */ - phone?: Lark.Phone - /** 联系地址 */ - address?: Lark.Address - /** 出生证明 */ - birth_certificate_of_child?: Lark.File[] - } - export type PersonalProfile = { - /** 资料类型 */ - personal_profile_type?: Lark.Enum - /** 上传文件列表 */ - files?: Lark.File[] - } - export type ResidentTax = { - /** 年度 */ - year_resident_tax: string - /** -| 居民身份，枚举值 api_name 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "resident_tax" - custom_api_name = "resident_status" */ - resident_status?: Lark.Enum - /** 国家/地区，可通过【查询国家/地区信息】 接口查询 */ - tax_country_region_id?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - } - export type PersonInfo = { - /** 个人信息 ID */ - person_id?: string - /** 个人电话 */ - phone_number?: string - /** 法定姓名 */ - legal_name?: string - /** 常用名 */ - preferred_name?: string - /** 常用本地全名 */ - preferred_local_full_name?: string - /** 常用英文全名 */ - preferred_english_full_name?: string - /** 姓名列表 */ - name_list?: Lark.PersonName[] - /** -| 性别，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：gender - object_api_name：person */ - gender?: Lark.Enum - /** 出生日期 */ - date_of_birth?: string - /** 国籍 ID，可通过【查询国籍信息】接口查询 */ - nationality_id_v2?: string - /** -| 民族 / 种族，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：ethnicity_race - object_api_name：person */ - race?: Lark.Enum - /** -| 婚姻状况，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：marital_status - object_api_name：person */ - marital_status?: Lark.Enum - /** 电话列表，只有当满足下面所有条件时，电话在个人信息页才可见 */ - phone_list?: Lark.Phone[] - /** 地址列表 */ - address_list?: Lark.Address[] - /** 邮箱列表 */ - email_list?: Lark.Email[] - /** 工作经历列表 */ - work_experience_list?: Lark.WorkExperienceInfo[] - /** 教育经历列表 */ - education_list?: Lark.Education[] - /** 银行账户 */ - bank_account_list?: Lark.BankAccount[] - /** 证件 */ - national_id_list?: Lark.NationalId[] - /** 家庭成员列表 */ - dependent_list?: Lark.Dependent[] - /** 紧急联系人列表 */ - emergency_contact_list?: Lark.EmergencyContact[] - /** 参加工作日期 */ - date_entered_workforce?: string - /** 工龄 */ - working_years?: number - /** 头像资源的 ID */ - profile_image_id?: string - /** 邮箱地址 */ - email_address?: string - /** 年龄 */ - age?: number - /** 最高学历教育经历 */ - highest_level_of_education?: Lark.Education - /** 最高学位教育经历 */ - highest_degree_of_education?: Lark.Education - /** 个人资料附件 */ - personal_profile?: Lark.PersonalProfile[] - /** 籍贯 ID */ - native_region?: string - /** 户口类型，枚举值可通过文档【飞书人事枚举常量】户口类型（hukou_type）枚举定义部分获得 */ - hukou_type?: Lark.Enum - /** 户口所在地 */ - hukou_location?: string - /** 人才 ID */ - talent_id?: string - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - /** 居民身份证件号码 */ - national_id_number?: string - /** 家庭地址 */ - family_address?: string - /** 出生国家/地区 */ - born_country_region?: string - /** 是否残疾 */ - is_disabled?: boolean - /** 残疾证号 */ - disable_card_number?: string - /** 是否烈属 */ - is_martyr_family?: boolean - /** 烈属证号 */ - martyr_card_number?: string - /** 是否孤老 */ - is_old_alone?: boolean - /** 居民身份信息 */ - resident_taxes?: Lark.ResidentTax[] - /** 首次入境日期 */ - first_entry_time?: string - /** 预计离境日期 */ - leave_time?: string - } - export type BasicDepartment = { - /** 部门 ID */ - id?: string - /** 部门名称 */ - department_name?: Lark.I18n[] - } - export type BasicPersonInfo = { - /** 个人信息 ID */ - person_id?: string - /** 常用名 */ - preferred_name?: string - /** 常用本地全名 */ - preferred_local_full_name?: string - /** 常用英文全名 */ - preferred_english_full_name?: string - } - export type BasicEmployee = { - /** 雇佣 ID */ - employment_id?: string - /** 工号 */ - employee_number?: string - /** 邮箱地址 */ - email_address?: string - /** 基本个人信息 */ - person_info?: Lark.BasicPersonInfo - } - export type EmploymentCreate = { - /** 待入职 ID */ - prehire_id?: string - /** 人员类型 */ - employee_type_id?: string - /** 司龄 */ - tenure?: string - /** 部门 ID，枚举值及详细信息可通过【批量查询部门】接口查询获得 */ - department_id?: string - /** 职级 ID，枚举值及详细信息可通过【批量查询职务级别】接口查询获得 */ - job_level_id?: string - /** 工作地点 ID，枚举值及详细信息可通过【批量查询地点】接口查询获得 */ - work_location_id?: string - /** 职务序列 ID，枚举值及详细信息可通过【批量查询职务序列】接口查询获得 */ - job_family_id?: string - /** 职务 ID，枚举值及详细信息可通过【批量查询职务】接口查询获得 */ - job_id?: string - /** 法人主体 ID，枚举值及详细信息可通过【批量查询公司】接口查询获得 */ - company_id?: string - /** 工时制度 ID，枚举值及详细信息可通过【批量查询工时制度】接口查询获得 */ - working_hours_type_id?: string - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 资历起算日期 */ - seniority_date?: string - /** 员工编号 */ - employee_number?: string - /** 入职日期 */ - effective_time: string - /** 离职日期 */ - expiration_time?: string - /** 雇佣类型 */ - employment_type: Lark.Enum - /** 人员信息，引用Person的ID */ - person_id: string - /** 试用期时长 */ - probation_period?: number - /** 是否在试用期中 */ - on_probation?: string - /** 试用期结束日期 */ - probation_end_date?: string - /** 是否是主雇佣信息 */ - primary_employment: boolean - /** 雇员状态 */ - employment_status?: Lark.Enum - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 工作邮箱列表 */ - work_email_list?: Lark.Email[] - /** 邮箱 */ - email_address?: string - /** 离职原因 */ - reason_for_offboarding?: Lark.Enum - /** 成本中心列表 */ - cost_center_list?: Lark.JobDataCostCenter[] - /** 招聘应用 ID */ - ats_application_id?: string - /** 是否离职重聘 */ - rehire?: Lark.Enum - /** 历史雇佣信息 ID */ - rehire_employment_id?: string - } - export type Employment = { - /** 待入职 ID */ - prehire_id?: string - /** 人员类型 */ - employee_type_id?: string - /** 司龄 */ - tenure?: string - /** 部门 ID，枚举值及详细信息可通过【批量查询部门】接口查询获得 */ - department_id?: string - /** 职级 ID，枚举值及详细信息可通过【批量查询职务级别】接口查询获得 */ - job_level_id?: string - /** 工作地点 ID，枚举值及详细信息可通过【批量查询地点】接口查询获得 */ - work_location_id?: string - /** 职务序列 ID，枚举值及详细信息可通过【批量查询职务序列】接口查询获得 */ - job_family_id?: string - /** 职务 ID，枚举值及详细信息可通过【批量查询职务】接口查询获得 */ - job_id?: string - /** 法人主体 ID，枚举值及详细信息可通过【批量查询公司】接口查询获得 */ - company_id?: string - /** 工时制度 ID，枚举值及详细信息可通过【批量查询工时制度】接口查询获得 */ - working_hours_type_id?: string - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 资历起算日期 */ - seniority_date?: string - /** 员工编号 */ - employee_number?: string - /** 入职日期 */ - effective_time: string - /** 离职日期 */ - expiration_time?: string - /** 雇佣类型 */ - employment_type: Lark.Enum - /** 人员信息，引用Person的ID */ - person_id: string - /** 试用期时长 */ - probation_period?: number - /** 是否在试用期中 */ - on_probation?: string - /** 试用期结束日期 */ - probation_end_date?: string - /** 是否是主雇佣信息 */ - primary_employment: boolean - /** 雇员状态 */ - employment_status?: Lark.Enum - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 工作邮箱列表 */ - work_email_list?: Lark.Email[] - /** 邮箱 */ - email_address?: string - /** 离职原因 */ - reason_for_offboarding?: Lark.Enum - /** 成本中心列表 */ - cost_center_list?: Lark.JobDataCostCenter[] - /** 招聘应用 ID */ - ats_application_id?: string - } - export type SupportCostCenterItem = { - /** 支持的成本中心id */ - cost_center_id?: string - /** 分摊比例 */ - rate?: number - } - export type JobData = { - /** 实体在 CoreHR 内部的唯一键 */ - id?: string - /** 级别 */ - job_level_id?: string - /** 雇员类型 */ - employee_type_id: string - /** 工时制度 */ - working_hours_type_id?: string - /** 工作地点 */ - work_location_id?: string - /** 部门 */ - department_id?: string - /** 职务 */ - job_id?: string - /** 试用期开始日期 */ - probation_start_date?: string - /** 试用期 */ - probation_end_date?: string - /** 主任职 */ - primary_job_data: boolean - /** Employment ID */ - employment_id: string - /** 生效时间 */ - effective_time: string - /** 失效时间 */ - expiration_time?: string - /** 职务分类 ID */ - job_family_id?: string - /** 任职原因 */ - assignment_start_reason?: Lark.Enum - /** 试用期结束日期 */ - probation_expected_end_date?: string - /** 周工作时长 */ - weekly_working_hours?: number - /** 实线主管 */ - direct_manager_id?: string - /** 虚线主管 */ - dotted_line_manager_id_list?: string[] - /** 第二实线主管 */ - second_direct_manager_id?: string - /** 成本中心分摊信息 */ - cost_center_rate?: Lark.SupportCostCenterItem[] - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - } - export type BasicJobData = { - /** 任职信息 ID */ - job_data_id?: string - /** 雇佣 ID */ - employment_id?: string - } - export type EmployeeJobData = { - /** Employment ID */ - employment_id: string - /** 实体在 CoreHR 内部的唯一键 */ - job_datas?: Lark.JobData[] - } - export type DepartmentParentInfo = { - /** 部门 ID */ - department_id?: string - /** 部门名称 */ - department_name?: Lark.I18n[] - /** 上级部门 ID */ - parent_department_id?: string - /** 是否启用 */ - active?: boolean - /** 是否根部门 */ - is_root?: boolean - } - export type DepartmentParents = { - /** 部门 ID */ - department_id?: string - /** 父部门列表，部门按照至底向上的顺序返回 */ - parent_department_list?: Lark.DepartmentParentInfo[] - } - export type HiberarchyCommon = { - /** 上级组织 */ - parent_id?: string - /** 名称 */ - name: Lark.I18n[] - /** 启用 */ - active: boolean - /** 编码 */ - code?: string - /** 描述 */ - description?: Lark.I18n[] - } - export type DepartmentCreate = { - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 子类型 */ - sub_type?: Lark.Enum - /** 部门负责人 */ - manager?: string - /** 是否保密 */ - is_confidential?: boolean - /** 层级关系，内层字段见实体 */ - hiberarchy_common: Lark.HiberarchyCommon - /** 生效时间 */ - effective_time: string - /** 失效时间 */ - expiration_time?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 成本中心id */ - cost_center_id?: string - } - export type Company = { - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 层级关系，内层字段见实体 */ - hiberarchy_common: Lark.HiberarchyCommon - /** 性质 */ - type?: Lark.Enum - /** 行业 */ - industry_list?: Lark.Enum[] - /** 法定代表人 */ - legal_representative?: Lark.I18n[] - /** 邮编 */ - post_code?: string - /** 纳税人识别号 */ - tax_payer_id?: string - /** confidential */ - confidential?: boolean - /** 主体类型 */ - sub_type_list?: Lark.Enum[] - /** 是否为分公司 */ - branch_company?: boolean - /** 主要负责人 */ - primary_manager?: Lark.I18n[] - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - } - export type PhoneNumberAndAreaCode = { - /** 区号 */ - area_code: Lark.Enum - /** 号码 */ - phone_number: string - } - export type CostCenter = { - /** 成本中心ID */ - cost_center_id?: string - /** 成本中心名称 */ - name: Lark.I18n[] - /** 编码 */ - code?: string - /** 上级成本中心ID */ - parent_cost_center_id?: string - /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ - managers?: string[] - /** 成本中心描述 */ - description?: Lark.I18n[] - /** 生效时间 */ - effective_time: string - /** 过期时间 */ - expiration_time?: string - /** 当前实体是否启用 */ - active?: boolean - } - export type CostCenterVersion = { - /** 成本中心ID */ - cost_center_id?: string - /** 成本中心版本ID */ - version_id?: string - /** 成本中心名称 */ - name: Lark.I18n[] - /** 编码 */ - code?: string - /** 上级成本中心ID */ - parent_cost_center_id?: string - /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ - managers?: string[] - /** 成本中心描述 */ - description?: Lark.I18n[] - /** 生效时间 */ - effective_time: string - /** 过期时间 */ - expiration_time?: string - /** 当前实体是否启用 */ - active?: boolean - } - export type BasicInfo = { - /** 描述 */ - name?: Lark.Name - /** 手机号 */ - phone_number?: string - /** 区号 */ - international_area_code?: string - /** 个人邮箱 */ - email?: string - /** 生日 */ - date_of_birth?: string - /** 证件号 */ - personal_id_number?: string - /** 参加工作日期 */ - date_entered_workforce?: string - /** 性别 */ - gender_id?: string - /** 国籍 */ - nationality_id?: string - /** 家庭地址 */ - home_address?: string - /** 人员编号 */ - worker_id?: string - } - export type OfferInfo = { - /** Offer id */ - offer_id?: string - /** Offer hr id */ - offer_hr_id?: string - /** 部门 id */ - department_id?: string - /** 直属领导id */ - direct_leader_id?: string - /** 职务id */ - job_id?: string - /** 序列id */ - job_family_id?: string - /** 级别id */ - job_level_id?: string - /** 职务头衔id */ - job_title?: string - /** 试用期开始日期 */ - probation_start_date?: string - /** 试用期结束日期 */ - probation_end_date?: string - /** 合同开始日期 */ - contract_start_date?: string - /** 合同结束日期 */ - contract_end_date?: string - /** 入职日期 */ - onboarding_date?: string - /** 入职地点id */ - onboarding_location_id?: string - /** 办公地点id */ - office_location_id?: string - /** 招聘来源id */ - recruitment_type_id?: string - /** 试用期时长 */ - probation_period?: string - /** 人员类型id */ - employee_type_id?: string - /** 雇佣类型id */ - employment_type_id?: string - /** 工作邮箱 */ - work_email?: string - /** 期限类型id */ - duration_type_id?: string - /** 签订类型id */ - signing_type_id?: string - /** 入职方式 */ - entry_mode?: string - /** 社保城市id */ - social_security_city_id?: string - /** 合同类型 */ - contract_type?: string - /** 公司 */ - company?: string - /** 成本中心分摊信息 */ - cost_center_rate?: Lark.JobDataCostCenter[] - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - } - export type EducationInfo = { - /** 学校名称 */ - school_name?: string - /** 学历 */ - education?: string - /** 开始时间 */ - start_time?: string - /** 结束时间 */ - end_time?: string - /** 专业 */ - field_of_study?: string - } - export type PreHire = { - /** 招聘系统的候选人 ID */ - ats_application_id?: string - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 入职日期 */ - hire_date?: string - /** 雇佣类型 */ - employee_type: Lark.Enum - /** 人员编号 */ - worker_id?: string - /** 雇佣类型 */ - employee_type_id: string - /** 引用Person ID */ - person_id: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 成本中心分摊信息 */ - cost_center_rate?: Lark.SupportCostCenterItem[] - /** 入职状态 */ - onboarding_status: Lark.Enum - } - export type PreHireQuery = { - /** 招聘系统的候选人 ID */ - ats_application_id?: string - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 入职日期 */ - hire_date?: string - /** 雇佣类型 */ - employee_type: Lark.Enum - /** 人员编号 */ - worker_id?: string - /** 雇佣类型 */ - employee_type_id: string - /** 引用Person ID */ - person_id: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 入职状态 */ - onboarding_status: Lark.Enum - /** 成本中心分摊信息 */ - cost_center_rate?: Lark.SupportCostCenterItem[] - /** 工作邮箱 */ - work_email_list?: Lark.Email[] - /** 部门ID */ - department_id?: string - } - export type Contract = { - /** 合同ID */ - id?: string - /** 合同开始日期 */ - effective_time?: string - /** 合同结束日期 */ - contract_end_date?: string - /** 实际结束日期 */ - expiration_time?: string - /** 雇佣 ID */ - employment_id?: string - /** 合同类型，枚举值可通过文档【飞书人事枚举常量】合同类型（contract_type）枚举定义部分获得 */ - contract_type?: Lark.Enum - /** 合同主体, 引用Company的ID，枚举值及详细信息可通过【批量查询公司】接口查询获得 */ - first_party_company_id?: string - /** Person ID，枚举值及详细信息可通过【批量查询个人信息】接口查询获得 */ - person_id?: string - /** 期限类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（duration_type）枚举定义部分获得 */ - duration_type?: Lark.Enum - /** 合同编号 */ - contract_number?: string - /** 签订类型，枚举值可通过文档【飞书人事枚举常量】签订类型（signing_type）枚举定义部分获得 */ - signing_type?: Lark.Enum - } - export type Assessment = { - /** 考核结果 ID */ - assessment_id?: string - /** 考核状态 */ - assessment_status?: Lark.Enum - /** 试用期考核结果 */ - assessment_result?: Lark.Enum - /** 考核得分 */ - assessment_score?: number - /** 试用期考核等级 */ - assessment_grade?: Lark.Enum - /** 考核评语 */ - assessment_comment?: string - /** 考核结果页面超链接 */ - assessment_detail?: string - /** 是否为最终考核结果 */ - is_final_asssessment?: boolean - } - export type ProbationInfo = { - /** 雇佣 ID */ - employment_id?: string - /** 试用期信息 ID */ - probation_id?: string - /** 试用期开始日期 */ - probation_start_date?: string - /** 试用期预计结束日期 */ - probation_expected_end_date?: string - /** 试用期实际结束日期 */ - actual_probation_end_date?: string - /** 转正发起日期 */ - initiating_time?: string - /** 发起方 */ - submission_type?: Lark.Enum - /** 转正发起人的雇佣 ID，当系统发起转正时该字段为空 */ - initiator_id?: string - /** 试用期状态 */ - probation_status?: Lark.Enum - /** 员工自评 */ - self_review?: string - /** 备注 */ - notes?: string - /** 流程实例 ID */ - process_id?: string - /** 是否通过 BPM 转正 */ - converted_via_bpm?: boolean - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - /** 试用期考核最终状态 */ - final_assessment_status?: Lark.Enum - /** 试用期考核最终结果 */ - final_assessment_result?: Lark.Enum - /** 试用期考核最终得分 */ - final_assessment_score?: number - /** 试用期考核最终等级 */ - final_assessment_grade?: Lark.Enum - /** 试用期考核最终评语 */ - final_assessment_comment?: string - /** 最终考核结果页面超链接 */ - final_assessment_detail?: string - /** 试用期考核结果列表 */ - assessments?: Lark.Assessment[] - } - export type AssessmentForCreate = { - /** 考核状态 */ - assessment_status: string - /** 试用期考核结果 */ - assessment_result?: string - /** 考核得分 */ - assessment_score?: number - /** 试用期考核等级 */ - assessment_grade?: string - /** 考核评语 */ - assessment_comment?: string - /** 考核结果页面超链接 */ - assessment_detail?: string - /** 是否为最终考核结果 */ - is_final_asssessment: boolean - } - export type TransferReason = { - /** 异动原因唯一标识 */ - transfer_reason_unique_identifier?: string - /** 内容 */ - name?: Lark.I18n[] - /** active */ - active?: boolean - /** 上级异动原因唯一标识 */ - parent_transfer_reason_unique_identifier?: string - /** 创建时间 */ - created_time?: string - /** 更新时间 */ - updated_time?: string - } - export type TransferType = { - /** 异动类型唯一标识 */ - transfer_type_unique_identifier?: string - /** 异动类型名称 */ - name?: Lark.I18n[] - /** 异动类型状态 */ - active?: boolean - /** 关联流程唯一标识符 */ - flow_id?: string - /** 关联流程名称 */ - flow_name?: Lark.I18n[] - /** 创建时间 */ - created_time?: string - /** 更新时间 */ - updated_time?: string - } - export type TransferInfo = { - /** 备注 */ - remark?: string - /** offer信息 */ - offer_info?: string - /** 是否撤销虚线上级 */ - target_dotted_manager_clean?: boolean - /** 是否有试用期 */ - probation_exist?: boolean - /** 原部门 */ - original_department?: string - /** 新部门 */ - target_department?: string - /** 原工作地点 */ - original_work_location?: string - /** 新工作地点 */ - target_work_location?: string - /** 原直属上级 */ - original_direct_manager?: string - /** 新直属上级 */ - target_direct_manager?: string - /** 原虚线上级 */ - original_dotted_manager?: string - /** 新虚线上级 */ - target_dotted_manager?: string - /** 原职务 */ - original_job?: string - /** 新职务 */ - target_job?: string - /** 原序列 */ - original_job_family?: string - /** 新序列 */ - target_job_family?: string - /** 原级别 */ - original_job_level?: string - /** 新级别 */ - target_job_level?: string - /** 原人员类型 */ - original_workforce_type?: string - /** 新人员类型 */ - target_workforce_type?: string - /** 原公司 */ - original_company?: string - /** 新公司 */ - target_company?: string - /** 原合同编号 */ - original_contract_number?: string - /** 新合同编号 */ - target_contract_number?: string - /** 原合同类型 */ - original_contract_type?: string - /** 新合同类型 */ - target_contract_type?: string - /** 原期限类型 */ - original_duration_type?: string - /** 新期限类型 */ - target_duration_type?: string - /** 原签订类型 */ - original_signing_type?: string - /** 新签订类型 */ - target_signing_type?: string - /** 原合同开始日期 */ - original_contract_start_date?: string - /** 新合同开始日期 */ - target_contract_start_date?: string - /** 原合同结束日期 */ - original_contract_end_date?: string - /** 新合同结束日期 */ - target_contract_end_date?: string - /** 原工时制度 */ - original_working_hours_type?: string - /** 新工时制度 */ - target_working_hours_type?: string - /** 原工作日历 */ - original_working_calendar?: string - /** 新工作日历 */ - target_working_calendar?: string - /** 原试用期预计结束日期 */ - original_probation_end_date?: string - /** 新试用期预计结束日期 */ - target_probation_end_date?: string - /** 原周工作时长 */ - original_weekly_working_hours?: string - /** 新周工作时长 */ - target_weekly_working_hours?: string - /** 原排班 */ - original_work_shift?: string - /** 新排班 */ - target_work_shift?: string - /** 原成本中心分摊信息 */ - original_cost_center_rate?: Lark.SupportCostCenterItem[] - /** 新成本中心分摊信息 */ - target_cost_center_rate?: Lark.SupportCostCenterItem[] - } - export type JobChange = { - /** 异动记录 id */ - job_change_id?: string - /** 雇员 id */ - employment_id?: string - /** 异动状态 */ - status?: string - /** 异动类型 */ - transfer_type_unique_identifier?: string - /** 异动原因 */ - transfer_reason_unique_identifier?: string - /** 异动流程 id */ - process_id?: string - /** 生效时间 */ - effective_date?: string - /** 创建时间 */ - created_time?: string - /** 异动详细信息 */ - transfer_info?: Lark.TransferInfo - } - export type OffboardingReason = { - /** 离职原因唯一标识 */ - offboarding_reason_unique_identifier?: string - /** 名称 */ - name?: Lark.I18n[] - /** 是否启用 */ - active?: boolean - /** 当前离职原因的父级原因唯一标识 */ - parent_offboarding_reason_unique_identifier?: string - /** 创建时间 */ - created_time?: string - /** 更新时间 */ - updated_time?: string - } - export type ApplicationInfo = { - /** 离职审批发起人的雇佣 ID */ - apply_initiator_id?: string - /** 离职申请流程发起时间 */ - apply_initiating_time?: string - /** 离职申请流程结束时间 */ - apply_finish_time?: string - /** 流程 ID */ - process_id?: string - } - export type OffboardingInfo = { - /** 离职员工的雇佣 ID */ - employment_id?: string - /** 员工的 hrbp 列表，所有的 hrbp */ - hrbp_id?: string[] - /** 期望离职日期 */ - expected_offboarding_date?: string - /** 离职日期 */ - offboarding_date?: string - /** 离职原因 */ - reason?: Lark.Enum - /** 离职原因说明 */ - reason_explanation?: string - /** 离职原因（员工） */ - employee_reason?: Lark.Enum - /** 离职原因说明（员工） */ - employee_reason_explanation?: string - /** 是否加入离职屏蔽名单 */ - add_block_list?: string - /** 屏蔽原因 */ - block_reason?: Lark.Enum - /** 屏蔽原因说明 */ - block_reason_explanation?: string - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - } - export type OffboardingChecklist = { - /** 离职办理状态 */ - checklist_status?: string - /** 离职流转开始时间 */ - checklist_start_time?: string - /** 离职流转结束时间 */ - checklist_finish_time?: string - /** 离职流转流程实例 ID */ - checklist_process_id?: string - } - export type Offboarding = { - /** 离职发起类型，包括： */ - initiating_type?: string - /** 离职状态 */ - status?: string - /** 离职审批信息 */ - application_info?: Lark.ApplicationInfo - /** 员工离职信息 */ - offboarding_info?: Lark.OffboardingInfo - /** 离职办理流程信息 */ - offboarding_checklist?: Lark.OffboardingChecklist - } - export type LeaveGrantingRecord = { - /** 假期授予记录 ID */ - id: string - /** 员工 ID */ - employment_id: string - /** 假期类型 ID */ - leave_type_id: string - /** 授予数量 */ - granting_quantity: string - /** 授予时长单位 */ - granting_unit: number - /** 生效时间 */ - effective_date: string - /** 失效时间（根据休假规则自动计算） */ - expiration_date: string - /** 授予来源 */ - granted_by: number - /** 授予原因 */ - reason: Lark.I18n[] - /** 授予记录的创建时间，毫秒级unix时间戳 */ - created_at: string - /** 授予记录的创建人，值为创建人的员工 ID */ - created_by: string - /** 授予记录的更新时间 */ - updated_at: string - /** 授予记录的更新人，值为更新人的员工 ID */ - updated_by: string - } - export type LeaveSubtype = { - /** 假期子类ID */ - leave_type_id: string - /** 假期子类名称 */ - leave_type_name: Lark.I18n[] - } - export type LeaveType = { - /** 假期类型ID */ - leave_type_id: string - /** 假期类型名称 */ - leave_type_name: Lark.I18n[] - /** 假期类型状态 */ - status: number - /** 假期子类列表 */ - leave_subtype_list?: Lark.LeaveSubtype[] - /** 假期类型的创建时间 */ - created_at: string - /** 假期类型的创建人，值为创建人的员工 ID */ - created_by: string - /** 假期类型的更新时间 */ - updated_at: string - /** 假期类型的更新人，值为更新人的员工 ID */ - updated_by: string - } - export type LeaveBalance = { - /** 假期类型ID */ - leave_type_id: string - /** 假期类型名称 */ - leave_type_name: Lark.I18n[] - /** 结转的历史周期授予时长 */ - historical_cycles_left?: string - /** 本周期授予时长 */ - this_cycle_total?: string - /** 本周期已休时长 */ - this_cycle_taken: string - /** 假期余额 */ - leave_balance: string - /** 假期时长的单位 */ - leave_duration_unit: number - } - export type EmploymentLeaveBalance = { - /** 雇佣信息ID */ - employment_id: string - /** 员工姓名 */ - employment_name: Lark.I18n[] - /** 余额查看日期 */ - as_of_date: string - /** 假期余额列表 */ - leave_balance_list: Lark.LeaveBalance[] - } - export type LeaveRequestDetail = { - /** 请假记录id */ - leave_request_id: string - /** 假期发生日期 */ - leave_date: string - /** 假期时长 */ - leave_duration: string - /** 假期时长单位，1：天，2：小时 */ - leave_duration_unit: number - /** 是否影响算薪，1：不参与算薪计算, 非对应的日期类型或者无对应的假期计划，2：影响算薪，3：不影响算薪 */ - paid_type: number - } - export type LeaveRequest = { - /** 请假记录ID */ - leave_request_id: string - /** 雇佣信息ID */ - employment_id: string - /** 员工姓名 */ - employment_name: Lark.I18n[] - /** 假期类型ID */ - leave_type_id: string - /** 假期类型名称 */ - leave_type_name: Lark.I18n[] - /** 假期开始时间 */ - start_time: string - /** 假期结束时间 */ - end_time: string - /** 假期时长 */ - leave_duration: string - /** 假期时长的单位 */ - leave_duration_unit: number - /** 请假记录的状态 */ - leave_request_status: number - /** 数据来源 */ - grant_source: string - /** 返岗时间 */ - return_time: string - /** 发起时间 */ - submitted_at: string - /** 发起人 */ - submitted_by: string - /** 备注 */ - notes: string - /** 审批通过日期 */ - approval_date?: string - /** 是否带薪 */ - is_deducted?: boolean - /** 请假详情 */ - details?: Lark.LeaveRequestDetail[] - /** 假期类型枚举 */ - leave_type_code?: string - /** 实际结束日期 */ - actual_end_date?: string - /** 预估结束日期 */ - estimated_end_date?: string - /** 时区 */ - time_zone?: string - } - export type EmploymentBp = { - /** 员工雇佣 ID */ - employment_id?: string - /** 员工直属 HRBP 雇佣 ID，若员工是部门负责人，且同部门 HRBP 在权限中配置了 HRBP 不可见部门负责人，则在结果中不会出现该 HRBP */ - hrbp_ids?: string[] - /** 员工直属属地 BP 雇佣 ID */ - location_bp_ids?: string[] - } - export type DepartmentHrbp = { - /** 部门 ID */ - department_id?: string - /** 部门 HRBP 雇佣 ID */ - hrbp_ids?: string[] - } - export type Bp = { - /** 部门 ID */ - department_id?: string - /** 部门 HRBP 的雇佣 ID，不包括上级部门的 HRBP */ - hrbp_id?: string - } - export type BpRoleOrganization = { - /** 角色类型的唯一标识 */ - role_key: string - /** 部门 id */ - department_id: string - /** 工作地点 id */ - work_location_id?: string - } - export type Hrbp = { - /** HRBP/属地 BP 的雇员ID */ - employment_id_list: string[] - /** 部门 id */ - department_id?: string - /** 工作地点 id */ - work_location_id?: string - } - export type ManagementScope = { - /** 管理维度 */ - management_dimension: string - /** 被授权管理维度对象ID */ - obj_id: string - } - export type RoleAuthorization = { - /** 雇员 ID */ - employment_id: string - /** 实际授权管理范围 */ - management_scope_list?: Lark.ManagementScope[] - } - export type SecurityGroup = { - /** 角色ID */ - id: string - /** 角色code */ - code: string - /** 角色名称 */ - name?: Lark.Name - /** 状态 */ - active_status: number - /** 角色描述 */ - description?: Lark.Name - /** 更新时间 */ - update_time: string - } - export type DataengineI18n = { - /** 中文值 */ - zh_cn?: string - /** 英文值 */ - en_us?: string - } - export type ProcessLink = { - /** web端单据详情页地址 */ - web_link?: string - /** 飞书pc端单据详情页地址 */ - pc_link?: string - /** 飞书移动端单据详情页地址 */ - mobile_link?: string - } - export type ProcessAbstractItem = { - /** 摘要标题 */ - name?: Lark.DataengineI18n - /** 摘要值 */ - value?: Lark.DataengineI18n - } - export type ProcessTodoItem = { - /** 单据ID */ - approver_id?: string - /** 单据类型 */ - type?: number - /** 单据地址 */ - links?: Lark.ProcessLink - /** 操作人ID */ - operator_id?: string - /** 操作人姓名 */ - operator_name?: Lark.DataengineI18n - /** 节点名称 */ - node_name?: Lark.DataengineI18n - /** 创建时间，Unix毫秒时间戳 */ - create_time?: string - /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ - node_definition_id?: string - } - export type ProcessCcItem = { - /** 单据ID */ - approver_id?: string - /** 单据地址 */ - links?: Lark.ProcessLink - /** 抄送人ID */ - operator_id?: string - /** 抄送人姓名 */ - operator_name?: Lark.DataengineI18n - /** 节点名称 */ - node_name?: Lark.DataengineI18n - /** 抄送时间，Unix毫秒时间戳 */ - create_time?: string - /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ - node_definition_id?: string - } - export type ProcessDoneItem = { - /** 单据ID */ - approver_id?: string - /** 单据类型 */ - type?: number - /** 单据状态 */ - status?: number - /** 单据地址 */ - links?: Lark.ProcessLink - /** 操作人ID */ - operator_id?: string - /** 操作人姓名 */ - operator_name?: Lark.DataengineI18n - /** 节点名称 */ - node_name?: Lark.DataengineI18n - /** 创建时间，Unix毫秒时间戳 */ - create_time?: string - /** 完成时间，Unix毫秒时间戳 */ - complete_time?: string - /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ - node_definition_id?: string - } - export type BpmDataengineI18n = { - /** i18n类型字段，中文值 */ - zh_cn?: string - /** i18n类型字段，英文值 */ - en_us?: string - } - export type FormFieldVariableTextValue = { - /** 文本类型变量的值 */ - value?: string - } - export type FormFieldVariableNumberValue = { - /** 数值类型变量的值 */ - value?: string - } - export type FormFieldVariableDateValue = { - /** 日期变量的值，从1970起的天数 */ - value?: number - } - export type FormFieldVariableEmploymentValue = { - /** employmentID */ - value?: string - /** 员工ID 如3158117 */ - user_id?: string - } - export type FormFieldVariableDatetimeValue = { - /** 毫秒的时间戳 */ - value?: number - /** 时区 */ - zone?: string - } - export type FormFieldVariableEnumValue = { - /** 枚举值 */ - value?: string - /** 枚举的名称 */ - name?: Lark.BpmDataengineI18n - /** 枚举的描述 */ - desc?: Lark.BpmDataengineI18n - } - export type FormFieldVariableNullValue = { - - } - export type FormFieldVariableBoolValue = { - /** 布尔变量的值 */ - value?: boolean - } - export type FormFieldVariableDepartmentValue = { - /** 部门ID */ - value?: string - } - export type FormFieldVariableFileValue = { - /** 文件源类型（1BPM; 2主数据） */ - source_type?: number - /** 文件id */ - file_id?: string - /** 文件名称 */ - file_name?: string - /** 文件长度 */ - length?: number - /** mime type */ - mime_type?: string - } - export type FormFieldVariableI18nValue = { - /** i18n值 */ - value?: Lark.BpmDataengineI18n - } - export type FormFieldVariableObjectValue = { - /** 对象ID */ - value?: string - /** 主数据apiName */ - wk_api_name?: string - } - export type FormFieldVariableListObject = { - /** 文本变量对象 */ - text_value?: Lark.FormFieldVariableTextValue - /** 数值变量对象 */ - number_value?: Lark.FormFieldVariableNumberValue - /** 日期变量对象 */ - date_value?: Lark.FormFieldVariableDateValue - /** 员工变量对象 */ - employment_value?: Lark.FormFieldVariableEmploymentValue - /** 日期时间变量对象 */ - date_time_value?: Lark.FormFieldVariableDatetimeValue - /** 枚举变量对象 */ - enum_value?: Lark.FormFieldVariableEnumValue - /** 空变量对象 */ - null_value?: Lark.FormFieldVariableNullValue - /** 布尔变量对象 */ - bool_value?: Lark.FormFieldVariableBoolValue - /** 部门变量对象 */ - department_value?: Lark.FormFieldVariableDepartmentValue - /** 文件变量对象 */ - file_value?: Lark.FormFieldVariableFileValue - /** i18n变量对象 */ - i18n_value?: Lark.FormFieldVariableI18nValue - /** 对象变量 */ - object_value?: Lark.FormFieldVariableObjectValue - } - export type FormFieldVariableListValue = { - /** 列表值 */ - values?: Lark.FormFieldVariableListObject[] - } - export type FormVariableValueInfo = { - /** 文本变量对象 */ - text_value?: Lark.FormFieldVariableTextValue - /** 数值变量对象 */ - number_value?: Lark.FormFieldVariableNumberValue - /** 日期变量对象 */ - date_value?: Lark.FormFieldVariableDateValue - /** 员工变量对象 */ - employment_value?: Lark.FormFieldVariableEmploymentValue - /** 日期时间变量对象 */ - date_time_value?: Lark.FormFieldVariableDatetimeValue - /** 枚举变量对象 */ - enum_value?: Lark.FormFieldVariableEnumValue - /** 空变量对象 */ - null_value?: Lark.FormFieldVariableNullValue - /** 布尔变量对象 */ - bool_value?: Lark.FormFieldVariableBoolValue - /** 部门变量对象 */ - department_value?: Lark.FormFieldVariableDepartmentValue - /** 文件变量对象 */ - file_value?: Lark.FormFieldVariableFileValue - /** i18n变量对象 */ - i18n_value?: Lark.FormFieldVariableI18nValue - /** 对象变量 */ - object_value?: Lark.FormFieldVariableObjectValue - /** 列表对象 */ - list_value?: Lark.FormFieldVariableListValue - } - export type FormFieldVariable = { - /** 变量api名称 */ - variable_api_name?: string - /** 变量名称的i18n描述 */ - variable_name?: Lark.BpmDataengineI18n - /** 变量值的对象 */ - variable_value?: Lark.FormVariableValueInfo - } - export type ReferenceObject = { - /** cpst_item(项目)、 cpst_indicator(指标) */ - api_name?: string - /** 值列表 例如部门ID */ - id?: string - } - export type CpstStandardType = { - /** 薪资标准类型 */ - api_name?: string - } - export type CpstBandWidth = { - /** 上限 */ - upper_limit?: string - /** 下限 */ - lower_limit?: string - } - export type CpstGradeStandardValue = { - /** 薪资标准的关联对象，项目或者指标 */ - reference_object?: Lark.ReferenceObject - /** 薪资标准类型 */ - standard_type?: Lark.CpstStandardType - /** 上下限 */ - band_width?: Lark.CpstBandWidth - /** 标准值 */ - standard_value?: string - } - export type CpstI18n = { - /** 中文 */ - zh_cn?: string - /** 英文 */ - en_us?: string - } - export type CpstCurrency = { - /** 币种ID */ - currency_id?: string - /** 币种code */ - code?: string - /** 币种名称 */ - name?: Lark.CpstI18n - } - export type CpstGrade = { - /** 薪资等级ID */ - grade_id?: string - /** 薪资等级时间轴ID */ - grade_tid?: string - /** 带宽上下限和标准值 */ - grade_standard_value?: Lark.CpstGradeStandardValue - /** 币种 */ - currency?: Lark.CpstCurrency - /** 薪资标准描述 */ - description?: Lark.CpstI18n - } - export type CpstMatchItem = { - /** 薪资标准表ID */ - standard_id?: string - /** 薪资等级 */ - grade?: Lark.CpstGrade - /** 生效时间 */ - effective_time?: string - } - export type CombinedJobObjectValueMap = { - /** 结构 ID */ - object_id?: string - /** 结构值 */ - value?: string - } - export type JobManager = { - /** 职位ID */ - id?: string - /** 招聘负责人ID */ - recruiter_id: string - /** 用人经理ID列表 */ - hiring_manager_id_list: string[] - /** 协助人ID列表 */ - assistant_id_list?: string[] - } - export type CombinedJobResultDefaultJobPost = { - /** 默认职位广告的 ID，用以发布至招聘渠道的内容 */ - id?: string - } - export type JobRecruitmentType = { - /** 雇佣类型 ID */ - id?: string - /** 雇佣类型中文名称 */ - zh_name?: string - /** 雇佣类型英文名称 */ - en_name?: string - /** 雇佣类型启用状态 */ - active_status?: number - } - export type JobDepartment = { - /** 部门 ID */ - id?: string - /** 部门中文名称 */ - zh_name?: string - /** 部门英文名称 */ - en_name?: string - } - export type JobCity = { - /** 工作地点城市代码 */ - city_code?: string - /** 工作地点中文名称 */ - zh_name?: string - /** 工作地点英文名称 */ - en_name?: string - } - export type JobHighlight = { - /** 职位亮点 ID */ - id?: string - /** 职位亮点中文名称 */ - zh_name?: string - /** 职位亮点英文名称 */ - en_name?: string - } - export type JobCategory = { - /** 职位序列 ID */ - id?: string - /** 职位序列中文名称 */ - zh_name?: string - /** 职位序列英文名称 */ - en_name?: string - /** 职位序列启用状态 */ - active_status?: number - } - export type JobType = { - /** 职位类别 ID */ - id?: string - /** 职位类别中文名称 */ - zh_name?: string - /** 职位类别英文名称 */ - en_name?: string - } - export type JobCustomizedOption = { - /** 选项 ID */ - key?: string - /** 选项名称 */ - name?: Lark.I18n - } - export type JobCustomizedTimeRange = { - /** 开始时间 */ - start_time?: string - /** 结束时间 */ - end_time?: string - } - export type JobCustomizedValue = { - /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ - content?: string - /** 当字段类型为单选时，从此字段取值 */ - option?: Lark.JobCustomizedOption - /** 当字段类型为多选时，从此字段取值 */ - option_list?: Lark.JobCustomizedOption[] - /** 当字段类型为时间段时，从此字段取值 */ - time_range?: Lark.JobCustomizedTimeRange - /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是毫秒级时间戳 */ - time?: string - /** 当字段类型为数字时，从此字段取值 */ - number?: string - } - export type JobCustomizedData = { - /** 自定义字段 ID */ - object_id?: string - /** 字段名称 */ - name?: Lark.I18n - /** 字段类型 */ - object_type?: number - /** 自定义字段值 */ - value?: Lark.JobCustomizedValue - } - export type IdNameObject = { - /** ID */ - id?: string - /** 名称 */ - name?: Lark.I18n - } - export type CodeNameObject = { - /** 编码 */ - code?: string - /** 名称 */ - name?: Lark.I18n - } - export type TargetMajorInfo = { - /** 目标专业ID */ - id?: string - /** 目标专业中文名称 */ - zh_name?: string - /** 目标专业英文名称 */ - en_name?: string - } - export type RegistrationSchemaInfo = { - /** 信息登记表ID */ - schema_id?: string - /** 信息登记表名称 */ - name?: string - } - export type CombinedJobResult = { - /** 职位广告 */ - default_job_post?: Lark.CombinedJobResultDefaultJobPost - /** 职位 */ - job?: Lark.Job - /** 职位负责人 */ - job_manager?: Lark.JobManager - /** 面试登记表 */ - interview_registration_schema_info?: Lark.RegistrationSchemaInfo - /** 入职登记表 */ - onboard_registration_schema_info?: Lark.RegistrationSchemaInfo - /** 目标专业 */ - target_major_list?: Lark.TargetMajorInfo[] - } - export type JobConfigInterviewRound = { - /** 面试官列表 */ - interviewer_list?: Lark.IdNameObject[] - /** 面试轮次 */ - round?: number - } - export type RegistrationInfo = { - /** 面试登记表ID */ - schema_id?: string - /** 面试登记表名称 */ - name?: string - } - export type JobConfigRoundTypeResult = { - /** 面试轮次类型 */ - assessment_round?: Lark.IdNameObject - /** 面试评价表 */ - assessment_template?: Lark.IdNameObject - } - export type InterviewAppointmentConfigContent = { - /** 面试类型 */ - interview_type?: number - /** 时区 */ - talent_timezone_code?: string - /** 联系人id */ - contact_user_id?: string - /** 联系人电话 */ - contact_mobile?: string - /** 联系人邮箱 */ - contact_email?: string - /** 地址id */ - address_id?: string - /** 视频面试类型 */ - video_type?: number - /** 抄送人id lsit */ - cc?: string[] - /** 备注 */ - remark?: string - /** 面试通知模板 */ - interview_notification_template_id?: string - /** 预约通知模板 */ - appointment_notification_template_id?: string - /** 取消面试通知 */ - cancel_interview_notification_template_id?: string - } - export type InterviewAppointmentConfig = { - /** 是否开启面试官安排面试 */ - enable_interview_appointment_by_interviewer?: boolean - /** 配置详情 */ - config?: Lark.InterviewAppointmentConfigContent - } - export type JobConfigResult = { - /** Offer 申请表，含 ID+name */ - offer_apply_schema?: Lark.IdNameObject - /** Offer 审批流，含 ID+name */ - offer_process_conf?: Lark.IdNameObject - /** 建议评估人，可多位 */ - recommended_evaluator_list?: Lark.IdNameObject[] - /** 面试评价表，含 ID+name */ - assessment_template?: Lark.IdNameObject - /** 职位 ID */ - id?: string - /** 建议面试官列表，可多位 */ - interview_round_list?: Lark.JobConfigInterviewRound[] - /** 招聘需求，含 ID+name */ - job_requirement_list?: Lark.IdNameObject[] - /** 面试登记表 */ - interview_registration?: Lark.RegistrationInfo - /** 入职登记表 */ - onboard_registration?: Lark.RegistrationInfo - /** 面试轮次类型列表 */ - interview_round_type_list?: Lark.JobConfigRoundTypeResult[] - /** 关联职位列表 */ - related_job_list?: Lark.IdNameObject[] - /** 职位属性，1是实体职位，2是虚拟职位 */ - job_attribute?: number - /** 面试官安排面试配置 */ - interview_appointment_config?: Lark.InterviewAppointmentConfig - } - export type JobConfigInterviewRoundConf = { - /** 建议面试官 ID 列表 */ - interviewer_id_list?: string[] - /** 面试轮次 */ - round?: number - } - export type JobConfigRoundType = { - /** 面试轮次类型 ID */ - round_biz_id?: string - /** 面试评价表 ID */ - assessment_template_biz_id?: string - } - export type JobTypeInfo = { - /** 职位类别ID */ - id: string - /** 职位类别名称 */ - name: Lark.I18n - /** 父级职位类别ID */ - parent_id?: string - } - export type JobRecruiter2 = { - /** 职位ID */ - id?: string - /** 招聘负责人ID */ - recruiter_id?: string - /** 用人经理ID列表 */ - hiring_manager_id_list?: string[] - /** 协助人ID列表 */ - assistant_id_list?: string[] - } - export type JobRequirementCustomizedData = { - /** 自定义字段 ID */ - object_id?: string - /** 自定义字段 value，1. 对于自定义字段，若字段类型为单行文本/多行文本，传值格式为"这是一个文本"；2. 若字段类型为单选，传值内容为选项的 ID，格式为"6890840516938696974"；3. 若字段类型为多选，传值内容为选项的ID 列表，格式为"[\"6890840516938696974\", \"6890840516938696975\" ]"；4. 若字段类型为时间段，传值格式为"[\"1609430400000\", \"1612108800000\" ]"，单位是毫米级时间戳；5. 若字段类型为年份选择，传值格式为"1609430400000"，单位是毫秒级时间戳；6. 若字段类型为月份选择，传值格式为"1625068800000"，单位是毫秒级时间戳；7. 若字段类型为数字，传值格式为"1"; */ - value?: string - } - export type JobRequirementCustomizedOption = { - /** 选项 ID */ - key?: string - /** 选项名称 */ - name?: Lark.I18n - } - export type JobRequirementCustomizedTimeRange = { - /** 开始时间，毫秒级时间戳 */ - start_time?: string - /** 结束时间，毫秒级时间戳 */ - end_time?: string - } - export type JobRequirementCustomizedValue = { - /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ - content?: string - /** 当字段类型为单选时，从此字段取值 */ - option?: Lark.JobRequirementCustomizedOption - /** 当字段类型为多选时，从此字段取值 */ - option_list?: Lark.JobRequirementCustomizedOption[] - /** 当字段类型为时间段时，从此字段取值 */ - time_range?: Lark.JobRequirementCustomizedTimeRange - /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是毫秒级时间戳 */ - time?: string - /** 当字段类型为数字时，从此字段取值 */ - number?: string - } - export type JobRequirementCustomizedDataDto = { - /** 自定义字段 ID */ - object_id?: string - /** 字段名称 */ - name?: Lark.I18n - /** 字段类型 */ - object_type?: number - /** 自定义字段值 */ - value?: Lark.JobRequirementCustomizedValue - } - export type JobRequirementDto = { - /** 招聘需求 ID */ - id?: string - /** 招聘需求编号 */ - short_code?: string - /** 需求名称 */ - name?: string - /** 需求状态 */ - display_progress?: number - /** 需求人数 */ - head_count?: number - /** 职位性质 */ - recruitment_type?: Lark.IdNameObject - /** 最高职级 */ - max_level?: Lark.IdNameObject - /** 最低职级 */ - min_level?: Lark.IdNameObject - /** 职位序列 */ - sequence?: Lark.IdNameObject - /** 需求类型 */ - category?: number - /** 需求部门 */ - department?: Lark.IdNameObject - /** 需求负责人 */ - recruiter_list?: Lark.IdNameObject[] - /** 需求用人经理 */ - jr_hiring_managers?: Lark.IdNameObject[] - /** 直属上级 */ - direct_leader_list?: Lark.IdNameObject[] - /** 开始日期，毫秒级时间戳 */ - start_time?: string - /** 预计完成日期，毫秒级时间戳 */ - deadline?: string - /** 招聘优先级 */ - priority?: number - /** 学历要求 */ - required_degree?: number - /** 最高薪资 */ - max_salary?: string - /** 最低薪资 */ - min_salary?: string - /** 工作地点 */ - address?: Lark.IdNameObject - /** 需求描述 */ - description?: string - /** 自定义字段 */ - customized_data_list?: Lark.JobRequirementCustomizedDataDto[] - /** 关联职位 ID */ - job_id_list?: string[] - } - export type CommonSchemaSetting = { - /** 字段类型 */ - object_type?: number - /** 配置信息 */ - config?: Lark.CommonSchemaConfig - } - export type CommonSchemaChild = { - /** 字段 ID */ - id?: string - /** 字段名称 */ - name?: Lark.I18n - /** 字段描述 */ - description?: Lark.I18n - /** 字段信息 */ - setting?: Lark.CommonSchemaSetting - /** 所属模块 ID */ - parent_id?: string - /** 是否是自定义字段 */ - is_customized?: boolean - /** 是否必填 */ - is_required?: boolean - /** 是否启用 */ - active_status?: number - } - export type CommonSchema = { - /** 模块 ID */ - id?: string - /** 模块名称 */ - name?: Lark.I18n - /** 模块描述 */ - description?: Lark.I18n - /** 模块信息 */ - setting?: Lark.CommonSchemaSetting - /** 是否是自定义模块 */ - is_customized?: boolean - /** 是否必填 */ - is_required?: boolean - /** 是否启用 */ - active_status?: number - /** 字段列表 */ - children_list?: Lark.CommonSchemaChild[] - } - export type JobRequirementSchema = { - /** 模板 ID */ - id?: string - /** 国际化模板名称 */ - name?: Lark.I18n - /** 模板字段 */ - object_list?: Lark.CommonSchema[] - } - export type JobProcessesStage = { - /** ID */ - id?: string - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - /** 1=筛选型, 2=评估型, 3=笔试型, 4=面试型, 5=Offer型, 6=待入职, 7=已入职, 8=其它类型, 255=系统默认，后端模型中并没有该字段，仅用于前端显示, */ - type?: number - } - export type JobProcesses = { - /** ID */ - id?: string - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - /** 类型 1=社招流程, 2=校招流程, */ - type?: number - /** 阶段列表, 内部按用户设置顺序排列 */ - stage_list?: Lark.JobProcessesStage[] - } - export type RegistrationSchema = { - /** 信息登记表模板 ID */ - id?: string - /** 信息登记表模板名称 */ - name?: string - /** 登记表适用场景 */ - scenarios?: number[] - /** 模块列表 */ - objects?: Lark.CommonSchema[] - } - export type CommonAddress = { - /** ID */ - id?: string - /** 名称 */ - name?: Lark.I18n - /** 区域信息 */ - district?: Lark.CodeNameObject - /** 城市信息 */ - city?: Lark.CodeNameObject - /** 省信息 */ - state?: Lark.CodeNameObject - /** 国家信息 */ - country?: Lark.CodeNameObject - } - export type WebsiteJobPostCustomizedOption = { - /** 选项 ID */ - key?: string - /** 选项名称 */ - name?: Lark.I18n - } - export type WebsiteJobPostCustomizedTimeRange = { - /** 开始时间 */ - start_time?: string - /** 结束时间 */ - end_time?: string - } - export type WebsiteJobPostCustomizedValue = { - /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ - content?: string - /** 当字段类型为单选时，从此字段取值 */ - option?: Lark.WebsiteJobPostCustomizedOption - /** 当字段类型为多选时，从此字段取值 */ - option_list?: Lark.WebsiteJobPostCustomizedOption[] - /** 当字段类型为时间段时，从此字段取值 */ - time_range?: Lark.WebsiteJobPostCustomizedTimeRange - /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是毫秒级时间戳 */ - time?: string - /** 当字段类型为数字时，从此字段取值 */ - number?: string - } - export type WebsiteJobPostCustomizedData = { - /** 自定义字段 ID */ - object_id?: string - /** 字段名称 */ - name?: Lark.I18n - /** 字段类型 */ - object_type?: number - /** 自定义字段值 */ - value?: Lark.WebsiteJobPostCustomizedValue - } - export type PortalJobPost = { - /** 职位广告 ID */ - id?: string - /** 标题 */ - title?: string - /** 职位 ID */ - job_id?: string - /** 职位编码 */ - job_code?: string - /** 职位过期时间，「null」代表「长期有效」 */ - job_expire_time?: string - /** 职位状态 */ - job_active_status?: number - /** 职位流程类型 */ - job_process_type?: number - /** 职位雇佣类型 */ - job_recruitment_type?: Lark.IdNameObject - /** 职位部门 */ - job_department?: Lark.IdNameObject - /** 职位类型 */ - job_type?: Lark.IdNameObject - /** 职位地址 */ - address?: Lark.CommonAddress - /** 月薪范围-最低薪资 */ - min_salary?: string - /** 月薪范围-最高薪资 */ - max_salary?: string - /** 学历要求 */ - required_degree?: number - /** 经验 */ - experience?: number - /** 数量 */ - headcount?: number - /** 职位亮点 */ - high_light_list?: Lark.IdNameObject[] - /** 职位描述 */ - description?: string - /** 职位要求 */ - requirement?: string - /** 创建人 */ - creator?: Lark.IdNameObject - /** 创建时间 */ - create_time?: string - /** 修改时间 */ - modify_time?: string - /** 自定义字段 */ - customized_data_list?: Lark.WebsiteJobPostCustomizedData[] - /** 职位广告地址列表 */ - address_list?: Lark.CommonAddress[] - } - export type Referral = { - /** 内推的 ID */ - id: string - /** 投递 ID */ - application_id: string - /** 创建时间（ms） */ - create_time: number - /** 内推人的 ID */ - referral_user_id: string - /** 内推人信息 */ - referral_user?: Lark.IdNameObject - } - export type ExternalApplication = { - /** 外部投递 ID */ - id?: string - /** 职位招聘类型 */ - job_recruitment_type?: number - /** 职位名称 */ - job_title?: string - /** 简历来源 */ - resume_source?: string - /** 阶段 */ - stage?: string - /** 人才 ID */ - talent_id: string - /** 终止原因 */ - termination_reason?: string - /** 投递类型 */ - delivery_type?: number - /** 更新时间 */ - modify_time?: number - /** 终止类型 */ - termination_type?: string - } - export type ExternalInterview = { - /** 外部投递 ID */ - external_application_id: string - /** 外部面试 ID */ - id?: string - /** 参与状态 */ - participate_status?: number - /** 开始时间 */ - begin_time?: number - /** 结束时间 */ - end_time?: number - } - export type ExternalInterviewAssessmentDimension = { - /** 打分题分数（当题目类型为「打分题」时使用） */ - score?: number - /** 单选选项（当题目类型为「单选题」时使用） */ - option?: string - /** 多选选项（当题目类型为「多选题」时使用） */ - options?: string[] - /** 描述内容（当题目类型为「描述题」时使用） */ - content?: string - /** 题目类型 */ - assessment_type?: number - /** 题目标题 */ - title?: string - /** 题目描述 */ - description?: string - } - export type ExternalInterviewAssessment = { - /** 外部面评 ID */ - id?: string - /** 面试官姓名 */ - username?: string - /** 面试结果 */ - conclusion?: number - /** 评价维度列表 */ - assessment_dimension_list?: Lark.ExternalInterviewAssessmentDimension[] - /** 综合记录 */ - content?: string - /** 外部面试 ID */ - external_interview_id: string - } - export type ExternalBackgroundCheckAttachment = { - /** 附件 ID */ - id?: string - /** 附件名字 */ - name?: string - /** 附件大小 */ - size?: number - } - export type ExternalBackgroundCheck = { - /** 外部背调 ID */ - id?: string - /** 外部投递 ID */ - external_application_id: string - /** 背调日期 */ - date?: number - /** 背调名字 */ - name?: string - /** 背调结果 */ - result?: string - /** 背调附件ID列表 */ - attachment_id_list?: string[] - /** 背调附件 */ - attachment_list?: Lark.ExternalBackgroundCheckAttachment[] - } - export type TalentFolder = { - /** 名字 */ - name: string - /** 文件夹ID */ - folder_id?: string - /** 所有者ID */ - owner_id?: string - } - export type TalentBatchInfo = { - /** 人才 ID */ - talent_id?: string - /** 手机国家区号 */ - mobile_code?: string - /** 手机号 */ - mobile_number?: string - /** 邮箱 */ - email?: string - /** 证件类型，可参考招聘枚举常量 IdentificationType 枚举定义 */ - identification_type?: number - /** 证件号 */ - identification_number?: string - } - export type TalentNationality = { - /** 国家编码 */ - nationality_code?: string - /** 中文名 */ - zh_name?: string - /** 英文名 */ - en_name?: string - } - export type TalentCityInfo = { - /** 城市码 */ - city_code?: string - /** 中文名 */ - zh_name?: string - /** 英文名 */ - en_name?: string - } - export type TalentBasicInfo = { - /** 名字 */ - name: string - /** 手机 */ - mobile?: string - /** 手机国家区号 */ - mobile_code?: string - /** 手机国家代码 */ - mobile_country_code?: string - /** 邮箱 */ - email?: string - /** 工作年限 */ - experience_years?: number - /** 年龄 */ - age?: number - /** 国籍 */ - nationality?: Lark.TalentNationality - /** 性别 */ - gender?: number - /** 所在地点 */ - current_city?: Lark.TalentCityInfo - /** 家乡 */ - hometown_city?: Lark.TalentCityInfo - /** 意向地点 */ - preferred_city_list?: Lark.TalentCityInfo[] - /** 证件类型 */ - identification_type?: number - /** 证件号 */ - identification_number?: string - /** 生日 */ - birthday?: number - /** 创建人 */ - creator_id?: string - /** 婚姻状况 */ - marital_status?: number - /** 家庭住址 */ - current_home_address?: string - /** 修改时间 */ - modify_time?: string - } - export type TalentEducationInfo = { - /** ID */ - id?: string - /** 学位 */ - degree?: number - /** 学校 */ - school?: string - /** 专业 */ - field_of_study?: string - /** 开始时间 */ - start_time?: string - /** 结束时间（历史字段） ,如果是至今传值 -1，传输「至今」投递进入系统后可正常查看字段，但进入编辑态后需要修改为一个具体时间 */ - end_time?: string - /** 结束时间-新，无「至今」传值。建议使用此字段，避免模糊的毕业时间影响候选人筛选 */ - end_time_v2?: string - /** 学历类型 */ - education_type?: number - /** 成绩排名 */ - academic_ranking?: number - /** 教育经历标签 */ - tag_list?: number[] - } - export type TalentCareerInfo = { - /** ID */ - id?: string - /** 公司名称 */ - company?: string - /** 职位名称 */ - title?: string - /** 描述 */ - desc?: string - /** 开始时间 */ - start_time?: string - /** 结束时间 */ - end_time?: string - /** 经历类型 */ - career_type?: number - /** 工作经历标签 */ - tag_list?: number[] - } - export type TalentProjectInfo = { - /** ID */ - id?: string - /** 项目名称 */ - name?: string - /** 项目角色 */ - role?: string - /** 项目链接 */ - link?: string - /** 描述 */ - desc?: string - /** 开始时间 */ - start_time?: string - /** 结束时间 */ - end_time?: string - } - export type TalentWorksInfo = { - /** ID */ - id?: string - /** 作品链接 */ - link?: string - /** 描述 */ - desc?: string - /** 作品附件名称，若需获取作品附件预览信息可调用「获取附件预览信息」接口 */ - name?: string - } - export type TalentAwardInfo = { - /** ID */ - id?: string - /** 获奖名称 */ - title?: string - /** 获奖时间 */ - award_time?: string - /** 描述 */ - desc?: string - } - export type TalentLanguageInfo = { - /** ID */ - id?: string - /** 语言 */ - language?: number - /** 精通程度 */ - proficiency?: number - } - export type TalentSnsInfo = { - /** ID */ - id?: string - /** SNS名称 */ - sns_type?: number - /** URL/ID */ - link?: string - } - export type TalentResumeSource = { - /** ID */ - id?: string - /** 中文名 */ - zh_name?: string - /** 英文名 */ - en_name?: string - } - export type TalentInterviewRegistrationSimple = { - /** ID */ - id?: string - /** 创建时间 */ - registration_time?: number - } - export type Talent = { - /** 人才ID */ - id?: string - /** 是否在猎头保护期 */ - is_in_agency_period?: boolean - /** 是否已入职 */ - is_onboarded?: boolean - /** 基础信息 */ - basic_info?: Lark.TalentBasicInfo - /** 教育经历 */ - education_list?: Lark.TalentEducationInfo[] - /** 工作经历 */ - career_list?: Lark.TalentCareerInfo[] - /** 项目经历 */ - project_list?: Lark.TalentProjectInfo[] - /** 作品 */ - works_list?: Lark.TalentWorksInfo[] - /** 获奖 */ - award_list?: Lark.TalentAwardInfo[] - /** 语言能力 */ - language_list?: Lark.TalentLanguageInfo[] - /** 社交账号 */ - sns_list?: Lark.TalentSnsInfo[] - /** 简历来源 */ - resume_source_list?: Lark.TalentResumeSource[] - /** 面试登记表 */ - interview_registration_list?: Lark.TalentInterviewRegistrationSimple[] - /** 简历附件id列表（按照简历创建时间降序） */ - resume_attachment_id_list?: string[] - /** 最高学历 */ - top_degree?: number - /** 第一学历 */ - first_degree?: number - } - export type TalentCustomizedOption = { - /** 选项 ID */ - key?: string - /** 选项名称 */ - name?: Lark.I18n - } - export type TalentCustomizedTimeRange = { - /** 开始时间 */ - start_time?: string - /** 结束时间，当值为至今时，返回「-」 */ - end_time?: string - } - export type TalentCustomizedAttachment = { - /** 附件 ID */ - file_id?: string - /** 附件名称 */ - file_name?: string - /** 附件类型 */ - content_type?: string - /** 附件大小 */ - file_size?: number - } - export type TalentCustomizedValue = { - /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ - content?: string - /** 当字段类型为单选时，从此字段取值 */ - option?: Lark.TalentCustomizedOption - /** 当字段类型为多选时，从此字段取值 */ - option_list?: Lark.TalentCustomizedOption[] - /** 当字段类型为时间段时，从此字段取值 */ - time_range?: Lark.TalentCustomizedTimeRange - /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是秒级时间戳 */ - time?: string - /** 当字段类型为数字时，从此字段取值 */ - number?: string - /** 当字段类型为附件时，从此字段取值 */ - customized_attachment?: Lark.TalentCustomizedAttachment[] - } - export type TalentCustomizedDataChild = { - /** 自定义字段 ID */ - object_id?: string - /** 字段名称 */ - name?: Lark.I18n - /** 字段类型 */ - object_type?: number - /** 自定义字段值 */ - value?: Lark.TalentCustomizedValue - } - export type RegistrationBasicInfo = { - /** ID */ - id?: string - /** 创建时间 */ - registration_time?: number - /** 下载链接 */ - download_url?: string - /** 登记表场景 */ - scenario?: number - } - export type TalentCustomizedData = { - /** 模块 ID */ - object_id?: string - /** 模块名称 */ - name?: Lark.I18n - /** 类型 */ - object_type?: number - /** 模块下的字段 */ - children?: Lark.TalentCustomizedDataChild[] - } - export type ApplicationStageInfo = { - /** 阶段id */ - id?: string - /** 阶段中文名字 */ - zh_name?: string - /** 英文名 */ - en_name?: string - /** 阶段类型 */ - type?: number - } - export type ApplicationResumeSource = { - /** 投递来源 ID */ - id?: string - /** 投递来源名称 */ - name?: Lark.I18n - /** 投递来源类型 */ - resume_source_type?: number - } - export type ApplicationWebsiteChannel = { - /** 官网推广渠道 ID */ - channel_id?: string - /** 官网推广渠道名称 */ - channel_name?: Lark.I18n - } - export type ApplicationWebsiteResumeSource = { - /** 官网站点 ID */ - website_id?: string - /** 官网站点名称 */ - website_name?: Lark.I18n - /** 推广渠道来源 */ - channel?: Lark.ApplicationWebsiteChannel - } - export type ApplicationStageTime = { - /** 阶段 ID */ - stage_id?: string - /** 最近一次进入该阶段的时间 */ - enter_time?: string - /** 最后一次离开时间，如当前在该阶段，则为空 */ - exit_time?: string - } - export type Evaluation = { - /** 评估 ID */ - id?: string - /** 投递 ID */ - application_id?: string - /** 投递阶段 */ - stage_id?: string - /** 创建人user_id */ - creator_id?: string - /** 评估人user_id */ - evaluator_id?: string - /** 提交状态 */ - commit_status?: number - /** 评估结论 */ - conclusion?: number - /** 评估详情 */ - content?: string - /** 创建时间 */ - create_time?: string - /** 最近更新时间 */ - update_time?: string - } - export type SelectOptionResult = { - /** 选项 ID */ - option_id?: string - /** 选项中文名称 */ - option_name?: string - /** 选项英文名称 */ - option_en_name?: string - /** 选项中文描述 */ - option_desc?: string - /** 选项英文描述 */ - option_en_desc?: string - /** 是否选择 */ - is_selected?: boolean - } - export type FiveStartScoringResult = { - /** 最高分中文描述 */ - highest_score_desc?: string - /** 最高分英文描述 */ - highest_score_en_desc?: string - /** 最低分中文描述 */ - lowest_score_desc?: string - /** 最低分英文描述 */ - lowest_score_en_desc?: string - /** 评分分数 */ - score_result?: number - } - export type Question = { - /** 题目 ID */ - question_id?: string - /** 题目中文名称 */ - question_name?: string - /** 题目英文名称 */ - question_en_name?: string - /** 题目中文描述 */ - question_desc?: string - /** 题目英文描述 */ - question_en_desc?: string - /** 题目类型 */ - question_type?: number - /** 是否必填 */ - is_required?: boolean - /** 选项题回答列表（单选题及多选题） */ - select_option_result_list?: Lark.SelectOptionResult[] - /** 评分题回答 */ - five_start_scoring_result?: Lark.FiveStartScoringResult - /** 描述题回答 */ - description_result?: string - } - export type Questionnaire = { - /** 问卷 ID */ - questionnaire_id?: string - /** 投递 ID */ - application_id?: string - /** 面试 ID */ - interview_id?: string - /** 问卷版本 */ - version?: number - /** 题目列表 */ - questions?: Lark.Question[] - /** 是否完成作答 */ - has_answers?: boolean - /** 更新时间 */ - update_time?: string - } - export type InterviewScore = { - /** 面试得分 ID */ - id?: string - /** 分数级别 */ - level?: number - /** 中文名称 */ - zh_name?: string - /** 中文描述 */ - zh_description?: string - /** 英文名称 */ - en_name?: string - /** 英文描述 */ - en_description?: string - } - export type InterviewRecord = { - /** 面试记录 ID */ - id?: string - /** 面试官用户 ID */ - user_id?: string - /** 面试记录内容 */ - content?: string - /** 提交状态 */ - commit_status?: number - /** 面试结论 */ - conclusion?: number - /** 面试得分 */ - interview_score?: Lark.InterviewScore - /** 面试官信息 */ - interviewer?: Lark.IdNameObject - } - export type InterviewAddress = { - /** 地址 ID */ - id?: string - /** 地址名称 */ - name?: Lark.I18n - /** 区域 */ - district?: Lark.CodeNameObject - /** 城市 */ - city?: Lark.CodeNameObject - /** 省 */ - state?: Lark.CodeNameObject - /** 国家 */ - country?: Lark.CodeNameObject - } - export type InterviewMeetingRoom = { - /** 会议室 ID */ - room_id?: string - /** 会议室名称 */ - room_name?: string - /** 建筑名称 */ - building_name?: string - /** 会议室预定状态 */ - reserved_status?: number - /** 楼层 */ - floor_name?: string - } - export type InterviewExtend = { - /** 面试 ID */ - id?: string - /** 面试开始时间（ms） */ - begin_time?: number - /** 面试结束时间（ms） */ - end_time?: number - /** 面试轮次（从0开始计数） */ - round?: number - /** 面试记录信息 */ - interview_record_list?: Lark.InterviewRecord[] - /** 面试评价提交时间 */ - feedback_submit_time?: number - /** 面试关联的投递阶段 */ - stage_id?: string - /** 投递 ID */ - application_id?: string - /** 阶段信息 */ - stage?: Lark.IdNameObject - /** 创建人 */ - creator?: Lark.IdNameObject - /** 创建时间（ms） */ - biz_create_time?: number - /** 最近更新时间（ms） */ - biz_modify_time?: number - /** 面试状态 */ - interview_round_summary?: number - /** 面试安排 ID */ - interview_arrangement_id?: string - /** 面试类型 */ - interview_type?: number - /** 候选人时区 */ - talent_time_zone?: Lark.CodeNameObject - /** 面试联系人 */ - contact_user?: Lark.IdNameObject - /** 面试联系人电话 */ - contact_mobile?: string - /** 备注 */ - remark?: string - /** 面试地点 */ - address?: Lark.InterviewAddress - /** 视频面试工具 */ - video_type?: number - /** 当安排类型为集中面试时，此值表示集中面试的安排状态 */ - arrangement_status?: number - /** 安排类型 */ - arrangement_type?: number - /** 安排方式（是否使用自助约面） */ - arrangement_appointment_kind?: number - /** 面试会议室 */ - meeting_room_list?: Lark.InterviewMeetingRoom[] - /** 面试轮次类型 */ - interview_round_type?: Lark.IdNameObject - } - export type OfferBasicInfo = { - /** 部门 ID */ - department_id: string - /** 直属上级 ID */ - leader_user_id: string - /** 职务 ID */ - employment_job_id?: string - /** 人员类型 ID */ - employee_type_id?: string - /** 职位序列 ID */ - job_family_id?: string - /** 职位级别 ID */ - job_level_id?: string - /** 试用期 */ - probation_month?: number - /** 合同期 */ - contract_year?: number - /** 预计入职日期 */ - expected_onboard_date?: string - /** 入职地点 ID */ - onboard_address_id?: string - /** 办公地点 ID */ - work_address_id?: string - /** Offer负责人 ID */ - owner_user_id: string - /** Offer 推荐语 */ - recommended_words?: string - /** 招聘需求 ID */ - job_requirement_id?: string - /** 招聘流程类型 ID */ - job_process_type_id?: number - /** 附件ID列表 */ - attachment_id_list?: string[] - /** 附件描述 */ - attachment_description?: string - /** Offer操作人 ID */ - operator_user_id: string - } - export type OfferSalaryInfo = { - /** 币种 */ - currency?: string - /** 基本薪资 */ - basic_salary?: string - /** 试用期百分比 */ - probation_salary_percentage?: string - /** 年终奖月数 */ - award_salary_multiple?: string - /** 期权股数 */ - option_shares?: string - /** 季度奖金额 */ - quarterly_bonus?: string - /** 半年奖金额 */ - half_year_bonus?: string - } - export type OfferCustomizedInfo = { - /** 自定义字段 ID */ - id?: string - /** 自定义字段信息 */ - value?: string - } - export type BaseBilingualWithId = { - /** ID */ - id?: string - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - } - export type BaseDistrict = { - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - /** 编码 */ - code?: string - /** 地址类型 1=COUNTRY, 2=STATE, 3=CITY, 4=DISTRICT, 5=ADDRESS, */ - location_type?: number - } - export type BaseCity = { - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - /** 编码 */ - code?: string - /** 地址类型 1=COUNTRY, 2=STATE, 3=CITY, 4=DISTRICT, 5=ADDRESS, */ - location_type?: number - } - export type BaseCountry = { - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - /** 编码 */ - code?: string - /** 地址类型 1=COUNTRY, 2=STATE, 3=CITY, 4=DISTRICT, 5=ADDRESS, */ - location_type?: number - } - export type BaseAddress = { - /** ID */ - id?: string - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - /** 区域信息 */ - district?: Lark.BaseDistrict - /** 城市信息 */ - city?: Lark.BaseCity - /** 省信息 */ - state?: Lark.BaseCity - /** 国家信息 */ - country?: Lark.BaseCountry - } - export type ApplicationOfferCustomValue = { - /** 自定义字段ID */ - object_id?: string - /** 自定义字段Value */ - customize_value?: string - } - export type ApplicationOfferBasicInfo = { - /** Offer类型 1=Social, 2=Campus, 3=Intern, 4=InternTransfer */ - offer_type?: number - /** 备注 */ - remark?: string - /** Offer过期时间 */ - expire_time?: number - /** Offer 负责人 ID */ - owner_user_id?: string - /** Offer 创建人 ID */ - creator_user_id?: string - /** Offer 人员类型 */ - employee_type?: Lark.BaseBilingualWithId - /** 创建时间 */ - create_time?: string - /** 直属上级 ID */ - leader_user_id?: string - /** 入职日期 */ - onboard_date?: string - /** 入职部门 */ - department_id?: string - /** 试用期, 比如试用期6个月 */ - probation_month?: number - /** 合同期, 比如3年 */ - contract_year?: number - /** 雇员类型 */ - recruitment_type?: Lark.BaseBilingualWithId - /** 序列 */ - sequence?: Lark.BaseBilingualWithId - /** 级别 */ - level?: Lark.BaseBilingualWithId - /** 入职地点 */ - onboard_address?: Lark.BaseAddress - /** 工作地点 */ - work_address?: Lark.BaseAddress - /** 自定义字段的value信息 */ - customize_info_list?: Lark.ApplicationOfferCustomValue[] - } - export type ApplicationOfferSalaryPlan = { - /** 币种 */ - currency?: string - /** 基本薪资, 注意是json */ - basic_salary?: string - /** 试用期百分比 */ - probation_salary_percentage?: string - /** 年终奖月数 */ - award_salary_multiple?: string - /** 期权股数 */ - option_shares?: string - /** 季度奖金额 */ - quarterly_bonus?: string - /** 半年奖金额 */ - half_year_bonus?: string - /** 年度现金总额(数量，非公式) */ - total_annual_cash?: string - /** 自定义字段的value信息 */ - customize_info_list?: Lark.ApplicationOfferCustomValue[] - } - export type OfferJobInfo = { - /** Offer 职位 ID */ - job_id?: string - /** Offer 职位名称 */ - job_name?: string - } - export type ApplicationOffer = { - /** Offer id */ - id?: string - /** 投递id */ - application_id?: string - /** 基础信息 */ - basic_info?: Lark.ApplicationOfferBasicInfo - /** 薪酬计划 */ - salary_plan?: Lark.ApplicationOfferSalaryPlan - /** 当前offer使用的schema */ - schema_id?: string - /** Offer状态 */ - offer_status?: number - /** 职位信息 */ - job_info?: Lark.OfferJobInfo - } - export type Offer = { - /** Offer ID */ - id?: string - /** 投递 ID */ - application_id?: string - /** 基础信息 */ - basic_info?: Lark.ApplicationOfferBasicInfo - /** 薪酬计划 */ - salary_plan?: Lark.ApplicationOfferSalaryPlan - /** 当前 Offer 使用的 Schema */ - schema_id?: string - /** Offer 状态 */ - offer_status?: number - /** Offer 类型 */ - offer_type?: number - /** 职位信息 */ - job_info?: Lark.OfferJobInfo - } - export type OfferListInfo = { - /** Offer ID */ - id?: string - /** Offer 职位 */ - job_info?: Lark.OfferJobInfo - /** 创建时间 */ - create_time?: string - /** Offer 状态 */ - offer_status?: number - /** Offer 类型 */ - offer_type?: number - /** Offer 人员类型 */ - employee_type?: Lark.BaseBilingualWithId - /** Offer 投递 ID */ - application_id?: string - } - export type InternOfferOnboardingInfo = { - /** 实际入职日期 */ - actual_onboarding_date: string - } - export type InternOfferOffboardingInfo = { - /** 实际离职日期（实际离职日期需晚于实际入职日期） */ - actual_offboarding_date: string - /** 备注 */ - notes?: string - } - export type InternOfferStatus = { - /** Offer ID */ - offer_id?: string - /** 更新入/离职状态的操作 */ - operation: string - /** 入职表单信息（当 operation 为 confirm_onboarding 时，该字段必填） */ - onboarding_info?: Lark.InternOfferOnboardingInfo - /** 离职表单信息（当 operation 为 offboard 时，该字段必填） */ - offboarding_info?: Lark.InternOfferOffboardingInfo - } - export type EmployeeConversionInfo = { - /** 实际转正日期 */ - actual_conversion_time?: number - } - export type EmployeeOverboardInfo = { - /** 实际离职日期 */ - actual_overboard_time?: number - /** 离职原因 */ - overboard_note?: string - } - export type Note = { - /** ID备注 */ - id?: string - /** 人才ID */ - talent_id: string - /** 投递ID */ - application_id?: string - /** 是否私密 */ - is_private?: boolean - /** 创建时间 */ - create_time?: number - /** 更新时间 */ - modify_time?: number - /** 创建人ID */ - creator_id?: string - /** 内容 */ - content: string - } - export type ResumeSource = { - /** 来源id */ - id?: string - /** 中文名 */ - zh_name?: string - /** 英文名 */ - en_name?: string - /** 启用状态 */ - active_status?: number - /** 来源类型 */ - resume_source_type?: number - } - export type EcoAccountCustomFieldData = { - /** 自定义字段的标识，同一 scope 内须唯一 */ - key: string - /** 自定义字段的名称，用户在添加账号表单看到的控件标题 */ - name: Lark.I18n - /** 是否必填 */ - is_required: boolean - /** 自定义字段的描述，用户在添加账号表单看到的 place holder */ - description?: Lark.I18n - } - export type EcoBackgroundCheckCustomFieldDataOption = { - /** 选项的 key */ - key: string - /** 选项的名称 */ - name: Lark.I18n - } - export type EcoBackgroundCheckCustomFieldData = { - /** 自定义字段类型 */ - type: string - /** 自定义字段的标识，在同一账号内唯一 */ - key: string - /** 自定义字段的名称，用户在安排背调表单看到的控件标题 */ - name: Lark.I18n - /** 是否必填 */ - is_required: boolean - /** 自定义字段的描述，如果是输入控件，为用户在安排背调表单看到的 placeholder 或 提示文字 */ - description?: Lark.I18n - /** type 为 select 或 multiselect 时必填，单选或多选的选项 */ - options?: Lark.EcoBackgroundCheckCustomFieldDataOption[] - } - export type EcoBackgroundCheckPackageData = { - /** 套餐 ID */ - id: string - /** 背调名称 */ - name: string - /** 套餐描述 */ - description?: string - } - export type EcoBackgroundCheckPackageAdditionalItem = { - /** 附件调查项 ID */ - id: string - /** 附加调查项名称 */ - name: string - /** 附加调查项描述 */ - description?: string - } - export type EcoBackgroundCheckReportFile = { - /** 报告名称 */ - report_name: string - /** 报告地址；报告地址类型为空或为1时需为可下载 pdf 的链接；为2时为预览型链接 */ - report_url: string - /** 报告地址类型；枚举值 1 或为空时为可下载的 pdf 链接，2 为预览型链接 */ - report_url_type?: number - } - export type EcoExamPaperData = { - /** 试卷 ID */ - id: string - /** 试卷名称 */ - name: string - /** 考试时长（分钟） */ - duration?: number - /** 试卷题目数量 */ - question_count?: number - /** 开始时间，留空或不传表示不限制开始时间 */ - start_time?: string - /** 结束时间，留空或不传表示不限制结束时间 */ - end_time?: string - } - export type EcoExamLoginInfo = { - /** 笔试链接 */ - exam_url: string - /** 用户名 */ - username?: string - /** 密码 */ - password?: string - } - export type EcoExamResultReport = { - /** 报告名称 */ - name: string - /** 报告链接 */ - url: string - /** 作答完成时间(毫秒时间戳) */ - answer_time?: string - } - export type EcoExamResultDetail = { - /** 评价 ID */ - id?: string - /** 评价名称 */ - name: string - /** 评价结果 */ - result: string - } - export type Mobile = { - /** 国家代码 */ - code?: string - /** 手机号码 */ - number?: string - } - export type BonusAmount = { - /** 积分奖励 */ - point_bonus?: number - } - export type Assets = { - /** 已确认的奖励 */ - confirmed_bonus?: Lark.BonusAmount - } - export type Account = { - /** 账户ID */ - account_id: string - /** 账户资产 */ - assets?: Lark.Assets - /** 账号状态 */ - status?: number - } - export type TradeDetail = { - /** 账户ID */ - account_id: string - /** 时间段内该账户在积分商城的实际充值金额 */ - total_recharge_reward_info?: Lark.BonusAmount - } - export type CheckFailedAccountInfo = { - /** 账户ID */ - account_id?: string - /** 招聘系统内的提取金额 */ - total_withdraw_reward_info?: Lark.BonusAmount - /** 商城实际充值金额 */ - total_recharge_reward_info?: Lark.BonusAmount - } - export type Period = { - /** id */ - id?: string - /** 中文名称 */ - zh_name?: string - /** 英文名称 */ - en_name?: string - /** 状态 */ - status?: number - /** 周期开始时间 */ - period_start_time?: string - /** 周期结束时间 */ - period_end_time?: string - } - export type PeriodRule = { - /** 周期规则 */ - period_rule_id?: string - /** 周期类型. year: 年度周期. month: 月份周期 */ - type?: string - /** 周期长度（月) */ - length?: number - /** 周期长度（月) */ - first_month?: number - } - export type OkrObjectiveProgressRate = { - /** Objective 进度百分比 >= 0 */ - percent?: number - /** Objective 进度状态 */ - status?: string - } - export type ProgressRecordSimplify = { - /** OKR 进展ID */ - id?: string - } - export type OkrObjectiveAlignedObjectiveOwner = { - /** 用户的 open_id */ - open_id?: string - /** 用户的 user_id */ - user_id?: string - } - export type OkrObjectiveKr = { - /** Key Result ID */ - id?: string - /** KeyResult 内容 */ - content?: string - /** KeyResult打分（0 - 100） */ - score?: number - /** KeyResult的权重（0 - 100）（废弃） */ - weight?: number - /** KeyResult的权重（0 - 100） */ - kr_weight?: number - /** KR进度 */ - progress_rate?: Lark.OkrObjectiveProgressRate - /** 该KR的进度列表 */ - progress_record_list?: Lark.ProgressRecordSimplify[] - /** 最后一次进度百分比更新时间 毫秒 */ - progress_rate_percent_last_updated_time?: string - /** 最后一次状态更新时间 毫秒 */ - progress_rate_status_last_updated_time?: string - /** 最后一次在侧边栏新增或者编辑进展的时间 毫秒 */ - progress_record_last_updated_time?: string - /** 最后一次编辑进展记录/备注的时间 毫秒 */ - progress_report_last_updated_time?: string - /** 最后一次打分更新时间 毫秒 */ - score_last_updated_time?: string - /** 截止时间 毫秒 */ - deadline?: string - /** 该Objective提到的人员列表 */ - mentioned_user_list?: Lark.OkrObjectiveAlignedObjectiveOwner[] - } - export type OkrObjectiveAlignedObjective = { - /** Objective的ID */ - id?: string - /** OKR的ID */ - okr_id?: string - /** 该Objective的Owner */ - owner?: Lark.OkrObjectiveAlignedObjectiveOwner - } - export type OkrBatch = { - /** id */ - id?: string - /** OKR的访问权限 */ - permission?: number - /** period_id */ - period_id?: string - /** 名称 */ - name?: string - /** Objective列表 */ - objective_list?: Lark.OkrObjective[] - /** OKR确认状态 */ - confirm_status?: number - } - export type ContentList = { - /** 列表类型 */ - type?: string - /** 列表的缩进级别，支持指定一行的缩进 除代码块以外的列表都支持设置缩进，支持 1-16 级缩进，取值范围：[1,16] */ - indentLevel?: number - /** 用于指定列表的行号，仅对有序列表和代码块生效 如果为有序列表设置了缩进，行号可能会显示为字母或者罗马数字 */ - number?: number - } - export type ContentParagraphStyle = { - /** 有序列表/无序列表/任务列表 */ - list?: Lark.ContentList - } - export type ContentColor = { - /** 红 取值范围[0,255] */ - red?: number - /** 绿 取值范围[0,255] */ - green?: number - /** 蓝 取值范围[0,255] */ - blue?: number - /** 透明度 取值范围[0,1] */ - alpha?: number - } - export type ContentLink = { - /** 链接地址 */ - url?: string - } - export type ContentTextStyle = { - /** 是否加粗 */ - bold?: boolean - /** 是否删除 */ - strikeThrough?: boolean - /** 背景颜色 */ - backColor?: Lark.ContentColor - /** 字体颜色 */ - textColor?: Lark.ContentColor - /** 链接地址 */ - link?: Lark.ContentLink - } - export type ContentTextRun = { - /** 具体的文本内容 */ - text?: string - /** 文本内容的样式，支持 BIUS、颜色等 */ - style?: Lark.ContentTextStyle - } - export type ContentDocsLink = { - /** 链接地址 */ - url?: string - /** 链接文案 */ - title?: string - } - export type ContentPerson = { - /** 员工的OpenID */ - openId?: string - } - export type ContentParagraphElement = { - /** 元素类型 */ - type?: string - /** 文本 */ - textRun?: Lark.ContentTextRun - /** 文档链接，可以根据链接自动识别为标题 */ - docsLink?: Lark.ContentDocsLink - /** 艾特用户 */ - person?: Lark.ContentPerson - } - export type ContentParagraph = { - /** 段落样式 */ - style?: Lark.ContentParagraphStyle - /** 段落元素组成一个段落 */ - elements?: Lark.ContentParagraphElement[] - } - export type ContentImageItem = { - /** 图片 token，比如boxcnOj88GDkmWGm2zsTyCBqoLb，不支持编辑 */ - fileToken?: string - /** 图片链接 */ - src?: string - /** 图片宽，单位px */ - width?: number - /** 图片高，单位px */ - height?: number - } - export type ContentGallery = { - /** 图片元素 */ - imageList?: Lark.ContentImageItem[] - } - export type ContentBlockElement = { - /** 文档元素类型 */ - type?: string - /** 文本段落 */ - paragraph?: Lark.ContentParagraph - /** 图片 */ - gallery?: Lark.ContentGallery - } - export type ContentBlock = { - /** 文档结构是按行排列的，每行内容是一个 Block */ - blocks?: Lark.ContentBlockElement[] - } - export type ProgressRecord = { - /** OKR 进展ID */ - progress_id?: string - /** 进展更新时间 毫秒 */ - modify_time?: string - /** 进展 对应的 Content 详细内容 */ - content?: Lark.ContentBlock - } - export type ImageInfo = { - /** 图片token */ - file_token?: string - /** 图片下载链接 */ - url?: string - } - export type UserExternal = { - /** 用户类型 */ - user_type: number - /** 用户id */ - user_id?: string - /** 用户名称 */ - user_name?: string - /** 电话号码 */ - phone_num?: string - /** 部门id */ - department_id?: string - } - export type DeviceExternal = { - /** 设备id */ - id?: string - /** 设备名称 */ - name?: string - } - export type OpeningTimeValidDayExternal = { - /** 权限开始时间 */ - start_day: number - /** 权限结束时间 */ - end_day: number - } - export type OpeningTimePeriodExternal = { - /** 起始时间 */ - start_hhmm: number - /** 结束时间 */ - end_hhmm: number - } - export type OpeningTimeExternal = { - /** 有效日期 */ - valid_day?: Lark.OpeningTimeValidDayExternal - /** 有效星期 */ - weekdays?: number[] - /** 有效时间 */ - day_times?: Lark.OpeningTimePeriodExternal[] - } - export type Rule = { - /** 权限组id */ - id?: string - /** 权限组名称 */ - name?: string - /** 权限组包含的设备 */ - devices?: Lark.DeviceExternal[] - /** 权限组包含的员工个数 */ - user_count?: string - /** 权限组包含的员工列表 */ - users?: Lark.UserExternal[] - /** 权限组包含的访客个数 */ - visitor_count?: string - /** 权限组包含的访客列表 */ - visitors?: Lark.UserExternal[] - /** 是否通知人员录入 */ - remind_face?: boolean - /** 开门时间段 */ - opening_time?: Lark.OpeningTimeExternal - /** 是否为临时权限组 */ - is_temp?: boolean - } - export type Feature = { - /** 卡号 */ - card?: number - } - export type AccessRecord = { - /** 门禁记录 ID */ - access_record_id?: string - /** 门禁记录所属用户 ID */ - user_id?: string - /** 门禁设备 ID */ - device_id?: string - /** 是否是打卡 */ - is_clock_in?: boolean - /** 访问时间，单位秒 */ - access_time?: string - /** 识别方式 */ - access_type?: string - /** 识别相关数据，根据 access_type 不同，取值不同 */ - access_data?: string - /** 是否开门 */ - is_door_open?: boolean - } - export type Semester = { - /** 绩效评估周期 ID */ - id?: string - /** 绩效评估周期 名称 */ - name?: Lark.I18n - /** 绩效评估周期 开始时间 */ - start_time?: string - /** 绩效评估周期 结束时间 */ - end_time?: string - /** 绩效评估周期 创建时间 */ - create_time?: string - } - export type SemesterBaseInfo = { - /** 周期ID */ - semester_id?: string - /** 周期名称 */ - semester_name?: Lark.I18n - /** 开始时间 */ - start_time?: string - /** 结束时间 */ - end_time?: string - } - export type StageTaskStatusNum = { - /** 支持的ID */ - task_option_id?: number - /** 对Stage分类聚合 */ - stage_num?: number - } - export type StageTaskInfo = { - /** 环节ID */ - stage_id?: string - /** 环节名称 */ - name?: Lark.I18n - /** 环节截止时间 */ - deadline?: string - /** 环节任务数量 */ - need_todo_count?: number - /** 环节跳转链接 */ - jump_url?: string - /** 环节任务状态 */ - stage_task_status?: string - /** 归属分类ID */ - task_option_id?: number - } - export type StageTask = { - /** 用户ID */ - user_id?: string - /** 状态数量列表 */ - stage_num_lists?: Lark.StageTaskStatusNum[] - /** 任务信息列表 */ - stage_task_info_lists?: Lark.StageTaskInfo[] - } - export type Activity = { - /** 绩效评估项目 ID */ - id?: string - /** 绩效评估项目 名称 */ - name?: Lark.I18n - /** 绩效评估周期 ID */ - semester_id?: string - } - export type IndicatorOption = { - /** 等级 ID */ - id?: string - /** 等级名称 */ - name?: Lark.I18n - /** 等级代号 */ - label?: string - } - export type Indicator = { - /** 评估项 ID */ - id?: string - /** 评估项 名称 */ - name?: Lark.I18n - /** 评估项 等级列表 */ - options?: Lark.IndicatorOption[] - } - export type Template = { - /** 评估模板 ID */ - id?: string - /** 评估模板名称 */ - name?: Lark.I18n - /** 评估模板环节 */ - stage?: string - } - export type ReviewDetail = { - /** 评估模板 ID */ - template_id?: string - /** 评估内容 ID */ - unit_id?: string - /** 评估控件 ID */ - field_id?: string - /** 评估人 ID */ - reviewer_user_id?: Lark.User - /** 最后提交时间 */ - submit_time?: string - /** 评估项 ID */ - indicator_id?: string - /** 评估项结果等级 ID */ - option_id?: string - /** 评分型评估项填写内容 */ - score?: string - /** 填写项填写内容 */ - text?: string - } - export type ReviewStage = { - /** 环节类型 */ - stage_type?: string - /** 环节状态 */ - progress?: number - /** 环节填写内容 */ - data?: Lark.ReviewDetail[] - } - export type ReviewProfile = { - /** 被评估人 ID */ - user_id?: Lark.User - /** 绩效评估周期 ID */ - semester_id?: string - /** 绩效评估项目 ID */ - activity_id?: string - /** 本周期内各环节内容 */ - stages?: Lark.ReviewStage[] - } - export type ReviewData = { - /** 绩效评估周期列表 */ - semesters?: Lark.Semester[] - /** 绩效评估项目列表 */ - activities?: Lark.Activity[] - /** 评估项列表 */ - indicators?: Lark.Indicator[] - /** 评估模板列表 */ - templates?: Lark.Template[] - /** 评估内容列表 */ - units?: Lark.Unit[] - /** 填写项列表 */ - fields?: Lark.Field[] - /** 评估数据列表 */ - datas?: Lark.ReviewProfile[] - } - export type DisplayStatus = { - /** 是否允许在 IM 和 Doc 等场景进行高亮提示 */ - allow_highlight: boolean - /** 是否允许在飞书中被搜索到 */ - allow_search: boolean - } - export type Referer = { - /** 数据 id */ - id: string - /** 标题 */ - title?: string - } - export type Abbreviation = { - /** 相关其他词条 id */ - id?: string - } - export type Classification = { - /** 唯一分类 ID */ - id: string - /** 父级分类的 ID */ - father_id?: string - } - export type BaikeImage = { - /** 通过文件接口上传后的图片 token */ - token: string - } - export type RelatedMeta = { - /** 关联用户信息 */ - users?: Lark.Referer[] - /** 关联群组信息 */ - chats?: Lark.Referer[] - /** 关联文档信息 */ - docs?: Lark.Referer[] - /** 关联值班者信息 */ - oncalls?: Lark.Referer[] - /** 关联链接信息 */ - links?: Lark.Referer[] - /** 相关词条信息 */ - abbreviations?: Lark.Abbreviation[] - /** 所属分类信息（不支持传入一级分类。词条不可同时属于同一个一级分类下的多个二级分类，一级分类下的二级分类互斥） */ - classifications?: Lark.Classification[] - /** 上传的相关图片 */ - images?: Lark.BaikeImage[] - } - export type OuterInfo = { - /** 数据提供方（不能包含中横线 "-"） */ - provider: string - /** 唯一标识，可用来和其他平台的内容进行绑定。需保证和百科词条唯一对应（不能包含中横线 "-"） */ - outer_id: string - } - export type I18nEntryDesc = { - /** 语言类型 */ - language: number - /** 纯文本释义 */ - description?: string - /** 富文本描述 */ - rich_text?: string - } - export type Statistics = { - /** 点赞数量 */ - like_count: number - /** 点踩数量 */ - dislike_count: number - } - export type Entity = { - /** 实体词 Id */ - id?: string - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 创建者 */ - creator?: string - /** 词条创建时间（秒级时间戳） */ - create_time?: string - /** 最近一次更新者 */ - updater?: string - /** 最近一次更新词条时间（秒级时间戳） */ - update_time?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 统计数据 */ - statistics?: Lark.Statistics - /** 外部 id 关联数据 */ - outer_info?: Lark.OuterInfo - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string - /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */ - source?: number - /** 国际化的词条释义 */ - i18n_descs?: Lark.I18nEntryDesc[] - } - export type Draft = { - /** 草稿 Id */ - draft_id?: string - /** 实体词 */ - entity?: Lark.Entity - } - export type MatchInfo = { - /** 实体词 id */ - entity_id?: string - /** 匹配中的字段 */ - type?: number - } - export type ClassificationFilter = { - /** 需要获取的分类 */ - include?: string[] - /** 需要排除的分类 */ - exclude?: string[] - } - export type Span = { - /** 偏移量开始位置，从 0 开始计数（编码格式采用 utf-8） */ - start: number - /** 偏移量结束位置，从 0 开始计数（编码格式采用 utf-8） */ - end: number - } - export type Phrase = { - /** 文本中切分出的百科词条名称 */ - name: string - /** 实体词 id 列表 */ - entity_ids: string[] - /** 实体词所在位置 */ - span: Lark.Span - } - export type I18nClsName = { - /** 语言类型 */ - language: number - /** 分类名 */ - name: string - } - export type Repo = { - /** 词库 id */ - id: string - /** 词库名 */ - name: string - } - export type OpenapiLogDetail = { - /** http请求路径 */ - path?: string - /** http请求方法 */ - method?: string - /** http查询参数 */ - query_param?: string - /** http请求体 */ - payload?: string - /** http状态码 */ - status_code?: number - /** http响应体，仅返回code，msg，error信息等 */ - response?: string - } - export type OpenapiLog = { - /** openapi日志唯一标识 */ - id: string - /** 飞书开放平台定义的API */ - api_key: string - /** 日志产生的时间，以秒为单位的时间戳 */ - event_time?: number - /** 在开发者后台——凭证与基础信息页面查看的app_id（cli_xxxxx） */ - app_id?: string - /** 发起调用api的ip地址 */ - ip?: string - /** openapi调用日志详情 */ - log_detail?: Lark.OpenapiLogDetail - } - export type AuditObjectDetail = { - /** 克隆来源 */ - clone_source?: string - /** 其他文本 */ - text_detail?: string - /** 文件名称 */ - file_name?: string - /** 第三方APPID */ - third_party_appID?: string - /** 文件或文件夹数量 */ - contain_file_num?: number - /** 链接分享设置 */ - permission_setting_type?: string - /** 是否开启外部访问设置 */ - permission_external_access_Type?: boolean - /** 分享设置 */ - permission_share_type?: string - /** file上传业务来源 */ - file_service_source?: string - /** 下载OKR时的内容范围 */ - okr_download_content?: string - /** 容器类型，标识是否wiki */ - container_type?: string - /** 容器id，wiki标识字段 */ - container_id?: string - /** 截屏、录制的开始页面 */ - current_page?: string - } - export type AuditObjectEntity = { - /** 操作对象类型 */ - object_type?: string - /** 操作对象值，可能存在department_id、user_id等，需要进行lark_id的转换 */ - object_value?: string - /** 操作对象名称，如会话名、文档名等 */ - object_name?: string - /** 操作对象的所有者 */ - object_owner?: string - /** object 详情 */ - object_detail?: Lark.AuditObjectDetail - } - export type AuditRecipientDetail = { - /** 修改权限协作者 */ - permission_action_type?: string - } - export type AuditRecipientEntity = { - /** 接收者对象类型 */ - recipient_type?: string - /** 接收者对象值，可能存在department_id、user_id等，需要进行lark_id的转换 */ - recipient_value?: string - /** recipient 详情 */ - recipient_detail?: Lark.AuditRecipientDetail - } - export type AuditIosContext = { - /** UDID */ - udid?: string - /** 设备ID */ - did?: string - /** app的版本 */ - app_ver?: string - /** SecSDK版本 */ - ver?: string - /** 系统类型及版本 */ - os?: string - /** 系统时区 */ - STZone?: string - /** 当前语言 */ - ML?: string - /** 是否越狱 */ - sjd?: string - /** 代理ip */ - proxyip?: string - /** wifi ip */ - wifip?: string - /** GPS经纬度 */ - location?: string - /** 当前设备活跃ip */ - active_ip?: string - /** 当前设备活跃ip对应网卡类型 */ - active_ip_detail?: string - /** 基站信息 */ - cell_base_station?: string - /** 公网ip */ - IP?: string - } - export type AuditPcContext = { - /** UDID */ - udid?: string - /** 设备ID */ - did?: string - /** app的版本 */ - app_ver?: string - /** SecSDK版本 */ - ver?: string - /** 客户端类型 */ - os?: string - /** wifi ip */ - wifip?: string - /** 设备区域 */ - region?: string - /** 公网ip */ - IP?: string - } - export type AuditWebContext = { - /** UA信息 */ - user_agent?: string - /** 本机IP */ - IP?: string - } - export type AuditAndroidContext = { - /** UDID */ - udid?: string - /** 设备ID */ - did?: string - /** app的版本 */ - app_ver?: string - /** SecSDK版本 */ - ver?: string - /** 设备语言 */ - region?: string - /** 安卓版本号 */ - id_i?: string - /** 安卓版本 */ - id_r?: string - /** Brand */ - hw_brand?: string - /** 制造商 */ - hw_manuf?: string - /** wifi ip */ - wifip?: string - /** 路由IP */ - route_iip?: string - /** 路由网关IP */ - route_gip?: string - /** 表示当前是否root */ - env_su?: string - /** 手机系统时区 */ - env_tz?: string - /** 手机系统语言 */ - env_ml?: string - /** GPS经纬度 */ - location?: string - /** 当前设备活跃ip */ - active_ip?: string - /** 当前设备活跃ip对应网卡类型 */ - active_ip_detail?: string - /** 基站信息 */ - cell_base_station?: string - /** 公网ip */ - IP?: string - } - export type AuditContext = { - /** 终端类型 */ - terminal_type?: number - /** ios的环境信息 */ - ios_context?: Lark.AuditIosContext - /** pc的环境信息 */ - pc_context?: Lark.AuditPcContext - /** web的环境信息 */ - web_context?: Lark.AuditWebContext - /** android的环境信息 */ - android_context?: Lark.AuditAndroidContext - } - export type AuditEventExtend = { - /** 评论类型 */ - comment_type?: string - /** app信息 */ - app_detail?: string - /** 是否两步验证 */ - two_step_validation?: boolean - /** 登录方式 */ - login_method?: string - /** 创建新的{x}人会议/通话 */ - new_people_num_in_video?: number - /** 将{x}名外部用户加入/退出通话 */ - external_people_num_in_video?: number - /** 将{x}名外部用户加入/退出群组 */ - external_people_num_in_chat?: number - /** 创建{x}人数的群组 */ - join_group?: number - /** 解散{x}人数的群组 */ - quit_group?: number - /** 分享文档给{x}名外部用户 */ - external_people_num_in_doc_share?: number - } - export type ApiAuditDrawerInfo = { - /** key信息 */ - info_key?: string - /** val值 */ - info_val?: string - /** key对应的i18nkey */ - key_i18n_key?: string - /** val类型 */ - val_type?: string - /** val对应的i18nkey */ - val_i18n_key?: string - } - export type ApiAuditCommonDrawers = { - /** 扩展字段信息 */ - common_draw_info_list?: Lark.ApiAuditDrawerInfo[] - } - export type AuditDetail = { - /** mac地址 */ - mc?: string - /** 设备模型 */ - device_model?: string - /** 操作系统 */ - os?: string - /** ip属地 */ - city?: string - } - export type AuditInfo = { - /** 事件id */ - event_id?: string - /** 唯一id */ - unique_id?: string - /** 事件名称 */ - event_name: string - /** 用户所属部门的ID列表 */ - department_ids?: string[] - /** 模块 */ - event_module: number - /** 操作人类型 */ - operator_type?: number - /** 操作人id */ - operator_value?: string - /** 操作对象列表 */ - objects?: Lark.AuditObjectEntity[] - /** 接收者对象列表 */ - recipients?: Lark.AuditRecipientEntity[] - /** 事件时间 */ - event_time?: number - /** ip信息 */ - ip?: string - /** 第三方isvID */ - operator_app?: string - /** 环境信息 */ - audit_context?: Lark.AuditContext - /** 事件级别的扩展 */ - extend?: Lark.AuditEventExtend - /** 第三方isv名称 */ - operator_app_name?: string - /** 扩展字段信息 */ - common_drawers?: Lark.ApiAuditCommonDrawers - /** 日志扩展信息 */ - audit_detail?: Lark.AuditDetail - } - export type UserViewDetail = { - /** 用户ID */ - user_id?: string - /** 用户的最近查看时间timestamp（ms级别） */ - view_time?: string - } - export type Statictics = { - /** 用户浏览数 */ - user_view_count?: string - /** 页面浏览数量 */ - page_view_count?: string - /** 用户浏览列表 */ - user_view_list?: Lark.UserViewDetail[] - } - export type Minute = { - /** 妙记token */ - token?: string - /** 所有者ID */ - owner_id?: string - /** 妙记创建时间timestamp（ms级别） */ - create_time?: string - /** 妙记标题 */ - title?: string - /** 妙记封面链接 */ - cover?: string - /** 妙记时长（ms级别） */ - duration?: string - /** 妙记链接 */ - url?: string - } - export type AccessData = { - /** 访问次数 */ - pv?: number - /** 访问用户数(去重) */ - uv?: number - } - export type WorkplaceAccessData = { - /** 时间,精确到天,格式yyyy-MM-dd */ - date?: string - /** 全部工作台的访问数据 */ - all_workplace?: Lark.AccessData - /** 默认工作台的访问数据 */ - default_workplace?: Lark.AccessData - } - export type I18nName = { - /** ISO 639-1的语言代码。比如zh表示中文。 */ - language?: string - /** 名字 */ - name?: string - } - export type CustomWorkplaceAccessData = { - /** 定制工作台ID */ - custom_workplace_id?: string - /** 访问数据 */ - access_data?: Lark.AccessData - /** 时间,精确到天,格式yyyy-MM-dd */ - date?: string - /** 定制工作台多语言名字。 */ - custom_workplace_name?: Lark.I18nName[] - } - export type BlockAccessData = { - /** 时间,精确到天,格式yyyy-MM-dd */ - date?: string - /** 小组件id */ - block_id?: string - /** block访问数据信息。 */ - access_data?: Lark.AccessData - } - export type OpenMethod = { - /** applink类型 */ - type?: string - /** applink链接 */ - applink?: string - } - export type AppRecommendRuleVisibilityInfo = { - /** 是否全员可见 */ - is_all?: boolean - /** 可见部门 ID 列表 */ - department_ids?: string[] - /** 可见用户 ID 列表 */ - user_ids?: string[] - /** 可见用户组 ID 列表 */ - group_ids?: string[] - } - export type AppRecommendRuleItemInfoI18nName = { - /** 应用项的简体中文名称 */ - zh_cn?: string - /** 应用项的繁体中文（中国香港）名称 */ - zh_hk?: string - /** 应用项的繁体中文（中国台湾）名称 */ - zh_tw?: string - /** 应用项的英文名称 */ - en_us?: string - /** 应用项的日文名称 */ - ja_jp?: string - } - export type AppRecommendRuleItemInfo = { - /** 推荐应用项 ID */ - item_id?: string - /** 推荐应用项类型 */ - item_type?: string - /** 推荐应用项名称 */ - name?: string - /** 推荐应用项描述 */ - description?: string - /** 链接类型应用项的跳转链接（应用类型该字段为空） */ - link_url?: string - /** 应用类型应用项的 app id（链接类型该字段为空） */ - client_id?: string - /** 应用项图标链接 */ - icon_url?: string - /** 链接类型应用项的默认展示语种（应用类型该字段为空） */ - default_locale?: string - /** 应用项的多语种名称 */ - i18n_name?: Lark.AppRecommendRuleItemInfoI18nName - } - export type AppRecommendRule = { - /** 推荐规则 ID */ - id?: string - /** 推荐规则名称 */ - name?: string - /** 推荐规则启用状态 */ - status?: string - /** 推荐规则可见性信息 */ - visibility_info?: Lark.AppRecommendRuleVisibilityInfo - /** 不可移除推荐应用项列表 */ - recommend_item_infos?: Lark.AppRecommendRuleItemInfo[] - /** 可移除推荐应用项列表 */ - distributed_recommend_item_infos?: Lark.AppRecommendRuleItemInfo[] - } - export type FormField = { - /** 字段名称 */ - name?: string - /** 字段类型 */ - type?: string - } - export type FormContent = { - /** 表单字段ID */ - field_id?: string - /** 表单字段名称 */ - field_name?: string - /** 表单字段值 */ - field_value?: string - } - export type UserAccessTokenInfo = { - /** user_access_token，用于获取用户资源 */ - access_token?: string - /** token 类型 */ - token_type?: string - /** `access_token`的有效期，单位: 秒 */ - expires_in?: number - /** 用户姓名 */ - name?: string - /** 用户英文名称 */ - en_name?: string - /** 用户头像 */ - avatar_url?: string - /** 用户头像 72x72 */ - avatar_thumb?: string - /** 用户头像 240x240 */ - avatar_middle?: string - /** 用户头像 640x640 */ - avatar_big?: string - /** 用户在应用内的唯一标识 */ - open_id?: string - /** 用户统一ID */ - union_id?: string - /** 用户邮箱 */ - email?: string - /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */ - enterprise_email?: string - /** 用户 user_id */ - user_id?: string - /** 用户手机号 */ - mobile?: string - /** 当前企业标识 */ - tenant_key?: string - /** `refresh_token` 的有效期，单位: 秒 */ - refresh_expires_in?: number - /** 刷新用户 `access_token` 时使用的 token */ - refresh_token?: string - /** 用户当前登录态session的唯一标识，为空则不返回 */ - sid?: string - } - export type EntityWord = { - /** 抽取出的词条名 */ - name: string - /** 词条可能的推荐别名 */ - aliases?: string[] - } - export type InterviewDimensionScore = { - /** 选项ID */ - id?: string - /** 选项名称 */ - name?: Lark.I18n - } - export type InterviewDimensionAssessment = { - /** 题目评价 ID */ - id?: string - /** 题目名称 */ - name?: Lark.I18n - /** 当题目类型为描述题时，从此取值 */ - content?: string - /** 题目 ID */ - dimension_id?: string - /** 当题目类型为单选题时，从此取值 */ - dimension_score?: Lark.InterviewDimensionScore - /** 当题目类型为多选题时，从此取值 */ - dimension_score_list?: Lark.InterviewDimensionScore[] - /** 题目类型 */ - dimension_type?: number - } - export type Interview = { - /** 面试id */ - id?: string - /** 面试开始时间（ms） */ - begin_time?: number - /** 面试结束时间（ms） */ - end_time?: number - /** 面试轮次（从0开始计数） */ - round?: number - /** 面试关联的投递阶段 */ - stage_id?: string - /** 面试官记录列表 */ - interview_record_list?: Lark.InterviewRecord[] - } - export type OfferSchemaName = { - /** 中文名 */ - zh_cn?: string - /** 英文名 */ - en_us?: string - } - export type OfferSchemaDetailOption = { - /** 名字 */ - name?: Lark.OfferSchemaName - /** 选项序号 */ - index?: number - /** 选项当前是否启用 */ - active_status?: number - } - export type OfferSchemaDetail = { - /** 字段ID */ - id?: string - /** 字段名称 */ - name?: Lark.OfferSchemaName - /** 字段类型, text=单行文本, long_text=多行文本, select=单选, multi_select=多选, date_select=日期, number=数字 */ - type?: string - /** 字段是否为自定义 */ - is_customized?: boolean - /** 单选/多选可选择字段的选项值 */ - option_list?: Lark.OfferSchemaDetailOption[] - } - export type OfferSchema = { - /** offer申请表ID */ - id?: string - /** offer申请表使用场景 */ - scenario?: number - /** 申请表版本 */ - version?: number - /** 字段对象信息 */ - object_list?: Lark.OfferSchemaDetail[] - } - export type Subregion = { - /** 城市/区域id */ - id: string - /** 城市/区域名称 */ - name: Lark.I18n[] - /** 所属省份/行政区id，详细信息可通过【查询省份/行政区信息】接口查询获得 */ - subdivision_id: string - /** 上级城市/区域区id */ - superior_subregion_id?: string - } - export type Subdivision = { - /** 省份/行政区id */ - id: string - /** 省份/行政区名称 */ - name: Lark.I18n[] - /** 所属国家/地区id，详细信息可通过【查询国家/地区信息】接口查询获得 */ - country_region_id: string - /** 行政区类型，枚举值可通过文档【飞书人事枚举常量】行政区类型（subdivision_type）枚举定义部分获得 */ - subdivision_type: Lark.Enum - } - - } -} - -export interface ListEventOutboundIpQuery { - /** 分页大小，默认10，取值范围 10-50 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface TenantAccessTokenInternalAuthRequest { - /** 应用唯一标识，创建应用后获得 */ - app_id: string - /** 应用秘钥，创建应用后获得 */ - app_secret: string -} -export interface AppAccessTokenInternalAuthRequest { - /** 应用唯一标识，创建应用后获得 */ - app_id: string - /** 应用秘钥，创建应用后获得 */ - app_secret: string -} -export interface AppAccessTokenAuthRequest { - /** 应用唯一标识，创建应用后获得 */ - app_id: string - /** 应用秘钥，创建应用后获得 */ - app_secret: string - /** 平台定时推送给应用的临时凭证，通过事件监听机制获得 */ - app_ticket: string -} -export interface TenantAccessTokenAuthRequest { - /** 应用唯一标识，创建应用 */ - app_access_token: string - /** 应用秘钥，创建应用后获得 */ - tenant_key: string -} -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 AppTicketResendAuthRequest { - /** 应用唯一标识，创建应用后获得 */ - app_id: string - /** 应用秘钥，创建应用后获得 */ - app_secret: string -} -export interface QueryPassportSessionRequest { - /** 用户 ID */ - user_ids?: string[] -} -export interface QueryPassportSessionQuery { - user_id_type?: string -} -export interface ListContactScopeQuery { - /** 返回值的用户ID的类型 */ - user_id_type?: string - /** 返回值的部门ID的类型 */ - department_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小，返回值所有列表长度之和不超过这个值 */ - page_size?: number -} -export interface CreateContactUserRequest { - /** 租户内用户的唯一标识 */ - user_id?: string - /** 用户名 */ - name: string - /** 英文名 */ - en_name?: string - /** 别名 */ - nickname?: string - /** 邮箱 */ - email?: string - /** 手机号 */ - mobile: string - /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ - mobile_visible?: boolean - /** 性别 */ - gender?: number - /** 头像的文件Key */ - avatar_key?: string - /** 用户所在的部门 */ - department_ids: string[] - /** 用户的上级领导 */ - leader_user_id?: string - /** 城市 */ - city?: string - /** 国家 */ - country?: string - /** 工位 */ - work_station?: string - /** 入职时间 */ - join_time?: number - /** 工号 */ - employee_no?: string - /** 员工类型 */ - employee_type: number - /** 用户排序信息 */ - orders?: Lark.UserOrder[] - /** 自定义属性 */ - custom_attrs?: Lark.UserCustomAttr[] - /** 企业邮箱 */ - enterprise_email?: string - /** 职务 */ - job_title?: string - /** 数据驻留地 */ - geo?: string - /** 职级ID */ - job_level_id?: string - /** 序列ID */ - job_family_id?: string - /** 分配给用户的席位ID列表 */ - subscription_ids?: string[] - /** 虚线上级ID */ - dotted_line_leader_user_ids?: string[] -} -export interface CreateContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型。 - - 不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ - department_id_type?: string - /** 用于幂等判断是否为同一请求，避免重复创建。字符串类型，自行生成。 */ - client_token?: string -} -export interface DeleteContactUserRequest { - /** 部门群接收者。被删除用户为部门群群主时，转让群主给指定接收者，不指定接收者则默认转让给群内第一个入群的人 */ - department_chat_acceptor_user_id?: string - /** 外部群接收者。被删除用户为外部群群主时，转让群主给指定接收者，不指定接收者则默认转让给群内与被删除用户在同一组织的第一个入群的人，如果组织内只有该用户在群里，则解散外部群 */ - external_chat_acceptor_user_id?: string - /** 文档接收者。用户被删除时，其拥有的文档转让给接收者。不指定接收者则默认转让给直属上级，如果无直属上级则将文档资源保留在该用户名下。 */ - docs_acceptor_user_id?: string - /** 日程接收者。用户被删除时，其拥有的日程转让给接收者，不指定接收者则默认转让给直属上级，如果无直属上级则直接删除日程资源。 */ - calendar_acceptor_user_id?: string - /** 应用接受者。用户被删除时，其创建的应用转让给接收者，不指定接收者则默认转让给直属上级。如果无直属上级则保留应用在该用户名下，但该用户无法登录开发者后台进行应用管理，管理员可以在管理后台手动转移应用给其他人。 */ - application_acceptor_user_id?: string - /** 妙记接收者。用户被删除时，其拥有的妙记资源转让给接收者。如果不指定接收者，则默认转让给直属上级。如果无直属上级则将妙记保留在该用户名下。 */ - minutes_acceptor_user_id?: string - /** 飞书问卷接收者。用户被删除时，其拥有的飞书问卷资源转让给接收者，不指定接收者则默认转让给直属上级，如果无直属上级则直接删除飞书问卷资源。 */ - survey_acceptor_user_id?: string - /** 用户邮件资源处理方式。用户被删除时，根据传递的操作指令对其拥有的邮件资源做对应处理。未传递指令时默认将邮件资源转让给直属上级，如果无直属上级则保留邮件资源在该用户名下。 */ - email_acceptor?: Lark.ResourceAcceptor -} -export interface DeleteContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ResurrectContactUserRequest { - /** 指定恢复后用户所在部门 */ - departments?: Lark.UserDepartmentInfo[] - /** 指定恢复后分配的席位 */ - subscription_ids?: string[] -} -export interface ResurrectContactUserQuery { - /** 用户id类型 */ - user_id_type?: string - /** 部门id类型 */ - department_id_type?: string -} -export interface PatchContactUserRequest { - /** 用户名称 */ - name?: string - /** 英文名 */ - en_name?: string - /** 别名 */ - nickname?: string - /** 邮箱 */ - email?: string - /** 用户手机号 */ - mobile?: string - /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ - mobile_visible?: boolean - /** 性别 */ - gender?: number - /** 头像的文件Key */ - avatar_key?: string - /** 用户所在部门ID */ - department_ids?: string[] - /** 用户直属上级 */ - leader_user_id?: string - /** 城市 */ - city?: string - /** 国家 */ - country?: string - /** 工位 */ - work_station?: string - /** 入职时间 */ - join_time?: number - /** 工号 */ - employee_no?: string - /** 员工类型 */ - employee_type?: number - /** 用户排序信息 */ - orders?: Lark.UserOrder[] - /** 自定义属性 */ - custom_attrs?: Lark.UserCustomAttr[] - /** 企业邮箱 */ - enterprise_email?: string - /** 职务 */ - job_title?: string - /** 是否冻结用户 */ - is_frozen?: boolean - /** 职级ID */ - job_level_id?: string - /** 序列ID */ - job_family_id?: string - /** 分配给用户的席位ID列表 */ - subscription_ids?: string[] - /** 虚线上级ID */ - dotted_line_leader_user_ids?: string[] -} -export interface PatchContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface GetContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 - - 不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ - department_id_type?: string -} -export interface BatchContactUserQuery { - /** 要查询的用户ID列表 */ - user_ids: string[] - /** 指定请求中用户ID类型 */ - user_id_type?: string - /** 指定查询结果中用户关联的部门ID类型 */ - department_id_type?: string -} -export interface FindByDepartmentContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 - - 部门ID类型的区别参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ - department_id_type?: string - /** 填写该字段表示获取该部门下用户，必填。根部门的部门ID为0。 - - ID值与查询参数中的department_id_type 对应。 - - 不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ - department_id: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string -} -export interface BatchGetIdContactUserRequest { - /** 要查询的用户邮箱，最多 50 条。 - - 注意，emails与mobiles相互独立，每条用户邮箱返回对应的用户ID。 - - 本接口返回的用户ID数量为emails数量与mobiles数量的和。 */ - emails?: string[] - /** 要查询的用户手机号，最多 50 条。 - - 注意 - 1. emails与mobiles相互独立，每条用户手机号返回对应的用户ID。 - 2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。 */ - mobiles?: string[] -} -export interface BatchGetIdContactUserQuery { - /** 返回的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateUserIdContactUserRequest { - /** 自定义新用户ID */ - new_user_id: string -} -export interface UpdateUserIdContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateContactGroupRequest { - /** 用户组的名字，企业内唯一，最大长度：100 字符 */ - name: string - /** 用户组描述 */ - description?: string - /** 用户组的类型。默认为1表示普通用户组 */ - type?: number - /** 自定义用户组ID，可在创建时自定义，不自定义则由系统自动生成，已创建用户组不允许修改 group_id 。 - - 自定义group_id数据校验规则： - - 最大长度：64 字符 - - 校验规则：数字、大小写字母的组合，不能包含空格 */ - group_id?: string -} -export interface CreateContactGroupQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface PatchContactGroupRequest { - /** 用户组的名字，企业内唯一，最大长度：100 字符 */ - name?: string - /** 用户组描述信息 - 最大长度：500 字 */ - description?: string -} -export interface PatchContactGroupQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface GetContactGroupQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface SimplelistContactGroupQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户组类型 */ - type?: number -} -export interface MemberBelongContactGroupQuery { - /** 成员ID */ - member_id: string - /** 成员ID类型 */ - member_id_type?: string - /** 欲获取的用户组类型 */ - group_type?: number - /** 分页查询大小 */ - page_size?: number - /** 分页查询Token */ - page_token?: string -} -export interface ListContactCustomAttrQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateContactEmployeeTypeEnumRequest { - /** 枚举内容 */ - content: string - /** 类型 */ - enum_type: number - /** 类型 */ - enum_status: number - /** i18n定义 */ - i18n_content?: Lark.I18nContent[] -} -export interface UpdateContactEmployeeTypeEnumRequest { - /** 枚举内容 */ - content: string - /** 类型 */ - enum_type: number - /** 类型 */ - enum_status: number - /** i18n定义 */ - i18n_content?: Lark.I18nContent[] -} -export interface ListContactEmployeeTypeEnumQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface CreateContactDepartmentRequest { - /** 部门名称 */ - name: string - /** 国际化的部门名称 */ - i18n_name?: Lark.DepartmentI18nName - /** 父部门的ID */ - parent_department_id: string - /** 本部门的自定义部门ID */ - department_id?: string - /** 部门主管用户ID */ - leader_user_id?: string - /** 部门的排序 */ - order?: string - /** 部门单位自定义ID列表，当前只支持一个 */ - unit_ids?: string[] - /** 是否创建部门群，默认不创建 */ - create_group_chat?: boolean - /** 部门负责人 */ - leaders?: Lark.DepartmentLeader[] - /** 部门群雇员类型限制 */ - group_chat_employee_types?: number[] - /** 部门HRBP */ - department_hrbps?: string[] -} -export interface CreateContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 - - 不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ - department_id_type?: string - /** 用于幂等判断是否为同一请求，避免重复创建。字符串类型，自行生成。 */ - client_token?: string -} -export interface DeleteContactDepartmentQuery { - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface PatchContactDepartmentRequest { - /** 部门名 */ - name?: string - /** 国际化的部门名称 */ - i18n_name?: Lark.DepartmentI18nName - /** 父部门ID */ - parent_department_id?: string - /** leaderID */ - leader_user_id?: string - /** 部门的排序 */ - order?: string - /** 部门单位自定义ID列表，当前只支持一个 */ - unit_ids?: string[] - /** 是否创建部门群，默认不创建 */ - create_group_chat?: boolean - /** 部门负责人 */ - leaders?: Lark.DepartmentLeader[] - /** 部门群雇员类型限制 */ - group_chat_employee_types?: number[] - /** 部门HRBP */ - department_hrbps?: string[] -} -export interface PatchContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface UpdateContactDepartmentRequest { - /** 部门名称 */ - name: string - /** 国际化的部门名称 */ - i18n_name?: Lark.DepartmentI18nName - /** 父部门ID */ - parent_department_id: string - /** LeaderID */ - leader_user_id?: string - /** 部门的排序 */ - order?: string - /** 部门单位自定义ID列表，当前只支持一个 */ - unit_ids?: string[] - /** 是否创建部门群，默认不创建 */ - create_group_chat?: boolean - /** 部门负责人 */ - leaders?: Lark.DepartmentLeader[] - /** 部门群雇员类型限制 */ - group_chat_employee_types?: number[] -} -export interface UpdateContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface UnbindDepartmentChatContactDepartmentRequest { - /** 部门ID */ - department_id: string -} -export interface UnbindDepartmentChatContactDepartmentQuery { - /** 此次调用中使用的部门ID的类型，默认为"open_department_id" */ - department_id_type?: string -} -export interface GetContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 - - 不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ - department_id_type?: string -} -export interface BatchContactDepartmentQuery { - /** 查询的部门ID列表，类型需要与department_id_type对应 */ - department_ids: string[] - /** 说明请求中department_id_list参数所使用的部门ID类型 */ - department_id_type?: string - /** 指定调用结果中包含用户（如部门leader）关联的用户ID类型 */ - user_id_type?: string -} -export interface ChildrenContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 - - 不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ - department_id_type?: string - /** 是否递归获取子部门 */ - fetch_child?: boolean - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string -} -export interface ParentContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 部门ID */ - department_id: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface SearchContactDepartmentRequest { - /** 搜索关键词，匹配字段为部门名称（不支持匹配部门国际化名称） */ - query: string -} -export interface SearchContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface UpdateDepartmentIdContactDepartmentRequest { - /** 本部门的自定义部门新ID */ - new_department_id: string -} -export interface UpdateDepartmentIdContactDepartmentQuery { - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface CreateContactUnitRequest { - /** 单位自定义ID。不带默认自动生成。1-64字节范围大小，需为数字字母 */ - unit_id?: string - /** 单位的名字，长度范围为1-100个字 */ - name: string - /** 单位类型，长度范围为1-100个字，创建后不可修改 */ - unit_type: string -} -export interface PatchContactUnitRequest { - /** 单位的名字 */ - name?: string -} -export interface BindDepartmentContactUnitRequest { - /** 单位ID */ - unit_id: string - /** 单位关联的部门ID */ - department_id: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface UnbindDepartmentContactUnitRequest { - /** 单位ID */ - unit_id: string - /** 预解除关联的部门ID */ - department_id: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface ListDepartmentContactUnitQuery { - /** 单位ID */ - unit_id: string - /** 此次调用中预获取的部门ID的类型 */ - department_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface ListContactUnitQuery { - /** 分页大小，默认50，取值范围 1-100 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface AddContactGroupMemberRequest { - /** 用户组成员的类型，取值为 user */ - member_type: string - /** 当member_type =user时候，member_id_type表示user_id_type，枚举值为open_id, union_id, user_id */ - member_id_type: string - /** 添加的成员ID */ - member_id: string -} -export interface BatchAddContactGroupMemberRequest { - /** 待添加成员 */ - members?: Lark.Memberlist[] -} -export interface RemoveContactGroupMemberRequest { - /** 用户组成员的类型，取值为 user */ - member_type: string - /** 操作移除的用户组成员ID */ - member_id: string - /** 当member_type =user时候，member_id_type表示user_id_type，枚举值为open_id, union_id, user_id */ - member_id_type: string -} -export interface BatchRemoveContactGroupMemberRequest { - /** 待移除成员 */ - members: Lark.Memberlist[] -} -export interface SimplelistContactGroupMemberQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 欲获取成员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?: string - /** 欲获取的用户组成员类型。 */ - member_type?: string -} -export interface CreateContactFunctionalRoleRequest { - /** 角色名称，在单租户下唯一 */ - role_name: string -} -export interface UpdateContactFunctionalRoleRequest { - /** 修改的角色名称，在单租户下唯一 */ - role_name: string -} -export interface BatchCreateContactFunctionalRoleMemberRequest { - /** 角色添加的角色成员列表（一批用户的UserID列表) */ - members: string[] -} -export interface BatchCreateContactFunctionalRoleMemberQuery { - /** 成员ID类型 */ - user_id_type?: string -} -export interface BatchDeleteContactFunctionalRoleMemberRequest { - /** 角色删除的角色成员列表（一批用户的UserID列表) */ - members?: string[] -} -export interface BatchDeleteContactFunctionalRoleMemberQuery { - /** 成员ID类型 */ - user_id_type?: string -} -export interface ScopesContactFunctionalRoleMemberRequest { - /** 角色修改的角色成员列表（一批用户的UserID列表) */ - members: string[] - /** 角色内用户的管理范围 */ - departments: string[] -} -export interface ScopesContactFunctionalRoleMemberQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface GetContactFunctionalRoleMemberQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface ListContactFunctionalRoleMemberQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface CreateContactJobLevelRequest { - /** 职级名称 */ - name: string - /** 职级描述 */ - description?: string - /** 职级的排序，可填入自然数100-100000的数值，系统按照数值大小从小到大排序。不填写该字段时，默认新增排序在当前职级列表中最后位（最大值） */ - order?: number - /** 是否启用 */ - status: boolean - /** 多语言名称 */ - i18n_name?: Lark.I18nContent[] - /** 多语言描述 */ - i18n_description?: Lark.I18nContent[] -} -export interface UpdateContactJobLevelRequest { - /** 职级名称 */ - name?: string - /** 职级描述 */ - description?: string - /** 职级的排序，可填入自然数100-100000的数值，系统按照数值大小从小到大排序。不填写该字段时，默认新增排序在当前职级列表中最后位（最大值） */ - order?: number - /** 是否启用 */ - status?: boolean - /** 多语言名称 */ - i18n_name?: Lark.I18nContent[] - /** 多语言描述 */ - i18n_description?: Lark.I18nContent[] -} -export interface ListContactJobLevelQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 传入该字段时，可查询指定职级名称对应的职级信息。 */ - name?: string -} -export interface CreateContactJobFamilyRequest { - /** 序列名称。1-100字符，支持中、英文及符号 */ - name: string - /** 序列描述，描述序列详情信息 */ - description?: string - /** 上级序列ID。需是该租户的序列ID列表中的值，对应唯一的序列名称。 */ - parent_job_family_id?: string - /** 是否启用 */ - status: boolean - /** 多语言序列名称 */ - i18n_name?: Lark.I18nContent[] - /** 多语言描述 */ - i18n_description?: Lark.I18nContent[] -} -export interface UpdateContactJobFamilyRequest { - /** 序列名称。1-100字符，支持中、英文及符号 */ - name?: string - /** 序列描述，描述序列详情信息 */ - description?: string - /** 上级序列ID。需是该租户的序列ID列表中的值，对应唯一的序列名称。 */ - parent_job_family_id?: string - /** 是否启用 */ - status?: boolean - /** 多语言序列名称 */ - i18n_name?: Lark.I18nContent[] - /** 多语言描述 */ - i18n_description?: Lark.I18nContent[] -} -export interface ListContactJobFamilyQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 序列名称,传入该字段时，可查询指定序列名称对应的序列信息 */ - name?: string -} -export interface ListContactJobTitleQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface ListContactWorkCityQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateImMessageRequest { - /** 依据receive_id_type的值，填写对应的消息接收者id */ - receive_id: string - /** 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，类型定义请参考[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */ - msg_type: string - /** 消息内容，json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，具体格式说明参考：[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) - - 请求体大小限制： - - 文本消息请求体最大不能超过150KB - - 卡片及富文本消息请求体最大不能超过30KB */ - content: string - /** 由开发者生成的唯一字符串序列，用于发送消息请求去重；持有相同uuid的请求1小时内至多成功执行一次 */ - uuid?: string -} -export interface CreateImMessageQuery { - /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */ - receive_id_type: 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 - /** 是否以话题形式回复。取值为 true 时将以话题形式回复。注意：如果要回复的消息已经是话题形式的消息，则默认以话题形式进行回复。 */ - 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: string - /** 由开发者生成的唯一字符串序列，用于转发消息请求去重；持有相同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: string - /** 由开发者生成的唯一字符串序列，用于转发消息请求去重；持有相同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: string - /** 由开发者生成的唯一字符串序列，用于转发消息请求去重；持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */ - uuid?: string -} -export interface ReadUsersImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: string - /** 此次调用中使用的分页的大小 */ - page_size?: number - /** 下一页分页的token */ - page_token?: string -} -export interface ListImMessageQuery { - /** 容器类型 ，目前可选值仅有"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?: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string -} -export interface GetImMessageResourceQuery { - /** 资源类型，可选"image, file“； image对应消息中的 图片，富文本消息中的图片。 file对应消息中的 文件、音频、视频、（表情包除外） */ - type: string -} -export interface GetImMessageQuery { - /** - * 用户 ID 类型 - * - * - `open_id`：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。 - * - `union_id`：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。 - * - `user_id`：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。 - * @default 'open_id' - */ - user_id_type?: 'open_id' | 'user_id' | 'union_id' -} -export interface UrgentAppImMessageRequest { - /** 该字段标识目标用户的id类型 */ - user_id_list: string[] -} -export interface UrgentAppImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: string -} -export interface UrgentSmsImMessageRequest { - /** 该字段标识目标用户的id类型 */ - user_id_list: string[] -} -export interface UrgentSmsImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: string -} -export interface UrgentPhoneImMessageRequest { - /** 该字段标识目标用户的id类型 */ - user_id_list: string[] -} -export interface UrgentPhoneImMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: string -} -export interface CreateImImageForm { - /** 图片类型 */ - image_type: 'message' | 'avatar' - /** - * 图片内容。传值方式可以参考请求体示例。 - * - * 注意： - * - * - 上传的图片大小不能超过 10 MB，也不能上传大小为 0 的图片。 - * - 分辨率限制： - * - GIF 图片分辨率不能超过 2000 x 2000，其他图片分辨率不能超过 12000 x 12000。 - * - 用于设置头像的图片分辨率不能超过 4096 x 4096。 - */ - image: Blob -} -export interface CreateImFileForm { - /** - * 待上传的文件类型 - * - * 可选值有： - * - * - opus：OPUS 音频文件。其他格式的音频文件，请转为 OPUS 格式后上传。可使用 ffmpeg 转换格式： - * ```sh - * ffmpeg -i SourceFile.mp3 -acodec libopus -ac 1 -ar 16000 TargetFile.opus - * ``` - * - mp4：MP4 格式视频文件 - * - pdf：PDF 格式文件 - * - doc：DOC 格式文件 - * - xls：XLS 格式文件 - * - ppt：PPT 格式文件 - * - stream：stream 格式文件。若上传文件不属于以上枚举类型，可以使用 stream 格式 - */ - file_type: string - /** 带后缀的文件名 */ - file_name: string - /** 文件的时长（视频、音频），单位：毫秒。不传值时无法显示文件的具体时长。 */ - duration?: number - /** - * 文件内容，具体的传值方式可参考请求体示例。 - * - * 注意：文件大小不得超过 30 MB，且不允许上传空文件。 - */ - file: Blob -} -export interface PatchImMessageRequest { - /** 消息内容 json 格式，[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)，参考文档中的卡片格式 */ - content: string -} -export interface CreateImMessageReactionRequest { - /** reaction资源类型 */ - reaction_type: Lark.Emoji -} -export interface ListImMessageReactionQuery { - /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。 - - - 不传入该参数，表示拉取所有类型reaction */ - reaction_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时，会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number - /** 当操作人为用户时返回用户ID的类型 */ - user_id_type?: string -} -export interface CreateImPinRequest { - /** 待Pin的消息ID */ - message_id: string -} -export interface ListImPinQuery { - /** 待获取Pin消息的Chat ID */ - chat_id: string - /** Pin信息的起始时间（毫秒级时间戳） */ - start_time?: string - /** Pin信息的结束时间（毫秒级时间戳） */ - end_time?: string - /** 此次调用中使用的分页的大小 */ - page_size?: number - /** 下一页分页的token */ - page_token?: 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?: Lark.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`：群组 */ - 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?: Lark.RestrictedModeSetting - /** 谁可以加急 */ - urgent_setting?: string - /** 谁可以发起视频会议 */ - video_conference_setting?: string - /** 谁可以编辑群信息 */ - edit_permission?: string -} -export interface CreateImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 如果选择了设置群主为指定用户，可以选择是否同时设置创建此群的机器人为管理员，此标志位用于标记是否设置创建群的机器人为管理员 */ - 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?: Lark.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?: Lark.RestrictedModeSetting - /** 群类型 */ - chat_type?: string - /** 谁可以加急 */ - urgent_setting?: string - /** 谁可以发起视频会议 */ - video_conference_setting?: string -} -export interface UpdateImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -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?: string -} -export interface GetImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PutTopNoticeImChatTopNoticeRequest { - /** 要进行发布的群置顶 */ - chat_top_notice: Lark.ChatTopNotice[] -} -export interface ListImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 群组排序方式 */ - sort_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface SearchImChatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 关键词。注意：如果query为空值将返回空的结果 */ - query?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface GetImChatModerationQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface LinkImChatRequest { - /** 群分享链接有效时长，可选值week、year、permanently，分别表示7天、1年以及永久有效 */ - validity_period?: string -} -export interface AddManagersImChatManagersRequest { - /** 要增加的 manager_id */ - manager_ids?: string[] -} -export interface AddManagersImChatManagersQuery { - /** 群成员 id 类型 open_id/user_id/union_id/app_id */ - member_id_type?: string -} -export interface DeleteManagersImChatManagersRequest { - /** 要删除的 manager_id */ - manager_ids?: string[] -} -export interface DeleteManagersImChatManagersQuery { - /** 群成员 id 类型 open_id/user_id/union_id/app_id */ - member_id_type?: 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?: string - /** 出现不可用ID后的处理方式 0/1/2 */ - succeed_type?: number -} -export interface DeleteImChatMembersRequest { - /** 成员列表 */ - id_list?: string[] -} -export interface DeleteImChatMembersQuery { - /** 出群成员 id 类型 open_id/user_id/union_id/app_id */ - member_id_type?: string -} -export interface GetImChatMembersQuery { - /** 群成员 用户 ID 类型，详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ - member_id_type?: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface PatchImChatAnnouncementRequest { - /** 文档当前版本号 int64 类型，get 接口会返回 */ - revision: string - /** 修改文档请求的序列化字段 - - 更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */ - requests?: string[] -} -export interface GetImChatAnnouncementQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateImChatTabRequest { - /** 会话标签页 */ - chat_tabs: Lark.ChatTab[] -} -export interface DeleteTabsImChatTabRequest { - /** 会话标签页id列表 */ - tab_ids: string[] -} -export interface UpdateTabsImChatTabRequest { - /** 会话标签页 */ - chat_tabs?: Lark.ChatTab[] -} -export interface SortTabsImChatTabRequest { - /** 会话标签页ID列表 */ - tab_ids?: string[] -} -export interface CreateImChatMenuTreeRequest { - /** 要向群内追加的菜单 */ - menu_tree: Lark.ChatMenuTree -} -export interface DeleteImChatMenuTreeRequest { - /** 要删除的一级菜单ID列表 */ - chat_menu_top_level_ids: string[] -} -export interface PatchImChatMenuItemRequest { - /** 修改的字段 */ - update_fields: string[] - /** 元信息 */ - chat_menu_item: Lark.ChatMenuItem -} -export interface SortImChatMenuTreeRequest { - /** 一级菜单id列表 */ - chat_menu_top_level_ids: string[] -} -export interface ListDrivev1FileQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 文件夹的token（若不填写该参数或填写空字符串，则默认获取用户云空间下的清单，且不支持分页） */ - folder_token?: string - /** 排序规则 */ - order_by?: string - /** 升序降序 */ - direction?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateFolderDrivev1FileRequest { - /** 文件夹名称 */ - name: string - /** 父文件夹token */ - folder_token: string -} -export interface BatchQueryDrivev1MetaRequest { - /** 请求文档, 一次不超过200个 */ - request_docs: Lark.RequestDoc[] - /** 是否获取文档链接 */ - with_url?: boolean -} -export interface BatchQueryDrivev1MetaQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetDrivev1FileStatisticsQuery { - /** 文档类型 */ - file_type: string -} -export interface CopyDrivev1FileRequest { - /** 被复制文件的新名称 */ - name: string - /** 被复制文件的类型，如果该值为空或者与文件实际类型不匹配，接口会返回失败。 */ - type?: string - /** 文件被复制到的目标文件夹token */ - folder_token: string - /** 用户自定义请求附加参数，用于实现特殊的复制语义 */ - extra?: Lark.Property[] -} -export interface CopyDrivev1FileQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface MoveDrivev1FileRequest { - /** 文件类型，如果该值为空或者与文件实际类型不匹配，接口会返回失败。 */ - type?: string - /** 目标文件夹token */ - folder_token?: string -} -export interface DeleteDrivev1FileQuery { - /** 被删除文件的类型 */ - type: string -} -export interface CreateShortcutDrivev1FileRequest { - /** 创建快捷方式的目标父文件夹 token */ - parent_token: string - /** 快捷方式映射到的文档和文件列表信息 */ - refer_entity: Lark.ReferEntity -} -export interface CreateShortcutDrivev1FileQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface TaskCheckDrivev1FileQuery { - /** 文件相关异步任务id */ - task_id: string -} -export interface UploadAllDrivev1MediaForm { - /** - * 要上传的素材的名称 - * - * 数据校验规则： - * - * - 最大长度：250 字符 - */ - file_name: string - /** - * 上传点的类型。你可根据上传的素材类型与云文档类型确定上传点类型。例如，要将一张图片插入到新版文档（文件类型为 docx）中，需指定上传点为 docx_image；要将一个附件上传到新版文档中，需指定上传点为 docx_file。 - * - * 可选值有： - * - * - doc_image：旧版文档图片 - * - docx_image：新版文档图片 - * - sheet_image：电子表格图片 - * - doc_file：旧版文档文件 - * - docx_file：新版文档文件 - */ - parent_type: string - /** 上传点的 token，即要上传的云文档的 token，用于指定素材将要上传到的云文档或位置。参考素材概述了解上传点类型与上传点 token 的对应关系 */ - parent_node: string - /** - * 文件的大小，单位为字节 - * - * 数据校验规则： - * - * - 最大值：20971520 - */ - size: number - /** 文件的 Adler-32 校验和 */ - checksum?: string - /** 其它扩展信息。详情参考素材概述。如果需要跨域路由，需要填写路由的云文档 token，格式为 {"drive_route_token":"需要路由的云文档的 token"} */ - extra?: string - /** 文件的二进制内容 */ - file: Blob -} -export interface DownloadDrivev1MediaQuery { - /** 扩展信息 */ - extra?: string -} -export interface BatchGetTmpDownloadUrlDrivev1MediaQuery { - /** 文件标识符列表 */ - file_tokens: string[] - /** 拓展信息(可选) */ - extra?: string -} -export interface UploadPrepareDrivev1MediaRequest { - /** 文件名 */ - file_name: string - /** 上传点类型 */ - parent_type: string - /** 上传点的标识符 */ - parent_node: string - /** 文件大小 */ - size: number - /** 扩展信息(可选) */ - extra?: string -} -export interface UploadPartDrivev1MediaForm { - /** 分片上传事务的 ID。通过调用分片上传素材（预上传）接口获取。 */ - upload_id: string - /** 块号，从 0 开始计数。 */ - seq: number - /** 块的大小，单位为字节。 */ - size: number - /** 素材文件的 Adler-32 校验和 */ - checksum?: string - /** 素材文件分片的二进制内容 */ - file: Blob -} -export interface UploadFinishDrivev1MediaRequest { - /** 分片上传事务ID */ - upload_id: string - /** 分片数量 */ - block_num: number -} -export interface SubscribeDrivev1FileQuery { - /** 文档类型 */ - file_type: string -} -export interface DeleteSubscribeDrivev1FileQuery { - /** 文档类型 */ - file_type: string -} -export interface GetSubscribeDrivev1FileQuery { - /** 文档类型 */ - file_type: string -} -export interface UploadAllDrivev1FileForm { - /** - * 要上传的文件的名称。 - * - * 数据校验规则： - * - * - 最大长度：250 字符 - */ - file_name: string - /** - * 上传点的类型。取固定值 explorer，表示将文件上传至云空间中。 - * - * 可选值有： - * - * - explorer：云空间 - */ - parent_type: string - /** 云空间中文件夹的 token。获取方式见文件夹概述。 */ - parent_node: string - /** - * 文件的大小，单位为字节。 - * - * 数据校验规则： - * - * - 最大值：20971520 - */ - size: number - /** 文件的 Adler-32 校验和 */ - checksum?: string - /** 文件的二进制内容 */ - file: Blob -} -export interface UploadPrepareDrivev1FileRequest { - /** 文件名 */ - file_name: string - /** 上传点类型 */ - parent_type: string - /** 文件夹的token */ - parent_node: string - /** 文件大小 */ - size: number -} -export interface UploadPartDrivev1FileForm { - /** 分片上传事务 ID。通过调用分片上传文件-预上传接口获取。 */ - upload_id: string - /** 文件分片的序号，从 0 开始计数。 */ - seq: number - /** 分片的大小，单位为字节。 */ - size: number - /** 文件分片的 Adler-32 校验和 */ - checksum?: string - /** 文件分片的二进制内容 */ - file: Blob -} -export interface UploadFinishDrivev1FileRequest { - /** 分片上传事务ID */ - upload_id: string - /** 分片数量 */ - block_num: number -} -export interface CreateDrivev1ImportTaskRequest { - /** 导入文件格式后缀 */ - file_extension: string - /** 导入文件Drive FileToken */ - file_token: string - /** 导入目标云文档格式 */ - type: string - /** 导入目标云文档文件名 ，若为空使用Drive文件名 */ - file_name?: string - /** 挂载点 */ - point: Lark.ImportTaskMountPoint -} -export interface CreateDrivev1ExportTaskRequest { - /** 导出文件扩展名 */ - file_extension: string - /** 导出文档 token */ - token: string - /** 导出文档类型 */ - type: string - /** 导出子表ID，仅当将 sheet/bitable 导出为 csv 时使用 */ - sub_id?: string -} -export interface GetDrivev1ExportTaskQuery { - /** 导出文档的 token */ - token: string -} -export interface ListDrivev1FileViewRecordQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 文档类型 */ - file_type: string - /** 此次调用中使用的访问者 ID 的类型 */ - viewer_id_type?: string -} -export interface CreateDrivev1FileVersionRequest { - /** 版本文档标题 */ - name?: string - /** 版本文档版本号 */ - version?: string - /** 源文档token */ - parent_token?: string - /** 版本文档所有者id */ - owner_id?: string - /** 版本文档创建者id */ - creator_id?: string - /** 版本文档创建时间 */ - create_time?: string - /** 版本文档更新时间 */ - update_time?: string - /** 版本文档状态 */ - status?: string - /** 版本文档类型 */ - obj_type?: string - /** 源文档类型 */ - parent_type?: string -} -export interface CreateDrivev1FileVersionQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteDrivev1FileVersionQuery { - /** 文档类型 */ - obj_type: string - /** 用户ID类型 */ - user_id_type?: string -} -export interface GetDrivev1FileVersionQuery { - /** 文档类型 */ - obj_type: string - /** 用户ID类型 */ - user_id_type?: string -} -export interface ListDrivev1FileVersionQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 原文档类型 */ - obj_type: string - /** 用户id类型 */ - user_id_type?: string -} -export interface TransferOwnerDrivev1PermissionMemberRequest { - /** 文档拥有者的ID类型 */ - member_type: string - /** 文档拥有者的ID，与文档拥有者的ID类型需要对应 */ - member_id: string -} -export interface TransferOwnerDrivev1PermissionMemberQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string - /** 是否需要通知新 Owner */ - need_notification?: boolean - /** 转移后是否需要移除原 Owner 的权限 */ - remove_old_owner?: boolean - /** 仅当内容不在共享文件夹中，此参数才会生效。如果设为false，系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true，则留在原位置。 */ - stay_put?: boolean -} -export interface AuthDrivev1PermissionMemberQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string - /** 需要判断的权限 */ - action: string -} -export interface ListDrivev1PermissionMemberQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string - /** 指定返回的协作者字段信息，如无指定则默认不返回 - - **可选值有：** - - `name`：协作者名 - - `type`：协作者类型 - - `avatar`：头像 - - `external_label`：外部标签 - - **注意：** - - 你可以使用特殊值`*`指定返回目前支持的所有字段 - - 你可以使用`,`分隔若干个你想指定返回的字段，如：`name,avatar` - - 按需指定返回字段接口性能更好 */ - fields?: string -} -export interface CreateDrivev1PermissionMemberRequest { - /** 协作者ID类型 */ - member_type: string - /** 协作者ID，与协作者ID类型需要对应 */ - member_id: string - /** 需要增加的权限角色 */ - perm: string -} -export interface CreateDrivev1PermissionMemberQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string - /** 添加权限后是否通知对方 */ - need_notification?: boolean -} -export interface UpdateDrivev1PermissionMemberRequest { - /** 协作者ID类型 */ - member_type: string - /** 需要增加的权限角色 */ - perm: string -} -export interface UpdateDrivev1PermissionMemberQuery { - /** 更新权限后是否通知对方 - - **注意：** 使用`tenant_access_token`访问不支持该参数 */ - need_notification?: boolean - /** 文件类型，放于query参数中，如：`?type=doc` */ - type: string -} -export interface DeleteDrivev1PermissionMemberQuery { - /** 文件类型，放于query参数中，如：`?type=doc` */ - type: string - /** 权限成员类型，放于query参数中，如：`?member_type=openid` */ - member_type: string -} -export interface CreateDrivev1PermissionPublicPasswordQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string -} -export interface UpdateDrivev1PermissionPublicPasswordQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string -} -export interface DeleteDrivev1PermissionPublicPasswordQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string -} -export interface GetDrivev1PermissionPublicQuery { - /** 文件类型，放于query参数中，如：`?type=doc` */ - type: string -} -export interface PatchDrivev1PermissionPublicRequest { - /** 允许内容被分享到组织外 */ - external_access?: boolean - /** 谁可以复制内容、创建副本、打印、下载 */ - security_entity?: string - /** 谁可以评论 */ - comment_entity?: string - /** 谁可以添加和管理协作者 */ - share_entity?: string - /** 链接分享设置 */ - link_share_entity?: string - /** 允许非「可管理权限」的人分享到组织外 */ - invite_external?: boolean -} -export interface PatchDrivev1PermissionPublicQuery { - /** 文件类型，放于query参数中，如：`?type=doc` */ - type: string -} -export interface GetDrivev2PermissionPublicQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string -} -export interface PatchDrivev2PermissionPublicRequest { - /** 允许内容被分享到组织外 */ - external_access_entity?: string - /** 谁可以创建副本、打印、下载 */ - security_entity?: string - /** 谁可以评论 */ - comment_entity?: string - /** 谁可以添加和管理协作者-组织维度 */ - share_entity?: string - /** 谁可以添加和管理协作者-协作者维度 */ - manage_collaborator_entity?: string - /** 链接分享设置 */ - link_share_entity?: string - /** 谁可以复制内容 */ - copy_entity?: string -} -export interface PatchDrivev2PermissionPublicQuery { - /** 文件类型，需要与文件的 token 相匹配 */ - type: string -} -export interface ListDrivev1FileCommentQuery { - /** 文档类型 */ - file_type: string - /** 是否全文评论 */ - is_whole?: boolean - /** 是否已解决（可选） */ - is_solved?: boolean - /** 评论分页参数 */ - page_token?: string - /** 获取满足 commen_id > page_token 的评论数量 */ - page_size?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchQueryDrivev1FileCommentRequest { - /** 需要获取数据的评论id */ - comment_ids: string[] -} -export interface BatchQueryDrivev1FileCommentQuery { - /** 文档类型 */ - file_type: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchDrivev1FileCommentRequest { - /** 评论解决标志 */ - is_solved: boolean -} -export interface PatchDrivev1FileCommentQuery { - /** 文档类型 */ - file_type: string -} -export interface CreateDrivev1FileCommentRequest { - /** 评论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?: Lark.ReplyList -} -export interface CreateDrivev1FileCommentQuery { - /** 文档类型 */ - file_type: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetDrivev1FileCommentQuery { - /** 文档类型 */ - file_type: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListDrivev1FileCommentReplyQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 文档类型 */ - file_type: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateDrivev1FileCommentReplyRequest { - /** 回复内容 */ - content: Lark.ReplyContent -} -export interface UpdateDrivev1FileCommentReplyQuery { - /** 文档类型 */ - file_type: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteDrivev1FileCommentReplyQuery { - /** 文档类型 */ - file_type: string -} -export interface RawContentDocxDocumentQuery { - /** 语言（用于 MentionUser 语言的选取） */ - lang?: number -} -export interface ListDocxDocumentBlockQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 查询的文档版本，-1表示文档最新版本。若此时查询的版本为文档最新版本，则需要持有文档的阅读权限；若此时查询的版本为文档的历史版本，则需要持有文档的编辑权限。 */ - document_revision_id?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateDocxDocumentRequest { - /** 文件夹 token，获取方式见云文档接口快速入门；空表示根目录，tenant_access_token应用权限仅允许操作应用创建的目录 */ - folder_token?: string - /** 文档标题，只支持纯文本 */ - title?: string -} -export interface GetDocxDocumentBlockQuery { - /** 查询的文档版本，-1表示文档最新版本。若此时查询的版本为文档最新版本，则需要持有文档的阅读权限；若此时查询的版本为文档的历史版本，则需要持有文档的编辑权限。 */ - document_revision_id?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetDocxDocumentBlockChildrenQuery { - /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ - document_revision_id?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateDocxDocumentBlockChildrenRequest { - /** 添加的孩子列表。 */ - children?: Lark.Block[] - /** 当前 block 在 children 中的插入位置，起始值为 0，最大值为原 children 长度 */ - index?: number -} -export interface CreateDocxDocumentBlockChildrenQuery { - /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ - document_revision_id?: number - /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ - client_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchDocxDocumentBlockRequest { - /** 更新文本元素请求 */ - update_text_elements?: Lark.UpdateTextElementsRequest - /** 更新文本样式请求 */ - update_text_style?: Lark.UpdateTextStyleRequest - /** 更新表格属性请求 */ - update_table_property?: Lark.UpdateTablePropertyRequest - /** 表格插入新行请求 */ - insert_table_row?: Lark.InsertTableRowRequest - /** 表格插入新列请求 */ - insert_table_column?: Lark.InsertTableColumnRequest - /** 表格批量删除行请求 */ - delete_table_rows?: Lark.DeleteTableRowsRequest - /** 表格批量删除列请求 */ - delete_table_columns?: Lark.DeleteTableColumnsRequest - /** 表格合并单元格请求 */ - merge_table_cells?: Lark.MergeTableCellsRequest - /** 表格取消单元格合并状态请求 */ - unmerge_table_cells?: Lark.UnmergeTableCellsRequest - /** 分栏插入新的分栏列请求 */ - insert_grid_column?: Lark.InsertGridColumnRequest - /** 分栏删除列请求 */ - delete_grid_column?: Lark.DeleteGridColumnRequest - /** 更新分栏列宽比例请求 */ - update_grid_column_width_ratio?: Lark.UpdateGridColumnWidthRatioRequest - /** 替换图片请求 */ - replace_image?: Lark.ReplaceImageRequest - /** 替换附件请求 */ - replace_file?: Lark.ReplaceFileRequest - /** 更新文本元素及样式请求 */ - update_text?: Lark.UpdateTextRequest -} -export interface PatchDocxDocumentBlockQuery { - /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ - document_revision_id?: number - /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ - client_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchUpdateDocxDocumentBlockRequest { - /** 批量更新 Block */ - requests: Lark.UpdateBlockRequest[] -} -export interface BatchUpdateDocxDocumentBlockQuery { - /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ - document_revision_id?: number - /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ - client_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchDeleteDocxDocumentBlockChildrenRequest { - /** 删除的起始索引（操作区间左闭右开） */ - start_index: number - /** 删除的末尾索引（操作区间左闭右开） */ - end_index: number -} -export interface BatchDeleteDocxDocumentBlockChildrenQuery { - /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ - document_revision_id?: number - /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ - client_token?: string -} -export interface PatchSheetsSpreadsheetRequest { - /** 表格标题 */ - title?: string -} -export interface GetSheetsSpreadsheetQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateSheetsSpreadsheetRequest { - /** 表格标题 */ - title?: string - /** 文件夹token */ - folder_token?: string -} -export interface MoveDimensionSheetsSpreadsheetSheetRequest { - /** 移动源位置参数 */ - source?: Lark.Dimension - /** 移动的目标位置行或者列号 */ - destination_index?: number -} -export interface FindSheetsSpreadsheetSheetRequest { - /** 查找条件 */ - find_condition: Lark.FindCondition - /** 查找的字符串 */ - find: string -} -export interface ReplaceSheetsSpreadsheetSheetRequest { - /** 查找条件 */ - find_condition: Lark.FindCondition - /** 查找的字符串 */ - find: string - /** 替换的字符串 */ - replacement: string -} -export interface CreateSheetsSpreadsheetSheetFilterRequest { - /** 筛选应用范围 */ - range: string - /** 设置筛选条件的列 */ - col: string - /** 筛选的条件 */ - condition: Lark.Condition -} -export interface UpdateSheetsSpreadsheetSheetFilterRequest { - /** 更新筛选条件的列 */ - col: string - /** 筛选条件 */ - condition: Lark.Condition -} -export interface CreateSheetsSpreadsheetSheetFilterViewRequest { - /** 筛选视图 id */ - filter_view_id?: string - /** 筛选视图名字 */ - filter_view_name?: string - /** 筛选视图的筛选范围 */ - range?: string -} -export interface PatchSheetsSpreadsheetSheetFilterViewRequest { - /** 筛选视图名字 */ - filter_view_name?: string - /** 筛选视图的筛选范围 */ - range?: string -} -export interface CreateSheetsSpreadsheetSheetFilterViewConditionRequest { - /** 设置筛选条件的列，使用字母号 */ - condition_id?: string - /** 筛选类型 */ - filter_type?: string - /** 比较类型 */ - compare_type?: string - /** 筛选参数 */ - expected?: string[] -} -export interface UpdateSheetsSpreadsheetSheetFilterViewConditionRequest { - /** 筛选类型 */ - filter_type?: string - /** 比较类型 */ - compare_type?: string - /** 筛选参数 */ - expected?: string[] -} -export interface CreateSheetsSpreadsheetSheetFloatImageRequest { - /** 浮动图片 id */ - float_image_id?: string - /** 浮动图片 token，需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */ - float_image_token?: string - /** 浮动图片的左上角单元格定位，只支持一个单元格 */ - range?: string - /** 浮动图片的宽度，大于等于 20px */ - width?: number - /** 浮动图片的高度，大于等于 20px */ - height?: number - /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移，大于等于0且小于所在单元格的宽度 */ - offset_x?: number - /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移，大于等于0且小于所在单元格的高度 */ - offset_y?: number -} -export interface PatchSheetsSpreadsheetSheetFloatImageRequest { - /** 浮动图片 token，需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */ - float_image_token?: string - /** 浮动图片的左上角单元格定位，只支持一个单元格 */ - range?: string - /** 浮动图片的宽度，大于等于 20px */ - width?: number - /** 浮动图片的高度，大于等于 20px */ - height?: number - /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移，大于等于0且小于所在单元格的宽度 */ - offset_x?: number - /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移，大于等于0且小于所在单元格的高度 */ - offset_y?: number -} -export interface CopyBitableAppRequest { - /** 多维表格 App 名字 */ - name?: string - /** 多维表格 App 归属文件夹 */ - folder_token?: string - /** 不复制文档内容，只复制文档结构 */ - without_content?: boolean -} -export interface CreateBitableAppRequest { - /** 多维表格App名字 */ - name?: string - /** 多维表格App归属文件夹 */ - folder_token?: string -} -export interface UpdateBitableAppRequest { - /** 新的多维表格名字 */ - name?: string - /** 多维表格是否开启高级权限 */ - is_advanced?: boolean -} -export interface CreateBitableAppTableRequest { - /** 数据表 */ - table?: Lark.ReqTable -} -export interface BatchCreateBitableAppTableRequest { - /** tables */ - tables?: Lark.ReqTable[] -} -export interface BatchCreateBitableAppTableQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchDeleteBitableAppTableRequest { - /** 删除的多条tableid列表 */ - table_ids?: string[] -} -export interface PatchBitableAppTableRequest { - /** 数据表的新名称 */ - name?: string -} -export interface ListBitableAppTableQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface CopyBitableAppDashboardRequest { - /** 仪表盘名称 */ - name: string -} -export interface ListBitableAppDashboardQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface PatchBitableAppTableViewRequest { - /** 视图名称 */ - view_name?: string - /** 视图属性 */ - property?: Lark.AppTableViewProperty -} -export interface ListBitableAppTableViewQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateBitableAppTableViewRequest { - /** 视图名字 */ - view_name: string - /** 视图类型 */ - view_type?: string -} -export interface PatchBitableAppTableFormRequest { - /** 表单名称 */ - name?: string - /** 表单描述 */ - description?: string - /** 是否开启共享 */ - shared?: boolean - /** 分享范围限制 */ - shared_limit?: string - /** 填写次数限制一次 */ - submit_limit_once?: boolean -} -export interface PatchBitableAppTableFormFieldRequest { - /** 上一个表单问题 ID */ - pre_field_id?: string - /** 表单问题 */ - title?: string - /** 问题描述 */ - description?: string - /** 是否必填 */ - required?: boolean - /** 是否可见 */ - visible?: boolean -} -export interface ListBitableAppTableFormFieldQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface GetBitableAppTableRecordQuery { - /** 控制多行文本字段数据的返回格式, true 表示以数组形式返回 */ - text_field_as_array?: boolean - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 控制公式、查找引用是否显示完整的原样返回结果 */ - display_formula_ref?: boolean - /** 控制是否返回该记录的链接 */ - with_shared_url?: boolean - /** 控制是否返回自动计算的字段，例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`，true 表示返回 */ - automatic_fields?: boolean -} -export interface SearchBitableAppTableRecordRequest { - /** 视图Id,指定视图id则按照视图的筛选排序结果返回数据 */ - view_id?: string - /** 指定要返回的字段 */ - field_names?: string[] - /** 排序条件 */ - sort?: Lark.Sort[] - /** 筛选条件 */ - filter?: Lark.FilterInfo - /** 控制是否返回自动计算的字段, true 表示返回 */ - automatic_fields?: boolean -} -export interface SearchBitableAppTableRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface CreateBitableAppTableRecordRequest { - /** 记录字段 */ - fields: unknown -} -export interface CreateBitableAppTableRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 格式为标准的 uuid，操作的唯一标识，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ - client_token?: string -} -export interface UpdateBitableAppTableRecordRequest { - /** 记录字段 */ - fields: unknown -} -export interface UpdateBitableAppTableRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchCreateBitableAppTableRecordRequest { - /** 记录 */ - records: Lark.AppTableRecord[] -} -export interface BatchCreateBitableAppTableRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 格式为标准的 uuid，操作的唯一标识，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ - client_token?: string -} -export interface BatchUpdateBitableAppTableRecordRequest { - /** 记录 */ - records: Lark.AppTableRecord[] -} -export interface BatchUpdateBitableAppTableRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchDeleteBitableAppTableRecordRequest { - /** 删除的多条记录id列表 */ - records: string[] -} -export interface ListBitableAppTableFieldQuery { - /** 视图 ID */ - view_id?: string - /** 控制字段描述（多行文本格式）数据的返回格式, true 表示以数组富文本形式返回 */ - text_field_as_array?: boolean - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface CreateBitableAppTableFieldRequest { - /** 字段名 */ - field_name: string - /** 字段类型 */ - type: number - /** 字段属性 */ - property?: Lark.AppTableFieldProperty - /** 字段的描述 */ - description?: Lark.AppTableFieldDescription - /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ - ui_type?: string -} -export interface CreateBitableAppTableFieldQuery { - /** 格式为标准的 uuid，操作的唯一标识，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ - client_token?: string -} -export interface UpdateBitableAppTableFieldRequest { - /** 字段名 */ - field_name: string - /** 字段类型 */ - type: number - /** 字段属性 */ - property?: Lark.AppTableFieldProperty - /** 字段的描述 */ - description?: Lark.AppTableFieldDescription - /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ - ui_type?: string -} -export interface ListBitableAppRoleQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateBitableAppRoleRequest { - /** 自定义权限的名字 */ - role_name: string - /** 数据表权限 */ - table_roles: Lark.AppRoleTableRole[] - /** block权限 */ - block_roles?: Lark.AppRoleBlockRole[] -} -export interface UpdateBitableAppRoleRequest { - /** 自定义权限的名字 */ - role_name: string - /** 数据表权限 */ - table_roles: Lark.AppRoleTableRole[] - /** block权限 */ - block_roles?: Lark.AppRoleBlockRole[] -} -export interface BatchDeleteBitableAppRoleMemberRequest { - /** 协作者列表 */ - member_list: Lark.AppRoleMemberId[] -} -export interface BatchCreateBitableAppRoleMemberRequest { - /** 协作者列表 */ - member_list: Lark.AppRoleMemberId[] -} -export interface ListBitableAppRoleMemberQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateBitableAppRoleMemberRequest { - /** 协作者id */ - member_id: string -} -export interface CreateBitableAppRoleMemberQuery { - /** 协作者id类型，与请求体中的member_id要对应 */ - member_id_type?: string -} -export interface DeleteBitableAppRoleMemberQuery { - /** 协作者id类型，与请求体中的member_id要对应 */ - member_id_type?: string -} -export interface ListWikiSpaceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateWikiSpaceRequest { - /** 知识空间名称 */ - name?: string - /** 知识空间描述 */ - description?: string -} -export interface CreateWikiSpaceMemberRequest { - /** 用户id类型： “email” - 邮箱地址 “openid” - 开放平台id “openchat” - 群id “userid” - 用户id “departmentid” - 部门id */ - member_type: string - /** 用户id */ - member_id: string - /** 角色:“admin” - 管理员 “member” - 成员 */ - member_role: string -} -export interface CreateWikiSpaceMemberQuery { - /** 添加权限后是否通知对方 */ - need_notification?: boolean -} -export interface DeleteWikiSpaceMemberRequest { - /** 用户id类型： “email” - 邮箱地址 “openid” - 开放平台id “openchat” - 群id “userid” - 用户id “departmentid” - 部门id */ - member_type: string - /** 角色:“admin” - 管理员 “member” - 成员 */ - member_role: string -} -export interface UpdateWikiSpaceSettingRequest { - /** 谁可以创建空间的一级页面： "admin_and_member" = 管理员和成员 "admin" - 仅管理员 */ - create_setting?: string - /** 可阅读用户可否创建副本/打印/导出/复制： "allow" - 允许 "not_allow" - 不允许 */ - security_setting?: string - /** 可阅读用户可否评论： "allow" - 允许 "not_allow" - 不允许 */ - comment_setting?: string -} -export interface CreateWikiSpaceNodeRequest { - /** 文档类型，对于快捷方式，该字段是对应的实体的obj_type。 */ - obj_type: string - /** 父节点 token。若当前节点为一级节点，父节点 token 为空。 */ - parent_node_token?: string - /** 节点类型 */ - node_type: string - /** 快捷方式对应的实体node_token，当节点为快捷方式时，该值不为空。 */ - origin_node_token?: string - /** 文档标题 */ - title?: string -} -export interface GetNodeWikiSpaceQuery { - /** 文档的wiki token */ - token: string - /** 文档类型 */ - obj_type?: string -} -export interface ListWikiSpaceNodeQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 父节点token */ - parent_node_token?: string -} -export interface MoveWikiSpaceNodeRequest { - /** 移动到的父节点token */ - target_parent_token?: string - /** 移动到的知识空间ID */ - target_space_id?: string -} -export interface UpdateTitleWikiSpaceNodeRequest { - /** 节点新标题 */ - title: string -} -export interface CopyWikiSpaceNodeRequest { - /** 目标父节点token */ - target_parent_token?: string - /** 目标知识空间id */ - target_space_id?: string - /** 复制后的新标题。如果填空，则新标题为空。如果不填，则使用原节点标题。 */ - title?: string -} -export interface MoveDocsToWikiWikiSpaceNodeRequest { - /** 节点的父亲token */ - parent_wiki_token?: string - /** 文档类型 */ - obj_type: string - /** 文档token */ - obj_token: string - /** 没有权限时，是否申请迁入文档 */ - apply?: boolean -} -export interface GetWikiTaskQuery { - /** 任务类型 */ - task_type: string -} -export interface SearchWikiNodeRequest { - /** 搜索关键词 */ - query: string - /** 文档所属的知识空间ID，为空搜索所有 wiki */ - space_id?: string - /** wiki token，不为空搜索该节点及其所有子节点，为空搜索所有 wiki（根据 space_id 选择 space） */ - node_id?: string -} -export interface SearchWikiNodeQuery { - page_token?: string - page_size?: number -} -export interface GetDrivev1FileSubscriptionRequest { - /** 订阅关系ID */ - subscription_id?: string - /** 是否订阅 */ - subscription_type?: string - /** 是否订阅 */ - is_subcribe?: boolean - /** 文档类型 */ - file_type: string -} -export interface CreateDrivev1FileSubscriptionRequest { - /** 订阅关系ID */ - subscription_id?: string - /** 订阅类型 */ - subscription_type: string - /** 是否订阅 */ - is_subcribe?: boolean - /** 文档类型 */ - file_type: string -} -export interface PatchDrivev1FileSubscriptionRequest { - /** 是否订阅 */ - is_subscribe: boolean - /** 文档类型 */ - file_type: string -} -export interface CreateCalendarRequest { - /** 日历标题 */ - summary?: string - /** 日历描述 */ - description?: string - permissions?: string - /** 日历颜色，颜色RGB值的int32表示。客户端展示时会映射到色板上最接近的一种颜色。仅对当前身份生效 */ - color?: number - /** 日历备注名，修改或添加后仅对当前身份生效 */ - summary_alias?: string -} -export interface PrimaryCalendarQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListCalendarFreebusyRequest { - /** 查询时段开始时间，需要url编码 */ - time_min: string - /** 查询时段结束时间，需要url编码 */ - time_max: string - /** 用户user_id，输入时与 room_id 二选一。参见[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ - user_id?: string - /** 会议室room_id，输入时与 user_id 二选一 */ - room_id?: string -} -export interface ListCalendarFreebusyQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListCalendarQuery { - /** 一次请求要求返回最大数量，默认500，取值范围为[50. 1000] */ - page_size?: number - /** 上次请求Response返回的分页标记，首次请求时为空 */ - page_token?: string - /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ - sync_token?: string -} -export interface PatchCalendarRequest { - /** 日历标题 */ - summary?: string - /** 日历描述 */ - description?: string - permissions?: string - /** 日历颜色，颜色RGB值的int32表示。客户端展示时会映射到色板上最接近的一种颜色。仅对当前身份生效 */ - color?: number - /** 日历备注名，修改或添加后仅对当前身份生效 */ - summary_alias?: string -} -export interface SearchCalendarRequest { - /** 搜索关键字 */ - query: string -} -export interface SearchCalendarQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface CreateCalendarCalendarAclRequest { - /** 对日历的访问权限 */ - role: string - /** 权限范围 */ - scope: Lark.AclScope -} -export interface CreateCalendarCalendarAclQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListCalendarCalendarAclQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface CreateCalendarCalendarEventRequest { - /** 日程标题 */ - summary?: string - /** 日程描述 */ - description?: string - /** 是否发送通知消息 */ - need_notification?: boolean - /** 日程开始时间 */ - start_time: Lark.TimeInfo - /** 日程结束时间 */ - end_time: Lark.TimeInfo - /** 视频会议信息，仅当日程至少有一位attendee时生效 */ - vchat?: Lark.Vchat - /** 日程公开范围，新建日程默认为Default；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ - visibility?: string - /** 参与人权限 */ - attendee_ability?: string - /** 日程占用的忙闲状态，新建日程默认为Busy；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ - free_busy_status?: string - /** 日程地点 */ - location?: Lark.EventLocation - /** 日程颜色，颜色RGB值的int32表示。仅对当前身份生效；客户端展示时会映射到色板上最接近的一种颜色；值为0或-1时默认跟随日历颜色。 */ - color?: number - /** 日程提醒列表 */ - reminders?: Lark.Reminder[] - /** 重复日程的重复性规则 */ - recurrence?: string - /** 日程自定义信息 */ - schemas?: Lark.Schema[] -} -export interface CreateCalendarCalendarEventQuery { - /** 幂等唯一key */ - idempotency_key?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteCalendarCalendarEventQuery { - /** 删除日程是否给日程参与人发送bot通知，默认为true */ - need_notification?: boolean -} -export interface PatchCalendarCalendarEventRequest { - /** 日程标题 */ - summary?: string - /** 日程描述 */ - description?: string - /** 是否发送通知消息 */ - need_notification?: boolean - /** 日程开始时间 */ - start_time?: Lark.TimeInfo - /** 日程结束时间 */ - end_time?: Lark.TimeInfo - /** 视频会议信息，仅当日程至少有一位attendee时生效 */ - vchat?: Lark.Vchat - /** 日程公开范围，新建日程默认为Default；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ - visibility?: string - /** 参与人权限 */ - attendee_ability?: string - /** 日程占用的忙闲状态，新建日程默认为Busy；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ - free_busy_status?: string - /** 日程地点 */ - location?: Lark.EventLocation - /** 日程颜色，颜色RGB值的int32表示。仅对当前身份生效；客户端展示时会映射到色板上最接近的一种颜色；值为0或-1时默认跟随日历颜色。 */ - color?: number - /** 日程提醒列表 */ - reminders?: Lark.Reminder[] - /** 重复日程的重复性规则 */ - recurrence?: string - /** 日程自定义信息 */ - schemas?: Lark.Schema[] -} -export interface PatchCalendarCalendarEventQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetCalendarCalendarEventQuery { - /** 是否需要返回会前设置 */ - need_meeting_settings?: boolean - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListCalendarCalendarEventQuery { - /** 一次请求要求返回最大数量，默认500，取值范围为[50, 1000] */ - page_size?: number - /** 拉取anchor_time之后的日程，为timestamp */ - anchor_time?: string - /** 上次请求Response返回的分页标记，首次请求时为空 */ - page_token?: string - /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ - sync_token?: string - /** 日程开始Unix时间戳，单位为秒 */ - start_time?: string - /** 日程结束Unix时间戳，单位为秒 */ - end_time?: string -} -export interface SearchCalendarCalendarEventRequest { - /** 搜索关键字 */ - query: string - /** 搜索过滤器 */ - filter?: Lark.EventSearchFilter -} -export interface SearchCalendarCalendarEventQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface ReplyCalendarCalendarEventRequest { - /** rsvp状态 */ - rsvp_status: string -} -export interface InstancesCalendarCalendarEventQuery { - /** 日程实例开始Unix时间戳，单位为秒,日程的end_time的下限（不包含） */ - start_time: string - /** 日程实例结束Unix时间戳，单位为秒,日程的start_time上限（不包含） */ - end_time: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface InstanceViewCalendarCalendarEventQuery { - /** 日程开始Unix时间戳，单位为秒 */ - start_time: string - /** 日程结束Unix时间戳，单位为秒 */ - end_time: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteCalendarCalendarEventMeetingChatQuery { - /** 会议群ID */ - meeting_chat_id: string -} -export interface CreateCalendarTimeoffEventRequest { - /** 用户的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 CreateCalendarTimeoffEventQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateCalendarCalendarEventAttendeeRequest { - /** 新增参与人列表；
- - 单次请求会议室的数量限制为100。 */ - attendees?: Lark.CalendarEventAttendee[] - /** 是否给参与人发送bot通知 默认为true */ - need_notification?: boolean - /** 使用管理员身份访问时要修改的实例(仅用于重复日程修改其中的一个实例，非重复日程无需填此字段) */ - instance_start_time_admin?: string - /** 是否启用管理员身份(需先在管理后台设置某人为会议室管理员) */ - is_enable_admin?: boolean - /** 是否添加会议室operate_id标识的用户到参与人 */ - add_operator_to_attendee?: boolean -} -export interface CreateCalendarCalendarEventAttendeeQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchDeleteCalendarCalendarEventAttendeeRequest { - /** 要移除的参与人 ID 列表。参见[参与人ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/introduction#4998889c) */ - attendee_ids?: string[] - /** 需要删除的参与人类型实体ID，作为attendee_ids字段的补充。 */ - delete_ids?: Lark.CalendarEventAttendeeId[] - /** 删除日程参与人时是否要给参与人发送bot通知，默认为true */ - need_notification?: boolean - /** 使用管理员身份访问时要修改的实例 */ - instance_start_time_admin?: string - /** 是否启用管理员身份(需先在管理后台设置某人为会议室管理员) */ - is_enable_admin?: boolean -} -export interface BatchDeleteCalendarCalendarEventAttendeeQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListCalendarCalendarEventAttendeeQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 是否需要会议室表单信息 */ - need_resource_customization?: boolean - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface ListCalendarCalendarEventAttendeeChatMemberQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GenerateCaldavConfCalendarSettingRequest { - /** 需要同步日历的设备名，在日历中展示用来管理密码 */ - device_name?: string -} -export interface CreateCalendarExchangeBindingRequest { - /** admin账户 */ - admin_account?: string - /** 用户绑定的Exchange账户 */ - exchange_account?: string - /** Exchange账户绑定user唯一标识id */ - user_id?: string -} -export interface CreateCalendarExchangeBindingQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetCalendarExchangeBindingQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ApplyVcReserveRequest { - /** 预约到期时间（unix时间，单位sec），多人会议必填 */ - end_time?: string - /** 指定会议归属人，使用tenant_access_token时生效且必传，使用user_access_token时不生效，必须指定为同租户下的合法lark用户 */ - owner_id?: string - /** 会议设置 */ - meeting_settings: Lark.ReserveMeetingSetting -} -export interface ApplyVcReserveQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface UpdateVcReserveRequest { - /** 预约到期时间（unix时间，单位sec） */ - end_time?: string - /** 会议设置 */ - meeting_settings?: Lark.ReserveMeetingSetting -} -export interface UpdateVcReserveQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface GetVcReserveQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetActiveMeetingVcReserveQuery { - /** 是否需要参会人列表，默认为false */ - with_participants?: boolean - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface InviteVcMeetingRequest { - /** 被邀请的用户列表 */ - invitees: Lark.MeetingUser[] -} -export interface InviteVcMeetingQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface KickoutVcMeetingRequest { - /** 需踢出的用户列表 */ - kickout_users: Lark.MeetingUser[] -} -export interface KickoutVcMeetingQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface SetHostVcMeetingRequest { - /** 将要设置的主持人 */ - host_user: Lark.MeetingUser - /** 当前主持人（CAS并发安全：如果和会中当前主持人不符则会设置失败，可使用返回的最新数据重新设置） */ - old_host_user?: Lark.MeetingUser -} -export interface SetHostVcMeetingQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface GetVcMeetingQuery { - /** 是否需要参会人列表 */ - with_participants?: boolean - /** 是否需要会中使用能力统计（仅限tenant_access_token） */ - with_meeting_ability?: boolean - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface ListByNoVcMeetingQuery { - /** 9位会议号 */ - meeting_no: string - /** 查询开始时间（unix时间，单位sec） */ - start_time: string - /** 查询结束时间（unix时间，单位sec） */ - end_time: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface StartVcMeetingRecordingRequest { - /** 录制文件时间显示使用的时区[-12,12] */ - timezone?: number -} -export interface SetPermissionVcMeetingRecordingRequest { - /** 授权对象列表 */ - permission_objects: Lark.RecordingPermissionObject[] - /** 授权或者取消授权，默认授权 */ - action_type?: number -} -export interface SetPermissionVcMeetingRecordingQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface GetDailyVcReportQuery { - /** 开始时间（unix时间，单位sec） */ - start_time: string - /** 结束时间（unix时间，单位sec） */ - end_time: string -} -export interface GetTopUserVcReportQuery { - /** 开始时间（unix时间，单位sec） */ - start_time: string - /** 结束时间（unix时间，单位sec） */ - end_time: string - /** 取前多少位 */ - limit: number - /** 排序依据（降序） */ - order_by: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface MeetingListVcExportRequest { - /** 查询开始时间（unix时间，单位sec） */ - start_time: string - /** 查询结束时间（unix时间，单位sec） */ - end_time: string - /** 按9位会议号筛选（最多一个筛选条件） */ - meeting_no?: string - /** 按参会Lark用户筛选（最多一个筛选条件） */ - user_id?: string - /** 按参会Rooms筛选（最多一个筛选条件） */ - room_id?: string -} -export interface MeetingListVcExportQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface ParticipantListVcExportRequest { - /** 会议开始时间（unix时间，单位sec） */ - meeting_start_time: string - /** 会议结束时间（unix时间，单位sec） */ - meeting_end_time: string - /** 9位会议号 */ - meeting_no: string - /** 按参会Lark用户筛选（最多一个筛选条件） */ - user_id?: string - /** 按参会Rooms筛选（最多一个筛选条件） */ - room_id?: string -} -export interface ParticipantListVcExportQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface ParticipantQualityListVcExportRequest { - /** 会议开始时间（unix时间，单位sec） */ - meeting_start_time: string - /** 会议结束时间（unix时间，单位sec） */ - meeting_end_time: string - /** 9位会议号 */ - meeting_no: string - /** 参会人入会时间（unix时间，单位sec） */ - join_time: string - /** 参会人为Lark用户时填入 */ - user_id?: string - /** 参会人为Rooms时填入 */ - room_id?: string -} -export interface ParticipantQualityListVcExportQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface ResourceReservationListVcExportRequest { - /** 层级id */ - room_level_id: string - /** 是否展示会议主题 */ - need_topic?: boolean - /** 查询开始时间（unix时间，单位sec） */ - start_time: string - /** 查询结束时间（unix时间，单位sec） */ - end_time: string - /** 待筛选的会议室id列表 */ - room_ids?: string[] - /** 若为true表示导出room_ids范围外的会议室，默认为false */ - is_exclude?: boolean -} -export interface DownloadVcExportQuery { - /** 文档token */ - file_token: string -} -export interface CreateVcRoomLevelRequest { - /** 层级名称 */ - name: string - /** 父层级ID */ - parent_id: string - /** 自定义层级ID */ - custom_group_id?: string -} -export interface DelVcRoomLevelRequest { - /** 层级ID */ - room_level_id: string - /** 是否删除所有子层级 */ - delete_child?: boolean -} -export interface PatchVcRoomLevelRequest { - /** 层级名称 */ - name: string - /** 父层级ID */ - parent_id: string - /** 自定义层级ID */ - custom_group_id?: string -} -export interface MgetVcRoomLevelRequest { - /** 层级id列表 */ - level_ids: string[] -} -export interface ListVcRoomLevelQuery { - /** 层级ID，不传则返回该租户下第一层级列表 */ - room_level_id?: string - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string -} -export interface SearchVcRoomLevelQuery { - /** 用于查询指定会议室的租户自定义会议室ID */ - custom_level_ids: string -} -export interface CreateVcRoomRequest { - /** 会议室名称 */ - name: string - /** 会议室能容纳的人数 */ - capacity: number - /** 会议室的相关描述 */ - description?: string - /** 自定义的会议室ID */ - custom_room_id?: string - /** 层级ID */ - room_level_id: string - /** 会议室状态 */ - room_status?: Lark.RoomStatus - /** 设施信息列表 */ - device?: Lark.Device[] -} -export interface CreateVcRoomQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface PatchVcRoomRequest { - /** 会议室名称 */ - name?: string - /** 会议室能容纳的人数 */ - capacity?: number - /** 会议室的相关描述 */ - description?: string - /** 自定义的会议室ID */ - custom_room_id?: string - /** 层级ID */ - room_level_id?: string - /** 会议室状态 */ - room_status?: Lark.RoomStatus - /** 设施信息列表 */ - device?: Lark.Device[] -} -export interface PatchVcRoomQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface GetVcRoomQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface MgetVcRoomRequest { - /** 会议室id列表 */ - room_ids: string[] -} -export interface MgetVcRoomQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface ListVcRoomQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 层级ID，不传则返回该租户下的所有会议室 */ - room_level_id?: string - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface SearchVcRoomRequest { - /** 用于查询指定会议室的租户自定义会议室ID列表，优先使用该字段进行查询 */ - custom_room_ids?: string[] - /** 会议室搜索关键词（当custom_room_ids为空时，使用该字段进行查询） */ - keyword?: string - /** 在该会议室层级下进行搜索 */ - room_level_id?: string - /** 搜索会议室是否包括层级名称 */ - search_level_name?: boolean - /** 分页大小，该值默认为10，最大为100 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface SearchVcRoomQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface GetVcScopeConfigQuery { - /** 查询节点范围 */ - scope_type: number - /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */ - scope_id: string - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface CreateVcScopeConfigRequest { - /** 查询节点范围 */ - scope_type: number - /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */ - scope_id: string - /** 节点配置 */ - scope_config?: Lark.RoomConfig -} -export interface CreateVcScopeConfigQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface ReserveScopeVcReserveConfigQuery { - /** 会议室或层级id */ - scope_id: string - /** 1代表层级，2代表会议室 */ - scope_type: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchVcReserveConfigRequest { - /** 1代表层级，2代表会议室 */ - scope_type: string - /** 预定审批设置 */ - approval_config?: Lark.ApprovalConfig - /** 预定时间设置 */ - time_config?: Lark.TimeConfig - /** 预定范围设置 */ - reserve_scope_config?: Lark.ReserveScopeConfig -} -export interface PatchVcReserveConfigQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetVcReserveConfigFormQuery { - /** 1代表层级，2代表会议室 */ - scope_type: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchVcReserveConfigFormRequest { - /** 1代表层级，2代表会议室 */ - scope_type: number - /** 预定表单设置 */ - reserve_form_config: Lark.ReserveFormConfig -} -export interface PatchVcReserveConfigFormQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetVcReserveConfigAdminQuery { - /** 会议室或层级 */ - scope_type: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchVcReserveConfigAdminRequest { - /** 1代表层级，2代表会议室 */ - scope_type: number - /** 预定管理员或部门 */ - reserve_admin_config: Lark.ReserveAdminConfig -} -export interface PatchVcReserveConfigAdminQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetVcReserveConfigDisableInformQuery { - /** 1表示层级，2表示会议室 */ - scope_type: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchVcReserveConfigDisableInformRequest { - /** 1表示会议室层级，2表示会议室 */ - scope_type: number - /** 禁用通知配置 */ - disable_inform: Lark.DisableInformConfig -} -export interface PatchVcReserveConfigDisableInformQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetVcMeetingListQuery { - /** 查询开始时间（unix时间，单位sec） */ - start_time: string - /** 查询结束时间（unix时间，单位sec） */ - end_time: string - /** 按9位会议号筛选（最多一个筛选条件） */ - meeting_no?: string - /** 按参会Lark用户筛选（最多一个筛选条件） */ - user_id?: string - /** 按参会Rooms筛选（最多一个筛选条件） */ - room_id?: string - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetVcParticipantListQuery { - /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */ - meeting_start_time: string - /** 会议结束时间（unix时间，单位sec） */ - meeting_end_time: string - /** 9位会议号 */ - meeting_no: string - /** 按参会Lark用户筛选（最多一个筛选条件） */ - user_id?: string - /** 按参会Rooms筛选（最多一个筛选条件） */ - room_id?: string - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetVcParticipantQualityListQuery { - /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */ - meeting_start_time: string - /** 会议结束时间（unix时间，单位sec） */ - meeting_end_time: string - /** 9位会议号 */ - meeting_no: string - /** 参会人入会时间（unix时间，单位sec） */ - join_time: string - /** 参会人为Lark用户时填入 */ - user_id?: string - /** 参会人为Rooms时填入 */ - room_id?: string - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetVcResourceReservationListQuery { - /** 层级id */ - room_level_id: string - /** 是否展示会议主题 */ - need_topic?: boolean - /** 查询开始时间（unix时间，单位sec） */ - start_time: string - /** 查询结束时间（unix时间，单位sec） */ - end_time: string - /** 待筛选的会议室id列表 */ - room_ids: string[] - /** 若为true表示导出room_ids范围外的会议室，默认为false */ - is_exclude?: boolean - /** 分页尺寸大小 */ - page_size?: number - /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ - page_token?: string -} -export interface ListVcAlertQuery { - /** 开始时间（unix时间，单位sec） */ - start_time: string - /** 结束时间（unix时间，单位sec） */ - end_time: string - /** 查询对象类型 */ - query_type?: number - /** 查询对象ID */ - query_value?: string - /** 请求期望返回的告警记录数量，不足则返回全部，该值默认为 100，最大为 1000 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateAttendanceShiftRequest { - /** 班次名称 */ - shift_name: string - /** 打卡次数 */ - punch_times: number - /** 排班组子负责人id列表 */ - sub_shift_leader_ids?: string[] - /** 是否弹性打卡 */ - is_flexible?: boolean - /** 弹性打卡时间，设置【上班最多可晚到】与【下班最多可早走】时间，如果不设置flexible_rule则生效 */ - flexible_minutes?: number - /** 弹性打卡时间设置 */ - flexible_rule?: Lark.FlexibleRule[] - /** 不需要打下班卡 */ - no_need_off?: boolean - /** 打卡规则 */ - punch_time_rule: Lark.PunchTimeRule[] - /** 晚走晚到规则 */ - late_off_late_on_rule?: Lark.LateOffLateOnRule[] - /** 休息规则 */ - rest_time_rule?: Lark.RestRule[] - /** 打卡规则 */ - overtime_rule?: Lark.OvertimeRule[] - /** 是否允许在非打卡时段申请打卡 */ - allow_punch_approval?: boolean -} -export interface QueryAttendanceShiftQuery { - /** 班次名称 */ - shift_name: string -} -export interface ListAttendanceShiftQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateAttendanceGroupRequest { - /** 6921319402260496386 */ - group: Lark.Group - /** 操作人uid，如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines)，则此字段为必填字段 */ - operator_id?: string -} -export interface CreateAttendanceGroupQuery { - /** 用户 ID 的类型 */ - employee_type: string - /** 部门 ID 的类型 */ - dept_type: string -} -export interface GetAttendanceGroupQuery { - /** 用户 ID 的类型 */ - employee_type: string - /** 部门 ID 的类型 */ - dept_type: string -} -export interface SearchAttendanceGroupRequest { - /** 考勤组名称 */ - group_name: string -} -export interface ListAttendanceGroupQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface BatchCreateAttendanceUserDailyShiftRequest { - /** 班表信息列表 */ - user_daily_shifts: Lark.UserDailyShift[] - /** 操作人uid，如果您未操作[考勤管理后台“API 接入”流程](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines)，则此字段为必填字段 */ - operator_id?: string -} -export interface BatchCreateAttendanceUserDailyShiftQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -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: string -} -export interface UpdateAttendanceUserStatsViewRequest { - /** 统计设置 */ - view: Lark.UserStatsView -} -export interface UpdateAttendanceUserStatsViewQuery { - /** 员工工号类型 */ - employee_type: string -} -export interface QueryAttendanceUserStatsFieldRequest { - /** 语言类型 */ - locale: string - /** 统计类型 */ - stats_type: string - /** 开始时间 */ - start_date: number - /** 结束时间（时间间隔不超过 40 天） */ - end_date: number -} -export interface QueryAttendanceUserStatsFieldQuery { - /** 响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -export interface QueryAttendanceUserStatsViewRequest { - /** 语言类型 */ - locale: string - /** 统计类型 */ - stats_type: string - /** 查询用户id，同【查询统计数据】、【更新统计设置】user_id */ - user_id?: string -} -export interface QueryAttendanceUserStatsViewQuery { - /** 响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -export interface QueryAttendanceUserStatsDataRequest { - /** 语言类型 */ - locale: string - /** 统计类型 */ - stats_type: string - /** 开始时间 */ - 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: string -} -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?: string - /** 查询状态（不填默认查询已通过状态） */ - status?: number - /** 查询的起始时间，精确到秒的时间戳 */ - check_time_from?: string - /** 查询的结束时间，精确到秒的时间戳 */ - check_time_to?: string -} -export interface QueryAttendanceUserApprovalQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -export interface CreateAttendanceUserApprovalRequest { - /** 审批信息 */ - user_approval?: Lark.UserApproval -} -export interface CreateAttendanceUserApprovalQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -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: string -} -export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyRequest { - /** 用户 ID */ - user_id: string - /** 补卡日期 */ - remedy_date: number -} -export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -export interface QueryAttendanceUserTaskRemedyRequest { - /** employee_no 或 employee_id 列表 */ - user_ids: string[] - /** 查询的起始时间，精确到秒的时间戳 */ - check_time_from: string - /** 查询的结束时间，精确到秒的时间戳 */ - check_time_to: string - /** 查询依据的时间类型（不填默认依据PeriodTime） */ - check_date_type?: string - /** 查询状态（不填默认查询已通过状态） */ - status?: number -} -export interface QueryAttendanceUserTaskRemedyQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -export interface BatchCreateAttendanceUserFlowRequest { - /** 打卡流水记录列表 */ - flow_records: Lark.UserFlow[] -} -export interface BatchCreateAttendanceUserFlowQuery { - /** 请求体和响应体中的 user_id 和 creator_id 的员工工号类型 */ - employee_type: string -} -export interface GetAttendanceUserFlowQuery { - /** 响应体中的 user_id 和 creator_id 的员工工号类型 */ - employee_type: 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: string - /** 由于新入职用户可以复用已离职用户的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: string - /** 是否忽略无效和没有权限的用户。如果 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 ModifyAttendanceUserSettingRequest { - /** 用户设置 */ - user_setting?: Lark.UserSetting -} -export interface ModifyAttendanceUserSettingQuery { - /** 请求体和响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -export interface QueryAttendanceUserSettingRequest { - /** employee_no 或 employee_id 列表 */ - user_ids: string[] -} -export interface QueryAttendanceUserSettingQuery { - /** 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 */ - employee_type: string -} -export interface UploadAttendanceFileForm { - /** 文件内容 */ - file?: Blob -} -export interface UploadAttendanceFileQuery { - /** 带后缀的文件名 */ - file_name: 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?: string -} -export interface PatchAttendanceLeaveAccrualRecordRequest { - /** 授予记录的唯一ID */ - leave_granting_record_id: string - /** 员工ID */ - employment_id: string - /** 假期类型ID */ - leave_type_id: string - /** 修改授予记录原因 */ - reason: Lark.LangText[] - /** 时间偏移，东八区：480 8*60 */ - time_offset?: number - /** 失效日期，格式"2020-01-01" */ - expiration_date?: string - /** 修改source 余额 */ - quantity?: string -} -export interface PatchAttendanceLeaveAccrualRecordQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface CreateApprovalRequest { - /** 审批名称的国际化文案 Key，以 @i18n@ 开头，长度不得少于 9 个字符 */ - approval_name: string - /** 传空表示新建 */ - approval_code?: string - /** 审批描述的国际化文案 Key，以 @i18n@ 开头，长度不得少于 9 个字符 */ - description?: string - /** viewers 字段指定了哪些人能从审批应用的前台发起该审批。 当 view_type 为 USER，需要填写viewer_user_id； 当 view_type 为DEPARTMENT，需要填写viewer_department_id； 当 view_type 为TENANT或NONE时，viewer_user_id和viewer_department_id无需填写 */ - viewers: Lark.ApprovalCreateViewers[] - /** 审批定义表单内容，json 数组 */ - form: Lark.ApprovalForm - /** 审批定义节点，需要将开始节点作为 list 第一个元素，结束节点作为最后一个元素 */ - node_list: Lark.ApprovalNode[] - /** 审批定义其他设置 */ - settings?: Lark.ApprovalSetting - /** 审批定义配置项，用于配置对应审批定义是否可以由用户在审批后台进行修改 */ - config?: Lark.ApprovalConfig - /** 审批图标枚举，详见下方说明，默认为 0 */ - icon?: number - /** 国际化文案 */ - i18n_resources: Lark.I18nResource[] - /** 流程负责人 */ - process_manager_ids?: string[] -} -export interface CreateApprovalQuery { - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateApprovalInstanceRequest { - /** 审批定义 code */ - approval_code: string - /** 发起审批用户 */ - user_id?: string - /** 发起审批用户 open id, 如果传了 user_id 则优先使用 user_id */ - open_id?: string - /** 发起审批用户部门id，如果用户只属于一个部门，可以不填。如果属于多个部门，默认会选择部门列表第一个部门 */ - department_id?: string - /** json 数组，控件值 */ - form: string - /** 如果有发起人自选节点，则需要填写对应节点的审批人 */ - node_approver_user_id_list?: Lark.NodeApprover[] - /** 审批人发起人自选 open id，与上述node_approver_user_id_list字段取并集 */ - node_approver_open_id_list?: Lark.NodeApprover[] - /** 如果有发起人自选节点，则可填写对应节点的抄送人，单个节点最多选择20位抄送人 */ - node_cc_user_id_list?: Lark.NodeCc[] - /** 抄送人发起人自选 open id 单个节点最多选择20位抄送人 */ - node_cc_open_id_list?: Lark.NodeCc[] - /** 审批实例 uuid，用于幂等操作, 每个租户下面的唯一key，同一个 uuid 只能用于创建一个审批实例，如果冲突，返回错误码 60012 ，格式建议为 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX，不区分大小写 */ - uuid?: string - /** 可配置是否可以再次提交 */ - allow_resubmit?: boolean - /** 可配置是否可以重新提交 */ - allow_submit_again?: boolean - /** 配置bot是否取消通知结果 */ - cancel_bot_notification?: string - /** 配置是否可以禁止撤销 */ - forbid_revoke?: boolean - /** 国际化文案 */ - i18n_resources?: Lark.I18nResource[] - /** 审批展示名称，如果填写了该字段，则审批列表中的审批名称使用该字段，如果不填该字段，则审批名称使用审批定义的名称 */ - title?: string - /** 详情页title展示模式 */ - title_display_method?: number -} -export interface CancelApprovalInstanceRequest { - /** 审批定义Code */ - approval_code: string - /** 审批实例Code */ - instance_code: string - /** 操作用户, 根据user_id_type填写 */ - user_id: string -} -export interface CancelApprovalInstanceQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CcApprovalInstanceRequest { - /** 审批定义 code */ - approval_code: string - /** 审批实例 code */ - instance_code: string - /** 根据user_id_type填写发起抄送的人的用户id */ - user_id: string - /** 根据user_id_type填写被抄送人的 用户id 列表 */ - cc_user_ids: string[] - /** 抄送留言 */ - comment?: string -} -export interface CcApprovalInstanceQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PreviewApprovalInstanceRequest { - /** 用户id */ - user_id: string - /** 审批定义code */ - approval_code?: string - /** 部门id */ - department_id?: string - /** 表单数据 */ - form?: string - /** 审批实例code */ - instance_code?: string - /** 语言类型 */ - locale?: string - /** 任务id */ - task_id?: string -} -export interface PreviewApprovalInstanceQuery { - /** open_id(ou_开头)，union_id(on_开头)，user_id(字符串)。user_id_type不填默认为open_id */ - user_id_type?: string -} -export interface GetApprovalInstanceQuery { - /** 语言 */ - locale?: string - /** 发起审批用户id，仅自建应用可返回 */ - user_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListApprovalInstanceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 审批定义唯一标识 */ - approval_code: string - /** 审批实例创建时间区间（毫秒） */ - start_time: string - /** 审批实例创建时间区间（毫秒） */ - end_time: string -} -export interface ApproveApprovalTaskRequest { - /** 审批定义 Code */ - approval_code: string - /** 审批实例 Code */ - instance_code: string - /** 根据user_id_type填写操作用户id */ - user_id: string - /** 意见 */ - comment?: string - /** 任务 ID， 审批实例详情task_list中id */ - task_id: string - /** json 数组，控件值 */ - form?: string -} -export interface ApproveApprovalTaskQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface RejectApprovalTaskRequest { - /** 审批定义 Code */ - approval_code: string - /** 审批实例 Code */ - instance_code: string - /** 根据user_id_type填写操作用户id */ - user_id: string - /** 意见 */ - comment?: string - /** 任务 ID， 审批实例详情task_list中id */ - task_id: string - /** json 数组，控件值 */ - form?: string -} -export interface RejectApprovalTaskQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface TransferApprovalTaskRequest { - /** 审批定义 Code */ - approval_code: string - /** 审批实例 Code */ - instance_code: string - /** 根据user_id_type填写操作用户id */ - user_id: string - /** 意见 */ - comment?: string - /** 根据user_id_type填写被转交人唯一 ID */ - transfer_user_id: string - /** 任务 ID， 审批实例详情task_list中id */ - task_id: string -} -export interface TransferApprovalTaskQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface SpecifiedRollbackApprovalInstanceRequest { - /** 用户ID */ - user_id: string - /** 回退的任务ID */ - task_id: string - /** 退回原因 */ - reason?: string - /** 扩展字段 */ - extra?: string - /** 退回到节点列表 */ - task_def_key_list: string[] -} -export interface SpecifiedRollbackApprovalInstanceQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface AddSignApprovalInstanceRequest { - /** 操作用户id */ - user_id: string - /** 审批定义code */ - approval_code: string - /** 审批实例code */ - instance_code: string - /** 任务id */ - task_id: string - /** 意见 */ - comment?: string - /** 被加签人id */ - add_sign_user_ids: string[] - /** 1/2/3分别代表前加签/后加签/并加签 */ - add_sign_type: number - /** 仅在前加签、后加签时需要填写，1/2 分别代表或签/会签 */ - approval_method?: number -} -export interface ResubmitApprovalTaskRequest { - /** 审批定义 Code */ - approval_code: string - /** 审批实例 Code */ - instance_code: string - /** 根据user_id_type填写操作用户id */ - user_id: string - /** 意见 */ - comment?: string - /** 任务 ID， 审批实例详情task_list中id */ - task_id: string - /** json 数组，控件值 */ - form: string -} -export interface ResubmitApprovalTaskQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateApprovalInstanceCommentRequest { - /** 评论内容，包含艾特人、附件等 */ - content?: string - /** 评论中艾特人信息 */ - at_info_list?: Lark.CommentAtInfo[] - /** 父评论ID，如果是回复评论，需要传 */ - parent_comment_id?: string - /** 评论ID，如果是编辑、删除一条评论，需要传 */ - comment_id?: string - /** disable_bot=true只同步数据，不触发bot */ - disable_bot?: boolean - /** 附加字段 */ - extra?: string -} -export interface CreateApprovalInstanceCommentQuery { - /** 用户ID类型，不填默认为open_id */ - user_id_type?: string - /** 用户ID */ - user_id: string -} -export interface DeleteApprovalInstanceCommentQuery { - /** 用户ID类型，不填默认为open_id */ - user_id_type?: string - /** 根据user_id_type填写用户ID */ - user_id: string -} -export interface RemoveApprovalInstanceCommentQuery { - /** 用户ID类型，不填默认为open_id */ - user_id_type?: string - /** 根据user_id_type填写用户ID */ - user_id?: string -} -export interface ListApprovalInstanceCommentQuery { - /** 用户ID类型，不填默认为open_id */ - user_id_type?: string - /** 用户ID */ - user_id: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface CreateApprovalExternalApprovalRequest { - /** 审批定义名称，创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段。 */ - approval_name: string - /** 审批定义 code，用户自定义，定义的唯一标识，如果不存在该 code，则创建，否则更新 */ - approval_code: string - /** 审批定义所属审批分组，用户自定义； 如果group_code当前不存在，则会新建审批分组； 如果group_code已经存在，则会使用group_name更新审批分组名称 */ - group_code: string - /** 分组名称，值的格式是 i18n key，文案放在 i18n_resource； 如果是 group_code 当前不存在，则该 group_name 必填，否则，如果填写了则会更新分组名称，不填则不更新分组名称； 审批发起页 审批定义的分组名称来自该字段 */ - group_name?: string - /** 审批定义的说明，值的格式是 i18n key，文案放在 i18n_resource； 审批发起页 审批定义的说明内容来自该字段 */ - description?: string - /** 三方审批相关 */ - external: Lark.ApprovalCreateExternal - /** 可见人列表，可通知配置多个可见人，只有在配置的范围内用户可以在审批发起也看到该审批，默认不传，则是任何人不可见 */ - viewers?: Lark.ApprovalCreateViewers[] - /** 国际化文案 */ - i18n_resources?: Lark.I18nResource[] - /** 根据user_id_type填写流程管理员id */ - managers?: string[] -} -export interface CreateApprovalExternalApprovalQuery { - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetApprovalExternalApprovalQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateApprovalExternalInstanceRequest { - /** 审批定义 code， 创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段 */ - approval_code: string - /** 审批实例状态 */ - status: string - /** 审批实例扩展 JSON */ - extra?: string - /** 审批实例唯一标识，用户自定义，需确保证租户、应用下唯一 */ - instance_id: string - /** 审批实例链接集合 ，用于【已发起】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ - links: Lark.ExternalInstanceLink - /** 审批展示名称，如果填写了该字段，则审批列表中的审批名称使用该字段，如果不填该字段，则审批名称使用审批定义的名称 */ - title?: string - /** 用户提交审批时填写的表单数据，用于所有审批列表中展示。可传多个值，但审批中心pc展示前2个,移动端展示前3个,长度不超过2048字符 */ - form?: Lark.ExternalInstanceForm[] - /** 审批发起人 user_id，发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】，【已审批】【抄送我】列表中，该字段展示审批是谁发起的。审批发起人 open id，和 user id 二选一。 */ - user_id?: string - /** 审批发起人 用户名，如果发起人不是真实的用户（例如是某个部门），没有 user_id，则可以使用该字段传名称 */ - user_name?: string - /** 审批发起人 open id，和 user id 二选一 */ - open_id?: string - /** 发起人部门，用于列表中展示发起人所属部门。不传则不展示。如果用户没加入任何部门，传 ""，将展示租户名称传 department_name 展示部门名称 */ - department_id?: string - /** 审批发起人 部门，如果发起人不是真实的用户（例如是某个部门），没有 department_id，则可以使用该字段传名称 */ - department_name?: string - /** 审批发起时间，Unix毫秒时间戳 */ - start_time: string - /** 审批实例结束时间：未结束的审批为 0，Unix毫秒时间戳 */ - end_time: string - /** 审批实例最近更新时间；用于推送数据版本控制如果 update_mode 值为 UPDATE，则只有传过来的 update_time 有变化时（变大），才会更新审批中心中的审批实例信息。使用该字段主要用来避免并发时老的数据更新了新的数据 */ - update_time: string - /** 列表页打开审批实例的方式 */ - display_method?: string - /** 更新方式， 当 update_mode=REPLACE时，每次都以当前推送的数据为最终数据，会删掉审批中心中多余的任务、抄送数据（不在这次推送的数据中）; 当 update_mode=UPDATE时，则不会删除审批中心的数据，而只是进行新增和更新实例、任务数据 */ - update_mode?: string - /** 任务列表 */ - task_list?: Lark.ExternalInstanceTaskNode[] - /** 抄送列表 */ - cc_list?: Lark.CcNode[] - /** 国际化文案 */ - i18n_resources: Lark.I18nResource[] - /** 单据托管认证token，托管回调会附带此token，帮助业务方认证 */ - trusteeship_url_token?: string - /** 用户的类型，会影响请求参数用户标识域的选择，包括加签操作回传的目标用户， 目前仅支持 "user_id" */ - trusteeship_user_id_type?: string - /** 单据托管回调接入方的接口的URL地址 */ - trusteeship_urls?: Lark.TrusteeshipUrls - /** 托管预缓存策略 */ - trusteeship_cache_config?: Lark.TrusteeshipInstanceCacheConfig -} -export interface CheckApprovalExternalInstanceRequest { - /** 校验的实例信息 */ - instances: Lark.ExteranlInstanceCheck[] -} -export interface ListApprovalExternalTaskRequest { - /** 审批定义 Code，用于指定只获取这些定义下的数据 */ - approval_codes?: string[] - /** 审批实例 ID, 用于指定只获取这些实例下的数据，最多支持 20 个 */ - instance_ids?: string[] - /** 审批人 user_id，用于指定只获取这些用户的数据 */ - user_ids?: string[] - /** 审批任务状态，用于指定获取该状态下的数据 */ - status?: string -} -export interface ListApprovalExternalTaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface QueryApprovalInstanceRequest { - /** 根据x_user_type填写用户 id */ - user_id?: string - /** 审批定义 code */ - approval_code?: string - /** 审批实例 code */ - instance_code?: string - /** 审批实例第三方 id 注：和 approval_code 取并集 */ - instance_external_id?: string - /** 审批定义分组第三方 id 注：和 instance_code 取并集 */ - group_external_id?: string - /** 审批实例标题（只有第三方审批有） */ - instance_title?: string - /** 审批实例状态，注：若不在集合中，报错 */ - instance_status?: string - /** 实例查询开始时间（unix毫秒时间戳） */ - instance_start_time_from?: string - /** 实例查询结束时间 (unix毫秒时间戳) */ - instance_start_time_to?: string - /** 地区 */ - locale?: string -} -export interface QueryApprovalInstanceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface SearchCcApprovalInstanceRequest { - /** 根据x_user_type填写用户 id */ - user_id?: string - /** 审批定义 code */ - approval_code?: string - /** 审批实例 code */ - instance_code?: string - /** 审批实例第三方 id 注：和 approval_code 取并集 */ - instance_external_id?: string - /** 审批定义分组第三方 id 注：和 instance_code 取并集 */ - group_external_id?: string - /** 审批实例标题（只有第三方审批有） */ - cc_title?: string - /** 审批抄送状态，注：若不在集合中，报错 */ - read_status?: string - /** 实例查询开始时间（unix毫秒时间戳） */ - cc_create_time_from?: string - /** 实例查询结束时间 (unix毫秒时间戳) */ - cc_create_time_to?: string - /** 地区 */ - locale?: string -} -export interface SearchCcApprovalInstanceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface SearchApprovalTaskRequest { - /** 根据x_user_type填写用户 id */ - user_id?: string - /** 审批定义 code */ - approval_code?: string - /** 审批实例 code */ - instance_code?: string - /** 审批实例第三方 id 注：和 approval_code 取并集 */ - instance_external_id?: string - /** 审批定义分组第三方 id 注：和 instance_code 取并集 */ - group_external_id?: string - /** 审批任务标题（只有第三方审批有） */ - task_title?: string - /** 审批任务状态，注：若不设置，查询全部状态 若不在集合中，报错 */ - task_status?: string - /** 任务查询开始时间（unix毫秒时间戳） */ - task_start_time_from?: string - /** 任务查询结束时间 (unix毫秒时间戳) */ - task_start_time_to?: string - /** 地区 */ - locale?: string - /** 可选择task_status中的多个状态，当填写此参数时，task_status失效 */ - task_status_list?: string[] - /** 按时间排序 */ - order?: number -} -export interface SearchApprovalTaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface QueryApprovalTaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 需要查询的 User ID */ - user_id: string - /** 需要查询的任务分组主题，如「待办」、「已办」等 */ - topic: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchHelpdeskAgentRequest { - /** agent status */ - status?: number -} -export interface CreateHelpdeskAgentScheduleRequest { - /** 新客服日程 */ - agent_schedules?: Lark.AgentScheduleUpdateInfo[] -} -export interface PatchHelpdeskAgentSchedulesRequest { - /** 工作日程列表 */ - agent_schedule?: Lark.AgentScheduleUpdateInfo -} -export interface ListHelpdeskAgentScheduleQuery { - /** 筛选条件, 1 - online客服, 2 - offline(手动)客服, 3 - off duty(下班)客服, 4 - 移除客服 */ - status: number[] -} -export interface CreateHelpdeskAgentSkillRequest { - /** 技能名 */ - name?: string - /** 技能rules */ - rules?: Lark.AgentSkillRule[] - /** 客服 ids */ - agent_ids?: string[] -} -export interface PatchHelpdeskAgentSkillRequest { - /** 更新技能 */ - agent_skill?: Lark.AgentSkill -} -export interface StartServiceHelpdeskTicketRequest { - /** 是否直接进入人工(若appointed_agents填写了，该值为必填) */ - human_service?: boolean - /** 客服 open ids (获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get))，human_service需要为true */ - appointed_agents?: string[] - /** 用户 open id,(获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */ - open_id: string - /** 工单来源自定义信息，长度限制1024字符，如设置，[获取工单详情](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */ - customized_info?: string -} -export interface UpdateHelpdeskTicketRequest { - /** new status, 1: 已创建, 2: 处理中, 3: 排队中, 5: 待定, 50: 机器人关闭工单, 51: 关闭工单 */ - status?: number - /** 新标签名 */ - tag_names?: string[] - /** 新评论 */ - comment?: string - /** 自定义字段 */ - customized_fields?: Lark.CustomizedFieldDisplayItem[] - /** ticket stage */ - ticket_type?: number - /** 工单是否解决，1: 未解决, 2: 已解决 */ - solved?: number - /** 工单来源渠道ID */ - channel?: number -} -export interface ListHelpdeskTicketQuery { - /** 搜索条件：工单ID */ - ticket_id?: string - /** 搜索条件: 客服id */ - agent_id?: string - /** 搜索条件: 关单客服id */ - closed_by_id?: string - /** 搜索条件: 工单类型 1:bot 2:人工 */ - type?: number - /** 搜索条件: 工单渠道 */ - channel?: number - /** 搜索条件: 工单是否解决 1:没解决 2:已解决 */ - solved?: number - /** 搜索条件: 工单评分 */ - score?: number - /** 搜索条件: 工单状态列表 */ - status_list?: number[] - /** 搜索条件: 用户名称 */ - guest_name?: string - /** 搜索条件: 用户id */ - guest_id?: string - /** 搜索条件: 用户标签列表 */ - tags?: string[] - /** 页数, 从1开始, 默认为1 */ - page?: number - /** 当前页大小，最大为200， 默认为20。分页查询最多累计返回一万条数据，超过一万条请更改查询条件，推荐通过时间查询。 */ - page_size?: number - /** 搜索条件: 工单创建起始时间 ms (也需要填上create_time_end)，相当于>=create_time_start */ - create_time_start?: number - /** 搜索条件: 工单创建结束时间 ms (也需要填上create_time_start)，相当于<=create_time_end */ - create_time_end?: number - /** 搜索条件: 工单修改起始时间 ms (也需要填上update_time_end) */ - update_time_start?: number - /** 搜索条件: 工单修改结束时间 ms(也需要填上update_time_start) */ - update_time_end?: number -} -export interface TicketImageHelpdeskTicketQuery { - /** 工单ID */ - ticket_id: string - /** 消息ID - - [查询消息ID](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list) */ - msg_id: string - /** index，当消息类型为post时，需指定图片index，index从0开始。当消息类型为img时，无需index */ - index?: number -} -export interface AnswerUserQueryHelpdeskTicketRequest { - /** 事件ID,可从订阅事件中提取 */ - event_id: string - /** faq结果列表 */ - faqs?: Lark.UserQueryFaqInfo[] -} -export interface CustomizedFieldsHelpdeskTicketQuery { - /** visible only */ - visible_only?: boolean -} -export interface CreateHelpdeskTicketMessageRequest { - /** 消息类型；text：纯文本；post：富文本 */ - msg_type: string - /** - 纯文本，参考[发送文本消息](/ssl:ttdoc/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content； - - 富文本，参考[发送富文本消息](/ssl:ttdoc/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content */ - content: string -} -export interface ListHelpdeskTicketMessageQuery { - /** 起始时间 */ - time_start?: number - /** 结束时间 */ - time_end?: number - /** 页数ID */ - page?: number - /** 消息数量，最大200，默认20 */ - page_size?: number -} -export interface CreateHelpdeskBotMessageRequest { - /** 消息类型 */ - msg_type: string - /** 消息内容 */ - content: string - /** 接收消息用户id */ - receiver_id: string - /** 接收消息方式，chat(服务台专属服务群)或user(服务台机器人私聊)。若选择专属服务群，用户有正在处理的工单将会发送失败。默认以chat方式发送。 */ - receive_type?: string -} -export interface CreateHelpdeskBotMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateHelpdeskTicketCustomizedFieldRequest { - /** 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 - /** if the dropdown field supports multi-select */ - dropdown_allow_multiple?: boolean -} -export interface PatchHelpdeskTicketCustomizedFieldRequest { - /** display name */ - display_name?: string - /** the position of ticket customized field in the page */ - position?: string - /** description of the field */ - description?: string - /** if the field is visible */ - visible?: boolean - /** if the field is required */ - required?: boolean -} -export interface ListHelpdeskTicketCustomizedFieldRequest { - /** 是否可见 */ - visible?: boolean -} -export interface ListHelpdeskTicketCustomizedFieldQuery { - page_token?: string - page_size?: number -} -export interface CreateHelpdeskFaqRequest { - /** 知识库详情 */ - faq?: Lark.FaqUpdateInfo -} -export interface PatchHelpdeskFaqRequest { - /** 修改的知识库内容 */ - faq?: Lark.FaqUpdateInfo -} -export interface ListHelpdeskFaqQuery { - /** 知识库分类ID */ - category_id?: string - /** 搜索条件: 知识库状态 1:在线 0:删除，可恢复 2：删除，不可恢复 */ - status?: string - /** 搜索条件: 关键词，匹配问题标题，问题关键字，用户姓名 */ - search?: string - page_token?: string - page_size?: number -} -export interface SearchHelpdeskFaqQuery { - /** 搜索query - ，query内容如果不是英文，包含中文空格等有两种编码策略：1. url编码 2. base64编码，同时加上base64=true参数 */ - query: string - /** 是否转换为base64,输入true表示是，不填写表示否，中文需要转换为base64 */ - base64?: string - page_token?: string - page_size?: number -} -export interface CreateHelpdeskCategoryRequest { - /** category name */ - name: string - /** parent category id, if any */ - parent_id: string - /** category language */ - language?: string -} -export interface PatchHelpdeskCategoryRequest { - /** category name */ - name?: string - /** parent category id, if any */ - parent_id?: string -} -export interface ListHelpdeskCategoryQuery { - /** 知识库分类语言 */ - lang?: string - /** 排序键。1: 根据知识库分类更新时间排序 */ - order_by?: number - /** 顺序。true: 正序；false：反序 */ - asc?: boolean -} -export interface CreateHelpdeskNotificationRequest { - /** 唯一ID */ - id?: string - /** 任务名称 */ - job_name?: string - /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */ - status?: number - /** 创建人 */ - create_user?: Lark.NotificationUser - /** 创建时间（毫秒时间戳） */ - created_at?: string - /** 更新用户 */ - update_user?: Lark.NotificationUser - /** 更新时间（毫秒时间戳） */ - updated_at?: string - /** 目标推送用户 */ - target_user_count?: number - /** 已推送用户总数 */ - sent_user_count?: number - /** 已读用户总数 */ - read_user_count?: number - /** 推送任务触发时间（毫秒时间戳） */ - send_at?: string - /** 推送内容，详见：https://open.feishu.cn/tool/cardbuilder?from=howtoguide */ - push_content?: string - /** 0（定时推送：push_scope不能等于3） 1（新人入职推送：push_scope必须等于1或者3；new_staff_scope_type不能为空） */ - push_type?: number - /** 推送范围（服务台私信） 0：组织内全部成员（user_list和department_list必须为空） 1：不推送任何成员（user_list和department_list必须为空，chat_list不可为空） 2：推送到部分成员（user_list或department_list不能为空） 3：入职新人 以上四种状态，chat_list都相对独立，只有在推送范围为1时，必须需要设置chat_list */ - push_scope_type?: number - /** 新人入职范围类型（push_type为1时生效） 0：组织内所有新人 1：组织内特定的部门（new_staff_scope_department_list 字段不能为空） */ - new_staff_scope_type?: number - /** 新人入职生效部门列表 */ - new_staff_scope_department_list?: Lark.NotificationDepartment[] - /** push推送到成员列表 */ - user_list?: Lark.NotificationUser[] - /** push推送到的部门信息列表 */ - department_list?: Lark.NotificationDepartment[] - /** push推送到的会话列表(群) */ - chat_list?: Lark.NotificationChat[] - /** 预留扩展字段 */ - ext?: string -} -export interface CreateHelpdeskNotificationQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchHelpdeskNotificationRequest { - /** 唯一ID */ - id?: string - /** 任务名称 */ - job_name?: string - /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */ - status?: number - /** 创建人 */ - create_user?: Lark.NotificationUser - /** 创建时间（毫秒时间戳） */ - created_at?: string - /** 更新用户 */ - update_user?: Lark.NotificationUser - /** 更新时间（毫秒时间戳） */ - updated_at?: string - /** 目标推送用户 */ - target_user_count?: number - /** 已推送用户总数 */ - sent_user_count?: number - /** 已读用户总数 */ - read_user_count?: number - /** 推送任务触发时间（毫秒时间戳） */ - send_at?: string - /** 推送内容，详见：https://open.feishu.cn/tool/cardbuilder?from=howtoguide */ - push_content?: string - /** 0（定时推送：push_scope不能等于3） 1（新人入职推送：push_scope必须等于1或者3；new_staff_scope_type不能为空） */ - push_type?: number - /** 推送范围（服务台私信） 0：组织内全部成员（user_list和department_list必须为空） 1：不推送任何成员（user_list和department_list必须为空，chat_list不可为空） 2：推送到部分成员（user_list或department_list不能为空） 3：入职新人 以上四种状态，chat_list都相对独立，只有在推送范围为1时，必须需要设置chat_list */ - push_scope_type?: number - /** 新人入职范围类型（push_type为1时生效） 0：组织内所有新人 1：组织内特定的部门（new_staff_scope_department_list 字段不能为空） */ - new_staff_scope_type?: number - /** 新人入职生效部门列表 */ - new_staff_scope_department_list?: Lark.NotificationDepartment[] - /** push推送到成员列表 */ - user_list?: Lark.NotificationUser[] - /** push推送到的部门信息列表 */ - department_list?: Lark.NotificationDepartment[] - /** push推送到的会话列表(群) */ - chat_list?: Lark.NotificationChat[] - /** 预留扩展字段 */ - ext?: string -} -export interface PatchHelpdeskNotificationQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetHelpdeskNotificationQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface SubmitApproveHelpdeskNotificationRequest { - /** 提交审批理由 */ - reason: string -} -export interface ExecuteSendHelpdeskNotificationRequest { - /** 发送时间戳(毫秒) */ - send_at: string -} -export interface CancelSendHelpdeskNotificationRequest { - /** 是否召回已发送的消息,新人入职消息同样适用 */ - is_recall: boolean -} -export interface SubscribeHelpdeskEventRequest { - /** 可订阅的事件列表 */ - events: Lark.Event[] -} -export interface UnsubscribeHelpdeskEventRequest { - /** event list to unsubscribe */ - events: Lark.Event[] -} -export interface CreateTaskv1Request { - /** 任务标题。创建任务时，如果没有标题填充，将其视为无主题的任务。 */ - summary?: string - /** 任务备注 */ - description?: string - /** 接入方可以自定义的附属信息二进制格式，采用 base64 编码，解析方式由接入方自己决定 */ - extra?: string - /** 任务的截止时间设置 */ - due?: Lark.Due - /** 任务关联的第三方平台来源信息 */ - origin: Lark.Origin - /** 此字段用于控制该任务在任务中心是否可编辑，默认为false，若为true则第三方需考虑是否需要接入事件来接收任务在任务中心的变更信息 */ - can_edit?: boolean - /** 此字段用于存储第三方需透传到端上的自定义数据，Json格式。取值举例中custom_complete字段存储「完成」按钮的跳转链接（href）或提示信息（tip），pc、ios、android三端均可自定义，其中tip字段的key为语言类型，value为提示信息，可自行增加或减少语言类型，支持的各地区语言名：it_it, th_th, ko_kr, es_es, ja_jp, zh_cn, id_id, zh_hk, pt_br, de_de, fr_fr, zh_tw, ru_ru, en_us, hi_in, vi_vn。href的优先级高于tip，href和tip同时不为空时只跳转不提示。链接和提示信息可自定义，其余的key需按举例中的结构传递 */ - custom?: string - /** 创建任务时添加的执行者用户id列表 */ - collaborator_ids?: string[] - /** 创建任务时添加的关注者用户id列表 */ - follower_ids?: string[] - /** 重复任务重复规则 */ - repeat_rule?: string - /** 富文本任务标题。创建任务时，如果没有标题填充，将其视为无主题的任务。 */ - rich_summary?: string - /** 富文本任务备注 */ - rich_description?: string -} -export interface CreateTaskv1Query { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchTaskv1Request { - /** 被更新的任务实体基础信息 */ - task: Lark.Task - /** 指定需要更新的字段（目前可选更新的字段为：summary, description, due, extra），否则服务端将不知道更新哪些字段 */ - update_fields: string[] -} -export interface PatchTaskv1Query { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetTaskv1Query { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListTaskv1Query { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 范围查询任务时，查询的起始时间。不填时默认起始时间为第一个任务的创建时间。 */ - start_create_time?: string - /** 范围查询任务时，查询的结束时间。不填时默认结束时间为最后一个任务的创建时间。 */ - end_create_time?: string - /** 可用于查询时过滤任务完成状态。true表示只返回已完成的任务，false表示只返回未完成的任务。不填时表示同时返回两种完成状态的任务。 */ - task_completed?: boolean - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateTaskv1TaskReminderRequest { - /** 相对于截止时间的提醒时间（如提前 30 分钟，截止时间后 30 分钟，则为 -30） */ - relative_fire_minute: number -} -export interface ListTaskv1TaskReminderQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateTaskv1TaskCommentRequest { - /** 评论内容 */ - content?: string - /** 评论的父ID，创建评论时若不为空则为某条评论的回复，若为空则不是回复 */ - parent_id?: string - /** 评论创建的时间戳，单位为毫秒，用于展示，创建时不用填写 */ - create_milli_time?: string - /** 富文本评论内容 */ - rich_content?: string -} -export interface CreateTaskv1TaskCommentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateTaskv1TaskCommentRequest { - /** 新的评论内容 */ - content?: string - /** 新的富文本评论内容（优先使用） */ - rich_content?: string -} -export interface UpdateTaskv1TaskCommentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetTaskv1TaskCommentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListTaskv1TaskCommentQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token获取查询结果 */ - page_token?: string - /** 评论排序标记，可按照评论时间从小到大查询，或者评论时间从大到小查询，不填默认按照从小到大 */ - list_direction?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateTaskv1TaskFollowerRequest { - /** 任务关注者 ID */ - id?: string - /** 要添加为关注人的user_id */ - id_list?: string[] -} -export interface CreateTaskv1TaskFollowerQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteTaskv1TaskFollowerQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchDeleteFollowerTaskv1Request { - /** 要添加为关注人的user_id */ - id_list?: string[] -} -export interface BatchDeleteFollowerTaskv1Query { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListTaskv1TaskFollowerQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateTaskv1TaskCollaboratorRequest { - /** 任务协作者的 ID */ - id?: string - /** 协作人的用户ID列表 */ - id_list?: string[] -} -export interface CreateTaskv1TaskCollaboratorQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteTaskv1TaskCollaboratorQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchDeleteCollaboratorTaskv1Request { - /** 协作人的用户ID列表 */ - id_list?: string[] -} -export interface BatchDeleteCollaboratorTaskv1Query { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListTaskv1TaskCollaboratorQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateTaskv2Request { - /** 任务标题 */ - summary: string - /** 任务描述 */ - description?: string - /** 任务截止时间戳(ms)，截止时间戳和截止日期选择一个填写。 */ - due?: Lark.Due - /** 任务关联的第三方平台来源信息 */ - origin?: Lark.Origin - /** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */ - extra?: string - /** 任务的完成时刻时间戳(ms) */ - completed_at?: string - /** 任务成员列表 */ - members?: Lark.Member[] - /** 如果设置，则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */ - repeat_rule?: string - /** 如果设置，则将任务设计为“自定义完成”。用户在任务中心点击“完成”时，不会直接完成任务，而是跳转到第三方配置好的地址或者现实自定义提示。 */ - custom_complete?: Lark.CustomComplete - /** 任务所在清单的信息 */ - tasklists?: Lark.TaskInTasklistInfo[] - /** 幂等token，如果填写则触发幂等行为。 */ - client_token?: string - /** 任务的开始时间(ms) */ - start?: Lark.Start - /** 任务提醒 */ - reminders?: Lark.Reminder[] - /** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */ - mode?: number - /** 是否是里程碑任务 */ - is_milestone?: boolean - /** 自定义字段值 */ - custom_fields?: Lark.InputCustomFieldValue[] -} -export interface CreateTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface GetTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface PatchTaskv2Request { - /** 要更新的任务数据，只需要写明要更新的字段 */ - task?: Lark.InputTask - /** 要更新的字段名称。支持summary, description, due, start, completed_at, extra, repeat_rule, custom_complete, mode, is_milestone, custom_fields。 */ - update_fields: string[] -} -export interface PatchTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface AddMembersTaskv2Request { - /** 要添加的members列表 */ - members: Lark.Member[] - /** 幂等token，如果提供则实现幂等行为 */ - client_token?: string -} -export interface AddMembersTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface RemoveMembersTaskv2Request { - /** 要移除的member列表 */ - members: Lark.Member[] -} -export interface RemoveMembersTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface ListTaskv2Query { - /** 每页的任务数量 */ - page_size?: number - /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ - page_token?: string - /** 是否按任务完成进行过滤。不填写表示不过滤。 */ - completed?: boolean - /** 查询任务的范围 */ - type?: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface AddTasklistTaskv2Request { - /** 要添加到的清单的全局唯一ID */ - tasklist_guid: string - /** 要添加到清单的自定义分组全局唯一ID，如不填写表示添加到默认分组 */ - section_guid?: string -} -export interface AddTasklistTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface RemoveTasklistTaskv2Request { - /** 要移除的清单的全局唯一ID */ - tasklist_guid: string -} -export interface RemoveTasklistTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface AddRemindersTaskv2Request { - /** 要添加的reminder的列表 */ - reminders: Lark.Reminder[] -} -export interface AddRemindersTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface RemoveRemindersTaskv2Request { - /** 要移除的reminder的id列表 */ - reminder_ids: string[] -} -export interface RemoveRemindersTaskv2Query { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface AddDependenciesTaskv2Request { - /** 要添加的依赖 */ - dependencies?: Lark.TaskDependency[] -} -export interface RemoveDependenciesTaskv2Request { - /** 要移除的依赖 */ - dependencies: Lark.TaskDependency[] -} -export interface CreateTaskv2TaskSubtaskRequest { - /** 任务标题 */ - summary: string - /** 任务描述 */ - description?: string - /** 任务截止时间戳(ms)，截止时间戳和截止日期选择一个填写。 */ - due?: Lark.Due - /** 任务关联的第三方平台来源信息 */ - origin?: Lark.Origin - /** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */ - extra?: string - /** 任务的完成时刻时间戳(ms) */ - completed_at?: string - /** 任务成员列表 */ - members?: Lark.Member[] - /** 如果设置，则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */ - repeat_rule?: string - /** 如果设置，则将任务设计为“自定义完成”。用户在任务中心点击“完成”时，不会直接完成任务，而是跳转到第三方配置好的地址或者现实自定义提示。 */ - custom_complete?: Lark.CustomComplete - /** 任务所在清单的信息 */ - tasklists?: Lark.TaskInTasklistInfo[] - /** 幂等token，如果填写则触发幂等行为。 */ - client_token?: string - /** 任务的开始时间(ms) */ - start?: Lark.Start - /** 任务提醒 */ - reminders?: Lark.Reminder[] - /** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */ - mode?: number - /** 是否是里程碑任务 */ - is_milestone?: boolean - /** 自定义字段值 */ - custom_fields?: Lark.InputCustomFieldValue[] -} -export interface CreateTaskv2TaskSubtaskQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface ListTaskv2TaskSubtaskQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface CreateTaskv2TasklistRequest { - /** 清单名称 */ - name: string - /** 清单的成员列表 */ - members?: Lark.Member[] -} -export interface CreateTaskv2TasklistQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface GetTaskv2TasklistQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface PatchTaskv2TasklistRequest { - /** 要更新清单的数据 */ - tasklist: Lark.InputTasklist - /** 要更新的字段名，只支持更新"owner", "name"两个字段 */ - update_fields: string[] - /** 该字段表示如果更新了新的负责人，则将原负责人设为指定的协作人角色。仅在update_fields包含owner字段时生效。根据清单的角色设计方式，不允许提前为清单的负责人添加其他角色，但负责人更新后，原有负责人会无法访问该清单。该字段可以帮助避免原负责人彻底退出清单。 */ - origin_owner_to_role?: string -} -export interface PatchTaskv2TasklistQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface AddMembersTaskv2TasklistRequest { - /** 要添加的成员列表 */ - members: Lark.Member[] -} -export interface AddMembersTaskv2TasklistQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface RemoveMembersTaskv2TasklistRequest { - /** 要移除的member列表 */ - members: Lark.Member[] -} -export interface RemoveMembersTaskv2TasklistQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface TasksTaskv2TasklistQuery { - /** 每页返回的任务数量 */ - page_size?: number - /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ - page_token?: string - /** 只查看特定完成状态的任务，不填写表示不按完成状态过滤 */ - completed?: boolean - /** 任务创建的起始时间戳（ms），闭区间，不填写默认为首个任务的创建时间戳 */ - created_from?: string - /** 任务创建的结束时间戳（ms），闭区间，不填写默认为最后创建任务的创建时间戳 */ - created_to?: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface ListTaskv2TasklistQuery { - /** 每页返回的清单数量 */ - page_size?: number - /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ - page_token?: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface CreateTaskv2TasklistActivitySubscriptionRequest { - /** 订阅名称 */ - name: string - /** 订阅者列表 */ - subscribers: Lark.Member[] - /** 订阅的事件key列表 */ - include_keys: number[] - /** 该订阅是否为停用 */ - disabled?: boolean -} -export interface CreateTaskv2TasklistActivitySubscriptionQuery { - /** 用户ID类型 */ - user_id_type?: string -} -export interface GetTaskv2TasklistActivitySubscriptionQuery { - /** 用户ID类型 */ - user_id_type?: string -} -export interface ListTaskv2TasklistActivitySubscriptionQuery { - /** 返回结果的最大数量 */ - limit?: number - /** 用户ID类型 */ - user_id_type?: string -} -export interface PatchTaskv2TasklistActivitySubscriptionRequest { - /** 要更新的订阅数据 */ - activity_subscription: Lark.TasklistActivitySubscription - /** 要更新的字段 */ - update_fields: string[] -} -export interface PatchTaskv2TasklistActivitySubscriptionQuery { - /** 用户ID类型 */ - user_id_type?: string -} -export interface CreateTaskv2CommentRequest { - /** 评论内容 */ - content: string - /** 回复给评论的id */ - reply_to_comment_id?: string - /** 评论归属的资源类型 */ - resource_type?: string - /** 评论归属的资源ID */ - resource_id?: string -} -export interface CreateTaskv2CommentQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface GetTaskv2CommentQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface PatchTaskv2CommentRequest { - /** 要更新的评论数据，支持更新content, md_content */ - comment: Lark.InputComment - /** 要更新的字段 */ - update_fields: string[] -} -export interface PatchTaskv2CommentQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface ListTaskv2CommentQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 要获取评论列表的资源类型 */ - resource_type?: string - /** 要获取评论的资源ID。例如要获取任务的评论列表，此处应该填写任务全局唯一ID */ - resource_id: string - /** 返回数据的排序方式 */ - direction?: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface UploadTaskv2AttachmentForm { - /** - * 附件归属资源的类型 - * - * 默认值：task - */ - resource_type?: string - /** - * 附件要归属资源的id。例如，要给任务添加附件，这里要填入任务GUID。任务GUID可以通过任务相关接口获得。 - * - * 数据校验规则： - * - * - 最大长度：100 字符 - */ - resource_id: string - /** 要上传的文件，单请求支持最多5个文件。上传结果的顺序将和请求中文件的顺序保持一致。 */ - file: Blob -} -export interface UploadTaskv2AttachmentQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface ListTaskv2AttachmentQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 附件归属的资源类型 */ - resource_type?: string - /** 附件归属资源的id，配合resource_type使用。例如希望获取任务的附件，需要设置 resource_type为task， resource_id为任务的全局唯一ID */ - resource_id: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface GetTaskv2AttachmentQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface CreateTaskv2SectionRequest { - /** 自定义分组名称 */ - name: string - /** 自定义分组归属的资源类型，支持"tasklist"或者"my_tasks" */ - resource_type: string - /** 自定义分组要归属的资源id */ - resource_id?: string - /** 要将新分组插入到自定义分分组的前面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ - insert_before?: string - /** 要将新分组插入到自定义分分组的后面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ - insert_after?: string -} -export interface CreateTaskv2SectionQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface GetTaskv2SectionQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface PatchTaskv2SectionRequest { - /** 要更新的自定义分组的数据，仅支持name, insert_after, insert_before */ - section: Lark.InputSection - /** 要更新的字段名 */ - update_fields: string[] -} -export interface PatchTaskv2SectionQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface ListTaskv2SectionQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 自定义分组所属的资源类型。支持"my_tasks"(我负责的）和"tasklist"（清单）。当使用"tasklist"时，需要用resource_id提供清单GUID。 */ - resource_type: string - /** 如`resource_type`为"tasklist"，这里需要填写要列取自定义分组的清单的GUID。 */ - resource_id?: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface TasksTaskv2SectionQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记 */ - page_token?: string - /** 按照任务状态过滤，如果不填写则表示不按完成状态过滤 */ - completed?: boolean - /** 按照创建时间筛选的起始时间戳（ms)，如不填写则为首个任务的创建时刻 */ - created_from?: string - /** 按照创建时间筛选的起始时间戳（ms)，如不填写则为最后任务的创建时刻 */ - created_to?: string - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface CreateTaskv2CustomFieldRequest { - /** 自定义字段要归属的资源类型，支持"tasklist" */ - resource_type: string - /** 自定义字段要归属的资源ID，可以填写清单的tasklist_guid */ - resource_id: string - /** 字段名称 */ - name: string - /** 自定义字段类型，支持"number", "datetime", "member", "single_select", "multi_select" */ - type: string - /** 数字类型的字段设置 */ - number_setting?: Lark.NumberSetting - /** 人员类型的字段设置 */ - member_setting?: Lark.MemberSetting - /** 时间日期类型的字段设置 */ - datetime_setting?: Lark.DatetimeSetting - /** 单选设置 */ - single_select_setting?: Lark.SelectSetting - /** 多选设置 */ - multi_select_setting?: Lark.SelectSetting - /** 文本类型 */ - text_setting?: Lark.TextSetting -} -export interface CreateTaskv2CustomFieldQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface GetTaskv2CustomFieldQuery { - /** 表示user的ID的类型，支持open_id, user_id, union_id */ - user_id_type?: string -} -export interface PatchTaskv2CustomFieldRequest { - /** 要修改的自定义字段数据 */ - custom_field?: Lark.InputCustomField - /** 要修改的自定义字段类型，支持name, member_setting, number_setting, datetime_setting, single_select_setting, multi_select_setting */ - update_fields?: string[] -} -export interface PatchTaskv2CustomFieldQuery { - /** 用户ID格式 */ - user_id_type?: string -} -export interface ListTaskv2CustomFieldQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户ID格式，支持open_id, user_id, union_id */ - user_id_type?: string - /** 资源类型，如提供表示仅查询特定资源下的自定义字段。目前只支持tasklist。 */ - resource_type?: string - /** 要查询自定义字段的归属resource_id */ - resource_id?: string -} -export interface AddTaskv2CustomFieldRequest { - /** 要将自定义字段添加到一个资源的资源类型。目前只支持tasklist */ - resource_type: string - /** 要将自定义字段添加到的资源id，目前只支持tasklist_guid */ - resource_id: string -} -export interface RemoveTaskv2CustomFieldRequest { - /** 要从某个资源移除自定义字段的资源类型，目前只支持清单"tasklist"。 */ - resource_type: string - /** 要从某个资源移除自定义字段的资源id，`resource_type`为"tasklist"时，需填写清单的GUID */ - resource_id: string -} -export interface CreateTaskv2CustomFieldOptionRequest { - /** 选项名 */ - name: string - /** 颜色索引值，支持0～54中的一个数字。如果不填写，则会随机选一个。 */ - color_index?: number - /** 要放到某个option之前的option_guid */ - insert_before?: string - /** 要放到某个option之后的option_guid */ - insert_after?: string - /** 是否隐藏 */ - is_hidden?: boolean -} -export interface PatchTaskv2CustomFieldOptionRequest { - /** 要更新的option数据 */ - option?: Lark.InputOption - /** 要更新的字段名，支持name,color,is_hidden,insert_before,insert_after */ - update_fields?: string[] -} -export interface CreateMailMailgroupRequest { - /** The mail group's email address */ - email?: string - /** The mail group's display name */ - name?: string - /** The mail group's description */ - description?: string - /** 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?: string -} -export interface PatchMailMailgroupRequest { - /** The public mailbox's new primary email address */ - email?: string - /** The mail group's display name */ - name?: string - /** The mail group's description */ - description?: string - /** 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?: string -} -export interface UpdateMailMailgroupRequest { - /** The public mailbox's new primary email address */ - email?: string - /** The mail group's display name */ - name?: string - /** The mail group's description */ - description?: string - /** 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?: string -} -export interface ListMailMailgroupQuery { - /** 邮件组管理员用户ID，用于获取该用户有管理权限的邮件组 */ - manager_user_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface BatchCreateMailMailgroupManagerRequest { - /** 邮件组管理员列表 */ - mailgroup_manager_list?: Lark.MailgroupManager[] -} -export interface BatchCreateMailMailgroupManagerQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BatchDeleteMailMailgroupManagerRequest { - /** 邮件组管理员列表 */ - mailgroup_manager_list?: Lark.MailgroupManager[] -} -export interface BatchDeleteMailMailgroupManagerQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListMailMailgroupManagerQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateMailMailgroupMemberRequest { - /** 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?: string -} -export interface CreateMailMailgroupMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface GetMailMailgroupMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface ListMailMailgroupMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface BatchCreateMailMailgroupMemberRequest { - /** 本次添加的邮件组成员列表 */ - items?: Lark.MailgroupMember[] -} -export interface BatchCreateMailMailgroupMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface BatchDeleteMailMailgroupMemberRequest { - /** 本次调用删除的成员ID列表 */ - member_id_list?: string[] -} -export interface CreateMailMailgroupAliasRequest { - /** 邮箱别名 */ - email_alias?: string -} -export interface CreateMailMailgroupPermissionMemberRequest { - /** 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?: string -} -export interface CreateMailMailgroupPermissionMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface GetMailMailgroupPermissionMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface ListMailMailgroupPermissionMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface BatchCreateMailMailgroupPermissionMemberRequest { - /** 本次添加的邮件组权限成员列表 */ - items?: Lark.MailgroupPermissionMember[] -} -export interface BatchCreateMailMailgroupPermissionMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface BatchDeleteMailMailgroupPermissionMemberRequest { - /** 本次调用删除的权限成员ID列表 */ - permission_member_id_list: string[] -} -export interface CreateMailPublicMailboxRequest { - /** The public mailbox's email address */ - email?: string - /** The public mailbox's display name */ - name?: string -} -export interface PatchMailPublicMailboxRequest { - /** The public mailbox's new primary email address */ - email?: string - /** The public mailbox's display name */ - name?: string -} -export interface UpdateMailPublicMailboxRequest { - /** The public mailbox's new primary email address */ - email?: string - /** The public mailbox's display name */ - name?: string -} -export interface ListMailPublicMailboxQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -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?: string -} -export interface CreateMailPublicMailboxMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetMailPublicMailboxMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListMailPublicMailboxMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface BatchCreateMailPublicMailboxMemberRequest { - /** 本次调用添加的公共邮箱成员列表 */ - items: Lark.PublicMailboxMember[] -} -export interface BatchCreateMailPublicMailboxMemberQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -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 ListMailUserMailboxAliasQuery { - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface QueryMailUserRequest { - /** 需要查询的邮箱地址列表 */ - email_list: string[] -} -export interface GetApplicationQuery { - /** 指定获取应用在该语言下的信息 */ - lang: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetApplicationApplicationAppVersionQuery { - /** 应用信息的语言版本 */ - lang: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListApplicationApplicationAppVersionQuery { - /** 应用信息的语言版本 */ - lang: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 0：按照时间倒序 1：按照时间正序 */ - order?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ContactsRangeSuggestApplicationApplicationAppVersionQuery { - /** 返回值的部门ID的类型 */ - department_id_type?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UnderauditlistApplicationQuery { - /** 指定返回的语言 */ - lang: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchApplicationApplicationAppVersionRequest { - /** 版本状态 */ - status?: number -} -export interface PatchApplicationApplicationAppVersionQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type: string - /** 操作者的 open_id */ - operator_id: string - /** 当修改版本状态为被驳回时，这一项必填 */ - reject_reason?: string -} -export interface PatchApplicationRequest { - /** 应用分类的国际化描述 */ - common_categories?: string[] -} -export interface PatchApplicationQuery { - /** 指定返回的语言 */ - lang: string -} -export interface ContactsRangeConfigurationApplicationQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 返回值的部门ID的类型 */ - department_id_type?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchApplicationApplicationContactsRangeRequest { - /** 更新范围方式 */ - contacts_range_type: string - /** 可见范围新增列表 */ - add_visible_list?: Lark.AppContactsRangeIdList - /** 删除可用名单 */ - del_visible_list?: Lark.AppContactsRangeIdList -} -export interface PatchApplicationApplicationContactsRangeQuery { - /** 成员id类型 */ - user_id_type?: string - /** 部门id 类型 */ - department_id_type?: string -} -export interface CheckWhiteBlackListApplicationApplicationVisibilityRequest { - /** 用户ID列表 */ - user_ids?: string[] - /** 部门ID列表 */ - department_ids?: string[] - /** 用户组ID列表 */ - group_ids?: string[] -} -export interface CheckWhiteBlackListApplicationApplicationVisibilityQuery { - /** 此次请求传参中的user_id的类型 */ - user_id_type?: string - /** 此次请求传参中的department_id的类型 */ - department_id_type?: string -} -export interface PatchApplicationApplicationVisibilityRequest { - /** 添加可用人员名单 */ - add_visible_list?: Lark.AppVisibilityIdList - /** 删除可用人员名单 */ - del_visible_list?: Lark.AppVisibilityIdList - /** 添加禁用人员名单 */ - add_invisible_list?: Lark.AppVisibilityIdList - /** 删除禁用人员名单 */ - del_invisible_list?: Lark.AppVisibilityIdList - /** 是否全员可见,false:否;true:是;不填:继续当前状态不改变.如果可见范围为全员后添加的可用人员则无效,禁用人员仍然有效 */ - is_visible_to_all?: boolean -} -export interface PatchApplicationApplicationVisibilityQuery { - /** 部门id 类型 */ - department_id_type?: string - /** open_id 类型 */ - user_id_type?: string -} -export interface UpdateApplicationApplicationManagementRequest { - /** 启用/停用应用 */ - enable?: boolean -} -export interface DepartmentOverviewApplicationApplicationAppUsageRequest { - /** 查询日期，格式为yyyy-mm-dd，若cycle_type为1，date可以为任何自然日；若cycle_type为2，则输入的date必须为周一； 若cycle_type为3，则输入的date必须为每月1号 */ - date: string - /** 活跃周期的统计类型 */ - cycle_type: number - /** 查询的部门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。 */ - recursion?: number - /** 分页大小，取值范围 1~20 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据。 */ - page_token?: string -} -export interface DepartmentOverviewApplicationApplicationAppUsageQuery { - /** 调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface OverviewApplicationApplicationAppUsageRequest { - /** 查询日期，格式为yyyy-mm-dd，若cycle_type为1，date可以为任何自然日；若cycle_type为2，则输入的date必须为周一； 若cycle_type为3，则输入的date必须为每月1号 */ - date: string - /** 活跃周期的统计类型 */ - cycle_type: number - /** 查询的部门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 - /** 能力类型，按能力类型进行筛选，返回对应能力的活跃数据 */ - ability: string -} -export interface OverviewApplicationApplicationAppUsageQuery { - /** 调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface PatchApplicationApplicationFeedbackQuery { - user_id_type?: string - /** 反馈处理状态 */ - status: number - /** 反馈处理人员id，租户内用户的唯一标识， ID值与查询参数中的user_id_type 对应 */ - operator_id: string -} -export interface ListApplicationApplicationFeedbackQuery { - /** 查询的起始日期，格式为yyyy-mm-dd。不填则默认为当前日期减去180天。 */ - from_date?: string - /** 查询的结束日期，格式为yyyy-mm-dd。不填默认为当前日期。 - 只能查询 180 天内的数据。 */ - to_date?: string - /** 反馈类型，不填写则表示查询所有反馈类型。 */ - feedback_type?: number - /** 反馈处理状态，不填写则表示查询所有处理类型。 */ - status?: number - user_id_type?: string - /** 分页拉取反馈列表起始位置标示，不填表示从头开始 */ - page_token?: string - /** 本次拉取反馈列表最大个数 */ - page_size?: number -} -export interface SetApplicationAppBadgeRequest { - /** 用户ID */ - user_id: string - /** badge数据版本号 */ - version: string - /** badge extra 信息 */ - extra?: string - /** pc端badge数量 */ - pc?: Lark.ClientBadgeNum - /** 移动端badge数量 */ - mobile?: Lark.ClientBadgeNum -} -export interface SetApplicationAppBadgeQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreatePersonalSettingsSystemStatusRequest { - /** 系统状态名称，名称字符数要在1到20范围内。 */ - title: string - /** 系统状态国际化名称，名称字符数要在1到20范围内。 */ - i18n_title?: Lark.SystemStatusI18nName - /** 图标 */ - icon_key: string - /** 颜色 */ - color?: string - /** 优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。 */ - priority?: number - /** 同步设置 */ - sync_setting?: Lark.SystemStatusSyncSetting -} -export interface PatchPersonalSettingsSystemStatusRequest { - /** 系统状态 */ - system_status: Lark.SystemStatus - /** 需要更新的字段 */ - update_fields: string[] -} -export interface ListPersonalSettingsSystemStatusQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface BatchOpenPersonalSettingsSystemStatusRequest { - /** 开启列表 */ - user_list: Lark.SystemStatusUserOpenParam[] -} -export interface BatchOpenPersonalSettingsSystemStatusQuery { - /** 用户id类型 open_id/user_id/union_id */ - user_id_type?: string -} -export interface BatchClosePersonalSettingsSystemStatusRequest { - /** 成员列表 */ - user_list: string[] -} -export interface BatchClosePersonalSettingsSystemStatusQuery { - /** 用户id类型 open_id/user_id/union_id */ - user_id_type?: string -} -export interface CreateSearchMessageRequest { - /** 搜索关键词 */ - query: string - /** 消息来自user_id列表 */ - from_ids?: string[] - /** 消息所在chat_id列表 */ - chat_ids?: string[] - /** 消息类型(file/image/media) */ - message_type?: string - /** at用户user_id列表 */ - at_chatter_ids?: string[] - /** 消息来自类型(bot/user) */ - from_type?: string - /** 会话类型(group_chat/p2p_chat) */ - chat_type?: string - /** 消息发送起始时间 */ - start_time?: string - /** 消息发送结束时间 */ - end_time?: string -} -export interface CreateSearchMessageQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页大小 */ - page_size?: number - /** 分页token */ - page_token?: string -} -export interface CreateSearchAppRequest { - /** 搜索关键词 */ - query: string -} -export interface CreateSearchAppQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 分页大小 */ - page_size?: number - /** 分页token */ - page_token?: string -} -export interface CreateSearchDataSourceRequest { - /** data_source的展示名称 */ - name: string - /** 数据源状态，0-已上线，1-未上线 */ - state?: number - /** 对于数据源的描述 */ - description?: string - /** 数据源在 search tab 上的展示图标路径 */ - icon_url?: string - /** 数据源采用的展示模版名称 */ - template?: string - /** 描述哪些字段可以被搜索 */ - searchable_fields?: string[] - /** 数据源的国际化展示名称 */ - i18n_name?: Lark.I18nMeta - /** 数据源的国际化描述 */ - i18n_description?: Lark.I18nMeta - /** 数据源关联的 schema 标识 */ - schema_id?: string - /** datasource对应的开放平台应用id */ - app_id?: string -} -export interface PatchSearchDataSourceRequest { - /** 数据源的展示名称 */ - name?: string - /** 数据源状态，0-已上线，1-未上线 */ - state?: number - /** 对于数据源的描述 */ - description?: string - /** 数据源在 search tab 上的展示图标路径 */ - icon_url?: string - /** 数据源名称多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"测试数据源", "en_us":"Test DataSource"} */ - i18n_name?: Lark.I18nMeta - /** 数据源描述多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"搜索测试数据源相关数据", "en_us":"Search data from Test DataSource"} */ - i18n_description?: Lark.I18nMeta -} -export interface ListSearchDataSourceQuery { - /** 回包数据格式，0-全量数据；1-摘要数据。 - - **注**：摘要数据仅包含"id"，"name"，"state"。 */ - view?: number - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateSearchDataSourceItemRequest { - /** item 在 datasource 中的唯一标识，只接受英文字母、数字和下划线 */ - id: string - /** item 的访问权限控制 */ - acl: Lark.Acl[] - /** item 的元信息 */ - metadata: Lark.ItemMetadata - /** 结构化数据 */ - structured_data: string - /** 非结构化数据，如文档文本 */ - content?: Lark.ItemContent -} -export interface CreateSearchSchemaRequest { - /** 数据范式的属性定义 */ - properties: Lark.SchemaProperty[] - /** 数据展示相关配置 */ - display: Lark.SchemaDisplay - /** 用户自定义数据范式的唯一标识 */ - schema_id: string -} -export interface CreateSearchSchemaQuery { - /** 是否只用来校验合法性 */ - validate_only?: boolean -} -export interface PatchSearchSchemaRequest { - /** 数据展示相关配置 */ - display?: Lark.SchemaDisplay -} -export interface ParseDocumentAiResumeForm { - /** 简历文件，支持 PDF / DOCX / PNG / JPG */ - file: Blob -} -export interface RecognizeDocumentAiVehicleInvoiceForm { - /** 识别的机动车发票源文件 */ - file: Blob -} -export interface RecognizeDocumentAiHealthCertificateForm { - /** 识别的健康证源文件 */ - file: Blob -} -export interface RecognizeDocumentAiHkmMainlandTravelPermitForm { - /** 识别的港澳居民来往内地通行证源文件 */ - file: Blob -} -export interface RecognizeDocumentAiTwMainlandTravelPermitForm { - /** 识别的台湾居民来往大陆通行证源文件 */ - file: Blob -} -export interface RecognizeDocumentAiChinesePassportForm { - /** 识别的中国护照源文件 */ - file: Blob -} -export interface RecognizeDocumentAiBankCardForm { - /** 识别的银行卡源文件 */ - file: Blob -} -export interface RecognizeDocumentAiVehicleLicenseForm { - /** 识别的行驶证源文件 */ - file: Blob -} -export interface RecognizeDocumentAiTrainInvoiceForm { - /** 识别的火车票源文件 */ - file: Blob -} -export interface RecognizeDocumentAiTaxiInvoiceForm { - /** 识别的出租车票源文件 */ - file: Blob -} -export interface RecognizeDocumentAiIdCardForm { - /** 识别身份证的源文件 */ - file: Blob -} -export interface RecognizeDocumentAiFoodProduceLicenseForm { - /** 识别的食品生产许可证源文件 */ - file: Blob -} -export interface RecognizeDocumentAiFoodManageLicenseForm { - /** 识别的食品经营许可证源文件 */ - file: Blob -} -export interface RecognizeDocumentAiDrivingLicenseForm { - /** 识别的驾驶证源文件 */ - file: Blob -} -export interface RecognizeDocumentAiVatInvoiceForm { - /** 识别的增值税发票文件（支持JPG/JPEG/PNG/PDF/BMP/OFD） */ - file: Blob -} -export interface RecognizeDocumentAiBusinessLicenseForm { - /** 识别的营业执照源文件 */ - file: Blob -} -export interface FieldExtractionDocumentAiContractForm { - /** 合同字段解析的源文件，当前只支持pdf, doc, docx三种类型的文件 */ - file: Blob - /** pdf页数限制，太长会导致latency增加，最大允许100页 */ - pdf_page_limit: number - /** - * ocr 参数，当前支持force, pdf, unused三种格式 - * - * 可选值有： - * - * - force：pdf类型文件直接走OCR解析 - * - auto：pdf类型文件先走本地解析，无法解析（扫描/图片版）再走OCR - * - unused：不调用OCR，扫描/图片PDF返回不可解析信息 - */ - ocr_mode: string -} -export interface RecognizeDocumentAiBusinessCardForm { - /** 识别名片的源文件（支持 JPG / PNG / PDF） */ - file: Blob -} -export interface BasicRecognizeOpticalCharRecognitionImageRequest { - /** base64 后的图片数据 */ - image?: string -} -export interface FileRecognizeSpeechToTextSpeechRequest { - /** 语音资源 */ - speech: Lark.Speech - /** 配置属性 */ - config: Lark.FileConfig -} -export interface StreamRecognizeSpeechToTextSpeechRequest { - /** 语音资源 */ - speech: Lark.Speech - /** 配置属性 */ - config: Lark.StreamConfig -} -export interface DetectTranslationTextRequest { - /** 需要被识别语种的文本 */ - text: string -} -export interface TranslateTranslationTextRequest { - /** 源语言 */ - source_language: string - /** 源文本 */ - text: string - /** 目标语言 */ - target_language: string - /** 请求级术语表，携带术语，仅在本次翻译中生效（最多能携带 128个术语词） */ - glossary?: Lark.Term[] -} -export interface AgreeApaasApprovalTaskRequest { - /** 操作人id */ - user_id: string - /** 审批意见 */ - opinion?: string -} -export interface RejectApaasApprovalTaskRequest { - /** 操作用户id */ - user_id: string - /** 审批意见 */ - opinion?: string -} -export interface TransferApaasApprovalTaskRequest { - /** 操作人id */ - user_id: string - /** 原审批人id */ - from_user_ids?: string[] - /** 新审批人id */ - to_user_ids?: string[] - /** 审批意见 */ - opinion?: string -} -export interface AddAssigneeApaasApprovalTaskRequest { - /** 操作人id */ - user_id: string - /** 审批人列表 */ - approvers?: string[] - /** 加签类型 */ - add_assignee_type?: string - /** 加签原因 */ - opinion?: string -} -export interface ResetAdminPasswordRequest { - /** 需要重置的密码参数，不少于8个字符，字母、数字和符号，至少三选二 */ - password: Lark.Password - /** 待修改密码的用户ID，只针对邮箱登录凭证与企业邮箱(包括别名)相等的用户生效 */ - user_id: string -} -export interface ResetAdminPasswordQuery { - /** 用户ID类型 */ - user_id_type: string -} -export interface ListAdminAdminDeptStatQuery { - /** 部门ID类型 */ - department_id_type: string - /** 起始日期（包含），格式是YYYY-mm-dd */ - start_date: string - /** 终止日期（包含），格式是YYYY-mm-dd，起止日期之间相差不能超过91天（包含91天） */ - end_date: string - /** 部门的 ID，取决于department_id_type，仅支持根部门及其下前4级子部门 */ - department_id: string - /** 是否包含子部门，如果该值为false，则只查出本部门直属用户活跃和功能使用数据；如果该值为true，则查出该部门以及其子部门（子部门层级最多不超过根部门下的前4级）的用户活跃和功能使用数据 */ - contains_child_dept: boolean - /** 分页大小，默认是10 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ - page_token?: string -} -export interface ListAdminAdminUserStatQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 部门ID类型 */ - department_id_type?: string - /** 起始日期（包含），格式是YYYY-mm-dd */ - start_date: string - /** 终止日期（包含），格式是YYYY-mm-dd。起止日期之间相差不能超过31天（包含31天） */ - end_date: string - /** 部门的 ID，取决于department_id_type */ - department_id?: string - /** 用户的open_id，user_id或者union_id，取决于user_id_type */ - user_id?: string - /** 分页大小，默认是10 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ - page_token?: string -} -export interface CreateAdminBadgeRequest { - /** 租户内唯一的勋章名称，最多30个字符。 */ - name: string - /** 勋章的描述文案，最多100个字符。 */ - explanation?: string - /** 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ - detail_image: string - /** 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ - show_image: string - /** 勋章的多语言名称，同name字段限制，最多30个字符。 */ - i18n_name?: Lark.I18n - /** 勋章的多语言描述文案，同explanation字段限制，最多100个字符。 */ - i18n_explanation?: Lark.I18n -} -export interface UpdateAdminBadgeRequest { - /** 租户内唯一的勋章名称，最多30个字符。 */ - name: string - /** 勋章的描述文案，最多100个字符。 */ - explanation?: string - /** 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ - detail_image: string - /** 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ - show_image: string - /** 勋章的多语言名称，同name字段限制，最多30个字符。 */ - i18n_name?: Lark.I18n - /** 勋章的多语言描述文案，同explanation字段限制，最多100个字符。 */ - i18n_explanation?: Lark.I18n -} -export interface CreateAdminBadgeImageForm { - /** 勋章图片的文件，仅支持 PNG 格式，320 x 320 像素，大小不超过 1024 KB。 */ - image_file: Blob - /** - * 图片的类型 - * - * 可选值有： - * - * - 1：勋章详情图 - * - 2：勋章挂饰图 - */ - image_type: 1 | 2 -} -export interface ListAdminBadgeQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 租户内唯一的勋章名称，精确匹配。 */ - name?: string -} -export interface CreateAdminBadgeGrantRequest { - /** 授予名单名称，最多100个字符。 */ - name: string - /** 勋章下唯一的授予事项 */ - grant_type: number - /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */ - time_zone: string - /** 规则详情 */ - rule_detail: Lark.RuleDetail - /** 是否授予给全员。1.为false时，需要关联1~500个用户群体。2.为true时，不可关联用户、用户组、部门。 */ - is_grant_all: boolean - /** 授予的用户ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - user_ids?: string[] - /** 授予的部门ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - department_ids?: string[] - /** 授予的用户组ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - group_ids?: string[] -} -export interface CreateAdminBadgeGrantQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型。 */ - department_id_type?: string -} -export interface UpdateAdminBadgeGrantRequest { - /** 授予名单名称，最多100个字符。 */ - name: string - /** 勋章下唯一的授予事项 */ - grant_type: number - /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */ - time_zone: string - /** 规则详情 */ - rule_detail: Lark.RuleDetail - /** 是否授予给全员。1.为false时，需要关联1~500个用户群体。2.为true时，不可关联用户、用户组、部门。 */ - is_grant_all: boolean - /** 授予的用户ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - user_ids?: string[] - /** 授予的部门ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - department_ids?: string[] - /** 授予的用户组ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ - group_ids?: string[] -} -export interface UpdateAdminBadgeGrantQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型。 */ - department_id_type?: string -} -export interface ListAdminBadgeGrantQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型。 */ - department_id_type?: string - /** 授予名单名称，精确匹配。 */ - name?: string -} -export interface GetAdminBadgeGrantQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型。 */ - department_id_type?: string -} -export interface ListEhrEmployeeQuery { - /** 返回数据类型 */ - view?: string - /** 员工状态，不传代表查询所有员工状态 - - 实际在职 = 2&4 - - 可同时查询多个状态的记录，如 status=2&status=4 */ - status?: number[] - /** 雇员类型，不传代表查询所有雇员类型 */ - type?: number[] - /** 查询开始时间（创建时间 >= 此时间） */ - start_time?: string - /** 查询结束时间（创建时间 <= 此时间） */ - end_time?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** user_id、open_id 或 union_id，默认为 open_id。 - - 如果传入的值不是 open_id，需要一并传入 user_id_type 参数。 - - 可一次查询多个 id 的用户，例如：user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde - - [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ - user_ids?: string[] - /** 分页标记，第一次请求可以不填，表示从头开始遍历；分页查询返回结果has_more 为 true 时会同时返回新的 page_token, 下次遍历可使用该返回的 page_token 获取更多信息。 */ - page_token?: string - /** 分页大小，取值范围 1~100，默认 10 */ - page_size?: number -} -export interface SearchCorehrBasicInfoNationalityRequest { - /** 国籍 ID 列表 */ - nationality_id_list?: string[] - /** 国家 / 地区 ID 列表 */ - country_region_id_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoNationalityQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface SearchCorehrBasicInfoBankRequest { - /** 银行 ID 列表，与「银行名称列表」查询条件至少填写一项 */ - bank_id_list?: string[] - /** 银行名称列表，支持对银行名称精确搜索 */ - bank_name_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoBankQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface SearchCorehrBasicInfoBankBranchRequest { - /** 银行 ID 列表，与「支行 ID 列表」、「支行名称列表」至少填写一项 */ - bank_id_list?: string[] - /** 支行 ID 列表 */ - bank_branch_id_list?: string[] - /** 支行名称列表，支持对支行名称精确搜索 */ - bank_branch_name_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoBankBranchQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface GetByParamCorehrCustomFieldQuery { - /** 自定义字段 apiname */ - custom_api_name: string - /** 所属对象 apiname */ - object_api_name: string -} -export interface QueryCorehrCustomFieldQuery { - /** 所属对象 apiname，支持一个或多个 - - 当前数量限制为 20 个 */ - object_api_name_list: string[] -} -export interface ListObjectApiNameCorehrCustomFieldQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface SearchCorehrBasicInfoCountryRegionRequest { - /** 国家/地区 ID 列表 */ - country_region_id_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoCountryRegionQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface SearchCorehrBasicInfoCountryRegionSubdivisionRequest { - /** 国家/地区 ID 列表，可通过【查询国家/地区信息】接口获取 */ - country_region_id_list?: string[] - /** 省份/行政区 ID 列表 */ - country_region_subdivision_id_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoCountryRegionSubdivisionQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface SearchCorehrBasicInfoCityRequest { - /** 省份/行政区 ID 列表，可通过【查询省份/行政区信息】接口获取 */ - country_region_subdivision_id_list?: string[] - /** 城市 ID 列表 */ - city_id_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoCityQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface SearchCorehrBasicInfoDistrictRequest { - /** 所属城市 ID 列表，详细信息可通过【查询城市信息】接口查询获得 */ - city_id_list?: string[] - /** 区/县 ID 列表 */ - district_id_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoDistrictQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateCorehrEmployeeTypeRequest { - /** 名称 */ - name: Lark.I18n[] - /** 默认雇员类型 */ - default_employee_type: boolean - /** 启用 */ - active: boolean - /** 编码 */ - code?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrEmployeeTypeQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrEmployeeTypeRequest { - /** 名称 */ - name?: Lark.I18n[] - /** 默认雇员类型 */ - default_employee_type?: boolean - /** 启用 */ - active?: boolean - /** 编码 */ - code?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface PatchCorehrEmployeeTypeQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrEmployeeTypeQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface CreateCorehrNationalIdTypeRequest { - /** 国家 / 地区 */ - country_region_id: string - /** 名称 */ - name: Lark.I18n[] - /** 启用 */ - active: boolean - /** 校验规则 */ - validation_rule: string - /** 校验规则描述 */ - validation_rule_description?: Lark.I18n[] - /** 编码 */ - code: string - /** 证件类型 */ - identification_type: Lark.Enum - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrNationalIdTypeQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrNationalIdTypeRequest { - /** 国家 / 地区 */ - country_region_id?: string - /** 名称 */ - name?: Lark.I18n[] - /** 启用 */ - active?: boolean - /** 校验规则 */ - validation_rule?: string - /** 校验规则描述 */ - validation_rule_description?: Lark.I18n[] - /** 编码 */ - code?: string - /** 证件类型 */ - identification_type?: Lark.Enum - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface PatchCorehrNationalIdTypeQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrNationalIdTypeQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 证件类型 */ - identification_type?: string - /** 证件类型编码 */ - code?: string - /** 国家地区ID */ - country_region_id?: string -} -export interface CreateCorehrWorkingHoursTypeRequest { - /** 编码 */ - code?: string - /** 名称 */ - name: Lark.I18n[] - /** 国家/地区 */ - country_region_id_list?: string[] - /** 职务默认值 */ - default_for_job: boolean - /** 启用 */ - active: boolean - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrWorkingHoursTypeQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrWorkingHoursTypeRequest { - /** 编码 */ - code?: string - /** 名称 */ - name?: Lark.I18n[] - /** 国家/地区 */ - country_region_id_list?: string[] - /** 职务默认值 */ - default_for_job?: boolean - /** 启用 */ - active?: boolean - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface PatchCorehrWorkingHoursTypeQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrWorkingHoursTypeQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface SearchCorehrBasicInfoCurrencyRequest { - /** 货币 ID 列表 */ - currency_id_list?: string[] - /** 状态列表 */ - status_list?: number[] -} -export interface SearchCorehrBasicInfoCurrencyQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface BatchGetCorehrEmployeeRequest { - /** 返回数据的字段列表，填写方式：为空时默认仅返回 ID */ - fields?: string[] - /** 雇佣 ID 列表 */ - employment_ids?: string[] - /** 个人信息 ID 列表，employment_ids参数有值时该参数不生效 */ - person_ids?: string[] - /** 主工作邮箱列表 */ - work_emails?: string[] -} -export interface BatchGetCorehrEmployeeQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface SearchCorehrEmployeeRequest { - /** 返回数据的字段列表，填写方式：为空时默认仅返回 ID */ - fields?: string[] - /** 雇佣 ID 列表 */ - employment_id_list?: string[] - /** 工号列表 */ - employee_number_list?: string[] - /** 邮箱，精确匹配查询 */ - work_email?: string - /** 个人电话，精确匹配查询 */ - phone_number?: string - /** 搜索关键字，支持对邮箱、工号和姓名的模糊匹配 */ - key_word?: string - /** 雇佣状态 */ - employment_status?: string - /** 人员类型 ID */ - employee_type_id?: string - /** 部门 ID，根据员工主职的直接部门查询，可以通过【查询部门】API 获取 部门 ID */ - department_id_list?: string[] - /** 直接上级的雇佣 ID，根据员工主职的直接上级查询 */ - direct_manager_id_list?: string[] - /** 虚线上级的雇佣 ID，根据员工主职的虚线上级查询 */ - dotted_line_manager_id_list?: string[] - /** 转正式员工日期-搜索范围开始 */ - regular_employee_start_date_start?: string - /** 转正式员工日期-搜索范围结束 */ - regular_employee_start_date_end?: string - /** 入职日期-搜索范围开始，需要与搜索范围结束一同使用 */ - effective_time_start?: string - /** 入职日期-搜索范围结束 */ - effective_time_end?: string - /** 工作地点 ID 列表，查询属于该工作地点及下级工作地点的员工 */ - work_location_id_list_include_sub?: string[] - /** 常用英文全名精确搜索 */ - preferred_english_full_name_list?: string[] - /** 常用本地全名精确搜索 */ - preferred_local_full_name_list?: string[] - /** 居民身份证件号码精确搜索 */ - national_id_number_list?: string[] - /** 个人电话列表，精确匹配查询 */ - phone_number_list?: string[] - /** 工作邮箱地址列表，精确匹配查询 */ - email_address_list?: string[] - /** 部门 ID 列表，查询属于该部门及下级部门的员工 */ - department_id_list_include_sub?: string[] -} -export interface SearchCorehrEmployeeQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface CreateCorehrEmploymentRequest { - /** 资历起算日期 */ - seniority_date?: string - /** 员工编号 */ - employee_number?: string - /** 入职日期 */ - effective_time: string - /** 离职日期 */ - expiration_time?: string - /** 雇佣类型 */ - employment_type: Lark.Enum - /** 人员信息，引用Person的ID */ - person_id: string - /** 是否是主雇佣信息 */ - primary_employment: boolean - /** 雇员状态 */ - employment_status?: Lark.Enum - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 工作邮箱列表 */ - work_email_list?: Lark.Email[] - /** 离职原因 */ - reason_for_offboarding?: Lark.Enum - /** 招聘应用 ID */ - ats_application_id?: string - /** 是否离职重聘 */ - rehire?: Lark.Enum - /** 历史雇佣信息 ID */ - rehire_employment_id?: string -} -export interface CreateCorehrEmploymentQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrEmploymentRequest { - /** 资历起算日期 */ - seniority_date?: string - /** 员工编号 */ - employee_number?: string - /** 雇佣类型 */ - employment_type?: Lark.Enum - /** 人员信息，引用Person的ID */ - person_id?: string - /** 是否是主雇佣信息 */ - primary_employment?: boolean - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 工作邮箱列表 */ - work_email_list?: Lark.Email[] - /** 离职原因 */ - reason_for_offboarding?: Lark.Enum - /** 招聘应用 ID */ - ats_application_id?: string -} -export interface PatchCorehrEmploymentQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface DeleteCorehrEmploymentQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface CreateCorehrPersonRequest { - /** 姓名列表 */ - name_list?: Lark.PersonName[] - /** -| 性别，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：gender - object_api_name：person */ - gender?: Lark.Enum - /** 出生日期 */ - date_of_birth?: string - /** -| 民族 / 种族，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：ethnicity_race - object_api_name：person */ - race?: Lark.Enum - /** -| 婚姻状况，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：marital_status - object_api_name：person */ - marital_status?: Lark.Enum - /** 电话列表，只有当满足下面所有条件时，电话在个人信息页才可见 */ - phone_list?: Lark.Phone[] - /** 地址列表 */ - address_list?: Lark.Address[] - /** 邮箱列表 */ - email_list?: Lark.Email[] - /** 工作经历列表 */ - work_experience_list?: Lark.WorkExperienceInfo[] - /** 教育经历列表 */ - education_list?: Lark.Education[] - /** 银行账户 */ - bank_account_list?: Lark.BankAccount[] - /** 证件 */ - national_id_list?: Lark.NationalId[] - /** 家庭成员列表 */ - dependent_list?: Lark.Dependent[] - /** 紧急联系人列表 */ - emergency_contact_list?: Lark.EmergencyContact[] - /** 参加工作日期 */ - date_entered_workforce?: string - /** 头像资源的 ID */ - profile_image_id?: string - /** 年龄 */ - age?: number - /** 个人资料附件 */ - personal_profile?: Lark.PersonalProfile[] - /** 籍贯 ID */ - native_region?: string - /** 户口类型，枚举值可通过文档【飞书人事枚举常量】户口类型（hukou_type）枚举定义部分获得 */ - hukou_type?: Lark.Enum - /** 户口所在地 */ - hukou_location?: string - /** 人才 ID */ - talent_id?: string - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - /** 出生国家/地区 */ - born_country_region?: string - /** 是否残疾 */ - is_disabled?: boolean - /** 残疾证号 */ - disable_card_number?: string - /** 是否烈属 */ - is_martyr_family?: boolean - /** 烈属证号 */ - martyr_card_number?: string - /** 是否孤老 */ - is_old_alone?: boolean - /** 居民身份信息 */ - resident_taxes?: Lark.ResidentTax[] - /** 首次入境日期 */ - first_entry_time?: string - /** 预计离境日期 */ - leave_time?: string -} -export interface CreateCorehrPersonQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrPersonRequest { - /** 姓名列表 */ - name_list?: Lark.PersonName[] - /** -| 性别，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：gender - object_api_name：person */ - gender?: Lark.Enum - /** 出生日期 */ - date_of_birth?: string - /** -| 民族 / 种族，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：ethnicity_race - object_api_name：person */ - race?: Lark.Enum - /** -| 婚姻状况，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：marital_status - object_api_name：person */ - marital_status?: Lark.Enum - /** 电话列表，只有当满足下面所有条件时，电话在个人信息页才可见 */ - phone_list?: Lark.Phone[] - /** 地址列表 */ - address_list?: Lark.Address[] - /** 邮箱列表 */ - email_list?: Lark.Email[] - /** 工作经历列表 */ - work_experience_list?: Lark.WorkExperienceInfo[] - /** 教育经历列表 */ - education_list?: Lark.Education[] - /** 银行账户 */ - bank_account_list?: Lark.BankAccount[] - /** 证件 */ - national_id_list?: Lark.NationalId[] - /** 家庭成员列表 */ - dependent_list?: Lark.Dependent[] - /** 紧急联系人列表 */ - emergency_contact_list?: Lark.EmergencyContact[] - /** 参加工作日期 */ - date_entered_workforce?: string - /** 头像资源的 ID */ - profile_image_id?: string - /** 年龄 */ - age?: number - /** 个人资料附件 */ - personal_profile?: Lark.PersonalProfile[] - /** 籍贯 ID */ - native_region?: string - /** 户口类型，枚举值可通过文档【飞书人事枚举常量】户口类型（hukou_type）枚举定义部分获得 */ - hukou_type?: Lark.Enum - /** 户口所在地 */ - hukou_location?: string - /** 人才 ID */ - talent_id?: string - /** 自定义字段 */ - custom_fields?: Lark.CustomFieldData[] - /** 出生国家/地区 */ - born_country_region?: string - /** 是否残疾 */ - is_disabled?: boolean - /** 残疾证号 */ - disable_card_number?: string - /** 是否烈属 */ - is_martyr_family?: boolean - /** 烈属证号 */ - martyr_card_number?: string - /** 是否孤老 */ - is_old_alone?: boolean - /** 居民身份信息 */ - resident_taxes?: Lark.ResidentTax[] - /** 首次入境日期 */ - first_entry_time?: string - /** 预计离境日期 */ - leave_time?: string -} -export interface PatchCorehrPersonQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface UploadCorehrPersonForm { - /** 文件二进制内容，大小不超过50M */ - file_content: Blob - /** 文件名称（需带有文件后缀） */ - file_name: string -} -export interface CreateCorehrJobDataRequest { - /** 级别 */ - job_level_id?: string - /** 雇员类型 */ - employee_type_id: string - /** 工时制度 */ - working_hours_type_id?: string - /** 工作地点 */ - work_location_id?: string - /** 部门 */ - department_id?: string - /** 职务 */ - job_id?: string - /** 试用期开始日期 */ - probation_start_date?: string - /** 试用期 */ - probation_end_date?: string - /** 主任职 */ - primary_job_data: boolean - /** Employment ID */ - employment_id: string - /** 生效时间 */ - effective_time: string - /** 失效时间 */ - expiration_time?: string - /** 职务分类 ID */ - job_family_id?: string - /** 任职原因 */ - assignment_start_reason: Lark.Enum - /** 试用期结束日期 */ - probation_expected_end_date?: string - /** 实线主管 */ - direct_manager_id?: string - /** 虚线主管 */ - dotted_line_manager_id_list?: string[] - /** 第二实线主管 */ - second_direct_manager_id?: string - /** 成本中心分摊信息 */ - cost_center_rate?: Lark.SupportCostCenterItem[] - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrJobDataQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface PatchCorehrJobDataRequest { - /** 级别 */ - job_level_id?: string - /** 雇员类型 */ - employee_type_id?: string - /** 工时制度 */ - working_hours_type_id?: string - /** 工作地点 */ - work_location_id?: string - /** 部门 */ - department_id?: string - /** 职务 */ - job_id?: string - /** 试用期开始日期 */ - probation_start_date?: string - /** 试用期 */ - probation_end_date?: string - /** 主任职 */ - primary_job_data?: boolean - /** Employment ID */ - employment_id?: string - /** 生效时间 */ - effective_time?: string - /** 失效时间 */ - expiration_time?: string - /** 职务分类 ID */ - job_family_id?: string - /** 任职原因 */ - assignment_start_reason?: Lark.Enum - /** 试用期结束日期 */ - probation_expected_end_date?: string - /** 实线主管 */ - direct_manager_id?: string - /** 虚线主管 */ - dotted_line_manager_id_list?: string[] - /** 第二实线主管 */ - second_direct_manager_id?: string - /** 成本中心分摊信息 */ - cost_center_rate?: Lark.SupportCostCenterItem[] - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface PatchCorehrJobDataQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface GetCorehrJobDataQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface QueryCorehrEmployeesJobDataRequest { - /** 是否获取所有任职记录，true 为获取员工所有版本的任职记录，false 为仅获取当前生效的任职记录，默认为 false */ - get_all_version?: boolean - /** 查看数据日期 */ - data_date?: string - /** 生效日期 - 搜索范围开始 */ - effective_date_start?: string - /** 生效日期 - 搜索范围结束 */ - effective_date_end?: string -} -export interface QueryCorehrEmployeesJobDataQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface BatchGetCorehrEmployeesJobDataRequest { - /** 员工雇佣 ID 列表 */ - employment_ids: string[] - /** 是否获取所有任职记录，true 为获取员工所有版本的任职记录，false 为仅获取当前生效的任职记录，默认为 false */ - get_all_version?: boolean - /** 生效日期 - 搜索范围开始 */ - effective_date_start?: string - /** 生效日期 - 搜索范围结束 */ - effective_date_end?: string - /** 查看数据日期，默认为今天 */ - data_date?: string -} -export interface BatchGetCorehrEmployeesJobDataQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface ListCorehrJobDataQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 雇佣 ID */ - employment_id?: string - /** 任职信息 ID 列表，最大 100 个（不传则默认查询全部任职信息） */ - job_data_id_list?: string[] - /** 部门 ID */ - department_id?: string - /** 职务 ID */ - job_id?: string - /** 是否获取所有任职记录，true 为获取员工所有版本的任职记录，false 为仅获取当前生效的任职记录，默认为 false */ - get_all_version?: boolean - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface ParentsCorehrDepartmentRequest { - /** 部门 ID 列表，一次性最多传入 100 个部门 ID */ - department_id_list: string[] -} -export interface ParentsCorehrDepartmentQuery { - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface SearchCorehrDepartmentRequest { - /** manager ID 列表 - **字段权限要求：按照部门负责人搜索 (corehr:department.manager.search:read)** */ - manager_list?: string[] - /** 部门 ID 列表 */ - department_id_list?: string[] - /** 部门名称列表，需精确匹配 */ - name_list?: string[] - /** 上级部门 ID ，可查询直接下级部门 - **字段权限要求：按照上级部门搜索 (corehr:department.organize.search:read) ** */ - parent_department_id?: string - /** 部门 code 列表 */ - code_list?: string[] - /** 返回数据的字段列表 */ - fields?: string[] -} -export interface SearchCorehrDepartmentQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface CreateCorehrDepartmentRequest { - /** 子类型 */ - sub_type?: Lark.Enum - /** 部门负责人 */ - manager?: string - /** 是否保密 */ - is_confidential?: boolean - /** 层级关系，内层字段见实体 */ - hiberarchy_common: Lark.HiberarchyCommon - /** 生效时间 */ - effective_time: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 成本中心id */ - cost_center_id?: string -} -export interface CreateCorehrDepartmentQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface PatchCorehrDepartmentRequest { - /** 实体在CoreHR内部的唯一键 */ - id?: string - /** 子类型 */ - sub_type?: Lark.Enum - /** 部门负责人 */ - manager?: string - /** 是否保密 */ - is_confidential?: boolean - /** 层级关系，内层字段见实体 */ - hiberarchy_common: Lark.HiberarchyCommon - /** 生效时间 */ - effective_time: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 成本中心id */ - cost_center_id?: string -} -export interface PatchCorehrDepartmentQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface GetCorehrDepartmentQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface BatchGetCorehrDepartmentRequest { - /** 部门 ID 列表 */ - department_id_list?: string[] - /** 返回数据的字段列表 */ - fields?: string[] - /** 部门名称精确匹配，最多传100个 */ - department_name_list?: string[] -} -export interface BatchGetCorehrDepartmentQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface ListCorehrDepartmentQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 部门ID列表 */ - department_id_list?: string[] - /** 部门名称列表，需精确匹配 */ - name_list?: string[] - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface BatchGetCorehrLocationRequest { - /** 地点 ID 列表 */ - location_ids: string[] -} -export interface CreateCorehrLocationRequest { - /** 层级关系，内层字段见实体 */ - hiberarchy_common: Lark.HiberarchyCommon - /** 地点用途 */ - location_usage_list?: Lark.Enum[] - /** 地址 */ - address?: Lark.Address[] - /** 工时制度 */ - working_hours_type_id?: string - /** 生效时间 */ - effective_time: string - /** 区域设置 */ - locale?: Lark.Enum - /** 时区 */ - time_zone_id?: string - /** 默认显示语言 */ - display_language_id?: string -} -export interface CreateCorehrLocationQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrLocationQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface ListCorehrCompanyQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface BatchGetCorehrCompanyRequest { - /** 公司 ID 列表 */ - company_ids: string[] -} -export interface CreateCorehrCompanyRequest { - /** 层级关系，内层字段见实体 */ - hiberarchy_common: Lark.HiberarchyCommon - /** 性质 */ - type?: Lark.Enum - /** 行业 */ - industry_list?: Lark.Enum[] - /** 法定代表人 */ - legal_representative?: Lark.I18n[] - /** 邮编 */ - post_code?: string - /** 纳税人识别号 */ - tax_payer_id?: string - /** confidential */ - confidential?: boolean - /** 主体类型 */ - sub_type_list?: Lark.Enum[] - /** 是否为分公司 */ - branch_company?: boolean - /** 主要负责人 */ - primary_manager?: Lark.I18n[] - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrCompanyQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrCompanyRequest { - /** 层级关系，内层字段见实体 */ - hiberarchy_common: Lark.HiberarchyCommon - /** 性质 */ - type?: Lark.Enum - /** 行业 */ - industry_list?: Lark.Enum[] - /** 法定代表人 */ - legal_representative?: Lark.I18n[] - /** 邮编 */ - post_code?: string - /** 纳税人识别号 */ - tax_payer_id?: string - /** confidential */ - confidential?: boolean - /** 主体类型 */ - sub_type_list?: Lark.Enum[] - /** 是否为分公司 */ - branch_company?: boolean - /** 主要负责人 */ - primary_manager?: Lark.I18n[] - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 默认币种 */ - currency?: Lark.Currency - /** 电话 */ - phone?: Lark.PhoneNumberAndAreaCode - /** 传真 */ - fax?: Lark.PhoneNumberAndAreaCode -} -export interface PatchCorehrCompanyQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface CreateCorehrCostCenterRequest { - /** 成本中心名称 */ - name: Lark.I18n[] - /** 编码 */ - code?: string - /** 上级成本中心ID */ - parent_cost_center_id?: string - /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ - managers?: string[] - /** 成本中心描述 */ - description?: Lark.I18n[] - /** 生效时间 */ - effective_time: string -} -export interface CreateCorehrCostCenterQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface PatchCorehrCostCenterRequest { - /** 生效时间 */ - effective_time: string - /** 启用停用状态 */ - active: boolean - /** 操作原因 */ - operation_reason: string -} -export interface PatchCorehrCostCenterQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface DeleteCorehrCostCenterRequest { - /** 操作原因 */ - operation_reason: string -} -export interface SearchCorehrCostCenterRequest { - /** 成本中心ID 列表 */ - cost_center_id_list?: string[] - /** 成长中心名称列表，精确匹配 */ - name_list?: string[] - /** 成本中心编码 */ - code?: string - /** 上级成本中心ID，可用于查询直接下级成本中心 */ - parent_cost_center_id?: string - /** 是否获取所有陈本中心版本 */ - get_all_version?: boolean -} -export interface SearchCorehrCostCenterQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface CreateCorehrCostCenterVersionRequest { - /** 成本中心名称 */ - name: Lark.I18n[] - /** 上级成本中心ID */ - parent_cost_center_id?: string - /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ - managers?: string[] - /** 成本中心描述 */ - description?: Lark.I18n[] - /** 生效时间 */ - effective_time: string - /** 操作原因 */ - operation_reason: string -} -export interface CreateCorehrCostCenterVersionQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface PatchCorehrCostCenterVersionRequest { - /** 成本中心名称 */ - name: Lark.I18n[] - /** 上级成本中心ID */ - parent_cost_center_id?: string - /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ - managers?: string[] - /** 成本中心描述 */ - description?: Lark.I18n[] - /** 生效时间 */ - effective_time: string - /** 操作原因 */ - operation_reason: string -} -export interface PatchCorehrCostCenterVersionQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface DeleteCorehrCostCenterVersionRequest { - /** 操作原因 */ - operation_reason: string -} -export interface BatchGetCorehrJobLevelRequest { - /** 职级 ID 列表 */ - job_level_ids: string[] -} -export interface CreateCorehrJobLevelRequest { - /** 职级数值 */ - level_order: number - /** 编码 */ - code?: string - /** 名称 */ - name: Lark.I18n[] - /** 描述 */ - description?: Lark.I18n[] - /** 启用 */ - active: boolean - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrJobLevelQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrJobLevelRequest { - /** 职级数值 */ - level_order?: number - /** 编码 */ - code?: string - /** 名称 */ - name?: Lark.I18n[] - /** 描述 */ - description?: Lark.I18n[] - /** 启用 */ - active?: boolean - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface PatchCorehrJobLevelQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrJobLevelQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface BatchGetCorehrJobFamilyRequest { - /** 序列 ID 列表 */ - job_family_ids: string[] -} -export interface CreateCorehrJobFamilyRequest { - /** 名称 */ - name: Lark.I18n[] - /** 启用 */ - active: boolean - /** 上级序列 */ - parent_id?: string - /** 生效时间 */ - effective_time: string - /** 失效时间 */ - expiration_time?: string - /** 编码 */ - code?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrJobFamilyQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrJobFamilyRequest { - /** 名称 */ - name?: Lark.I18n[] - /** 启用 */ - active?: boolean - /** 上级序列 */ - parent_id?: string - /** 生效时间 */ - effective_time?: string - /** 失效时间 */ - expiration_time?: string - /** 编码 */ - code?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface PatchCorehrJobFamilyQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrJobFamilyQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface CreateCorehrJobRequest { - /** 编码 */ - code?: string - /** 名称 */ - name: Lark.I18n[] - /** 描述 */ - description?: Lark.I18n[] - /** 启用 */ - active: boolean - /** 职务头衔 */ - job_title?: Lark.I18n[] - /** 序列 */ - job_family_id_list?: string[] - /** 职级 */ - job_level_id_list?: string[] - /** 工时制度，引用WorkingHoursType的ID */ - working_hours_type_id?: string - /** 生效时间 */ - effective_time: string - /** 失效时间 */ - expiration_time?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface CreateCorehrJobQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrJobRequest { - /** 编码 */ - code?: string - /** 名称 */ - name?: Lark.I18n[] - /** 描述 */ - description?: Lark.I18n[] - /** 启用 */ - active?: boolean - /** 职务头衔 */ - job_title?: Lark.I18n[] - /** 序列 */ - job_family_id_list?: string[] - /** 职级 */ - job_level_id_list?: string[] - /** 工时制度，引用WorkingHoursType的ID */ - working_hours_type_id?: string - /** 生效时间 */ - effective_time?: string - /** 失效时间 */ - expiration_time?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface PatchCorehrJobQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrJobQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 名称 */ - name?: string - /** 语言 */ - query_language?: string -} -export interface ListCorehrJobQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 名称 */ - name?: string - /** 语言 */ - query_language?: string -} -export interface CreateCorehrPreHireRequest { - /** 个人信息 */ - basic_info: Lark.BasicInfo - /** 职位信息 */ - offer_info: Lark.OfferInfo - /** 教育经历 */ - education_info?: Lark.EducationInfo[] - /** 工作经历 */ - work_experience?: Lark.WorkExperience[] - /** 招聘应用ID */ - ats_application_id?: string -} -export interface PatchCorehrPreHireRequest { - /** 招聘系统的候选人 ID */ - ats_application_id?: string - /** 入职日期 */ - hire_date?: string - /** 雇佣类型 */ - employee_type?: Lark.Enum - /** 人员编号 */ - worker_id?: string - /** 雇佣类型 */ - employee_type_id?: string - /** 引用Person ID */ - person_id?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 成本中心分摊信息 */ - cost_center_rate?: Lark.SupportCostCenterItem[] - /** 入职状态 */ - onboarding_status: Lark.Enum -} -export interface PatchCorehrPreHireQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrPreHireQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 待入职ID列表 */ - pre_hire_ids?: string[] -} -export interface SearchCorehrContractRequest { - /** 雇佣 ID 列表 */ - employment_id_list?: string[] - /** 合同ID列表 */ - contract_id_list?: string[] -} -export interface SearchCorehrContractQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface CreateCorehrContractRequest { - /** 合同开始日期 */ - effective_time: string - /** 实际结束日期 */ - expiration_time?: string - /** 雇员ID */ - employment_id: string - /** 合同类型 */ - contract_type: Lark.Enum - /** 甲方, 引用Company的ID */ - first_party_company_id: string - /** Person ID */ - person_id?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 期限类型 */ - duration_type?: Lark.Enum - /** 合同结束日期 */ - contract_end_date?: string - /** 合同编号 */ - contract_number?: string - /** 签订类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（signing_type）枚举定义部分获得 */ - signing_type?: Lark.Enum -} -export interface CreateCorehrContractQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface PatchCorehrContractRequest { - /** 合同开始日期 */ - effective_time?: string - /** 实际结束日期 */ - expiration_time?: string - /** 雇员ID */ - employment_id?: string - /** 合同类型 */ - contract_type?: Lark.Enum - /** 甲方, 引用Company的ID */ - first_party_company_id?: string - /** Person ID */ - person_id?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] - /** 期限类型 */ - duration_type?: Lark.Enum - /** 合同结束日期 */ - contract_end_date?: string - /** 合同编号 */ - contract_number?: string - /** 签订类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（signing_type）枚举定义部分获得 */ - signing_type?: Lark.Enum -} -export interface PatchCorehrContractQuery { - /** 根据client_token是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface ListCorehrContractQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface SearchCorehrProbationRequest { - /** 雇佣 ID 列表 */ - employment_ids?: string[] - /** 部门 ID 列表 */ - department_ids?: string[] - /** 试用期开始日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ - probation_start_date_start?: string - /** 试用期开始日期 - 搜索范围结束 */ - probation_start_date_end?: string - /** 试用期预计结束日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ - probation_expected_end_date_start?: string - /** 试用期预计结束日期 - 搜索范围结束 */ - probation_expected_end_date_end?: string - /** 试用期实际结束日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ - actual_probation_end_date_start?: string - /** 试用期实际结束日期 - 搜索范围结束 */ - actual_probation_end_date_end?: string - /** 转正发起日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ - initiating_time_start?: string - /** 转正发起日期 - 搜索范围结束 */ - initiating_time_end?: string - /** 试用期状态 */ - probation_status?: string - /** 试用期最终考核结果 */ - final_assessment_result?: string - /** 试用期最终考核等级 */ - final_assessment_grade?: string -} -export interface SearchCorehrProbationQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface EnableDisableAssessmentCorehrProbationRequest { - /** 启用 / 停用状态。启用后可在试用期管理页面中可见试用期考核相关的字段。 */ - active: boolean - /** 试用期考核系统入口链接，当启用功能时该字段必填。 */ - app_url?: string -} -export interface CreateCorehrProbationAssessmentRequest { - /** 试用期人员的雇佣 ID */ - employment_id: string - /** 试用期考核结果列表 */ - assessments: Lark.AssessmentForCreate[] -} -export interface CreateCorehrProbationAssessmentQuery { - /** 根据 client_token 是否一致来判断是否为同一请求 */ - client_token?: string - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface PatchCorehrProbationAssessmentRequest { - /** 考核状态 */ - assessment_status: string - /** 试用期考核结果 */ - assessment_result?: string - /** 考核得分 */ - assessment_score?: number - /** 试用期考核等级 */ - assessment_grade?: string - /** 考核评语 */ - assessment_comment?: string - /** 考核结果页面超链接 */ - assessment_detail?: string - /** 是否为最终考核结果 */ - is_final_asssessment: boolean -} -export interface PatchCorehrProbationAssessmentQuery { - /** 根据 client_token 是否一致来判断是否为同一请求 */ - client_token?: string -} -export interface QueryCorehrTransferReasonQuery { - /** 异动原因状态 */ - active?: boolean - /** 异动原因唯一标识，多条时最多数量为10 */ - transfer_reason_unique_identifier?: string[] -} -export interface QueryCorehrTransferTypeQuery { - /** 异动类型状态 */ - active?: boolean - /** 异动类型唯一标识，多条时最多数量为10 */ - transfer_type_unique_identifier?: string[] -} -export interface CreateCorehrJobChangeRequest { - /** 异动方式 */ - transfer_mode: number - /** 雇员id */ - employment_id: string - /** 异动类型唯一标识 */ - transfer_type_unique_identifier: string - /** 异动流程ID */ - flow_id?: string - /** 生效日期 */ - effective_date: string - /** 异动详细信息 */ - transfer_info: Lark.TransferInfo - /** 异动记录标识符 */ - transfer_key?: string - /** 异动发起人 ID */ - initiator_id?: string -} -export interface CreateCorehrJobChangeQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface SearchCorehrJobChangeRequest { - /** 雇员 ID 列表 */ - employment_ids?: string[] - /** 异动记录 ID 列表 */ - job_change_ids?: string[] - /** 异动状态，多个状态之间为「或」的关系 */ - statuses?: string[] -} -export interface SearchCorehrJobChangeQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface QueryCorehrOffboardingRequest { - /** 是否启用 */ - active?: boolean - /** 离职原因唯一标识列表，用于过滤，最大20个 */ - offboarding_reason_unique_identifier?: string[] -} -export interface SubmitCorehrOffboardingRequest { - /** 离职方式 */ - offboarding_mode: number - /** 雇员 id */ - employment_id: string - /** 离职日期 */ - offboarding_date: string - /** 离职原因，可通过接口 - [【查询员工离职原因列表】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query)获取 */ - offboarding_reason_unique_identifier: string - /** 离职原因说明，长度限制6000 */ - offboarding_reason_explanation?: string - /** 操作发起人 ID（employment_id），为空默认为系统发起。注意：只有操作发起人可以撤销流程 */ - initiator_id?: string - /** 是否加入离职屏蔽名单 */ - add_block_list?: boolean - /** 屏蔽原因 */ - block_reason?: string - /** 屏蔽原因说明 */ - block_reason_explanation?: string - /** 自定义字段 */ - custom_fields?: Lark.ObjectFieldData[] -} -export interface SubmitCorehrOffboardingQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface SearchCorehrOffboardingRequest { - /** 雇佣 ID 列表，为空默认查询所有离职人员 */ - employment_ids?: string[] - /** 离职审批发起时间-搜索范围开始，需要与搜索范围结束一同使用 */ - apply_initiating_time_start?: string - /** 离职审批发起时间 - 搜索范围结束 */ - apply_initiating_time_end?: string - /** 期望离职日期-搜索范围开始，需要与搜索范围结束一同使用 */ - expected_offboarding_date_start?: string - /** 期望离职日期 - 搜索范围结束 */ - expected_offboarding_date_end?: string - /** 离职日期-搜索范围开始，需要与搜索范围结束一同使用 */ - offboarding_date_start?: string - /** 离职日期 - 搜索范围结束 */ - offboarding_date_end?: string - /** 离职状态，多个状态之间为「或」的关系 */ - statuses?: string[] - /** 离职原因列表 , 可以通过【查询员工离职原因列表】接口获取 ，查询时不返回下级原因相关的离职信息 */ - reasons?: string[] - /** 离职原因（员工）列表 , 可以通过【查询员工离职原因列表】接口获取，查询时不返回下级原因相关的离职信息 */ - employee_reasons?: string[] -} -export interface SearchCorehrOffboardingQuery { - /** 分页大小，最大 100 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface CreateCorehrLeaveGrantingRecordRequest { - /** 假期类型 ID，枚举值可通过【获取假期类型列表】接口获取（若假期类型下存在假期子类，此处仅支持传入假期子类的 ID） */ - leave_type_id: string - /** 员工 ID */ - employment_id: string - /** 授予数量 */ - granting_quantity: string - /** 授予时长单位 - - 可选值有： - - - 1: 天 - - 2: 小时 */ - granting_unit: number - /** 生效时间 */ - effective_date: string - /** 失效时间 */ - expiration_date?: string - /** 授予原因 */ - reason: Lark.I18n[] - /** 自定义外部 ID，可用于避免数据重复写入（不能超过 64 字符） */ - external_id?: string -} -export interface CreateCorehrLeaveGrantingRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface LeaveTypesCorehrLeaveQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 假期类型状态（不传则为全部） - - 可选值有： - - - 1：已启用 - - - 2：已停用 */ - status?: string - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface LeaveBalancesCorehrLeaveQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大20 */ - page_size: string - /** 查询截止日期，即截止到某天余额数据的日期（不传则默认为当天） */ - as_of_date?: string - /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ - employment_id_list?: string[] - /** 用户 ID 类型 */ - user_id_type?: string - /** 查询时区 */ - time_zone?: string -} -export interface LeaveRequestHistoryCorehrLeaveQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ - employment_id_list?: string[] - /** 休假发起人 ID 列表，最大 100 个 */ - initiator_id_list?: string[] - /** - * 请假记录的状态 - * - * 可选值有： - * - * - 1：已通过 - * - 2：审批中 - * - 3：审批中（更正） - * - 4：审批中（取消休假） - * - 5：审批中（返岗） - * - 6：已返岗 - * - 7：已拒绝 - * - 8：已取消 - * - 9：已撤回 - */ - leave_request_status?: string[] - /** 假期类型 ID 列表，枚举值可通过【获取假期类型列表】接口获取 */ - leave_type_id_list?: string[] - /** 休假开始时间晚于等于的日期 */ - leave_start_date_min?: string - /** 休假开始时间早于等于的日期 */ - leave_start_date_max?: string - /** 休假结束时间晚于等于的日期 */ - leave_end_date_min?: string - /** 休假结束时间早于等于的日期 */ - leave_end_date_max?: string - /** 休假发起时间晚于等于的日期 */ - leave_submit_date_min?: string - /** 休假发起时间早于等于的日期 */ - leave_submit_date_max?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 请假记录更新时间晚于等于的时间 */ - leave_update_time_min?: string - /** 请假记录更新时间早于等于的时间 */ - leave_update_time_max?: string - /** 是否返回请假详情，若为true，将在每条请假记录的details字段返回请假详情 */ - return_detail?: boolean - /** 指定过滤长/短假类型，0表示不过滤，1表示仅获取短假，2表示仅获取长假, 默认0 */ - leave_term_type?: number - /** 请假记录所在时区 */ - time_zone?: string -} -export interface BatchGetCorehrEmployeesBpRequest { - /** 员工雇佣 ID */ - employment_ids: string[] - /** 是否获取全部 BP，true 为获取员工所在部门及来自上级部门的全部 HRBP 和属地 BP，false 为仅获取员工的直属 HRBP 和属地 BP（当员工所在部门、属地无 BP 时，会上钻找到最近的 BP），默认为 false */ - get_all?: boolean -} -export interface BatchGetCorehrEmployeesBpQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface GetByDepartmentCorehrBpRequest { - /** 部门 ID */ - department_id: string -} -export interface GetByDepartmentCorehrBpQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface ListCorehrBpQuery { - /** 分页大小，最大 500 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface QueryCorehrSecurityGroupRequest { - /** 角色列表，一次最多支持查询 50 个 */ - item_list: Lark.BpRoleOrganization[] -} -export interface QueryCorehrSecurityGroupQuery { - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string -} -export interface SearchCorehrAssignedUserRequest { - /** 角色 ID，仅支持组织类角色， 角色 ID 可通过【批量获取角色列表】接口获取 */ - role_id: string - /** 管理范围信息 */ - management_scope_list: Lark.ManagementScope[] - /** 查找方式 - - 可选值有： - - 1：只查找指定 部门/工作地点/公司/社保城市，如无授权信息则返回为空 - - 2：当指定的 部门/工作地点/公司/社保城市 无授权信息，向上查找第一个授权记录并直接返回 */ - search_method: string - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface SearchCorehrAssignedUserQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface ListCorehrSecurityGroupQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface ListCorehrProcessQuery { - /** 任务查询结束时间 (unix毫秒时间戳)，闭区间，开始时间和结束时间跨度不能超过31天 */ - modify_time_to: string - /** 查询状态列表 */ - statuses?: number[] - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size: number - /** 查询开始时间（unix毫秒时间戳），闭区间，开始时间和结束时间跨度不能超过31天 */ - modify_time_from: string - /** 流程定义ID */ - flow_definition_id?: string -} -export interface GetCorehrProcessQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface MatchCorehrCompensationStandardQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 类型 */ - department_id_type?: string - /** 雇员ID */ - employment_id: string - /** 薪资标准的关联对象，项目或者指标 */ - reference_object_api?: string - /** 薪资标准关联对象ID */ - reference_object_id: string - /** 部门ID */ - department_id?: string - /** 工作地点ID */ - work_location_id?: string - /** 公司ID */ - company_id?: string - /** 职务序列ID */ - job_family_id?: string - /** 职级ID */ - job_level_id?: string - /** 人员类型ID */ - employee_type_id?: string - /** 招聘类型 */ - recruitment_type?: string - /** 定调薪原因ID */ - cpst_change_reason_id?: string - /** 薪资方案ID */ - cpst_plan_id?: string - /** 薪级薪等ID */ - cpst_salary_level_id?: string - /** 生效时间 */ - effective_time?: string -} -export interface CombinedCreateHireJobRequest { - /** 职位编号，可传入职位的「职位编号」、「职位 ID」或者「职位序号」，将以传入的参数作为职位编号，以便双方系统的数据映射 */ - code?: string - /** 工作年限 */ - experience?: number - /** 到期日期，请使用 */ - expiry_time?: number - /** 自定义字段 */ - customized_data_list?: Lark.CombinedJobObjectValueMap[] - /** 最低职级，枚举通过接口「获取职级列表」获取 */ - min_level_id?: string - /** 最低薪资 */ - min_salary?: number - /** 职位名称 */ - title: string - /** 职位负责人，仅一位，可通过用户相关接口获取用户 id */ - job_managers: Lark.JobManager - /** 招聘流程，枚举通过接口「获取招聘流程信息」获取 */ - job_process_id: string - /** 职位流程类型 */ - process_type: number - /** 项目，枚举通过「获取项目列表」获取 */ - subject_id?: string - /** 职能分类，通过「获取职能分类」获取 */ - job_function_id?: string - /** 部门，枚举通过接口「获取部门信息列表」获取 */ - department_id: string - /** 招聘数量 */ - head_count?: number - /** 是否长期有效 */ - is_never_expired: boolean - /** 最高薪资 */ - max_salary?: number - /** 职位要求 */ - requirement?: string - /** 职位描述 */ - description?: string - /** 职位亮点 */ - highlight_list?: string[] - /** 职位类别 */ - job_type_id: string - /** 最高职级，枚举通过接口「获取职级列表」获取 */ - max_level_id?: string - /** 雇佣类型 */ - recruitment_type_id: string - /** 学历要求 */ - required_degree?: number - /** 序列 */ - job_category_id?: string - /** 工作地点，枚举通过接口「获取地址列表」获取，选择地点用途为「职位地址」 */ - address_id_list?: string[] - /** 职位属性，1是实体职位，2是虚拟职位 */ - job_attribute?: number - /** 到期日期的毫秒时间戳 */ - expiry_timestamp?: string - /** 面试登记表ID */ - interview_registration_schema_id?: string - /** 入职登记表ID */ - onboard_registration_schema_id?: string - /** 目标专业ID List */ - target_major_id_list?: string[] -} -export interface CombinedCreateHireJobQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface GetHireJobQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface ConfigHireJobQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListHireJobQuery { - /** 最早更新时间，毫秒级时间戳 */ - update_start_time?: string - /** 最晚更新时间，毫秒级时间戳 */ - update_end_time?: string - /** 分页大小, 不能超过 20 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string - /** 此次调用中使用的「职级 ID」的类型 */ - job_level_id_type?: string - /** 此次调用中使用的「序列 ID」的类型 */ - job_family_id_type?: string -} -export interface CombinedUpdateHireJobRequest { - /** 职位 ID */ - id?: string - /** 工作年限 */ - experience?: number - /** 到期日期，请使用 */ - expiry_time?: number - /** 自定义字段 */ - customized_data_list?: Lark.CombinedJobObjectValueMap[] - /** 最低职级，枚举通过接口「获取职级列表」获取 */ - min_level_id?: string - /** 最低薪资 */ - min_salary?: number - /** 职位名称 */ - title?: string - /** 职位负责人，仅一位，可通过用户相关接口获取用户 id */ - job_managers?: Lark.JobManager - /** 招聘流程，枚举通过接口「获取招聘流程信息」获取 */ - job_process_id?: string - /** 项目，枚举通过「获取项目列表」获取 */ - subject_id?: string - /** 职能分类，通过「获取职能分类」获取 */ - job_function_id?: string - /** 部门，枚举通过接口「获取部门信息列表」获取 */ - department_id?: string - /** 招聘数量 */ - head_count?: number - /** 是否长期有效 */ - is_never_expired: boolean - /** 最高薪资 */ - max_salary?: number - /** 职位要求 */ - requirement?: string - /** 职位描述 */ - description?: string - /** 职位亮点 */ - highlight_list?: string[] - /** 职位类别 */ - job_type_id: string - /** 最高职级，枚举通过接口「获取职级列表」获取 */ - max_level_id?: string - /** 学历要求 */ - required_degree?: number - /** 序列 */ - job_category_id?: string - /** 工作地点，枚举通过接口「获取地址列表」获取，选择地点用途为「职位地址」 */ - address_id_list?: string[] - /** 职位属性，1是实体职位，2是虚拟职位 */ - job_attribute?: number - /** 到期日期的毫秒时间戳 */ - expiry_timestamp?: string - /** 目标专业ID List */ - target_major_id_list?: string[] -} -export interface CombinedUpdateHireJobQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface UpdateConfigHireJobRequest { - /** Offer 申请表，枚举通过接口「获取 Offer 申请表列表」获取 */ - offer_apply_schema_id?: string - /** Offer 审批流，枚举通过接口「获取 Offer 审批流列表」获取 */ - offer_process_conf?: string - /** 建议评估人 ID 列表 */ - recommended_evaluator_id_list?: string[] - /** 更新选项，传入要更新的配置项 */ - update_option_list: number[] - /** 面试评价表，枚举通过接口「获取面试评价表列表」获取 */ - assessment_template_biz_id?: string - /** 建议面试官列表 */ - interview_round_conf_list?: Lark.JobConfigInterviewRoundConf[] - /** 关联招聘需求，支持关联多个，枚举通过接口「获取招聘需求」获取 */ - jr_id_list?: string[] - /** 面试登记表ID，当在飞书招聘「设置 - 信息登记表使用设置 - 面试登记表使用方式」中选择「HR 按职位选择登记表」时，该字段为必填；否则该字段不生效。 */ - interview_registration_schema_id?: string - /** 入职登记表ID，当在飞书招聘「设置 - 信息登记表使用设置 - 入职登记表使用方式」中选择「HR 按职位选择登记表」时，该字段为必填；否则该字段不生效。 */ - onboard_registration_schema_id?: string - /** 面试轮次类型 ID 列表 */ - interview_round_type_conf_list?: Lark.JobConfigRoundType[] - /** 关联职位列表，如职位为实体职位则关联虚拟职位id，如职位为虚拟职位则关联实体职位id */ - related_job_id_list?: string[] - /** 面试官安排面试配置 */ - interview_appointment_config?: Lark.InterviewAppointmentConfig -} -export interface UpdateConfigHireJobQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListHireJobTypeQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface RecruiterHireJobQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateHireJobRequirementRequest { - /** 招聘需求编号 */ - short_code: string - /** 需求名称 */ - name: string - /** 需求状态 */ - display_progress: number - /** 需求人数 */ - head_count: number - /** 职位性质 ID */ - recruitment_type_id: string - /** 最高职级 ID */ - max_level_id?: string - /** 最低职级 ID */ - min_level_id?: string - /** 职位序列 ID */ - sequence_id?: string - /** 需求类型 */ - category?: number - /** 需求部门 ID */ - department_id?: string - /** 需求负责人 ID 列表 */ - recruiter_id_list?: string[] - /** 需求用人经理 ID 列表 */ - jr_hiring_manager_id_list?: string[] - /** 直属上级 ID */ - direct_leader_id_list?: string[] - /** 开始日期，毫秒级时间戳 */ - start_time?: string - /** 预计完成日期，毫秒级时间戳 */ - deadline?: string - /** 招聘优先级 */ - priority?: number - /** 学历要求 */ - required_degree?: number - /** 最高薪资 */ - max_salary?: string - /** 最低薪资 */ - min_salary?: string - /** 工作地点 ID */ - address_id?: string - /** 需求描述 */ - description?: string - /** 自定义字段 */ - customized_data_list?: Lark.JobRequirementCustomizedData[] -} -export interface CreateHireJobRequirementQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface ListHireJobRequirementQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number - /** 职位ID */ - job_id?: string - /** 起始创建时间，传入毫秒级时间戳 */ - create_time_begin?: string - /** 截止创建时间，传入毫秒级时间戳 */ - create_time_end?: string - /** 起始更新时间，传入毫秒级时间戳 */ - update_time_begin?: string - /** 截止更新时间，传入毫秒级时间戳 */ - update_time_end?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface UpdateHireJobRequirementRequest { - /** 需求名称 */ - name: string - /** 需求状态 */ - display_progress: number - /** 需求人数 */ - head_count: number - /** 职位性质 ID */ - recruitment_type_id: string - /** 最高职级 ID */ - max_level_id?: string - /** 最低职级 ID */ - min_level_id?: string - /** 职位序列 ID */ - sequence_id?: string - /** 需求类型 */ - category?: number - /** 需求部门 ID */ - department_id?: string - /** 需求负责人 ID 列表 */ - recruiter_id_list?: string[] - /** 需求用人经理 ID 列表 */ - jr_hiring_manager_id_list?: string[] - /** 直属上级 ID */ - direct_leader_id_list?: string[] - /** 开始日期，毫秒级时间戳 */ - start_time?: string - /** 预计完成日期，毫秒级时间戳 */ - deadline?: string - /** 招聘优先级 */ - priority?: number - /** 学历要求 */ - required_degree?: number - /** 最高薪资 */ - max_salary?: string - /** 最低薪资 */ - min_salary?: string - /** 工作地点 ID */ - address_id?: string - /** 需求描述 */ - description?: string - /** 自定义字段 */ - customized_data_list?: Lark.JobRequirementCustomizedData[] -} -export interface UpdateHireJobRequirementQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface ListHireJobRequirementSchemaQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number -} -export interface ListHireJobProcessQuery { - /** 分页大小, 不能超过 100 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface ListHireRegistrationSchemaQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 登记表适用场景；不填表示获取全部类型信息登记表 */ - scenario?: number -} -export interface ListHireReferralWebsiteJobPostQuery { - /** 招聘流程类型 */ - process_type?: number - /** 下一页页码 */ - page_token?: string - /** 每页获取记录数量，最大10 */ - page_size?: number - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface GetHireReferralWebsiteJobPostQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface GetByApplicationHireReferralQuery { - /** 投递的 ID */ - application_id: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateHireExternalApplicationRequest { - /** 外部系统背调主键 （仅用于幂等） */ - external_id?: string - /** 职位招聘类型 */ - job_recruitment_type?: number - /** 职位名称 */ - job_title?: string - /** 简历来源 */ - resume_source?: string - /** 阶段 */ - stage?: string - /** 人才 ID */ - talent_id: string - /** 终止原因 */ - termination_reason?: string - /** 投递类型 */ - delivery_type?: number - /** 更新时间 */ - modify_time?: number - /** 终止类型 */ - termination_type?: string -} -export interface UpdateHireExternalApplicationRequest { - /** 外部系统背调主键 （仅用于幂等） */ - external_id?: string - /** 职位招聘类型 */ - job_recruitment_type?: number - /** 职位名称 */ - job_title?: string - /** 简历来源 */ - resume_source?: string - /** 阶段 */ - stage?: string - /** 人才 ID */ - talent_id: string - /** 终止原因 */ - termination_reason?: string - /** 投递类型 */ - delivery_type?: number - /** 更新时间 */ - modify_time?: number - /** 终止类型 */ - termination_type?: string -} -export interface DeleteHireExternalApplicationQuery { - /** 人才ID */ - talent_id?: string -} -export interface CreateHireExternalInterviewRequest { - /** 外部系统面试主键 （仅用于幂等） */ - external_id?: string - /** 外部投递 ID */ - external_application_id: string - /** 参与状态 */ - participate_status?: number - /** 开始时间 */ - begin_time?: number - /** 结束时间 */ - end_time?: number -} -export interface CreateHireExternalInterviewAssessmentRequest { - /** 外部系统面评主键（仅用于幂等） */ - external_id?: string - /** 面试官姓名 */ - username?: string - /** 面试结果 */ - conclusion?: number - /** 评价维度列表 */ - assessment_dimension_list?: Lark.ExternalInterviewAssessmentDimension[] - /** 综合记录 */ - content?: string - /** 外部面试 ID */ - external_interview_id: string -} -export interface CreateHireExternalBackgroundCheckRequest { - /** 外部系统背调主键 （仅用于幂等） */ - external_id?: string - /** 外部投递 ID */ - external_application_id: string - /** 背调日期 */ - date?: number - /** 背调名字 */ - name?: string - /** 背调结果 */ - result?: string - /** 背调附件ID列表 */ - attachment_id_list?: string[] -} -export interface AddToFolderHireTalentRequest { - /** 人才 ID 列表 */ - talent_id_list?: string[] - /** 文件夹 ID */ - folder_id?: string -} -export interface ListHireTalentFolderQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number - /** 用户ID类型 */ - user_id_type?: string -} -export interface BatchGetIdHireTalentRequest { - /** 手机国家区号，默认值：86，即中国大陆地区 */ - mobile_code?: string - /** 手机号，区号均采用 mobile_code 参数的值，最多 100 个 */ - mobile_number_list?: string[] - /** 邮箱信息列表，最多 100 个 */ - email_list?: string[] - /** 证件类型，可参考招聘枚举常量文档下的 IdentificationType 枚举定义 */ - identification_type?: number - /** 证件号 */ - identification_number_list?: string[] -} -export interface ListHireTalentQuery { - /** 最早更新时间，毫秒级时间戳 */ - update_start_time?: string - /** 最晚更新时间，毫秒级时间戳 */ - update_end_time?: string - /** 分页大小, 不能超过 20 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 请求控制参数 */ - query_option?: string -} -export interface GetHireTalentQuery { - /** 用户 ID 类型 */ - user_id_type?: string -} -export interface CreateHireApplicationRequest { - /** 人才ID */ - talent_id: string - /** 职位ID */ - job_id: string - /** 简历来源 ID，可通过「获取简历来源」接口查询。若简历来源类型属于「员工转岗」或「实习生转正」，人才需处于已入职状态。 */ - resume_source_id?: string - /** 意向投递城市列表，可从「获取职位信息」返回的工作地点列表获取 */ - application_preferred_city_code_list?: string[] -} -export interface TerminateHireApplicationRequest { - /** 终止原因的类型 */ - termination_type: number - /** 终止的具体原因的id列表 */ - termination_reason_list?: string[] - /** 终止备注 */ - termination_reason_note?: string -} -export interface ListHireApplicationQuery { - /** 按流程过滤，招聘流程 ID，枚举值通过接口「获取招聘流程信息」接口获取 */ - process_id?: string - /** 按招聘阶段过滤，招聘阶段 ID，枚举值通过「获取招聘流程信息」接口获取 */ - stage_id?: string - /** 按人才过滤 */ - talent_id?: string - /** 按活跃状态筛选 1=活跃投递, 2=非活跃投递, 3=全部 */ - active_status?: string - /** 职位 ID */ - job_id?: string - /** 查询游标, 由上一页结果返回, 第一页不传 */ - page_token?: string - /** 每页限制, 每页最大不超过100 */ - page_size?: number - /** 最早更新时间，毫秒级时间戳 */ - update_start_time?: string - /** 最晚更新时间，毫秒级时间戳 */ - update_end_time?: string -} -export interface ListHireEvaluationQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number - /** 投递 ID */ - application_id?: string - /** 最早更新时间，毫秒级时间戳 */ - update_start_time?: string - /** 最晚更新时间，毫秒级时间戳 */ - update_end_time?: string - /** 用户ID类型 */ - user_id_type?: string -} -export interface ListHireQuestionnaireQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number - /** 投递 ID */ - application_id?: string - /** 面试 ID */ - interview_id?: string - /** 最早更新时间 */ - update_start_time?: string - /** 最晚更新时间 */ - update_end_time?: string -} -export interface ListHireInterviewQuery { - /** 分页大小，不能超过 100 */ - page_size?: number - /** 查询游标, 由上一页结果返回, 第一页不传 */ - page_token?: string - /** 投递 ID */ - application_id?: string - /** 面试 ID */ - interview_id?: string - /** 最早开始时间，格式为时间戳 */ - start_time?: string - /** 最晚开始时间，格式为时间戳 */ - end_time?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateHireOfferRequest { - /** 投递 ID */ - application_id: string - /** 模板 ID */ - schema_id: string - /** Offer 类型 */ - offer_type?: number - /** Offer 基本信息 */ - basic_info: Lark.OfferBasicInfo - /** Offer 薪资信息 */ - salary_info?: Lark.OfferSalaryInfo - /** 自定义信息 */ - customized_info_list?: Lark.OfferCustomizedInfo[] -} -export interface CreateHireOfferQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface UpdateHireOfferRequest { - /** 模板 ID */ - schema_id: string - /** Offer 基本信息 */ - basic_info: Lark.OfferBasicInfo - /** Offer 薪资信息 */ - salary_info?: Lark.OfferSalaryInfo - /** 自定义信息 */ - customized_info_list?: Lark.OfferCustomizedInfo[] -} -export interface UpdateHireOfferQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface OfferHireApplicationQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface GetHireOfferQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface ListHireOfferQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size?: number - /** 人才 ID */ - talent_id: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface OfferStatusHireOfferRequest { - /** offer状态 */ - offer_status: number - /** offer 失效时间，当反馈状态是「offer已发出」时为必填项 */ - expiration_date?: string - /** 终止原因列表，当反馈状态是「候选人已拒绝」时为必填项；最多传入50个 */ - termination_reason_id_list?: string[] - /** 终止备注 */ - termination_reason_note?: string -} -export interface InternOfferStatusHireOfferRequest { - /** 更新入/离职状态的操作 */ - operation: string - /** 入职表单信息（当 operation 为 confirm_onboarding 时，该字段必填） */ - onboarding_info?: Lark.InternOfferOnboardingInfo - /** 离职表单信息（当 operation 为 offboard 时，该字段必填） */ - offboarding_info?: Lark.InternOfferOffboardingInfo -} -export interface PatchHireEhrImportTaskRequest { - /** 失败原因 */ - fail_reason?: string - /** 跳转链接 */ - redirect_url?: string - /** 状态 */ - state: number -} -export interface TransferOnboardHireApplicationRequest { - /** 实际入职时间 */ - actual_onboard_time?: number - /** 预期转正时间 */ - expected_conversion_time?: number - /** 招聘需求 ID */ - job_requirement_id?: string - /** 操作人 UserID */ - operator_id?: string - /** 候选人办公地点 ID ，枚举可通过接口「获取地址列表」获取，将用于候选人内推奖规则判断 */ - onboard_city_code?: string - /** 候选人入职部门 ID ，枚举可通过接口「获取部门信息列表」获取，将用于候选人内推奖规则判断 */ - department?: string - /** 候选人直属上级 UserID ，将用于候选人内推奖规则判断 */ - leader?: string - /** 候选人序列 ID ，枚举可通过接口「获取职务分类列表」获取，将用于候选人内推奖规则判断 */ - sequence?: string - /** 候选人职级 ID ，枚举可通过接口「获取职级列表」获取，将用于候选人内推奖规则判断 */ - level?: string - /** 候选人入职人员类型 ID，可通过接口人力资源管理平台「获取员工类型列表」获取，将用于候选人内推奖规则判断 */ - employee_type?: string -} -export interface TransferOnboardHireApplicationQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface PatchHireEmployeeRequest { - /** 修改状态操作 */ - operation: number - conversion_info?: Lark.EmployeeConversionInfo - overboard_info?: Lark.EmployeeOverboardInfo -} -export interface PatchHireEmployeeQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface GetByApplicationHireEmployeeQuery { - /** 投递ID */ - application_id: string - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface GetHireEmployeeQuery { - /** 用户 ID 类型 */ - user_id_type?: string - /** 此次调用中使用的部门 ID 的类型 */ - department_id_type?: string -} -export interface CreateHireNoteRequest { - /** 人才ID */ - talent_id: string - /** 投递ID */ - application_id?: string - /** 创建人ID */ - creator_id?: string - /** 内容 */ - content: string - /** 备注私密属性（默认为公开） */ - privacy?: number -} -export interface CreateHireNoteQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchHireNoteRequest { - /** 备注内容 */ - content: string -} -export interface PatchHireNoteQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetHireNoteQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListHireNoteQuery { - /** 每页限制, 每页最大不超过100 */ - page_size?: number - /** 查询游标, 由上一页结果返回, 第一页不传 */ - page_token?: string - /** 人才ID */ - talent_id: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListHireResumeSourceQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface CreateHireEcoAccountCustomFieldRequest { - /** 适用范围 */ - scope: number - /** 自定义字段列表 */ - custom_field_list: Lark.EcoAccountCustomFieldData[] -} -export interface BatchUpdateHireEcoAccountCustomFieldRequest { - /** 适用范围 */ - scope: number - /** 自定义字段列表 */ - custom_field_list: Lark.EcoAccountCustomFieldData[] -} -export interface BatchDeleteHireEcoAccountCustomFieldRequest { - /** 适用范围 */ - scope?: number - /** 要删除的自定义字段的 key 列表 */ - custom_field_key_list?: string[] -} -export interface CreateHireEcoBackgroundCheckCustomFieldRequest { - /** 背调账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 自定义字段列表 */ - custom_field_list: Lark.EcoBackgroundCheckCustomFieldData[] -} -export interface BatchUpdateHireEcoBackgroundCheckCustomFieldRequest { - /** 背调账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 自定义字段列表 */ - custom_field_list: Lark.EcoBackgroundCheckCustomFieldData[] -} -export interface BatchDeleteHireEcoBackgroundCheckCustomFieldRequest { - /** 背调账号 ID，可在「账号绑定」事件中获取 */ - account_id: string -} -export interface CreateHireEcoBackgroundCheckPackageRequest { - /** 背调账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 背调套餐列表 */ - package_list: Lark.EcoBackgroundCheckPackageData[] - /** 附加调查项列表 */ - additional_item_list?: Lark.EcoBackgroundCheckPackageAdditionalItem[] -} -export interface BatchUpdateHireEcoBackgroundCheckPackageRequest { - /** 背调账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 背调套餐列表 */ - package_list: Lark.EcoBackgroundCheckPackageData[] - /** 附加调查项列表 */ - additional_item_list?: Lark.EcoBackgroundCheckPackageAdditionalItem[] -} -export interface BatchDeleteHireEcoBackgroundCheckPackageRequest { - /** 背调账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 要删除的套餐 ID 列表，删除套餐不影响已安排的背调 */ - package_id_list?: string[] - /** 要删除的附加调查项 ID 列表，删除附加调查项不影响已安排的背调 */ - additional_item_id_list?: string[] -} -export interface UpdateProgressHireEcoBackgroundCheckRequest { - /** 背调 ID，招聘侧的 ID */ - background_check_id: string - /** 阶段 ID，同一背调订单此 ID 不能重复 */ - stage_id: string - /** 背调阶段英文名称 */ - stage_en_name?: string - /** 背调阶段名称 */ - stage_name: string - /** 进入到此背调阶段的时间 */ - stage_time: string - /** 阶段性背调结果 */ - result?: string - /** 报告列表 */ - report_file_list?: Lark.EcoBackgroundCheckReportFile[] -} -export interface UpdateResultHireEcoBackgroundCheckRequest { - /** 背调 ID */ - background_check_id: string - /** 背调结果 */ - result: string - /** 背调结果时间 */ - result_time: string - /** 报告列表 */ - report_file_list?: Lark.EcoBackgroundCheckReportFile[] -} -export interface CancelHireEcoBackgroundCheckRequest { - /** 背调 ID */ - background_check_id: string -} -export interface CreateHireEcoExamPaperRequest { - /** 账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 试卷列表 */ - paper_list: Lark.EcoExamPaperData[] -} -export interface BatchUpdateHireEcoExamPaperRequest { - /** 账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 试卷列表 */ - paper_list: Lark.EcoExamPaperData[] -} -export interface BatchDeleteHireEcoExamPaperRequest { - /** 背调账号 ID，可在「账号绑定」事件中获取 */ - account_id: string - /** 试卷 ID 列表 */ - paper_id_list: string[] -} -export interface LoginInfoHireEcoExamRequest { - /** 状态码，0-成功 非零-错误码 */ - result?: number - /** 成功或失败的描述信息 */ - msg?: string - /** 笔试作答信息 */ - exam_login_info: Lark.EcoExamLoginInfo -} -export interface UpdateResultHireEcoExamRequest { - /** 笔试结果 */ - result: string - /** 笔试结果时间 */ - result_time?: string - /** 报告列表 */ - report_list?: Lark.EcoExamResultReport[] - /** 详细评价结果 */ - detail_list?: Lark.EcoExamResultDetail[] -} -export interface CreateHireReferralAccountRequest { - /** 电话 */ - mobile?: Lark.Mobile - /** 邮箱 */ - email?: string -} -export interface WithdrawHireReferralAccountRequest { - /** 请求提现的奖励类型 */ - withdraw_bonus_type?: number[] - /** 提现单ID，请求时由请求方提供，后续关于本次提现操作的交互都以此提现单ID为标识进行，需要保证唯一,用于保证提现的幂等性，传入重复ID会返回对应提现单提取的金额明细 */ - external_order_id?: string -} -export interface ReconciliationHireReferralAccountRequest { - /** 按时间范围进行对账时 时间段的起始交易时间 */ - start_trans_time?: string - /** 按时间范围进行对账时 时间段的截止交易时间 */ - end_trans_time?: string - /** 交易信息 */ - trade_details?: Lark.TradeDetail[] -} -export interface GetHireAttachmentQuery { - /** 附件类型 */ - type?: number -} -export interface CreateOkrPeriodRequest { - /** 周期规则 id */ - period_rule_id: string - /** 周期起始年月 */ - start_month: string -} -export interface PatchOkrPeriodRequest { - /** 周期显示状态 */ - status: number -} -export interface ListOkrPeriodQuery { - /** 分页标志page_token */ - page_token?: string - /** 分页大小，默认10 */ - page_size?: number -} -export interface ListOkrUserOkrQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 请求列表的偏移，offset>=0 */ - offset: string - /** 列表长度，0-10 */ - limit: string - /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn */ - lang?: string - /** period_id列表，最多10个 */ - period_ids?: string[] -} -export interface BatchGetOkrQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** OKR ID 列表，最多10个 */ - okr_ids: string[] - /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn，请求 Query中 */ - lang?: string -} -export interface CreateOkrProgressRecordRequest { - /** 进展来源 */ - source_title: string - /** 进展来源链接 */ - source_url: string - /** 目标id，与target_type对应 */ - target_id: string - /** 目标类型 */ - target_type: number - /** 进展详情 富文本格式 */ - content: Lark.ContentBlock - /** pc进展来源链接 */ - source_url_pc?: string - /** mobile进展来源链接 */ - source_url_mobile?: string -} -export interface CreateOkrProgressRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateOkrProgressRecordRequest { - /** 进展详情 富文本格式 */ - content: Lark.ContentBlock -} -export interface UpdateOkrProgressRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetOkrProgressRecordQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UploadOkrImageForm { - /** 图片 */ - data: Blob - /** 图片的目标ID */ - target_id: string - /** - * 图片使用的目标类型 - * - * 可选值有： - * - * - 2：okr的O - * - 3：okr的KR - */ - target_type: 2 | 3 -} -export interface CreateHumanAuthenticationIdentityRequest { - /** 姓名 */ - identity_name: string - /** 身份证号 */ - identity_code: string - /** 手机号 */ - mobile?: string -} -export interface CreateHumanAuthenticationIdentityQuery { - /** 用户的唯一标识（使用的ID类型见下一参数描述，不同ID类型的区别和获取，参考文档：[如何获得 User ID、Open ID 和 Union ID？](/ssl:ttdoc/home/user-identity-introduction/how-to-get)） */ - user_id: string - /** 用户ID类型 open_id/user_id/union_id */ - user_id_type?: string -} -export interface DeleteAcsVisitorQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateAcsVisitorRequest { - /** 访客信息 */ - user: Lark.UserExternal -} -export interface CreateAcsVisitorQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeviceBindAcsRuleExternalRequest { - /** 设备id */ - device_id: string - /** 权限组id列表 */ - rule_ids: string[] -} -export interface GetAcsRuleExternalQuery { - /** 设备id */ - device_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteAcsRuleExternalQuery { - /** 权限组id */ - rule_id: string -} -export interface CreateAcsRuleExternalRequest { - /** 权限组信息 */ - rule: Lark.Rule -} -export interface CreateAcsRuleExternalQuery { - /** 权限组id-为空创建,不为空则更新 */ - rule_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface PatchAcsUserRequest { - /** 用户特征 */ - feature?: Lark.Feature -} -export interface PatchAcsUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetAcsUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListAcsUserQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateAcsUserFaceQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetAcsUserFaceQuery { - /** 裁剪图 */ - is_cropped?: boolean - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListAcsAccessRecordQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 记录开始时间，单位秒 */ - from: number - /** 记录结束时间，单位秒， - 时间跨度不能超过30天 */ - to: number - /** 门禁设备 ID */ - device_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListPerformanceSemesterQuery { - /** 周期开始时间 */ - start_time?: string - /** 周期结束时间 */ - end_time?: string -} -export interface FindByUserListPerformanceStageTaskRequest { - /** 周期ID，可以通过「查询周期」接口获得 */ - semester_id: string - /** 用户ID列表 */ - user_id_lists: string[] - /** 任务分类(不传默认包含所有) */ - task_option_lists?: number[] - /** 查询晚于当前时间截止的环节 */ - after_time?: string - /** 查询早于当前时间截止的环节 */ - before_time?: string -} -export interface FindByUserListPerformanceStageTaskQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface FindByPagePerformanceStageTaskRequest { - /** 周期ID，可以通过「查询周期」接口获得 */ - semester_id: string - /** 任务分类(不传默认包含所有) */ - task_option_lists?: number[] - /** 查询晚于当前时间截止的环节 */ - after_time?: string - /** 查询早于当前时间截止的环节 */ - before_time?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface FindByPagePerformanceStageTaskQuery { - /** 调用结果中用户ID的类型 */ - user_id_type?: string -} -export interface QueryPerformanceReviewDataRequest { - /** 查询范围的开始日期，毫秒级时间戳，开始日期不能晚于截止日期 */ - start_time: string - /** 查询范围的截止日期，毫秒级时间戳，截止日期不能早于开始日期 */ - end_time: string - /** 评估环节类型，目前仅支持上级评估环节和结果沟通环节（不传默认包含所有的环节） - - **可选值有**： - - `leader_review`：上级评估环节 - - `communication_and_open_result`：结果沟通环节 */ - stage_types: string[] - /** 评估环节状态（不传默认包含所有的状态） - - **可选值有**： - - `0`：未开始，任务的开始时间未到达 - - `1`：待完成，任务的开始时间到达而截止时间未到达，且任务未完成 - - `2`：已截止，任务的截止时间已到达，且任务未完成 - - `3`：已完成，任务已完成 */ - stage_progress?: number[] - /** 评估周期 ID 列表，semester_id 是一个评估周期的唯一标识，可以通过「我的评估」页面 url 获取，也可通过本接口的返回值获取 */ - semester_id_list?: string[] - /** 被评估人 ID 列表 */ - reviewee_user_id_list: string[] - /** 环节更新时间晚于，可筛选出在此时间之后，有内容提交的环节数据 */ - updated_later_than?: string -} -export interface QueryPerformanceReviewDataQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateLingoDraftRequest { - /** 实体词 Id */ - id?: string - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 外部 id 关联数据 */ - outer_info?: Lark.OuterInfo - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string - /** 国际化的词条释义 */ - i18n_descs?: Lark.I18nEntryDesc[] -} -export interface CreateLingoDraftQuery { - /** 词库ID */ - repo_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateLingoDraftRequest { - /** 实体词 Id */ - id?: string - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string - /** 国际化的词条释义 */ - i18n_descs?: Lark.I18nEntryDesc[] -} -export interface UpdateLingoDraftQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateLingoEntityRequest { - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 外部 id 关联数据 */ - outer_info?: Lark.OuterInfo - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string - /** 国际化的词条释义 */ - i18n_descs?: Lark.I18nEntryDesc[] -} -export interface CreateLingoEntityQuery { - /** 词库 ID */ - repo_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateLingoEntityRequest { - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 外部 id 关联数据 */ - outer_info?: Lark.OuterInfo - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string - /** 国际化的词条释义 */ - i18n_descs?: Lark.I18nEntryDesc[] -} -export interface UpdateLingoEntityQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface DeleteLingoEntityQuery { - /** 数据提供方（使用时需要将路径中的词条 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ - provider?: string - /** 外部唯一 id（使用时需要将路径中的词条 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ - outer_id?: string -} -export interface GetLingoEntityQuery { - /** 数据提供方（使用时需要将路径中的实体词 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ - provider?: string - /** 外部唯一 id（使用时需要将路径中的实体词 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ - outer_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListLingoEntityQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 数据提供方【可用来过滤数据】 */ - provider?: string - /** 词库 id */ - repo_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface MatchLingoEntityRequest { - /** 实体词主关键词、全称、别名全匹配 */ - word: string -} -export interface MatchLingoEntityQuery { - /** 词库ID */ - repo_id?: string -} -export interface SearchLingoEntityRequest { - /** 搜索关键词 */ - query?: string - /** 分类筛选 */ - classification_filter?: Lark.ClassificationFilter - /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */ - sources?: number[] - /** 创建者 */ - creators?: string[] -} -export interface SearchLingoEntityQuery { - /** 每页返回的词条量 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 词库ID */ - repo_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface HighlightLingoEntityRequest { - /** 需要被识别实体词内容的一句话（不要超过1000字） */ - text: string -} -export interface ListLingoClassificationQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 词库ID */ - repo_id?: string -} -export interface UploadLingoFileForm { - /** - * 文件名称，当前仅支持上传图片且图片格式为以下六种：icon、bmp、gif、png、jpeg、webp - * - * 数据校验规则： - * - * - 长度范围：1 字符 ～ 100 字符 - */ - name: string - /** 二进制文件内容，高宽像素在 320-4096 像素之间，大小在 3KB-10MB 的图片 */ - file: Blob -} -export interface ListDataSecurityAndComplianceOpenapiLogRequest { - /** 飞书开放平台定义的API */ - api_keys?: string[] - /** 以秒为单位的起始时间戳 */ - start_time?: number - /** 以秒为单位的终止时间戳 */ - end_time?: number - /** 在开发者后台——凭证与基础信息页面查看的app_id（cli_xxx），指调用openapi的应用 */ - app_id?: string - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ - page_token?: string -} -export interface ListAdminAuditInfoQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 起始时间戳 */ - latest?: number - /** 终止时间戳 */ - oldest?: number - /** 事件名称 */ - event_name?: string - /** 操作者类型 */ - operator_type?: string - /** 操作者值 */ - operator_value?: string - /** 模块 */ - event_module?: number - /** 下一页分页的token */ - page_token?: string - /** 分页参数 */ - page_size?: number -} -export interface GetMinutesMinuteStatisticsQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetMinutesMinuteQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface SearchWorkplaceWorkplaceAccessDataQuery { - /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ - from_date: string - /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ - to_date: string - /** 分页大小，最小为 1，最大为 200，默认为 20。 */ - page_size: number - /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ - page_token?: string -} -export interface SearchWorkplaceCustomWorkplaceAccessDataQuery { - /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ - from_date: string - /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ - to_date: string - /** 分页大小，最小为 1，最大为 200，默认为 20。 */ - page_size: number - /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ - page_token?: string - /** 定制化工作台id.非必填,不填的时候,返回所有定制化工作台数据。 */ - custom_workplace_id?: string -} -export interface SearchWorkplaceWorkplaceBlockAccessDataQuery { - /** 数据检索开始时间，精确到日。格式yyyy-MM-dd。 */ - from_date: string - /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ - to_date: string - /** 分页大小，最小为 1，最大为 200，默认为 20。 */ - page_size: number - /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ - page_token?: string - /** 小组件id */ - block_id?: string -} -export interface FavouriteApplicationQuery { - /** 应用信息的语言版本 */ - language?: string - /** 分页标记,不填表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 单页需求最大个数（最大 100），不传默认10个 */ - page_size?: number -} -export interface RecommendApplicationQuery { - /** 应用信息的语言版本 */ - language?: string - /** 推荐应用类型，默认为用户不可移除的推荐应用列表 */ - recommend_type?: string - /** 分页标记,不填表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 单页需求最大个数（最大 100），不传默认10个 */ - page_size?: number -} -export interface ListApplicationAppRecommendRuleQuery { - /** 分页大小 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface BindMdmUserAuthDataRelationRequest { - /** 数据类型编码 */ - root_dimension_type: string - /** 数据编码列表 */ - sub_dimension_types: string[] - /** 授权人的lark id */ - authorized_user_ids: string[] - /** uams系统中应用id */ - uams_app_id: string -} -export interface BindMdmUserAuthDataRelationQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UnbindMdmUserAuthDataRelationRequest { - /** 数据类型编码 */ - root_dimension_type: string - /** 数据编码列表 */ - sub_dimension_types: string[] - /** 授权人的lark id */ - authorized_user_ids: string[] - /** uams系统中应用id */ - uams_app_id: string -} -export interface UnbindMdmUserAuthDataRelationQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface QueryReportRuleQuery { - /** 规则名称 */ - rule_name: string - /** 是否包括已删除，默认未删除 */ - include_deleted?: number - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface RemoveReportRuleViewRequest { - /** 列表为空删除规则下全用户视图，列表不为空删除指定用户视图，大小限制200。 */ - user_ids?: string[] -} -export interface RemoveReportRuleViewQuery { - user_id_type?: string -} -export interface QueryReportTaskRequest { - /** 提交开始时间时间戳 */ - commit_start_time: number - /** 提交结束时间时间戳 */ - commit_end_time: number - /** 汇报规则ID */ - rule_id?: string - /** 用户ID */ - user_id?: string - /** 分页标识符 */ - page_token: string - /** 单次分页返回的条数 */ - page_size: number -} -export interface QueryReportTaskQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: 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 CreateBaikeDraftRequest { - /** 实体词 Id */ - id?: string - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 外部 id 关联数据 */ - outer_info?: Lark.OuterInfo - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string -} -export interface CreateBaikeDraftQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateBaikeDraftRequest { - /** 实体词 Id */ - id?: string - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string -} -export interface UpdateBaikeDraftQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface CreateBaikeEntityRequest { - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 外部 id 关联数据 */ - outer_info?: Lark.OuterInfo - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string -} -export interface CreateBaikeEntityQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface UpdateBaikeEntityRequest { - /** 词条名 */ - main_keys: Lark.Term[] - /** 别名 */ - aliases?: Lark.Term[] - /** 详情描述 */ - description?: string - /** 相关数据 */ - related_meta?: Lark.RelatedMeta - /** 外部 id 关联数据 */ - outer_info?: Lark.OuterInfo - /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ - rich_text?: string -} -export interface UpdateBaikeEntityQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetBaikeEntityQuery { - /** 外部系统 */ - provider?: string - /** 词条在外部系统中对应的唯一 ID */ - outer_id?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListBaikeEntityQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 相关外部系统【可用来过滤词条数据】 */ - provider?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface MatchBaikeEntityRequest { - /** 搜索关键词，将与词条名、别名进行精准匹配 */ - word: string -} -export interface SearchBaikeEntityRequest { - /** 搜索关键词 */ - query?: string - /** 分类筛选 */ - classification_filter?: Lark.ClassificationFilter - /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */ - sources?: number[] - /** 创建者 */ - creators?: string[] -} -export interface SearchBaikeEntityQuery { - /** 每页返回的词条量 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface HighlightBaikeEntityRequest { - /** 需要识别百科词条的内容（不超过1000字） */ - text: string -} -export interface ExtractBaikeEntityRequest { - /** 需要被提取百科实体词的文本（不会过滤租户已成为百科词条的内容） */ - text?: string -} -export interface ListBaikeClassificationQuery { - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string -} -export interface UploadBaikeFileForm { - /** - * 文件名称，当前仅支持上传图片且图片格式为以下六种：icon、bmp、gif、png、jpeg、webp - * - * 数据校验规则： - * - * - 长度范围：1 字符 ～ 100 字符 - */ - name: string - /** 二进制文件内容，高宽像素在 320-4096 像素之间，大小在 3KB-10MB 的图片 */ - file: Blob -} -export interface ListContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 填写该字段表示获取部门下所有用户，选填。 */ - department_id?: string - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface UpdateContactUserRequest { - /** 用户名 */ - name: string - /** 英文名 */ - en_name?: string - /** 别名 */ - nickname?: string - /** 邮箱 */ - email?: string - /** 手机号 */ - mobile: string - /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ - mobile_visible?: boolean - /** 性别 */ - gender?: number - /** 头像的文件Key */ - avatar_key?: string - /** 用户所在部门ID */ - department_ids: string[] - /** 用户直属上级 */ - leader_user_id?: string - /** 城市 */ - city?: string - /** 国家 */ - country?: string - /** 工位 */ - work_station?: string - /** 入职时间 */ - join_time?: number - /** 工号 */ - employee_no?: string - /** 员工类型 */ - employee_type: number - /** 用户排序信息 */ - orders?: Lark.UserOrder[] - /** 自定义属性 */ - custom_attrs?: Lark.UserCustomAttr[] - /** 企业邮箱 */ - enterprise_email?: string - /** 职务 */ - job_title?: string - /** 是否冻结用户 */ - is_frozen?: boolean -} -export interface UpdateContactUserQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string -} -export interface ListContactDepartmentQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 此次调用中使用的部门ID的类型 */ - department_id_type?: string - /** 父部门的ID，填上获取部门下所有子部门，此处填写的 ID 必须是 department_id_type 指定的 ID。 */ - parent_department_id?: string - /** 是否递归获取子部门 */ - fetch_child?: boolean - /** 分页大小 */ - page_size?: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string -} -export interface ListBitableAppTableRecordQuery { - /** 视图 id - - 注意：如 filter 或 sort 有值，view_id 会被忽略。 */ - view_id?: string - /** 筛选参数 - - 注意： - - 1.筛选记录的表达式不超过2000个字符。 - - 2.不支持对“人员”以及“关联字段”的属性进行过滤筛选，如人员的 OpenID。 - - 3.仅支持字段在页面展示字符值进行筛选。 - - 详细请参考[记录筛选开发指南](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter) */ - filter?: string - /** 排序参数 - - 注意： - - 1.表达式需要不超过1000字符。 - - 2.不支持对带“公式”和“关联字段”的表的使用。 - - 3.使用引号将字段名称和顺序逆序连接起来。 */ - sort?: string - /** 字段名称 */ - field_names?: string - /** 控制多行文本字段数据的返回格式，true 表示以数组形式返回。 - - 注意： - - 1.多行文本中如果有超链接部分，则会返回链接的 URL。 - - 2.目前可以返回多行文本中 URL 类型为多维表格链接、飞书 doc、飞书 sheet的URL类型以及@人员的数据结构。 */ - text_field_as_array?: boolean - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string - /** 控制公式、查找引用是否显示完整的原样返回结果 */ - display_formula_ref?: boolean - /** 控制是否返回自动计算的字段，例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`，true 表示返回 */ - automatic_fields?: boolean - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ - page_token?: string - /** 分页大小 */ - page_size?: number -} -export interface ListHireApplicationInterviewQuery { - /** 分页大小，不能超过 50 */ - page_size: number - /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ - page_token?: string - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface GetHireJobManagerQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface ListCorehrSubregionQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 省份/行政区id，填写后只查询该省份/行政区下的城市/区域 */ - subdivision_id?: string -} -export interface ListCorehrSubdivisionQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string - /** 国家/地区id，填写后只查询该国家/地区下的省份/行政区 */ - country_region_id?: string -} -export interface ListCorehrCountryRegionQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface ListCorehrCurrencyQuery { - /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ - page_token?: string - /** 每页获取记录数量，最大100 */ - page_size: string -} -export interface GetCorehrPersonQuery { - /** 此次调用中使用的用户ID的类型 */ - user_id_type?: string -} -export interface SetCheckboardAccessCodeVcRoomConfigRequest { - /** 设置节点范围 */ - scope: number - /** 国家/地区ID scope为2，3时需要此参数 */ - country_id?: string - /** 城市ID scope为3时需要此参数 */ - district_id?: string - /** 建筑ID scope为4，5时需要此参数 */ - building_id?: string - /** 楼层 scope为5时需要此参数 */ - floor_name?: string - /** 会议室ID scope为6时需要此参数 */ - room_id?: string - /** 有效天数 */ - valid_day: number -} -export interface SetRoomAccessCodeVcRoomConfigRequest { - /** 设置节点范围 */ - scope: number - /** 国家/地区ID scope为2，3时需要此参数 */ - country_id?: string - /** 城市ID scope为3时需要此参数 */ - district_id?: string - /** 建筑ID scope为4，5时需要此参数 */ - building_id?: string - /** 楼层 scope为5时需要此参数 */ - floor_name?: string - /** 会议室ID scope为6时需要此参数 */ - room_id?: string - /** 有效天数 */ - valid_day: number -} -export interface QueryVcRoomConfigQuery { - /** 查询节点范围 */ - scope: number - /** 国家/地区ID scope为2，3时需要此参数 */ - country_id?: string - /** 城市ID scope为3时需要此参数 */ - district_id?: string - /** 建筑ID scope为4，5时需要此参数 */ - building_id?: string - /** 楼层 scope为5时需要此参数 */ - floor_name?: string - /** 会议室ID scope为6时需要此参数 */ - room_id?: string - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} -export interface SetVcRoomConfigRequest { - /** 设置节点范围 */ - scope: number - /** 国家/地区ID scope为2，3时需要此参数 */ - country_id?: string - /** 城市ID scope为3时需要此参数 */ - district_id?: string - /** 建筑ID scope为4，5时需要此参数 */ - building_id?: string - /** 楼层 scope为5时需要此参数 */ - floor_name?: string - /** 会议室ID scope为6时需要此参数 */ - room_id?: string - /** 会议室设置 */ - room_config: Lark.RoomConfig -} -export interface SetVcRoomConfigQuery { - /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ - user_id_type?: string -} - -export interface ListEventOutboundIpResponse extends Paginated {} -export interface TenantAccessTokenInternalAuthResponse extends BaseResponse { - /** 访问 token */ - tenant_access_token?: string - /** app_access_token 过期时间 */ - expire?: number -} -export interface AppAccessTokenInternalAuthResponse 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 TenantAccessTokenAuthResponse extends BaseResponse { - /** 访问 token */ - tenant_access_token?: string - /** app_access_token 过期时间 */ - expire?: number -} -export interface CreateAuthenOidcAccessTokenResponse extends Lark.TokenInfo {} -export interface CreateAuthenOidcRefreshAccessTokenResponse extends Lark.TokenInfo {} -export interface GetAuthenUserInfoResponse extends Lark.UserInfo {} -export interface QueryPassportSessionResponse { - mask_sessions?: Lark.MaskSession[] -} -export interface ListContactScopeResponse extends Paginated {} -export interface CreateContactUserResponse { - user?: Lark.User -} -export interface PatchContactUserResponse { - user?: Lark.User -} -export interface GetContactUserResponse { - user?: Lark.User -} -export interface BatchContactUserResponse { - /** 查询到的用户信息，其中异常的用户ID不返回结果。 */ - items?: Lark.User[] -} -export interface FindByDepartmentContactUserResponse extends Paginated {} -export interface BatchGetIdContactUserResponse { - /** 手机号或者邮箱对应的用户id信息 */ - user_list?: Lark.UserContactInfo[] -} -export interface CreateContactGroupResponse { - /** 用户组ID */ - group_id: string -} -export interface GetContactGroupResponse { - /** 用户组详情 */ - group: Lark.Group -} -export interface SimplelistContactGroupResponse extends Paginated {} -export interface MemberBelongContactGroupResponse extends Paginated {} -export interface ListContactCustomAttrResponse extends Paginated {} -export interface CreateContactEmployeeTypeEnumResponse { - /** 创建人员类型接口 */ - employee_type_enum?: Lark.EmployeeTypeEnum -} -export interface UpdateContactEmployeeTypeEnumResponse { - employee_type_enum?: Lark.EmployeeTypeEnum -} -export interface ListContactEmployeeTypeEnumResponse extends Paginated {} -export interface CreateContactDepartmentResponse { - department?: Lark.Department -} -export interface PatchContactDepartmentResponse { - department?: Lark.Department -} -export interface UpdateContactDepartmentResponse { - department?: Lark.Department -} -export interface GetContactDepartmentResponse { - department?: Lark.Department -} -export interface BatchContactDepartmentResponse { - /** 查询到的部门信息，其中异常的部门ID不返回结果。 */ - items?: Lark.Department[] -} -export interface ChildrenContactDepartmentResponse extends Paginated {} -export interface ParentContactDepartmentResponse extends Paginated {} -export interface SearchContactDepartmentResponse extends Paginated {} -export interface CreateContactUnitResponse { - /** 单位的自定义ID */ - unit_id: string -} -export interface ListDepartmentContactUnitResponse extends Paginated {} -export interface GetContactUnitResponse { - /** 单位信息 */ - unit: Lark.Unit -} -export interface ListContactUnitResponse extends Paginated {} -export interface BatchAddContactGroupMemberResponse { - /** 成员添加操作结果 */ - results?: Lark.MemberResult[] -} -export interface SimplelistContactGroupMemberResponse extends Paginated {} -export interface CreateContactFunctionalRoleResponse { - /** 角色ID，在单租户下唯一 */ - role_id: string -} -export interface BatchCreateContactFunctionalRoleMemberResponse { - /** 批量新增角色成员结果集 */ - results?: Lark.FunctionalRoleMemberResult[] -} -export interface BatchDeleteContactFunctionalRoleMemberResponse { - /** 批量新增角色成员结果集 */ - result?: Lark.FunctionalRoleMemberResult[] -} -export interface ScopesContactFunctionalRoleMemberResponse { - /** 批量更新角色成员管理范围结果集 */ - results?: Lark.FunctionalRoleMemberResult[] -} -export interface GetContactFunctionalRoleMemberResponse { - /** 成员的管理范围 */ - member?: Lark.FunctionalRoleMember -} -export interface ListContactFunctionalRoleMemberResponse extends Paginated {} -export interface CreateContactJobLevelResponse { - /** 职级信息 */ - job_level?: Lark.JobLevel -} -export interface UpdateContactJobLevelResponse { - /** 职级信息 */ - job_level?: Lark.JobLevel -} -export interface GetContactJobLevelResponse { - /** 职级信息 */ - job_level?: Lark.JobLevel -} -export interface ListContactJobLevelResponse extends Paginated {} -export interface CreateContactJobFamilyResponse { - /** 序列信息 */ - job_family?: Lark.JobFamily -} -export interface UpdateContactJobFamilyResponse { - /** 更新后的序列信息 */ - job_family?: Lark.JobFamily -} -export interface GetContactJobFamilyResponse { - /** 序列信息 */ - job_family?: Lark.JobFamily -} -export interface ListContactJobFamilyResponse extends Paginated {} -export interface GetContactJobTitleResponse { - /** 职务信息 */ - job_title?: Lark.JobTitle -} -export interface ListContactJobTitleResponse extends Paginated {} -export interface GetContactWorkCityResponse { - /** 工作城市信息 */ - work_city?: Lark.WorkCity -} -export interface ListContactWorkCityResponse extends Paginated {} -export interface CreateImMessageResponse extends Lark.Message {} -export interface ReplyImMessageResponse extends Lark.Message {} -export interface UpdateImMessageResponse extends Lark.Message {} -export interface ForwardImMessageResponse extends Lark.Message {} -export interface MergeForwardImMessageResponse { - /** 合并转发生成的新消息 */ - message?: Lark.Message - /** 无效的消息ID列表 */ - invalid_message_id_list?: string[] -} -export interface ForwardImThreadResponse extends Lark.Message {} -export interface ReadUsersImMessageResponse extends Paginated {} -export interface ListImMessageResponse extends Paginated {} -export interface GetImMessageResponse { - /** message[] */ - items?: Lark.Message[] -} -export interface UrgentAppImMessageResponse { - /** 无效的用户id */ - invalid_user_id_list: string[] -} -export interface UrgentSmsImMessageResponse { - /** 无效的用户id */ - invalid_user_id_list: string[] -} -export interface UrgentPhoneImMessageResponse { - /** 无效的用户id */ - invalid_user_id_list: string[] -} -export interface ReadUserImBatchMessageResponse { - read_user?: Lark.BatchMessageReadUser -} -export interface GetProgressImBatchMessageResponse { - /** 消息发送进度 */ - batch_message_send_progress?: Lark.BatchMessageSendProgress - /** 消息撤回进度 */ - batch_message_recall_progress?: Lark.BatchMessageRecallProgress -} -export interface CreateImImageResponse { - /** 图片的key */ - image_key: string -} -export interface CreateImFileResponse { - /** 文件的key */ - file_key: string -} -export interface CreateImMessageReactionResponse extends Lark.MessageReaction {} -export interface DeleteImMessageReactionResponse extends Lark.MessageReaction {} -export interface ListImMessageReactionResponse extends Paginated {} -export interface CreateImPinResponse { - pin?: Lark.Pin -} -export interface ListImPinResponse extends Paginated {} -export interface CreateImChatResponse { - /** 群ID */ - chat_id?: string - /** 群头像URL */ - avatar?: string - /** 群名称 */ - name?: string - /** 群描述 */ - description?: string - /** 群国际化名称 */ - i18n_names?: Lark.I18nNames - /** 群主 ID */ - owner_id?: string - /** 群主 ID 类型 */ - owner_id_type?: string - /** 谁可以加急 */ - urgent_setting?: string - /** 谁可以发起视频会议 */ - video_conference_setting?: string - /** 加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 - /** 群模式 */ - chat_mode?: string - /** 群类型 */ - chat_type?: string - /** 优先级最高的一个群tag */ - chat_tag?: string - /** 是否是外部群 */ - external?: boolean - /** tenant key */ - tenant_key?: string - /** 入群消息可见性 */ - join_message_visibility?: string - /** 出群消息可见性 */ - leave_message_visibility?: string - /** 加群审批 */ - membership_approval?: string - /** 发言权限 */ - moderation_permission?: string - /** 防泄密模式设置 */ - restricted_mode_setting?: Lark.RestrictedModeSetting -} -export interface GetImChatResponse { - /** 群头像URL */ - avatar?: string - /** 群名称 */ - name?: string - /** 群描述 */ - description?: string - /** 群国际化名称 */ - i18n_names?: Lark.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的类型(open_id/user_id/union_id) */ - owner_id_type?: string - /** 群主ID */ - owner_id?: string - /** 用户管理员列表 */ - user_manager_id_list?: string[] - /** 机器人管理员列表 */ - bot_manager_id_list?: string[] - /** 群模式 */ - chat_mode?: string - /** 群类型 */ - chat_type?: string - /** 优先级最高的一个群tag */ - chat_tag?: string - /** 入群消息可见性 */ - join_message_visibility?: string - /** 出群消息可见性 */ - leave_message_visibility?: string - /** 加群审批 */ - membership_approval?: string - /** 发言权限 */ - moderation_permission?: string - /** 是否是外部群 */ - external?: boolean - /** tenant key */ - tenant_key?: string - /** 群成员人数 */ - user_count?: string - /** 群机器人数 */ - bot_count?: string - /** 防泄密模式设置 */ - restricted_mode_setting?: Lark.RestrictedModeSetting - /** 谁可以加急 */ - urgent_setting?: string - /** 谁可以发起视频会议 */ - video_conference_setting?: string -} -export interface ListImChatResponse extends Paginated {} -export interface SearchImChatResponse extends Paginated {} -export interface GetImChatModerationResponse extends Paginated {} -export interface LinkImChatResponse { - /** 群分享链接 */ - share_link?: string - /** 分享链接过期时间戳（秒级） */ - expire_time?: string - /** 分享链接是否永久有效 */ - is_permanent?: boolean -} -export interface AddManagersImChatManagersResponse { - /** 群目前的管理员id */ - chat_managers?: string[] - /** 群目前的管理员bot id */ - chat_bot_managers?: string[] -} -export interface DeleteManagersImChatManagersResponse { - /** 群目前的管理员id */ - chat_managers?: string[] - /** 群目前的管理员bot id */ - chat_bot_managers?: string[] -} -export interface CreateImChatMembersResponse { - /** ID无效的成员列表 */ - invalid_id_list?: string[] - /** ID不存在的成员列表 */ - not_existed_id_list?: string[] - /** 等待群主或管理员审批的成员ID列表 */ - pending_approval_id_list?: string[] -} -export interface DeleteImChatMembersResponse { - /** 无效成员列表 */ - invalid_id_list?: string[] -} -export interface GetImChatMembersResponse extends Paginated {} -export interface IsInChatImChatMembersResponse { - /** 用户或者机器人是否在群中 */ - is_in_chat?: boolean -} -export interface GetImChatAnnouncementResponse { - /** CCM 文档序列化信息 */ - content?: string - /** 文档当前版本号 纯数字 */ - revision?: string - /** 文档生成的时间戳（秒） */ - create_time?: string - /** 消息更新的时间戳（秒） */ - update_time?: string - /** 文档所有者id类型， open_id/user_id/union_id/app_id */ - owner_id_type?: string - /** 文档所有者id */ - owner_id?: string - /** 文档最新修改者id类型， open_id/user_id/union_id/app_id */ - modifier_id_type?: string - /** 文档最新修改者id */ - modifier_id?: string -} -export interface CreateImChatTabResponse { - /** 群标签列表 */ - chat_tabs?: Lark.ChatTab[] -} -export interface DeleteTabsImChatTabResponse { - /** 群标签列表 */ - chat_tabs?: Lark.ChatTab[] -} -export interface UpdateTabsImChatTabResponse { - /** 群标签列表 */ - chat_tabs?: Lark.ChatTab[] -} -export interface SortTabsImChatTabResponse { - /** 群标签列表 */ - chat_tabs?: Lark.ChatTab[] -} -export interface ListTabsImChatTabResponse { - /** 会话标签页 */ - chat_tabs?: Lark.ChatTab[] -} -export interface CreateImChatMenuTreeResponse { - /** 追加后群内现有菜单 */ - menu_tree?: Lark.ChatMenuTree -} -export interface DeleteImChatMenuTreeResponse { - /** 群内现有菜单 */ - menu_tree?: Lark.ChatMenuTree -} -export interface PatchImChatMenuItemResponse { - chat_menu_item?: Lark.ChatMenuItem -} -export interface SortImChatMenuTreeResponse { - /** 排序后群内菜单 */ - menu_tree?: Lark.ChatMenuTree -} -export interface GetImChatMenuTreeResponse { - /** 群内所有菜单 */ - menu_tree?: Lark.ChatMenuTree -} -export interface ListDrivev1FileResponse extends Paginated {} -export interface CreateFolderDrivev1FileResponse { - /** 创建文件夹的token */ - token?: string - /** 创建文件夹的访问url */ - url?: string -} -export interface BatchQueryDrivev1MetaResponse { - metas: Lark.Meta[] - failed_list?: Lark.MetaFailed[] -} -export interface GetDrivev1FileStatisticsResponse { - /** 文档token */ - file_token?: string - /** 文档类型 */ - file_type?: string - /** 文档统计信息 */ - statistics?: Lark.FileStatistics -} -export interface CopyDrivev1FileResponse { - /** 复制后的文件资源 */ - file?: Lark.File -} -export interface MoveDrivev1FileResponse { - /** 异步任务id，移动文件夹时返回 */ - task_id?: string -} -export interface DeleteDrivev1FileResponse { - /** 异步任务id，删除文件夹时返回 */ - task_id?: string -} -export interface CreateShortcutDrivev1FileResponse { - /** 返回创建成功的shortcut节点 */ - succ_shortcut_node?: Lark.File -} -export interface TaskCheckDrivev1FileResponse { - /** 异步任务的执行状态 */ - status?: string -} -export interface UploadAllDrivev1MediaResponse { - file_token?: string -} -export interface BatchGetTmpDownloadUrlDrivev1MediaResponse { - /** 临时下载列表 */ - tmp_download_urls?: Lark.TmpDownloadUrl[] -} -export interface UploadPrepareDrivev1MediaResponse { - /** 分片上传事务ID */ - upload_id?: string - /** 分片大小策略 */ - block_size?: number - /** 分片数量 */ - block_num?: number -} -export interface UploadFinishDrivev1MediaResponse { - file_token?: string -} -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?: Lark.ImportTask -} -export interface CreateDrivev1ExportTaskResponse { - /** 导出任务ID */ - ticket?: string -} -export interface GetDrivev1ExportTaskResponse { - /** 导出结果 */ - result?: Lark.ExportTask -} -export interface ListDrivev1FileViewRecordResponse extends Paginated {} -export interface CreateDrivev1FileVersionResponse extends Lark.Version {} -export interface GetDrivev1FileVersionResponse extends Lark.Version {} -export interface ListDrivev1FileVersionResponse extends Paginated {} -export interface AuthDrivev1PermissionMemberResponse { - /** 是否有权限 */ - auth_result: boolean -} -export interface ListDrivev1PermissionMemberResponse { - /** 返回的列表数据 */ - items?: Lark.Member[] -} -export interface CreateDrivev1PermissionMemberResponse { - /** 本次添加权限的用户信息 */ - member?: Lark.BaseMember -} -export interface UpdateDrivev1PermissionMemberResponse { - /** 本次更新权限的用户信息 */ - member?: Lark.BaseMember -} -export interface CreateDrivev1PermissionPublicPasswordResponse { - /** 密码 */ - password?: string -} -export interface UpdateDrivev1PermissionPublicPasswordResponse { - /** 密码 */ - password?: string -} -export interface GetDrivev1PermissionPublicResponse { - /** 返回的文档公共设置 */ - permission_public?: Lark.PermissionPublic -} -export interface PatchDrivev1PermissionPublicResponse { - /** 本次更新后的文档公共设置 */ - permission_public?: Lark.PermissionPublic -} -export interface GetDrivev2PermissionPublicResponse { - /** 返回的文档公共设置 */ - permission_public?: Lark.PermissionPublic -} -export interface PatchDrivev2PermissionPublicResponse { - /** 本次更新后文档公共设置 */ - permission_public?: Lark.PermissionPublic -} -export interface ListDrivev1FileCommentResponse extends Paginated {} -export interface BatchQueryDrivev1FileCommentResponse { - /** 评论的相关信息、回复的信息、回复分页的信息 */ - items?: Lark.FileComment[] -} -export interface CreateDrivev1FileCommentResponse extends Lark.FileComment {} -export interface GetDrivev1FileCommentResponse extends Lark.FileComment {} -export interface ListDrivev1FileCommentReplyResponse extends Paginated {} -export interface GetDocxDocumentResponse { - /** 文档信息 */ - document?: Lark.Document -} -export interface RawContentDocxDocumentResponse { - /** 文档纯文本 */ - content?: string -} -export interface ListDocxDocumentBlockResponse extends Paginated {} -export interface CreateDocxDocumentResponse { - /** 新建文档的文档信息 */ - document?: Lark.Document -} -export interface GetDocxDocumentBlockResponse { - /** 查询的 Block 的信息 */ - block?: Lark.Block -} -export interface GetDocxDocumentBlockChildrenResponse extends Paginated {} -export interface CreateDocxDocumentBlockChildrenResponse { - /** 所添加的孩子的 Block 信息 */ - children?: Lark.Block[] - /** 当前 block children 创建成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识，更新请求中使用此值表示幂等的进行此次更新 */ - client_token: string -} -export interface PatchDocxDocumentBlockResponse { - /** 更新后的 block 信息 */ - block?: Lark.Block - /** 当前更新成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识，更新请求中使用此值表示幂等的进行此次更新 */ - client_token: string -} -export interface BatchUpdateDocxDocumentBlockResponse { - /** 批量更新的 Block */ - blocks?: Lark.Block[] - /** 当前更新成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识，更新请求中使用此值表示幂等的进行此次更新 */ - client_token: string -} -export interface BatchDeleteDocxDocumentBlockChildrenResponse { - /** 当前删除操作成功后文档的版本号 */ - document_revision_id?: number - /** 操作的唯一标识，更新请求中使用此值表示幂等的进行此次更新 */ - client_token: string -} -export interface ListBoardWhiteboardNodeResponse { - /** 查询结果 */ - nodes?: Lark.WhiteboardNode[] -} -export interface GetSheetsSpreadsheetResponse { - spreadsheet?: Lark.GetSpreadsheet -} -export interface CreateSheetsSpreadsheetResponse { - /** 表格信息 */ - spreadsheet?: Lark.Spreadsheet -} -export interface GetSheetsSpreadsheetSheetResponse { - sheet?: Lark.Sheet -} -export interface QuerySheetsSpreadsheetSheetResponse { - /** 工作表信息 */ - sheets?: Lark.Sheet[] -} -export interface FindSheetsSpreadsheetSheetResponse { - /** 查找返回符合条件的信息 */ - find_result?: Lark.FindReplaceResult -} -export interface ReplaceSheetsSpreadsheetSheetResponse { - /** 符合查找条件并替换的单元格信息 */ - replace_result?: Lark.FindReplaceResult -} -export interface GetSheetsSpreadsheetSheetFilterResponse { - sheet_filter_info?: Lark.SheetFilterInfo -} -export interface GetSheetsSpreadsheetSheetFilterViewResponse { - /** 筛选视图信息，包括 id、name、range */ - filter_view?: Lark.FilterView -} -export interface QuerySheetsSpreadsheetSheetFilterViewResponse { - /** 子表的所有筛选视图信息，id、name、range */ - items?: Lark.FilterView[] -} -export interface CreateSheetsSpreadsheetSheetFilterViewResponse { - /** 创建的筛选视图的 id 、name、range */ - filter_view?: Lark.FilterView -} -export interface PatchSheetsSpreadsheetSheetFilterViewResponse { - /** 更新后的筛选视图的 id 、name、range */ - filter_view?: Lark.FilterView -} -export interface GetSheetsSpreadsheetSheetFilterViewConditionResponse { - /** 筛选的条件 */ - condition?: Lark.FilterViewCondition -} -export interface QuerySheetsSpreadsheetSheetFilterViewConditionResponse { - /** 筛选视图设置的所有筛选条件 */ - items?: Lark.FilterViewCondition[] -} -export interface CreateSheetsSpreadsheetSheetFilterViewConditionResponse { - /** 创建的筛选条件 */ - condition?: Lark.FilterViewCondition -} -export interface UpdateSheetsSpreadsheetSheetFilterViewConditionResponse { - /** 更新后的筛选条件 */ - condition?: Lark.FilterViewCondition -} -export interface GetSheetsSpreadsheetSheetFloatImageResponse { - float_image?: Lark.FloatImage -} -export interface QuerySheetsSpreadsheetSheetFloatImageResponse { - /** 子表的所有浮动图片信息 */ - items?: Lark.FloatImage[] -} -export interface CreateSheetsSpreadsheetSheetFloatImageResponse { - float_image?: Lark.FloatImage -} -export interface PatchSheetsSpreadsheetSheetFloatImageResponse { - float_image?: Lark.FloatImage -} -export interface CopyBitableAppResponse { - app?: Lark.App -} -export interface CreateBitableAppResponse { - app?: Lark.App -} -export interface GetBitableAppResponse { - app?: Lark.DisplayApp -} -export interface UpdateBitableAppResponse { - app?: Lark.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 extends Paginated {} -export interface CopyBitableAppDashboardResponse { - /** 多维表格 block_id */ - block_id?: string - /** block 名称 */ - name?: string -} -export interface ListBitableAppDashboardResponse extends Paginated {} -export interface PatchBitableAppTableViewResponse { - view?: Lark.AppTableView -} -export interface GetBitableAppTableViewResponse { - view?: Lark.AppTableView -} -export interface ListBitableAppTableViewResponse extends Paginated {} -export interface CreateBitableAppTableViewResponse { - view?: Lark.AppTableView -} -export interface PatchBitableAppTableFormResponse { - /** 表单元数据信息 */ - form: Lark.AppTableForm -} -export interface GetBitableAppTableFormResponse { - /** 表单元数据信息 */ - form: Lark.AppTableForm -} -export interface PatchBitableAppTableFormFieldResponse { - /** 更新后的field值 */ - field?: Lark.AppTableFormPatchedField -} -export interface ListBitableAppTableFormFieldResponse extends Paginated {} -export interface GetBitableAppTableRecordResponse { - record?: Lark.AppTableRecord -} -export interface SearchBitableAppTableRecordResponse extends Paginated {} -export interface CreateBitableAppTableRecordResponse { - record?: Lark.AppTableRecord -} -export interface UpdateBitableAppTableRecordResponse { - record?: Lark.AppTableRecord -} -export interface DeleteBitableAppTableRecordResponse extends Lark.DeleteRecord {} -export interface BatchCreateBitableAppTableRecordResponse { - /** 本次请求新增的记录列表 */ - records?: Lark.AppTableRecord[] -} -export interface BatchUpdateBitableAppTableRecordResponse { - /** 更新后的记录 */ - records?: Lark.AppTableRecord[] -} -export interface BatchDeleteBitableAppTableRecordResponse { - /** 记录删除结果 */ - records?: Lark.DeleteRecord[] -} -export interface ListBitableAppTableFieldResponse extends Paginated {} -export interface CreateBitableAppTableFieldResponse { - field?: Lark.AppTableField -} -export interface UpdateBitableAppTableFieldResponse { - field?: Lark.AppTableField -} -export interface DeleteBitableAppTableFieldResponse { - /** 字段唯一标识id */ - field_id?: string - /** 是否已删除 */ - deleted?: boolean -} -export interface ListBitableAppRoleResponse extends Paginated {} -export interface CreateBitableAppRoleResponse { - role?: Lark.AppRole -} -export interface UpdateBitableAppRoleResponse { - role?: Lark.AppRole -} -export interface ListBitableAppRoleMemberResponse extends Paginated {} -export interface ListWikiSpaceResponse extends Paginated {} -export interface GetWikiSpaceResponse { - space?: Lark.Space -} -export interface CreateWikiSpaceResponse { - space?: Lark.Space -} -export interface CreateWikiSpaceMemberResponse { - member?: Lark.Member -} -export interface DeleteWikiSpaceMemberResponse { - /** 成员信息 */ - member: Lark.Member -} -export interface UpdateWikiSpaceSettingResponse { - setting?: Lark.Setting -} -export interface CreateWikiSpaceNodeResponse { - node?: Lark.Node -} -export interface GetNodeWikiSpaceResponse { - /** 节点信息 */ - node?: Lark.Node -} -export interface ListWikiSpaceNodeResponse extends Paginated {} -export interface MoveWikiSpaceNodeResponse { - /** 移动后的节点信息 */ - node?: Lark.Node -} -export interface CopyWikiSpaceNodeResponse { - /** copy后的节点 */ - node: Lark.Node -} -export interface MoveDocsToWikiWikiSpaceNodeResponse { - /** 移动后的知识库token */ - wiki_token?: string - /** 任务id */ - task_id?: string - /** 是否提交了文档迁入申请 */ - applied?: boolean -} -export interface GetWikiTaskResponse { - /** 任务结果 */ - task: Lark.TaskResult -} -export interface SearchWikiNodeResponse extends Paginated {} -export interface GetDrivev1FileSubscriptionResponse { - /** 文档订阅信息 */ - subscription?: Lark.FileSubscription -} -export interface CreateDrivev1FileSubscriptionResponse { - /** 本次增加的文档订阅信息 */ - subscription?: Lark.FileSubscription -} -export interface PatchDrivev1FileSubscriptionResponse { - /** 本次修改的文档订阅信息 */ - subscription?: Lark.FileSubscription -} -export interface CreateCalendarResponse { - calendar?: Lark.Calendar -} -export interface PrimaryCalendarResponse { - /** 主日历列表 */ - calendars?: Lark.UserCalendar[] -} -export interface GetCalendarResponse extends Lark.Calendar {} -export interface ListCalendarFreebusyResponse { - /** 日历上请求时间区间内的忙闲信息 */ - freebusy_list?: Lark.Freebusy[] -} -export interface ListCalendarResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下次请求需要带上的分页标记，90 天有效期 */ - page_token?: string - /** 下次请求需要带上的增量同步标记，90 天有效期 */ - sync_token?: string - /** 分页加载的日历数据列表 */ - calendar_list?: Lark.Calendar[] -} -export interface PatchCalendarResponse { - calendar?: Lark.Calendar -} -export interface SearchCalendarResponse extends Paginated {} -export interface SubscribeCalendarResponse { - calendar?: Lark.Calendar -} -export interface CreateCalendarCalendarAclResponse extends Lark.CalendarAcl {} -export interface ListCalendarCalendarAclResponse extends Paginated {} -export interface CreateCalendarCalendarEventResponse { - event?: Lark.CalendarEvent -} -export interface PatchCalendarCalendarEventResponse { - event?: Lark.CalendarEvent -} -export interface GetCalendarCalendarEventResponse { - event?: Lark.CalendarEvent -} -export interface ListCalendarCalendarEventResponse { - /** 是否有下一页数据 */ - has_more?: boolean - /** 下次请求需要带上的分页标记，90 天有效期 */ - page_token?: string - /** 下次请求需要带上的增量同步标记，90 天有效期 */ - sync_token?: string - /** 日程列表 */ - items?: Lark.CalendarEvent[] -} -export interface SearchCalendarCalendarEventResponse extends Paginated {} -export interface InstancesCalendarCalendarEventResponse extends Paginated {} -export interface InstanceViewCalendarCalendarEventResponse { - /** 日程instance列表 */ - items?: Lark.Instance[] -} -export interface CreateCalendarCalendarEventMeetingChatResponse { - /** 会议群ID */ - meeting_chat_id?: string - /** 群分享链接 */ - applink?: string -} -export interface CreateCalendarTimeoffEventResponse extends Lark.TimeoffEvent {} -export interface CreateCalendarCalendarEventAttendeeResponse { - /** 被添加的参与人列表 */ - attendees?: Lark.CalendarEventAttendee[] -} -export interface ListCalendarCalendarEventAttendeeResponse extends Paginated {} -export interface ListCalendarCalendarEventAttendeeChatMemberResponse extends Paginated {} -export interface GenerateCaldavConfCalendarSettingResponse { - /** caldav密码 */ - password?: string - /** caldav用户名 */ - user_name?: string - /** 服务器地址 */ - server_address?: string - /** 设备名 */ - device_name?: string -} -export interface CreateCalendarExchangeBindingResponse extends Lark.ExchangeBinding {} -export interface GetCalendarExchangeBindingResponse extends Lark.ExchangeBinding {} -export interface ApplyVcReserveResponse { - reserve?: Lark.Reserve - reserve_correction_check_info?: Lark.ReserveCorrectionCheckInfo -} -export interface UpdateVcReserveResponse { - reserve?: Lark.Reserve - reserve_correction_check_info?: Lark.ReserveCorrectionCheckInfo -} -export interface GetVcReserveResponse { - reserve?: Lark.Reserve -} -export interface GetActiveMeetingVcReserveResponse { - meeting?: Lark.Meeting -} -export interface InviteVcMeetingResponse { - /** 邀请结果 */ - invite_results?: Lark.MeetingInviteStatus[] -} -export interface KickoutVcMeetingResponse { - /** 踢出结果 */ - kickout_results?: Lark.MeetingParticipantResult[] -} -export interface SetHostVcMeetingResponse { - /** 会中当前主持人 */ - host_user?: Lark.MeetingUser -} -export interface GetVcMeetingResponse { - meeting?: Lark.Meeting -} -export interface ListByNoVcMeetingResponse extends Paginated {} -export interface GetVcMeetingRecordingResponse { - recording?: Lark.MeetingRecording -} -export interface GetDailyVcReportResponse { - /** 会议报告 */ - meeting_report?: Lark.Report -} -export interface GetTopUserVcReportResponse { - /** top用户列表 */ - top_user_report?: Lark.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: number - /** 文件下载地址 */ - url?: string - /** 文件token */ - file_token?: string - /** 失败信息 */ - fail_msg?: string -} -export interface CreateVcRoomLevelResponse { - room_level?: Lark.RoomLevel -} -export interface GetVcRoomLevelResponse { - room_level?: Lark.RoomLevel -} -export interface MgetVcRoomLevelResponse { - items?: Lark.RoomLevel[] -} -export interface ListVcRoomLevelResponse extends Paginated {} -export interface SearchVcRoomLevelResponse { - /** 层级id列表 */ - level_ids?: string[] -} -export interface CreateVcRoomResponse { - room?: Lark.Room -} -export interface GetVcRoomResponse { - room?: Lark.Room -} -export interface MgetVcRoomResponse { - items?: Lark.Room[] -} -export interface ListVcRoomResponse extends Paginated {} -export interface SearchVcRoomResponse extends Paginated {} -export interface GetVcScopeConfigResponse { - /** 当前节点的配置，根据层级顺序从底向上进行合并计算后的结果；如果当前节点某个值已配置，则取该节点的值，否则会从该节点的父层级节点获取，如果父节点依然未配置，则继续向上递归获取；若所有节点均未配置，则该值返回为空 */ - current_config?: Lark.ScopeConfig - /** 所有节点的原始配置，按照层级顺序从底向上返回；如果某节点某个值未配置，则该值返回为空 */ - origin_configs?: Lark.ScopeConfig[] -} -export interface ReserveScopeVcReserveConfigResponse { - /** 预定审批设置 */ - approve_config?: Lark.ApprovalConfig - /** 预定时间设置 */ - time_config?: Lark.TimeConfig - /** 预定范围设置 */ - reserve_scope_config?: Lark.ReserveScopeConfig -} -export interface GetVcReserveConfigFormResponse { - /** 预定表单 */ - reserve_form_config: Lark.ReserveFormConfig -} -export interface GetVcReserveConfigAdminResponse { - /** 预定管理员/部门 */ - reserve_admin_config: Lark.ReserveAdminConfig -} -export interface GetVcReserveConfigDisableInformResponse { - /** 会议室禁用通知配置 */ - disable_inform?: Lark.DisableInformConfig -} -export interface GetVcMeetingListResponse extends Paginated {} -export interface GetVcParticipantListResponse extends Paginated {} -export interface GetVcParticipantQualityListResponse extends Paginated {} -export interface GetVcResourceReservationListResponse extends Paginated {} -export interface ListVcAlertResponse extends Paginated {} -export interface CreateAttendanceShiftResponse { - /** 班次 */ - shift?: Lark.Shift -} -export interface GetAttendanceShiftResponse extends Lark.Shift {} -export interface QueryAttendanceShiftResponse extends Lark.Shift {} -export interface ListAttendanceShiftResponse extends Paginated {} -export interface CreateAttendanceGroupResponse { - group?: Lark.Group -} -export interface GetAttendanceGroupResponse extends Lark.Group {} -export interface SearchAttendanceGroupResponse { - /** 考勤组列表 */ - group_list?: Lark.GroupMeta[] -} -export interface ListAttendanceGroupResponse extends Paginated {} -export interface BatchCreateAttendanceUserDailyShiftResponse { - /** 班表信息列表 */ - user_daily_shifts?: Lark.UserDailyShift[] -} -export interface QueryAttendanceUserDailyShiftResponse { - /** 班表信息列表 */ - user_daily_shifts?: Lark.UserDailyShift[] -} -export interface UpdateAttendanceUserStatsViewResponse { - /** 视图 */ - view?: Lark.UserStatsView -} -export interface QueryAttendanceUserStatsFieldResponse { - user_stats_field?: Lark.UserStatsField -} -export interface QueryAttendanceUserStatsViewResponse { - view?: Lark.UserStatsView -} -export interface QueryAttendanceUserStatsDataResponse { - /** 用户统计数据 */ - user_datas?: Lark.UserStatsData[] - /** 无权限获取的用户列表 */ - invalid_user_list?: string[] -} -export interface QueryAttendanceUserApprovalResponse { - /** 审批结果列表 */ - user_approvals?: Lark.UserApproval[] -} -export interface CreateAttendanceUserApprovalResponse { - /** 审批信息 */ - user_approval?: Lark.UserApproval -} -export interface ProcessAttendanceApprovalInfoResponse { - /** 审批信息 */ - approval_info?: Lark.ApprovalInfo -} -export interface CreateAttendanceUserTaskRemedyResponse { - /** 补卡审批信息 */ - user_remedy?: Lark.UserTaskRemedy -} -export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyResponse { - /** 用户可补卡时间 */ - user_allowed_remedys?: Lark.UserAllowedRemedy[] -} -export interface QueryAttendanceUserTaskRemedyResponse { - /** 补卡记录列表 */ - user_remedys?: Lark.UserTaskRemedy[] -} -export interface BatchCreateAttendanceUserFlowResponse { - /** 打卡流水记录列表 */ - flow_records?: Lark.UserFlow[] -} -export interface GetAttendanceUserFlowResponse extends Lark.UserFlow {} -export interface QueryAttendanceUserFlowResponse { - /** 打卡记录列表 */ - user_flow_results?: Lark.UserFlow[] -} -export interface QueryAttendanceUserTaskResponse { - /** 打卡任务列表 */ - user_task_results?: Lark.UserTask[] - /** 无效用户工号列表 */ - invalid_user_ids?: string[] - /** 没有权限用户工号列表 */ - unauthorized_user_ids?: string[] -} -export interface ModifyAttendanceUserSettingResponse { - /** 用户设置 */ - user_setting?: Lark.UserSetting -} -export interface QueryAttendanceUserSettingResponse { - /** 用户设置信息列表 */ - user_settings?: Lark.UserSetting[] -} -export interface UploadAttendanceFileResponse { - file?: Lark.File -} -export interface GetAttendanceLeaveEmployExpireRecordResponse { - /** 员工过期日期的授予记录 */ - records: Lark.LeaveEmployExpireRecord[] -} -export interface PatchAttendanceLeaveAccrualRecordResponse { - /** 员工过期日期的授予记录 */ - record: Lark.LeaveAccrualRecord -} -export interface CreateApprovalResponse { - /** 审批定义 Code */ - approval_code?: string - /** 审批定义 id */ - approval_id?: string -} -export interface CreateApprovalInstanceResponse { - /** 审批实例 Code */ - instance_code: string -} -export interface PreviewApprovalInstanceResponse { - /** 预览节点信息 */ - preview_nodes?: Lark.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: string - /** 用户的唯一标识id */ - uuid: string - /** json字符串，控件值 */ - form: string - /** 审批任务列表 */ - task_list: Lark.InstanceTask[] - /** 评论列表 */ - comment_list: Lark.InstanceComment[] - /** 审批动态 */ - timeline: Lark.InstanceTimeline[] - /** 修改的原实例 code,仅在查询修改实例时显示该字段 */ - modified_instance_code?: string - /** 撤销的原实例 code,仅在查询撤销实例时显示该字段 */ - reverted_instance_code?: string - /** 审批定义 Code */ - approval_code: string - /** 单据是否被撤销 */ - reverted?: boolean - /** 审批实例 Code */ - instance_code: string -} -export interface ListApprovalInstanceResponse extends Paginated {} -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 extends Paginated {} -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?: Lark.ApprovalCreateExternal - /** 可见人列表 */ - viewers?: Lark.ApprovalCreateViewers[] - /** 国际化文案 */ - i18n_resources?: Lark.I18nResource[] - /** 流程管理员 */ - managers?: string[] -} -export interface CreateApprovalExternalInstanceResponse { - /** 同步的实例数据 */ - data?: Lark.ExternalInstance -} -export interface CheckApprovalExternalInstanceResponse { - /** 更新时间不一致的实例信息 */ - diff_instances?: Lark.ExteranlInstanceCheckResponse[] -} -export interface ListApprovalExternalTaskResponse extends Paginated {} -export interface QueryApprovalInstanceResponse extends Paginated {} -export interface SearchCcApprovalInstanceResponse { - /** 查询返回条数 */ - count?: number - /** 审批实例列表 */ - cc_list?: Lark.CcSearchItem[] - /** 翻页 Token */ - page_token?: string - /** 是否有更多任务可供拉取 */ - has_more?: boolean -} -export interface SearchApprovalTaskResponse { - /** 查询返回条数 */ - count?: number - /** 审批任务列表 */ - task_list?: Lark.TaskSearchItem[] - /** 翻页 Token */ - page_token?: string - /** 是否有更多任务可供拉取 */ - has_more?: boolean -} -export interface QueryApprovalTaskResponse extends Paginated {} -export interface AgentEmailHelpdeskAgentResponse { - /** agent emails */ - agents?: string -} -export interface GetHelpdeskAgentSchedulesResponse { - /** schedules of an agent */ - agent_schedule?: Lark.AgentSchedule -} -export interface ListHelpdeskAgentScheduleResponse { - /** schedule of all agent */ - agent_schedules?: Lark.AgentSchedule[] -} -export interface CreateHelpdeskAgentSkillResponse { - agent_skill_id?: string -} -export interface GetHelpdeskAgentSkillResponse { - /** agent skill */ - agent_skill?: Lark.AgentSkill -} -export interface ListHelpdeskAgentSkillResponse { - /** list of agent groups */ - agent_skills?: Lark.AgentSkill[] -} -export interface ListHelpdeskAgentSkillRuleResponse { - /** all rules for agent skill */ - rules?: Lark.AgentSkillRule[] -} -export interface StartServiceHelpdeskTicketResponse { - /** chat id */ - chat_id: string -} -export interface GetHelpdeskTicketResponse { - /** ticket detail */ - ticket?: Lark.Ticket -} -export interface ListHelpdeskTicketResponse { - /** the total count */ - total?: number - tickets?: Lark.Ticket[] -} -export interface CustomizedFieldsHelpdeskTicketResponse { - /** user customized fields */ - user_customized_fields?: Lark.UserCustomizedField[] - /** ticket customized fields */ - ticket_customized_fields?: Lark.TicketCustomizedField[] -} -export interface CreateHelpdeskTicketMessageResponse { - /** chat消息open ID */ - message_id?: string -} -export interface ListHelpdeskTicketMessageResponse { - /** list of ticket messages */ - messages?: Lark.TicketMessage[] - /** total number of messages */ - total?: number -} -export interface CreateHelpdeskBotMessageResponse { - message_id?: string -} -export interface GetHelpdeskTicketCustomizedFieldResponse extends Lark.TicketCustomizedField {} -export interface ListHelpdeskTicketCustomizedFieldResponse extends Paginated {} -export interface CreateHelpdeskFaqResponse { - /** faq detail */ - faq?: Lark.Faq -} -export interface GetHelpdeskFaqResponse { - /** faq detail */ - faq?: Lark.Faq -} -export interface ListHelpdeskFaqResponse extends Paginated {} -export interface SearchHelpdeskFaqResponse extends Paginated {} -export interface CreateHelpdeskCategoryResponse { - /** category */ - category?: Lark.Category -} -export interface GetHelpdeskCategoryResponse extends Lark.Category {} -export interface ListHelpdeskCategoryResponse { - /** list of categories */ - categories?: Lark.Category[] -} -export interface CreateHelpdeskNotificationResponse { - /** 创建成功后的唯一id */ - notification_id?: string - /** 当前状态 */ - status?: number -} -export interface GetHelpdeskNotificationResponse { - /** push任务详情 */ - notification?: Lark.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 -} -export interface CreateTaskv1Response { - /** 返回创建好的任务 */ - task?: Lark.Task -} -export interface PatchTaskv1Response { - /** 返回修改后的任务详情 */ - task?: Lark.Task -} -export interface GetTaskv1Response { - /** 返回任务资源详情 */ - task?: Lark.Task -} -export interface ListTaskv1Response extends Paginated {} -export interface CreateTaskv1TaskReminderResponse { - /** 返回创建成功的提醒时间 */ - reminder?: Lark.Reminder -} -export interface ListTaskv1TaskReminderResponse extends Paginated {} -export interface CreateTaskv1TaskCommentResponse { - /** 返回创建好的任务评论 */ - comment?: Lark.Comment -} -export interface UpdateTaskv1TaskCommentResponse { - /** 返回修改后的任务评论详情 */ - comment?: Lark.Comment -} -export interface GetTaskv1TaskCommentResponse { - /** 返回新的任务评论详情 */ - comment?: Lark.Comment -} -export interface ListTaskv1TaskCommentResponse extends Paginated {} -export interface CreateTaskv1TaskFollowerResponse { - /** 创建后的任务关注者 */ - follower: Lark.Follower -} -export interface BatchDeleteFollowerTaskv1Response { - /** 实际删除的关注人用户ID列表 */ - followers?: string[] -} -export interface ListTaskv1TaskFollowerResponse extends Paginated {} -export interface CreateTaskv1TaskCollaboratorResponse { - /** 返回创建成功后的任务协作者 */ - collaborator: Lark.Collaborator -} -export interface BatchDeleteCollaboratorTaskv1Response { - /** 实际删除的执行人用户ID列表 */ - collaborators?: string[] -} -export interface ListTaskv1TaskCollaboratorResponse extends Paginated {} -export interface CreateTaskv2Response { - /** 产生的任务 */ - task?: Lark.Task -} -export interface GetTaskv2Response { - /** 获得的任务实体 */ - task?: Lark.Task -} -export interface PatchTaskv2Response { - /** 更新后的任务 */ - task?: Lark.Task -} -export interface AddMembersTaskv2Response { - /** 更新完成后的任务实体数据 */ - task?: Lark.Task -} -export interface RemoveMembersTaskv2Response { - /** 移除成员后的任务数据 */ - task?: Lark.Task -} -export interface ListTaskv2Response extends Paginated {} -export interface TasklistsTaskv2Response { - /** 任务所在清单的摘要信息 */ - tasklists?: Lark.TaskInTasklistInfo[] -} -export interface AddTasklistTaskv2Response { - /** 添加后的任务详情 */ - task?: Lark.Task -} -export interface RemoveTasklistTaskv2Response { - /** 添加后的任务详情 */ - task?: Lark.Task -} -export interface AddRemindersTaskv2Response { - /** 更新完成后的任务实体 */ - task?: Lark.Task -} -export interface RemoveRemindersTaskv2Response { - /** 移除后任务的提醒列表 */ - task?: Lark.Task -} -export interface AddDependenciesTaskv2Response { - /** 被添加后任务的所有依赖 */ - dependencies?: Lark.TaskDependency[] -} -export interface RemoveDependenciesTaskv2Response { - /** 移除之后的任务GUID */ - dependencies?: Lark.TaskDependency[] -} -export interface CreateTaskv2TaskSubtaskResponse { - /** 创建的任务 */ - subtask?: Lark.Task -} -export interface ListTaskv2TaskSubtaskResponse extends Paginated {} -export interface CreateTaskv2TasklistResponse { - /** 创建的清单数据 */ - tasklist?: Lark.Tasklist -} -export interface GetTaskv2TasklistResponse { - /** 清单详情 */ - tasklist?: Lark.Tasklist -} -export interface PatchTaskv2TasklistResponse { - /** 修改后的任务清单 */ - tasklist?: Lark.Tasklist -} -export interface AddMembersTaskv2TasklistResponse { - /** 完成更新后的清单实体 */ - tasklist?: Lark.Tasklist -} -export interface RemoveMembersTaskv2TasklistResponse { - /** 修改完成后的清单实体 */ - tasklist?: Lark.Tasklist -} -export interface TasksTaskv2TasklistResponse extends Paginated {} -export interface ListTaskv2TasklistResponse extends Paginated {} -export interface CreateTaskv2TasklistActivitySubscriptionResponse { - /** 清单动态订阅 */ - activity_subscription?: Lark.TasklistActivitySubscription -} -export interface GetTaskv2TasklistActivitySubscriptionResponse { - /** 订阅详情 */ - activity_subscription?: Lark.TasklistActivitySubscription -} -export interface ListTaskv2TasklistActivitySubscriptionResponse { - /** 清单的动态订阅数据 */ - items?: Lark.TasklistActivitySubscription[] -} -export interface PatchTaskv2TasklistActivitySubscriptionResponse { - /** 更新后的订阅 */ - activity_subscription?: Lark.TasklistActivitySubscription -} -export interface CreateTaskv2CommentResponse { - /** 创建的评论详情 */ - comment?: Lark.Comment -} -export interface GetTaskv2CommentResponse { - /** 评论详情 */ - comment?: Lark.Comment -} -export interface PatchTaskv2CommentResponse { - /** 更新后的评论 */ - comment?: Lark.Comment -} -export interface ListTaskv2CommentResponse extends Paginated {} -export interface UploadTaskv2AttachmentResponse { - /** 上传的附件列表 */ - items?: Lark.Attachment[] -} -export interface ListTaskv2AttachmentResponse extends Paginated {} -export interface GetTaskv2AttachmentResponse { - /** 附件详情 */ - attachment?: Lark.Attachment -} -export interface CreateTaskv2SectionResponse { - /** 创建的自定义分组数据 */ - section?: Lark.Section -} -export interface GetTaskv2SectionResponse { - /** 获取的自定义分组详情 */ - section?: Lark.Section -} -export interface PatchTaskv2SectionResponse { - /** 更新后的自定义分组 */ - section?: Lark.Section -} -export interface ListTaskv2SectionResponse extends Paginated {} -export interface TasksTaskv2SectionResponse extends Paginated {} -export interface CreateTaskv2CustomFieldResponse { - /** 创建的自定义字段 */ - custom_field?: Lark.CustomField -} -export interface GetTaskv2CustomFieldResponse { - /** 获取的自定义字段数据 */ - custom_field?: Lark.CustomField -} -export interface PatchTaskv2CustomFieldResponse { - /** 修改后的自定义字段设置 */ - custom_field?: Lark.CustomField -} -export interface ListTaskv2CustomFieldResponse extends Paginated {} -export interface CreateTaskv2CustomFieldOptionResponse { - /** 创建的选项 */ - option?: Lark.Option -} -export interface PatchTaskv2CustomFieldOptionResponse { - /** 更新后的option数据 */ - option?: Lark.Option -} -export interface CreateMailMailgroupResponse extends Lark.Mailgroup {} -export interface PatchMailMailgroupResponse extends Lark.Mailgroup {} -export interface UpdateMailMailgroupResponse extends Lark.Mailgroup {} -export interface GetMailMailgroupResponse extends Lark.Mailgroup {} -export interface ListMailMailgroupResponse extends Paginated {} -export interface ListMailMailgroupManagerResponse extends Paginated {} -export interface CreateMailMailgroupMemberResponse extends Lark.MailgroupMember {} -export interface GetMailMailgroupMemberResponse extends Lark.MailgroupMember {} -export interface ListMailMailgroupMemberResponse extends Paginated {} -export interface BatchCreateMailMailgroupMemberResponse { - /** 添加成功后的邮件组成员信息列表 */ - items?: Lark.MailgroupMember[] -} -export interface CreateMailMailgroupAliasResponse { - /** 邮件组别名 */ - mailgroup_alias?: Lark.EmailAlias -} -export interface ListMailMailgroupAliasResponse { - /** 邮件组别名 */ - items?: Lark.EmailAlias[] -} -export interface CreateMailMailgroupPermissionMemberResponse extends Lark.MailgroupPermissionMember {} -export interface GetMailMailgroupPermissionMemberResponse extends Lark.MailgroupPermissionMember {} -export interface ListMailMailgroupPermissionMemberResponse extends Paginated {} -export interface BatchCreateMailMailgroupPermissionMemberResponse { - /** 添加成功后的邮件组权限成员信息列表 */ - items?: Lark.MailgroupPermissionMember[] -} -export interface CreateMailPublicMailboxResponse extends Lark.PublicMailbox {} -export interface PatchMailPublicMailboxResponse extends Lark.PublicMailbox {} -export interface UpdateMailPublicMailboxResponse extends Lark.PublicMailbox {} -export interface GetMailPublicMailboxResponse extends Lark.PublicMailbox {} -export interface ListMailPublicMailboxResponse extends Paginated {} -export interface CreateMailPublicMailboxMemberResponse extends Lark.PublicMailboxMember {} -export interface GetMailPublicMailboxMemberResponse extends Lark.PublicMailboxMember {} -export interface ListMailPublicMailboxMemberResponse extends Paginated {} -export interface BatchCreateMailPublicMailboxMemberResponse { - /** 添加成功后的公共邮箱成员信息列表 */ - items?: Lark.PublicMailboxMember[] -} -export interface CreateMailPublicMailboxAliasResponse { - /** 公共邮箱别名 */ - public_mailbox_alias?: Lark.EmailAlias -} -export interface ListMailPublicMailboxAliasResponse { - /** 公共邮箱别名 */ - items?: Lark.EmailAlias[] -} -export interface CreateMailUserMailboxAliasResponse { - /** 用户邮箱别名 */ - user_mailbox_alias?: Lark.EmailAlias -} -export interface ListMailUserMailboxAliasResponse extends Paginated {} -export interface QueryMailUserResponse { - /** 邮箱地址返回 */ - user_list?: Lark.User[] -} -export interface GetApplicationResponse { - /** 应用数据 */ - app?: Lark.Application -} -export interface GetApplicationApplicationAppVersionResponse { - app_version?: Lark.ApplicationAppVersion -} -export interface ListApplicationApplicationAppVersionResponse extends Paginated {} -export interface ContactsRangeSuggestApplicationApplicationAppVersionResponse { - contacts_range?: Lark.ApplicationAppContactsRange -} -export interface UnderauditlistApplicationResponse extends Paginated {} -export interface ContactsRangeConfigurationApplicationResponse { - contacts_range?: Lark.ApplicationAppContactsRange - /** 是否还有更多项 */ - has_more?: boolean - /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ - page_token?: string -} -export interface CheckWhiteBlackListApplicationApplicationVisibilityResponse { - /** 用户可见性信息列表 */ - user_visibility_list?: Lark.ApplicationVisibilityUserWhiteBlackInfo[] - /** 部门可见性信息列表 */ - department_visibility_list?: Lark.ApplicationVisibilityDepartmentWhiteBlackInfo[] - /** 用户组可见性信息列表 */ - group_visibility_list?: Lark.ApplicationVisibilityGroupWhiteBlackInfo[] -} -export interface DepartmentOverviewApplicationApplicationAppUsageResponse extends Paginated {} -export interface OverviewApplicationApplicationAppUsageResponse { - /** 员工使用应用概览数据 */ - items?: Lark.ApplicationAppUsage[] -} -export interface ListApplicationApplicationFeedbackResponse extends Paginated {} -export interface QueryTenantTenantProductAssignInfoResponse { - /** 租户待分配席位列表 */ - assign_info_list?: Lark.TenantAssignInfo[] -} -export interface QueryTenantResponse { - /** 企业信息 */ - tenant?: Lark.Tenant -} -export interface GetVerificationResponse { - verification?: Lark.Verification -} -export interface CreatePersonalSettingsSystemStatusResponse { - /** 系统状态 */ - system_status?: Lark.SystemStatus -} -export interface PatchPersonalSettingsSystemStatusResponse { - /** 系统状态 */ - system_status?: Lark.SystemStatus -} -export interface ListPersonalSettingsSystemStatusResponse extends Paginated {} -export interface BatchOpenPersonalSettingsSystemStatusResponse { - /** 开启结果 */ - result_list: Lark.SystemStatusUserOpenResultEntity[] -} -export interface BatchClosePersonalSettingsSystemStatusResponse { - /** 关闭结果 */ - result_list: Lark.SystemStatusUserCloseResultEntity[] -} -export interface CreateSearchMessageResponse extends Paginated {} -export interface CreateSearchAppResponse extends Paginated {} -export interface CreateSearchDataSourceResponse { - /** 数据源实例 */ - data_source?: Lark.DataSource -} -export interface PatchSearchDataSourceResponse { - /** 数据源 */ - data_source?: Lark.DataSource -} -export interface GetSearchDataSourceResponse { - /** 数据源实例 */ - data_source?: Lark.DataSource -} -export interface ListSearchDataSourceResponse extends Paginated {} -export interface GetSearchDataSourceItemResponse { - /** 数据项实例 */ - item: Lark.Item -} -export interface CreateSearchSchemaResponse { - /** 数据范式实例 */ - schema?: Lark.Schema -} -export interface PatchSearchSchemaResponse { - /** 数据范式实例 */ - schema?: Lark.Schema -} -export interface GetSearchSchemaResponse { - /** 数据范式 */ - schema?: Lark.Schema -} -export interface ParseDocumentAiResumeResponse { - /** 简历信息 */ - resumes?: Lark.Resume[] -} -export interface RecognizeDocumentAiVehicleInvoiceResponse { - /** 机动车发票信息 */ - vehicle_invoice?: Lark.VehicleInvoice -} -export interface RecognizeDocumentAiHealthCertificateResponse { - /** 健康证信息 */ - health_certificate?: Lark.HealthCertificate -} -export interface RecognizeDocumentAiHkmMainlandTravelPermitResponse { - /** 港澳居民来往内地通行证信息 */ - hkm_mainland_travel_permit?: Lark.HkmMainlandTravelPermit -} -export interface RecognizeDocumentAiTwMainlandTravelPermitResponse { - /** 台湾居民来往大陆通行证信息 */ - tw_mainland_travel_permit?: Lark.TwMainlandTravelPermit -} -export interface RecognizeDocumentAiChinesePassportResponse { - /** 中国护照信息 */ - chinese_passport?: Lark.ChinesePassport -} -export interface RecognizeDocumentAiBankCardResponse { - /** 银行卡信息 */ - bank_card?: Lark.BankCard -} -export interface RecognizeDocumentAiVehicleLicenseResponse { - /** 行驶证信息 */ - vehicle_license?: Lark.VehicleLicense -} -export interface RecognizeDocumentAiTrainInvoiceResponse { - /** 火车票信息 */ - train_invoices?: Lark.TrainInvoice[] -} -export interface RecognizeDocumentAiTaxiInvoiceResponse { - /** 出租车票信息 */ - taxi_invoices?: Lark.TaxiInvoice[] -} -export interface RecognizeDocumentAiIdCardResponse { - /** 身份证信息 */ - id_card?: Lark.IdCard -} -export interface RecognizeDocumentAiFoodProduceLicenseResponse { - /** 食品生产许可证信息 */ - food_produce_license?: Lark.FoodProduceLicense -} -export interface RecognizeDocumentAiFoodManageLicenseResponse { - /** 食品经营许可证信息 */ - food_manage_license?: Lark.FoodManageLicense -} -export interface RecognizeDocumentAiDrivingLicenseResponse { - /** 驾驶证信息 */ - driving_license?: Lark.DrvingLicense -} -export interface RecognizeDocumentAiVatInvoiceResponse { - /** 增值税发票信息 */ - vat_invoices?: Lark.VatInvoice[] -} -export interface RecognizeDocumentAiBusinessLicenseResponse { - /** 营业执照信息 */ - business_license?: Lark.BusinessLicense -} -export interface FieldExtractionDocumentAiContractResponse { - /** 文件的唯一id */ - file_id?: string - /** 总交易金额 */ - price?: Lark.ExtractPrice - /** 期限相关信息，包括开始日期、结束日期、有效时长 */ - time?: Lark.ExtractTime - /** 盖章份数 */ - copy?: Lark.ExtractCopy - /** 币种 */ - currency?: Lark.ExtractCurrency - /** 合同标题 */ - header?: string - /** 主体信息 */ - body_info?: Lark.BodyInfo[] - /** 银行信息 */ - bank_info?: Lark.BankInfo[] -} -export interface RecognizeDocumentAiBusinessCardResponse { - /** 名片信息 */ - business_cards?: Lark.RecognizedEntities[] -} -export interface BasicRecognizeOpticalCharRecognitionImageResponse { - /** 按区域识别，返回文本列表 */ - text_list: string[] -} -export interface FileRecognizeSpeechToTextSpeechResponse { - /** 语音识别后的文本信息 */ - recognition_text: string -} -export interface StreamRecognizeSpeechToTextSpeechResponse { - /** 16 位 String 随机串作为同一数据流的标识 */ - stream_id: string - /** 数据流分片的序号，序号从 0 开始，每次请求递增 1 */ - sequence_id: number - /** 语音流识别后的文本信息 */ - recognition_text: string -} -export interface DetectTranslationTextResponse { - /** 识别的文本语种，返回符合 ISO 693-1 标准 */ - language: string -} -export interface TranslateTranslationTextResponse { - /** 翻译后的文本 */ - text: string -} -export interface ListAdminAdminDeptStatResponse extends Paginated {} -export interface ListAdminAdminUserStatResponse extends Paginated {} -export interface CreateAdminBadgeResponse { - /** 勋章的信息 */ - badge?: Lark.Badge -} -export interface UpdateAdminBadgeResponse { - /** 勋章信息 */ - badge?: Lark.Badge -} -export interface CreateAdminBadgeImageResponse { - /** 图片的key */ - image_key?: string -} -export interface ListAdminBadgeResponse extends Paginated {} -export interface GetAdminBadgeResponse { - /** 勋章信息 */ - badge?: Lark.Badge -} -export interface CreateAdminBadgeGrantResponse { - /** 授予名单的信息 */ - grant?: Lark.Grant -} -export interface UpdateAdminBadgeGrantResponse { - /** 授予名单 */ - grant?: Lark.Grant -} -export interface ListAdminBadgeGrantResponse extends Paginated {} -export interface GetAdminBadgeGrantResponse { - /** 授予名单信息 */ - grant?: Lark.Grant -} -export interface ListEhrEmployeeResponse extends Paginated {} -export interface SearchCorehrBasicInfoNationalityResponse extends Paginated {} -export interface SearchCorehrBasicInfoBankResponse extends Paginated {} -export interface SearchCorehrBasicInfoBankBranchResponse extends Paginated {} -export interface GetByParamCorehrCustomFieldResponse { - /** 自定义字段详情 */ - data?: Lark.CustomField -} -export interface QueryCorehrCustomFieldResponse { - /** 自定义字段列表 */ - items?: Lark.CustomField[] -} -export interface ListObjectApiNameCorehrCustomFieldResponse extends Paginated {} -export interface SearchCorehrBasicInfoCountryRegionResponse extends Paginated {} -export interface SearchCorehrBasicInfoCountryRegionSubdivisionResponse extends Paginated {} -export interface SearchCorehrBasicInfoCityResponse extends Paginated {} -export interface SearchCorehrBasicInfoDistrictResponse extends Paginated {} -export interface CreateCorehrEmployeeTypeResponse { - employee_type?: Lark.EmployeeType -} -export interface PatchCorehrEmployeeTypeResponse { - employee_type?: Lark.EmployeeType -} -export interface GetCorehrEmployeeTypeResponse { - /** 雇员类型 */ - employee_type?: Lark.EmployeeType -} -export interface ListCorehrEmployeeTypeResponse extends Paginated {} -export interface CreateCorehrNationalIdTypeResponse { - national_id_type?: Lark.NationalIdType -} -export interface PatchCorehrNationalIdTypeResponse { - national_id_type?: Lark.NationalIdType -} -export interface GetCorehrNationalIdTypeResponse { - /** 国家证件类型信息 */ - national_id_type?: Lark.NationalIdType -} -export interface ListCorehrNationalIdTypeResponse extends Paginated {} -export interface CreateCorehrWorkingHoursTypeResponse { - working_hours_type?: Lark.WorkingHoursType -} -export interface PatchCorehrWorkingHoursTypeResponse { - working_hours_type?: Lark.WorkingHoursType -} -export interface GetCorehrWorkingHoursTypeResponse { - /** 工时制度信息 */ - working_hours_type?: Lark.WorkingHoursType -} -export interface ListCorehrWorkingHoursTypeResponse extends Paginated {} -export interface SearchCorehrBasicInfoCurrencyResponse extends Paginated {} -export interface BatchGetCorehrEmployeeResponse { - /** 查询的雇佣信息 */ - items?: Lark.Employee[] -} -export interface SearchCorehrEmployeeResponse extends Paginated {} -export interface CreateCorehrEmploymentResponse { - employment?: Lark.EmploymentCreate -} -export interface PatchCorehrEmploymentResponse { - employment?: Lark.Employment -} -export interface CreateCorehrPersonResponse { - person?: Lark.PersonInfo -} -export interface PatchCorehrPersonResponse { - person?: Lark.PersonInfo -} -export interface UploadCorehrPersonResponse { - /** 上传文件ID */ - id?: string -} -export interface CreateCorehrJobDataResponse { - job_data?: Lark.JobData -} -export interface PatchCorehrJobDataResponse { - job_data?: Lark.JobData -} -export interface GetCorehrJobDataResponse { - /** 任职信息 */ - job_data?: Lark.JobData -} -export interface QueryCorehrEmployeesJobDataResponse extends Paginated {} -export interface BatchGetCorehrEmployeesJobDataResponse { - /** 查询的雇佣信息 */ - items?: Lark.EmployeeJobData[] -} -export interface ListCorehrJobDataResponse extends Paginated {} -export interface ParentsCorehrDepartmentResponse extends Paginated {} -export interface SearchCorehrDepartmentResponse extends Paginated {} -export interface CreateCorehrDepartmentResponse { - department?: Lark.DepartmentCreate -} -export interface PatchCorehrDepartmentResponse { - department?: Lark.Department -} -export interface GetCorehrDepartmentResponse { - /** 部门信息 */ - department?: Lark.Department -} -export interface BatchGetCorehrDepartmentResponse { - /** 查询的部门信息 */ - items?: Lark.Department[] -} -export interface ListCorehrDepartmentResponse extends Paginated {} -export interface BatchGetCorehrLocationResponse { - /** 查询的地点信息 */ - items?: Lark.Location[] -} -export interface CreateCorehrLocationResponse { - location?: Lark.Location -} -export interface GetCorehrLocationResponse { - /** 地点信息 */ - location?: Lark.Location -} -export interface ListCorehrLocationResponse extends Paginated {} -export interface GetCorehrCompanyResponse { - /** 公司信息 */ - company?: Lark.Company -} -export interface ListCorehrCompanyResponse extends Paginated {} -export interface BatchGetCorehrCompanyResponse { - /** 查询的公司信息 */ - items?: Lark.Company[] -} -export interface CreateCorehrCompanyResponse { - company?: Lark.Company -} -export interface PatchCorehrCompanyResponse { - company?: Lark.Company -} -export interface CreateCorehrCostCenterResponse { - cost_center?: Lark.CostCenter -} -export interface PatchCorehrCostCenterResponse { - cost_center?: Lark.CostCenter -} -export interface SearchCorehrCostCenterResponse extends Paginated {} -export interface CreateCorehrCostCenterVersionResponse { - version?: Lark.CostCenterVersion -} -export interface PatchCorehrCostCenterVersionResponse { - version?: Lark.CostCenterVersion -} -export interface BatchGetCorehrJobLevelResponse { - /** 查询的职级信息 */ - items?: Lark.JobLevel[] -} -export interface CreateCorehrJobLevelResponse { - job_level?: Lark.JobLevel -} -export interface PatchCorehrJobLevelResponse { - job_level?: Lark.JobLevel -} -export interface GetCorehrJobLevelResponse { - /** 职务级别信息 */ - job_level?: Lark.JobLevel -} -export interface ListCorehrJobLevelResponse extends Paginated {} -export interface BatchGetCorehrJobFamilyResponse { - /** 查询的序列信息 */ - items?: Lark.JobFamily[] -} -export interface CreateCorehrJobFamilyResponse { - job_family?: Lark.JobFamily -} -export interface PatchCorehrJobFamilyResponse { - job_family?: Lark.JobFamily -} -export interface GetCorehrJobFamilyResponse { - /** 职务序列信息 */ - job_family?: Lark.JobFamily -} -export interface ListCorehrJobFamilyResponse extends Paginated {} -export interface CreateCorehrJobResponse { - job?: Lark.Job -} -export interface PatchCorehrJobResponse { - job?: Lark.Job -} -export interface GetCorehrJobResponse { - /** 职务信息 */ - job?: Lark.Job -} -export interface ListCorehrJobResponse extends Paginated {} -export interface CreateCorehrPreHireResponse { - /** 待入职 ID */ - pre_hire_id?: string -} -export interface PatchCorehrPreHireResponse { - pre_hire?: Lark.PreHire -} -export interface GetCorehrPreHireResponse { - /** 待入职信息 */ - pre_hire?: Lark.PreHire -} -export interface ListCorehrPreHireResponse extends Paginated {} -export interface SearchCorehrContractResponse extends Paginated {} -export interface CreateCorehrContractResponse { - contract?: Lark.Contract -} -export interface PatchCorehrContractResponse { - contract?: Lark.Contract -} -export interface GetCorehrContractResponse { - /** 合同信息 */ - contract?: Lark.Contract -} -export interface ListCorehrContractResponse extends Paginated {} -export interface SearchCorehrProbationResponse extends Paginated {} -export interface CreateCorehrProbationAssessmentResponse { - /** 创建的试用期考核记录 ID 列表，有序返回 */ - assessment_ids?: string[] -} -export interface QueryCorehrTransferReasonResponse { - /** 异动原因列表 */ - items?: Lark.TransferReason[] -} -export interface QueryCorehrTransferTypeResponse { - /** 异动类型列表 */ - items?: Lark.TransferType[] -} -export interface CreateCorehrJobChangeResponse extends Lark.JobChange {} -export interface SearchCorehrJobChangeResponse extends Paginated {} -export interface QueryCorehrOffboardingResponse { - /** 离职原因列表 */ - items?: Lark.OffboardingReason[] -} -export interface SubmitCorehrOffboardingResponse { - /** 离职记录 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 -} -export interface SearchCorehrOffboardingResponse extends Paginated {} -export interface CreateCorehrLeaveGrantingRecordResponse { - /** 假期授予记录 */ - leave_granting_record?: Lark.LeaveGrantingRecord -} -export interface LeaveTypesCorehrLeaveResponse extends Paginated {} -export interface LeaveBalancesCorehrLeaveResponse extends Paginated {} -export interface LeaveRequestHistoryCorehrLeaveResponse extends Paginated {} -export interface BatchGetCorehrEmployeesBpResponse { - /** 员工直属 BP 信息，当员工所在部门、属地无 BP 时，会上钻找到最近的 BP */ - employment_direct_bps?: Lark.EmploymentBp[] - /** 员工全部 BP 信息 */ - employment_all_bps?: Lark.EmploymentBp[] -} -export interface GetByDepartmentCorehrBpResponse { - /** 部门 HRBP 信息，依次为部门及各层级上级部门 */ - items?: Lark.DepartmentHrbp[] -} -export interface ListCorehrBpResponse extends Paginated {} -export interface QueryCorehrSecurityGroupResponse { - /** HRBP/属地 BP 信息 */ - hrbp_list?: Lark.Hrbp[] -} -export interface SearchCorehrAssignedUserResponse extends Paginated {} -export interface ListCorehrSecurityGroupResponse extends Paginated {} -export interface ListCorehrProcessResponse extends Paginated {} -export interface GetCorehrProcessResponse { - /** 流程实例ID */ - process_id?: string - /** 流程状态 */ - status?: number - /** 业务类型ID */ - flow_template_id?: string - /** 业务类型名称 */ - flow_template_name?: Lark.DataengineI18n - /** 流程定义ID */ - flow_definition_id?: string - /** 流程定义名称 */ - flow_definition_name?: Lark.DataengineI18n - /** 流程发起人ID */ - initiator_id?: string - /** 流程发起人姓名 */ - initiator_name?: Lark.DataengineI18n - /** 流程发起时间，Unix毫秒时间戳 */ - create_time?: string - /** 流程结束时间，Unix毫秒时间戳 */ - complete_time?: string - /** 发起单据地址 */ - start_links?: Lark.ProcessLink - /** 流程摘要，会随着流程流转发生变化 */ - abstracts?: Lark.ProcessAbstractItem[] - /** 待办列表 */ - todos?: Lark.ProcessTodoItem[] - /** 抄送列表 */ - cc_list?: Lark.ProcessCcItem[] - /** 已办列表 */ - done_list?: Lark.ProcessDoneItem[] -} -export interface GetCorehrProcessFormVariableDataResponse { - /** 流程变量 */ - field_variable_values?: Lark.FormFieldVariable[] -} -export interface MatchCorehrCompensationStandardResponse extends Lark.CpstMatchItem {} -export interface CombinedCreateHireJobResponse extends Lark.CombinedJobResult {} -export interface GetHireJobResponse { - /** 职位数据 */ - job?: Lark.Job -} -export interface ConfigHireJobResponse { - job_config?: Lark.JobConfigResult -} -export interface ListHireJobResponse extends Paginated {} -export interface CombinedUpdateHireJobResponse extends Lark.CombinedJobResult {} -export interface UpdateConfigHireJobResponse { - job_config?: Lark.JobConfigResult -} -export interface ListHireJobTypeResponse extends Paginated {} -export interface RecruiterHireJobResponse { - /** 职位负责人 */ - info?: Lark.JobRecruiter2 -} -export interface CreateHireJobRequirementResponse { - job_requirement?: Lark.JobRequirementDto -} -export interface ListHireJobRequirementResponse extends Paginated {} -export interface ListHireJobRequirementSchemaResponse extends Paginated {} -export interface ListHireJobProcessResponse extends Paginated {} -export interface ListHireRegistrationSchemaResponse extends Paginated {} -export interface ListHireReferralWebsiteJobPostResponse extends Paginated {} -export interface GetHireReferralWebsiteJobPostResponse { - job_post?: Lark.PortalJobPost -} -export interface GetByApplicationHireReferralResponse { - /** 内推信息 */ - referral?: Lark.Referral -} -export interface CreateHireExternalApplicationResponse { - external_application?: Lark.ExternalApplication -} -export interface UpdateHireExternalApplicationResponse { - external_application?: Lark.ExternalApplication -} -export interface DeleteHireExternalApplicationResponse { - external_application?: Lark.ExternalApplication -} -export interface CreateHireExternalInterviewResponse { - external_interview?: Lark.ExternalInterview -} -export interface CreateHireExternalInterviewAssessmentResponse { - external_interview_assessment?: Lark.ExternalInterviewAssessment -} -export interface CreateHireExternalBackgroundCheckResponse { - external_background_check?: Lark.ExternalBackgroundCheck -} -export interface AddToFolderHireTalentResponse { - /** 人才 ID 列表 */ - talent_id_list?: string[] - /** 文件夹 ID */ - folder_id?: string -} -export interface ListHireTalentFolderResponse extends Paginated {} -export interface BatchGetIdHireTalentResponse { - /** 人才信息列表 */ - talent_list?: Lark.TalentBatchInfo[] -} -export interface ListHireTalentResponse extends Paginated {} -export interface QueryHireTalentObjectResponse { - items?: Lark.CommonSchema[] -} -export interface GetHireTalentResponse { - /** 人才信息 */ - talent?: Lark.Talent -} -export interface CreateHireApplicationResponse { - /** 投递ID */ - id?: string -} -export interface GetHireApplicationResponse { - /** 投递数据 */ - application?: Lark.Application -} -export interface ListHireApplicationResponse extends Paginated {} -export interface ListHireEvaluationResponse extends Paginated {} -export interface ListHireQuestionnaireResponse extends Paginated {} -export interface ListHireInterviewResponse extends Paginated {} -export interface CreateHireOfferResponse extends Lark.OfferInfo {} -export interface OfferHireApplicationResponse { - offer?: Lark.ApplicationOffer -} -export interface GetHireOfferResponse { - /** Offer 详情 */ - offer?: Lark.Offer -} -export interface ListHireOfferResponse extends Paginated {} -export interface InternOfferStatusHireOfferResponse extends Lark.InternOfferStatus {} -export interface TransferOnboardHireApplicationResponse { - /** employee */ - employee?: Lark.Employee -} -export interface PatchHireEmployeeResponse { - /** 员工信息 */ - employee?: Lark.Employee -} -export interface GetByApplicationHireEmployeeResponse { - /** 员工信息 */ - employee?: Lark.Employee -} -export interface GetHireEmployeeResponse { - /** 员工信息 */ - employee?: Lark.Employee -} -export interface CreateHireNoteResponse { - note?: Lark.Note -} -export interface PatchHireNoteResponse { - /** 备注数据 */ - note?: Lark.Note -} -export interface GetHireNoteResponse { - /** 备注数据 */ - note?: Lark.Note -} -export interface ListHireNoteResponse extends Paginated {} -export interface ListHireResumeSourceResponse extends Paginated {} -export interface CreateHireReferralAccountResponse { - /** 账号信息 */ - account?: Lark.Account -} -export interface DeactivateHireReferralAccountResponse { - /** 账号信息 */ - account?: Lark.Account -} -export interface WithdrawHireReferralAccountResponse { - /** 请求时传入的提现单ID */ - external_order_id?: string - /** 交易时间戳，需要保存，用于统一交易时间，方便对账 */ - trans_time?: string - /** 本次提现金额明细 */ - withdrawal_details?: Lark.BonusAmount -} -export interface ReconciliationHireReferralAccountResponse { - /** 核对失败的信息 */ - check_failed_list?: Lark.CheckFailedAccountInfo[] -} -export interface GetHireAttachmentResponse { - /** 附件信息 */ - attachment?: Lark.Attachment -} -export interface PreviewHireAttachmentResponse { - /** 预览链接 */ - url: string -} -export interface CreateOkrPeriodResponse { - /** 周期id */ - period_id?: string - /** 周期起始年月 */ - start_month?: string - /** 周期结束年月 */ - end_month?: string -} -export interface PatchOkrPeriodResponse { - /** 周期规则id */ - period_id?: string - /** 周期显示状态 */ - status?: number -} -export interface ListOkrPeriodResponse extends Paginated {} -export interface ListOkrPeriodRuleResponse { - /** 指标库列表 */ - period_rules?: Lark.PeriodRule[] -} -export interface ListOkrUserOkrResponse { - /** OKR周期总数 */ - total?: number - /** OKR 列表 */ - okr_list?: Lark.OkrBatch[] -} -export interface BatchGetOkrResponse { - /** OKR 列表 */ - okr_list?: Lark.OkrBatch[] -} -export interface CreateOkrProgressRecordResponse extends Lark.ProgressRecord {} -export interface UpdateOkrProgressRecordResponse extends Lark.ProgressRecord {} -export interface GetOkrProgressRecordResponse extends Lark.ProgressRecord {} -export interface UploadOkrImageResponse extends Lark.ImageInfo {} -export interface CreateHumanAuthenticationIdentityResponse { - /** uid of user bind authentication */ - verify_uid: string -} -export interface CreateAcsVisitorResponse { - /** 访客的id */ - visitor_id: string -} -export interface GetAcsRuleExternalResponse { - /** 设备权限组信息 */ - rules: Lark.Rule[] -} -export interface CreateAcsRuleExternalResponse { - /** 权限组id */ - rule_id: string -} -export interface GetAcsUserResponse { - /** 门禁用户信息 */ - user?: Lark.User -} -export interface ListAcsUserResponse extends Paginated {} -export interface ListAcsDeviceResponse { - items?: Lark.Device[] -} -export interface ListAcsAccessRecordResponse extends Paginated {} -export interface ListPerformanceSemesterResponse { - /** 周期meta信息列表 */ - items?: Lark.Semester[] -} -export interface FindByUserListPerformanceStageTaskResponse { - /** 周期基础信息 */ - base?: Lark.SemesterBaseInfo - /** 周期环节信息列表 */ - items?: Lark.StageTask[] -} -export interface FindByPagePerformanceStageTaskResponse { - /** 周期基础信息 */ - base?: Lark.SemesterBaseInfo - /** 周期环节信息列表 */ - items?: Lark.StageTask[] - /** 是否有下一页数据 */ - has_more?: boolean - /** 下一页分页的token */ - page_token?: string -} -export interface QueryPerformanceReviewDataResponse extends Lark.ReviewData {} -export interface CreateLingoDraftResponse { - draft?: Lark.Draft -} -export interface UpdateLingoDraftResponse { - draft?: Lark.Draft -} -export interface CreateLingoEntityResponse { - entity?: Lark.Entity -} -export interface UpdateLingoEntityResponse { - entity?: Lark.Entity -} -export interface GetLingoEntityResponse { - /** 实体词 */ - entity?: Lark.Entity -} -export interface ListLingoEntityResponse extends Paginated {} -export interface MatchLingoEntityResponse { - /** 匹配结果 */ - results?: Lark.MatchInfo[] -} -export interface SearchLingoEntityResponse extends Paginated {} -export interface HighlightLingoEntityResponse { - /** 返回识别到的实体词信息 */ - phrases?: Lark.Phrase[] -} -export interface ListLingoClassificationResponse extends Paginated {} -export interface ListLingoRepoResponse { - /** 词库列表 */ - items?: Lark.Repo[] -} -export interface UploadLingoFileResponse { - /** 文件 token */ - file_token?: string -} -export interface ListDataSecurityAndComplianceOpenapiLogResponse extends Paginated {} -export interface ListAdminAuditInfoResponse extends Paginated {} -export interface GetMinutesMinuteStatisticsResponse { - /** 妙记浏览信息统计 */ - statistics?: Lark.Statictics -} -export interface GetMinutesMinuteResponse { - /** 妙记基本信息 */ - minute?: Lark.Minute -} -export interface SearchWorkplaceWorkplaceAccessDataResponse extends Paginated {} -export interface SearchWorkplaceCustomWorkplaceAccessDataResponse extends Paginated {} -export interface SearchWorkplaceWorkplaceBlockAccessDataResponse extends Paginated {} -export interface FavouriteApplicationResponse extends Paginated {} -export interface RecommendApplicationResponse extends Paginated {} -export interface ListApplicationAppRecommendRuleResponse extends Paginated {} -export interface QueryReportRuleResponse { - /** 规则列表 */ - rules?: Lark.Rule[] -} -export interface QueryReportTaskResponse extends Paginated {} -export interface CreateAuthenAccessTokenResponse extends Lark.UserAccessTokenInfo {} -export interface CreateAuthenRefreshAccessTokenResponse extends Lark.UserAccessTokenInfo {} -export interface CreateBaikeDraftResponse { - draft?: Lark.Draft -} -export interface UpdateBaikeDraftResponse { - draft?: Lark.Draft -} -export interface CreateBaikeEntityResponse { - entity?: Lark.Entity -} -export interface UpdateBaikeEntityResponse { - entity?: Lark.Entity -} -export interface GetBaikeEntityResponse { - /** 实体词 */ - entity?: Lark.Entity -} -export interface ListBaikeEntityResponse extends Paginated {} -export interface MatchBaikeEntityResponse { - /** 匹配结果 */ - results?: Lark.MatchInfo[] -} -export interface SearchBaikeEntityResponse extends Paginated {} -export interface HighlightBaikeEntityResponse { - /** 返回识别到的实体词信息 */ - phrases?: Lark.Phrase[] -} -export interface ExtractBaikeEntityResponse { - /** 文本中可能的成为百科词条的实体词 */ - entity_word: Lark.EntityWord[] -} -export interface ListBaikeClassificationResponse extends Paginated {} -export interface UploadBaikeFileResponse { - /** 文件 token */ - file_token?: string -} -export interface ListContactUserResponse extends Paginated {} -export interface UpdateContactUserResponse { - user?: Lark.User -} -export interface ListContactDepartmentResponse extends Paginated {} -export interface ListBitableAppTableRecordResponse extends Paginated {} -export interface ListHireApplicationInterviewResponse extends Paginated {} -export interface GetHireJobManagerResponse { - /** 职位负责人 */ - info?: Lark.JobManager -} -export interface GetHireOfferSchemaResponse extends Lark.OfferSchema {} -export interface ListCorehrSubregionResponse extends Paginated {} -export interface GetCorehrSubregionResponse { - /** 城市/区域信息 */ - subregion?: Lark.Subregion -} -export interface ListCorehrSubdivisionResponse extends Paginated {} -export interface GetCorehrSubdivisionResponse { - /** 国家/地址信息 */ - subdivision?: Lark.Subdivision -} -export interface ListCorehrCountryRegionResponse extends Paginated {} -export interface GetCorehrCountryRegionResponse { - /** 国家/地址信息 */ - country_region?: Lark.CountryRegion -} -export interface ListCorehrCurrencyResponse extends Paginated {} -export interface GetCorehrCurrencyResponse { - /** 货币信息 */ - currency?: Lark.Currency -} -export interface GetCorehrPersonResponse { - /** 个人信息 */ - person?: Lark.Person -} -export interface SetCheckboardAccessCodeVcRoomConfigResponse { - /** 部署访问码 */ - access_code?: string -} -export interface SetRoomAccessCodeVcRoomConfigResponse { - /** 部署访问码 */ - access_code?: string -} -export interface QueryVcRoomConfigResponse extends Lark.RoomConfig {} - -Internal.define({ - '/auth/v3/tenant_access_token/internal': { - POST: 'tenantAccessTokenInternalAuth', - }, - '/auth/v3/app_access_token/internal': { - POST: 'appAccessTokenInternalAuth', - }, - '/auth/v3/app_access_token': { - POST: 'appAccessTokenAuth', - }, - '/auth/v3/tenant_access_token': { - POST: 'tenantAccessTokenAuth', - }, - '/auth/v3/app_ticket/resend': { - POST: 'appTicketResendAuth', - }, -}, { type: 'json-body' }) - -Internal.define({ - '/im/v1/messages/{message_id}/resources/{file_key}': { - GET: 'getImMessageResource', - }, - '/im/v1/images/{image_key}': { - GET: 'getImImage', - }, - '/im/v1/files/{file_key}': { - GET: 'getImFile', - }, - '/drive/v1/medias/{file_token}/download': { - GET: 'downloadDrivev1Media', - }, - '/drive/v1/files/{file_token}/download': { - GET: 'downloadDrivev1File', - }, - '/vc/v1/exports/download': { - GET: 'downloadVcExport', - }, - '/attendance/v1/files/{file_id}/download': { - GET: 'downloadAttendanceFile', - }, - '/helpdesk/v1/ticket_images': { - GET: 'ticketImageHelpdeskTicket', - }, - '/helpdesk/v1/faqs/{id}/image/{image_key}': { - GET: 'faqImageHelpdeskFaq', - }, - '/ehr/v1/attachments/{token}': { - GET: 'getEhrAttachment', - }, - '/corehr/v1/files/{id}': { - GET: 'getCorehrFile', - }, - '/acs/v1/users/{user_id}/face': { - GET: 'getAcsUserFace', - }, - '/acs/v1/access_records/{access_record_id}/access_photo': { - GET: 'getAcsAccessRecordAccessPhoto', - }, - '/lingo/v1/files/{file_token}/download': { - GET: 'downloadLingoFile', - }, - '/baike/v1/files/{file_token}/download': { - GET: 'downloadBaikeFile', - }, -}, { type: 'binary' }) - -Internal.define({ - '/event/v1/outbound_ip': { - GET: 'listEventOutboundIp', - }, - '/authen/v1/oidc/access_token': { - POST: 'createAuthenOidcAccessToken', - }, - '/authen/v1/oidc/refresh_access_token': { - POST: 'createAuthenOidcRefreshAccessToken', - }, - '/authen/v1/user_info': { - GET: 'getAuthenUserInfo', - }, - '/passport/v1/sessions/query': { - POST: 'queryPassportSession', - }, - '/contact/v3/scopes': { - GET: 'listContactScope', - }, - '/contact/v3/users': { - POST: 'createContactUser', - GET: 'listContactUser', - }, - '/contact/v3/users/{user_id}': { - DELETE: 'deleteContactUser', - PATCH: 'patchContactUser', - GET: 'getContactUser', - PUT: 'updateContactUser', - }, - '/contact/v3/users/{user_id}/resurrect': { - POST: 'resurrectContactUser', - }, - '/contact/v3/users/batch': { - GET: 'batchContactUser', - }, - '/contact/v3/users/find_by_department': { - GET: 'findByDepartmentContactUser', - }, - '/contact/v3/users/batch_get_id': { - POST: 'batchGetIdContactUser', - }, - '/contact/v3/users/{user_id}/update_user_id': { - PATCH: 'updateUserIdContactUser', - }, - '/contact/v3/group': { - POST: 'createContactGroup', - }, - '/contact/v3/group/{group_id}': { - DELETE: 'deleteContactGroup', - PATCH: 'patchContactGroup', - GET: 'getContactGroup', - }, - '/contact/v3/group/simplelist': { - GET: 'simplelistContactGroup', - }, - '/contact/v3/group/member_belong': { - GET: 'memberBelongContactGroup', - }, - '/contact/v3/custom_attrs': { - GET: 'listContactCustomAttr', - }, - '/contact/v3/employee_type_enums': { - POST: 'createContactEmployeeTypeEnum', - GET: 'listContactEmployeeTypeEnum', - }, - '/contact/v3/employee_type_enums/{enum_id}': { - DELETE: 'deleteContactEmployeeTypeEnum', - PUT: 'updateContactEmployeeTypeEnum', - }, - '/contact/v3/departments': { - POST: 'createContactDepartment', - GET: 'listContactDepartment', - }, - '/contact/v3/departments/{department_id}': { - DELETE: 'deleteContactDepartment', - PATCH: 'patchContactDepartment', - PUT: 'updateContactDepartment', - GET: 'getContactDepartment', - }, - '/contact/v3/departments/unbind_department_chat': { - POST: 'unbindDepartmentChatContactDepartment', - }, - '/contact/v3/departments/batch': { - GET: 'batchContactDepartment', - }, - '/contact/v3/departments/{department_id}/children': { - GET: 'childrenContactDepartment', - }, - '/contact/v3/departments/parent': { - GET: 'parentContactDepartment', - }, - '/contact/v3/departments/search': { - POST: 'searchContactDepartment', - }, - '/contact/v3/departments/{department_id}/update_department_id': { - PATCH: 'updateDepartmentIdContactDepartment', - }, - '/contact/v3/unit': { - POST: 'createContactUnit', - GET: 'listContactUnit', - }, - '/contact/v3/unit/{unit_id}': { - DELETE: 'deleteContactUnit', - PATCH: 'patchContactUnit', - GET: 'getContactUnit', - }, - '/contact/v3/unit/bind_department': { - POST: 'bindDepartmentContactUnit', - }, - '/contact/v3/unit/unbind_department': { - POST: 'unbindDepartmentContactUnit', - }, - '/contact/v3/unit/list_department': { - GET: 'listDepartmentContactUnit', - }, - '/contact/v3/group/{group_id}/member/add': { - POST: 'addContactGroupMember', - }, - '/contact/v3/group/{group_id}/member/batch_add': { - POST: 'batchAddContactGroupMember', - }, - '/contact/v3/group/{group_id}/member/remove': { - POST: 'removeContactGroupMember', - }, - '/contact/v3/group/{group_id}/member/batch_remove': { - POST: 'batchRemoveContactGroupMember', - }, - '/contact/v3/group/{group_id}/member/simplelist': { - GET: 'simplelistContactGroupMember', - }, - '/contact/v3/functional_roles': { - POST: 'createContactFunctionalRole', - }, - '/contact/v3/functional_roles/{role_id}': { - DELETE: 'deleteContactFunctionalRole', - PUT: 'updateContactFunctionalRole', - }, - '/contact/v3/functional_roles/{role_id}/members/batch_create': { - POST: 'batchCreateContactFunctionalRoleMember', - }, - '/contact/v3/functional_roles/{role_id}/members/batch_delete': { - PATCH: 'batchDeleteContactFunctionalRoleMember', - }, - '/contact/v3/functional_roles/{role_id}/members/scopes': { - PATCH: 'scopesContactFunctionalRoleMember', - }, - '/contact/v3/functional_roles/{role_id}/members/{member_id}': { - GET: 'getContactFunctionalRoleMember', - }, - '/contact/v3/functional_roles/{role_id}/members': { - GET: 'listContactFunctionalRoleMember', - }, - '/contact/v3/job_levels': { - POST: 'createContactJobLevel', - GET: 'listContactJobLevel', - }, - '/contact/v3/job_levels/{job_level_id}': { - DELETE: 'deleteContactJobLevel', - PUT: 'updateContactJobLevel', - GET: 'getContactJobLevel', - }, - '/contact/v3/job_families': { - POST: 'createContactJobFamily', - GET: 'listContactJobFamily', - }, - '/contact/v3/job_families/{job_family_id}': { - DELETE: 'deleteContactJobFamily', - PUT: 'updateContactJobFamily', - GET: 'getContactJobFamily', - }, - '/contact/v3/job_titles/{job_title_id}': { - GET: 'getContactJobTitle', - }, - '/contact/v3/job_titles': { - GET: 'listContactJobTitle', - }, - '/contact/v3/work_cities/{work_city_id}': { - GET: 'getContactWorkCity', - }, - '/contact/v3/work_cities': { - GET: 'listContactWorkCity', - }, - '/im/v1/messages': { - POST: 'createImMessage', - GET: 'listImMessage', - }, - '/im/v1/messages/{message_id}/reply': { - POST: 'replyImMessage', - }, - '/im/v1/messages/{message_id}': { - PUT: 'updateImMessage', - DELETE: 'deleteImMessage', - GET: 'getImMessage', - PATCH: 'patchImMessage', - }, - '/im/v1/messages/{message_id}/forward': { - POST: 'forwardImMessage', - }, - '/im/v1/messages/merge_forward': { - POST: 'mergeForwardImMessage', - }, - '/im/v1/threads/{thread_id}/forward': { - POST: 'forwardImThread', - }, - '/im/v1/messages/{message_id}/read_users': { - GET: 'readUsersImMessage', - }, - '/im/v1/messages/{message_id}/urgent_app': { - PATCH: 'urgentAppImMessage', - }, - '/im/v1/messages/{message_id}/urgent_sms': { - PATCH: 'urgentSmsImMessage', - }, - '/im/v1/messages/{message_id}/urgent_phone': { - PATCH: 'urgentPhoneImMessage', - }, - '/im/v1/batch_messages/{batch_message_id}': { - DELETE: 'deleteImBatchMessage', - }, - '/im/v1/batch_messages/{batch_message_id}/read_user': { - GET: 'readUserImBatchMessage', - }, - '/im/v1/batch_messages/{batch_message_id}/get_progress': { - GET: 'getProgressImBatchMessage', - }, - '/im/v1/messages/{message_id}/reactions': { - POST: 'createImMessageReaction', - GET: 'listImMessageReaction', - }, - '/im/v1/messages/{message_id}/reactions/{reaction_id}': { - DELETE: 'deleteImMessageReaction', - }, - '/im/v1/pins': { - POST: 'createImPin', - GET: 'listImPin', - }, - '/im/v1/pins/{message_id}': { - DELETE: 'deleteImPin', - }, - '/im/v1/chats': { - POST: 'createImChat', - GET: 'listImChat', - }, - '/im/v1/chats/{chat_id}': { - DELETE: 'deleteImChat', - PUT: 'updateImChat', - GET: 'getImChat', - }, - '/im/v1/chats/{chat_id}/moderation': { - PUT: 'updateImChatModeration', - GET: 'getImChatModeration', - }, - '/im/v1/chats/{chat_id}/top_notice/put_top_notice': { - POST: 'putTopNoticeImChatTopNotice', - }, - '/im/v1/chats/{chat_id}/top_notice/delete_top_notice': { - POST: 'deleteTopNoticeImChatTopNotice', - }, - '/im/v1/chats/search': { - GET: 'searchImChat', - }, - '/im/v1/chats/{chat_id}/link': { - POST: 'linkImChat', - }, - '/im/v1/chats/{chat_id}/managers/add_managers': { - POST: 'addManagersImChatManagers', - }, - '/im/v1/chats/{chat_id}/managers/delete_managers': { - POST: 'deleteManagersImChatManagers', - }, - '/im/v1/chats/{chat_id}/members': { - POST: 'createImChatMembers', - DELETE: 'deleteImChatMembers', - GET: 'getImChatMembers', - }, - '/im/v1/chats/{chat_id}/members/me_join': { - PATCH: 'meJoinImChatMembers', - }, - '/im/v1/chats/{chat_id}/members/is_in_chat': { - GET: 'isInChatImChatMembers', - }, - '/im/v1/chats/{chat_id}/announcement': { - PATCH: 'patchImChatAnnouncement', - GET: 'getImChatAnnouncement', - }, - '/im/v1/chats/{chat_id}/chat_tabs': { - POST: 'createImChatTab', - }, - '/im/v1/chats/{chat_id}/chat_tabs/delete_tabs': { - DELETE: 'deleteTabsImChatTab', - }, - '/im/v1/chats/{chat_id}/chat_tabs/update_tabs': { - POST: 'updateTabsImChatTab', - }, - '/im/v1/chats/{chat_id}/chat_tabs/sort_tabs': { - POST: 'sortTabsImChatTab', - }, - '/im/v1/chats/{chat_id}/chat_tabs/list_tabs': { - GET: 'listTabsImChatTab', - }, - '/im/v1/chats/{chat_id}/menu_tree': { - POST: 'createImChatMenuTree', - DELETE: 'deleteImChatMenuTree', - GET: 'getImChatMenuTree', - }, - '/im/v1/chats/{chat_id}/menu_items/{menu_item_id}': { - PATCH: 'patchImChatMenuItem', - }, - '/im/v1/chats/{chat_id}/menu_tree/sort': { - POST: 'sortImChatMenuTree', - }, - '/drive/v1/files': { - GET: 'listDrivev1File', - }, - '/drive/v1/files/create_folder': { - POST: 'createFolderDrivev1File', - }, - '/drive/v1/metas/batch_query': { - POST: 'batchQueryDrivev1Meta', - }, - '/drive/v1/files/{file_token}/statistics': { - GET: 'getDrivev1FileStatistics', - }, - '/drive/v1/files/{file_token}/copy': { - POST: 'copyDrivev1File', - }, - '/drive/v1/files/{file_token}/move': { - POST: 'moveDrivev1File', - }, - '/drive/v1/files/{file_token}': { - DELETE: 'deleteDrivev1File', - }, - '/drive/v1/files/create_shortcut': { - POST: 'createShortcutDrivev1File', - }, - '/drive/v1/files/task_check': { - GET: 'taskCheckDrivev1File', - }, - '/drive/v1/medias/batch_get_tmp_download_url': { - GET: 'batchGetTmpDownloadUrlDrivev1Media', - }, - '/drive/v1/medias/upload_prepare': { - POST: 'uploadPrepareDrivev1Media', - }, - '/drive/v1/medias/upload_finish': { - POST: 'uploadFinishDrivev1Media', - }, - '/drive/v1/files/{file_token}/subscribe': { - POST: 'subscribeDrivev1File', - }, - '/drive/v1/files/{file_token}/delete_subscribe': { - DELETE: 'deleteSubscribeDrivev1File', - }, - '/drive/v1/files/{file_token}/get_subscribe': { - GET: 'getSubscribeDrivev1File', - }, - '/drive/v1/files/upload_prepare': { - POST: 'uploadPrepareDrivev1File', - }, - '/drive/v1/files/upload_finish': { - POST: 'uploadFinishDrivev1File', - }, - '/drive/v1/import_tasks': { - POST: 'createDrivev1ImportTask', - }, - '/drive/v1/import_tasks/{ticket}': { - GET: 'getDrivev1ImportTask', - }, - '/drive/v1/export_tasks': { - POST: 'createDrivev1ExportTask', - }, - '/drive/v1/export_tasks/{ticket}': { - GET: 'getDrivev1ExportTask', - }, - '/drive/v1/export_tasks/file/{file_token}/download': { - GET: 'downloadDrivev1ExportTask', - }, - '/drive/v1/files/{file_token}/view_records': { - GET: 'listDrivev1FileViewRecord', - }, - '/drive/v1/files/{file_token}/versions': { - POST: 'createDrivev1FileVersion', - GET: 'listDrivev1FileVersion', - }, - '/drive/v1/files/{file_token}/versions/{version_id}': { - DELETE: 'deleteDrivev1FileVersion', - GET: 'getDrivev1FileVersion', - }, - '/drive/v1/permissions/{token}/members/transfer_owner': { - POST: 'transferOwnerDrivev1PermissionMember', - }, - '/drive/v1/permissions/{token}/members/auth': { - GET: 'authDrivev1PermissionMember', - }, - '/drive/v1/permissions/{token}/members': { - GET: 'listDrivev1PermissionMember', - POST: 'createDrivev1PermissionMember', - }, - '/drive/v1/permissions/{token}/members/{member_id}': { - PUT: 'updateDrivev1PermissionMember', - DELETE: 'deleteDrivev1PermissionMember', - }, - '/drive/v1/permissions/{token}/public/password': { - POST: 'createDrivev1PermissionPublicPassword', - PUT: 'updateDrivev1PermissionPublicPassword', - DELETE: 'deleteDrivev1PermissionPublicPassword', - }, - '/drive/v1/permissions/{token}/public': { - GET: 'getDrivev1PermissionPublic', - PATCH: 'patchDrivev1PermissionPublic', - }, - '/drive/v2/permissions/{token}/public': { - GET: 'getDrivev2PermissionPublic', - PATCH: 'patchDrivev2PermissionPublic', - }, - '/drive/v1/files/{file_token}/comments': { - GET: 'listDrivev1FileComment', - POST: 'createDrivev1FileComment', - }, - '/drive/v1/files/{file_token}/comments/batch_query': { - POST: 'batchQueryDrivev1FileComment', - }, - '/drive/v1/files/{file_token}/comments/{comment_id}': { - PATCH: 'patchDrivev1FileComment', - GET: 'getDrivev1FileComment', - }, - '/drive/v1/files/{file_token}/comments/{comment_id}/replies': { - GET: 'listDrivev1FileCommentReply', - }, - '/drive/v1/files/{file_token}/comments/{comment_id}/replies/{reply_id}': { - PUT: 'updateDrivev1FileCommentReply', - DELETE: 'deleteDrivev1FileCommentReply', - }, - '/docx/v1/documents/{document_id}': { - GET: 'getDocxDocument', - }, - '/docx/v1/documents/{document_id}/raw_content': { - GET: 'rawContentDocxDocument', - }, - '/docx/v1/documents/{document_id}/blocks': { - GET: 'listDocxDocumentBlock', - }, - '/docx/v1/documents': { - POST: 'createDocxDocument', - }, - '/docx/v1/documents/{document_id}/blocks/{block_id}': { - GET: 'getDocxDocumentBlock', - PATCH: 'patchDocxDocumentBlock', - }, - '/docx/v1/documents/{document_id}/blocks/{block_id}/children': { - GET: 'getDocxDocumentBlockChildren', - POST: 'createDocxDocumentBlockChildren', - }, - '/docx/v1/documents/{document_id}/blocks/batch_update': { - PATCH: 'batchUpdateDocxDocumentBlock', - }, - '/docx/v1/documents/{document_id}/blocks/{block_id}/children/batch_delete': { - DELETE: 'batchDeleteDocxDocumentBlockChildren', - }, - '/board/v1/whiteboards/{whiteboard_id}/nodes': { - GET: 'listBoardWhiteboardNode', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}': { - PATCH: 'patchSheetsSpreadsheet', - GET: 'getSheetsSpreadsheet', - }, - '/sheets/v3/spreadsheets': { - POST: 'createSheetsSpreadsheet', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}': { - GET: 'getSheetsSpreadsheetSheet', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/query': { - GET: 'querySheetsSpreadsheetSheet', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/move_dimension': { - POST: 'moveDimensionSheetsSpreadsheetSheet', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/find': { - POST: 'findSheetsSpreadsheetSheet', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/replace': { - POST: 'replaceSheetsSpreadsheetSheet', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter': { - GET: 'getSheetsSpreadsheetSheetFilter', - POST: 'createSheetsSpreadsheetSheetFilter', - PUT: 'updateSheetsSpreadsheetSheetFilter', - DELETE: 'deleteSheetsSpreadsheetSheetFilter', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}': { - GET: 'getSheetsSpreadsheetSheetFilterView', - PATCH: 'patchSheetsSpreadsheetSheetFilterView', - DELETE: 'deleteSheetsSpreadsheetSheetFilterView', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/query': { - GET: 'querySheetsSpreadsheetSheetFilterView', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views': { - POST: 'createSheetsSpreadsheetSheetFilterView', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}/conditions/{condition_id}': { - GET: 'getSheetsSpreadsheetSheetFilterViewCondition', - PUT: 'updateSheetsSpreadsheetSheetFilterViewCondition', - DELETE: 'deleteSheetsSpreadsheetSheetFilterViewCondition', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}/conditions/query': { - GET: 'querySheetsSpreadsheetSheetFilterViewCondition', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}/conditions': { - POST: 'createSheetsSpreadsheetSheetFilterViewCondition', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/float_images/{float_image_id}': { - GET: 'getSheetsSpreadsheetSheetFloatImage', - PATCH: 'patchSheetsSpreadsheetSheetFloatImage', - DELETE: 'deleteSheetsSpreadsheetSheetFloatImage', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/float_images/query': { - GET: 'querySheetsSpreadsheetSheetFloatImage', - }, - '/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/float_images': { - POST: 'createSheetsSpreadsheetSheetFloatImage', - }, - '/bitable/v1/apps/{app_token}/copy': { - POST: 'copyBitableApp', - }, - '/bitable/v1/apps': { - POST: 'createBitableApp', - }, - '/bitable/v1/apps/{app_token}': { - GET: 'getBitableApp', - PUT: 'updateBitableApp', - }, - '/bitable/v1/apps/{app_token}/tables': { - POST: 'createBitableAppTable', - GET: 'listBitableAppTable', - }, - '/bitable/v1/apps/{app_token}/tables/batch_create': { - POST: 'batchCreateBitableAppTable', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}': { - DELETE: 'deleteBitableAppTable', - PATCH: 'patchBitableAppTable', - }, - '/bitable/v1/apps/{app_token}/tables/batch_delete': { - POST: 'batchDeleteBitableAppTable', - }, - '/bitable/v1/apps/{app_token}/dashboards/{block_id}/copy': { - POST: 'copyBitableAppDashboard', - }, - '/bitable/v1/apps/{app_token}/dashboards': { - GET: 'listBitableAppDashboard', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/views/{view_id}': { - PATCH: 'patchBitableAppTableView', - GET: 'getBitableAppTableView', - DELETE: 'deleteBitableAppTableView', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/views': { - GET: 'listBitableAppTableView', - POST: 'createBitableAppTableView', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}': { - PATCH: 'patchBitableAppTableForm', - GET: 'getBitableAppTableForm', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}/fields/{field_id}': { - PATCH: 'patchBitableAppTableFormField', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}/fields': { - GET: 'listBitableAppTableFormField', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}': { - GET: 'getBitableAppTableRecord', - PUT: 'updateBitableAppTableRecord', - DELETE: 'deleteBitableAppTableRecord', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/records/search': { - POST: 'searchBitableAppTableRecord', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/records': { - POST: 'createBitableAppTableRecord', - GET: 'listBitableAppTableRecord', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_create': { - POST: 'batchCreateBitableAppTableRecord', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_update': { - POST: 'batchUpdateBitableAppTableRecord', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_delete': { - POST: 'batchDeleteBitableAppTableRecord', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/fields': { - GET: 'listBitableAppTableField', - POST: 'createBitableAppTableField', - }, - '/bitable/v1/apps/{app_token}/tables/{table_id}/fields/{field_id}': { - PUT: 'updateBitableAppTableField', - DELETE: 'deleteBitableAppTableField', - }, - '/bitable/v1/apps/{app_token}/roles': { - GET: 'listBitableAppRole', - POST: 'createBitableAppRole', - }, - '/bitable/v1/apps/{app_token}/roles/{role_id}': { - DELETE: 'deleteBitableAppRole', - PUT: 'updateBitableAppRole', - }, - '/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_delete': { - POST: 'batchDeleteBitableAppRoleMember', - }, - '/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_create': { - POST: 'batchCreateBitableAppRoleMember', - }, - '/bitable/v1/apps/{app_token}/roles/{role_id}/members': { - GET: 'listBitableAppRoleMember', - POST: 'createBitableAppRoleMember', - }, - '/bitable/v1/apps/{app_token}/roles/{role_id}/members/{member_id}': { - DELETE: 'deleteBitableAppRoleMember', - }, - '/wiki/v2/spaces': { - GET: 'listWikiSpace', - POST: 'createWikiSpace', - }, - '/wiki/v2/spaces/{space_id}': { - GET: 'getWikiSpace', - }, - '/wiki/v2/spaces/{space_id}/members': { - POST: 'createWikiSpaceMember', - }, - '/wiki/v2/spaces/{space_id}/members/{member_id}': { - DELETE: 'deleteWikiSpaceMember', - }, - '/wiki/v2/spaces/{space_id}/setting': { - PUT: 'updateWikiSpaceSetting', - }, - '/wiki/v2/spaces/{space_id}/nodes': { - POST: 'createWikiSpaceNode', - GET: 'listWikiSpaceNode', - }, - '/wiki/v2/spaces/get_node': { - GET: 'getNodeWikiSpace', - }, - '/wiki/v2/spaces/{space_id}/nodes/{node_token}/move': { - POST: 'moveWikiSpaceNode', - }, - '/wiki/v2/spaces/{space_id}/nodes/{node_token}/update_title': { - POST: 'updateTitleWikiSpaceNode', - }, - '/wiki/v2/spaces/{space_id}/nodes/{node_token}/copy': { - POST: 'copyWikiSpaceNode', - }, - '/wiki/v2/spaces/{space_id}/nodes/move_docs_to_wiki': { - POST: 'moveDocsToWikiWikiSpaceNode', - }, - '/wiki/v2/tasks/{task_id}': { - GET: 'getWikiTask', - }, - '/wiki/v1/nodes/search': { - POST: 'searchWikiNode', - }, - '/drive/v1/files/{file_token}/subscriptions/{subscription_id}': { - GET: 'getDrivev1FileSubscription', - PATCH: 'patchDrivev1FileSubscription', - }, - '/drive/v1/files/{file_token}/subscriptions': { - POST: 'createDrivev1FileSubscription', - }, - '/calendar/v4/calendars': { - POST: 'createCalendar', - GET: 'listCalendar', - }, - '/calendar/v4/calendars/{calendar_id}': { - DELETE: 'deleteCalendar', - GET: 'getCalendar', - PATCH: 'patchCalendar', - }, - '/calendar/v4/calendars/primary': { - POST: 'primaryCalendar', - }, - '/calendar/v4/freebusy/list': { - POST: 'listCalendarFreebusy', - }, - '/calendar/v4/calendars/search': { - POST: 'searchCalendar', - }, - '/calendar/v4/calendars/{calendar_id}/subscribe': { - POST: 'subscribeCalendar', - }, - '/calendar/v4/calendars/{calendar_id}/unsubscribe': { - POST: 'unsubscribeCalendar', - }, - '/calendar/v4/calendars/subscription': { - POST: 'subscriptionCalendar', - }, - '/calendar/v4/calendars/unsubscription': { - POST: 'unsubscriptionCalendar', - }, - '/calendar/v4/calendars/{calendar_id}/acls': { - POST: 'createCalendarCalendarAcl', - GET: 'listCalendarCalendarAcl', - }, - '/calendar/v4/calendars/{calendar_id}/acls/{acl_id}': { - DELETE: 'deleteCalendarCalendarAcl', - }, - '/calendar/v4/calendars/{calendar_id}/acls/subscription': { - POST: 'subscriptionCalendarCalendarAcl', - }, - '/calendar/v4/calendars/{calendar_id}/acls/unsubscription': { - POST: 'unsubscriptionCalendarCalendarAcl', - }, - '/calendar/v4/calendars/{calendar_id}/events': { - POST: 'createCalendarCalendarEvent', - GET: 'listCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/{event_id}': { - DELETE: 'deleteCalendarCalendarEvent', - PATCH: 'patchCalendarCalendarEvent', - GET: 'getCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/search': { - POST: 'searchCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/subscription': { - POST: 'subscriptionCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/unsubscription': { - POST: 'unsubscriptionCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/{event_id}/reply': { - POST: 'replyCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/{event_id}/instances': { - GET: 'instancesCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/instance_view': { - GET: 'instanceViewCalendarCalendarEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/{event_id}/meeting_chat': { - POST: 'createCalendarCalendarEventMeetingChat', - DELETE: 'deleteCalendarCalendarEventMeetingChat', - }, - '/calendar/v4/timeoff_events': { - POST: 'createCalendarTimeoffEvent', - }, - '/calendar/v4/timeoff_events/{timeoff_event_id}': { - DELETE: 'deleteCalendarTimeoffEvent', - }, - '/calendar/v4/calendars/{calendar_id}/events/{event_id}/attendees': { - POST: 'createCalendarCalendarEventAttendee', - GET: 'listCalendarCalendarEventAttendee', - }, - '/calendar/v4/calendars/{calendar_id}/events/{event_id}/attendees/batch_delete': { - POST: 'batchDeleteCalendarCalendarEventAttendee', - }, - '/calendar/v4/calendars/{calendar_id}/events/{event_id}/attendees/{attendee_id}/chat_members': { - GET: 'listCalendarCalendarEventAttendeeChatMember', - }, - '/calendar/v4/settings/generate_caldav_conf': { - POST: 'generateCaldavConfCalendarSetting', - }, - '/calendar/v4/exchange_bindings': { - POST: 'createCalendarExchangeBinding', - }, - '/calendar/v4/exchange_bindings/{exchange_binding_id}': { - DELETE: 'deleteCalendarExchangeBinding', - GET: 'getCalendarExchangeBinding', - }, - '/vc/v1/reserves/apply': { - POST: 'applyVcReserve', - }, - '/vc/v1/reserves/{reserve_id}': { - DELETE: 'deleteVcReserve', - PUT: 'updateVcReserve', - GET: 'getVcReserve', - }, - '/vc/v1/reserves/{reserve_id}/get_active_meeting': { - GET: 'getActiveMeetingVcReserve', - }, - '/vc/v1/meetings/{meeting_id}/invite': { - PATCH: 'inviteVcMeeting', - }, - '/vc/v1/meetings/{meeting_id}/kickout': { - POST: 'kickoutVcMeeting', - }, - '/vc/v1/meetings/{meeting_id}/set_host': { - PATCH: 'setHostVcMeeting', - }, - '/vc/v1/meetings/{meeting_id}/end': { - PATCH: 'endVcMeeting', - }, - '/vc/v1/meetings/{meeting_id}': { - GET: 'getVcMeeting', - }, - '/vc/v1/meetings/list_by_no': { - GET: 'listByNoVcMeeting', - }, - '/vc/v1/meetings/{meeting_id}/recording/start': { - PATCH: 'startVcMeetingRecording', - }, - '/vc/v1/meetings/{meeting_id}/recording/stop': { - PATCH: 'stopVcMeetingRecording', - }, - '/vc/v1/meetings/{meeting_id}/recording': { - GET: 'getVcMeetingRecording', - }, - '/vc/v1/meetings/{meeting_id}/recording/set_permission': { - PATCH: 'setPermissionVcMeetingRecording', - }, - '/vc/v1/reports/get_daily': { - GET: 'getDailyVcReport', - }, - '/vc/v1/reports/get_top_user': { - GET: 'getTopUserVcReport', - }, - '/vc/v1/exports/meeting_list': { - POST: 'meetingListVcExport', - }, - '/vc/v1/exports/participant_list': { - POST: 'participantListVcExport', - }, - '/vc/v1/exports/participant_quality_list': { - POST: 'participantQualityListVcExport', - }, - '/vc/v1/exports/resource_reservation_list': { - POST: 'resourceReservationListVcExport', - }, - '/vc/v1/exports/{task_id}': { - GET: 'getVcExport', - }, - '/vc/v1/room_levels': { - POST: 'createVcRoomLevel', - GET: 'listVcRoomLevel', - }, - '/vc/v1/room_levels/del': { - POST: 'delVcRoomLevel', - }, - '/vc/v1/room_levels/{room_level_id}': { - PATCH: 'patchVcRoomLevel', - GET: 'getVcRoomLevel', - }, - '/vc/v1/room_levels/mget': { - POST: 'mgetVcRoomLevel', - }, - '/vc/v1/room_levels/search': { - GET: 'searchVcRoomLevel', - }, - '/vc/v1/rooms': { - POST: 'createVcRoom', - GET: 'listVcRoom', - }, - '/vc/v1/rooms/{room_id}': { - DELETE: 'deleteVcRoom', - PATCH: 'patchVcRoom', - GET: 'getVcRoom', - }, - '/vc/v1/rooms/mget': { - POST: 'mgetVcRoom', - }, - '/vc/v1/rooms/search': { - POST: 'searchVcRoom', - }, - '/vc/v1/scope_config': { - GET: 'getVcScopeConfig', - POST: 'createVcScopeConfig', - }, - '/vc/v1/reserve_configs/reserve_scope': { - GET: 'reserveScopeVcReserveConfig', - }, - '/vc/v1/reserve_configs/{reserve_config_id}': { - PATCH: 'patchVcReserveConfig', - }, - '/vc/v1/reserve_configs/{reserve_config_id}/form': { - GET: 'getVcReserveConfigForm', - PATCH: 'patchVcReserveConfigForm', - }, - '/vc/v1/reserve_configs/{reserve_config_id}/admin': { - GET: 'getVcReserveConfigAdmin', - PATCH: 'patchVcReserveConfigAdmin', - }, - '/vc/v1/reserve_configs/{reserve_config_id}/disable_inform': { - GET: 'getVcReserveConfigDisableInform', - PATCH: 'patchVcReserveConfigDisableInform', - }, - '/vc/v1/meeting_list': { - GET: 'getVcMeetingList', - }, - '/vc/v1/participant_list': { - GET: 'getVcParticipantList', - }, - '/vc/v1/participant_quality_list': { - GET: 'getVcParticipantQualityList', - }, - '/vc/v1/resource_reservation_list': { - GET: 'getVcResourceReservationList', - }, - '/vc/v1/alerts': { - GET: 'listVcAlert', - }, - '/attendance/v1/shifts': { - POST: 'createAttendanceShift', - GET: 'listAttendanceShift', - }, - '/attendance/v1/shifts/{shift_id}': { - DELETE: 'deleteAttendanceShift', - GET: 'getAttendanceShift', - }, - '/attendance/v1/shifts/query': { - POST: 'queryAttendanceShift', - }, - '/attendance/v1/groups': { - POST: 'createAttendanceGroup', - GET: 'listAttendanceGroup', - }, - '/attendance/v1/groups/{group_id}': { - DELETE: 'deleteAttendanceGroup', - GET: 'getAttendanceGroup', - }, - '/attendance/v1/groups/search': { - POST: 'searchAttendanceGroup', - }, - '/attendance/v1/user_daily_shifts/batch_create': { - POST: 'batchCreateAttendanceUserDailyShift', - }, - '/attendance/v1/user_daily_shifts/query': { - POST: 'queryAttendanceUserDailyShift', - }, - '/attendance/v1/user_stats_views/{user_stats_view_id}': { - PUT: 'updateAttendanceUserStatsView', - }, - '/attendance/v1/user_stats_fields/query': { - POST: 'queryAttendanceUserStatsField', - }, - '/attendance/v1/user_stats_views/query': { - POST: 'queryAttendanceUserStatsView', - }, - '/attendance/v1/user_stats_datas/query': { - POST: 'queryAttendanceUserStatsData', - }, - '/attendance/v1/user_approvals/query': { - POST: 'queryAttendanceUserApproval', - }, - '/attendance/v1/user_approvals': { - POST: 'createAttendanceUserApproval', - }, - '/attendance/v1/approval_infos/process': { - POST: 'processAttendanceApprovalInfo', - }, - '/attendance/v1/user_task_remedys': { - POST: 'createAttendanceUserTaskRemedy', - }, - '/attendance/v1/user_task_remedys/query_user_allowed_remedys': { - POST: 'queryUserAllowedRemedysAttendanceUserTaskRemedy', - }, - '/attendance/v1/user_task_remedys/query': { - POST: 'queryAttendanceUserTaskRemedy', - }, - '/attendance/v1/user_flows/batch_create': { - POST: 'batchCreateAttendanceUserFlow', - }, - '/attendance/v1/user_flows/{user_flow_id}': { - GET: 'getAttendanceUserFlow', - }, - '/attendance/v1/user_flows/query': { - POST: 'queryAttendanceUserFlow', - }, - '/attendance/v1/user_tasks/query': { - POST: 'queryAttendanceUserTask', - }, - '/attendance/v1/user_settings/modify': { - POST: 'modifyAttendanceUserSetting', - }, - '/attendance/v1/user_settings/query': { - GET: 'queryAttendanceUserSetting', - }, - '/attendance/v1/leave_employ_expire_records/{leave_id}': { - GET: 'getAttendanceLeaveEmployExpireRecord', - }, - '/attendance/v1/leave_accrual_record/{leave_id}': { - PATCH: 'patchAttendanceLeaveAccrualRecord', - }, - '/approval/v4/approvals': { - POST: 'createApproval', - }, - '/approval/v4/approvals/{approval_code}': { - GET: 'getApproval', - }, - '/approval/v4/instances': { - POST: 'createApprovalInstance', - GET: 'listApprovalInstance', - }, - '/approval/v4/instances/cancel': { - POST: 'cancelApprovalInstance', - }, - '/approval/v4/instances/cc': { - POST: 'ccApprovalInstance', - }, - '/approval/v4/instances/preview': { - POST: 'previewApprovalInstance', - }, - '/approval/v4/instances/{instance_id}': { - GET: 'getApprovalInstance', - }, - '/approval/v4/tasks/approve': { - POST: 'approveApprovalTask', - }, - '/approval/v4/tasks/reject': { - POST: 'rejectApprovalTask', - }, - '/approval/v4/tasks/transfer': { - POST: 'transferApprovalTask', - }, - '/approval/v4/instances/specified_rollback': { - POST: 'specifiedRollbackApprovalInstance', - }, - '/approval/v4/instances/add_sign': { - POST: 'addSignApprovalInstance', - }, - '/approval/v4/tasks/resubmit': { - POST: 'resubmitApprovalTask', - }, - '/approval/v4/instances/{instance_id}/comments': { - POST: 'createApprovalInstanceComment', - GET: 'listApprovalInstanceComment', - }, - '/approval/v4/instances/{instance_id}/comments/{comment_id}': { - DELETE: 'deleteApprovalInstanceComment', - }, - '/approval/v4/instances/{instance_id}/comments/remove': { - POST: 'removeApprovalInstanceComment', - }, - '/approval/v4/external_approvals': { - POST: 'createApprovalExternalApproval', - }, - '/approval/v4/external_approvals/{approval_code}': { - GET: 'getApprovalExternalApproval', - }, - '/approval/v4/external_instances': { - POST: 'createApprovalExternalInstance', - }, - '/approval/v4/external_instances/check': { - POST: 'checkApprovalExternalInstance', - }, - '/approval/v4/external_tasks': { - GET: 'listApprovalExternalTask', - }, - '/approval/v4/instances/query': { - POST: 'queryApprovalInstance', - }, - '/approval/v4/instances/search_cc': { - POST: 'searchCcApprovalInstance', - }, - '/approval/v4/tasks/search': { - POST: 'searchApprovalTask', - }, - '/approval/v4/tasks/query': { - GET: 'queryApprovalTask', - }, - '/approval/v4/approvals/{approval_code}/subscribe': { - POST: 'subscribeApproval', - }, - '/approval/v4/approvals/{approval_code}/unsubscribe': { - POST: 'unsubscribeApproval', - }, - '/helpdesk/v1/agents/{agent_id}': { - PATCH: 'patchHelpdeskAgent', - }, - '/helpdesk/v1/agent_emails': { - GET: 'agentEmailHelpdeskAgent', - }, - '/helpdesk/v1/agent_schedules': { - POST: 'createHelpdeskAgentSchedule', - GET: 'listHelpdeskAgentSchedule', - }, - '/helpdesk/v1/agents/{agent_id}/schedules': { - DELETE: 'deleteHelpdeskAgentSchedules', - PATCH: 'patchHelpdeskAgentSchedules', - GET: 'getHelpdeskAgentSchedules', - }, - '/helpdesk/v1/agent_skills': { - POST: 'createHelpdeskAgentSkill', - GET: 'listHelpdeskAgentSkill', - }, - '/helpdesk/v1/agent_skills/{agent_skill_id}': { - DELETE: 'deleteHelpdeskAgentSkill', - PATCH: 'patchHelpdeskAgentSkill', - GET: 'getHelpdeskAgentSkill', - }, - '/helpdesk/v1/agent_skill_rules': { - GET: 'listHelpdeskAgentSkillRule', - }, - '/helpdesk/v1/start_service': { - POST: 'startServiceHelpdeskTicket', - }, - '/helpdesk/v1/tickets/{ticket_id}': { - GET: 'getHelpdeskTicket', - PUT: 'updateHelpdeskTicket', - }, - '/helpdesk/v1/tickets': { - GET: 'listHelpdeskTicket', - }, - '/helpdesk/v1/tickets/{ticket_id}/answer_user_query': { - POST: 'answerUserQueryHelpdeskTicket', - }, - '/helpdesk/v1/customized_fields': { - GET: 'customizedFieldsHelpdeskTicket', - }, - '/helpdesk/v1/tickets/{ticket_id}/messages': { - POST: 'createHelpdeskTicketMessage', - GET: 'listHelpdeskTicketMessage', - }, - '/helpdesk/v1/message': { - POST: 'createHelpdeskBotMessage', - }, - '/helpdesk/v1/ticket_customized_fields': { - POST: 'createHelpdeskTicketCustomizedField', - GET: 'listHelpdeskTicketCustomizedField', - }, - '/helpdesk/v1/ticket_customized_fields/{ticket_customized_field_id}': { - DELETE: 'deleteHelpdeskTicketCustomizedField', - PATCH: 'patchHelpdeskTicketCustomizedField', - GET: 'getHelpdeskTicketCustomizedField', - }, - '/helpdesk/v1/faqs': { - POST: 'createHelpdeskFaq', - GET: 'listHelpdeskFaq', - }, - '/helpdesk/v1/faqs/{id}': { - DELETE: 'deleteHelpdeskFaq', - PATCH: 'patchHelpdeskFaq', - GET: 'getHelpdeskFaq', - }, - '/helpdesk/v1/faqs/search': { - GET: 'searchHelpdeskFaq', - }, - '/helpdesk/v1/categories': { - POST: 'createHelpdeskCategory', - GET: 'listHelpdeskCategory', - }, - '/helpdesk/v1/categories/{id}': { - GET: 'getHelpdeskCategory', - PATCH: 'patchHelpdeskCategory', - DELETE: 'deleteHelpdeskCategory', - }, - '/helpdesk/v1/notifications': { - POST: 'createHelpdeskNotification', - }, - '/helpdesk/v1/notifications/{notification_id}': { - PATCH: 'patchHelpdeskNotification', - GET: 'getHelpdeskNotification', - }, - '/helpdesk/v1/notifications/{notification_id}/preview': { - POST: 'previewHelpdeskNotification', - }, - '/helpdesk/v1/notifications/{notification_id}/submit_approve': { - POST: 'submitApproveHelpdeskNotification', - }, - '/helpdesk/v1/notifications/{notification_id}/cancel_approve': { - POST: 'cancelApproveHelpdeskNotification', - }, - '/helpdesk/v1/notifications/{notification_id}/execute_send': { - POST: 'executeSendHelpdeskNotification', - }, - '/helpdesk/v1/notifications/{notification_id}/cancel_send': { - POST: 'cancelSendHelpdeskNotification', - }, - '/helpdesk/v1/events/subscribe': { - POST: 'subscribeHelpdeskEvent', - }, - '/helpdesk/v1/events/unsubscribe': { - POST: 'unsubscribeHelpdeskEvent', - }, - '/task/v1/tasks': { - POST: 'createTaskv1', - GET: 'listTaskv1', - }, - '/task/v1/tasks/{task_id}': { - DELETE: 'deleteTaskv1', - PATCH: 'patchTaskv1', - GET: 'getTaskv1', - }, - '/task/v1/tasks/{task_id}/complete': { - POST: 'completeTaskv1', - }, - '/task/v1/tasks/{task_id}/uncomplete': { - POST: 'uncompleteTaskv1', - }, - '/task/v1/tasks/{task_id}/reminders': { - POST: 'createTaskv1TaskReminder', - GET: 'listTaskv1TaskReminder', - }, - '/task/v1/tasks/{task_id}/reminders/{reminder_id}': { - DELETE: 'deleteTaskv1TaskReminder', - }, - '/task/v1/tasks/{task_id}/comments': { - POST: 'createTaskv1TaskComment', - GET: 'listTaskv1TaskComment', - }, - '/task/v1/tasks/{task_id}/comments/{comment_id}': { - DELETE: 'deleteTaskv1TaskComment', - PUT: 'updateTaskv1TaskComment', - GET: 'getTaskv1TaskComment', - }, - '/task/v1/tasks/{task_id}/followers': { - POST: 'createTaskv1TaskFollower', - GET: 'listTaskv1TaskFollower', - }, - '/task/v1/tasks/{task_id}/followers/{follower_id}': { - DELETE: 'deleteTaskv1TaskFollower', - }, - '/task/v1/tasks/{task_id}/batch_delete_follower': { - POST: 'batchDeleteFollowerTaskv1', - }, - '/task/v1/tasks/{task_id}/collaborators': { - POST: 'createTaskv1TaskCollaborator', - GET: 'listTaskv1TaskCollaborator', - }, - '/task/v1/tasks/{task_id}/collaborators/{collaborator_id}': { - DELETE: 'deleteTaskv1TaskCollaborator', - }, - '/task/v1/tasks/{task_id}/batch_delete_collaborator': { - POST: 'batchDeleteCollaboratorTaskv1', - }, - '/task/v2/tasks': { - POST: 'createTaskv2', - GET: 'listTaskv2', - }, - '/task/v2/tasks/{task_guid}': { - GET: 'getTaskv2', - PATCH: 'patchTaskv2', - DELETE: 'deleteTaskv2', - }, - '/task/v2/tasks/{task_guid}/add_members': { - POST: 'addMembersTaskv2', - }, - '/task/v2/tasks/{task_guid}/remove_members': { - POST: 'removeMembersTaskv2', - }, - '/task/v2/tasks/{task_guid}/tasklists': { - GET: 'tasklistsTaskv2', - }, - '/task/v2/tasks/{task_guid}/add_tasklist': { - POST: 'addTasklistTaskv2', - }, - '/task/v2/tasks/{task_guid}/remove_tasklist': { - POST: 'removeTasklistTaskv2', - }, - '/task/v2/tasks/{task_guid}/add_reminders': { - POST: 'addRemindersTaskv2', - }, - '/task/v2/tasks/{task_guid}/remove_reminders': { - POST: 'removeRemindersTaskv2', - }, - '/task/v2/tasks/{task_guid}/add_dependencies': { - POST: 'addDependenciesTaskv2', - }, - '/task/v2/tasks/{task_guid}/remove_dependencies': { - POST: 'removeDependenciesTaskv2', - }, - '/task/v2/tasks/{task_guid}/subtasks': { - POST: 'createTaskv2TaskSubtask', - GET: 'listTaskv2TaskSubtask', - }, - '/task/v2/tasklists': { - POST: 'createTaskv2Tasklist', - GET: 'listTaskv2Tasklist', - }, - '/task/v2/tasklists/{tasklist_guid}': { - GET: 'getTaskv2Tasklist', - PATCH: 'patchTaskv2Tasklist', - DELETE: 'deleteTaskv2Tasklist', - }, - '/task/v2/tasklists/{tasklist_guid}/add_members': { - POST: 'addMembersTaskv2Tasklist', - }, - '/task/v2/tasklists/{tasklist_guid}/remove_members': { - POST: 'removeMembersTaskv2Tasklist', - }, - '/task/v2/tasklists/{tasklist_guid}/tasks': { - GET: 'tasksTaskv2Tasklist', - }, - '/task/v2/tasklists/{tasklist_guid}/activity_subscriptions': { - POST: 'createTaskv2TasklistActivitySubscription', - GET: 'listTaskv2TasklistActivitySubscription', - }, - '/task/v2/tasklists/{tasklist_guid}/activity_subscriptions/{activity_subscription_guid}': { - GET: 'getTaskv2TasklistActivitySubscription', - PATCH: 'patchTaskv2TasklistActivitySubscription', - DELETE: 'deleteTaskv2TasklistActivitySubscription', - }, - '/task/v2/comments': { - POST: 'createTaskv2Comment', - GET: 'listTaskv2Comment', - }, - '/task/v2/comments/{comment_id}': { - GET: 'getTaskv2Comment', - PATCH: 'patchTaskv2Comment', - DELETE: 'deleteTaskv2Comment', - }, - '/task/v2/attachments': { - GET: 'listTaskv2Attachment', - }, - '/task/v2/attachments/{attachment_guid}': { - GET: 'getTaskv2Attachment', - DELETE: 'deleteTaskv2Attachment', - }, - '/task/v2/sections': { - POST: 'createTaskv2Section', - GET: 'listTaskv2Section', - }, - '/task/v2/sections/{section_guid}': { - GET: 'getTaskv2Section', - PATCH: 'patchTaskv2Section', - DELETE: 'deleteTaskv2Section', - }, - '/task/v2/sections/{section_guid}/tasks': { - GET: 'tasksTaskv2Section', - }, - '/task/v2/custom_fields': { - POST: 'createTaskv2CustomField', - GET: 'listTaskv2CustomField', - }, - '/task/v2/custom_fields/{custom_field_guid}': { - GET: 'getTaskv2CustomField', - PATCH: 'patchTaskv2CustomField', - }, - '/task/v2/custom_fields/{custom_field_guid}/add': { - POST: 'addTaskv2CustomField', - }, - '/task/v2/custom_fields/{custom_field_guid}/remove': { - POST: 'removeTaskv2CustomField', - }, - '/task/v2/custom_fields/{custom_field_guid}/options': { - POST: 'createTaskv2CustomFieldOption', - }, - '/task/v2/custom_fields/{custom_field_guid}/options/{option_guid}': { - PATCH: 'patchTaskv2CustomFieldOption', - }, - '/mail/v1/mailgroups': { - POST: 'createMailMailgroup', - GET: 'listMailMailgroup', - }, - '/mail/v1/mailgroups/{mailgroup_id}': { - DELETE: 'deleteMailMailgroup', - PATCH: 'patchMailMailgroup', - PUT: 'updateMailMailgroup', - GET: 'getMailMailgroup', - }, - '/mail/v1/mailgroups/{mailgroup_id}/managers/batch_create': { - POST: 'batchCreateMailMailgroupManager', - }, - '/mail/v1/mailgroups/{mailgroup_id}/managers/batch_delete': { - POST: 'batchDeleteMailMailgroupManager', - }, - '/mail/v1/mailgroups/{mailgroup_id}/managers': { - GET: 'listMailMailgroupManager', - }, - '/mail/v1/mailgroups/{mailgroup_id}/members': { - POST: 'createMailMailgroupMember', - GET: 'listMailMailgroupMember', - }, - '/mail/v1/mailgroups/{mailgroup_id}/members/{member_id}': { - DELETE: 'deleteMailMailgroupMember', - GET: 'getMailMailgroupMember', - }, - '/mail/v1/mailgroups/{mailgroup_id}/members/batch_create': { - POST: 'batchCreateMailMailgroupMember', - }, - '/mail/v1/mailgroups/{mailgroup_id}/members/batch_delete': { - DELETE: 'batchDeleteMailMailgroupMember', - }, - '/mail/v1/mailgroups/{mailgroup_id}/aliases': { - POST: 'createMailMailgroupAlias', - GET: 'listMailMailgroupAlias', - }, - '/mail/v1/mailgroups/{mailgroup_id}/aliases/{alias_id}': { - DELETE: 'deleteMailMailgroupAlias', - }, - '/mail/v1/mailgroups/{mailgroup_id}/permission_members': { - POST: 'createMailMailgroupPermissionMember', - GET: 'listMailMailgroupPermissionMember', - }, - '/mail/v1/mailgroups/{mailgroup_id}/permission_members/{permission_member_id}': { - DELETE: 'deleteMailMailgroupPermissionMember', - GET: 'getMailMailgroupPermissionMember', - }, - '/mail/v1/mailgroups/{mailgroup_id}/permission_members/batch_create': { - POST: 'batchCreateMailMailgroupPermissionMember', - }, - '/mail/v1/mailgroups/{mailgroup_id}/permission_members/batch_delete': { - DELETE: 'batchDeleteMailMailgroupPermissionMember', - }, - '/mail/v1/public_mailboxes': { - POST: 'createMailPublicMailbox', - GET: 'listMailPublicMailbox', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}': { - PATCH: 'patchMailPublicMailbox', - PUT: 'updateMailPublicMailbox', - GET: 'getMailPublicMailbox', - DELETE: 'deleteMailPublicMailbox', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}/members': { - POST: 'createMailPublicMailboxMember', - GET: 'listMailPublicMailboxMember', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}/members/{member_id}': { - DELETE: 'deleteMailPublicMailboxMember', - GET: 'getMailPublicMailboxMember', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}/members/clear': { - POST: 'clearMailPublicMailboxMember', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}/members/batch_create': { - POST: 'batchCreateMailPublicMailboxMember', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}/members/batch_delete': { - DELETE: 'batchDeleteMailPublicMailboxMember', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}/aliases': { - POST: 'createMailPublicMailboxAlias', - GET: 'listMailPublicMailboxAlias', - }, - '/mail/v1/public_mailboxes/{public_mailbox_id}/aliases/{alias_id}': { - DELETE: 'deleteMailPublicMailboxAlias', - }, - '/mail/v1/user_mailboxes/{user_mailbox_id}': { - DELETE: 'deleteMailUserMailbox', - }, - '/mail/v1/user_mailboxes/{user_mailbox_id}/aliases': { - POST: 'createMailUserMailboxAlias', - GET: 'listMailUserMailboxAlias', - }, - '/mail/v1/user_mailboxes/{user_mailbox_id}/aliases/{alias_id}': { - DELETE: 'deleteMailUserMailboxAlias', - }, - '/mail/v1/users/query': { - POST: 'queryMailUser', - }, - '/application/v6/applications/{app_id}': { - GET: 'getApplication', - PATCH: 'patchApplication', - }, - '/application/v6/applications/{app_id}/app_versions/{version_id}': { - GET: 'getApplicationApplicationAppVersion', - PATCH: 'patchApplicationApplicationAppVersion', - }, - '/application/v6/applications/{app_id}/app_versions': { - GET: 'listApplicationApplicationAppVersion', - }, - '/application/v6/applications/{app_id}/app_versions/{version_id}/contacts_range_suggest': { - GET: 'contactsRangeSuggestApplicationApplicationAppVersion', - }, - '/application/v6/applications/underauditlist': { - GET: 'underauditlistApplication', - }, - '/application/v6/applications/{app_id}/contacts_range_configuration': { - GET: 'contactsRangeConfigurationApplication', - }, - '/application/v6/applications/{app_id}/contacts_range': { - PATCH: 'patchApplicationApplicationContactsRange', - }, - '/application/v6/applications/{app_id}/visibility/check_white_black_list': { - POST: 'checkWhiteBlackListApplicationApplicationVisibility', - }, - '/application/v6/applications/{app_id}/visibility': { - PATCH: 'patchApplicationApplicationVisibility', - }, - '/application/v6/applications/{app_id}/management': { - PUT: 'updateApplicationApplicationManagement', - }, - '/application/v6/applications/{app_id}/app_usage/department_overview': { - POST: 'departmentOverviewApplicationApplicationAppUsage', - }, - '/application/v6/applications/{app_id}/app_usage/overview': { - POST: 'overviewApplicationApplicationAppUsage', - }, - '/application/v6/applications/{app_id}/feedbacks/{feedback_id}': { - PATCH: 'patchApplicationApplicationFeedback', - }, - '/application/v6/applications/{app_id}/feedbacks': { - GET: 'listApplicationApplicationFeedback', - }, - '/application/v6/app_badge/set': { - POST: 'setApplicationAppBadge', - }, - '/tenant/v2/tenant/assign_info_list/query': { - GET: 'queryTenantTenantProductAssignInfo', - }, - '/tenant/v2/tenant/query': { - GET: 'queryTenant', - }, - '/verification/v1/verification': { - GET: 'getVerification', - }, - '/personal_settings/v1/system_statuses': { - POST: 'createPersonalSettingsSystemStatus', - GET: 'listPersonalSettingsSystemStatus', - }, - '/personal_settings/v1/system_statuses/{system_status_id}': { - DELETE: 'deletePersonalSettingsSystemStatus', - PATCH: 'patchPersonalSettingsSystemStatus', - }, - '/personal_settings/v1/system_statuses/{system_status_id}/batch_open': { - POST: 'batchOpenPersonalSettingsSystemStatus', - }, - '/personal_settings/v1/system_statuses/{system_status_id}/batch_close': { - POST: 'batchClosePersonalSettingsSystemStatus', - }, - '/search/v2/message': { - POST: 'createSearchMessage', - }, - '/search/v2/app': { - POST: 'createSearchApp', - }, - '/search/v2/data_sources': { - POST: 'createSearchDataSource', - GET: 'listSearchDataSource', - }, - '/search/v2/data_sources/{data_source_id}': { - DELETE: 'deleteSearchDataSource', - PATCH: 'patchSearchDataSource', - GET: 'getSearchDataSource', - }, - '/search/v2/data_sources/{data_source_id}/items': { - POST: 'createSearchDataSourceItem', - }, - '/search/v2/data_sources/{data_source_id}/items/{item_id}': { - DELETE: 'deleteSearchDataSourceItem', - GET: 'getSearchDataSourceItem', - }, - '/search/v2/schemas': { - POST: 'createSearchSchema', - }, - '/search/v2/schemas/{schema_id}': { - DELETE: 'deleteSearchSchema', - PATCH: 'patchSearchSchema', - GET: 'getSearchSchema', - }, - '/optical_char_recognition/v1/image/basic_recognize': { - POST: 'basicRecognizeOpticalCharRecognitionImage', - }, - '/speech_to_text/v1/speech/file_recognize': { - POST: 'fileRecognizeSpeechToTextSpeech', - }, - '/speech_to_text/v1/speech/stream_recognize': { - POST: 'streamRecognizeSpeechToTextSpeech', - }, - '/translation/v1/text/detect': { - POST: 'detectTranslationText', - }, - '/translation/v1/text/translate': { - POST: 'translateTranslationText', - }, - '/apaas/v1/approval_tasks/{approval_task_id}/agree': { - POST: 'agreeApaasApprovalTask', - }, - '/apaas/v1/approval_tasks/{approval_task_id}/reject': { - POST: 'rejectApaasApprovalTask', - }, - '/apaas/v1/approval_tasks/{approval_task_id}/transfer': { - POST: 'transferApaasApprovalTask', - }, - '/apaas/v1/approval_tasks/{approval_task_id}/add_assignee': { - POST: 'addAssigneeApaasApprovalTask', - }, - '/admin/v1/password/reset': { - POST: 'resetAdminPassword', - }, - '/admin/v1/admin_dept_stats': { - GET: 'listAdminAdminDeptStat', - }, - '/admin/v1/admin_user_stats': { - GET: 'listAdminAdminUserStat', - }, - '/admin/v1/badges': { - POST: 'createAdminBadge', - GET: 'listAdminBadge', - }, - '/admin/v1/badges/{badge_id}': { - PUT: 'updateAdminBadge', - GET: 'getAdminBadge', - }, - '/admin/v1/badges/{badge_id}/grants': { - POST: 'createAdminBadgeGrant', - GET: 'listAdminBadgeGrant', - }, - '/admin/v1/badges/{badge_id}/grants/{grant_id}': { - DELETE: 'deleteAdminBadgeGrant', - PUT: 'updateAdminBadgeGrant', - GET: 'getAdminBadgeGrant', - }, - '/ehr/v1/employees': { - GET: 'listEhrEmployee', - }, - '/corehr/v2/basic_info/nationalities/search': { - POST: 'searchCorehrBasicInfoNationality', - }, - '/corehr/v2/basic_info/banks/search': { - POST: 'searchCorehrBasicInfoBank', - }, - '/corehr/v2/basic_info/bank_branchs/search': { - POST: 'searchCorehrBasicInfoBankBranch', - }, - '/corehr/v1/custom_fields/get_by_param': { - GET: 'getByParamCorehrCustomField', - }, - '/corehr/v1/custom_fields/query': { - GET: 'queryCorehrCustomField', - }, - '/corehr/v1/custom_fields/list_object_api_name': { - GET: 'listObjectApiNameCorehrCustomField', - }, - '/corehr/v2/basic_info/country_regions/search': { - POST: 'searchCorehrBasicInfoCountryRegion', - }, - '/corehr/v2/basic_info/country_region_subdivisions/search': { - POST: 'searchCorehrBasicInfoCountryRegionSubdivision', - }, - '/corehr/v2/basic_info/cities/search': { - POST: 'searchCorehrBasicInfoCity', - }, - '/corehr/v2/basic_info/districts/search': { - POST: 'searchCorehrBasicInfoDistrict', - }, - '/corehr/v1/employee_types': { - POST: 'createCorehrEmployeeType', - GET: 'listCorehrEmployeeType', - }, - '/corehr/v1/employee_types/{employee_type_id}': { - DELETE: 'deleteCorehrEmployeeType', - PATCH: 'patchCorehrEmployeeType', - GET: 'getCorehrEmployeeType', - }, - '/corehr/v1/national_id_types': { - POST: 'createCorehrNationalIdType', - GET: 'listCorehrNationalIdType', - }, - '/corehr/v1/national_id_types/{national_id_type_id}': { - DELETE: 'deleteCorehrNationalIdType', - PATCH: 'patchCorehrNationalIdType', - GET: 'getCorehrNationalIdType', - }, - '/corehr/v1/working_hours_types': { - POST: 'createCorehrWorkingHoursType', - GET: 'listCorehrWorkingHoursType', - }, - '/corehr/v1/working_hours_types/{working_hours_type_id}': { - DELETE: 'deleteCorehrWorkingHoursType', - PATCH: 'patchCorehrWorkingHoursType', - GET: 'getCorehrWorkingHoursType', - }, - '/corehr/v2/basic_info/currencies/search': { - POST: 'searchCorehrBasicInfoCurrency', - }, - '/corehr/v2/employees/batch_get': { - POST: 'batchGetCorehrEmployee', - }, - '/corehr/v2/employees/search': { - POST: 'searchCorehrEmployee', - }, - '/corehr/v1/employments': { - POST: 'createCorehrEmployment', - }, - '/corehr/v1/employments/{employment_id}': { - PATCH: 'patchCorehrEmployment', - DELETE: 'deleteCorehrEmployment', - }, - '/corehr/v2/persons': { - POST: 'createCorehrPerson', - }, - '/corehr/v2/persons/{person_id}': { - PATCH: 'patchCorehrPerson', - }, - '/corehr/v1/persons/{person_id}': { - DELETE: 'deleteCorehrPerson', - GET: 'getCorehrPerson', - }, - '/corehr/v1/job_datas': { - POST: 'createCorehrJobData', - GET: 'listCorehrJobData', - }, - '/corehr/v1/job_datas/{job_data_id}': { - DELETE: 'deleteCorehrJobData', - PATCH: 'patchCorehrJobData', - GET: 'getCorehrJobData', - }, - '/corehr/v2/employees/job_datas/query': { - POST: 'queryCorehrEmployeesJobData', - }, - '/corehr/v2/employees/job_datas/batch_get': { - POST: 'batchGetCorehrEmployeesJobData', - }, - '/corehr/v2/departments/parents': { - POST: 'parentsCorehrDepartment', - }, - '/corehr/v2/departments/search': { - POST: 'searchCorehrDepartment', - }, - '/corehr/v1/departments': { - POST: 'createCorehrDepartment', - GET: 'listCorehrDepartment', - }, - '/corehr/v1/departments/{department_id}': { - PATCH: 'patchCorehrDepartment', - DELETE: 'deleteCorehrDepartment', - GET: 'getCorehrDepartment', - }, - '/corehr/v2/departments/batch_get': { - POST: 'batchGetCorehrDepartment', - }, - '/corehr/v2/locations/batch_get': { - POST: 'batchGetCorehrLocation', - }, - '/corehr/v1/locations': { - POST: 'createCorehrLocation', - GET: 'listCorehrLocation', - }, - '/corehr/v1/locations/{location_id}': { - DELETE: 'deleteCorehrLocation', - GET: 'getCorehrLocation', - }, - '/corehr/v1/companies/{company_id}': { - GET: 'getCorehrCompany', - PATCH: 'patchCorehrCompany', - DELETE: 'deleteCorehrCompany', - }, - '/corehr/v1/companies': { - GET: 'listCorehrCompany', - POST: 'createCorehrCompany', - }, - '/corehr/v2/companies/batch_get': { - POST: 'batchGetCorehrCompany', - }, - '/corehr/v2/cost_centers': { - POST: 'createCorehrCostCenter', - }, - '/corehr/v2/cost_centers/{cost_center_id}': { - PATCH: 'patchCorehrCostCenter', - DELETE: 'deleteCorehrCostCenter', - }, - '/corehr/v2/cost_centers/search': { - POST: 'searchCorehrCostCenter', - }, - '/corehr/v2/cost_centers/{cost_center_id}/versions': { - POST: 'createCorehrCostCenterVersion', - }, - '/corehr/v2/cost_centers/{cost_center_id}/versions/{version_id}': { - PATCH: 'patchCorehrCostCenterVersion', - DELETE: 'deleteCorehrCostCenterVersion', - }, - '/corehr/v2/job_levels/batch_get': { - POST: 'batchGetCorehrJobLevel', - }, - '/corehr/v1/job_levels': { - POST: 'createCorehrJobLevel', - GET: 'listCorehrJobLevel', - }, - '/corehr/v1/job_levels/{job_level_id}': { - DELETE: 'deleteCorehrJobLevel', - PATCH: 'patchCorehrJobLevel', - GET: 'getCorehrJobLevel', - }, - '/corehr/v2/job_families/batch_get': { - POST: 'batchGetCorehrJobFamily', - }, - '/corehr/v1/job_families': { - POST: 'createCorehrJobFamily', - GET: 'listCorehrJobFamily', - }, - '/corehr/v1/job_families/{job_family_id}': { - DELETE: 'deleteCorehrJobFamily', - PATCH: 'patchCorehrJobFamily', - GET: 'getCorehrJobFamily', - }, - '/corehr/v1/jobs': { - POST: 'createCorehrJob', - GET: 'listCorehrJob', - }, - '/corehr/v1/jobs/{job_id}': { - DELETE: 'deleteCorehrJob', - PATCH: 'patchCorehrJob', - GET: 'getCorehrJob', - }, - '/corehr/v2/jobs/{job_id}': { - GET: 'getCorehrJob', - }, - '/corehr/v2/jobs': { - GET: 'listCorehrJob', - }, - '/corehr/v2/pre_hires': { - POST: 'createCorehrPreHire', - }, - '/corehr/v1/pre_hires/{pre_hire_id}': { - PATCH: 'patchCorehrPreHire', - DELETE: 'deleteCorehrPreHire', - GET: 'getCorehrPreHire', - }, - '/corehr/v1/pre_hires': { - GET: 'listCorehrPreHire', - }, - '/corehr/v2/contracts/search': { - POST: 'searchCorehrContract', - }, - '/corehr/v1/contracts': { - POST: 'createCorehrContract', - GET: 'listCorehrContract', - }, - '/corehr/v1/contracts/{contract_id}': { - DELETE: 'deleteCorehrContract', - PATCH: 'patchCorehrContract', - GET: 'getCorehrContract', - }, - '/corehr/v2/probation/search': { - POST: 'searchCorehrProbation', - }, - '/corehr/v2/probation/enable_disable_assessment': { - POST: 'enableDisableAssessmentCorehrProbation', - }, - '/corehr/v2/probation/assessments': { - POST: 'createCorehrProbationAssessment', - }, - '/corehr/v2/probation/assessments/{assessment_id}': { - PATCH: 'patchCorehrProbationAssessment', - DELETE: 'deleteCorehrProbationAssessment', - }, - '/corehr/v1/transfer_reasons/query': { - GET: 'queryCorehrTransferReason', - }, - '/corehr/v1/transfer_types/query': { - GET: 'queryCorehrTransferType', - }, - '/corehr/v1/job_changes': { - POST: 'createCorehrJobChange', - }, - '/corehr/v2/job_changes/search': { - POST: 'searchCorehrJobChange', - }, - '/corehr/v1/offboardings/query': { - POST: 'queryCorehrOffboarding', - }, - '/corehr/v1/offboardings/submit': { - POST: 'submitCorehrOffboarding', - }, - '/corehr/v1/offboardings/search': { - POST: 'searchCorehrOffboarding', - }, - '/corehr/v1/leave_granting_records': { - POST: 'createCorehrLeaveGrantingRecord', - }, - '/corehr/v1/leave_granting_records/{leave_granting_record_id}': { - DELETE: 'deleteCorehrLeaveGrantingRecord', - }, - '/corehr/v1/leaves/leave_types': { - GET: 'leaveTypesCorehrLeave', - }, - '/corehr/v1/leaves/leave_balances': { - GET: 'leaveBalancesCorehrLeave', - }, - '/corehr/v1/leaves/leave_request_history': { - GET: 'leaveRequestHistoryCorehrLeave', - }, - '/corehr/v2/employees/bps/batch_get': { - POST: 'batchGetCorehrEmployeesBp', - }, - '/corehr/v2/bps/get_by_department': { - POST: 'getByDepartmentCorehrBp', - }, - '/corehr/v2/bps': { - GET: 'listCorehrBp', - }, - '/corehr/v1/security_groups/query': { - POST: 'queryCorehrSecurityGroup', - }, - '/corehr/v1/assigned_users/search': { - POST: 'searchCorehrAssignedUser', - }, - '/corehr/v1/security_groups': { - GET: 'listCorehrSecurityGroup', - }, - '/corehr/v2/processes': { - GET: 'listCorehrProcess', - }, - '/corehr/v2/processes/{process_id}': { - GET: 'getCorehrProcess', - }, - '/corehr/v1/processes/{process_id}/form_variable_data': { - GET: 'getCorehrProcessFormVariableData', - }, - '/corehr/v1/compensation_standards/match': { - GET: 'matchCorehrCompensationStandard', - }, - '/hire/v1/jobs/combined_create': { - POST: 'combinedCreateHireJob', - }, - '/hire/v1/jobs/{job_id}': { - GET: 'getHireJob', - }, - '/hire/v1/jobs/{job_id}/config': { - GET: 'configHireJob', - }, - '/hire/v1/jobs': { - GET: 'listHireJob', - }, - '/hire/v1/jobs/{job_id}/combined_update': { - POST: 'combinedUpdateHireJob', - }, - '/hire/v1/jobs/{job_id}/update_config': { - POST: 'updateConfigHireJob', - }, - '/hire/v1/job_types': { - GET: 'listHireJobType', - }, - '/hire/v1/jobs/{job_id}/recruiter': { - GET: 'recruiterHireJob', - }, - '/hire/v1/job_requirements': { - POST: 'createHireJobRequirement', - GET: 'listHireJobRequirement', - }, - '/hire/v1/job_requirements/search': { - POST: 'listByIdHireJobRequirement', - }, - '/hire/v1/job_requirements/{job_requirement_id}': { - PUT: 'updateHireJobRequirement', - DELETE: 'deleteHireJobRequirement', - }, - '/hire/v1/job_requirement_schemas': { - GET: 'listHireJobRequirementSchema', - }, - '/hire/v1/job_processes': { - GET: 'listHireJobProcess', - }, - '/hire/v1/registration_schemas': { - GET: 'listHireRegistrationSchema', - }, - '/hire/v1/referral_websites/job_posts': { - GET: 'listHireReferralWebsiteJobPost', - }, - '/hire/v1/referral_websites/job_posts/{job_post_id}': { - GET: 'getHireReferralWebsiteJobPost', - }, - '/hire/v1/referrals/get_by_application': { - GET: 'getByApplicationHireReferral', - }, - '/hire/v1/external_applications': { - POST: 'createHireExternalApplication', - }, - '/hire/v1/external_applications/{external_application_id}': { - PUT: 'updateHireExternalApplication', - DELETE: 'deleteHireExternalApplication', - }, - '/hire/v1/external_interviews': { - POST: 'createHireExternalInterview', - }, - '/hire/v1/external_interview_assessments': { - POST: 'createHireExternalInterviewAssessment', - }, - '/hire/v1/external_background_checks': { - POST: 'createHireExternalBackgroundCheck', - }, - '/hire/v1/talents/add_to_folder': { - POST: 'addToFolderHireTalent', - }, - '/hire/v1/talent_folders': { - GET: 'listHireTalentFolder', - }, - '/hire/v1/talents/batch_get_id': { - POST: 'batchGetIdHireTalent', - }, - '/hire/v1/talents': { - GET: 'listHireTalent', - }, - '/hire/v1/talent_objects/query': { - GET: 'queryHireTalentObject', - }, - '/hire/v1/talents/{talent_id}': { - GET: 'getHireTalent', - }, - '/hire/v1/applications': { - POST: 'createHireApplication', - GET: 'listHireApplication', - }, - '/hire/v1/applications/{application_id}/terminate': { - POST: 'terminateHireApplication', - }, - '/hire/v1/applications/{application_id}': { - GET: 'getHireApplication', - }, - '/hire/v1/evaluations': { - GET: 'listHireEvaluation', - }, - '/hire/v1/questionnaires': { - GET: 'listHireQuestionnaire', - }, - '/hire/v1/interviews': { - GET: 'listHireInterview', - }, - '/hire/v1/offers': { - POST: 'createHireOffer', - GET: 'listHireOffer', - }, - '/hire/v1/offers/{offer_id}': { - PUT: 'updateHireOffer', - GET: 'getHireOffer', - }, - '/hire/v1/applications/{application_id}/offer': { - GET: 'offerHireApplication', - }, - '/hire/v1/offers/{offer_id}/offer_status': { - PATCH: 'offerStatusHireOffer', - }, - '/hire/v1/offers/{offer_id}/intern_offer_status': { - POST: 'internOfferStatusHireOffer', - }, - '/hire/v1/ehr_import_tasks/{ehr_import_task_id}': { - PATCH: 'patchHireEhrImportTask', - }, - '/hire/v1/applications/{application_id}/transfer_onboard': { - POST: 'transferOnboardHireApplication', - }, - '/hire/v1/employees/{employee_id}': { - PATCH: 'patchHireEmployee', - GET: 'getHireEmployee', - }, - '/hire/v1/employees/get_by_application': { - GET: 'getByApplicationHireEmployee', - }, - '/hire/v1/notes': { - POST: 'createHireNote', - GET: 'listHireNote', - }, - '/hire/v1/notes/{note_id}': { - PATCH: 'patchHireNote', - GET: 'getHireNote', - }, - '/hire/v1/resume_sources': { - GET: 'listHireResumeSource', - }, - '/hire/v1/eco_account_custom_fields': { - POST: 'createHireEcoAccountCustomField', - }, - '/hire/v1/eco_account_custom_fields/batch_update': { - PATCH: 'batchUpdateHireEcoAccountCustomField', - }, - '/hire/v1/eco_account_custom_fields/batch_delete': { - POST: 'batchDeleteHireEcoAccountCustomField', - }, - '/hire/v1/eco_background_check_custom_fields': { - POST: 'createHireEcoBackgroundCheckCustomField', - }, - '/hire/v1/eco_background_check_custom_fields/batch_update': { - PATCH: 'batchUpdateHireEcoBackgroundCheckCustomField', - }, - '/hire/v1/eco_background_check_custom_fields/batch_delete': { - POST: 'batchDeleteHireEcoBackgroundCheckCustomField', - }, - '/hire/v1/eco_background_check_packages': { - POST: 'createHireEcoBackgroundCheckPackage', - }, - '/hire/v1/eco_background_check_packages/batch_update': { - PATCH: 'batchUpdateHireEcoBackgroundCheckPackage', - }, - '/hire/v1/eco_background_check_packages/batch_delete': { - POST: 'batchDeleteHireEcoBackgroundCheckPackage', - }, - '/hire/v1/eco_background_checks/update_progress': { - POST: 'updateProgressHireEcoBackgroundCheck', - }, - '/hire/v1/eco_background_checks/update_result': { - POST: 'updateResultHireEcoBackgroundCheck', - }, - '/hire/v1/eco_background_checks/cancel': { - POST: 'cancelHireEcoBackgroundCheck', - }, - '/hire/v1/eco_exam_papers': { - POST: 'createHireEcoExamPaper', - }, - '/hire/v1/eco_exam_papers/batch_update': { - PATCH: 'batchUpdateHireEcoExamPaper', - }, - '/hire/v1/eco_exam_papers/batch_delete': { - POST: 'batchDeleteHireEcoExamPaper', - }, - '/hire/v1/eco_exams/{exam_id}/login_info': { - POST: 'loginInfoHireEcoExam', - }, - '/hire/v1/eco_exams/{exam_id}/update_result': { - POST: 'updateResultHireEcoExam', - }, - '/hire/v1/referral_account': { - POST: 'createHireReferralAccount', - }, - '/hire/v1/referral_account/{referral_account_id}/deactivate': { - POST: 'deactivateHireReferralAccount', - }, - '/hire/v1/referral_account/{referral_account_id}/withdraw': { - POST: 'withdrawHireReferralAccount', - }, - '/hire/v1/referral_account/reconciliation': { - POST: 'reconciliationHireReferralAccount', - }, - '/hire/v1/attachments/{attachment_id}': { - GET: 'getHireAttachment', - }, - '/hire/v1/attachments/{attachment_id}/preview': { - GET: 'previewHireAttachment', - }, - '/okr/v1/periods': { - POST: 'createOkrPeriod', - GET: 'listOkrPeriod', - }, - '/okr/v1/periods/{period_id}': { - PATCH: 'patchOkrPeriod', - }, - '/okr/v1/period_rules': { - GET: 'listOkrPeriodRule', - }, - '/okr/v1/users/{user_id}/okrs': { - GET: 'listOkrUserOkr', - }, - '/okr/v1/okrs/batch_get': { - GET: 'batchGetOkr', - }, - '/okr/v1/progress_records': { - POST: 'createOkrProgressRecord', - }, - '/okr/v1/progress_records/{progress_id}': { - DELETE: 'deleteOkrProgressRecord', - PUT: 'updateOkrProgressRecord', - GET: 'getOkrProgressRecord', - }, - '/human_authentication/v1/identities': { - POST: 'createHumanAuthenticationIdentity', - }, - '/acs/v1/visitors/{visitor_id}': { - DELETE: 'deleteAcsVisitor', - }, - '/acs/v1/visitors': { - POST: 'createAcsVisitor', - }, - '/acs/v1/rule_external/device_bind': { - POST: 'deviceBindAcsRuleExternal', - }, - '/acs/v1/rule_external': { - GET: 'getAcsRuleExternal', - DELETE: 'deleteAcsRuleExternal', - POST: 'createAcsRuleExternal', - }, - '/acs/v1/users/{user_id}': { - PATCH: 'patchAcsUser', - GET: 'getAcsUser', - }, - '/acs/v1/users': { - GET: 'listAcsUser', - }, - '/acs/v1/users/{user_id}/face': { - PUT: 'updateAcsUserFace', - GET: 'getAcsUserFace', - }, - '/acs/v1/devices': { - GET: 'listAcsDevice', - }, - '/acs/v1/access_records': { - GET: 'listAcsAccessRecord', - }, - '/performance/v1/semesters': { - GET: 'listPerformanceSemester', - }, - '/performance/v1/stage_tasks/find_by_user_list': { - POST: 'findByUserListPerformanceStageTask', - }, - '/performance/v1/stage_tasks/find_by_page': { - POST: 'findByPagePerformanceStageTask', - }, - '/performance/v1/review_datas/query': { - POST: 'queryPerformanceReviewData', - }, - '/lingo/v1/drafts': { - POST: 'createLingoDraft', - }, - '/lingo/v1/drafts/{draft_id}': { - PUT: 'updateLingoDraft', - }, - '/lingo/v1/entities': { - POST: 'createLingoEntity', - GET: 'listLingoEntity', - }, - '/lingo/v1/entities/{entity_id}': { - PUT: 'updateLingoEntity', - DELETE: 'deleteLingoEntity', - GET: 'getLingoEntity', - }, - '/lingo/v1/entities/match': { - POST: 'matchLingoEntity', - }, - '/lingo/v1/entities/search': { - POST: 'searchLingoEntity', - }, - '/lingo/v1/entities/highlight': { - POST: 'highlightLingoEntity', - }, - '/lingo/v1/classifications': { - GET: 'listLingoClassification', - }, - '/lingo/v1/repos': { - GET: 'listLingoRepo', - }, - '/security_and_compliance/v1/openapi_logs/list_data': { - POST: 'listDataSecurityAndComplianceOpenapiLog', - }, - '/admin/v1/audit_infos': { - GET: 'listAdminAuditInfo', - }, - '/minutes/v1/minutes/{minute_token}/statistics': { - GET: 'getMinutesMinuteStatistics', - }, - '/minutes/v1/minutes/{minute_token}': { - GET: 'getMinutesMinute', - }, - '/workplace/v1/workplace_access_data/search': { - POST: 'searchWorkplaceWorkplaceAccessData', - }, - '/workplace/v1/custom_workplace_access_data/search': { - POST: 'searchWorkplaceCustomWorkplaceAccessData', - }, - '/workplace/v1/workplace_block_access_data/search': { - POST: 'searchWorkplaceWorkplaceBlockAccessData', - }, - '/application/v5/applications/favourite': { - GET: 'favouriteApplication', - }, - '/application/v5/applications/recommend': { - GET: 'recommendApplication', - }, - '/application/v6/app_recommend_rules': { - GET: 'listApplicationAppRecommendRule', - }, - '/mdm/v1/user_auth_data_relations/bind': { - POST: 'bindMdmUserAuthDataRelation', - }, - '/mdm/v1/user_auth_data_relations/unbind': { - POST: 'unbindMdmUserAuthDataRelation', - }, - '/report/v1/rules/query': { - GET: 'queryReportRule', - }, - '/report/v1/rules/{rule_id}/views/remove': { - POST: 'removeReportRuleView', - }, - '/report/v1/tasks/query': { - POST: 'queryReportTask', - }, - '/authen/v1/access_token': { - POST: 'createAuthenAccessToken', - }, - '/authen/v1/refresh_access_token': { - POST: 'createAuthenRefreshAccessToken', - }, - '/baike/v1/drafts': { - POST: 'createBaikeDraft', - }, - '/baike/v1/drafts/{draft_id}': { - PUT: 'updateBaikeDraft', - }, - '/baike/v1/entities': { - POST: 'createBaikeEntity', - GET: 'listBaikeEntity', - }, - '/baike/v1/entities/{entity_id}': { - PUT: 'updateBaikeEntity', - GET: 'getBaikeEntity', - }, - '/baike/v1/entities/match': { - POST: 'matchBaikeEntity', - }, - '/baike/v1/entities/search': { - POST: 'searchBaikeEntity', - }, - '/baike/v1/entities/highlight': { - POST: 'highlightBaikeEntity', - }, - '/baike/v1/entities/extract': { - POST: 'extractBaikeEntity', - }, - '/baike/v1/classifications': { - GET: 'listBaikeClassification', - }, - '/hire/v1/applications/{application_id}/interviews': { - GET: 'listHireApplicationInterview', - }, - '/hire/v1/jobs/{job_id}/managers/{manager_id}': { - GET: 'getHireJobManager', - }, - '/hire/v1/offer_schemas/{offer_schema_id}': { - GET: 'getHireOfferSchema', - }, - '/corehr/v1/subregions': { - GET: 'listCorehrSubregion', - }, - '/corehr/v1/subregions/{subregion_id}': { - GET: 'getCorehrSubregion', - }, - '/corehr/v1/subdivisions': { - GET: 'listCorehrSubdivision', - }, - '/corehr/v1/subdivisions/{subdivision_id}': { - GET: 'getCorehrSubdivision', - }, - '/corehr/v1/country_regions': { - GET: 'listCorehrCountryRegion', - }, - '/corehr/v1/country_regions/{country_region_id}': { - GET: 'getCorehrCountryRegion', - }, - '/corehr/v1/currencies': { - GET: 'listCorehrCurrency', - }, - '/corehr/v1/currencies/{currency_id}': { - GET: 'getCorehrCurrency', - }, - '/vc/v1/room_configs/set_checkboard_access_code': { - POST: 'setCheckboardAccessCodeVcRoomConfig', - }, - '/vc/v1/room_configs/set_room_access_code': { - POST: 'setRoomAccessCodeVcRoomConfig', - }, - '/vc/v1/room_configs/query': { - GET: 'queryVcRoomConfig', - }, - '/vc/v1/room_configs/set': { - POST: 'setVcRoomConfig', - }, -}) - -Internal.define({ - '/im/v1/images': { - POST: 'createImImage', - }, - '/im/v1/files': { - POST: 'createImFile', - }, - '/drive/v1/medias/upload_all': { - POST: 'uploadAllDrivev1Media', - }, - '/drive/v1/medias/upload_part': { - POST: 'uploadPartDrivev1Media', - }, - '/drive/v1/files/upload_all': { - POST: 'uploadAllDrivev1File', - }, - '/drive/v1/files/upload_part': { - POST: 'uploadPartDrivev1File', - }, - '/attendance/v1/files/upload': { - POST: 'uploadAttendanceFile', - }, - '/task/v2/attachments/upload': { - POST: 'uploadTaskv2Attachment', - }, - '/document_ai/v1/resume/parse': { - POST: 'parseDocumentAiResume', - }, - '/document_ai/v1/vehicle_invoice/recognize': { - POST: 'recognizeDocumentAiVehicleInvoice', - }, - '/document_ai/v1/health_certificate/recognize': { - POST: 'recognizeDocumentAiHealthCertificate', - }, - '/document_ai/v1/hkm_mainland_travel_permit/recognize': { - POST: 'recognizeDocumentAiHkmMainlandTravelPermit', - }, - '/document_ai/v1/tw_mainland_travel_permit/recognize': { - POST: 'recognizeDocumentAiTwMainlandTravelPermit', - }, - '/document_ai/v1/chinese_passport/recognize': { - POST: 'recognizeDocumentAiChinesePassport', - }, - '/document_ai/v1/bank_card/recognize': { - POST: 'recognizeDocumentAiBankCard', - }, - '/document_ai/v1/vehicle_license/recognize': { - POST: 'recognizeDocumentAiVehicleLicense', - }, - '/document_ai/v1/train_invoice/recognize': { - POST: 'recognizeDocumentAiTrainInvoice', - }, - '/document_ai/v1/taxi_invoice/recognize': { - POST: 'recognizeDocumentAiTaxiInvoice', - }, - '/document_ai/v1/id_card/recognize': { - POST: 'recognizeDocumentAiIdCard', - }, - '/document_ai/v1/food_produce_license/recognize': { - POST: 'recognizeDocumentAiFoodProduceLicense', - }, - '/document_ai/v1/food_manage_license/recognize': { - POST: 'recognizeDocumentAiFoodManageLicense', - }, - '/document_ai/v1/driving_license/recognize': { - POST: 'recognizeDocumentAiDrivingLicense', - }, - '/document_ai/v1/vat_invoice/recognize': { - POST: 'recognizeDocumentAiVatInvoice', - }, - '/document_ai/v1/business_license/recognize': { - POST: 'recognizeDocumentAiBusinessLicense', - }, - '/document_ai/v1/contract/field_extraction': { - POST: 'fieldExtractionDocumentAiContract', - }, - '/document_ai/v1/business_card/recognize': { - POST: 'recognizeDocumentAiBusinessCard', - }, - '/admin/v1/badge_images': { - POST: 'createAdminBadgeImage', - }, - '/corehr/v1/persons/upload': { - POST: 'uploadCorehrPerson', - }, - '/okr/v1/images/upload': { - POST: 'uploadOkrImage', - }, - '/lingo/v1/files/upload': { - POST: 'uploadLingoFile', - }, - '/baike/v1/files/upload': { - POST: 'uploadBaikeFile', - }, -}, { multipart: true }) diff --git a/adapters/lark/src/types/application.ts b/adapters/lark/src/types/application.ts new file mode 100644 index 00000000..c58ec0c8 --- /dev/null +++ b/adapters/lark/src/types/application.ts @@ -0,0 +1,597 @@ +import { Internal } from '../internal' +import { AppContactsRangeIdList, AppRecommendRule, AppVisibilityIdList, Application, ApplicationAppContactsRange, ApplicationAppUsage, ApplicationAppVersion, ApplicationDepartmentAppUsage, ApplicationFeedback, ApplicationVisibilityDepartmentWhiteBlackInfo, ApplicationVisibilityGroupWhiteBlackInfo, ApplicationVisibilityUserWhiteBlackInfo, ClientBadgeNum, Scope } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取应用信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/get + */ + getApplication(app_id: string, query?: GetApplicationQuery): Promise + /** + * 获取应用版本信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/get + */ + getApplicationApplicationAppVersion(app_id: string, version_id: string, query?: GetApplicationApplicationAppVersionQuery): Promise + /** + * 获取应用版本列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list + */ + listApplicationApplicationAppVersion(app_id: string, query?: ListApplicationApplicationAppVersionQuery): Promise + /** + * 获取应用版本中开发者申请的通讯录权限范围 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/contacts_range_suggest + */ + contactsRangeSuggestApplicationApplicationAppVersion(app_id: string, version_id: string, query?: ContactsRangeSuggestApplicationApplicationAppVersionQuery): Promise + /** + * 向管理员申请授权 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/scope/apply + */ + applyApplicationScope(): Promise + /** + * 查询租户授权状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/scope/list + */ + listApplicationScope(): Promise + /** + * 获取企业安装的应用 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/list + */ + listApplication(query?: ListApplicationQuery): Promise + /** + * 查看待审核的应用列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist + */ + underauditlistApplication(query?: UnderauditlistApplicationQuery): Promise + /** + * 更新应用审核状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/patch + */ + patchApplicationApplicationAppVersion(app_id: string, version_id: string, body: PatchApplicationApplicationAppVersionRequest, query?: PatchApplicationApplicationAppVersionQuery): Promise + /** + * 更新应用分组信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/patch + */ + patchApplication(app_id: string, body: PatchApplicationRequest, query?: PatchApplicationQuery): Promise + /** + * 获取应用通讯录权限范围配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration + */ + contactsRangeConfigurationApplication(app_id: string, query?: ContactsRangeConfigurationApplicationQuery): Promise + /** + * 更新应用通讯录权限范围配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-contacts_range/patch + */ + patchApplicationApplicationContactsRange(app_id: string, body: PatchApplicationApplicationContactsRangeRequest, query?: PatchApplicationApplicationContactsRangeQuery): Promise + /** + * 查询用户或部门是否在应用的可用或禁用名单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/check_white_black_list + */ + checkWhiteBlackListApplicationApplicationVisibility(app_id: string, body: CheckWhiteBlackListApplicationApplicationVisibilityRequest, query?: CheckWhiteBlackListApplicationApplicationVisibilityQuery): Promise + /** + * 更新应用可用范围 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/patch + */ + patchApplicationApplicationVisibility(app_id: string, body: PatchApplicationApplicationVisibilityRequest, query?: PatchApplicationApplicationVisibilityQuery): Promise + /** + * 启停用应用 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-management/update + */ + updateApplicationApplicationManagement(app_id: string, body: UpdateApplicationApplicationManagementRequest): Promise + /** + * 获取多部门应用使用概览 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/department_overview + */ + departmentOverviewApplicationApplicationAppUsage(app_id: string, body: DepartmentOverviewApplicationApplicationAppUsageRequest, query?: DepartmentOverviewApplicationApplicationAppUsageQuery): Promise + /** + * 获取消息推送概览 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/message_push_overview + */ + messagePushOverviewApplicationApplicationAppUsage(app_id: string, body: MessagePushOverviewApplicationApplicationAppUsageRequest, query?: MessagePushOverviewApplicationApplicationAppUsageQuery): Promise + /** + * 获取应用使用概览 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/overview + */ + overviewApplicationApplicationAppUsage(app_id: string, body: OverviewApplicationApplicationAppUsageRequest, query?: OverviewApplicationApplicationAppUsageQuery): Promise + /** + * 更新应用反馈 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/patch + */ + patchApplicationApplicationFeedback(app_id: string, feedback_id: string, query?: PatchApplicationApplicationFeedbackQuery): Promise + /** + * 获取应用反馈列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/list + */ + listApplicationApplicationFeedback(app_id: string, query?: ListApplicationApplicationFeedbackQuery): Promise + /** + * 更新应用红点 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_badge/set + */ + setApplicationAppBadge(body: SetApplicationAppBadgeRequest, query?: SetApplicationAppBadgeQuery): Promise + /** + * 获取用户自定义常用的应用 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/favourite + */ + favouriteApplication(query?: FavouriteApplicationQuery): Promise + /** + * 获取管理员推荐的应用 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/recommend + */ + recommendApplication(query?: RecommendApplicationQuery): Promise + /** + * 获取当前设置的推荐规则列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list + */ + listApplicationAppRecommendRule(query?: ListApplicationAppRecommendRuleQuery): Promise + } +} + +export interface GetApplicationQuery { + /** 指定获取应用在该语言下的信息 */ + lang: 'zh_cn' | 'en_us' | 'ja_jp' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetApplicationApplicationAppVersionQuery { + /** 应用信息的语言版本 */ + lang: 'zh_cn' | 'en_us' | 'ja_jp' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListApplicationApplicationAppVersionQuery { + /** 应用信息的语言版本 */ + lang: 'zh_cn' | 'en_us' | 'ja_jp' + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 0：按照时间倒序 1：按照时间正序 */ + order?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ContactsRangeSuggestApplicationApplicationAppVersionQuery { + /** 返回值的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListApplicationQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: string + /** 应用的图标、描述、帮助文档链接是按照应用的主语言返回；其他内容（如应用权限、应用分类）按照该参数设定返回对应的语言。可选值有： zh_cn：中文 en_us：英文 ja_jp：日文 如不填写，则按照应用的主语言返回 */ + lang: string + /** 不传入代表全部返回。传入则按照这种应用状态返回。应用状态可选值有：0：停用状态1：启用状态 2：未启用状态 */ + status?: 0 | 1 | 2 + /** 不传入代表全部返回。传入则按照这种应用状态返回。 付费类型 可选值： 0：免费 1：付费 */ + payment_type?: 0 | 1 + /** 不传入代表全部返回。传入则按照这种应用状态返回。所有者类型，可选值： 0：飞书科技 1：飞书合作伙伴 2：企业内成员 */ + owner_type?: 0 | 1 | 2 +} + +export interface UnderauditlistApplicationQuery { + /** 指定返回的语言 */ + lang: 'zh_cn' | 'en_us' | 'ja_jp' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchApplicationApplicationAppVersionRequest { + /** 版本状态 */ + status?: 0 | 1 | 2 | 3 | 4 +} + +export interface PatchApplicationApplicationAppVersionQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type: 'user_id' | 'union_id' | 'open_id' + /** 操作者的 open_id */ + operator_id: string + /** 当修改版本状态为被驳回时，这一项必填 */ + reject_reason?: string +} + +export interface PatchApplicationRequest { + /** 应用分类的国际化描述 */ + common_categories?: string[] +} + +export interface PatchApplicationQuery { + /** 指定返回的语言 */ + lang: 'zh_cn' | 'en_us' | 'ja_jp' +} + +export interface ContactsRangeConfigurationApplicationQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 返回值的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchApplicationApplicationContactsRangeRequest { + /** 更新范围方式 */ + contacts_range_type: 'equal_to_availability' | 'some' | 'all' + /** 可见范围新增列表 */ + add_visible_list?: AppContactsRangeIdList + /** 删除可用名单 */ + del_visible_list?: AppContactsRangeIdList +} + +export interface PatchApplicationApplicationContactsRangeQuery { + /** 成员id类型 */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' + /** 部门id 类型 */ + department_id_type?: 'open_department_id' | 'department_id' +} + +export interface CheckWhiteBlackListApplicationApplicationVisibilityRequest { + /** 用户ID列表 */ + user_ids?: string[] + /** 部门ID列表 */ + department_ids?: string[] + /** 用户组ID列表 */ + group_ids?: string[] +} + +export interface CheckWhiteBlackListApplicationApplicationVisibilityQuery { + /** 此次请求传参中的user_id的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次请求传参中的department_id的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface PatchApplicationApplicationVisibilityRequest { + /** 添加可用人员名单 */ + add_visible_list?: AppVisibilityIdList + /** 删除可用人员名单 */ + del_visible_list?: AppVisibilityIdList + /** 添加禁用人员名单 */ + add_invisible_list?: AppVisibilityIdList + /** 删除禁用人员名单 */ + del_invisible_list?: AppVisibilityIdList + /** 是否全员可见,false:否;true:是;不填:继续当前状态不改变.如果可见范围为全员后添加的可用人员则无效,禁用人员仍然有效 */ + is_visible_to_all?: boolean +} + +export interface PatchApplicationApplicationVisibilityQuery { + /** 部门id 类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** open_id 类型 */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' +} + +export interface UpdateApplicationApplicationManagementRequest { + /** 启用/停用应用 */ + enable?: boolean +} + +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 + /** 查询的部门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。 */ + recursion?: number + /** 分页大小，取值范围 1~20 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据。 */ + page_token?: string +} + +export interface DepartmentOverviewApplicationApplicationAppUsageQuery { + /** 调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface MessagePushOverviewApplicationApplicationAppUsageRequest { + /** 查询日期，若cycle_type为week，则输入的date必须为周一； 若cycle_type为month，则输入的date必须为每月1号 */ + date: string + /** 枚举值：day，week，month；week指自然周，返回当前日期所在周的数据；不满一周则从周一到当前日期算。month指自然月，返回当前日期所在月的数据。 */ + cycle_type: 1 | 2 | 3 + /** 需要查询的部门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 +} + +export interface MessagePushOverviewApplicationApplicationAppUsageQuery { + /** 调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +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 + /** 查询的部门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 + /** 能力类型，按能力类型进行筛选，返回对应能力的活跃数据 */ + ability: 'app' | 'mp' | 'h5' | 'bot' +} + +export interface OverviewApplicationApplicationAppUsageQuery { + /** 调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface PatchApplicationApplicationFeedbackQuery { + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 反馈处理状态 */ + status: 0 | 1 | 2 | 3 + /** 反馈处理人员id，租户内用户的唯一标识， ID值与查询参数中的user_id_type 对应 */ + operator_id: string +} + +export interface ListApplicationApplicationFeedbackQuery { + /** 查询的起始日期，格式为yyyy-mm-dd。不填则默认为当前日期减去180天。 */ + from_date?: string + /** 查询的结束日期，格式为yyyy-mm-dd。不填默认为当前日期。只能查询 180 天内的数据。 */ + to_date?: string + /** 反馈类型，不填写则表示查询所有反馈类型。 */ + feedback_type?: 1 | 2 + /** 反馈处理状态，不填写则表示查询所有处理类型。 */ + status?: 0 | 1 | 2 | 3 + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 分页拉取反馈列表起始位置标示，不填表示从头开始 */ + page_token?: string + /** 本次拉取反馈列表最大个数 */ + page_size?: number +} + +export interface SetApplicationAppBadgeRequest { + /** 用户ID */ + user_id: string + /** badge数据版本号 */ + version: string + /** badge extra 信息 */ + extra?: string + /** pc端badge数量 */ + pc?: ClientBadgeNum + /** 移动端badge数量 */ + mobile?: ClientBadgeNum +} + +export interface SetApplicationAppBadgeQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface FavouriteApplicationQuery { + /** 应用信息的语言版本 */ + language?: 'zh_cn' | 'en_us' | 'ja_jp' + /** 分页标记,不填表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 单页需求最大个数（最大 100），不传默认10个 */ + page_size?: number +} + +export interface RecommendApplicationQuery { + /** 应用信息的语言版本 */ + language?: 'zh_cn' | 'en_us' | 'ja_jp' + /** 推荐应用类型，默认为用户不可移除的推荐应用列表 */ + recommend_type?: 'user_unremovable' | 'user_removable' + /** 分页标记,不填表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 单页需求最大个数（最大 100），不传默认10个 */ + page_size?: number +} + +export interface ListApplicationAppRecommendRuleQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetApplicationResponse { + /** 应用数据 */ + app?: Application +} + +export interface GetApplicationApplicationAppVersionResponse { + app_version?: ApplicationAppVersion +} + +export interface ListApplicationApplicationAppVersionResponse { + /** 应用版本列表 */ + items?: ApplicationAppVersion[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface ContactsRangeSuggestApplicationApplicationAppVersionResponse { + contacts_range?: ApplicationAppContactsRange +} + +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 UnderauditlistApplicationResponse { + /** 待审核应用列表 */ + items: Application[] + /** 是否有下一页数据 */ + has_more: boolean + /** 下一页分页的token */ + page_token?: string +} + +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 DepartmentOverviewApplicationApplicationAppUsageResponse { + /** 分页查询时返回，代表是否还有更多数据 */ + has_more?: boolean + /** 分页标记，下一页分页的token */ + page_token?: string + /** 部门内员工使用应用的概览数据 */ + items?: ApplicationDepartmentAppUsage[] +} + +export interface MessagePushOverviewApplicationApplicationAppUsageResponse { + /** 消息推送情况 */ + items?: ApplicationAppUsage[] +} + +export interface OverviewApplicationApplicationAppUsageResponse { + /** 员工使用应用概览数据 */ + items?: ApplicationAppUsage[] +} + +export interface ListApplicationApplicationFeedbackResponse { + /** 应用的反馈列表 */ + feedback_list?: ApplicationFeedback[] + /** 是否还有更多用户反馈列表，true：是，false：否 */ + has_more: boolean + /** 拉取下一页应用反馈列表时使用的 page_token */ + page_token?: string +} + +export interface FavouriteApplicationResponse { + /** 分页的token */ + page_token?: string + /** 总的数量 */ + total_count?: number + /** 是否有更多数据 */ + has_more?: boolean + /** 应用数据列表 */ + app_list?: Application[] +} + +export interface RecommendApplicationResponse { + /** 分页的token */ + page_token?: string + /** 分页数量 */ + page_size?: number + /** 总的数量 */ + total_count?: number + /** 是否有更多数据 */ + has_more?: boolean + /** 应用数据列表 */ + app_list?: Application[] +} + +export interface ListApplicationAppRecommendRuleResponse { + /** 推荐规则列表 */ + rules?: AppRecommendRule[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +Internal.define({ + '/open-apis/application/v6/applications/{app_id}': { + GET: 'getApplication', + PATCH: 'patchApplication', + }, + '/open-apis/application/v6/applications/{app_id}/app_versions/{version_id}': { + GET: 'getApplicationApplicationAppVersion', + PATCH: 'patchApplicationApplicationAppVersion', + }, + '/open-apis/application/v6/applications/{app_id}/app_versions': { + GET: 'listApplicationApplicationAppVersion', + }, + '/open-apis/application/v6/applications/{app_id}/app_versions/{version_id}/contacts_range_suggest': { + GET: 'contactsRangeSuggestApplicationApplicationAppVersion', + }, + '/open-apis/application/v6/scopes/apply': { + POST: 'applyApplicationScope', + }, + '/open-apis/application/v6/scopes': { + GET: 'listApplicationScope', + }, + '/open-apis/application/v6/applications': { + GET: 'listApplication', + }, + '/open-apis/application/v6/applications/underauditlist': { + GET: 'underauditlistApplication', + }, + '/open-apis/application/v6/applications/{app_id}/contacts_range_configuration': { + GET: 'contactsRangeConfigurationApplication', + }, + '/open-apis/application/v6/applications/{app_id}/contacts_range': { + PATCH: 'patchApplicationApplicationContactsRange', + }, + '/open-apis/application/v6/applications/{app_id}/visibility/check_white_black_list': { + POST: 'checkWhiteBlackListApplicationApplicationVisibility', + }, + '/open-apis/application/v6/applications/{app_id}/visibility': { + PATCH: 'patchApplicationApplicationVisibility', + }, + '/open-apis/application/v6/applications/{app_id}/management': { + PUT: 'updateApplicationApplicationManagement', + }, + '/open-apis/application/v6/applications/{app_id}/app_usage/department_overview': { + POST: 'departmentOverviewApplicationApplicationAppUsage', + }, + '/open-apis/application/v6/applications/{app_id}/app_usage/message_push_overview': { + POST: 'messagePushOverviewApplicationApplicationAppUsage', + }, + '/open-apis/application/v6/applications/{app_id}/app_usage/overview': { + POST: 'overviewApplicationApplicationAppUsage', + }, + '/open-apis/application/v6/applications/{app_id}/feedbacks/{feedback_id}': { + PATCH: 'patchApplicationApplicationFeedback', + }, + '/open-apis/application/v6/applications/{app_id}/feedbacks': { + GET: 'listApplicationApplicationFeedback', + }, + '/open-apis/application/v6/app_badge/set': { + POST: 'setApplicationAppBadge', + }, + '/open-apis/application/v5/applications/favourite': { + GET: 'favouriteApplication', + }, + '/open-apis/application/v5/applications/recommend': { + GET: 'recommendApplication', + }, + '/open-apis/application/v6/app_recommend_rules': { + GET: 'listApplicationAppRecommendRule', + }, +}) diff --git a/adapters/lark/src/types/approval.ts b/adapters/lark/src/types/approval.ts new file mode 100644 index 00000000..96c267a5 --- /dev/null +++ b/adapters/lark/src/types/approval.ts @@ -0,0 +1,973 @@ +import { Internal } from '../internal' +import { ApprovalConfig, ApprovalCreateExternal, ApprovalCreateViewers, ApprovalForm, ApprovalNode, ApprovalNodeInfo, ApprovalSetting, ApprovalViewerInfo, CcNode, CcSearchItem, Comment, CommentAtInfo, Count, ExteranlInstanceCheck, ExteranlInstanceCheckResponse, ExternalInstance, ExternalInstanceForm, ExternalInstanceLink, ExternalInstanceTaskNode, ExternalTaskList, I18nResource, InstanceComment, InstanceSearchItem, InstanceTask, InstanceTimeline, NodeApprover, NodeAutoApproval, NodeCc, PreviewNode, Task, TaskSearchItem, TrusteeshipInstanceCacheConfig, TrusteeshipUrls } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建审批定义 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create + */ + createApproval(body: CreateApprovalRequest, query?: CreateApprovalQuery): Promise + /** + * 查看指定审批定义 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get + */ + getApproval(approval_code: string, query?: GetApprovalQuery): Promise + /** + * 创建审批实例 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/create + */ + createApprovalInstance(body: CreateApprovalInstanceRequest): Promise + /** + * 撤回审批实例 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cancel + */ + cancelApprovalInstance(body: CancelApprovalInstanceRequest, query?: CancelApprovalInstanceQuery): Promise + /** + * 抄送审批实例 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cc + */ + ccApprovalInstance(body: CcApprovalInstanceRequest, query?: CcApprovalInstanceQuery): Promise + /** + * 预览审批流程 + * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview + */ + previewApprovalInstance(body: PreviewApprovalInstanceRequest, query?: PreviewApprovalInstanceQuery): Promise + /** + * 获取单个审批实例详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get + */ + getApprovalInstance(instance_id: string, query?: GetApprovalInstanceQuery): Promise + /** + * 批量获取审批实例 ID + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list + */ + listApprovalInstance(query?: ListApprovalInstanceQuery): Promise + /** + * 同意审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve + */ + approveApprovalTask(body: ApproveApprovalTaskRequest, query?: ApproveApprovalTaskQuery): Promise + /** + * 拒绝审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/reject + */ + rejectApprovalTask(body: RejectApprovalTaskRequest, query?: RejectApprovalTaskQuery): Promise + /** + * 转交审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/transfer + */ + transferApprovalTask(body: TransferApprovalTaskRequest, query?: TransferApprovalTaskQuery): Promise + /** + * 退回审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback + */ + specifiedRollbackApprovalInstance(body: SpecifiedRollbackApprovalInstanceRequest, query?: SpecifiedRollbackApprovalInstanceQuery): Promise + /** + * 审批任务加签 + * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign + */ + addSignApprovalInstance(body: AddSignApprovalInstanceRequest): Promise + /** + * 重新提交审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/resubmit + */ + resubmitApprovalTask(body: ResubmitApprovalTaskRequest, query?: ResubmitApprovalTaskQuery): Promise + /** + * 创建评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/create + */ + createApprovalInstanceComment(instance_id: string, body: CreateApprovalInstanceCommentRequest, query?: CreateApprovalInstanceCommentQuery): Promise + /** + * 删除评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/delete + */ + deleteApprovalInstanceComment(instance_id: string, comment_id: string, query?: DeleteApprovalInstanceCommentQuery): Promise + /** + * 清空评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/remove + */ + removeApprovalInstanceComment(instance_id: string, query?: RemoveApprovalInstanceCommentQuery): Promise + /** + * 获取评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list + */ + listApprovalInstanceComment(instance_id: string, query?: ListApprovalInstanceCommentQuery): Promise + /** + * 创建三方审批定义 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create + */ + createApprovalExternalApproval(body: CreateApprovalExternalApprovalRequest, query?: CreateApprovalExternalApprovalQuery): Promise + /** + * 查看指定三方审批定义 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/get + */ + getApprovalExternalApproval(approval_code: string, query?: GetApprovalExternalApprovalQuery): Promise + /** + * 同步三方审批实例 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create + */ + createApprovalExternalInstance(body: CreateApprovalExternalInstanceRequest): Promise + /** + * 校验三方审批实例 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/check + */ + checkApprovalExternalInstance(body: CheckApprovalExternalInstanceRequest): Promise + /** + * 获取三方审批任务状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list + */ + listApprovalExternalTask(body: ListApprovalExternalTaskRequest, query?: ListApprovalExternalTaskQuery): Promise + /** + * 查询实例列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query + */ + queryApprovalInstance(body: QueryApprovalInstanceRequest, query?: QueryApprovalInstanceQuery): Promise + /** + * 查询抄送列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc + */ + searchCcApprovalInstance(body: SearchCcApprovalInstanceRequest, query?: SearchCcApprovalInstanceQuery): Promise + /** + * 查询任务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search + */ + searchApprovalTask(body: SearchApprovalTaskRequest, query?: SearchApprovalTaskQuery): Promise + /** + * 查询用户的任务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query + */ + queryApprovalTask(query?: QueryApprovalTaskQuery): Promise + /** + * 订阅审批事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe + */ + subscribeApproval(approval_code: string): Promise + /** + * 取消订阅审批事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/unsubscribe + */ + unsubscribeApproval(approval_code: string): Promise + } +} + +export interface CreateApprovalRequest { + /** 审批名称的国际化文案 Key，以 @i18n@ 开头，长度不得少于 9 个字符 */ + approval_name: string + /** 传空表示新建 */ + approval_code?: string + /** 审批描述的国际化文案 Key，以 @i18n@ 开头，长度不得少于 9 个字符 */ + description?: string + /** viewers 字段指定了哪些人能从审批应用的前台发起该审批。 当 view_type 为 USER，需要填写viewer_user_id； 当 view_type 为DEPARTMENT，需要填写viewer_department_id； 当 view_type 为TENANT或NONE时，viewer_user_id和viewer_department_id无需填写 */ + viewers: ApprovalCreateViewers[] + /** 审批定义表单内容，json 数组 */ + form: ApprovalForm + /** 审批定义节点，需要将开始节点作为 list 第一个元素，结束节点作为最后一个元素 */ + node_list: ApprovalNode[] + /** 审批定义其他设置 */ + settings?: ApprovalSetting + /** 审批定义配置项，用于配置对应审批定义是否可以由用户在审批后台进行修改 */ + config?: ApprovalConfig + /** 审批图标枚举，详见下方说明，默认为 0 */ + icon?: number + /** 国际化文案 */ + i18n_resources: I18nResource[] + /** 流程负责人 */ + process_manager_ids?: string[] +} + +export interface CreateApprovalQuery { + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetApprovalQuery { + /** 语言可选值 */ + locale?: 'zh-CN' | 'en-US' | 'ja-JP' + /** 可选是否返回有数据权限审批流程管理员ID列表 */ + with_admin_id?: boolean + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateApprovalInstanceRequest { + /** 审批定义 code */ + approval_code: string + /** 发起审批用户 */ + user_id?: string + /** 发起审批用户 open id, 如果传了 user_id 则优先使用 user_id */ + open_id?: string + /** 发起审批用户部门id，如果用户只属于一个部门，可以不填。如果属于多个部门，默认会选择部门列表第一个部门 */ + department_id?: string + /** json 数组，控件值 */ + form: string + /** 如果有发起人自选节点，则需要填写对应节点的审批人 */ + node_approver_user_id_list?: NodeApprover[] + /** 审批人发起人自选 open id，与上述node_approver_user_id_list字段取并集 */ + node_approver_open_id_list?: NodeApprover[] + /** 如果有发起人自选节点，则可填写对应节点的抄送人，单个节点最多选择20位抄送人 */ + node_cc_user_id_list?: NodeCc[] + /** 抄送人发起人自选 open id 单个节点最多选择20位抄送人 */ + node_cc_open_id_list?: NodeCc[] + /** 审批实例 uuid，用于幂等操作, 每个租户下面的唯一key，同一个 uuid 只能用于创建一个审批实例，如果冲突，返回错误码 60012 ，格式建议为 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX，不区分大小写 */ + uuid?: string + /** 可配置是否可以再次提交 */ + allow_resubmit?: boolean + /** 可配置是否可以重新提交 */ + allow_submit_again?: boolean + /** 配置bot是否取消通知结果 */ + cancel_bot_notification?: string + /** 配置是否可以禁止撤销 */ + forbid_revoke?: boolean + /** 国际化文案 */ + i18n_resources?: I18nResource[] + /** 审批展示名称，如果填写了该字段，则审批列表中的审批名称使用该字段，如果不填该字段，则审批名称使用审批定义的名称 */ + title?: string + /** 详情页title展示模式 */ + title_display_method?: 0 | 1 + /** 自动通过节点ID */ + node_auto_approval_list?: NodeAutoApproval[] +} + +export interface CancelApprovalInstanceRequest { + /** 审批定义Code */ + approval_code: string + /** 审批实例Code */ + instance_code: string + /** 操作用户, 根据user_id_type填写 */ + user_id: string +} + +export interface CancelApprovalInstanceQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CcApprovalInstanceRequest { + /** 审批定义 code */ + approval_code: string + /** 审批实例 code */ + instance_code: string + /** 根据user_id_type填写发起抄送的人的用户id */ + user_id: string + /** 根据user_id_type填写被抄送人的 用户id 列表 */ + cc_user_ids: string[] + /** 抄送留言 */ + comment?: string +} + +export interface CcApprovalInstanceQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PreviewApprovalInstanceRequest { + /** 用户id */ + user_id: string + /** 审批定义code */ + approval_code?: string + /** 部门id */ + department_id?: string + /** 表单数据 */ + form?: string + /** 审批实例code */ + instance_code?: string + /** 语言类型 */ + locale?: string + /** 任务id */ + task_id?: string +} + +export interface PreviewApprovalInstanceQuery { + /** open_id(ou_开头)，union_id(on_开头)，user_id(字符串)。user_id_type不填默认为open_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' +} + +export interface GetApprovalInstanceQuery { + /** 语言 */ + locale?: 'zh-CN' | 'en-US' | 'ja-JP' + /** 发起审批用户id，仅自建应用可返回 */ + user_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'open_id' | 'union_id' +} + +export interface ListApprovalInstanceQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 审批定义唯一标识 */ + approval_code: string + /** 审批实例创建时间区间（毫秒） */ + start_time: string + /** 审批实例创建时间区间（毫秒） */ + end_time: string +} + +export interface ApproveApprovalTaskRequest { + /** 审批定义 Code */ + approval_code: string + /** 审批实例 Code */ + instance_code: string + /** 根据user_id_type填写操作用户id */ + user_id: string + /** 意见 */ + comment?: string + /** 任务 ID， 审批实例详情task_list中id */ + task_id: string + /** json 数组，控件值 */ + form?: string +} + +export interface ApproveApprovalTaskQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface RejectApprovalTaskRequest { + /** 审批定义 Code */ + approval_code: string + /** 审批实例 Code */ + instance_code: string + /** 根据user_id_type填写操作用户id */ + user_id: string + /** 意见 */ + comment?: string + /** 任务 ID， 审批实例详情task_list中id */ + task_id: string + /** json 数组，控件值 */ + form?: string +} + +export interface RejectApprovalTaskQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface TransferApprovalTaskRequest { + /** 审批定义 Code */ + approval_code: string + /** 审批实例 Code */ + instance_code: string + /** 根据user_id_type填写操作用户id */ + user_id: string + /** 意见 */ + comment?: string + /** 根据user_id_type填写被转交人唯一 ID */ + transfer_user_id: string + /** 任务 ID， 审批实例详情task_list中id */ + task_id: string +} + +export interface TransferApprovalTaskQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SpecifiedRollbackApprovalInstanceRequest { + /** 用户ID */ + user_id: string + /** 回退的任务ID */ + task_id: string + /** 退回原因 */ + reason?: string + /** 扩展字段 */ + extra?: string + /** 退回到节点列表 */ + task_def_key_list: string[] +} + +export interface SpecifiedRollbackApprovalInstanceQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface AddSignApprovalInstanceRequest { + /** 操作用户id */ + user_id: string + /** 审批定义code */ + approval_code: string + /** 审批实例code */ + instance_code: string + /** 任务id */ + task_id: string + /** 意见 */ + comment?: string + /** 被加签人id */ + add_sign_user_ids: string[] + /** 1/2/3分别代表前加签/后加签/并加签 */ + add_sign_type: 1 | 2 | 3 + /** 仅在前加签、后加签时需要填写，1/2 分别代表或签/会签 */ + approval_method?: 1 | 2 | 3 +} + +export interface ResubmitApprovalTaskRequest { + /** 审批定义 Code */ + approval_code: string + /** 审批实例 Code */ + instance_code: string + /** 根据user_id_type填写操作用户id */ + user_id: string + /** 意见 */ + comment?: string + /** 任务 ID， 审批实例详情task_list中id */ + task_id: string + /** json 数组，控件值 */ + form: string +} + +export interface ResubmitApprovalTaskQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateApprovalInstanceCommentRequest { + /** 评论内容，包含艾特人、附件等 */ + content?: string + /** 评论中艾特人信息 */ + at_info_list?: CommentAtInfo[] + /** 父评论ID，如果是回复评论，需要传 */ + parent_comment_id?: string + /** 评论ID，如果是编辑、删除一条评论，需要传 */ + comment_id?: string + /** disable_bot=true只同步数据，不触发bot */ + disable_bot?: boolean + /** 附加字段 */ + extra?: string +} + +export interface CreateApprovalInstanceCommentQuery { + /** 用户ID类型，不填默认为open_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' + /** 用户ID */ + user_id: string +} + +export interface DeleteApprovalInstanceCommentQuery { + /** 用户ID类型，不填默认为open_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' + /** 根据user_id_type填写用户ID */ + user_id: string +} + +export interface RemoveApprovalInstanceCommentQuery { + /** 用户ID类型，不填默认为open_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' + /** 根据user_id_type填写用户ID */ + user_id?: string +} + +export interface ListApprovalInstanceCommentQuery { + /** 用户ID类型，不填默认为open_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' + /** 用户ID */ + user_id: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateApprovalExternalApprovalRequest { + /** 审批定义名称，创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段。 */ + approval_name: string + /** 审批定义 code，用户自定义，定义的唯一标识，如果不存在该 code，则创建，否则更新 */ + approval_code: string + /** 审批定义所属审批分组，用户自定义； 如果group_code当前不存在，则会新建审批分组； 如果group_code已经存在，则会使用group_name更新审批分组名称 */ + group_code: string + /** 分组名称，值的格式是 i18n key，文案放在 i18n_resource； 如果是 group_code 当前不存在，则该 group_name 必填，否则，如果填写了则会更新分组名称，不填则不更新分组名称； 审批发起页 审批定义的分组名称来自该字段 */ + group_name?: string + /** 审批定义的说明，值的格式是 i18n key，文案放在 i18n_resource； 审批发起页 审批定义的说明内容来自该字段 */ + description?: string + /** 三方审批相关 */ + external: ApprovalCreateExternal + /** 可见人列表，可通知配置多个可见人，只有在配置的范围内用户可以在审批发起也看到该审批，默认不传，则是任何人不可见 */ + viewers?: ApprovalCreateViewers[] + /** 国际化文案 */ + i18n_resources?: I18nResource[] + /** 根据user_id_type填写流程管理员id */ + managers?: string[] +} + +export interface CreateApprovalExternalApprovalQuery { + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetApprovalExternalApprovalQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateApprovalExternalInstanceRequest { + /** 审批定义 code， 创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段 */ + approval_code: string + /** 审批实例状态 */ + status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED' | 'HIDDEN' | 'TERMINATED' + /** 审批实例扩展 JSON */ + extra?: string + /** 审批实例唯一标识，用户自定义，需确保证租户、应用下唯一 */ + instance_id: string + /** 审批实例链接集合 ，用于【已发起】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ + links: ExternalInstanceLink + /** 审批展示名称，如果填写了该字段，则审批列表中的审批名称使用该字段，如果不填该字段，则审批名称使用审批定义的名称 */ + title?: string + /** 用户提交审批时填写的表单数据，用于所有审批列表中展示。可传多个值，但审批中心pc展示前2个,移动端展示前3个,长度不超过2048字符 */ + form?: ExternalInstanceForm[] + /** 审批发起人 user_id，发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】，【已审批】【抄送我】列表中，该字段展示审批是谁发起的。审批发起人 open id，和 user id 二选一。 */ + user_id?: string + /** 审批发起人 用户名，如果发起人不是真实的用户（例如是某个部门），没有 user_id，则可以使用该字段传名称 */ + user_name?: string + /** 审批发起人 open id，和 user id 二选一 */ + open_id?: string + /** 发起人部门，用于列表中展示发起人所属部门。不传则不展示。如果用户没加入任何部门，传 ""，将展示租户名称传 department_name 展示部门名称 */ + department_id?: string + /** 审批发起人 部门，如果发起人不是真实的用户（例如是某个部门），没有 department_id，则可以使用该字段传名称 */ + department_name?: string + /** 审批发起时间，Unix毫秒时间戳 */ + start_time: string + /** 审批实例结束时间：未结束的审批为 0，Unix毫秒时间戳 */ + end_time: string + /** 审批实例最近更新时间；用于推送数据版本控制如果 update_mode 值为 UPDATE，则只有传过来的 update_time 有变化时（变大），才会更新审批中心中的审批实例信息。使用该字段主要用来避免并发时老的数据更新了新的数据 */ + update_time: string + /** 列表页打开审批实例的方式 */ + display_method?: 'BROWSER' | 'SIDEBAR' | 'NORMAL' | 'TRUSTEESHIP' + /** 更新方式， 当 update_mode=REPLACE时，每次都以当前推送的数据为最终数据，会删掉审批中心中多余的任务、抄送数据（不在这次推送的数据中）; 当 update_mode=UPDATE时，则不会删除审批中心的数据，而只是进行新增和更新实例、任务数据 */ + update_mode?: 'REPLACE' | 'UPDATE' + /** 任务列表 */ + task_list?: ExternalInstanceTaskNode[] + /** 抄送列表 */ + cc_list?: CcNode[] + /** 国际化文案 */ + i18n_resources: I18nResource[] + /** 单据托管认证token，托管回调会附带此token，帮助业务方认证 */ + trusteeship_url_token?: string + /** 用户的类型，会影响请求参数用户标识域的选择，包括加签操作回传的目标用户， 目前仅支持 "user_id" */ + trusteeship_user_id_type?: string + /** 单据托管回调接入方的接口的URL地址 */ + trusteeship_urls?: TrusteeshipUrls + /** 托管预缓存策略 */ + trusteeship_cache_config?: TrusteeshipInstanceCacheConfig + /** 资源所在地区， 内部统计用字段， 不需要填 */ + resource_region?: string +} + +export interface CheckApprovalExternalInstanceRequest { + /** 校验的实例信息 */ + instances: ExteranlInstanceCheck[] +} + +export interface ListApprovalExternalTaskRequest { + /** 审批定义 Code，用于指定只获取这些定义下的数据 */ + approval_codes?: string[] + /** 审批实例 ID, 用于指定只获取这些实例下的数据，最多支持 20 个 */ + instance_ids?: string[] + /** 审批人 user_id，用于指定只获取这些用户的数据 */ + user_ids?: string[] + /** 审批任务状态，用于指定获取该状态下的数据 */ + status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE' +} + +export interface ListApprovalExternalTaskQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface QueryApprovalInstanceRequest { + /** 根据x_user_type填写用户 id */ + user_id?: string + /** 审批定义 code */ + approval_code?: string + /** 审批实例 code */ + instance_code?: string + /** 审批实例第三方 id 注：和 approval_code 取并集 */ + instance_external_id?: string + /** 审批定义分组第三方 id 注：和 instance_code 取并集 */ + group_external_id?: string + /** 审批实例标题（只有第三方审批有） */ + instance_title?: string + /** 审批实例状态，注：若不在集合中，报错 */ + instance_status?: 'PENDING' | 'RECALL' | 'REJECT' | 'DELETED' | 'APPROVED' | 'ALL' + /** 实例查询开始时间（unix毫秒时间戳） */ + instance_start_time_from?: string + /** 实例查询结束时间 (unix毫秒时间戳) */ + instance_start_time_to?: string + /** 地区 */ + locale?: 'zh-CN' | 'en-US' | 'ja-JP' +} + +export interface QueryApprovalInstanceQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SearchCcApprovalInstanceRequest { + /** 根据x_user_type填写用户 id */ + user_id?: string + /** 审批定义 code */ + approval_code?: string + /** 审批实例 code */ + instance_code?: string + /** 审批实例第三方 id 注：和 approval_code 取并集 */ + instance_external_id?: string + /** 审批定义分组第三方 id 注：和 instance_code 取并集 */ + group_external_id?: string + /** 审批实例标题（只有第三方审批有） */ + cc_title?: string + /** 审批抄送状态，注：若不在集合中，报错 */ + read_status?: 'READ' | 'UNREAD' | 'ALL' + /** 实例查询开始时间（unix毫秒时间戳） */ + cc_create_time_from?: string + /** 实例查询结束时间 (unix毫秒时间戳) */ + cc_create_time_to?: string + /** 地区 */ + locale?: 'zh-CN' | 'en-US' | 'ja-JP' +} + +export interface SearchCcApprovalInstanceQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SearchApprovalTaskRequest { + /** 根据x_user_type填写用户 id */ + user_id?: string + /** 审批定义 code */ + approval_code?: string + /** 审批实例 code */ + instance_code?: string + /** 审批实例第三方 id 注：和 approval_code 取并集 */ + instance_external_id?: string + /** 审批定义分组第三方 id 注：和 instance_code 取并集 */ + group_external_id?: string + /** 审批任务标题（只有第三方审批有） */ + task_title?: string + /** 审批任务状态，注：若不设置，查询全部状态 若不在集合中，报错 */ + task_status?: 'PENDING' | 'REJECTED' | 'APPROVED' | 'TRANSFERRED' | 'DONE' | 'RM_REPEAT' | 'PROCESSED' | 'ALL' + /** 任务查询开始时间（unix毫秒时间戳） */ + task_start_time_from?: string + /** 任务查询结束时间 (unix毫秒时间戳) */ + task_start_time_to?: string + /** 地区 */ + locale?: 'zh-CN' | 'en-US' | 'ja-JP' + /** 可选择task_status中的多个状态，当填写此参数时，task_status失效 */ + task_status_list?: string[] + /** 按时间排序 */ + order?: 0 | 1 | 2 | 3 +} + +export interface SearchApprovalTaskQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface QueryApprovalTaskQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 需要查询的 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 ListApprovalInstanceResponse { + /** 审批实例 Code */ + instance_code_list: string[] + /** 翻页 Token */ + page_token: string + /** 是否有更多任务可供拉取 */ + has_more: boolean +} + +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 ListApprovalExternalTaskResponse { + /** 任务列表 */ + data?: ExternalTaskList[] + /** 翻页 Token */ + page_token?: string + /** 是否有更多任务可供拉取 */ + has_more?: boolean +} + +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 + /** 审批任务列表 */ + task_list?: TaskSearchItem[] + /** 翻页 Token */ + page_token?: string + /** 是否有更多任务可供拉取 */ + has_more?: boolean +} + +export interface QueryApprovalTaskResponse { + /** 任务列表 */ + tasks: Task[] + /** 翻页 Token */ + page_token?: string + /** 是否有更多任务可供拉取 */ + has_more?: boolean + /** 列表计数，只在分页第一页返回 */ + count?: Count +} + +Internal.define({ + '/open-apis/approval/v4/approvals': { + POST: 'createApproval', + }, + '/open-apis/approval/v4/approvals/{approval_code}': { + GET: 'getApproval', + }, + '/open-apis/approval/v4/instances': { + POST: 'createApprovalInstance', + GET: 'listApprovalInstance', + }, + '/open-apis/approval/v4/instances/cancel': { + POST: 'cancelApprovalInstance', + }, + '/open-apis/approval/v4/instances/cc': { + POST: 'ccApprovalInstance', + }, + '/open-apis/approval/v4/instances/preview': { + POST: 'previewApprovalInstance', + }, + '/open-apis/approval/v4/instances/{instance_id}': { + GET: 'getApprovalInstance', + }, + '/open-apis/approval/v4/tasks/approve': { + POST: 'approveApprovalTask', + }, + '/open-apis/approval/v4/tasks/reject': { + POST: 'rejectApprovalTask', + }, + '/open-apis/approval/v4/tasks/transfer': { + POST: 'transferApprovalTask', + }, + '/open-apis/approval/v4/instances/specified_rollback': { + POST: 'specifiedRollbackApprovalInstance', + }, + '/open-apis/approval/v4/instances/add_sign': { + POST: 'addSignApprovalInstance', + }, + '/open-apis/approval/v4/tasks/resubmit': { + POST: 'resubmitApprovalTask', + }, + '/open-apis/approval/v4/instances/{instance_id}/comments': { + POST: 'createApprovalInstanceComment', + GET: 'listApprovalInstanceComment', + }, + '/open-apis/approval/v4/instances/{instance_id}/comments/{comment_id}': { + DELETE: 'deleteApprovalInstanceComment', + }, + '/open-apis/approval/v4/instances/{instance_id}/comments/remove': { + POST: 'removeApprovalInstanceComment', + }, + '/open-apis/approval/v4/external_approvals': { + POST: 'createApprovalExternalApproval', + }, + '/open-apis/approval/v4/external_approvals/{approval_code}': { + GET: 'getApprovalExternalApproval', + }, + '/open-apis/approval/v4/external_instances': { + POST: 'createApprovalExternalInstance', + }, + '/open-apis/approval/v4/external_instances/check': { + POST: 'checkApprovalExternalInstance', + }, + '/open-apis/approval/v4/external_tasks': { + GET: 'listApprovalExternalTask', + }, + '/open-apis/approval/v4/instances/query': { + POST: 'queryApprovalInstance', + }, + '/open-apis/approval/v4/instances/search_cc': { + POST: 'searchCcApprovalInstance', + }, + '/open-apis/approval/v4/tasks/search': { + POST: 'searchApprovalTask', + }, + '/open-apis/approval/v4/tasks/query': { + GET: 'queryApprovalTask', + }, + '/open-apis/approval/v4/approvals/{approval_code}/subscribe': { + POST: 'subscribeApproval', + }, + '/open-apis/approval/v4/approvals/{approval_code}/unsubscribe': { + POST: 'unsubscribeApproval', + }, +}) diff --git a/adapters/lark/src/types/attendance.ts b/adapters/lark/src/types/attendance.ts new file mode 100644 index 00000000..e21c32f2 --- /dev/null +++ b/adapters/lark/src/types/attendance.ts @@ -0,0 +1,1214 @@ +import { Internal } from '../internal' +import { ApprovalInfo, ArchiveField, ArchiveReportData, ArchiveReportMeta, File, FlexibleRule, FreePunchCfg, Group, GroupMeta, LangText, LateOffLateOnRule, LateOffLateOnSetting, LeaveAccrualRecord, LeaveEmployExpireRecord, LeaveNeedPunchCfg, Location, Machine, MemberStatusChange, OvertimeClockCfg, OvertimeRule, PunchMember, PunchSpecialDateShift, PunchTimeRule, RestRule, RestTimeFlexibleConfig, Shift, ShiftAttendanceTimeConfig, ShiftMiddleTimeRule, UserAllowedRemedy, UserApproval, UserBase, UserDailyShift, UserFlow, UserSetting, UserStatsData, UserStatsField, UserStatsView, UserTask, UserTaskRemedy, UserTmpDailyShift } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建班次 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/create + */ + createAttendanceShift(body: CreateAttendanceShiftRequest, query?: CreateAttendanceShiftQuery): Promise + /** + * 删除班次 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/delete + */ + deleteAttendanceShift(shift_id: string): Promise + /** + * 按 ID 查询班次 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/get + */ + getAttendanceShift(shift_id: string): Promise + /** + * 按名称查询班次 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/query + */ + queryAttendanceShift(query?: QueryAttendanceShiftQuery): Promise + /** + * 查询所有班次 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/list + */ + listAttendanceShift(query?: ListAttendanceShiftQuery): Promise + /** + * 创建或修改排班表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/batch_create + */ + batchCreateAttendanceUserDailyShift(body: BatchCreateAttendanceUserDailyShiftRequest, query?: BatchCreateAttendanceUserDailyShiftQuery): Promise + /** + * 查询排班表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/query + */ + queryAttendanceUserDailyShift(body: QueryAttendanceUserDailyShiftRequest, query?: QueryAttendanceUserDailyShiftQuery): Promise + /** + * 创建或修改临时排班 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/batch_create_temp + */ + batchCreateTempAttendanceUserDailyShift(body: BatchCreateTempAttendanceUserDailyShiftRequest, query?: BatchCreateTempAttendanceUserDailyShiftQuery): Promise + /** + * 查询考勤组下所有成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list_user + */ + listUserAttendanceGroup(group_id: string, query?: ListUserAttendanceGroupQuery): Promise + /** + * 创建或修改考勤组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/create + */ + createAttendanceGroup(body: CreateAttendanceGroupRequest, query?: CreateAttendanceGroupQuery): Promise + /** + * 删除考勤组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/delete + */ + deleteAttendanceGroup(group_id: string): Promise + /** + * 按 ID 查询考勤组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/get + */ + getAttendanceGroup(group_id: string, query?: GetAttendanceGroupQuery): Promise + /** + * 按名称查询考勤组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/search + */ + searchAttendanceGroup(body: SearchAttendanceGroupRequest): Promise + /** + * 查询所有考勤组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list + */ + listAttendanceGroup(query?: ListAttendanceGroupQuery): Promise + /** + * 修改用户人脸识别信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/modify + */ + modifyAttendanceUserSetting(body: ModifyAttendanceUserSettingRequest, query?: ModifyAttendanceUserSettingQuery): Promise + /** + * 批量查询用户人脸识别信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/query + */ + queryAttendanceUserSetting(body: QueryAttendanceUserSettingRequest, query?: QueryAttendanceUserSettingQuery): Promise + /** + * 上传用户人脸识别照片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/upload + */ + uploadAttendanceFile(form: UploadAttendanceFileForm, query?: UploadAttendanceFileQuery): Promise + /** + * 下载用户人脸识别照片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/download + */ + downloadAttendanceFile(file_id: string): Promise + /** + * 更新统计设置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_view/update + */ + updateAttendanceUserStatsView(user_stats_view_id: string, body: UpdateAttendanceUserStatsViewRequest, query?: UpdateAttendanceUserStatsViewQuery): Promise + /** + * 查询统计表头 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_field/query + */ + queryAttendanceUserStatsField(body: QueryAttendanceUserStatsFieldRequest, query?: QueryAttendanceUserStatsFieldQuery): Promise + /** + * 查询统计设置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_view/query + */ + queryAttendanceUserStatsView(body: QueryAttendanceUserStatsViewRequest, query?: QueryAttendanceUserStatsViewQuery): Promise + /** + * 查询统计数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_data/query + */ + queryAttendanceUserStatsData(body: QueryAttendanceUserStatsDataRequest, query?: QueryAttendanceUserStatsDataQuery): Promise + /** + * 获取审批通过数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query + */ + queryAttendanceUserApproval(body: QueryAttendanceUserApprovalRequest, query?: QueryAttendanceUserApprovalQuery): Promise + /** + * 写入审批结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create + */ + createAttendanceUserApproval(body: CreateAttendanceUserApprovalRequest, query?: CreateAttendanceUserApprovalQuery): Promise + /** + * 通知审批状态更新 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/approval_info/process + */ + processAttendanceApprovalInfo(body: ProcessAttendanceApprovalInfoRequest): Promise + /** + * 通知补卡审批发起 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create + */ + createAttendanceUserTaskRemedy(body: CreateAttendanceUserTaskRemedyRequest, query?: CreateAttendanceUserTaskRemedyQuery): Promise + /** + * 获取可补卡时间 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/query_user_allowed_remedys + */ + queryUserAllowedRemedysAttendanceUserTaskRemedy(body: QueryUserAllowedRemedysAttendanceUserTaskRemedyRequest, query?: QueryUserAllowedRemedysAttendanceUserTaskRemedyQuery): Promise + /** + * 获取补卡记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/query + */ + queryAttendanceUserTaskRemedy(body: QueryAttendanceUserTaskRemedyRequest, query?: QueryAttendanceUserTaskRemedyQuery): Promise + /** + * 查询归档报表表头 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/user_stats_fields_query + */ + userStatsFieldsQueryAttendanceArchiveRule(body: UserStatsFieldsQueryAttendanceArchiveRuleRequest, query?: UserStatsFieldsQueryAttendanceArchiveRuleQuery): Promise + /** + * 写入归档报表结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/upload_report + */ + uploadReportAttendanceArchiveRule(body: UploadReportAttendanceArchiveRuleRequest, query?: UploadReportAttendanceArchiveRuleQuery): Promise + /** + * 删除归档报表行数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/del_report + */ + delReportAttendanceArchiveRule(body: DelReportAttendanceArchiveRuleRequest, query?: DelReportAttendanceArchiveRuleQuery): Promise + /** + * 查询所有归档规则 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/list + */ + listAttendanceArchiveRule(query?: ListAttendanceArchiveRuleQuery): Promise + /** + * 导入打卡流水 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/batch_create + */ + batchCreateAttendanceUserFlow(body: BatchCreateAttendanceUserFlowRequest, query?: BatchCreateAttendanceUserFlowQuery): Promise + /** + * 查询打卡流水 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/get + */ + getAttendanceUserFlow(user_flow_id: string, query?: GetAttendanceUserFlowQuery): Promise + /** + * 批量查询打卡流水 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/query + */ + queryAttendanceUserFlow(body: QueryAttendanceUserFlowRequest, query?: QueryAttendanceUserFlowQuery): Promise + /** + * 查询打卡结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task/query + */ + queryAttendanceUserTask(body: QueryAttendanceUserTaskRequest, query?: QueryAttendanceUserTaskQuery): Promise + /** + * 通过过期时间获取发放记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/leave_employ_expire_record/get + */ + getAttendanceLeaveEmployExpireRecord(leave_id: string, body: GetAttendanceLeaveEmployExpireRecordRequest, query?: GetAttendanceLeaveEmployExpireRecordQuery): Promise + /** + * 修改发放记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/leave_accrual_record/patch + */ + patchAttendanceLeaveAccrualRecord(leave_id: string, body: PatchAttendanceLeaveAccrualRecordRequest, query?: PatchAttendanceLeaveAccrualRecordQuery): Promise + } +} + +export interface CreateAttendanceShiftRequest { + /** 班次名称 */ + shift_name: string + /** 打卡次数 */ + punch_times: number + /** 排班组子负责人id列表 */ + sub_shift_leader_ids?: string[] + /** 是否弹性打卡 */ + is_flexible?: boolean + /** 弹性打卡时间，设置【上班最多可晚到】与【下班最多可早走】时间，如果不设置flexible_rule则生效 */ + flexible_minutes?: number + /** 弹性打卡时间设置 */ + flexible_rule?: FlexibleRule[] + /** 不需要打下班卡 */ + no_need_off?: boolean + /** 打卡规则 */ + punch_time_rule: PunchTimeRule[] + /** 晚走晚到规则 */ + late_off_late_on_rule?: LateOffLateOnRule[] + /** 休息规则 */ + rest_time_rule?: RestRule[] + /** 打卡规则 */ + overtime_rule?: OvertimeRule[] + /** 日期类型，【是否弹性打卡 = ture】时，不可设置为“休息日” 可选值：1：工作日 2：休息日 示例值：（默认值）1 */ + day_type?: number + /** 班外休息规则 */ + overtime_rest_time_rule?: RestRule[] + /** 晚到多久记为严重迟到（优先级比原有字段高） */ + late_minutes_as_serious_late?: number + /** 半天分割规则 */ + shift_middle_time_rule?: ShiftMiddleTimeRule + /** 应出勤配置 */ + shift_attendance_time_config?: ShiftAttendanceTimeConfig + /** 晚走次日晚到配置规则 */ + late_off_late_on_setting?: LateOffLateOnSetting + /** 班次id(更新班次时需要传递) */ + id?: string + /** 休息弹性设置 */ + rest_time_flexible_configs?: RestTimeFlexibleConfig[] +} + +export interface CreateAttendanceShiftQuery { + /** 用户 ID 的类型 不提供则用户相关字段无效 */ + employee_type?: 'employee_id' | 'employee_no' +} + +export interface QueryAttendanceShiftQuery { + /** 班次名称 */ + shift_name: string +} + +export interface ListAttendanceShiftQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: 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 { + /** 用户 ID 的类型 */ + employee_type: string + /** 部门 ID 的类型 */ + dept_type: string + /** 分页大小 */ + page_size?: number + /** 第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: 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 ListAttendanceGroupQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: 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 ListAttendanceArchiveRuleQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: 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 +} + +export interface GetAttendanceShiftResponse { + /** 班次Id */ + shift_id: string + /** 班次名称 */ + shift_name: string + /** 打卡次数 */ + punch_times: number + /** 排班组子负责人id列表 */ + sub_shift_leader_ids?: string[] + /** 是否弹性打卡 */ + is_flexible?: boolean + /** 弹性打卡时间，设置【上班最多可晚到】与【下班最多可早走】时间，如果不设置flexible_rule则生效 */ + flexible_minutes?: number + /** 弹性打卡时间设置 */ + flexible_rule?: FlexibleRule[] + /** 不需要打下班卡 */ + no_need_off?: boolean + /** 打卡规则 */ + punch_time_rule: PunchTimeRule[] + /** 晚走晚到规则 */ + late_off_late_on_rule?: LateOffLateOnRule[] + /** 休息规则 */ + rest_time_rule?: RestRule[] + /** 打卡规则 */ + overtime_rule?: OvertimeRule[] + /** 日期类型，【是否弹性打卡 = ture】时，不可设置为“休息日” 可选值：1：工作日 2：休息日 示例值：（默认值）1 */ + day_type?: number + /** 班外休息规则 */ + overtime_rest_time_rule?: RestRule[] + /** 晚到多久记为严重迟到（优先级比原有字段高） */ + late_minutes_as_serious_late?: number + /** 半天分割规则 */ + shift_middle_time_rule?: ShiftMiddleTimeRule + /** 应出勤配置 */ + shift_attendance_time_config?: ShiftAttendanceTimeConfig + /** 晚走次日晚到配置规则 */ + late_off_late_on_setting?: LateOffLateOnSetting + /** 班次id(更新班次时需要传递) */ + id?: string + /** 休息弹性设置 */ + rest_time_flexible_configs?: RestTimeFlexibleConfig[] +} + +export interface QueryAttendanceShiftResponse { + /** 班次Id */ + shift_id: string + /** 班次名称 */ + shift_name: string + /** 打卡次数 */ + punch_times: number + /** 排班组子负责人id列表 */ + sub_shift_leader_ids?: string[] + /** 是否弹性打卡 */ + is_flexible?: boolean + /** 弹性打卡时间，设置【上班最多可晚到】与【下班最多可早走】时间，如果不设置flexible_rule则生效 */ + flexible_minutes?: number + /** 弹性打卡时间设置 */ + flexible_rule?: FlexibleRule[] + /** 不需要打下班卡 */ + no_need_off?: boolean + /** 打卡规则 */ + punch_time_rule: PunchTimeRule[] + /** 晚走晚到规则 */ + late_off_late_on_rule?: LateOffLateOnRule[] + /** 休息规则 */ + rest_time_rule?: RestRule[] + /** 打卡规则 */ + overtime_rule?: OvertimeRule[] + /** 日期类型，【是否弹性打卡 = ture】时，不可设置为“休息日” 可选值：1：工作日 2：休息日 示例值：（默认值）1 */ + day_type?: number + /** 班外休息规则 */ + overtime_rest_time_rule?: RestRule[] + /** 晚到多久记为严重迟到（优先级比原有字段高） */ + late_minutes_as_serious_late?: number + /** 半天分割规则 */ + shift_middle_time_rule?: ShiftMiddleTimeRule + /** 应出勤配置 */ + shift_attendance_time_config?: ShiftAttendanceTimeConfig + /** 晚走次日晚到配置规则 */ + late_off_late_on_setting?: LateOffLateOnSetting + /** 班次id(更新班次时需要传递) */ + id?: string + /** 休息弹性设置 */ + rest_time_flexible_configs?: RestTimeFlexibleConfig[] +} + +export interface ListAttendanceShiftResponse { + /** 班次列表 */ + shift_list?: Shift[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface BatchCreateAttendanceUserDailyShiftResponse { + /** 班表信息列表 */ + user_daily_shifts?: UserDailyShift[] +} + +export interface QueryAttendanceUserDailyShiftResponse { + /** 班表信息列表 */ + user_daily_shifts?: UserDailyShift[] +} + +export interface BatchCreateTempAttendanceUserDailyShiftResponse { + /** 临时班表信息列表 */ + user_tmp_daily_shifts?: UserTmpDailyShift[] +} + +export interface ListUserAttendanceGroupResponse { + /** 考勤组成员列表 */ + users?: UserBase[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface CreateAttendanceGroupResponse { + group?: Group +} + +export interface GetAttendanceGroupResponse { + /** 考勤组的Id， 需要从获取用户打卡结果信息的接口中获取groupId，修改考勤组时必填 */ + group_id?: string + /** 考勤组名称 */ + group_name: string + /** 考勤组时区 */ + time_zone: string + /** 参加考勤的部门id列表 */ + bind_dept_ids?: string[] + /** 无需考勤的部门id列表 */ + except_dept_ids?: string[] + /** 参加考勤的人员id列表 */ + bind_user_ids?: string[] + /** 参加考勤的人员id列表 */ + except_user_ids?: string[] + /** 考勤组主负责人id列表 */ + group_leader_ids: string[] + /** 考勤组子负责人id列表 */ + sub_group_leader_ids?: string[] + /** 是否允许外勤打卡 */ + allow_out_punch?: boolean + /** 外勤打卡需审批，先审批后打卡（需要允许外勤打卡才能设置生效） */ + out_punch_need_approval?: boolean + /** 外勤打卡需审批，先打卡后审批（需要允许外勤打卡才能设置生效） */ + out_punch_need_post_approval?: boolean + /** 外勤打卡需填写备注（需要允许外勤打卡才能设置生效） */ + out_punch_need_remark?: boolean + /** 外勤打卡需拍照（需要允许外勤打卡才能设置生效） */ + out_punch_need_photo?: boolean + /** 外勤打卡允许员工隐藏详细地址（需要允许外勤打卡才能设置生效） */ + out_punch_allowed_hide_addr?: boolean + /** 外勤打卡允许微调地址（需要允许外勤打卡才能设置生效） */ + out_punch_allowed_adjust_addr?: boolean + /** 微调范围，默认为 50 米 */ + adjust_range?: number + /** 是否允许pc打卡 */ + allow_pc_punch?: boolean + /** 是否允许补卡 */ + allow_remedy?: boolean + /** 补卡次数是否限制（需要允许补卡才能设置生效） */ + remedy_limit?: boolean + /** 补卡次数（需要允许补卡才能设置生效） */ + remedy_limit_count?: number + /** 补卡时间是否限制（需要允许补卡才能设置生效） */ + remedy_date_limit?: boolean + /** 补卡时间,几天内可以发起补卡（需要允许补卡才能设置生效） */ + remedy_date_num?: number + /** 允许缺卡补卡（需要允许补卡才能设置生效） */ + allow_remedy_type_lack?: boolean + /** 允许迟到补卡（需要允许补卡才能设置生效） */ + allow_remedy_type_late?: boolean + /** 允许早退补卡（需要允许补卡才能设置生效） */ + allow_remedy_type_early?: boolean + /** 允许正常补卡（需要允许补卡才能设置生效） */ + allow_remedy_type_normal?: boolean + /** 是否展示累计时长 */ + show_cumulative_time?: boolean + /** 是否展示加班时长 */ + show_over_time?: boolean + /** 是否隐藏员工打卡详情 */ + hide_staff_punch_time?: boolean + /** 是否开启人脸打卡 */ + face_punch?: boolean + /** 人脸打卡规则， 1：每次打卡均需人脸识别 2：疑似需要 */ + face_punch_cfg?: number + /** 人脸打卡规则， false：开启活体验证 true：0动作验证，仅在 face_punch_cfg = 1 时有效 */ + face_live_need_action?: boolean + /** 脸识别失败时允许普通拍照打卡 */ + face_downgrade?: boolean + /** 是否允许替换基准图片 */ + replace_basic_pic?: boolean + /** 考勤机信息 */ + machines?: Machine[] + /** GPS打卡的地址范围 */ + gps_range?: number + /** GPS打卡的地址信息 */ + locations?: Location[] + /** 考勤类型 0：固定考勤 2：排班考勤， 3：自由班次 */ + group_type: number + /** 固定班次必需填 */ + punch_day_shift_ids: string[] + free_punch_cfg?: FreePunchCfg + /** 国家日历 id，（0：不根据国家日历休息, 1：中国，2：美国，3：日本，4：印度，5：新加坡），默认 1 */ + calendar_id: number + /** 强制需要打卡的日期 */ + need_punch_special_days?: PunchSpecialDateShift[] + /** 强制不需要打卡的日期 */ + no_need_punch_special_days?: PunchSpecialDateShift[] + /** 自由班次下工作日不打卡是否记为缺卡 */ + work_day_no_punch_as_lack?: boolean + /** 补卡周期类型 */ + remedy_period_type?: number + /** 补卡自定义周期起始日期 */ + remedy_period_custom_date?: number + /** 打卡类型，位运算。1:GPS打卡；2:wifi打卡；4:考勤机打卡；8:IP打卡 */ + punch_type?: number + /** 生效时间，精确到秒的时间戳 */ + effect_time?: string + /** 固定班次生效时间，精确到秒的时间戳 */ + fixshift_effect_time?: string + /** 参加考勤的人员、部门变动生效时间，精确到秒的时间戳 */ + member_effect_time?: string + /** 休息日打卡需审批 */ + rest_clockIn_need_approval?: boolean + /** 每次打卡均需拍照 */ + clockIn_need_photo?: boolean + /** 人员异动打卡设置 */ + member_status_change?: MemberStatusChange + /** 请假离岗或返岗是否需打卡 */ + leave_need_punch?: boolean + /** 请假离岗或返岗打卡规则 */ + leave_need_punch_cfg?: LeaveNeedPunchCfg + /** 外出期间是否需打卡 */ + go_out_need_punch?: number + /** 外出期间打卡规则 */ + go_out_need_punch_cfg?: LeaveNeedPunchCfg + /** 出差期间是否需打卡 */ + travel_need_punch?: number + /** 出差期间打卡规则 */ + travel_need_punch_cfg?: LeaveNeedPunchCfg + /** 需要打卡的人员配置（新） */ + need_punch_members?: PunchMember[] + /** 无需打卡的人员配置（新） */ + no_need_punch_members?: PunchMember[] + /** 是否直接保存可以自动变更的冲突规则 */ + save_auto_changes?: boolean + /** 人员异动开关（人员组织架构变更后是否允许自动调整到该考勤组） */ + org_change_auto_adjust?: boolean + /** 默认出勤的部门id列表 */ + bind_default_dept_ids?: string[] + /** 默认出勤的用户ID列表 */ + bind_default_user_ids?: string[] + /** 加班打卡规则 */ + overtime_clock_cfg?: OvertimeClockCfg + /** 节假日id，（如果考勤组使用了自定义节假日，请用此参数传入节假日id） */ + new_calendar_id?: string + /** 定位不准时是否允许申请打卡 */ + allow_apply_punch?: boolean +} + +export interface SearchAttendanceGroupResponse { + /** 考勤组列表 */ + group_list?: GroupMeta[] +} + +export interface ListAttendanceGroupResponse { + /** 考勤组列表 */ + group_list?: GroupMeta[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface ModifyAttendanceUserSettingResponse { + /** 用户设置 */ + user_setting?: UserSetting +} + +export interface QueryAttendanceUserSettingResponse { + /** 用户设置信息列表 */ + user_settings?: UserSetting[] +} + +export interface UploadAttendanceFileResponse { + file?: File +} + +export interface UpdateAttendanceUserStatsViewResponse { + /** 视图 */ + view?: UserStatsView +} + +export interface QueryAttendanceUserStatsFieldResponse { + user_stats_field?: UserStatsField +} + +export interface QueryAttendanceUserStatsViewResponse { + view?: UserStatsView +} + +export interface QueryAttendanceUserStatsDataResponse { + /** 用户统计数据 */ + user_datas?: UserStatsData[] + /** 无权限获取的用户列表 */ + invalid_user_list?: string[] +} + +export interface QueryAttendanceUserApprovalResponse { + /** 审批结果列表 */ + user_approvals?: UserApproval[] +} + +export interface CreateAttendanceUserApprovalResponse { + /** 审批信息 */ + user_approval?: UserApproval +} + +export interface ProcessAttendanceApprovalInfoResponse { + /** 审批信息 */ + approval_info?: ApprovalInfo +} + +export interface CreateAttendanceUserTaskRemedyResponse { + /** 补卡审批信息 */ + user_remedy?: UserTaskRemedy +} + +export interface QueryUserAllowedRemedysAttendanceUserTaskRemedyResponse { + /** 用户可补卡时间 */ + user_allowed_remedys?: UserAllowedRemedy[] +} + +export interface QueryAttendanceUserTaskRemedyResponse { + /** 补卡记录列表 */ + user_remedys?: UserTaskRemedy[] +} + +export interface UserStatsFieldsQueryAttendanceArchiveRuleResponse { + /** 统计数据表头 */ + archive_report_fields?: ArchiveField[] +} + +export interface UploadReportAttendanceArchiveRuleResponse { + /** 无效的code */ + invalid_code?: string[] + /** 无效的member_id */ + invalid_member_id?: string[] +} + +export interface ListAttendanceArchiveRuleResponse { + /** 分页查询结果项 */ + items?: ArchiveReportMeta[] + /** 分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否有更多项 */ + has_more?: boolean +} + +export interface BatchCreateAttendanceUserFlowResponse { + /** 打卡流水记录列表 */ + flow_records?: UserFlow[] +} + +export interface GetAttendanceUserFlowResponse { + /** 用户工号 */ + user_id: string + /** 记录创建者的工号 */ + creator_id: string + /** 打卡位置名称信息 */ + location_name: string + /** 打卡时间，精确到秒的时间戳 */ + check_time: string + /** 打卡备注 */ + comment: string + /** 打卡记录ID */ + record_id?: string + /** 打卡wifi ssid */ + ssid?: string + /** 打卡wifi MAC地址 */ + bssid?: string + /** 是否为外勤打卡 */ + is_field?: boolean + /** 是否为wifi打卡 */ + is_wifi?: boolean + /** 记录生成方式 */ + type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 打卡照片列表 */ + photo_urls?: string[] + /** 打卡设备ID */ + device_id?: string + /** 打卡结果 */ + check_result?: 'NoNeedCheck' | 'SystemCheck' | 'Normal' | 'Early' | 'Late' | 'SeriousLate' | 'Lack' | 'Invalid' | 'None' | 'Todo' + /** 用户导入的外部打卡记录ID */ + external_id?: string + /** 唯一幂等键 */ + idempotent_id?: string +} + +export interface QueryAttendanceUserFlowResponse { + /** 打卡记录列表 */ + user_flow_results?: UserFlow[] +} + +export interface QueryAttendanceUserTaskResponse { + /** 打卡任务列表 */ + user_task_results?: UserTask[] + /** 无效用户工号列表 */ + invalid_user_ids?: string[] + /** 没有权限用户工号列表 */ + unauthorized_user_ids?: string[] +} + +export interface GetAttendanceLeaveEmployExpireRecordResponse { + /** 员工过期日期的授予记录 */ + records: LeaveEmployExpireRecord[] +} + +export interface PatchAttendanceLeaveAccrualRecordResponse { + /** 员工过期日期的授予记录 */ + record: LeaveAccrualRecord +} + +Internal.define({ + '/open-apis/attendance/v1/shifts': { + POST: 'createAttendanceShift', + GET: 'listAttendanceShift', + }, + '/open-apis/attendance/v1/shifts/{shift_id}': { + DELETE: 'deleteAttendanceShift', + GET: 'getAttendanceShift', + }, + '/open-apis/attendance/v1/shifts/query': { + POST: 'queryAttendanceShift', + }, + '/open-apis/attendance/v1/user_daily_shifts/batch_create': { + POST: 'batchCreateAttendanceUserDailyShift', + }, + '/open-apis/attendance/v1/user_daily_shifts/query': { + POST: 'queryAttendanceUserDailyShift', + }, + '/open-apis/attendance/v1/user_daily_shifts/batch_create_temp': { + POST: 'batchCreateTempAttendanceUserDailyShift', + }, + '/open-apis/attendance/v1/groups/{group_id}/list_user': { + GET: 'listUserAttendanceGroup', + }, + '/open-apis/attendance/v1/groups': { + POST: 'createAttendanceGroup', + GET: 'listAttendanceGroup', + }, + '/open-apis/attendance/v1/groups/{group_id}': { + DELETE: 'deleteAttendanceGroup', + GET: 'getAttendanceGroup', + }, + '/open-apis/attendance/v1/groups/search': { + POST: 'searchAttendanceGroup', + }, + '/open-apis/attendance/v1/user_settings/modify': { + POST: 'modifyAttendanceUserSetting', + }, + '/open-apis/attendance/v1/user_settings/query': { + GET: 'queryAttendanceUserSetting', + }, + '/open-apis/attendance/v1/files/upload': { + POST: { name: 'uploadAttendanceFile', multipart: true }, + }, + '/open-apis/attendance/v1/files/{file_id}/download': { + GET: { name: 'downloadAttendanceFile', type: 'binary' }, + }, + '/open-apis/attendance/v1/user_stats_views/{user_stats_view_id}': { + PUT: 'updateAttendanceUserStatsView', + }, + '/open-apis/attendance/v1/user_stats_fields/query': { + POST: 'queryAttendanceUserStatsField', + }, + '/open-apis/attendance/v1/user_stats_views/query': { + POST: 'queryAttendanceUserStatsView', + }, + '/open-apis/attendance/v1/user_stats_datas/query': { + POST: 'queryAttendanceUserStatsData', + }, + '/open-apis/attendance/v1/user_approvals/query': { + POST: 'queryAttendanceUserApproval', + }, + '/open-apis/attendance/v1/user_approvals': { + POST: 'createAttendanceUserApproval', + }, + '/open-apis/attendance/v1/approval_infos/process': { + POST: 'processAttendanceApprovalInfo', + }, + '/open-apis/attendance/v1/user_task_remedys': { + POST: 'createAttendanceUserTaskRemedy', + }, + '/open-apis/attendance/v1/user_task_remedys/query_user_allowed_remedys': { + POST: 'queryUserAllowedRemedysAttendanceUserTaskRemedy', + }, + '/open-apis/attendance/v1/user_task_remedys/query': { + POST: 'queryAttendanceUserTaskRemedy', + }, + '/open-apis/attendance/v1/archive_rule/user_stats_fields_query': { + POST: 'userStatsFieldsQueryAttendanceArchiveRule', + }, + '/open-apis/attendance/v1/archive_rule/upload_report': { + POST: 'uploadReportAttendanceArchiveRule', + }, + '/open-apis/attendance/v1/archive_rule/del_report': { + POST: 'delReportAttendanceArchiveRule', + }, + '/open-apis/attendance/v1/archive_rule': { + GET: 'listAttendanceArchiveRule', + }, + '/open-apis/attendance/v1/user_flows/batch_create': { + POST: 'batchCreateAttendanceUserFlow', + }, + '/open-apis/attendance/v1/user_flows/{user_flow_id}': { + GET: 'getAttendanceUserFlow', + }, + '/open-apis/attendance/v1/user_flows/query': { + POST: 'queryAttendanceUserFlow', + }, + '/open-apis/attendance/v1/user_tasks/query': { + POST: 'queryAttendanceUserTask', + }, + '/open-apis/attendance/v1/leave_employ_expire_records/{leave_id}': { + GET: 'getAttendanceLeaveEmployExpireRecord', + }, + '/open-apis/attendance/v1/leave_accrual_record/{leave_id}': { + PATCH: 'patchAttendanceLeaveAccrualRecord', + }, +}) diff --git a/adapters/lark/src/types/auth.ts b/adapters/lark/src/types/auth.ts new file mode 100644 index 00000000..2565c59a --- /dev/null +++ b/adapters/lark/src/types/auth.ts @@ -0,0 +1,122 @@ +import { Internal } from '../internal' + +declare module '../internal' { + interface Internal { + /** + * 自建应用获取 tenant_access_token + * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal + */ + tenantAccessTokenInternalAuth(body: TenantAccessTokenInternalAuthRequest): Promise + /** + * 自建应用获取 app_access_token + * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token_internal + */ + appAccessTokenInternalAuth(body: AppAccessTokenInternalAuthRequest): Promise + /** + * 重新获取 app_ticket + * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_ticket_resend + */ + appTicketResendAuth(body: AppTicketResendAuthRequest): Promise + /** + * 商店应用获取 app_access_token + * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token + */ + appAccessTokenAuth(body: AppAccessTokenAuthRequest): Promise + /** + * 商店应用获取 tenant_access_token + * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token + */ + tenantAccessTokenAuth(body: TenantAccessTokenAuthRequest): Promise + } +} + +export interface TenantAccessTokenInternalAuthRequest { + /** 应用唯一标识，创建应用后获得 */ + app_id: string + /** 应用秘钥，创建应用后获得 */ + app_secret: string +} + +export interface AppAccessTokenInternalAuthRequest { + /** 应用唯一标识，创建应用后获得 */ + app_id: string + /** 应用秘钥，创建应用后获得 */ + app_secret: string +} + +export interface AppTicketResendAuthRequest { + /** 应用唯一标识，创建应用后获得 */ + app_id: string + /** 应用秘钥，创建应用后获得 */ + app_secret: string +} + +export interface AppAccessTokenAuthRequest { + /** 应用唯一标识，创建应用后获得 */ + app_id: string + /** 应用秘钥，创建应用后获得 */ + app_secret: string + /** 平台定时推送给应用的临时凭证，通过事件监听机制获得 */ + app_ticket: string +} + +export interface TenantAccessTokenAuthRequest { + /** 应用唯一标识，创建应用 */ + app_access_token: string + /** 应用秘钥，创建应用后获得 */ + tenant_key: string +} + +export interface TenantAccessTokenInternalAuthResponse extends BaseResponse { + code?: number + msg?: string + /** 访问 token */ + tenant_access_token?: string + /** app_access_token 过期时间 */ + expire?: number +} + +export interface AppAccessTokenInternalAuthResponse extends BaseResponse { + code?: number + msg?: string + /** 访问 token */ + app_access_token?: string + /** app_access_token 过期时间 */ + expire?: number +} + +export interface AppAccessTokenAuthResponse extends BaseResponse { + code?: number + msg?: string + /** 访问 token */ + app_access_token?: string + /** app_access_token 过期时间 */ + expire?: number +} + +export interface TenantAccessTokenAuthResponse extends BaseResponse { + code?: number + msg?: string + /** 访问 token */ + tenant_access_token?: string + /** app_access_token 过期时间 */ + expire?: number +} + +Internal.define({ + '/open-apis/auth/v3/tenant_access_token/internal': { + POST: { name: 'tenantAccessTokenInternalAuth', type: 'raw-json' }, + }, + '/open-apis/auth/v3/app_access_token/internal': { + POST: { name: 'appAccessTokenInternalAuth', type: 'raw-json' }, + }, + '/open-apis/auth/v3/app_ticket/resend': { + POST: 'appTicketResendAuth', + }, + '/open-apis/auth/v3/app_access_token': { + POST: { name: 'appAccessTokenAuth', type: 'raw-json' }, + }, + '/open-apis/auth/v3/tenant_access_token': { + POST: { name: 'tenantAccessTokenAuth', type: 'raw-json' }, + }, +}) diff --git a/adapters/lark/src/types/authen.ts b/adapters/lark/src/types/authen.ts new file mode 100644 index 00000000..37e7df17 --- /dev/null +++ b/adapters/lark/src/types/authen.ts @@ -0,0 +1,220 @@ +import { Internal } from '../internal' + +declare module '../internal' { + interface Internal { + /** + * 获取用户信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/user_info/get + */ + getAuthenUserInfo(): Promise + /** + * 获取 user_access_token + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create + */ + createAuthenOidcAccessToken(body: CreateAuthenOidcAccessTokenRequest): Promise + /** + * 刷新 user_access_token + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-refresh_access_token/create + */ + createAuthenOidcRefreshAccessToken(body: CreateAuthenOidcRefreshAccessTokenRequest): Promise + /** + * 获取 user_access_token（v1 版本） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/access_token/create + */ + createAuthenAccessToken(body: CreateAuthenAccessTokenRequest): Promise + /** + * 刷新 user_access_token（v1 版本） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/refresh_access_token/create + */ + createAuthenRefreshAccessToken(body: CreateAuthenRefreshAccessTokenRequest): Promise + } +} + +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 + /** 用户英文名称 */ + en_name?: string + /** 用户头像 */ + avatar_url?: string + /** 用户头像 72x72 */ + avatar_thumb?: string + /** 用户头像 240x240 */ + avatar_middle?: string + /** 用户头像 640x640 */ + avatar_big?: string + /** 用户在应用内的唯一标识 */ + open_id?: string + /** 用户统一ID */ + union_id?: string + /** 用户邮箱 */ + email?: string + /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */ + enterprise_email?: string + /** 用户 user_id */ + user_id?: string + /** 用户手机号 */ + mobile?: string + /** 当前企业标识 */ + tenant_key?: string + /** 用户工号 */ + employee_no?: string +} + +export interface CreateAuthenOidcAccessTokenResponse { + /** user_access_token，用于获取用户资源和访问某些open api */ + access_token: string + /** 刷新用户 `access_token` 时使用的 token */ + refresh_token?: string + /** token 类型，固定值 */ + token_type: string + /** `access_token`的有效期，单位: 秒，一般是两个小时左右，需要以返回结果为准 */ + expires_in?: number + /** `refresh_token` 的有效期，单位: 秒，一般是30天左右，需要以返回结果为准 */ + refresh_expires_in?: number + /** 用户授予app的权限全集 */ + scope?: string +} + +export interface CreateAuthenOidcRefreshAccessTokenResponse { + /** user_access_token，用于获取用户资源和访问某些open api */ + access_token: string + /** 刷新用户 `access_token` 时使用的 token */ + refresh_token?: string + /** token 类型，固定值 */ + token_type: string + /** `access_token`的有效期，单位: 秒，一般是两个小时左右，需要以返回结果为准 */ + expires_in?: number + /** `refresh_token` 的有效期，单位: 秒，一般是30天左右，需要以返回结果为准 */ + refresh_expires_in?: number + /** 用户授予app的权限全集 */ + scope?: string +} + +export interface CreateAuthenAccessTokenResponse { + /** user_access_token，用于获取用户资源 */ + access_token?: string + /** token 类型 */ + token_type?: string + /** `access_token`的有效期，单位: 秒 */ + expires_in?: number + /** 用户姓名 */ + name?: string + /** 用户英文名称 */ + en_name?: string + /** 用户头像 */ + avatar_url?: string + /** 用户头像 72x72 */ + avatar_thumb?: string + /** 用户头像 240x240 */ + avatar_middle?: string + /** 用户头像 640x640 */ + avatar_big?: string + /** 用户在应用内的唯一标识 */ + open_id?: string + /** 用户统一ID */ + union_id?: string + /** 用户邮箱 */ + email?: string + /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */ + enterprise_email?: string + /** 用户 user_id */ + user_id?: string + /** 用户手机号 */ + mobile?: string + /** 当前企业标识 */ + tenant_key?: string + /** `refresh_token` 的有效期，单位: 秒 */ + refresh_expires_in?: number + /** 刷新用户 `access_token` 时使用的 token */ + refresh_token?: string + /** 用户当前登录态session的唯一标识，为空则不返回 */ + sid?: string +} + +export interface CreateAuthenRefreshAccessTokenResponse { + /** user_access_token，用于获取用户资源 */ + access_token?: string + /** token 类型 */ + token_type?: string + /** `access_token`的有效期，单位: 秒 */ + expires_in?: number + /** 用户姓名 */ + name?: string + /** 用户英文名称 */ + en_name?: string + /** 用户头像 */ + avatar_url?: string + /** 用户头像 72x72 */ + avatar_thumb?: string + /** 用户头像 240x240 */ + avatar_middle?: string + /** 用户头像 640x640 */ + avatar_big?: string + /** 用户在应用内的唯一标识 */ + open_id?: string + /** 用户统一ID */ + union_id?: string + /** 用户邮箱 */ + email?: string + /** 企业邮箱，请先确保已在管理后台启用飞书邮箱服务 */ + enterprise_email?: string + /** 用户 user_id */ + user_id?: string + /** 用户手机号 */ + mobile?: string + /** 当前企业标识 */ + tenant_key?: string + /** `refresh_token` 的有效期，单位: 秒 */ + refresh_expires_in?: number + /** 刷新用户 `access_token` 时使用的 token */ + refresh_token?: string + /** 用户当前登录态session的唯一标识，为空则不返回 */ + sid?: string +} + +Internal.define({ + '/open-apis/authen/v1/user_info': { + GET: 'getAuthenUserInfo', + }, + '/open-apis/authen/v1/oidc/access_token': { + POST: 'createAuthenOidcAccessToken', + }, + '/open-apis/authen/v1/oidc/refresh_access_token': { + POST: 'createAuthenOidcRefreshAccessToken', + }, + '/open-apis/authen/v1/access_token': { + POST: 'createAuthenAccessToken', + }, + '/open-apis/authen/v1/refresh_access_token': { + POST: 'createAuthenRefreshAccessToken', + }, +}) diff --git a/adapters/lark/src/types/baike.ts b/adapters/lark/src/types/baike.ts new file mode 100644 index 00000000..eed4a366 --- /dev/null +++ b/adapters/lark/src/types/baike.ts @@ -0,0 +1,321 @@ +import { Internal } from '../internal' +import { Classification, ClassificationFilter, Draft, Entity, EntityWord, MatchInfo, OuterInfo, Phrase, RelatedMeta, Term } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建草稿 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/create + */ + createBaikeDraft(body: CreateBaikeDraftRequest, query?: CreateBaikeDraftQuery): Promise + /** + * 更新草稿 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/update + */ + updateBaikeDraft(draft_id: string, body: UpdateBaikeDraftRequest, query?: UpdateBaikeDraftQuery): Promise + /** + * 创建免审词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create + */ + createBaikeEntity(body: CreateBaikeEntityRequest, query?: CreateBaikeEntityQuery): Promise + /** + * 更新免审词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update + */ + updateBaikeEntity(entity_id: string, body: UpdateBaikeEntityRequest, query?: UpdateBaikeEntityQuery): Promise + /** + * 获取词条详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get + */ + getBaikeEntity(entity_id: string, query?: GetBaikeEntityQuery): Promise + /** + * 获取词条列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list + */ + listBaikeEntity(query?: ListBaikeEntityQuery): Promise + /** + * 精准搜索词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match + */ + matchBaikeEntity(body: MatchBaikeEntityRequest): Promise + /** + * 模糊搜索词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search + */ + searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise + /** + * 词条高亮 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight + */ + highlightBaikeEntity(body: HighlightBaikeEntityRequest): Promise + /** + * 提取潜在的词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract + */ + extractBaikeEntity(body: ExtractBaikeEntityRequest): Promise + /** + * 获取词典分类 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list + */ + listBaikeClassification(query?: ListBaikeClassificationQuery): Promise + /** + * 上传图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload + */ + uploadBaikeFile(form: UploadBaikeFileForm): Promise + /** + * 下载图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/download + */ + downloadBaikeFile(file_token: string): Promise + } +} + +export interface CreateBaikeDraftRequest { + /** 实体词 Id */ + id?: string + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 外部 id 关联数据 */ + outer_info?: OuterInfo + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string +} + +export interface CreateBaikeDraftQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateBaikeDraftRequest { + /** 实体词 Id */ + id?: string + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string +} + +export interface UpdateBaikeDraftQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateBaikeEntityRequest { + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 外部 id 关联数据 */ + outer_info?: OuterInfo + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string +} + +export interface CreateBaikeEntityQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateBaikeEntityRequest { + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 外部 id 关联数据 */ + outer_info?: OuterInfo + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string +} + +export interface UpdateBaikeEntityQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetBaikeEntityQuery { + /** 外部系统 */ + provider?: string + /** 词条在外部系统中对应的唯一 ID */ + outer_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListBaikeEntityQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 相关外部系统【可用来过滤词条数据】 */ + provider?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface MatchBaikeEntityRequest { + /** 搜索关键词，将与词条名、别名进行精准匹配 */ + word: string +} + +export interface SearchBaikeEntityRequest { + /** 搜索关键词 */ + query?: string + /** 分类筛选 */ + classification_filter?: ClassificationFilter + /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */ + sources?: number[] + /** 创建者 */ + creators?: string[] +} + +export interface SearchBaikeEntityQuery { + /** 每页返回的词条量 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface HighlightBaikeEntityRequest { + /** 需要识别百科词条的内容（不超过1000字） */ + text: string +} + +export interface ExtractBaikeEntityRequest { + /** 需要被提取百科实体词的文本（不会过滤租户已成为百科词条的内容） */ + text?: string +} + +export interface ListBaikeClassificationQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: 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[] + /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ + page_token?: string +} + +export interface HighlightBaikeEntityResponse { + /** 返回识别到的实体词信息 */ + phrases?: Phrase[] +} + +export interface ExtractBaikeEntityResponse { + /** 文本中可能的成为百科词条的实体词 */ + entity_word: EntityWord[] +} + +export interface ListBaikeClassificationResponse { + items?: Classification[] + /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ + page_token?: string +} + +export interface UploadBaikeFileResponse { + /** 文件 token */ + file_token?: string +} + +Internal.define({ + '/open-apis/baike/v1/drafts': { + POST: 'createBaikeDraft', + }, + '/open-apis/baike/v1/drafts/{draft_id}': { + PUT: 'updateBaikeDraft', + }, + '/open-apis/baike/v1/entities': { + POST: 'createBaikeEntity', + GET: 'listBaikeEntity', + }, + '/open-apis/baike/v1/entities/{entity_id}': { + PUT: 'updateBaikeEntity', + GET: 'getBaikeEntity', + }, + '/open-apis/baike/v1/entities/match': { + POST: 'matchBaikeEntity', + }, + '/open-apis/baike/v1/entities/search': { + POST: 'searchBaikeEntity', + }, + '/open-apis/baike/v1/entities/highlight': { + POST: 'highlightBaikeEntity', + }, + '/open-apis/baike/v1/entities/extract': { + POST: 'extractBaikeEntity', + }, + '/open-apis/baike/v1/classifications': { + GET: 'listBaikeClassification', + }, + '/open-apis/baike/v1/files/upload': { + POST: { name: 'uploadBaikeFile', multipart: true }, + }, + '/open-apis/baike/v1/files/{file_token}/download': { + GET: { name: 'downloadBaikeFile', type: 'binary' }, + }, +}) diff --git a/adapters/lark/src/types/bitable.ts b/adapters/lark/src/types/bitable.ts new file mode 100644 index 00000000..75c94d62 --- /dev/null +++ b/adapters/lark/src/types/bitable.ts @@ -0,0 +1,946 @@ +import { Internal } from '../internal' +import { App, AppDashboard, AppRole, AppRoleBlockRole, AppRoleMember, AppRoleMemberId, AppRoleTableRole, AppTable, AppTableField, AppTableFieldDescription, AppTableFieldForList, AppTableFieldProperty, AppTableForm, AppTableFormField, AppTableFormPatchedField, AppTableRecord, AppTableView, AppTableViewProperty, AppWorkflow, DeleteRecord, DisplayApp, DisplayAppV2, FilterInfo, ReqTable, Sort } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建多维表格 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create + */ + createBitableApp(body: CreateBitableAppRequest): Promise + /** + * 复制多维表格 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy + */ + copyBitableApp(app_token: string, body: CopyBitableAppRequest): Promise + /** + * 获取多维表格元数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get + */ + getBitableApp(app_token: string): Promise + /** + * 更新多维表格元数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update + */ + updateBitableApp(app_token: string, body: UpdateBitableAppRequest): Promise + /** + * 新增一个数据表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create + */ + createBitableAppTable(app_token: string, body: CreateBitableAppTableRequest): Promise + /** + * 新增多个数据表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create + */ + batchCreateBitableAppTable(app_token: string, body: BatchCreateBitableAppTableRequest, query?: BatchCreateBitableAppTableQuery): Promise + /** + * 更新数据表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/patch + */ + patchBitableAppTable(app_token: string, table_id: string, body: PatchBitableAppTableRequest): Promise + /** + * 列出数据表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list + */ + listBitableAppTable(app_token: string, query?: ListBitableAppTableQuery): Promise + /** + * 删除一个数据表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete + */ + deleteBitableAppTable(app_token: string, table_id: string): Promise + /** + * 删除多个数据表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete + */ + batchDeleteBitableAppTable(app_token: string, body: BatchDeleteBitableAppTableRequest): Promise + /** + * 新增视图 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create + */ + createBitableAppTableView(app_token: string, table_id: string, body: CreateBitableAppTableViewRequest): Promise + /** + * 更新视图 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch + */ + patchBitableAppTableView(app_token: string, table_id: string, view_id: string, body: PatchBitableAppTableViewRequest): Promise + /** + * 列出视图 + * @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 + /** + * 获取视图 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get + */ + getBitableAppTableView(app_token: string, table_id: string, view_id: string): Promise + /** + * 删除视图 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete + */ + deleteBitableAppTableView(app_token: string, table_id: string, view_id: string): Promise + /** + * 新增记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create + */ + createBitableAppTableRecord(app_token: string, table_id: string, body: CreateBitableAppTableRecordRequest, query?: CreateBitableAppTableRecordQuery): Promise + /** + * 更新记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/update + */ + updateBitableAppTableRecord(app_token: string, table_id: string, record_id: string, body: UpdateBitableAppTableRecordRequest, query?: UpdateBitableAppTableRecordQuery): Promise + /** + * 查询记录 + * @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 + /** + * 删除记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete + */ + deleteBitableAppTableRecord(app_token: string, table_id: string, record_id: string): Promise + /** + * 新增多条记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_create + */ + batchCreateBitableAppTableRecord(app_token: string, table_id: string, body: BatchCreateBitableAppTableRecordRequest, query?: BatchCreateBitableAppTableRecordQuery): Promise + /** + * 更新多条记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_update + */ + batchUpdateBitableAppTableRecord(app_token: string, table_id: string, body: BatchUpdateBitableAppTableRecordRequest, query?: BatchUpdateBitableAppTableRecordQuery): Promise + /** + * 批量获取记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_get + */ + batchGetBitableAppTableRecord(app_token: string, table_id: string, body: BatchGetBitableAppTableRecordRequest): Promise + /** + * 删除多条记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_delete + */ + batchDeleteBitableAppTableRecord(app_token: string, table_id: string, body: BatchDeleteBitableAppTableRecordRequest): Promise + /** + * 新增字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/create + */ + createBitableAppTableField(app_token: string, table_id: string, body: CreateBitableAppTableFieldRequest, query?: CreateBitableAppTableFieldQuery): Promise + /** + * 更新字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/update + */ + updateBitableAppTableField(app_token: string, table_id: string, field_id: string, body: UpdateBitableAppTableFieldRequest): Promise + /** + * 列出字段 + * @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 + /** + * 删除字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete + */ + deleteBitableAppTableField(app_token: string, table_id: string, field_id: string): Promise + /** + * 复制仪表盘 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/copy + */ + copyBitableAppDashboard(app_token: string, block_id: string, body: CopyBitableAppDashboardRequest): Promise + /** + * 列出仪表盘 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list + */ + listBitableAppDashboard(app_token: string, query?: ListBitableAppDashboardQuery): Promise + /** + * 更新表单元数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch + */ + patchBitableAppTableForm(app_token: string, table_id: string, form_id: string, body: PatchBitableAppTableFormRequest): Promise + /** + * 获取表单元数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/get + */ + getBitableAppTableForm(app_token: string, table_id: string, form_id: string): Promise + /** + * 更新表单问题 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/patch + */ + patchBitableAppTableFormField(app_token: string, table_id: string, form_id: string, field_id: string, body: PatchBitableAppTableFormFieldRequest): Promise + /** + * 列出表单问题 + * @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?: ListBitableAppTableFormFieldQuery): Promise + /** + * 列出自定义角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list + */ + listBitableAppRole(app_token: string, query?: ListBitableAppRoleQuery): Promise + /** + * 新增自定义角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create + */ + createBitableAppRole(app_token: string, body: CreateBitableAppRoleRequest): Promise + /** + * 删除自定义角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete + */ + deleteBitableAppRole(app_token: string, role_id: string): Promise + /** + * 更新自定义角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/update + */ + updateBitableAppRole(app_token: string, role_id: string, body: UpdateBitableAppRoleRequest): Promise + /** + * 批量删除协作者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete + */ + batchDeleteBitableAppRoleMember(app_token: string, role_id: string, body: BatchDeleteBitableAppRoleMemberRequest): Promise + /** + * 批量新增协作者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_create + */ + batchCreateBitableAppRoleMember(app_token: string, role_id: string, body: BatchCreateBitableAppRoleMemberRequest): Promise + /** + * 列出协作者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list + */ + listBitableAppRoleMember(app_token: string, role_id: string, query?: ListBitableAppRoleMemberQuery): Promise + /** + * 新增协作者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create + */ + createBitableAppRoleMember(app_token: string, role_id: string, body: CreateBitableAppRoleMemberRequest, query?: CreateBitableAppRoleMemberQuery): Promise + /** + * 删除协作者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete + */ + deleteBitableAppRoleMember(app_token: string, role_id: string, member_id: string, query?: DeleteBitableAppRoleMemberQuery): Promise + /** + * 列出自动化流程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/list + */ + listBitableAppWorkflow(app_token: string, query?: ListBitableAppWorkflowQuery): Promise + /** + * 更新自动化流程状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/update + */ + updateBitableAppWorkflow(app_token: string, workflow_id: string, body: UpdateBitableAppWorkflowRequest): Promise + /** + * 检索记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/get + */ + getBitableAppTableRecord(app_token: string, table_id: string, record_id: string, query?: GetBitableAppTableRecordQuery): Promise + /** + * 列出记录 + * @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 + } +} + +export interface CreateBitableAppRequest { + /** 多维表格App名字 */ + name?: string + /** 多维表格App归属文件夹 */ + folder_token?: string + /** 文档时区，说明见：https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */ + time_zone?: string +} + +export interface CopyBitableAppRequest { + /** 多维表格 App 名字 */ + name?: string + /** 多维表格 App 归属文件夹 */ + folder_token?: string + /** 不复制文档内容，只复制文档结构 */ + without_content?: boolean + /** 文档时区，说明见：https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */ + time_zone?: string +} + +export interface UpdateBitableAppRequest { + /** 新的多维表格名字 */ + name?: string + /** 多维表格是否开启高级权限 */ + is_advanced?: boolean +} + +export interface CreateBitableAppTableRequest { + /** 数据表 */ + table?: ReqTable +} + +export interface BatchCreateBitableAppTableRequest { + /** tables */ + tables?: ReqTable[] +} + +export interface BatchCreateBitableAppTableQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchBitableAppTableRequest { + /** 数据表的新名称 */ + name?: string +} + +export interface ListBitableAppTableQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface BatchDeleteBitableAppTableRequest { + /** 删除的多条tableid列表 */ + table_ids?: string[] +} + +export interface CreateBitableAppTableViewRequest { + /** 视图名字 */ + view_name: string + /** 视图类型 */ + view_type?: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form' +} + +export interface PatchBitableAppTableViewRequest { + /** 视图名称 */ + view_name?: string + /** 视图属性 */ + property?: AppTableViewProperty +} + +export interface ListBitableAppTableViewQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateBitableAppTableRecordRequest { + /** 记录字段 */ + fields: unknown +} + +export interface CreateBitableAppTableRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 格式为标准的 uuid，操作的唯一标识，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string + /** 用于控制一致性读写，默认开启检查 */ + ignore_consistency_check?: boolean +} + +export interface UpdateBitableAppTableRecordRequest { + /** 记录字段 */ + fields: unknown +} + +export interface UpdateBitableAppTableRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 用于控制一致性读写，默认开启检查 */ + ignore_consistency_check?: boolean +} + +export interface SearchBitableAppTableRecordRequest { + /** 视图Id,指定视图id则按照视图的筛选排序结果返回数据 */ + view_id?: string + /** 指定要返回的字段 */ + field_names?: string[] + /** 排序条件 */ + sort?: Sort[] + /** 筛选条件 */ + filter?: FilterInfo + /** 控制是否返回自动计算的字段, true 表示返回 */ + automatic_fields?: boolean +} + +export interface SearchBitableAppTableRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface BatchCreateBitableAppTableRecordRequest { + /** 记录 */ + records: AppTableRecord[] +} + +export interface BatchCreateBitableAppTableRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 格式为标准的 uuid，操作的唯一标识，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string + /** 用于控制一致性读写，默认开启检查 */ + ignore_consistency_check?: boolean +} + +export interface BatchUpdateBitableAppTableRecordRequest { + /** 记录 */ + records: AppTableRecord[] +} + +export interface BatchUpdateBitableAppTableRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 用于控制一致性读写，默认开启检查 */ + ignore_consistency_check?: boolean +} + +export interface BatchGetBitableAppTableRecordRequest { + /** 记录 id 列表 */ + record_ids: string[] + /** 此次调用中使用的用户 id 的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 控制是否返回记录的分享链接，true 表示返回分享链接 */ + with_shared_url?: boolean + /** 控制是否返回自动计算的字段，true 表示返回 */ + automatic_fields?: boolean +} + +export interface BatchDeleteBitableAppTableRecordRequest { + /** 删除的多条记录id列表 */ + records: string[] +} + +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 + /** 字段属性 */ + property?: AppTableFieldProperty + /** 字段的描述 */ + description?: AppTableFieldDescription + /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ + 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 CreateBitableAppTableFieldQuery { + /** 格式为标准的 uuid，操作的唯一标识，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string +} + +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 + /** 字段属性 */ + property?: AppTableFieldProperty + /** 字段的描述 */ + description?: AppTableFieldDescription + /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ + ui_type?: 'Text' | 'Email' | 'Barcode' | 'Number' | 'Progress' | 'Currency' | 'Rating' | 'SingleSelect' | 'MultiSelect' | 'DateTime' | 'Checkbox' | 'User' | 'GroupChat' | 'Phone' | 'Url' | 'Attachment' | 'SingleLink' | 'Formula' | 'DuplexLink' | 'Location' | 'CreatedTime' | 'ModifiedTime' | 'CreatedUser' | 'ModifiedUser' | 'AutoNumber' +} + +export interface ListBitableAppTableFieldQuery { + /** 视图 ID */ + view_id?: string + /** 控制字段描述（多行文本格式）数据的返回格式, true 表示以数组富文本形式返回 */ + text_field_as_array?: boolean + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CopyBitableAppDashboardRequest { + /** 仪表盘名称 */ + name: string +} + +export interface ListBitableAppDashboardQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface PatchBitableAppTableFormRequest { + /** 表单名称 */ + name?: string + /** 表单描述 */ + description?: string + /** 是否开启共享 */ + shared?: boolean + /** 分享范围限制 */ + shared_limit?: 'off' | 'tenant_editable' | 'anyone_editable' + /** 填写次数限制一次 */ + submit_limit_once?: boolean +} + +export interface PatchBitableAppTableFormFieldRequest { + /** 上一个表单问题 ID */ + pre_field_id?: string + /** 表单问题 */ + title?: string + /** 问题描述 */ + description?: string + /** 是否必填 */ + required?: boolean + /** 是否可见 */ + visible?: boolean +} + +export interface ListBitableAppTableFormFieldQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListBitableAppRoleQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateBitableAppRoleRequest { + /** 自定义权限的名字 */ + role_name: string + /** 数据表权限 */ + table_roles: AppRoleTableRole[] + /** block权限 */ + block_roles?: AppRoleBlockRole[] +} + +export interface UpdateBitableAppRoleRequest { + /** 自定义权限的名字 */ + role_name: string + /** 数据表权限 */ + table_roles: AppRoleTableRole[] + /** block权限 */ + block_roles?: AppRoleBlockRole[] +} + +export interface BatchDeleteBitableAppRoleMemberRequest { + /** 协作者列表 */ + member_list: AppRoleMemberId[] +} + +export interface BatchCreateBitableAppRoleMemberRequest { + /** 协作者列表 */ + member_list: AppRoleMemberId[] +} + +export interface ListBitableAppRoleMemberQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateBitableAppRoleMemberRequest { + /** 协作者id */ + member_id: string +} + +export interface CreateBitableAppRoleMemberQuery { + /** 协作者id类型，与请求体中的member_id要对应 */ + member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id' +} + +export interface DeleteBitableAppRoleMemberQuery { + /** 协作者id类型，与请求体中的member_id要对应 */ + member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id' +} + +export interface ListBitableAppWorkflowQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface UpdateBitableAppWorkflowRequest { + /** 自动化状态 */ + status: string +} + +export interface GetBitableAppTableRecordQuery { + /** 控制多行文本字段数据的返回格式, true 表示以数组形式返回 */ + text_field_as_array?: boolean + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 控制公式、查找引用是否显示完整的原样返回结果 */ + display_formula_ref?: boolean + /** 控制是否返回该记录的链接 */ + with_shared_url?: boolean + /** 控制是否返回自动计算的字段，例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`，true 表示返回 */ + automatic_fields?: boolean +} + +export interface ListBitableAppTableRecordQuery { + /** 视图 id注意：如 filter 或 sort 有值，view_id 会被忽略。 */ + view_id?: string + /** 筛选参数注意：1.筛选记录的表达式不超过2000个字符。2.不支持对“人员”以及“关联字段”的属性进行过滤筛选，如人员的 OpenID。3.仅支持字段在页面展示字符值进行筛选。详细请参考[记录筛选开发指南](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter) */ + filter?: string + /** 排序参数注意：1.表达式需要不超过1000字符。2.不支持对带“公式”和“关联字段”的表的使用。3.使用引号将字段名称和顺序逆序连接起来。 */ + sort?: string + /** 字段名称 */ + field_names?: string + /** 控制多行文本字段数据的返回格式，true 表示以数组形式返回。注意：1.多行文本中如果有超链接部分，则会返回链接的 URL。2.目前可以返回多行文本中 URL 类型为多维表格链接、飞书 doc、飞书 sheet的URL类型以及@人员的数据结构。 */ + text_field_as_array?: boolean + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 控制公式、查找引用是否显示完整的原样返回结果 */ + display_formula_ref?: boolean + /** 控制是否返回自动计算的字段，例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`，true 表示返回 */ + automatic_fields?: boolean + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateBitableAppResponse { + 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 ListBitableAppDashboardResponse { + /** 仪表盘信息 */ + dashboards: AppDashboard[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token: string + /** 是否还有更多项 */ + has_more: boolean +} + +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 ListBitableAppRoleResponse { + /** 角色列表 */ + items?: AppRole[] + /** 下一页分页的token */ + page_token?: string + /** 是否有下一页数据 */ + has_more?: boolean + /** 总数 */ + total?: number +} + +export interface CreateBitableAppRoleResponse { + role?: AppRole +} + +export interface UpdateBitableAppRoleResponse { + role?: AppRole +} + +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 + /** 下一页分页的token */ + page_token?: string + /** 总数 */ + total?: number + items?: AppTableRecord[] +} + +Internal.define({ + '/open-apis/bitable/v1/apps': { + POST: 'createBitableApp', + }, + '/open-apis/bitable/v1/apps/{app_token}/copy': { + POST: 'copyBitableApp', + }, + '/open-apis/bitable/v1/apps/{app_token}': { + GET: 'getBitableApp', + PUT: 'updateBitableApp', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables': { + POST: 'createBitableAppTable', + GET: 'listBitableAppTable', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/batch_create': { + POST: 'batchCreateBitableAppTable', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}': { + PATCH: 'patchBitableAppTable', + DELETE: 'deleteBitableAppTable', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/batch_delete': { + POST: 'batchDeleteBitableAppTable', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/views': { + POST: 'createBitableAppTableView', + GET: 'listBitableAppTableView', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/views/{view_id}': { + PATCH: 'patchBitableAppTableView', + GET: 'getBitableAppTableView', + DELETE: 'deleteBitableAppTableView', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records': { + POST: 'createBitableAppTableRecord', + GET: 'listBitableAppTableRecord', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}': { + PUT: 'updateBitableAppTableRecord', + DELETE: 'deleteBitableAppTableRecord', + GET: 'getBitableAppTableRecord', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/search': { + POST: 'searchBitableAppTableRecord', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_create': { + POST: 'batchCreateBitableAppTableRecord', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_update': { + POST: 'batchUpdateBitableAppTableRecord', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_get': { + POST: 'batchGetBitableAppTableRecord', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_delete': { + POST: 'batchDeleteBitableAppTableRecord', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/fields': { + POST: 'createBitableAppTableField', + GET: 'listBitableAppTableField', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/fields/{field_id}': { + PUT: 'updateBitableAppTableField', + DELETE: 'deleteBitableAppTableField', + }, + '/open-apis/bitable/v1/apps/{app_token}/dashboards/{block_id}/copy': { + POST: 'copyBitableAppDashboard', + }, + '/open-apis/bitable/v1/apps/{app_token}/dashboards': { + GET: 'listBitableAppDashboard', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}': { + PATCH: 'patchBitableAppTableForm', + GET: 'getBitableAppTableForm', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}/fields/{field_id}': { + PATCH: 'patchBitableAppTableFormField', + }, + '/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/forms/{form_id}/fields': { + GET: 'listBitableAppTableFormField', + }, + '/open-apis/bitable/v1/apps/{app_token}/roles': { + GET: 'listBitableAppRole', + POST: 'createBitableAppRole', + }, + '/open-apis/bitable/v1/apps/{app_token}/roles/{role_id}': { + DELETE: 'deleteBitableAppRole', + PUT: 'updateBitableAppRole', + }, + '/open-apis/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_delete': { + POST: 'batchDeleteBitableAppRoleMember', + }, + '/open-apis/bitable/v1/apps/{app_token}/roles/{role_id}/members/batch_create': { + POST: 'batchCreateBitableAppRoleMember', + }, + '/open-apis/bitable/v1/apps/{app_token}/roles/{role_id}/members': { + GET: 'listBitableAppRoleMember', + POST: 'createBitableAppRoleMember', + }, + '/open-apis/bitable/v1/apps/{app_token}/roles/{role_id}/members/{member_id}': { + DELETE: 'deleteBitableAppRoleMember', + }, + '/open-apis/bitable/v1/apps/{app_token}/workflows': { + GET: 'listBitableAppWorkflow', + }, + '/open-apis/bitable/v1/apps/{app_token}/workflows/{workflow_id}': { + PUT: 'updateBitableAppWorkflow', + }, +}) diff --git a/adapters/lark/src/types/board.ts b/adapters/lark/src/types/board.ts new file mode 100644 index 00000000..03c76cc1 --- /dev/null +++ b/adapters/lark/src/types/board.ts @@ -0,0 +1,31 @@ +import { Internal } from '../internal' +import { WhiteboardNode } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取所有节点 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/list + */ + listBoardWhiteboardNode(whiteboard_id: string): Promise + /** + * 获取画板缩略图片 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/download_as_image + */ + downloadAsImageBoardWhiteboard(whiteboard_id: string): Promise + } +} + +export interface ListBoardWhiteboardNodeResponse { + /** 查询结果 */ + nodes?: WhiteboardNode[] +} + +Internal.define({ + '/open-apis/board/v1/whiteboards/{whiteboard_id}/nodes': { + GET: 'listBoardWhiteboardNode', + }, + '/open-apis/board/v1/whiteboards/{whiteboard_id}/download_as_image': { + GET: { name: 'downloadAsImageBoardWhiteboard', type: 'binary' }, + }, +}) diff --git a/adapters/lark/src/types/calendar.ts b/adapters/lark/src/types/calendar.ts new file mode 100644 index 00000000..a54a4ed5 --- /dev/null +++ b/adapters/lark/src/types/calendar.ts @@ -0,0 +1,886 @@ +import { Internal } from '../internal' +import { AclScope, Attachment, Calendar, CalendarAcl, CalendarEvent, CalendarEventAttendee, CalendarEventAttendeeChatMember, CalendarEventAttendeeId, EventLocation, EventSearchFilter, Freebusy, Instance, Reminder, Schema, TimeInfo, UserCalendar, Vchat } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建共享日历 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/create + */ + createCalendar(body: CreateCalendarRequest): Promise + /** + * 删除共享日历 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/delete + */ + deleteCalendar(calendar_id: string): Promise + /** + * 查询主日历信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary + */ + primaryCalendar(query?: PrimaryCalendarQuery): Promise + /** + * 查询日历信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get + */ + getCalendar(calendar_id: string): Promise + /** + * 查询主日历日程忙闲信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/list + */ + listCalendarFreebusy(body: ListCalendarFreebusyRequest, query?: ListCalendarFreebusyQuery): Promise + /** + * 查询日历列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list + */ + listCalendar(query?: ListCalendarQuery): Promise + /** + * 更新日历信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/patch + */ + patchCalendar(calendar_id: string, body: PatchCalendarRequest): Promise + /** + * 搜索日历 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/search + */ + searchCalendar(body: SearchCalendarRequest, query?: SearchCalendarQuery): Promise + /** + * 订阅日历 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscribe + */ + subscribeCalendar(calendar_id: string): Promise + /** + * 取消订阅日历 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscribe + */ + unsubscribeCalendar(calendar_id: string): Promise + /** + * 订阅日历变更事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscription + */ + subscriptionCalendar(): Promise + /** + * 取消订阅日历变更事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscription + */ + unsubscriptionCalendar(): Promise + /** + * 创建访问控制 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/create + */ + createCalendarCalendarAcl(calendar_id: string, body: CreateCalendarCalendarAclRequest, query?: CreateCalendarCalendarAclQuery): Promise + /** + * 删除访问控制 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/delete + */ + deleteCalendarCalendarAcl(calendar_id: string, acl_id: string): Promise + /** + * 获取访问控制列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/list + */ + listCalendarCalendarAcl(calendar_id: string, query?: ListCalendarCalendarAclQuery): Promise + /** + * 订阅日历访问控制变更事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/subscription + */ + subscriptionCalendarCalendarAcl(calendar_id: string): Promise + /** + * 取消订阅日历访问控制变更事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/unsubscription + */ + unsubscriptionCalendarCalendarAcl(calendar_id: string): Promise + /** + * 创建日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/create + */ + createCalendarCalendarEvent(calendar_id: string, body: CreateCalendarCalendarEventRequest, query?: CreateCalendarCalendarEventQuery): Promise + /** + * 删除日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/delete + */ + deleteCalendarCalendarEvent(calendar_id: string, event_id: string, query?: DeleteCalendarCalendarEventQuery): Promise + /** + * 更新日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/patch + */ + patchCalendarCalendarEvent(calendar_id: string, event_id: string, body: PatchCalendarCalendarEventRequest, query?: PatchCalendarCalendarEventQuery): Promise + /** + * 获取日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/get + */ + getCalendarCalendarEvent(calendar_id: string, event_id: string, query?: GetCalendarCalendarEventQuery): Promise + /** + * 获取日程列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/list + */ + listCalendarCalendarEvent(calendar_id: string, query?: ListCalendarCalendarEventQuery): Promise + /** + * 搜索日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search + */ + searchCalendarCalendarEvent(calendar_id: string, body: SearchCalendarCalendarEventRequest, query?: SearchCalendarCalendarEventQuery): Promise + /** + * 订阅日程变更事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/subscription + */ + subscriptionCalendarCalendarEvent(calendar_id: string): Promise + /** + * 取消订阅日程变更事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/unsubscription + */ + unsubscriptionCalendarCalendarEvent(calendar_id: string): Promise + /** + * 回复日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/reply + */ + replyCalendarCalendarEvent(calendar_id: string, event_id: string, body: ReplyCalendarCalendarEventRequest): Promise + /** + * 获取重复日程实例 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instances + */ + instancesCalendarCalendarEvent(calendar_id: string, event_id: string, query?: InstancesCalendarCalendarEventQuery): Promise + /** + * 查询日程视图 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instance_view + */ + instanceViewCalendarCalendarEvent(calendar_id: string, query?: InstanceViewCalendarCalendarEventQuery): Promise + /** + * 创建会议群 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_chat/create + */ + createCalendarCalendarEventMeetingChat(calendar_id: string, event_id: string): Promise + /** + * 解绑会议群 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_chat/delete + */ + deleteCalendarCalendarEventMeetingChat(calendar_id: string, event_id: string, query?: DeleteCalendarCalendarEventMeetingChatQuery): Promise + /** + * 创建会议纪要 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_minute/create + */ + createCalendarCalendarEventMeetingMinute(calendar_id: string, event_id: string): Promise + /** + * 创建请假日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/timeoff_event/create + */ + createCalendarTimeoffEvent(body: CreateCalendarTimeoffEventRequest, query?: CreateCalendarTimeoffEventQuery): Promise + /** + * 删除请假日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/timeoff_event/delete + */ + deleteCalendarTimeoffEvent(timeoff_event_id: string): Promise + /** + * 添加日程参与人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/create + */ + createCalendarCalendarEventAttendee(calendar_id: string, event_id: string, body: CreateCalendarCalendarEventAttendeeRequest, query?: CreateCalendarCalendarEventAttendeeQuery): Promise + /** + * 删除日程参与人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/batch_delete + */ + batchDeleteCalendarCalendarEventAttendee(calendar_id: string, event_id: string, body: BatchDeleteCalendarCalendarEventAttendeeRequest, query?: BatchDeleteCalendarCalendarEventAttendeeQuery): Promise + /** + * 获取日程参与人列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/list + */ + listCalendarCalendarEventAttendee(calendar_id: string, event_id: string, query?: ListCalendarCalendarEventAttendeeQuery): Promise + /** + * 获取日程参与群成员列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list + */ + listCalendarCalendarEventAttendeeChatMember(calendar_id: string, event_id: string, attendee_id: string, query?: ListCalendarCalendarEventAttendeeChatMemberQuery): Promise + /** + * 生成 CalDAV 配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/setting/generate_caldav_conf + */ + generateCaldavConfCalendarSetting(body: GenerateCaldavConfCalendarSettingRequest): Promise + /** + * 将 Exchange 账户绑定到飞书账户 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/create + */ + createCalendarExchangeBinding(body: CreateCalendarExchangeBindingRequest, query?: CreateCalendarExchangeBindingQuery): Promise + /** + * 解除 Exchange 账户绑定 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/delete + */ + deleteCalendarExchangeBinding(exchange_binding_id: string): Promise + /** + * 查询 Exchange 账户的绑定状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/get + */ + getCalendarExchangeBinding(exchange_binding_id: string, query?: GetCalendarExchangeBindingQuery): Promise + } +} + +export interface CreateCalendarRequest { + /** 日历标题 */ + summary?: string + /** 日历描述 */ + description?: string + /** 权限 */ + permissions?: 'private' | 'show_only_free_busy' | 'public' + /** 日历颜色，颜色RGB值的int32表示。客户端展示时会映射到色板上最接近的一种颜色。仅对当前身份生效 */ + color?: number + /** 日历备注名，修改或添加后仅对当前身份生效 */ + summary_alias?: string +} + +export interface PrimaryCalendarQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListCalendarFreebusyRequest { + /** 查询时段开始时间，需要url编码 */ + time_min: string + /** 查询时段结束时间，需要url编码 */ + time_max: string + /** 用户user_id，输入时与 room_id 二选一。参见[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ + user_id?: string + /** 会议室room_id，输入时与 user_id 二选一 */ + room_id?: string + /** 是否包含绑定的三方日历中的日程，不传默认为true，即包含。 */ + include_external_calendar?: boolean + /** 是否包含标记为空闲的日程，不传默认为true，即包含。 */ + only_busy?: boolean +} + +export interface ListCalendarFreebusyQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListCalendarQuery { + /** 一次请求要求返回最大数量，默认500，取值范围为[50. 1000] */ + page_size?: number + /** 上次请求Response返回的分页标记，首次请求时为空 */ + page_token?: string + /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ + sync_token?: string +} + +export interface PatchCalendarRequest { + /** 标题 */ + summary?: string + /** 日历描述 */ + description?: string + /** 权限 */ + permissions?: 'private' | 'show_only_free_busy' | 'public' + /** 日历颜色，颜色RGB值的int32表示。客户端展示时会映射到色板上最接近的一种颜色。仅对当前身份生效 */ + color?: number + /** 日历备注名，修改或添加后仅对当前身份生效 */ + summary_alias?: string +} + +export interface SearchCalendarRequest { + /** 搜索关键字 */ + query: string +} + +export interface SearchCalendarQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateCalendarCalendarAclRequest { + /** 对日历的访问权限 */ + role: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner' + /** 权限范围 */ + scope: AclScope +} + +export interface CreateCalendarCalendarAclQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListCalendarCalendarAclQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateCalendarCalendarEventRequest { + /** 日程标题 */ + summary?: string + /** 日程描述 */ + description?: string + /** 是否发送通知消息 */ + need_notification?: boolean + /** 日程开始时间 */ + start_time: TimeInfo + /** 日程结束时间 */ + end_time: TimeInfo + /** 视频会议信息，仅当日程至少有一位attendee时生效 */ + vchat?: Vchat + /** 日程公开范围，新建日程默认为Default；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ + visibility?: 'default' | 'public' | 'private' + /** 参与人权限 */ + attendee_ability?: 'none' | 'can_see_others' | 'can_invite_others' | 'can_modify_event' + /** 日程占用的忙闲状态，新建日程默认为Busy；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ + free_busy_status?: 'busy' | 'free' + /** 日程地点 */ + location?: EventLocation + /** 日程颜色，颜色RGB值的int32表示。仅对当前身份生效；客户端展示时会映射到色板上最接近的一种颜色；值为0或-1时默认跟随日历颜色。 */ + color?: number + /** 日程提醒列表 */ + reminders?: Reminder[] + /** 重复日程的重复性规则 */ + recurrence?: string + /** 日程自定义信息 */ + schemas?: Schema[] + /** 日程附件 */ + attachments?: Attachment[] +} + +export interface CreateCalendarCalendarEventQuery { + /** 幂等唯一key */ + idempotency_key?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteCalendarCalendarEventQuery { + /** 删除日程是否给日程参与人发送bot通知，默认为true */ + need_notification?: 'true' | 'false' +} + +export interface PatchCalendarCalendarEventRequest { + /** 日程标题 */ + summary?: string + /** 日程描述 */ + description?: string + /** 是否发送通知消息 */ + need_notification?: boolean + /** 日程开始时间 */ + start_time?: TimeInfo + /** 日程结束时间 */ + end_time?: TimeInfo + /** 视频会议信息，仅当日程至少有一位attendee时生效 */ + vchat?: Vchat + /** 日程公开范围，新建日程默认为Default；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ + visibility?: 'default' | 'public' | 'private' + /** 参与人权限 */ + attendee_ability?: 'none' | 'can_see_others' | 'can_invite_others' | 'can_modify_event' + /** 日程占用的忙闲状态，新建日程默认为Busy；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ + free_busy_status?: 'busy' | 'free' + /** 日程地点 */ + location?: EventLocation + /** 日程颜色，颜色RGB值的int32表示。仅对当前身份生效；客户端展示时会映射到色板上最接近的一种颜色；值为0或-1时默认跟随日历颜色。 */ + color?: number + /** 日程提醒列表 */ + reminders?: Reminder[] + /** 重复日程的重复性规则 */ + recurrence?: string + /** 日程自定义信息 */ + schemas?: Schema[] + /** 日程附件 */ + attachments?: Attachment[] +} + +export interface PatchCalendarCalendarEventQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetCalendarCalendarEventQuery { + /** 是否需要返回会前设置 */ + need_meeting_settings?: boolean + /** 是否需要返回参与人信息 */ + need_attendee?: boolean + /** 返回的最大参与人数量 */ + max_attendee_num?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListCalendarCalendarEventQuery { + /** 一次请求要求返回最大数量，默认500，取值范围为[50, 1000] */ + page_size?: number + /** 拉取anchor_time之后的日程，为timestamp */ + anchor_time?: string + /** 上次请求Response返回的分页标记，首次请求时为空 */ + page_token?: string + /** 上次请求Response返回的增量同步标记，分页请求未结束时为空 */ + sync_token?: string + /** 日程开始Unix时间戳，单位为秒 */ + start_time?: string + /** 日程结束Unix时间戳，单位为秒 */ + end_time?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SearchCalendarCalendarEventRequest { + /** 搜索关键字 */ + query: string + /** 搜索过滤器 */ + filter?: EventSearchFilter +} + +export interface SearchCalendarCalendarEventQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface ReplyCalendarCalendarEventRequest { + /** rsvp-日程状态 */ + rsvp_status: 'accept' | 'decline' | 'tentative' +} + +export interface InstancesCalendarCalendarEventQuery { + /** 日程实例开始Unix时间戳，单位为秒,日程的end_time的下限（不包含） */ + start_time: string + /** 日程实例结束Unix时间戳，单位为秒,日程的start_time上限（不包含） */ + end_time: string + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface InstanceViewCalendarCalendarEventQuery { + /** 日程开始Unix时间戳，单位为秒 */ + start_time: string + /** 日程结束Unix时间戳，单位为秒 */ + end_time: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteCalendarCalendarEventMeetingChatQuery { + /** 会议群ID */ + meeting_chat_id: string +} + +export interface CreateCalendarTimeoffEventRequest { + /** 用户的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 CreateCalendarTimeoffEventQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateCalendarCalendarEventAttendeeRequest { + /** 新增参与人列表；
- 单次请求会议室的数量限制为100。 */ + attendees?: CalendarEventAttendee[] + /** 是否给参与人发送bot通知 默认为true */ + need_notification?: boolean + /** 使用管理员身份访问时要修改的实例(仅用于重复日程修改其中的一个实例，非重复日程无需填此字段) */ + instance_start_time_admin?: string + /** 是否启用管理员身份(需先在管理后台设置某人为会议室管理员) */ + is_enable_admin?: boolean + /** 是否添加会议室operate_id标识的用户到参与人 */ + add_operator_to_attendee?: boolean +} + +export interface CreateCalendarCalendarEventAttendeeQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchDeleteCalendarCalendarEventAttendeeRequest { + /** 要移除的参与人 ID 列表。参见[参与人ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/introduction#4998889c) */ + attendee_ids?: string[] + /** 需要删除的参与人类型实体ID，作为attendee_ids字段的补充。 */ + delete_ids?: CalendarEventAttendeeId[] + /** 删除日程参与人时是否要给参与人发送bot通知，默认为true */ + need_notification?: boolean + /** 使用管理员身份访问时要修改的实例 */ + instance_start_time_admin?: string + /** 是否启用管理员身份(需先在管理后台设置某人为会议室管理员) */ + is_enable_admin?: boolean +} + +export interface BatchDeleteCalendarCalendarEventAttendeeQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListCalendarCalendarEventAttendeeQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 是否需要会议室表单信息 */ + need_resource_customization?: boolean + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface ListCalendarCalendarEventAttendeeChatMemberQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GenerateCaldavConfCalendarSettingRequest { + /** 需要同步日历的设备名，在日历中展示用来管理密码 */ + device_name?: string +} + +export interface CreateCalendarExchangeBindingRequest { + /** admin账户 */ + admin_account?: string + /** 用户绑定的Exchange账户 */ + exchange_account?: string + /** Exchange账户绑定user唯一标识id */ + user_id?: string +} + +export interface CreateCalendarExchangeBindingQuery { + /** 此次调用中使用的用户ID的类型 */ + 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 ListCalendarCalendarAclResponse { + /** 入参日历对应的acl列表 */ + acls?: CalendarAcl[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下次请求需要带上的分页标记，90 天有效期 */ + page_token?: string +} + +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 InstancesCalendarCalendarEventResponse { + /** instances实例 */ + items?: Instance[] + page_token?: string + has_more?: boolean +} + +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 ListCalendarCalendarEventAttendeeResponse { + /** 日程的参与者列表 */ + items?: CalendarEventAttendee[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下次请求需要带上的分页标记，90 天有效期 */ + page_token?: string +} + +export interface ListCalendarCalendarEventAttendeeChatMemberResponse { + /** chat类型的参与人的群成员列表 */ + items?: CalendarEventAttendeeChatMember[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下次请求需要带上的分页标记 */ + page_token?: string +} + +export interface GenerateCaldavConfCalendarSettingResponse { + /** caldav密码 */ + password?: string + /** caldav用户名 */ + user_name?: string + /** 服务器地址 */ + server_address?: string + /** 设备名 */ + device_name?: string +} + +export interface CreateCalendarExchangeBindingResponse { + /** admin账户 */ + admin_account?: string + /** 用户绑定的Exchange账户 */ + exchange_account?: string + /** Exchange账户绑定user唯一标识id */ + user_id?: string + /** Exchange账户同步状态 */ + status?: 'doing' | 'cal_done' | 'timespan_done' | 'done' | 'err' + /** exchange绑定唯一标识id */ + exchange_binding_id: string +} + +export interface GetCalendarExchangeBindingResponse { + /** admin账户 */ + admin_account?: string + /** 用户绑定的Exchange账户 */ + exchange_account?: string + /** Exchange账户绑定user唯一标识id */ + user_id?: string + /** Exchange账户同步状态 */ + status?: 'doing' | 'cal_done' | 'timespan_done' | 'done' | 'err' + /** Exchange绑定关系唯一标识ID */ + exchange_binding_id?: string +} + +Internal.define({ + '/open-apis/calendar/v4/calendars': { + POST: 'createCalendar', + GET: 'listCalendar', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}': { + DELETE: 'deleteCalendar', + GET: 'getCalendar', + PATCH: 'patchCalendar', + }, + '/open-apis/calendar/v4/calendars/primary': { + POST: 'primaryCalendar', + }, + '/open-apis/calendar/v4/freebusy/list': { + POST: 'listCalendarFreebusy', + }, + '/open-apis/calendar/v4/calendars/search': { + POST: 'searchCalendar', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/subscribe': { + POST: 'subscribeCalendar', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/unsubscribe': { + POST: 'unsubscribeCalendar', + }, + '/open-apis/calendar/v4/calendars/subscription': { + POST: 'subscriptionCalendar', + }, + '/open-apis/calendar/v4/calendars/unsubscription': { + POST: 'unsubscriptionCalendar', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/acls': { + POST: 'createCalendarCalendarAcl', + GET: 'listCalendarCalendarAcl', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/acls/{acl_id}': { + DELETE: 'deleteCalendarCalendarAcl', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/acls/subscription': { + POST: 'subscriptionCalendarCalendarAcl', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/acls/unsubscription': { + POST: 'unsubscriptionCalendarCalendarAcl', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events': { + POST: 'createCalendarCalendarEvent', + GET: 'listCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}': { + DELETE: 'deleteCalendarCalendarEvent', + PATCH: 'patchCalendarCalendarEvent', + GET: 'getCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/search': { + POST: 'searchCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/subscription': { + POST: 'subscriptionCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/unsubscription': { + POST: 'unsubscriptionCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/reply': { + POST: 'replyCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/instances': { + GET: 'instancesCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/instance_view': { + GET: 'instanceViewCalendarCalendarEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/meeting_chat': { + POST: 'createCalendarCalendarEventMeetingChat', + DELETE: 'deleteCalendarCalendarEventMeetingChat', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/meeting_minute': { + POST: 'createCalendarCalendarEventMeetingMinute', + }, + '/open-apis/calendar/v4/timeoff_events': { + POST: 'createCalendarTimeoffEvent', + }, + '/open-apis/calendar/v4/timeoff_events/{timeoff_event_id}': { + DELETE: 'deleteCalendarTimeoffEvent', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/attendees': { + POST: 'createCalendarCalendarEventAttendee', + GET: 'listCalendarCalendarEventAttendee', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/attendees/batch_delete': { + POST: 'batchDeleteCalendarCalendarEventAttendee', + }, + '/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/attendees/{attendee_id}/chat_members': { + GET: 'listCalendarCalendarEventAttendeeChatMember', + }, + '/open-apis/calendar/v4/settings/generate_caldav_conf': { + POST: 'generateCaldavConfCalendarSetting', + }, + '/open-apis/calendar/v4/exchange_bindings': { + POST: 'createCalendarExchangeBinding', + }, + '/open-apis/calendar/v4/exchange_bindings/{exchange_binding_id}': { + DELETE: 'deleteCalendarExchangeBinding', + GET: 'getCalendarExchangeBinding', + }, +}) diff --git a/adapters/lark/src/types/cardkit.ts b/adapters/lark/src/types/cardkit.ts new file mode 100644 index 00000000..5a15a401 --- /dev/null +++ b/adapters/lark/src/types/cardkit.ts @@ -0,0 +1,182 @@ +import { Internal } from '../internal' +import { Card } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建卡片实体 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/create + */ + createCardkitCard(body: CreateCardkitCardRequest): Promise + /** + * 更新卡片配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings + */ + settingsCardkitCard(card_id: string, body: SettingsCardkitCardRequest): Promise + /** + * 批量更新卡片实体 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update + */ + batchUpdateCardkitCard(card_id: string, body: BatchUpdateCardkitCardRequest): Promise + /** + * 全量更新卡片实体 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/update + */ + updateCardkitCard(card_id: string, body: UpdateCardkitCardRequest): Promise + /** + * 转换 ID + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/id_convert + */ + idConvertCardkitCard(body: IdConvertCardkitCardRequest): Promise + /** + * 新增组件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/create + */ + createCardkitCardElement(card_id: string, body: CreateCardkitCardElementRequest): Promise + /** + * 更新组件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/update + */ + updateCardkitCardElement(card_id: string, element_id: string, body: UpdateCardkitCardElementRequest): Promise + /** + * 更新组件属性 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/patch + */ + patchCardkitCardElement(card_id: string, element_id: string, body: PatchCardkitCardElementRequest): Promise + /** + * 流式更新文本 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/content + */ + contentCardkitCardElement(card_id: string, element_id: string, body: ContentCardkitCardElementRequest): Promise + /** + * 删除组件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/delete + */ + deleteCardkitCardElement(card_id: string, element_id: string, body: DeleteCardkitCardElementRequest): Promise + } +} + +export interface CreateCardkitCardRequest { + /** 卡片数据的类型 */ + type: string + /** 卡片数据内容，与卡片数据的类型相对应 */ + data: string +} + +export interface SettingsCardkitCardRequest { + /** 卡片设置 */ + settings: string + /** UUID */ + uuid?: string + /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */ + sequence: number +} + +export interface BatchUpdateCardkitCardRequest { + /** 幂等 id，最大长度为 64。可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */ + uuid?: string + /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */ + sequence: number + /** 操作列表，可选值有： partial_update_setting：更新卡片设置，此时 parmas 结构参考更新卡片设置接口请求体的 settings 字段 ；add_elements，此时 parmas 结构参考添加组件接口请求体的 type、target_element_id、elements 字段 ； delete_elements，此时 parmas 结构内仅支持 element_ids 参数，参数值为组件 ID 数组 ； partial_update_element，此时 parmas 结构包括参考局部更新组件接口的路径参数 element_id 和请求体 partial_element 字段 ; update_element，此时 parmas 结构参考全量更新组件接口的路径参数 element_id 和请求体 element 字段 */ + actions: string +} + +export interface UpdateCardkitCardRequest { + /** 卡片内容 */ + card: Card + /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */ + uuid?: string + /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */ + sequence: number +} + +export interface IdConvertCardkitCardRequest { + /** 消息ID */ + message_id: string +} + +export interface CreateCardkitCardElementRequest { + /** 添加组件的方式 */ + type: 'insert_before' | 'insert_after' | 'append' + /** 目标组件的 ID。 当 type 为 insert_before、insert_after 时，为用于定位的目标组件。 当 type 为 append 时，该字段仅支持容器类组件，为用于指定末尾添加的目标组件，未填写默认为在卡片 body 末尾添加。 */ + target_element_id?: string + /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */ + uuid?: string + /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */ + sequence: number + /** 组件列表 */ + elements: string +} + +export interface UpdateCardkitCardElementRequest { + /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */ + uuid?: string + /** 新的组件 */ + element: string + /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */ + sequence: number +} + +export interface PatchCardkitCardElementRequest { + /** 要更改的组件部分配置内容，传入 id 参数后将对原有组件的 id 进行更新，不支持修改 tag 参数。 */ + partial_element: string + /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */ + uuid?: string + /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */ + sequence: number +} + +export interface ContentCardkitCardElementRequest { + /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */ + uuid?: string + /** 更新后的文本内容 */ + content: string + /** 顺序序号，用于保证更新文本内容的时序性。在卡片的单次 streaming 模式周期中（steaming 状态从开始到停止），该值需为递增的正整数，否则将报错。 */ + sequence: number +} + +export interface DeleteCardkitCardElementRequest { + /** 幂等 id，可通过传入唯一的 uuid 以保证相同批次的操作只进行一次。 */ + uuid?: string + /** 卡片处于流式更新模式时，进行卡片操作的顺序序号，用于保证多次更新的时序性。值为正整数，一次流式状态的多次更新操作（streaming_mode 一次从 true 到 false 期间）需要保证 sequence 递增，否则将报错。推荐使用时间戳。 */ + sequence: number +} + +export interface CreateCardkitCardResponse { + /** 卡片ID */ + card_id: string +} + +export interface IdConvertCardkitCardResponse { + /** 消息 ID 对应的卡片 ID */ + card_id?: string +} + +Internal.define({ + '/open-apis/cardkit/v1/cards': { + POST: 'createCardkitCard', + }, + '/open-apis/cardkit/v1/cards/{card_id}/settings': { + PATCH: 'settingsCardkitCard', + }, + '/open-apis/cardkit/v1/cards/{card_id}/batch_update': { + POST: 'batchUpdateCardkitCard', + }, + '/open-apis/cardkit/v1/cards/{card_id}': { + PUT: 'updateCardkitCard', + }, + '/open-apis/cardkit/v1/cards/id_convert': { + POST: 'idConvertCardkitCard', + }, + '/open-apis/cardkit/v1/cards/{card_id}/elements': { + POST: 'createCardkitCardElement', + }, + '/open-apis/cardkit/v1/cards/{card_id}/elements/{element_id}': { + PUT: 'updateCardkitCardElement', + PATCH: 'patchCardkitCardElement', + DELETE: 'deleteCardkitCardElement', + }, + '/open-apis/cardkit/v1/cards/{card_id}/elements/{element_id}/content': { + PUT: 'contentCardkitCardElement', + }, +}) diff --git a/adapters/lark/src/types/compensation.ts b/adapters/lark/src/types/compensation.ts new file mode 100644 index 00000000..c79ebbf6 --- /dev/null +++ b/adapters/lark/src/types/compensation.ts @@ -0,0 +1,169 @@ +import { Internal } from '../internal' +import { ArchiveDetail, ChangeReason, Indicator, Item, ItemCategory, PlanDetail } from '.' + +declare module '../internal' { + interface Internal { + /** + * 批量查询员工薪资档案 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query + */ + queryCompensationArchive(body: QueryCompensationArchiveRequest, query?: QueryCompensationArchiveQuery): Promise + /** + * 批量查询薪资项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list + */ + listCompensationItem(query?: ListCompensationItemQuery): Promise + /** + * 批量查询薪资统计指标 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list + */ + listCompensationIndicator(query?: ListCompensationIndicatorQuery): Promise + /** + * 批量获取薪资项分类信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item_category/list + */ + listCompensationItemCategory(query?: ListCompensationItemCategoryQuery): Promise + /** + * 批量查询薪资方案 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list + */ + listCompensationPlan(query?: ListCompensationPlanQuery): Promise + /** + * 批量查询定调薪原因 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list + */ + listCompensationChangeReason(query?: ListCompensationChangeReasonQuery): Promise + } +} + +export interface QueryCompensationArchiveRequest { + /** 用户ID列表 */ + user_id_list: string[] + /** 档案Tid列表 */ + tid_list?: string[] + /** 生效开始时间 */ + effective_start_date?: string + /** 生效结束时间 */ + effective_end_date?: string +} + +export interface QueryCompensationArchiveQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户ID类型 */ + user_id_type: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface ListCompensationItemQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 薪酬项类型（不传则认为查询所有类型薪酬项） */ + item_type?: 'salary' | 'bonus' | 'recurring_payment' +} + +export interface ListCompensationIndicatorQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListCompensationItemCategoryQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListCompensationPlanQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListCompensationChangeReasonQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface QueryCompensationArchiveResponse { + /** 档案信息列表 */ + items: ArchiveDetail[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more: boolean +} + +export interface ListCompensationItemResponse { + /** 薪酬项信息列表 */ + items: Item[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more: boolean +} + +export interface ListCompensationIndicatorResponse { + /** 薪资统计指标信息列表 */ + items: Indicator[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface ListCompensationItemCategoryResponse { + /** 薪酬项分类信息列表 */ + items?: ItemCategory[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface ListCompensationPlanResponse { + /** 薪资方案信息列表 */ + items: PlanDetail[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more: boolean +} + +export interface ListCompensationChangeReasonResponse { + /** 调薪原因信息列表 */ + items: ChangeReason[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more: boolean +} + +Internal.define({ + '/open-apis/compensation/v1/archives/query': { + POST: 'queryCompensationArchive', + }, + '/open-apis/compensation/v1/items': { + GET: 'listCompensationItem', + }, + '/open-apis/compensation/v1/indicators': { + GET: 'listCompensationIndicator', + }, + '/open-apis/compensation/v1/item_categories': { + GET: 'listCompensationItemCategory', + }, + '/open-apis/compensation/v1/plans': { + GET: 'listCompensationPlan', + }, + '/open-apis/compensation/v1/change_reasons': { + GET: 'listCompensationChangeReason', + }, +}) diff --git a/adapters/lark/src/types/contact.ts b/adapters/lark/src/types/contact.ts new file mode 100644 index 00000000..4a6e8053 --- /dev/null +++ b/adapters/lark/src/types/contact.ts @@ -0,0 +1,1662 @@ +import { Internal } from '../internal' +import { CustomAttr, Department, DepartmentI18nName, DepartmentLeader, EmployeeTypeEnum, FunctionalRoleMember, FunctionalRoleMemberResult, Group, I18nContent, JobFamily, JobLevel, JobTitle, MemberResult, Memberlist, ResourceAcceptor, Unit, UnitDepartment, User, UserContactInfo, UserCustomAttr, UserDepartmentInfo, UserOrder, WorkCity } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取通讯录授权范围 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/scope/list + */ + listContactScope(query?: ListContactScopeQuery): Promise + /** + * 创建用户 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create + */ + createContactUser(body: CreateContactUserRequest, query?: CreateContactUserQuery): Promise + /** + * 修改用户部分信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch + */ + patchContactUser(user_id: string, body: PatchContactUserRequest, query?: PatchContactUserQuery): Promise + /** + * 更新用户 ID + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update_user_id + */ + updateUserIdContactUser(user_id: string, body: UpdateUserIdContactUserRequest, query?: UpdateUserIdContactUserQuery): Promise + /** + * 获取单个用户信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get + */ + getContactUser(user_id: string, query?: GetContactUserQuery): Promise + /** + * 批量获取用户信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch + */ + batchContactUser(query?: BatchContactUserQuery): Promise + /** + * 获取部门直属用户列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department + */ + findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery): Promise + /** + * 通过手机号或邮箱获取用户 ID + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id + */ + batchGetIdContactUser(body: BatchGetIdContactUserRequest, query?: BatchGetIdContactUserQuery): Promise + /** + * 删除用户 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete + */ + deleteContactUser(user_id: string, body: DeleteContactUserRequest, query?: DeleteContactUserQuery): Promise + /** + * 恢复已删除用户 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/resurrect + */ + resurrectContactUser(user_id: string, body: ResurrectContactUserRequest, query?: ResurrectContactUserQuery): Promise + /** + * 创建用户组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/create + */ + createContactGroup(body: CreateContactGroupRequest, query?: CreateContactGroupQuery): Promise + /** + * 更新用户组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/patch + */ + patchContactGroup(group_id: string, body: PatchContactGroupRequest, query?: PatchContactGroupQuery): Promise + /** + * 查询指定用户组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/get + */ + getContactGroup(group_id: string, query?: GetContactGroupQuery): Promise + /** + * 查询用户组列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist + */ + simplelistContactGroup(query?: SimplelistContactGroupQuery): Promise + /** + * 查询用户所属用户组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong + */ + memberBelongContactGroup(query?: MemberBelongContactGroupQuery): Promise + /** + * 删除用户组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete + */ + deleteContactGroup(group_id: string): Promise + /** + * 获取企业自定义用户字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list + */ + listContactCustomAttr(query?: ListContactCustomAttrQuery): Promise + /** + * 新增人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create + */ + createContactEmployeeTypeEnum(body: CreateContactEmployeeTypeEnumRequest): Promise + /** + * 更新人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/update + */ + updateContactEmployeeTypeEnum(enum_id: string, body: UpdateContactEmployeeTypeEnumRequest): Promise + /** + * 查询人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list + */ + listContactEmployeeTypeEnum(query?: ListContactEmployeeTypeEnumQuery): Promise + /** + * 删除人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete + */ + deleteContactEmployeeTypeEnum(enum_id: string): Promise + /** + * 创建部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create + */ + createContactDepartment(body: CreateContactDepartmentRequest, query?: CreateContactDepartmentQuery): Promise + /** + * 修改部门部分信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch + */ + patchContactDepartment(department_id: string, body: PatchContactDepartmentRequest, query?: PatchContactDepartmentQuery): Promise + /** + * 更新部门所有信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update + */ + updateContactDepartment(department_id: string, body: UpdateContactDepartmentRequest, query?: UpdateContactDepartmentQuery): Promise + /** + * 更新部门 ID + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update_department_id + */ + updateDepartmentIdContactDepartment(department_id: string, body: UpdateDepartmentIdContactDepartmentRequest, query?: UpdateDepartmentIdContactDepartmentQuery): Promise + /** + * 部门群转为普通群 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat + */ + unbindDepartmentChatContactDepartment(body: UnbindDepartmentChatContactDepartmentRequest, query?: UnbindDepartmentChatContactDepartmentQuery): Promise + /** + * 获取单个部门信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get + */ + getContactDepartment(department_id: string, query?: GetContactDepartmentQuery): Promise + /** + * 批量获取部门信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/batch + */ + batchContactDepartment(query?: BatchContactDepartmentQuery): Promise + /** + * 获取子部门列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children + */ + childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery): Promise + /** + * 获取父部门信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent + */ + parentContactDepartment(query?: ParentContactDepartmentQuery): Promise + /** + * 搜索部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search + */ + searchContactDepartment(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): Promise + /** + * 删除部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete + */ + deleteContactDepartment(department_id: string, query?: DeleteContactDepartmentQuery): Promise + /** + * 创建单位 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/create + */ + createContactUnit(body: CreateContactUnitRequest): Promise + /** + * 修改单位信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/patch + */ + patchContactUnit(unit_id: string, body: PatchContactUnitRequest): Promise + /** + * 建立部门与单位的绑定关系 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/bind_department + */ + bindDepartmentContactUnit(body: BindDepartmentContactUnitRequest): Promise + /** + * 解除部门与单位的绑定关系 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/unbind_department + */ + unbindDepartmentContactUnit(body: UnbindDepartmentContactUnitRequest): Promise + /** + * 获取单位绑定的部门列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department + */ + listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery): Promise + /** + * 获取单位信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get + */ + getContactUnit(unit_id: string): Promise + /** + * 获取单位列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list + */ + listContactUnit(query?: ListContactUnitQuery): Promise + /** + * 删除单位 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete + */ + deleteContactUnit(unit_id: string): Promise + /** + * 添加用户组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/add + */ + addContactGroupMember(group_id: string, body: AddContactGroupMemberRequest): Promise + /** + * 批量添加用户组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_add + */ + batchAddContactGroupMember(group_id: string, body: BatchAddContactGroupMemberRequest): Promise + /** + * 查询用户组成员列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist + */ + simplelistContactGroupMember(group_id: string, query?: SimplelistContactGroupMemberQuery): Promise + /** + * 移除用户组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove + */ + removeContactGroupMember(group_id: string, body: RemoveContactGroupMemberRequest): Promise + /** + * 批量移除用户组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_remove + */ + batchRemoveContactGroupMember(group_id: string, body: BatchRemoveContactGroupMemberRequest): Promise + /** + * 创建角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/create + */ + createContactFunctionalRole(body: CreateContactFunctionalRoleRequest): Promise + /** + * 修改角色名称 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/update + */ + updateContactFunctionalRole(role_id: string, body: UpdateContactFunctionalRoleRequest): Promise + /** + * 删除角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/delete + */ + deleteContactFunctionalRole(role_id: string): Promise + /** + * 批量添加角色成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_create + */ + batchCreateContactFunctionalRoleMember(role_id: string, body: BatchCreateContactFunctionalRoleMemberRequest, query?: BatchCreateContactFunctionalRoleMemberQuery): Promise + /** + * 批量设置角色成员管理范围 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/scopes + */ + scopesContactFunctionalRoleMember(role_id: string, body: ScopesContactFunctionalRoleMemberRequest, query?: ScopesContactFunctionalRoleMemberQuery): Promise + /** + * 查询角色下某个成员的管理范围 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/get + */ + getContactFunctionalRoleMember(role_id: string, member_id: string, query?: GetContactFunctionalRoleMemberQuery): Promise + /** + * 查询角色下的所有成员信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list + */ + listContactFunctionalRoleMember(role_id: string, query?: ListContactFunctionalRoleMemberQuery): Promise + /** + * 删除角色下的成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete + */ + batchDeleteContactFunctionalRoleMember(role_id: string, body: BatchDeleteContactFunctionalRoleMemberRequest, query?: BatchDeleteContactFunctionalRoleMemberQuery): Promise + /** + * 创建职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/create + */ + createContactJobLevel(body: CreateContactJobLevelRequest): Promise + /** + * 更新职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/update + */ + updateContactJobLevel(job_level_id: string, body: UpdateContactJobLevelRequest): Promise + /** + * 获取单个职级信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/get + */ + getContactJobLevel(job_level_id: string): Promise + /** + * 获取租户职级列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list + */ + listContactJobLevel(query?: ListContactJobLevelQuery): Promise + /** + * 删除职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete + */ + deleteContactJobLevel(job_level_id: string): Promise + /** + * 创建序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/create + */ + createContactJobFamily(body: CreateContactJobFamilyRequest): Promise + /** + * 更新序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/update + */ + updateContactJobFamily(job_family_id: string, body: UpdateContactJobFamilyRequest): Promise + /** + * 获取单个序列信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/get + */ + getContactJobFamily(job_family_id: string): Promise + /** + * 获取租户序列列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list + */ + listContactJobFamily(query?: ListContactJobFamilyQuery): Promise + /** + * 删除序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete + */ + deleteContactJobFamily(job_family_id: string): Promise + /** + * 获取单个职务信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/get + */ + getContactJobTitle(job_title_id: string): Promise + /** + * 获取租户职务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list + */ + listContactJobTitle(query?: ListContactJobTitleQuery): Promise + /** + * 获取单个工作城市信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get + */ + getContactWorkCity(work_city_id: string): Promise + /** + * 获取租户工作城市列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list + */ + listContactWorkCity(query?: ListContactWorkCityQuery): Promise + /** + * 获取用户列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list + */ + listContactUser(query?: ListContactUserQuery): Promise + /** + * 更新用户所有信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update + */ + updateContactUser(user_id: string, body: UpdateContactUserRequest, query?: UpdateContactUserQuery): Promise + /** + * 获取部门信息列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list + */ + listContactDepartment(query?: ListContactDepartmentQuery): Promise + } +} + +export interface ListContactScopeQuery { + /** 返回值的用户ID的类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 返回值的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小，返回值所有列表长度之和不超过这个值 */ + page_size?: number +} + +export interface CreateContactUserRequest { + /** 租户内用户的唯一标识 */ + user_id?: string + /** 用户名 */ + name: string + /** 英文名 */ + en_name?: string + /** 别名 */ + nickname?: string + /** 邮箱 */ + email?: string + /** 手机号 */ + mobile: string + /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ + mobile_visible?: boolean + /** 性别 */ + gender?: 0 | 1 | 2 | 3 + /** 头像的文件Key */ + avatar_key?: string + /** 用户所在的部门 */ + department_ids: string[] + /** 用户的上级领导 */ + leader_user_id?: string + /** 城市 */ + city?: string + /** 国家 */ + country?: string + /** 工位 */ + work_station?: string + /** 入职时间 */ + join_time?: number + /** 工号 */ + employee_no?: string + /** 员工类型 */ + employee_type: number + /** 用户排序信息 */ + orders?: UserOrder[] + /** 自定义属性 */ + custom_attrs?: UserCustomAttr[] + /** 企业邮箱 */ + enterprise_email?: string + /** 职务 */ + job_title?: string + /** 数据驻留地 */ + geo?: string + /** 职级ID */ + job_level_id?: string + /** 序列ID */ + job_family_id?: string + /** 分配给用户的席位ID列表 */ + subscription_ids?: string[] + /** 虚线上级ID */ + dotted_line_leader_user_ids?: string[] +} + +export interface CreateContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型。不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ + department_id_type?: 'department_id' | 'open_department_id' + /** 用于幂等判断是否为同一请求，避免重复创建。字符串类型，自行生成。 */ + client_token?: string +} + +export interface PatchContactUserRequest { + /** 用户名称 */ + name?: string + /** 英文名 */ + en_name?: string + /** 别名 */ + nickname?: string + /** 邮箱 */ + email?: string + /** 用户手机号 */ + mobile?: string + /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ + mobile_visible?: boolean + /** 性别 */ + gender?: 0 | 1 | 2 | 3 + /** 头像的文件Key */ + avatar_key?: string + /** 用户所在部门ID */ + department_ids?: string[] + /** 用户直属上级 */ + leader_user_id?: string + /** 城市 */ + city?: string + /** 国家 */ + country?: string + /** 工位 */ + work_station?: string + /** 入职时间 */ + join_time?: number + /** 工号 */ + employee_no?: string + /** 员工类型 */ + employee_type?: number + /** 用户排序信息 */ + orders?: UserOrder[] + /** 自定义属性 */ + custom_attrs?: UserCustomAttr[] + /** 企业邮箱 */ + enterprise_email?: string + /** 职务 */ + job_title?: string + /** 是否冻结用户 */ + is_frozen?: boolean + /** 职级ID */ + job_level_id?: string + /** 序列ID */ + job_family_id?: string + /** 分配给用户的席位ID列表 */ + subscription_ids?: string[] + /** 虚线上级ID */ + dotted_line_leader_user_ids?: string[] +} + +export interface PatchContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface UpdateUserIdContactUserRequest { + /** 自定义新用户ID */ + new_user_id: string +} + +export interface UpdateUserIdContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface BatchContactUserQuery { + /** 要查询的用户ID列表 */ + user_ids: string[] + /** 指定请求中用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 指定查询结果中用户关联的部门ID类型 */ + department_id_type?: 'open_department_id' | 'department_id' +} + +export interface FindByDepartmentContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型部门ID类型的区别参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ + department_id_type?: 'department_id' | 'open_department_id' + /** 填写该字段表示获取该部门下用户，必填。根部门的部门ID为0。ID值与查询参数中的department_id_type 对应。不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ + department_id: string + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string +} + +export interface BatchGetIdContactUserRequest { + /** 要查询的用户邮箱，最多 50 条。注意，emails与mobiles相互独立，每条用户邮箱返回对应的用户ID。本接口返回的用户ID数量为emails数量与mobiles数量的和。 */ + emails?: string[] + /** 要查询的用户手机号，最多 50 条。注意1. emails与mobiles相互独立，每条用户手机号返回对应的用户ID。2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。 */ + mobiles?: string[] + /** 查询结果包含离职员工，可查询离职用户的ID */ + include_resigned?: boolean +} + +export interface BatchGetIdContactUserQuery { + /** 返回的用户ID的类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface DeleteContactUserRequest { + /** 部门群接收者。被删除用户为部门群群主时，转让群主给指定接收者，不指定接收者则默认转让给群内第一个入群的人 */ + department_chat_acceptor_user_id?: string + /** 外部群接收者。被删除用户为外部群群主时，转让群主给指定接收者，不指定接收者则默认转让给群内与被删除用户在同一组织的第一个入群的人，如果组织内只有该用户在群里，则解散外部群 */ + external_chat_acceptor_user_id?: string + /** 文档接收者。用户被删除时，其拥有的文档转让给接收者。不指定接收者则默认转让给直属上级，如果无直属上级则将文档资源保留在该用户名下。 */ + docs_acceptor_user_id?: string + /** 日程接收者。用户被删除时，其拥有的日程转让给接收者，不指定接收者则默认转让给直属上级，如果无直属上级则直接删除日程资源。 */ + calendar_acceptor_user_id?: string + /** 应用接受者。用户被删除时，其创建的应用转让给接收者，不指定接收者则默认转让给直属上级。如果无直属上级则保留应用在该用户名下，但该用户无法登录开发者后台进行应用管理，管理员可以在管理后台手动转移应用给其他人。 */ + application_acceptor_user_id?: string + /** 妙记接收者。用户被删除时，其拥有的妙记资源转让给接收者。如果不指定接收者，则默认转让给直属上级。如果无直属上级则将妙记保留在该用户名下。 */ + minutes_acceptor_user_id?: string + /** 飞书问卷接收者。用户被删除时，其拥有的飞书问卷资源转让给接收者，不指定接收者则默认转让给直属上级，如果无直属上级则直接删除飞书问卷资源。 */ + survey_acceptor_user_id?: string + /** 用户邮件资源处理方式。用户被删除时，根据传递的操作指令对其拥有的邮件资源做对应处理。未传递指令时默认将邮件资源转让给直属上级，如果无直属上级则保留邮件资源在该用户名下。 */ + email_acceptor?: ResourceAcceptor + /** 用户集成平台资源接收者 */ + anycross_acceptor_user_id?: string +} + +export interface DeleteContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ResurrectContactUserRequest { + /** 指定恢复后用户所在部门 */ + departments?: UserDepartmentInfo[] + /** 指定恢复后分配的席位 */ + subscription_ids?: string[] +} + +export interface ResurrectContactUserQuery { + /** 用户id类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 部门id类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface CreateContactGroupRequest { + /** 用户组的名字，企业内唯一，最大长度：100 字符 */ + name: string + /** 用户组描述 */ + description?: string + /** 用户组的类型。默认为1表示普通用户组 */ + type?: 1 | 2 + /** 自定义用户组ID，可在创建时自定义，不自定义则由系统自动生成，已创建用户组不允许修改 group_id 。自定义group_id数据校验规则：最大长度：64 字符校验规则：数字、大小写字母的组合，不能包含空格 */ + group_id?: string +} + +export interface CreateContactGroupQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'open_department_id' | 'department_id' +} + +export interface PatchContactGroupRequest { + /** 用户组的名字，企业内唯一，最大长度：100 字符 */ + name?: string + /** 用户组描述信息最大长度：500 字 */ + description?: string +} + +export interface PatchContactGroupQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface GetContactGroupQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'open_department_id' | 'department_id' +} + +export interface SimplelistContactGroupQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户组类型 */ + type?: 1 | 2 +} + +export interface MemberBelongContactGroupQuery { + /** 成员ID */ + member_id: string + /** 成员ID类型 */ + member_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 欲获取的用户组类型 */ + group_type?: 1 | 2 + /** 分页查询大小 */ + page_size?: number + /** 分页查询Token */ + page_token?: string +} + +export interface ListContactCustomAttrQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateContactEmployeeTypeEnumRequest { + /** 枚举内容 */ + content: string + /** 类型 */ + enum_type: 1 | 2 + /** 类型 */ + enum_status: 1 | 2 + /** i18n定义 */ + i18n_content?: I18nContent[] +} + +export interface UpdateContactEmployeeTypeEnumRequest { + /** 枚举内容 */ + content: string + /** 类型 */ + enum_type: 1 | 2 + /** 类型 */ + enum_status: 1 | 2 + /** i18n定义 */ + i18n_content?: I18nContent[] +} + +export interface ListContactEmployeeTypeEnumQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateContactDepartmentRequest { + /** 部门名称 */ + name: string + /** 国际化的部门名称 */ + i18n_name?: DepartmentI18nName + /** 父部门的ID */ + parent_department_id: string + /** 本部门的自定义部门ID */ + department_id?: string + /** 部门主管用户ID */ + leader_user_id?: string + /** 部门的排序 */ + order?: string + /** 是否创建部门群，默认不创建 */ + create_group_chat?: boolean + /** 部门负责人 */ + leaders?: DepartmentLeader[] + /** 部门群雇员类型限制 */ + group_chat_employee_types?: number[] + /** 部门HRBP */ + department_hrbps?: string[] +} + +export interface CreateContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ + department_id_type?: 'department_id' | 'open_department_id' + /** 用于幂等判断是否为同一请求，避免重复创建。字符串类型，自行生成。 */ + client_token?: string +} + +export interface PatchContactDepartmentRequest { + /** 部门名 */ + name?: string + /** 国际化的部门名称 */ + i18n_name?: DepartmentI18nName + /** 父部门ID */ + parent_department_id?: string + /** leaderID */ + leader_user_id?: string + /** 部门的排序 */ + order?: string + /** 是否创建部门群，默认不创建 */ + create_group_chat?: boolean + /** 部门负责人 */ + leaders?: DepartmentLeader[] + /** 部门群雇员类型限制 */ + group_chat_employee_types?: number[] + /** 部门HRBP */ + department_hrbps?: string[] +} + +export interface PatchContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface UpdateContactDepartmentRequest { + /** 部门名称 */ + name: string + /** 国际化的部门名称 */ + i18n_name?: DepartmentI18nName + /** 父部门ID */ + parent_department_id: string + /** LeaderID */ + leader_user_id?: string + /** 部门的排序 */ + order?: string + /** 是否创建部门群，默认不创建 */ + create_group_chat?: boolean + /** 部门负责人 */ + leaders?: DepartmentLeader[] + /** 部门群雇员类型限制 */ + group_chat_employee_types?: number[] +} + +export interface UpdateContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface UpdateDepartmentIdContactDepartmentRequest { + /** 本部门的自定义部门新ID */ + new_department_id: string +} + +export interface UpdateDepartmentIdContactDepartmentQuery { + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface UnbindDepartmentChatContactDepartmentRequest { + /** 部门ID */ + department_id: string +} + +export interface UnbindDepartmentChatContactDepartmentQuery { + /** 此次调用中使用的部门ID的类型，默认为"open_department_id" */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface GetContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface BatchContactDepartmentQuery { + /** 查询的部门ID列表，类型需要与department_id_type对应 */ + department_ids: string[] + /** 说明请求中department_id_list参数所使用的部门ID类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 指定调用结果中包含用户（如部门leader）关联的用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface ChildrenContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */ + department_id_type?: 'department_id' | 'open_department_id' + /** 是否递归获取子部门 */ + fetch_child?: boolean + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string +} + +export interface ParentContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 部门ID */ + department_id: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface SearchContactDepartmentRequest { + /** 搜索关键词，匹配字段为部门名称（不支持匹配部门国际化名称） */ + query: string +} + +export interface SearchContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface DeleteContactDepartmentQuery { + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface CreateContactUnitRequest { + /** 单位自定义ID。不带默认自动生成。1-64字节范围大小，需为数字字母 */ + unit_id?: string + /** 单位的名字，长度范围为1-100个字 */ + name: string + /** 单位类型，长度范围为1-100个字，创建后不可修改 */ + unit_type: string +} + +export interface PatchContactUnitRequest { + /** 单位的名字 */ + name?: string +} + +export interface BindDepartmentContactUnitRequest { + /** 单位ID */ + unit_id: string + /** 单位关联的部门ID */ + department_id: string + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface UnbindDepartmentContactUnitRequest { + /** 单位ID */ + unit_id: string + /** 预解除关联的部门ID */ + department_id: string + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface ListDepartmentContactUnitQuery { + /** 单位ID */ + unit_id: string + /** 此次调用中预获取的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface ListContactUnitQuery { + /** 分页大小，默认50，取值范围 1-100 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface AddContactGroupMemberRequest { + /** 用户组成员的类型，取值为 user */ + member_type: 'user' + /** 当member_type =user时候，member_id_type表示user_id_type，枚举值为open_id, union_id, user_id */ + member_id_type: 'open_id' | 'union_id' | 'user_id' + /** 添加的成员ID */ + member_id: string +} + +export interface BatchAddContactGroupMemberRequest { + /** 待添加成员 */ + members?: Memberlist[] +} + +export interface SimplelistContactGroupMemberQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 欲获取成员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' + /** 欲获取的用户组成员类型。 */ + member_type?: 'user' | 'department' +} + +export interface RemoveContactGroupMemberRequest { + /** 用户组成员的类型，取值为 user */ + member_type: 'user' + /** 操作移除的用户组成员ID */ + member_id: string + /** 当member_type =user时候，member_id_type表示user_id_type，枚举值为open_id, union_id, user_id */ + member_id_type: 'open_id' | 'union_id' | 'user_id' +} + +export interface BatchRemoveContactGroupMemberRequest { + /** 待移除成员 */ + members: Memberlist[] +} + +export interface CreateContactFunctionalRoleRequest { + /** 角色名称，在单租户下唯一 */ + role_name: string +} + +export interface UpdateContactFunctionalRoleRequest { + /** 修改的角色名称，在单租户下唯一 */ + role_name: string +} + +export interface BatchCreateContactFunctionalRoleMemberRequest { + /** 角色添加的角色成员列表（一批用户的UserID列表) */ + members: string[] +} + +export interface BatchCreateContactFunctionalRoleMemberQuery { + /** 成员ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface ScopesContactFunctionalRoleMemberRequest { + /** 角色修改的角色成员列表（一批用户的UserID列表) */ + members: string[] + /** 角色内用户的管理范围 */ + departments: string[] +} + +export interface ScopesContactFunctionalRoleMemberQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface GetContactFunctionalRoleMemberQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface ListContactFunctionalRoleMemberQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface BatchDeleteContactFunctionalRoleMemberRequest { + /** 角色删除的角色成员列表（一批用户的UserID列表) */ + members?: string[] +} + +export interface BatchDeleteContactFunctionalRoleMemberQuery { + /** 成员ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface CreateContactJobLevelRequest { + /** 职级名称 */ + name: string + /** 职级描述 */ + description?: string + /** 职级的排序，可填入自然数100-100000的数值，系统按照数值大小从小到大排序。不填写该字段时，默认新增排序在当前职级列表中最后位（最大值） */ + order?: number + /** 是否启用 */ + status: boolean + /** 多语言名称 */ + i18n_name?: I18nContent[] + /** 多语言描述 */ + i18n_description?: I18nContent[] +} + +export interface UpdateContactJobLevelRequest { + /** 职级名称 */ + name?: string + /** 职级描述 */ + description?: string + /** 职级的排序，可填入自然数100-100000的数值，系统按照数值大小从小到大排序。不填写该字段时，默认新增排序在当前职级列表中最后位（最大值） */ + order?: number + /** 是否启用 */ + status?: boolean + /** 多语言名称 */ + i18n_name?: I18nContent[] + /** 多语言描述 */ + i18n_description?: I18nContent[] +} + +export interface ListContactJobLevelQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 传入该字段时，可查询指定职级名称对应的职级信息。 */ + name?: string +} + +export interface CreateContactJobFamilyRequest { + /** 序列名称。1-100字符，支持中、英文及符号 */ + name: string + /** 序列描述，描述序列详情信息 */ + description?: string + /** 上级序列ID。需是该租户的序列ID列表中的值，对应唯一的序列名称。 */ + parent_job_family_id?: string + /** 是否启用 */ + status: boolean + /** 多语言序列名称 */ + i18n_name?: I18nContent[] + /** 多语言描述 */ + i18n_description?: I18nContent[] +} + +export interface UpdateContactJobFamilyRequest { + /** 序列名称。1-100字符，支持中、英文及符号 */ + name?: string + /** 序列描述，描述序列详情信息 */ + description?: string + /** 上级序列ID。需是该租户的序列ID列表中的值，对应唯一的序列名称。 */ + parent_job_family_id?: string + /** 是否启用 */ + status?: boolean + /** 多语言序列名称 */ + i18n_name?: I18nContent[] + /** 多语言描述 */ + i18n_description?: I18nContent[] +} + +export interface ListContactJobFamilyQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 序列名称,传入该字段时，可查询指定序列名称对应的序列信息 */ + name?: string +} + +export interface ListContactJobTitleQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListContactWorkCityQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 填写该字段表示获取部门下所有用户，选填。 */ + department_id?: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface UpdateContactUserRequest { + /** 用户名 */ + name: string + /** 英文名 */ + en_name?: string + /** 别名 */ + nickname?: string + /** 邮箱 */ + email?: string + /** 手机号 */ + mobile: string + /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ + mobile_visible?: boolean + /** 性别 */ + gender?: 0 | 1 | 2 | 3 + /** 头像的文件Key */ + avatar_key?: string + /** 用户所在部门ID */ + department_ids: string[] + /** 用户直属上级 */ + leader_user_id?: string + /** 城市 */ + city?: string + /** 国家 */ + country?: string + /** 工位 */ + work_station?: string + /** 入职时间 */ + join_time?: number + /** 工号 */ + employee_no?: string + /** 员工类型 */ + employee_type: number + /** 用户排序信息 */ + orders?: UserOrder[] + /** 自定义属性 */ + custom_attrs?: UserCustomAttr[] + /** 企业邮箱 */ + enterprise_email?: string + /** 职务 */ + job_title?: string + /** 是否冻结用户 */ + is_frozen?: boolean +} + +export interface UpdateContactUserQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface ListContactDepartmentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 父部门的ID，填上获取部门下所有子部门，此处填写的 ID 必须是 department_id_type 指定的 ID。 */ + parent_department_id?: string + /** 是否递归获取子部门 */ + fetch_child?: boolean + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string +} + +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 FindByDepartmentContactUserResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 用户列表 */ + items?: User[] +} + +export interface BatchGetIdContactUserResponse { + /** 手机号或者邮箱对应的用户id信息 */ + user_list?: UserContactInfo[] +} + +export interface CreateContactGroupResponse { + /** 用户组ID */ + group_id: string +} + +export interface GetContactGroupResponse { + /** 用户组详情 */ + group: Group +} + +export interface SimplelistContactGroupResponse { + /** 用户组列表 */ + grouplist: Group[] + /** 下次分页获取的page_token */ + page_token: string + /** 是否还需要分页获取 */ + has_more: boolean +} + +export interface MemberBelongContactGroupResponse { + /** 用户组ID列表 */ + group_list?: string[] + /** 分页查询Token */ + page_token?: string + /** 是否有更多结果 */ + has_more?: boolean +} + +export interface ListContactCustomAttrResponse { + /** 自定义字段定义 */ + items?: CustomAttr[] + /** 分页标记 */ + page_token?: string + /** 是否还有下一页 */ + has_more?: boolean +} + +export interface CreateContactEmployeeTypeEnumResponse { + /** 创建人员类型接口 */ + employee_type_enum?: EmployeeTypeEnum +} + +export interface UpdateContactEmployeeTypeEnumResponse { + employee_type_enum?: EmployeeTypeEnum +} + +export interface ListContactEmployeeTypeEnumResponse { + /** 雇员类型列表 */ + items?: EmployeeTypeEnum[] + /** 是否下一页 */ + has_more?: boolean + /** 分页token */ + page_token?: string +} + +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 ChildrenContactDepartmentResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 部门列表 */ + items?: Department[] +} + +export interface ParentContactDepartmentResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 部门列表 */ + items?: Department[] +} + +export interface SearchContactDepartmentResponse { + /** 部门列表 */ + items?: Department[] + /** 翻页 token，传入返回下一页，首页不需要传入 */ + page_token?: string + /** 是否还有下一页 */ + has_more: boolean +} + +export interface CreateContactUnitResponse { + /** 单位的自定义ID */ + unit_id: string +} + +export interface ListDepartmentContactUnitResponse { + /** 单位绑定的部门列表 */ + departmentlist: UnitDepartment[] + /** 是否还有分页数据 */ + has_more: boolean + /** 下次分页请求标记 */ + page_token: string +} + +export interface GetContactUnitResponse { + /** 单位信息 */ + unit: Unit +} + +export interface ListContactUnitResponse { + /** 单位列表 */ + unitlist: Unit[] + /** 是否还有分页数据 */ + has_more: boolean + /** 分页下次调用的page_token值 */ + page_token: string +} + +export interface BatchAddContactGroupMemberResponse { + /** 成员添加操作结果 */ + results?: MemberResult[] +} + +export interface SimplelistContactGroupMemberResponse { + /** 成员列表 */ + memberlist: Memberlist[] + /** 下次分页获取的page_token */ + page_token: string + /** 是否还需要分页获取 */ + has_more: boolean +} + +export interface CreateContactFunctionalRoleResponse { + /** 角色ID，在单租户下唯一 */ + role_id: string +} + +export interface BatchCreateContactFunctionalRoleMemberResponse { + /** 批量新增角色成员结果集 */ + results?: FunctionalRoleMemberResult[] +} + +export interface ScopesContactFunctionalRoleMemberResponse { + /** 批量更新角色成员管理范围结果集 */ + results?: FunctionalRoleMemberResult[] +} + +export interface GetContactFunctionalRoleMemberResponse { + /** 成员的管理范围 */ + member?: FunctionalRoleMember +} + +export interface ListContactFunctionalRoleMemberResponse { + /** 角色成员列表 */ + members?: FunctionalRoleMember[] + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否还有值 */ + has_more?: boolean +} + +export interface BatchDeleteContactFunctionalRoleMemberResponse { + /** 批量新增角色成员结果集 */ + result?: FunctionalRoleMemberResult[] +} + +export interface CreateContactJobLevelResponse { + /** 职级信息 */ + job_level?: JobLevel +} + +export interface UpdateContactJobLevelResponse { + /** 职级信息 */ + job_level?: JobLevel +} + +export interface GetContactJobLevelResponse { + /** 职级信息 */ + job_level?: JobLevel +} + +export interface ListContactJobLevelResponse { + /** 职级列表 */ + items?: JobLevel[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface CreateContactJobFamilyResponse { + /** 序列信息 */ + job_family?: JobFamily +} + +export interface UpdateContactJobFamilyResponse { + /** 更新后的序列信息 */ + job_family?: JobFamily +} + +export interface GetContactJobFamilyResponse { + /** 序列信息 */ + job_family?: JobFamily +} + +export interface ListContactJobFamilyResponse { + /** 序列信息 */ + items?: JobFamily[] + /** 下一页分页的token */ + page_token?: string + /** 是否有下一页数据 */ + has_more?: boolean +} + +export interface GetContactJobTitleResponse { + /** 职务信息 */ + job_title?: JobTitle +} + +export interface ListContactJobTitleResponse { + /** 职务列表 */ + items?: JobTitle[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface GetContactWorkCityResponse { + /** 工作城市信息 */ + work_city?: WorkCity +} + +export interface ListContactWorkCityResponse { + /** 工作城市列表 */ + items?: WorkCity[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface ListContactUserResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + items?: User[] +} + +export interface UpdateContactUserResponse { + user?: User +} + +export interface ListContactDepartmentResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + items?: Department[] +} + +Internal.define({ + '/open-apis/contact/v3/scopes': { + GET: 'listContactScope', + }, + '/open-apis/contact/v3/users': { + POST: 'createContactUser', + GET: 'listContactUser', + }, + '/open-apis/contact/v3/users/{user_id}': { + PATCH: 'patchContactUser', + GET: 'getContactUser', + DELETE: 'deleteContactUser', + PUT: 'updateContactUser', + }, + '/open-apis/contact/v3/users/{user_id}/update_user_id': { + PATCH: 'updateUserIdContactUser', + }, + '/open-apis/contact/v3/users/batch': { + GET: 'batchContactUser', + }, + '/open-apis/contact/v3/users/find_by_department': { + GET: 'findByDepartmentContactUser', + }, + '/open-apis/contact/v3/users/batch_get_id': { + POST: 'batchGetIdContactUser', + }, + '/open-apis/contact/v3/users/{user_id}/resurrect': { + POST: 'resurrectContactUser', + }, + '/open-apis/contact/v3/group': { + POST: 'createContactGroup', + }, + '/open-apis/contact/v3/group/{group_id}': { + PATCH: 'patchContactGroup', + GET: 'getContactGroup', + DELETE: 'deleteContactGroup', + }, + '/open-apis/contact/v3/group/simplelist': { + GET: 'simplelistContactGroup', + }, + '/open-apis/contact/v3/group/member_belong': { + GET: 'memberBelongContactGroup', + }, + '/open-apis/contact/v3/custom_attrs': { + GET: 'listContactCustomAttr', + }, + '/open-apis/contact/v3/employee_type_enums': { + POST: 'createContactEmployeeTypeEnum', + GET: 'listContactEmployeeTypeEnum', + }, + '/open-apis/contact/v3/employee_type_enums/{enum_id}': { + PUT: 'updateContactEmployeeTypeEnum', + DELETE: 'deleteContactEmployeeTypeEnum', + }, + '/open-apis/contact/v3/departments': { + POST: 'createContactDepartment', + GET: 'listContactDepartment', + }, + '/open-apis/contact/v3/departments/{department_id}': { + PATCH: 'patchContactDepartment', + PUT: 'updateContactDepartment', + GET: 'getContactDepartment', + DELETE: 'deleteContactDepartment', + }, + '/open-apis/contact/v3/departments/{department_id}/update_department_id': { + PATCH: 'updateDepartmentIdContactDepartment', + }, + '/open-apis/contact/v3/departments/unbind_department_chat': { + POST: 'unbindDepartmentChatContactDepartment', + }, + '/open-apis/contact/v3/departments/batch': { + GET: 'batchContactDepartment', + }, + '/open-apis/contact/v3/departments/{department_id}/children': { + GET: 'childrenContactDepartment', + }, + '/open-apis/contact/v3/departments/parent': { + GET: 'parentContactDepartment', + }, + '/open-apis/contact/v3/departments/search': { + POST: 'searchContactDepartment', + }, + '/open-apis/contact/v3/unit': { + POST: 'createContactUnit', + GET: 'listContactUnit', + }, + '/open-apis/contact/v3/unit/{unit_id}': { + PATCH: 'patchContactUnit', + GET: 'getContactUnit', + DELETE: 'deleteContactUnit', + }, + '/open-apis/contact/v3/unit/bind_department': { + POST: 'bindDepartmentContactUnit', + }, + '/open-apis/contact/v3/unit/unbind_department': { + POST: 'unbindDepartmentContactUnit', + }, + '/open-apis/contact/v3/unit/list_department': { + GET: 'listDepartmentContactUnit', + }, + '/open-apis/contact/v3/group/{group_id}/member/add': { + POST: 'addContactGroupMember', + }, + '/open-apis/contact/v3/group/{group_id}/member/batch_add': { + POST: 'batchAddContactGroupMember', + }, + '/open-apis/contact/v3/group/{group_id}/member/simplelist': { + GET: 'simplelistContactGroupMember', + }, + '/open-apis/contact/v3/group/{group_id}/member/remove': { + POST: 'removeContactGroupMember', + }, + '/open-apis/contact/v3/group/{group_id}/member/batch_remove': { + POST: 'batchRemoveContactGroupMember', + }, + '/open-apis/contact/v3/functional_roles': { + POST: 'createContactFunctionalRole', + }, + '/open-apis/contact/v3/functional_roles/{role_id}': { + PUT: 'updateContactFunctionalRole', + DELETE: 'deleteContactFunctionalRole', + }, + '/open-apis/contact/v3/functional_roles/{role_id}/members/batch_create': { + POST: 'batchCreateContactFunctionalRoleMember', + }, + '/open-apis/contact/v3/functional_roles/{role_id}/members/scopes': { + PATCH: 'scopesContactFunctionalRoleMember', + }, + '/open-apis/contact/v3/functional_roles/{role_id}/members/{member_id}': { + GET: 'getContactFunctionalRoleMember', + }, + '/open-apis/contact/v3/functional_roles/{role_id}/members': { + GET: 'listContactFunctionalRoleMember', + }, + '/open-apis/contact/v3/functional_roles/{role_id}/members/batch_delete': { + PATCH: 'batchDeleteContactFunctionalRoleMember', + }, + '/open-apis/contact/v3/job_levels': { + POST: 'createContactJobLevel', + GET: 'listContactJobLevel', + }, + '/open-apis/contact/v3/job_levels/{job_level_id}': { + PUT: 'updateContactJobLevel', + GET: 'getContactJobLevel', + DELETE: 'deleteContactJobLevel', + }, + '/open-apis/contact/v3/job_families': { + POST: 'createContactJobFamily', + GET: 'listContactJobFamily', + }, + '/open-apis/contact/v3/job_families/{job_family_id}': { + PUT: 'updateContactJobFamily', + GET: 'getContactJobFamily', + DELETE: 'deleteContactJobFamily', + }, + '/open-apis/contact/v3/job_titles/{job_title_id}': { + GET: 'getContactJobTitle', + }, + '/open-apis/contact/v3/job_titles': { + GET: 'listContactJobTitle', + }, + '/open-apis/contact/v3/work_cities/{work_city_id}': { + GET: 'getContactWorkCity', + }, + '/open-apis/contact/v3/work_cities': { + GET: 'listContactWorkCity', + }, +}) diff --git a/adapters/lark/src/types/corehr.ts b/adapters/lark/src/types/corehr.ts new file mode 100644 index 00000000..3861ea62 --- /dev/null +++ b/adapters/lark/src/types/corehr.ts @@ -0,0 +1,6043 @@ +import { Internal } from '../internal' +import { Address, ApprovalGroup, ApproverInfo, AssessmentForCreate, AssignedOrganizationWithCode, Bank, BankAccount, BankBranch, BasicInfo, BasicInfoUpdate, Bp, BpRoleOrganization, City, Company, Contract, CostCenter, CostCenterVersion, CountryRegion, CountryRegionSubdivision, CpstGrade, CreateTransferInfo, Currency, CustomField, CustomFieldData, DataengineI18n, Department, DepartmentChange, DepartmentCreate, DepartmentHrbp, DepartmentParents, DepartmentTimeline, DepartmentTree, Dependent, District, Education, EducationInfo, Email, EmergencyContact, Employee, EmployeeJobData, EmployeeType, EmployeesAdditionalJob, EmployeesAdditionalJobBatchReqDate, EmployeesAdditionalJobWriteResp, Employment, EmploymentBp, EmploymentCreate, EmploymentLeaveBalance, Enum, EnumFieldOption, FieldVariableValue, FormFieldVariable, HiberarchyCommon, Hrbp, I18n, IdInfo, Job, JobChange, JobData, JobFamily, JobGrade, JobLevel, Language, LeaveGrantingRecord, LeaveRequest, LeaveType, Location, ManagementScope, NationalId, NationalIdType, Nationality, Object, ObjectFieldData, Offboarding, OffboardingReason, OfferInfo, OfferInfoUpdate, OrganizationOpLog, Person, PersonInfo, PersonName, PersonalProfile, Phone, PhoneNumberAndAreaCode, PreHire, PreHireQuery, ProbationInfo, ProbationInfoForSubmit, ProcessAbstractItem, ProcessCcItem, ProcessCommentInfo, ProcessDoneItem, ProcessFormVariableV2, ProcessLink, ProcessSystemDoneItem, ProcessSystemTodoItem, ProcessTodoItem, ProfileSettingCareer, ProfileSettingDataAttachment, ProfileSettingEmploymentInfo, ProfileSettingPersonalInfo, ResidentTax, RoleAuthorization, SecurityGroup, Subdivision, Subregion, SupportCostCenterItem, TimeZone, TransferInfo, TransferReason, TransferType, WkCalendarDate, WkOption, WorkCalendarDetail, WorkExperience, WorkExperienceInfo, WorkforcePlan, WorkforcePlanDetail, WorkforcePlanDetailRow, WorkingHoursType } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取飞书人事对象列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/list_object_api_name + */ + listObjectApiNameCorehrCustomField(query?: ListObjectApiNameCorehrCustomFieldQuery): Promise + /** + * 获取自定义字段列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query + */ + queryCorehrCustomField(query?: QueryCorehrCustomFieldQuery): Promise + /** + * 获取字段详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param + */ + getByParamCorehrCustomField(query?: GetByParamCorehrCustomFieldQuery): Promise + /** + * 增加字段枚举值选项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-meta_data/add_enum_option + */ + addEnumOptionCorehrCommonDataMetaData(body: AddEnumOptionCorehrCommonDataMetaDataRequest, query?: AddEnumOptionCorehrCommonDataMetaDataQuery): Promise + /** + * 修改字段枚举值选项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-meta_data/edit_enum_option + */ + editEnumOptionCorehrCommonDataMetaData(body: EditEnumOptionCorehrCommonDataMetaDataRequest, query?: EditEnumOptionCorehrCommonDataMetaDataQuery): Promise + /** + * 查询国家/地区信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search + */ + searchCorehrBasicInfoCountryRegion(body: SearchCorehrBasicInfoCountryRegionRequest, query?: SearchCorehrBasicInfoCountryRegionQuery): Promise + /** + * 查询省份/主要行政区信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search + */ + searchCorehrBasicInfoCountryRegionSubdivision(body: SearchCorehrBasicInfoCountryRegionSubdivisionRequest, query?: SearchCorehrBasicInfoCountryRegionSubdivisionQuery): Promise + /** + * 查询城市信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search + */ + searchCorehrBasicInfoCity(body: SearchCorehrBasicInfoCityRequest, query?: SearchCorehrBasicInfoCityQuery): Promise + /** + * 查询区/县信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search + */ + searchCorehrBasicInfoDistrict(body: SearchCorehrBasicInfoDistrictRequest, query?: SearchCorehrBasicInfoDistrictQuery): Promise + /** + * 查询国籍信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search + */ + searchCorehrBasicInfoNationality(body: SearchCorehrBasicInfoNationalityRequest, query?: SearchCorehrBasicInfoNationalityQuery): Promise + /** + * 创建国家证件类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/create + */ + createCorehrNationalIdType(body: CreateCorehrNationalIdTypeRequest, query?: CreateCorehrNationalIdTypeQuery): Promise + /** + * 删除国家证件类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/delete + */ + deleteCorehrNationalIdType(national_id_type_id: string): Promise + /** + * 更新国家证件类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/patch + */ + patchCorehrNationalIdType(national_id_type_id: string, body: PatchCorehrNationalIdTypeRequest, query?: PatchCorehrNationalIdTypeQuery): Promise + /** + * 查询单个国家证件类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/get + */ + getCorehrNationalIdType(national_id_type_id: string): Promise + /** + * 批量查询国家证件类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/list + */ + listCorehrNationalIdType(query?: ListCorehrNationalIdTypeQuery): Promise + /** + * 查询银行信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search + */ + searchCorehrBasicInfoBank(body: SearchCorehrBasicInfoBankRequest, query?: SearchCorehrBasicInfoBankQuery): Promise + /** + * 查询支行信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank_branch/search + */ + searchCorehrBasicInfoBankBranch(body: SearchCorehrBasicInfoBankBranchRequest, query?: SearchCorehrBasicInfoBankBranchQuery): Promise + /** + * 查询货币信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search + */ + searchCorehrBasicInfoCurrency(body: SearchCorehrBasicInfoCurrencyRequest, query?: SearchCorehrBasicInfoCurrencyQuery): Promise + /** + * 查询时区信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-time_zone/search + */ + searchCorehrBasicInfoTimeZone(body: SearchCorehrBasicInfoTimeZoneRequest, query?: SearchCorehrBasicInfoTimeZoneQuery): Promise + /** + * 查询语言信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-language/search + */ + searchCorehrBasicInfoLanguage(body: SearchCorehrBasicInfoLanguageRequest, query?: SearchCorehrBasicInfoLanguageQuery): Promise + /** + * 创建人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/create + */ + createCorehrEmployeeType(body: CreateCorehrEmployeeTypeRequest, query?: CreateCorehrEmployeeTypeQuery): Promise + /** + * 删除人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/delete + */ + deleteCorehrEmployeeType(employee_type_id: string): Promise + /** + * 更新人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/patch + */ + patchCorehrEmployeeType(employee_type_id: string, body: PatchCorehrEmployeeTypeRequest, query?: PatchCorehrEmployeeTypeQuery): Promise + /** + * 查询单个人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get + */ + getCorehrEmployeeType(employee_type_id: string): Promise + /** + * 批量查询人员类型 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list + */ + listCorehrEmployeeType(query?: ListCorehrEmployeeTypeQuery): Promise + /** + * 创建工时制度 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/create + */ + createCorehrWorkingHoursType(body: CreateCorehrWorkingHoursTypeRequest, query?: CreateCorehrWorkingHoursTypeQuery): Promise + /** + * 删除工时制度 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/delete + */ + deleteCorehrWorkingHoursType(working_hours_type_id: string): Promise + /** + * 更新工时制度 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/patch + */ + patchCorehrWorkingHoursType(working_hours_type_id: string, body: PatchCorehrWorkingHoursTypeRequest, query?: PatchCorehrWorkingHoursTypeQuery): Promise + /** + * 查询单个工时制度 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get + */ + getCorehrWorkingHoursType(working_hours_type_id: string): Promise + /** + * 批量查询工时制度 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list + */ + listCorehrWorkingHoursType(query?: ListCorehrWorkingHoursTypeQuery): Promise + /** + * ID 转换 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-id/convert + */ + convertCorehrCommonDataId(body: ConvertCorehrCommonDataIdRequest, query?: ConvertCorehrCommonDataIdQuery): Promise + /** + * 批量查询员工信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get + */ + batchGetCorehrEmployee(body: BatchGetCorehrEmployeeRequest, query?: BatchGetCorehrEmployeeQuery): Promise + /** + * 搜索员工信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search + */ + searchCorehrEmployee(body: SearchCorehrEmployeeRequest, query?: SearchCorehrEmployeeQuery): Promise + /** + * 添加人员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/create + */ + createCorehrEmployee(body: CreateCorehrEmployeeRequest, query?: CreateCorehrEmployeeQuery): Promise + /** + * 创建个人信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/create + */ + createCorehrPerson(body: CreateCorehrPersonRequest, query?: CreateCorehrPersonQuery): Promise + /** + * 更新个人信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/patch + */ + patchCorehrPerson(person_id: string, body: PatchCorehrPersonRequest, query?: PatchCorehrPersonQuery): Promise + /** + * 删除个人信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/delete + */ + deleteCorehrPerson(person_id: string): Promise + /** + * 上传文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/upload + */ + uploadCorehrPerson(form: UploadCorehrPersonForm): Promise + /** + * 下载文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/file/get + */ + getCorehrFile(id: string): Promise + /** + * 创建雇佣信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/create + */ + createCorehrEmployment(body: CreateCorehrEmploymentRequest, query?: CreateCorehrEmploymentQuery): Promise + /** + * 更新雇佣信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/patch + */ + patchCorehrEmployment(employment_id: string, body: PatchCorehrEmploymentRequest, query?: PatchCorehrEmploymentQuery): Promise + /** + * 删除雇佣信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/delete + */ + deleteCorehrEmployment(employment_id: string, query?: DeleteCorehrEmploymentQuery): Promise + /** + * 创建任职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/create + */ + createCorehrJobData(body: CreateCorehrJobDataRequest, query?: CreateCorehrJobDataQuery): Promise + /** + * 删除任职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/delete + */ + deleteCorehrJobData(job_data_id: string, query?: DeleteCorehrJobDataQuery): Promise + /** + * 更新任职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/patch + */ + patchCorehrJobData(job_data_id: string, body: PatchCorehrJobDataRequest, query?: PatchCorehrJobDataQuery): Promise + /** + * 获取任职信息列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/query + */ + queryCorehrEmployeesJobData(body: QueryCorehrEmployeesJobDataRequest, query?: QueryCorehrEmployeesJobDataQuery): Promise + /** + * 批量查询员工任职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/batch_get + */ + batchGetCorehrEmployeesJobData(body: BatchGetCorehrEmployeesJobDataRequest, query?: BatchGetCorehrEmployeesJobDataQuery): Promise + /** + * 批量查询任职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/list + */ + listCorehrJobData(query?: ListCorehrJobDataQuery): Promise + /** + * 查询单个任职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/get + */ + getCorehrJobData(job_data_id: string, query?: GetCorehrJobDataQuery): Promise + /** + * 创建兼职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/create + */ + createCorehrEmployeesAdditionalJob(body: CreateCorehrEmployeesAdditionalJobRequest, query?: CreateCorehrEmployeesAdditionalJobQuery): Promise + /** + * 更新兼职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/patch + */ + patchCorehrEmployeesAdditionalJob(additional_job_id: string, body: PatchCorehrEmployeesAdditionalJobRequest, query?: PatchCorehrEmployeesAdditionalJobQuery): Promise + /** + * 删除兼职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/delete + */ + deleteCorehrEmployeesAdditionalJob(additional_job_id: string): Promise + /** + * 批量查询兼职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/batch + */ + batchCorehrEmployeesAdditionalJob(body: BatchCorehrEmployeesAdditionalJobRequest, query?: BatchCorehrEmployeesAdditionalJobQuery): Promise + /** + * 批量查询部门操作日志 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_operation_logs + */ + queryOperationLogsCorehrDepartment(body: QueryOperationLogsCorehrDepartmentRequest, query?: QueryOperationLogsCorehrDepartmentQuery): Promise + /** + * 创建部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/create + */ + createCorehrDepartment(body: CreateCorehrDepartmentRequest, query?: CreateCorehrDepartmentQuery): Promise + /** + * 更新部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/patch + */ + patchCorehrDepartment(department_id: string, body: PatchCorehrDepartmentRequest, query?: PatchCorehrDepartmentQuery): Promise + /** + * 获取父部门信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/parents + */ + parentsCorehrDepartment(body: ParentsCorehrDepartmentRequest, query?: ParentsCorehrDepartmentQuery): Promise + /** + * 批量查询部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get + */ + batchGetCorehrDepartment(body: BatchGetCorehrDepartmentRequest, query?: BatchGetCorehrDepartmentQuery): Promise + /** + * 查询指定时间范围内当前生效信息发生变更的部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_recent_change + */ + queryRecentChangeCorehrDepartment(query?: QueryRecentChangeCorehrDepartmentQuery): Promise + /** + * 查询指定生效日期的部门基本信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_timeline + */ + queryTimelineCorehrDepartment(body: QueryTimelineCorehrDepartmentRequest, query?: QueryTimelineCorehrDepartmentQuery): Promise + /** + * 查询指定生效日期的部门架构树 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/tree + */ + treeCorehrDepartment(body: TreeCorehrDepartmentRequest, query?: TreeCorehrDepartmentQuery): Promise + /** + * 批量查询部门版本信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_multi_timeline + */ + queryMultiTimelineCorehrDepartment(body: QueryMultiTimelineCorehrDepartmentRequest, query?: QueryMultiTimelineCorehrDepartmentQuery): Promise + /** + * 搜索部门信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search + */ + searchCorehrDepartment(body: SearchCorehrDepartmentRequest, query?: SearchCorehrDepartmentQuery): Promise + /** + * 删除部门 V2 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/delete + */ + deleteCorehrDepartment(department_id: string, query?: DeleteCorehrDepartmentQuery): Promise + /** + * 创建地点 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create + */ + createCorehrLocation(body: CreateCorehrLocationRequest, query?: CreateCorehrLocationQuery): Promise + /** + * 更新地点 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/patch + */ + patchCorehrLocation(location_id: string, body: PatchCorehrLocationRequest, query?: PatchCorehrLocationQuery): Promise + /** + * 查询单个地点 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get + */ + getCorehrLocation(location_id: string): Promise + /** + * 查询当前生效信息发生变更的地点 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/query_recent_change + */ + queryRecentChangeCorehrLocation(query?: QueryRecentChangeCorehrLocationQuery): Promise + /** + * 通过地点 ID 批量获取地点信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/batch_get + */ + batchGetCorehrLocation(body: BatchGetCorehrLocationRequest): Promise + /** + * 批量分页查询地点信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list + */ + listCorehrLocation(query?: ListCorehrLocationQuery): Promise + /** + * 启用/停用地点 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/active + */ + activeCorehrLocation(body: ActiveCorehrLocationRequest): Promise + /** + * 删除地点 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/delete + */ + deleteCorehrLocation(location_id: string): Promise + /** + * 删除地点地址 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/delete + */ + deleteCorehrLocationAddress(location_id: string, address_id: string): Promise + /** + * 更新地点地址 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/patch + */ + patchCorehrLocationAddress(location_id: string, address_id: string, body: PatchCorehrLocationAddressRequest, query?: PatchCorehrLocationAddressQuery): Promise + /** + * 添加地点地址 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/create + */ + createCorehrLocationAddress(location_id: string, body: CreateCorehrLocationAddressRequest, query?: CreateCorehrLocationAddressQuery): Promise + /** + * 创建公司 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/create + */ + createCorehrCompany(body: CreateCorehrCompanyRequest, query?: CreateCorehrCompanyQuery): Promise + /** + * 更新公司 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/patch + */ + patchCorehrCompany(company_id: string, body: PatchCorehrCompanyRequest, query?: PatchCorehrCompanyQuery): Promise + /** + * 启用/停用公司 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/active + */ + activeCorehrCompany(body: ActiveCorehrCompanyRequest): Promise + /** + * 查询单个公司 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get + */ + getCorehrCompany(company_id: string): Promise + /** + * 批量查询公司 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list + */ + listCorehrCompany(query?: ListCorehrCompanyQuery): Promise + /** + * 查询指定时间范围内当前生效信息发生变更的公司 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/query_recent_change + */ + queryRecentChangeCorehrCompany(query?: QueryRecentChangeCorehrCompanyQuery): Promise + /** + * 通过公司 ID 批量获取公司信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/batch_get + */ + batchGetCorehrCompany(body: BatchGetCorehrCompanyRequest): Promise + /** + * 删除公司 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/delete + */ + deleteCorehrCompany(company_id: string): Promise + /** + * 创建成本中心 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/create + */ + createCorehrCostCenter(body: CreateCorehrCostCenterRequest, query?: CreateCorehrCostCenterQuery): Promise + /** + * 启用 / 停用成本中心 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/patch + */ + patchCorehrCostCenter(cost_center_id: string, body: PatchCorehrCostCenterRequest, query?: PatchCorehrCostCenterQuery): Promise + /** + * 查询当前生效信息发生变更的成本中心 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/query_recent_change + */ + queryRecentChangeCorehrCostCenter(query?: QueryRecentChangeCorehrCostCenterQuery): Promise + /** + * 搜索成本中心信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search + */ + searchCorehrCostCenter(body: SearchCorehrCostCenterRequest, query?: SearchCorehrCostCenterQuery): Promise + /** + * 删除成本中心 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/delete + */ + deleteCorehrCostCenter(cost_center_id: string, body: DeleteCorehrCostCenterRequest): Promise + /** + * 创建成本中心版本 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/create + */ + createCorehrCostCenterVersion(cost_center_id: string, body: CreateCorehrCostCenterVersionRequest, query?: CreateCorehrCostCenterVersionQuery): Promise + /** + * 更正成本中心版本 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/patch + */ + patchCorehrCostCenterVersion(cost_center_id: string, version_id: string, body: PatchCorehrCostCenterVersionRequest, query?: PatchCorehrCostCenterVersionQuery): Promise + /** + * 撤销成本中心版本 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/delete + */ + deleteCorehrCostCenterVersion(cost_center_id: string, version_id: string, body: DeleteCorehrCostCenterVersionRequest): Promise + /** + * 根据流程 ID 查询组织架构调整记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approval_groups/get + */ + getCorehrApprovalGroups(process_id: string, query?: GetCorehrApprovalGroupsQuery): Promise + /** + * 批量查询部门调整内容 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approval_groups/open_query_department_change_list_by_ids + */ + openQueryDepartmentChangeListByIdsCorehrApprovalGroups(body: OpenQueryDepartmentChangeListByIdsCorehrApprovalGroupsRequest, query?: OpenQueryDepartmentChangeListByIdsCorehrApprovalGroupsQuery): Promise + /** + * 批量查询人员调整内容 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approval_groups/open_query_job_change_list_by_ids + */ + openQueryJobChangeListByIdsCorehrApprovalGroups(body: OpenQueryJobChangeListByIdsCorehrApprovalGroupsRequest, query?: OpenQueryJobChangeListByIdsCorehrApprovalGroupsQuery): Promise + /** + * 创建序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/create + */ + createCorehrJobFamily(body: CreateCorehrJobFamilyRequest, query?: CreateCorehrJobFamilyQuery): Promise + /** + * 更新序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/patch + */ + patchCorehrJobFamily(job_family_id: string, body: PatchCorehrJobFamilyRequest, query?: PatchCorehrJobFamilyQuery): Promise + /** + * 查询单个序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get + */ + getCorehrJobFamily(job_family_id: string): Promise + /** + * 批量查询序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list + */ + listCorehrJobFamily(query?: ListCorehrJobFamilyQuery): Promise + /** + * 查询当前生效信息发生变更的序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_family/query_recent_change + */ + queryRecentChangeCorehrJobFamily(query?: QueryRecentChangeCorehrJobFamilyQuery): Promise + /** + * 通过序列 ID 批量获取序列信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_family/batch_get + */ + batchGetCorehrJobFamily(body: BatchGetCorehrJobFamilyRequest): Promise + /** + * 删除序列 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/delete + */ + deleteCorehrJobFamily(job_family_id: string): Promise + /** + * 新建职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/create + */ + createCorehrJobLevel(body: CreateCorehrJobLevelRequest, query?: CreateCorehrJobLevelQuery): Promise + /** + * 更新单个职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/patch + */ + patchCorehrJobLevel(job_level_id: string, body: PatchCorehrJobLevelRequest, query?: PatchCorehrJobLevelQuery): Promise + /** + * 查询单个职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get + */ + getCorehrJobLevel(job_level_id: string): Promise + /** + * 批量查询职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list + */ + listCorehrJobLevel(query?: ListCorehrJobLevelQuery): Promise + /** + * 查询当前生效信息发生变更的职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_level/query_recent_change + */ + queryRecentChangeCorehrJobLevel(query?: QueryRecentChangeCorehrJobLevelQuery): Promise + /** + * 通过职级 ID 批量获取职级信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_level/batch_get + */ + batchGetCorehrJobLevel(body: BatchGetCorehrJobLevelRequest): Promise + /** + * 删除职级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/delete + */ + deleteCorehrJobLevel(job_level_id: string): Promise + /** + * 创建职等 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/create + */ + createCorehrJobGrade(body: CreateCorehrJobGradeRequest, query?: CreateCorehrJobGradeQuery): Promise + /** + * 更新职等 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/patch + */ + patchCorehrJobGrade(job_grade_id: string, body: PatchCorehrJobGradeRequest, query?: PatchCorehrJobGradeQuery): Promise + /** + * 查询职等 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query + */ + queryCorehrJobGrade(body: QueryCorehrJobGradeRequest, query?: QueryCorehrJobGradeQuery): Promise + /** + * 查询当前生效信息发生变更的职等 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query_recent_change + */ + queryRecentChangeCorehrJobGrade(query?: QueryRecentChangeCorehrJobGradeQuery): Promise + /** + * 删除职等 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/delete + */ + deleteCorehrJobGrade(job_grade_id: string): Promise + /** + * 创建职务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/create + */ + createCorehrJob(body: CreateCorehrJobRequest, query?: CreateCorehrJobQuery): Promise + /** + * 删除职务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/delete + */ + deleteCorehrJob(job_id: string): Promise + /** + * 更新职务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/patch + */ + patchCorehrJob(job_id: string, body: PatchCorehrJobRequest, query?: PatchCorehrJobQuery): Promise + /** + * 查询单个职务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/get + */ + getCorehrJob(job_id: string): Promise + /** + * 批量查询职务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list + */ + listCorehrJob(query?: ListCorehrJobQuery): Promise + /** + * 撤销入职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/withdraw_onboarding + */ + withdrawOnboardingCorehrPreHire(body: WithdrawOnboardingCorehrPreHireRequest): Promise + /** + * 恢复入职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/restore_flow_instance + */ + restoreFlowInstanceCorehrPreHire(body: RestoreFlowInstanceCorehrPreHireRequest): Promise + /** + * 直接创建待入职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/create + */ + createCorehrPreHire(body: CreateCorehrPreHireRequest): Promise + /** + * 更新待入职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/patch + */ + patchCorehrPreHire(pre_hire_id: string, body: PatchCorehrPreHireRequest): Promise + /** + * 删除待入职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/delete + */ + deleteCorehrPreHire(pre_hire_id: string): Promise + /** + * 查询待入职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query + */ + queryCorehrPreHire(body: QueryCorehrPreHireRequest, query?: QueryCorehrPreHireQuery): Promise + /** + * 查询单个待入职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/get + */ + getCorehrPreHire(pre_hire_id: string): Promise + /** + * 批量查询待入职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/list + */ + listCorehrPreHire(query?: ListCorehrPreHireQuery): Promise + /** + * 搜索待入职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search + */ + searchCorehrPreHire(body: SearchCorehrPreHireRequest, query?: SearchCorehrPreHireQuery): Promise + /** + * 流转入职任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/transit_task + */ + transitTaskCorehrPreHire(pre_hire_id: string, body: TransitTaskCorehrPreHireRequest): Promise + /** + * 操作员工完成入职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/complete + */ + completeCorehrPreHire(pre_hire_id: string): Promise + /** + * 删除待入职（不推荐） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/delete + */ + deleteCorehrPreHire(pre_hire_id: string): Promise + /** + * 更新待入职信息（不推荐） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/patch + */ + patchCorehrPreHire(pre_hire_id: string, body: PatchCorehrPreHireRequest, query?: PatchCorehrPreHireQuery): Promise + /** + * 新增试用期考核信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/create + */ + createCorehrProbationAssessment(body: CreateCorehrProbationAssessmentRequest, query?: CreateCorehrProbationAssessmentQuery): Promise + /** + * 启用/停用试用期考核功能 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/enable_disable_assessment + */ + enableDisableAssessmentCorehrProbation(body: EnableDisableAssessmentCorehrProbationRequest): Promise + /** + * 更新试用期考核信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/patch + */ + patchCorehrProbationAssessment(assessment_id: string, body: PatchCorehrProbationAssessmentRequest, query?: PatchCorehrProbationAssessmentQuery): Promise + /** + * 搜索试用期信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search + */ + searchCorehrProbation(body: SearchCorehrProbationRequest, query?: SearchCorehrProbationQuery): Promise + /** + * 删除试用期考核信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation-assessment/delete + */ + deleteCorehrProbationAssessment(assessment_id: string): Promise + /** + * 发起转正 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/submit + */ + submitCorehrProbation(body: SubmitCorehrProbationRequest, query?: SubmitCorehrProbationQuery): Promise + /** + * 撤销转正 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/withdraw + */ + withdrawCorehrProbation(body: WithdrawCorehrProbationRequest, query?: WithdrawCorehrProbationQuery): Promise + /** + * 发起员工异动 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/create + */ + createCorehrJobChange(body: CreateCorehrJobChangeRequest, query?: CreateCorehrJobChangeQuery): Promise + /** + * 获取异动类型列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query + */ + queryCorehrTransferType(query?: QueryCorehrTransferTypeQuery): Promise + /** + * 获取异动原因列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_reason/query + */ + queryCorehrTransferReason(query?: QueryCorehrTransferReasonQuery): Promise + /** + * 搜索员工异动信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search + */ + searchCorehrJobChange(body: SearchCorehrJobChangeRequest, query?: SearchCorehrJobChangeQuery): Promise + /** + * 撤销异动 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/revoke + */ + revokeCorehrJobChange(job_change_id: string, body: RevokeCorehrJobChangeRequest, query?: RevokeCorehrJobChangeQuery): Promise + /** + * 发起员工异动(不推荐) + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/create + */ + createCorehrJobChange(body: CreateCorehrJobChangeRequest, query?: CreateCorehrJobChangeQuery): Promise + /** + * 查询员工离职原因列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query + */ + queryCorehrOffboarding(body: QueryCorehrOffboardingRequest): Promise + /** + * 操作员工离职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/submit_v2 + */ + submitV2CorehrOffboarding(body: SubmitV2CorehrOffboardingRequest, query?: SubmitV2CorehrOffboardingQuery): Promise + /** + * 编辑离职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/edit + */ + editCorehrOffboarding(body: EditCorehrOffboardingRequest, query?: EditCorehrOffboardingQuery): Promise + /** + * 撤销离职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/revoke + */ + revokeCorehrOffboarding(body: RevokeCorehrOffboardingRequest, query?: RevokeCorehrOffboardingQuery): Promise + /** + * 搜索离职信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/search + */ + searchCorehrOffboarding(body: SearchCorehrOffboardingRequest, query?: SearchCorehrOffboardingQuery): Promise + /** + * 新建合同 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/create + */ + createCorehrContract(body: CreateCorehrContractRequest, query?: CreateCorehrContractQuery): Promise + /** + * 更新合同 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/patch + */ + patchCorehrContract(contract_id: string, body: PatchCorehrContractRequest, query?: PatchCorehrContractQuery): Promise + /** + * 删除合同 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/delete + */ + deleteCorehrContract(contract_id: string): Promise + /** + * 查询单个合同 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/get + */ + getCorehrContract(contract_id: string): Promise + /** + * 批量查询合同 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list + */ + listCorehrContract(query?: ListCorehrContractQuery): Promise + /** + * 搜索合同 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/contract/search + */ + searchCorehrContract(body: SearchCorehrContractRequest, query?: SearchCorehrContractQuery): Promise + /** + * 批量创建/更新明细行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail_row/batchSave + */ + batchSaveCorehrWorkforcePlanDetailRow(body: BatchSaveCorehrWorkforcePlanDetailRowRequest): Promise + /** + * 批量删除明细行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail_row/batchDelete + */ + batchDeleteCorehrWorkforcePlanDetailRow(body: BatchDeleteCorehrWorkforcePlanDetailRowRequest): Promise + /** + * 批量创建/更新填报行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/report_detail_row/batchSave + */ + batchSaveCorehrReportDetailRow(body: BatchSaveCorehrReportDetailRowRequest): Promise + /** + * 批量删除填报行 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/report_detail_row/batchDelete + */ + batchDeleteCorehrReportDetailRow(body: BatchDeleteCorehrReportDetailRowRequest): Promise + /** + * 查询编制规划方案 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan/list + */ + listCorehrWorkforcePlan(query?: ListCorehrWorkforcePlanQuery): Promise + /** + * 查询编制规划明细信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail/batch + */ + batchCorehrWorkforcePlanDetail(body: BatchCorehrWorkforcePlanDetailRequest, query?: BatchCorehrWorkforcePlanDetailQuery): Promise + /** + * 创建假期发放记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave_granting_record/create + */ + createCorehrLeaveGrantingRecord(body: CreateCorehrLeaveGrantingRecordRequest, query?: CreateCorehrLeaveGrantingRecordQuery): Promise + /** + * 删除假期发放记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave_granting_record/delete + */ + deleteCorehrLeaveGrantingRecord(leave_granting_record_id: string): Promise + /** + * 获取假期类型列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_types + */ + leaveTypesCorehrLeave(query?: LeaveTypesCorehrLeaveQuery): Promise + /** + * 批量查询员工假期余额 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_balances + */ + leaveBalancesCorehrLeave(query?: LeaveBalancesCorehrLeaveQuery): Promise + /** + * 批量查询员工请假记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_request_history + */ + leaveRequestHistoryCorehrLeave(query?: LeaveRequestHistoryCorehrLeaveQuery): Promise + /** + * 获取工作日历 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar + */ + workCalendarCorehrLeave(body: WorkCalendarCorehrLeaveRequest): Promise + /** + * 根据适用条件获取工作日历 ID + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/calendar_by_scope + */ + calendarByScopeCorehrLeave(query?: CalendarByScopeCorehrLeaveQuery): Promise + /** + * 获取工作日历日期详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar_date + */ + workCalendarDateCorehrLeave(body: WorkCalendarDateCorehrLeaveRequest): Promise + /** + * 批量查询用户授权 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/query + */ + queryCorehrAuthorization(query?: QueryCorehrAuthorizationQuery): Promise + /** + * 查询单个用户授权 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/get_by_param + */ + getByParamCorehrAuthorization(query?: GetByParamCorehrAuthorizationQuery): Promise + /** + * 批量获取角色列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/list + */ + listCorehrSecurityGroup(query?: ListCorehrSecurityGroupQuery): Promise + /** + * 为用户授权角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/add_role_assign + */ + addRoleAssignCorehrAuthorization(body: AddRoleAssignCorehrAuthorizationRequest, query?: AddRoleAssignCorehrAuthorizationQuery): Promise + /** + * 更新用户被授权的数据范围 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/update_role_assign + */ + updateRoleAssignCorehrAuthorization(body: UpdateRoleAssignCorehrAuthorizationRequest, query?: UpdateRoleAssignCorehrAuthorizationQuery): Promise + /** + * 移除用户被授权的角色 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/remove_role_assign + */ + removeRoleAssignCorehrAuthorization(query?: RemoveRoleAssignCorehrAuthorizationQuery): Promise + /** + * 查询员工 HRBP / 属地 BP + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-bp/batch_get + */ + batchGetCorehrEmployeesBp(body: BatchGetCorehrEmployeesBpRequest, query?: BatchGetCorehrEmployeesBpQuery): Promise + /** + * 查询部门 HRBP + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/get_by_department + */ + getByDepartmentCorehrBp(body: GetByDepartmentCorehrBpRequest, query?: GetByDepartmentCorehrBpQuery): Promise + /** + * 查询部门 / 地点的 HRBP / 属地 BP + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/query + */ + queryCorehrSecurityGroup(body: QueryCorehrSecurityGroupRequest, query?: QueryCorehrSecurityGroupQuery): Promise + /** + * 获取 HRBP 列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/list + */ + listCorehrBp(query?: ListCorehrBpQuery): Promise + /** + * 获取组织类角色授权列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/assigned_user/search + */ + searchCorehrAssignedUser(body: SearchCorehrAssignedUserRequest, query?: SearchCorehrAssignedUserQuery): Promise + /** + * 查询流程实例列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/list + */ + listCorehrProcess(query?: ListCorehrProcessQuery): Promise + /** + * 获取单个流程详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/get + */ + getCorehrProcess(process_id: string, query?: GetCorehrProcessQuery): Promise + /** + * 获取流程表单数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-form_variable_data/get + */ + getCorehrProcessFormVariableData(process_id: string, query?: GetCorehrProcessFormVariableDataQuery): Promise + /** + * 撤销流程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process_revoke/update + */ + updateCorehrProcessRevoke(process_id: string, body: UpdateCorehrProcessRevokeRequest, query?: UpdateCorehrProcessRevokeQuery): Promise + /** + * 撤回流程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process_withdraw/update + */ + updateCorehrProcessWithdraw(process_id: string, body: UpdateCorehrProcessWithdrawRequest, query?: UpdateCorehrProcessWithdrawQuery): Promise + /** + * 获取指定人员审批任务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approver/list + */ + listCorehrApprover(query?: ListCorehrApproverQuery): Promise + /** + * 通过/拒绝审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-approver/update + */ + updateCorehrProcessApprover(process_id: string, approver_id: string, body: UpdateCorehrProcessApproverRequest, query?: UpdateCorehrProcessApproverQuery): Promise + /** + * 加签审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-extra/update + */ + updateCorehrProcessExtra(process_id: string, body: UpdateCorehrProcessExtraRequest, query?: UpdateCorehrProcessExtraQuery): Promise + /** + * 转交审批任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-transfer/update + */ + updateCorehrProcessTransfer(process_id: string, body: UpdateCorehrProcessTransferRequest, query?: UpdateCorehrProcessTransferQuery): Promise + /** + * 获取员工薪资标准 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/compensation_standard/match + */ + matchCorehrCompensationStandard(query?: MatchCorehrCompensationStandardQuery): Promise + /** + * 获取流程表单数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/process-form_variable_data/get + */ + getCorehrProcessFormVariableData(process_id: string): Promise + /** + * 批量查询城市/区域信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/list + */ + listCorehrSubregion(query?: ListCorehrSubregionQuery): Promise + /** + * 查询单条城市/区域信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/get + */ + getCorehrSubregion(subregion_id: string): Promise + /** + * 批量查询省份/行政区信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/list + */ + listCorehrSubdivision(query?: ListCorehrSubdivisionQuery): Promise + /** + * 查询单条省份/行政区信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/get + */ + getCorehrSubdivision(subdivision_id: string): Promise + /** + * 批量查询国家/地区信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/list + */ + listCorehrCountryRegion(query?: ListCorehrCountryRegionQuery): Promise + /** + * 查询单条国家/地区信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/get + */ + getCorehrCountryRegion(country_region_id: string): Promise + /** + * 批量查询货币信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/list + */ + listCorehrCurrency(query?: ListCorehrCurrencyQuery): Promise + /** + * 查询单个货币信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/get + */ + getCorehrCurrency(currency_id: string): Promise + /** + * 查询单个职务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get + */ + getCorehrJob(job_id: string): Promise + /** + * 删除部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/delete + */ + deleteCorehrDepartment(department_id: string): Promise + /** + * 更新部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/patch + */ + patchCorehrDepartment(department_id: string, body: PatchCorehrDepartmentRequest, query?: PatchCorehrDepartmentQuery): Promise + /** + * 查询单个部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get + */ + getCorehrDepartment(department_id: string, query?: GetCorehrDepartmentQuery): Promise + /** + * 批量查询职务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/list + */ + listCorehrJob(query?: ListCorehrJobQuery): Promise + /** + * 批量查询部门 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/list + */ + listCorehrDepartment(query?: ListCorehrDepartmentQuery): Promise + /** + * 更新个人信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/patch + */ + patchCorehrPerson(person_id: string, body: PatchCorehrPersonRequest, query?: PatchCorehrPersonQuery): Promise + /** + * 创建个人信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/create + */ + createCorehrPerson(body: CreateCorehrPersonRequest, query?: CreateCorehrPersonQuery): Promise + /** + * 查询单个个人信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/get + */ + getCorehrPerson(person_id: string, query?: GetCorehrPersonQuery): Promise + /** + * 操作员工离职 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/submit + */ + submitCorehrOffboarding(body: SubmitCorehrOffboardingRequest, query?: SubmitCorehrOffboardingQuery): Promise + } +} + +export interface ListObjectApiNameCorehrCustomFieldQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface QueryCorehrCustomFieldQuery { + /** 所属对象 apiname，支持一个或多个当前数量限制为 20 个 */ + object_api_name_list: string[] +} + +export interface GetByParamCorehrCustomFieldQuery { + /** 所属对象 apiname */ + object_api_name: string + /** 自定义字段 apiname */ + custom_api_name: string +} + +export interface AddEnumOptionCorehrCommonDataMetaDataRequest { + /** 所属对象 API name，可通过[获取飞书人事对象列表](/ssl:ttdoc/server-docs/corehr-v1/basic-infomation/custom_field/list_object_api_name)接口中返回的 `object_api_name` 字段获取 */ + object_api_name: string + /** 枚举字段 API name，可通过[获取自定义字段列表](/ssl:ttdoc/server-docs/corehr-v1/basic-infomation/custom_field/query)接口中返回的 `custom_api_name` 字段获取 */ + enum_field_api_name: string + /** 新增枚举选项列表 */ + enum_field_options: EnumFieldOption[] +} + +export interface AddEnumOptionCorehrCommonDataMetaDataQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface EditEnumOptionCorehrCommonDataMetaDataRequest { + /** 所属对象 API name，可通过[获取飞书人事对象列表](/ssl:ttdoc/server-docs/corehr-v1/basic-infomation/custom_field/list_object_api_name)接口中返回的 `object_api_name` 字段获取 */ + object_api_name: string + /** 枚举字段 API name，可通过[获取自定义字段列表](/ssl:ttdoc/server-docs/corehr-v1/basic-infomation/custom_field/query)接口中返回的 `custom_api_name` 字段获取 */ + enum_field_api_name: string + /** 枚举选项 */ + enum_field_option: EnumFieldOption +} + +export interface EditEnumOptionCorehrCommonDataMetaDataQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface SearchCorehrBasicInfoCountryRegionRequest { + /** 国家/地区 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[] +} + +export interface SearchCorehrBasicInfoCountryRegionQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoCountryRegionSubdivisionRequest { + /** 国家/地区 ID 列表，可通过【查询国家/地区信息】接口获取 */ + country_region_id_list?: string[] + /** 省份/行政区 ID 列表 */ + country_region_subdivision_id_list?: string[] + /** 状态列表 */ + status_list?: 1 | 0[] +} + +export interface SearchCorehrBasicInfoCountryRegionSubdivisionQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoCityRequest { + /** 省份/主要行政区 ID 列表，可通过[查询省份/主要行政区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口列举，或从[批量查询地点](/ssl:ttdoc/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.region_id`、[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.region_id` 等字段中获取 */ + country_region_subdivision_id_list?: string[] + /** 城市 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[] +} + +export interface SearchCorehrBasicInfoCityQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoDistrictRequest { + /** 所属城市 ID 列表，可通过[查询城市信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)接口列举，或从[批量查询地点](/ssl:ttdoc/server-docs/corehr-v1/organization-management/location/list)接口返回的 `location.address.city_v2_id`、[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)接口返回的 `person_info.address_list.city_v2_id` 等字段中获取 */ + city_id_list?: string[] + /** 区/县 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[] +} + +export interface SearchCorehrBasicInfoDistrictQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoNationalityRequest { + /** 国籍 ID 列表，可从[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)接口返回的 `person_info.nationality_id_v2` 等字段中获取 */ + nationality_id_list?: string[] + /** 国家/地区 ID 列表，可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口列举 */ + country_region_id_list?: string[] + /** 状态列表 */ + status_list?: 1 | 0[] +} + +export interface SearchCorehrBasicInfoNationalityQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateCorehrNationalIdTypeRequest { + /** 国家 / 地区 */ + country_region_id: string + /** 名称 */ + name: I18n[] + /** 启用 */ + active: boolean + /** 校验规则 */ + validation_rule: string + /** 校验规则描述 */ + validation_rule_description?: I18n[] + /** 编码 */ + code: string + /** 证件类型 */ + identification_type: Enum + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface CreateCorehrNationalIdTypeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrNationalIdTypeRequest { + /** 国家 / 地区 */ + country_region_id?: string + /** 名称 */ + name?: I18n[] + /** 启用 */ + active?: boolean + /** 校验规则 */ + validation_rule?: string + /** 校验规则描述 */ + validation_rule_description?: I18n[] + /** 编码 */ + code?: string + /** 证件类型 */ + identification_type?: Enum + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface PatchCorehrNationalIdTypeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ListCorehrNationalIdTypeQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 证件类型 */ + identification_type?: string + /** 证件类型编码 */ + code?: string + /** 国家地区ID */ + country_region_id?: string +} + +export interface SearchCorehrBasicInfoBankRequest { + /** 银行 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[] + /** 最早更新时间 */ + update_start_time?: string + /** 最晚更新时间 */ + update_end_time?: string +} + +export interface SearchCorehrBasicInfoBankQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoBankBranchRequest { + /** 银行 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[] + /** 支行 ID 列表，可通过[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)、[批量查询员工信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)等接口返回的 `person_info.bank_account_list.bank_branch_id_v2` 字段获取 */ + bank_branch_id_list?: string[] + /** 支行名称列表，支持对支行名称精确搜索 */ + bank_branch_name_list?: string[] + /** 金融分支机构编码（联行号）列表，支持对金融分支机构编码精确搜索 */ + code_list?: string[] + /** 状态列表 */ + status_list?: 1 | 0[] + /** 最早更新时间 */ + update_start_time?: string + /** 最晚更新时间 */ + update_end_time?: string +} + +export interface SearchCorehrBasicInfoBankBranchQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoCurrencyRequest { + /** 货币 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[] +} + +export interface SearchCorehrBasicInfoCurrencyQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoTimeZoneRequest { + /** 时区 ID 列表 */ + time_zone_id_list?: string[] + /** 状态列表 */ + status_list?: 1 | 0[] +} + +export interface SearchCorehrBasicInfoTimeZoneQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoLanguageRequest { + /** 语言 ID 列表 */ + language_id_list?: string[] + /** 状态列表 */ + status_list?: 1 | 0[] +} + +export interface SearchCorehrBasicInfoLanguageQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateCorehrEmployeeTypeRequest { + /** 名称 */ + name: I18n[] + /** 默认雇员类型 */ + default_employee_type: boolean + /** 启用 */ + active: boolean + /** 编码 */ + code?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface CreateCorehrEmployeeTypeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrEmployeeTypeRequest { + /** 名称 */ + name?: I18n[] + /** 默认雇员类型 */ + default_employee_type?: boolean + /** 启用 */ + active?: boolean + /** 编码 */ + code?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface PatchCorehrEmployeeTypeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ListCorehrEmployeeTypeQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface CreateCorehrWorkingHoursTypeRequest { + /** 编码 */ + code?: string + /** 名称 */ + name: I18n[] + /** 国家/地区 */ + country_region_id_list?: string[] + /** 职务默认值 */ + default_for_job: boolean + /** 启用 */ + active: boolean + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface CreateCorehrWorkingHoursTypeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrWorkingHoursTypeRequest { + /** 编码 */ + code?: string + /** 名称 */ + name?: I18n[] + /** 国家/地区 */ + country_region_id_list?: string[] + /** 职务默认值 */ + default_for_job?: boolean + /** 启用 */ + active?: boolean + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface PatchCorehrWorkingHoursTypeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ListCorehrWorkingHoursTypeQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface ConvertCorehrCommonDataIdRequest { + /** ID 列表（最多传入 100 个 ID，ID 长度限制 50 个字符） */ + ids: string[] +} + +export interface ConvertCorehrCommonDataIdQuery { + /** ID 转换类型 */ + id_transform_type: 1 | 2 | 3 | 4 + /** 要转换的ID类型 */ + id_type: 'user_id' | 'department_id' | 'job_level_id' | 'job_family_id' | 'employee_type_id' + /** 用户 ID 类型 */ + feishu_user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 类型 */ + feishu_department_id_type?: 'open_department_id' | 'department_id' +} + +export interface BatchGetCorehrEmployeeRequest { + /** 返回数据的字段列表，填写方式：为空时默认仅返回 ID */ + fields?: string[] + /** 雇佣 ID 列表 */ + employment_ids?: string[] + /** 个人信息 ID 列表，employment_ids参数有值时该参数不生效 */ + person_ids?: string[] + /** 主工作邮箱列表 */ + work_emails?: string[] +} + +export interface BatchGetCorehrEmployeeQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface SearchCorehrEmployeeRequest { + /** 返回数据的字段列表，填写方式：为空时默认仅返回 ID */ + fields?: string[] + /** 雇佣 ID 列表 */ + employment_id_list?: string[] + /** 工号列表 */ + employee_number_list?: string[] + /** 邮箱，精确匹配查询 */ + work_email?: string + /** 个人电话，精确匹配查询 */ + phone_number?: string + /** 搜索关键字，支持对邮箱、工号和姓名的模糊匹配 */ + key_word?: string + /** 雇佣状态 */ + employment_status?: 'hired' | 'terminated' + /** 人员类型 ID */ + employee_type_id?: string + /** 部门 ID，根据员工主职的直接部门查询，可以通过【查询部门】API 获取 部门 ID */ + department_id_list?: string[] + /** 直接上级的雇佣 ID，根据员工主职的直接上级查询 */ + direct_manager_id_list?: string[] + /** 虚线上级的雇佣 ID，根据员工主职的虚线上级查询 */ + dotted_line_manager_id_list?: string[] + /** 转正式员工日期-搜索范围开始 */ + regular_employee_start_date_start?: string + /** 转正式员工日期-搜索范围结束 */ + regular_employee_start_date_end?: string + /** 入职日期-搜索范围开始，需要与搜索范围结束一同使用 */ + effective_time_start?: string + /** 入职日期-搜索范围结束 */ + effective_time_end?: string + /** 工作地点 ID 列表，查询属于该工作地点及下级工作地点的员工 */ + work_location_id_list_include_sub?: string[] + /** 常用英文全名精确搜索 */ + preferred_english_full_name_list?: string[] + /** 常用本地全名精确搜索 */ + preferred_local_full_name_list?: string[] + /** 居民身份证件号码精确搜索 */ + national_id_number_list?: string[] + /** 个人电话列表，精确匹配查询 */ + phone_number_list?: string[] + /** 工作邮箱地址列表，精确匹配查询 */ + email_address_list?: string[] + /** 部门 ID 列表，查询属于该部门及下级部门的员工 */ + department_id_list_include_sub?: string[] + /** 其他国籍ID列表，精准匹配查询 */ + additional_national_id_number_list?: string[] + /** 公民身份类型列表，精确匹配查询 */ + citizenship_status_list?: string[] + /** 成本中心 ID 列表- 可通过 [【搜索成本中心信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search) 获取 */ + cost_center_id_list?: string[] + /** 任职公司 ID 列表- [【批量查询公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取 */ + service_company_list?: string[] + /** 任职公司 ID 列表（含下级）- [【批量查询公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取 */ + service_company_list_include_sub?: string[] + /** 序列 ID 列表 - [【批量查询序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取 */ + job_family_id_list?: string[] + /** 序列 ID 列表（含下级） - [【批量查询序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取 */ + job_family_id_list_include_sub?: string[] + /** 职级 ID 列表- 可通过[【批量查询职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取- 需要有字段读取权限 */ + job_level_id_list?: string[] + /** 职等 ID 列表- 可通过[【查询职等】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取- 需要有字段读取权限 */ + job_grade_id_list?: string[] + /** 职务 ID 列表- 可通过[【批量查询职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取- 需要有字段读取权限 */ + job_id_list?: string[] + /** 岗位 ID 列表 - 功能灰度中，如有需求请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) - 需要有字段读取权限 */ + position_id_list?: string[] + /** 岗位 ID 列表（含下级） - 功能灰度中，如有需求请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) - 需要有字段读取权限 */ + position_id_list_include_sub?: string[] + /** 工时制度 ID 列表- 可通过[【批量查询工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取- 需要有字段读取权限 */ + working_hours_type_id_list?: string[] + /** 国籍 ID 列表- 可通过[【查询国籍信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search)获取- 需要有字段读取权限 */ + nationality_id_list?: string[] + /** 员工所属薪资组 ID 列表 - 可通过 [【获取薪资组基本信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list) 获取 - 需要有字段读取权限 */ + pay_group_id_list?: string[] + /** 员工所属外派薪资组 ID 列表- 可通过 [【获取薪资组基本信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list) 获取- 需要有字段读取权限 */ + assignment_pay_group_id_list?: string[] + /** 员工当前合同类型列表- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)查询 - object_api_name：contract - custom_api_name：contract_type- 需要有字段读取权限 */ + contract_type_list?: string[] + /** 员工当前所属薪资方案 ID 列表- 可通过[【批量查询薪资方案】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list)获取- 需要有字段读取权限 */ + archive_cpst_plan_id_list?: string[] +} + +export interface SearchCorehrEmployeeQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface CreateCorehrEmployeeRequest { + /** 个人信息 */ + personal_info?: ProfileSettingPersonalInfo + /** 工作信息 */ + employment_info?: ProfileSettingEmploymentInfo + /** 履历信息 */ + career?: ProfileSettingCareer + /** 资料附件 */ + data_attachment?: ProfileSettingDataAttachment +} + +export interface CreateCorehrEmployeeQuery { + /** 幂等标识，服务端会忽略client_token重复的请求 */ + client_token?: string + /** 是否为离职重聘：false: 否，系统直接标为非离职重聘人员，不再做重复判断"true: 是，要求rehire_employment_id */ + rehire?: boolean + /** 离职重聘员工雇佣ID, rehire */ + rehire_employment_id?: string + /** 是否强制提交，超编等场景需要用户确认影响才能提交 */ + force_submit?: boolean + /** 是否忽略工时制度自动生成规则 */ + ignore_working_hours_type_rule?: boolean +} + +export interface CreateCorehrPersonRequest { + /** 姓名列表 */ + name_list: PersonName[] + /** -| 性别，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：gender - object_api_name：person */ + gender?: Enum + /** 出生日期 */ + date_of_birth?: string + /** 国籍 ID，可通过【查询国籍信息】接口查询 */ + nationality_id_v2?: string + /** -| 民族 / 种族，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：ethnicity_race - object_api_name：person */ + race?: Enum + /** -| 婚姻状况，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：marital_status - object_api_name：person */ + marital_status?: Enum + /** 电话列表，只有当满足下面所有条件时，电话在个人信息页才可见 */ + phone_list?: Phone[] + /** 地址列表 */ + address_list?: Address[] + /** 邮箱列表 */ + email_list?: Email[] + /** 工作经历列表 */ + work_experience_list?: WorkExperienceInfo[] + /** 教育经历列表 */ + education_list?: Education[] + /** 银行账户 */ + bank_account_list?: BankAccount[] + /** 证件 */ + national_id_list?: NationalId[] + /** 家庭成员列表 */ + dependent_list?: Dependent[] + /** 紧急联系人列表 */ + emergency_contact_list?: EmergencyContact[] + /** 参加工作日期 */ + date_entered_workforce?: string + /** 头像资源的 ID */ + profile_image_id?: string + /** 个人资料附件 */ + personal_profile?: PersonalProfile[] + /** 籍贯 ID */ + native_region?: string + /** 户口类型，枚举值可通过文档【飞书人事枚举常量】户口类型（hukou_type）枚举定义部分获得 */ + hukou_type?: Enum + /** 户口所在地 */ + hukou_location?: string + /** 政治面貌，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：political_affiliation - object_api_name：person_info_chn */ + political_affiliations?: Enum[] + /** 人才 ID */ + talent_id?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 出生国家/地区 */ + born_country_region?: string + /** 是否残疾 */ + is_disabled?: boolean + /** 残疾证号 */ + disable_card_number?: string + /** 是否烈属 */ + is_martyr_family?: boolean + /** 烈属证号 */ + martyr_card_number?: string + /** 是否孤老 */ + is_old_alone?: boolean + /** 居民身份信息 */ + resident_taxes?: ResidentTax[] + /** 首次入境日期 */ + first_entry_time?: string + /** 预计离境日期 */ + leave_time?: string +} + +export interface CreateCorehrPersonQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrPersonRequest { + /** 姓名列表 */ + name_list?: PersonName[] + /** -| 性别，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：gender - object_api_name：person */ + gender?: Enum + /** 出生日期 */ + date_of_birth?: string + /** 国籍 ID，可通过【查询国籍信息】接口查询 */ + nationality_id_v2?: string + /** -| 民族 / 种族，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：ethnicity_race - object_api_name：person */ + race?: Enum + /** -| 婚姻状况，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：marital_status - object_api_name：person */ + marital_status?: Enum + /** 电话列表，只有当满足下面所有条件时，电话在个人信息页才可见 */ + phone_list?: Phone[] + /** 地址列表 */ + address_list?: Address[] + /** 邮箱列表 */ + email_list?: Email[] + /** 工作经历列表 */ + work_experience_list?: WorkExperienceInfo[] + /** 教育经历列表 */ + education_list?: Education[] + /** 银行账户 */ + bank_account_list?: BankAccount[] + /** 证件 */ + national_id_list?: NationalId[] + /** 家庭成员列表 */ + dependent_list?: Dependent[] + /** 紧急联系人列表 */ + emergency_contact_list?: EmergencyContact[] + /** 参加工作日期 */ + date_entered_workforce?: string + /** 头像资源的 ID */ + profile_image_id?: string + /** 个人资料附件 */ + personal_profile?: PersonalProfile[] + /** 籍贯 ID */ + native_region?: string + /** 户口类型，枚举值可通过文档【飞书人事枚举常量】户口类型（hukou_type）枚举定义部分获得 */ + hukou_type?: Enum + /** 户口所在地 */ + hukou_location?: string + /** 政治面貌，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：political_affiliation - object_api_name：person_info_chn */ + political_affiliations?: Enum[] + /** 人才 ID */ + talent_id?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 出生国家/地区 */ + born_country_region?: string + /** 是否残疾 */ + is_disabled?: boolean + /** 残疾证号 */ + disable_card_number?: string + /** 是否烈属 */ + is_martyr_family?: boolean + /** 烈属证号 */ + martyr_card_number?: string + /** 是否孤老 */ + is_old_alone?: boolean + /** 居民身份信息 */ + resident_taxes?: ResidentTax[] + /** 首次入境日期 */ + first_entry_time?: string + /** 预计离境日期 */ + leave_time?: string +} + +export interface PatchCorehrPersonQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string + /** 根据no_need_query判断更新后是否做查询请求并返回个人信息 */ + no_need_query?: boolean +} + +export interface UploadCorehrPersonForm { + /** 文件二进制内容 */ + file_content: Blob + /** 文件名称 */ + file_name: string +} + +export interface CreateCorehrEmploymentRequest { + /** 资历起算日期 */ + seniority_date?: string + /** 员工编号 */ + employee_number?: string + /** 入职日期 */ + effective_time: string + /** 离职日期 */ + expiration_time?: string + /** 雇佣类型 */ + employment_type: Enum + /** 人员信息，引用Person的ID */ + person_id: string + /** 是否是主雇佣信息 */ + primary_employment: boolean + /** 雇员状态 */ + employment_status: Enum + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 工作邮箱列表 */ + work_email_list?: Email[] + /** 离职原因 */ + reason_for_offboarding?: Enum + /** 招聘应用 ID */ + ats_application_id?: string + /** 是否离职重聘 */ + rehire?: Enum + /** 历史雇佣信息 ID */ + rehire_employment_id?: string +} + +export interface CreateCorehrEmploymentQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrEmploymentRequest { + /** 资历起算日期 */ + seniority_date?: string + /** 员工编号 */ + employee_number?: string + /** 雇佣类型 */ + employment_type?: Enum + /** 人员信息，引用Person的ID */ + person_id?: string + /** 是否是主雇佣信息 */ + primary_employment?: boolean + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 工作邮箱列表 */ + work_email_list?: Email[] + /** 离职原因 */ + reason_for_offboarding?: Enum + /** 招聘应用 ID */ + ats_application_id?: string +} + +export interface PatchCorehrEmploymentQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface DeleteCorehrEmploymentQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface CreateCorehrJobDataRequest { + /** 级别 */ + job_level_id?: string + /** 职等ID */ + job_grade_id?: string + /** 雇员类型 */ + employee_type_id: string + /** 工时制度 */ + working_hours_type_id?: string + /** 工作地点 */ + work_location_id?: string + /** 部门 */ + department_id: string + /** 职务 */ + job_id?: string + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期 */ + probation_end_date?: string + /** 主任职 */ + primary_job_data: boolean + /** Employment ID */ + employment_id: string + /** 生效时间 */ + effective_time: string + /** 失效时间 */ + expiration_time?: string + /** 职务分类 ID */ + job_family_id?: string + /** 任职原因 */ + assignment_start_reason: Enum + /** 试用期结束日期 */ + probation_expected_end_date?: string + /** 实线主管 */ + direct_manager_id?: string + /** 虚线主管 */ + dotted_line_manager_id_list?: string[] + /** 第二实线主管 */ + second_direct_manager_id?: string + /** 成本中心分摊信息 */ + cost_center_rate?: SupportCostCenterItem[] + /** 排班类型 */ + work_shift?: Enum + /** 薪资类型 */ + compensation_type?: Enum + /** 任职公司 */ + service_company?: string +} + +export interface CreateCorehrJobDataQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface DeleteCorehrJobDataQuery { + /** 需要删除的任职记录版本 ID */ + version_id?: string +} + +export interface PatchCorehrJobDataRequest { + /** 任职记录版本 ID */ + version_id?: string + /** 级别 */ + job_level_id?: string + /** 职等ID */ + job_grade_id?: string + /** 雇员类型 */ + employee_type_id?: string + /** 工时制度 */ + working_hours_type_id?: string + /** 工作地点 */ + work_location_id?: string + /** 部门 */ + department_id?: string + /** 职务 */ + job_id?: string + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期 */ + probation_end_date?: string + /** 主任职 */ + primary_job_data?: boolean + /** 生效时间 */ + effective_time?: string + /** 失效时间 */ + expiration_time?: string + /** 职务分类 ID */ + job_family_id?: string + /** 任职原因 */ + assignment_start_reason?: Enum + /** 试用期结束日期 */ + probation_expected_end_date?: string + /** 实线主管 */ + direct_manager_id?: string + /** 虚线主管 */ + dotted_line_manager_id_list?: string[] + /** 第二实线主管 */ + second_direct_manager_id?: string + /** 成本中心分摊信息 */ + cost_center_rate?: SupportCostCenterItem[] + /** 排班类型 */ + work_shift?: Enum + /** 薪资类型 */ + compensation_type?: Enum + /** 任职公司 */ + service_company?: string +} + +export interface PatchCorehrJobDataQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' + /** 是否强校验。值为 true 时，会对入参进行业务校验，并产生异动记录、发送异动事件。- 默认值：false- 仅在新增任职版本时生效，当 version_id 不为空时该字段不生效 */ + strict_verify?: string +} + +export interface QueryCorehrEmployeesJobDataRequest { + /** 是否获取所有任职记录，true 为获取员工所有版本的任职记录，false 为仅获取当前生效的任职记录，默认为 false */ + get_all_version?: boolean + /** 查看数据日期 */ + data_date?: string + /** 生效日期 - 搜索范围开始 */ + effective_date_start?: string + /** 生效日期 - 搜索范围结束 */ + effective_date_end?: string + /** 部门 ID */ + department_id?: string + /** 员工雇佣 ID 列表 */ + employment_ids?: string[] + /** 是否仅查询主职- true：仅返回 primary_job_data 为 true 的任职记录- false：仅返回 primary_job_data 为 false 的任职记录- 不传：返回全部 */ + primary_job_data?: boolean + /** 任职原因- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：assignment_start_reason */ + assignment_start_reasons?: string[] +} + +export interface QueryCorehrEmployeesJobDataQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface BatchGetCorehrEmployeesJobDataRequest { + /** 员工雇佣 ID 列表 */ + employment_ids: string[] + /** 是否获取所有任职记录，true 为获取员工所有版本的任职记录，false 为仅获取当前生效的任职记录，默认为 false */ + get_all_version?: boolean + /** 生效日期 - 搜索范围开始 */ + effective_date_start?: string + /** 生效日期 - 搜索范围结束 */ + effective_date_end?: string + /** 查看数据日期，默认为今天 */ + data_date?: string + /** 是否仅查询主职- true：仅返回 primary_job_data 为 true 的任职记录- false：仅返回 primary_job_data 为 false 的任职记录- 不传：返回全部 */ + primary_job_data?: boolean + /** 任职原因- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：assignment_start_reason */ + assignment_start_reasons?: string[] +} + +export interface BatchGetCorehrEmployeesJobDataQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface ListCorehrJobDataQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 雇佣 ID */ + employment_id?: string + /** 任职信息 ID 列表，最大 100 个（不传则默认查询全部任职信息） */ + job_data_id_list?: string[] + /** 部门 ID */ + department_id?: string + /** 职务 ID */ + job_id?: string + /** 是否获取所有任职记录，true 为获取员工所有版本的任职记录，false 为仅获取当前生效的任职记录，默认为 false */ + get_all_version?: boolean + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface GetCorehrJobDataQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface CreateCorehrEmployeesAdditionalJobRequest { + /** 人员类型 ID，可通过[【批量查询人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取 */ + employee_type_id: string + /** 工时制度 ID，可通过[【批量查询工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取详细信息 */ + working_hours_type_id?: string + /** 工作地点 ID，可通过[【批量查询地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)获取详细信息 */ + work_location_id?: string + /** 部门 ID，可通过[【批量查询部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)获取详细信息；类型与department_id_type一致 */ + department_id: string + /** 职务 ID，可通过[【批量查询职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取详细信息 */ + job_id?: string + /** 职级 ID，可通过[【批量查询职级】](/ssl:ttdoc//uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取详细信息 */ + job_level_id?: string + /** 序列 ID，可通过[【批量查询序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取详细信息 */ + job_family_id?: string + /** 雇佣 ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + employment_id: string + /** 兼职开始日期 */ + start_date: string + /** 兼职结束日期，不可清空 */ + end_date?: string + /** 直属上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + direct_manager_id?: string + /** 虚线上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + dotted_line_manager_id?: string + /** 排班类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "work_shift" */ + work_shift?: Enum + /** 薪资类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "compensation_type" */ + compensation_type?: Enum + /** 任职公司，可通过[【批量查询公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取详细信息 */ + service_company?: string + /** 周工作时长【0~168】 */ + weekly_working_hours?: string + /** 工作日历ID，可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */ + work_calendar_id?: string + /** 岗位 ID */ + position_id?: string + /** 人员子类型 ID */ + employee_subtype_id?: string +} + +export interface CreateCorehrEmployeesAdditionalJobQuery { + /** 操作的唯一标识，用于幂等校验。请求成功时，重复的client_token不会再创建、变更数据。 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface PatchCorehrEmployeesAdditionalJobRequest { + /** 人员类型 ID，可通过[【批量查询人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)获取 */ + employee_type_id?: string + /** 工时制度 ID，可通过[【批量查询工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)获取详细信息 */ + working_hours_type_id?: string + /** 工作地点 ID，可通过[【批量查询地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)获取详细信息 */ + work_location_id?: string + /** 部门 ID，可通过[【批量查询部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)获取详细信息；类型与department_id_type一致 */ + department_id?: string + /** 职务 ID，可通过[【批量查询职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)获取详细信息 */ + job_id?: string + /** 职级 ID，可通过[【批量查询职级】](/ssl:ttdoc//uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)获取详细信息 */ + job_level_id?: string + /** 序列 ID，可通过[【批量查询序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)获取详细信息 */ + job_family_id?: string + /** 兼职开始日期 */ + start_date?: string + /** 兼职结束日期，不可清空 */ + end_date?: string + /** 直属上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + direct_manager_id?: string + /** 虚线上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + dotted_line_manager_id?: string + /** 排班类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "work_shift" */ + work_shift?: Enum + /** 薪资类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "compensation_type" */ + compensation_type?: Enum + /** 任职公司，可通过[【批量查询公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)获取详细信息 */ + service_company?: string + /** 周工作时长【0~168】 */ + weekly_working_hours?: string + /** 工作日历ID，可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */ + work_calendar_id?: string + /** 岗位 ID */ + position_id?: string + /** 人员子类型 ID */ + employee_subtype_id?: string +} + +export interface PatchCorehrEmployeesAdditionalJobQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface BatchCorehrEmployeesAdditionalJobRequest { + /** 雇佣 ID */ + employment_ids?: string[] + /** 兼职 ID */ + additional_job_ids?: string[] + /** 开始日期 */ + start_date?: EmployeesAdditionalJobBatchReqDate + /** 结束日期 */ + end_date?: EmployeesAdditionalJobBatchReqDate + /** 查看数据日期，默认当天 */ + data_date?: string + /** 仅查询 【data_date】日期生效中的 */ + is_effective?: boolean +} + +export interface BatchCorehrEmployeesAdditionalJobQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface QueryOperationLogsCorehrDepartmentRequest { + /** 部门ID列表 */ + department_ids: string[] + /** 查询的起始操作日期，格式 "YYYY-MM-DD"，不带时分秒，包含start_date传入的时间，系统会以start_date的00:00:00为开始时间进行查询 */ + start_date: string + /** 查询的截止操作日期，格式 "YYYY-MM-DD"，不带时分秒，包含end_date传入的时间，系统会以end_date的23:59:59为截止时间进行查询。查询截止日期应大于起始日期，起止日期跨度最大为366天 */ + end_date: string +} + +export interface QueryOperationLogsCorehrDepartmentQuery { + /** 分页大小，最大 1000 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface CreateCorehrDepartmentRequest { + /** 子类型 */ + sub_type?: Enum + /** 部门负责人 */ + manager?: string + /** 是否保密 */ + is_confidential?: boolean + /** 层级关系，内层字段见实体 */ + hiberarchy_common: HiberarchyCommon + /** 生效时间 */ + effective_time: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 成本中心id */ + cost_center_id?: string + /** 是否使用职务 */ + staffing_model?: Enum +} + +export interface CreateCorehrDepartmentQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface PatchCorehrDepartmentRequest { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 子类型 */ + sub_type?: Enum + /** 部门负责人 */ + manager?: string + /** 是否保密 */ + is_confidential?: boolean + /** 层级关系，内层字段见实体 */ + hiberarchy_common?: HiberarchyCommon + /** 生效时间 */ + effective_time: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 成本中心id */ + cost_center_id?: string + /** 是否使用职务 */ + staffing_model?: Enum +} + +export interface PatchCorehrDepartmentQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface ParentsCorehrDepartmentRequest { + /** 部门 ID 列表，一次性最多传入 100 个部门 ID */ + department_id_list: string[] +} + +export interface ParentsCorehrDepartmentQuery { + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface BatchGetCorehrDepartmentRequest { + /** 部门 ID 列表 */ + department_id_list?: string[] + /** 返回数据的字段列表 */ + fields?: string[] + /** 部门名称精确匹配，最多传100个 */ + department_name_list?: string[] +} + +export interface BatchGetCorehrDepartmentQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface QueryRecentChangeCorehrDepartmentQuery { + /** 分页大小，最大 2000 */ + page_size: number + /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的开始时间，格式 "yyyy-MM-dd"，不带时分秒，包含 start_date 传入的时间, 系统会以 start_date 的 00:00:00 查询。 */ + start_date: string + /** 查询的结束时间，格式 "yyyy-MM-dd"，不带时分秒， 查询日期小于 end_data + 1 天的 00:00:00。 */ + end_date: string + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface QueryTimelineCorehrDepartmentRequest { + /** 部门 ID 列表 */ + department_ids: string[] + /** 生效日期 */ + effective_date: string + /** 返回数据的字段列表，可选["department_name", "code", "active", "parent_department_id", "manager", "description", "effective_date"] */ + fields?: string[] +} + +export interface QueryTimelineCorehrDepartmentQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface TreeCorehrDepartmentRequest { + /** 部门 ID，默认根部门 */ + department_id?: string + /** 是否包含失效部门，默认false */ + need_inactive?: boolean + /** 生效日期，格式yyyy-mm-dd，默认当前日期 */ + effective_date?: string +} + +export interface TreeCorehrDepartmentQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface QueryMultiTimelineCorehrDepartmentRequest { + /** 部门 ID 列表 */ + department_ids: string[] + /** 生效日期开始(包含) */ + effective_date_start?: string + /** 生效日期结束(包含) */ + effective_date_end?: string + /** 返回数据的字段列表，可选["department_name", "code", "active", "parent_department_id", "manager", "description", "effective_date"], 以及自定义字段field_name */ + fields?: string[] +} + +export interface QueryMultiTimelineCorehrDepartmentQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface SearchCorehrDepartmentRequest { + /** 是否启用 */ + active?: boolean + /** 当通过上级部门 ID 查询时，填写 true 返回所有子部门，填写 false 只返回直接下级部门 */ + get_all_children?: boolean + /** manager ID 列表**字段权限要求：按照部门负责人搜索 (corehr:department.manager.search:read)** */ + manager_list?: string[] + /** 部门 ID 列表 */ + department_id_list?: string[] + /** 部门名称列表，需精确匹配 */ + name_list?: string[] + /** 上级部门 ID ，可查询直接下级部门**字段权限要求：按照上级部门搜索 (corehr:department.organize.search:read) ** */ + parent_department_id?: string + /** 部门 code 列表 */ + code_list?: string[] + /** 返回数据的字段列表 */ + fields?: string[] +} + +export interface SearchCorehrDepartmentQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface DeleteCorehrDepartmentQuery { + /** 此次删除中所使用的部门ID类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface CreateCorehrLocationRequest { + /** 层级关系，内层字段见实体 */ + hiberarchy_common: HiberarchyCommon + /** 地点用途 */ + location_usage_list?: Enum[] + /** 地址 */ + address?: Address[] + /** 工时制度 */ + working_hours_type_id?: string + /** 生效时间 */ + effective_time: string + /** 区域设置 */ + locale?: Enum + /** 时区 */ + time_zone_id?: string + /** 默认显示语言 */ + display_language_id?: string +} + +export interface CreateCorehrLocationQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrLocationRequest { + /** 上级地点 ID */ + parent_id?: string + /** 地点名称 */ + names?: I18n[] + /** 是否启用 */ + active?: boolean + /** 生效时间 */ + effective_time: string + /** 地点编码 */ + code?: string + /** 地点描述 */ + descriptions?: I18n[] + /** 地点用途 */ + location_usages?: Enum[] + /** 工时制度 ID */ + working_hours_type_id?: string + /** 区域设置 */ + locale?: Enum + /** 时区 ID */ + time_zone_id?: string + /** 默认显示语言 ID */ + display_language_id?: string +} + +export interface PatchCorehrLocationQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface QueryRecentChangeCorehrLocationQuery { + /** 分页大小，最大 2000 */ + page_size: number + /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ + start_date: string + /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ + end_date: string +} + +export interface BatchGetCorehrLocationRequest { + /** 地点 ID 列表 */ + location_ids: string[] +} + +export interface ListCorehrLocationQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface ActiveCorehrLocationRequest { + /** 地点 ID */ + location_id: string + /** 生效时间 */ + effective_time: string + /** 启用停用状态 */ + active: boolean + /** 操作原因 */ + operation_reason: string +} + +export interface PatchCorehrLocationAddressRequest { + /** 国家 / 地区 */ + country_region_id?: string + /** 主要行政区 */ + region_id?: string + /** 城市 */ + city_id?: string + /** 区 / 县 */ + distinct_id?: string + /** 地址行 1（非拉丁语系的本地文字） */ + local_address_line1?: string + /** 地址行 2（非拉丁语系的本地文字） */ + local_address_line2?: string + /** 地址行 3（非拉丁语系的本地文字） */ + local_address_line3?: string + /** 地址行 4（非拉丁语系的本地文字） */ + local_address_line4?: string + /** 地址行 5（非拉丁语系的本地文字） */ + local_address_line5?: string + /** 地址行 6（非拉丁语系的本地文字） */ + local_address_line6?: string + /** 地址行 7（非拉丁语系的本地文字） */ + local_address_line7?: string + /** 地址行 8（非拉丁语系的本地文字） */ + local_address_line8?: string + /** 地址行 9（非拉丁语系的本地文字） */ + local_address_line9?: string + /** 邮政编码 */ + postal_code?: string + /** 地址类型，枚举值及详细信息可通过【枚举常量介绍】查询获得 */ + address_types?: Enum[] + /** 是否主要地址 */ + is_primary?: boolean + /** 是否公开地址 */ + is_public?: boolean +} + +export interface PatchCorehrLocationAddressQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface CreateCorehrLocationAddressRequest { + /** 国家 / 地区 */ + country_region_id: string + /** 主要行政区 */ + region_id: string + /** 城市 */ + city_id: string + /** 区 / 县 */ + distinct_id: string + /** 地址行 1（非拉丁语系的本地文字） */ + local_address_line1?: string + /** 地址行 2（非拉丁语系的本地文字） */ + local_address_line2?: string + /** 地址行 3（非拉丁语系的本地文字） */ + local_address_line3?: string + /** 地址行 4（非拉丁语系的本地文字） */ + local_address_line4?: string + /** 地址行 5（非拉丁语系的本地文字） */ + local_address_line5?: string + /** 地址行 6（非拉丁语系的本地文字） */ + local_address_line6?: string + /** 地址行 7（非拉丁语系的本地文字） */ + local_address_line7?: string + /** 地址行 8（非拉丁语系的本地文字） */ + local_address_line8?: string + /** 地址行 9（非拉丁语系的本地文字） */ + local_address_line9?: string + /** 邮政编码 */ + postal_code?: string + /** 地址类型，枚举值及详细信息可通过【枚举常量介绍】查询获得 */ + address_types?: Enum[] + /** 是否主要地址 */ + is_primary?: boolean + /** 是否公开地址 */ + is_public?: boolean +} + +export interface CreateCorehrLocationAddressQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface CreateCorehrCompanyRequest { + /** 层级关系，内层字段见实体 */ + hiberarchy_common: HiberarchyCommon + /** 性质 */ + type?: Enum + /** 行业 */ + industry_list?: Enum[] + /** 法定代表人 */ + legal_representative?: I18n[] + /** 邮编 */ + post_code?: string + /** 纳税人识别号 */ + tax_payer_id?: string + /** confidential */ + confidential?: boolean + /** 主体类型 */ + sub_type_list?: Enum[] + /** 是否为分公司 */ + branch_company?: boolean + /** 主要负责人 */ + primary_manager?: I18n[] + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 默认币种 */ + currency?: Currency + /** 电话 */ + phone?: PhoneNumberAndAreaCode + /** 传真 */ + fax?: PhoneNumberAndAreaCode + /** 注册地址详细信息 */ + registered_office_address_info?: Address + /** 办公地址详细信息 */ + office_address_info?: Address +} + +export interface CreateCorehrCompanyQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrCompanyRequest { + /** 层级关系，内层字段见实体 */ + hiberarchy_common?: HiberarchyCommon + /** 性质 */ + type?: Enum + /** 行业 */ + industry_list?: Enum[] + /** 法定代表人 */ + legal_representative?: I18n[] + /** 邮编 */ + post_code?: string + /** 纳税人识别号 */ + tax_payer_id?: string + /** confidential */ + confidential?: boolean + /** 主体类型 */ + sub_type_list?: Enum[] + /** 是否为分公司 */ + branch_company?: boolean + /** 主要负责人 */ + primary_manager?: I18n[] + /** 默认币种 */ + currency?: Currency + /** 电话 */ + phone?: PhoneNumberAndAreaCode + /** 传真 */ + fax?: PhoneNumberAndAreaCode + /** 注册地址详细信息 */ + registered_office_address_info?: Address + /** 办公地址详细信息 */ + office_address_info?: Address +} + +export interface PatchCorehrCompanyQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ActiveCorehrCompanyRequest { + /** 公司ID */ + company_id: string + /** 生效时间 */ + effective_time: string + /** 启用停用状态 */ + active: boolean + /** 操作原因 */ + operation_reason: string +} + +export interface ListCorehrCompanyQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface QueryRecentChangeCorehrCompanyQuery { + /** 分页大小，最大 2000 */ + page_size: number + /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ + start_date: string + /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ + end_date: string +} + +export interface BatchGetCorehrCompanyRequest { + /** 公司 ID 列表 */ + company_ids: string[] +} + +export interface CreateCorehrCostCenterRequest { + /** 成本中心名称 */ + name: I18n[] + /** 编码 */ + code?: string + /** 上级成本中心ID */ + parent_cost_center_id?: string + /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ + managers?: string[] + /** 成本中心描述 */ + description?: I18n[] + /** 生效时间 */ + effective_time: string +} + +export interface CreateCorehrCostCenterQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface PatchCorehrCostCenterRequest { + /** 生效时间 */ + effective_time: string + /** 启用停用状态 */ + active: boolean + /** 操作原因 */ + operation_reason: string +} + +export interface PatchCorehrCostCenterQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface QueryRecentChangeCorehrCostCenterQuery { + /** 分页大小，最大 2000 */ + page_size: number + /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ + start_date: string + /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ + end_date: string +} + +export interface SearchCorehrCostCenterRequest { + /** 成本中心ID 列表 */ + cost_center_id_list?: string[] + /** 成长中心名称列表，精确匹配 */ + name_list?: string[] + /** 成本中心编码 */ + code?: string + /** 上级成本中心ID，可用于查询直接下级成本中心 */ + parent_cost_center_id?: string + /** 是否获取所有陈本中心版本 */ + get_all_version?: boolean +} + +export interface SearchCorehrCostCenterQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface DeleteCorehrCostCenterRequest { + /** 操作原因 */ + operation_reason: string +} + +export interface CreateCorehrCostCenterVersionRequest { + /** 成本中心名称 */ + name: I18n[] + /** 上级成本中心ID */ + parent_cost_center_id?: string + /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ + managers?: string[] + /** 成本中心描述 */ + description?: I18n[] + /** 生效时间 */ + effective_time: string + /** 操作原因 */ + operation_reason: string +} + +export interface CreateCorehrCostCenterVersionQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface PatchCorehrCostCenterVersionRequest { + /** 成本中心名称 */ + name?: I18n[] + /** 上级成本中心ID */ + parent_cost_center_id?: string + /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ + managers?: string[] + /** 成本中心描述 */ + description?: I18n[] + /** 生效时间 */ + effective_time: string + /** 操作原因 */ + operation_reason: string +} + +export interface PatchCorehrCostCenterVersionQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface DeleteCorehrCostCenterVersionRequest { + /** 操作原因 */ + operation_reason: string +} + +export interface GetCorehrApprovalGroupsQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface OpenQueryDepartmentChangeListByIdsCorehrApprovalGroupsRequest { + /** 部门调整记录 ID List */ + department_change_ids?: string[] + /** 是否返回部门全路径 */ + need_department_path?: boolean +} + +export interface OpenQueryDepartmentChangeListByIdsCorehrApprovalGroupsQuery { + /** 组织架构调整流程 ID */ + process_id: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface OpenQueryJobChangeListByIdsCorehrApprovalGroupsRequest { + /** 人员异动记录 ID List */ + job_change_ids?: string[] + /** 是否返回部门全路径 */ + need_department_path?: boolean +} + +export interface OpenQueryJobChangeListByIdsCorehrApprovalGroupsQuery { + /** 组织架构调整流程 ID */ + process_id: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface CreateCorehrJobFamilyRequest { + /** 名称 */ + name: I18n[] + /** 启用 */ + active: boolean + /** 上级序列 */ + parent_id?: string + /** 生效时间 */ + effective_time: string + /** 编码 */ + code?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface CreateCorehrJobFamilyQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrJobFamilyRequest { + /** 名称 */ + name?: I18n[] + /** 启用 */ + active?: boolean + /** 上级序列 */ + parent_id?: string + /** 生效时间 */ + effective_time?: string + /** 编码 */ + code?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface PatchCorehrJobFamilyQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ListCorehrJobFamilyQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface QueryRecentChangeCorehrJobFamilyQuery { + /** 分页大小，最大 2000 */ + page_size: number + /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ + start_date: string + /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ + end_date: string +} + +export interface BatchGetCorehrJobFamilyRequest { + /** 序列 ID 列表 */ + job_family_ids: string[] +} + +export interface CreateCorehrJobLevelRequest { + /** 职级数值 */ + level_order: number + /** 编码 */ + code?: string + /** 名称 */ + name: I18n[] + /** 描述 */ + description?: I18n[] + /** 启用 */ + active: boolean + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 职等 ID 列表 */ + job_grade?: string[] +} + +export interface CreateCorehrJobLevelQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrJobLevelRequest { + /** 职级数值 */ + level_order?: number + /** 编码 */ + code?: string + /** 名称 */ + name?: I18n[] + /** 描述 */ + description?: I18n[] + /** 启用 */ + active?: boolean + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 职等 ID 列表 */ + job_grade?: string[] +} + +export interface PatchCorehrJobLevelQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ListCorehrJobLevelQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface QueryRecentChangeCorehrJobLevelQuery { + /** 分页大小，最大 2000 */ + page_size: number + /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ + start_date: string + /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ + end_date: string +} + +export interface BatchGetCorehrJobLevelRequest { + /** 职级 ID 列表 */ + job_level_ids: string[] +} + +export interface CreateCorehrJobGradeRequest { + /** 职等数值 */ + grade_order: number + /** 编码 */ + code?: string + /** 名称 */ + names: I18n[] + /** 描述 */ + descriptions?: I18n[] +} + +export interface CreateCorehrJobGradeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrJobGradeRequest { + /** 职等数值 */ + grade_order?: number + /** 编码 */ + code?: string + /** 名称 */ + names?: I18n[] + /** 描述 */ + descriptions?: I18n[] + /** 启用 */ + active?: boolean +} + +export interface PatchCorehrJobGradeQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface QueryCorehrJobGradeRequest { + /** 职等ID列表 */ + ids?: string[] + /** 职等code列表 */ + codes?: string[] + /** 是否启用 */ + active?: boolean +} + +export interface QueryCorehrJobGradeQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface QueryRecentChangeCorehrJobGradeQuery { + /** 分页大小，最大 2000 */ + page_size: number + /** 页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的开始时间，支持"yyyy-MM-dd HH:MM:SS" */ + start_date: string + /** 查询的结束时间，格式 "yyyy-MM-dd HH:MM:SS" */ + end_date: string +} + +export interface CreateCorehrJobRequest { + /** 编码 */ + code?: string + /** 名称 */ + name: I18n[] + /** 描述 */ + description?: I18n[] + /** 启用 */ + active: boolean + /** 职务头衔 */ + job_title?: I18n[] + /** 序列 */ + job_family_id_list?: string[] + /** 职级 */ + job_level_id_list?: string[] + /** 工时制度，引用WorkingHoursType的ID */ + working_hours_type_id?: string + /** 生效时间 */ + effective_time: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface CreateCorehrJobQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrJobRequest { + /** 编码 */ + code?: string + /** 名称 */ + name?: I18n[] + /** 描述 */ + description?: I18n[] + /** 启用 */ + active?: boolean + /** 职务头衔 */ + job_title?: I18n[] + /** 序列 */ + job_family_id_list?: string[] + /** 职级 */ + job_level_id_list?: string[] + /** 工时制度，引用WorkingHoursType的ID */ + working_hours_type_id?: string + /** 生效时间 */ + effective_time?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface PatchCorehrJobQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ListCorehrJobQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 名称 */ + name?: string + /** 语言 */ + query_language?: string +} + +export interface WithdrawOnboardingCorehrPreHireRequest { + /** 待入职ID，可从待入职列表接口获取 */ + pre_hire_id: string + /** 撤销原因 */ + withdraw_reason: string +} + +export interface RestoreFlowInstanceCorehrPreHireRequest { + /** 待入职ID，可从待入职列表接口获取 */ + pre_hire_id: string + /** 是否强制占编；true为强制占编；false为非强制占编 */ + confirm_workforce?: boolean +} + +export interface CreateCorehrPreHireRequest { + /** 个人信息 */ + basic_info: BasicInfo + /** 职位信息 */ + offer_info: OfferInfo + /** 教育经历 */ + education_info?: EducationInfo[] + /** 工作经历 */ + work_experience?: WorkExperience[] + /** 招聘应用ID */ + ats_application_id?: string + /** 外部业务唯一编码 */ + out_biz_id?: string +} + +export interface PatchCorehrPreHireRequest { + /** 更新个人（person）信息 */ + basic_info_update?: BasicInfoUpdate + /** 更新待入职（prehire）信息 */ + offer_info_update?: OfferInfoUpdate + /** 指定需要更新的系统字段，只支持最多下钻一层，格式如下： - basic_info_update字段：basic_info_update.name（对name整体进行覆盖更新）；basic_info_update.emails（对邮箱整体进行更新） - offer_info_update字段：offer_info_update.onboarding_method - 招聘ID：ats_application_id */ + standard_update_fields?: string[] + /** 指定需要更新的PreHire对象上的自定义字段，格式如下： - custom_field1__c */ + custom_update_fields?: string[] + /** 指定需要更新的Person对象上的自定义字段，格式如下： - custom_field1__c */ + person_custom_update_fields?: string[] +} + +export interface QueryCorehrPreHireRequest { + /** 待入职人员 ID 列表；如果该字段非空，则不按照page_size、page_token分页方式查询 */ + pre_hire_ids?: string[] + /** 返回数据的字段列表，填写方式：- 为空时只返回 pre_hire_id- 不为空时按照传入的字段返回数据，格式如下： - person_info 字段：person_info.gender，person_info.age - employment_info 字段：employment_info.department - onboarding_info 字段：onboarding_info.onboarding_date - probation_info 字段：probation_info.probation_period - contract_info 字段：contract_info.contract_type- 如果要返回所有下级，只用传上级结构体名称，例如 person_info- 返回数据越多，查询接口性能越慢，请按需填写返回字段 */ + fields?: string[] +} + +export interface QueryCorehrPreHireQuery { + /** 分页大小，最大 10 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface ListCorehrPreHireQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 待入职ID列表 */ + pre_hire_ids?: string[] +} + +export interface SearchCorehrPreHireRequest { + /** 待入职人员工号列表 */ + worker_ids?: string[] + /** 待入职人员 ID 列表 */ + pre_hire_ids?: string[] + /** 个人信息 ID 列表 */ + person_ids?: string[] + /** 入职日期-搜索范围开始，需要与搜索范围结束一同使用 */ + onboarding_date_start?: string + /** 入职日期-搜索范围结束 */ + onboarding_date_end?: string + /** 待入职数据更新时间-搜索范围开始，需要与搜索范围结束一同使用 */ + updated_date_start?: string + /** 待入职数据更新时间-搜索范围结束，需要与搜索范围结束一同使用 */ + updated_date_end?: string + /** 入职地点 ID 列表 */ + onboarding_location_ids?: string[] + /** 入职状态 */ + onboarding_status?: 'preboarding' | 'deleted' | 'day_one' | 'withdrawn' | 'completed' + /** 部门 ID 列表 */ + department_ids?: string[] + /** 直接上级的雇佣 ID 列表 */ + direct_manager_ids?: string[] + /** 人员类型 ID 列表 */ + employee_type_ids?: string[] + /** 人员子类型 ID 列表 */ + employee_subtype_ids?: string[] + /** 序列 ID 列表 */ + job_family_ids?: string[] + /** 搜索关键字，支持对常用名模糊搜索 + 工号精确搜索 */ + key_word?: string + /** 是否离职重聘 */ + rehire?: 'to_be_confirmed' | 'no' | 'yes' + /** 返回数据的字段列表，填写方式：- 为空时只返回 pre_hire_id- 不为空时按照传入的字段返回数据，格式如下： - person_info 字段：person_info.gender，person_info.age - employment_info 字段：employment_info.department - onboarding_info 字段：onboarding_info.onboarding_date - probation_info 字段：probation_info.probation_period - contract_info 字段：contract_info.contract_type- 如果要返回所有下级，只用传上级结构体名称，例如 person_info- 返回数据越多，查询接口性能越慢，请按需填写返回字段 */ + fields?: string[] +} + +export interface SearchCorehrPreHireQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface TransitTaskCorehrPreHireRequest { + /** 系统预置的职位信息和个人信息任务的task_id分别为1和2，自定义任务的task_id是一串UUID */ + task_id: string +} + +export interface PatchCorehrPreHireRequest { + /** 招聘系统的候选人 ID */ + ats_application_id?: string + /** 入职日期 */ + hire_date?: string + /** 雇佣类型 */ + employee_type?: Enum + /** 人员编号 */ + worker_id?: string + /** 雇佣类型 */ + employee_type_id?: string + /** 引用Person ID */ + person_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 成本中心分摊信息 */ + cost_center_rate?: SupportCostCenterItem[] + /** 入职状态 */ + onboarding_status: Enum +} + +export interface PatchCorehrPreHireQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface CreateCorehrProbationAssessmentRequest { + /** 试用期人员的雇佣 ID */ + employment_id: string + /** 试用期考核结果列表 */ + assessments: AssessmentForCreate[] +} + +export interface CreateCorehrProbationAssessmentQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface EnableDisableAssessmentCorehrProbationRequest { + /** 启用 / 停用状态。启用后可在试用期管理页面中可见试用期考核相关的字段。 */ + active: boolean + /** 试用期考核系统入口链接，当启用功能时该字段必填。 */ + app_url?: string +} + +export interface PatchCorehrProbationAssessmentRequest { + /** 考核状态 */ + assessment_status: 'not_started' | 'in_process' | 'completed' | 'no_need' + /** 试用期考核结果 */ + assessment_result?: 'approved' | 'rejected' + /** 考核得分 */ + assessment_score?: number + /** 试用期考核等级 */ + assessment_grade?: string + /** 考核评语 */ + assessment_comment?: string + /** 考核结果页面超链接 */ + assessment_detail?: string + /** 是否为最终考核结果 */ + is_final_asssessment: boolean +} + +export interface PatchCorehrProbationAssessmentQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface SearchCorehrProbationRequest { + /** 雇佣 ID 列表 */ + employment_ids?: string[] + /** 部门 ID 列表 */ + department_ids?: string[] + /** 试用期开始日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ + probation_start_date_start?: string + /** 试用期开始日期 - 搜索范围结束 */ + probation_start_date_end?: string + /** 试用期预计结束日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ + probation_expected_end_date_start?: string + /** 试用期预计结束日期 - 搜索范围结束 */ + probation_expected_end_date_end?: string + /** 试用期实际结束日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ + actual_probation_end_date_start?: string + /** 试用期实际结束日期 - 搜索范围结束 */ + actual_probation_end_date_end?: string + /** 转正发起日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ + initiating_time_start?: string + /** 转正发起日期 - 搜索范围结束 */ + initiating_time_end?: string + /** 试用期状态 */ + probation_status?: 'pending' | 'rejected' | 'waiting' | 'approved' | 'converted' | 'offboarded' + /** 试用期最终考核结果 */ + final_assessment_result?: 'approved' | 'rejected' + /** 试用期最终考核等级 */ + final_assessment_grade?: string +} + +export interface SearchCorehrProbationQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface SubmitCorehrProbationRequest { + /** 试用期人员的雇佣 ID */ + employment_id: string + /** 转正方式 */ + conversion_mode: 1 | 2 + /** 实际结束日期，如果为空则默认填入试用期预计结束日期，填入日期需满足：试用期开始时间 <= 实际结束日期 <= 试用期预计结束日期 */ + actual_probation_end_date?: string + /** 发起方 */ + submission_type: 'self_submission' | 'system' | 'hr_submission' + /** 发起人 ID，当发起方为 HR 时填写，为其他发起方时该字段会自动计算 */ + initiator_id?: string + /** 备注，当为直接转正时必填 */ + notes?: string + /** 员工自评 */ + self_review?: string + /** 自定义字段（试用期中如果有附件自定义字段，当前不支持使用「上传文件」接口写入） */ + custom_fields?: CustomFieldData[] +} + +export interface SubmitCorehrProbationQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface WithdrawCorehrProbationRequest { + /** 试用期人员的雇佣 ID */ + employment_id: string +} + +export interface WithdrawCorehrProbationQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface CreateCorehrJobChangeRequest { + /** 异动方式 */ + transfer_mode: 1 | 2 + /** 雇员id */ + employment_id: string + /** 异动类型唯一标识 */ + transfer_type_unique_identifier: string + /** 异动流程ID */ + flow_id?: string + /** 生效日期 */ + effective_date: string + /** 异动详细信息 */ + transfer_info: CreateTransferInfo + /** 异动记录标识符 */ + transfer_key?: string + /** 异动发起人 ID */ + initiator_id?: string + /** 异动原因唯一标识 */ + transfer_reason_unique_identifier?: string +} + +export interface CreateCorehrJobChangeQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface QueryCorehrTransferTypeQuery { + /** 异动类型状态 */ + active?: boolean + /** 异动类型唯一标识，多条时最多数量为10 */ + transfer_type_unique_identifier?: string[] +} + +export interface QueryCorehrTransferReasonQuery { + /** 异动原因状态 */ + active?: boolean + /** 异动原因唯一标识，多条时最多数量为10 */ + transfer_reason_unique_identifier?: string[] +} + +export interface SearchCorehrJobChangeRequest { + /** 雇员 ID 列表 */ + employment_ids?: string[] + /** 异动记录 ID 列表 */ + job_change_ids?: string[] + /** 异动状态，多个状态之间为「或」的关系 */ + statuses?: 'Approving' | 'Approved' | 'Transformed' | 'Rejected' | 'Cancelled' | 'NoNeedApproval'[] + /** 异动生效日期 - 搜索范围开始，需要与搜索范围结束一同使用 */ + effective_date_start?: string + /** 异动生效日期 - 搜索范围结束 */ + effective_date_end?: string + /** 异动更新时间 - 搜索范围开始，需要与搜索范围结束一同使用 */ + updated_time_start?: string + /** 异动更新时间 - 搜索范围结束 */ + updated_time_end?: string + /** 新部门 ID 列表 */ + target_department_ids?: string[] +} + +export interface SearchCorehrJobChangeQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface RevokeCorehrJobChangeRequest { + /** 操作人id */ + operator_id: string +} + +export interface RevokeCorehrJobChangeQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' | 'people_corehr_id' +} + +export interface CreateCorehrJobChangeRequest { + /** 异动方式 */ + transfer_mode: 1 | 2 + /** 雇员id */ + employment_id: string + /** 异动类型唯一标识 */ + transfer_type_unique_identifier: string + /** 异动流程ID */ + flow_id?: string + /** 生效日期 */ + effective_date: string + /** 异动详细信息 */ + transfer_info: TransferInfo + /** 异动记录标识符 */ + transfer_key?: string + /** 异动发起人 ID */ + initiator_id?: string +} + +export interface CreateCorehrJobChangeQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface QueryCorehrOffboardingRequest { + /** 是否启用 */ + active?: boolean + /** 离职原因唯一标识列表，用于过滤，最大20个 */ + offboarding_reason_unique_identifier?: string[] +} + +export interface SubmitV2CorehrOffboardingRequest { + /** 离职方式 */ + offboarding_mode: 1 | 2 + /** 雇员 id */ + employment_id: string + /** 离职日期 */ + offboarding_date: string + /** 离职原因 */ + offboarding_reason_unique_identifier: string + /** 离职原因说明 */ + offboarding_reason_explanation?: string + /** 操作发起人 ID（employment_id），为空默认为系统发起。注意：只有操作发起人可以撤销流程 */ + initiator_id?: string + /** 是否加入离职屏蔽名单 */ + add_block_list?: boolean + /** 屏蔽原因 */ + block_reason?: string + /** 屏蔽原因说明 */ + block_reason_explanation?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 离职是否保留飞书账号 */ + retain_account?: boolean + /** 编制随人员一起调整 */ + is_transfer_with_workforce?: boolean +} + +export interface SubmitV2CorehrOffboardingQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface EditCorehrOffboardingRequest { + /** 离职记录 ID */ + offboarding_id: string + /** 操作人雇佣 ID（employment_id），为空默认为系统操作。 */ + operator_id?: string + /** 编辑字段数据信息 */ + update_data: ObjectFieldData[] +} + +export interface EditCorehrOffboardingQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface RevokeCorehrOffboardingRequest { + /** 离职记录 ID */ + offboarding_id: string + /** 操作人雇佣 ID（employment_id），为空默认为系统操作。 */ + operator_id?: string +} + +export interface RevokeCorehrOffboardingQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface SearchCorehrOffboardingRequest { + /** 雇佣 ID 列表，为空默认查询所有离职人员 */ + employment_ids?: string[] + /** 离职审批发起时间-搜索范围开始，需要与搜索范围结束一同使用 */ + apply_initiating_time_start?: string + /** 离职审批发起时间 - 搜索范围结束 */ + apply_initiating_time_end?: string + /** 离职审批结束时间 - 搜索范围开始，需要与搜索范围结束一同使用 */ + apply_finished_time_start?: string + /** 离职审批结束时间 - 搜索范围结束 */ + apply_finished_time_end?: string + /** 期望离职日期-搜索范围开始，需要与搜索范围结束一同使用 */ + expected_offboarding_date_start?: string + /** 期望离职日期 - 搜索范围结束 */ + expected_offboarding_date_end?: string + /** 离职日期-搜索范围开始，需要与搜索范围结束一同使用 */ + offboarding_date_start?: string + /** 离职日期 - 搜索范围结束 */ + offboarding_date_end?: string + /** 离职状态，多个状态之间为「或」的关系 */ + statuses?: 'Approving' | 'Approved' | 'Offboarded' | 'Rejected' | 'Withdrawn' | 'NoNeedApproval'[] + /** 离职原因列表 , 可以通过【查询员工离职原因列表】接口获取 ，查询时不返回下级原因相关的离职信息 */ + reasons?: string[] + /** 离职原因（员工）列表 , 可以通过【查询员工离职原因列表】接口获取，查询时不返回下级原因相关的离职信息 */ + employee_reasons?: string[] +} + +export interface SearchCorehrOffboardingQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface CreateCorehrContractRequest { + /** 合同开始日期 */ + effective_time: string + /** 实际结束日期 */ + expiration_time?: string + /** 雇员ID */ + employment_id: string + /** 合同类型 */ + contract_type: Enum + /** 甲方, 引用Company的ID */ + first_party_company_id: string + /** Person ID */ + person_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 期限类型 */ + duration_type?: Enum + /** 合同结束日期 */ + contract_end_date?: string + /** 合同编号 */ + contract_number?: string + /** 签订类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（signing_type）枚举定义部分获得 */ + signing_type?: Enum +} + +export interface CreateCorehrContractQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface PatchCorehrContractRequest { + /** 合同开始日期 */ + effective_time?: string + /** 实际结束日期 */ + expiration_time?: string + /** 雇员ID */ + employment_id?: string + /** 合同类型 */ + contract_type?: Enum + /** 甲方, 引用Company的ID */ + first_party_company_id?: string + /** Person ID */ + person_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 期限类型 */ + duration_type?: Enum + /** 合同结束日期 */ + contract_end_date?: string + /** 合同编号 */ + contract_number?: string + /** 签订类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（signing_type）枚举定义部分获得 */ + signing_type?: Enum +} + +export interface PatchCorehrContractQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface ListCorehrContractQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface SearchCorehrContractRequest { + /** 雇佣 ID 列表 */ + employment_id_list?: string[] + /** 合同ID列表 */ + contract_id_list?: string[] +} + +export interface SearchCorehrContractQuery { + /** 分页大小，最大 100 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface BatchSaveCorehrWorkforcePlanDetailRowRequest { + /** 编制规划id */ + workforce_plan_id: string + /** 编制规划的多个明细行 */ + items: WorkforcePlanDetailRow[] +} + +export interface BatchDeleteCorehrWorkforcePlanDetailRowRequest { + /** 编制规划id */ + workforce_plan_id: string + /** 编制规划的多个明细行 */ + items: WorkforcePlanDetailRow[] +} + +export interface BatchSaveCorehrReportDetailRowRequest { + /** 编制规划id */ + workforce_plan_id: string + /** 集中填报id */ + centralized_reporting_project_id: string + /** 集中填报的一些填报行 */ + items: WorkforcePlanDetailRow[] +} + +export interface BatchDeleteCorehrReportDetailRowRequest { + /** 编制规划id */ + workforce_plan_id: string + /** 集中填报id */ + centralized_reporting_project_id: string + /** 集中填报的一些填报行 */ + items: WorkforcePlanDetailRow[] +} + +export interface ListCorehrWorkforcePlanQuery { + /** 是否获取所有编制规划方案，true 所有编制规划方案列表，false 为仅获取当前生效的编制规划方案，默认为 false示例值：false */ + get_all_plan?: boolean + /** 是否只获取已启用的方案，true 获取已启用编制规划方案，false 获取所有编制规划方案，默认为 true示例值：true */ + active?: boolean +} + +export interface BatchCorehrWorkforcePlanDetailRequest { + /** 编制规划方案ID，ID及详细信息可通过获取编制规划方案列表接口查询获得。查询编制规划明细信息时，编制规划方案ID必填，是否为集中填报项目设置为false，不填写集中填报项目ID（是否填写不影响返回结果） */ + workforce_plan_id?: string + /** 是否为集中填报项目。如果租户未使用集中填报功能，将此参数置空即可。如果查询集中填报明细，将此参数设置为true。 */ + is_centralized_reporting_project?: boolean + /** 编制规划集中填报项目ID，ID可通过访问集中填报页面，从URL中提取report_id参数。如果租户未使用集中填报功能，将此参数置空即可。查询集中填报信息时，集中填报项目ID必填，是否为集中填报项目设置为true，不填写编制规划方案ID（是否填写不影响返回结果） */ + centralized_reporting_project_id?: string + /** 部门 ID 列表，枚举值及详细信息可通过查询单个部门接口查询获得 */ + department_ids?: string[] + /** 人员类型 ID 列表，枚举值及详细信息可通过查询单个人员类型接口查询获得 */ + employee_type_ids?: string[] + /** 工作地点 ID 列表，枚举值及详细信息可通过查询单个地点接口查询获得 */ + work_location_ids?: string[] + /** 序列 ID 列表，枚举值及详细信息可通过查询单个序列接口查询获得 */ + job_family_ids?: string[] + /** 职级 ID 列表，枚举值及详细信息可通过查询单个职级接口查询获得 */ + job_level_ids?: string[] + /** 职务 ID 列表，枚举值及详细信息可通过查询单个职务接口查询获得 */ + job_ids?: string[] + /** 成本中心 ID 列表，可以通过搜索成本中心信息接口获取对应的成本中心信息 */ + cost_center_ids?: string[] +} + +export interface BatchCorehrWorkforcePlanDetailQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateCorehrLeaveGrantingRecordRequest { + /** 假期类型 ID，枚举值可通过【获取假期类型列表】接口获取（若假期类型下存在假期子类，此处仅支持传入假期子类的 ID） */ + leave_type_id: string + /** 员工 ID */ + employment_id: string + /** 授予数量 */ + granting_quantity: string + /** 授予时长单位可选值有：- 1: 天- 2: 小时 */ + granting_unit: number + /** 生效时间 */ + effective_date: string + /** 失效时间 */ + expiration_date?: string + /** 是否参与折算 */ + section_type?: number + /** 授予原因 */ + reason: I18n[] + /** 自定义外部 ID，可用于避免数据重复写入（不能超过 64 字符） */ + external_id?: string +} + +export interface CreateCorehrLeaveGrantingRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface LeaveTypesCorehrLeaveQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 假期类型状态（不传则为全部）可选值有：- 1：已启用- 2：已停用 */ + status?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface LeaveBalancesCorehrLeaveQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大20 */ + page_size: string + /** 查询截止日期，即截止到某天余额数据的日期（不传则默认为当天） */ + as_of_date?: string + /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ + employment_id_list?: string[] + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 查询时区 */ + time_zone?: string + /** 是否获取离职折算字段 */ + include_offboard?: boolean +} + +export interface LeaveRequestHistoryCorehrLeaveQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 员工 ID 列表，最大 100 个（不传则默认查询全部员工） */ + employment_id_list?: string[] + /** 休假发起人 ID 列表，最大 100 个 */ + initiator_id_list?: string[] + /** 请假记录的状态可选值有：- 1：已通过- 2：审批中- 3：审批中（更正）- 4：审批中（取消休假）- 5：审批中（返岗）- 6：已返岗- 7：已拒绝- 8：已取消- 9：已撤回 */ + leave_request_status?: string[] + /** 假期类型 ID 列表，枚举值可通过【获取假期类型列表】接口获取 */ + leave_type_id_list?: string[] + /** 休假开始时间晚于等于的日期 */ + leave_start_date_min?: string + /** 休假开始时间早于等于的日期 */ + leave_start_date_max?: string + /** 休假结束时间晚于等于的日期 */ + leave_end_date_min?: string + /** 休假结束时间早于等于的日期 */ + leave_end_date_max?: string + /** 休假发起时间晚于等于的日期 */ + leave_submit_date_min?: string + /** 休假发起时间早于等于的日期 */ + leave_submit_date_max?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 请假记录更新时间晚于等于的时间 */ + leave_update_time_min?: string + /** 请假记录更新时间早于等于的时间 */ + leave_update_time_max?: string + /** 是否返回请假详情，若为true，将在每条请假记录的details字段返回请假详情 */ + return_detail?: boolean + /** 指定过滤长/短假类型，0表示不过滤，1表示仅获取短假，2表示仅获取长假, 默认0 */ + leave_term_type?: number + /** 请假记录所在时区 */ + time_zone?: string + /** 请假记录数据源，1表示中国大陆休假，2表示海外休假，不传或0表示不过滤 */ + data_source?: number + /** 请假记录DB更新时间晚于等于的时间 */ + db_update_time_min?: string + /** 请假记录DB更新时间早于等于的时间 */ + db_update_time_max?: string + /** WorkDay专用 是否返回0值的请假记录，若为true，将返回0值的请假记录 */ + wd_need_amount_zero_records?: boolean + /** WorkDay专用 是否拒绝和取消的请假记录，若为true，将返回拒绝和取消的请假记录 */ + wd_need_denied_and_canceled_record?: boolean + /** WorkDay专用 扣薪类型, 1不参与算薪 2影响算薪 3不影响算薪 */ + wd_paid_type?: number +} + +export interface WorkCalendarCorehrLeaveRequest { + /** 工作日历ID列表 */ + wk_calendar_ids: string[] + /** 工作日历ID大于 */ + wk_calendar_id_gt?: string + /** 分页、排序等选项 */ + wk_option?: WkOption + /** 是否只返回启用的工作日历，不填默认true */ + only_enable?: boolean +} + +export interface CalendarByScopeCorehrLeaveQuery { + /** 用户所属部门的ID列表 */ + wk_department_id?: string + /** 国家/地区 ID */ + wk_country_region_id?: string + /** 人员类型 */ + wk_employee_type_id?: string + /** 工作地点 */ + wk_work_location_id?: string + /** 工时制度 */ + wk_working_hours_type_id?: string + /** 职务序列 */ + wk_job_family_id?: string + /** 公司 ID */ + wk_company_id?: string +} + +export interface WorkCalendarDateCorehrLeaveRequest { + /** 工作日历WKID列表，最多100 */ + wk_calendar_ids: string[] + /** 日期，格式："2006-01-02"，最多50个 */ + dates?: string[] + /** 日期范围-开始日期，格式："2006-01-02" */ + begin_date?: string + /** 日期范围-结束日期(含)，格式："2006-01-02" */ + end_date?: string + /** 分页 */ + offset?: number + /** 分页大小 */ + limit?: number + /** 日期id，与其他筛选参数互斥，传了该参数，其他筛选参数不起效 */ + ids?: string[] +} + +export interface QueryCorehrAuthorizationQuery { + /** 员工ID列表，最大100个（不传则默认查询全部员工） */ + employment_id_list?: string[] + /** 角色 ID 列表，最大 100 个 */ + role_id_list?: string[] + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大20 */ + page_size?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 授权时间大于 */ + updated_at_gte?: string + /** 授权时间小于 */ + updated_at_lte?: string +} + +export interface GetByParamCorehrAuthorizationQuery { + /** 雇员 ID */ + employment_id: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface ListCorehrSecurityGroupQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface AddRoleAssignCorehrAuthorizationRequest { + /** 授权 */ + assigned_organization_items: AssignedOrganizationWithCode[][] +} + +export interface AddRoleAssignCorehrAuthorizationQuery { + /** 雇员 ID */ + employment_id: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 角色 ID */ + role_id: string +} + +export interface UpdateRoleAssignCorehrAuthorizationRequest { + /** 授权 */ + assigned_organization_items: AssignedOrganizationWithCode[][] +} + +export interface UpdateRoleAssignCorehrAuthorizationQuery { + /** 雇员 ID */ + employment_id: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 角色 ID */ + role_id: string +} + +export interface RemoveRoleAssignCorehrAuthorizationQuery { + /** 雇员 ID */ + employment_id: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 角色 ID */ + role_id: string +} + +export interface BatchGetCorehrEmployeesBpRequest { + /** 员工雇佣 ID */ + employment_ids: string[] + /** 是否获取全部 BP，true 为获取员工所在部门及来自上级部门的全部 HRBP 和属地 BP，false 为仅获取员工的直属 HRBP 和属地 BP（当员工所在部门、属地无 BP 时，会上钻找到最近的 BP），默认为 false */ + get_all?: boolean +} + +export interface BatchGetCorehrEmployeesBpQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface GetByDepartmentCorehrBpRequest { + /** 部门 ID */ + department_id: string +} + +export interface GetByDepartmentCorehrBpQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface QueryCorehrSecurityGroupRequest { + /** 角色列表，一次最多支持查询 50 个 */ + item_list: BpRoleOrganization[] + /** 授权时间大于 */ + updated_at_gte?: string + /** 授权时间小于 */ + updated_at_lte?: string +} + +export interface QueryCorehrSecurityGroupQuery { + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface ListCorehrBpQuery { + /** 分页大小，最大 500 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface SearchCorehrAssignedUserRequest { + /** 角色 ID，仅支持组织类角色， 角色 ID 可通过【批量获取角色列表】接口获取 */ + role_id: string + /** 管理范围信息 */ + management_scope_list: ManagementScope[] + /** 查找方式可选值有：- 1：只查找指定 部门/工作地点/公司/社保城市，如无授权信息则返回为空- 2：当指定的 部门/工作地点/公司/社保城市 无授权信息，向上查找第一个授权记录并直接返回 */ + search_method: string + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface SearchCorehrAssignedUserQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface ListCorehrProcessQuery { + /** 查询流程状态列表。 */ + statuses?: number[] + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size: number + /** 查询开始时间（unix毫秒时间戳），闭区间，开始时间和结束时间跨度不能超过31天 */ + modify_time_from: string + /** 1. 任务查询结束时间，闭区间 2. 单位：ms。从1970年1月1日(UTC/GMT的午夜) 开始经过的毫秒数 3. 注意：开始时间和结束时间跨度不能超过31天 4. 示例值：1719549169735 */ + modify_time_to: string + /** 流程定义ID */ + flow_definition_id?: string +} + +export interface GetCorehrProcessQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface GetCorehrProcessFormVariableDataQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface UpdateCorehrProcessRevokeRequest { + /** 按照指定的用户ID类型传递对应的用户ID。 */ + user_id?: string + /** 原因 */ + reason?: string + /** true-系统身份操作 */ + system_user?: boolean +} + +export interface UpdateCorehrProcessRevokeQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' +} + +export interface UpdateCorehrProcessWithdrawRequest { + /** 按照指定的用户ID类型传递对应的用户ID。 */ + user_id?: string + /** 原因 */ + reason?: string + /** true-系统身份操作 */ + system_user?: boolean +} + +export interface UpdateCorehrProcessWithdrawQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' +} + +export interface ListCorehrApproverQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 按user_id_type类型传递。如果system_approval为false，则必填。否则非必填。 */ + user_id: string + /** 任务状态 */ + approver_status?: -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 12 | 14 | 16 +} + +export interface UpdateCorehrProcessApproverRequest { + /** 将审批任务修改为同意/拒绝 */ + status: 2 | 3 + /** 按user_id_type类型传递。如果system_approval为false，则必填。否则非必填。 */ + user_id?: string + /** true - 使用系统身份审批 */ + system_approval?: boolean + /** 通过原因，长度限制为500 */ + reason?: string + /** 表单数据 */ + field_values_v2?: ProcessFormVariableV2[] +} + +export interface UpdateCorehrProcessApproverQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface UpdateCorehrProcessExtraRequest { + /** 操作人，当system_user为true时，可以不传值 */ + operator?: string + /** 流程节点id，与approver_id二选一传入，都传以node_id为准 */ + node_id?: string + /** 审批任务id，与node_id二选一传入，都传以node_id为准 */ + approver_id?: string + /** 加签方式 */ + extra_type: 0 | 1 | 2 + /** 多人加签时的审批方式 */ + approval_type?: 0 | 1 + /** 加签人员id列表 */ + extra_user_ids: string[] + /** 备注 */ + remark?: string + /** true-以系统身份操作 */ + system_user?: boolean +} + +export interface UpdateCorehrProcessExtraQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' +} + +export interface UpdateCorehrProcessTransferRequest { + /** 操作人，当system_user为true，可不传值 */ + operator?: string + /** 被转交人id */ + to_user_id: string + /** 待转交审批任务id列表 */ + approver_ids: string[] + /** 备注 */ + remark?: string + /** true-以系统身份操作 */ + system_user?: boolean +} + +export interface UpdateCorehrProcessTransferQuery { + /** 用户 ID 类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' | 'people_corehr_id' +} + +export interface MatchCorehrCompensationStandardQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' + /** 雇员ID */ + employment_id: string + /** 薪资标准的关联对象，项目或者指标 */ + reference_object_api?: 'cpst_item' | 'cpst_indicator' + /** 薪资标准关联对象ID */ + reference_object_id: string + /** 部门ID */ + department_id?: string + /** 工作地点ID */ + work_location_id?: string + /** 公司ID */ + company_id?: string + /** 职务序列ID */ + job_family_id?: string + /** 职级ID */ + job_level_id?: string + /** 人员类型ID */ + employee_type_id?: string + /** 招聘类型 */ + recruitment_type?: 'experienced_professionals' | 'recent_graduates' | 'routine_intern' + /** 定调薪原因ID */ + cpst_change_reason_id?: string + /** 薪资方案ID */ + cpst_plan_id?: string + /** 薪级薪等ID */ + cpst_salary_level_id?: string + /** 生效时间 */ + effective_time?: string +} + +export interface ListCorehrSubregionQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 省份/行政区id，填写后只查询该省份/行政区下的城市/区域 */ + subdivision_id?: string +} + +export interface ListCorehrSubdivisionQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 国家/地区id，填写后只查询该国家/地区下的省份/行政区 */ + country_region_id?: string +} + +export interface ListCorehrCountryRegionQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface ListCorehrCurrencyQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string +} + +export interface PatchCorehrDepartmentRequest { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 子类型 */ + sub_type?: Enum + /** 部门负责人 */ + manager?: string + /** 是否保密 */ + is_confidential?: boolean + /** 层级关系，内层字段见实体 */ + hiberarchy_common?: HiberarchyCommon + /** 生效时间 */ + effective_time: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 成本中心id */ + cost_center_id?: string + /** 是否使用职务 */ + staffing_model?: Enum +} + +export interface PatchCorehrDepartmentQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface GetCorehrDepartmentQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface ListCorehrJobQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 名称 */ + name?: string + /** 语言 */ + query_language?: string +} + +export interface ListCorehrDepartmentQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size: string + /** 部门ID列表 */ + department_id_list?: string[] + /** 部门名称列表，需精确匹配 */ + name_list?: string[] + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_corehr_department_id' +} + +export interface PatchCorehrPersonRequest { + /** 姓名 */ + name_list?: PersonName[] + /** 性别 */ + gender?: Enum + /** 出生日期 */ + date_of_birth?: string + /** 国籍 ID，该字段已作废，请使用 nationality_id_v2 字段 */ + nationality_id?: string + /** 民族 / 种族 */ + race?: Enum + /** 婚姻状况 */ + marital_status?: Enum + /** 电话 */ + phone_list?: Phone[] + /** 地址 */ + address_list?: Address[] + /** 邮件 */ + email_list?: Email[] + /** 工作履历 */ + work_experience_list?: WorkExperience[] + /** 教育经历 */ + education_list?: Education[] + /** 银行账号 */ + bank_account_list?: BankAccount[] + /** 证件号码 */ + national_id_list?: NationalId[] + /** 亲属 */ + dependent_list?: Dependent[] + /** 紧急联系人 */ + emergency_contact_list?: EmergencyContact[] + /** 进入工作地的日期 */ + date_entered_workforce?: string + /** 头像资源的id */ + profile_image_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 纳税身份信息 */ + resident_tax_id_list?: string[] + /** 年龄 */ + age?: number + /** 个人资料 */ + personal_profile?: PersonalProfile[] +} + +export interface PatchCorehrPersonQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface CreateCorehrPersonRequest { + /** 姓名 */ + name_list: PersonName[] + /** 性别 */ + gender?: Enum + /** 出生日期 */ + date_of_birth?: string + /** 国籍 ID，该字段已作废，请使用 nationality_id_v2 字段 */ + nationality_id?: string + /** 民族 / 种族 */ + race?: Enum + /** 婚姻状况 */ + marital_status?: Enum + /** 电话 */ + phone_list?: Phone[] + /** 地址 */ + address_list?: Address[] + /** 邮件 */ + email_list?: Email[] + /** 工作履历 */ + work_experience_list?: WorkExperience[] + /** 教育经历 */ + education_list?: Education[] + /** 银行账号 */ + bank_account_list?: BankAccount[] + /** 证件号码 */ + national_id_list?: NationalId[] + /** 亲属 */ + dependent_list?: Dependent[] + /** 紧急联系人 */ + emergency_contact_list?: EmergencyContact[] + /** 进入工作地的日期 */ + date_entered_workforce?: string + /** 头像资源的id */ + profile_image_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 纳税身份信息 */ + resident_tax_id_list?: string[] + /** 年龄 */ + age?: number + /** 个人资料 */ + personal_profile?: PersonalProfile[] +} + +export interface CreateCorehrPersonQuery { + /** 根据client_token是否一致来判断是否为同一请求 */ + client_token?: string +} + +export interface GetCorehrPersonQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'people_employee_id' +} + +export interface SubmitCorehrOffboardingRequest { + /** 离职方式 */ + offboarding_mode: 1 + /** 雇员 id */ + employment_id: string + /** 离职日期 */ + offboarding_date: string + /** 离职原因，可通过接口[【查询员工离职原因列表】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query)获取 */ + offboarding_reason_unique_identifier: string + /** 离职原因说明，长度限制6000 */ + offboarding_reason_explanation?: string + /** 操作发起人 ID（employment_id），为空默认为系统发起。注意：只有操作发起人可以撤销流程 */ + initiator_id?: string + /** 是否加入离职屏蔽名单 */ + add_block_list?: boolean + /** 屏蔽原因 */ + block_reason?: string + /** 屏蔽原因说明 */ + block_reason_explanation?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface SubmitCorehrOffboardingQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_corehr_id' +} + +export interface ListObjectApiNameCorehrCustomFieldResponse { + /** 对象列表 */ + items?: Object[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface QueryCorehrCustomFieldResponse { + /** 自定义字段列表 */ + items?: CustomField[] +} + +export interface GetByParamCorehrCustomFieldResponse { + /** 自定义字段详情 */ + data?: CustomField +} + +export interface AddEnumOptionCorehrCommonDataMetaDataResponse { + /** 枚举字段 API name */ + enum_field_api_name?: string + /** 枚举全部选项列表 */ + enum_field_options?: EnumFieldOption[] +} + +export interface EditEnumOptionCorehrCommonDataMetaDataResponse { + /** 枚举字段 API name */ + enum_field_api_name?: string + /** 枚举全部选项列表 */ + enum_field_options?: EnumFieldOption[] +} + +export interface SearchCorehrBasicInfoCountryRegionResponse { + /** 查询到的国家/地区列表 */ + items?: CountryRegion[] + page_token?: string + has_more?: boolean +} + +export interface SearchCorehrBasicInfoCountryRegionSubdivisionResponse { + /** 查询的省份/行政区信息 */ + items?: CountryRegionSubdivision[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface SearchCorehrBasicInfoCityResponse { + /** 查询到的城市列表 */ + items?: City[] + page_token?: string + has_more?: boolean +} + +export interface SearchCorehrBasicInfoDistrictResponse { + /** 查询到的区/县列表 */ + items?: District[] + page_token?: string + has_more?: boolean +} + +export interface SearchCorehrBasicInfoNationalityResponse { + /** 查询到的国籍列表 */ + items?: Nationality[] + page_token?: string + has_more?: boolean +} + +export interface CreateCorehrNationalIdTypeResponse { + national_id_type?: NationalIdType +} + +export interface PatchCorehrNationalIdTypeResponse { + national_id_type?: NationalIdType +} + +export interface GetCorehrNationalIdTypeResponse { + /** 国家证件类型信息 */ + national_id_type?: NationalIdType +} + +export interface ListCorehrNationalIdTypeResponse { + /** 查询的国家证件类型信息 */ + items?: NationalIdType[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface SearchCorehrBasicInfoBankResponse { + /** 查询到的银行列表 */ + items?: Bank[] + page_token?: string + has_more?: boolean +} + +export interface SearchCorehrBasicInfoBankBranchResponse { + /** 查询到的支行列表 */ + items?: BankBranch[] + page_token?: string + has_more?: boolean +} + +export interface SearchCorehrBasicInfoCurrencyResponse { + /** 查询到的货币信息列表 */ + items?: Currency[] + page_token?: string + has_more?: boolean +} + +export interface SearchCorehrBasicInfoTimeZoneResponse { + /** 查询到的时区列表 */ + items?: TimeZone[] + page_token?: string + has_more?: boolean +} + +export interface SearchCorehrBasicInfoLanguageResponse { + /** 查询到的语言列表 */ + items?: Language[] + page_token?: string + has_more?: boolean +} + +export interface CreateCorehrEmployeeTypeResponse { + employee_type?: EmployeeType +} + +export interface PatchCorehrEmployeeTypeResponse { + employee_type?: EmployeeType +} + +export interface GetCorehrEmployeeTypeResponse { + /** 雇员类型 */ + employee_type?: EmployeeType +} + +export interface ListCorehrEmployeeTypeResponse { + /** 查询的雇员类型信息 */ + items?: EmployeeType[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface CreateCorehrWorkingHoursTypeResponse { + working_hours_type?: WorkingHoursType +} + +export interface PatchCorehrWorkingHoursTypeResponse { + working_hours_type?: WorkingHoursType +} + +export interface GetCorehrWorkingHoursTypeResponse { + /** 工时制度信息 */ + working_hours_type?: WorkingHoursType +} + +export interface ListCorehrWorkingHoursTypeResponse { + /** 查询的工时制度信息 */ + items?: WorkingHoursType[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ConvertCorehrCommonDataIdResponse { + /** ID 信息列表 */ + items?: IdInfo[] +} + +export interface BatchGetCorehrEmployeeResponse { + /** 查询的雇佣信息 */ + items?: Employee[] +} + +export interface SearchCorehrEmployeeResponse { + /** 查询的雇佣信息 */ + items?: Employee[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface CreateCorehrEmployeeResponse { + /** 雇佣信息 ID */ + employment_id?: string + /** 合同 ID */ + contract_id?: string + /** 任职信息 ID */ + job_data_id?: string +} + +export interface CreateCorehrPersonResponse { + person?: PersonInfo +} + +export interface PatchCorehrPersonResponse { + person?: PersonInfo +} + +export interface UploadCorehrPersonResponse { + /** 上传文件ID */ + id?: string +} + +export interface CreateCorehrEmploymentResponse { + employment?: EmploymentCreate +} + +export interface PatchCorehrEmploymentResponse { + employment?: Employment +} + +export interface CreateCorehrJobDataResponse { + job_data?: JobData +} + +export interface PatchCorehrJobDataResponse { + job_data?: JobData +} + +export interface QueryCorehrEmployeesJobDataResponse { + /** 任职信息 */ + items?: EmployeeJobData[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface BatchGetCorehrEmployeesJobDataResponse { + /** 查询的雇佣信息 */ + items?: EmployeeJobData[] +} + +export interface ListCorehrJobDataResponse { + /** 查询的任职信息 */ + items?: JobData[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetCorehrJobDataResponse { + /** 任职信息 */ + job_data?: JobData +} + +export interface CreateCorehrEmployeesAdditionalJobResponse { + additional_job?: EmployeesAdditionalJobWriteResp +} + +export interface PatchCorehrEmployeesAdditionalJobResponse { + additional_job?: EmployeesAdditionalJobWriteResp +} + +export interface BatchCorehrEmployeesAdditionalJobResponse { + /** 兼职记录 */ + items?: EmployeesAdditionalJob[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface QueryOperationLogsCorehrDepartmentResponse { + /** 操作日志列表 */ + op_logs?: OrganizationOpLog[] + /** 下一页token */ + next_page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface CreateCorehrDepartmentResponse { + department?: DepartmentCreate +} + +export interface ParentsCorehrDepartmentResponse { + /** 父部门查询结果 */ + items?: DepartmentParents[] +} + +export interface BatchGetCorehrDepartmentResponse { + /** 查询的部门信息 */ + items?: Department[] +} + +export interface QueryRecentChangeCorehrDepartmentResponse { + /** 部门 ID 列表 */ + department_ids?: string[] + /** 目标查询时间范围内被删除的部门列表 */ + deleted_department_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface QueryTimelineCorehrDepartmentResponse { + /** 部门信息 */ + items?: DepartmentTimeline[] +} + +export interface TreeCorehrDepartmentResponse { + /** 部门树节点 */ + items?: DepartmentTree[] + /** 下一页token */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface QueryMultiTimelineCorehrDepartmentResponse { + /** 部门信息 */ + items?: DepartmentTimeline[] + /** 下一页token */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface SearchCorehrDepartmentResponse { + /** 查询的部门信息 */ + items?: Department[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface CreateCorehrLocationResponse { + location?: Location +} + +export interface GetCorehrLocationResponse { + /** 地点信息 */ + location?: Location +} + +export interface QueryRecentChangeCorehrLocationResponse { + /** 地点 ID 列表 */ + location_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的地点 ID 列表 */ + deleted_location_ids?: string[] +} + +export interface BatchGetCorehrLocationResponse { + /** 查询的地点信息 */ + items?: Location[] +} + +export interface ListCorehrLocationResponse { + /** 查询的地点信息 */ + items?: Location[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface CreateCorehrLocationAddressResponse { + /** 地址 ID */ + address_id?: string +} + +export interface CreateCorehrCompanyResponse { + company?: Company +} + +export interface PatchCorehrCompanyResponse { + company?: Company +} + +export interface GetCorehrCompanyResponse { + /** 公司信息 */ + company?: Company +} + +export interface ListCorehrCompanyResponse { + /** 查询的公司信息 */ + items?: Company[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface QueryRecentChangeCorehrCompanyResponse { + /** 公司 ID 列表 */ + company_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的公司 ID 列表 */ + deleted_company_ids?: string[] +} + +export interface BatchGetCorehrCompanyResponse { + /** 查询的公司信息 */ + items?: Company[] +} + +export interface CreateCorehrCostCenterResponse { + cost_center?: CostCenter +} + +export interface PatchCorehrCostCenterResponse { + cost_center?: CostCenter +} + +export interface QueryRecentChangeCorehrCostCenterResponse { + /** 成本中心 ID 列表 */ + cost_center_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的成本中心 ID 列表 */ + deleted_cost_center_ids?: string[] +} + +export interface SearchCorehrCostCenterResponse { + /** 成本中心信息 */ + items?: CostCenterVersion[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface CreateCorehrCostCenterVersionResponse { + version?: CostCenterVersion +} + +export interface PatchCorehrCostCenterVersionResponse { + version?: CostCenterVersion +} + +export interface GetCorehrApprovalGroupsResponse { + /** 组织架构调整流程信息 */ + approval_group?: ApprovalGroup +} + +export interface OpenQueryDepartmentChangeListByIdsCorehrApprovalGroupsResponse { + /** 部门调整记录信息列表 */ + department_changes?: DepartmentChange[] +} + +export interface OpenQueryJobChangeListByIdsCorehrApprovalGroupsResponse { + /** 人员异动记录信息列表 */ + job_changes?: JobChange[] +} + +export interface CreateCorehrJobFamilyResponse { + job_family?: JobFamily +} + +export interface PatchCorehrJobFamilyResponse { + job_family?: JobFamily +} + +export interface GetCorehrJobFamilyResponse { + /** 职务序列信息 */ + job_family?: JobFamily +} + +export interface ListCorehrJobFamilyResponse { + /** 查询的职务序列信息 */ + items?: JobFamily[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface QueryRecentChangeCorehrJobFamilyResponse { + /** 序列 ID 列表 */ + job_family_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的序列 ID 列表 */ + deleted_job_family_ids?: string[] +} + +export interface BatchGetCorehrJobFamilyResponse { + /** 查询的序列信息 */ + items?: JobFamily[] +} + +export interface CreateCorehrJobLevelResponse { + job_level?: JobLevel +} + +export interface PatchCorehrJobLevelResponse { + job_level?: JobLevel +} + +export interface GetCorehrJobLevelResponse { + /** 职务级别信息 */ + job_level?: JobLevel +} + +export interface ListCorehrJobLevelResponse { + /** 查询的职务级别信息 */ + items?: JobLevel[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface QueryRecentChangeCorehrJobLevelResponse { + /** 职级 ID 列表 */ + job_level_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的职级 ID 列表 */ + deleted_job_level_ids?: string[] +} + +export interface BatchGetCorehrJobLevelResponse { + /** 查询的职级信息 */ + items?: JobLevel[] +} + +export interface CreateCorehrJobGradeResponse { + /** 职等ID */ + grade_id?: string +} + +export interface QueryCorehrJobGradeResponse { + /** 职等信息列表 */ + items?: JobGrade[] + /** 下一页token */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface QueryRecentChangeCorehrJobGradeResponse { + /** 职等 ID 列表 */ + job_grade_ids?: string[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean + /** 删除的职等 ID 列表 */ + deleted_job_grade_ids?: string[] +} + +export interface CreateCorehrJobResponse { + job?: Job +} + +export interface PatchCorehrJobResponse { + job?: Job +} + +export interface GetCorehrJobResponse { + /** 职务信息 */ + job?: Job +} + +export interface ListCorehrJobResponse { + /** 查询的职务信息 */ + items?: Job[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface WithdrawOnboardingCorehrPreHireResponse { + /** 是否成功撤销入职 */ + success?: boolean +} + +export interface RestoreFlowInstanceCorehrPreHireResponse { + /** 是否成功恢复入职 */ + success?: boolean +} + +export interface CreateCorehrPreHireResponse { + /** 待入职 ID */ + pre_hire_id?: string +} + +export interface PatchCorehrPreHireResponse { + /** 待入职ID */ + pre_hire_id?: string +} + +export interface QueryCorehrPreHireResponse { + /** 查询待入职的信息 */ + items?: PreHire[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface GetCorehrPreHireResponse { + /** 待入职信息 */ + pre_hire?: PreHire +} + +export interface ListCorehrPreHireResponse { + /** 查询的待入职信息 */ + items?: PreHireQuery[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface SearchCorehrPreHireResponse { + /** 查询的部门信息 */ + items?: PreHire[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface TransitTaskCorehrPreHireResponse { + /** 是否成功流转任务 */ + success?: boolean +} + +export interface CompleteCorehrPreHireResponse { + /** 是否成功完成入职 */ + success?: boolean +} + +export interface PatchCorehrPreHireResponse { + pre_hire?: PreHire +} + +export interface CreateCorehrProbationAssessmentResponse { + /** 创建的试用期考核记录 ID 列表，有序返回 */ + assessment_ids?: string[] +} + +export interface SearchCorehrProbationResponse { + /** 查询的试用期信息 */ + items?: ProbationInfo[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface SubmitCorehrProbationResponse { + /** 试用期信息 */ + probation_info?: ProbationInfoForSubmit +} + +export interface CreateCorehrJobChangeResponse { + /** 异动记录 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 QueryCorehrTransferTypeResponse { + /** 异动类型列表 */ + items?: TransferType[] +} + +export interface QueryCorehrTransferReasonResponse { + /** 异动原因列表 */ + items?: TransferReason[] +} + +export interface SearchCorehrJobChangeResponse { + /** 员工异动列表 */ + items?: JobChange[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface CreateCorehrJobChangeResponse { + /** 异动记录 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 QueryCorehrOffboardingResponse { + /** 离职原因列表 */ + items?: OffboardingReason[] +} + +export interface SubmitV2CorehrOffboardingResponse { + /** 离职记录 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 EditCorehrOffboardingResponse { + /** 编辑字段数据信息 */ + data: ObjectFieldData[] +} + +export interface SearchCorehrOffboardingResponse { + /** 查询的员工离职信息 */ + items?: Offboarding[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface CreateCorehrContractResponse { + contract?: Contract +} + +export interface PatchCorehrContractResponse { + contract?: Contract +} + +export interface GetCorehrContractResponse { + /** 合同信息 */ + contract?: Contract +} + +export interface ListCorehrContractResponse { + /** 查询的合同信息 */ + items?: Contract[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface SearchCorehrContractResponse { + /** 查询的合同信息 */ + items?: Contract[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface ListCorehrWorkforcePlanResponse { + /** 方案列表 */ + items?: WorkforcePlan[] + /** 方案总数 */ + total?: number +} + +export interface BatchCorehrWorkforcePlanDetailResponse { + /** 编制规划方案 ID */ + workforce_plan_id?: string + /** 集中填报项目 ID */ + centralized_reporting_project_id?: string + /** 编制规划明细信息 */ + items?: WorkforcePlanDetail[] + /** 分页标识 */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface CreateCorehrLeaveGrantingRecordResponse { + /** 假期授予记录 */ + leave_granting_record?: LeaveGrantingRecord +} + +export interface LeaveTypesCorehrLeaveResponse { + /** 假期类型列表 */ + leave_type_list?: LeaveType[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface LeaveBalancesCorehrLeaveResponse { + /** 员工假期余额信息列表 */ + employment_leave_balance_list?: EmploymentLeaveBalance[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface LeaveRequestHistoryCorehrLeaveResponse { + /** 请假记录信息列表 */ + leave_request_list?: LeaveRequest[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface WorkCalendarCorehrLeaveResponse { + /** 工作日历列表 */ + work_calendars?: WorkCalendarDetail[] + /** 入参count=true，则返回符合条件的工作日历总数 */ + count?: number +} + +export interface CalendarByScopeCorehrLeaveResponse { + /** 工作日历id */ + calendar_wk_id?: string +} + +export interface WorkCalendarDateCorehrLeaveResponse { + /** 日期类型列表 */ + calendar_dates?: WkCalendarDate[] +} + +export interface QueryCorehrAuthorizationResponse { + /** 查询的用户授权信息 */ + items?: RoleAuthorization[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetByParamCorehrAuthorizationResponse { + /** 角色授权信息 */ + role_authorization?: RoleAuthorization +} + +export interface ListCorehrSecurityGroupResponse { + /** 查询的用户角色信息 */ + items?: SecurityGroup[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface AddRoleAssignCorehrAuthorizationResponse { + /** 授权id */ + assign_id?: string +} + +export interface UpdateRoleAssignCorehrAuthorizationResponse { + /** 授权id */ + assign_id?: string +} + +export interface RemoveRoleAssignCorehrAuthorizationResponse { + /** 授权id */ + assign_id?: string +} + +export interface BatchGetCorehrEmployeesBpResponse { + /** 员工直属 BP 信息，当员工所在部门、属地无 BP 时，会上钻找到最近的 BP */ + employment_direct_bps?: EmploymentBp[] + /** 员工全部 BP 信息 */ + employment_all_bps?: EmploymentBp[] +} + +export interface GetByDepartmentCorehrBpResponse { + /** 部门 HRBP 信息，依次为部门及各层级上级部门 */ + items?: DepartmentHrbp[] +} + +export interface QueryCorehrSecurityGroupResponse { + /** HRBP/属地 BP 信息 */ + hrbp_list?: Hrbp[] +} + +export interface ListCorehrBpResponse { + /** HRBP 信息 */ + items?: Bp[] + /** 下一页页码 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface SearchCorehrAssignedUserResponse { + /** 用户授权信息 */ + items?: RoleAuthorization[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListCorehrProcessResponse { + /** 流程实例ID列表 */ + process_ids?: string[] + /** 是否还有更多项 */ + has_more?: boolean + /** 有更多项时的分页键 */ + page_token?: string +} + +export interface GetCorehrProcessResponse { + /** 流程实例ID */ + process_id?: string + /** 流程状态 */ + 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 GetCorehrProcessFormVariableDataResponse { + /** 表单数据 */ + field_variable_values?: FieldVariableValue[] + /** 流程实例id */ + process_id?: string +} + +export interface ListCorehrApproverResponse { + /** 分页键 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean + /** 审批任务列表 */ + approver_list?: ApproverInfo[] +} + +export interface UpdateCorehrProcessApproverResponse { + /** 错误码，非 0 表示失败 */ + code: number + /** 错误描述 */ + msg?: string +} + +export interface MatchCorehrCompensationStandardResponse { + /** 薪资标准表ID */ + standard_id?: string + /** 薪资等级 */ + grade?: CpstGrade + /** 生效时间 */ + effective_time?: string +} + +export interface GetCorehrProcessFormVariableDataResponse { + /** 流程变量 */ + field_variable_values?: FormFieldVariable[] +} + +export interface ListCorehrSubregionResponse { + /** 城市/区域信息 */ + items?: Subregion[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetCorehrSubregionResponse { + /** 城市/区域信息 */ + subregion?: Subregion +} + +export interface ListCorehrSubdivisionResponse { + /** 省份/行政区信息 */ + items?: Subdivision[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetCorehrSubdivisionResponse { + /** 国家/地址信息 */ + subdivision?: Subdivision +} + +export interface ListCorehrCountryRegionResponse { + /** 国家/地址信息 */ + items?: CountryRegion[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetCorehrCountryRegionResponse { + /** 国家/地址信息 */ + country_region?: CountryRegion +} + +export interface ListCorehrCurrencyResponse { + /** 货币信息 */ + items?: Currency[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetCorehrCurrencyResponse { + /** 货币信息 */ + currency?: Currency +} + +export interface GetCorehrJobResponse { + /** 职务信息 */ + job?: Job +} + +export interface PatchCorehrDepartmentResponse { + department?: Department +} + +export interface GetCorehrDepartmentResponse { + /** 部门信息 */ + department?: Department +} + +export interface ListCorehrJobResponse { + /** 查询的职务信息 */ + items?: Job[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListCorehrDepartmentResponse { + /** 查询的部门信息 */ + items?: Department[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface PatchCorehrPersonResponse { + person?: Person +} + +export interface CreateCorehrPersonResponse { + person?: Person +} + +export interface GetCorehrPersonResponse { + /** 个人信息 */ + person?: Person +} + +export interface SubmitCorehrOffboardingResponse { + /** 离职记录 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 +} + +Internal.define({ + '/open-apis/corehr/v1/custom_fields/list_object_api_name': { + GET: 'listObjectApiNameCorehrCustomField', + }, + '/open-apis/corehr/v1/custom_fields/query': { + GET: 'queryCorehrCustomField', + }, + '/open-apis/corehr/v1/custom_fields/get_by_param': { + GET: 'getByParamCorehrCustomField', + }, + '/open-apis/corehr/v1/common_data/meta_data/add_enum_option': { + POST: 'addEnumOptionCorehrCommonDataMetaData', + }, + '/open-apis/corehr/v1/common_data/meta_data/edit_enum_option': { + POST: 'editEnumOptionCorehrCommonDataMetaData', + }, + '/open-apis/corehr/v2/basic_info/country_regions/search': { + POST: 'searchCorehrBasicInfoCountryRegion', + }, + '/open-apis/corehr/v2/basic_info/country_region_subdivisions/search': { + POST: 'searchCorehrBasicInfoCountryRegionSubdivision', + }, + '/open-apis/corehr/v2/basic_info/cities/search': { + POST: 'searchCorehrBasicInfoCity', + }, + '/open-apis/corehr/v2/basic_info/districts/search': { + POST: 'searchCorehrBasicInfoDistrict', + }, + '/open-apis/corehr/v2/basic_info/nationalities/search': { + POST: 'searchCorehrBasicInfoNationality', + }, + '/open-apis/corehr/v1/national_id_types': { + POST: 'createCorehrNationalIdType', + GET: 'listCorehrNationalIdType', + }, + '/open-apis/corehr/v1/national_id_types/{national_id_type_id}': { + DELETE: 'deleteCorehrNationalIdType', + PATCH: 'patchCorehrNationalIdType', + GET: 'getCorehrNationalIdType', + }, + '/open-apis/corehr/v2/basic_info/banks/search': { + POST: 'searchCorehrBasicInfoBank', + }, + '/open-apis/corehr/v2/basic_info/bank_branchs/search': { + POST: 'searchCorehrBasicInfoBankBranch', + }, + '/open-apis/corehr/v2/basic_info/currencies/search': { + POST: 'searchCorehrBasicInfoCurrency', + }, + '/open-apis/corehr/v2/basic_info/time_zones/search': { + POST: 'searchCorehrBasicInfoTimeZone', + }, + '/open-apis/corehr/v2/basic_info/languages/search': { + POST: 'searchCorehrBasicInfoLanguage', + }, + '/open-apis/corehr/v1/employee_types': { + POST: 'createCorehrEmployeeType', + GET: 'listCorehrEmployeeType', + }, + '/open-apis/corehr/v1/employee_types/{employee_type_id}': { + DELETE: 'deleteCorehrEmployeeType', + PATCH: 'patchCorehrEmployeeType', + GET: 'getCorehrEmployeeType', + }, + '/open-apis/corehr/v1/working_hours_types': { + POST: 'createCorehrWorkingHoursType', + GET: 'listCorehrWorkingHoursType', + }, + '/open-apis/corehr/v1/working_hours_types/{working_hours_type_id}': { + DELETE: 'deleteCorehrWorkingHoursType', + PATCH: 'patchCorehrWorkingHoursType', + GET: 'getCorehrWorkingHoursType', + }, + '/open-apis/corehr/v1/common_data/id/convert': { + POST: 'convertCorehrCommonDataId', + }, + '/open-apis/corehr/v2/employees/batch_get': { + POST: 'batchGetCorehrEmployee', + }, + '/open-apis/corehr/v2/employees/search': { + POST: 'searchCorehrEmployee', + }, + '/open-apis/corehr/v2/employees': { + POST: 'createCorehrEmployee', + }, + '/open-apis/corehr/v2/persons': { + POST: 'createCorehrPerson', + }, + '/open-apis/corehr/v2/persons/{person_id}': { + PATCH: 'patchCorehrPerson', + }, + '/open-apis/corehr/v1/persons/{person_id}': { + DELETE: 'deleteCorehrPerson', + PATCH: 'patchCorehrPerson', + GET: 'getCorehrPerson', + }, + '/open-apis/corehr/v1/persons/upload': { + POST: { name: 'uploadCorehrPerson', multipart: true }, + }, + '/open-apis/corehr/v1/files/{id}': { + GET: { name: 'getCorehrFile', type: 'binary' }, + }, + '/open-apis/corehr/v1/employments': { + POST: 'createCorehrEmployment', + }, + '/open-apis/corehr/v1/employments/{employment_id}': { + PATCH: 'patchCorehrEmployment', + DELETE: 'deleteCorehrEmployment', + }, + '/open-apis/corehr/v1/job_datas': { + POST: 'createCorehrJobData', + GET: 'listCorehrJobData', + }, + '/open-apis/corehr/v1/job_datas/{job_data_id}': { + DELETE: 'deleteCorehrJobData', + PATCH: 'patchCorehrJobData', + GET: 'getCorehrJobData', + }, + '/open-apis/corehr/v2/employees/job_datas/query': { + POST: 'queryCorehrEmployeesJobData', + }, + '/open-apis/corehr/v2/employees/job_datas/batch_get': { + POST: 'batchGetCorehrEmployeesJobData', + }, + '/open-apis/corehr/v2/employees/additional_jobs': { + POST: 'createCorehrEmployeesAdditionalJob', + }, + '/open-apis/corehr/v2/employees/additional_jobs/{additional_job_id}': { + PATCH: 'patchCorehrEmployeesAdditionalJob', + DELETE: 'deleteCorehrEmployeesAdditionalJob', + }, + '/open-apis/corehr/v2/employees/additional_jobs/batch': { + POST: 'batchCorehrEmployeesAdditionalJob', + }, + '/open-apis/corehr/v2/departments/query_operation_logs': { + POST: 'queryOperationLogsCorehrDepartment', + }, + '/open-apis/corehr/v1/departments': { + POST: 'createCorehrDepartment', + GET: 'listCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/{department_id}': { + PATCH: 'patchCorehrDepartment', + DELETE: 'deleteCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/parents': { + POST: 'parentsCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/batch_get': { + POST: 'batchGetCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/query_recent_change': { + GET: 'queryRecentChangeCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/query_timeline': { + POST: 'queryTimelineCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/tree': { + POST: 'treeCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/query_multi_timeline': { + POST: 'queryMultiTimelineCorehrDepartment', + }, + '/open-apis/corehr/v2/departments/search': { + POST: 'searchCorehrDepartment', + }, + '/open-apis/corehr/v1/locations': { + POST: 'createCorehrLocation', + GET: 'listCorehrLocation', + }, + '/open-apis/corehr/v2/locations/{location_id}': { + PATCH: 'patchCorehrLocation', + }, + '/open-apis/corehr/v1/locations/{location_id}': { + GET: 'getCorehrLocation', + DELETE: 'deleteCorehrLocation', + }, + '/open-apis/corehr/v2/locations/query_recent_change': { + GET: 'queryRecentChangeCorehrLocation', + }, + '/open-apis/corehr/v2/locations/batch_get': { + POST: 'batchGetCorehrLocation', + }, + '/open-apis/corehr/v2/locations/active': { + POST: 'activeCorehrLocation', + }, + '/open-apis/corehr/v2/locations/{location_id}/addresses/{address_id}': { + DELETE: 'deleteCorehrLocationAddress', + PATCH: 'patchCorehrLocationAddress', + }, + '/open-apis/corehr/v2/locations/{location_id}/addresses': { + POST: 'createCorehrLocationAddress', + }, + '/open-apis/corehr/v1/companies': { + POST: 'createCorehrCompany', + GET: 'listCorehrCompany', + }, + '/open-apis/corehr/v1/companies/{company_id}': { + PATCH: 'patchCorehrCompany', + GET: 'getCorehrCompany', + DELETE: 'deleteCorehrCompany', + }, + '/open-apis/corehr/v2/companies/active': { + POST: 'activeCorehrCompany', + }, + '/open-apis/corehr/v2/companies/query_recent_change': { + GET: 'queryRecentChangeCorehrCompany', + }, + '/open-apis/corehr/v2/companies/batch_get': { + POST: 'batchGetCorehrCompany', + }, + '/open-apis/corehr/v2/cost_centers': { + POST: 'createCorehrCostCenter', + }, + '/open-apis/corehr/v2/cost_centers/{cost_center_id}': { + PATCH: 'patchCorehrCostCenter', + DELETE: 'deleteCorehrCostCenter', + }, + '/open-apis/corehr/v2/cost_centers/query_recent_change': { + GET: 'queryRecentChangeCorehrCostCenter', + }, + '/open-apis/corehr/v2/cost_centers/search': { + POST: 'searchCorehrCostCenter', + }, + '/open-apis/corehr/v2/cost_centers/{cost_center_id}/versions': { + POST: 'createCorehrCostCenterVersion', + }, + '/open-apis/corehr/v2/cost_centers/{cost_center_id}/versions/{version_id}': { + PATCH: 'patchCorehrCostCenterVersion', + DELETE: 'deleteCorehrCostCenterVersion', + }, + '/open-apis/corehr/v2/approval_groups/{process_id}': { + GET: 'getCorehrApprovalGroups', + }, + '/open-apis/corehr/v2/approval_groups/open_query_department_change_list_by_ids': { + POST: 'openQueryDepartmentChangeListByIdsCorehrApprovalGroups', + }, + '/open-apis/corehr/v2/approval_groups/open_query_job_change_list_by_ids': { + POST: 'openQueryJobChangeListByIdsCorehrApprovalGroups', + }, + '/open-apis/corehr/v1/job_families': { + POST: 'createCorehrJobFamily', + GET: 'listCorehrJobFamily', + }, + '/open-apis/corehr/v1/job_families/{job_family_id}': { + PATCH: 'patchCorehrJobFamily', + GET: 'getCorehrJobFamily', + DELETE: 'deleteCorehrJobFamily', + }, + '/open-apis/corehr/v2/job_families/query_recent_change': { + GET: 'queryRecentChangeCorehrJobFamily', + }, + '/open-apis/corehr/v2/job_families/batch_get': { + POST: 'batchGetCorehrJobFamily', + }, + '/open-apis/corehr/v1/job_levels': { + POST: 'createCorehrJobLevel', + GET: 'listCorehrJobLevel', + }, + '/open-apis/corehr/v1/job_levels/{job_level_id}': { + PATCH: 'patchCorehrJobLevel', + GET: 'getCorehrJobLevel', + DELETE: 'deleteCorehrJobLevel', + }, + '/open-apis/corehr/v2/job_levels/query_recent_change': { + GET: 'queryRecentChangeCorehrJobLevel', + }, + '/open-apis/corehr/v2/job_levels/batch_get': { + POST: 'batchGetCorehrJobLevel', + }, + '/open-apis/corehr/v2/job_grades': { + POST: 'createCorehrJobGrade', + }, + '/open-apis/corehr/v2/job_grades/{job_grade_id}': { + PATCH: 'patchCorehrJobGrade', + DELETE: 'deleteCorehrJobGrade', + }, + '/open-apis/corehr/v2/job_grades/query': { + POST: 'queryCorehrJobGrade', + }, + '/open-apis/corehr/v2/job_grades/query_recent_change': { + GET: 'queryRecentChangeCorehrJobGrade', + }, + '/open-apis/corehr/v1/jobs': { + POST: 'createCorehrJob', + GET: 'listCorehrJob', + }, + '/open-apis/corehr/v1/jobs/{job_id}': { + DELETE: 'deleteCorehrJob', + PATCH: 'patchCorehrJob', + GET: 'getCorehrJob', + }, + '/open-apis/corehr/v2/jobs/{job_id}': { + GET: 'getCorehrJob', + }, + '/open-apis/corehr/v2/jobs': { + GET: 'listCorehrJob', + }, + '/open-apis/corehr/v2/pre_hires/withdraw_onboarding': { + POST: 'withdrawOnboardingCorehrPreHire', + }, + '/open-apis/corehr/v2/pre_hires/restore_flow_instance': { + POST: 'restoreFlowInstanceCorehrPreHire', + }, + '/open-apis/corehr/v2/pre_hires': { + POST: 'createCorehrPreHire', + }, + '/open-apis/corehr/v2/pre_hires/{pre_hire_id}': { + PATCH: 'patchCorehrPreHire', + DELETE: 'deleteCorehrPreHire', + }, + '/open-apis/corehr/v2/pre_hires/query': { + POST: 'queryCorehrPreHire', + }, + '/open-apis/corehr/v1/pre_hires/{pre_hire_id}': { + GET: 'getCorehrPreHire', + DELETE: 'deleteCorehrPreHire', + PATCH: 'patchCorehrPreHire', + }, + '/open-apis/corehr/v1/pre_hires': { + GET: 'listCorehrPreHire', + }, + '/open-apis/corehr/v2/pre_hires/search': { + POST: 'searchCorehrPreHire', + }, + '/open-apis/corehr/v2/pre_hires/{pre_hire_id}/transit_task': { + POST: 'transitTaskCorehrPreHire', + }, + '/open-apis/corehr/v2/pre_hires/{pre_hire_id}/complete': { + POST: 'completeCorehrPreHire', + }, + '/open-apis/corehr/v2/probation/assessments': { + POST: 'createCorehrProbationAssessment', + }, + '/open-apis/corehr/v2/probation/enable_disable_assessment': { + POST: 'enableDisableAssessmentCorehrProbation', + }, + '/open-apis/corehr/v2/probation/assessments/{assessment_id}': { + PATCH: 'patchCorehrProbationAssessment', + DELETE: 'deleteCorehrProbationAssessment', + }, + '/open-apis/corehr/v2/probation/search': { + POST: 'searchCorehrProbation', + }, + '/open-apis/corehr/v2/probation/submit': { + POST: 'submitCorehrProbation', + }, + '/open-apis/corehr/v2/probation/withdraw': { + POST: 'withdrawCorehrProbation', + }, + '/open-apis/corehr/v2/job_changes': { + POST: 'createCorehrJobChange', + }, + '/open-apis/corehr/v1/transfer_types/query': { + GET: 'queryCorehrTransferType', + }, + '/open-apis/corehr/v1/transfer_reasons/query': { + GET: 'queryCorehrTransferReason', + }, + '/open-apis/corehr/v2/job_changes/search': { + POST: 'searchCorehrJobChange', + }, + '/open-apis/corehr/v2/job_changes/{job_change_id}/revoke': { + POST: 'revokeCorehrJobChange', + }, + '/open-apis/corehr/v1/job_changes': { + POST: 'createCorehrJobChange', + }, + '/open-apis/corehr/v1/offboardings/query': { + POST: 'queryCorehrOffboarding', + }, + '/open-apis/corehr/v2/offboardings/submit_v2': { + POST: 'submitV2CorehrOffboarding', + }, + '/open-apis/corehr/v2/offboardings/edit': { + POST: 'editCorehrOffboarding', + }, + '/open-apis/corehr/v2/offboardings/revoke': { + POST: 'revokeCorehrOffboarding', + }, + '/open-apis/corehr/v1/offboardings/search': { + POST: 'searchCorehrOffboarding', + }, + '/open-apis/corehr/v1/contracts': { + POST: 'createCorehrContract', + GET: 'listCorehrContract', + }, + '/open-apis/corehr/v1/contracts/{contract_id}': { + PATCH: 'patchCorehrContract', + DELETE: 'deleteCorehrContract', + GET: 'getCorehrContract', + }, + '/open-apis/corehr/v2/contracts/search': { + POST: 'searchCorehrContract', + }, + '/open-apis/corehr/v2/workforce_plan_detail_row/batchSave': { + POST: 'batchSaveCorehrWorkforcePlanDetailRow', + }, + '/open-apis/corehr/v2/workforce_plan_detail_row/batchDelete': { + POST: 'batchDeleteCorehrWorkforcePlanDetailRow', + }, + '/open-apis/corehr/v2/report_detail_row/batchSave': { + POST: 'batchSaveCorehrReportDetailRow', + }, + '/open-apis/corehr/v2/report_detail_row/batchDelete': { + POST: 'batchDeleteCorehrReportDetailRow', + }, + '/open-apis/corehr/v2/workforce_plans': { + GET: 'listCorehrWorkforcePlan', + }, + '/open-apis/corehr/v2/workforce_plan_details/batch': { + POST: 'batchCorehrWorkforcePlanDetail', + }, + '/open-apis/corehr/v1/leave_granting_records': { + POST: 'createCorehrLeaveGrantingRecord', + }, + '/open-apis/corehr/v1/leave_granting_records/{leave_granting_record_id}': { + DELETE: 'deleteCorehrLeaveGrantingRecord', + }, + '/open-apis/corehr/v1/leaves/leave_types': { + GET: 'leaveTypesCorehrLeave', + }, + '/open-apis/corehr/v1/leaves/leave_balances': { + GET: 'leaveBalancesCorehrLeave', + }, + '/open-apis/corehr/v1/leaves/leave_request_history': { + GET: 'leaveRequestHistoryCorehrLeave', + }, + '/open-apis/corehr/v1/leaves/work_calendar': { + POST: 'workCalendarCorehrLeave', + }, + '/open-apis/corehr/v1/leaves/calendar_by_scope': { + GET: 'calendarByScopeCorehrLeave', + }, + '/open-apis/corehr/v1/leaves/work_calendar_date': { + POST: 'workCalendarDateCorehrLeave', + }, + '/open-apis/corehr/v1/authorizations/query': { + GET: 'queryCorehrAuthorization', + }, + '/open-apis/corehr/v1/authorizations/get_by_param': { + GET: 'getByParamCorehrAuthorization', + }, + '/open-apis/corehr/v1/security_groups': { + GET: 'listCorehrSecurityGroup', + }, + '/open-apis/corehr/v1/authorizations/add_role_assign': { + POST: 'addRoleAssignCorehrAuthorization', + }, + '/open-apis/corehr/v1/authorizations/update_role_assign': { + POST: 'updateRoleAssignCorehrAuthorization', + }, + '/open-apis/corehr/v1/authorizations/remove_role_assign': { + POST: 'removeRoleAssignCorehrAuthorization', + }, + '/open-apis/corehr/v2/employees/bps/batch_get': { + POST: 'batchGetCorehrEmployeesBp', + }, + '/open-apis/corehr/v2/bps/get_by_department': { + POST: 'getByDepartmentCorehrBp', + }, + '/open-apis/corehr/v1/security_groups/query': { + POST: 'queryCorehrSecurityGroup', + }, + '/open-apis/corehr/v2/bps': { + GET: 'listCorehrBp', + }, + '/open-apis/corehr/v1/assigned_users/search': { + POST: 'searchCorehrAssignedUser', + }, + '/open-apis/corehr/v2/processes': { + GET: 'listCorehrProcess', + }, + '/open-apis/corehr/v2/processes/{process_id}': { + GET: 'getCorehrProcess', + }, + '/open-apis/corehr/v2/processes/{process_id}/form_variable_data': { + GET: 'getCorehrProcessFormVariableData', + }, + '/open-apis/corehr/v2/process_revoke/{process_id}': { + PUT: 'updateCorehrProcessRevoke', + }, + '/open-apis/corehr/v2/process_withdraw/{process_id}': { + PUT: 'updateCorehrProcessWithdraw', + }, + '/open-apis/corehr/v2/approvers': { + GET: 'listCorehrApprover', + }, + '/open-apis/corehr/v2/processes/{process_id}/approvers/{approver_id}': { + PUT: 'updateCorehrProcessApprover', + }, + '/open-apis/corehr/v2/processes/{process_id}/extra': { + PUT: 'updateCorehrProcessExtra', + }, + '/open-apis/corehr/v2/processes/{process_id}/transfer': { + PUT: 'updateCorehrProcessTransfer', + }, + '/open-apis/corehr/v1/compensation_standards/match': { + GET: 'matchCorehrCompensationStandard', + }, + '/open-apis/corehr/v1/processes/{process_id}/form_variable_data': { + GET: 'getCorehrProcessFormVariableData', + }, + '/open-apis/corehr/v1/subregions': { + GET: 'listCorehrSubregion', + }, + '/open-apis/corehr/v1/subregions/{subregion_id}': { + GET: 'getCorehrSubregion', + }, + '/open-apis/corehr/v1/subdivisions': { + GET: 'listCorehrSubdivision', + }, + '/open-apis/corehr/v1/subdivisions/{subdivision_id}': { + GET: 'getCorehrSubdivision', + }, + '/open-apis/corehr/v1/country_regions': { + GET: 'listCorehrCountryRegion', + }, + '/open-apis/corehr/v1/country_regions/{country_region_id}': { + GET: 'getCorehrCountryRegion', + }, + '/open-apis/corehr/v1/currencies': { + GET: 'listCorehrCurrency', + }, + '/open-apis/corehr/v1/currencies/{currency_id}': { + GET: 'getCorehrCurrency', + }, + '/open-apis/corehr/v1/departments/{department_id}': { + DELETE: 'deleteCorehrDepartment', + PATCH: 'patchCorehrDepartment', + GET: 'getCorehrDepartment', + }, + '/open-apis/corehr/v1/persons': { + POST: 'createCorehrPerson', + }, + '/open-apis/corehr/v1/offboardings/submit': { + POST: 'submitCorehrOffboarding', + }, +}) diff --git a/adapters/lark/src/types/docs.ts b/adapters/lark/src/types/docs.ts new file mode 100644 index 00000000..6683e78c --- /dev/null +++ b/adapters/lark/src/types/docs.ts @@ -0,0 +1,33 @@ +import { Internal } from '../internal' + +declare module '../internal' { + interface Internal { + /** + * 获取云文档内容 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/docs-v1/content/get + */ + getDocsContent(query?: GetDocsContentQuery): Promise + } +} + +export interface GetDocsContentQuery { + /** 文档唯一标识 */ + doc_token: string + /** 文档类型 */ + doc_type: 'docx' + /** 内容类型 */ + content_type: 'markdown' + /** 语言 */ + lang?: 'zh' | 'en' | 'ja' +} + +export interface GetDocsContentResponse { + /** 内容 */ + content?: string +} + +Internal.define({ + '/open-apis/docs/v1/content': { + GET: 'getDocsContent', + }, +}) diff --git a/adapters/lark/src/types/document_ai.ts b/adapters/lark/src/types/document_ai.ts new file mode 100644 index 00000000..b3b1136e --- /dev/null +++ b/adapters/lark/src/types/document_ai.ts @@ -0,0 +1,352 @@ +import { Internal } from '../internal' +import { BankCard, BankInfo, BodyInfo, BusinessLicense, ChinesePassport, DrvingLicense, ExtractCopy, ExtractCurrency, ExtractPrice, ExtractTime, FoodManageLicense, FoodProduceLicense, HealthCertificate, HkmMainlandTravelPermit, IdCard, RecognizedEntities, Resume, TaxiInvoice, TrainInvoice, TwMainlandTravelPermit, VatInvoice, VehicleInvoice, VehicleLicense } from '.' + +declare module '../internal' { + interface Internal { + /** + * 识别文件中的简历信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/resume/parse + */ + parseDocumentAiResume(form: ParseDocumentAiResumeForm): Promise + /** + * 识别文件中的机动车发票 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vehicle_invoice/recognize + */ + recognizeDocumentAiVehicleInvoice(form: RecognizeDocumentAiVehicleInvoiceForm): Promise + /** + * 识别文件中的健康证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/health_certificate/recognize + */ + recognizeDocumentAiHealthCertificate(form: RecognizeDocumentAiHealthCertificateForm): Promise + /** + * 识别文件中的港澳居民来往内地通行证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/hkm_mainland_travel_permit/recognize + */ + recognizeDocumentAiHkmMainlandTravelPermit(form: RecognizeDocumentAiHkmMainlandTravelPermitForm): Promise + /** + * 识别文件中的台湾居民来往大陆通行证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/tw_mainland_travel_permit/recognize + */ + recognizeDocumentAiTwMainlandTravelPermit(form: RecognizeDocumentAiTwMainlandTravelPermitForm): Promise + /** + * 识别文件中的中国护照 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/chinese_passport/recognize + */ + recognizeDocumentAiChinesePassport(form: RecognizeDocumentAiChinesePassportForm): Promise + /** + * 识别文件中的银行卡 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/bank_card/recognize + */ + recognizeDocumentAiBankCard(form: RecognizeDocumentAiBankCardForm): Promise + /** + * 识别文件中的行驶证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vehicle_license/recognize + */ + recognizeDocumentAiVehicleLicense(form: RecognizeDocumentAiVehicleLicenseForm): Promise + /** + * 识别文件中的火车票 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/train_invoice/recognize + */ + recognizeDocumentAiTrainInvoice(form: RecognizeDocumentAiTrainInvoiceForm): Promise + /** + * 识别文件中的出租车发票 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/taxi_invoice/recognize + */ + recognizeDocumentAiTaxiInvoice(form: RecognizeDocumentAiTaxiInvoiceForm): Promise + /** + * 识别文件中的身份证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/id_card/recognize + */ + recognizeDocumentAiIdCard(form: RecognizeDocumentAiIdCardForm): Promise + /** + * 识别文件中的食品生产许可证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/food_produce_license/recognize + */ + recognizeDocumentAiFoodProduceLicense(form: RecognizeDocumentAiFoodProduceLicenseForm): Promise + /** + * 识别文件中的食品经营许可证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/food_manage_license/recognize + */ + recognizeDocumentAiFoodManageLicense(form: RecognizeDocumentAiFoodManageLicenseForm): Promise + /** + * 识别文件中的驾驶证 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/driving_license/recognize + */ + recognizeDocumentAiDrivingLicense(form: RecognizeDocumentAiDrivingLicenseForm): Promise + /** + * 识别文件中的增值税发票 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vat_invoice/recognize + */ + recognizeDocumentAiVatInvoice(form: RecognizeDocumentAiVatInvoiceForm): Promise + /** + * 识别文件中的营业执照 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/business_license/recognize + */ + recognizeDocumentAiBusinessLicense(form: RecognizeDocumentAiBusinessLicenseForm): Promise + /** + * 提取文件中的合同字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/contract/field_extraction + */ + fieldExtractionDocumentAiContract(form: FieldExtractionDocumentAiContractForm): Promise + /** + * 识别文件中的名片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/business_card/recognize + */ + recognizeDocumentAiBusinessCard(form: RecognizeDocumentAiBusinessCardForm): Promise + } +} + +export interface ParseDocumentAiResumeForm { + /** 简历文件，支持 PDF / DOCX / PNG / JPG */ + file: Blob +} + +export interface RecognizeDocumentAiVehicleInvoiceForm { + /** 识别的机动车发票源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiHealthCertificateForm { + /** 识别的健康证源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiHkmMainlandTravelPermitForm { + /** 识别的港澳居民来往内地通行证源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiTwMainlandTravelPermitForm { + /** 识别的台湾居民来往大陆通行证源文件 */ + file?: Blob +} + +export interface RecognizeDocumentAiChinesePassportForm { + /** 识别的中国护照源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiBankCardForm { + /** 识别的银行卡源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiVehicleLicenseForm { + /** 识别的行驶证源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiTrainInvoiceForm { + /** 识别的火车票源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiTaxiInvoiceForm { + /** 识别的出租车票源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiIdCardForm { + /** 识别身份证的源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiFoodProduceLicenseForm { + /** 识别的食品生产许可证源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiFoodManageLicenseForm { + /** 识别的食品经营许可证源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiDrivingLicenseForm { + /** 识别的驾驶证源文件 */ + file: Blob +} + +export interface RecognizeDocumentAiVatInvoiceForm { + /** 识别的增值税发票文件 */ + file: Blob +} + +export interface RecognizeDocumentAiBusinessLicenseForm { + /** 识别的营业执照源文件 */ + file: Blob +} + +export interface FieldExtractionDocumentAiContractForm { + /** 合同字段解析的源文件，当前只支持pdf, doc, docx三种类型的文件 */ + file: Blob + /** pdf页数限制，太长会导致latency增加，最大允许100页 */ + pdf_page_limit: number + /** ocr 参数，当前支持force, pdf, unused三种格式 */ + 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 + /** 总交易金额 */ + price?: ExtractPrice + /** 期限相关信息，包括开始日期、结束日期、有效时长 */ + time?: ExtractTime + /** 盖章份数 */ + copy?: ExtractCopy + /** 币种 */ + currency?: ExtractCurrency + /** 合同标题 */ + header?: string + /** 主体信息 */ + body_info?: BodyInfo[] + /** 银行信息 */ + bank_info?: BankInfo[] +} + +export interface RecognizeDocumentAiBusinessCardResponse { + /** 名片信息 */ + business_cards?: RecognizedEntities[] +} + +Internal.define({ + '/open-apis/document_ai/v1/resume/parse': { + POST: { name: 'parseDocumentAiResume', multipart: true }, + }, + '/open-apis/document_ai/v1/vehicle_invoice/recognize': { + POST: { name: 'recognizeDocumentAiVehicleInvoice', multipart: true }, + }, + '/open-apis/document_ai/v1/health_certificate/recognize': { + POST: { name: 'recognizeDocumentAiHealthCertificate', multipart: true }, + }, + '/open-apis/document_ai/v1/hkm_mainland_travel_permit/recognize': { + POST: { name: 'recognizeDocumentAiHkmMainlandTravelPermit', multipart: true }, + }, + '/open-apis/document_ai/v1/tw_mainland_travel_permit/recognize': { + POST: { name: 'recognizeDocumentAiTwMainlandTravelPermit', multipart: true }, + }, + '/open-apis/document_ai/v1/chinese_passport/recognize': { + POST: { name: 'recognizeDocumentAiChinesePassport', multipart: true }, + }, + '/open-apis/document_ai/v1/bank_card/recognize': { + POST: { name: 'recognizeDocumentAiBankCard', multipart: true }, + }, + '/open-apis/document_ai/v1/vehicle_license/recognize': { + POST: { name: 'recognizeDocumentAiVehicleLicense', multipart: true }, + }, + '/open-apis/document_ai/v1/train_invoice/recognize': { + POST: { name: 'recognizeDocumentAiTrainInvoice', multipart: true }, + }, + '/open-apis/document_ai/v1/taxi_invoice/recognize': { + POST: { name: 'recognizeDocumentAiTaxiInvoice', multipart: true }, + }, + '/open-apis/document_ai/v1/id_card/recognize': { + POST: { name: 'recognizeDocumentAiIdCard', multipart: true }, + }, + '/open-apis/document_ai/v1/food_produce_license/recognize': { + POST: { name: 'recognizeDocumentAiFoodProduceLicense', multipart: true }, + }, + '/open-apis/document_ai/v1/food_manage_license/recognize': { + POST: { name: 'recognizeDocumentAiFoodManageLicense', multipart: true }, + }, + '/open-apis/document_ai/v1/driving_license/recognize': { + POST: { name: 'recognizeDocumentAiDrivingLicense', multipart: true }, + }, + '/open-apis/document_ai/v1/vat_invoice/recognize': { + POST: { name: 'recognizeDocumentAiVatInvoice', multipart: true }, + }, + '/open-apis/document_ai/v1/business_license/recognize': { + POST: { name: 'recognizeDocumentAiBusinessLicense', multipart: true }, + }, + '/open-apis/document_ai/v1/contract/field_extraction': { + POST: { name: 'fieldExtractionDocumentAiContract', multipart: true }, + }, + '/open-apis/document_ai/v1/business_card/recognize': { + POST: { name: 'recognizeDocumentAiBusinessCard', multipart: true }, + }, +}) diff --git a/adapters/lark/src/types/docx.ts b/adapters/lark/src/types/docx.ts new file mode 100644 index 00000000..bf0a03bd --- /dev/null +++ b/adapters/lark/src/types/docx.ts @@ -0,0 +1,523 @@ +import { Internal } from '../internal' +import { Block, BlockIdRelation, DeleteGridColumnRequest, DeleteTableColumnsRequest, DeleteTableRowsRequest, Document, InsertGridColumnRequest, InsertTableColumnRequest, InsertTableRowRequest, MergeTableCellsRequest, ReplaceFileRequest, ReplaceImageRequest, UnmergeTableCellsRequest, UpdateBlockRequest, UpdateGridColumnWidthRatioRequest, UpdateTablePropertyRequest, UpdateTaskRequest, UpdateTextElementsRequest, UpdateTextRequest, UpdateTextStyleRequest } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取群公告基本信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement/get + */ + getDocxChatAnnouncement(chat_id: string, query?: GetDocxChatAnnouncementQuery): Promise + /** + * 获取群公告所有块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/list + */ + listDocxChatAnnouncementBlock(chat_id: string, query?: ListDocxChatAnnouncementBlockQuery): Promise + /** + * 在群公告中创建块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/create + */ + createDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, body: CreateDocxChatAnnouncementBlockChildrenRequest, query?: CreateDocxChatAnnouncementBlockChildrenQuery): Promise + /** + * 批量更新群公告块的内容 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/batch_update + */ + batchUpdateDocxChatAnnouncementBlock(chat_id: string, body: BatchUpdateDocxChatAnnouncementBlockRequest, query?: BatchUpdateDocxChatAnnouncementBlockQuery): Promise + /** + * 获取群公告块的内容 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/get + */ + getDocxChatAnnouncementBlock(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockQuery): Promise + /** + * 获取所有子块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/get + */ + getDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockChildrenQuery): Promise + /** + * 删除群公告中的块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/batch_delete + */ + batchDeleteDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, body: BatchDeleteDocxChatAnnouncementBlockChildrenRequest, query?: BatchDeleteDocxChatAnnouncementBlockChildrenQuery): Promise + /** + * 创建文档 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/create + */ + createDocxDocument(body: CreateDocxDocumentRequest): Promise + /** + * 获取文档基本信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/get + */ + getDocxDocument(document_id: string): Promise + /** + * 获取文档纯文本内容 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/raw_content + */ + rawContentDocxDocument(document_id: string, query?: RawContentDocxDocumentQuery): Promise + /** + * 获取文档所有块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list + */ + listDocxDocumentBlock(document_id: string, query?: ListDocxDocumentBlockQuery): Promise + /** + * 创建块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/create + */ + createDocxDocumentBlockChildren(document_id: string, block_id: string, body: CreateDocxDocumentBlockChildrenRequest, query?: CreateDocxDocumentBlockChildrenQuery): Promise + /** + * 创建嵌套块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-descendant/create + */ + createDocxDocumentBlockDescendant(document_id: string, block_id: string, body: CreateDocxDocumentBlockDescendantRequest, query?: CreateDocxDocumentBlockDescendantQuery): Promise + /** + * 更新块的内容 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/patch + */ + patchDocxDocumentBlock(document_id: string, block_id: string, body: PatchDocxDocumentBlockRequest, query?: PatchDocxDocumentBlockQuery): Promise + /** + * 获取块的内容 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/get + */ + getDocxDocumentBlock(document_id: string, block_id: string, query?: GetDocxDocumentBlockQuery): Promise + /** + * 批量更新块的内容 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/batch_update + */ + batchUpdateDocxDocumentBlock(document_id: string, body: BatchUpdateDocxDocumentBlockRequest, query?: BatchUpdateDocxDocumentBlockQuery): Promise + /** + * 获取所有子块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/get + */ + getDocxDocumentBlockChildren(document_id: string, block_id: string, query?: GetDocxDocumentBlockChildrenQuery): Promise + /** + * 删除块 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/batch_delete + */ + batchDeleteDocxDocumentBlockChildren(document_id: string, block_id: string, body: BatchDeleteDocxDocumentBlockChildrenRequest, query?: BatchDeleteDocxDocumentBlockChildrenQuery): Promise + } +} + +export interface GetDocxChatAnnouncementQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListDocxChatAnnouncementBlockQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的群公告版本，-1 表示群公告最新版本。群公告创建后，版本为 1。若查询的版本为群公告最新版本，则需要持有群公告的阅读权限；若查询的版本为群公告的历史版本，则需要持有群公告的编辑权限。 */ + revision_id?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateDocxChatAnnouncementBlockChildrenRequest { + /** 添加的孩子列表。 */ + children?: Block[] + /** 当前 block 在 children 中的插入位置，起始值为 0，最大值为原 children 长度 */ + index?: number +} + +export interface CreateDocxChatAnnouncementBlockChildrenQuery { + /** 要操作的群公告版本。-1 表示群公告最新版本。群公告创建后，版本为 1。你需确保你已拥有群公告的编辑权限 */ + revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchUpdateDocxChatAnnouncementBlockRequest { + /** 批量更新 Block */ + requests?: UpdateBlockRequest[] +} + +export interface BatchUpdateDocxChatAnnouncementBlockQuery { + /** 要操作的群公告版本。-1 表示群公告最新版本。群公告创建后，版本为 1。你需确保你已拥有群公告的编辑权限。 */ + revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetDocxChatAnnouncementBlockQuery { + /** 查询的群公告版本，-1 表示群公告最新版本。群公告创建后，版本为 1。若查询的版本为群公告最新版本，则需要持有群公告的阅读权限；若查询的版本为群公告的历史版本，则需要持有群公告的更新权限 */ + revision_id?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetDocxChatAnnouncementBlockChildrenQuery { + /** 查询的群公告版本，-1 表示群公告最新版本。群公告创建后，版本为 1。若查询的版本为群公告最新版本，则需要持有群公告的阅读权限；若查询的版本为群公告的历史版本，则需要持有群公告的更新权限。 */ + revision_id?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchDeleteDocxChatAnnouncementBlockChildrenRequest { + /** 删除的起始索引（操作区间左闭右开） */ + start_index: number + /** 删除的末尾索引（操作区间左闭右开） */ + end_index: number +} + +export interface BatchDeleteDocxChatAnnouncementBlockChildrenQuery { + /** 要操作的群公告版本。-1 表示群公告最新版本。群公告创建后，版本为 1。你需确保你已拥有群公告的编辑权限 */ + revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string +} + +export interface CreateDocxDocumentRequest { + /** 文件夹 token，获取方式见云文档接口快速入门；空表示根目录，tenant_access_token应用权限仅允许操作应用创建的目录 */ + folder_token?: string + /** 文档标题，只支持纯文本 */ + title?: string +} + +export interface RawContentDocxDocumentQuery { + /** 语言（用于 MentionUser 语言的选取） */ + lang?: 0 | 1 | 2 +} + +export interface ListDocxDocumentBlockQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 查询的文档版本，-1表示文档最新版本。若此时查询的版本为文档最新版本，则需要持有文档的阅读权限；若此时查询的版本为文档的历史版本，则需要持有文档的编辑权限。 */ + document_revision_id?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateDocxDocumentBlockChildrenRequest { + /** 添加的孩子列表。 */ + children?: Block[] + /** 当前 block 在 children 中的插入位置，起始值为 0，最大值为原 children 长度 */ + index?: number +} + +export interface CreateDocxDocumentBlockChildrenQuery { + /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ + document_revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateDocxDocumentBlockDescendantRequest { + /** 添加的孩子 BlockID 列表 */ + children_id: string[] + /** 当前 Block 在 Children 中的插入位置，起始值为 0，最大值为原 Children 长度 */ + index?: number + /** 添加的子孙列表，包括孩子 */ + descendants: Block[] +} + +export interface CreateDocxDocumentBlockDescendantQuery { + /** 操作的文档版本，-1 表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限 */ + document_revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作 */ + client_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchDocxDocumentBlockRequest { + /** 更新文本元素请求 */ + update_text_elements?: UpdateTextElementsRequest + /** 更新文本样式请求 */ + update_text_style?: UpdateTextStyleRequest + /** 更新表格属性请求 */ + update_table_property?: UpdateTablePropertyRequest + /** 表格插入新行请求 */ + insert_table_row?: InsertTableRowRequest + /** 表格插入新列请求 */ + insert_table_column?: InsertTableColumnRequest + /** 表格批量删除行请求 */ + delete_table_rows?: DeleteTableRowsRequest + /** 表格批量删除列请求 */ + delete_table_columns?: DeleteTableColumnsRequest + /** 表格合并单元格请求 */ + merge_table_cells?: MergeTableCellsRequest + /** 表格取消单元格合并状态请求 */ + unmerge_table_cells?: UnmergeTableCellsRequest + /** 分栏插入新的分栏列请求 */ + insert_grid_column?: InsertGridColumnRequest + /** 分栏删除列请求 */ + delete_grid_column?: DeleteGridColumnRequest + /** 更新分栏列宽比例请求 */ + update_grid_column_width_ratio?: UpdateGridColumnWidthRatioRequest + /** 替换图片请求 */ + replace_image?: ReplaceImageRequest + /** 替换附件请求 */ + replace_file?: ReplaceFileRequest + /** 更新文本元素及样式请求 */ + update_text?: UpdateTextRequest + /** 更新任务 Block 请求 */ + update_task?: UpdateTaskRequest +} + +export interface PatchDocxDocumentBlockQuery { + /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ + document_revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetDocxDocumentBlockQuery { + /** 查询的文档版本，-1表示文档最新版本。若此时查询的版本为文档最新版本，则需要持有文档的阅读权限；若此时查询的版本为文档的历史版本，则需要持有文档的编辑权限。 */ + document_revision_id?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchUpdateDocxDocumentBlockRequest { + /** 批量更新 Block */ + requests: UpdateBlockRequest[] +} + +export interface BatchUpdateDocxDocumentBlockQuery { + /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ + document_revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + client_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetDocxDocumentBlockChildrenQuery { + /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ + document_revision_id?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchDeleteDocxDocumentBlockChildrenRequest { + /** 删除的起始索引（操作区间左闭右开） */ + start_index: number + /** 删除的末尾索引（操作区间左闭右开） */ + end_index: number +} + +export interface BatchDeleteDocxDocumentBlockChildrenQuery { + /** 操作的文档版本，-1表示文档最新版本。若此时操作的版本为文档最新版本，则需要持有文档的阅读权限；若此时操作的版本为文档的历史版本，则需要持有文档的编辑权限。 */ + document_revision_id?: number + /** 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。 */ + 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 ListDocxChatAnnouncementBlockResponse { + /** 群公告的 Block 信息 */ + items?: Block[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +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 GetDocxChatAnnouncementBlockChildrenResponse { + /** Block 的 Children 列表 */ + items?: Block[] + /** 下一个分页的分页标记 */ + page_token?: string + /** 是否还有下一个分页 */ + has_more?: boolean +} + +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 ListDocxDocumentBlockResponse { + /** 文档的 Block 信息 */ + items?: Block[] + /** 下一个分页的分页标记 */ + page_token?: string + /** 是否还有下一个分页 */ + has_more?: boolean +} + +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 GetDocxDocumentBlockChildrenResponse { + /** block 的 children 列表 */ + items?: Block[] + /** 下一个分页的分页标记 */ + page_token?: string + /** 是否还有下一个分页 */ + has_more?: boolean +} + +export interface BatchDeleteDocxDocumentBlockChildrenResponse { + /** 当前删除操作成功后文档的版本号 */ + document_revision_id?: number + /** 操作的唯一标识，更新请求中使用此值表示幂等的进行此次更新 */ + client_token: string +} + +Internal.define({ + '/open-apis/docx/v1/chats/{chat_id}/announcement': { + GET: 'getDocxChatAnnouncement', + }, + '/open-apis/docx/v1/chats/{chat_id}/announcement/blocks': { + GET: 'listDocxChatAnnouncementBlock', + }, + '/open-apis/docx/v1/chats/{chat_id}/announcement/blocks/{block_id}/children': { + POST: 'createDocxChatAnnouncementBlockChildren', + GET: 'getDocxChatAnnouncementBlockChildren', + }, + '/open-apis/docx/v1/chats/{chat_id}/announcement/blocks/batch_update': { + PATCH: 'batchUpdateDocxChatAnnouncementBlock', + }, + '/open-apis/docx/v1/chats/{chat_id}/announcement/blocks/{block_id}': { + GET: 'getDocxChatAnnouncementBlock', + }, + '/open-apis/docx/v1/chats/{chat_id}/announcement/blocks/{block_id}/children/batch_delete': { + DELETE: 'batchDeleteDocxChatAnnouncementBlockChildren', + }, + '/open-apis/docx/v1/documents': { + POST: 'createDocxDocument', + }, + '/open-apis/docx/v1/documents/{document_id}': { + GET: 'getDocxDocument', + }, + '/open-apis/docx/v1/documents/{document_id}/raw_content': { + GET: 'rawContentDocxDocument', + }, + '/open-apis/docx/v1/documents/{document_id}/blocks': { + GET: 'listDocxDocumentBlock', + }, + '/open-apis/docx/v1/documents/{document_id}/blocks/{block_id}/children': { + POST: 'createDocxDocumentBlockChildren', + GET: 'getDocxDocumentBlockChildren', + }, + '/open-apis/docx/v1/documents/{document_id}/blocks/{block_id}/descendant': { + POST: 'createDocxDocumentBlockDescendant', + }, + '/open-apis/docx/v1/documents/{document_id}/blocks/{block_id}': { + PATCH: 'patchDocxDocumentBlock', + GET: 'getDocxDocumentBlock', + }, + '/open-apis/docx/v1/documents/{document_id}/blocks/batch_update': { + PATCH: 'batchUpdateDocxDocumentBlock', + }, + '/open-apis/docx/v1/documents/{document_id}/blocks/{block_id}/children/batch_delete': { + DELETE: 'batchDeleteDocxDocumentBlockChildren', + }, +}) diff --git a/adapters/lark/src/types/drive.ts b/adapters/lark/src/types/drive.ts new file mode 100644 index 00000000..a018fbe5 --- /dev/null +++ b/adapters/lark/src/types/drive.ts @@ -0,0 +1,1386 @@ +import { Internal } from '../internal' +import { BaseMember, ExportTask, File, FileComment, FileCommentReply, FileLike, FileStatistics, FileViewRecord, ImportTask, ImportTaskMountPoint, Member, Meta, MetaFailed, PermissionPublic, Property, ReferEntity, ReplyContent, ReplyList, RequestDoc, TmpDownloadUrl, Version } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取文件夹中的文件清单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list + */ + listDriveV1File(query?: ListDriveV1FileQuery): Promise + /** + * 新建文件夹 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder + */ + createFolderDriveV1File(body: CreateFolderDriveV1FileRequest): Promise + /** + * 查询异步任务状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check + */ + taskCheckDriveV1File(query?: TaskCheckDriveV1FileQuery): Promise + /** + * 获取文件元数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/meta/batch_query + */ + batchQueryDriveV1Meta(body: BatchQueryDriveV1MetaRequest, query?: BatchQueryDriveV1MetaQuery): Promise + /** + * 获取文件统计信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-statistics/get + */ + getDriveV1FileStatistics(file_token: string, query?: GetDriveV1FileStatisticsQuery): Promise + /** + * 获取文件访问记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list + */ + listDriveV1FileViewRecord(file_token: string, query?: ListDriveV1FileViewRecordQuery): Promise + /** + * 复制文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy + */ + copyDriveV1File(file_token: string, body: CopyDriveV1FileRequest, query?: CopyDriveV1FileQuery): Promise + /** + * 移动文件或文件夹 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/move + */ + moveDriveV1File(file_token: string, body: MoveDriveV1FileRequest): Promise + /** + * 删除文件或文件夹 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete + */ + deleteDriveV1File(file_token: string, query?: DeleteDriveV1FileQuery): Promise + /** + * 创建文件快捷方式 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_shortcut + */ + createShortcutDriveV1File(body: CreateShortcutDriveV1FileRequest, query?: CreateShortcutDriveV1FileQuery): Promise + /** + * 上传文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_all + */ + uploadAllDriveV1File(form: UploadAllDriveV1FileForm): Promise + /** + * 分片上传文件-预上传 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare + */ + uploadPrepareDriveV1File(body: UploadPrepareDriveV1FileRequest): Promise + /** + * 分片上传文件-上传分片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part + */ + uploadPartDriveV1File(form: UploadPartDriveV1FileForm): Promise + /** + * 分片上传文件-完成上传 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_finish + */ + uploadFinishDriveV1File(body: UploadFinishDriveV1FileRequest): Promise + /** + * 下载文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/download + */ + downloadDriveV1File(file_token: string): Promise + /** + * 创建导入任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/create + */ + createDriveV1ImportTask(body: CreateDriveV1ImportTaskRequest): Promise + /** + * 查询导入任务结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/get + */ + getDriveV1ImportTask(ticket: string): Promise + /** + * 创建导出任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/create + */ + createDriveV1ExportTask(body: CreateDriveV1ExportTaskRequest): Promise + /** + * 查询导出任务结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/get + */ + getDriveV1ExportTask(ticket: string, query?: GetDriveV1ExportTaskQuery): Promise + /** + * 下载导出文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/download + */ + downloadDriveV1ExportTask(file_token: string): Promise + /** + * 上传素材 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_all + */ + uploadAllDriveV1Media(form: UploadAllDriveV1MediaForm): Promise + /** + * 分片上传素材-预上传 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_prepare + */ + uploadPrepareDriveV1Media(body: UploadPrepareDriveV1MediaRequest): Promise + /** + * 分片上传素材-上传分片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_part + */ + uploadPartDriveV1Media(form: UploadPartDriveV1MediaForm): Promise + /** + * 分片上传素材-完成上传 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_finish + */ + uploadFinishDriveV1Media(body: UploadFinishDriveV1MediaRequest): Promise + /** + * 下载素材 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/download + */ + downloadDriveV1Media(file_token: string, query?: DownloadDriveV1MediaQuery): Promise + /** + * 获取素材临时下载链接 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/batch_get_tmp_download_url + */ + batchGetTmpDownloadUrlDriveV1Media(query?: BatchGetTmpDownloadUrlDriveV1MediaQuery): Promise + /** + * 创建文档版本 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/create + */ + createDriveV1FileVersion(file_token: string, body: CreateDriveV1FileVersionRequest, query?: CreateDriveV1FileVersionQuery): Promise + /** + * 获取文档版本列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list + */ + listDriveV1FileVersion(file_token: string, query?: ListDriveV1FileVersionQuery): Promise + /** + * 获取文档版本信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get + */ + getDriveV1FileVersion(file_token: string, version_id: string, query?: GetDriveV1FileVersionQuery): Promise + /** + * 删除文档版本 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/delete + */ + deleteDriveV1FileVersion(file_token: string, version_id: string, query?: DeleteDriveV1FileVersionQuery): Promise + /** + * 获取云文档的点赞者列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/file-like/list + */ + listDriveV2FileLike(file_token: string, query?: ListDriveV2FileLikeQuery): Promise + /** + * 订阅云文档事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe + */ + subscribeDriveV1File(file_token: string, query?: SubscribeDriveV1FileQuery): Promise + /** + * 查询云文档事件订阅状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/get_subscribe + */ + getSubscribeDriveV1File(file_token: string, query?: GetSubscribeDriveV1FileQuery): Promise + /** + * 取消云文档事件订阅 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete_subscribe + */ + deleteSubscribeDriveV1File(file_token: string, query?: DeleteSubscribeDriveV1FileQuery): Promise + /** + * 批量增加协作者权限 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/batch_create + */ + batchCreateDriveV1PermissionMember(token: string, body: BatchCreateDriveV1PermissionMemberRequest, query?: BatchCreateDriveV1PermissionMemberQuery): Promise + /** + * 转移所有者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner + */ + transferOwnerDriveV1PermissionMember(token: string, body: TransferOwnerDriveV1PermissionMemberRequest, query?: TransferOwnerDriveV1PermissionMemberQuery): Promise + /** + * 判断当前用户是否有某权限 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth + */ + authDriveV1PermissionMember(token: string, query?: AuthDriveV1PermissionMemberQuery): Promise + /** + * 获取协作者列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list + */ + listDriveV1PermissionMember(token: string, query?: ListDriveV1PermissionMemberQuery): Promise + /** + * 增加协作者权限 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create + */ + createDriveV1PermissionMember(token: string, body: CreateDriveV1PermissionMemberRequest, query?: CreateDriveV1PermissionMemberQuery): Promise + /** + * 更新协作者权限 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update + */ + updateDriveV1PermissionMember(token: string, member_id: string, body: UpdateDriveV1PermissionMemberRequest, query?: UpdateDriveV1PermissionMemberQuery): Promise + /** + * 移除协作者权限 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete + */ + deleteDriveV1PermissionMember(token: string, member_id: string, body: DeleteDriveV1PermissionMemberRequest, query?: DeleteDriveV1PermissionMemberQuery): Promise + /** + * 开启密码 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create + */ + createDriveV1PermissionPublicPassword(token: string, query?: CreateDriveV1PermissionPublicPasswordQuery): Promise + /** + * 刷新密码 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update + */ + updateDriveV1PermissionPublicPassword(token: string, query?: UpdateDriveV1PermissionPublicPasswordQuery): Promise + /** + * 关闭密码 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete + */ + deleteDriveV1PermissionPublicPassword(token: string, query?: DeleteDriveV1PermissionPublicPasswordQuery): Promise + /** + * 获取云文档权限设置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/get + */ + getDriveV1PermissionPublic(token: string, query?: GetDriveV1PermissionPublicQuery): Promise + /** + * 更新云文档权限设置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/patch + */ + patchDriveV1PermissionPublic(token: string, body: PatchDriveV1PermissionPublicRequest, query?: PatchDriveV1PermissionPublicQuery): Promise + /** + * 获取云文档权限设置 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get + */ + getDriveV2PermissionPublic(token: string, query?: GetDriveV2PermissionPublicQuery): Promise + /** + * 更新云文档权限设置 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch + */ + patchDriveV2PermissionPublic(token: string, body: PatchDriveV2PermissionPublicRequest, query?: PatchDriveV2PermissionPublicQuery): Promise + /** + * 获取云文档所有评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list + */ + listDriveV1FileComment(file_token: string, query?: ListDriveV1FileCommentQuery): Promise + /** + * 批量获取评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/batch_query + */ + batchQueryDriveV1FileComment(file_token: string, body: BatchQueryDriveV1FileCommentRequest, query?: BatchQueryDriveV1FileCommentQuery): Promise + /** + * 解决/恢复评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/patch + */ + patchDriveV1FileComment(file_token: string, comment_id: string, body: PatchDriveV1FileCommentRequest, query?: PatchDriveV1FileCommentQuery): Promise + /** + * 添加全文评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/create + */ + createDriveV1FileComment(file_token: string, body: CreateDriveV1FileCommentRequest, query?: CreateDriveV1FileCommentQuery): Promise + /** + * 获取全文评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/get + */ + getDriveV1FileComment(file_token: string, comment_id: string, query?: GetDriveV1FileCommentQuery): Promise + /** + * 获取回复信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/list + */ + listDriveV1FileCommentReply(file_token: string, comment_id: string, query?: ListDriveV1FileCommentReplyQuery): Promise + /** + * 更新回复的内容 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/update + */ + updateDriveV1FileCommentReply(file_token: string, comment_id: string, reply_id: string, body: UpdateDriveV1FileCommentReplyRequest, query?: UpdateDriveV1FileCommentReplyQuery): Promise + /** + * 删除回复 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/delete + */ + deleteDriveV1FileCommentReply(file_token: string, comment_id: string, reply_id: string, query?: DeleteDriveV1FileCommentReplyQuery): Promise + /** + * 获取订阅状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/get + */ + getDriveV1FileSubscription(file_token: string, subscription_id: string, body: GetDriveV1FileSubscriptionRequest): Promise + /** + * 创建订阅 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/create + */ + createDriveV1FileSubscription(file_token: string, body: CreateDriveV1FileSubscriptionRequest): Promise + /** + * 更新订阅状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/patch + */ + patchDriveV1FileSubscription(file_token: string, subscription_id: string, body: PatchDriveV1FileSubscriptionRequest): Promise + } +} + +export interface ListDriveV1FileQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 文件夹的token（若不填写该参数或填写空字符串，则默认获取用户云空间下的清单，且不支持分页） */ + folder_token?: string + /** 排序规则 */ + order_by?: 'EditedTime' | 'CreatedTime' + /** 升序降序 */ + direction?: 'ASC' | 'DESC' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateFolderDriveV1FileRequest { + /** 文件夹名称 */ + name: string + /** 父文件夹token */ + folder_token: string +} + +export interface TaskCheckDriveV1FileQuery { + /** 文件相关异步任务id */ + task_id: string +} + +export interface BatchQueryDriveV1MetaRequest { + /** 请求文档, 一次不超过200个 */ + request_docs: RequestDoc[] + /** 是否获取文档链接 */ + with_url?: boolean +} + +export interface BatchQueryDriveV1MetaQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetDriveV1FileStatisticsQuery { + /** 文档类型 */ + file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx' +} + +export interface ListDriveV1FileViewRecordQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 文档类型 */ + file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file' + /** 此次调用中使用的访问者 ID 的类型 */ + viewer_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CopyDriveV1FileRequest { + /** 被复制文件的新名称 */ + name: string + /** 被复制文件的类型，如果该值为空或者与文件实际类型不匹配，接口会返回失败。 */ + type?: 'file' | 'doc' | 'sheet' | 'bitable' | 'docx' | 'mindnote' | 'slides' + /** 文件被复制到的目标文件夹token */ + folder_token: string + /** 用户自定义请求附加参数，用于实现特殊的复制语义 */ + extra?: Property[] +} + +export interface CopyDriveV1FileQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface MoveDriveV1FileRequest { + /** 文件类型，如果该值为空或者与文件实际类型不匹配，接口会返回失败。 */ + type?: 'file' | 'docx' | 'bitable' | 'doc' | 'sheet' | 'mindnote' | 'folder' | 'slides' + /** 目标文件夹token */ + folder_token?: string +} + +export interface DeleteDriveV1FileQuery { + /** 被删除文件的类型 */ + type: 'file' | 'docx' | 'bitable' | 'folder' | 'doc' | 'sheet' | 'mindnote' | 'shortcut' | 'slides' +} + +export interface CreateShortcutDriveV1FileRequest { + /** 创建快捷方式的目标父文件夹 token */ + parent_token: string + /** 快捷方式映射到的文档和文件列表信息 */ + refer_entity: ReferEntity +} + +export interface CreateShortcutDriveV1FileQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UploadAllDriveV1FileForm { + /** 文件名。 */ + file_name: string + /** 上传点类型。 */ + parent_type: 'explorer' + /** 文件夹token，获取方式见 [概述](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction) */ + parent_node: string + /** 文件大小（以字节为单位）。 */ + size: number + /** 文件adler32校验和(可选)。 */ + checksum?: string + /** 文件二进制内容。 */ + file: Blob +} + +export interface UploadPrepareDriveV1FileRequest { + /** 文件名 */ + file_name: string + /** 上传点类型 */ + parent_type: 'explorer' + /** 文件夹的token */ + parent_node: string + /** 文件大小 */ + size: number +} + +export interface UploadPartDriveV1FileForm { + /** 分片上传事务ID。 */ + upload_id: string + /** 块号，从0开始计数。 */ + seq: number + /** 块大小（以字节为单位）。 */ + size: number + /** 文件分块adler32校验和(可选)。 */ + checksum?: string + /** 文件分片二进制内容。 */ + file: Blob +} + +export interface UploadFinishDriveV1FileRequest { + /** 分片上传事务ID */ + upload_id: string + /** 分片数量 */ + block_num: number +} + +export interface CreateDriveV1ImportTaskRequest { + /** 导入文件格式后缀 */ + file_extension: string + /** 导入的文件 Token */ + file_token: string + /** 导入目标云文档类型，支持的类型 新版文档：docx；电子表格：sheet；多维表格：bitable */ + type: string + /** 目标云文档的标题，若为空，则使用导入文件的名字 */ + file_name?: string + /** 挂载点 */ + point: ImportTaskMountPoint +} + +export interface CreateDriveV1ExportTaskRequest { + /** 导出文件扩展名 */ + file_extension: 'docx' | 'pdf' | 'xlsx' | 'csv' + /** 导出文档 Token */ + token: string + /** 导出文档类型 */ + type: 'doc' | 'sheet' | 'bitable' | 'docx' + /** 导出子表 ID，仅当将 sheet/bitable 导出为 csv 时使用 */ + sub_id?: string +} + +export interface GetDriveV1ExportTaskQuery { + /** 导出文档的 token */ + token: string +} + +export interface UploadAllDriveV1MediaForm { + /** 文件名。 */ + file_name: string + /** 上传点类型。 */ + parent_type: 'doc_image' | 'docx_image' | 'sheet_image' | 'doc_file' | 'docx_file' | 'sheet_file' | 'vc_virtual_background' | 'bitable_image' | 'bitable_file' | 'moments' | 'ccm_import_open' | 'calendar' | 'base_global' | 'lark_ai_media_analysis' + /** 上传点的token。 */ + parent_node: string + /** 文件大小（以字节为单位）。 */ + size: number + /** 文件adler32校验和（可选）。 */ + checksum?: string + /** 扩展信息(可选)。 */ + extra?: string + /** 文件二进制内容。 */ + file: Blob +} + +export interface UploadPrepareDriveV1MediaRequest { + /** 文件名 */ + file_name: string + /** 上传点类型 */ + parent_type: 'doc_image' | 'docx_image' | 'sheet_image' | 'doc_file' | 'docx_file' | 'sheet_file' | 'vc_virtual_background' | 'bitable_image' | 'bitable_file' | 'moments' | 'ccm_import_open' | 'calendar' | 'base_global' | 'lark_ai_media_analysis' + /** 文件大小 */ + size: number + /** 上传点的标识符 */ + parent_node?: string + /** 扩展信息(可选) */ + extra?: string +} + +export interface UploadPartDriveV1MediaForm { + /** 分片上传事务ID。 */ + upload_id: string + /** 块号，从0开始计数。 */ + seq: number + /** 块大小（以字节为单位）。 */ + size: number + /** 文件分块adler32校验和(可选)。 */ + checksum?: string + /** 文件分片二进制内容。 */ + file: Blob +} + +export interface UploadFinishDriveV1MediaRequest { + /** 分片上传事务ID */ + upload_id: string + /** 分片数量 */ + block_num: number +} + +export interface DownloadDriveV1MediaQuery { + /** 扩展信息 */ + extra?: string +} + +export interface BatchGetTmpDownloadUrlDriveV1MediaQuery { + /** 文件标识符列表 */ + file_tokens: string[] + /** 拓展信息(可选) */ + extra?: string +} + +export interface CreateDriveV1FileVersionRequest { + /** 版本文档标题，最大长度 1024 个Unicode 码点。通常情况下，一个英文或中文字符对应一个码点，但是某些特殊符号可能会对应多个码点。例如，家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */ + name?: string + /** 版本文档类型 */ + obj_type?: 'docx' | 'sheet' +} + +export interface CreateDriveV1FileVersionQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListDriveV1FileVersionQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 原文档类型 */ + obj_type: 'docx' | 'sheet' + /** 用户id类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface GetDriveV1FileVersionQuery { + /** 文档类型 */ + obj_type: 'docx' | 'sheet' + /** 用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface DeleteDriveV1FileVersionQuery { + /** 文档类型 */ + obj_type: 'docx' | 'sheet' + /** 用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface ListDriveV2FileLikeQuery { + /** 文件类型，如果该值为空或者与文件实际类型不匹配，接口会返回失败。 */ + file_type: 'doc' | 'docx' | 'file' + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SubscribeDriveV1FileQuery { + /** 文档类型 */ + file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'folder' + /** 事件类型 */ + event_type?: string +} + +export interface GetSubscribeDriveV1FileQuery { + /** 文档类型 */ + file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder' + /** 事件类型 */ + event_type?: string +} + +export interface DeleteSubscribeDriveV1FileQuery { + /** 文档类型 */ + file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder' + /** 事件类型 */ + event_type?: string +} + +export interface BatchCreateDriveV1PermissionMemberRequest { + /** 协作者列表 */ + members: BaseMember[] +} + +export interface BatchCreateDriveV1PermissionMemberQuery { + /** 文件的类型 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides' + /** 添加权限后是否通知对方 */ + need_notification?: boolean +} + +export interface TransferOwnerDriveV1PermissionMemberRequest { + /** 文档拥有者的ID类型 */ + member_type: 'email' | 'openid' | 'userid' + /** 文档拥有者的ID，与文档拥有者的ID类型需要对应 */ + member_id: string +} + +export interface TransferOwnerDriveV1PermissionMemberQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' | 'folder' + /** 是否需要通知新 Owner */ + need_notification?: boolean + /** 转移后是否需要移除原 Owner 的权限 */ + remove_old_owner?: boolean + /** 仅当内容不在共享文件夹中，此参数才会生效。如果设为false，系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true，则留在原位置。 */ + stay_put?: boolean + /** 仅当 remove_old_owner = false 时，此参数才会生效 保留原文件所有者指定的权限角色 */ + old_owner_perm?: string +} + +export interface AuthDriveV1PermissionMemberQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' + /** 需要判断的权限 */ + action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public' +} + +export interface ListDriveV1PermissionMemberQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' + /** 指定返回的协作者字段信息，如无指定则默认不返回**可选值有：** - `name`：协作者名- `type`：协作者类型- `avatar`：头像- `external_label`：外部标签**注意：** - 你可以使用特殊值`*`指定返回目前支持的所有字段- 你可以使用`,`分隔若干个你想指定返回的字段，如：`name,avatar`- 按需指定返回字段接口性能更好 */ + fields?: string + /** 协作者的权限角色类型 */ + perm_type?: 'container' | 'single_page' +} + +export interface CreateDriveV1PermissionMemberRequest { + /** 协作者ID类型 */ + member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid' + /** 协作者ID，与协作者ID类型需要对应 */ + member_id: string + /** 协作者的权限角色 */ + perm: 'view' | 'edit' | 'full_access' + /** 协作者的权限角色类型 */ + perm_type?: 'container' | 'single_page' + /** 协作者类型 */ + type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor' +} + +export interface CreateDriveV1PermissionMemberQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides' + /** 添加权限后是否通知对方 */ + need_notification?: boolean +} + +export interface UpdateDriveV1PermissionMemberRequest { + /** 协作者ID类型 */ + member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid' + /** 协作者的权限角色 */ + perm: 'view' | 'edit' | 'full_access' + /** 协作者的权限角色类型 */ + perm_type?: 'container' | 'single_page' + /** 协作者类型 */ + type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor' +} + +export interface UpdateDriveV1PermissionMemberQuery { + /** 更新权限后是否通知对方**注意：** 使用`tenant_access_token`访问不支持该参数 */ + need_notification?: boolean + /** 文件类型，放于query参数中，如：`?type=doc` */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface DeleteDriveV1PermissionMemberRequest { + /** 协作者类型 */ + type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor' + /** 协作者的权限角色类型 */ + perm_type?: 'container' | 'single_page' +} + +export interface DeleteDriveV1PermissionMemberQuery { + /** 文件类型，放于query参数中，如：`?type=doc` */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides' + /** 权限成员类型，放于query参数中，如：`?member_type=openid` */ + member_type: 'email' | 'openid' | 'openchat' | 'opendepartmentid' | 'userid' | 'unionid' | 'groupid' | 'wikispaceid' +} + +export interface CreateDriveV1PermissionPublicPasswordQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface UpdateDriveV1PermissionPublicPasswordQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface DeleteDriveV1PermissionPublicPasswordQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface GetDriveV1PermissionPublicQuery { + /** 文件类型，放于query参数中，如：`?type=doc` */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface PatchDriveV1PermissionPublicRequest { + /** 允许内容被分享到组织外 */ + external_access?: boolean + /** 谁可以复制内容、创建副本、打印、下载 */ + security_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access' + /** 谁可以评论 */ + comment_entity?: 'anyone_can_view' | 'anyone_can_edit' + /** 谁可以添加和管理协作者 */ + share_entity?: 'anyone' | 'same_tenant' | 'only_full_access' + /** 链接分享设置 */ + link_share_entity?: 'tenant_readable' | 'tenant_editable' | 'anyone_readable' | 'anyone_editable' | 'closed' + /** 允许非「可管理权限」的人分享到组织外 */ + invite_external?: boolean +} + +export interface PatchDriveV1PermissionPublicQuery { + /** 文件类型，放于query参数中，如：`?type=doc` */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface GetDriveV2PermissionPublicQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface PatchDriveV2PermissionPublicRequest { + /** 允许内容被分享到组织外 */ + external_access_entity?: 'open' | 'closed' | 'allow_share_partner_tenant' + /** 谁可以创建副本、打印、下载 */ + security_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access' + /** 谁可以评论 */ + comment_entity?: 'anyone_can_view' | 'anyone_can_edit' + /** 谁可以添加和管理协作者-组织维度 */ + share_entity?: 'anyone' | 'same_tenant' + /** 谁可以添加和管理协作者-协作者维度 */ + manage_collaborator_entity?: 'collaborator_can_view' | 'collaborator_can_edit' | 'collaborator_full_access' + /** 链接分享设置 */ + link_share_entity?: 'tenant_readable' | 'tenant_editable' | 'partner_tenant_readable' | 'partner_tenant_editable' | 'anyone_readable' | 'anyone_editable' | 'closed' + /** 谁可以复制内容 */ + copy_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access' +} + +export interface PatchDriveV2PermissionPublicQuery { + /** 文件类型，需要与文件的 token 相匹配 */ + type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' +} + +export interface ListDriveV1FileCommentQuery { + /** 文档类型 */ + file_type: 'doc' | 'sheet' | 'file' | 'docx' + /** 是否全文评论 */ + is_whole?: boolean + /** 是否已解决（可选） */ + is_solved?: boolean + /** 评论分页参数 */ + page_token?: string + /** 获取满足 commen_id > page_token 的评论数量 */ + page_size?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchQueryDriveV1FileCommentRequest { + /** 需要获取数据的评论id */ + comment_ids: string[] +} + +export interface BatchQueryDriveV1FileCommentQuery { + /** 文档类型 */ + file_type: 'doc' | 'sheet' | 'file' | 'docx' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchDriveV1FileCommentRequest { + /** 评论解决标志 */ + is_solved: boolean +} + +export interface PatchDriveV1FileCommentQuery { + /** 文档类型 */ + file_type: 'doc' | 'sheet' | 'file' | 'docx' +} + +export interface CreateDriveV1FileCommentRequest { + /** 评论里的回复列表 */ + reply_list?: ReplyList +} + +export interface CreateDriveV1FileCommentQuery { + /** 文档类型 */ + file_type: 'doc' | 'docx' + /** 此次调用中使用的用户 ID 的类型 */ + 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 ListDriveV1FileCommentReplyQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 文档类型 */ + 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 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 ListDriveV1FileResponse { + /** 文档详细信息 */ + files?: File[] + /** 下一页分页参数 */ + next_page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +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 ListDriveV1FileViewRecordResponse { + /** 访问记录列表 */ + items?: FileViewRecord[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +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 ListDriveV1FileVersionResponse { + /** 版本文档列表 */ + items?: Version[] + /** 下一页请求token */ + page_token?: string + /** 是否有下一页数据 */ + has_more?: boolean +} + +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 ListDriveV2FileLikeResponse { + /** 文件的点赞者列表 */ + items?: FileLike[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多点赞记录 */ + has_more?: boolean +} + +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 ListDriveV1FileCommentResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的 Token */ + page_token?: string + items?: FileComment[] +} + +export interface BatchQueryDriveV1FileCommentResponse { + /** 评论的相关信息、回复的信息、回复分页的信息 */ + items?: FileComment[] +} + +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 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 ListDriveV1FileCommentReplyResponse { + items?: FileCommentReply[] + page_token?: string + has_more: boolean +} + +export interface GetDriveV1FileSubscriptionResponse { + /** 订阅关系ID */ + subscription_id: string + /** 订阅类型 */ + subscription_type?: 'comment_update' + /** 是否订阅 */ + is_subcribe?: boolean + /** 文档类型 */ + file_type?: 'doc' | 'docx' | 'wiki' +} + +export interface CreateDriveV1FileSubscriptionResponse { + /** 订阅关系ID */ + subscription_id?: string + /** 订阅类型 */ + subscription_type?: 'comment_update' + /** 是否订阅 */ + is_subcribe?: boolean + /** 文档类型 */ + file_type?: 'doc' | 'docx' | 'wiki' +} + +export interface PatchDriveV1FileSubscriptionResponse { + /** 订阅关系ID */ + subscription_id?: string + /** 订阅类型 */ + subscription_type?: 'comment_update' + /** 是否订阅 */ + is_subcribe?: boolean + /** 文档类型 */ + file_type?: 'doc' | 'docx' | 'wiki' +} + +Internal.define({ + '/open-apis/drive/v1/files': { + GET: 'listDriveV1File', + }, + '/open-apis/drive/v1/files/create_folder': { + POST: 'createFolderDriveV1File', + }, + '/open-apis/drive/v1/files/task_check': { + GET: 'taskCheckDriveV1File', + }, + '/open-apis/drive/v1/metas/batch_query': { + POST: 'batchQueryDriveV1Meta', + }, + '/open-apis/drive/v1/files/{file_token}/statistics': { + GET: 'getDriveV1FileStatistics', + }, + '/open-apis/drive/v1/files/{file_token}/view_records': { + GET: 'listDriveV1FileViewRecord', + }, + '/open-apis/drive/v1/files/{file_token}/copy': { + POST: 'copyDriveV1File', + }, + '/open-apis/drive/v1/files/{file_token}/move': { + POST: 'moveDriveV1File', + }, + '/open-apis/drive/v1/files/{file_token}': { + DELETE: 'deleteDriveV1File', + }, + '/open-apis/drive/v1/files/create_shortcut': { + POST: 'createShortcutDriveV1File', + }, + '/open-apis/drive/v1/files/upload_all': { + POST: { name: 'uploadAllDriveV1File', multipart: true }, + }, + '/open-apis/drive/v1/files/upload_prepare': { + POST: 'uploadPrepareDriveV1File', + }, + '/open-apis/drive/v1/files/upload_part': { + POST: { name: 'uploadPartDriveV1File', multipart: true }, + }, + '/open-apis/drive/v1/files/upload_finish': { + POST: 'uploadFinishDriveV1File', + }, + '/open-apis/drive/v1/files/{file_token}/download': { + GET: { name: 'downloadDriveV1File', type: 'binary' }, + }, + '/open-apis/drive/v1/import_tasks': { + POST: 'createDriveV1ImportTask', + }, + '/open-apis/drive/v1/import_tasks/{ticket}': { + GET: 'getDriveV1ImportTask', + }, + '/open-apis/drive/v1/export_tasks': { + POST: 'createDriveV1ExportTask', + }, + '/open-apis/drive/v1/export_tasks/{ticket}': { + GET: 'getDriveV1ExportTask', + }, + '/open-apis/drive/v1/export_tasks/file/{file_token}/download': { + GET: { name: 'downloadDriveV1ExportTask', type: 'binary' }, + }, + '/open-apis/drive/v1/medias/upload_all': { + POST: { name: 'uploadAllDriveV1Media', multipart: true }, + }, + '/open-apis/drive/v1/medias/upload_prepare': { + POST: 'uploadPrepareDriveV1Media', + }, + '/open-apis/drive/v1/medias/upload_part': { + POST: { name: 'uploadPartDriveV1Media', multipart: true }, + }, + '/open-apis/drive/v1/medias/upload_finish': { + POST: 'uploadFinishDriveV1Media', + }, + '/open-apis/drive/v1/medias/{file_token}/download': { + GET: { name: 'downloadDriveV1Media', type: 'binary' }, + }, + '/open-apis/drive/v1/medias/batch_get_tmp_download_url': { + GET: 'batchGetTmpDownloadUrlDriveV1Media', + }, + '/open-apis/drive/v1/files/{file_token}/versions': { + POST: 'createDriveV1FileVersion', + GET: 'listDriveV1FileVersion', + }, + '/open-apis/drive/v1/files/{file_token}/versions/{version_id}': { + GET: 'getDriveV1FileVersion', + DELETE: 'deleteDriveV1FileVersion', + }, + '/open-apis/drive/v2/files/{file_token}/likes': { + GET: 'listDriveV2FileLike', + }, + '/open-apis/drive/v1/files/{file_token}/subscribe': { + POST: 'subscribeDriveV1File', + }, + '/open-apis/drive/v1/files/{file_token}/get_subscribe': { + GET: 'getSubscribeDriveV1File', + }, + '/open-apis/drive/v1/files/{file_token}/delete_subscribe': { + DELETE: 'deleteSubscribeDriveV1File', + }, + '/open-apis/drive/v1/permissions/{token}/members/batch_create': { + POST: 'batchCreateDriveV1PermissionMember', + }, + '/open-apis/drive/v1/permissions/{token}/members/transfer_owner': { + POST: 'transferOwnerDriveV1PermissionMember', + }, + '/open-apis/drive/v1/permissions/{token}/members/auth': { + GET: 'authDriveV1PermissionMember', + }, + '/open-apis/drive/v1/permissions/{token}/members': { + GET: 'listDriveV1PermissionMember', + POST: 'createDriveV1PermissionMember', + }, + '/open-apis/drive/v1/permissions/{token}/members/{member_id}': { + PUT: 'updateDriveV1PermissionMember', + DELETE: 'deleteDriveV1PermissionMember', + }, + '/open-apis/drive/v1/permissions/{token}/public/password': { + POST: 'createDriveV1PermissionPublicPassword', + PUT: 'updateDriveV1PermissionPublicPassword', + DELETE: 'deleteDriveV1PermissionPublicPassword', + }, + '/open-apis/drive/v1/permissions/{token}/public': { + GET: 'getDriveV1PermissionPublic', + PATCH: 'patchDriveV1PermissionPublic', + }, + '/open-apis/drive/v2/permissions/{token}/public': { + GET: 'getDriveV2PermissionPublic', + PATCH: 'patchDriveV2PermissionPublic', + }, + '/open-apis/drive/v1/files/{file_token}/comments': { + GET: 'listDriveV1FileComment', + POST: 'createDriveV1FileComment', + }, + '/open-apis/drive/v1/files/{file_token}/comments/batch_query': { + POST: 'batchQueryDriveV1FileComment', + }, + '/open-apis/drive/v1/files/{file_token}/comments/{comment_id}': { + PATCH: 'patchDriveV1FileComment', + GET: 'getDriveV1FileComment', + }, + '/open-apis/drive/v1/files/{file_token}/comments/{comment_id}/replies': { + GET: 'listDriveV1FileCommentReply', + }, + '/open-apis/drive/v1/files/{file_token}/comments/{comment_id}/replies/{reply_id}': { + PUT: 'updateDriveV1FileCommentReply', + DELETE: 'deleteDriveV1FileCommentReply', + }, + '/open-apis/drive/v1/files/{file_token}/subscriptions/{subscription_id}': { + GET: 'getDriveV1FileSubscription', + PATCH: 'patchDriveV1FileSubscription', + }, + '/open-apis/drive/v1/files/{file_token}/subscriptions': { + POST: 'createDriveV1FileSubscription', + }, +}) diff --git a/adapters/lark/src/types/ehr.ts b/adapters/lark/src/types/ehr.ts new file mode 100644 index 00000000..e410d434 --- /dev/null +++ b/adapters/lark/src/types/ehr.ts @@ -0,0 +1,55 @@ +import { Internal } from '../internal' +import { Employee } from '.' + +declare module '../internal' { + interface Internal { + /** + * 批量获取员工花名册信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list + */ + listEhrEmployee(query?: ListEhrEmployeeQuery): Promise + /** + * 下载人员的附件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/attachment/get + */ + getEhrAttachment(token: string): Promise + } +} + +export interface ListEhrEmployeeQuery { + /** 返回数据类型 */ + view?: 'basic' | 'full' + /** 员工状态，不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录，如 status=2&status=4 */ + status?: 1 | 2 | 3 | 4 | 5[] + /** 雇员类型，不传代表查询所有雇员类型 */ + type?: 1 | 2 | 3 | 4 | 5[] + /** 查询开始时间（创建时间 >= 此时间） */ + start_time?: string + /** 查询结束时间（创建时间 <= 此时间） */ + end_time?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** user_id、open_id 或 union_id，默认为 open_id。如果传入的值不是 open_id，需要一并传入 user_id_type 参数。可一次查询多个 id 的用户，例如：user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ + user_ids?: string[] + /** 分页标记，第一次请求可以不填，表示从头开始遍历；分页查询返回结果has_more 为 true 时会同时返回新的 page_token, 下次遍历可使用该返回的 page_token 获取更多信息。 */ + page_token?: string + /** 分页大小，取值范围 1~100，默认 10 */ + page_size?: number +} + +export interface ListEhrEmployeeResponse { + items?: Employee[] + /** 下次请求需要带上的分页标记 */ + page_token?: string + /** 是否有下一页数据 */ + has_more?: boolean +} + +Internal.define({ + '/open-apis/ehr/v1/employees': { + GET: 'listEhrEmployee', + }, + '/open-apis/ehr/v1/attachments/{token}': { + GET: { name: 'getEhrAttachment', type: 'binary' }, + }, +}) diff --git a/adapters/lark/src/types/event.ts b/adapters/lark/src/types/event.ts index 401d903e..da44c9c8 100644 --- a/adapters/lark/src/types/event.ts +++ b/adapters/lark/src/types/event.ts @@ -1,22 +1,33 @@ -export interface EventHeader { - event_id: string - event_type: K - create_time: string - token: string - app_id: string - tenant_key: string +import { Internal } from '../internal' + +declare module '../internal' { + interface Internal { + /** + * 获取事件出口 IP + * @see https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list + */ + listEventOutboundIp(query?: ListEventOutboundIpQuery): Promise + } +} + +export interface ListEventOutboundIpQuery { + /** 分页大小，默认10，取值范围 10-50 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string } -export interface Events {} +export interface ListEventOutboundIpResponse { + /** outbound ip */ + ip_list?: string[] + /** 分页下次调用的page_token值 */ + page_token?: string + /** 是否还有分页数据 */ + has_more?: boolean +} -// In fact, this is the 2.0 version of the event sent by Lark. -// And only the 2.0 version has the `schema` field. -export type EventPayload = { - [K in keyof Events]: { - schema: '2.0' - // special added field for TypeScript - type: K - header: EventHeader - event: Events[K] - } -}[keyof Events] +Internal.define({ + '/open-apis/event/v1/outbound_ip': { + GET: 'listEventOutboundIp', + }, +}) diff --git a/adapters/lark/src/types/helpdesk.ts b/adapters/lark/src/types/helpdesk.ts new file mode 100644 index 00000000..35e06099 --- /dev/null +++ b/adapters/lark/src/types/helpdesk.ts @@ -0,0 +1,948 @@ +import { Internal } from '../internal' +import { AgentSchedule, AgentScheduleUpdateInfo, AgentSkill, AgentSkillRule, Category, CustomizedFieldDisplayItem, Event, Faq, FaqCreateInfo, FaqUpdateInfo, Notification, NotificationChat, NotificationDepartment, NotificationUser, Ticket, TicketCustomizedField, TicketMessage, TicketUser, UserCustomizedField, UserQueryFaqInfo } from '.' + +declare module '../internal' { + interface Internal { + /** + * 更新客服信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent/patch + */ + patchHelpdeskAgent(agent_id: string, body: PatchHelpdeskAgentRequest): Promise + /** + * 获取客服邮箱 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent/agent_email + */ + agentEmailHelpdeskAgent(): Promise + /** + * 创建客服工作日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/create + */ + createHelpdeskAgentSchedule(body: CreateHelpdeskAgentScheduleRequest): Promise + /** + * 删除客服工作日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/delete + */ + deleteHelpdeskAgentSchedules(agent_id: string): Promise + /** + * 更新客服工作日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/patch + */ + patchHelpdeskAgentSchedules(agent_id: string, body: PatchHelpdeskAgentSchedulesRequest): Promise + /** + * 查询指定客服工作日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/get + */ + getHelpdeskAgentSchedules(agent_id: string): Promise + /** + * 查询全部客服工作日程 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/list + */ + listHelpdeskAgentSchedule(query?: ListHelpdeskAgentScheduleQuery): Promise + /** + * 创建客服技能 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/create + */ + createHelpdeskAgentSkill(body: CreateHelpdeskAgentSkillRequest): Promise + /** + * 删除客服技能 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/delete + */ + deleteHelpdeskAgentSkill(agent_skill_id: string): Promise + /** + * 更新客服技能 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/patch + */ + patchHelpdeskAgentSkill(agent_skill_id: string, body: PatchHelpdeskAgentSkillRequest): Promise + /** + * 查询指定客服技能 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/get + */ + getHelpdeskAgentSkill(agent_skill_id: string): Promise + /** + * 查询全部客服技能 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/list + */ + listHelpdeskAgentSkill(): Promise + /** + * 获取客服技能列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill_rule/list + */ + listHelpdeskAgentSkillRule(): Promise + /** + * 创建服务台对话 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/start_service + */ + startServiceHelpdeskTicket(body: StartServiceHelpdeskTicketRequest): Promise + /** + * 查询指定工单详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get + */ + getHelpdeskTicket(ticket_id: string): Promise + /** + * 更新工单详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/update + */ + updateHelpdeskTicket(ticket_id: string, body: UpdateHelpdeskTicketRequest): Promise + /** + * 查询全部工单详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/list + */ + listHelpdeskTicket(query?: ListHelpdeskTicketQuery): Promise + /** + * 获取工单内图像 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/ticket_image + */ + ticketImageHelpdeskTicket(query?: TicketImageHelpdeskTicketQuery): Promise + /** + * 回复用户在工单里的提问 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/answer_user_query + */ + answerUserQueryHelpdeskTicket(ticket_id: string, body: AnswerUserQueryHelpdeskTicketRequest): Promise + /** + * 获取服务台自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/customized_fields + */ + customizedFieldsHelpdeskTicket(query?: CustomizedFieldsHelpdeskTicketQuery): Promise + /** + * 发送工单消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/create + */ + createHelpdeskTicketMessage(ticket_id: string, body: CreateHelpdeskTicketMessageRequest): Promise + /** + * 获取工单消息详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list + */ + listHelpdeskTicketMessage(ticket_id: string, query?: ListHelpdeskTicketMessageQuery): Promise + /** + * 服务台机器人向工单绑定的群内发送消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/bot-message/create + */ + createHelpdeskBotMessage(body: CreateHelpdeskBotMessageRequest, query?: CreateHelpdeskBotMessageQuery): Promise + /** + * 创建工单自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/create-ticket-customized-field + */ + createHelpdeskTicketCustomizedField(body: CreateHelpdeskTicketCustomizedFieldRequest): Promise + /** + * 删除工单自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/delete + */ + deleteHelpdeskTicketCustomizedField(ticket_customized_field_id: string): Promise + /** + * 更新工单自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/update-ticket-customized-field + */ + patchHelpdeskTicketCustomizedField(ticket_customized_field_id: string, body: PatchHelpdeskTicketCustomizedFieldRequest): Promise + /** + * 获取指定工单自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/get-ticket-customized-field + */ + getHelpdeskTicketCustomizedField(ticket_customized_field_id: string): Promise + /** + * 获取全部工单自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields + */ + listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: ListHelpdeskTicketCustomizedFieldQuery): Promise + /** + * 创建知识库 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/create + */ + createHelpdeskFaq(body: CreateHelpdeskFaqRequest): Promise + /** + * 删除知识库 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/delete + */ + deleteHelpdeskFaq(id: string): Promise + /** + * 修改知识库 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/patch + */ + patchHelpdeskFaq(id: string, body: PatchHelpdeskFaqRequest): Promise + /** + * 获取指定知识库详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/get + */ + getHelpdeskFaq(id: string): Promise + /** + * 获取全部知识库详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/list + */ + listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise + /** + * 获取知识库图像 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/faq_image + */ + faqImageHelpdeskFaq(id: string, image_key: string): Promise + /** + * 搜索知识库 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/search + */ + searchHelpdeskFaq(query?: SearchHelpdeskFaqQuery): Promise + /** + * 创建知识库分类 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/create + */ + createHelpdeskCategory(body: CreateHelpdeskCategoryRequest): Promise + /** + * 获取知识库分类 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/get + */ + getHelpdeskCategory(id: string): Promise + /** + * 更新知识库分类详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/patch + */ + patchHelpdeskCategory(id: string, body: PatchHelpdeskCategoryRequest): Promise + /** + * 删除知识库分类详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/delete + */ + deleteHelpdeskCategory(id: string): Promise + /** + * 获取全部知识库分类 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/list-categories + */ + listHelpdeskCategory(query?: ListHelpdeskCategoryQuery): Promise + /** + * 创建推送 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/create + */ + createHelpdeskNotification(body: CreateHelpdeskNotificationRequest, query?: CreateHelpdeskNotificationQuery): Promise + /** + * 更新推送 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/patch + */ + patchHelpdeskNotification(notification_id: string, body: PatchHelpdeskNotificationRequest, query?: PatchHelpdeskNotificationQuery): Promise + /** + * 查询推送 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/get + */ + getHelpdeskNotification(notification_id: string, query?: GetHelpdeskNotificationQuery): Promise + /** + * 预览推送 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/preview + */ + previewHelpdeskNotification(notification_id: string): Promise + /** + * 提交审核 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/submit_approve + */ + submitApproveHelpdeskNotification(notification_id: string, body: SubmitApproveHelpdeskNotificationRequest): Promise + /** + * 取消审核 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_approve + */ + cancelApproveHelpdeskNotification(notification_id: string): Promise + /** + * 执行推送 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/execute_send + */ + executeSendHelpdeskNotification(notification_id: string, body: ExecuteSendHelpdeskNotificationRequest): Promise + /** + * 取消推送 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_send + */ + cancelSendHelpdeskNotification(notification_id: string, body: CancelSendHelpdeskNotificationRequest): Promise + /** + * 订阅服务台事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/subscribe + */ + subscribeHelpdeskEvent(body: SubscribeHelpdeskEventRequest): Promise + /** + * 取消订阅服务台事件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/unsubscribe + */ + unsubscribeHelpdeskEvent(body: UnsubscribeHelpdeskEventRequest): Promise + } +} + +export interface PatchHelpdeskAgentRequest { + /** agent status */ + status?: number +} + +export interface CreateHelpdeskAgentScheduleRequest { + /** 新客服日程 */ + agent_schedules?: AgentScheduleUpdateInfo[] +} + +export interface PatchHelpdeskAgentSchedulesRequest { + /** 工作日程列表 */ + agent_schedule?: AgentScheduleUpdateInfo +} + +export interface ListHelpdeskAgentScheduleQuery { + /** 筛选条件, 1 - online客服, 2 - offline(手动)客服, 3 - off duty(下班)客服, 4 - 移除客服 */ + status: number[] +} + +export interface CreateHelpdeskAgentSkillRequest { + /** 技能名 */ + name?: string + /** 技能rules */ + rules?: AgentSkillRule[] + /** 客服 ids */ + agent_ids?: string[] +} + +export interface PatchHelpdeskAgentSkillRequest { + /** 更新技能 */ + agent_skill?: AgentSkill +} + +export interface StartServiceHelpdeskTicketRequest { + /** 是否直接进入人工(若appointed_agents填写了，该值为必填) */ + human_service?: boolean + /** 客服 open ids (获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get))，human_service需要为true */ + appointed_agents?: string[] + /** 用户 open id,(获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */ + open_id: string + /** 工单来源自定义信息，长度限制1024字符，如设置，[获取工单详情](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */ + customized_info?: string +} + +export interface UpdateHelpdeskTicketRequest { + /** new status, 1: 已创建, 2: 处理中, 3: 排队中, 5: 待定, 50: 机器人关闭工单, 51: 关闭工单 */ + status?: number + /** 新标签名 */ + tag_names?: string[] + /** 新评论 */ + comment?: string + /** 自定义字段 */ + customized_fields?: CustomizedFieldDisplayItem[] + /** ticket stage */ + ticket_type?: number + /** 工单是否解决，1: 未解决, 2: 已解决 */ + solved?: number + /** 工单来源渠道ID */ + channel?: number +} + +export interface ListHelpdeskTicketQuery { + /** 搜索条件：工单ID */ + ticket_id?: string + /** 搜索条件: 客服id */ + agent_id?: string + /** 搜索条件: 关单客服id */ + closed_by_id?: string + /** 搜索条件: 工单类型 1:bot 2:人工 */ + type?: number + /** 搜索条件: 工单渠道 */ + channel?: number + /** 搜索条件: 工单是否解决 1:没解决 2:已解决 */ + solved?: number + /** 搜索条件: 工单评分 */ + score?: number + /** 搜索条件: 工单状态列表 */ + status_list?: number[] + /** 搜索条件: 用户名称 */ + guest_name?: string + /** 搜索条件: 用户id */ + guest_id?: string + /** 搜索条件: 用户标签列表 */ + tags?: string[] + /** 页数, 从1开始, 默认为1 */ + page?: number + /** 当前页大小，最大为200， 默认为20。分页查询最多累计返回一万条数据，超过一万条请更改查询条件，推荐通过时间查询。 */ + page_size?: number + /** 搜索条件: 工单创建起始时间 ms (也需要填上create_time_end)，相当于>=create_time_start */ + create_time_start?: number + /** 搜索条件: 工单创建结束时间 ms (也需要填上create_time_start)，相当于<=create_time_end */ + create_time_end?: number + /** 搜索条件: 工单修改起始时间 ms (也需要填上update_time_end) */ + update_time_start?: number + /** 搜索条件: 工单修改结束时间 ms(也需要填上update_time_start) */ + update_time_end?: number +} + +export interface TicketImageHelpdeskTicketQuery { + /** 工单ID */ + ticket_id: string + /** 消息ID[查询消息ID](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list) */ + msg_id: string + /** index，当消息类型为post时，需指定图片index，index从0开始。当消息类型为img时，无需index */ + index?: number +} + +export interface AnswerUserQueryHelpdeskTicketRequest { + /** 事件ID,可从订阅事件中提取 */ + event_id: string + /** faq结果列表 */ + faqs?: UserQueryFaqInfo[] +} + +export interface CustomizedFieldsHelpdeskTicketQuery { + /** visible only */ + visible_only?: boolean +} + +export interface CreateHelpdeskTicketMessageRequest { + /** 消息类型；text：纯文本；post：富文本 */ + msg_type: string + /** - 纯文本，参考[发送文本消息](/ssl:ttdoc/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content；- 富文本，参考[发送富文本消息](/ssl:ttdoc/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content */ + content: string +} + +export interface ListHelpdeskTicketMessageQuery { + /** 起始时间 */ + time_start?: number + /** 结束时间 */ + time_end?: number + /** 页数ID */ + page?: number + /** 消息数量，最大200，默认20 */ + page_size?: number +} + +export interface CreateHelpdeskBotMessageRequest { + /** 消息类型 */ + msg_type: 'text' | 'post' | 'image' | 'interactive' + /** 消息内容 */ + content: string + /** 接收消息用户id */ + receiver_id: string + /** 接收消息方式，chat(服务台专属服务群)或user(服务台机器人私聊)。若选择专属服务群，用户有正在处理的工单将会发送失败。默认以chat方式发送。 */ + receive_type?: 'chat' | 'user' +} + +export interface CreateHelpdeskBotMessageQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateHelpdeskTicketCustomizedFieldRequest { + /** 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 + /** if the dropdown field supports multi-select */ + dropdown_allow_multiple?: boolean +} + +export interface PatchHelpdeskTicketCustomizedFieldRequest { + /** display name */ + display_name?: string + /** the position of ticket customized field in the page */ + position?: string + /** description of the field */ + description?: string + /** if the field is visible */ + visible?: boolean + /** if the field is required */ + required?: boolean +} + +export interface ListHelpdeskTicketCustomizedFieldRequest { + /** 是否可见 */ + visible?: boolean +} + +export interface ListHelpdeskTicketCustomizedFieldQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateHelpdeskFaqRequest { + /** 知识库详情 */ + faq?: FaqCreateInfo +} + +export interface PatchHelpdeskFaqRequest { + /** 修改的知识库内容 */ + faq?: FaqUpdateInfo +} + +export interface ListHelpdeskFaqQuery { + /** 知识库分类ID */ + category_id?: string + /** 搜索条件: 知识库状态 1:在线 0:删除，可恢复 2：删除，不可恢复 */ + status?: string + /** 搜索条件: 关键词，匹配问题标题，问题关键字，用户姓名 */ + search?: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface SearchHelpdeskFaqQuery { + /** 搜索query，query内容如果不是英文，包含中文空格等有两种编码策略：1. url编码 2. base64编码，同时加上base64=true参数 */ + query: string + /** 是否转换为base64,输入true表示是，不填写表示否，中文需要转换为base64 */ + base64?: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface CreateHelpdeskCategoryRequest { + /** category name */ + name: string + /** parent category id, if any */ + parent_id: string + /** category language */ + language?: string +} + +export interface PatchHelpdeskCategoryRequest { + /** category name */ + name?: string + /** parent category id, if any */ + parent_id?: string +} + +export interface ListHelpdeskCategoryQuery { + /** 知识库分类语言 */ + lang?: string + /** 排序键。1: 根据知识库分类更新时间排序 */ + order_by?: number + /** 顺序。true: 正序；false：反序 */ + asc?: boolean +} + +export interface CreateHelpdeskNotificationRequest { + /** 唯一ID */ + id?: string + /** 任务名称 */ + job_name?: string + /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */ + status?: number + /** 创建人 */ + create_user?: NotificationUser + /** 创建时间（毫秒时间戳） */ + created_at?: string + /** 更新用户 */ + update_user?: NotificationUser + /** 更新时间（毫秒时间戳） */ + updated_at?: string + /** 目标推送用户 */ + target_user_count?: number + /** 已推送用户总数 */ + sent_user_count?: number + /** 已读用户总数 */ + read_user_count?: number + /** 推送任务触发时间（毫秒时间戳） */ + send_at?: string + /** 推送内容，详见：https://open.feishu.cn/tool/cardbuilder?from=howtoguide */ + push_content?: string + /** 0（定时推送：push_scope不能等于3） 1（新人入职推送：push_scope必须等于1或者3；new_staff_scope_type不能为空） */ + push_type?: number + /** 推送范围（服务台私信） 0：组织内全部成员（user_list和department_list必须为空） 1：不推送任何成员（user_list和department_list必须为空，chat_list不可为空） 2：推送到部分成员（user_list或department_list不能为空） 3：入职新人 以上四种状态，chat_list都相对独立，只有在推送范围为1时，必须需要设置chat_list */ + push_scope_type?: number + /** 新人入职范围类型（push_type为1时生效） 0：组织内所有新人 1：组织内特定的部门（new_staff_scope_department_list 字段不能为空） */ + new_staff_scope_type?: number + /** 新人入职生效部门列表 */ + new_staff_scope_department_list?: NotificationDepartment[] + /** push推送到成员列表 */ + user_list?: NotificationUser[] + /** push推送到的部门信息列表 */ + department_list?: NotificationDepartment[] + /** push推送到的会话列表(群) */ + chat_list?: NotificationChat[] + /** 预留扩展字段 */ + ext?: string +} + +export interface CreateHelpdeskNotificationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchHelpdeskNotificationRequest { + /** 唯一ID */ + id?: string + /** 任务名称 */ + job_name?: string + /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */ + status?: number + /** 创建人 */ + create_user?: NotificationUser + /** 创建时间（毫秒时间戳） */ + created_at?: string + /** 更新用户 */ + update_user?: NotificationUser + /** 更新时间（毫秒时间戳） */ + updated_at?: string + /** 目标推送用户 */ + target_user_count?: number + /** 已推送用户总数 */ + sent_user_count?: number + /** 已读用户总数 */ + read_user_count?: number + /** 推送任务触发时间（毫秒时间戳） */ + send_at?: string + /** 推送内容，详见：https://open.feishu.cn/tool/cardbuilder?from=howtoguide */ + push_content?: string + /** 0（定时推送：push_scope不能等于3） 1（新人入职推送：push_scope必须等于1或者3；new_staff_scope_type不能为空） */ + push_type?: number + /** 推送范围（服务台私信） 0：组织内全部成员（user_list和department_list必须为空） 1：不推送任何成员（user_list和department_list必须为空，chat_list不可为空） 2：推送到部分成员（user_list或department_list不能为空） 3：入职新人 以上四种状态，chat_list都相对独立，只有在推送范围为1时，必须需要设置chat_list */ + push_scope_type?: number + /** 新人入职范围类型（push_type为1时生效） 0：组织内所有新人 1：组织内特定的部门（new_staff_scope_department_list 字段不能为空） */ + new_staff_scope_type?: number + /** 新人入职生效部门列表 */ + new_staff_scope_department_list?: NotificationDepartment[] + /** push推送到成员列表 */ + user_list?: NotificationUser[] + /** push推送到的部门信息列表 */ + department_list?: NotificationDepartment[] + /** push推送到的会话列表(群) */ + chat_list?: NotificationChat[] + /** 预留扩展字段 */ + ext?: string +} + +export interface PatchHelpdeskNotificationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetHelpdeskNotificationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SubmitApproveHelpdeskNotificationRequest { + /** 提交审批理由 */ + reason: string +} + +export interface ExecuteSendHelpdeskNotificationRequest { + /** 发送时间戳(毫秒) */ + send_at: string +} + +export interface CancelSendHelpdeskNotificationRequest { + /** 是否召回已发送的消息,新人入职消息同样适用 */ + is_recall: boolean +} + +export interface SubscribeHelpdeskEventRequest { + /** 可订阅的事件列表 */ + events: Event[] +} + +export interface UnsubscribeHelpdeskEventRequest { + /** event list to unsubscribe */ + 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 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 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 SearchHelpdeskFaqResponse { + /** if there's next page */ + has_more?: boolean + /** the next page token */ + page_token?: string + 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({ + '/open-apis/helpdesk/v1/agents/{agent_id}': { + PATCH: 'patchHelpdeskAgent', + }, + '/open-apis/helpdesk/v1/agent_emails': { + GET: 'agentEmailHelpdeskAgent', + }, + '/open-apis/helpdesk/v1/agent_schedules': { + POST: 'createHelpdeskAgentSchedule', + GET: 'listHelpdeskAgentSchedule', + }, + '/open-apis/helpdesk/v1/agents/{agent_id}/schedules': { + DELETE: 'deleteHelpdeskAgentSchedules', + PATCH: 'patchHelpdeskAgentSchedules', + GET: 'getHelpdeskAgentSchedules', + }, + '/open-apis/helpdesk/v1/agent_skills': { + POST: 'createHelpdeskAgentSkill', + GET: 'listHelpdeskAgentSkill', + }, + '/open-apis/helpdesk/v1/agent_skills/{agent_skill_id}': { + DELETE: 'deleteHelpdeskAgentSkill', + PATCH: 'patchHelpdeskAgentSkill', + GET: 'getHelpdeskAgentSkill', + }, + '/open-apis/helpdesk/v1/agent_skill_rules': { + GET: 'listHelpdeskAgentSkillRule', + }, + '/open-apis/helpdesk/v1/start_service': { + POST: 'startServiceHelpdeskTicket', + }, + '/open-apis/helpdesk/v1/tickets/{ticket_id}': { + GET: 'getHelpdeskTicket', + PUT: 'updateHelpdeskTicket', + }, + '/open-apis/helpdesk/v1/tickets': { + GET: 'listHelpdeskTicket', + }, + '/open-apis/helpdesk/v1/ticket_images': { + GET: { name: 'ticketImageHelpdeskTicket', type: 'binary' }, + }, + '/open-apis/helpdesk/v1/tickets/{ticket_id}/answer_user_query': { + POST: 'answerUserQueryHelpdeskTicket', + }, + '/open-apis/helpdesk/v1/customized_fields': { + GET: 'customizedFieldsHelpdeskTicket', + }, + '/open-apis/helpdesk/v1/tickets/{ticket_id}/messages': { + POST: 'createHelpdeskTicketMessage', + GET: 'listHelpdeskTicketMessage', + }, + '/open-apis/helpdesk/v1/message': { + POST: 'createHelpdeskBotMessage', + }, + '/open-apis/helpdesk/v1/ticket_customized_fields': { + POST: 'createHelpdeskTicketCustomizedField', + GET: 'listHelpdeskTicketCustomizedField', + }, + '/open-apis/helpdesk/v1/ticket_customized_fields/{ticket_customized_field_id}': { + DELETE: 'deleteHelpdeskTicketCustomizedField', + PATCH: 'patchHelpdeskTicketCustomizedField', + GET: 'getHelpdeskTicketCustomizedField', + }, + '/open-apis/helpdesk/v1/faqs': { + POST: 'createHelpdeskFaq', + GET: 'listHelpdeskFaq', + }, + '/open-apis/helpdesk/v1/faqs/{id}': { + DELETE: 'deleteHelpdeskFaq', + PATCH: 'patchHelpdeskFaq', + GET: 'getHelpdeskFaq', + }, + '/open-apis/helpdesk/v1/faqs/{id}/image/{image_key}': { + GET: { name: 'faqImageHelpdeskFaq', type: 'binary' }, + }, + '/open-apis/helpdesk/v1/faqs/search': { + GET: 'searchHelpdeskFaq', + }, + '/open-apis/helpdesk/v1/categories': { + POST: 'createHelpdeskCategory', + GET: 'listHelpdeskCategory', + }, + '/open-apis/helpdesk/v1/categories/{id}': { + GET: 'getHelpdeskCategory', + PATCH: 'patchHelpdeskCategory', + DELETE: 'deleteHelpdeskCategory', + }, + '/open-apis/helpdesk/v1/notifications': { + POST: 'createHelpdeskNotification', + }, + '/open-apis/helpdesk/v1/notifications/{notification_id}': { + PATCH: 'patchHelpdeskNotification', + GET: 'getHelpdeskNotification', + }, + '/open-apis/helpdesk/v1/notifications/{notification_id}/preview': { + POST: 'previewHelpdeskNotification', + }, + '/open-apis/helpdesk/v1/notifications/{notification_id}/submit_approve': { + POST: 'submitApproveHelpdeskNotification', + }, + '/open-apis/helpdesk/v1/notifications/{notification_id}/cancel_approve': { + POST: 'cancelApproveHelpdeskNotification', + }, + '/open-apis/helpdesk/v1/notifications/{notification_id}/execute_send': { + POST: 'executeSendHelpdeskNotification', + }, + '/open-apis/helpdesk/v1/notifications/{notification_id}/cancel_send': { + POST: 'cancelSendHelpdeskNotification', + }, + '/open-apis/helpdesk/v1/events/subscribe': { + POST: 'subscribeHelpdeskEvent', + }, + '/open-apis/helpdesk/v1/events/unsubscribe': { + POST: 'unsubscribeHelpdeskEvent', + }, +}) diff --git a/adapters/lark/src/types/hire.ts b/adapters/lark/src/types/hire.ts new file mode 100644 index 00000000..8dd4e812 --- /dev/null +++ b/adapters/lark/src/types/hire.ts @@ -0,0 +1,4605 @@ +import { Internal } from '../internal' +import { Account, Agency, AgencyAccount, AgencyProtection, AgencySupplier, Application, ApplicationDetailInfo, ApplicationOffer, Attachment, AttachmentInfo, BackgroundCheckOrder, BonusAmount, CheckFailedAccountInfo, CombinedJobObjectValueMap, CombinedJobResultDefaultJobPost, CommonFilter, CommonSchema, CompositeTalentAwardInfo, CompositeTalentBasicInfo, CompositeTalentCareerInfo, CompositeTalentCustomizedData, CompositeTalentEducationInfo, CompositeTalentInternshipInfo, CompositeTalentLanguageInfo, CompositeTalentProjectInfo, CompositeTalentSnsInfo, CompositeTalentWorksInfo, DiInfo, EcoAccountCustomFieldData, EcoBackgroundCheckCustomFieldData, EcoBackgroundCheckPackageAdditionalItem, EcoBackgroundCheckPackageData, EcoBackgroundCheckReportFile, EcoExamLoginInfo, EcoExamPaperData, EcoExamResultDetail, EcoExamResultReport, Employee, EmployeeConversionInfo, EmployeeOverboardInfo, Evaluation, EvaluationTask, ExamMarkingTask, ExternalApplication, ExternalBackgroundCheck, ExternalInterview, ExternalInterviewAssessment, ExternalInterviewAssessmentDimension, ExternalOffer, I18n, InternOfferOffboardingInfo, InternOfferOnboardingInfo, Interview, InterviewAppointmentConfig, InterviewExtend, InterviewFeedbackForm, InterviewRecord, InterviewRegistrationSchema, InterviewRoundType, InterviewTask, Interviewer, Job, JobConfigInterviewRoundConf, JobConfigResult, JobConfigRoundType, JobDetail, JobFunction, JobManager, JobProcesses, JobRecruiter2, JobRequirementCustomizedData, JobRequirementDto, JobRequirementSchema, JobRequirementUpdateOption, JobSchema, JobTypeInfo, Location, LocationDto, MentionEntity, Minutes, Mobile, Note, Offer, OfferApplyForm, OfferApplyFormInfo, OfferBasicInfo, OfferCustomFieldConfig, OfferCustomizedInfo, OfferListInfo, OfferSalaryInfo, OfferSchemaDetail, PortalJobPost, Questionnaire, Referral, ReferralInfo, RegistrationBasicInfo, RegistrationSchema, RegistrationSchemaInfo, ResumeSource, Role, RoleDetail, Subject, Talent, TalentBatchInfo, TalentBlock, TalentCombinedAwardInfo, TalentCombinedBasicInfo, TalentCombinedCareerInfo, TalentCombinedEducationInfo, TalentCombinedLanguageInfo, TalentCombinedProjectInfo, TalentCombinedSnsInfo, TalentCombinedWorkInfo, TalentCustomizedDataObjectValue, TalentExternalInfo, TalentFolder, TalentFolderForList, TalentInterview, TalentInterviewRegistrationSimple, TalentNote, TalentOperationLog, TalentPool, TalentResumeAttachment, TalentResumeSource, TalentSelfEvaluation, TalentSimilar, TalentTag, TargetMajorInfo, TerminationReason, Test, Todo, TradeDetail, TripartiteAgreementInfo, UserRole, Website, WebsiteChannelInfo, WebsiteDeliveryAttachmentIndentification, WebsiteDeliveryDto, WebsiteDeliveryResume, WebsiteJobPost, WebsiteUser } from '.' + +declare module '../internal' { + interface Internal { + /** + * 查询地点列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query + */ + queryHireLocation(body: QueryHireLocationRequest, query?: QueryHireLocationQuery): Promise + /** + * 获取地址列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/list + */ + listHireLocation(query?: ListHireLocationQuery): Promise + /** + * 获取角色详情 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/get + */ + getHireRole(role_id: string): Promise + /** + * 获取角色列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/list + */ + listHireRole(query?: ListHireRoleQuery): Promise + /** + * 获取用户角色列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/user_role/list + */ + listHireUserRole(query?: ListHireUserRoleQuery): Promise + /** + * 新建职位 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_create + */ + combinedCreateHireJob(body: CombinedCreateHireJobRequest, query?: CombinedCreateHireJobQuery): Promise + /** + * 更新职位 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_update + */ + combinedUpdateHireJob(job_id: string, body: CombinedUpdateHireJobRequest, query?: CombinedUpdateHireJobQuery): Promise + /** + * 更新职位设置 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/update_config + */ + updateConfigHireJob(job_id: string, body: UpdateConfigHireJobRequest, query?: UpdateConfigHireJobQuery): Promise + /** + * 更新职位相关人员 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job-manager/batch_update + */ + batchUpdateHireJobManager(job_id: string, body: BatchUpdateHireJobManagerRequest, query?: BatchUpdateHireJobManagerQuery): Promise + /** + * 获取职位详情 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/get_detail + */ + getDetailHireJob(job_id: string, query?: GetDetailHireJobQuery): Promise + /** + * 获取职位信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/get + */ + getHireJob(job_id: string, query?: GetHireJobQuery): Promise + /** + * 获取职位上的招聘人员信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/recruiter + */ + recruiterHireJob(job_id: string, query?: RecruiterHireJobQuery): Promise + /** + * 获取职位设置 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/config + */ + configHireJob(job_id: string, query?: ConfigHireJobQuery): Promise + /** + * 获取职位列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/list + */ + listHireJob(query?: ListHireJobQuery): Promise + /** + * 关闭职位 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/close + */ + closeHireJob(job_id: string): Promise + /** + * 重启职位 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/open + */ + openHireJob(job_id: string, body: OpenHireJobRequest): Promise + /** + * 获取职位模板 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_schema/list + */ + listHireJobSchema(query?: ListHireJobSchemaQuery): Promise + /** + * 发布职位广告 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/advertisement/publish + */ + publishHireAdvertisement(advertisement_id: string, body: PublishHireAdvertisementRequest): Promise + /** + * 获取职位广告发布记录 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_publish_record/search + */ + searchHireJobPublishRecord(body: SearchHireJobPublishRecordRequest, query?: SearchHireJobPublishRecordQuery): Promise + /** + * 获取职能分类列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_function/list + */ + listHireJobFunction(query?: ListHireJobFunctionQuery): Promise + /** + * 获取职位类别列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_type/list + */ + listHireJobType(query?: ListHireJobTypeQuery): Promise + /** + * 创建招聘需求 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/create + */ + createHireJobRequirement(body: CreateHireJobRequirementRequest, query?: CreateHireJobRequirementQuery): Promise + /** + * 更新招聘需求 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/update + */ + updateHireJobRequirement(job_requirement_id: string, body: UpdateHireJobRequirementRequest, query?: UpdateHireJobRequirementQuery): Promise + /** + * 获取招聘需求信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list_by_id + */ + listByIdHireJobRequirement(body: ListByIdHireJobRequirementRequest, query?: ListByIdHireJobRequirementQuery): Promise + /** + * 获取招聘需求列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list + */ + listHireJobRequirement(query?: ListHireJobRequirementQuery): Promise + /** + * 删除招聘需求 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/delete + */ + deleteHireJobRequirement(job_requirement_id: string): Promise + /** + * 获取招聘需求模板列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement_schema/list + */ + listHireJobRequirementSchema(query?: ListHireJobRequirementSchemaQuery): Promise + /** + * 获取招聘流程信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list + */ + listHireJobProcess(query?: ListHireJobProcessQuery): Promise + /** + * 获取项目列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/subject/list + */ + listHireSubject(query?: ListHireSubjectQuery): Promise + /** + * 获取人才标签信息列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list + */ + listHireTalentTag(query?: ListHireTalentTagQuery): Promise + /** + * 获取信息登记表列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/registration_schema/list + */ + listHireRegistrationSchema(query?: ListHireRegistrationSchemaQuery): Promise + /** + * 获取面试评价表列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_feedback_form/list + */ + listHireInterviewFeedbackForm(query?: ListHireInterviewFeedbackFormQuery): Promise + /** + * 获取面试轮次类型列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_round_type/list + */ + listHireInterviewRoundType(query?: ListHireInterviewRoundTypeQuery): Promise + /** + * 获取面试登记表列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_registration_schema/list + */ + listHireInterviewRegistrationSchema(query?: ListHireInterviewRegistrationSchemaQuery): Promise + /** + * 查询面试官信息列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/list + */ + listHireInterviewer(query?: ListHireInterviewerQuery): Promise + /** + * 更新面试官信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/patch + */ + patchHireInterviewer(interviewer_id: string, body: PatchHireInterviewerRequest, query?: PatchHireInterviewerQuery): Promise + /** + * 更新 Offer 申请表自定义字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_custom_field/update + */ + updateHireOfferCustomField(offer_custom_field_id: string, body: UpdateHireOfferCustomFieldRequest): Promise + /** + * 获取 Offer 申请表信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_application_form/get + */ + getHireOfferApplicationForm(offer_application_form_id: string): Promise + /** + * 获取 Offer 申请表列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_application_form/list + */ + listHireOfferApplicationForm(query?: ListHireOfferApplicationFormQuery): Promise + /** + * 查询人才内推信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral/search + */ + searchHireReferral(body: SearchHireReferralRequest, query?: SearchHireReferralQuery): Promise + /** + * 获取内推官网下职位广告列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/list + */ + listHireReferralWebsiteJobPost(query?: ListHireReferralWebsiteJobPostQuery): Promise + /** + * 获取内推官网下职位广告详情 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/get + */ + getHireReferralWebsiteJobPost(job_post_id: string, query?: GetHireReferralWebsiteJobPostQuery): Promise + /** + * 获取内推信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral/get_by_application + */ + getByApplicationHireReferral(query?: GetByApplicationHireReferralQuery): Promise + /** + * 新建招聘官网推广渠道 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/create + */ + createHireWebsiteChannel(website_id: string, body: CreateHireWebsiteChannelRequest): Promise + /** + * 删除招聘官网推广渠道 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/delete + */ + deleteHireWebsiteChannel(website_id: string, channel_id: string): Promise + /** + * 更新招聘官网推广渠道 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/update + */ + updateHireWebsiteChannel(website_id: string, channel_id: string, body: UpdateHireWebsiteChannelRequest): Promise + /** + * 获取招聘官网推广渠道列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list + */ + listHireWebsiteChannel(website_id: string, query?: ListHireWebsiteChannelQuery): Promise + /** + * 新建招聘官网用户 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-site_user/create + */ + createHireWebsiteSiteUser(website_id: string, body: CreateHireWebsiteSiteUserRequest): Promise + /** + * 获取招聘官网下职位广告详情 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/get + */ + getHireWebsiteJobPost(website_id: string, job_post_id: string, query?: GetHireWebsiteJobPostQuery): Promise + /** + * 搜索招聘官网下的职位广告列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/search + */ + searchHireWebsiteJobPost(website_id: string, body: SearchHireWebsiteJobPostRequest, query?: SearchHireWebsiteJobPostQuery): Promise + /** + * 获取招聘官网下的职位广告列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/list + */ + listHireWebsiteJobPost(website_id: string, query?: ListHireWebsiteJobPostQuery): Promise + /** + * 新建招聘官网投递 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume + */ + createByResumeHireWebsiteDelivery(website_id: string, body: CreateByResumeHireWebsiteDeliveryRequest, query?: CreateByResumeHireWebsiteDeliveryQuery): Promise + /** + * 根据简历附件创建招聘官网投递任务 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_attachment + */ + createByAttachmentHireWebsiteDelivery(website_id: string, body: CreateByAttachmentHireWebsiteDeliveryRequest): Promise + /** + * 获取招聘官网投递任务结果 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery_task/get + */ + getHireWebsiteDeliveryTask(website_id: string, delivery_task_id: string): Promise + /** + * 获取招聘官网列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list + */ + listHireWebsite(query?: ListHireWebsiteQuery): Promise + /** + * 设置猎头保护期 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/protect + */ + protectHireAgency(body: ProtectHireAgencyRequest, query?: ProtectHireAgencyQuery): Promise + /** + * 获取猎头供应商信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/get + */ + getHireAgency(agency_id: string, query?: GetHireAgencyQuery): Promise + /** + * 查询猎头保护期信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/protect_search + */ + protectSearchHireAgency(body: ProtectSearchHireAgencyRequest): Promise + /** + * 查询猎头供应商信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/query + */ + queryHireAgency(query?: QueryHireAgencyQuery): Promise + /** + * 查询猎头供应商下猎头列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/get_agency_account + */ + getAgencyAccountHireAgency(body: GetAgencyAccountHireAgencyRequest, query?: GetAgencyAccountHireAgencyQuery): Promise + /** + * 搜索猎头供应商列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/batch_query + */ + batchQueryHireAgency(body: BatchQueryHireAgencyRequest, query?: BatchQueryHireAgencyQuery): Promise + /** + * 禁用/取消禁用猎头 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/operate_agency_account + */ + operateAgencyAccountHireAgency(body: OperateAgencyAccountHireAgencyRequest): Promise + /** + * 创建人才外部信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent-external_info/create + */ + createHireTalentExternalInfo(talent_id: string, body: CreateHireTalentExternalInfoRequest): Promise + /** + * 更新人才外部信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent-external_info/update + */ + updateHireTalentExternalInfo(talent_id: string, body: UpdateHireTalentExternalInfoRequest): Promise + /** + * 创建外部投递 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/create + */ + createHireExternalApplication(body: CreateHireExternalApplicationRequest): Promise + /** + * 更新外部投递 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/update + */ + updateHireExternalApplication(external_application_id: string, body: UpdateHireExternalApplicationRequest): Promise + /** + * 查询外部投递列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/list + */ + listHireExternalApplication(query?: ListHireExternalApplicationQuery): Promise + /** + * 删除外部投递 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/delete + */ + deleteHireExternalApplication(external_application_id: string, query?: DeleteHireExternalApplicationQuery): Promise + /** + * 创建外部面试 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/create + */ + createHireExternalInterview(body: CreateHireExternalInterviewRequest): Promise + /** + * 更新外部面试 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/update + */ + updateHireExternalInterview(external_interview_id: string, body: UpdateHireExternalInterviewRequest): Promise + /** + * 查询外部面试列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/batch_query + */ + batchQueryHireExternalInterview(body: BatchQueryHireExternalInterviewRequest, query?: BatchQueryHireExternalInterviewQuery): Promise + /** + * 删除外部面试 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/delete + */ + deleteHireExternalInterview(external_interview_id: string): Promise + /** + * 创建外部面评 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview_assessment/create + */ + createHireExternalInterviewAssessment(body: CreateHireExternalInterviewAssessmentRequest): Promise + /** + * 更新外部面评 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview_assessment/patch + */ + patchHireExternalInterviewAssessment(external_interview_assessment_id: string, body: PatchHireExternalInterviewAssessmentRequest): Promise + /** + * 创建外部 Offer + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/create + */ + createHireExternalOffer(body: CreateHireExternalOfferRequest): Promise + /** + * 更新外部 Offer + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/update + */ + updateHireExternalOffer(external_offer_id: string, body: UpdateHireExternalOfferRequest): Promise + /** + * 查询外部 Offer 列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/batch_query + */ + batchQueryHireExternalOffer(body: BatchQueryHireExternalOfferRequest, query?: BatchQueryHireExternalOfferQuery): Promise + /** + * 删除外部 Offer + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/delete + */ + deleteHireExternalOffer(external_offer_id: string): Promise + /** + * 创建外部背调 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/create + */ + createHireExternalBackgroundCheck(body: CreateHireExternalBackgroundCheckRequest): Promise + /** + * 更新外部背调 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/update + */ + updateHireExternalBackgroundCheck(external_background_check_id: string, body: UpdateHireExternalBackgroundCheckRequest): Promise + /** + * 查询外部背调列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/batch_query + */ + batchQueryHireExternalBackgroundCheck(body: BatchQueryHireExternalBackgroundCheckRequest, query?: BatchQueryHireExternalBackgroundCheckQuery): Promise + /** + * 删除外部背调 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/delete + */ + deleteHireExternalBackgroundCheck(external_background_check_id: string): Promise + /** + * 导入外部内推奖励 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_referral_reward/create + */ + createHireExternalReferralReward(body: CreateHireExternalReferralRewardRequest, query?: CreateHireExternalReferralRewardQuery): Promise + /** + * 删除外部内推奖励 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_referral_reward/delete + */ + deleteHireExternalReferralReward(external_referral_reward_id: string): Promise + /** + * 批量加入/移除人才库中人才 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/batch_change_talent_pool + */ + batchChangeTalentPoolHireTalentPool(talent_pool_id: string, body: BatchChangeTalentPoolHireTalentPoolRequest): Promise + /** + * 获取人才库列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/search + */ + searchHireTalentPool(query?: SearchHireTalentPoolQuery): Promise + /** + * 将人才加入人才库 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/move_talent + */ + moveTalentHireTalentPool(talent_pool_id: string, body: MoveTalentHireTalentPoolRequest): Promise + /** + * 操作人才标签 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/tag + */ + tagHireTalent(talent_id: string, body: TagHireTalentRequest): Promise + /** + * 创建人才 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/combined_create + */ + combinedCreateHireTalent(body: CombinedCreateHireTalentRequest, query?: CombinedCreateHireTalentQuery): Promise + /** + * 更新人才 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/combined_update + */ + combinedUpdateHireTalent(body: CombinedUpdateHireTalentRequest, query?: CombinedUpdateHireTalentQuery): Promise + /** + * 将人才加入指定文件夹 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/add_to_folder + */ + addToFolderHireTalent(body: AddToFolderHireTalentRequest): Promise + /** + * 将人才从指定文件夹移除 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/remove_to_folder + */ + removeToFolderHireTalent(body: RemoveToFolderHireTalentRequest): Promise + /** + * 获取人才文件夹列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_folder/list + */ + listHireTalentFolder(query?: ListHireTalentFolderQuery): Promise + /** + * 批量获取人才ID + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/batch_get_id + */ + batchGetIdHireTalent(body: BatchGetIdHireTalentRequest): Promise + /** + * 获取人才列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/list + */ + listHireTalent(query?: ListHireTalentQuery): Promise + /** + * 获取人才字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query + */ + queryHireTalentObject(): Promise + /** + * 获取人才信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/get + */ + getHireTalent(talent_id: string, query?: GetHireTalentQuery): Promise + /** + * 获取人才详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/talent/get + */ + getHireTalent(talent_id: string, query?: GetHireTalentQuery): Promise + /** + * 更新人才在职状态 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/onboard_status + */ + onboardStatusHireTalent(talent_id: string, body: OnboardStatusHireTalentRequest): Promise + /** + * 加入/移除屏蔽名单 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_blocklist/change_talent_block + */ + changeTalentBlockHireTalentBlocklist(body: ChangeTalentBlockHireTalentBlocklistRequest): Promise + /** + * 获取投递详情 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get_detail + */ + getDetailHireApplication(application_id: string, query?: GetDetailHireApplicationQuery): Promise + /** + * 恢复投递 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/recover + */ + recoverHireApplication(application_id: string): Promise + /** + * 创建投递 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/create + */ + createHireApplication(body: CreateHireApplicationRequest, query?: CreateHireApplicationQuery): Promise + /** + * 终止投递 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/terminate + */ + terminateHireApplication(application_id: string, body: TerminateHireApplicationRequest): Promise + /** + * 转移投递阶段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/transfer_stage + */ + transferStageHireApplication(application_id: string, body: TransferStageHireApplicationRequest): Promise + /** + * 获取终止投递原因 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/termination_reason/list + */ + listHireTerminationReason(query?: ListHireTerminationReasonQuery): Promise + /** + * 获取投递信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get + */ + getHireApplication(application_id: string, query?: GetHireApplicationQuery): Promise + /** + * 获取投递列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list + */ + listHireApplication(query?: ListHireApplicationQuery): Promise + /** + * 获取申请表附加信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/diversity_inclusion/search + */ + searchHireDiversityInclusion(body: SearchHireDiversityInclusionRequest): Promise + /** + * 获取简历评估信息列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation/list + */ + listHireEvaluation(query?: ListHireEvaluationQuery): Promise + /** + * 添加笔试结果 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam/create + */ + createHireExam(body: CreateHireExamRequest, query?: CreateHireExamQuery): Promise + /** + * 获取笔试列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/test/search + */ + searchHireTest(body: SearchHireTestRequest, query?: SearchHireTestQuery): Promise + /** + * 获取面试信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/list + */ + listHireInterview(query?: ListHireInterviewQuery): Promise + /** + * 获取人才面试信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/get_by_talent + */ + getByTalentHireInterview(query?: GetByTalentHireInterviewQuery): Promise + /** + * 获取面试评价详细信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record/get + */ + getHireInterviewRecord(interview_record_id: string, query?: GetHireInterviewRecordQuery): Promise + /** + * 获取面试评价详细信息（新版） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/interview_record/get + */ + getHireInterviewRecord(interview_record_id: string, query?: GetHireInterviewRecordQuery): Promise + /** + * 批量获取面试评价详细信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record/list + */ + listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Promise + /** + * 批量获取面试评价详细信息（新版） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/interview_record/list + */ + listHireInterviewRecord(query?: ListHireInterviewRecordQuery): Promise + /** + * 获取面试记录附件 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record-attachment/get + */ + getHireInterviewRecordAttachment(query?: GetHireInterviewRecordAttachmentQuery): Promise + /** + * 获取面试速记明细 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/minutes/get + */ + getHireMinutes(query?: GetHireMinutesQuery): Promise + /** + * 获取面试满意度问卷列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/questionnaire/list + */ + listHireQuestionnaire(query?: ListHireQuestionnaireQuery): Promise + /** + * 创建 Offer + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/create + */ + createHireOffer(body: CreateHireOfferRequest, query?: CreateHireOfferQuery): Promise + /** + * 更新 Offer 信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/update + */ + updateHireOffer(offer_id: string, body: UpdateHireOfferRequest, query?: UpdateHireOfferQuery): Promise + /** + * 获取 Offer 信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/offer + */ + offerHireApplication(application_id: string, query?: OfferHireApplicationQuery): Promise + /** + * 获取 Offer 详情 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/get + */ + getHireOffer(offer_id: string, query?: GetHireOfferQuery): Promise + /** + * 获取 Offer 列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/list + */ + listHireOffer(query?: ListHireOfferQuery): Promise + /** + * 更新 Offer 状态 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/offer_status + */ + offerStatusHireOffer(offer_id: string, body: OfferStatusHireOfferRequest): Promise + /** + * 更新实习 Offer 入/离职状态 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/intern_offer_status + */ + internOfferStatusHireOffer(offer_id: string, body: InternOfferStatusHireOfferRequest): Promise + /** + * 获取背调信息列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/background_check_order/list + */ + listHireBackgroundCheckOrder(query?: ListHireBackgroundCheckOrderQuery): Promise + /** + * 创建三方协议 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/create + */ + createHireTripartiteAgreement(body: CreateHireTripartiteAgreementRequest): Promise + /** + * 获取三方协议 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/list + */ + listHireTripartiteAgreement(query?: ListHireTripartiteAgreementQuery): Promise + /** + * 更新三方协议 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/update + */ + updateHireTripartiteAgreement(tripartite_agreement_id: string, body: UpdateHireTripartiteAgreementRequest): Promise + /** + * 删除三方协议 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/delete + */ + deleteHireTripartiteAgreement(tripartite_agreement_id: string): Promise + /** + * 更新 e-HR 导入任务结果 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/ehr_import_task/patch + */ + patchHireEhrImportTask(ehr_import_task_id: string, body: PatchHireEhrImportTaskRequest): Promise + /** + * 操作候选人入职 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/transfer_onboard + */ + transferOnboardHireApplication(application_id: string, body: TransferOnboardHireApplicationRequest, query?: TransferOnboardHireApplicationQuery): Promise + /** + * 更新员工状态 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/patch + */ + patchHireEmployee(employee_id: string, body: PatchHireEmployeeRequest, query?: PatchHireEmployeeQuery): Promise + /** + * 通过投递 ID 获取入职信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get_by_application + */ + getByApplicationHireEmployee(query?: GetByApplicationHireEmployeeQuery): Promise + /** + * 通过员工 ID 获取入职信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get + */ + getHireEmployee(employee_id: string, query?: GetHireEmployeeQuery): Promise + /** + * 批量获取待办事项 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/todo/list + */ + listHireTodo(query?: ListHireTodoQuery): Promise + /** + * 获取简历评估任务列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation_task/list + */ + listHireEvaluationTask(query?: ListHireEvaluationTaskQuery): Promise + /** + * 获取笔试阅卷任务列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam_marking_task/list + */ + listHireExamMarkingTask(query?: ListHireExamMarkingTaskQuery): Promise + /** + * 获取面试任务列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_task/list + */ + listHireInterviewTask(query?: ListHireInterviewTaskQuery): Promise + /** + * 创建备注 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/create + */ + createHireNote(body: CreateHireNoteRequest, query?: CreateHireNoteQuery): Promise + /** + * 更新备注 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/patch + */ + patchHireNote(note_id: string, body: PatchHireNoteRequest, query?: PatchHireNoteQuery): Promise + /** + * 获取备注 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/get + */ + getHireNote(note_id: string, query?: GetHireNoteQuery): Promise + /** + * 获取备注列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/list + */ + listHireNote(query?: ListHireNoteQuery): Promise + /** + * 删除备注 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/delete + */ + deleteHireNote(note_id: string): Promise + /** + * 获取简历来源列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/resume_source/list + */ + listHireResumeSource(query?: ListHireResumeSourceQuery): Promise + /** + * 创建账号自定义字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/create + */ + createHireEcoAccountCustomField(body: CreateHireEcoAccountCustomFieldRequest): Promise + /** + * 更新账号自定义字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/batch_update + */ + batchUpdateHireEcoAccountCustomField(body: BatchUpdateHireEcoAccountCustomFieldRequest): Promise + /** + * 删除账号自定义字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/batch_delete + */ + batchDeleteHireEcoAccountCustomField(body: BatchDeleteHireEcoAccountCustomFieldRequest): Promise + /** + * 创建背调自定义字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/create + */ + createHireEcoBackgroundCheckCustomField(body: CreateHireEcoBackgroundCheckCustomFieldRequest): Promise + /** + * 更新背调自定义字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/batch_update + */ + batchUpdateHireEcoBackgroundCheckCustomField(body: BatchUpdateHireEcoBackgroundCheckCustomFieldRequest): Promise + /** + * 删除背调自定义字段 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/batch_delete + */ + batchDeleteHireEcoBackgroundCheckCustomField(body: BatchDeleteHireEcoBackgroundCheckCustomFieldRequest): Promise + /** + * 创建背调套餐和附加调查项 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/create + */ + createHireEcoBackgroundCheckPackage(body: CreateHireEcoBackgroundCheckPackageRequest): Promise + /** + * 更新背调套餐和附加调查项 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/batch_update + */ + batchUpdateHireEcoBackgroundCheckPackage(body: BatchUpdateHireEcoBackgroundCheckPackageRequest): Promise + /** + * 删除背调套餐和附加调查项 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/batch_delete + */ + batchDeleteHireEcoBackgroundCheckPackage(body: BatchDeleteHireEcoBackgroundCheckPackageRequest): Promise + /** + * 更新背调订单进度 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_progress + */ + updateProgressHireEcoBackgroundCheck(body: UpdateProgressHireEcoBackgroundCheckRequest): Promise + /** + * 回传背调订单的最终结果 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_result + */ + updateResultHireEcoBackgroundCheck(body: UpdateResultHireEcoBackgroundCheckRequest): Promise + /** + * 终止背调订单 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/cancel + */ + cancelHireEcoBackgroundCheck(body: CancelHireEcoBackgroundCheckRequest): Promise + /** + * 创建试卷列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/create + */ + createHireEcoExamPaper(body: CreateHireEcoExamPaperRequest): Promise + /** + * 更新试卷列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/batch_update + */ + batchUpdateHireEcoExamPaper(body: BatchUpdateHireEcoExamPaperRequest): Promise + /** + * 删除试卷列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/batch_delete + */ + batchDeleteHireEcoExamPaper(body: BatchDeleteHireEcoExamPaperRequest): Promise + /** + * 回传笔试安排结果 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam/login_info + */ + loginInfoHireEcoExam(exam_id: string, body: LoginInfoHireEcoExamRequest): Promise + /** + * 回传笔试结果 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam/update_result + */ + updateResultHireEcoExam(exam_id: string, body: UpdateResultHireEcoExamRequest): Promise + /** + * 启用内推账户 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/enable + */ + enableHireReferralAccount(body: EnableHireReferralAccountRequest, query?: EnableHireReferralAccountQuery): Promise + /** + * 查询内推账户 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/get_account_assets + */ + getAccountAssetsHireReferralAccount(query?: GetAccountAssetsHireReferralAccountQuery): Promise + /** + * 注册内推账户 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/create + */ + createHireReferralAccount(body: CreateHireReferralAccountRequest, query?: CreateHireReferralAccountQuery): Promise + /** + * 停用内推账户 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/deactivate + */ + deactivateHireReferralAccount(referral_account_id: string, query?: DeactivateHireReferralAccountQuery): Promise + /** + * 全额提取内推账户余额 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/withdraw + */ + withdrawHireReferralAccount(referral_account_id: string, body: WithdrawHireReferralAccountRequest): Promise + /** + * 内推账户提现数据对账 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/reconciliation + */ + reconciliationHireReferralAccount(body: ReconciliationHireReferralAccountRequest): Promise + /** + * 创建附件 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment + */ + createHireAttachment(): Promise + /** + * 获取附件信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/attachment/get + */ + getHireAttachment(attachment_id: string, query?: GetHireAttachmentQuery): Promise + /** + * 获取附件 PDF 格式下载链接 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/attachment/preview + */ + previewHireAttachment(attachment_id: string): Promise + /** + * 获取面试记录列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application-interview/list + */ + listHireApplicationInterview(application_id: string, query?: ListHireApplicationInterviewQuery): Promise + /** + * 查询人才操作记录 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/talent_operation_log/search + */ + searchHireTalentOperationLog(body: SearchHireTalentOperationLogRequest, query?: SearchHireTalentOperationLogQuery): Promise + /** + * 获取职位上的招聘人员信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job-manager/get + */ + getHireJobManager(job_id: string, manager_id: string, query?: GetHireJobManagerQuery): Promise + /** + * 获取 Offer 申请表详细信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_schema/get + */ + getHireOfferSchema(offer_schema_id: string): Promise + } +} + +export interface QueryHireLocationRequest { + /** 地址码列表,最大长度不超过100 */ + code_list?: string[] + /** 地址类型 */ + location_type: 1 | 2 | 3 | 4 +} + +export interface QueryHireLocationQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 每页限制, 数据校验规则 1-100 */ + page_size: number +} + +export interface ListHireLocationQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 地址类型 */ + usage: 'position_location' | 'interview_location' | 'store_location' +} + +export interface ListHireRoleQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量 */ + page_size?: number +} + +export interface ListHireUserRoleQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大10 */ + page_size?: number + /** 用户 ID */ + user_id?: string + /** 角色 ID */ + role_id?: string + /** 最早更新时间，毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间，毫秒级时间戳 */ + update_end_time?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CombinedCreateHireJobRequest { + /** 职位编号，可传入职位的「职位编号」、「职位 ID」或者「职位序号」，将以传入的参数作为职位编号，以便双方系统的数据映射 */ + code?: string + /** 工作年限 */ + experience?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + /** 到期日期，请使用 */ + expiry_time?: number + /** 自定义字段 */ + customized_data_list?: CombinedJobObjectValueMap[] + /** 最低职级，枚举通过接口「获取职级列表」获取 */ + min_level_id?: string + /** 最低薪资 */ + min_salary?: number + /** 职位名称 */ + title: string + /** 职位负责人，仅一位，可通过用户相关接口获取用户 id */ + job_managers: JobManager + /** 招聘流程，枚举通过接口「获取招聘流程信息」获取 */ + job_process_id: string + /** 职位流程类型 */ + process_type: 1 | 2 + /** 项目，枚举通过「获取项目列表」获取 */ + subject_id?: string + /** 职能分类，通过「获取职能分类」获取 */ + job_function_id?: string + /** 部门，枚举通过接口「获取部门信息列表」获取 */ + department_id: string + /** 招聘数量 */ + head_count?: number + /** 是否长期有效 */ + is_never_expired: boolean + /** 最高薪资 */ + max_salary?: number + /** 职位要求 */ + requirement?: string + /** 职位描述 */ + description?: string + /** 职位亮点 */ + highlight_list?: string[] + /** 职位类别 */ + job_type_id: string + /** 最高职级，枚举通过接口「获取职级列表」获取 */ + max_level_id?: string + /** 雇佣类型 */ + recruitment_type_id: string + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 序列 */ + job_category_id?: string + /** 工作地点，枚举通过接口「获取地址列表」获取，选择地点用途为「职位地址」 */ + address_id_list?: string[] + /** 职位属性，1是实体职位，2是虚拟职位 */ + job_attribute?: 1 | 2 + /** 到期日期的毫秒时间戳 */ + expiry_timestamp?: string + /** 面试登记表ID */ + interview_registration_schema_id?: string + /** 入职登记表ID */ + onboard_registration_schema_id?: string + /** 目标专业ID List */ + target_major_id_list?: string[] + /** 官网申请表ID */ + portal_website_apply_form_schema_id?: string +} + +export interface CombinedCreateHireJobQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' +} + +export interface CombinedUpdateHireJobRequest { + /** 职位 ID */ + id?: string + /** 工作年限 */ + experience?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + /** 到期日期，请使用 */ + expiry_time?: number + /** 自定义字段 */ + customized_data_list?: CombinedJobObjectValueMap[] + /** 最低职级，枚举通过接口「获取职级列表」获取 */ + min_level_id?: string + /** 最低薪资 */ + min_salary?: number + /** 职位名称 */ + title?: string + /** 职位负责人，仅一位，可通过用户相关接口获取用户 id */ + job_managers: JobManager + /** 招聘流程，枚举通过接口「获取招聘流程信息」获取 */ + job_process_id?: string + /** 项目，枚举通过「获取项目列表」获取 */ + subject_id?: string + /** 职能分类，通过「获取职能分类」获取 */ + job_function_id?: string + /** 部门，枚举通过接口「获取部门信息列表」获取 */ + department_id?: string + /** 招聘数量 */ + head_count?: number + /** 是否长期有效 */ + is_never_expired: boolean + /** 最高薪资 */ + max_salary?: number + /** 职位要求 */ + requirement?: string + /** 职位描述 */ + description?: string + /** 职位亮点 */ + highlight_list?: string[] + /** 职位类别 */ + job_type_id: string + /** 最高职级，枚举通过接口「获取职级列表」获取 */ + max_level_id?: string + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 序列 */ + job_category_id?: string + /** 工作地点，枚举通过接口「获取地址列表」获取，选择地点用途为「职位地址」 */ + address_id_list?: string[] + /** 职位属性，1是实体职位，2是虚拟职位 */ + job_attribute?: 1 | 2 + /** 到期日期的毫秒时间戳 */ + expiry_timestamp?: string + /** 目标专业ID List */ + target_major_id_list?: string[] +} + +export interface CombinedUpdateHireJobQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' +} + +export interface UpdateConfigHireJobRequest { + /** Offer 申请表，枚举通过接口「获取 Offer 申请表列表」获取 */ + offer_apply_schema_id?: string + /** Offer 审批流，枚举通过接口「获取 Offer 审批流列表」获取 */ + offer_process_conf?: string + /** 建议评估人 ID 列表 */ + recommended_evaluator_id_list?: string[] + /** 更新选项，传入要更新的配置项 */ + update_option_list: 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | 11 | 12[] + /** 面试评价表，枚举通过接口「获取面试评价表列表」获取 */ + assessment_template_biz_id?: string + /** 建议面试官列表 */ + interview_round_conf_list?: JobConfigInterviewRoundConf[] + /** 关联招聘需求，支持关联多个，枚举通过接口「获取招聘需求」获取 */ + jr_id_list?: string[] + /** 面试登记表ID，当在飞书招聘「设置 - 信息登记表使用设置 - 面试登记表使用方式」中选择「HR 按职位选择登记表」时，该字段为必填；否则该字段不生效。 */ + interview_registration_schema_id?: string + /** 入职登记表ID，当在飞书招聘「设置 - 信息登记表使用设置 - 入职登记表使用方式」中选择「HR 按职位选择登记表」时，该字段为必填；否则该字段不生效。 */ + onboard_registration_schema_id?: string + /** 面试轮次类型 ID 列表 */ + interview_round_type_conf_list?: JobConfigRoundType[] + /** 关联职位列表，如职位为实体职位则关联虚拟职位id，如职位为虚拟职位则关联实体职位id */ + related_job_id_list?: string[] + /** 面试官安排面试配置 */ + interview_appointment_config?: InterviewAppointmentConfig + /** 官网申请表ID */ + portal_website_apply_form_schema_id?: string +} + +export interface UpdateConfigHireJobQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchUpdateHireJobManagerRequest { + /** 招聘负责人 ID */ + recruiter_id?: string + /** 招聘协助人 ID */ + assistant_id_list?: string[] + /** 用人经理 ID */ + hiring_manager_id_list?: string[] + /** 更新的人员类型，可选值：1=招聘负责人; 2=招聘协助人; 3=用人经理； */ + update_option_list: 1 | 2 | 3[] + /** 操作者 ID */ + creator_id?: string +} + +export interface BatchUpdateHireJobManagerQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetDetailHireJobQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' +} + +export interface GetHireJobQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' +} + +export interface RecruiterHireJobQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ConfigHireJobQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ListHireJobQuery { + /** 最早更新时间，毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间，毫秒级时间戳 */ + update_end_time?: string + /** 分页大小, 不能超过 20 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' +} + +export interface OpenHireJobRequest { + /** 到期日期 */ + expiry_time?: number + /** 是否长期有效 */ + is_never_expired: boolean +} + +export interface ListHireJobSchemaQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 职位模板类型 */ + scenario?: 1 | 2 +} + +export interface PublishHireAdvertisementRequest { + /** 职位渠道 ID，选择要发布的招聘官网，单次仅可发布 1 个渠道，1. 内推平台提供对应的 id = 3，2. 官网渠道的 ID 通过接口「获取官网列表」获取 */ + job_channel_id?: string +} + +export interface SearchHireJobPublishRecordRequest { + /** 渠道 ID */ + job_channel_id: string +} + +export interface SearchHireJobPublishRecordQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' +} + +export interface ListHireJobFunctionQuery { + /** 分页大小, 不能超过 50 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListHireJobTypeQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateHireJobRequirementRequest { + /** 招聘需求编号 */ + short_code: string + /** 需求名称 */ + name: string + /** 需求状态 */ + display_progress: 1 | 2 | 3 | 4 | 5 | 6 + /** 需求人数 */ + head_count: number + /** 职位性质 ID */ + recruitment_type_id?: string + /** 人员类型 */ + employee_type_id?: string + /** 最高职级 ID */ + max_level_id?: string + /** 最低职级 ID */ + min_level_id?: string + /** 职位序列 ID */ + sequence_id?: string + /** 需求类型 */ + category?: 1 | 2 + /** 需求部门 ID */ + department_id?: string + /** 需求负责人 ID 列表 */ + recruiter_id_list?: string[] + /** 需求用人经理 ID 列表 */ + jr_hiring_manager_id_list?: string[] + /** 直属上级 ID */ + direct_leader_id_list?: string[] + /** 开始日期，毫秒级时间戳 */ + start_time?: string + /** 预计完成日期，毫秒级时间戳 */ + deadline?: string + /** 招聘优先级 */ + priority?: 1 | 2 | 3 + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 最高薪资 */ + max_salary?: string + /** 最低薪资 */ + min_salary?: string + /** 工作地点 ID */ + address_id?: string + /** 需求描述 */ + description?: string + /** 自定义字段 */ + customized_data_list?: JobRequirementCustomizedData[] + /** 支持的招聘类型列表 */ + process_type?: 1 | 2 + /** 招聘需求中的职位类别 */ + job_type_id?: string + /** 关联的职位 ID 列表 */ + job_id_list?: string[] + /** 职务 ID */ + employment_job_id?: string + /** 岗位 ID */ + position_id?: string +} + +export interface CreateHireJobRequirementQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface UpdateHireJobRequirementRequest { + /** 需求名称 */ + name: string + /** 需求状态 */ + display_progress: 1 | 2 | 3 | 4 | 5 | 6 + /** 需求人数 */ + head_count: number + /** 职位性质 ID */ + recruitment_type_id?: string + /** 人员类型 */ + employee_type_id?: string + /** 最高职级 ID */ + max_level_id?: string + /** 最低职级 ID */ + min_level_id?: string + /** 职位序列 ID */ + sequence_id?: string + /** 需求类型 */ + category?: 1 | 2 + /** 需求部门 ID */ + department_id?: string + /** 需求负责人 ID 列表 */ + recruiter_id_list?: string[] + /** 需求用人经理 ID 列表 */ + jr_hiring_manager_id_list?: string[] + /** 直属上级 ID */ + direct_leader_id_list?: string[] + /** 开始日期，毫秒级时间戳 */ + start_time?: string + /** 预计完成日期，毫秒级时间戳 */ + deadline?: string + /** 招聘优先级 */ + priority?: 1 | 2 | 3 + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 最高薪资 */ + max_salary?: string + /** 最低薪资 */ + min_salary?: string + /** 工作地点 ID */ + address_id?: string + /** 需求描述 */ + description?: string + /** 自定义字段 */ + customized_data_list?: JobRequirementCustomizedData[] + /** 支持的招聘类型列表 */ + process_type?: 1 | 2 + /** 招聘需求中的职位类别 */ + job_type_id?: string + /** 关联的职位 ID 列表 */ + job_id_list?: string[] + /** 职务 ID */ + employment_job_id?: string + /** 岗位 ID */ + position_id?: string + /** 招聘需求修改确认控制 */ + update_option?: JobRequirementUpdateOption +} + +export interface UpdateHireJobRequirementQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface ListByIdHireJobRequirementRequest { + /** 招聘需求ID列表 */ + id_list?: string[] +} + +export interface ListByIdHireJobRequirementQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface ListHireJobRequirementQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 职位ID */ + job_id?: string + /** 起始创建时间，传入毫秒级时间戳 */ + create_time_begin?: string + /** 截止创建时间，传入毫秒级时间戳 */ + create_time_end?: string + /** 起始更新时间，传入毫秒级时间戳 */ + update_time_begin?: string + /** 截止更新时间，传入毫秒级时间戳 */ + update_time_end?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface ListHireJobRequirementSchemaQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number +} + +export interface ListHireJobProcessQuery { + /** 分页大小, 不能超过 100 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListHireSubjectQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 项目ID列表 */ + subject_ids?: string[] + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number +} + +export interface ListHireTalentTagQuery { + /** 搜索关键词 */ + keyword?: string + /** ID 列表 */ + id_list?: string[] + /** 标签类型 */ + type?: 1 | 2 + /** 包含停用 */ + include_inactive?: boolean + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListHireRegistrationSchemaQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 登记表适用场景；不填表示获取全部类型信息登记表 */ + scenario?: 5 | 6 | 14 +} + +export interface ListHireInterviewFeedbackFormQuery { + /** 面试评价表ID列表, 如果使用此字段则会忽略其他参数 */ + interview_feedback_form_ids?: string[] + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListHireInterviewRoundTypeQuery { + /** 职位流程类型 */ + process_type?: 1 | 2 +} + +export interface ListHireInterviewRegistrationSchemaQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number +} + +export interface ListHireInterviewerQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 面试官userID列表 */ + user_ids?: string[] + /** 认证状态 */ + verify_status?: 1 | 2 + /** 最早更新时间，毫秒时间戳 */ + earliest_update_time?: string + /** 最晚更新时间，毫秒时间戳 */ + latest_update_time?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchHireInterviewerRequest { + /** 面试官信息 */ + interviewer: Interviewer +} + +export interface PatchHireInterviewerQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateHireOfferCustomFieldRequest { + /** 自定义字段名称 */ + name: I18n + /** 配置信息 */ + config?: OfferCustomFieldConfig +} + +export interface ListHireOfferApplicationFormQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number +} + +export interface SearchHireReferralRequest { + /** 人才id */ + talent_id: string + /** 投递起始时间，若不填，默认为全部，但最多返回200条 */ + start_time?: string + /** 投递终止时间，若不填，默认为全部，但最多返回200条 */ + end_time?: string +} + +export interface SearchHireReferralQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListHireReferralWebsiteJobPostQuery { + /** 招聘流程类型 */ + process_type?: 1 | 2 + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大10 */ + page_size?: number + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' +} + +export interface GetHireReferralWebsiteJobPostQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' +} + +export interface GetByApplicationHireReferralQuery { + /** 投递的 ID */ + application_id: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface CreateHireWebsiteChannelRequest { + /** 推广渠道名称 */ + channel_name: string +} + +export interface UpdateHireWebsiteChannelRequest { + /** 推广渠道名称 */ + channel_name: string +} + +export interface ListHireWebsiteChannelQuery { + /** 每页获取记录最大数量，最大100 */ + page_size?: string + /** 页码标识，获取第一页传空，每次查询会返回下一页的 page_token */ + page_token?: string +} + +export interface CreateHireWebsiteSiteUserRequest { + /** 姓名 */ + name?: string + /** 邮箱 */ + email?: string + /** 外部用户 ID */ + external_id: string + /** 电话，请和区号对应的国家码一并提供 */ + mobile?: string + /** 国家码，请和电话一并提供，可从「获取地址码」查询 */ + mobile_country_code?: string +} + +export interface GetHireWebsiteJobPostQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' +} + +export interface SearchHireWebsiteJobPostRequest { + /** 职位类型列表 */ + job_type_id_list?: string[] + /** 职位城市列表 */ + city_code_list?: string[] + /** 职能分类列表 */ + job_function_id_list?: string[] + /** 职位项目列表 */ + subject_id_list?: string[] + /** 关键字 */ + keyword?: string + /** 最早更新时间,毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间,毫秒级时间戳 */ + update_end_time?: string + /** 最早创建时间,毫秒级时间戳 */ + create_start_time?: string + /** 最晚创建时间,毫秒级时间戳 */ + create_end_time?: string +} + +export interface SearchHireWebsiteJobPostQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大10 */ + page_size?: number + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' +} + +export interface ListHireWebsiteJobPostQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大10 */ + page_size?: number + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 最早更新时间,毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间,毫秒级时间戳 */ + update_end_time?: string + /** 最早创建时间,毫秒级时间戳 */ + create_start_time?: string + /** 最晚创建时间,毫秒级时间戳 */ + create_end_time?: string +} + +export interface CreateByResumeHireWebsiteDeliveryRequest { + /** 职位广告 ID */ + job_post_id: string + /** 人才信息 */ + resume: WebsiteDeliveryResume + /** 官网用户 ID */ + user_id: string + /** 意向投递城市列表，可从「获取职位信息」返回的工作地点列表获取 */ + application_preferred_city_code_list?: string[] + /** 官网推广渠道 ID */ + channel_id?: string +} + +export interface CreateByResumeHireWebsiteDeliveryQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateByAttachmentHireWebsiteDeliveryRequest { + /** 职位广告 ID */ + job_post_id: string + /** 官网用户 ID */ + user_id: string + /** 简历文件 ID，使用「创建附件」生成 */ + resume_file_id: string + /** 官网推广渠道 ID */ + channel_id?: string + /** 意向投递城市列表，可从「获取职位信息」返回的工作地点列表获取 */ + application_preferred_city_code_list?: string[] + /** 电话国际区号，可从「获取地址码」查询（当该参数值与简历附件中的相关值不一致时，将以该参数值为准） */ + mobile_country_code?: string + /** 电话号码（当该参数值与简历附件中的相关值不一致时，将以该参数值为准） */ + mobile?: string + /** 邮箱（当该参数值与简历附件中的相关值不一致时，将以该参数值为准） */ + email?: string + /** 身份证件号码（当该参数值与简历附件中的相关值不一致时，将以该参数值为准） */ + identification?: WebsiteDeliveryAttachmentIndentification +} + +export interface ListHireWebsiteQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大10 */ + page_size?: number +} + +export interface ProtectHireAgencyRequest { + /** 人才ID */ + talent_id: string + /** 供应商ID */ + supplier_id: string + /** 猎头顾问ID */ + consultant_id: string + /** 保护期创建时间 */ + protect_create_time: number + /** 保护期过期时间 */ + protect_expire_time: number + /** 推荐语 */ + comment?: string + /** 当前薪资 */ + current_salary?: string + /** 预期薪资 */ + expected_salary?: string +} + +export interface ProtectHireAgencyQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface GetHireAgencyQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ProtectSearchHireAgencyRequest { + /** 人才id */ + talent_id: string +} + +export interface QueryHireAgencyQuery { + /** 猎头供应商名称 */ + name: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetAgencyAccountHireAgencyRequest { + /** 猎头供应商 ID */ + supplier_id: string + /** 猎头状态 */ + status?: 0 | 1 | 2 + /** 角色 */ + role?: 0 | 1 +} + +export interface GetAgencyAccountHireAgencyQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'union_id' | 'open_id' + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量 */ + page_size?: number +} + +export interface BatchQueryHireAgencyRequest { + /** 猎头供应商 ID 列表，当传递此值，以此值为准，其余查询字段失效 */ + agency_supplier_id_list?: string[] + /** 搜索关键字，可传入名称或邮箱 */ + keyword?: string + /** 筛选项，相同的 Key 仅可传一次 */ + filter_list?: CommonFilter[] +} + +export interface BatchQueryHireAgencyQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量 */ + page_size?: number +} + +export interface OperateAgencyAccountHireAgencyRequest { + /** 操作类型 */ + option: 1 | 2 + /** 猎头 ID */ + id: string + /** 禁用原因，仅当禁用操作时，必填 */ + reason?: string +} + +export interface CreateHireTalentExternalInfoRequest { + /** 人才在外部系统创建时间 */ + external_create_time: string +} + +export interface UpdateHireTalentExternalInfoRequest { + /** 人才在外部系统创建时间 */ + external_create_time: string +} + +export interface CreateHireExternalApplicationRequest { + /** 外部系统背调主键 （仅用于幂等） */ + external_id?: string + /** 职位招聘类型 */ + job_recruitment_type?: 1 | 2 + /** 职位名称 */ + job_title?: string + /** 简历来源 */ + resume_source?: string + /** 阶段 */ + stage?: string + /** 人才 ID */ + talent_id: string + /** 终止原因 */ + termination_reason?: string + /** 投递类型 */ + delivery_type?: 1 | 2 | 3 | 4 + /** 更新时间，招聘系统内用作投递在外部系统终止时间 */ + modify_time?: number + /** 投递在外部系统创建时间 */ + create_time?: number + /** 终止类型 */ + termination_type?: string +} + +export interface UpdateHireExternalApplicationRequest { + /** 职位招聘类型 */ + job_recruitment_type?: 1 | 2 + /** 职位名称 */ + job_title?: string + /** 简历来源 */ + resume_source?: string + /** 阶段 */ + stage?: string + /** 终止原因 */ + termination_reason?: string + /** 投递类型 */ + delivery_type?: 1 | 2 | 3 | 4 + /** 更新时间，招聘系统内用作投递在外部系统终止时间 */ + modify_time?: number + /** 投递在外部系统创建时间 */ + create_time?: number + /** 终止类型 */ + termination_type?: string +} + +export interface ListHireExternalApplicationQuery { + /** 人才ID */ + talent_id: string + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface DeleteHireExternalApplicationQuery { + /** 人才ID */ + talent_id?: string +} + +export interface CreateHireExternalInterviewRequest { + /** 外部系统面试主键 （仅用于幂等） */ + external_id?: string + /** 外部投递 ID */ + external_application_id: string + /** 参与状态 */ + participate_status?: 1 | 2 | 3 + /** 开始时间 */ + begin_time?: number + /** 结束时间 */ + end_time?: number + /** 面试评价列表 */ + interview_assessments?: ExternalInterviewAssessment[] +} + +export interface UpdateHireExternalInterviewRequest { + /** 外部投递 ID */ + external_application_id: string + /** 参与状态 */ + participate_status?: 1 | 2 | 3 + /** 开始时间 */ + begin_time?: number + /** 结束时间 */ + end_time?: number + /** 面试评价列表 */ + interview_assessments?: ExternalInterviewAssessment[] +} + +export interface BatchQueryHireExternalInterviewRequest { + /** 外部面试 ID列表,当传递此值时,以此值为准 */ + external_interview_id_list?: string[] +} + +export interface BatchQueryHireExternalInterviewQuery { + /** 外部投递 ID */ + external_application_id?: string + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateHireExternalInterviewAssessmentRequest { + /** 外部系统面评主键（仅用于幂等） */ + external_id?: string + /** 面试官姓名 */ + username?: string + /** 面试结果 */ + conclusion?: 1 | 2 | 3 + /** 评价维度列表 */ + assessment_dimension_list?: ExternalInterviewAssessmentDimension[] + /** 综合记录 */ + content?: string + /** 外部面试 ID */ + external_interview_id?: string +} + +export interface PatchHireExternalInterviewAssessmentRequest { + /** 面试官姓名 */ + username?: string + /** 面试结果 */ + conclusion?: 1 | 2 | 3 + /** 评价维度列表 */ + assessment_dimension_list?: ExternalInterviewAssessmentDimension[] + /** 综合记录 */ + content?: string +} + +export interface CreateHireExternalOfferRequest { + /** 外部系统 Offer 主键（仅用于幂等） */ + external_id?: string + /** 外部投递 ID */ + external_application_id: string + /** Offer 创建时间，毫秒时间戳 */ + biz_create_time?: string + /** Offer 负责人 */ + owner?: string + /** Offer 状态 */ + offer_status?: string + /** Offer详情附件ID列表 */ + attachment_id_list?: string[] +} + +export interface UpdateHireExternalOfferRequest { + /** 外部投递 ID */ + external_application_id: string + /** Offer 创建时间，毫秒时间戳 */ + biz_create_time?: string + /** Offer 负责人 */ + owner?: string + /** Offer 状态 */ + offer_status?: string + /** Offer详情附件ID列表 */ + attachment_id_list?: string[] +} + +export interface BatchQueryHireExternalOfferRequest { + /** 外部 Offer ID列表,当传递此值时,以此值为准 */ + external_offer_id_list?: string[] +} + +export interface BatchQueryHireExternalOfferQuery { + /** 外部投递 ID */ + external_application_id?: string + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateHireExternalBackgroundCheckRequest { + /** 外部系统背调主键 （仅用于幂等） */ + external_id?: string + /** 外部投递 ID */ + external_application_id: string + /** 背调日期 */ + date?: number + /** 背调名字 */ + name?: string + /** 背调结果 */ + result?: string + /** 背调附件ID列表 */ + attachment_id_list?: string[] +} + +export interface UpdateHireExternalBackgroundCheckRequest { + /** 外部投递 ID */ + external_application_id: string + /** 背调日期 */ + date?: number + /** 背调名字 */ + name?: string + /** 背调结果 */ + result?: string + /** 背调附件ID列表 */ + attachment_id_list?: string[] +} + +export interface BatchQueryHireExternalBackgroundCheckRequest { + /** 外部背调 ID 列表,当传递此值时,以此值为准 */ + external_background_check_id_list?: string[] +} + +export interface BatchQueryHireExternalBackgroundCheckQuery { + /** 外部投递 ID */ + external_application_id?: string + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateHireExternalReferralRewardRequest { + /** 内推人ID */ + referral_user_id: string + /** 奖励创建人，管理员与内推人可见，若不传，则默认为「外部系统」 */ + create_user_id?: string + /** 奖励确认人，若导入的「内推奖励状态」为「已确认」可传入，若不传，则默认为「外部系统」 */ + confirm_user_id?: string + /** 奖励发放人，导入奖励状态为「已发放」的奖励传入，若不传，则默认为「外部系统」 */ + pay_user_id?: string + /** 外部系统奖励唯一id（仅用于幂等） */ + external_id: string + /** 投递id，和「人才id」二选一 */ + application_id?: string + /** 人才id，和「投递id」二选一 */ + talent_id?: string + /** 职位id，当参数包含「人才id」时，可以选填职位id */ + job_id?: string + /** 奖励原因 */ + reason?: string + /** 导入的奖励规则类型，将展示在内推奖励明细中，管理员与内推人可见 */ + rule_type: 1 | 2 | 3 | 4 | 5 + /** 奖励数据 */ + bonus: BonusAmount + /** 导入的内推奖励状态 */ + stage: 1 | 2 | 3 + /** 奖励产生时间，内推奖励触发时间，若未传入，取接口传入时间 */ + create_time?: string + /** 奖励确认时间，若导入的「内推奖励状态」为「已确认」可传入，若未传入，取接口传入时间 */ + confirm_time?: string + /** 奖励发放时间，若导入的「内推奖励状态」为「已确认」可传入，若未传入，取接口传入时间 */ + pay_time?: string + /** 入职时间，管理员与内推人可见，若为「入职奖励」可传入 */ + onboard_time?: string + /** 入职时间，管理员与内推人可见，若为「入职奖励」可传入 */ + conversion_time?: string + /** 操作备注，管理员与内推人可见，若为空，将展示为奖励原因 */ + comment?: string +} + +export interface CreateHireExternalReferralRewardQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchChangeTalentPoolHireTalentPoolRequest { + /** 人才 ID 列表 */ + talent_id_list: string[] + /** 操作类型 */ + option_type: 1 | 2 +} + +export interface SearchHireTalentPoolQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 人才库ID列表 */ + id_list?: string[] +} + +export interface MoveTalentHireTalentPoolRequest { + /** 人才ID */ + talent_id: string + /** 操作类型 */ + add_type: 1 | 2 +} + +export interface TagHireTalentRequest { + /** 操作类型 */ + operation: 1 | 2 + /** 标签 ID 列表 */ + tag_id_list: string[] +} + +export interface CombinedCreateHireTalentRequest { + /** 简历来源 ID，可通过[获取简历来源列表](/ssl:ttdoc/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */ + init_source_id?: string + /** 简历来源 ID */ + resume_source_id?: string + /** 文件夹 ID 列表 */ + folder_id_list?: string[] + /** 创建人 ID */ + creator_id?: string + /** 创建人类型 */ + creator_account_type?: 1 | 3 + /** 简历附件 ID */ + resume_attachment_id?: string + /** 基础信息 */ + basic_info: TalentCombinedBasicInfo + /** 教育经历 */ + education_list?: TalentCombinedEducationInfo[] + /** 工作经历 */ + career_list?: TalentCombinedCareerInfo[] + /** 项目经历 */ + project_list?: TalentCombinedProjectInfo[] + /** 作品 */ + works_list?: TalentCombinedWorkInfo[] + /** 获奖 */ + award_list?: TalentCombinedAwardInfo[] + /** 语言能力 */ + language_list?: TalentCombinedLanguageInfo[] + /** 社交账号 */ + sns_list?: TalentCombinedSnsInfo[] + /** 意向地点 */ + preferred_city_code_list?: string[] + /** 自我评价 */ + self_evaluation?: TalentSelfEvaluation + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface CombinedCreateHireTalentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface CombinedUpdateHireTalentRequest { + /** 人才 ID */ + talent_id: string + /** 简历来源 ID，可通过[获取简历来源列表](/ssl:ttdoc/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query)接口查询 */ + init_source_id?: string + /** 文件夹 ID 列表 */ + folder_id_list?: string[] + /** 更新人 ID */ + operator_id?: string + /** 更新人类型 */ + operator_account_type?: 1 | 3 + /** 简历附件id */ + resume_attachment_id?: string + /** 基础信息 */ + basic_info: TalentCombinedBasicInfo + /** 教育经历 */ + education_list?: TalentCombinedEducationInfo[] + /** 工作经历 */ + career_list?: TalentCombinedCareerInfo[] + /** 项目经历 */ + project_list?: TalentCombinedProjectInfo[] + /** 作品 */ + works_list?: TalentCombinedWorkInfo[] + /** 获奖 */ + award_list?: TalentCombinedAwardInfo[] + /** 语言能力 */ + language_list?: TalentCombinedLanguageInfo[] + /** 社交账号 */ + sns_list?: TalentCombinedSnsInfo[] + /** 偏好城市 */ + preferred_city_code_list?: string[] + /** 自我评价 */ + self_evaluation?: TalentSelfEvaluation + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface CombinedUpdateHireTalentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface AddToFolderHireTalentRequest { + /** 人才 ID 列表 */ + talent_id_list: string[] + /** 文件夹 ID */ + folder_id: string +} + +export interface RemoveToFolderHireTalentRequest { + /** 人才 ID 列表 */ + talent_id_list: string[] + /** 文件夹 ID */ + folder_id: string +} + +export interface ListHireTalentFolderQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 用户ID类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface BatchGetIdHireTalentRequest { + /** 手机国家区号，默认值：86，即中国大陆地区 */ + mobile_code?: string + /** 手机号，区号均采用 mobile_code 参数的值，最多 100 个 */ + mobile_number_list?: string[] + /** 邮箱信息列表，最多 100 个 */ + email_list?: string[] + /** 证件类型，可参考招聘枚举常量文档下的 IdentificationType 枚举定义 */ + identification_type?: number + /** 证件号 */ + identification_number_list?: string[] +} + +export interface ListHireTalentQuery { + /** 搜索关键词，支持布尔语言（使用 and、or、not 连接关键词） */ + keyword?: string + /** 最早更新时间，毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间，毫秒级时间戳 */ + update_end_time?: string + /** 分页大小, 不能超过 20 */ + page_size?: number + /** 排序规则 */ + sort_by?: 1 | 2 | 3 | 4 + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 请求控制参数 */ + query_option?: 'ignore_empty_error' +} + +export interface GetHireTalentQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface GetHireTalentQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface OnboardStatusHireTalentRequest { + /** 操作类型 1:入职 2:离职 */ + operation: 1 | 2 + /** 毫秒时间戳 */ + onboard_time?: string + /** 毫秒时间戳 */ + overboard_time?: string +} + +export interface ChangeTalentBlockHireTalentBlocklistRequest { + /** 人才 ID */ + talent_id: string + /** 操作类型 */ + option: 1 | 2 + /** 原因，当执行加入屏蔽名单操作时必填 */ + reason?: string +} + +export interface GetDetailHireApplicationQuery { + /** 此次调用中使用的用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的部门 ID 类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' + /** 请求控制参数，用于控制获取哪些关联实体信息。 */ + options?: 'with_job' | 'with_talent' | 'with_interview' | 'with_offer' | 'with_evaluation' | 'with_employee' | 'with_agency' | 'with_referral' | 'with_portal'[] +} + +export interface CreateHireApplicationRequest { + /** 人才ID */ + talent_id: string + /** 职位ID */ + job_id: string + /** 人员ID */ + user_id?: string + /** 简历来源 ID，可通过「获取简历来源」接口查询。若简历来源类型属于「员工转岗」或「实习生转正」，人才需处于已入职状态。 */ + resume_source_id?: string + /** 意向投递城市列表，可从「获取职位信息」返回的工作地点列表获取 */ + application_preferred_city_code_list?: string[] +} + +export interface CreateHireApplicationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface TerminateHireApplicationRequest { + /** 终止原因的类型 */ + termination_type: 1 | 22 | 27 + /** 终止的具体原因的id列表 */ + termination_reason_list?: string[] + /** 终止备注 */ + termination_reason_note?: string +} + +export interface TransferStageHireApplicationRequest { + /** 要转移到的阶段 ID，可通过「获取招聘流程信息」接口获取阶段 ID 枚举 */ + stage_id: string +} + +export interface ListHireTerminationReasonQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大10 */ + page_size?: number +} + +export interface GetHireApplicationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 请求控制参数，用于控制接口响应逻辑。如需一次查询多个用户ID，可通过将同一参数名多次传递，并且每次传递不同的参数值。 */ + options?: 'get_latest_application_on_chain'[] +} + +export interface ListHireApplicationQuery { + /** 按流程过滤，招聘流程 ID，枚举值通过接口「获取招聘流程信息」接口获取 */ + process_id?: string + /** 按招聘阶段过滤，招聘阶段 ID，枚举值通过「获取招聘流程信息」接口获取 */ + stage_id?: string + /** 按人才过滤 */ + talent_id?: string + /** 按活跃状态筛选 1=活跃投递, 2=非活跃投递, 3=全部 */ + active_status?: string + /** 职位 ID */ + job_id?: string + /** 锁定状态 */ + lock_status?: 1 | 2 | 3[] + /** 查询游标, 由上一页结果返回, 第一页不传 */ + page_token?: string + /** 每页限制, 每页最大不超过100 */ + page_size?: number + /** 最早更新时间，毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间，毫秒级时间戳 */ + update_end_time?: string +} + +export interface SearchHireDiversityInclusionRequest { + /** 需要查询DI数据的人才ID列表 */ + talent_ids?: string[] + /** 需要查询DI数据的投递ID列表 */ + application_ids?: string[] +} + +export interface ListHireEvaluationQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 投递 ID */ + application_id?: string + /** 最早更新时间，毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间，毫秒级时间戳 */ + update_end_time?: string + /** 用户ID类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface CreateHireExamRequest { + /** 投递 ID */ + application_id: string + /** 试卷名称 */ + exam_resource_name: string + /** 笔试分数 */ + score: number + /** 报告附件，使用[创建附件](/ssl:ttdoc/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment)上传，获取附件ID，支持的文件格式：JPG、JPEG、PNG、PDF，不超过 100MB。 */ + uuid?: string + /** 添加人 ID */ + operator_id: string +} + +export interface CreateHireExamQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface SearchHireTestRequest { + /** 投递 ID 列表，最多 100 个，默认查询全部投递 */ + application_id_list?: string[] + /** 笔试开始时间晚于等于的时间 */ + test_start_time_min?: string + /** 笔试开始时间早于等于的时间 */ + test_start_time_max?: string +} + +export interface SearchHireTestQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListHireInterviewQuery { + /** 分页大小，不能超过 100 */ + page_size?: number + /** 查询游标, 由上一页结果返回, 第一页不传 */ + page_token?: string + /** 投递 ID */ + application_id?: string + /** 面试 ID */ + interview_id?: string + /** 最早开始时间，格式为时间戳 */ + start_time?: string + /** 最晚开始时间，格式为时间戳 */ + end_time?: string + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetByTalentHireInterviewQuery { + /** 人才 ID */ + talent_id: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' +} + +export interface GetHireInterviewRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetHireInterviewRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListHireInterviewRecordQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 面试评价ID列表，使用该筛选项时不会分页 */ + ids?: string[] + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListHireInterviewRecordQuery { + /** 面试评价ID列表，使用该筛选项时不会分页 */ + ids?: string[] + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetHireInterviewRecordAttachmentQuery { + /** 投递 ID */ + application_id: string + /** 面试记录 ID */ + interview_record_id?: string + /** 面试记录语言 */ + language?: 1 | 2 +} + +export interface GetHireMinutesQuery { + /** 面试ID */ + interview_id: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token获取查询结果 */ + page_token?: string + /** 分页大小，表示本次请求获取的速记中的语句的最大数量 */ + page_size?: number +} + +export interface ListHireQuestionnaireQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 投递 ID */ + application_id?: string + /** 面试 ID */ + interview_id?: string + /** 最早更新时间 */ + update_start_time?: string + /** 最晚更新时间 */ + update_end_time?: string +} + +export interface CreateHireOfferRequest { + /** 投递 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 CreateHireOfferQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface UpdateHireOfferRequest { + /** 模板 ID */ + schema_id: string + /** Offer 基本信息 */ + basic_info: OfferBasicInfo + /** Offer 薪资信息 */ + salary_info?: OfferSalaryInfo + /** 自定义信息 */ + customized_info_list?: OfferCustomizedInfo[] +} + +export interface UpdateHireOfferQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface OfferHireApplicationQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface GetHireOfferQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface ListHireOfferQuery { + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 人才 ID */ + talent_id: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface OfferStatusHireOfferRequest { + /** offer状态 */ + offer_status: 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 + /** offer 失效时间，当反馈状态是「offer已发出」时为必填项 */ + expiration_date?: string + /** 终止原因列表，当反馈状态是「候选人已拒绝」时为必填项；最多传入50个 */ + termination_reason_id_list?: string[] + /** 终止备注 */ + termination_reason_note?: string +} + +export interface InternOfferStatusHireOfferRequest { + /** 更新入/离职状态的操作 */ + operation: 'confirm_onboarding' | 'cancel_onboarding' | 'offboard' + /** 入职表单信息（当 operation 为 confirm_onboarding 时，该字段必填） */ + onboarding_info?: InternOfferOnboardingInfo + /** 离职表单信息（当 operation 为 offboard 时，该字段必填） */ + offboarding_info?: InternOfferOffboardingInfo +} + +export interface ListHireBackgroundCheckOrderQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 页码标识，获取第一页传空，每次查询会返回下一页的page_token */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 投递 ID */ + application_id?: string + /** 最早更新时间，毫秒级时间戳 */ + update_start_time?: string + /** 最晚更新时间，毫秒级时间戳 */ + update_end_time?: string +} + +export interface CreateHireTripartiteAgreementRequest { + /** 投递ID */ + application_id: string + /** 三方协议状态 */ + state: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 三方协议创建时间，毫秒时间戳 */ + create_time: string +} + +export interface ListHireTripartiteAgreementQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 投递 ID，必填投递 id 与三方协议 ID 其中之一 */ + application_id?: string + /** 三方协议 ID，必填投递 id 与三方协议 ID 其中之一 */ + tripartite_agreement_id?: string +} + +export interface UpdateHireTripartiteAgreementRequest { + /** 三方协议状态 */ + state: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 三方协议修改时间戳，不可小于创建时间或者当前修改时间 */ + modify_time: string +} + +export interface PatchHireEhrImportTaskRequest { + /** 失败原因 */ + fail_reason?: string + /** 跳转链接 */ + redirect_url?: string + /** 状态 */ + state: 1 | 2 +} + +export interface TransferOnboardHireApplicationRequest { + /** 实际入职时间 */ + actual_onboard_time?: number + /** 预期转正时间 */ + expected_conversion_time?: number + /** 招聘需求 ID */ + job_requirement_id?: string + /** 操作人 UserID */ + operator_id?: string + /** 候选人办公地点 ID ，枚举可通过接口「获取地址列表」获取，将用于候选人内推奖规则判断 */ + onboard_city_code?: string + /** 候选人入职部门 ID ，枚举可通过接口「获取部门信息列表」获取，将用于候选人内推奖规则判断 */ + department?: string + /** 候选人直属上级 UserID ，将用于候选人内推奖规则判断 */ + leader?: string + /** 候选人序列 ID ，枚举可通过接口「获取职务分类列表」获取，将用于候选人内推奖规则判断 */ + sequence?: string + /** 候选人职级 ID ，枚举可通过接口「获取职级列表」获取，将用于候选人内推奖规则判断 */ + level?: string + /** 候选人入职人员类型 ID，可通过接口人力资源管理平台「获取员工类型列表」获取，将用于候选人内推奖规则判断 */ + employee_type?: string +} + +export interface TransferOnboardHireApplicationQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_admin_department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface PatchHireEmployeeRequest { + /** 修改状态操作 */ + operation: 1 | 2 + conversion_info?: EmployeeConversionInfo + overboard_info?: EmployeeOverboardInfo +} + +export interface PatchHireEmployeeQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_admin_department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface GetByApplicationHireEmployeeQuery { + /** 投递ID */ + application_id: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_admin_department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface GetHireEmployeeQuery { + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门 ID 的类型 */ + department_id_type?: 'open_department_id' | 'department_id' | 'people_admin_department_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' + /** 此次调用中使用的「序列 ID」的类型 */ + job_family_id_type?: 'people_admin_job_category_id' | 'job_family_id' + /** 此次调用中使用的「人员类型 ID」的类型 */ + employee_type_id_type?: 'people_admin_employee_type_id' | 'employee_type_enum_id' +} + +export interface ListHireTodoQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: string + /** 用户 ID，当 token 为租户 token 时，必须传入该字段，当 token 为用户 token 时，不传该字段 */ + user_id?: string + /** 用户 ID 类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 待办类型 */ + type: 'evaluation' | 'offer' | 'exam' | 'interview' +} + +export interface ListHireEvaluationTaskQuery { + /** 分页大小, 默认10，不能超过 20 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID */ + user_id: string + /** 任务状态 */ + activity_status?: 1 | 2 | 3 + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ListHireExamMarkingTaskQuery { + /** 分页大小, 默认10，不能超过 20 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID */ + user_id: string + /** 任务状态 */ + activity_status?: 1 | 2 + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ListHireInterviewTaskQuery { + /** 分页大小, 默认10，不能超过 20 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户 ID */ + user_id: string + /** 任务状态 */ + activity_status?: 1 | 2 | 3 | 5 + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface CreateHireNoteRequest { + /** 人才ID */ + talent_id: string + /** 投递ID */ + application_id?: string + /** 创建人ID */ + creator_id?: string + /** 内容 */ + content: string + /** 备注私密属性（默认为公开） */ + privacy?: 1 | 2 + /** 是否通知被@的用户 */ + notify_mentioned_user?: boolean + /** 被@用户列表 */ + mention_entity_list?: MentionEntity[] +} + +export interface CreateHireNoteQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface PatchHireNoteRequest { + /** 备注内容 */ + content: string + /** 更新人 ID */ + operator_id?: string + /** 是否通知被@的用户 */ + notify_mentioned_user?: boolean + /** 被@用户列表 */ + mention_entity_list?: MentionEntity[] +} + +export interface PatchHireNoteQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface GetHireNoteQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ListHireNoteQuery { + /** 每页限制, 每页最大不超过100 */ + page_size?: number + /** 查询游标, 由上一页结果返回, 第一页不传 */ + page_token?: string + /** 人才ID */ + talent_id: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ListHireResumeSourceQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateHireEcoAccountCustomFieldRequest { + /** 适用范围 */ + scope: 1 | 2 + /** 自定义字段列表 */ + custom_field_list: EcoAccountCustomFieldData[] +} + +export interface BatchUpdateHireEcoAccountCustomFieldRequest { + /** 适用范围 */ + scope: 1 | 2 + /** 自定义字段列表 */ + custom_field_list: EcoAccountCustomFieldData[] +} + +export interface BatchDeleteHireEcoAccountCustomFieldRequest { + /** 适用范围 */ + scope: 1 | 2 + /** 要删除的自定义字段的 key 列表 */ + custom_field_key_list?: string[] +} + +export interface CreateHireEcoBackgroundCheckCustomFieldRequest { + /** 背调账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 自定义字段列表 */ + custom_field_list: EcoBackgroundCheckCustomFieldData[] +} + +export interface BatchUpdateHireEcoBackgroundCheckCustomFieldRequest { + /** 背调账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 自定义字段列表 */ + custom_field_list: EcoBackgroundCheckCustomFieldData[] +} + +export interface BatchDeleteHireEcoBackgroundCheckCustomFieldRequest { + /** 背调账号 ID，可在「账号绑定」事件中获取 */ + account_id: string +} + +export interface CreateHireEcoBackgroundCheckPackageRequest { + /** 背调账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 背调套餐列表 */ + package_list: EcoBackgroundCheckPackageData[] + /** 附加调查项列表 */ + additional_item_list?: EcoBackgroundCheckPackageAdditionalItem[] +} + +export interface BatchUpdateHireEcoBackgroundCheckPackageRequest { + /** 背调账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 背调套餐列表 */ + package_list: EcoBackgroundCheckPackageData[] + /** 附加调查项列表 */ + additional_item_list?: EcoBackgroundCheckPackageAdditionalItem[] +} + +export interface BatchDeleteHireEcoBackgroundCheckPackageRequest { + /** 背调账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 要删除的套餐 ID 列表，删除套餐不影响已安排的背调 */ + package_id_list?: string[] + /** 要删除的附加调查项 ID 列表，删除附加调查项不影响已安排的背调 */ + additional_item_id_list?: string[] +} + +export interface UpdateProgressHireEcoBackgroundCheckRequest { + /** 背调 ID，招聘侧的 ID */ + background_check_id: string + /** 阶段 ID，同一背调订单此 ID 不能重复 */ + stage_id: string + /** 背调阶段英文名称 */ + stage_en_name?: string + /** 背调阶段名称 */ + stage_name: string + /** 进入到此背调阶段的时间 */ + stage_time: string + /** 阶段性背调结果 */ + result?: string + /** 操作人角色，默认值为 1 */ + operator_role?: 1 | 2 + /** 报告列表 */ + report_file_list?: EcoBackgroundCheckReportFile[] +} + +export interface UpdateResultHireEcoBackgroundCheckRequest { + /** 背调 ID */ + background_check_id: string + /** 背调结果 */ + result: string + /** 背调结果时间 */ + result_time: string + /** 操作人角色，默认值为 1 */ + operator_role?: 1 | 2 + /** 报告列表 */ + report_file_list?: EcoBackgroundCheckReportFile[] +} + +export interface CancelHireEcoBackgroundCheckRequest { + /** 背调 ID */ + background_check_id: string +} + +export interface CreateHireEcoExamPaperRequest { + /** 账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 试卷列表 */ + paper_list: EcoExamPaperData[] +} + +export interface BatchUpdateHireEcoExamPaperRequest { + /** 账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 试卷列表 */ + paper_list: EcoExamPaperData[] +} + +export interface BatchDeleteHireEcoExamPaperRequest { + /** 背调账号 ID，可在「账号绑定」事件中获取 */ + account_id: string + /** 试卷 ID 列表 */ + paper_id_list: string[] +} + +export interface LoginInfoHireEcoExamRequest { + /** 状态码，0-成功 非零-错误码 */ + result?: number + /** 成功或失败的描述信息 */ + msg?: string + /** 笔试作答信息 */ + exam_login_info: EcoExamLoginInfo +} + +export interface UpdateResultHireEcoExamRequest { + /** 笔试结果 */ + result: string + /** 笔试结果时间 */ + result_time?: string + /** 报告列表 */ + report_list?: EcoExamResultReport[] + /** 详细评价结果 */ + detail_list?: EcoExamResultDetail[] +} + +export interface EnableHireReferralAccountRequest { + /** 账户 ID */ + referral_account_id?: string +} + +export interface EnableHireReferralAccountQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetAccountAssetsHireReferralAccountQuery { + /** 账户 ID */ + referral_account_id: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateHireReferralAccountRequest { + /** 电话 */ + mobile?: Mobile + /** 邮箱 */ + email?: string +} + +export interface CreateHireReferralAccountQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeactivateHireReferralAccountQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface WithdrawHireReferralAccountRequest { + /** 请求提现的奖励类型 */ + withdraw_bonus_type: 1 | 2[] + /** 提现单ID，请求时由请求方提供，后续关于本次提现操作的交互都以此提现单ID为标识进行，需要保证唯一,用于保证提现的幂等性，传入重复ID会返回对应提现单提取的金额明细 */ + external_order_id: string +} + +export interface ReconciliationHireReferralAccountRequest { + /** 按时间范围进行对账时 时间段的起始交易时间 */ + start_trans_time: string + /** 按时间范围进行对账时 时间段的截止交易时间 */ + end_trans_time: string + /** 交易信息 */ + trade_details?: TradeDetail[] +} + +export interface GetHireAttachmentQuery { + /** 附件类型 */ + type?: 1 | 2 | 3 +} + +export interface ListHireApplicationInterviewQuery { + /** 分页大小，不能超过 50 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 此次调用中使用的「职级 ID」的类型 */ + job_level_id_type?: 'people_admin_job_level_id' | 'job_level_id' +} + +export interface SearchHireTalentOperationLogRequest { + /** 职位 ID 列表 */ + job_id_list?: string[] + /** 操作人 ID 列表 */ + operator_id_list: string[] + /** 操作类型 ID 列表 */ + operation_list: number[] +} + +export interface SearchHireTalentOperationLogQuery { + /** 下一页页码 */ + page_token?: string + /** 每页获取记录数量，最大100 */ + page_size?: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetHireJobManagerQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface QueryHireLocationResponse { + /** 地址数据列表 */ + items?: LocationDto[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token,否则不返回 page_token */ + page_token?: string +} + +export interface ListHireLocationResponse { + /** 列表 */ + items?: Location[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetHireRoleResponse { + /** 角色详情 */ + role?: RoleDetail +} + +export interface ListHireRoleResponse { + /** 角色列表 */ + items?: Role[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListHireUserRoleResponse { + /** 用户角色列表 */ + items?: UserRole[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface CombinedCreateHireJobResponse { + /** 职位广告 */ + default_job_post?: CombinedJobResultDefaultJobPost + /** 职位 */ + 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 { + /** 职位负责人 */ + info?: JobRecruiter2 +} + +export interface ConfigHireJobResponse { + job_config?: JobConfigResult +} + +export interface ListHireJobResponse { + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 列表 */ + items?: Job[] +} + +export interface ListHireJobSchemaResponse { + /** 数据列表 */ + items?: JobSchema[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface SearchHireJobPublishRecordResponse { + /** 列表 */ + items?: WebsiteJobPost[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListHireJobFunctionResponse { + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 列表 */ + items?: JobFunction[] +} + +export interface ListHireJobTypeResponse { + /** 职位类别列表 */ + items?: JobTypeInfo[] + page_token?: string + has_more?: boolean +} + +export interface CreateHireJobRequirementResponse { + job_requirement?: JobRequirementDto +} + +export interface ListByIdHireJobRequirementResponse { + /** 招聘需求列表 */ + items?: JobRequirementDto[] +} + +export interface ListHireJobRequirementResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** 查询的招聘需求信息 */ + items?: JobRequirementDto[] +} + +export interface ListHireJobRequirementSchemaResponse { + /** 列表 */ + items?: JobRequirementSchema[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListHireJobProcessResponse { + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 列表 */ + items?: JobProcesses[] +} + +export interface ListHireSubjectResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** 项目列表 */ + items?: Subject[] +} + +export interface ListHireTalentTagResponse { + /** 标签列表 */ + items?: TalentTag[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface ListHireRegistrationSchemaResponse { + /** 信息登记表列表 */ + items?: RegistrationSchema[] + /** 分页标记 */ + page_token?: string + /** 是否仍有数据 */ + has_more?: boolean +} + +export interface ListHireInterviewFeedbackFormResponse { + items?: InterviewFeedbackForm[] + page_token?: string + has_more?: boolean +} + +export interface ListHireInterviewRoundTypeResponse { + /** 是否启用面试轮次类型 */ + active_status?: 1 | 2 + /** 列表 */ + items?: InterviewRoundType[] +} + +export interface ListHireInterviewRegistrationSchemaResponse { + /** 列表 */ + items?: InterviewRegistrationSchema[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListHireInterviewerResponse { + items?: Interviewer[] + page_token?: string + has_more?: boolean +} + +export interface PatchHireInterviewerResponse { + /** 面试官信息 */ + interviewer?: Interviewer +} + +export interface GetHireOfferApplicationFormResponse { + /** Offer 申请表详情 */ + offer_apply_form?: OfferApplyFormInfo +} + +export interface ListHireOfferApplicationFormResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** Offer 申请表列表 */ + items?: OfferApplyForm[] +} + +export interface SearchHireReferralResponse { + /** 内推信息列表 */ + items?: ReferralInfo[] +} + +export interface ListHireReferralWebsiteJobPostResponse { + /** 列表 */ + items?: PortalJobPost[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetHireReferralWebsiteJobPostResponse { + job_post?: PortalJobPost +} + +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 ListHireWebsiteChannelResponse { + /** 是否有更多数据 */ + has_more?: boolean + /** 分页token */ + page_token?: string + /** 官网推广渠道列表 */ + website_channel_list?: WebsiteChannelInfo[] +} + +export interface CreateHireWebsiteSiteUserResponse { + site_user?: WebsiteUser +} + +export interface GetHireWebsiteJobPostResponse { + job_post?: WebsiteJobPost +} + +export interface SearchHireWebsiteJobPostResponse { + /** 列表 */ + items?: WebsiteJobPost[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListHireWebsiteJobPostResponse { + /** 列表 */ + items?: WebsiteJobPost[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface CreateByResumeHireWebsiteDeliveryResponse { + delivery?: WebsiteDeliveryDto +} + +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 ListHireWebsiteResponse { + /** 列表 */ + items?: Website[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +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 GetAgencyAccountHireAgencyResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + items?: AgencyAccount[] +} + +export interface BatchQueryHireAgencyResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + items?: AgencySupplier[] +} + +export interface CreateHireTalentExternalInfoResponse { + /** 人才外部信息 */ + external_info?: TalentExternalInfo +} + +export interface UpdateHireTalentExternalInfoResponse { + /** 人才外部信息 */ + external_info?: TalentExternalInfo +} + +export interface CreateHireExternalApplicationResponse { + external_application?: ExternalApplication +} + +export interface UpdateHireExternalApplicationResponse { + external_application?: ExternalApplication +} + +export interface ListHireExternalApplicationResponse { + /** 外部投递列表 */ + items?: ExternalApplication[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface DeleteHireExternalApplicationResponse { + external_application?: ExternalApplication +} + +export interface CreateHireExternalInterviewResponse { + external_interview?: ExternalInterview +} + +export interface UpdateHireExternalInterviewResponse { + external_interview?: ExternalInterview +} + +export interface BatchQueryHireExternalInterviewResponse { + items?: ExternalInterview[] + page_token?: string + has_more?: boolean +} + +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 BatchQueryHireExternalOfferResponse { + items?: ExternalOffer[] + page_token?: string + has_more?: boolean +} + +export interface CreateHireExternalBackgroundCheckResponse { + external_background_check?: ExternalBackgroundCheck +} + +export interface UpdateHireExternalBackgroundCheckResponse { + external_background_check?: ExternalBackgroundCheck +} + +export interface BatchQueryHireExternalBackgroundCheckResponse { + items?: ExternalBackgroundCheck[] + page_token?: string + has_more?: boolean +} + +export interface CreateHireExternalReferralRewardResponse { + /** 创建的内推奖励的id */ + id?: string +} + +export interface SearchHireTalentPoolResponse { + /** 人才库列表 */ + items?: TalentPool[] + /** 分页标记 */ + page_token?: string + /** 是否有剩余数据 */ + has_more?: boolean +} + +export interface MoveTalentHireTalentPoolResponse { + /** 人才库ID */ + talent_pool_id?: string + /** 人才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 ListHireTalentFolderResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** 文件夹列表 */ + items?: TalentFolderForList[] +} + +export interface BatchGetIdHireTalentResponse { + /** 人才信息列表 */ + talent_list?: TalentBatchInfo[] +} + +export interface ListHireTalentResponse { + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 列表 */ + items?: Talent[] +} + +export interface QueryHireTalentObjectResponse { + items?: CommonSchema[] +} + +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 ListHireTerminationReasonResponse { + /** 列表 */ + items?: TerminationReason[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetHireApplicationResponse { + /** 投递数据 */ + application?: Application +} + +export interface ListHireApplicationResponse { + /** 投递数据列表 */ + items?: string[] + /** 游标, 翻下一页数据时使用 */ + page_token?: string + /** 是否还有下一页数据 */ + has_more?: boolean +} + +export interface SearchHireDiversityInclusionResponse { + /** 多元化与包容性信息列表 */ + items?: DiInfo[] +} + +export interface ListHireEvaluationResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** 简历评估信息列表 */ + items?: Evaluation[] +} + +export interface CreateHireExamResponse { + /** 笔试 ID */ + exam_id?: string + /** 投递 ID */ + application_id?: string + /** 试卷名称 */ + exam_resource_name?: string + /** 笔试分数 */ + score?: number + /** 附件ID */ + uuid?: string + /** 操作人 ID */ + operator_id?: string + /** 操作时间 */ + operate_time?: string +} + +export interface SearchHireTestResponse { + /** 笔试列表 */ + items?: Test[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListHireInterviewResponse { + /** 面试列表 */ + items?: InterviewExtend[] + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetByTalentHireInterviewResponse { + /** 投递面试列表 */ + items?: TalentInterview[] +} + +export interface GetHireInterviewRecordResponse { + /** 数据 */ + interview_record?: InterviewRecord +} + +export interface GetHireInterviewRecordResponse { + interview_record?: InterviewRecord +} + +export interface ListHireInterviewRecordResponse { + /** 面试评价详细信息列表 */ + items?: InterviewRecord[] + page_token?: string + has_more?: boolean +} + +export interface ListHireInterviewRecordResponse { + /** 面试评价详细信息列表 */ + items?: InterviewRecord[] + page_token?: string + has_more?: boolean +} + +export interface GetHireInterviewRecordAttachmentResponse { + /** 附件信息 */ + attachment?: AttachmentInfo +} + +export interface GetHireMinutesResponse { + minutes?: Minutes + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 对应面试是否还有更多项 */ + has_more?: boolean +} + +export interface ListHireQuestionnaireResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** 满意度评价列表 */ + items?: Questionnaire[] +} + +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 ListHireOfferResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** Offer 列表 */ + items?: OfferListInfo[] +} + +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 ListHireBackgroundCheckOrderResponse { + /** 是否有下一页 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string + /** 背调信息列表 */ + items?: BackgroundCheckOrder[] +} + +export interface CreateHireTripartiteAgreementResponse { + /** 创建的三方协议的 id */ + id?: string +} + +export interface ListHireTripartiteAgreementResponse { + items?: TripartiteAgreementInfo[] + page_token?: string + has_more?: boolean +} + +export interface UpdateHireTripartiteAgreementResponse { + /** 三方协议信息 */ + tripartite_agreement?: TripartiteAgreementInfo +} + +export interface TransferOnboardHireApplicationResponse { + /** employee */ + employee?: Employee +} + +export interface PatchHireEmployeeResponse { + /** 员工信息 */ + employee?: Employee +} + +export interface GetByApplicationHireEmployeeResponse { + /** 员工信息 */ + employee?: Employee +} + +export interface GetHireEmployeeResponse { + /** 员工信息 */ + employee?: Employee +} + +export interface ListHireTodoResponse { + /** 待办信息 */ + items?: Todo[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface ListHireEvaluationTaskResponse { + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 列表 */ + items?: EvaluationTask[] +} + +export interface ListHireExamMarkingTaskResponse { + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 列表 */ + items?: ExamMarkingTask[] +} + +export interface ListHireInterviewTaskResponse { + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 列表 */ + items?: InterviewTask[] +} + +export interface CreateHireNoteResponse { + note?: Note +} + +export interface PatchHireNoteResponse { + /** 备注数据 */ + note?: Note +} + +export interface GetHireNoteResponse { + /** 备注数据 */ + note?: Note +} + +export interface ListHireNoteResponse { + /** 备注数据列表 */ + items?: Note[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 游标, 翻下一页数据时使用 */ + page_token?: string +} + +export interface ListHireResumeSourceResponse { + items?: ResumeSource[] + page_token?: string + has_more?: boolean +} + +export interface EnableHireReferralAccountResponse { + /** 账号信息 */ + account?: Account +} + +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 ListHireApplicationInterviewResponse { + /** 分页标志 */ + page_token?: string + /** 是否有更多 */ + has_more?: boolean + /** 面试列表 */ + items?: Interview[] +} + +export interface SearchHireTalentOperationLogResponse { + /** 列表 */ + items?: TalentOperationLog[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 下一页页码 */ + page_token?: string +} + +export interface GetHireJobManagerResponse { + /** 职位负责人 */ + info?: JobManager +} + +export interface GetHireOfferSchemaResponse { + /** offer申请表ID */ + id?: string + /** offer申请表使用场景 */ + scenario?: 1 + /** 申请表版本 */ + version?: number + /** 字段对象信息 */ + object_list?: OfferSchemaDetail[] +} + +Internal.define({ + '/open-apis/hire/v1/locations/query': { + POST: 'queryHireLocation', + }, + '/open-apis/hire/v1/locations': { + GET: 'listHireLocation', + }, + '/open-apis/hire/v1/roles/{role_id}': { + GET: 'getHireRole', + }, + '/open-apis/hire/v1/roles': { + GET: 'listHireRole', + }, + '/open-apis/hire/v1/user_roles': { + GET: 'listHireUserRole', + }, + '/open-apis/hire/v1/jobs/combined_create': { + POST: 'combinedCreateHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}/combined_update': { + POST: 'combinedUpdateHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}/update_config': { + POST: 'updateConfigHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}/managers/batch_update': { + POST: 'batchUpdateHireJobManager', + }, + '/open-apis/hire/v1/jobs/{job_id}/get_detail': { + GET: 'getDetailHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}': { + GET: 'getHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}/recruiter': { + GET: 'recruiterHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}/config': { + GET: 'configHireJob', + }, + '/open-apis/hire/v1/jobs': { + GET: 'listHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}/close': { + POST: 'closeHireJob', + }, + '/open-apis/hire/v1/jobs/{job_id}/open': { + POST: 'openHireJob', + }, + '/open-apis/hire/v1/job_schemas': { + GET: 'listHireJobSchema', + }, + '/open-apis/hire/v1/advertisements/{advertisement_id}/publish': { + POST: 'publishHireAdvertisement', + }, + '/open-apis/hire/v1/job_publish_records/search': { + POST: 'searchHireJobPublishRecord', + }, + '/open-apis/hire/v1/job_functions': { + GET: 'listHireJobFunction', + }, + '/open-apis/hire/v1/job_types': { + GET: 'listHireJobType', + }, + '/open-apis/hire/v1/job_requirements': { + POST: 'createHireJobRequirement', + GET: 'listHireJobRequirement', + }, + '/open-apis/hire/v1/job_requirements/{job_requirement_id}': { + PUT: 'updateHireJobRequirement', + DELETE: 'deleteHireJobRequirement', + }, + '/open-apis/hire/v1/job_requirements/search': { + POST: 'listByIdHireJobRequirement', + }, + '/open-apis/hire/v1/job_requirement_schemas': { + GET: 'listHireJobRequirementSchema', + }, + '/open-apis/hire/v1/job_processes': { + GET: 'listHireJobProcess', + }, + '/open-apis/hire/v1/subjects': { + GET: 'listHireSubject', + }, + '/open-apis/hire/v1/talent_tags': { + GET: 'listHireTalentTag', + }, + '/open-apis/hire/v1/registration_schemas': { + GET: 'listHireRegistrationSchema', + }, + '/open-apis/hire/v1/interview_feedback_forms': { + GET: 'listHireInterviewFeedbackForm', + }, + '/open-apis/hire/v1/interview_round_types': { + GET: 'listHireInterviewRoundType', + }, + '/open-apis/hire/v1/interview_registration_schemas': { + GET: 'listHireInterviewRegistrationSchema', + }, + '/open-apis/hire/v1/interviewers': { + GET: 'listHireInterviewer', + }, + '/open-apis/hire/v1/interviewers/{interviewer_id}': { + PATCH: 'patchHireInterviewer', + }, + '/open-apis/hire/v1/offer_custom_fields/{offer_custom_field_id}': { + PUT: 'updateHireOfferCustomField', + }, + '/open-apis/hire/v1/offer_application_forms/{offer_application_form_id}': { + GET: 'getHireOfferApplicationForm', + }, + '/open-apis/hire/v1/offer_application_forms': { + GET: 'listHireOfferApplicationForm', + }, + '/open-apis/hire/v1/referrals/search': { + POST: 'searchHireReferral', + }, + '/open-apis/hire/v1/referral_websites/job_posts': { + GET: 'listHireReferralWebsiteJobPost', + }, + '/open-apis/hire/v1/referral_websites/job_posts/{job_post_id}': { + GET: 'getHireReferralWebsiteJobPost', + }, + '/open-apis/hire/v1/referrals/get_by_application': { + GET: 'getByApplicationHireReferral', + }, + '/open-apis/hire/v1/websites/{website_id}/channels': { + POST: 'createHireWebsiteChannel', + GET: 'listHireWebsiteChannel', + }, + '/open-apis/hire/v1/websites/{website_id}/channels/{channel_id}': { + DELETE: 'deleteHireWebsiteChannel', + PUT: 'updateHireWebsiteChannel', + }, + '/open-apis/hire/v1/websites/{website_id}/site_users': { + POST: 'createHireWebsiteSiteUser', + }, + '/open-apis/hire/v1/websites/{website_id}/job_posts/{job_post_id}': { + GET: 'getHireWebsiteJobPost', + }, + '/open-apis/hire/v1/websites/{website_id}/job_posts/search': { + POST: 'searchHireWebsiteJobPost', + }, + '/open-apis/hire/v1/websites/{website_id}/job_posts': { + GET: 'listHireWebsiteJobPost', + }, + '/open-apis/hire/v1/websites/{website_id}/deliveries/create_by_resume': { + POST: 'createByResumeHireWebsiteDelivery', + }, + '/open-apis/hire/v1/websites/{website_id}/deliveries/create_by_attachment': { + POST: 'createByAttachmentHireWebsiteDelivery', + }, + '/open-apis/hire/v1/websites/{website_id}/delivery_tasks/{delivery_task_id}': { + GET: 'getHireWebsiteDeliveryTask', + }, + '/open-apis/hire/v1/websites': { + GET: 'listHireWebsite', + }, + '/open-apis/hire/v1/agencies/protect': { + POST: 'protectHireAgency', + }, + '/open-apis/hire/v1/agencies/{agency_id}': { + GET: 'getHireAgency', + }, + '/open-apis/hire/v1/agencies/protection_period/search': { + POST: 'protectSearchHireAgency', + }, + '/open-apis/hire/v1/agencies/query': { + GET: 'queryHireAgency', + }, + '/open-apis/hire/v1/agencies/get_agency_account': { + POST: 'getAgencyAccountHireAgency', + }, + '/open-apis/hire/v1/agencies/batch_query': { + POST: 'batchQueryHireAgency', + }, + '/open-apis/hire/v1/agencies/operate_agency_account': { + POST: 'operateAgencyAccountHireAgency', + }, + '/open-apis/hire/v1/talents/{talent_id}/external_info': { + POST: 'createHireTalentExternalInfo', + PUT: 'updateHireTalentExternalInfo', + }, + '/open-apis/hire/v1/external_applications': { + POST: 'createHireExternalApplication', + GET: 'listHireExternalApplication', + }, + '/open-apis/hire/v1/external_applications/{external_application_id}': { + PUT: 'updateHireExternalApplication', + DELETE: 'deleteHireExternalApplication', + }, + '/open-apis/hire/v1/external_interviews': { + POST: 'createHireExternalInterview', + }, + '/open-apis/hire/v1/external_interviews/{external_interview_id}': { + PUT: 'updateHireExternalInterview', + DELETE: 'deleteHireExternalInterview', + }, + '/open-apis/hire/v1/external_interviews/batch_query': { + POST: 'batchQueryHireExternalInterview', + }, + '/open-apis/hire/v1/external_interview_assessments': { + POST: 'createHireExternalInterviewAssessment', + }, + '/open-apis/hire/v1/external_interview_assessments/{external_interview_assessment_id}': { + PATCH: 'patchHireExternalInterviewAssessment', + }, + '/open-apis/hire/v1/external_offers': { + POST: 'createHireExternalOffer', + }, + '/open-apis/hire/v1/external_offers/{external_offer_id}': { + PUT: 'updateHireExternalOffer', + DELETE: 'deleteHireExternalOffer', + }, + '/open-apis/hire/v1/external_offers/batch_query': { + POST: 'batchQueryHireExternalOffer', + }, + '/open-apis/hire/v1/external_background_checks': { + POST: 'createHireExternalBackgroundCheck', + }, + '/open-apis/hire/v1/external_background_checks/{external_background_check_id}': { + PUT: 'updateHireExternalBackgroundCheck', + DELETE: 'deleteHireExternalBackgroundCheck', + }, + '/open-apis/hire/v1/external_background_checks/batch_query': { + POST: 'batchQueryHireExternalBackgroundCheck', + }, + '/open-apis/hire/v1/external_referral_rewards': { + POST: 'createHireExternalReferralReward', + }, + '/open-apis/hire/v1/external_referral_rewards/{external_referral_reward_id}': { + DELETE: 'deleteHireExternalReferralReward', + }, + '/open-apis/hire/v1/talent_pools/{talent_pool_id}/batch_change_talent_pool': { + POST: 'batchChangeTalentPoolHireTalentPool', + }, + '/open-apis/hire/v1/talent_pools/': { + GET: 'searchHireTalentPool', + }, + '/open-apis/hire/v1/talent_pools/{talent_pool_id}/talent_relationship': { + POST: 'moveTalentHireTalentPool', + }, + '/open-apis/hire/v1/talents/{talent_id}/tag': { + POST: 'tagHireTalent', + }, + '/open-apis/hire/v1/talents/combined_create': { + POST: 'combinedCreateHireTalent', + }, + '/open-apis/hire/v1/talents/combined_update': { + POST: 'combinedUpdateHireTalent', + }, + '/open-apis/hire/v1/talents/add_to_folder': { + POST: 'addToFolderHireTalent', + }, + '/open-apis/hire/v1/talents/remove_to_folder': { + POST: 'removeToFolderHireTalent', + }, + '/open-apis/hire/v1/talent_folders': { + GET: 'listHireTalentFolder', + }, + '/open-apis/hire/v1/talents/batch_get_id': { + POST: 'batchGetIdHireTalent', + }, + '/open-apis/hire/v1/talents': { + GET: 'listHireTalent', + }, + '/open-apis/hire/v1/talent_objects/query': { + GET: 'queryHireTalentObject', + }, + '/open-apis/hire/v1/talents/{talent_id}': { + GET: 'getHireTalent', + }, + '/open-apis/hire/v2/talents/{talent_id}': { + GET: 'getHireTalent', + }, + '/open-apis/hire/v1/talents/{talent_id}/onboard_status': { + POST: 'onboardStatusHireTalent', + }, + '/open-apis/hire/v1/talent_blocklist/change_talent_block': { + POST: 'changeTalentBlockHireTalentBlocklist', + }, + '/open-apis/hire/v1/applications/{application_id}/get_detail': { + GET: 'getDetailHireApplication', + }, + '/open-apis/hire/v1/applications/{application_id}/recover': { + POST: 'recoverHireApplication', + }, + '/open-apis/hire/v1/applications': { + POST: 'createHireApplication', + GET: 'listHireApplication', + }, + '/open-apis/hire/v1/applications/{application_id}/terminate': { + POST: 'terminateHireApplication', + }, + '/open-apis/hire/v1/applications/{application_id}/transfer_stage': { + POST: 'transferStageHireApplication', + }, + '/open-apis/hire/v1/termination_reasons': { + GET: 'listHireTerminationReason', + }, + '/open-apis/hire/v1/applications/{application_id}': { + GET: 'getHireApplication', + }, + '/open-apis/hire/v1/applications/diversity_inclusions/search': { + POST: 'searchHireDiversityInclusion', + }, + '/open-apis/hire/v1/evaluations': { + GET: 'listHireEvaluation', + }, + '/open-apis/hire/v1/exams': { + POST: 'createHireExam', + }, + '/open-apis/hire/v1/tests/search': { + POST: 'searchHireTest', + }, + '/open-apis/hire/v1/interviews': { + GET: 'listHireInterview', + }, + '/open-apis/hire/v1/interviews/get_by_talent': { + GET: 'getByTalentHireInterview', + }, + '/open-apis/hire/v1/interview_records/{interview_record_id}': { + GET: 'getHireInterviewRecord', + }, + '/open-apis/hire/v2/interview_records/{interview_record_id}': { + GET: 'getHireInterviewRecord', + }, + '/open-apis/hire/v1/interview_records': { + GET: 'listHireInterviewRecord', + }, + '/open-apis/hire/v2/interview_records': { + GET: 'listHireInterviewRecord', + }, + '/open-apis/hire/v1/interview_records/attachments': { + GET: 'getHireInterviewRecordAttachment', + }, + '/open-apis/hire/v1/minutes': { + GET: 'getHireMinutes', + }, + '/open-apis/hire/v1/questionnaires': { + GET: 'listHireQuestionnaire', + }, + '/open-apis/hire/v1/offers': { + POST: 'createHireOffer', + GET: 'listHireOffer', + }, + '/open-apis/hire/v1/offers/{offer_id}': { + PUT: 'updateHireOffer', + GET: 'getHireOffer', + }, + '/open-apis/hire/v1/applications/{application_id}/offer': { + GET: 'offerHireApplication', + }, + '/open-apis/hire/v1/offers/{offer_id}/offer_status': { + PATCH: 'offerStatusHireOffer', + }, + '/open-apis/hire/v1/offers/{offer_id}/intern_offer_status': { + POST: 'internOfferStatusHireOffer', + }, + '/open-apis/hire/v1/background_check_orders': { + GET: 'listHireBackgroundCheckOrder', + }, + '/open-apis/hire/v1/tripartite_agreements': { + POST: 'createHireTripartiteAgreement', + GET: 'listHireTripartiteAgreement', + }, + '/open-apis/hire/v1/tripartite_agreements/{tripartite_agreement_id}': { + PUT: 'updateHireTripartiteAgreement', + DELETE: 'deleteHireTripartiteAgreement', + }, + '/open-apis/hire/v1/ehr_import_tasks/{ehr_import_task_id}': { + PATCH: 'patchHireEhrImportTask', + }, + '/open-apis/hire/v1/applications/{application_id}/transfer_onboard': { + POST: 'transferOnboardHireApplication', + }, + '/open-apis/hire/v1/employees/{employee_id}': { + PATCH: 'patchHireEmployee', + GET: 'getHireEmployee', + }, + '/open-apis/hire/v1/employees/get_by_application': { + GET: 'getByApplicationHireEmployee', + }, + '/open-apis/hire/v1/todos': { + GET: 'listHireTodo', + }, + '/open-apis/hire/v1/evaluation_tasks': { + GET: 'listHireEvaluationTask', + }, + '/open-apis/hire/v1/exam_marking_tasks': { + GET: 'listHireExamMarkingTask', + }, + '/open-apis/hire/v1/interview_tasks': { + GET: 'listHireInterviewTask', + }, + '/open-apis/hire/v1/notes': { + POST: 'createHireNote', + GET: 'listHireNote', + }, + '/open-apis/hire/v1/notes/{note_id}': { + PATCH: 'patchHireNote', + GET: 'getHireNote', + DELETE: 'deleteHireNote', + }, + '/open-apis/hire/v1/resume_sources': { + GET: 'listHireResumeSource', + }, + '/open-apis/hire/v1/eco_account_custom_fields': { + POST: 'createHireEcoAccountCustomField', + }, + '/open-apis/hire/v1/eco_account_custom_fields/batch_update': { + PATCH: 'batchUpdateHireEcoAccountCustomField', + }, + '/open-apis/hire/v1/eco_account_custom_fields/batch_delete': { + POST: 'batchDeleteHireEcoAccountCustomField', + }, + '/open-apis/hire/v1/eco_background_check_custom_fields': { + POST: 'createHireEcoBackgroundCheckCustomField', + }, + '/open-apis/hire/v1/eco_background_check_custom_fields/batch_update': { + PATCH: 'batchUpdateHireEcoBackgroundCheckCustomField', + }, + '/open-apis/hire/v1/eco_background_check_custom_fields/batch_delete': { + POST: 'batchDeleteHireEcoBackgroundCheckCustomField', + }, + '/open-apis/hire/v1/eco_background_check_packages': { + POST: 'createHireEcoBackgroundCheckPackage', + }, + '/open-apis/hire/v1/eco_background_check_packages/batch_update': { + PATCH: 'batchUpdateHireEcoBackgroundCheckPackage', + }, + '/open-apis/hire/v1/eco_background_check_packages/batch_delete': { + POST: 'batchDeleteHireEcoBackgroundCheckPackage', + }, + '/open-apis/hire/v1/eco_background_checks/update_progress': { + POST: 'updateProgressHireEcoBackgroundCheck', + }, + '/open-apis/hire/v1/eco_background_checks/update_result': { + POST: 'updateResultHireEcoBackgroundCheck', + }, + '/open-apis/hire/v1/eco_background_checks/cancel': { + POST: 'cancelHireEcoBackgroundCheck', + }, + '/open-apis/hire/v1/eco_exam_papers': { + POST: 'createHireEcoExamPaper', + }, + '/open-apis/hire/v1/eco_exam_papers/batch_update': { + PATCH: 'batchUpdateHireEcoExamPaper', + }, + '/open-apis/hire/v1/eco_exam_papers/batch_delete': { + POST: 'batchDeleteHireEcoExamPaper', + }, + '/open-apis/hire/v1/eco_exams/{exam_id}/login_info': { + POST: 'loginInfoHireEcoExam', + }, + '/open-apis/hire/v1/eco_exams/{exam_id}/update_result': { + POST: 'updateResultHireEcoExam', + }, + '/open-apis/hire/v1/referral_account/enable': { + POST: 'enableHireReferralAccount', + }, + '/open-apis/hire/v1/referral_account/get_account_assets': { + GET: 'getAccountAssetsHireReferralAccount', + }, + '/open-apis/hire/v1/referral_account': { + POST: 'createHireReferralAccount', + }, + '/open-apis/hire/v1/referral_account/{referral_account_id}/deactivate': { + POST: 'deactivateHireReferralAccount', + }, + '/open-apis/hire/v1/referral_account/{referral_account_id}/withdraw': { + POST: 'withdrawHireReferralAccount', + }, + '/open-apis/hire/v1/referral_account/reconciliation': { + POST: 'reconciliationHireReferralAccount', + }, + '/open-apis/hire/v1/attachments': { + POST: 'createHireAttachment', + }, + '/open-apis/hire/v1/attachments/{attachment_id}': { + GET: 'getHireAttachment', + }, + '/open-apis/hire/v1/attachments/{attachment_id}/preview': { + GET: 'previewHireAttachment', + }, + '/open-apis/hire/v1/applications/{application_id}/interviews': { + GET: 'listHireApplicationInterview', + }, + '/open-apis/hire/v1/talent_operation_logs/search': { + POST: 'searchHireTalentOperationLog', + }, + '/open-apis/hire/v1/jobs/{job_id}/managers/{manager_id}': { + GET: 'getHireJobManager', + }, + '/open-apis/hire/v1/offer_schemas/{offer_schema_id}': { + GET: 'getHireOfferSchema', + }, +}) diff --git a/adapters/lark/src/types/human_authentication.ts b/adapters/lark/src/types/human_authentication.ts new file mode 100644 index 00000000..e323870c --- /dev/null +++ b/adapters/lark/src/types/human_authentication.ts @@ -0,0 +1,38 @@ +import { Internal } from '../internal' + +declare module '../internal' { + interface Internal { + /** + * 录入身份信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/human_authentication-v1/identity/create + */ + createHumanAuthenticationIdentity(body: CreateHumanAuthenticationIdentityRequest, query?: CreateHumanAuthenticationIdentityQuery): Promise + } +} + +export interface CreateHumanAuthenticationIdentityRequest { + /** 姓名 */ + identity_name: string + /** 身份证号 */ + identity_code: string + /** 手机号 */ + mobile?: string +} + +export interface CreateHumanAuthenticationIdentityQuery { + /** 用户的唯一标识（使用的ID类型见下一参数描述，不同ID类型的区别和获取，参考文档：[如何获得 User ID、Open ID 和 Union ID？](/ssl:ttdoc/home/user-identity-introduction/how-to-get)） */ + user_id: string + /** 用户ID类型 open_id/user_id/union_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' +} + +export interface CreateHumanAuthenticationIdentityResponse { + /** uid of user bind authentication */ + verify_uid: string +} + +Internal.define({ + '/open-apis/human_authentication/v1/identities': { + POST: 'createHumanAuthenticationIdentity', + }, +}) diff --git a/adapters/lark/src/types/im.ts b/adapters/lark/src/types/im.ts new file mode 100644 index 00000000..4c06cacf --- /dev/null +++ b/adapters/lark/src/types/im.ts @@ -0,0 +1,1691 @@ +import { Internal } from '../internal' +import { BatchMessageReadUser, BatchMessageRecallProgress, BatchMessageSendProgress, ChatMenuItem, ChatMenuTree, ChatTab, ChatTopNotice, CreateTag, CreateTagFailReason, Emoji, FailedReason, FollowUp, I18nNames, ListChat, ListMember, ListModerator, Mention, Message, MessageBody, MessageReaction, OpenAppFeedCard, OpenAppFeedCardButtons, OpenFailedUserAppFeedCardItem, Operator, PatchTag, PatchTagFailReason, Pin, ReadUser, RestrictedModeSetting, Sender, TagInfo, TagInfoWithBindVersion, UserOpenAppFeedCardDeleter, UserOpenAppFeedCardUpdater } from '.' + +declare module '../internal' { + interface Internal { + /** + * 发送消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create + */ + createImMessage(body: CreateImMessageRequest, query?: CreateImMessageQuery): Promise + /** + * 回复消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/reply + */ + replyImMessage(message_id: string, body: ReplyImMessageRequest): Promise + /** + * 编辑消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/update + */ + updateImMessage(message_id: string, body: UpdateImMessageRequest): Promise + /** + * 转发消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/forward + */ + forwardImMessage(message_id: string, body: ForwardImMessageRequest, query?: ForwardImMessageQuery): Promise + /** + * 合并转发消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/merge_forward + */ + mergeForwardImMessage(body: MergeForwardImMessageRequest, query?: MergeForwardImMessageQuery): Promise + /** + * 转发话题 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/thread/forward + */ + forwardImThread(thread_id: string, body: ForwardImThreadRequest, query?: ForwardImThreadQuery): Promise + /** + * 撤回消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete + */ + deleteImMessage(message_id: string): Promise + /** + * 添加跟随气泡 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/push_follow_up + */ + pushFollowUpImMessage(message_id: string, body: PushFollowUpImMessageRequest): Promise + /** + * 查询消息已读信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users + */ + readUsersImMessage(message_id: string, query?: ReadUsersImMessageQuery): Promise + /** + * 获取会话历史消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list + */ + listImMessage(query?: ListImMessageQuery): Promise + /** + * 获取消息中的资源文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get + */ + getImMessageResource(message_id: string, file_key: string, query?: GetImMessageResourceQuery): Promise + /** + * 获取指定消息的内容 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/get + */ + getImMessage(message_id: string, query?: GetImMessageQuery): Promise + /** + * 批量撤回消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete + */ + deleteImBatchMessage(batch_message_id: string): Promise + /** + * 查询批量消息推送和阅读人数 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user + */ + readUserImBatchMessage(batch_message_id: string): Promise + /** + * 查询批量消息整体进度 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/get_progress + */ + getProgressImBatchMessage(batch_message_id: string): Promise + /** + * 上传图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create + */ + createImImage(form: CreateImImageForm): Promise + /** + * 下载图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get + */ + getImImage(image_key: string): Promise + /** + * 上传文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/create + */ + createImFile(form: CreateImFileForm): Promise + /** + * 下载文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/get + */ + getImFile(file_key: string): Promise + /** + * 发送应用内加急 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_app + */ + urgentAppImMessage(message_id: string, body: UrgentAppImMessageRequest, query?: UrgentAppImMessageQuery): Promise + /** + * 发送短信加急 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_sms + */ + urgentSmsImMessage(message_id: string, body: UrgentSmsImMessageRequest, query?: UrgentSmsImMessageQuery): Promise + /** + * 发送电话加急 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_phone + */ + urgentPhoneImMessage(message_id: string, body: UrgentPhoneImMessageRequest, query?: UrgentPhoneImMessageQuery): Promise + /** + * 添加消息表情回复 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create + */ + createImMessageReaction(message_id: string, body: CreateImMessageReactionRequest): Promise + /** + * 获取消息表情回复 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list + */ + listImMessageReaction(message_id: string, query?: ListImMessageReactionQuery): Promise + /** + * 删除消息表情回复 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete + */ + deleteImMessageReaction(message_id: string, reaction_id: string): Promise + /** + * Pin 消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/create + */ + createImPin(body: CreateImPinRequest): Promise + /** + * 移除 Pin 消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/delete + */ + deleteImPin(message_id: string): Promise + /** + * 获取群内 Pin 消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list + */ + listImPin(query?: ListImPinQuery): Promise + /** + * 更新应用发送的消息卡片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/patch + */ + patchImMessage(message_id: string, body: PatchImMessageRequest): Promise + /** + * 更新 URL 预览 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/url_preview/batch_update + */ + batchUpdateImUrlPreview(body: BatchUpdateImUrlPreviewRequest): Promise + /** + * 创建群 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create + */ + createImChat(body: CreateImChatRequest, query?: CreateImChatQuery): Promise + /** + * 解散群 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete + */ + deleteImChat(chat_id: string): Promise + /** + * 更新群信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update + */ + updateImChat(chat_id: string, body: UpdateImChatRequest, query?: UpdateImChatQuery): Promise + /** + * 更新群发言权限 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/update + */ + updateImChatModeration(chat_id: string, body: UpdateImChatModerationRequest, query?: UpdateImChatModerationQuery): Promise + /** + * 获取群信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get + */ + getImChat(chat_id: string, query?: GetImChatQuery): Promise + /** + * 更新群置顶 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/put_top_notice + */ + putTopNoticeImChatTopNotice(chat_id: string, body: PutTopNoticeImChatTopNoticeRequest): Promise + /** + * 撤销群置顶 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/delete_top_notice + */ + deleteTopNoticeImChatTopNotice(chat_id: string): Promise + /** + * 获取用户或机器人所在的群列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list + */ + listImChat(query?: ListImChatQuery): Promise + /** + * 搜索对用户或机器人可见的群列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search + */ + searchImChat(query?: SearchImChatQuery): Promise + /** + * 获取群成员发言权限 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get + */ + getImChatModeration(chat_id: string, query?: GetImChatModerationQuery): Promise + /** + * 获取群分享链接 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link + */ + linkImChat(chat_id: string, body: LinkImChatRequest): Promise + /** + * 指定群管理员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/add_managers + */ + addManagersImChatManagers(chat_id: string, body: AddManagersImChatManagersRequest, query?: AddManagersImChatManagersQuery): Promise + /** + * 删除群管理员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/delete_managers + */ + deleteManagersImChatManagers(chat_id: string, body: DeleteManagersImChatManagersRequest, query?: DeleteManagersImChatManagersQuery): Promise + /** + * 将用户或机器人拉入群聊 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create + */ + createImChatMembers(chat_id: string, body: CreateImChatMembersRequest, query?: CreateImChatMembersQuery): Promise + /** + * 用户或机器人主动加入群聊 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join + */ + meJoinImChatMembers(chat_id: string): Promise + /** + * 将用户或机器人移出群聊 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete + */ + deleteImChatMembers(chat_id: string, body: DeleteImChatMembersRequest, query?: DeleteImChatMembersQuery): Promise + /** + * 获取群成员列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get + */ + getImChatMembers(chat_id: string, query?: GetImChatMembersQuery): Promise + /** + * 判断用户或机器人是否在群里 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat + */ + isInChatImChatMembers(chat_id: string): Promise + /** + * 更新群公告信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/patch + */ + patchImChatAnnouncement(chat_id: string, body: PatchImChatAnnouncementRequest): Promise + /** + * 获取群公告信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get + */ + getImChatAnnouncement(chat_id: string, query?: GetImChatAnnouncementQuery): Promise + /** + * 添加会话标签页 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create + */ + createImChatTab(chat_id: string, body: CreateImChatTabRequest): Promise + /** + * 删除会话标签页 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/delete_tabs + */ + deleteTabsImChatTab(chat_id: string, body: DeleteTabsImChatTabRequest): Promise + /** + * 更新会话标签页 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/update_tabs + */ + updateTabsImChatTab(chat_id: string, body: UpdateTabsImChatTabRequest): Promise + /** + * 会话标签页排序 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/sort_tabs + */ + sortTabsImChatTab(chat_id: string, body: SortTabsImChatTabRequest): Promise + /** + * 拉取会话标签页 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs + */ + listTabsImChatTab(chat_id: string): Promise + /** + * 添加群菜单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/create + */ + createImChatMenuTree(chat_id: string, body: CreateImChatMenuTreeRequest): Promise + /** + * 删除群菜单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/delete + */ + deleteImChatMenuTree(chat_id: string, body: DeleteImChatMenuTreeRequest): Promise + /** + * 修改群菜单元信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_item/patch + */ + patchImChatMenuItem(chat_id: string, menu_item_id: string, body: PatchImChatMenuItemRequest): Promise + /** + * 排序群菜单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/sort + */ + sortImChatMenuTree(chat_id: string, body: SortImChatMenuTreeRequest): Promise + /** + * 获取群菜单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get + */ + getImChatMenuTree(chat_id: string): Promise + /** + * 创建应用消息流卡片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card/create + */ + createImAppFeedCard(body: CreateImAppFeedCardRequest, query?: CreateImAppFeedCardQuery): Promise + /** + * 更新应用消息流卡片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/update + */ + updateImAppFeedCardBatch(body: UpdateImAppFeedCardBatchRequest, query?: UpdateImAppFeedCardBatchQuery): Promise + /** + * 删除应用消息流卡片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/delete + */ + deleteImAppFeedCardBatch(body: DeleteImAppFeedCardBatchRequest, query?: DeleteImAppFeedCardBatchQuery): Promise + /** + * 机器人单聊即时提醒 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/bot_time_sentive + */ + botTimeSentiveImFeedCard(body: BotTimeSentiveImFeedCardRequest, query?: BotTimeSentiveImFeedCardQuery): Promise + /** + * 更新消息流卡片按钮 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/chat_button/update + */ + updateImChatButton(body: UpdateImChatButtonRequest, query?: UpdateImChatButtonQuery): Promise + /** + * 即时提醒 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/patch + */ + patchImFeedCard(feed_card_id: string, body: PatchImFeedCardRequest, query?: PatchImFeedCardQuery): Promise + /** + * 查询实体与标签的绑定关系 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/get + */ + getImBizEntityTagRelation(query?: GetImBizEntityTagRelationQuery): Promise + /** + * 创建标签 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/create + */ + createImTag(body: CreateImTagRequest): Promise + /** + * 修改标签 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/patch + */ + patchImTag(tag_id: string, body: PatchImTagRequest): Promise + /** + * 绑定标签到群 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/create + */ + createImBizEntityTagRelation(body: CreateImBizEntityTagRelationRequest): Promise + /** + * 解绑标签与群 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/update + */ + updateImBizEntityTagRelation(body: UpdateImBizEntityTagRelationRequest): Promise + } +} + +export interface CreateImMessageRequest { + /** 依据receive_id_type的值，填写对应的消息接收者id */ + receive_id: string + /** 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，类型定义请参考[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */ + msg_type: string + /** 消息内容，json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等，具体格式说明参考：[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)请求体大小限制：- 文本消息请求体最大不能超过150KB- 卡片及富文本消息请求体最大不能超过30KB */ + content: string + /** 由开发者生成的唯一字符串序列，用于发送消息请求去重；持有相同uuid的请求1小时内至多成功执行一次 */ + uuid?: string +} + +export interface CreateImMessageQuery { + /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */ + 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 { + /** 此次调用中使用的用户ID的类型 */ + user_id_type: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的分页的大小 */ + page_size?: number + /** 下一页分页的token */ + page_token?: string +} + +export interface ListImMessageQuery { + /** 容器类型 ，目前可选值仅有"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' + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string +} + +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 { + /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数，表示拉取所有类型reaction */ + reaction_type?: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时，会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number + /** 当操作人为用户时返回用户ID的类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface CreateImPinRequest { + /** 待Pin的消息ID */ + message_id: string +} + +export interface ListImPinQuery { + /** 待获取Pin消息的Chat ID */ + chat_id: string + /** Pin信息的起始时间（毫秒级时间戳） */ + start_time?: string + /** Pin信息的结束时间（毫秒级时间戳） */ + end_time?: string + /** 此次调用中使用的分页的大小 */ + page_size?: number + /** 下一页分页的token */ + page_token?: 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 { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 群组排序方式 */ + sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface SearchImChatQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 关键词。注意：如果query为空值将返回空的结果 */ + query?: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface GetImChatModerationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +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 { + /** 群成员 用户 ID 类型，详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */ + member_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface PatchImChatAnnouncementRequest { + /** 文档当前版本号 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 + /** 根消息id open_message_id */ + root_id?: string + /** 父消息的id open_message_id */ + parent_id?: string + /** 消息所属的话题 ID */ + thread_id?: string + /** 消息类型 text post card image等等 */ + msg_type?: string + /** 消息生成的时间戳(毫秒) */ + create_time?: string + /** 消息更新的时间戳 */ + update_time?: string + /** 消息是否被撤回 */ + deleted?: boolean + /** 消息是否被更新 */ + updated?: boolean + /** 所属的群 */ + chat_id?: string + /** 发送者，可以是用户或应用 */ + sender?: Sender + /** 消息内容,json结构 */ + body?: MessageBody + /** 被艾特的人或应用的id */ + mentions?: Mention[] + /** 合并消息的上一层级消息id open_message_id */ + upper_message_id?: string +} + +export interface ReplyImMessageResponse { + /** 消息id open_message_id */ + message_id?: string + /** 根消息id open_message_id */ + root_id?: string + /** 父消息的id open_message_id */ + parent_id?: string + /** 消息所属的话题 ID */ + thread_id?: string + /** 消息类型 text post card image等等 */ + msg_type?: string + /** 消息生成的时间戳(毫秒) */ + create_time?: string + /** 消息更新的时间戳 */ + update_time?: string + /** 消息是否被撤回 */ + deleted?: boolean + /** 消息是否被更新 */ + updated?: boolean + /** 所属的群 */ + chat_id?: string + /** 发送者，可以是用户或应用 */ + sender?: Sender + /** 消息内容,json结构 */ + body?: MessageBody + /** 被艾特的人或应用的id */ + mentions?: Mention[] + /** 合并消息的上一层级消息id open_message_id */ + upper_message_id?: string +} + +export interface UpdateImMessageResponse { + /** 消息id open_message_id */ + message_id?: string + /** 根消息id open_message_id */ + root_id?: string + /** 父消息的id open_message_id */ + parent_id?: string + /** 消息所属的话题 ID */ + thread_id?: string + /** 消息类型 text post card image等等 */ + msg_type?: string + /** 消息生成的时间戳(毫秒) */ + create_time?: string + /** 消息更新的时间戳 */ + update_time?: string + /** 消息是否被撤回 */ + deleted?: boolean + /** 消息是否被更新 */ + updated?: boolean + /** 所属的群 */ + chat_id?: string + /** 发送者，可以是用户或应用 */ + sender?: Sender + /** 消息内容,json结构 */ + body?: MessageBody + /** 被艾特的人或应用的id */ + mentions?: Mention[] + /** 合并消息的上一层级消息id open_message_id */ + upper_message_id?: string +} + +export interface ForwardImMessageResponse { + /** 消息id open_message_id */ + message_id?: string + /** 根消息id open_message_id */ + root_id?: string + /** 父消息的id open_message_id */ + parent_id?: string + /** 消息所属的话题 ID */ + thread_id?: string + /** 消息类型 text post card image等等 */ + msg_type?: string + /** 消息生成的时间戳(毫秒) */ + create_time?: string + /** 消息更新的时间戳 */ + update_time?: string + /** 消息是否被撤回 */ + deleted?: boolean + /** 消息是否被更新 */ + updated?: boolean + /** 所属的群 */ + chat_id?: string + /** 发送者，可以是用户或应用 */ + sender?: Sender + /** 消息内容,json结构 */ + body?: MessageBody + /** 被艾特的人或应用的id */ + mentions?: Mention[] + /** 合并消息的上一层级消息id open_message_id */ + upper_message_id?: string +} + +export interface MergeForwardImMessageResponse { + /** 合并转发生成的新消息 */ + message?: Message + /** 无效的消息ID列表 */ + invalid_message_id_list?: string[] +} + +export interface ForwardImThreadResponse { + /** 消息id open_message_id */ + message_id?: string + /** 根消息id open_message_id */ + root_id?: string + /** 父消息的id open_message_id */ + parent_id?: string + /** 消息所属的话题 ID */ + thread_id?: string + /** 消息类型 text post card image等等 */ + msg_type?: string + /** 消息生成的时间戳(毫秒) */ + create_time?: string + /** 消息更新的时间戳 */ + update_time?: string + /** 消息是否被撤回 */ + deleted?: boolean + /** 消息是否被更新 */ + updated?: boolean + /** 所属的群 */ + chat_id?: string + /** 发送者，可以是用户或应用 */ + sender?: Sender + /** 消息内容,json结构 */ + body?: MessageBody + /** 被艾特的人或应用的id */ + mentions?: Mention[] + /** 合并消息的上一层级消息id open_message_id */ + upper_message_id?: string +} + +export interface ReadUsersImMessageResponse { + /** read_user[] */ + items?: ReadUser[] + /** 是否还有下一页 */ + has_more: boolean + /** 下一页分页的token */ + page_token?: string +} + +export interface ListImMessageResponse { + /** 是否还有后续翻页 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** message[] */ + items?: Message[] +} + +export interface GetImMessageResponse { + /** message[] */ + items?: Message[] +} + +export interface ReadUserImBatchMessageResponse { + read_user?: BatchMessageReadUser +} + +export interface GetProgressImBatchMessageResponse { + /** 消息发送进度 */ + batch_message_send_progress?: BatchMessageSendProgress + /** 消息撤回进度 */ + batch_message_recall_progress?: BatchMessageRecallProgress +} + +export interface CreateImImageResponse { + /** 图片的key */ + image_key?: string +} + +export interface CreateImFileResponse { + /** 文件的key */ + file_key?: string +} + +export interface UrgentAppImMessageResponse { + /** 无效的用户id */ + invalid_user_id_list: string[] +} + +export interface UrgentSmsImMessageResponse { + /** 无效的用户id */ + invalid_user_id_list: string[] +} + +export interface UrgentPhoneImMessageResponse { + /** 无效的用户id */ + invalid_user_id_list: string[] +} + +export interface CreateImMessageReactionResponse { + /** reaction资源ID */ + reaction_id?: string + /** 添加reaction的操作人 */ + operator?: Operator + /** reaction动作的的unix timestamp(单位:ms) */ + action_time?: string + /** reaction资源类型 */ + reaction_type?: Emoji +} + +export interface ListImMessageReactionResponse { + /** 查询指定reaction_type返回的reaction列表 */ + items: MessageReaction[] + /** 是否还有后续翻页 */ + has_more: boolean + /** 下一页分页的token */ + page_token: string +} + +export interface DeleteImMessageReactionResponse { + /** reaction资源ID */ + reaction_id?: string + /** 添加reaction的操作人 */ + operator?: Operator + /** reaction动作的的unix timestamp(单位:ms) */ + action_time?: string + /** reaction资源类型 */ + reaction_type?: Emoji +} + +export interface CreateImPinResponse { + pin?: Pin +} + +export interface ListImPinResponse { + /** Pin的操作信息 */ + items?: Pin[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface CreateImChatResponse { + /** 群ID */ + chat_id?: string + /** 群头像URL */ + avatar?: string + /** 群名称 */ + name?: string + /** 群描述 */ + description?: string + /** 群国际化名称 */ + i18n_names?: I18nNames + /** 群主 ID */ + owner_id?: string + /** 群主 ID 类型 */ + owner_id_type?: string + /** 谁可以加急 */ + urgent_setting?: 'only_owner' | 'all_members' + /** 谁可以发起视频会议 */ + video_conference_setting?: 'only_owner' | 'all_members' + /** 加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 + /** 群消息模式 */ + group_message_type?: string + /** 群模式 */ + chat_mode?: string + /** 群类型 */ + chat_type?: string + /** 优先级最高的一个群tag */ + chat_tag?: string + /** 是否是外部群 */ + external?: boolean + /** tenant key */ + tenant_key?: string + /** 入群消息可见性 */ + join_message_visibility?: string + /** 出群消息可见性 */ + leave_message_visibility?: string + /** 加群审批 */ + membership_approval?: string + /** 发言权限 */ + moderation_permission?: string + /** 防泄密模式设置 */ + restricted_mode_setting?: RestrictedModeSetting + /** 隐藏群成员人数设置 */ + hide_member_count_setting?: 'all_members' | 'only_owner' +} + +export interface GetImChatResponse { + /** 群头像URL */ + 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的类型(open_id/user_id/union_id) */ + owner_id_type?: string + /** 群主ID */ + owner_id?: string + /** 用户管理员列表 */ + user_manager_id_list?: string[] + /** 机器人管理员列表 */ + bot_manager_id_list?: string[] + /** 群消息模式 */ + group_message_type?: string + /** 群模式 */ + chat_mode?: string + /** 群类型 */ + chat_type?: string + /** 优先级最高的一个群tag */ + chat_tag?: string + /** 入群消息可见性 */ + join_message_visibility?: string + /** 出群消息可见性 */ + leave_message_visibility?: string + /** 加群审批 */ + membership_approval?: string + /** 发言权限 */ + moderation_permission?: string + /** 是否是外部群 */ + external?: boolean + /** tenant key */ + tenant_key?: string + /** 群成员人数 */ + user_count?: string + /** 群机器人数 */ + bot_count?: string + /** 防泄密模式设置 */ + restricted_mode_setting?: RestrictedModeSetting + /** 谁可以加急 */ + urgent_setting?: 'only_owner' | 'all_members' + /** 谁可以发起视频会议 */ + video_conference_setting?: 'only_owner' | 'all_members' + /** 隐藏群成员人数设置 */ + hide_member_count_setting?: 'all_members' | 'only_owner' + /** 群状态 */ + chat_status?: 'normal' | 'dissolved' | 'dissolved_save' +} + +export interface ListImChatResponse { + /** chat列表 */ + items?: ListChat[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface SearchImChatResponse { + /** chat列表 */ + items?: ListChat[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多群组 */ + has_more?: boolean +} + +export interface GetImChatModerationResponse { + /** 群发言模式 */ + moderation_setting?: string + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean + /** 可发言用户列表 */ + items?: ListModerator[] +} + +export interface LinkImChatResponse { + /** 群分享链接 */ + share_link?: string + /** 分享链接过期时间戳（秒级） */ + expire_time?: string + /** 分享链接是否永久有效 */ + is_permanent?: boolean +} + +export interface AddManagersImChatManagersResponse { + /** 群目前的管理员id */ + chat_managers?: string[] + /** 群目前的管理员bot id */ + chat_bot_managers?: string[] +} + +export interface DeleteManagersImChatManagersResponse { + /** 群目前的管理员id */ + chat_managers?: string[] + /** 群目前的管理员bot id */ + chat_bot_managers?: string[] +} + +export interface CreateImChatMembersResponse { + /** ID无效的成员列表 */ + invalid_id_list?: string[] + /** ID不存在的成员列表 */ + not_existed_id_list?: string[] + /** 等待群主或管理员审批的成员ID列表 */ + pending_approval_id_list?: string[] +} + +export interface DeleteImChatMembersResponse { + /** 无效成员列表 */ + invalid_id_list?: string[] +} + +export interface GetImChatMembersResponse { + /** member列表 */ + items?: ListMember[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean + /** 成员总数 */ + member_total?: number +} + +export interface IsInChatImChatMembersResponse { + /** 用户或者机器人是否在群中 */ + is_in_chat?: boolean +} + +export interface GetImChatAnnouncementResponse { + /** CCM 文档序列化信息 */ + content?: string + /** 文档当前版本号 纯数字 */ + revision?: string + /** 文档生成的时间戳（秒） */ + create_time?: string + /** 消息更新的时间戳（秒） */ + update_time?: string + /** 文档所有者id类型， open_id/user_id/union_id/app_id */ + owner_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' + /** 文档所有者id */ + owner_id?: string + /** 文档最新修改者id类型， open_id/user_id/union_id/app_id */ + modifier_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id' + /** 文档最新修改者id */ + modifier_id?: string +} + +export interface CreateImChatTabResponse { + /** 群标签列表 */ + chat_tabs?: ChatTab[] +} + +export interface DeleteTabsImChatTabResponse { + /** 群标签列表 */ + chat_tabs?: ChatTab[] +} + +export interface UpdateTabsImChatTabResponse { + /** 群标签列表 */ + chat_tabs?: ChatTab[] +} + +export interface SortTabsImChatTabResponse { + /** 群标签列表 */ + chat_tabs?: ChatTab[] +} + +export interface ListTabsImChatTabResponse { + /** 会话标签页 */ + chat_tabs?: ChatTab[] +} + +export interface CreateImChatMenuTreeResponse { + /** 追加后群内现有菜单 */ + menu_tree?: ChatMenuTree +} + +export interface DeleteImChatMenuTreeResponse { + /** 群内现有菜单 */ + menu_tree?: ChatMenuTree +} + +export interface PatchImChatMenuItemResponse { + chat_menu_item?: ChatMenuItem +} + +export interface SortImChatMenuTreeResponse { + /** 排序后群内菜单 */ + menu_tree?: ChatMenuTree +} + +export interface GetImChatMenuTreeResponse { + /** 群内所有菜单 */ + menu_tree?: ChatMenuTree +} + +export interface CreateImAppFeedCardResponse { + /** 失败的卡片 */ + failed_cards?: OpenFailedUserAppFeedCardItem[] + /** 卡片业务 ID */ + biz_id?: string +} + +export interface UpdateImAppFeedCardBatchResponse { + /** 失败的卡片 */ + failed_cards?: OpenFailedUserAppFeedCardItem[] +} + +export interface DeleteImAppFeedCardBatchResponse { + /** 失败的卡片 */ + failed_cards?: OpenFailedUserAppFeedCardItem[] +} + +export interface BotTimeSentiveImFeedCardResponse { + /** 失败原因 */ + failed_user_reasons?: FailedReason[] +} + +export interface UpdateImChatButtonResponse { + /** 失败的用户 */ + failed_user_reasons?: FailedReason[] +} + +export interface PatchImFeedCardResponse { + /** 失败原因 */ + failed_user_reasons?: FailedReason[] +} + +export interface GetImBizEntityTagRelationResponse { + /** 标签内容及绑定时间 */ + tag_info_with_bind_versions?: TagInfoWithBindVersion[] +} + +export interface CreateImTagResponse { + /** 创建的tagid */ + id?: string + /** 创建失败原因 */ + create_tag_fail_reason?: CreateTagFailReason +} + +export interface PatchImTagResponse { + /** 编辑后的taginfo */ + tag_info?: TagInfo + /** 修改失败原因 */ + patch_tag_fail_reason?: PatchTagFailReason +} + +Internal.define({ + '/open-apis/im/v1/messages': { + POST: 'createImMessage', + GET: 'listImMessage', + }, + '/open-apis/im/v1/messages/{message_id}/reply': { + POST: 'replyImMessage', + }, + '/open-apis/im/v1/messages/{message_id}': { + PUT: 'updateImMessage', + DELETE: 'deleteImMessage', + GET: 'getImMessage', + PATCH: 'patchImMessage', + }, + '/open-apis/im/v1/messages/{message_id}/forward': { + POST: 'forwardImMessage', + }, + '/open-apis/im/v1/messages/merge_forward': { + POST: 'mergeForwardImMessage', + }, + '/open-apis/im/v1/threads/{thread_id}/forward': { + POST: 'forwardImThread', + }, + '/open-apis/im/v1/messages/{message_id}/push_follow_up': { + POST: 'pushFollowUpImMessage', + }, + '/open-apis/im/v1/messages/{message_id}/read_users': { + GET: 'readUsersImMessage', + }, + '/open-apis/im/v1/messages/{message_id}/resources/{file_key}': { + GET: { name: 'getImMessageResource', type: 'binary' }, + }, + '/open-apis/im/v1/batch_messages/{batch_message_id}': { + DELETE: 'deleteImBatchMessage', + }, + '/open-apis/im/v1/batch_messages/{batch_message_id}/read_user': { + GET: 'readUserImBatchMessage', + }, + '/open-apis/im/v1/batch_messages/{batch_message_id}/get_progress': { + GET: 'getProgressImBatchMessage', + }, + '/open-apis/im/v1/images': { + POST: { name: 'createImImage', multipart: true }, + }, + '/open-apis/im/v1/images/{image_key}': { + GET: { name: 'getImImage', type: 'binary' }, + }, + '/open-apis/im/v1/files': { + POST: { name: 'createImFile', multipart: true }, + }, + '/open-apis/im/v1/files/{file_key}': { + GET: { name: 'getImFile', type: 'binary' }, + }, + '/open-apis/im/v1/messages/{message_id}/urgent_app': { + PATCH: 'urgentAppImMessage', + }, + '/open-apis/im/v1/messages/{message_id}/urgent_sms': { + PATCH: 'urgentSmsImMessage', + }, + '/open-apis/im/v1/messages/{message_id}/urgent_phone': { + PATCH: 'urgentPhoneImMessage', + }, + '/open-apis/im/v1/messages/{message_id}/reactions': { + POST: 'createImMessageReaction', + GET: 'listImMessageReaction', + }, + '/open-apis/im/v1/messages/{message_id}/reactions/{reaction_id}': { + DELETE: 'deleteImMessageReaction', + }, + '/open-apis/im/v1/pins': { + POST: 'createImPin', + GET: 'listImPin', + }, + '/open-apis/im/v1/pins/{message_id}': { + DELETE: 'deleteImPin', + }, + '/open-apis/im/v2/url_previews/batch_update': { + POST: 'batchUpdateImUrlPreview', + }, + '/open-apis/im/v1/chats': { + POST: 'createImChat', + GET: 'listImChat', + }, + '/open-apis/im/v1/chats/{chat_id}': { + DELETE: 'deleteImChat', + PUT: 'updateImChat', + GET: 'getImChat', + }, + '/open-apis/im/v1/chats/{chat_id}/moderation': { + PUT: 'updateImChatModeration', + GET: 'getImChatModeration', + }, + '/open-apis/im/v1/chats/{chat_id}/top_notice/put_top_notice': { + POST: 'putTopNoticeImChatTopNotice', + }, + '/open-apis/im/v1/chats/{chat_id}/top_notice/delete_top_notice': { + POST: 'deleteTopNoticeImChatTopNotice', + }, + '/open-apis/im/v1/chats/search': { + GET: 'searchImChat', + }, + '/open-apis/im/v1/chats/{chat_id}/link': { + POST: 'linkImChat', + }, + '/open-apis/im/v1/chats/{chat_id}/managers/add_managers': { + POST: 'addManagersImChatManagers', + }, + '/open-apis/im/v1/chats/{chat_id}/managers/delete_managers': { + POST: 'deleteManagersImChatManagers', + }, + '/open-apis/im/v1/chats/{chat_id}/members': { + POST: 'createImChatMembers', + DELETE: 'deleteImChatMembers', + GET: 'getImChatMembers', + }, + '/open-apis/im/v1/chats/{chat_id}/members/me_join': { + PATCH: 'meJoinImChatMembers', + }, + '/open-apis/im/v1/chats/{chat_id}/members/is_in_chat': { + GET: 'isInChatImChatMembers', + }, + '/open-apis/im/v1/chats/{chat_id}/announcement': { + PATCH: 'patchImChatAnnouncement', + GET: 'getImChatAnnouncement', + }, + '/open-apis/im/v1/chats/{chat_id}/chat_tabs': { + POST: 'createImChatTab', + }, + '/open-apis/im/v1/chats/{chat_id}/chat_tabs/delete_tabs': { + DELETE: 'deleteTabsImChatTab', + }, + '/open-apis/im/v1/chats/{chat_id}/chat_tabs/update_tabs': { + POST: 'updateTabsImChatTab', + }, + '/open-apis/im/v1/chats/{chat_id}/chat_tabs/sort_tabs': { + POST: 'sortTabsImChatTab', + }, + '/open-apis/im/v1/chats/{chat_id}/chat_tabs/list_tabs': { + GET: 'listTabsImChatTab', + }, + '/open-apis/im/v1/chats/{chat_id}/menu_tree': { + POST: 'createImChatMenuTree', + DELETE: 'deleteImChatMenuTree', + GET: 'getImChatMenuTree', + }, + '/open-apis/im/v1/chats/{chat_id}/menu_items/{menu_item_id}': { + PATCH: 'patchImChatMenuItem', + }, + '/open-apis/im/v1/chats/{chat_id}/menu_tree/sort': { + POST: 'sortImChatMenuTree', + }, + '/open-apis/im/v2/app_feed_card': { + POST: 'createImAppFeedCard', + }, + '/open-apis/im/v2/app_feed_card/batch': { + PUT: 'updateImAppFeedCardBatch', + DELETE: 'deleteImAppFeedCardBatch', + }, + '/open-apis/im/v2/feed_cards/bot_time_sentive': { + PATCH: 'botTimeSentiveImFeedCard', + }, + '/open-apis/im/v2/chat_button': { + PUT: 'updateImChatButton', + }, + '/open-apis/im/v2/feed_cards/{feed_card_id}': { + PATCH: 'patchImFeedCard', + }, + '/open-apis/im/v2/biz_entity_tag_relation': { + GET: 'getImBizEntityTagRelation', + POST: 'createImBizEntityTagRelation', + PUT: 'updateImBizEntityTagRelation', + }, + '/open-apis/im/v2/tags': { + POST: 'createImTag', + }, + '/open-apis/im/v2/tags/{tag_id}': { + PATCH: 'patchImTag', + }, +}) diff --git a/adapters/lark/src/types/index.ts b/adapters/lark/src/types/index.ts index b39cf1fd..eaca95c8 100644 --- a/adapters/lark/src/types/index.ts +++ b/adapters/lark/src/types/index.ts @@ -1,40 +1,17759 @@ -export * from './internal' +export * from './acs' +export * from './admin' +export * from './aily' +export * from './apaas' +export * from './application' +export * from './approval' +export * from './attendance' +export * from './auth' +export * from './authen' +export * from './baike' +export * from './bitable' +export * from './board' +export * from './calendar' +export * from './cardkit' +export * from './compensation' +export * from './contact' +export * from './corehr' +export * from './docs' +export * from './document_ai' +export * from './docx' +export * from './drive' +export * from './ehr' export * from './event' -export * from './message' -export * from './api' - -export namespace Lark { - /** - * A user in Lark has several different IDs. - * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction - */ - export interface UserIds { - union_id: string - /** *user_id* only available when the app has permissions granted by the administrator */ - user_id?: string - open_id: string - } - - /** - * Identify a user in Lark. - * This behaves like {@link Lark.UserIds}, but it only contains *open_id*. - * (i.e. the id_type is always `open_id`) - */ - export interface UserIdentifiers { - id: string - id_type: string - } - - export type UserIdType = 'union_id' | 'user_id' | 'open_id' - /** - * The id type when specify a receiver, would be used in the request query. - * - * NOTE: we always use **open_id** to identify a user, use **chat_id** to identify a channel. - * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create - */ - export type ReceiveIdType = UserIdType | 'email' | 'chat_id' - - export type DepartmentIdType = 'department_id' | 'open_department_id' -} - -export { Lark as Feishu } +export * from './helpdesk' +export * from './hire' +export * from './human_authentication' +export * from './im' +export * from './lingo' +export * from './mail' +export * from './mdm' +export * from './minutes' +export * from './moments' +export * from './okr' +export * from './optical_char_recognition' +export * from './passport' +export * from './payroll' +export * from './performance' +export * from './personal_settings' +export * from './report' +export * from './search' +export * from './security_and_compliance' +export * from './sheets' +export * from './speech_to_text' +export * from './task' +export * from './tenant' +export * from './translation' +export * from './vc' +export * from './verification' +export * from './wiki' +export * from './workplace' + +export interface Abbreviation { + /** 相关其他词条 id */ + id?: string +} + +export interface Ability { + /** 能力项ID */ + id: string + /** 能力项名称 */ + name?: I18n + /** 能力项描述 */ + description?: I18n +} + +export interface Acceptance { + /** 操作类型 */ + operator_type?: 1 | 2 + /** offer 接受或拒绝的结果 */ + conclusion?: 1 | 2 + /** 备注，如果是拒绝，则展示拒绝原因 */ + memo?: string + /** 操作的字符串毫秒时间戳 */ + operate_time?: string +} + +export interface AccessData { + /** 访问次数 */ + pv?: number + /** 访问用户数(去重) */ + uv?: number +} + +export interface AccessRecord { + /** 门禁记录 ID */ + access_record_id?: string + /** 门禁记录所属用户 ID */ + user_id?: string + /** 门禁设备 ID */ + device_id?: string + /** 是否是打卡 */ + is_clock_in?: boolean + /** 访问时间，单位秒 */ + access_time?: string + /** 识别方式 */ + access_type?: 'FA' | 'QRCode' | 'Card' | 'Fp' + /** 识别相关数据，根据 access_type 不同，取值不同 */ + access_data?: string + /** 是否开门 */ + is_door_open?: boolean +} + +export interface Account { + /** 账户ID */ + account_id: string + /** 账户资产 */ + assets?: Assets + /** 账号状态 */ + status?: 1 | 2 +} + +export interface AcctItem { + /** 算薪项ID */ + id?: string + /** 算薪项名称 */ + i18n_names?: I18nContent[] + /** 算薪项分类ID */ + category_id?: string + /** 算薪项数据类型 */ + data_type?: number + /** 小数位数 */ + decimal_places?: number + /** 启用状态 */ + active_status?: number +} + +export interface Acl { + /** 权限类型，优先级：Deny > Allow */ + access?: 'allow' | 'deny' + /** 设置的权限值，依赖 type 描述 */ + value?: string + /** 权限值类型 */ + type?: 'user_id' | 'open_id' | 'union_id' | 'department_id' | 'open_department_id' | 'group_id' | 'app_group_id' | 'user' | 'group' +} + +export interface AclScope { + /** 权限类型，当type为User时，值为open_id/user_id/union_id */ + type: 'user' + /** 用户ID */ + user_id?: string +} + +export interface ActionConfig { + /** 操作类型，每个任务都可以配置2个操作，会展示审批列表中，当用户操作时，回调请求会带上该字段，表示用户进行了同意操作还是拒绝操作。APPROVE - 同意 REJECT - 拒绝 {KEY} - 任意字符串，如果使用任意字符串，则需要提供 action_name */ + action_type: string + /** 操作名称，i18n key 用于前台展示，如果 action_type 不是 APPROVAL和REJECT，则必须提供该字段，用于展示特定的操作名称 */ + action_name?: string + /** 是否需要意见, 如果为true,则用户操作时，会跳转到 意见填写页面 */ + is_need_reason?: boolean + /** 审批意见是否必填 */ + is_reason_required?: boolean + /** 意见是否支持上传附件 */ + is_need_attachment?: boolean +} + +export interface Activity { + /** 项目 ID */ + id: string + /** 项目名称 */ + name?: I18n + /** 项目描述 */ + description?: I18n + /** 周期 ID */ + semester_id?: string + /** 项目模式 */ + mode?: 'metric_development' | 'performance_review' | 'metric_development_and_performance_review' + /** 项目状态 */ + progress?: 'configurable' | 'unable' | 'initiating' | 'enabled' | 'finished' + /** 项目创建时间，毫秒时间戳 */ + create_time?: string + /** 项目更新时间，毫秒时间戳 */ + modify_time?: string + /** 项目创建人 ID */ + create_user_id?: string + /** 项目更新人 ID */ + modify_user_id?: string +} + +export interface AdditionalInformation { + /** 飞书绩效的事项 ID */ + item_id?: string + /** 外部系统的事项 ID，没有则返回为空 */ + external_id?: string + /** 被评估人 ID */ + reviewee_user_id: string + /** 事项 */ + item: string + /** 事项时间，格式为文本内容 */ + time: string + /** 事项详细描述 */ + detailed_description: string +} + +export interface AddOns { + /** 团队互动应用唯一ID */ + component_id?: string + /** 团队互动应用类型，比如问答互动"blk_636a0a6657db8001c8df5488" */ + component_type_id: string + /** 文档小组件内容数据，JSON 字符串 */ + record?: string +} + +export interface Address { + /** 地址 ID */ + address_id?: string + /** 国家 / 地区 */ + country_region_id: string + /** 主要行政区 */ + region_id?: string + /** 地址行 1 */ + address_line1?: string + /** 地址行 2 */ + address_line2?: string + /** 地址行 3 */ + address_line3?: string + /** 地址行 4 */ + address_line4?: string + /** 地址行 5 */ + address_line5?: string + /** 地址行 6 */ + address_line6?: string + /** 地址行 7 */ + address_line7?: string + /** 地址行 8 */ + address_line8?: string + /** 地址行 9 */ + address_line9?: string + /** 地址行 1（非拉丁语系的本地文字） */ + local_address_line1?: string + /** 地址行 2（非拉丁语系的本地文字） */ + local_address_line2?: string + /** 地址行 3（非拉丁语系的本地文字） */ + local_address_line3?: string + /** 地址行 4（非拉丁语系的本地文字） */ + local_address_line4?: string + /** 地址行 5（非拉丁语系的本地文字） */ + local_address_line5?: string + /** 地址行 6（非拉丁语系的本地文字） */ + local_address_line6?: string + /** 地址行 7（非拉丁语系的本地文字） */ + local_address_line7?: string + /** 地址行 8（非拉丁语系的本地文字） */ + local_address_line8?: string + /** 地址行 9（非拉丁语系的本地文字） */ + local_address_line9?: string + /** 邮政编码 */ + postal_code?: string + /** 地址类型 */ + address_type_list: Enum[] + /** 主要地址 */ + is_primary: boolean + /** 公开地址 */ + is_public: boolean + /** 自定义字段 */ + custom_fields?: CustomFieldData[] +} + +export interface AddressForUpdate { + /** 国家 / 地区 */ + country_region_id: string + /** 主要行政区 */ + region_id?: string + /** 地址行 1（非拉丁语系的本地文字） */ + local_address_line1?: string + /** 地址行 2（非拉丁语系的本地文字） */ + local_address_line2?: string + /** 地址行 3（非拉丁语系的本地文字） */ + local_address_line3?: string + /** 地址行 4（非拉丁语系的本地文字） */ + local_address_line4?: string + /** 地址行 5（非拉丁语系的本地文字） */ + local_address_line5?: string + /** 地址行 6（非拉丁语系的本地文字） */ + local_address_line6?: string + /** 地址行 7（非拉丁语系的本地文字） */ + local_address_line7?: string + /** 地址行 8（非拉丁语系的本地文字） */ + local_address_line8?: string + /** 地址行 9（非拉丁语系的本地文字） */ + local_address_line9?: string + /** 邮政编码 */ + postal_code?: string + /** 地址类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可：- object_api_name = "address" - custom_api_name = "address_type" */ + address_types: string[] + /** 主要地址 */ + is_primary: boolean + /** 公开地址 */ + is_public: boolean + /** 城市 */ + city_id_v2?: string + /** 区/县 */ + district_id_v2?: string +} + +export interface AdjustmentLogic { + /** 固定值 */ + fixed?: string + /** 公式配置 */ + formula?: Formula +} + +export interface AdminDeptStat { + /** 日期 */ + date?: string + /** 部门ID */ + department_id?: string + /** 部门名 */ + department_name?: string + /** 部门路径 */ + department_path?: string + /** 部门总人数 */ + total_user_num?: number + /** 激活人数 */ + active_user_num?: number + /** 激活率 */ + active_user_rate?: string + /** 活跃人数 */ + suite_dau?: number + /** 活跃率 */ + suite_active_rate?: string + /** 新用户数 */ + new_user_num?: number + /** 新激活数 */ + new_active_num?: number + /** 离职人数 */ + resign_user_num?: number + /** 消息活跃人数 */ + im_dau?: number + /** 发送消息人数 */ + send_messenger_user_num?: number + /** 发送消息数 */ + send_messenger_num?: number + /** 人均发送消息数 */ + avg_send_messenger_num?: string + /** 云文档活跃人数 */ + docs_dau?: number + /** 创建文件人数 */ + create_docs_user_num?: number + /** 创建文件数 */ + create_docs_num?: number + /** 人均创建文件数 */ + avg_create_docs_num?: string + /** 日历活跃人数 */ + cal_dau?: number + /** 创建日程人数 */ + create_cal_user_num?: number + /** 创建日程数 */ + create_cal_num?: number + /** 人均创建日程数 */ + avg_create_cal_num?: string + /** 音视频会议活跃人数 */ + vc_dau?: number + /** 会议时长（分钟） */ + vc_duration?: number + /** 人均会议时长（分钟） */ + avg_vc_duration?: string + /** 人均飞书使用时长（分钟） */ + avg_duration?: string + /** 任务活跃人数 */ + task_dau?: number + /** 创建任务人数 */ + create_task_user_num?: number + /** 创建任务数 */ + create_task_num?: number + /** 人均创建任务数 */ + avg_create_task_num?: string + /** 邮件总发件量 */ + email_send_count?: string + /** 邮件总收件量 */ + email_receive_count?: string + /** 对外发件数 */ + email_send_ext_count?: string + /** 来自外部收件数 */ + email_receive_ext_count?: string + /** 对内发件数 */ + email_send_in_count?: string + /** 来自内部收件数 */ + email_receive_in_count?: string + /** 大搜搜索活跃人数 */ + search_active_dau?: string + /** 总搜索次数 */ + total_search_count?: string + /** 综搜次数 */ + quick_search_count?: string + /** 垂搜次数 */ + tab_search_count?: string + /** 产品版本名称 */ + product_version?: string +} + +export interface AdminUserStat { + /** 日期 */ + date?: string + /** 用户ID */ + user_id?: string + /** 用户名 */ + user_name?: string + /** 部门名 */ + department_name?: string + /** 部门路径 */ + department_path?: string + /** 添加时间 */ + create_time?: string + /** 用户激活状态 */ + user_active_flag?: 0 | 1 + /** 激活时间 */ + register_time?: string + /** 用户活跃状态 */ + suite_active_flag?: 0 | 1 + /** 最近活跃时间 */ + last_active_time?: string + /** 用户消息活跃状态 */ + im_active_flag?: 0 | 1 + /** 发送消息数 */ + send_messenger_num?: number + /** 用户云文档活跃状态 */ + docs_active_flag?: 0 | 1 + /** 创建文件数 */ + create_docs_num?: number + /** 用户日历活跃状态 */ + cal_active_flag?: 0 | 1 + /** 创建日程数 */ + create_cal_num?: number + /** 用户音视频会议活跃状态 */ + vc_active_flag?: 0 | 1 + /** 会议时长 */ + vc_duration?: number + /** 活跃设备 */ + active_os?: string + /** 创建任务数 */ + create_task_num?: number + /** 会议数 */ + vc_num?: number + /** 飞书的应用类型名称 */ + app_package_type?: string + /** 操作系统名称 */ + os_name?: string + /** 邮件总发件量 */ + email_send_count?: string + /** 邮件总收件量 */ + email_receive_count?: string + /** 对外发件数 */ + email_send_ext_count?: string + /** 来自外部收件数 */ + email_receive_ext_count?: string + /** 对内发件数 */ + email_send_in_count?: string + /** 来自内部收件数 */ + email_receive_in_count?: string + /** 是否使用了大搜 */ + search_active_flag?: number + /** 总搜索次数 */ + total_search_count?: string + /** 综搜次数 */ + quick_search_count?: string + /** 垂搜次数 */ + tab_search_count?: string +} + +export interface Agency { + /** 猎头供应商ID */ + id?: string + /** 猎头供应商名称 */ + name?: string + /** 供应商联系人ID */ + contactor_id?: string + /** 供应商联系人名称 */ + contactor_name?: I18n +} + +export interface AgencyAccount { + /** 猎头 ID */ + id?: string + /** 禁用原因 */ + reason?: string + /** 添加时间，毫秒时间戳 */ + create_time?: string + /** 猎头状态 */ + status?: 0 | 1 | 2 + /** 用户信息 */ + user_info?: AgencyAccountUser + /** 角色 */ + role?: 0 | 1 +} + +export interface AgencyAccountUser { + /** 用户ID */ + user_id?: string + /** 用户名称 */ + name?: I18n + /** 用户邮箱 */ + email?: string + /** 用户手机 */ + mobile?: string +} + +export interface AgencyBasicInfo { + /** 猎头用户名 */ + hunter_user_name?: I18n + /** 猎头公司名 */ + hunter_company_name?: string +} + +export interface AgencyInfo { + /** 猎头基本信息 */ + basic_info?: AgencyBasicInfo + /** 猎头评价信息 */ + comment_info?: ReportCustomData[] + /** 薪酬信息 */ + salary_info?: ReportCustomData[] +} + +export interface AgencyProtection { + /** 保护期类型 */ + protection_type?: 1 | 2 + /** 如保护期类型为职位保护，返回职位保护所在的投递id */ + application_id?: string + /** 保护期开始时间 */ + start_time?: string + /** 保护期过期时间 */ + expire_time?: string + /** 推荐的猎头供应商 ID */ + agency_supplier_id?: string + /** 推荐的猎头供应商名称 */ + agency_supplier_name?: I18n + /** 推荐的猎头顾问ID，目前仅作为唯一标识，不可查询具体的人员信息 */ + agency_supplier_user_id?: string + /** 推荐的猎头顾问名称 */ + agency_supplier_user_name?: I18n +} + +export interface AgencySupplier { + /** 猎头供应商 ID */ + id?: string + /** 猎头供应商名称 */ + name?: string + /** 标签列表 */ + label_list?: AgencySupplierLabel[] + /** 管理员列表 */ + admin_list?: AgencySupplierAdmin[] + /** 猎头简历保护期 */ + agency_protect_time?: AgencySupplierProtectTime + /** 合作创建时间，毫秒时间戳 */ + cooperation_create_time?: string + /** 合作开始时间，毫秒时间戳 */ + cooperation_start_time?: string + /** 合作终止时间，毫秒时间戳 */ + cooperation_end_time?: string + /** 合作状态，毫秒时间戳 */ + cooperation_status?: 1 | 2 | 3 | 4 + /** 供应商邮箱 */ + invite_email?: string + /** 猎头区域 */ + supplier_area?: 1 | 2 + /** 企业自有简历保护期 */ + talent_protect_time?: AgencySupplierTalentProtectTime +} + +export interface AgencySupplierAdmin { + /** 管理员 ID */ + user_id?: string + /** 管理员名称 */ + name?: I18n + /** 管理员邮箱 */ + email?: string +} + +export interface AgencySupplierLabel { + /** 标签 ID */ + id?: string + /** 标签名称 */ + name?: I18n +} + +export interface AgencySupplierProtectTime { + /** 保护时长，单位（天） */ + day?: number + /** 是否使用统一设置 */ + use_default?: boolean +} + +export interface AgencySupplierTalentProtectTime { + /** 保护时长，单位（天） */ + day?: number + /** 是否使用统一设置 */ + use_default?: boolean + /** 是否永久保护 */ + forever?: boolean +} + +export type Agenda = unknown + +export type AgendaItem = unknown + +export type AgendaItemContent = unknown + +export interface AgendaItemTitle { + /** 文本元素 */ + elements: AgendaTitleElement[] + /** 对齐方式 */ + align?: 1 | 2 | 3 +} + +export interface AgendaTitleElement { + /** 文字 */ + text_run?: TextRun + /** @用户 */ + mention_user?: MentionUser + /** @文档 */ + mention_doc?: MentionDoc + /** 日期提醒 */ + reminder?: Reminder + /** 内联附件 */ + file?: InlineFile + /** 未支持的 TextElement */ + undefined?: UndefinedElement + /** 内联 block */ + inline_block?: InlineBlock + /** 公式 */ + equation?: Equation +} + +export interface AgentSchedule { + /** status of agent */ + status?: number + /** agent info */ + agent?: AgentUser + /** day schedule */ + schedule?: WeekdaySchedule[] + /** agent skills */ + agent_skills?: AgentSkillLessInfo[] +} + +export interface AgentScheduleUpdateInfo { + /** agent id */ + agent_id?: string + /** schedule listing */ + schedule?: WeekdaySchedule[] + /** skill ids */ + agent_skill_ids?: string[] +} + +export interface AgentSkill { + /** name of agent skill */ + name?: string + /** rules for group */ + rules?: AgentSkillRule[] + /** agent ids in this group */ + agent_ids?: string[] +} + +export interface AgentSkillLessInfo { + /** skill id */ + id?: string + /** name of agent skill */ + name?: string + /** is default group type */ + is_default?: boolean +} + +export interface AgentSkillRule { + /** attribute id */ + id?: string + /** selected operator, 2 for GreaterEqual, 3 for LessEqual, 4 for RangeValue, 5 for In, 6 for NotIn, 7 for MultiSelectExcludeAll, 8 for MultiSelectContainAny, 9 for ContainAny, 10 for ExcludeAll, 11 for ContainAll, 12 for MultiSelectContainAll */ + selected_operator?: number + /** operand value based on selected_operator */ + operand?: string + /** 1 for FAQ, 2 for Ticket, 3 for User, 4 for PreInquiryForm */ + category?: number +} + +export interface AgentUser { + /** user id */ + id?: string + /** user avartal url */ + avatar_url?: string + /** user name */ + name?: string + /** user email */ + email?: string + /** user department */ + department?: string + /** company */ + company_name?: string +} + +export interface AilyKnowledgeAskProcessData { + /** 有数据分析时，根据数据生成的图表描述，按markdown语义描述 */ + chart_dsls?: string[] + /** 召回的知识视图切片的文本数据 */ + chunks?: string[] + /** 有数据分析时，查询到数据结果，每个元素为 json 序列化后的数据结果 */ + sql_data?: string[] +} + +export interface AilyKnowledgeFaq { + /** 匹配问题 */ + question?: string + /** 匹配描述 */ + answer?: string +} + +export interface AilyKnowledgeMessage { + /** 消息内容 */ + content?: string +} + +export interface AilyMention { + /** 实体 ID */ + entity_id?: string + /** 身份提供者 */ + identity_provider?: IdentityProvider + /** 被@实体在消息体中的占位符 */ + key?: string + /** 被@实体的名称 */ + name?: string + /** Aily 账号体系下的 ID */ + aily_id?: string +} + +export interface AilyMessage { + /** 消息 ID */ + id?: string + /** 会话 ID */ + session_id?: string + /** 运行 ID */ + run_id?: string + /** 消息内容类型 */ + content_type?: AilyMessageContentType + /** 消息内容 */ + content?: string + /** 消息中包含的文件 */ + files?: AilyMessageFile[] + /** 引用的消息 ID */ + quote_message_id?: string + /** 发送者 */ + sender?: AilySender + /** 被@的实体 */ + mentions?: AilyMention[] + /** 消息体的纯文本表达 */ + plain_text?: string + /** 消息的创建时间，毫秒时间戳 */ + created_at?: string + /** 状态 */ + status?: AilyMessageStatus +} + +export type AilyMessageContentType = 'MDX' | 'TEXT' | 'CLIP' | 'SmartCard' | 'JSON' + +export interface AilyMessageFile { + /** 文件 ID */ + id?: string + /** 文件类型，参见 https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/MIME_types */ + mime_type?: string + /** 文件名 */ + file_name?: string + /** 其他透传信息 */ + metadata?: string + /** 文件的创建时间，毫秒时间戳 */ + created_at?: string + /** 文件预览链接 */ + preview_url?: AilyMessageFilePreview +} + +export interface AilyMessageFilePreview { + /** 文件的 URL */ + url: string + /** url 过期时间，秒时间戳 */ + expired_at?: string +} + +export type AilyMessageStatus = 'IN_PROGRESS' | 'COMPLETED' + +export interface AilySender { + /** 实体 ID */ + entity_id?: string + /** 身份提供者 */ + identity_provider?: IdentityProvider + /** 发送人类型 */ + sender_type?: AilySenderType + /** Aily 账号体系下的 ID */ + aily_id?: string +} + +export type AilySenderType = 'USER' | 'ASSISTANT' + +export interface AilySession { + /** 会话 ID */ + id: string + /** 会话的创建时间，毫秒时间戳 */ + created_at: string + /** 会话的上次更新时间，毫秒时间戳 */ + modified_at: string + /** 会话的创建人 */ + created_by: string + /** 渠道上下文 */ + channel_context?: string + /** 其他透传信息 */ + metadata?: string +} + +export interface Alert { + /** 告警ID */ + alert_id?: string + /** 触发告警规则的会议室/服务器具体的名称 */ + resource_scope?: string + /** 触发告警规则的监控对象 */ + monitor_target?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 告警规则的规则描述 */ + alert_strategy?: string + /** 告警通知发生时间（unix时间，单位sec） */ + alert_time?: string + /** 告警等级：严重/警告/提醒 */ + alert_level?: 0 | 1 | 2 + /** 告警联系人 */ + contacts?: Contact[] + /** 通知方式 */ + notifyMethods?: 0 | 1[] + /** 规则名称 */ + alertRule?: string + /** 处理时间 */ + process_time?: string + /** 恢复时间 */ + recover_time?: string + /** 处理状态：待处理/处理中/已恢复 */ + process_status?: 0 | 1 | 2 | 3 | 4 + /** 告警规则ID */ + alert_rule_id?: string + /** 触发告警规则的会议室ID，当触发告警规则的是会议室时返回该信息 */ + monitor_target_room_id?: string + /** 触发告警规则的会议室主机Mac地址，当monitor_target=1时返回该信息 */ + monitor_target_room_mac?: string +} + +export interface AllowedEditModes { + /** 是否允许手动录入 */ + manual?: boolean + /** 是否允许移动端录入 */ + scan?: boolean +} + +export interface AllowedRollbaclkTaskItemType { + /** 任务ID */ + id?: string + /** 任务对应的活动名称 */ + activity_label?: I18ns + /** 是否开始节点 */ + is_start?: boolean +} + +export interface ApiAuditCommonDrawers { + /** 扩展字段信息 */ + common_draw_info_list?: ApiAuditDrawerInfo[] +} + +export interface ApiAuditDrawerInfo { + /** key信息 */ + info_key?: string + /** val值 */ + info_val?: string + /** key对应的i18nkey */ + key_i18n_key?: string + /** val类型 */ + val_type?: string + /** val对应的i18nkey */ + val_i18n_key?: string +} + +export interface App { + /** 多维表格 app token */ + app_token?: string + /** 多维表格 App 名字 */ + name?: string + /** 多维表格 App 归属文件夹 */ + folder_token?: string + /** 多维表格 App URL */ + url?: string + /** 默认的表格id */ + default_table_id?: string + /** 文档时区，说明见：https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */ + time_zone?: string +} + +export interface AppAbility { + /** 小程序能力 */ + gadget?: Gadget + /** 网页能力 */ + web_app?: WebApp + /** 机器人能力 */ + bot?: Bot + /** 小组件能力 */ + workplace_widgets?: WorkplaceWidget[] + /** 主导航小程序 */ + navigate?: Navigate + /** 云文档应用 */ + cloud_doc?: CloudDoc + /** 云文档小组件 */ + docs_blocks?: DocsBlock[] + /** 消息快捷操作 */ + message_action?: MessageAction + /** 加号菜单 */ + plus_menu?: PlusMenu +} + +export interface AppContactsRangeIdList { + /** 成员id列表 */ + user_ids?: string[] + /** 部门id列表 */ + department_ids?: string[] + /** 用户组列表 */ + group_ids?: string[] +} + +export interface AppDashboard { + /** 仪表盘 ID */ + block_id: string + /** 仪表盘名字 */ + name: string +} + +export interface AppFeedNotify { + /** 是否关闭通知 */ + close_notify?: boolean + /** 自定义语音播报文本内容 */ + custom_sound_text?: string + /** 是否播报自定义语音 */ + with_custom_sound?: boolean +} + +export interface AppFieldPropertyAutoSerial { + /** 自动编号类型 */ + type: 'custom' | 'auto_increment_number' + /** 自动编号规则列表 */ + options?: AppFieldPropertyAutoSerialOptions[] +} + +export interface AppFieldPropertyAutoSerialOptions { + /** 自动编号的可选规则项类型 */ + type: 'system_number' | 'fixed_text' | 'created_time' + /** 与类型相对应的取值 */ + value: string +} + +export interface AppFieldPropertyLocation { + /** 地理位置输入限制 */ + input_type: 'only_mobile' | 'not_limit' +} + +export interface AppI18nInfo { + /** 国际化语言的 key */ + i18n_key: 'zh_cn' | 'en_us' | 'ja_jp' | 'zh_hk' | 'zh_tw' | 'id_id' | 'ms_my' | 'de_de' | 'es_es' | 'fr_fr' | 'it_it' | 'pt_br' | 'vi_vn' | 'ru_ru' | 'th_th' | 'ko_kr' + /** 应用国际化名称 */ + name?: string + /** 应用国际化描述（副标题） */ + description?: string + /** 帮助国际化文档链接 */ + help_use?: string +} + +export interface Application { + /** 应用的 id */ + app_id: string + /** 应用创建者（所有者） */ + creator_id?: string + /** 应用状态 */ + status?: 0 | 1 | 2 | 3 + /** 应用类型 */ + scene_type?: 0 | 1 | 2 | 3 + /** 付费类型 */ + payment_type?: 0 | 1 + /** 应用创建来源(目前仅Base应用返回) */ + create_source?: 'developer_console' | 'base' | 'app_engine' | 'bot_builder' | 'aily' | 'unknown' + /** 安全设置中的重定向 URL */ + redirect_urls?: string[] + /** 发布在线上的应用版本 */ + online_version_id?: string + /** 在审核中的版本号信息，若没有则为空 */ + unaudit_version_id?: string + /** 应用默认名称，如果没有对应语言下的名称，则返回默认语言下的名称 */ + app_name?: string + /** 应用图标链接 */ + avatar_url?: string + /** 应用默认描述 */ + description?: string + /** 应用权限列表 */ + scopes?: AppScope[] + /** 后台主页地址 */ + back_home_url?: string + /** 应用的国际化信息列表 */ + i18n?: AppI18nInfo[] + /** 应用主语言 */ + primary_language?: 'zh_cn' | 'en_us' | 'ja_jp' + /** 应用分类的国际化描述 */ + common_categories?: string[] + /** 应用的所有者信息 */ + owner?: ApplicationOwner + /** 移动端默认能力 */ + mobile_default_ability?: 'gadget' | 'web_app' | 'bot' + /** PC端默认能力 */ + pc_default_ability?: 'gadget' | 'web_app' | 'bot' +} + +export interface ApplicationAppContactsRange { + /** 通讯录可见性类型 */ + contacts_scope_type?: 'equal_to_availability' | 'some' | 'all' + /** 可用名单 */ + visible_list?: AppVisibleList +} + +export interface ApplicationAppUsage { + /** 指标名称 */ + metric_name: string + /** 指标值 */ + metric_value: number +} + +export interface ApplicationAppVersion { + /** 应用 id */ + app_id: string + /** 开发者填入的应用版本 ID */ + version?: string + /** 唯一标识应用版本的 ID */ + version_id: string + /** 应用默认名称 */ + app_name?: string + /** 应用头像 url */ + avatar_url?: string + /** 应用默认描述 */ + description?: string + /** 应用权限列表 */ + scopes?: AppScope[] + /** 后台主页地址 */ + back_home_url?: string + /** 应用的国际化信息列表 */ + i18n?: AppI18nInfo[] + /** 应用分类的国际化描述 */ + common_categories?: string[] + /** 应用已订阅开放平台事件列表 */ + events?: string[] + /** 版本状态 */ + status?: 0 | 1 | 2 | 3 | 4 + /** 版本创建时间（单位：s） */ + create_time?: string + /** 版本发布时间（单位：s） */ + publish_time?: string + /** 当前版本下应用开启的能力 */ + ability?: AppAbility + /** 跟随应用版本的信息 */ + remark?: AppVersionRemark + /** 应用已订阅事件详情列表 */ + event_infos?: Event[] +} + +export interface ApplicationDepartmentAppUsage { + /** 租户内部门的唯一标识，ID值与查询参数中的department_id_type 对应。 */ + department_id?: string + /** 应用整体使用情况。指标名称， uv：活跃用户数， total_users：累计用户数， new_users：新增用户数。 */ + app?: ApplicationAppUsage[] + /** 小程序使用情况，没有小程序形态时为null。 */ + gadget?: ApplicationAppUsage[] + /** 网页应用使用情况，没有网页应用形态时为null */ + webapp?: ApplicationAppUsage[] + /** 机器人使用情况，没有机器人形态时为null */ + bot?: ApplicationAppUsage[] +} + +export interface ApplicationDetailBasicInfo { + /** 投递 ID */ + id?: string + /** 投递的职位 ID */ + job_id?: string + /** 投递的人才 ID */ + talent_id?: string + /** 投递处于的阶段 */ + stage?: ApplicationStageInfo + /** 投递活跃状态 */ + active_status?: 1 | 2 + /** 投递方式 */ + delivery_type?: 1 | 2 + /** 投递来源信息 */ + resume_source_info?: ApplicationResumeSource + /** 官网投递来源 */ + website_resume_source?: ApplicationWebsiteResumeSource + /** 简历附件 ID */ + talent_attachment_resume_id?: string + /** 投递阶段变更时间列表 */ + stage_time_list?: ApplicationStageTime[] + /** 投递入职状态 */ + onboard_status?: 1 | 2 + /** 意向投递城市列表 */ + application_preferred_city_list?: CodeNameObject[] + /** 投递终止原因 */ + termination_reason?: TerminationReasonInfo + /** 投递创建者 ID，仅当投递创建人为企业内部员工时可获取（如员工手动上传简历 / 加入职位 / 内推），其余情况返回为空（如候选人主动投递） */ + creator_id?: string + /** 投递所有者 ID */ + owner_id?: string + /** 投递终止者 ID */ + terminator_id?: string + /** 创建时间戳（单位：毫秒） */ + create_time?: string + /** 修改时间戳（单位：毫秒） */ + modify_time?: string +} + +export interface ApplicationDetailInfo { + /** 投递基本信息 */ + basic_info?: ApplicationDetailBasicInfo + /** 投递职位信息 */ + job?: JobBasicInfo + /** 投递人才信息 */ + talent?: TalentBasicInfoV2 + /** 投递评估信息 */ + evaluations?: Evaluation[] + /** 投递面试信息 */ + interview_aggregation?: InterviewAggregation + /** 投递 Offer 信息 */ + offer?: OfferInfoV2 + /** 投递员工入转离信息 */ + employee?: EmployeeV2 + /** 投递猎头推荐信息 */ + agency?: AgencyInfo + /** 投递官网信息 */ + portal?: ApplicationDetailPortalInfo + /** 投递内推信息 */ + referral?: ReferralInfoV2 +} + +export interface ApplicationDetailPortalInfo { + /** 校招志愿信息 */ + campus_volunteer_info?: CampusVolumnteerInfo +} + +export interface ApplicationFeedback { + /** 应用反馈 ID，应用反馈记录唯一标识 */ + feedback_id: string + /** 被反馈应用ID */ + app_id: string + /** 反馈提交时间，格式为yyyy-mm-dd hh:mm:ss */ + feedback_time: string + /** 反馈用户的租户名， 查询 isv 应用时反馈数据时返回 */ + tenant_name?: string + /** 反馈类型 */ + feedback_type: 1 | 2 + /** 反馈处理状态 */ + status: 0 | 1 | 2 | 3 + /** 故障类型：1: 黑屏 2: 白屏 3: 无法打开小程序 4: 卡顿 5: 小程序闪退 6: 页面加载慢 7: 死机 8: 其他异常） 只在故障反馈时返回 */ + fault_type?: number[] + /** 故障时间，格式为yyyy-mm-dd hh:mm:ss */ + fault_time?: string + /** 反馈来源：1： 小程序 2：网页应用 3：机器人 4：webSDK */ + source?: 1 | 2 | 3 | 4 + /** 用户联系方式，只有用户填写联系方式后返回 */ + contact?: string + /** 反馈处理时间，格式为yyyy-mm-dd hh:mm:ss */ + update_time?: string + /** 反馈问题描述 */ + description: string + /** 反馈用户id，租户内用户的唯一标识 ，ID值与查询参数中的user_id_type对应，应用为 isv 应用时不返回 */ + user_id?: string + /** 操作者id，租户内用户的唯一标识， ID值与查询参数中的user_id_type 对应 反馈未被处理时该值为 nil */ + operator_id?: string + /** 反馈图片url列表，url 过期时间三天 */ + images?: string[] + /** 反馈页面路径 */ + feedback_path?: string +} + +export interface ApplicationInfo { + /** 离职审批发起人的雇佣 ID */ + apply_initiator_id?: string + /** 离职申请流程发起时间 */ + apply_initiating_time?: string + /** 离职申请流程结束时间 */ + apply_finish_time?: string + /** 流程 ID */ + process_id?: string +} + +export interface ApplicationOffer { + /** Offer id */ + id?: string + /** 投递id */ + application_id?: string + /** 基础信息 */ + basic_info?: ApplicationOfferBasicInfo + /** 薪酬计划 */ + salary_plan?: ApplicationOfferSalaryPlan + /** 当前offer使用的schema */ + schema_id?: string + /** Offer状态 */ + offer_status?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 + /** 职位信息 */ + job_info?: OfferJobInfo + /** offer自定义模块列表 */ + customized_module_list?: ApplicationOfferCustomModule[] + /** 招聘需求 ID */ + job_requirement_id?: string + /** offer 发送记录列表 */ + offer_send_record_list?: OfferSendRecord[] +} + +export interface ApplicationOfferBasicInfo { + /** Offer类型 1=Social, 2=Campus, 3=Intern, 4=InternTransfer */ + offer_type?: 1 | 2 | 3 | 4 + /** 备注 */ + remark?: string + /** Offer过期时间 */ + expire_time?: number + /** Offer 负责人 ID */ + owner_user_id?: string + /** Offer 创建人 ID */ + creator_user_id?: string + /** Offer 人员类型 */ + employee_type?: BaseBilingualWithId + /** 创建时间 */ + create_time?: string + /** 直属上级 ID */ + leader_user_id?: string + /** 入职日期 */ + onboard_date?: string + /** 入职部门 */ + department_id?: string + /** 试用期, 比如试用期6个月 */ + probation_month?: number + /** 合同期(年)，推荐使用「contract_period」，如果Offer申请表中「合同期(年)」字段已停用，则不可使用该字段 */ + contract_year?: number + /** 合同期（年/月） */ + contract_period?: ContractPeriodInfo + /** 雇员类型 */ + recruitment_type?: BaseBilingualWithId + /** 序列 */ + sequence?: BaseBilingualWithId + /** 级别 */ + level?: BaseBilingualWithId + /** 入职地点 */ + onboard_address?: BaseAddress + /** 工作地点 */ + work_address?: BaseAddress + /** 自定义模块的value信息 */ + customize_info_list?: ApplicationOfferCustomValue[] + /** 岗位 ID */ + position_id?: string + /** 入职职位 */ + job_offered?: string +} + +export interface ApplicationOfferCustomModule { + /** 自定义模块ID */ + ID?: string + /** 自定义模块下字段的值 */ + object_list?: ApplicationOfferCustomValue[] +} + +export interface ApplicationOfferCustomValue { + /** 自定义字段ID */ + object_id?: string + /** 自定义字段Value */ + customize_value?: string +} + +export interface ApplicationOfferSalaryPlan { + /** 币种 */ + currency?: string + /** 基本薪资, 注意是json */ + basic_salary?: string + /** 试用期百分比 */ + probation_salary_percentage?: string + /** 年终奖月数 */ + award_salary_multiple?: string + /** 期权股数 */ + option_shares?: string + /** 季度奖金额 */ + quarterly_bonus?: string + /** 半年奖金额 */ + half_year_bonus?: string + /** 年度现金总额(数量，非公式) */ + total_annual_cash?: string + /** 自定义字段的value信息 */ + customize_info_list?: ApplicationOfferCustomValue[] +} + +export interface ApplicationOwner { + /** 应用所有者类型 */ + type: 0 | 1 | 2 + /** 应用所有者ID */ + owner_id?: string + /** 应用开发商名称(仅商店应用返回) */ + name?: string + /** 应用开发商服务台链接(仅商店应用返回) */ + help_desk?: string + /** 应用开发商的邮箱(仅商店应用返回) */ + email?: string + /** 应用开发商的手机号(仅商店应用返回) */ + phone?: string + /** 客服账号，仅当商店应用配置了这种联系方式时才会返回 */ + customer_service_account?: string +} + +export interface ApplicationResumeSource { + /** 投递来源 ID */ + id?: string + /** 投递来源名称 */ + name?: I18n + /** 投递来源类型 */ + resume_source_type?: 10000 | 10001 | 10002 | 10003 | 10004 | 10005 | 10006 | 10007 | 10008 | 10009 +} + +export interface ApplicationStageInfo { + /** 阶段id */ + id?: string + /** 阶段中文名字 */ + zh_name?: string + /** 英文名 */ + en_name?: string + /** 阶段类型 */ + type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 255 +} + +export interface ApplicationStageTime { + /** 阶段 ID */ + stage_id?: string + /** 最近一次进入该阶段的时间 */ + enter_time?: string + /** 最后一次离开时间，如当前在该阶段，则为空 */ + exit_time?: string +} + +export interface ApplicationVisibilityDepartmentWhiteBlackInfo { + /** 部门ID */ + department_id?: string + /** 是否在白名单中 */ + in_white_list?: boolean + /** 是否在黑名单中 */ + in_black_list?: boolean +} + +export interface ApplicationVisibilityGroupWhiteBlackInfo { + /** 用户组ID */ + group_id?: string + /** 是否在白名单中 */ + in_white_list?: boolean + /** 是否在黑名单中 */ + in_black_list?: boolean +} + +export interface ApplicationVisibilityUserWhiteBlackInfo { + /** 用户ID */ + user_id?: string + /** 是否在白名单中 */ + in_white_list?: boolean + /** 是否在黑名单中 */ + in_black_list?: boolean + /** 是否在付费名单中 */ + in_paid_list?: boolean +} + +export interface ApplicationWebsiteChannel { + /** 官网推广渠道 ID */ + channel_id?: string + /** 官网推广渠道名称 */ + channel_name?: I18n +} + +export interface ApplicationWebsiteResumeSource { + /** 官网站点 ID */ + website_id?: string + /** 官网站点名称 */ + website_name?: I18n + /** 推广渠道来源 */ + channel?: ApplicationWebsiteChannel +} + +export interface AppRecommendRule { + /** 推荐规则 ID */ + id?: string + /** 推荐规则名称 */ + name?: string + /** 推荐规则启用状态 */ + status?: 'open' | 'closed' + /** 推荐规则可见性信息 */ + visibility_info?: AppRecommendRuleVisibilityInfo + /** 不可移除推荐应用项列表 */ + recommend_item_infos?: AppRecommendRuleItemInfo[] + /** 可移除推荐应用项列表 */ + distributed_recommend_item_infos?: AppRecommendRuleItemInfo[] +} + +export interface AppRecommendRuleItemInfo { + /** 推荐应用项 ID */ + item_id?: string + /** 推荐应用项类型 */ + item_type?: 'application' | 'link' + /** 推荐应用项名称 */ + name?: string + /** 推荐应用项描述 */ + description?: string + /** 链接类型应用项的跳转链接（应用类型该字段为空） */ + link_url?: string + /** 应用类型应用项的 app id（链接类型该字段为空） */ + client_id?: string + /** 应用项图标链接 */ + icon_url?: string + /** 链接类型应用项的默认展示语种（应用类型该字段为空） */ + default_locale?: 'zh_cn' | 'zh_hk' | 'zh_tw' | 'en_us' | 'ja_jp' + /** 应用项的多语种名称 */ + i18n_name?: AppRecommendRuleItemInfoI18nName +} + +export interface AppRecommendRuleItemInfoI18nName { + /** 应用项的简体中文名称 */ + zh_cn?: string + /** 应用项的繁体中文（中国香港）名称 */ + zh_hk?: string + /** 应用项的繁体中文（中国台湾）名称 */ + zh_tw?: string + /** 应用项的英文名称 */ + en_us?: string + /** 应用项的日文名称 */ + ja_jp?: string +} + +export interface AppRecommendRuleVisibilityInfo { + /** 是否全员可见 */ + is_all?: boolean + /** 可见部门 ID 列表 */ + department_ids?: string[] + /** 可见用户 ID 列表 */ + user_ids?: string[] + /** 可见用户组 ID 列表 */ + group_ids?: string[] +} + +export interface AppRole { + /** 自定义权限的名字 */ + role_name: string + /** 自定义权限的id */ + role_id?: string + /** 数据表权限 */ + table_roles: AppRoleTableRole[] + /** block权限 */ + block_roles?: AppRoleBlockRole[] +} + +export interface AppRoleBlockRole { + block_id: string + /** Block类型 */ + block_type?: 'dashboard' + /** Block权限 */ + block_perm: 0 | 1 +} + +export interface AppRoleMember { + /** 用户的open_id */ + open_id?: string + /** 用户的union_id */ + union_id?: string + /** 用户的user_id */ + user_id?: string + /** 群聊的chat_id */ + chat_id?: string + /** 部门的department_id */ + department_id?: string + /** 部门的open_department_id */ + open_department_id?: string + /** 协作者名字 */ + member_name?: string + /** 协作者英文名 */ + member_en_name?: string + /** 协作者类型 */ + member_type?: 'user' | 'chat' | 'department' +} + +export interface AppRoleMemberId { + /** 协作者 ID 类型 */ + type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id' + /** 协作者 ID */ + id: string +} + +export interface AppRoleTableRole { + /** 数据表权限 */ + table_perm: 0 | 1 | 2 | 4 + /** 数据表名 */ + table_name?: string + /** 数据表ID */ + table_id?: string + /** 记录筛选条件，在table_perm为1或2时有意义，用于指定可编辑或可阅读某些记录 */ + rec_rule?: AppRoleTableRoleRecRule + /** 字段权限，仅在table_perm为2时有意义，设置字段可编辑或可阅读 */ + field_perm?: unknown + /** 新增记录权限，仅在table_perm为2时有意义，用于设置记录是否可以新增 */ + allow_add_record?: boolean + /** 删除记录权限，仅在table_perm为2时有意义，用于设置记录是否可以删除 */ + allow_delete_record?: boolean +} + +export interface AppRoleTableRoleRecRule { + /** 记录筛选条件 */ + conditions: AppRoleTableRoleRecRuleCondition[] + /** 多个筛选条件的关系 */ + conjunction?: 'and' | 'or' + /** 其他记录权限，仅在table_perm为2时有效 */ + other_perm?: 0 | 1 +} + +export interface AppRoleTableRoleRecRuleCondition { + /** 字段名 */ + field_name: string + /** 运算符 */ + operator?: 'is' | 'isNot' | 'contains' | 'doesNotContain' | 'isEmpty' | 'isNotEmpty' + /** 单选或多选字段的选项id */ + value?: string[] + /** 字段类型 */ + field_type?: number +} + +export interface ApprovalApproverCcer { + /** 审批节点上的审批人，1.当 type 为 Supervisor、SupervisorTopDown、DepartmentManager 、DepartmentManagerTopDown 这 4 种时，需要在 level 中填写对应的级数，例如：由下往上三级主管审批，level = 3；2.当 type 为 Personal 时，需要根据x_user_id填写user_id，用于指定用户；3.当 approver 为 Free 发起人自选时，不需要指定 user_id ；ccer不支持 Free 发起人自选 */ + type: 'Supervisor' | 'SupervisorTopDown' | 'DepartmentManager' | 'DepartmentManagerTopDown' | 'Personal' | 'Free' + /** 用户id，根据user_id_type填写 */ + user_id?: string + /** 审批级数，当 type 为 Supervisor、SupervisorTopDown、DepartmentManager 、DepartmentManagerTopDown 这 4 种时，需要在 level 中填写对应的级数，例如：由下往上三级主管审批，level = 3 */ + level?: string +} + +export interface ApprovalConfig { + /** 预定审批开关，0关闭，1打开 */ + approval_switch?: number + /** 预定审批条件，0所有预定需要审批，1满足条件需审批 */ + approval_condition?: number + /** 超过 meeting_duration小时需要审批 */ + meeting_duration?: number + /** 审批人列表 */ + approvers?: SubscribeUser[] +} + +export interface ApprovalCreateExternal { + /** 列表中用于提示审批来自哪里，i18n key， 注意不需要“来自”前缀，审批中心会拼上前缀 */ + biz_name?: string + /** 审批定义业务类别 */ + biz_type?: string + /** 移动端发起链接，如果设置了该链接，则会在移动端审批发起页展示该审批，用户点击后会跳转到该链接进行发起； 如果不填，则在mobile端不显示该审批 */ + create_link_mobile?: string + /** PC端发起链接，如果设置了该链接，则会在PC端审批发起页展示该审批，用户点击后会跳转到该链接进行发起； 如果不填，则在PC端不显示该审批； */ + create_link_pc?: string + /** 审批实例、审批任务、审批抄送是否要在PC端展示，如果为 true，则PC端列表会展示该定义下的实例信息，否则，不展示 */ + support_pc?: boolean + /** 审批实例、审批任务、审批抄送是否要在移动端展示，如果为 true，则移动端列表会展示该定义下的实例信息，否则，不展示； support_pc和support_mobile不可都为false，否则不展示 */ + support_mobile?: boolean + /** 是否支持批量已读 */ + support_batch_read?: boolean + /** 是否支持标注可读 */ + enable_mark_readed?: boolean + /** 是否支持快速操作 */ + enable_quick_operate?: boolean + /** 三方系统的操作回调 url，【待审批】列表的任务审批人点同意或拒绝操作后，审批中心调用该地址通知三方系统，回调地址相关信息可参见：https://open.feishu.cn/document/ukTMukTMukTM/ukjNyYjL5YjM24SO2IjN/quick-approval-callback */ + action_callback_url?: string + /** 回调时带的 token， 用于业务系统验证请求来自审批,具体参考 https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM */ + action_callback_token?: string + /** 请求参数加密密钥，如果配置了该参数，则会对请求参数进行加密，业务需要对请求进行解密，加解密算法参考 https://open.feishu.cn/document/ukTMukTMukTM/uADM4QjLwADO04CMwgDN */ + action_callback_key?: string + /** 是否支持批量审批 */ + allow_batch_operate?: boolean + /** 审批流程数据是否不纳入效率统计 */ + exclude_efficiency_statistics?: boolean +} + +export interface ApprovalCreateViewers { + /** 可见人类型，如果 viewer_type 是 TENANT 和 NONE, viewer_user_id， viewer_department_id可不填 */ + viewer_type?: 'TENANT' | 'DEPARTMENT' | 'USER' | 'NONE' + /** 当 viewer_type 是 USER，根据user_id_type填写用户id */ + viewer_user_id?: string + /** 当 view_type 为DEPARTMENT，根据department_id_type填写部门id */ + viewer_department_id?: string +} + +export interface ApprovalForm { + /** 审批定义表单内容，json 数组 */ + form_content: string + /** 控件之间数据条件约束表达式 */ + widget_relation?: string +} + +export interface ApprovalGroup { + /** 组织架构调整审批组 ID */ + approval_group_id?: string + /** 组织架构调整流程 ID */ + process_id?: string + /** 组织架构调整流程状态 */ + approval_group_status?: '0' | '1' | '2' | '3' | '4' | '5' + /** 组织架构调整流程状态V2 */ + approval_group_status_v2?: 0 | 1 | 2 | 3 | 4 | 5 | 6 + /** 调整主题 */ + topic?: string + /** 调整原因 */ + adjust_reason?: string + /** 生效日期 */ + effective_date?: string + /** 发起人 */ + created_by?: string + /** 组织架构调整任务 ID */ + draft_id?: string + /** 组织架构调整任务状态 */ + draft_status?: '0' | '1' | '2' | '3' + /** 关联的部门调整记录 ID 列表 */ + department_changes?: string[] + /** 关联的人员调整记录 ID 列表 */ + job_changes?: string[] + /** 关联的岗位调整记录 ID 列表 */ + position_changes?: string[] +} + +export interface ApprovalInfo { + /** 审批实例id */ + approval_id: string + /** 审批类型，remedy为补卡 */ + approval_type: 'leave' | 'overtime' | 'trip' | 'out' | 'remedy' + /** 审批状态，1为不通过，2为通过，4为撤销 */ + status: 0 | 1 | 2 | 3 | 4 +} + +export interface ApprovalNode { + /** 节点 ID，开始节点的 ID 为 START，结束节点的 ID 为 END，开始和结束节点不需要指定 name、node_type 以及 approver */ + id: string + /** 节点名称的国际化文案 Key，以 @i18n@ 开头，长度不得少于 9 个字符 */ + name?: string + /** 审批类型枚举,当 node_type 为依次审批时，审批人必须为『发起人自选』 */ + node_type?: 'AND' | 'OR' | 'SEQUENTIAL' + /** 审批人列表 */ + approver?: ApprovalApproverCcer[] + /** 抄送人列表 */ + ccer?: ApprovalApproverCcer[] + /** 表单项的控件权限 */ + privilege_field?: FieldGroup + /** 自选审批人是否允许多选 */ + approver_chosen_multi?: boolean + /** 自选审批人选择范围 */ + approver_chosen_range?: ApproverRange[] + /** 审批人为提交人时的操作 */ + starter_assignee?: 'STARTER' | 'AUTO_PASS' | 'SUPERVISOR' | 'DEPARTMENT_MANAGER' +} + +export interface ApprovalNodeInfo { + /** 节点名称 */ + name: string + /** 是否发起人自选节点 true - 发起审批时需要提交审批人 */ + need_approver: boolean + /** 节点 ID */ + node_id: string + /** 节点自定义 ID，如果没有设置则不返回 */ + custom_node_id?: string + /** 审批方式 */ + node_type: 'AND' | 'OR' | 'SEQUENTIAL' | 'CC_NODE' + /** 是否支持多选：true-支持，发起、结束节点默认为false */ + approver_chosen_multi: boolean + /** 自选范围 */ + approver_chosen_range?: ApproverChosenRange[] + /** 是否签名 */ + require_signature?: boolean +} + +export interface ApprovalSetting { + /** 审批实例通过后允许撤回的时间，以秒为单位，默认 31 天，0 为不可撤回 */ + revert_interval?: number + /** 是否支持审批通过第一个节点后撤回，默认为1，0为不支持 */ + revert_option?: number + /** 拒绝设置 */ + reject_option?: 0 | 1 + /** 快捷审批配置项，开启后可在卡片上直接审批。默认值1为启用， 0为禁用 */ + quick_approval_option?: 0 | 1 + /** 流程关闭超时配置，传true就是关闭超时配置 */ + overtime_disable?: boolean + /** 单据未处理超时时间，单位天 */ + overtime_notice_time?: number + /** 单据已超时后，自动关闭时间，单位天 */ + overtime_close_time?: number + /** 单据自动关闭后，可恢复时间，单位天 */ + overtime_recover_time?: number +} + +export interface ApprovalViewerInfo { + /** 可见人类型 */ + type: 'TENANT' | 'DEPARTMENT' | 'USER' | 'ROLE' | 'USER_GROUP' | 'NONE' + /** 在可见人类型为DEPARTMENT时，id为部门的id ；在可见人类型为USER时，id为用户的id ；在可见人类型为ROLE时，id为角色的id ；在可见人类型为USER_GROUP时，id为用户组的id */ + id?: string + /** 在可见人类型为USER时，表示可见人用户id */ + user_id?: string +} + +export interface ApproverChosenRange { + /** 指定范围：0-all，1-指定角色，2-指定人员 */ + approver_range_type?: 0 | 1 | 2 + /** 根据上面的type，分别存放角色id与userid，type为0时本字段为空列表 */ + approver_range_ids?: string[] +} + +export interface ApproverInfo { + /** 审批任务id */ + approver_id?: string + /** 流程id */ + process_id?: string + /** 任务状态 */ + approver_status?: -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 12 | 14 | 16 +} + +export interface ApproverRange { + /** 审批人类型 */ + type?: 'ALL' | 'PERSONAL' | 'ROLE' + /** 审批人id */ + id_list?: string[] +} + +export interface AppScope { + /** 应用权限 */ + scope: string + /** 应用权限的国际化描述 */ + description?: string + /** 权限等级描述 */ + level?: 1 | 2 | 3 | 0 + /** 返回用户身份类型user、应用身份类型tenant。如果两种类型都支持，则同时返回两个。 */ + token_types?: string[] +} + +export interface AppTable { + /** 表格Id */ + table_id?: string + /** 数据表 版本号 */ + revision?: number + /** 数据表 名字 */ + name?: string +} + +export interface AppTableCreateHeader { + /** 字段名 */ + field_name: string + /** 字段类型 */ + type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005 + /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ + ui_type?: 'Text' | 'Barcode' | 'Number' | 'Progress' | 'Currency' | 'Rating' | 'SingleSelect' | 'MultiSelect' | 'DateTime' | 'Checkbox' | 'User' | 'GroupChat' | 'Phone' | 'Url' | 'Attachment' | 'SingleLink' | 'Formula' | 'DuplexLink' | 'Location' | 'CreatedTime' | 'ModifiedTime' | 'CreatedUser' | 'ModifiedUser' | 'AutoNumber' + /** 字段属性 */ + property?: AppTableFieldProperty + /** 字段的描述 */ + description?: AppTableFieldDescription +} + +export interface AppTableField { + /** 字段名 */ + field_name: string + /** 字段类型 */ + type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005 + /** 字段属性 */ + property?: AppTableFieldProperty + /** 字段的描述 */ + description?: AppTableFieldDescription + /** 是否是索引列 */ + is_primary?: boolean + /** 字段Id */ + field_id?: string + /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ + 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' + /** 是否是隐藏字段 */ + is_hidden?: boolean +} + +export interface AppTableFieldDescription { + /** 是否禁止同步，如果为true，表示禁止同步该描述内容到表单的问题描述 */ + disable_sync?: boolean + /** 字段描述内容，支持换行\n */ + text?: string +} + +export interface AppTableFieldForList { + /** 字段名 */ + field_name: string + /** 字段类型 */ + type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005 + /** 字段属性 */ + property?: AppTableFieldProperty + /** 字段的描述, text_field_as_array为false时值为字符串，为true则是对象数组 */ + description?: unknown + /** 是否是索引列 */ + is_primary?: boolean + /** 字段Id */ + field_id?: string + /** 字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ + ui_type?: 'Text' | 'Barcode' | 'Number' | 'Progress' | 'Currency' | 'Rating' | 'SingleSelect' | 'MultiSelect' | 'DateTime' | 'Checkbox' | 'User' | 'GroupChat' | 'Phone' | 'Url' | 'Attachment' | 'SingleLink' | 'Formula' | 'DuplexLink' | 'Location' | 'CreatedTime' | 'ModifiedTime' | 'CreatedUser' | 'ModifiedUser' | 'AutoNumber' + /** 是否是隐藏字段 */ + is_hidden?: boolean +} + +export interface AppTableFieldProperty { + /** 单选、多选字段的选项信息 */ + options?: AppTableFieldPropertyOption[] + /** 数字、公式字段的显示格式 */ + formatter?: string + /** 日期、创建时间、最后更新时间字段的显示格式 */ + date_formatter?: string + /** 日期字段中新纪录自动填写创建时间 */ + auto_fill?: boolean + /** 人员、群组字段中允许添加多个成员，单向关联、双向关联中允许添加多个记录 */ + multiple?: boolean + /** 单向关联、双向关联字段中关联的数据表的id */ + table_id?: string + /** 单向关联、双向关联字段中关联的数据表的名字 */ + table_name?: string + /** 双向关联字段中关联的数据表中对应的双向关联字段的名字 */ + back_field_name?: string + /** 自动编号类型 */ + auto_serial?: AppFieldPropertyAutoSerial + /** 地理位置输入方式 */ + location?: AppFieldPropertyLocation + /** 公式字段的表达式 */ + formula_expression?: string + /** 字段支持的编辑模式 */ + allowed_edit_modes?: AllowedEditModes + /** 进度、评分等字段的数据范围最小值 */ + min?: number + /** 进度、评分等字段的数据范围最大值 */ + max?: number + /** 进度等字段是否支持自定义范围 */ + range_customize?: boolean + /** 货币币种 */ + currency_code?: string + /** 评分字段的相关设置 */ + rating?: Rating + /** 公式字段数据类型 */ + type?: AppTableFieldPropertyType +} + +export interface AppTableFieldPropertyOption { + /** 选项名 */ + name?: string + /** 选项id */ + id?: string + /** 选项颜色 */ + color?: number +} + +export interface AppTableFieldPropertyType { + /** 公式字段对应的数据类型 */ + data_type: 1 | 2 | 3 | 4 | 5 | 7 | 11 | 13 | 15 | 17 | 18 | 20 | 21 | 22 | 23 | 1001 | 1002 | 1003 | 1004 | 1005 + /** 公式数据属性 */ + ui_property?: AppTableFieldPropertyTypeUiProperty + /** 公式字段在界面上的展示类型，例如进度字段是数字的一种展示形态 */ + ui_type?: 'Number' | 'Progress' | 'Currency' | 'Rating' | 'DateTime' +} + +export interface AppTableFieldPropertyTypeUiProperty { + /** 货币币种 */ + currency_code?: string + /** 数字、公式字段的显示格式 */ + formatter?: string + /** 进度等字段是否支持自定义范围 */ + range_customize?: boolean + /** 进度、评分等字段的数据范围最小值 */ + min?: number + /** 进度、评分等字段的数据范围最大值 */ + max?: number + /** 日期、创建时间、最后更新时间字段的显示格式 */ + date_formatter?: string + /** 评分字段的相关设置 */ + rating?: Rating +} + +export interface AppTableForm { + /** 表单名称 */ + name?: string + /** 表单描述 */ + description?: string + /** 是否开启共享 */ + shared?: boolean + /** 分享 URL */ + shared_url?: string + /** 分享范围限制 */ + shared_limit?: 'off' | 'tenant_editable' | 'anyone_editable' + /** 填写次数限制一次 */ + submit_limit_once?: boolean +} + +export interface AppTableFormField { + /** 表单问题 ID */ + field_id?: string + /** 表单问题 */ + title?: string + /** 问题描述 */ + description?: string + /** 是否必填 */ + required?: boolean + /** 是否可见 */ + visible?: boolean +} + +export interface AppTableFormPatchedField { + /** 上一个表单问题 ID */ + pre_field_id?: string + /** 表单问题 */ + title?: string + /** 问题描述 */ + description?: string + /** 是否必填 */ + required?: boolean + /** 是否可见 */ + visible?: boolean +} + +export interface AppTableRecord { + /** 记录字段 */ + fields: unknown + /** 记录Id */ + record_id?: string + /** 创建人 */ + created_by?: Person + /** 创建时间 */ + created_time?: unknown + /** 修改人 */ + last_modified_by?: Person + /** 最近更新时间 */ + last_modified_time?: unknown + /** 记录分享链接(批量获取记录接口将返回该字段) */ + shared_url?: string + /** 记录链接(检索记录接口将返回该字段) */ + record_url?: string +} + +export interface AppTableView { + /** 视图Id */ + view_id?: string + /** 视图名字 */ + view_name?: string + /** 视图类型 */ + view_type?: string +} + +export interface AppTableViewProperty { + /** 过滤条件 */ + filter_info?: AppTableViewPropertyFilterInfo + /** 隐藏字段ID列表 */ + hidden_fields?: string[] + /** 表格视图层级结构设置 */ + hierarchy_config?: AppTableViewPropertyHierarchyConfig +} + +export interface AppTableViewPropertyFilterInfo { + /** 多个筛选条件的关系 */ + conjunction: 'and' | 'or' + /** 筛选条件 */ + conditions: AppTableViewPropertyFilterInfoCondition[] +} + +export interface AppTableViewPropertyFilterInfoCondition { + /** 用于过滤的字段唯一ID */ + field_id: string + /** 过滤操作的类型 */ + operator: 'is' | 'isNot' | 'contains' | 'doesNotContain' | 'isEmpty' | 'isNotEmpty' | 'isGreater' | 'isGreaterEqual' | 'isLess' | 'isLessEqual' + /** 筛选值 */ + value?: string +} + +export interface AppTableViewPropertyHierarchyConfig { + /** 层级结构的关联列id */ + field_id?: string +} + +export interface AppVersionRemark { + /** 备注说明 */ + remark?: string + /** 更新说明 */ + update_remark?: string + /** 可见性名单 */ + visibility?: AppVisibility +} + +export interface AppVisibility { + /** 是否全员可见 */ + is_all?: boolean + /** 可见名单 */ + visible_list?: AppVisibleList + /** 不可见名单 */ + invisible_list?: AppVisibleList +} + +export interface AppVisibilityIdList { + /** 成员id列表(open_id/union_id/user_id) */ + user_ids?: string[] + /** 部门id列表(自定义部门id/open_department_id) */ + department_ids?: string[] + /** 用户组id */ + group_ids?: string[] +} + +export interface AppVisibleList { + /** 可见性成员 open_id 列表 */ + open_ids?: string[] + /** 可见性部门的 id 列表 */ + department_ids?: string[] + /** 可见性成员 group_id 列表 */ + group_ids?: string[] +} + +export interface AppWorkflow { + /** 自动化工作流的id */ + workflow_id: string + /** 自动化工作流的状态 */ + status?: string + /** 自动化工作流的名称 */ + title?: string +} + +export interface ArchiveDetail { + /** 员工ID */ + user_id: string + /** 档案ID */ + id: string + /** 档案TID */ + tid: string + /** 关联方案ID，详细信息可以通过[批量查询薪资方案](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list)接口查询获得 */ + plan_id: string + /** 关联方案TID，详细信息可以通过[批量查询薪资方案](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list)接口查询获得 */ + plan_tid: string + /** 档案币种ID，详细信息可以通过[查询货币信息v2](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search)接口查询获得 */ + currency_id?: string + /** 调薪原因ID，详细信息可以通过[批量查询定调薪原因](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list)接口查询获得 */ + change_reason_id: string + /** 调薪说明 */ + change_description: string + /** 生效时间 */ + effective_date: string + /** 失效时间 */ + expiration_date?: string + /** 薪级薪等ID */ + salary_level_id?: string + /** 档案关联的薪资项 */ + archive_items: ArchiveItem[] + /** 档案关联的薪资指标 */ + archive_indicators: ArchiveIndicator[] +} + +export interface ArchiveField { + /** 字段编号 */ + code?: string + /** 字段名称 */ + title?: string + /** 一级表头名字 */ + upper_titles?: string[] +} + +export interface ArchiveFieldData { + /** 字段编码(查询归档报表表头返回) */ + code: string + /** 字段结果值 */ + value?: string +} + +export interface ArchiveIndicator { + /** 薪资统计指标ID，详细信息可以通过[批量查询薪资统计指标](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list)接口查询获得 */ + indicator_id: string + /** 档案关联薪资统计指标数值 */ + indicator_result: string + /** 档案关联薪资统计指标转正后数值 */ + indicator_result_regular?: string +} + +export interface ArchiveItem { + /** 薪酬项ID，详细信息可以通过[批量查询薪资项](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list)接口查询获得 */ + item_id: string + /** 档案关联薪酬项数值 */ + item_result: string + /** 档案关联薪酬项转正后数值 */ + item_result_regular?: string +} + +export interface ArchiveReportData { + /** 用户ID */ + member_id: string + /** 考勤开始时间 */ + start_time: string + /** 考勤结束时间 */ + end_time: string + /** 字段结果(不超过200个) */ + field_datas?: ArchiveFieldData[] +} + +export interface ArchiveReportMeta { + /** 引用报表 ID */ + report_id?: string + /** 引用报表name */ + report_name?: I18nMap + /** 归档报表规则id */ + archive_rule_id?: string + /** 归档报表name */ + archive_rule_name?: I18nMap +} + +export interface Assessment { + /** 考核结果 ID */ + assessment_id?: string + /** 考核状态 */ + assessment_status?: Enum + /** 试用期考核结果 */ + assessment_result?: Enum + /** 考核得分 */ + assessment_score?: number + /** 试用期考核等级 */ + assessment_grade?: Enum + /** 考核评语 */ + assessment_comment?: string + /** 考核结果页面超链接 */ + assessment_detail?: string + /** 是否为最终考核结果 */ + is_final_asssessment?: boolean +} + +export interface AssessmentForCreate { + /** 考核状态 */ + assessment_status: 'not_started' | 'in_process' | 'completed' | 'no_need' + /** 试用期考核结果 */ + assessment_result?: 'approved' | 'rejected' + /** 考核得分 */ + assessment_score?: number + /** 试用期考核等级 */ + assessment_grade?: string + /** 考核评语 */ + assessment_comment?: string + /** 考核结果页面超链接 */ + assessment_detail?: string + /** 是否为最终考核结果 */ + is_final_asssessment: boolean +} + +export interface Assets { + /** 已确认的奖励 */ + confirmed_bonus?: BonusAmount +} + +export interface AssignedOrganization { + /** 管理对象key */ + org_key: string + /** 管理对象名称 */ + org_name?: Name + /** 管理对象id列表 */ + org_id_list: string[] +} + +export interface AssignedOrganizationWithCode { + /** 管理对象key */ + org_key: string + /** 管理对象id列表 */ + org_ids?: string[] + /** 管理对象code列表 */ + org_codes?: string[] +} + +export interface Attachment { + /** 附件token */ + file_token?: string +} + +export interface AttachmentInfo { + /** 附件id */ + id?: string + /** 附件的url */ + url?: string + /** 附件文件名 */ + name?: string + /** 媒体类型/MIME */ + mime?: string + /** 附件创建时间（单位ms） */ + create_time?: string +} + +export interface AuditAndroidContext { + /** UDID */ + udid?: string + /** 设备ID */ + did?: string + /** app的版本 */ + app_ver?: string + /** SecSDK版本 */ + ver?: string + /** 设备语言 */ + region?: string + /** 安卓版本号 */ + id_i?: string + /** 安卓版本 */ + id_r?: string + /** Brand */ + hw_brand?: string + /** 制造商 */ + hw_manuf?: string + /** wifi ip */ + wifip?: string + /** 路由IP */ + route_iip?: string + /** 路由网关IP */ + route_gip?: string + /** 表示当前是否root */ + env_su?: string + /** 手机系统时区 */ + env_tz?: string + /** 手机系统语言 */ + env_ml?: string + /** GPS经纬度 */ + location?: string + /** 当前设备活跃ip */ + active_ip?: string + /** 当前设备活跃ip对应网卡类型 */ + active_ip_detail?: string + /** 基站信息 */ + cell_base_station?: string + /** 公网ip */ + IP?: string +} + +export interface AuditContext { + /** 终端类型 */ + terminal_type?: 0 | 1 | 2 | 3 + /** ios的环境信息 */ + ios_context?: AuditIosContext + /** pc的环境信息 */ + pc_context?: AuditPcContext + /** web的环境信息 */ + web_context?: AuditWebContext + /** android的环境信息 */ + android_context?: AuditAndroidContext +} + +export interface AuditDetail { + /** mac地址 */ + mc?: string + /** 设备模型 */ + device_model?: string + /** 操作系统 */ + os?: string + /** ip属地 */ + city?: string +} + +export interface AuditEventExtend { + /** 评论类型 */ + comment_type?: string + /** app信息 */ + app_detail?: string + /** 是否两步验证 */ + two_step_validation?: boolean + /** 登录方式 */ + login_method?: string + /** 创建新的{x}人会议/通话 */ + new_people_num_in_video?: number + /** 将{x}名外部用户加入/退出通话 */ + external_people_num_in_video?: number + /** 将{x}名外部用户加入/退出群组 */ + external_people_num_in_chat?: number + /** 创建{x}人数的群组 */ + join_group?: number + /** 解散{x}人数的群组 */ + quit_group?: number + /** 分享文档给{x}名外部用户 */ + external_people_num_in_doc_share?: number +} + +export interface AuditInfo { + /** 事件id */ + event_id?: string + /** 唯一id */ + unique_id?: string + /** 事件名称 */ + event_name: string + /** 用户所属部门的ID列表 */ + department_ids?: string[] + /** 模块 */ + event_module: number + /** 操作人类型 */ + operator_type?: 0 | 1 + /** 操作人id */ + operator_value?: string + /** 操作对象列表 */ + objects?: AuditObjectEntity[] + /** 接收者对象列表 */ + recipients?: AuditRecipientEntity[] + /** 事件时间 */ + event_time?: number + /** ip信息 */ + ip?: string + /** 第三方isvID */ + operator_app?: string + /** 环境信息 */ + audit_context?: AuditContext + /** 事件级别的扩展 */ + extend?: AuditEventExtend + /** 第三方isv名称 */ + operator_app_name?: string + /** 扩展字段信息 */ + common_drawers?: ApiAuditCommonDrawers + /** 日志扩展信息 */ + audit_detail?: AuditDetail + /** 操作人企业编号 */ + operator_tenant?: string + /** 操作人详情 */ + operator_detail?: OperatorDetail +} + +export interface AuditIosContext { + /** UDID */ + udid?: string + /** 设备ID */ + did?: string + /** app的版本 */ + app_ver?: string + /** SecSDK版本 */ + ver?: string + /** 系统类型及版本 */ + os?: string + /** 系统时区 */ + STZone?: string + /** 当前语言 */ + ML?: string + /** 是否越狱 */ + sjd?: string + /** 代理ip */ + proxyip?: string + /** wifi ip */ + wifip?: string + /** GPS经纬度 */ + location?: string + /** 当前设备活跃ip */ + active_ip?: string + /** 当前设备活跃ip对应网卡类型 */ + active_ip_detail?: string + /** 基站信息 */ + cell_base_station?: string + /** 公网ip */ + IP?: string +} + +export interface AuditLogDetail { + /** 审计日志ID */ + log_id?: string + /** 日志基础信息 */ + basic_info?: BasicInfo + /** 审计日志操作信息 */ + op_info?: AuditLogOpInfo + /** 登录类型信息 */ + login_info?: AuditLogLoginInfo + /** 设备信息 */ + device_info?: AuditLogDeviceInfo + /** 网络信息 */ + net_info?: AuditLogNetInfo +} + +export interface AuditLogDeviceInfo { + /** 设备ID */ + device_id?: string + /** web端设备ID */ + web_device_id?: string + /** 终端类型：13002-PC类型；13003-Web类型 */ + terminal_type?: string + /** 系统类型：14002-window；14001-未知 */ + os_type?: string + /** 系统版本 */ + os_version?: string +} + +export interface AuditLogEsField { + /** 审计日志ID */ + log_id?: string + /** 操作时间 */ + op_time?: string + /** 日志类型:10000-全部类型;10001-企业管理; 10002-登录日志;10003-应用管理 */ + log_type?: string + /** 操作人 */ + operator?: LookupWithAvatar + /** 是否为外部用户,true代表是外部用户 */ + outsider?: boolean + /** 登录类型:11001-飞书登录;11003-账号密码登录 */ + login_type?: string + /** 飞书租户ID */ + lark_tenant_id?: string + /** apaas租户ID */ + apaas_tenant_id?: string + /** 用户地理信息 */ + user_geo?: string + /** 客户端IP */ + client_ip?: string + /** IP位置 */ + ip_loc?: string + /** IP提供商 */ + ip_provider?: string + /** 引用页面 */ + referer?: string + /** 源页面 */ + origin?: string + /** 路由路径 */ + api_path?: string + /** 网关路径 */ + full_path?: string + /** 用户代理 */ + user_agent?: string + /** 设备ID */ + device_id?: string + /** web端设备ID */ + web_device_id?: string + /** 终端类型:13002-PC类型;13003-Web类型 */ + terminal_type?: string + /** 系统类型:14002-window;14001-未知 */ + os_type?: string + /** 系统版本 */ + os_version?: string + /** 功能模块 */ + module?: string + /** 数据对象 */ + data_object?: string + /** 审计域:15001-企业管理后台;15002-应用管理后 台;15003-应用开发平台 */ + audit_scope?: string + /** 租户ID */ + tenant_id?: string + /** 应用唯一标识 */ + namespace?: string + /** 环境类型:16001-沙箱环境;16003-线上环境 */ + env_type?: string + /** 事件类型 */ + op_type?: string + /** 操作详情内容 */ + op_detail?: I18nText + /** 操作源:20001-前端;20004-openapi */ + op_source?: string + /** 操作状态:18001-成功;18002-失败 */ + status?: string + /** 失败原因 */ + failed_reason_i18n?: I18nText + /** 数据变化(旧值和新值) */ + data_changes?: string[] + /** 应用名称 */ + app_name?: I18nText + /** 应用版本号 */ + keyword_field_app_version?: string + /** 审计日志事件子模块 */ + keyword_field_functional_sub_module?: string +} + +export interface AuditLogLoginInfo { + /** 登录类型：11001-飞书登录；11003-账号密码登录 */ + login_type?: string +} + +export interface AuditLogNetInfo { + /** 客户端IP */ + client_ip?: string + /** IP位置 */ + ip_loc?: string + /** IP提供商 */ + ip_provider?: string + /** 引用页面 */ + referer?: string + /** 源页面 */ + origin?: string + /** 用户代理 */ + user_agent?: string +} + +export interface AuditLogOpInfo { + /** 操作人 */ + operator?: LookupWithAvatar + /** 是否为外部用户，true代表是外部用户 */ + outsider?: boolean + /** 操作详情内容 */ + op_detail?: I18nText + /** 操作状态：18001-成功；18002-失败 */ + status?: string + /** 失败原因 */ + failed_reason?: string + /** 多语类型失败原因 */ + failed_reason_i18n?: I18nText + /** 操作时间 */ + op_time?: string + /** 数据对象 */ + data_object?: string + /** 操作源：20001-前端；20004-openapi */ + op_source?: string + /** 数据变化(旧值和新值) */ + data_changes?: string[] +} + +export interface AuditObjectDetail { + /** 克隆来源 */ + clone_source?: string + /** 其他文本 */ + text_detail?: string + /** 文件名称 */ + file_name?: string + /** 第三方APPID */ + third_party_appID?: string + /** 文件或文件夹数量 */ + contain_file_num?: number + /** 链接分享设置 */ + permission_setting_type?: string + /** 是否开启外部访问设置 */ + permission_external_access_Type?: boolean + /** 分享设置 */ + permission_share_type?: string + /** file上传业务来源 */ + file_service_source?: string + /** 下载OKR时的内容范围 */ + okr_download_content?: string + /** 容器类型，标识是否wiki */ + container_type?: string + /** 容器id，wiki标识字段 */ + container_id?: string + /** 截屏、录制的开始页面 */ + current_page?: string +} + +export interface AuditObjectEntity { + /** 操作对象类型 */ + object_type?: string + /** 操作对象值，可能存在department_id、user_id等，需要进行lark_id的转换 */ + object_value?: string + /** 操作对象名称，如会话名、文档名等 */ + object_name?: string + /** 操作对象的所有者 */ + object_owner?: string + /** object 详情 */ + object_detail?: AuditObjectDetail +} + +export interface AuditPcContext { + /** UDID */ + udid?: string + /** 设备ID */ + did?: string + /** app的版本 */ + app_ver?: string + /** SecSDK版本 */ + ver?: string + /** 客户端类型 */ + os?: string + /** wifi ip */ + wifip?: string + /** 设备区域 */ + region?: string + /** 公网ip */ + IP?: string +} + +export interface AuditRecipientDetail { + /** 修改权限协作者 */ + permission_action_type?: string +} + +export interface AuditRecipientEntity { + /** 接收者对象类型 */ + recipient_type?: string + /** 接收者对象值，可能存在department_id、user_id等，需要进行lark_id的转换 */ + recipient_value?: string + /** recipient 详情 */ + recipient_detail?: AuditRecipientDetail +} + +export interface AuditWebContext { + /** UA信息 */ + user_agent?: string + /** 本机IP */ + IP?: string +} + +export interface Avatar { + /** 企业头像 */ + avatar_origin?: string + /** 企业头像 72x72 */ + avatar_72?: string + /** 企业头像 240x240 */ + avatar_240?: string + /** 企业头像 640x640 */ + avatar_640?: string +} + +export interface AvatarInfo { + /** 72*72像素头像链接 */ + avatar_72?: string + /** 240*240像素头像链接 */ + avatar_240?: string + /** 640*640像素头像链接 */ + avatar_640?: string + /** 原始头像链接 */ + avatar_origin?: string +} + +export interface BackgroundCheckCustomFieldDataValue { + /** 对应模板字段的Key */ + key?: string + /** 对应模板字段的value */ + value?: string +} + +export interface BackgroundCheckItemInfo { + /** 附加项的ID */ + id?: string + /** 附加项的名称 */ + name?: string +} + +export interface BackgroundCheckOrder { + /** 背调 ID */ + order_id?: string + /** 投递 ID */ + application_id?: string + /** 背调状态 */ + order_status?: 2 | 3 | 4 + /** 供应商类型 */ + account_third_type?: 1 | 2 | 3 | 127 + /** 背调套餐 */ + package?: string + /** 背调名称（仅手动录入的背调结果具有） */ + name?: string + /** 背调报告信息列表 */ + feedback_info_list?: BackgroundCheckOrderFeedbackInfo[] + /** 进度 */ + process_info_list?: BackgroundCheckOrderProcessInfo[] + /** 录入时间（仅手动录入的背调结果具有） */ + upload_time?: string + /** 候选人信息 */ + candidate_info?: UserContactInfo + /** 背调发起人信息 */ + creator_info?: BackgroundCheckOrderCreator + /** 背调联系人信息 */ + contactor_info?: UserContactInfo + /** 背调发起时间 */ + begin_time?: string + /** 背调结束时间 */ + end_time?: string + /** 背调结论 */ + conclusion?: string + /** 供应商信息 */ + provider_info?: ProviderIdNameObject + /** 自定义字段模板 */ + custom_field_list?: EcoBackgroundCheckCustomFieldData[] + /** 自定义字段值 */ + custom_data_list?: BackgroundCheckCustomFieldDataValue[] + /** 背调调查附加项 */ + ext_item_info_list?: BackgroundCheckItemInfo[] + /** 订单更新时间 */ + update_time?: string + /** 属地 */ + geo?: 'cn' | 'sg' | 'us' | 'jp' + /** 国家城市编码 */ + location_code?: string + /** 备注 */ + remark?: string +} + +export interface BackgroundCheckOrderCreator { + /** 创建人ID */ + user_id?: string +} + +export interface BackgroundCheckOrderFeedbackInfo { + /** 背调报告ID */ + id?: string + /** 背调信息附件下载链接 */ + attachment_url?: string + /** 背调信息附件预览链接 */ + report_preview_url?: string + /** 背调结果：红灯、黄灯、绿灯 */ + result?: string + /** 报告类型 */ + report_type?: 1 | 2 + /** 创建时间 */ + create_time?: string + /** 报告名称 */ + report_name?: string +} + +export interface BackgroundCheckOrderProcessInfo { + /** 背调进度 */ + process?: string + /** 进度更新时间 */ + update_time?: string + /** 英文背调进度 */ + en_process?: string +} + +export interface Badge { + /** 租户内勋章的唯一标识，该值由系统随机生成。 */ + id?: string + /** 租户内唯一的勋章名称，最多30个字符。 */ + name: string + /** 勋章的描述文案，最多100个字符。 */ + explanation?: string + /** 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ + detail_image: string + /** 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。 */ + show_image: string + /** 勋章的多语言名称，同name字段限制，最多30个字符。 */ + i18n_name?: I18n + /** 勋章的多语言描述文案，同explanation字段限制，最多100个字符。 */ + i18n_explanation?: I18n +} + +export interface BaikeImage { + /** 通过文件接口上传后的图片 token */ + token: string +} + +export interface Bank { + /** 银行 ID */ + bank_id?: string + /** 银行名称 */ + bank_name?: I18n[] + /** 总行代码 */ + bank_code?: string + /** 国家/地区 ID，可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询 */ + country_region_id?: string + /** 状态 */ + status?: 1 | 0 + /** 创建时间 */ + create_time?: string + /** 更新时间 */ + update_time?: string +} + +export interface BankAccount { + /** 银行名称 */ + bank_name?: string + /** 银行账号 */ + bank_account_number: string + /** 开户人姓名 */ + account_holder: string + /** 支行名称 */ + branch_name?: string + /** 银行 ID，详细信息可通过【查询银行信息】接口查询获得 */ + bank_id_v2?: string + /** 支行 ID，要求必须为填入银行的支行，详细信息可通过【查询支行信息】接口查询获得 */ + branch_id_v2?: string + /** 国家/地区 ID，详细信息可通过【查询国家/地区信息】接口查询获得 */ + country_region_id?: string + /** 银行卡用途，枚举值可通过文档【飞书人事枚举常量】银行卡用途（Bank Account Usage）枚举定义部分获得 */ + bank_account_usage?: Enum[] + /** 银行卡类型，枚举值可通过文档【飞书人事枚举常量】银行卡类型（Bank Account Type）枚举定义部分获得 */ + bank_account_type?: Enum + /** 分配方式，枚举值可通过文档【飞书人事枚举常量】分配方式（Payment Type）枚举定义部分获得 */ + payment_type?: Enum + /** 分配比例 */ + payment_rate?: string + /** 分配金额 */ + payment_amount?: string + /** 分配优先级 */ + priority?: number + /** 货币id */ + currency_id?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] +} + +export interface BankAccountForUpdate { + /** 银行名称：- 当填入 bank_id 时，自动填入 bank 的名称 - 未填入 bank_id ，取传入的银行名称 */ + bank_name?: string + /** 支行名称，仅当支行为手动输入时该字段才需要填入 */ + branch_name?: string + /** 银行账号 */ + bank_account_number: string + /** 开户人姓名 */ + account_holder: string + /** 国家/地区 ID，详细信息可通过【查询国家/地区信息】接口查询获得 */ + country_region_id?: string + /** 银行卡用途，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可：- object_api_name = "bank_account" - custom_api_name = "bank_account_usage" */ + bank_account_usages?: string[] + /** 银行卡类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可：- object_api_name = "bank_account" - custom_api_name = "bank_account_type" */ + bank_account_type?: string +} + +export interface BankBranch { + /** 支行 ID */ + bank_branch_id?: string + /** 支行名称 */ + bank_branch_name?: I18n[] + /** 所属银行 ID，可通过[查询银行信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search)接口查询 */ + bank_id?: string + /** 金融分支机构编码（联行号） */ + code?: string + /** SWIFT 银行代码（ISO 9362） */ + swift_code?: string + /** 状态 */ + status?: 1 | 0 + /** Bank Branch Code（特定国家地区汇款使用的编码，如美国银行的 ABA Number、澳大利亚银行的 BSB Code、英国银行的 Sort Code） */ + bank_branch_code?: string + /** 注册地址 */ + register_place?: string + /** 银行地址 */ + bank_address?: string + /** 创建时间 */ + create_time?: string + /** 更新时间 */ + update_time?: string +} + +export interface BankCard { + /** 识别出的实体类型 */ + entities?: BankCardEntity[] +} + +export interface BankCardEntity { + /** 识别的字段种类 */ + type?: 'card_number' | 'date_of_expiry' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface BankEntity { + /** 账户名 */ + account_name?: string + /** 银行名称 */ + bank_name?: string + /** 账户ID */ + account_number?: string + /** 电话 */ + phone?: string + /** 联系人 */ + contacts?: string + /** 传真号码 */ + tax_number?: string + /** 联系地址 */ + address?: string + /** id号 */ + id_number?: string + /** 邮箱 */ + email?: string +} + +export interface BankInfo { + /** 甲乙方信息类型 */ + bank_type?: 'buy_bank' | 'sell_bank' | 'third_bank' | 'unceratin_bank' + /** 值 */ + value?: BankEntity +} + +export interface BaseAddress { + /** ID */ + id?: string + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string + /** 区域信息 */ + district?: BaseDistrict + /** 城市信息 */ + city?: BaseCity + /** 省信息 */ + state?: BaseCity + /** 国家信息 */ + country?: BaseCountry +} + +export interface BaseAddressV2 { + /** ID */ + id?: string + /** 名称 */ + name?: I18n + /** 区域信息 */ + district?: BaseLocation + /** 城市信息 */ + city?: BaseLocation + /** 省信息 */ + state?: BaseLocation + /** 国家信息 */ + country?: BaseLocation +} + +export interface BaseBilingualWithId { + /** ID */ + id?: string + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string +} + +export interface BaseCity { + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string + /** 编码 */ + code?: string + /** 地址类型 1=COUNTRY, 2=STATE, 3=CITY, 4=DISTRICT, 5=ADDRESS, */ + location_type?: 1 | 2 | 3 | 4 | 5 +} + +export interface BaseCountry { + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string + /** 编码 */ + code?: string + /** 地址类型 1=COUNTRY, 2=STATE, 3=CITY, 4=DISTRICT, 5=ADDRESS, */ + location_type?: 1 | 2 | 3 | 4 | 5 +} + +export interface BaseDistrict { + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string + /** 编码 */ + code?: string + /** 地址类型 1=COUNTRY, 2=STATE, 3=CITY, 4=DISTRICT, 5=ADDRESS, */ + location_type?: number +} + +export interface BaseLocation { + /** 名称 */ + name?: I18n + /** 编码 */ + code?: string + /** 地址类型 1=COUNTRY, 2=STATE, 3=CITY, 4=DISTRICT, 5=ADDRESS, */ + location_type?: 1 | 2 | 3 | 4 | 5 +} + +export interface BaseMember { + /** 协作者ID类型 */ + member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid' + /** 协作者ID，与协作者ID类型需要对应 */ + member_id: string + /** 协作者的权限角色 */ + perm: 'view' | 'edit' | 'full_access' + /** 协作者的权限角色类型 */ + perm_type?: 'container' | 'single_page' + /** 协作者类型 */ + type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor' +} + +export interface BasicDepartmentInfo { + /** 部门 ID */ + id?: string + /** 部门名称 */ + name?: I18n +} + +export interface BasicInfo { + /** 日志类型：10000-全部类型；10001-企业管理；10002-登录日志；10003-应用管理 */ + log_type?: string + /** 审计域：15001-企业管理后台；15002-应用管理后台；15003-应用开发平台 */ + audit_scope?: string + /** 环境类型：16001-沙箱环境；16003-线上环境 */ + env_type?: string + /** 应用id */ + app_id?: string + /** 审计日志功能模块 */ + module?: string + /** 事件类型 */ + op_type?: string + /** 应用名称 */ + app_name?: I18nText +} + +export interface BasicInfoUpdate { + /** 姓名,该值是一个list，会全量更新 */ + names?: NameForUpdate[] + /** 电话,该值是一个list，会全量更新 */ + phones?: PhoneForUpdate[] + /** 邮箱,该值是一个list，会全量更新 */ + emails?: EmailForUpdate[] + /** 国籍 */ + nationality_v2_id?: string + /** 其他国籍 */ + additional_nationality_id_list?: string[] + /** 纳税身份信息,该值是一个list，会全量更新 */ + resident_tax_list?: ResidentTaxForUpdate[] + /** 出生国家/地区 */ + born_country_region?: string + /** 是否残疾 */ + is_disabled?: boolean + /** 残疾证号 */ + disable_card_number?: string + /** 是否孤老 */ + is_old_alone?: boolean + /** 是否烈属 */ + is_martyr_family?: boolean + /** 烈属证号 */ + martyr_card_number?: string + /** 家庭成员 */ + dependent_list?: DependentForUpdate[] + /** 宗教信仰 */ + religion?: string + /** 银行账号 */ + bank_account_list?: BankAccountForUpdate[] + /** 证件账号 */ + national_id_list?: NationalIdForUpdate[] + /** 个人资料 */ + personal_profile_list?: PersonalProfileForUpdate[] + /** 紧急联系人 */ + emergency_contact_list?: EmergencyContactForUpdate[] + /** 联系地址 */ + address_list?: AddressForUpdate[] + /** 婚姻状况 */ + marital_status?: string + /** 民族 / 种族 */ + ethnicity_race?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 籍贯 */ + native_region?: string + /** 户口类型 */ + hukou_type?: string + /** 户口所在地 */ + hukou_location?: string +} + +export interface BasicUserInfo { + /** 用户 ID */ + id?: string + /** 用户名称 */ + name?: I18n +} + +export interface BatchMessageReadUser { + /** 已读人数 */ + read_count: string + /** 总人数 */ + total_count: string +} + +export interface BatchMessageRecallProgress { + /** 该条批量消息是否被执行过撤回操作 */ + recall?: boolean + /** 已经成功撤回的消息数量 */ + recall_count?: number +} + +export interface BatchMessageSendProgress { + /** 批量请求中有效的userid数量(包含机器人不可见用户) */ + valid_user_ids_count?: number + /** 已经成功给用户发送成功的消息数量 */ + success_user_ids_count?: number + /** 已读信息用户数量 */ + read_user_ids_count?: number +} + +export interface Bitable { + /** 多维表格文档 Token。格式为 {BitableToken}_{TableID}，其中 BitableToken 是一篇多维表格的唯一标识，TableID 是一张数据表的唯一标识，使用时请注意拆分。 */ + token?: string +} + +export interface Block { + /** Block 唯一标识 */ + block_id?: string + /** block 的父亲 id */ + parent_id?: string + /** block 的孩子 id 列表 */ + children?: string[] + /** block 类型 */ + block_type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 999 + /** 文档 Block */ + page?: Text + /** 文本 Block */ + text?: Text + /** 一级标题 Block */ + heading1?: Text + /** 二级标题 Block */ + heading2?: Text + /** 三级标题 Block */ + heading3?: Text + /** 四级标题 Block */ + heading4?: Text + /** 五级标题 Block */ + heading5?: Text + /** 六级标题 Block */ + heading6?: Text + /** 七级标题 Block */ + heading7?: Text + /** 八级标题 Block */ + heading8?: Text + /** 九级标题 Block */ + heading9?: Text + /** 无序列表 Block */ + bullet?: Text + /** 有序列表 Block */ + ordered?: Text + /** 代码块 Block */ + code?: Text + /** 引用 Block */ + quote?: Text + /** 公式 Block */ + equation?: Text + /** 任务 Block */ + todo?: Text + /** 多维表格 Block */ + bitable?: Bitable + /** 高亮块 Block */ + callout?: Callout + /** 群聊卡片 Block */ + chat_card?: ChatCard + /** 流程图/UML Block */ + diagram?: Diagram + /** 分割线 Block */ + divider?: Divider + /** 文件 Block */ + file?: File + /** 分栏 Block */ + grid?: Grid + /** 分栏列 Block */ + grid_column?: GridColumn + /** 内嵌 Block */ + iframe?: Iframe + /** 图片 Block */ + image?: Image + /** 三方 Block */ + isv?: Isv + /** Add-ons */ + add_ons?: AddOns + /** 思维笔记 Block */ + mindnote?: Mindnote + /** 电子表格 Block */ + sheet?: Sheet + /** 表格 Block */ + table?: Table + /** 单元格 Block */ + table_cell?: TableCell + /** 视图 Block */ + view?: View + /** 未支持 Block */ + undefined?: Undefined + /** 引用容器 Block */ + quote_container?: QuoteContainer + /** 任务 Block */ + task?: Task + /** OKR Block */ + okr?: Okr + /** OKR Objective */ + okr_objective?: OkrObjective + /** OKR Key Result */ + okr_key_result?: OkrKeyResult + /** OKR 进展信息 */ + okr_progress?: OkrProgress + /** 评论 id 列表 */ + comment_ids?: string[] + /** Jira Issue */ + jira_issue?: JiraIssue + /** Wiki 子目录 Block */ + wiki_catalog?: WikiCatalog + /** 画板 Block */ + board?: Board + /** 议程 Block */ + agenda?: Agenda + /** 议程项 Block */ + agenda_item?: AgendaItem + /** 议程项标题 Block */ + agenda_item_title?: AgendaItemTitle + /** 议程项内容 Block */ + agenda_item_content?: AgendaItemContent + /** 链接预览 Block */ + link_preview?: LinkPreview +} + +export interface BlockAccessData { + /** 时间,精确到天,格式yyyy-MM-dd */ + date?: string + /** 小组件id */ + block_id?: string + /** block访问数据信息。 */ + access_data?: AccessData +} + +export interface BlockI18nInfo { + /** 国际化语言的 key */ + i18n_key?: 'zh_cn' | 'en_us' | 'ja_jp' + /** 名称 */ + name?: string +} + +export interface BlockIdRelation { + /** 用户传入的临时 BlockID */ + temporary_block_id?: string + /** 真实使用的 BlockID */ + block_id?: string +} + +export interface Board { + /** 画板 token */ + token?: string + /** 对齐方式 */ + align?: 1 | 2 | 3 + /** 宽度，单位 px；不填时自动适应文档宽度；值超出文档最大宽度时，页面渲染为文档最大宽度 */ + width?: number + /** 高度，单位 px；不填时自动根据画板内容计算；值超出屏幕两倍高度时，页面渲染为屏幕两倍高度 */ + height?: number +} + +export interface BodyEntity { + /** 地址 */ + address?: string + /** 联系人 */ + contacts?: string + /** 邮箱 */ + email?: string + /** 电话 */ + phone?: string + /** ID */ + id_number?: string + /** 法人代表 */ + legal_representative?: string + /** 当事人 */ + party?: string +} + +export interface BodyInfo { + /** 主体类型 */ + body_type?: 'buy' | 'sell' | 'third' + /** 值 */ + value?: BodyEntity +} + +export interface BonusAmount { + /** 奖励类型 */ + bonus_type: 1 | 2 + /** 积分奖励 */ + point_bonus?: number + /** 现金奖励 */ + cash?: Cash +} + +export interface Bot { + /** 消息卡片回调地址 */ + card_request_url?: string +} + +export interface Bp { + /** 部门 ID */ + department_id?: string + /** 部门 HRBP 的雇佣 ID，不包括上级部门的 HRBP */ + hrbp_id?: string +} + +export interface BpmDataengineI18n { + /** （注json key是zh-CN，不是zh_cn）i18n类型字段，中文值 */ + zh_cn?: string + /** （注json key是en-US，不是en_us）i18n类型字段，英文值 */ + en_us?: string +} + +export interface BpRoleOrganization { + /** 角色类型的唯一标识 */ + role_key: string + /** 部门 id */ + department_id: string + /** 工作地点 id */ + work_location_id?: string +} + +export interface BusinessEntity { + /** 识别的字段种类 */ + type?: 'certificate_type' | 'unified_social_credit_code' | 'company_name' | 'company_type' | 'domicile' | 'legal_representative' | 'registered_capital' | 'established_time' | 'established_date' | 'business_scope' | 'website' | 'approval_date' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface BusinessLicense { + /** 识别出的实体类型 */ + entities?: BusinessEntity[] +} + +export interface BusinessManagementScope { + /** 实体 */ + entity?: EntityInfo + /** 权限分组 */ + permission_groups?: PermissionGroupInfo[] +} + +export interface Calendar { + /** 日历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 CalendarAcl { + /** acl资源ID */ + acl_id: string + /** 对日历的访问权限 */ + role: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner' + /** 权限范围 */ + scope: AclScope +} + +export interface CalendarAttendeeResourceCustomization { + /** the unique key of customization option */ + index_key: string + /** should be filled when the type of customization is input */ + input_content?: string + /** 选项 */ + options?: CustomizationOption[] +} + +export interface CalendarEvent { + /** 日程ID */ + event_id: string + /** 日程组织者日历ID */ + organizer_calendar_id?: string + /** 日程标题 */ + summary?: string + /** 日程描述 */ + description?: string + /** 日程开始时间 */ + start_time: TimeInfo + /** 日程结束时间 */ + end_time: TimeInfo + /** 视频会议信息，仅当日程至少有一位attendee时生效 */ + vchat?: Vchat + /** 日程公开范围，新建日程默认为Default；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ + visibility?: 'default' | 'public' | 'private' + /** 参与人权限 */ + attendee_ability?: 'none' | 'can_see_others' | 'can_invite_others' | 'can_modify_event' + /** 日程占用的忙闲状态，新建日程默认为Busy；仅新建日程时对所有参与人生效，之后修改该属性仅对当前身份生效 */ + free_busy_status?: 'busy' | 'free' + /** 日程地点 */ + location?: EventLocation + /** 日程颜色，颜色RGB值的int32表示。仅对当前身份生效；客户端展示时会映射到色板上最接近的一种颜色；值为0或-1时默认跟随日历颜色。 */ + color?: number + /** 日程提醒列表 */ + reminders?: Reminder[] + /** 重复日程的重复性规则 */ + recurrence?: string + /** 日程状态 */ + status?: 'tentative' | 'confirmed' | 'cancelled' + /** 日程是否是一个重复日程的例外日程 */ + is_exception?: boolean + /** 例外日程的原重复日程的event_id */ + recurring_event_id?: string + /** 日程的创建时间戳 */ + create_time?: string + /** 日程自定义信息 */ + schemas?: Schema[] + /** 日程组织者信息 */ + event_organizer?: EventOrganizer + /** 日程的app_link,跳转到具体的某个日程 */ + app_link?: string + /** 日程附件 */ + attachments?: Attachment[] +} + +export interface CalendarEventAttendee { + /** 参与人类型，仅当新建参与人时可设置类型
type为User时，值为open_id/user_id/union_id
type为Chat时，值为open_chat_id
type为Resource时，值为open_room_id
type为ThirdParty时，值为third_party_email；不支持通过API新建该类型参与人 */ + type?: 'user' | 'chat' | 'resource' | 'third_party' + /** 参与人是否为「可选参加」，无法编辑群参与人的此字段 */ + is_optional?: boolean + /** 参与人的用户id，依赖于user_id_type返回对应的取值，当is_external为true时，此字段只会返回open_id或者union_id */ + user_id?: string + /** chat类型参与人的群组chat_id */ + chat_id?: string + /** resource类型参与人的会议室room_id */ + room_id?: string + /** third_party类型参与人的邮箱 */ + third_party_email?: string + /** bot身份操作时，为预定的会议室指定实际预定人 */ + operate_id?: string + /** 会议室的个性化配置 */ + resource_customization?: CalendarAttendeeResourceCustomization[] + /** 会议室审批原因 */ + approval_reason?: string +} + +export interface CalendarEventAttendeeChatMember { + /** 参与人RSVP状态 */ + rsvp_status?: 'needs_action' | 'accept' | 'tentative' | 'decline' | 'removed' + /** 参与人是否为「可选参加」 */ + is_optional?: boolean + /** 参与人名称 */ + display_name?: string + /** 用户open_id */ + open_id?: string + /** 参与人是否为日程组织者 */ + is_organizer?: boolean + /** 参与人是否为外部参与人 */ + is_external?: boolean +} + +export interface CalendarEventAttendeeId { + /** 参与人类型，仅当新建参与人时可设置类型
type为User时，值为open_id/user_id/union_id
type为Chat时，值为open_chat_id
type为Resource时，值为open_room_id
type为ThirdParty时，值为third_party_email；不支持通过API新建该类型参与人 */ + type?: 'user' | 'chat' | 'resource' | 'third_party' + /** 参与人的用户id，依赖于user_id_type返回对应的取值，当is_external为true时，此字段只会返回open_id或者union_id */ + user_id?: string + /** chat类型参与人的群组chat_id */ + chat_id?: string + /** resource类型参与人的会议室room_id */ + room_id?: string + /** third_party类型参与人的邮箱 */ + third_party_email?: string +} + +export interface Callout { + background_color?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 + border_color?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + text_color?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 高亮块图标 */ + emoji_id?: string +} + +export interface CampusVolumnteerInfo { + /** 志愿顺序 */ + volunteer_seq?: number +} + +export interface Card { + /** 卡片数据的类型 */ + type: 'card_json' + /** 卡片数据内容，与卡片数据的类型相对应 */ + data: string +} + +export interface Cash { + /** 币种 */ + currency_type: string + /** 数额 */ + amount: number +} + +export interface Category { + /** category id */ + category_id: string + /** category id, for backward compatibility */ + id: string + /** category name */ + name: string + /** parent category id, if any */ + parent_id: string + /** helpdesk id */ + helpdesk_id: string + /** category language */ + language?: string +} + +export interface CcNode { + /** 审批实例内唯一标识 */ + cc_id: string + /** 抄送人 employee id */ + user_id?: string + /** 抄送人 open id，和user id 二选一 */ + open_id?: string + /** 跳转链接，用于【抄送我的】列表中的跳转pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ + links: ExternalInstanceLink + /** 阅读状态，空值表示不支持已读未读： */ + read_status: 'READ' | 'UNREAD' + /** 扩展 json */ + extra?: string + /** 抄送任务名称 */ + title?: string + /** 抄送发起时间，Unix 毫秒时间戳 */ + create_time: string + /** 抄送最近更新时间，用于推送数据版本控制更新策略同 instance 的update_time */ + update_time: string + /** 列表页打开审批任务的方式 */ + display_method?: 'BROWSER' | 'SIDEBAR' | 'NORMAL' | 'TRUSTEESHIP' +} + +export interface CcSearchItem { + /** 审批定义 */ + approval?: InstanceSearchApproval + /** 审批定义分组 */ + group?: InstanceSearchGroup + /** 审批实例信息 */ + instance?: InstanceSearchNode + /** 审批任务 */ + cc?: CcSearchNode +} + +export interface CcSearchNode { + /** 审批实例发起人 id */ + user_id?: string + /** 审批实例开始时间 */ + create_time?: string + /** 审批实例状态 */ + read_status?: 'read' | 'unread' + /** 审批实例名称（只有第三方审批有） */ + title?: string + /** 审批实例扩展字段，string型json */ + extra?: string + /** 审批实例链接（只有第三方审批有） */ + link?: InstanceSearchLink +} + +export interface ChangeFieldPair { + /** 调整前 */ + origin_value?: CustomFieldData + /** 调整后 */ + target_value?: CustomFieldData +} + +export interface ChangeReason { + /** 调薪原因ID */ + id: string + /** 调薪原因名称 */ + name: string + /** 调薪原因备注 */ + note: string + /** 启用状态 */ + active_status: 1 | 0 + /** 多语言名称 */ + i18n_names: I18nContent[] + /** 多语言描述 */ + i18n_notes: I18nContent[] +} + +export interface Channel { + /** 自定义传入的变量 */ + variables?: string +} + +export interface ChatCard { + /** 群聊天会话 ID */ + chat_id: string + /** 对齐方式 */ + align?: 1 | 2 | 3 +} + +export interface ChatMenuItem { + /** 菜单类型 */ + action_type: 'NONE' | 'REDIRECT_LINK' + /** 跳转链接 */ + redirect_link?: ChatMenuItemRedirectLink + /** image_key */ + image_key?: string + /** 名称 */ + name: string + /** 国际化名称，一级菜单名称字符数要在1到8范围内，二级菜单名称字符数要在1到24范围内。

**注意：**
1中文=2英文=2其他语言字符=2字符 */ + i18n_names?: I18nNames +} + +export interface ChatMenuItemRedirectLink { + common_url?: string + ios_url?: string + android_url?: string + pc_url?: string + web_url?: string +} + +export interface ChatMenuSecondLevel { + /** 二级菜单信息 */ + chat_menu_item?: ChatMenuItem +} + +export interface ChatMenuTopLevel { + /** 一级菜单信息 */ + chat_menu_item: ChatMenuItem + /** 二级菜单列表 */ + children?: ChatMenuSecondLevel[] +} + +export interface ChatMenuTree { + /** 一级菜单列表 */ + chat_menu_top_levels: ChatMenuTopLevel[] +} + +export interface ChatTab { + /** Tab名称 */ + tab_name?: string + /** Tab类型 */ + tab_type: 'message' | 'doc_list' | 'doc' | 'pin' | 'meeting_minute' | 'chat_announcement' | 'url' | 'file' | 'files_resources' | 'images_videos' | 'task' + /** Tab内容 */ + tab_content?: ChatTabContent + /** Tab的配置 */ + tab_config?: ChatTabConfig +} + +export interface ChatTabConfig { + /** 群Tab图标 */ + icon_key?: string + /** 群tab是否App内嵌打开 */ + is_built_in?: boolean +} + +export interface ChatTabContent { + /** URL类型 */ + url?: string + /** Doc链接 */ + doc?: string + /** 会议纪要 */ + meeting_minute?: string + /** 任务 */ + task?: string +} + +export interface ChatTopNotice { + /** 置顶的类型 */ + action_type?: '1' | '2' + /** 消息ID */ + message_id?: string +} + +export interface CheckFailedAccountInfo { + /** 账户ID */ + account_id?: string + /** 招聘系统内的提取金额 */ + total_withdraw_reward_info?: BonusAmount + /** 商城实际充值金额 */ + total_recharge_reward_info?: BonusAmount +} + +export interface ChildField { + /** 统计数据子字段code */ + code: string + /** 统计数据子字段名称 */ + title: string + /** 时间单位 */ + time_unit?: string +} + +export interface ChildItem { + /** 二级表头code */ + code: string + /** 值 */ + value: string +} + +export interface ChinesePassport { + /** 识别出的实体类型 */ + entities?: ChinesePassportEntity[] +} + +export interface ChinesePassportEntity { + /** 识别的字段种类 */ + type?: 'full_name_cn' | 'full_name_en' | 'date_of_birth' | 'date_of_expiry' | 'place_of_issue' | 'passport_number' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface City { + /** 城市 ID */ + city_id?: string + /** 城市名称 */ + name?: I18n[] + /** 所属省份/主要行政区 ID，详细信息可通过[查询省份/主要行政区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获得 */ + country_region_subdivision_id?: string + /** 城市三位字母代码 */ + code?: string + /** 行政区划代码 */ + subregion_code?: string + /** 状态 */ + status?: 1 | 0 +} + +export interface Classification { + /** 唯一分类 ID */ + id: string + /** 父级分类的 ID */ + father_id?: string +} + +export interface ClassificationFilter { + /** 需要获取的分类 */ + include?: string[] + /** 需要排除的分类 */ + exclude?: string[] +} + +export interface ClientBadgeNum { + /** h5能力的badge数量 */ + web_app?: number + /** 小程序能力的badge数量 */ + gadget?: number +} + +export interface CloudDoc { + /** 云空间重定向 url */ + space_url?: string + /** 国际化信息 */ + i18n?: CloudDocI18nInfo[] + /** 图标链接 */ + icon_url?: string + /** 云文档支持模式 */ + mode?: 0 | 1 +} + +export interface CloudDocI18nInfo { + /** 国际化语言的 key */ + i18n_key: 'zh_cn' | 'en_us' | 'ja_jp' + /** 云文档国际化名称 */ + name?: string + /** 云文档国际化读权限说明 */ + read_description?: string + /** 云文档国际化写权限说明 */ + write_description?: string +} + +export interface CodeNameObject { + /** 编码 */ + code?: string + /** 名称 */ + name?: I18n +} + +export interface Collaborator { + /** 任务协作者的 ID */ + id?: string + /** 协作人的用户ID列表 */ + id_list?: string[] +} + +export interface CombinedJobObjectValueMap { + /** 结构 ID */ + object_id?: string + /** 结构值 */ + value?: string +} + +export interface CombinedJobResultDefaultJobPost { + /** 默认职位广告的 ID，用以发布至招聘渠道的内容 */ + id?: string +} + +export interface Comment { + /** 评论ID */ + id: string + /** 评论内容 */ + content: string + /** 评论创建时间 */ + create_time: string + /** 评论更新时间 */ + update_time: string + /** 是否删除，0:未删除，1:已删除 */ + is_delete: number + /** 评论的回复 */ + replies?: CommentReply[] + /** 评论中艾特人信息 */ + at_info_list?: CommentAtInfo[] + /** 评论创建人 */ + commentator: string + /** 附加字段 */ + extra?: string +} + +export interface CommentAtInfo { + /** 被艾特人的ID */ + user_id: string + /** 被艾特人的姓名 */ + name: string + /** 被艾特人在评论中的位置，从0开始 */ + offset: string +} + +export interface CommentReply { + /** 评论ID */ + id: string + /** 评论内容 */ + content: string + /** 评论创建时间 */ + create_time?: string + /** 评论更新时间 */ + update_time?: string + /** 是否删除，0:未删除，1:已删除 */ + is_delete: number + /** 评论中艾特人信息 */ + at_info_list?: CommentAtInfo[] + /** 评论创建人 */ + commentator: string + /** 附加字段 */ + extra?: string +} + +export interface Comments { + /** 备注 */ + content?: string + /** 备注时间，单位毫秒 */ + created_at?: number + /** 备注ID */ + id?: number + /** 备注人头像 */ + user_avatar_url?: string + /** 备注人姓名 */ + user_name?: string + /** 备注人ID */ + user_id?: number +} + +export interface CommonAddress { + /** ID */ + id?: string + /** 名称 */ + name?: I18n + /** 区域信息 */ + district?: CodeNameObject + /** 城市信息 */ + city?: CodeNameObject + /** 省信息 */ + state?: CodeNameObject + /** 国家信息 */ + country?: CodeNameObject +} + +export interface CommonFilter { + /** 筛选项 key */ + key: string + /** 筛选项值类型 */ + value_type: 1 | 2 | 3 + /** 筛选项值列表 */ + value_list?: string[] + /** 范围筛选 */ + range_filter?: RangeFilter +} + +export interface CommonSchema { + /** 模块 ID */ + id?: string + /** 模块名称 */ + name?: I18n + /** 模块描述 */ + description?: I18n + /** 模块信息 */ + setting?: CommonSchemaSetting + /** 是否是自定义模块 */ + is_customized?: boolean + /** 是否必填 */ + is_required?: boolean + /** 是否启用 */ + active_status?: 1 | 2 + /** 字段列表 */ + children_list?: CommonSchemaChild[] +} + +export interface CommonSchemaChild { + /** 字段 ID */ + id?: string + /** 字段名称 */ + name?: I18n + /** 字段描述 */ + description?: I18n + /** 字段信息 */ + setting?: CommonSchemaSetting + /** 所属模块 ID */ + parent_id?: string + /** 是否是自定义字段 */ + is_customized?: boolean + /** 是否必填 */ + is_required?: boolean + /** 是否启用 */ + active_status?: 1 | 2 +} + +export interface CommonSchemaConfig { + /** 选项信息 */ + options?: CommonSchemaOption[] +} + +export interface CommonSchemaOption { + /** 选项 ID */ + key?: string + /** 选项名称 */ + name?: I18n + /** 选项描述 */ + description?: I18n + /** 是否启用 */ + active_status?: 1 | 2 +} + +export interface CommonSchemaSetting { + /** 字段类型 */ + object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 13 + /** 配置信息 */ + config?: CommonSchemaConfig +} + +export interface Company { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 层级关系，内层字段见实体 */ + hiberarchy_common: HiberarchyCommon + /** 性质 */ + type?: Enum + /** 行业 */ + industry_list?: Enum[] + /** 法定代表人 */ + legal_representative?: I18n[] + /** 邮编 */ + post_code?: string + /** 纳税人识别号 */ + tax_payer_id?: string + /** confidential */ + confidential?: boolean + /** 主体类型 */ + sub_type_list?: Enum[] + /** 是否为分公司 */ + branch_company?: boolean + /** 主要负责人 */ + primary_manager?: I18n[] + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 默认币种 */ + currency?: Currency + /** 电话 */ + phone?: PhoneNumberAndAreaCode + /** 传真 */ + fax?: PhoneNumberAndAreaCode + /** 完整注册地址 */ + registered_office_address?: I18n[] + /** 完整办公地址 */ + office_address?: I18n[] + /** 注册地址详细信息 */ + registered_office_address_info?: Address + /** 办公地址详细信息 */ + office_address_info?: Address +} + +export interface CompensationCost { + /** 成本项值 */ + compensation_cost_value?: string + /** 成本项名称 */ + i18n_names?: I18nContent[] +} + +export interface CompensationCostItem { + /** 发薪人数 */ + number_of_individuals_for_payment?: number + /** 成本项数据 */ + compensation_costs?: CompensationCost[] +} + +export interface CompositeShape { + /** 基础图形的具体类型 */ + type: 'round_rect2' | 'ellipse' | 'hexagon' | 'cylinder' | 'parallelogram' | 'trapezoid' | 'triangle' | 'round_rect' | 'step' | 'diamond' | 'rect' | 'star' | 'bubble' | 'pentagon' | 'forward_arrow' | 'document_shape' | 'condition_shape' | 'cloud' | 'cross' | 'step2' | 'predefined_process' | 'delay_shape' | 'off_page_connector' | 'note_shape' | 'data_process' | 'data_store' | 'data_store2' | 'data_store3' | 'star2' | 'star3' | 'star4' | 'actor' | 'brace' | 'condition_shape2' | 'double_arrow' | 'data_flow_round_rect3' | 'rect_bubble' | 'manual_input' | 'flow_chart_round_rect' | 'flow_chart_round_rect2' | 'flow_chart_diamond' | 'flow_chart_parallelogram' | 'flow_chart_cylinder' | 'flow_chart_trapezoid' | 'flow_chart_hexagon' | 'data_flow_round_rect' | 'data_flow_ellipse' | 'backward_arrow' | 'brace_reverse' | 'flow_chart_mq' | 'horiz_cylinder' | 'class_interface' | 'classifier' | 'circular_ring' | 'pie' | 'right_triangle' | 'octagon' | 'state_start' | 'state_end' | 'state_concurrence' | 'component_shape' | 'component_shape2' | 'component_interface' | 'component_required_interface' | 'component_assembly' | 'cube' +} + +export interface CompositeTalentAwardInfo { + /** 名称 */ + award_name?: string + /** 获奖时间 */ + award_time?: string + /** 描述 */ + description?: string + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentBasicInfo { + /** 名字 */ + name: string + /** 手机 */ + mobile_number?: string + /** 手机国家区号 */ + mobile_code?: string + /** 邮箱 */ + email?: string + /** 工作年限 */ + experience_years?: number + /** 年龄 */ + age?: number + /** 国籍 */ + nationality_code?: string + /** 性别 */ + gender?: 1 | 2 | 3 + /** 所在地点 */ + current_location_code?: string + /** 家乡 */ + hometown_location_code?: string + /** 意向地点 */ + preferred_location_code_list?: string[] + /** 家庭住址 */ + home_address?: string + /** 证件类型 */ + identification_type?: 1 | 2 | 3 | 4 | 5 | 6 | 9 + /** 证件号 */ + identification_number?: string + /** 生日 */ + birthday?: number + /** 婚姻状况 */ + marital_status?: 1 | 2 + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] + /** 户口所在地 */ + hukou_location_code?: string + /** 人才更新时间 */ + update_time?: string + /** 人才创建时间 */ + create_time?: string + /** 人才隐藏状态 */ + confidential?: 1 | 2 +} + +export interface CompositeTalentCareerInfo { + /** 公司 */ + company_name?: string + /** 描述 */ + description?: string + /** 结束时间 */ + end_time?: string + /** 开始时间 */ + start_time?: string + /** 职称 */ + title?: string + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentCustomizedData { + /** 模块 ID */ + module_id?: string + /** 模块名称 */ + name?: I18n + /** 类型 */ + object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** 模块下的字段 */ + children?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentEducationInfo { + /** 学位 */ + degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 学校 */ + school_name?: string + /** 专业 */ + major?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 学历类型 */ + education_type?: 1 | 2 | 3 | 4 | 5 + /** 成绩排名 */ + academic_ranking?: 5 | 10 | 20 | 30 | 50 | -1 + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentInternshipInfo { + /** 公司 */ + company_name?: string + /** 描述 */ + description?: string + /** 结束时间 */ + end_time?: string + /** 开始时间 */ + start_time?: string + /** 职称 */ + title?: string + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentLanguageInfo { + /** 语言 */ + language?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 + /** 熟练程度 */ + proficiency?: 1 | 2 | 3 | 4 | 5 + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentProjectInfo { + /** 项目名称 */ + project_name?: string + /** 项目角色 */ + role?: string + /** 项目链接 */ + link?: string + /** 描述 */ + description?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentSnsInfo { + /** SNS类型 */ + sns_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** SNS链接 */ + link?: string + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface CompositeTalentWorksInfo { + /** ID */ + id?: string + /** 链接 */ + link?: string + /** 描述 */ + description?: string + /** 自定义字段 */ + customized_data_list?: TalentCustomizedDataChild[] +} + +export interface Condition { + /** 筛选类型 */ + filter_type: string + /** 比较类型 */ + compare_type?: string + /** 筛选参数 */ + expected: string[] +} + +export interface Connector { + /** 连线连接的起点图形 */ + start_object?: ConnectorAttachedObject + /** 连线连接的终点图形 */ + end_object?: ConnectorAttachedObject + /** 连线文本 */ + captions?: ConnectorCaption +} + +export interface ConnectorAttachedObject { + /** 连接图形的 id */ + id?: string +} + +export interface ConnectorCaption { + /** 文本 */ + data?: Text[] +} + +export interface ConnectorParam { + /** 回调时Request里面的id类型 */ + callback_user_id_type?: 0 | 1 | 2 | 3 + /** 回调时的地址，必须为POST地址 */ + callback_endpoint?: string +} + +export interface Contact { + contact_type?: 1 | 2 | 3 + /** 联系人名 */ + contact_name?: string +} + +export interface ContentBlock { + /** 文档结构是按行排列的，每行内容是一个 Block */ + blocks?: ContentBlockElement[] +} + +export interface ContentBlockElement { + /** 文档元素类型 */ + type?: 'paragraph' | 'gallery' + /** 文本段落 */ + paragraph?: ContentParagraph + /** 图片 */ + gallery?: ContentGallery +} + +export interface ContentColor { + /** 红 取值范围[0,255] */ + red?: number + /** 绿 取值范围[0,255] */ + green?: number + /** 蓝 取值范围[0,255] */ + blue?: number + /** 透明度 取值范围[0,1] */ + alpha?: number +} + +export interface ContentDocsLink { + /** 链接地址 */ + url?: string + /** 链接文案 */ + title?: string +} + +export interface ContentGallery { + /** 图片元素 */ + imageList?: ContentImageItem[] +} + +export interface ContentImageItem { + /** 图片 token，比如boxcnOj88GDkmWGm2zsTyCBqoLb，不支持编辑 */ + fileToken?: string + /** 图片链接 */ + src?: string + /** 图片宽，单位px */ + width?: number + /** 图片高，单位px */ + height?: number +} + +export interface ContentLink { + /** 链接地址 */ + url?: string +} + +export interface ContentList { + /** 列表类型 */ + type?: 'number' | 'bullet' | 'checkBox' | 'checkedBox' | 'indent' + /** 列表的缩进级别，支持指定一行的缩进 除代码块以外的列表都支持设置缩进，支持 1-16 级缩进，取值范围：[1,16] */ + indentLevel?: number + /** 用于指定列表的行号，仅对有序列表和代码块生效 如果为有序列表设置了缩进，行号可能会显示为字母或者罗马数字 */ + number?: number +} + +export interface ContentParagraph { + /** 段落样式 */ + style?: ContentParagraphStyle + /** 段落元素组成一个段落 */ + elements?: ContentParagraphElement[] +} + +export interface ContentParagraphElement { + /** 元素类型 */ + type?: 'textRun' | 'docsLink' | 'person' + /** 文本 */ + textRun?: ContentTextRun + /** 文档链接，可以根据链接自动识别为标题 */ + docsLink?: ContentDocsLink + /** 艾特用户 */ + person?: ContentPerson +} + +export interface ContentParagraphStyle { + /** 有序列表/无序列表/任务列表 */ + list?: ContentList +} + +export interface ContentPerson { + /** 员工的OpenID */ + openId?: string +} + +export interface ContentTextRun { + /** 具体的文本内容 */ + text?: string + /** 文本内容的样式，支持 BIUS、颜色等 */ + style?: ContentTextStyle +} + +export interface ContentTextStyle { + /** 是否加粗 */ + bold?: boolean + /** 是否删除 */ + strikeThrough?: boolean + /** 背景颜色 */ + backColor?: ContentColor + /** 字体颜色 */ + textColor?: ContentColor + /** 链接地址 */ + link?: ContentLink +} + +export interface Contract { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 合同开始日期 */ + effective_time: string + /** 实际结束日期 */ + expiration_time?: string + /** 雇员ID */ + employment_id: string + /** 合同类型 */ + contract_type: Enum + /** 甲方, 引用Company的ID */ + first_party_company_id: string + /** Person ID */ + person_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 期限类型 */ + duration_type?: Enum + /** 合同结束日期 */ + contract_end_date?: string + /** 合同编号 */ + contract_number?: string + /** 签订类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（signing_type）枚举定义部分获得 */ + signing_type?: Enum + /** 合同协议状态，枚举值可通过文档【飞书人事枚举常量】合同协议状态（contract_status）枚举定义部分获得 */ + contract_status?: Enum + /** 续签状态，枚举值可通过文档【飞书人事枚举常量】续签状态（renewal_status）枚举定义部分获得 */ + renewal_status?: Enum + /** 第几次签署 */ + signing_times?: number +} + +export interface ContractCompany { + id?: unknown + name?: string +} + +export interface ContractPeriodInfo { + /** 合同周期类型 */ + period_type: 1 | 2 + /** 合同时长 */ + period: number +} + +export interface CostAllocationPlan { + /** 唯一标识 */ + id?: string + /** 方案名称 */ + names?: I18nContent[] + /** 适用国家 */ + applicable_country_region?: string +} + +export interface CostAllocationReportData { + /** 数据维度汇总 */ + data_summary_dimensions?: DataSummaryDimension[] + /** 成本项数据 */ + compensation_cost_item?: CompensationCostItem +} + +export interface CostCenter { + /** 成本中心ID */ + cost_center_id?: string + /** 成本中心名称 */ + name: I18n[] + /** 编码 */ + code?: string + /** 上级成本中心ID */ + parent_cost_center_id?: string + /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ + managers?: string[] + /** 成本中心描述 */ + description?: I18n[] + /** 生效时间 */ + effective_time: string + /** 过期时间 */ + expiration_time?: string + /** 当前实体是否启用 */ + active?: boolean +} + +export interface CostCenterVersion { + /** 成本中心ID */ + cost_center_id?: string + /** 成本中心版本ID */ + version_id?: string + /** 成本中心名称 */ + name: I18n[] + /** 编码 */ + code?: string + /** 上级成本中心ID */ + parent_cost_center_id?: string + /** 成本中心负责人ID 列表，可通过雇佣信息接口查询获得 */ + managers?: string[] + /** 成本中心描述 */ + description?: I18n[] + /** 生效时间 */ + effective_time: string + /** 过期时间 */ + expiration_time?: string + /** 当前实体是否启用 */ + active?: boolean +} + +export interface Count { + /** 总数，大于等于 1000 个项目时将返回 999 */ + total: number + /** 还有更多，当大于等于 1000 时将返回 true */ + has_more?: boolean +} + +export interface CountryRegion { + /** 国家/地区 ID */ + country_region_id?: string + /** 国家/地区名称 */ + name?: I18n[] + /** 国家/地区全称 */ + full_name?: I18n[] + /** 国家/地区两位字母编码（ISO 3166-1） */ + alpha_2_code?: string + /** 国家/地区三位字母编码（ISO 3166-1） */ + alpha_3_code?: string + /** 国际电话区号 */ + global_code?: string + /** 状态 */ + status?: 1 | 0 +} + +export interface CountryRegionSubdivision { + /** 省份/主要行政区 ID */ + country_region_subdivision_id?: string + /** 省份/主要行政区名称 */ + name?: I18n[] + /** 所属国家/地区 ID，详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */ + country_region_id?: string + /** 行政区类型，枚举值可通过飞书人事[枚举常量介绍](/ssl:ttdoc/server-docs/corehr-v1/feishu-people-enum-constant#402ea9a0)文档中行政区类型（subdivision_type）定义部分获得 */ + subdivision_type?: Enum + /** 省份/主要行政区编码（ISO 3166-2） */ + iso_code?: string + /** 状态 */ + status?: 1 | 0 +} + +export interface CpstBandWidth { + /** 上限 */ + upper_limit?: string + /** 下限 */ + lower_limit?: string +} + +export interface CpstCurrency { + /** 币种ID */ + currency_id?: string + /** 币种code */ + code?: string + /** 币种名称 */ + name?: CpstI18n +} + +export interface CpstGrade { + /** 薪资等级ID */ + grade_id?: string + /** 薪资等级时间轴ID */ + grade_tid?: string + /** 带宽上下限和标准值 */ + grade_standard_value?: CpstGradeStandardValue + /** 币种 */ + currency?: CpstCurrency + /** 薪资标准描述 */ + description?: CpstI18n +} + +export interface CpstGradeStandardValue { + /** 薪资标准的关联对象，项目或者指标 */ + reference_object?: ReferenceObject + /** 薪资标准类型 */ + standard_type?: CpstStandardType + /** 上下限 */ + band_width?: CpstBandWidth + /** 标准值 */ + standard_value?: string +} + +export interface CpstI18n { + /** 中文 */ + zh_cn?: string + /** 英文 */ + en_us?: string +} + +export interface CpstStandardType { + /** 薪资标准类型 */ + api_name?: 'standard_value' | 'bandwidth_and_standard_value' | 'bandwidth_upper_and_lower_limit' +} + +export interface CreateEmpCustomOrg { + /** 自定义组织ID */ + id: string + /** 比例 如果是非比例的可不填写 */ + rate?: number +} + +export interface CreateTag { + /** 标签类型 */ + tag_type: 'tenant' + /** 标签默认名称 */ + name: string + /** i18n标签名称集合 */ + i18n_names?: TagI18nName[] +} + +export interface CreateTagFailReason { + /** 名称重复的标签id */ + duplicate_id?: string +} + +export interface CreateTransferInfo { + /** 备注 */ + remark?: string + /** offer信息 */ + offer_info?: string + /** 是否撤销虚线上级 */ + target_dotted_manager_clean?: boolean + /** 是否有试用期 */ + probation_exist?: boolean + /** 新部门 */ + target_department?: string + /** 新工作地点 */ + target_work_location?: string + /** 新直属上级 */ + target_direct_manager?: string + /** 新虚线上级 */ + target_dotted_manager?: string + /** 新职务 */ + target_job?: string + /** 新序列 */ + target_job_family?: string + /** 新级别 */ + target_job_level?: string + /** 新人员类型 */ + target_workforce_type?: string + /** 新人员子类型 */ + target_employee_subtype?: string + /** 新公司 */ + target_company?: string + /** 新合同编号 */ + target_contract_number?: string + /** 新合同类型 */ + target_contract_type?: string + /** 新期限类型 */ + target_duration_type?: string + /** 新签订类型 */ + target_signing_type?: string + /** 新合同开始日期 */ + target_contract_start_date?: string + /** 新合同结束日期 */ + target_contract_end_date?: string + /** 新工时制度 */ + target_working_hours_type?: string + /** 新工作日历 */ + target_working_calendar?: string + /** 新试用期预计结束日期 */ + target_probation_end_date?: string + /** 新周工作时长 */ + target_weekly_working_hours?: string + /** 新排班 */ + target_work_shift?: string + /** 新成本中心分摊方式 */ + target_cost_center_rates?: JobDataCostCenter[] + /** 新工作信息 */ + target_employment_change?: TranferEmploymentInfo + /** 新职等 */ + target_job_grade?: string + /** 新薪资类型 */ + target_compensation_type?: string + /** 新任职公司 */ + target_service_company?: string + /** 新岗位 */ + target_position?: string + /** 新社保城市 */ + target_social_security_city?: string + /** 编制随人员一起调整 */ + is_transfer_with_workforce?: boolean +} + +export interface Criterion { + /** 查询条件 */ + conditions?: Condition[] + /** 逻辑关系 */ + logic_expression?: string +} + +export interface Currency { + /** 货币 ID */ + currency_id?: string + /** 货币所属国家/地区 ID 列表，详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */ + country_region_id_list?: string[] + /** 货币名称 */ + currency_name?: I18n[] + /** 数字代码（ISO 4217） */ + numeric_code?: number + /** 三位字母代码（ISO 4217） */ + currency_alpha_3_code?: string + /** 状态 */ + status?: 1 | 0 +} + +export interface CustomAttr { + /** 自定义字段id */ + id: string + /** 自定义字段类型 */ + type: string + /** 选项定义，当type为ENUMERATION或者PICTURE_ENUM时此项有值，列举所有可选项 */ + options?: CustomAttrOptions + /** 多语言名称 */ + i18n_name?: I18nContent[] +} + +export interface CustomAttrGenericUser { + /** 用户id */ + id: string + /** 用户类型 1 User 2 Bot 11 Mail */ + type: number +} + +export interface CustomAttrOption { + /** 枚举类型选项id */ + id: string + /** 枚举选项值 */ + value: string + /** 名称 */ + name?: string +} + +export interface CustomAttrOptions { + /** 默认选项id */ + default_option_id?: string + /** 选项类型 */ + option_type: 'TEXT' | 'PICTURE' + /** 选项列表 */ + options: CustomAttrOption[] +} + +export interface CustomComplete { + /** pc客户端自定义完成配置（含mac和windows） */ + pc?: CustomCompleteItem + /** ios端的自定义完成配置 */ + ios?: CustomCompleteItem + /** android端的自定义完成配置 */ + android?: CustomCompleteItem +} + +export interface CustomCompleteItem { + /** 自定义完成的跳转url */ + href?: string + /** 自定义完成的弹出提示为 */ + tip?: I18nText +} + +export interface CustomField { + /** 自定义字段的GUID */ + guid?: string + /** 自定义字段名称 */ + name?: string + /** 自定义字段类型 */ + type?: string + /** 数字类型的字段设置 */ + number_setting?: NumberSetting + /** 人员类型的字段设置 */ + member_setting?: MemberSetting + /** 时间日期类型的字段设置 */ + datetime_setting?: DatetimeSetting + /** 单选类型的字段设置 */ + single_select_setting?: SelectSetting + /** 多选类型的字段设置 */ + multi_select_setting?: SelectSetting + /** 创建人 */ + creator?: Member + /** 自定义字段创建的时间戳(ms) */ + created_at?: string + /** 自定义字段的更新时间戳(ms) */ + updated_at?: string + /** 文本字段配置 */ + text_setting?: TextSetting +} + +export interface CustomFieldData { + /** 自定义字段 apiname，即自定义字段的唯一标识 */ + custom_api_name: string + /** 字段值，是 json 转义后的字符串，根据元数据定义不同，字段格式不同（如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05"） */ + value: string +} + +export interface CustomFields { + key?: string + label?: string + type?: 'text' | 'date' | 'option' | 'file' + /** 根据type不同，结构不同，不同type对应的数据结构在type的枚举值中有描述 */ + value?: string +} + +export interface CustomizationOption { + /** the option unique key */ + option_key?: string + /** should be filled if the option is others option */ + others_content?: string +} + +export interface CustomizedFieldDisplayItem { + /** id */ + id?: string + /** value */ + value?: string + /** key name */ + key_name?: string + /** display name */ + display_name?: string + /** position */ + position?: number + /** required */ + required?: boolean + /** editable */ + editable?: boolean +} + +export interface CustomMetricConfig { + /** 新增指标默认公式ID,非指标库指标的公式ID使用该值 */ + default_formula_id?: string + /** 维度允许添加指标下限(包含) */ + least_metrics_size?: number + /** 添加的指标方式 */ + add_metric_options?: 1 | 2[] +} + +export interface CustomWorkplaceAccessData { + /** 定制工作台ID */ + custom_workplace_id?: string + /** 访问数据 */ + access_data?: AccessData + /** 时间,精确到天,格式yyyy-MM-dd */ + date?: string + /** 定制工作台多语言名字。 */ + custom_workplace_name?: I18nName[] +} + +export interface DataAsset { + /** 数据知识ID */ + data_asset_id?: string + /** 数据知识标题 */ + label?: unknown + /** 数据知识描述 */ + description?: unknown + /** 数据资源类型 */ + 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' + /** 数据连接状态 */ + connect_status?: 'awaiting' | 'syncing' | 'successful' | 'continuously_syncing' | 'partially_successful' | 'failed' + /** 数据知识分类列表 */ + tags?: DataAssetTag[] + /** 数据知识项列表 */ + items?: DataAssetItem[] + /** 连接状态失败信息 */ + connect_failed_reason?: string + /** 数据连接类型 */ + connect_type?: 'import' | 'direct' + /** 创建时间，毫秒时间戳 */ + created_time?: string + /** 更新时间，毫秒时间戳 */ + updated_time?: string +} + +export interface DataAssetItem { + /** 数据知识项ID */ + data_asset_item_id?: string + /** 数据知识项标识 */ + api_name?: string + /** 数据知识项标题 */ + label?: unknown + /** 数据知识项描述 */ + description?: unknown + /** 数据知识资源 */ + resources?: DataAssetResource[] +} + +export interface DataAssetResource { + /** 数据知识资源ID */ + resource_id?: string + /** 数据知识资源类型 */ + resource_type?: 'dataset' | 'vector' +} + +export interface DataAssetTag { + /** 数据知识分类名称 */ + data_asset_tag_id?: string + /** 数据知识分类ID */ + name?: string +} + +export interface DataengineI18n { + /** 中文值 */ + zh_cn?: string + /** 英文值 */ + en_us?: string +} + +export interface DataPermission { + /** 权限点ID */ + id?: string + /** 权限点名称 */ + name?: I18n + /** 数据权限状态 */ + select_status?: 0 | 1 | 2 +} + +export interface DataSource { + /** 数据源的唯一标识 */ + id?: string + /** data_source的展示名称 */ + name: string + /** 数据源状态，0-已上线，1-未上线 */ + state?: 0 | 1 + /** 对于数据源的描述 */ + description?: string + /** 创建时间，采用 Unix 时间戳 */ + create_time?: string + /** 更新时间，采用 Unix 时间戳 */ + update_time?: string + /** 是否超限 */ + is_exceed_quota?: boolean + /** 数据源在 search tab 上的展示图标路径 */ + icon_url?: string + /** 数据源采用的展示模版名称 */ + template?: string + /** 描述哪些字段可以被搜索 */ + searchable_fields?: string[] + /** 数据源的国际化展示名称 */ + i18n_name?: I18nMeta + /** 数据源的国际化描述 */ + i18n_description?: I18nMeta + /** 数据源关联的 schema 标识 */ + schema_id?: string + /** datasource对应的开放平台应用id */ + app_id?: string + /** 搜索请求的接入方式 */ + connect_type?: 0 | 1 + /** 根据连接器类型不同所需要提供的相关参数 */ + connector_param?: ConnectorParam + /** 是否使用问答服务 */ + enable_answer?: boolean +} + +export interface DataSummaryDimension { + /** 层级 */ + dimension_level?: number + /** 类型 */ + dimension_type?: number + /** 维度ID，需要再次转换 */ + dimension_value_id?: string + /** 算薪项汇总维度时，当算薪项是特定枚举值，会使用该字段返回枚举值ID以及枚举值Key */ + enum_dimension?: EnumObject + /** 维度名称，自定义维度使用 */ + dimension_names?: I18nContent[] + /** 数据维度表头，自定义维度使用 */ + dimension_titles?: I18nContent[] +} + +export interface DatetimeSetting { + /** 日期显示格式 */ + format?: string +} + +export interface DeleteGridColumnRequest { + /** 删除列索引，从 0 开始，如 0 表示删除第一列（-1表示删除最后一列） */ + column_index: number +} + +export interface DeleteRecord { + /** 是否成功删除 */ + deleted?: boolean + /** 删除的记录id */ + record_id?: string +} + +export interface DeleteTableColumnsRequest { + /** 列开始索引（区间左闭右开） */ + column_start_index: number + /** 列结束索引（区间左闭右开） */ + column_end_index: number +} + +export interface DeleteTableRowsRequest { + /** 行开始索引（区间左闭右开） */ + row_start_index: number + /** 行结束索引（区间左闭右开） */ + row_end_index: number +} + +export interface Department { + /** 部门名称 */ + name: string + /** 国际化的部门名称 */ + i18n_name?: DepartmentI18nName + /** 父部门的部门ID */ + parent_department_id: string + /** 本部门的自定义部门ID */ + department_id?: string + /** 部门的open_id */ + open_department_id?: string + /** 部门主管用户ID */ + leader_user_id?: string + /** 部门群ID */ + chat_id?: string + /** 部门的排序 */ + order?: string + /** 部门单位自定义ID列表，当前只支持一个 */ + unit_ids?: string[] + /** 部门下用户的个数 */ + member_count?: number + /** 部门状态 */ + status?: DepartmentStatus + /** 部门负责人 */ + leaders?: DepartmentLeader[] + /** 部门群雇员类型限制 */ + group_chat_employee_types?: number[] + /** 部门HRBP */ + department_hrbps?: string[] + /** 部门下主属用户的个数 */ + primary_member_count?: number +} + +export interface DepartmentChange { + /** 部门调整记录 ID */ + department_change_id?: string + /** 部门 ID */ + department_id?: string + /** 调整部门 ID ，调整审批未生效前会返回格式为 td_xxx 的临时 ID */ + draft_department_id?: string + /** 调整类型 */ + department_change_type?: 'Unknown' | 'Create' | 'Modify' | 'Inactive' + /** 调整状态 */ + department_change_status?: 0 | 1 | 2 | 3 | 4 | 5 | 6 + /** 调整详细信息 */ + reorganization_info?: ReorganizationInfo +} + +export interface DepartmentCreate { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 子类型 */ + sub_type?: Enum + /** 部门负责人 */ + manager?: string + /** 是否保密 */ + is_confidential?: boolean + /** 层级关系，内层字段见实体 */ + hiberarchy_common: HiberarchyCommon + /** 生效时间 */ + effective_time: string + /** 失效时间 */ + expiration_time?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 成本中心id */ + cost_center_id?: string + /** 是否使用职务 */ + staffing_model?: Enum +} + +export interface DepartmentHrbp { + /** 部门 ID */ + department_id?: string + /** 部门 HRBP 雇佣 ID */ + hrbp_ids?: string[] +} + +export interface DepartmentI18nName { + /** 部门的中文名 */ + zh_cn?: string + /** 部门的日文名 */ + ja_jp?: string + /** 部门的英文名 */ + en_us?: string +} + +export interface DepartmentLeader { + /** 负责人类型 */ + leaderType: 1 | 2 + /** 负责人ID */ + leaderID: string +} + +export interface DepartmentParentInfo { + /** 部门 ID */ + department_id?: string + /** 部门名称 */ + department_name?: I18n[] + /** 上级部门 ID */ + parent_department_id?: string + /** 是否启用 */ + active?: boolean + /** 是否根部门 */ + is_root?: boolean +} + +export interface DepartmentParents { + /** 部门 ID */ + department_id?: string + /** 父部门列表，部门按照至底向上的顺序返回 */ + parent_department_list?: DepartmentParentInfo[] +} + +export interface DepartmentStatus { + /** 是否被删除 */ + is_deleted?: boolean +} + +export interface DepartmentTimeline { + /** 部门 ID */ + id?: string + /** 部门版本 ID */ + version_id?: string + /** 部门名称 */ + names?: I18n[] + /** 部门类型，枚举值可通过文档【飞书人事枚举常量】部门子类型（department_sub_type）枚举定义部分获得 */ + sub_type?: Enum + /** 上级部门 ID */ + parent_department_id?: string + /** 部门负责人雇佣 ID，枚举值及详细信息可通过【查询员工信息】接口查询获得 */ + manager?: string + /** 编码 */ + code?: string + /** 生效日期 */ + effective_date?: string + /** 是否启用 */ + active?: boolean + /** 描述 */ + descriptions?: I18n[] + /** 自定义字段 */ + custom_fields?: CustomFieldData[] +} + +export interface DepartmentTree { + /** 部门 ID */ + id?: string + /** 部门层级 */ + level?: number + /** 下级部门 ID 列表 */ + children?: string[] +} + +export interface Dependent { + /** 关系 */ + relationship: Enum + /** 性别 */ + gender?: Enum + /** 生日 */ + date_of_birth?: string + /** 国籍 ID，可通过【查询国籍信息】接口查询 */ + nationality_id_v2?: string + /** 证件号码 */ + national_id_list?: NationalId[] + /** 配偶工作状态 */ + spouses_working_status?: Enum + /** 包含家属医疗保险 */ + is_this_person_covered_by_health_insurance?: boolean + /** 允许家属抵扣税款 */ + is_this_person_allowed_for_tax_deduction?: boolean + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 家庭成员姓名 */ + dependent_name?: string + /** 工作单位 */ + employer?: string + /** 岗位 */ + job?: string + /** 电话 */ + phone?: Phone + /** 联系地址 */ + address?: Address + /** 出生证明 */ + birth_certificate_of_child?: File[] +} + +export interface DependentForUpdate { + /** 关系 */ + relationship: string + /** 性别 */ + gender?: string + /** 生日 */ + date_of_birth?: string + /** 证件号码 */ + national_ids?: NationalIdForUpdate[] + /** 配偶工作状态 */ + spouses_working_status?: string + /** 包含家属医疗保险 */ + is_this_person_covered_by_health_insurance?: boolean + /** 允许家属抵扣税款 */ + is_this_person_allowed_for_tax_deduction?: boolean + /** 家庭成员姓名 */ + dependent_name?: string + /** 工作单位 */ + employer?: string + /** 岗位 */ + job?: string + /** 电话 */ + phone?: PhoneForUpdate + /** 联系地址 */ + address?: AddressForUpdate +} + +export interface Device { + /** 设施名称 */ + name: string +} + +export interface DeviceExternal { + /** 设备id */ + id?: string + /** 设备名称 */ + name?: string +} + +export interface Diagram { + /** 绘图类型 */ + diagram_type?: 1 | 2 +} + +export interface DiData { + /** 字段值 1. 单选： "1" 2. 多选："["1", "2"]" 3. 月份选择："{"date":"2022-01"}" 4. 年份选择："{"date":"2022"}" 5. 数字："123" 6. 单行文本："xxx " 7. 多行文本："xxx xxxx" 8. 日期范围 "[1688140800000,1688140800000]" */ + value?: string + /** 字段属性 */ + object_attribute?: ObjectAttribute +} + +export interface DiInfo { + /** DI信息 ID */ + id?: string + /** 投递ID */ + application_id?: string + /** 人才ID */ + talent_id?: string + /** 数据来源 */ + source_type?: 1 | 2 | 3 + /** 创建时间毫秒时间戳 */ + create_time?: string + /** 更新时间毫秒时间戳 */ + update_time?: string + /** 多元信息 */ + di_data?: DiData[] +} + +export interface Dimension { + /** 操作行还是列，取值：ROWS、COLUMNS */ + major_dimension?: string + /** 起始行或者列号 */ + start_index?: number + /** 结束行或者列号 */ + end_index?: number +} + +export interface DimensionAbility { + /** 能力项ID */ + id?: string + /** 能力项名称 */ + name?: I18n + /** 能力项描述 */ + description?: I18n +} + +export interface DimensionAssessment { + /** 对应模版中维度ID */ + interview_feedback_form_dimension_id?: string + /** 维度名称 */ + dimension_name?: I18n + /** 维度类型 */ + dimension_type?: 1 | 2 | 3 | 5 | 6 | 7 | 10 | 11 | 12 + /** 维度权重 */ + weight?: number + /** 当维度类型为描述题时，从此取值 */ + dimension_content?: string + /** 当维度类型为单选题时，从此取值 */ + dimension_option?: DimensionOption + /** 当维度类型为多选题时，从此取值 */ + dimension_options?: DimensionOption[] + /** 当维度评价方式为「打分题(填空)时」，从此取值 */ + dimension_score?: number + /** 当维度为「职级建议」时，从此取值 */ + recommended_job_level?: RecommendedJobLevel + /** 维度关联面试题 */ + question_assessments?: QuestionAssessment[] +} + +export interface DimensionEntity { + /** 维度key */ + dimension_key: string + /** 维度值 */ + dimension_value: string +} + +export interface DimensionInfo { + /** 维度id */ + id: string + /** 维度名称 */ + name?: I18n[] +} + +export interface DimensionOption { + /** 选项ID */ + id?: string + /** 选项名称 */ + name?: I18n + /** 选项对应的分数 */ + score_val?: number +} + +export interface DisableInformConfig { + /** 是否覆盖子层级及会议室 */ + if_cover_child_scope?: boolean + /** 禁用状态变更通知开关 */ + if_inform: boolean + /** 通知成员列表 */ + informed_users?: SubscribeUser[] + /** 通知部门列表 */ + informed_depts?: SubscribeDepartment[] +} + +export interface DisplayApp { + /** 多维表格 app token */ + app_token?: string + /** 多维表格 App 名字 */ + name?: string + /** 多维表格 App 版本号 */ + revision?: number + /** 多维表格是否已开启高级权限 */ + is_advanced?: boolean + /** 文档时区 */ + time_zone?: string + /** 文档公式字段类型 */ + formula_type?: 1 | 2 + /** 文档高级权限版本 */ + advance_version?: 'v1' | 'v2' +} + +export interface DisplayAppV2 { + /** 多维表格 app token */ + app_token?: string + /** 多维表格 App 名字 */ + name?: string + /** 多维表格是否已开启高级权限 */ + is_advanced?: boolean + /** 文档时区 */ + time_zone?: string +} + +export interface District { + /** 区/县 ID */ + district_id?: string + /** 名称 */ + name?: I18n[] + /** 所属城市 ID，详细信息可通过[查询城市信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search)接口获得 */ + city_id?: string + /** 行政区划代码 */ + subregion_code?: string + /** 状态 */ + status?: 1 | 0 +} + +export type Divider = unknown + +export interface DocsBlock { + /** BlockTypeID */ + block_type_id?: string + /** block 的国际化信息 */ + i18n?: BlockI18nInfo[] + /** 移动端 icon 链接 */ + mobile_icon_url?: string + /** pc 端口 icon 链接 */ + pc_icon_url?: string +} + +export interface DocsLink { + /** 回复 at 云文档 */ + url: string +} + +export interface Document { + /** 文档唯一标识 */ + document_id?: string + /** 文档版本 ID */ + revision_id?: number + /** 文档标题 */ + title?: string + /** 文档展示设置 */ + display_setting?: DocumentDisplaySetting + /** 文档封面 */ + cover?: DocumentCover +} + +export interface DocumentCover { + /** 图片 token */ + token: string + /** 展示视图在水平方向的偏移比例。其值为距离原图中心的水平方向偏移值 px / 原图宽度 px。 视图在原图中心时，该值为 0； 视图在原图右部分时，该值为正数； 视图在原图左部分时，改值为负数。 */ + offset_ratio_x?: number + /** 展示视图在垂直方向的偏移比例。其值为距离原图中心的垂直方向偏移值 px / 原图高度 px。 视图在原图中心时，该值为 0； 视图在原图上部分时，该值为正数； 视图在原图下部分时，改值为负数。 */ + offset_ratio_y?: number +} + +export interface DocumentDisplaySetting { + /** 文档信息中是否展示文档作者 */ + show_authors?: boolean + /** 文档信息中是否展示文档创建时间 */ + show_create_time?: boolean + /** 文档信息中是否展示文档访问次数 */ + show_pv?: boolean + /** 文档信息中是否展示文档访问人数 */ + show_uv?: boolean + /** 文档信息中是否展示点赞总数 */ + show_like_count?: boolean + /** 文档信息中是否展示评论总数 */ + show_comment_count?: boolean + /** 文档信息中是否展示关联事项 */ + show_related_matters?: boolean +} + +export interface DocxSource { + /** 任务关联的文档token，要求：如果使用tenant_access_token请求，则请求机器人有文档编辑权限；如果使用user_access_token，则请求用户有文档的编辑权限 */ + token: string + /** 任务关联的文档block_id，要求block_id存在于token对应文档中、且block_id没有绑定过其他的任务 */ + block_id: string +} + +export interface Draft { + /** 草稿 Id */ + draft_id?: string + /** 实体词 */ + entity?: Entity +} + +export interface DrivingEntity { + /** 识别的字段种类 */ + type?: 'id_number' | 'name' | 'sex' | 'nationality' | 'address' | 'date_of_birth' | 'date_of_first_issue' | 'class' | 'valid_begin' | 'valid_end' | 'license_issuing_authority' | 'document_id' | 'record' | 'id_photo_location' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface DrvingLicense { + /** 识别出的实体类型 */ + entities?: DrivingEntity[] +} + +export interface Due { + /** 截止时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果截止时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true */ + timestamp?: string + /** 是否截止到一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。 */ + is_all_day?: boolean +} + +export interface EcoAccountCustomFieldData { + /** 自定义字段的标识，同一 scope 内须唯一 */ + key: string + /** 自定义字段的名称，用户在添加账号表单看到的控件标题 */ + name: I18n + /** 是否必填 */ + is_required: boolean + /** 自定义字段的描述，用户在添加账号表单看到的 place holder */ + description?: I18n +} + +export interface EcoBackgroundCheckCustomFieldData { + /** 自定义字段类型 */ + type: 'text' | 'textarea' | 'number' | 'boolean' | 'select' | 'multiselect' | 'date' | 'file' | 'resume' + /** 自定义字段的标识，在同一账号内唯一 */ + key: string + /** 自定义字段的名称，用户在安排背调表单看到的控件标题 */ + name: I18n + /** 是否必填 */ + is_required: boolean + /** 自定义字段的描述，如果是输入控件，为用户在安排背调表单看到的 placeholder 或 提示文字 */ + description?: I18n + /** type 为 select 或 multiselect 时必填，单选或多选的选项 */ + options?: EcoBackgroundCheckCustomFieldDataOption[] +} + +export interface EcoBackgroundCheckCustomFieldDataOption { + /** 选项的 key */ + key: string + /** 选项的名称 */ + name: I18n +} + +export interface EcoBackgroundCheckPackageAdditionalItem { + /** 附件调查项 ID */ + id: string + /** 附加调查项名称 */ + name: string + /** 附加调查项描述 */ + description?: string +} + +export interface EcoBackgroundCheckPackageData { + /** 套餐 ID */ + id: string + /** 背调名称 */ + name: string + /** 套餐描述 */ + description?: string +} + +export interface EcoBackgroundCheckReportFile { + /** 报告名称 */ + report_name: string + /** 报告地址；报告地址类型为空或为1时需为可下载 pdf 的链接；为2时为预览型链接 */ + report_url: string + /** 报告地址类型；枚举值 1 或为空时为可下载的 pdf 链接，2 为预览型链接 */ + report_url_type?: 1 | 2 +} + +export interface EcoExamLoginInfo { + /** 笔试链接 */ + exam_url: string + /** 用户名 */ + username?: string + /** 密码 */ + password?: string +} + +export interface EcoExamPaperData { + /** 试卷 ID */ + id: string + /** 试卷名称 */ + name: string + /** 考试时长（分钟） */ + duration?: number + /** 试卷题目数量 */ + question_count?: number + /** 开始时间，留空或不传表示不限制开始时间 */ + start_time?: string + /** 结束时间，留空或不传表示不限制结束时间 */ + end_time?: string +} + +export interface EcoExamResultDetail { + /** 评价 ID */ + id?: string + /** 评价名称 */ + name: string + /** 评价结果 */ + result: string +} + +export interface EcoExamResultReport { + /** 报告名称 */ + name: string + /** 报告链接 */ + url: string + /** 作答完成时间(毫秒时间戳) */ + answer_time?: string +} + +export interface Education { + level?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + school?: string + major?: string + degree?: 1 | 2 | 3 + start?: string + end?: string +} + +export interface EducationInfo { + /** 学校名称 */ + school_name?: string + /** 学历 */ + education?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 专业 */ + field_of_study?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export type EeKunlunCommonI18nI18nText = unknown + +export interface Email { + /** 邮箱地址 */ + email: string + /** 是否为主要邮箱 */ + is_primary?: boolean + /** 是否为公开邮箱 */ + is_public?: boolean + /** 邮箱用途，枚举值可通过文档【飞书人事枚举常量】邮箱用途（email_usage）枚举定义获得 */ + email_usage?: Enum +} + +export interface EmailAlias { + /** 主邮箱地址 */ + primary_email?: string + /** 邮箱别名 */ + email_alias?: string +} + +export interface EmailForUpdate { + /** 邮箱地址 */ + email: string + /** 是否为主要邮箱,若有多个邮箱，只能有一个邮箱的「is_primary」为true */ + is_primary: boolean + /** 是否为公开邮箱 */ + is_public: boolean + /** 邮箱用途，枚举值可通过文档【飞书人事枚举常量】邮箱用途（email_usage）枚举定义获得 */ + email_usage: string +} + +export interface EmergencyContact { + name?: string + relationship?: 1 | 2 | 3 | 4 | 5 | 6 + mobile?: string +} + +export interface EmergencyContactForUpdate { + /** 紧急联系人姓名 */ + legal_name?: string + /** 紧急联系人与本人亲属关系，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可：- object_api_name = "emergency_contact" - custom_api_name = "relationship" */ + relationship?: string + /** 电话 */ + phones?: PhoneForUpdate[] + /** 地址 */ + address?: AddressForUpdate + /** 邮箱 */ + email?: EmailForUpdate +} + +export interface Emoji { + /** emoji类型 */ + emoji_type: string +} + +export interface Employee { + /** user_id转换 */ + user_id?: string + /** 系统字段 */ + system_fields?: SystemFields + /** 自定义字段 */ + custom_fields?: CustomFields[] +} + +export interface EmployeeConversionInfo { + /** 实际转正日期 */ + actual_conversion_time?: number +} + +export interface EmployeeJobData { + /** Employment ID */ + employment_id: string + /** 实体在 CoreHR 内部的唯一键 */ + job_datas?: JobData[] +} + +export interface EmployeeOverboardInfo { + /** 实际离职日期 */ + actual_overboard_time?: number + /** 离职原因 */ + overboard_note?: string +} + +export interface EmployeesAdditionalJob { + /** 兼职记录ID */ + id?: string + /** 人员类型 ID，可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */ + employee_type_id: string + /** 工时制度 ID，可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */ + working_hours_type_id?: string + /** 工作地点 ID，可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */ + work_location_id?: string + /** 部门 ID，可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息；类型与department_id_type一致 */ + department_id: string + /** 职务 ID，可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */ + job_id?: string + /** 职级 ID，可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */ + job_level_id?: string + /** 序列 ID，可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */ + job_family_id?: string + /** 雇佣 ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + employment_id: string + /** 兼职开始日期 */ + start_date: string + /** 兼职结束日期 */ + end_date?: string + /** 直属上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + direct_manager_id?: string + /** 虚线上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + dotted_line_manager_id?: string + /** 排班类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "work_shift" */ + work_shift?: Enum + /** 薪资类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "compensation_type" */ + compensation_type?: Enum + /** 任职公司，可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */ + service_company?: string + /** 周工作时长【0~168】 */ + weekly_working_hours?: string + /** 工作日历ID，可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */ + work_calendar_id?: string + /** 岗位 ID */ + position_id?: string + /** 人员子类型 ID */ + employee_subtype_id?: string +} + +export interface EmployeesAdditionalJobBatchReqDate { + /** 开始 */ + start: string + /** 结束 */ + end: string +} + +export interface EmployeesAdditionalJobWriteResp { + /** 兼职记录ID */ + id?: string + /** 人员类型 ID，可通过[【查询单个人员类型】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 */ + employee_type_id: string + /** 工时制度 ID，可通过[【查询单个工时制度】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 */ + working_hours_type_id?: string + /** 工作地点 ID，可通过[【查询单个地点】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 */ + work_location_id?: string + /** 部门 ID，可通过[【查询单个部门】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息；类型与department_id_type一致 */ + department_id: string + /** 职务 ID，可通过[【查询单个职务】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 */ + job_id?: string + /** 职级 ID，可通过[【查询单个职级】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 */ + job_level_id?: string + /** 序列 ID，可通过[【查询单个序列】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 */ + job_family_id?: string + /** 雇佣 ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + employment_id: string + /** 兼职开始日期 */ + start_date: string + /** 兼职结束日期 */ + end_date?: string + /** 直属上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + direct_manager_id?: string + /** 虚线上级的雇佣ID，可通过[【批量查询员工信息】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息；类型与user_id_type一致 */ + dotted_line_manager_id?: string + /** 排班类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "work_shift" */ + work_shift?: Enum + /** 薪资类型，可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：- object_api_name = "job_data"- custom_api_name = "compensation_type" */ + compensation_type?: Enum + /** 任职公司，可通过[【查询单个公司】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 */ + service_company?: string + /** 周工作时长【0~168】 */ + weekly_working_hours?: string + /** 工作日历ID，可通过[【查询工作日历】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar)获取详细信息 */ + work_calendar_id?: string + /** 岗位 ID */ + position_id?: string + /** 人员子类型 ID */ + employee_subtype_id?: string +} + +export interface EmployeeType { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 名称 */ + name: I18n[] + /** 默认雇员类型 */ + default_employee_type: boolean + /** 启用 */ + active: boolean + /** 编码 */ + code?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface EmployeeTypeEnum { + /** 枚举值id */ + enum_id?: string + /** 枚举值 */ + enum_value?: string + /** 枚举内容 */ + content: string + /** 类型 */ + enum_type: 1 | 2 + /** 类型 */ + enum_status: 1 | 2 + /** i18n定义 */ + i18n_content?: I18nContent[] +} + +export interface EmployeeV2 { + /** 员工 ID */ + id?: string + /** 投递 ID */ + application_id?: string + /** 入职状态 */ + onboard_status?: 1 | 2 + /** 转正状态 */ + conversion_status?: 1 | 2 + /** 实际入职时间 */ + onboard_time?: string + /** 预期转正时间 */ + expected_conversion_time?: string + /** 实际转正时间 */ + actual_conversion_time?: string + /** 离职时间 */ + overboard_time?: string + /** 离职原因 */ + overboard_note?: string + /** 办公地点 */ + onboard_city_code?: string + /** 入职部门 ID */ + department_id?: string + /** 直属上级 ID */ + leader_id?: string + /** 序列 ID */ + sequence_id?: string + /** 职级 ID */ + level_id?: string + /** 员工类型 */ + employee_type?: string + /** 招聘需求ID */ + job_requirement_id?: string +} + +export interface Employment { + /** 待入职ID */ + prehire_id?: string + /** 人员类型 */ + employee_type_id?: string + /** 司龄 */ + tenure?: string + /** 部门 ID，枚举值及详细信息可通过【批量查询部门】接口查询获得 */ + department_id?: string + /** 职级 ID，枚举值及详细信息可通过【批量查询职务级别】接口查询获得 */ + job_level_id?: string + /** 工作地点 ID，枚举值及详细信息可通过【批量查询地点】接口查询获得 */ + work_location_id?: string + /** 职务序列 ID，枚举值及详细信息可通过【批量查询职务序列】接口查询获得 */ + job_family_id?: string + /** 职务 ID，枚举值及详细信息可通过【批量查询职务】接口查询获得 */ + job_id?: string + /** 法人主体 ID，枚举值及详细信息可通过【批量查询公司】接口查询获得 */ + company_id?: string + /** 工时制度 ID，枚举值及详细信息可通过【批量查询工时制度】接口查询获得 */ + working_hours_type_id?: string + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 资历起算日期 */ + seniority_date?: string + /** 员工编号 */ + employee_number?: string + /** 入职日期 */ + effective_time: string + /** 离职日期 */ + expiration_time?: string + /** 雇佣类型 */ + employment_type: Enum + /** 人员信息，引用Person的ID */ + person_id: string + /** 试用期时长 */ + probation_period?: number + /** 是否在试用期中 */ + on_probation?: string + /** 试用期结束日期 */ + probation_end_date?: string + /** 是否是主雇佣信息 */ + primary_employment: boolean + /** 雇员状态 */ + employment_status?: Enum + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 工作邮箱列表 */ + work_email_list?: Email[] + /** 邮箱 */ + email_address?: string + /** 离职原因 */ + reason_for_offboarding?: Enum + /** 成本中心列表 */ + cost_center_list?: JobDataCostCenter[] + /** 招聘应用 ID */ + ats_application_id?: string + /** 任职公司 */ + service_company?: string + /** 薪资类型 */ + compensation_type?: Enum + /** 排班类型 */ + work_shift?: Enum +} + +export interface EmploymentBp { + /** 员工雇佣 ID */ + employment_id?: string + /** 员工直属 HRBP 雇佣 ID，若员工是部门负责人，且同部门 HRBP 在权限中配置了 HRBP 不可见部门负责人，则在结果中不会出现该 HRBP */ + hrbp_ids?: string[] + /** 员工直属属地 BP 雇佣 ID */ + location_bp_ids?: string[] +} + +export interface EmploymentCreate { + /** 待入职 ID */ + prehire_id?: string + /** 人员类型 */ + employee_type_id?: string + /** 司龄 */ + tenure?: string + /** 部门 ID，枚举值及详细信息可通过【批量查询部门】接口查询获得 */ + department_id?: string + /** 职级 ID，枚举值及详细信息可通过【批量查询职务级别】接口查询获得 */ + job_level_id?: string + /** 工作地点 ID，枚举值及详细信息可通过【批量查询地点】接口查询获得 */ + work_location_id?: string + /** 职务序列 ID，枚举值及详细信息可通过【批量查询职务序列】接口查询获得 */ + job_family_id?: string + /** 职务 ID，枚举值及详细信息可通过【批量查询职务】接口查询获得 */ + job_id?: string + /** 法人主体 ID，枚举值及详细信息可通过【批量查询公司】接口查询获得 */ + company_id?: string + /** 工时制度 ID，枚举值及详细信息可通过【批量查询工时制度】接口查询获得 */ + working_hours_type_id?: string + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 资历起算日期 */ + seniority_date?: string + /** 员工编号 */ + employee_number?: string + /** 入职日期 */ + effective_time: string + /** 离职日期 */ + expiration_time?: string + /** 雇佣类型 */ + employment_type: Enum + /** 人员信息，引用Person的ID */ + person_id: string + /** 试用期时长 */ + probation_period?: number + /** 是否在试用期中 */ + on_probation?: string + /** 试用期结束日期 */ + probation_end_date?: string + /** 是否是主雇佣信息 */ + primary_employment: boolean + /** 雇员状态 */ + employment_status?: Enum + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 工作邮箱列表 */ + work_email_list?: Email[] + /** 邮箱 */ + email_address?: string + /** 离职原因 */ + reason_for_offboarding?: Enum + /** 成本中心列表 */ + cost_center_list?: JobDataCostCenter[] + /** 招聘应用 ID */ + ats_application_id?: string + /** 是否离职重聘 */ + rehire?: Enum + /** 历史雇佣信息 ID */ + rehire_employment_id?: string +} + +export interface EmploymentLeaveBalance { + /** 雇佣信息ID */ + employment_id: string + /** 员工姓名 */ + employment_name: I18n[] + /** 余额查看日期 */ + as_of_date: string + /** 假期余额列表 */ + leave_balance_list: LeaveBalance[] +} + +export interface Entity { + /** 实体词 Id */ + id?: string + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 创建者 */ + creator?: string + /** 词条创建时间（秒级时间戳） */ + create_time?: string + /** 最近一次更新者 */ + updater?: string + /** 最近一次更新词条时间（秒级时间戳） */ + update_time?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 统计数据 */ + statistics?: Statistics + /** 外部 id 关联数据 */ + outer_info?: OuterInfo + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string + /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */ + source?: number + /** 国际化的词条释义 */ + i18n_descs?: I18nEntryDesc[] +} + +export interface EntityInfo { + /** 实体code */ + code?: string + /** 实体名称 */ + name?: I18n +} + +export interface EntityWord { + /** 抽取出的词条名 */ + name: string + /** 词条可能的推荐别名 */ + aliases?: string[] +} + +export interface Enum { + /** 枚举值 */ + enum_name: string + /** 枚举多语展示 */ + display?: I18n[] +} + +export interface EnumFieldOption { + /** 枚举值选项 API Name，即选项的唯一标识 */ + option_api_name: string + /** 选项名称（需填写至少一个语种） */ + name: Name +} + +export interface EnumObject { + /** 枚举对象ID */ + enum_value_id?: string + /** 枚举对象 */ + enum_key?: string +} + +export interface EnvironmentVariable { + /** 环境变量 API 名称 */ + api_name: string + /** 环境变量的名称 */ + label: Label + /** 描述 */ + description: string + /** 返回 json marshal 后的字符串。 isEncrypted 为 「true」时，依然可以获取返回值。 */ + value: string + /** 是否加密，「type 」取值为 text, float 时才有效 */ + is_encrypted?: boolean + /** 对象的 API 名称，「type 」取值为 lookup, lookup_multi 时才有效 */ + object_api_name?: string + /** 对象的名称，「type 」取值为 lookup, lookup_multi 时才有效 */ + object_label?: Label + /** 「创建时间」，日期时间字段。 使用 Unix 时间戳 */ + created_at?: number + /** 「更新时间」，日期时间字段。 使用 Unix 时间戳 */ + updated_at: number + /** 环境变量的类型，可取值范围有：lookup, lookup_multi */ + type?: string +} + +export interface EnvironmentVariableFilter { + /** 模糊查询关键词 */ + quick_query?: string +} + +export interface Equation { + /** 符合 KaTeX 语法的公式内容，语法规则请参考：https://katex.org/docs/supported.html */ + content: string + /** 文本局部样式 */ + text_element_style?: TextElementStyle +} + +export interface Evaluation { + /** 评估 ID */ + id?: string + /** 投递 ID */ + application_id?: string + /** 投递阶段 */ + stage_id?: string + /** 创建人user_id */ + creator_id?: string + /** 评估人user_id */ + evaluator_id?: string + /** 提交状态 */ + commit_status?: 1 | 2 + /** 评估结论 */ + conclusion?: 1 | 2 + /** 评估详情 */ + content?: string + /** 创建时间 */ + create_time?: string + /** 最近更新时间 */ + update_time?: string +} + +export interface EvaluationTask { + /** 评估 ID */ + id?: string + /** 职位 ID */ + job_id?: string + /** 人才 ID */ + talent_id?: string + /** 投递 ID */ + application_id?: string + /** 任务状态 */ + activity_status?: 1 | 2 | 3 +} + +export interface Event { + /** event type */ + type: string + /** event subtype */ + subtype: string +} + +export interface EventLocation { + /** 地点名称 */ + name?: string + /** 地点地址 */ + address?: string + /** 地点坐标纬度信息，对于国内的地点，采用GCJ-02标准，海外地点采用WGS84标准 */ + latitude?: number + /** 地点坐标经度信息，对于国内的地点，采用GCJ-02标准，海外地点采用WGS84标准 */ + longitude?: number +} + +export interface EventOrganizer { + /** 日程组织者user ID */ + user_id?: string + /** 日程组织者姓名 */ + display_name?: string +} + +export interface EventSearchFilter { + /** 搜索过滤项，日程搜索区间的开始时间，被搜索日程的事件必须与搜索区间有交集 */ + start_time?: TimeInfo + /** 搜索过滤项，日程搜索区间的结束时间，被搜索日程的事件必须与搜索区间有交集 */ + end_time?: TimeInfo + /** 搜索过滤项，参与人的用户ID列表，被搜索日程中必须包含至少一个其中的参与人 */ + user_ids?: string[] + /** 搜索过滤项，会议室ID列表，被搜索日程中必须包含至少一个其中的会议室 */ + room_ids?: string[] + /** 搜索过滤项，群ID列表，被搜索日程的参与人中必须包含至少一个其中的群 */ + chat_ids?: string[] +} + +export interface ExamMarkingTask { + /** 笔试 ID */ + id?: string + /** 职位 ID */ + job_id?: string + /** 人才 ID */ + talent_id?: string + /** 投递 ID */ + application_id?: string + /** 任务状态 */ + activity_status?: 1 | 2 +} + +export interface ExportTask { + /** 导出文件扩展名 */ + file_extension: 'docx' | 'pdf' | 'xlsx' | 'csv' + /** 导出文档类型 */ + type: 'doc' | 'sheet' | 'bitable' | 'docx' + /** 导出文件名 */ + file_name?: string + /** 导出文件产物 Token */ + file_token?: string + /** 导出文件大小 */ + file_size?: number + /** 任务失败原因 */ + job_error_msg?: string + /** 任务状态 */ + job_status?: 0 | 1 | 2 | 3 | 107 | 108 | 109 | 110 | 111 | 122 | 123 | 6000 +} + +export interface ExteranlInstanceCheck { + /** 审批实例 id */ + instance_id: string + /** 审批实例最近更新时间 */ + update_time: string + /** 任务信息 */ + tasks: ExternalInstanceTask[] +} + +export interface ExteranlInstanceCheckResponse { + /** 审批实例 id */ + instance_id: string + /** 任务最近更新时间 */ + update_time?: string + /** 任务信息 */ + tasks?: ExternalInstanceTask[] +} + +export interface ExternalApplication { + /** 外部投递 ID */ + id?: string + /** 职位招聘类型 */ + job_recruitment_type?: 1 | 2 + /** 职位名称 */ + job_title?: string + /** 简历来源 */ + resume_source?: string + /** 阶段 */ + stage?: string + /** 人才 ID */ + talent_id: string + /** 终止原因 */ + termination_reason?: string + /** 投递类型 */ + delivery_type?: 1 | 2 | 3 | 4 + /** 更新时间，招聘系统内用作投递在外部系统终止时间 */ + modify_time?: number + /** 投递在外部系统创建时间 */ + create_time?: number + /** 终止类型 */ + termination_type?: string +} + +export interface ExternalBackgroundCheck { + /** 外部背调 ID */ + id?: string + /** 外部投递 ID */ + external_application_id: string + /** 背调日期 */ + date?: number + /** 背调名字 */ + name?: string + /** 背调结果 */ + result?: string + /** 背调附件 */ + attachment_list?: ExternalBackgroundCheckAttachment[] +} + +export interface ExternalBackgroundCheckAttachment { + /** 附件 ID */ + id?: string + /** 附件名字 */ + name?: string + /** 附件大小 */ + size?: number +} + +export interface ExternalCommonAttachment { + /** 附件 ID */ + id?: string + /** 附件名字 */ + name?: string + /** 附件大小 */ + size?: number +} + +export interface ExternalInstance { + /** 审批定义 code， 创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段 */ + approval_code: string + /** 审批实例状态 */ + status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED' | 'HIDDEN' | 'TERMINATED' + /** 审批实例扩展 JSON */ + extra?: string + /** 审批实例唯一标识，用户自定义，需确保证租户、应用下唯一 */ + instance_id: string + /** 审批实例链接集合 ，用于【已发起】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ + links: ExternalInstanceLink + /** 审批展示名称，如果填写了该字段，则审批列表中的审批名称使用该字段，如果不填该字段，则审批名称使用审批定义的名称 */ + title?: string + /** 用户提交审批时填写的表单数据，用于所有审批列表中展示。可传多个值，但审批中心pc展示前2个,移动端展示前3个,长度不超过2048字符 */ + form?: ExternalInstanceForm[] + /** 审批发起人 user_id，发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】，【已审批】【抄送我】列表中，该字段展示审批是谁发起的。审批发起人 open id，和 user id 二选一。 */ + user_id?: string + /** 审批发起人 用户名，如果发起人不是真实的用户（例如是某个部门），没有 user_id，则可以使用该字段传名称 */ + user_name?: string + /** 审批发起人 open id，和 user id 二选一 */ + open_id?: string + /** 发起人部门，用于列表中展示发起人所属部门。不传则不展示。如果用户没加入任何部门，传 ""，将展示租户名称传 department_name 展示部门名称 */ + department_id?: string + /** 审批发起人 部门，如果发起人不是真实的用户（例如是某个部门），没有 department_id，则可以使用该字段传名称 */ + department_name?: string + /** 审批发起时间，Unix毫秒时间戳 */ + start_time: string + /** 审批实例结束时间：未结束的审批为 0，Unix毫秒时间戳 */ + end_time: string + /** 审批实例最近更新时间；用于推送数据版本控制如果 update_mode 值为 UPDATE，则只有传过来的 update_time 有变化时（变大），才会更新审批中心中的审批实例信息。使用该字段主要用来避免并发时老的数据更新了新的数据 */ + update_time: string + /** 列表页打开审批实例的方式 */ + display_method?: 'BROWSER' | 'SIDEBAR' | 'NORMAL' | 'TRUSTEESHIP' + /** 更新方式， 当 update_mode=REPLACE时，每次都以当前推送的数据为最终数据，会删掉审批中心中多余的任务、抄送数据（不在这次推送的数据中）; 当 update_mode=UPDATE时，则不会删除审批中心的数据，而只是进行新增和更新实例、任务数据 */ + update_mode?: 'REPLACE' | 'UPDATE' + /** 任务列表 */ + task_list?: ExternalInstanceTaskNode[] + /** 抄送列表 */ + cc_list?: CcNode[] + /** 国际化文案 */ + i18n_resources: I18nResource[] + /** 单据托管认证token，托管回调会附带此token，帮助业务方认证 */ + trusteeship_url_token?: string + /** 用户的类型，会影响请求参数用户标识域的选择，包括加签操作回传的目标用户， 目前仅支持 "user_id" */ + trusteeship_user_id_type?: string + /** 单据托管回调接入方的接口的URL地址 */ + trusteeship_urls?: TrusteeshipUrls + /** 托管预缓存策略 */ + trusteeship_cache_config?: TrusteeshipInstanceCacheConfig + /** 资源所在地区， 内部统计用字段， 不需要填 */ + resource_region?: string +} + +export interface ExternalInstanceForm { + /** 表单字段名称 */ + name?: string + /** 表单值 */ + value?: string +} + +export interface ExternalInstanceLink { + /** pc 端的跳转链接，当用户使用飞书 pc 端时，使用该字段进行跳转 */ + pc_link: string + /** 移动端 跳转链接，当用户使用飞书 移动端时，使用该字段进行跳转 */ + mobile_link?: string +} + +export interface ExternalInstanceTask { + /** 任务 id */ + task_id: string + /** 任务最近更新时间 */ + update_time: string +} + +export interface ExternalInstanceTaskNode { + /** 审批实例内的唯一标识，用于更新审批任务时定位数据 */ + task_id: string + /** 审批人 user_id，该任务会出现在审批人的【待审批】或【已审批】列表中 */ + user_id?: string + /** 审批人 open id，和 user id 二选一 */ + open_id?: string + /** 审批任务名称 */ + title?: string + /** 【待审批】或【已审批】中使用的跳转链接，用于跳转回三方系统pc_link 和 mobile_link 必须填一个，填写的是哪一端的链接，即会跳转到该链接，不受平台影响 */ + links: ExternalInstanceLink + /** 任务状态 */ + status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE' + /** 扩展 json */ + extra?: string + /** 任务创建时间，Unix 毫秒时间戳 */ + create_time: string + /** 任务完成时间：未结束的审批为 0，Unix 毫秒时间戳 */ + end_time: string + /** task最近更新时间，用于推送数据版本控制； 更新策略同 instance 中的 update_time */ + update_time?: string + /** 操作上下文，当用户操作时，回调请求中带上该参数，用于传递该任务的上下文数据 */ + action_context?: string + /** 任务级别操作配置,快捷审批目前支持移动端操作 */ + action_configs?: ActionConfig[] + /** 列表页打开审批任务的方式 */ + display_method?: 'BROWSER' | 'SIDEBAR' | 'NORMAL' | 'TRUSTEESHIP' + /** 三方任务支持不纳入效率统计 */ + exclude_statistics?: boolean + /** 节点id */ + node_id?: string + /** 节点名称，示例：i18n@name。需要在i18n_resources中传该名称对应的国际化文案 */ + node_name?: string + /** 任务生成类型 */ + generate_type?: 'EXTERNAL_CONSIGN' | 'DEFAULT' +} + +export interface ExternalInterview { + /** 外部投递 ID */ + external_application_id: string + /** 外部面试 ID */ + id?: string + /** 参与状态 */ + participate_status?: 1 | 2 | 3 + /** 开始时间 */ + begin_time?: number + /** 结束时间 */ + end_time?: number + /** 面试评价列表 */ + interview_assessments?: ExternalInterviewAssessment[] +} + +export interface ExternalInterviewAssessment { + /** 面试官姓名 */ + username?: string + /** 面试结果 */ + conclusion?: 1 | 2 | 3 + /** 评价维度列表 */ + assessment_dimension_list?: ExternalInterviewAssessmentDimension[] + /** 综合记录 */ + content?: string +} + +export interface ExternalInterviewAssessmentDimension { + /** 打分题分数（当题目类型为「打分题」时使用） */ + score?: number + /** 单选选项（当题目类型为「单选题」时使用） */ + option?: string + /** 多选选项（当题目类型为「多选题」时使用） */ + options?: string[] + /** 描述内容（当题目类型为「描述题」时使用） */ + content?: string + /** 题目类型 */ + assessment_type?: 1 | 2 | 3 | 4 + /** 题目标题 */ + title?: string + /** 题目描述 */ + description?: string +} + +export interface ExternalOffer { + /** 外部 Offer ID */ + id?: string + /** 外部投递 ID */ + external_application_id: string + /** Offer 创建时间，毫秒时间戳 */ + biz_create_time?: string + /** Offer 负责人 */ + owner?: string + /** Offer 状态 */ + offer_status?: string + /** Offer 附件列表 */ + attachment_list?: ExternalCommonAttachment[] +} + +export interface ExternalTaskItem { + /** 审批任务 ID */ + id: string + /** 审批任务状态 */ + status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE' + /** 审批任务最后更新时间，单位 毫秒 */ + update_time: string +} + +export interface ExternalTaskList { + /** 审批实例 ID */ + instance_id: string + /** 审批的id */ + approval_id: string + /** 审批对应的 approval_code */ + approval_code: string + /** 审批实例当前的状态 */ + status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED' | 'HIDDEN' + /** 审批实例最后更新时间，单位 毫秒 */ + update_time: string + /** 审批实例下的审批任务 */ + tasks?: ExternalTaskItem[] +} + +export interface ExtractCopy { + /** 盖章份数 */ + copy_num?: number + /** 从原文中抽取的盖章份数 */ + original_copy?: string + /** 盖章文件类型 */ + key?: string + /** 原文有关盖章份数的描述 */ + text?: string +} + +export interface ExtractCurrency { + /** 币种名称 */ + currency_name?: string + /** 币种符号 */ + currency_text?: string +} + +export interface ExtractPrice { + /** 交易金额 */ + contract_price?: number + /** 从原文中抽取的交易金额 */ + contract_price_original?: string + /** 原文中描述交易金额的文字 */ + text?: string +} + +export interface ExtractTerm { + /** 合同持续时长 */ + initial_time?: string + /** 持续时长单位 */ + initial_unit?: string +} + +export interface ExtractTime { + /** 开始时间 */ + time_start?: string + /** 结束时间 */ + time_end?: string + /** 原文中抽取出的开始时间 */ + original_time_start?: string + /** 原文中抽取出的结束时间 */ + original_time_end?: string + /** 原文中关于开始时间的描述 */ + text_start?: string + /** 原文中关于结束时间的描述 */ + text_end?: string + /** 合同持续时长 */ + initial_term?: ExtractTerm + /** 原文中关于持续时间的描述 */ + text_initial_term?: string +} + +export interface FailedReason { + /** 错误码 */ + error_code?: number + /** 错误信息 */ + error_message?: string + /** 用户id */ + user_id?: string +} + +export interface Faq { + /** faq id */ + faq_id?: string + /** faq id, for backward compatibility */ + id?: string + /** helpdesk id */ + helpdesk_id?: string + /** faq question */ + question?: string + /** faq answer in plain text format */ + answer?: string + /** faq answer in richtext format, if any */ + answer_richtext?: Richtext[] + /** create time */ + create_time?: number + /** update time */ + update_time?: number + /** list of categories that faq belongs to */ + categories?: Category[] + /** faq tags */ + tags?: string[] + /** expire time */ + expire_time?: number + /** update user */ + update_user?: TicketUser + /** create user */ + create_user?: TicketUser +} + +export interface FaqCreateInfo { + /** faq category id */ + category_id?: string + /** faq question */ + question: string + /** faq answer */ + answer?: string + /** faq answer in richtext */ + answer_richtext?: string + /** faq tags */ + tags?: string[] +} + +export interface FaqUpdateInfo { + /** faq category id */ + category_id?: string + /** faq question */ + question: string + /** faq answer */ + answer?: string + /** faq answer in richtext */ + answer_richtext?: Richtext[] + /** faq tags */ + tags?: string[] +} + +export interface Feature { + /** 卡号 */ + card?: number +} + +export interface Field { + /** 统计数据父字段code */ + code: string + /** 统计数据父字段名称 */ + title: string + /** 统计数据子字段 */ + child_fields?: ChildField[] +} + +export interface FieldGroup { + /** 可写权限的表单项的 id列表 */ + writable: string[] + /** 可读权限的表单项的 id列表 */ + readable: string[] +} + +export interface FieldVariableSubVlaue { + /** 用于关联list和record类型变量值中的key */ + key?: string + /** 变量值 */ + value?: FieldVariableValueTo +} + +export interface FieldVariableSubVlaueForReview { + /** 用于关联list和record类型变量值中的key */ + key?: string + /** 变量值 */ + value?: FieldVariableValueToForReview +} + +export interface FieldVariableValue { + /** 变量唯一标识 */ + variable_api_name?: string + /** 变量名称 */ + variable_name?: FieldVariableValueI18n + /** 变量值 */ + variable_value?: FieldVariableValueTo + /** 在list_values和record_values中引用的变量 */ + sub_values?: FieldVariableSubVlaue[] +} + +export interface FieldVariableValueI18n { + /** 中文值 */ + zh_cn?: string + /** 英文值 */ + en_us?: string +} + +export interface FieldVariableValueTo { + /** 文本值 */ + text_value?: string + /** 布尔值 */ + bool_value?: boolean + /** 数字值 */ + number_value?: string + /** 枚举值，这里是枚举的id */ + enum_value?: string + /** 从 1970 开始的天数 */ + date_value?: string + /** 时间戳，毫秒 */ + date_time_value?: string + /** 多语字段值 */ + i18n_value?: FieldVariableValueI18n + /** 对象值，包括对象id和对象类型 */ + object_value?: FieldVariableValueToObject + /** 用户id，根据user_type选择对应的用户id */ + user_value?: string + /** 部门id，根据入参选择对应的部门id */ + department_value?: string + /** 记录类型字段值 */ + record_values?: FieldVariableValueToRecord[] + /** 员工类型字段值，为用户id，根据入参选择返回的用户id */ + employment_value?: string + /** 数组类型值，里面包含多个值，每个元素都对应subValues中的数组下标 */ + list_values?: string[] + /** 文件类型字段值，可通过主数据的文件下载Open API下载 */ + file_value?: FieldVariableValueToFile +} + +export interface FieldVariableValueToFile { + /** 用于主数据文件下载接口的id */ + open_file_id?: string + /** 文件名称 */ + file_name?: string + /** 文件大小，单位：Byte */ + length?: string + /** 文件类型，如`application/pdf` */ + mime_type?: string +} + +export interface FieldVariableValueToForReview { + /** 文本值 */ + text_value?: string + /** 布尔值 */ + bool_value?: boolean + /** 数字值 */ + number_value?: string + /** 枚举值，这里是枚举的id */ + enum_value?: string + /** 从 1970 开始的天数 */ + date_value?: string + /** 时间戳，毫秒 */ + date_time_value?: string + /** 多语字段值 */ + i18n_value?: FieldVariableValueI18n + /** 对象值，包括对象id和对象类型 */ + object_value?: FieldVariableValueToObject + /** 部门id，根据入参选择对应的部门id */ + department_value?: string + /** 员工类型字段值，为用户id，根据入参选择返回的用户id */ + employment_value?: string + /** 数组类型值，里面包含多个值，每个元素都对应subValues中的key */ + list_values?: string[] +} + +export interface FieldVariableValueToObject { + /** wukong的对象唯一标识 */ + wk_id?: string + /** wukong的元数据唯一标识 */ + wk_api_name?: string +} + +export interface FieldVariableValueToRecord { + /** 变量唯一标识 */ + variable_api_name?: string + /** 变量值，对应subValues中的key */ + sub_value_key?: string +} + +export interface File { + /** 附件 Token */ + token?: string + /** 文件名 */ + name?: string + /** 视图类型，卡片视图（默认）或预览视图 */ + view_type?: 1 | 2 +} + +export interface FileComment { + /** 评论 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 FileCommentReply { + /** 回复内容 */ + content: ReplyContent + /** 回复 ID */ + reply_id?: string + /** 用户 ID */ + user_id?: string + /** 创建时间 */ + create_time?: number + /** 更新时间 */ + update_time?: number + /** 回复的其他内容，图片 Token 等 */ + extra?: ReplyExtra +} + +export interface FileConfig { + /** 仅包含字母数字和下划线的 16 位字符串作为文件的标识，用户生成 */ + file_id: string + /** 语音格式，目前仅支持：pcm */ + format: string + /** 引擎类型，目前仅支持：16k_auto 中英混合 */ + engine_type: string +} + +export interface FileLike { + /** 用户 ID */ + user_id?: string + /** 用户最后点赞时间，秒级时间戳 */ + last_liked_time?: string + /** 用户名字，用户信息被脱敏时此值不会返回 */ + user_name?: string + /** 用户英文名字，用户信息被脱敏时此值不会返回 */ + user_en_name?: string + /** 用户头像，用户信息被脱敏时此值不会返回 */ + user_avatar_url?: string + /** 用户信息是否脱敏 */ + user_is_desensitized?: boolean +} + +export interface FileStatistics { + /** 文档历史访问人数，同一人多次访问按一次计算。 */ + uv?: number + /** 文档历史访问次数，同一人多次访问按多次计算。（注：同一人相邻两次访问间隔在半小时内视为一次访问） */ + pv?: number + /** 文档历史点赞总数 */ + like_count?: number + /** 时间戳（秒） */ + timestamp?: number + /** 今日新增文档访问人数 */ + uv_today?: number + /** 今日新增文档访问次数 */ + pv_today?: number + /** 今日新增文档点赞数 */ + like_count_today?: number +} + +export interface FileViewRecord { + /** 访问者 ID */ + viewer_id?: string + /** 访问者名称 */ + name?: string + /** 访问者头像 URL */ + avatar_url?: string + /** 最近访问时间，秒级时间戳 */ + last_view_time?: string +} + +export interface FilterCondition { + /** 左值 */ + left?: FilterRuleValue + /** 右值 */ + right?: FilterRuleValue + /** 操作符 */ + operator?: number + /** 右值类型 */ + right_value_type?: number +} + +export interface FilterExpression { + /** 规则 */ + conditions?: FilterCondition[] + /** 表达式 */ + expression?: string +} + +export interface FilterInfo { + /** 设置了筛选条件的列 */ + col: string + /** 筛选条件 */ + conditions: Condition[] +} + +export interface FilterRuleValue { + /** 规则值类型 */ + type?: number + /** 规则值 */ + value?: string + /** 下钻值 */ + lookup_value?: string + /** 下钻类型 */ + lookup_type?: string +} + +export interface FilterView { + /** 筛选视图 id */ + filter_view_id?: string + /** 筛选视图名字 */ + filter_view_name?: string + /** 筛选视图的筛选范围 */ + range?: string +} + +export interface FilterViewCondition { + /** 设置筛选条件的列，使用字母号 */ + condition_id?: string + /** 筛选类型 */ + filter_type?: string + /** 比较类型 */ + compare_type?: string + /** 筛选参数 */ + expected?: string[] +} + +export interface FindCondition { + /** 查找范围 */ + range: string + /** 大小写是否敏感 */ + match_case?: boolean + /** 是否匹配整个单元格 */ + match_entire_cell?: boolean + /** 是否为正则匹配 */ + search_by_regex?: boolean + /** 是否搜索公式内容 */ + include_formulas?: boolean +} + +export interface FindReplaceResult { + /** 符合查找条件的单元格数组，不包含公式，例如["A1", "A2"...] */ + matched_cells?: string[] + /** 符合查找条件的含有公式的单元格数组，例如["B3", "H7"...] */ + matched_formula_cells?: string[] + /** 符合查找条件的总行数 */ + rows_count?: number +} + +export interface FiveStartScoringResult { + /** 最高分中文描述 */ + highest_score_desc?: string + /** 最高分英文描述 */ + highest_score_en_desc?: string + /** 最低分中文描述 */ + lowest_score_desc?: string + /** 最低分英文描述 */ + lowest_score_en_desc?: string + /** 评分分数 */ + score_result?: number +} + +export interface FlexibleRule { + /** 下班最多可早走（上班早到几分钟，下班可早走几分钟） */ + flexible_early_minutes: number + /** 上班最多可晚到（上班晚到几分钟，下班须晚走几分钟） */ + flexible_late_minutes: number +} + +export interface FloatImage { + /** 浮动图片 id */ + float_image_id?: string + /** 浮动图片 token，需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */ + float_image_token?: string + /** 浮动图片的左上角单元格定位，只支持一个单元格 */ + range?: string + /** 浮动图片的宽度，大于等于 20px */ + width?: number + /** 浮动图片的高度，大于等于 20px */ + height?: number + /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移，大于等于0且小于所在单元格的宽度 */ + offset_x?: number + /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移，大于等于0且小于所在单元格的高度 */ + offset_y?: number +} + +export interface Follower { + /** 任务关注者 ID */ + id?: string + /** 要添加为关注人的user_id */ + id_list?: string[] +} + +export interface FollowUp { + /** 内容 */ + content: string + /** 多语言内容 */ + i18n_contents?: I18nContent[] +} + +export interface FoodManageEntity { + /** 识别的字段种类 */ + type?: 'validity_period' | 'issuer' | 'issuing_authority' | 'complaints_hotline' | 'license_number' | 'domicile' | 'legal_representative' | 'credit_code' | 'operator' | 'premise' | 'daily_supervisor' | 'daily_supervisory_authorities' | 'main_body' | 'operating_item' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface FoodManageLicense { + /** 识别出的实体列表 */ + entities?: FoodManageEntity[] +} + +export interface FoodProduceEntity { + /** 识别的字段种类 */ + type?: 'validity_period' | 'issuer' | 'issuing_authority' | 'complaints_hotline' | 'food_category' | 'production_address' | 'license_number' | 'domicile' | 'legal_representative' | 'credit_code' | 'producer' | 'daily_supervisory_authorities' | 'daily_supervisor' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface FoodProduceLicense { + /** 识别出的实体列表 */ + entities?: FoodProduceEntity[] +} + +export interface FormFieldVariable { + /** 变量api名称 */ + variable_api_name?: string + /** 变量名称的i18n描述 */ + variable_name?: BpmDataengineI18n + /** 变量值的对象 */ + variable_value?: FormVariableValueInfo +} + +export interface FormFieldVariableBoolValue { + /** 布尔变量的值 */ + value?: boolean +} + +export interface FormFieldVariableDatetimeValue { + /** 毫秒的时间戳 */ + value?: number + /** 时区 */ + zone?: string +} + +export interface FormFieldVariableDateValue { + /** 日期变量的值，从1970起的天数 */ + value?: number +} + +export interface FormFieldVariableDepartmentValue { + /** 部门ID */ + value?: string +} + +export interface FormFieldVariableEmploymentValue { + /** employmentID */ + value?: string + /** 员工ID 如3158117 */ + user_id?: string +} + +export interface FormFieldVariableEnumValue { + /** 枚举值 */ + value?: string + /** 枚举的名称 */ + name?: BpmDataengineI18n + /** 枚举的描述 */ + desc?: BpmDataengineI18n +} + +export interface FormFieldVariableFileValue { + /** 文件源类型（1BPM; 2主数据） */ + source_type?: number + /** 文件id */ + file_id?: string + /** 文件名称 */ + file_name?: string + /** 文件长度 */ + length?: number + /** mime type */ + mime_type?: string +} + +export interface FormFieldVariableI18nValue { + /** i18n值 */ + value?: BpmDataengineI18n +} + +export interface FormFieldVariableListObject { + /** 文本变量对象 */ + text_value?: FormFieldVariableTextValue + /** 数值变量对象 */ + number_value?: FormFieldVariableNumberValue + /** 日期变量对象 */ + date_value?: FormFieldVariableDateValue + /** 员工变量对象 */ + employment_value?: FormFieldVariableEmploymentValue + /** 日期时间变量对象 */ + date_time_value?: FormFieldVariableDatetimeValue + /** 枚举变量对象 */ + enum_value?: FormFieldVariableEnumValue + /** 空变量对象 */ + null_value?: FormFieldVariableNullValue + /** 布尔变量对象 */ + bool_value?: FormFieldVariableBoolValue + /** 部门变量对象 */ + department_value?: FormFieldVariableDepartmentValue + /** 文件变量对象 */ + file_value?: FormFieldVariableFileValue + /** i18n变量对象 */ + i18n_value?: FormFieldVariableI18nValue + /** 对象变量 */ + object_value?: FormFieldVariableObjectValue + /** 记录对象 */ + record_value?: FormFieldVariableRecordValue +} + +export interface FormFieldVariableListValue { + /** 列表值 */ + values?: FormFieldVariableListObject[] +} + +export type FormFieldVariableNullValue = unknown + +export interface FormFieldVariableNumberValue { + /** 数值类型变量的值 */ + value?: string +} + +export interface FormFieldVariableObjectValue { + /** 对象ID */ + value?: string + /** 主数据apiName */ + wk_api_name?: string +} + +export interface FormFieldVariableRecordValue { + /** 注意：这个值是一个map，key是变量唯一标识，value是变量值（平台限制，没法录入Map类型，这里用object示意一下） */ + values?: FormFieldVariableRecordValueExample +} + +export interface FormFieldVariableRecordValueExample { + /** 这个属性名称是map的key的示例，属性值是map的value的示例，值和外层的variable_value是的一样的结构。 */ + country_region?: FormVariableValueInfoExample +} + +export interface FormFieldVariableTextValue { + /** 文本类型变量的值 */ + value?: string +} + +export interface Formula { + /** 公式表达式 */ + expr?: string + /** 公式参数列表 */ + formula_params?: FormulaParam[] +} + +export interface FormulaParam { + /** 引用类型 */ + ref_type?: 1 | 2 + /** 引用类型ID */ + id?: string +} + +export interface FormVariableValueInfo { + /** 文本变量对象 */ + text_value?: FormFieldVariableTextValue + /** 数值变量对象 */ + number_value?: FormFieldVariableNumberValue + /** 日期变量对象 */ + date_value?: FormFieldVariableDateValue + /** 员工变量对象 */ + employment_value?: FormFieldVariableEmploymentValue + /** 日期时间变量对象 */ + date_time_value?: FormFieldVariableDatetimeValue + /** 枚举变量对象 */ + enum_value?: FormFieldVariableEnumValue + /** 空变量对象 */ + null_value?: FormFieldVariableNullValue + /** 布尔变量对象 */ + bool_value?: FormFieldVariableBoolValue + /** 部门变量对象 */ + department_value?: FormFieldVariableDepartmentValue + /** 文件变量对象 */ + file_value?: FormFieldVariableFileValue + /** i18n变量对象 */ + i18n_value?: FormFieldVariableI18nValue + /** 对象变量 */ + object_value?: FormFieldVariableObjectValue + /** 列表对象 */ + list_value?: FormFieldVariableListValue + /** 记录对象 */ + record_value?: FormFieldVariableRecordValue +} + +export interface FormVariableValueInfoExample { + /** 示例的国家地区变量对象 */ + object_value?: FormFieldVariableObjectValue +} + +export interface Freebusy { + /** 忙闲信息开始时间，RFC3339 date_time格式 */ + start_time: string + /** 忙闲信息结束时间，RFC3339 date_time格式 */ + end_time: string +} + +export interface FreePunchCfg { + /** 自由打卡开始时间 */ + free_start_time: string + /** 自由打卡结束时间 */ + free_end_time: string + /** 打卡的时间，一共7位，每一位代表一天，周一到周日，0是不上班，1是上班 */ + punch_day: number + /** 工作日不打卡即为缺卡 */ + work_day_no_punch_as_lack?: boolean + /** 工作日出勤是否需满足时长要求 */ + work_hours_demand?: boolean + /** 每日工作时长（分钟),范围[0,1440] */ + work_hours?: number +} + +export interface FunctionalRoleMember { + /** 成员ID */ + user_id?: string + /** 管理范围的类型 */ + scope_type?: 'All' | 'Part' | 'None' + /** 表示该角色成员的管理范围，scope_type为“指定范围”时，返回该值 */ + department_ids?: string[] +} + +export interface FunctionalRoleMemberResult { + /** 用户ID */ + user_id: string + /** 成员处理结果 */ + reason: 1 | 2 | 3 | 4 | 5 | 6 +} + +export interface Gadget { + /** pc 支持的小程序模式，bit 位表示 */ + enable_pc_mode?: 1 | 2 | 4 + /** schema url 列表 */ + schema_urls?: string[] + /** pc 端是否使用小程序版本 */ + pc_use_mobile_pkg?: boolean + /** pc 的小程序版本号 */ + pc_version?: string + /** 移动端小程序版本号 */ + mobile_version?: string + /** 移动端兼容的最低飞书版本 */ + mobile_min_lark_version?: string + /** pc 端兼容的最低飞书版本 */ + pc_min_lark_version?: string +} + +export interface GetSpreadsheet { + /** 电子表格标题 */ + title?: string + /** 电子表格owner */ + owner_id?: string + /** 电子表格token */ + token?: string + /** 电子表格url */ + url?: string +} + +export interface Grant { + /** 租户内授予名单的唯一标识，该值由系统随机生成。 */ + id?: string + /** 企业勋章的唯一ID */ + badge_id?: string + /** 授予名单名称，最多100个字符。 */ + name: string + /** 勋章下唯一的授予事项 */ + grant_type: 0 | 1 + /** 授予名单的生效时间对应的时区，用于检查RuleDetail的时间戳的取值是否规范，取值范围为TZ database name */ + time_zone: string + /** 规则详情 */ + rule_detail: RuleDetail + /** 是否授予给全员。1.为false时，需要关联1~500个用户群体。2.为true时，不可关联用户、用户组、部门。 */ + is_grant_all: boolean + /** 授予的用户ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + user_ids?: string[] + /** 授予的部门ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + department_ids?: string[] + /** 授予的用户组ID列表，授予名单列表接口返回结果中不返回该字段，只在详情接口返回 */ + group_ids?: string[] +} + +export interface Grid { + /** 分栏列数量 */ + column_size: number +} + +export interface GridColumn { + /** 当前分栏列占整个分栏的比例 */ + width_ratio?: number +} + +export interface Group { + /** 用户组ID */ + id: string + /** 用户组名字 */ + name: string + /** 用户组描述 */ + description?: string + /** 用户组成员中用户的数量 */ + member_user_count?: number + /** 用户组成员中部门的数量 */ + member_department_count?: number + /** 用户组的类型 */ + type?: 1 | 2 +} + +export interface GroupMeta { + /** 考勤组id */ + group_id: string + /** 考勤组名称 */ + group_name: string +} + +export interface HealthCertificate { + /** 识别出的实体类型 */ + entities?: HealthCertificateEntity[] +} + +export interface HealthCertificateEntity { + /** 识别的字段种类 */ + type?: 'name' | 'issued_by' | 'date_of_handling' | 'date_of_issue' | 'date_of_medical_examination' | 'valid_date' | 'other_date' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface HiberarchyCommon { + /** 上级组织 */ + parent_id?: string + /** 名称 */ + name: I18n[] + /** 启用 */ + active: boolean + /** 编码 */ + code?: string + /** 描述 */ + description?: I18n[] +} + +export interface HkmMainlandTravelPermit { + /** 识别出的实体类型 */ + entities?: HkmMainlandTravelPermitEntity[] +} + +export interface HkmMainlandTravelPermitEntity { + /** 识别的字段种类 */ + type?: 'full_name_cn' | 'full_name_en' | 'date_of_birth' | 'date_of_expiry' | 'card_number' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface Hrbp { + /** HRBP/属地 BP 的雇员ID */ + employment_id_list: string[] + /** 部门 id */ + department_id?: string + /** 工作地点 id */ + work_location_id?: string +} + +export interface Href { + /** 链接对应的地址 */ + url?: string + /** 链接对应的标题 */ + title?: string +} + +export interface I18n { + /** 中文描述 */ + zh_cn?: string + /** 英文描述 */ + en_us?: string + /** 日文描述 */ + ja_jp?: string +} + +export interface I18nContent { + /** 语言 */ + locale?: string + /** i18n内容 */ + value?: string +} + +export interface I18nEntryDesc { + /** 语言类型 */ + language: 1 | 2 | 3 + /** 纯文本释义 */ + description?: string + /** 富文本描述 */ + rich_text?: string +} + +export interface I18nMap { + /** 中文名称 */ + zh?: string + /** 英文名称 */ + en?: string + /** 日文名称 */ + ja?: string +} + +export interface I18nMeta { + /** 国际化字段：中文 */ + zh_cn?: string + /** 国际化字段：英文 */ + en_us?: string + /** 国际化字段：日文 */ + ja_jp?: string +} + +export interface I18nName { + /** ISO 639-1的语言代码。比如zh表示中文。 */ + language?: string + /** 名字 */ + name?: string +} + +export interface I18nNames { + /** 中文名 */ + zh_cn?: string + /** 英文名 */ + en_us?: string + /** 日文名 */ + ja_jp?: string +} + +export interface I18nResource { + /** 语言可选值有： zh-CN：中文 en-US：英文 ja-JP：日文 */ + locale: 'zh-CN' | 'en-US' | 'ja-JP' + /** 文案 key, value, i18n key 以 @i18n@ 开头； 该字段主要用于做国际化，语序用户同时传多个语言的文案，审批中心会根据用户当前的语音环境使用对应的文案，如果没有传用户当前的语音环境文案，则会使用默认的语言文案。 */ + texts: I18nResourceText[] + /** 是否默认语言，默认语言需要包含所有key，非默认语言如果key不存在会使用默认语言代替 */ + is_default: boolean +} + +export interface I18nResourceText { + key: string + value: string +} + +export type I18ns = I18n[] + +export interface I18nText { + /** 英文 */ + en_us?: string + /** 中文 */ + zh_cn?: string + /** 中文（香港地区） */ + zh_hk?: string + /** 中文（台湾地区） */ + zh_tw?: string + /** 日语 */ + ja_jp?: string + /** 法语 */ + fr_fr?: string + /** 意大利语 */ + it_it?: string + /** 德语 */ + de_de?: string + /** 俄语 */ + ru_ru?: string + /** 泰语 */ + th_th?: string + /** 西班牙语 */ + es_es?: string + /** 韩语 */ + ko_kr?: string +} + +export interface IdCard { + /** 识别的实体列表 */ + entities?: IdEntity[] + /** 正反面，1为身份证-姓名页，0为身份证-国徽页 */ + side?: number + /** 四角坐标[x0,y0,x1,y1,x2,y2,x3,y3] */ + conners?: number[] + /** 人像四角坐标[x0,y0,x1,y1,x2,y2,x3,y3] */ + face_conners?: number[] +} + +export interface IdEntity { + /** 识别的字段种类 */ + type?: 'identity_code' | 'identity_name' | 'address' | 'valid_date_start' | 'valid_date_end' | 'gender' | 'race' | 'issued_by' | 'birth' + /** 识别出字段的文本信息 */ + value?: string +} + +export type IdentityProvider = 'AILY' | 'FEISHU' + +export interface IdInfo { + /** 传入的 ID */ + id?: string + /** 目标 ID 值 */ + target_id?: string +} + +export interface IdNameObject { + /** 权限点ID */ + id?: string + /** 权限点名称 */ + name?: I18n +} + +export interface Iframe { + /** iframe 的组成元素 */ + component: IframeComponent +} + +export interface IframeComponent { + /** iframe 类型 */ + iframe_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 99 + /** iframe 目标 url（需要进行 url_encode） */ + url: string +} + +export interface Image { + /** 宽度，单位 px */ + width?: number + /** 高度，单位 px */ + height?: number + /** 图片 Token */ + token?: string + /** 对齐方式 */ + align?: 1 | 2 | 3 +} + +export interface ImportedMetric { + /** 被评估人 ID */ + reviewee_user_id: string + /** 指标 ID，指标的统一标识 */ + metric_id: string + /** 指标字段信息 */ + fields: ImportedMetricField[] +} + +export interface ImportedMetricField { + /** 指标字段 ID */ + field_id: string + /** 字段值 */ + field_value?: string + /** 字段值，当字段为人员信息时必填 */ + field_value_person?: string +} + +export interface ImportTask { + /** 任务 ID */ + ticket?: string + /** 导入目标云文档类型，支持的类型 新版文档：docx；电子表格：sheet；多维表格：bitable */ + type: string + /** 任务状态 */ + job_status?: 0 | 1 | 2 | 3 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 108 | 109 | 110 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 129 | 5000 | 7000 | 7001 | 7002 + /** 任务失败原因 */ + job_error_msg?: string + /** 导入云文档 Token */ + token?: string + /** 导入云文档 URL */ + url?: string + /** 任务成功后的提示信息 */ + extra?: string[] +} + +export interface ImportTaskMountPoint { + /** 挂载类型 */ + mount_type: 1 + /** 挂载位置,对于mount_type=1, 云空间目录token，空表示根目录 */ + mount_key: string +} + +export interface Indicator { + /** 薪资统计指标ID */ + id: string + /** 薪资统计指标名称 */ + name: string + /** 薪资统计指标数值类型 */ + value_type: 'money' | 'number' | 'percent' + /** 启用状态 */ + active_status: 1 | 0 + /** 多语言名称 */ + i18n_names: I18nContent[] +} + +export interface InlineBlock { + /** 关联的内联状态的 block 的 block_id */ + block_id: string + /** 文本局部样式 */ + text_element_style?: TextElementStyle +} + +export interface InlineFile { + /** 附件 token */ + file_token?: string + /** 当前文档中该附件所处的 block 的 id */ + source_block_id?: string + /** 文本局部样式 */ + text_element_style?: TextElementStyle +} + +export interface InputComment { + /** 评论内容 */ + content?: string +} + +export interface InputCustomField { + /** 字段名称 */ + name?: string + /** 数字类型的字段设置 */ + number_setting?: NumberSetting + /** 人员类型的字段设置 */ + member_setting?: MemberSetting + /** 时间日期类型的字段设置 */ + datetime_setting?: DatetimeSetting + /** 单选设置 */ + single_select_setting?: SelectSetting + /** 多选设置 */ + multi_select_setting?: SelectSetting + /** 文本类型 */ + text_setting?: TextSetting +} + +export interface InputCustomFieldValue { + /** 自定义字段guid */ + guid: string + /** 数字类型的自定义字段值，填写一个合法数字的字符串表示，空字符串表示设为空。 */ + number_value?: string + /** 人员类型的自定义字段值。可以设置1个或多个用户的id（遵循member格式，只支持user类型）。当字段设为只不能多选时只能输入一个值。设为空数组表示设为空。 */ + member_value?: Member[] + /** 日期类型自定义字段值，可以输入一个表示日期的以毫秒为单位的字符串。设为空字符串表示设为空。 */ + datetime_value?: string + /** 单选类型字段值，填写一个字段选项的option_guid。设置为空字符串表示设为空。 */ + single_select_value?: string + /** 多选类型字段值，可以填写一个或多个本字段的option_guid。设为空数组表示设为空。 */ + multi_select_value?: string[] + /** 文本类型字段值。可以填写最多3000字符。使用空字符串表示设为空。 */ + text_value?: string +} + +export interface InputOption { + /** 选项名称 */ + name?: string + /** 颜色索引值，支持0～54中的一个数字。如果不填写，则会随机选一个。 */ + color_index?: number + /** 要放到某个option之前的option_guid */ + insert_before?: string + /** 要放到某个option之后的option_guid */ + insert_after?: string + /** 是否隐藏 */ + is_hidden?: boolean +} + +export interface InputSection { + /** 自定义分组名 */ + name?: string + /** 要将新分组插入到自定义分分组的前面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ + insert_before?: string + /** 要将新分组插入到自定义分分组的后面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ + insert_after?: string +} + +export interface InputTask { + /** 任务标题 */ + summary?: string + /** 任务描述 */ + description?: string + /** 任务截止时间戳(ms)，截止时间戳和截止日期选择一个填写。 */ + due?: Due + /** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */ + extra?: string + /** 任务的完成时刻时间戳(ms) */ + completed_at?: string + /** 如果设置，则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */ + repeat_rule?: string + /** 如果设置，则将任务设计为“自定义完成”。用户在任务中心点击“完成”时，不会直接完成任务，而是跳转到第三方配置好的地址或者现实自定义提示。 */ + custom_complete?: CustomComplete + /** 任务的开始时间(ms) */ + start?: Start + /** 任务的完成模式。1 - 会签任务；2 - 或签任务 */ + mode?: number + /** 是否是里程碑任务 */ + is_milestone?: boolean + /** 自定义字段值 */ + custom_fields?: InputCustomFieldValue[] +} + +export interface InputTasklist { + /** 清单名称 */ + name?: string + /** 清单所有者 */ + owner?: Member +} + +export interface InsertGridColumnRequest { + /** 插入列索引，从 1 开始，如 1 表示在第一列后插入，注意不允许传 0（-1表示在最后一列后插入） */ + column_index: number +} + +export interface InsertTableColumnRequest { + /** 插入的列在表格中的索引。（-1表示在表格末尾插入一列） */ + column_index: number +} + +export interface InsertTableRowRequest { + /** 插入的行在表格中的索引。（-1表示在表格末尾插入一行） */ + row_index: number +} + +export interface Instance { + /** 日程实例ID */ + event_id: string + /** 日程主题 */ + summary?: string + /** 日程描述 */ + description?: string + /** 开始时间 */ + start_time?: TimeInfo + /** 结束时间 */ + end_time?: TimeInfo + /** 日程状态 */ + status?: 'tentative' | 'confirmed' | 'cancelled' + /** 是否是例外日程实例 */ + is_exception?: boolean + /** 日程的app_link,跳转到具体的某个日程 */ + app_link?: string + /** 日程地点 */ + location?: EventLocation +} + +export interface InstanceCcUser { + /** 抄送人 user id */ + user_id?: string + /** 审批实例内抄送唯一标识 */ + cc_id?: string + /** 抄送人 open id */ + open_id?: string +} + +export interface InstanceComment { + /** 评论 id */ + id: string + /** 发表评论用户 */ + user_id: string + /** 发表评论用户 open id */ + open_id: string + /** 评论内容 */ + comment: string + /** 1564590532967 */ + create_time: string + /** 评论附件 */ + files?: File[] +} + +export interface InstanceSearchApproval { + /** 审批定义 code */ + code?: string + /** 审批定义名称 */ + name?: string + /** 是否为第三方审批 */ + is_external?: boolean + /** 第三方审批信息 */ + external?: InstanceSearchApprovalExternal + /** 审批定义Id */ + approval_id?: string + /** 审批定义图标信息 */ + icon?: string +} + +export interface InstanceSearchApprovalExternal { + /** 是否支持批量读 */ + batch_cc_read?: boolean +} + +export interface InstanceSearchGroup { + /** 审批定义分组外部 id */ + external_id?: string + /** 审批定义分组名称 */ + name?: string +} + +export interface InstanceSearchItem { + /** 审批定义 */ + approval?: InstanceSearchApproval + /** 审批定义分组 */ + group?: InstanceSearchGroup + /** 审批实例信息 */ + instance?: InstanceSearchNode +} + +export interface InstanceSearchLink { + /** 审批实例 pc 端链接 */ + pc_link?: string + /** 审批实例移动端链接 */ + mobile_link?: string +} + +export interface InstanceSearchNode { + /** 审批实例 code */ + code?: string + /** 审批实例外部 id */ + external_id?: string + /** 审批实例发起人 id */ + user_id?: string + /** 审批实例开始时间 */ + start_time?: string + /** 审批实例结束时间 */ + end_time?: string + /** 审批实例状态 */ + status?: 'rejected' | 'pending' | 'canceled' | 'deleted' | 'approved' + /** 审批实例名称（只有第三方审批有） */ + title?: string + /** 审批实例扩展字段，string型json */ + extra?: string + /** 审批流水号 */ + serial_id?: string + /** 审批实例链接（只有第三方审批有） */ + link?: InstanceSearchLink +} + +export interface InstanceTask { + /** task id */ + id: string + /** 审批人的用户id，自动通过、自动拒绝 时为空 */ + user_id: string + /** 审批人 open id */ + open_id?: string + status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE' + /** task 所属节点 id */ + node_id?: string + /** task 所属节点名称 */ + node_name?: string + /** task 所属节点自定义 id, 如果没设置自定义 id, 则不返回该字段 */ + custom_node_id?: string + /** 审批方式 */ + type?: 'AND' | 'OR' | 'AUTO_PASS' | 'AUTO_REJECT' | 'SEQUENTIAL' + /** task 开始时间 */ + start_time: string + /** task 完成时间, 未完成为 0 */ + end_time?: string +} + +export interface InstanceTimeline { + /** 动态类型，不同类型 ext 内的 user_id_list 含义不一样 */ + type: 'START' | 'PASS' | 'REJECT' | 'AUTO_PASS' | 'AUTO_REJECT' | 'REMOVE_REPEAT' | 'TRANSFER' | 'ADD_APPROVER_BEFORE' | 'ADD_APPROVER' | 'ADD_APPROVER_AFTER' | 'DELETE_APPROVER' | 'ROLLBACK_SELECTED' | 'ROLLBACK' | 'CANCEL' | 'DELETE' | 'CC' + /** 发生时间 */ + create_time: string + /** 动态产生用户 */ + user_id?: string + /** 动态产生用户 open id */ + open_id?: string + /** 被抄送人列表 */ + user_id_list?: string[] + /** 被抄送人列表 */ + open_id_list?: string[] + /** 产生动态关联的task_id */ + task_id?: string + /** 理由 */ + comment?: string + /** 抄送人列表 */ + cc_user_list?: InstanceCcUser[] + /** 动态其他信息，json格式，目前包括 user_id_list, user_id，open_id_list，open_id */ + ext: string + /** 产生task的节点key */ + node_key?: string + /** 审批附件 */ + files?: File[] +} + +export interface InternOfferOffboardingInfo { + /** 实际离职日期（实际离职日期需晚于实际入职日期） */ + actual_offboarding_date: string + /** 备注 */ + notes?: string +} + +export interface InternOfferOnboardingInfo { + /** 实际入职日期 */ + actual_onboarding_date: string +} + +export interface Interview { + /** 面试id */ + id?: string + /** 面试开始时间（ms） */ + begin_time?: number + /** 面试结束时间（ms） */ + end_time?: number + /** 面试轮次（从0开始计数） */ + round?: number + /** 面试关联的投递阶段 */ + stage_id?: string + /** 面试官记录列表 */ + interview_record_list?: InterviewRecord[] +} + +export interface InterviewAddress { + /** 地址 ID */ + id?: string + /** 地址名称 */ + name?: I18n + /** 区域 */ + district?: CodeNameObject + /** 城市 */ + city?: CodeNameObject + /** 省 */ + state?: CodeNameObject + /** 国家 */ + country?: CodeNameObject +} + +export interface InterviewAggregation { + /** 面试信息列表 */ + interviews?: InterviewExtendV2[] +} + +export interface InterviewAppointmentConfig { + /** 是否开启面试官安排面试 */ + enable_interview_appointment_by_interviewer?: boolean + /** 配置详情 */ + config?: InterviewAppointmentConfigContent +} + +export interface InterviewAppointmentConfigContent { + /** 面试类型 */ + interview_type?: 1 | 2 | 3 + /** 时区 */ + talent_timezone_code?: string + /** 联系人id */ + contact_user_id?: string + /** 联系人电话 */ + contact_mobile?: string + /** 联系人邮箱 */ + contact_email?: string + /** 地址id */ + address_id?: string + /** 视频面试类型 */ + video_type?: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 100 + /** 抄送人id lsit */ + cc?: string[] + /** 备注 */ + remark?: string + /** 面试通知模板 */ + interview_notification_template_id?: string + /** 预约通知模板 */ + appointment_notification_template_id?: string + /** 取消面试通知 */ + cancel_interview_notification_template_id?: string +} + +export interface InterviewAttachment { + /** 附件 ID */ + file_id?: string + /** 附件名称 */ + file_name?: string + /** 附件类型 */ + content_type?: string + /** 附件创建时间(ms) */ + create_time?: string +} + +export interface InterviewDimensionOption { + /** 选项ID */ + id?: string + name?: I18n + description?: I18n + /** 选项分数值 */ + score_val?: number +} + +export interface Interviewer { + /** 面试官userID */ + user_id?: string + /** 认证状态 */ + verify_status?: 1 | 2 + /** 面试官标签ID */ + tag_id_list?: string[] +} + +export interface InterviewExtend { + /** 面试 ID */ + id?: string + /** 面试开始时间（ms） */ + begin_time?: number + /** 面试结束时间（ms） */ + end_time?: number + /** 面试轮次（从0开始计数） */ + round?: number + /** 面试记录信息 */ + interview_record_list?: InterviewRecord[] + /** 面试评价提交时间 */ + feedback_submit_time?: number + /** 面试关联的投递阶段 */ + stage_id?: string + /** 投递 ID */ + application_id?: string + /** 阶段信息 */ + stage?: IdNameObject + /** 创建人 */ + creator?: IdNameObject + /** 创建时间（ms） */ + biz_create_time?: number + /** 最近更新时间（ms） */ + biz_modify_time?: number + /** 面试状态 */ + interview_round_summary?: 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 + /** 面试安排 ID */ + interview_arrangement_id?: string + /** 面试类型 */ + interview_type?: 1 | 2 | 3 + /** 候选人时区 */ + talent_time_zone?: CodeNameObject + /** 面试联系人 */ + contact_user?: IdNameObject + /** 面试联系人电话 */ + contact_mobile?: string + /** 备注 */ + remark?: string + /** 面试地点 */ + address?: InterviewAddress + /** 视频面试工具 */ + video_type?: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 100 + /** 当安排类型为集中面试时，此值表示集中面试的安排状态 */ + arrangement_status?: 1 | 2 | 3 + /** 安排类型 */ + arrangement_type?: 1 | 2 + /** 安排方式（是否使用自助约面） */ + arrangement_appointment_kind?: 1 | 2 + /** 面试会议室 */ + meeting_room_list?: InterviewMeetingRoom[] + /** 面试轮次类型 */ + interview_round_type?: IdNameObject +} + +export interface InterviewExtendV2 { + /** 面试 ID */ + id?: string + /** 面试开始时间（ms） */ + begin_time?: string + /** 面试结束时间（ms） */ + end_time?: string + /** 面试轮次（从0开始计数） */ + round?: number + /** 面试记录信息 */ + interview_record_list?: InterviewRecordV2[] + /** 面试评价提交时间 */ + feedback_submit_time?: string + /** 面试关联的投递阶段 */ + stage_id?: string + /** 投递 ID */ + application_id?: string + /** 阶段信息 */ + stage?: IdNameObject + /** 创建人 */ + creator?: IdNameObject + /** 创建时间戳（单位：毫秒） */ + create_time?: string + /** 更新时间戳（单位：毫秒） */ + update_time?: string + /** 面试状态 */ + interview_round_summary?: 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 + /** 面试安排 ID */ + interview_arrangement_id?: string + /** 面试类型 */ + interview_type?: 1 | 2 | 3 + /** 候选人时区 */ + talent_time_zone?: CodeNameObject + /** 面试联系人 */ + contact_user?: IdNameObject + /** 面试联系人电话 */ + contact_mobile?: string + /** 备注 */ + remark?: string + /** 面试地点 */ + address?: BaseAddressV2 + /** 视频面试工具 */ + video_type?: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 100 + /** 当安排类型为集中面试时，此值表示集中面试的安排状态 */ + arrangement_status?: 1 | 2 | 3 | 4 + /** 安排类型 */ + arrangement_type?: 1 | 2 | 3 + /** 安排方式（是否使用自助约面） */ + arrangement_appointment_kind?: 1 | 2 + /** 面试会议室 */ + meeting_room_list?: InterviewMeetingRoom[] + /** 面试轮次类型 */ + interview_round_type?: IdNameObject +} + +export interface InterviewFeedbackForm { + /** 面试评价表ID */ + id?: string + /** 面试评价表版本号 */ + version?: number + /** 面试评价表名称 */ + name?: I18n + /** 面试评价表类型 */ + type?: 1 | 2 | 3 + /** 面试评价表打分计算配置（适用于打分评价表） */ + score_calculation_config?: ScoreCalculationConfig + /** 面试评价表模块列表 */ + modules?: InterviewFeedbackFormModule[] +} + +export interface InterviewFeedbackFormDimension { + /** 模块维度ID */ + id?: string + /** 维度名称 */ + name?: I18n + /** 维度描述 */ + description?: I18n + /** 维度类型 */ + type?: 1 | 2 | 3 | 5 | 6 | 7 | 10 | 11 | 12 + /** 是否启用 */ + enabled?: boolean + /** 维度顺序 */ + sequence?: number + /** 是否必选 */ + is_required?: boolean + /** 维度权重 */ + weight?: number + /** 评价维度的分数配置（适用于打分题） */ + score_dimension_config?: ScoreDimensionConfig + /** 选项列表(适用于单选题和多选题) */ + option_items?: InterviewDimensionOption[] + /** 是否展示「无法判断」选项，仅针对「职级建议」的维度类型 */ + display_not_evident?: boolean + /** 能力项列表 */ + ability_list?: DimensionAbility[] +} + +export interface InterviewFeedbackFormModule { + /** 面试评价表模块ID */ + id?: string + /** 模块名称 */ + name?: I18n + /** 模块描述 */ + description?: I18n + /** 模块类型 */ + type?: 1 | 2 + /** 模块顺序 */ + sequence?: number + /** 模块权重 */ + weight?: number + /** 模块维度列表 */ + dimensions?: InterviewFeedbackFormDimension[] +} + +export interface InterviewMeetingRoom { + /** 会议室 ID */ + room_id?: string + /** 会议室名称 */ + room_name?: string + /** 建筑名称 */ + building_name?: string + /** 会议室预定状态 */ + reserved_status?: 1 | 2 | 3 + /** 楼层 */ + floor_name?: string +} + +export interface InterviewRecord { + /** 面评ID */ + id?: string + /** 面试官用户 ID */ + user_id?: string + /** 面试记录内容 */ + content?: string + /** 提交状态 */ + commit_status?: 1 | 2 + /** 面试结论 */ + conclusion?: 1 | 2 | 3 | 4 | 5 + /** 面试得分 */ + interview_score?: InterviewScore + /** 面试官信息 */ + interviewer?: IdNameObject +} + +export interface InterviewRecordV2 { + /** 面试评价ID */ + id?: string + /** 面试评价表ID */ + feedback_form_id?: string + /** 提交状态 */ + commit_status?: 1 | 2 + /** 面试评价提交时间 */ + submit_time?: string + /** 面试评价分数 */ + record_score?: RecordScore + /** 面试官信息 */ + interviewer?: BasicUserInfo + /** 面试评价附件列表 */ + attachments?: InterviewAttachment[] + /** 模块评价列表 */ + module_assessments?: ModuleAssessment[] +} + +export interface InterviewRegistrationSchema { + /** 面试登记表模板 ID */ + id?: string + /** 面试登记表模板名称 */ + name?: string + /** 是否用作面试登记表 */ + is_used_as_interview?: boolean + /** 模块列表 */ + object_list?: CommonSchema[] +} + +export interface InterviewRoundType { + /** 面试轮次类型 ID */ + id?: string + /** 面试轮次类型业务 ID */ + biz_id?: string + /** 面试轮次类型名称 */ + name?: I18n + /** 职位流程类型 */ + process_type?: 1 | 2 + /** 启用状态 */ + active_status?: 1 | 2 + /** 面试评价表 */ + interview_assessment_template_info?: InterviewRoundTypeAssessmentTemplate +} + +export interface InterviewRoundTypeAssessmentTemplate { + /** 面试评价表 ID */ + id?: string + /** 面试评价表业务 ID */ + biz_id?: string + /** 面试评价表名称 */ + name?: I18n +} + +export interface InterviewScore { + /** 面试得分 ID */ + id?: string + /** 分数级别 */ + level?: number + /** 中文名称 */ + zh_name?: string + /** 中文描述 */ + zh_description?: string + /** 英文名称 */ + en_name?: string + /** 英文描述 */ + en_description?: string +} + +export interface InterviewTask { + /** 面试 ID */ + id?: string + /** 职位 ID */ + job_id?: string + /** 人才 ID */ + talent_id?: string + /** 投递 ID */ + application_id?: string + /** 任务状态 */ + activity_status?: 1 | 2 | 3 | 5 +} + +export interface Isv { + /** 团队互动应用唯一ID */ + component_id?: string + /** 团队互动应用类型，比如信息收集"blk_5f992038c64240015d280958" */ + component_type_id?: string +} + +export interface Item { + /** 用户统计设置一级项 */ + code: string + /** 用户统计设置二级项 */ + child_items?: ChildItem[] +} + +export interface ItemCategory { + /** 薪酬项分类ID */ + id: string + /** 薪酬项分类名称 */ + name: string + /** 薪酬项多语言分类 */ + i18n_names?: I18nContent[] +} + +export interface ItemContent { + /** 内容的格式 */ + format?: 'html' | 'plaintext' + /** 全文数据 */ + content_data?: string +} + +export interface ItemMetadata { + /** 数据项标题 */ + title: string + /** 搜索命中的跳转地址 */ + source_url: string + /** 数据项的创建时间，采用 Unix 时间戳 */ + create_time?: number + /** 数据项的更新时间，采用 Unix 时间戳 */ + update_time?: number + /** 移动端搜索命中的跳转地址。如果您PC端和移动端有不同的跳转地址，可以在这里写入移动端专用的url，我们会在搜索时为您选择合适的地址 */ + source_url_mobile?: string +} + +export interface JiraIssue { + /** Jira issue ID */ + id?: string + /** Jira issue key */ + key?: string +} + +export interface Job { + id?: unknown + name?: string +} + +export interface JobBasicInfo { + /** 职位 ID */ + id?: string + /** 职位名称 */ + name?: string + /** 职位编码 */ + code?: string +} + +export interface JobChange { + /** 异动记录 id */ + job_change_id?: string + /** 雇员 id */ + employment_id?: string + /** 异动详细信息 */ + transfer_info?: TransferInfo +} + +export interface JobConfigDetail { + /** Offer 申请表，含 ID+name */ + offer_apply_schema?: IdNameObject + /** Offer 审批流，含 ID+name */ + offer_process_conf?: IdNameObject + /** 建议评估人，可多位 */ + recommended_evaluator_list?: IdNameObject[] + /** 面试评价表，含 ID+name */ + assessment_template?: IdNameObject + /** 建议面试官列表，可多位 */ + interview_round_list?: JobConfigInterviewRound[] + /** 面试登记表 */ + interview_registration?: RegistrationInfo + /** 入职登记表 */ + onboard_registration?: RegistrationInfo + /** 面试轮次类型列表 */ + interview_round_type_list?: JobConfigRoundTypeResult[] + /** 关联职位列表 */ + related_job_list?: IdNameObject[] + /** 职位属性，1是实体职位，2是虚拟职位 */ + job_attribute?: number + /** 面试官安排面试配置 */ + interview_appointment_config?: InterviewAppointmentConfig + /** 实习Offer 申请表，含 ID+name */ + internship_offer_apply_schema?: IdNameObject +} + +export interface JobConfigInterviewRound { + /** 面试官列表 */ + interviewer_list?: IdNameObject[] + /** 面试轮次 */ + round?: number +} + +export interface JobConfigInterviewRoundConf { + /** 建议面试官 ID 列表 */ + interviewer_id_list?: string[] + /** 面试轮次 */ + round?: number +} + +export interface JobConfigResult { + /** Offer 申请表，含 ID+name */ + offer_apply_schema?: IdNameObject + /** Offer 审批流，含 ID+name */ + offer_process_conf?: IdNameObject + /** 建议评估人，可多位 */ + recommended_evaluator_list?: IdNameObject[] + /** 面试评价表，含 ID+name */ + assessment_template?: IdNameObject + /** 职位 ID */ + id?: string + /** 建议面试官列表，可多位 */ + interview_round_list?: JobConfigInterviewRound[] + /** 招聘需求，含 ID+name */ + job_requirement_list?: IdNameObject[] + /** 面试登记表 */ + interview_registration?: RegistrationInfo + /** 入职登记表 */ + onboard_registration?: RegistrationInfo + /** 面试轮次类型列表 */ + interview_round_type_list?: JobConfigRoundTypeResult[] + /** 关联职位列表 */ + related_job_list?: IdNameObject[] + /** 职位属性，1是实体职位，2是虚拟职位 */ + job_attribute?: number + /** 面试官安排面试配置 */ + interview_appointment_config?: InterviewAppointmentConfig + /** 官网申请表 */ + portal_website_apply_form_schema_info?: RegistrationInfo +} + +export interface JobConfigRoundType { + /** 面试轮次类型 ID */ + round_biz_id?: string + /** 面试评价表 ID */ + assessment_template_biz_id?: string +} + +export interface JobConfigRoundTypeResult { + /** 面试轮次类型 */ + assessment_round?: IdNameObject + /** 面试评价表 */ + assessment_template?: IdNameObject +} + +export interface JobCustomizedData { + /** 自定义字段 ID */ + object_id?: string + /** 字段名称 */ + name?: I18n + /** 字段类型 */ + object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** 自定义字段值 */ + value?: JobCustomizedValue +} + +export interface JobCustomizedOption { + /** 选项 ID */ + key?: string + /** 选项名称 */ + name?: I18n +} + +export interface JobCustomizedTimeRange { + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string +} + +export interface JobCustomizedValue { + /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ + content?: string + /** 当字段类型为单选时，从此字段取值 */ + option?: JobCustomizedOption + /** 当字段类型为多选时，从此字段取值 */ + option_list?: JobCustomizedOption[] + /** 当字段类型为时间段时，从此字段取值 */ + time_range?: JobCustomizedTimeRange + /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是毫秒级时间戳 */ + time?: string + /** 当字段类型为数字时，从此字段取值 */ + number?: string +} + +export interface JobData { + /** 实体在 CoreHR 内部的唯一键 */ + id?: string + /** 任职记录版本 ID */ + version_id?: string + /** 级别 */ + job_level_id?: string + /** 职等ID */ + job_grade_id?: string + /** 雇员类型 */ + employee_type_id: string + /** 工时制度 */ + working_hours_type_id?: string + /** 工作地点 */ + work_location_id?: string + /** 部门 */ + department_id?: string + /** 职务 */ + job_id?: string + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期 */ + probation_end_date?: string + /** 主任职 */ + primary_job_data: boolean + /** Employment ID */ + employment_id: string + /** 生效时间 */ + effective_time: string + /** 失效时间 */ + expiration_time?: string + /** 职务分类 ID */ + job_family_id?: string + /** 任职原因 */ + assignment_start_reason?: Enum + /** 试用期结束日期 */ + probation_expected_end_date?: string + /** 周工作时长 */ + weekly_working_hours?: number + /** 实线主管 */ + direct_manager_id?: string + /** 虚线主管 */ + dotted_line_manager_id_list?: string[] + /** 第二实线主管 */ + second_direct_manager_id?: string + /** 成本中心分摊信息 */ + cost_center_rate?: SupportCostCenterItem[] + /** 周工作时长v2 */ + weekly_working_hours_v2?: number + /** 排班类型 */ + work_shift?: Enum + /** 薪资类型 */ + compensation_type?: Enum + /** 任职公司 */ + service_company?: string +} + +export interface JobDataCostCenter { + /** 成本中心id，可以通过【查询单个成本中心信息】接口获取对应的成本中心信息 */ + cost_center_id?: string + /** 分摊比例 */ + rate?: number + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface JobDataCustomOrg { + /** 生效时间 */ + effective_time: string + /** 原因 */ + start_reason?: string + /** 自定义组织列表 */ + custom_org_with_rates: CreateEmpCustomOrg[] + /** 自定义组织类型 */ + object_api_name: string +} + +export interface JobDepartmentSimple { + /** 部门 ID */ + id?: string + /** 部门名称 */ + name?: I18n +} + +export interface JobDetail { + /** 职位基本信息 */ + basic_info?: JobDetailBasicInfo + /** 职位负责人 */ + recruiter?: JobUserInfo + /** 职位协助人列表 */ + assistant_list?: JobUserInfo[] + /** 职位用人经理列表 */ + hiring_manager_list?: JobUserInfo[] + /** 招聘需求列表 */ + job_requirement_list?: JobRequirementSimple[] + /** 职位地址列表 */ + address_list?: CommonAddress[] + /** 职位设置 */ + job_config?: JobConfigDetail + /** 门店列表 */ + storefront_list?: JobStorefront[] + /** 职位标签列表 */ + tag_list?: JobDetailTag[] +} + +export interface JobDetailBasicInfo { + /** 职位 ID */ + id?: string + /** 职位名称 */ + title?: string + /** 职位描述 */ + description?: string + /** 职位编号 */ + code?: string + /** 职位要求 */ + requirement?: string + /** 雇佣类型 */ + recruitment_type?: JobDetailRecruitmentType + /** 部门 */ + department?: JobDetailDepartment + /** 最低职级 */ + min_job_level?: JobDetailLevel + /** 最高职级 */ + max_job_level?: JobDetailLevel + /** 职位亮点 */ + highlight_list?: JobDetailHighlight[] + /** 职位序列 */ + job_category?: JobDetailCategory + /** 职位类别 */ + job_type?: JobDetailType + /** 启用状态 */ + active_status?: 1 | 2 + /** 创建人ID，若为空则为系统或其他对接系统创建 */ + creator_id?: string + /** 创建时间, 毫秒级时间戳 */ + create_time?: string + /** 更新时间，毫秒级时间戳 */ + update_time?: string + /** 职位流程类型 */ + process_type?: 1 | 2 + /** 职位流程 ID */ + process_id?: string + /** 职位流程名称 */ + process_name?: I18n + /** 自定义字段列表 */ + customized_data_list?: JobCustomizedData[] + /** 职能分类 */ + job_function?: IdNameObject + /** 职位项目 */ + subject?: IdNameObject + /** 招聘数量 */ + head_count?: number + /** 工作年限 */ + experience?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + /** 到期日期,毫秒级时间戳 */ + expiry_time?: string + /** 最低薪资，单位:k */ + min_salary?: number + /** 最高薪资，单位:k */ + max_salary?: number + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 工作地点列表 */ + city_list?: CodeNameObject[] + /** 职位属性，1是实体职位，2是虚拟职位 */ + job_attribute?: 1 | 2 + /** 目标专业 */ + target_major_list?: JobDetailTargetMajorInfo[] + /** 标志是否门店职位，1是普通职位，2是门店职位 */ + storefront_mode?: 1 | 2 +} + +export interface JobDetailCategory { + /** 职位序列 ID */ + id?: string + /** 职位序列名称 */ + name?: I18n + /** 职位序列启用状态 */ + active_status?: 1 | 2 +} + +export interface JobDetailDepartment { + /** 部门 ID */ + id?: string + /** 部门名称 */ + name?: I18n +} + +export interface JobDetailHighlight { + /** 职位亮点 ID */ + id?: string + /** 职位亮点名称 */ + name?: I18n +} + +export interface JobDetailLevel { + /** 职级 ID */ + id?: string + /** 职级名称 */ + name?: I18n + /** 职级启用状态 */ + active_status?: 1 | 2 +} + +export interface JobDetailRecruitmentType { + /** 雇佣类型 ID */ + id?: string + /** 雇佣类型名称 */ + name?: I18n + /** 雇佣类型启用状态 */ + active_status?: 1 | 2 +} + +export interface JobDetailTag { + /** 标签 ID */ + id?: string + /** 标签名称 */ + name?: I18n + /** 标签顺序 */ + order?: number +} + +export interface JobDetailTargetMajorInfo { + /** 目标专业ID */ + id?: string + /** 目标专业名称 */ + name?: I18n +} + +export interface JobDetailType { + /** 职位类别 ID */ + id?: string + /** 职位类别名称 */ + name?: I18n +} + +export interface JobFamily { + /** 序列名称。1-100字符，支持中、英文及符号 */ + name?: string + /** 序列描述，描述序列详情信息 */ + description?: string + /** 上级序列ID。需是该租户的序列ID列表中的值，对应唯一的序列名称。 */ + parent_job_family_id?: string + /** 是否启用 */ + status?: boolean + /** 多语言序列名称 */ + i18n_name?: I18nContent[] + /** 多语言描述 */ + i18n_description?: I18nContent[] + /** 职级序列ID */ + job_family_id?: string +} + +export interface JobFunction { + /** 职能分类 ID */ + id?: string + /** 职能名称 */ + name?: I18n + /** 启用状态 */ + active_status?: 1 | 2 + /** 父级职能分类 ID */ + parent_id?: string +} + +export interface JobGrade { + /** 职等 ID */ + job_grade_id?: string + /** 职等数值 */ + grade_order?: number + /** 编码 */ + code?: string + /** 名称 */ + names?: I18n[] + /** 描述 */ + descriptions?: I18n[] + /** 启用 */ + active?: boolean +} + +export interface JobLevel { + /** 职级名称 */ + name?: string + /** 职级描述 */ + description?: string + /** 职级的排序，可填入自然数100-100000的数值，系统按照数值大小从小到大排序。不填写该字段时，默认新增排序在当前职级列表中最后位（最大值） */ + order?: number + /** 是否启用 */ + status?: boolean + /** 职级ID */ + job_level_id?: string + /** 多语言名称 */ + i18n_name?: I18nContent[] + /** 多语言描述 */ + i18n_description?: I18nContent[] +} + +export interface JobManager { + /** 职位ID */ + id?: string + /** 招聘负责人ID */ + recruiter_id: string + /** 用人经理ID列表 */ + hiring_manager_id_list: string[] + /** 协助人ID列表 */ + assistant_id_list?: string[] +} + +export interface JobProcesses { + /** ID */ + id?: string + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string + /** 类型 1=社招流程, 2=校招流程, */ + type?: 1 | 2 + /** 阶段列表, 内部按用户设置顺序排列 */ + stage_list?: JobProcessesStage[] +} + +export interface JobProcessesStage { + /** ID */ + id?: string + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string + /** 1=筛选型, 2=评估型, 3=笔试型, 4=面试型, 5=Offer型, 6=待入职, 7=已入职, 8=其它类型, 255=系统默认，后端模型中并没有该字段，仅用于前端显示, */ + type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 255 +} + +export interface JobRecruiter2 { + /** 职位ID */ + id?: string + /** 招聘负责人ID */ + recruiter_id?: string + /** 用人经理ID列表 */ + hiring_manager_id_list?: string[] + /** 协助人ID列表 */ + assistant_id_list?: string[] +} + +export interface JobRequirementCustomizedData { + /** 自定义字段 ID */ + object_id?: string + /** 自定义字段 value，1. 对于自定义字段，若字段类型为单行文本/多行文本，传值格式为"这是一个文本"；2. 若字段类型为单选，传值内容为选项的 ID，格式为"6890840516938696974"；3. 若字段类型为多选，传值内容为选项的ID 列表，格式为"[\"6890840516938696974\", \"6890840516938696975\" ]"；4. 若字段类型为时间段，传值格式为"[\"1609430400000\", \"1612108800000\" ]"，单位是毫米级时间戳；5. 若字段类型为年份选择，传值格式为"1609430400000"，单位是毫秒级时间戳；6. 若字段类型为月份选择，传值格式为"1625068800000"，单位是毫秒级时间戳；7. 若字段类型为数字，传值格式为"1"; */ + value?: string +} + +export interface JobRequirementCustomizedDataDto { + /** 自定义字段 ID */ + object_id?: string + /** 字段名称 */ + name?: I18n + /** 字段类型 */ + object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** 自定义字段值 */ + value?: JobRequirementCustomizedValue +} + +export interface JobRequirementCustomizedOption { + /** 选项 ID */ + key?: string + /** 选项名称 */ + name?: I18n +} + +export interface JobRequirementCustomizedTimeRange { + /** 开始时间，毫秒级时间戳 */ + start_time?: string + /** 结束时间，毫秒级时间戳 */ + end_time?: string +} + +export interface JobRequirementCustomizedValue { + /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ + content?: string + /** 当字段类型为单选时，从此字段取值 */ + option?: JobRequirementCustomizedOption + /** 当字段类型为多选时，从此字段取值 */ + option_list?: JobRequirementCustomizedOption[] + /** 当字段类型为时间段时，从此字段取值 */ + time_range?: JobRequirementCustomizedTimeRange + /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是毫秒级时间戳 */ + time?: string + /** 当字段类型为数字时，从此字段取值 */ + number?: string +} + +export interface JobRequirementDto { + /** 招聘需求 ID */ + id?: string + /** 招聘需求编号 */ + short_code?: string + /** 需求名称 */ + name?: string + /** 需求状态 */ + display_progress?: 1 | 2 | 3 | 4 | 5 | 6 + /** 需求人数 */ + head_count?: number + /** 职位性质 */ + recruitment_type?: IdNameObject + /** 人员类型 */ + employee_type?: IdNameObject + /** 最高职级 */ + max_level?: IdNameObject + /** 最低职级 */ + min_level?: IdNameObject + /** 职位序列 */ + sequence?: IdNameObject + /** 需求类型 */ + category?: 1 | 2 + /** 需求部门 */ + department?: IdNameObject + /** 需求负责人 */ + recruiter_list?: IdNameObject[] + /** 需求用人经理 */ + jr_hiring_managers?: IdNameObject[] + /** 直属上级 */ + direct_leader_list?: IdNameObject[] + /** 开始日期，毫秒级时间戳 */ + start_time?: string + /** 预计完成日期，毫秒级时间戳 */ + deadline?: string + /** 招聘优先级 */ + priority?: 1 | 2 | 3 + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 最高薪资 */ + max_salary?: string + /** 最低薪资 */ + min_salary?: string + /** 工作地点 */ + address?: IdNameObject + /** 需求描述 */ + description?: string + /** 自定义字段 */ + customized_data_list?: JobRequirementCustomizedDataDto[] + /** 招聘需求支持的招聘类型 */ + process_type?: 1 | 2 + /** 职位类别 */ + job_type?: JobTypeInfo + /** 创建时间,毫秒级时间戳 */ + create_time?: string + /** 创建人ID */ + creator_id?: string + /** 更新时间,毫秒级时间戳 */ + update_time?: string + /** 职务 ID */ + employment_job_id?: string + /** 岗位 ID */ + position_id?: string +} + +export interface JobRequirementSchema { + /** 模板 ID */ + id?: string + /** 国际化模板名称 */ + name?: I18n + /** 模板字段 */ + object_list?: CommonSchema[] +} + +export interface JobRequirementSimple { + /** 招聘需求 ID */ + id?: string + /** 招聘需求编号 */ + short_code?: string + /** 需求名称 */ + name?: string + /** 需求部门 ID */ + department_id?: string +} + +export interface JobRequirementUpdateOption { + /** 是否需要修改关联的职位 */ + need_update_related_job?: boolean +} + +export interface JobSchema { + /** 职位模板 ID */ + id?: string + /** 职位模板名称 */ + name?: I18n + /** 职位模板类型 */ + scenario_type?: 1 | 2 + /** 模块列表 */ + object_list?: CommonSchema[] +} + +export interface JobStorefront { + /** 门店ID */ + id?: string + /** 门店名称 */ + name?: I18n + /** 启用状态 */ + active_status?: 1 | 2 + /** 门店部门 */ + department?: JobDepartmentSimple + /** 门店地址 */ + address?: CommonAddress + /** 门店负责人 */ + manager?: JobUserInfo + /** 创建时间，毫秒级时间戳 */ + create_time?: string + /** 备注 */ + remark?: I18n +} + +export interface JobTitle { + /** 职务ID */ + job_title_id?: string + /** 职务名称。1-100字符，支持中、英文及符号 */ + name?: string + /** 多语言职务名称 */ + i18n_name?: I18nContent[] + /** 是否启用 */ + status?: boolean +} + +export interface JobTypeInfo { + /** 职位类别ID */ + id: string + /** 职位类别名称 */ + name: I18n + /** 父级职位类别ID */ + parent_id?: string +} + +export interface JobUserInfo { + /** 人员 ID */ + id?: string + /** 名称 */ + name?: I18n +} + +export interface KvEntity { + /** 识别的实体类型 */ + type?: string + /** 识别出字段的文本信息 */ + value?: string +} + +export interface Label { + /** 中文内容 */ + zh_cn: string + /** 英文内容 */ + en_us: string +} + +export interface LangText { + /** 语言码 */ + lang: string + /** 语言码对应的文本 */ + value: string +} + +export interface Language { + /** 语言 ID */ + language_id?: string + /** 语言名称 */ + name?: I18n[] + /** IETF 编码 */ + ietf_language_tag?: string + /** 状态 */ + status?: 1 | 0 +} + +export interface LateOffLateOnRule { + /** 晚走多久 */ + late_off_minutes: number + /** 晚到多久 */ + late_on_minutes: number +} + +export interface LateOffLateOnSetting { + /** 当日晚走时间计算规则 */ + late_off_base_on_time_type?: 0 | 1 + /** 次日晚到时间计算规则 */ + late_on_base_on_time_type?: 0 | 1 +} + +export interface LeaveAccrualRecord { + /** 授予记录唯一ID */ + id: string + /** 员工ID */ + employment_id: string + /** 假期类型ID */ + leave_type_id: string + /** 授予数量 */ + granting_quantity: string + /** 授予单位，1表示天，2表示小时 */ + granting_unit: number + /** 生效日期，格式"2020-01-01" */ + effective_date: string + /** 失效日期，格式"2020-01-01" */ + expiration_date: string + /** 授予来源，1：系统授予；2：手动授予；3：外部系统授予 */ + granted_by: number + /** 授予原因 */ + reason: LangText[] + /** 授予记录的创建时间，unix时间戳 */ + created_at: string + /** 授予记录的创建人的ID */ + created_by: string + /** 授予记录的更新时间，unix时间戳 */ + updated_at: string + /** 授予记录的更新人的ID */ + updated_by: string + /** 是否参与折算 */ + section_type?: number +} + +export interface LeaveBalance { + /** 假期类型ID */ + leave_type_id: string + /** 假期类型名称 */ + leave_type_name: I18n[] + /** 结转的历史周期授予时长 */ + historical_cycles_left?: string + /** 本周期授予时长 */ + this_cycle_total?: string + /** 本周期已休时长 */ + this_cycle_taken: string + /** 假期余额 */ + leave_balance: string + /** 假期时长的单位 */ + leave_duration_unit: number + /** 历史结转发放 */ + history_cycle_accrual?: string + /** 当前周期余额 */ + balance_in_current_cycle?: string + /** 已休时长 */ + taken?: string + /** 历史周期已休时长 */ + taken_history_cycle?: string + /** 余额（离职折算） */ + offboarding_balance?: string + /** 已休时长（截止当日） */ + taken_current_date?: string + /** 本周期授予时长（离职折算） */ + offboarding_granted?: string +} + +export interface LeaveEmployExpireRecord { + /** record id */ + id: string + /** 员工ID */ + employment_id: string + /** 假期类型ID */ + leave_type_id: string + /** 授予余额数量 */ + granting_quantity: string + /** 授予数量 扣减完后的授予数量 */ + left_granting_quantity: string + /** 授予单位，1表示天，2表示小时 */ + granting_unit: number + /** 生效日期，格式"2020-01-01" */ + effective_date: string + /** 失效日期，格式"2020-01-01" */ + expiration_date: string + /** 授予原因 */ + reason: LangText[] + /** 是否已经被外部系统更改过 */ + is_update_by_external: boolean + /** 授予来源 */ + accrual_source: 1 | 2 | 3 | 4 | 5 | 6 + /** 假期子类型id */ + leave_sub_type_id: string + /** 是否参与清算 */ + section_type?: number +} + +export interface LeaveGrantingRecord { + /** 假期授予记录 ID */ + id: string + /** 员工 ID */ + employment_id: string + /** 假期类型 ID */ + leave_type_id: string + /** 授予数量 */ + granting_quantity: string + /** 授予时长单位 */ + granting_unit: number + /** 生效时间 */ + effective_date: string + /** 失效时间（根据休假规则自动计算） */ + expiration_date: string + /** 授予来源 */ + granted_by: number + /** 授予原因 */ + reason: I18n[] + /** 授予记录的创建时间，毫秒级unix时间戳 */ + created_at: string + /** 授予记录的创建人，值为创建人的员工 ID */ + created_by: string + /** 授予记录的更新时间 */ + updated_at: string + /** 授予记录的更新人，值为更新人的员工 ID */ + updated_by: string + /** 是否参与折算 */ + section_type?: number +} + +export interface LeaveNeedPunchCfg { + /** 晚到超过多久记为迟到 */ + late_minutes_as_late?: number + /** 晚到超过多久记为缺卡 */ + late_minutes_as_lack?: number + /** 早走超过多久记为早退 */ + early_minutes_as_early?: number + /** 早走超过多久记为缺卡 */ + early_minutes_as_lack?: number +} + +export interface LeaveProcessInfo { + /** 流程id */ + process_id: string + /** 流程状态 */ + process_status: string + /** 流程发起时间 */ + process_apply_time: string +} + +export interface LeaveRequest { + /** 请假记录ID */ + leave_request_id: string + /** 雇佣信息ID */ + employment_id: string + /** 员工姓名 */ + employment_name: I18n[] + /** 假期类型ID */ + leave_type_id: string + /** 假期类型名称 */ + leave_type_name: I18n[] + /** 假期开始时间 */ + start_time: string + /** 假期结束时间 */ + end_time: string + /** 假期时长 */ + leave_duration: string + /** 假期时长的单位 */ + leave_duration_unit: number + /** 请假记录的状态 */ + leave_request_status: number + /** 数据来源 */ + grant_source: string + /** 返岗时间 */ + return_time: string + /** 发起时间 */ + submitted_at: string + /** 发起人 */ + submitted_by: string + /** 备注 */ + notes: string + /** 审批通过日期 */ + approval_date?: string + /** 是否带薪 */ + is_deducted?: boolean + /** 请假详情 */ + details?: LeaveRequestDetail[] + /** 假期类型枚举 */ + leave_type_code?: string + /** 实际结束日期 */ + actual_end_date?: string + /** 预估结束日期 */ + estimated_end_date?: string + /** 时区 */ + time_zone?: string + /** 请假记录数据来源 */ + data_source?: number + /** 请假申请流程ID */ + leave_process_id?: string[] + /** 请假更正流程ID */ + leave_correct_process_id?: string[] + /** 请假取消流程ID */ + leave_cancel_process_id?: string[] + /** 请假返岗流程ID */ + leave_return_process_id?: string[] + /** workDay算薪类型 */ + wd_paid_type?: number + /** 请假更正流程信息 */ + leave_correct_process_info?: LeaveProcessInfo[] +} + +export interface LeaveRequestDetail { + /** 请假记录id */ + leave_request_id: string + /** 假期发生日期 */ + leave_date: string + /** 假期时长 */ + leave_duration: string + /** 假期时长单位，1：天，2：小时 */ + leave_duration_unit: number + /** 是否影响算薪，1：不参与算薪计算, 非对应的日期类型或者无对应的假期计划，2：影响算薪，3：不影响算薪 */ + paid_type: number +} + +export interface LeaveSubtype { + /** 假期子类ID */ + leave_type_id: string + /** 假期子类名称 */ + leave_type_name: I18n[] +} + +export interface LeaveType { + /** 假期类型ID */ + leave_type_id: string + /** 假期类型名称 */ + leave_type_name: I18n[] + /** 假期类型状态 */ + status: number + /** 假期子类列表 */ + leave_subtype_list?: LeaveSubtype[] + /** 假期类型的创建时间 */ + created_at: string + /** 假期类型的创建人，值为创建人的员工 ID */ + created_by: string + /** 假期类型的更新时间 */ + updated_at: string + /** 假期类型的更新人，值为更新人的员工 ID */ + updated_by: string +} + +export interface Link { + /** 超链接指向的 url (需要 url_encode) */ + url: string +} + +export interface LinkPreview { + /** 链接类型 */ + url_type: 'MessageLink' | 'Undefined' +} + +export interface ListChat { + /** 群组ID */ + chat_id?: string + /** 群头像URL */ + avatar?: string + /** 群名称 */ + name?: string + /** 群描述 */ + description?: string + /** 群主ID */ + owner_id?: string + /** 群主ID类型 */ + owner_id_type?: string + /** 是否是外部群 */ + external?: boolean + /** tenant key */ + tenant_key?: string + /** 群状态 */ + chat_status?: 'normal' | 'dissolved' | 'dissolved_save' +} + +export interface ListMember { + /** member id类型 */ + member_id_type?: string + /** member id */ + member_id?: string + /** 名字 */ + name?: string + /** tenant key */ + tenant_key?: string +} + +export interface ListModerator { + /** 可发言用户 ID 类型 */ + user_id_type?: string + /** 可发言用户 ID */ + user_id?: string + /** tenant key */ + tenant_key?: string +} + +export interface Location { + /** 地址id */ + location_id?: string + /** 地址名称 */ + location_name: string + /** 地址类型，GPS地址，1；WiFi的Mac地址，2；IP地址。8 */ + location_type: number + /** 地址维度 */ + latitude?: number + /** 地址经度 */ + longitude?: number + /** WiFi名称 */ + ssid?: string + /** WiFi的Mac地址 */ + bssid?: string + /** 地图类型，1：高德， 2：谷歌 */ + map_type?: number + /** 地址名称 */ + address?: string + /** IP地址 */ + ip?: string + /** 额外信息，例如运营商信息 */ + feature?: string + /** 距离范围 */ + gps_range?: number +} + +export interface LocationCity { + /** 市地址Code码 */ + city_code?: string + /** 省份/州地址Code码 */ + state_code?: string + /** 国家地址Code码 */ + country_code?: string + /** 市地址名称信息聚合 */ + city_name_info?: LocationNameInfo +} + +export interface LocationCountry { + /** 国家地址Code码 */ + country_code?: string + /** 国家地址名称信息聚合 */ + country_name_info?: LocationNameInfo +} + +export interface LocationDistrict { + /** 区/县Code码 */ + district_code?: string + /** 市地址Code码 */ + city_code?: string + /** 省份/州地址Code码 */ + state_code?: string + /** 国家地址Code码 */ + country_code?: string + /** 区/县地址名称信息聚合 */ + district_name_info?: LocationNameInfo +} + +export interface LocationDto { + /** 国家信息列表,仅当 location_type=1 时返回 */ + country?: LocationCountry + /** 省份/州信息列表,仅当 location_type=2 时返回 */ + state?: LocationState + /** 市信息列表，仅当 location_type=3 时返回 */ + city?: LocationCity + /** 区/县信息列表，仅当 location_type=4 时返回 */ + district?: LocationDistrict +} + +export interface LocationNameInfo { + /** 地址中文名 */ + zh_name?: string + /** 地址英文名 */ + en_name?: string + /** 地址拼音名 */ + py_name?: string +} + +export interface LocationState { + /** 省份/州地址Code码 */ + state_code?: string + /** 国家地址Code码 */ + country_code?: string + /** 省份/州地址名称信息聚合 */ + state_name_info?: LocationNameInfo +} + +export interface LookupWithAvatar { + /** 用户ID */ + id?: string + /** 用户名称 */ + name?: string + /** 租户ID */ + tenant_id?: string + /** 用户邮箱 */ + email?: string +} + +export interface Machine { + /** 考勤机序列号 */ + machine_sn: string + /** 考勤机名称 */ + machine_name: string +} + +export interface MailAddress { + /** 邮件地址 */ + mail_address: string + /** 名称 */ + name?: string +} + +export interface Mailgroup { + /** 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 MailgroupManager { + /** 管理员用户ID */ + user_id?: string +} + +export interface MailgroupMember { + /** 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 MailgroupPermissionMember { + /** 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 ManagementScope { + /** 管理维度 */ + management_dimension: string + /** 被授权管理维度对象ID */ + obj_id: string +} + +export interface Manager { + user_id?: string + name?: string + en_name?: string +} + +export interface MaskSession { + /** 创建时间 */ + create_time?: string + /** 客户端类型 */ + terminal_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 8 + /** 用户ID */ + user_id?: string + /** 需要登出的 session 标识符 */ + sid?: string +} + +export interface MatchInfo { + /** 实体词 id */ + entity_id?: string + /** 匹配中的字段 */ + type?: 0 | 1 | 2 +} + +export interface Meeting { + /** 会议ID */ + id?: string + /** 会议主题 */ + topic?: string + /** 会议链接 */ + url?: string + /** 会议号 */ + meeting_no?: string + /** 会议密码 */ + password?: string + /** 会议创建时间（unix时间，单位sec） */ + create_time?: string + /** 会议开始时间（unix时间，单位sec） */ + start_time?: string + /** 会议结束时间（unix时间，单位sec） */ + end_time?: string + /** 主持人 */ + host_user?: MeetingUser + /** 该会议是否支持互通 */ + meeting_connect?: boolean + /** 会议状态 */ + status?: 1 | 2 | 3 + /** 峰值参会人数 */ + participant_count?: string + /** 累计参会人数 */ + participant_count_accumulated?: string + /** 参会人列表 */ + participants?: MeetingParticipant[] + /** 会中使用的能力 */ + ability?: MeetingAbility +} + +export interface MeetingAbility { + /** 是否使用视频 */ + use_video?: boolean + /** 是否使用音频 */ + use_audio?: boolean + /** 是否使用共享屏幕 */ + use_share_screen?: boolean + /** 是否使用妙享（magic share） */ + use_follow_screen?: boolean + /** 是否使用录制 */ + use_recording?: boolean + /** 是否使用PSTN */ + use_pstn?: boolean +} + +export interface MeetingInfo { + /** 9位会议号 */ + meeting_id?: string + /** 会议主题 */ + meeting_topic?: string + /** 会议类型 */ + meeting_type?: 1 | 2 | 3 + /** 组织者 */ + organizer?: string + /** 部门 */ + department?: string + /** 用户ID */ + user_id?: string + /** 工号 */ + employee_id?: string + /** 邮箱 */ + email?: string + /** 手机 */ + mobile?: string + /** 会议开始时间 */ + meeting_start_time?: string + /** 会议结束时间 */ + meeting_end_time?: string + /** 会议持续时间 */ + meeting_duration?: string + /** 参会人数 */ + number_of_participants?: string + /** 累计入会设备数 */ + number_of_devices?: string + /** 音频 */ + audio?: boolean + /** 视频 */ + video?: boolean + /** 共享 */ + sharing?: boolean + /** 录制 */ + recording?: boolean + /** 电话 */ + telephone?: boolean + /** 关联会议室列表 */ + reserved_rooms?: ReservedRoom[] + /** 是否有关联文档和纪要 */ + has_related_document?: boolean +} + +export interface MeetingInviteStatus { + /** 用户ID */ + id?: string + /** 用户类型 */ + user_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 邀请结果 */ + status?: 1 | 2 +} + +export interface MeetingParticipant { + /** 用户ID */ + id?: string + /** 首次入会时间，秒级Unix时间戳 */ + first_join_time?: string + /** 最终离会时间，秒级Unix时间戳 */ + final_leave_time?: string + /** 累计在会中时间，时间单位：秒 */ + in_meeting_duration?: string + /** 用户类型 */ + user_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 是否为主持人 */ + is_host?: boolean + /** 是否为联席主持人 */ + is_cohost?: boolean + /** 是否为外部参会人 */ + is_external?: boolean + /** 参会人状态 */ + status?: 1 | 2 | 3 | 4 +} + +export interface MeetingParticipantResult { + /** 用户ID */ + id?: string + /** 用户类型 */ + user_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 结果 */ + result?: 1 | 2 +} + +export interface MeetingRecording { + /** 录制文件URL */ + url?: string + /** 录制总时长（单位msec） */ + duration?: string +} + +export interface MeetingSettings { + /** 设置会议 owner */ + owner_id?: string + /** 设置入会范围 */ + join_meeting_permission?: 'anyone_can_join' | 'only_organization_employees' | 'only_event_attendees' + /** 指定主持人 */ + assign_hosts?: string[] + /** 设置自动录制 */ + auto_record?: boolean + /** 开启等候室 */ + open_lobby?: boolean + /** 允许日程参与者发起会议 */ + allow_attendees_start?: boolean +} + +export interface MeetingUser { + /** 用户ID */ + id?: string + /** 用户类型 */ + user_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 +} + +export interface Member { + /** 知识库协作者 ID 类型 */ + member_type: string + /** 知识库协作者 ID */ + member_id: string + /** 知识库协作者角色 */ + member_role: string + /** 知识库协作者类型 */ + type?: 'user' | 'chat' | 'department' +} + +export interface Memberlist { + /** 成员ID */ + member_id: string + /** 用户组成员的类型，目前取值为 user。未来将支持department */ + member_type: string + /** 成员ID类别，仅请求参数中有效 */ + member_id_type?: string +} + +export interface MemberResult { + /** 成员ID */ + member_id: string + /** 结果响应码，0表示成功 */ + code: number +} + +export interface MemberSetting { + /** 是否支持多选 */ + multi?: boolean +} + +export interface MemberStatusChange { + /** 是否入职日上班无需打卡 */ + onboarding_on_no_need_punch?: boolean + /** 是否入职日下班无需打卡 */ + onboarding_off_no_need_punch?: boolean + /** 是否离职日上班无需打卡 */ + offboarding_on_no_need_punch?: boolean + /** 是否离职日下班无需打卡 */ + offboarding_off_no_need_punch?: boolean +} + +export interface Mention { + /** mention key */ + key: string + /** 用户或机器人的 id, id 类型与 id_type 一致 */ + id: string + /** id类型，包括open_id，user_id，union_id 或 app_id */ + id_type: string + /** 被at用户的姓名 */ + name: string + /** tenant key */ + tenant_key?: string +} + +export interface MentionDoc { + /** 云文档 token */ + token: string + /** 云文档类型 */ + obj_type: 1 | 3 | 8 | 11 | 12 | 15 | 16 | 22 + /** 云文档链接（需要 url_encode) */ + url: string + /** 文档标题，只读属性 */ + title?: string + /** 文本局部样式 */ + text_element_style?: TextElementStyle +} + +export interface MentionEntity { + /** 被@人在 content 中的偏移量 */ + offset: number + /** 被@人的 user id */ + user_id: string +} + +export interface MentionUser { + /** 用户 OpenID */ + user_id: string + /** 文本局部样式 */ + text_element_style?: TextElementStyle +} + +export interface MergeTableCellsRequest { + /** 行起始索引（区间左闭右开） */ + row_start_index: number + /** 行结束索引（区间左闭右开） */ + row_end_index: number + /** 列起始索引（区间左闭右开） */ + column_start_index: number + /** 列结束索引（区间左闭右开） */ + column_end_index: number +} + +export interface Message { + /** 消息id open_message_id */ + message_id?: string + /** 根消息id open_message_id */ + root_id?: string + /** 父消息的id open_message_id */ + parent_id?: string + /** 消息所属的话题 ID */ + thread_id?: string + /** 消息类型 text post card image等等 */ + msg_type?: string + /** 消息生成的时间戳(毫秒) */ + create_time?: string + /** 消息更新的时间戳 */ + update_time?: string + /** 消息是否被撤回 */ + deleted?: boolean + /** 消息是否被更新 */ + updated?: boolean + /** 所属的群 */ + chat_id?: string + /** 发送者，可以是用户或应用 */ + sender?: Sender + /** 消息内容,json结构 */ + body?: MessageBody + /** 被艾特的人或应用的id */ + mentions?: Mention[] + /** 合并消息的上一层级消息id open_message_id */ + upper_message_id?: string +} + +export interface MessageAction { + /** pc 端链接 */ + pc_app_link?: string + /** 移动端链接 */ + mobile_app_link?: string + /** 国际化信息 */ + i18n?: MessageActionI18nInfo[] +} + +export interface MessageActionI18nInfo { + /** 国际化语言的 key */ + i18n_key?: 'zh_cn' | 'en_us' | 'ja_jp' + /** 国际化名称 */ + name?: string +} + +export interface MessageBody { + /** 消息jsonContent */ + content: string +} + +export interface MessageReaction { + /** reaction资源ID */ + reaction_id?: string + /** 添加reaction的操作人 */ + operator?: Operator + /** reaction动作的的unix timestamp(单位:ms) */ + action_time?: string + /** reaction资源类型 */ + reaction_type?: Emoji +} + +export interface Meta { + /** 文件token */ + doc_token: string + /** 文件类型 */ + doc_type: string + /** 标题 */ + title: string + /** 文件所有者 */ + owner_id: string + /** 创建时间（Unix时间戳） */ + create_time: string + /** 最后编辑者 */ + latest_modify_user: string + /** 最后编辑时间（Unix时间戳） */ + latest_modify_time: string + /** 文档链接 */ + url: string + /** 文档密级标签名称 */ + sec_label_name?: string +} + +export interface MetaFailed { + /** 获取元数据失败的文档token */ + token: string + /** 获取元数据失败的错误码 */ + code: 970002 | 970003 | 970005 +} + +export interface MetricDetail { + /** 指标 ID */ + metric_id?: string + /** 指标名称，指标在该明细数据中的名称 */ + name?: string + /** 指标字段信息 */ + fields?: MetricFieldInDetails[] + /** 指标所属的指标维度 ID */ + dimension_id?: string + /** 指标维度名称 */ + dimension_name?: I18n + /** 指标维度的维度权重，如果没有设置则返回为空 */ + dimension_weight?: string + /** 指标添加来源 */ + add_from?: 'reviewee' | 'admin' + /** 指标是否引自指标库 */ + is_from_library?: boolean +} + +export interface MetricDimension { + /** 所属人群分组 ID，模板分人群设置指标时，指标维度按照人群分组；未分人群设置时该值为空 */ + group_id?: string + /** 指标维度 ID */ + metric_dimension_id?: string + /** 指标维度名称 */ + name?: I18n + /** 每条指标的评估规则 ID */ + evaluation_rule_id_for_each_metric?: string + /** 维度权重，如果没有设置则返回为空（备注：和 0 区分） */ + dimension_weight?: string + /** 维度描述 */ + description?: I18n + /** 指标评分规则设置 */ + review_rule_option?: 0 | 1 + /** 自定义指标设置 */ + custom_metric_config?: CustomMetricConfig +} + +export interface MetricField { + /** 指标字段信息 */ + field_id?: string + /** 字段名称 */ + name?: I18n + /** 字段类型 */ + type?: 'text' | 'number' | 'pencentage' | 'person' +} + +export interface MetricFieldInDetails { + /** 指标字段 ID。 系统预置的指标字段 ID 分别为：指标 1；权重 2；指标单位 3；目标值 4；完成值 5；完成说明 7。更多指标字段详情可通过【获取指标字段详情】接口获取 */ + field_id?: string + /** 字段值 */ + field_value?: string + /** 字段值，当字段为人员信息时有值 */ + field_value_person?: User +} + +export interface MetricFieldInLibrary { + /** 指标字段 ID。 系统预置的指标字段 ID 分别为：指标 1；权重 2；指标单位 3；目标值 4；完成值 5；完成说明 7。更多指标字段详情可通过【获取指标字段详情】接口获取 */ + field_id?: string + /** 字段填写方式设置 */ + input_setting?: 'admin' | 'data_source_inputter' | 'reviewee' + /** 字段值 */ + field_value?: string + /** 字段值，当字段为人员信息时有值 */ + field_value_person?: User +} + +export interface MetricFieldInTemplate { + /** 指标字段 ID */ + id?: string + /** 字段填写方式设置 */ + input_setting?: 'admin' | 'data_source_inputter' | 'reviewee' + /** 字段值 */ + filed_value?: string + /** 字段值，当字段为人员信息的时候有值 */ + field_value_person?: User +} + +export interface MetricGroup { + /** 人群分组ID */ + group_id?: string + /** 名称 */ + name?: string +} + +export interface MetricInLibrary { + /** 指标 ID */ + metric_id?: string + /** 指标名称 */ + name?: string + /** 指标类型 ID */ + type_id?: string + /** 所属的标签 */ + tags?: MetricTag[] + /** 指标字段信息 */ + fields?: MetricFieldInLibrary[] + /** 评分设置类型 */ + scoring_setting_type?: 'score_manually' | 'score_by_formula' + /** 评分公式 */ + scoring_formula?: Formula + /** 数据源录入人 ID */ + data_source_inputters?: User[] + /** 可用范围 */ + range_of_availability?: 'admins_and_reviewees' | 'only_admins' + /** 状态是否为启用 */ + is_active?: boolean +} + +export interface MetricInTemplate { + /** 所属人群分组 ID，模板分人群设置指标时，指标维度按照人群分组；未分人群设置时该值为空 */ + group_id?: string + /** 指标 ID（备注：指标的统一标识 ID。如果模板存在分组，需要+分组 ID 才能标识到指标模板唯一的指标） */ + metric_id?: string + /** 指标名称，指标在该模板中的名称 */ + name?: string + /** 指标类型 ID */ + type_id?: string + /** 指标字段信息 */ + fields?: MetricFieldInTemplate[] + /** 指标是否引自指标库 */ + is_from_library?: boolean + /** 评分设置类型 */ + scoring_setting_type?: 'socre_manually' | 'score_by_formula' + /** 数据源录入人 */ + data_source_inputters?: User[] + /** 所属维度ID */ + metric_dimension_id?: string + /** 指标评估规则配置 */ + review_rule_config?: MetricReviewRuleConfig +} + +export interface MetricReviewRuleConfig { + /** 上限 */ + max?: string + /** 下限 */ + min?: string +} + +export interface MetricTag { + /** 标签 ID */ + tag_id?: string + /** 标签名称 */ + tag_name?: I18n +} + +export interface MetricTemplate { + /** 指标模板ID */ + id?: string + /** 模版名称 */ + name?: I18n + /** 模板描述 */ + description?: I18n + /** 状态 */ + status?: 'to_be_configured' | 'to_be_activated' | 'enabled' | 'disabled' + /** 是否分人群设置指标 */ + is_set_by_group?: boolean + /** 指标总分计算方式 */ + total_metric_score_method?: 'review_manually' | 'sum' | 'weight' | 'formula' + /** 指标权重计算方式 */ + metric_weight_method?: 'sum_of_metric_weights_for_each_dimension_equals_1' | 'total_sum_of_all_metric_weight_equals_1' + /** 指标维度列表 */ + metric_dimensions?: MetricDimension[] + /** 指标列表 */ + metrics?: MetricInTemplate[] + /** 人群分组 */ + groups?: MetricGroup[] +} + +export interface MindMap { + /** 思维导图父节点 id ，为空表示是思维导图的根节点 */ + parent_id?: string +} + +export interface Mindnote { + /** 思维导图 token */ + token?: string +} + +export interface Minute { + /** 妙记token */ + token?: string + /** 所有者ID */ + owner_id?: string + /** 妙记创建时间timestamp（ms级别） */ + create_time?: string + /** 妙记标题 */ + title?: string + /** 妙记封面链接 */ + cover?: string + /** 妙记时长（ms级别） */ + duration?: string + /** 妙记链接 */ + url?: string +} + +export interface Minutes { + /** 速记语音文本列表 */ + sentences?: Sentence[] +} + +export interface Mobile { + /** 国家代码 */ + code?: string + /** 手机号码 */ + number?: string +} + +export interface ModuleAssessment { + /** 对应面试评价表中模块 ID */ + interview_feedback_form_module_id?: string + /** 模块名称 */ + module_name?: I18n + /** 模块类型 */ + module_type?: 1 | 2 + /** 模块权重 */ + module_weight?: number + /** 模块打分 */ + module_score?: number + /** 模块评价 */ + dimension_assessments?: DimensionAssessment[] +} + +export interface MoveResult { + /** 移动完成的节点信息 */ + node: Node + /** 节点移动状态码 */ + status: number + /** 节点移动状态信息 */ + status_msg: string +} + +export interface Name { + /** 中文 */ + zh_cn?: string + /** 英文 */ + en_us?: string +} + +export interface NameForUpdate { + /** 全名 */ + full_name?: string + /** 名 */ + first_name?: string + /** 中间名 */ + middle_name?: string + /** 姓 */ + name_primary?: string + /** 名 - 本地文字 */ + local_first_name?: string + /** 本地中间名 */ + local_middle_name?: string + /** 姓 - 本地文字 */ + local_primary?: string + /** 自定义姓名（本地文字） */ + custom_local_name?: string + /** 自定义姓名（西方文字） */ + custom_western_name?: string + /** 国家/地区 */ + country_region: string + /** 姓名类型，枚举值 */ + name_type: string +} + +export interface NationalId { + /** 国家证件类型 */ + national_id_type_id: string + /** 证件号码 */ + national_id_number: string + /** 证件签发日期 */ + issue_date?: string + /** 证件到期日期 */ + expiration_date?: string + /** 国家 / 地区 */ + country_region_id: string + /** 证件签发机构 */ + issued_by?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] +} + +export interface NationalIdForUpdate { + /** 国家 / 地区 */ + country_region_id: string + /** 国家证件类型 */ + national_id_type_id: string + /** 证件号码 */ + national_id_number: string + /** 证件签发日期 */ + issue_date?: string + /** 证件到期日期 */ + expiration_date?: string + /** 证件签发机构 */ + issued_by?: string +} + +export interface NationalIdType { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 国家 / 地区 */ + country_region_id: string + /** 名称 */ + name: I18n[] + /** 启用 */ + active: boolean + /** 校验规则 */ + validation_rule: string + /** 校验规则描述 */ + validation_rule_description?: I18n[] + /** 编码 */ + code: string + /** 证件类型 */ + identification_type: Enum + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface Nationality { + /** 国籍 ID，对应[搜索员工信息](/ssl:ttdoc/server-docs/corehr-v1/employee/search)等接口返回的 `nationality_id_v2` 字段 */ + nationality_id?: string + /** 名称 */ + name?: I18n[] + /** 国家/地区两位字母编码（ISO 3166-1） */ + alpha_2_code?: string + /** 国家/地区三位字母编码（ISO 3166-1） */ + alpha_3_code?: string + /** 数字代码 */ + numeric_code?: number + /** 所属国家/地区 ID，详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */ + country_region_id?: string + /** 状态 */ + status?: 1 | 0 +} + +export interface NativeRegion { + iso_code?: string + name?: string +} + +export interface Navigate { + /** pc 端主导航信息 */ + pc?: NavigateMeta + /** 移动端主导航信息 */ + mobile?: NavigateMeta +} + +export interface NavigateMeta { + /** 主导航小程序版本号 */ + version?: string + /** 默认图片 url */ + image_url?: string + /** 选中态图片 url */ + hover_image_url?: string +} + +export interface Node { + /** 知识空间id，[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */ + space_id?: string + /** 节点token，[获取方式](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview) */ + node_token?: string + /** 对应文档类型的token，可根据 obj_type 判断属于哪种文档类型。 */ + obj_token?: string + /** 文档类型，对于快捷方式，该字段是对应的实体的obj_type。 */ + obj_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'docx' | 'slides' + /** 父节点 token。若当前节点为一级节点，父节点 token 为空。 */ + parent_node_token?: string + /** 节点类型 */ + node_type: 'origin' | 'shortcut' + /** 快捷方式对应的实体node_token，当节点为快捷方式时，该值不为空。 */ + origin_node_token?: string + /** 快捷方式对应的实体所在的spaceid */ + origin_space_id?: string + /** 是否有子节点 */ + has_child?: boolean + /** 文档标题 */ + title?: string + /** 文档创建时间 */ + obj_create_time?: string + /** 文档最近编辑时间 */ + obj_edit_time?: string + /** 节点创建时间 */ + node_create_time?: string + /** 文档创建者 */ + creator?: string + /** 文档所有者 */ + owner?: string + /** 节点创建者 */ + node_creator?: string +} + +export interface NodeApprover { + /** node id 或 custom node id */ + key?: string + /** 通过 查看审批定义 获取 value: 审批人列表 */ + value?: string[] +} + +export interface NodeAutoApproval { + /** 节点id的类型 */ + node_id_type?: 'CUSTOM' | 'NON_CUSTOM' + /** 节点id */ + node_id?: string +} + +export interface NodeCc { + /** node id 或 custom node id */ + key?: string + /** 通过 查看审批定义 获取 value: 审批人列表 */ + value?: string[] +} + +export interface Note { + /** ID备注 */ + id?: string + /** 人才ID */ + talent_id: string + /** 投递ID */ + application_id?: string + /** 是否私密 */ + is_private?: boolean + /** 创建时间 */ + create_time?: number + /** 更新时间 */ + modify_time?: number + /** 创建人ID */ + creator_id?: string + /** 内容 */ + content: string +} + +export interface Notification { + /** 唯一ID */ + id?: string + /** 任务名称 */ + job_name?: string + /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */ + status?: number + /** 创建人 */ + create_user?: NotificationUser + /** 创建时间（毫秒时间戳） */ + created_at?: string + /** 更新用户 */ + update_user?: NotificationUser + /** 更新时间（毫秒时间戳） */ + updated_at?: string + /** 目标推送用户 */ + target_user_count?: number + /** 已推送用户总数 */ + sent_user_count?: number + /** 已读用户总数 */ + read_user_count?: number + /** 推送任务触发时间（毫秒时间戳） */ + send_at?: string + /** 推送内容，详见：https://open.feishu.cn/tool/cardbuilder?from=howtoguide */ + push_content?: string + /** 0（定时推送：push_scope不能等于3） 1（新人入职推送：push_scope必须等于1或者3；new_staff_scope_type不能为空） */ + push_type?: number + /** 推送范围（服务台私信） 0：组织内全部成员（user_list和department_list必须为空） 1：不推送任何成员（user_list和department_list必须为空，chat_list不可为空） 2：推送到部分成员（user_list或department_list不能为空） 3：入职新人 以上四种状态，chat_list都相对独立，只有在推送范围为1时，必须需要设置chat_list */ + push_scope_type?: number + /** 新人入职范围类型（push_type为1时生效） 0：组织内所有新人 1：组织内特定的部门（new_staff_scope_department_list 字段不能为空） */ + new_staff_scope_type?: number + /** 新人入职生效部门列表 */ + new_staff_scope_department_list?: NotificationDepartment[] + /** push推送到成员列表 */ + user_list?: NotificationUser[] + /** push推送到的部门信息列表 */ + department_list?: NotificationDepartment[] + /** push推送到的会话列表(群) */ + chat_list?: NotificationChat[] + /** 预留扩展字段 */ + ext?: string +} + +export interface NotificationChat { + /** 会话ID */ + chat_id?: string + /** 会话名称 */ + name?: string +} + +export interface NotificationDepartment { + /** 部门ID */ + department_id?: string + /** 部门名称 */ + name?: string +} + +export interface NotificationUser { + /** 用户id */ + user_id?: string + /** 头像地址 */ + avatar_url?: string + /** 用户名称 */ + name?: string +} + +export interface NumberSetting { + /** 数字展示的格式 */ + format?: 'normal' | 'percentage' | 'cny' | 'usd' | 'custom' + /** 自定义符号。只有`format`设为custom时才会生效。 */ + custom_symbol?: string + /** 自定义符号显示的位置。 */ + custom_symbol_position?: 'left' | 'right' + /** 分隔符样式 */ + separator?: 'none' | 'thousand' + /** 保留小数位数。输入的数字值的小数位数如果比该设置多，多余的位数将被四舍五入后舍弃。如果`format`为"percentage"，表示变为百分数之后的小数位数。 */ + decimal_count?: number +} + +export interface Object { + /** 对象 ID */ + id?: number + /** 对象 API 名称 */ + api_name?: string + /** 对象名称 */ + label?: EeKunlunCommonI18nI18nText + /** 对象配置 */ + settings?: ObjectSettings +} + +export interface ObjectAttribute { + /** 字段名称 */ + title?: I18n + /** 字段描述 */ + description?: I18n + /** 字段类型 */ + data_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + /** 字段标签 */ + tags?: number[] + /** 是否为居民数据 */ + is_fcf_data?: boolean + /** 是否为多元化数据 */ + is_di_data?: boolean +} + +export interface ObjectField { + /** 字段 id */ + id?: number + /** API 名称 */ + api_name?: string + /** 字段类型 */ + type?: string + /** 字段名称 */ + label?: EeKunlunCommonI18nI18nText +} + +export interface ObjectFieldData { + /** 字段名 */ + field_name: string + /** 字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(123, 123.23, true, [\"id1\",\"id2\], 2006-01-02 15:04:05]) */ + value: string +} + +export interface ObjectMeta { + /** 对象信息 */ + object?: Object + /** 字段信息 */ + fields?: ObjectField[] +} + +export interface ObjectSearchLayout { + /** 展示字段 */ + display_fields?: string[] +} + +export interface ObjectSettings { + /** 展示名称 */ + display_name?: string + /** 允许搜索字段 */ + allow_search_fields?: string[] + /** 展示字段 */ + search_layout?: ObjectSearchLayout +} + +export interface Offboarding { + /** 离职发起类型，包括： */ + initiating_type?: string + /** 离职状态 */ + status?: 'Approving' | 'Approved' | 'Offboarded' | 'Rejected' | 'Withdrawn' | 'NoNeedApproval' + /** 离职审批信息 */ + application_info?: ApplicationInfo + /** 员工离职信息 */ + offboarding_info?: OffboardingInfo + /** 离职办理流程信息 */ + offboarding_checklist?: OffboardingChecklist + /** 离职单据ID */ + offboarding_id?: string +} + +export interface OffboardingChecklist { + /** 离职办理状态 */ + checklist_status?: string + /** 离职流转开始时间 */ + checklist_start_time?: string + /** 离职流转结束时间 */ + checklist_finish_time?: string + /** 离职流转流程实例 ID */ + checklist_process_id?: string +} + +export interface OffboardingInfo { + /** 离职员工的雇佣 ID */ + employment_id?: string + /** 员工的 hrbp 列表，所有的 hrbp */ + hrbp_id?: string[] + /** 期望离职日期 */ + expected_offboarding_date?: string + /** 离职日期 */ + offboarding_date?: string + /** 离职原因 */ + reason?: Enum + /** 离职原因说明 */ + reason_explanation?: string + /** 离职原因（员工） */ + employee_reason?: Enum + /** 离职原因说明（员工） */ + employee_reason_explanation?: string + /** 是否加入离职屏蔽名单 */ + add_block_list?: string + /** 屏蔽原因 */ + block_reason?: Enum + /** 屏蔽原因说明 */ + block_reason_explanation?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 离职是否保留飞书账号 */ + retain_account?: boolean + /** 社保停保年月 */ + social_insurance_end_date?: string + /** 公积金截止年月 */ + provident_fund_end_date?: string + /** 是否启动竞业 */ + enforce_noncompete_agreement?: boolean + /** 竞业合同ID */ + noncompete_agreement_id?: string + /** 竞业公司ID */ + noncompete_agreement_company?: string + /** 竞业开始日期 */ + noncompete_agreement_start_date?: string + /** 竞业结束日期 */ + noncompete_agreement_end_date?: string + /** 签署方式 */ + sign_type?: Enum + /** 签署文件ID列表 */ + signature_file?: string + /** 最后出勤日 */ + last_attendance_date?: string + /** 是否带编转移 */ + is_transfer_with_workforce?: boolean +} + +export interface OffboardingReason { + /** 离职原因唯一标识 */ + offboarding_reason_unique_identifier?: string + /** 名称 */ + name?: I18n[] + /** 是否启用 */ + active?: boolean + /** 当前离职原因的父级原因唯一标识 */ + parent_offboarding_reason_unique_identifier?: string + /** 创建时间 */ + created_time?: string + /** 更新时间 */ + updated_time?: string +} + +export interface Offer { + /** Offer ID */ + id?: string + /** 投递 ID */ + application_id?: string + /** 基础信息 */ + basic_info?: ApplicationOfferBasicInfo + /** 薪酬计划 */ + salary_plan?: ApplicationOfferSalaryPlan + /** 当前 Offer 使用的 Schema */ + schema_id?: string + /** Offer 状态 */ + offer_status?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 + /** Offer 类型 */ + offer_type?: 1 | 2 + /** 职位信息 */ + job_info?: OfferJobInfo + /** offer自定义模块列表 */ + customized_module_list?: ApplicationOfferCustomModule[] + /** 招聘需求 ID */ + job_requirement_id?: string + /** offer 发送记录列表 */ + offer_send_record_list?: OfferSendRecord[] +} + +export interface OfferApplyForm { + /** ID */ + id?: string + /** 名称 */ + name?: I18n + /** 创建时间 */ + create_time?: string +} + +export interface OfferApplyFormConfigFormulaInfo { + /** 公式值 */ + value?: string + /** 公式结果类型枚举 */ + result?: 1 | 2 | 3 + /** 公式额外描述 */ + extra_map?: OfferApplyFormFormulaExtraMapInfo[] +} + +export interface OfferApplyFormConfigOptionInfo { + /** 选项 ID */ + id?: string + /** 选项名称 */ + name?: I18n + /** 选项描述 */ + description?: I18n +} + +export interface OfferApplyFormFormulaExtraMapInfo { + /** object ID */ + key?: string + /** object 名称 */ + value?: I18n +} + +export interface OfferApplyFormInfo { + /** offer申请表 ID */ + id?: string + /** offer申请表名称 */ + name?: I18n + /** schema 信息 */ + schema?: OfferApplyFormSchema +} + +export interface OfferApplyFormModuleInfo { + /** 模块 ID */ + id?: string + /** 模块名称 */ + name?: I18n + /** 是否为自定义模块 */ + is_customized?: boolean + /** 模块状态是否启用 */ + active_status?: 1 | 2 + /** 模块填写提示 */ + hint?: I18n + /** 字段列表 */ + object_list?: OfferApplyFormObjectInfo[] +} + +export interface OfferApplyFormObjectConfigInfo { + /** 选项信息 */ + options?: OfferApplyFormConfigOptionInfo[] + /** 公式信息 */ + formula?: OfferApplyFormConfigFormulaInfo + /** 级联配置信息 */ + object_display_config?: OfferApplyFormObjectDisplayConfigInfo +} + +export interface OfferApplyFormObjectDisplayConfigInfo { + /** 展示条件枚举 */ + display_condition?: 1 | 2 + /** 字段条件配置 */ + pre_object_config_list?: OfferApplyFormPreObjectConfigInfo[] +} + +export interface OfferApplyFormObjectInfo { + /** 字段 ID */ + id?: string + /** 字段名称 */ + name?: I18n + /** 字段描述 */ + description?: I18n + /** 所属模块 ID */ + module_id?: string + /** 是否为自定义模块 */ + is_customized?: boolean + /** 是否必填 */ + is_required?: boolean + /** 是否启用 */ + active_status?: 1 | 2 + /** 是否修改后需审批 */ + need_approve?: boolean + /** 是否敏感 */ + is_sensitive?: boolean + /** 字段类型枚举 */ + object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** 配置信息 */ + config?: OfferApplyFormObjectConfigInfo +} + +export interface OfferApplyFormPreObjectConfigInfo { + /** 字段 ID */ + id?: string + /** 运算符枚举 */ + operator?: 1 | 2 | 3 | 4 + /** 字段值 */ + value?: string[] +} + +export interface OfferApplyFormSchema { + /** schema ID，用于描述申请表单结构的元数据定义，即对申请表内容的描述 */ + id?: string + /** 模块列表 */ + module_list?: OfferApplyFormModuleInfo[] +} + +export interface OfferAttachmentInfo { + /** Offer 附件 ID */ + id?: string + /** Offer 附件名称 */ + name?: string + /** Offer 附件大小 */ + size?: number +} + +export interface OfferBasicInfo { + /** 部门 ID */ + department_id: string + /** 直属上级 ID */ + leader_user_id: string + /** 职务 ID */ + employment_job_id?: string + /** 人员类型 ID */ + employee_type_id?: string + /** 职位序列 ID */ + job_family_id?: string + /** 职位级别 ID */ + job_level_id?: string + /** 试用期 */ + probation_month?: number + /** 合同期(年)，推荐使用「contract_period」，如果Offer申请表中「合同期(年)」字段已停用，则不可使用该字段 */ + contract_year?: number + /** 合同期（年/月） */ + contract_period?: ContractPeriodInfo + /** 预计入职日期 */ + expected_onboard_date?: string + /** 入职地点 ID */ + onboard_address_id?: string + /** 办公地点 ID */ + work_address_id?: string + /** Offer负责人 ID */ + owner_user_id: string + /** Offer 推荐语 */ + recommended_words?: string + /** 招聘需求 ID */ + job_requirement_id?: string + /** 招聘流程类型 ID */ + job_process_type_id?: number + /** 附件ID列表 */ + attachment_id_list?: string[] + /** 附件描述 */ + attachment_description?: string + /** Offer操作人 ID */ + operator_user_id: string + /** 岗位 ID */ + position_id?: string + /** 入职职位 */ + job_offered?: string +} + +export interface OfferBasicInfoV2 { + /** Offer ID */ + id?: string + /** Offer 状态 */ + offer_status?: 10 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 直属上级 */ + leader?: BasicUserInfo + /** 人员类型 */ + employee_type?: IdNameObject + /** 部门 */ + department?: BasicDepartmentInfo + /** 序列 */ + sequence?: IdNameObject + /** 级别 */ + level?: IdNameObject + /** 公司主体 */ + company_main_body?: IdNameObject + /** 招聘需求 ID */ + job_requirement_id?: string + /** 试用期（单位：月） */ + probation_month?: number + /** 合同期（年/月） */ + contract_period?: ContractPeriodInfo + /** 入职日期 */ + onboard_date?: string + /** Offer 负责人 */ + owner?: BasicUserInfo + /** 入职地址 */ + onboard_address?: BaseAddressV2 + /** 工作地址 */ + work_address?: BaseAddressV2 + /** Offer 备注 */ + remark?: string + /** 附件列表 */ + attachment_list?: OfferAttachmentInfo[] + /** Offer 自定义字段数据 */ + customize_info_list?: ApplicationOfferCustomValue[] + /** Offer 创建时间戳（单位：毫秒） */ + create_time?: string +} + +export interface OfferCustomFieldConfig { + /** 选项信息，字段类型为「单选」、「多选」时需配置选项信息 */ + options?: OfferCustomFieldConfigOption[] +} + +export interface OfferCustomFieldConfigOption { + /** 选项名称 */ + name: I18n +} + +export interface OfferCustomizedInfo { + /** 自定义字段 ID */ + id?: string + /** 自定义字段信息 */ + value?: string +} + +export interface OfferEmailInfo { + /** 抄送人邮件列表 */ + cc_email_list?: string[] + /** 接收人邮件列表 */ + receiver_email_list?: string[] + /** 邮件内容 */ + content?: string +} + +export interface OfferFile { + /** 文件 id */ + id?: string + /** 文件模板 id */ + file_template_id?: string + /** 文件模板名称 */ + file_template_name?: string + /** 文件模板类型 id */ + file_template_type_id?: string + /** 文件模板类型名称 */ + file_template_type_name?: string +} + +export interface OfferInfo { + /** Offer id */ + offer_id?: string + /** Offer hr id */ + offer_hr_id?: string + /** 部门 id */ + department_id?: string + /** 直属领导id */ + direct_leader_id?: string + /** 虚线上级id */ + dotted_line_manager_id?: string + /** 职务id */ + job_id?: string + /** 序列id */ + job_family_id?: string + /** 级别id */ + job_level_id?: string + /** 职务头衔id */ + job_title?: string + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期结束日期 */ + probation_end_date?: string + /** 合同开始日期 */ + contract_start_date?: string + /** 合同结束日期 */ + contract_end_date?: string + /** 合同期限时长 */ + duration_period?: number + /** 合同期限单位 */ + duration_unit?: string + /** 入职日期 */ + onboarding_date?: string + /** 入职地点id */ + onboarding_location_id?: string + /** 办公地点id */ + office_location_id?: string + /** 招聘来源id */ + recruitment_type_id?: string + /** 试用期时长 */ + probation_period?: string + /** 人员类型id */ + employee_type_id?: string + /** 人员子类型id */ + employee_subtype_id?: string + /** 雇佣类型id */ + employment_type_id?: string + /** 工作邮箱 */ + work_email?: string + /** 期限类型id */ + duration_type_id?: string + /** 签订类型id */ + signing_type_id?: string + /** 入职方式 */ + entry_mode?: string + /** 社保城市id */ + social_security_city_id?: string + /** 合同类型 */ + contract_type?: string + /** 公司 */ + company?: string + /** 成本中心分摊信息 */ + cost_center_rate?: JobDataCostCenter[] + /** 职等ID */ + job_grade_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 任职公司 */ + service_company?: string + /** 排班 */ + work_shift?: string + /** 薪资类型 */ + compensation_type?: string + /** 工作地点id */ + work_location_id?: string + /** 入职地址id */ + onboarding_address_id?: string + /** 办公地址id */ + office_address_id?: string + /** 岗位id */ + position_id?: string + /** 工作日历id */ + working_calendar_id?: string + /** 工时制度 */ + working_hours_type?: string + /** 薪资组 */ + pay_group_id?: string + /** 入职流程ID */ + flow_id?: string + /** 签到日期 */ + check_in_time?: string + /** 签到方式 */ + check_in_method?: string + /** 司龄起算日期 */ + seniority_date?: string + /** 司龄调整信息 */ + seniority_adjust_information_list?: PrehireSeniorityAdjustInformation[] +} + +export interface OfferInfoUpdate { + /** 入职日期 */ + onboarding_date?: string + /** 招聘应用ID */ + ats_application_id?: string + /** 入职地点ID，详细信息可通过【批量查询地点】接口获得 */ + onboarding_location_id?: string + /** 入职地址ID，详细信息可通过【批量查询地址】接口获得 */ + onboarding_address_id?: string + /** 办公地点ID，详细信息可通过【批量查询地点】接口获得 */ + office_location_id?: string + /** 办公地址ID，详细信息可通过【批量查询地址】接口获得 */ + office_address_id?: string + /** 雇佣类型，通过查询枚举集【employment_type】获得枚举apiName */ + employment_type?: string + /** 入职方式，通过查询枚举集【onboarding_method】获得枚举apiName */ + onboarding_method?: string + /** 工作邮箱 */ + work_emails?: EmailForUpdate[] + /** 成本中心分摊信息,只支持商业化租户 */ + cost_center_rates?: JobDataCostCenter[] + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 岗位 ID, */ + position_id?: string + /** 试用期时长 */ + probation_period?: number + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期结束日期 */ + probation_end_date?: string + /** 合同开始日期 */ + contract_start_date?: string + /** 合同结束日期 */ + contract_end_date?: string + /** 合同类型 */ + contract_type?: string + /** 期限类型 */ + duration_type_id?: string + /** 签订类型 */ + signing_type_id?: string + /** 工号 */ + worker_id?: string + /** 签到时间 */ + check_in_time?: string + /** 签到方式 */ + check_in_method?: string + /** 公司主体 */ + company?: string + /** 排班 */ + work_shift?: string + /** 招聘类型 */ + recruitment_type_id?: string + /** 薪资类型 */ + compensation_type?: string + /** 薪资组 */ + pay_group_id?: string + /** offer HR */ + offer_hr_id?: string + /** 职务 */ + job_id?: string + /** 序列 */ + job_family_id?: string + /** 职级 */ + job_level_id?: string + /** 职等 */ + job_grade_id?: string + /** 人员类型 */ + employee_type_id?: string + /** 人员子类型 */ + employee_subtype_id?: string + /** 直属上级 */ + direct_leader_id?: string + /** 虚线上级 */ + dotted_line_manager_id?: string + /** 部门 */ + department_id?: string + /** 社保城市 */ + social_security_city?: string + /** 工作城市 */ + work_location_id?: string + /** 工作日历 */ + working_calendar?: string + /** 工时制度 */ + working_hours_type?: string + /** 司龄起算日期 */ + seniority_date?: string + /** 司龄调整信息 */ + seniority_adjust_information_list?: PrehireSeniorityAdjustInformationUpdate[] +} + +export interface OfferInfoV2 { + /** Offer 基本信息 */ + offer_basic?: OfferBasicInfoV2 + /** Offer 薪酬信息 */ + offer_salary?: OfferSalaryInfoV2 +} + +export interface OfferJobInfo { + /** Offer 职位 ID */ + job_id?: string + /** Offer 职位名称 */ + job_name?: string +} + +export interface OfferListInfo { + /** Offer ID */ + id?: string + /** Offer 职位 */ + job_info?: OfferJobInfo + /** 创建时间 */ + create_time?: string + /** Offer 状态 */ + offer_status?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 + /** Offer 类型 */ + offer_type?: 1 | 2 + /** Offer 人员类型 */ + employee_type?: BaseBilingualWithId + /** Offer 投递 ID */ + application_id?: string +} + +export interface OfferSalaryInfo { + /** 币种 */ + currency: string + /** 基本薪资 */ + basic_salary?: string + /** 试用期百分比 */ + probation_salary_percentage?: string + /** 年终奖月数 */ + award_salary_multiple?: string + /** 期权股数 */ + option_shares?: string + /** 季度奖金额 */ + quarterly_bonus?: string + /** 半年奖金额 */ + half_year_bonus?: string +} + +export interface OfferSalaryInfoV2 { + /** 薪酬 ID */ + id?: string + /** 薪酬状态 */ + salary_status?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 试用期百分比 */ + probation_salary_percentage?: string + /** 年终奖月数 */ + award_salary_multiple?: string + /** 期权股数 */ + option_shares?: string + /** 季度奖金额 */ + quarterly_bonus?: string + /** 半年奖金额 */ + half_year_bonus?: string + /** 年度现金总额 */ + total_annual_cash?: string + /** 薪酬自定义字段 */ + customize_info_list?: ApplicationOfferCustomValue[] + /** 薪酬创建时间戳（单位：毫秒） */ + create_time?: string +} + +export interface OfferSchemaDetail { + /** 字段ID */ + id?: string + /** 字段名称 */ + name?: OfferSchemaName + /** 字段类型, text=单行文本, long_text=多行文本, select=单选, multi_select=多选, date_select=日期, number=数字 */ + type?: string + /** 字段是否为自定义 */ + is_customized?: boolean + /** 单选/多选可选择字段的选项值 */ + option_list?: OfferSchemaDetailOption[] +} + +export interface OfferSchemaDetailOption { + /** 名字 */ + name?: OfferSchemaName + /** 选项序号 */ + index?: number + /** 选项当前是否启用 */ + active_status?: 1 | 2 +} + +export interface OfferSchemaName { + /** 中文名 */ + zh_cn?: string + /** 英文名 */ + en_us?: string +} + +export interface OfferSendRecord { + /** offer 发送记录 id */ + offer_send_record_id?: string + /** 操作人 user id */ + operator_user_id?: string + /** offer 发送时间 */ + send_time?: string + /** offer 状态 */ + offer_letter_status?: 1 | 2 | 3 | 4 | 5 + /** offer 邮件信息 */ + email_info?: OfferEmailInfo + /** 跟进记录 */ + acceptance_list?: Acceptance[] + /** offer 文件列表 */ + offer_file_list?: OfferFile[] + /** offer 签署信息 */ + offer_signature_info?: OfferSignatureInfo +} + +export interface OfferSignatureInfo { + /** 电子签信息 id */ + id?: string + /** 电子签签署状态 */ + signature_status?: 1 | 2 | 3 | 4 | 5 + /** 电子签附件列表 */ + attachment_list?: SignatureAttachment[] +} + +export interface Okr { + /** OKR ID */ + okr_id?: string + /** 周期的状态 */ + period_display_status?: 'default' | 'normal' | 'invalid' | 'hidden' + /** 周期名 - 中文 */ + period_name_zh?: string + /** 周期名 - 英文 */ + period_name_en?: string + /** OKR 所属的用户 ID */ + user_id?: string + /** 可见性设置 */ + visible_setting?: OkrVisibleSetting +} + +export interface OkrBatch { + /** id */ + id?: string + /** OKR的访问权限 */ + permission?: 0 | 1 + /** period_id */ + period_id?: string + /** 名称 */ + name?: string + /** Objective列表 */ + objective_list?: OkrObjective[] + /** OKR确认状态 */ + confirm_status?: 0 | 1 | 2 | 3 | 4 +} + +export interface OkrKeyResult { + /** key result 的 ID */ + kr_id?: string + /** 是否设置过私密权限 */ + confidential?: boolean + /** key result 的位置编号，对应 Block 中 KR1、KR2 的 1、2。 */ + position?: number + /** 打分信息 */ + score?: number + /** OKR Block 中此 key result 是否可见 */ + visible?: boolean + /** key result 的权重 */ + weight?: number + /** 进展信息 */ + progress_rate?: OkrProgressRate + /** key result 的文本内容 */ + content?: Text +} + +export interface OkrObjective { + /** objective ID */ + objective_id?: string + /** 是否设置过私密权限 */ + confidential?: boolean + /** objective 的位置编号，对应 Block 中 O1、O2 的 1、2 */ + position?: number + /** 打分信息 */ + score?: number + /** OKR Block 中是否展示该 objective */ + visible?: boolean + /** objective 的权重 */ + weight?: number + /** 进展信息 */ + progress_rate?: OkrProgressRate + /** objective 的文本内容 */ + content?: Text +} + +export interface OkrObjectiveAlignedObjectiveOwner { + /** 用户的 open_id */ + open_id?: string + /** 用户的 user_id */ + user_id?: string +} + +export type OkrProgress = unknown + +export interface OkrProgressRate { + /** 状态模式 */ + mode?: 'simple' | 'advanced' + /** 当前进度 */ + current?: number + /** 当前进度百分比，simple mode 下使用 */ + percent?: number + /** 进展状态 */ + progress_status?: 'unset' | 'normal' | 'risk' | 'extended' + /** 进度起始值，advanced模式使用 */ + start?: number + /** 状态类型 */ + status_type?: 'default' | 'custom' + /** 进度目标值，advanced模式使用 */ + target?: number +} + +export interface OkrReview { + /** 复盘的用户 */ + user_id?: OkrObjectiveAlignedObjectiveOwner + /** 用户对应的OKR复盘列表 */ + review_period_list?: OkrReviewPeriod[] +} + +export interface OkrReviewPeriod { + /** 周期ID */ + period_id?: string + /** 周期复盘 */ + cycle_review_list?: OkrReviewPeriodUrl[] + /** 进展报告 */ + progress_report_list?: OkrReviewPeriodUrl[] +} + +export interface OkrReviewPeriodUrl { + /** 文档链接 */ + url?: string + /** 创建时间 毫秒 */ + create_time?: string +} + +export interface OkrVisibleSetting { + /** 进展编辑区域是否可见 */ + progress_fill_area_visible?: boolean + /** 状态是否可见 */ + progress_status_visible?: boolean + /** 分数是否可见 */ + score_visible?: boolean +} + +export interface OnboardingTask { + /** 任务名称 */ + task_name?: string + /** 任务名称 */ + task_status?: 'initiating' | 'terminated' | 'exception' | 'in_progress' | 'not_started' | 'skipped' | 'uninitialized' | 'failed' | 'in_review' | 'rejected' | 'completed' + /** 当前操作人雇佣 ID */ + operator_id?: string + /** 任务code */ + task_code?: string +} + +export interface OpenapiLog { + /** openapi日志唯一标识 */ + id: string + /** 飞书开放平台定义的API */ + api_key: string + /** 日志产生的时间，以秒为单位的时间戳 */ + event_time?: number + /** 在开发者后台——凭证与基础信息页面查看的app_id（cli_xxxxx） */ + app_id?: string + /** 发起调用api的ip地址 */ + ip?: string + /** openapi调用日志详情 */ + log_detail?: OpenapiLogDetail +} + +export interface OpenapiLogDetail { + /** http请求路径 */ + path?: string + /** http请求方法 */ + method?: string + /** http查询参数 */ + query_param?: string + /** http请求体 */ + payload?: string + /** http状态码 */ + status_code?: number + /** http响应体，仅返回code，msg，error信息等 */ + response?: string +} + +export interface OpenAppFeedCard { + /** 业务 ID */ + biz_id?: string + /** 主标题 */ + title?: string + /** 头像 key */ + avatar_key?: string + /** 预览信息 */ + preview?: string + /** 状态标签 */ + status_label?: OpenFeedStatusLabel + /** 交互按钮 */ + buttons?: OpenAppFeedCardButtons + /** 跳转链接 */ + link?: OpenAppFeedLink + /** 即时提醒状态，true-打开，false-关闭 */ + time_sensitive?: boolean + /** 通知设置，当前可设置通知是否关闭，为空时默认进行通知 */ + notify?: AppFeedNotify +} + +export interface OpenAppFeedCardButton { + /** 跳转 URL */ + multi_url?: OpenAppFeedCardUrl + /** 交互类型 */ + action_type: 'url_page' | 'webhook' + /** 文字 */ + text: OpenAppFeedCardText + /** 按钮类型 */ + button_type?: 'default' | 'primary' | 'success' + /** action 字典 */ + action_map?: unknown +} + +export interface OpenAppFeedCardButtons { + /** 按钮组合 */ + buttons: OpenAppFeedCardButton[] +} + +export interface OpenAppFeedCardText { + /** 文本 */ + text: string +} + +export interface OpenAppFeedCardUrl { + /** 默认 URL */ + url?: string + /** Android 平台 URL */ + android_url?: string + /** iOS 平台 URL */ + ios_url?: string + /** PC URL */ + pc_url?: string +} + +export interface OpenAppFeedLink { + /** 链接 */ + link?: string +} + +export interface OpenFailedUserAppFeedCardItem { + /** 业务 ID */ + biz_id: string + /** 用户 ID */ + user_id: string + /** 原因 */ + reason?: '0' | '1' | '2' | '3' | '4' +} + +export interface OpenFeedStatusLabel { + /** 标签文字 */ + text: string + /** 标签类型 */ + type: 'primary' | 'secondary' | 'success' | 'danger' +} + +export interface OpeningTimeExternal { + /** 有效日期 */ + valid_day?: OpeningTimeValidDayExternal + /** 有效星期 */ + weekdays?: number[] + /** 有效时间 */ + day_times?: OpeningTimePeriodExternal[] +} + +export interface OpeningTimePeriodExternal { + /** 起始时间 */ + start_hhmm: number + /** 结束时间 */ + end_hhmm: number +} + +export interface OpeningTimeValidDayExternal { + /** 权限开始时间 */ + start_day: number + /** 权限结束时间 */ + end_day: number +} + +export interface OperationLogEntityField { + /** 变更字段 */ + field?: string + /** 旧值 */ + before?: string + /** 新值 */ + after?: string +} + +export interface Operator { + /** 操作人ID */ + operator_id: string + /** 操作人身份，用户或应用 */ + operator_type: 'app' | 'user' +} + +export interface OperatorDetail { + /** 操作人名字信息 */ + operator_name: OperatorName + /** 操作人租户名 */ + tenant_name?: string +} + +export interface OperatorName { + /** 操作人默认名 */ + default_name: string + /** 操作人 i18n 名字 map */ + i18n_value?: I18n +} + +export interface Option { + /** 选项名称，不能为空，最大50个字符 */ + name: string + /** 选项的颜色索引值，可以是0～54中的一个数字。如果不填写则会随机选一个。 */ + color_index?: number + /** 选项是否隐藏。隐藏后的选项在界面不可见，也不可以再通过openapi将字段值设为该选项。 */ + is_hidden?: boolean +} + +export interface OrderCondition { + /** 字段名 */ + field?: string + /** 排序方式 */ + order_type?: 'asc' | 'desc' +} + +export interface OrganizationOpLog { + /** 业务对象ID */ + object_id?: string + /** 字段变化列表 */ + changes?: OperationLogEntityField[] + /** 操作人 */ + operator?: string + /** 操作类型 */ + operation_type?: number + /** 操作时间 */ + operation_time?: string + /** 操作生效时间 */ + effective_time?: string + /** 操作原因说明 */ + operation_reason?: string + /** 调整原因列表 */ + change_reasons?: string[] +} + +export interface OrgdraftDepartmentId { + /** 部门 ID ，新建部门审批通过前会返回空值 */ + department_id?: string + /** 调整部门 ID ，新建部门审批通过前会返回格式为 td_xxx 的临时 ID */ + draft_department_id?: string +} + +export interface OrgTruncation { + /** 组织名称 */ + org_key?: string + /** 下钻类型 */ + type?: number + /** 下钻深度 */ + depth?: number +} + +export interface Origin { + /** 任务导入来源的名称，用于在任务中心详情页展示。需提供多语言版本。 */ + platform_i18n_name?: I18nText + /** 任务关联的来源平台详情页链接 */ + href?: Href +} + +export interface OuterInfo { + /** 数据提供方（不能包含中横线 "-"） */ + provider: string + /** 唯一标识，可用来和其他平台的内容进行绑定。需保证和百科词条唯一对应（不能包含中横线 "-"） */ + outer_id: string +} + +export interface OvertimeClockCfg { + /** 是否允许在非打卡时段申请打卡（仅灰度租户可用） */ + allow_punch_approval?: boolean + /** 加班开始和结束需打卡(需灰度) */ + need_clock_over_time_start_and_end?: boolean +} + +export interface OvertimeRule { + /** 上班时间 */ + on_overtime: string + /** 下班时间 */ + off_overtime: string +} + +export interface Participant { + /** 参会者 */ + participant_name?: string + /** 部门 */ + department?: string + /** 用户ID */ + user_id?: string + /** 会议室ID */ + meeting_room_id?: string + /** 工号 */ + employee_id?: string + /** 电话 */ + phone?: string + /** 邮箱 */ + email?: string + /** 设备 */ + device?: string + /** 客户端版本 */ + app_version?: string + /** 公网IP */ + public_ip?: string + /** 内网IP */ + internal_ip?: string + /** 代理服务 */ + use_rtc_proxy?: boolean + /** 位置 */ + location?: string + /** 网络类型 */ + network_type?: string + /** 连接类型 */ + protocol?: string + /** 麦克风 */ + microphone?: string + /** 扬声器 */ + speaker?: string + /** 摄像头 */ + camera?: string + /** 音频 */ + audio?: boolean + /** 视频 */ + video?: boolean + /** 共享 */ + sharing?: boolean + /** 入会时间 */ + join_time?: string + /** 离会时间 */ + leave_time?: string + /** 参会时长 */ + time_in_meeting?: string + /** 离会原因 */ + leave_reason?: string + /** 日程响应状态 */ + accept_status?: 1 | 2 | 3 | 4 +} + +export interface ParticipantQuality { + /** 网络 */ + network?: QualityNetwork + /** 音频 */ + audio?: QualityAudio + /** 视频 */ + video?: QualityVideoSharing + /** 共享屏幕 */ + screen_sharing?: QualityVideoSharing + /** Cpu使用量 */ + cpu_usage?: QualityCpuUsage +} + +export interface Password { + /** 企业邮箱密码 */ + ent_email_password: string +} + +export interface PatchSchemaProperty { + /** 属性名 */ + name: string + /** 属性描述 */ + desc?: string + /** 问答产品设置，仅在datasource中use_answer为true时生效 */ + answer_option?: SchemaFieldAnswerOption +} + +export interface PatchTag { + /** tagid */ + id?: string + /** tag name */ + name?: string + /** i18n名称集合 */ + i18n_names?: TagI18nName[] +} + +export interface PatchTagFailReason { + /** 名称重复的标签id */ + duplicate_id?: string +} + +export interface Paygroup { + /** 薪资组ID */ + pay_group_id: string + /** 薪资组名称 */ + name: I18n + /** 薪资组编码 */ + code: string + /** 薪资组状态 */ + status: 1 | 0 + /** 薪资组所属国家/地区 */ + country_region?: CountryRegion +} + +export interface Period { + /** id */ + id?: string + /** 中文名称 */ + zh_name?: string + /** 英文名称 */ + en_name?: string + /** 状态 */ + status?: 0 | 1 | 2 | 3 + /** 周期开始时间 */ + period_start_time?: string + /** 周期结束时间 */ + period_end_time?: string +} + +export interface PeriodRule { + /** 周期规则 */ + period_rule_id?: string + /** 周期类型. year: 年度周期. month: 月份周期 */ + type?: string + /** 周期长度（月) */ + length?: number + /** 周期长度（月) */ + first_month?: number +} + +export interface PermissionCollection { + /** 功能权限 */ + feature_permissions?: IdNameObject[] + /** 管理权限 */ + management_permissions?: IdNameObject[] + /** 数据权限 */ + data_permissions?: DataPermission[] + /** 业务管理范围 */ + business_management_scopes?: BusinessManagementScope[] +} + +export interface PermissionDetail { + /** 角色 */ + role?: SecurityGroup + /** 指定管理对象列表，如果该值为null，则使用设置数据权限 */ + assigned_organization_list?: AssignedOrganization[][] + /** 设置数据权限，如果该值为null，则使用指定管理对象列表 */ + grantor_rule_list?: PermissionSecurityGroup[] + /** 更新时间 */ + update_time?: string +} + +export interface PermissionGroupInfo { + /** 权限点ID列表 */ + permission_ids?: string[] + /** 管理范围 */ + scope_rule?: PermissionScopeRule +} + +export interface PermissionNameInfo { + /** id */ + id?: string + /** 名称 */ + name?: string +} + +export interface PermissionPublic { + /** 允许内容被分享到组织外 */ + external_access?: boolean + /** 谁可以复制内容、创建副本、打印、下载 */ + security_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access' + /** 谁可以评论 */ + comment_entity?: 'anyone_can_view' | 'anyone_can_edit' + /** 谁可以添加和管理协作者 */ + share_entity?: 'anyone' | 'same_tenant' | 'only_full_access' + /** 链接分享设置 */ + link_share_entity?: 'tenant_readable' | 'tenant_editable' | 'anyone_readable' | 'anyone_editable' | 'closed' + /** 允许非「可管理权限」的人分享到组织外（仅share_entity=“same_tenant”时有效） */ + invite_external?: boolean + /** 节点是否已加锁 */ + lock_switch?: boolean +} + +export interface PermissionScopeRule { + /** 管理范围 */ + rule_type?: 0 | 1 | 2 +} + +export interface PermissionSecurityGroup { + /** 管理维度 */ + rule_dimension?: RuleDimension + /** 管理类型 */ + rule_type?: number + /** 规则 */ + expression?: FilterExpression +} + +export interface Person { + /** 人员Id */ + id?: string + /** 中文姓名 */ + name?: string + /** 英文姓名 */ + en_name?: string + /** 邮箱 */ + email?: string + /** 头像链接 */ + avatar_url?: string +} + +export interface PersonalProfile { + /** 资料类型 */ + personal_profile_type?: Enum + /** 上传文件列表 */ + files?: File[] +} + +export interface PersonalProfileForUpdate { + /** 资料类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可：- object_api_name = "personal_profile" - custom_api_name = "profile_type" */ + personal_profile_type?: string + /** 资料文件列表 */ + files?: File[] +} + +export interface PersonInfo { + /** 个人信息 ID */ + person_id?: string + /** 个人电话 */ + phone_number?: string + /** 法定姓名 */ + legal_name?: string + /** 常用名 */ + preferred_name?: string + /** 常用本地全名 */ + preferred_local_full_name?: string + /** 常用英文全名 */ + preferred_english_full_name?: string + /** 姓名列表 */ + name_list?: PersonName[] + /** -| 性别，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：gender - object_api_name：person */ + gender?: Enum + /** 出生日期 */ + date_of_birth?: string + /** 国籍 ID，可通过【查询国籍信息】接口查询 */ + nationality_id_v2?: string + /** -| 民族 / 种族，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：ethnicity_race - object_api_name：person */ + race?: Enum + /** -| 婚姻状况，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：marital_status - object_api_name：person */ + marital_status?: Enum + /** 电话列表，只有当满足下面所有条件时，电话在个人信息页才可见 */ + phone_list?: Phone[] + /** 地址列表 */ + address_list?: Address[] + /** 邮箱列表 */ + email_list?: Email[] + /** 工作经历列表 */ + work_experience_list?: WorkExperienceInfo[] + /** 教育经历列表 */ + education_list?: Education[] + /** 银行账户 */ + bank_account_list?: BankAccount[] + /** 证件 */ + national_id_list?: NationalId[] + /** 家庭成员列表 */ + dependent_list?: Dependent[] + /** 紧急联系人列表 */ + emergency_contact_list?: EmergencyContact[] + /** 参加工作日期 */ + date_entered_workforce?: string + /** 工龄 */ + working_years?: number + /** 头像资源的 ID */ + profile_image_id?: string + /** 邮箱地址 */ + email_address?: string + /** 年龄 */ + age?: number + /** 最高学历教育经历 */ + highest_level_of_education?: Education + /** 最高学位教育经历 */ + highest_degree_of_education?: Education + /** 个人资料附件 */ + personal_profile?: PersonalProfile[] + /** 籍贯 ID */ + native_region?: string + /** 户口类型，枚举值可通过文档【飞书人事枚举常量】户口类型（hukou_type）枚举定义部分获得 */ + hukou_type?: Enum + /** 户口所在地 */ + hukou_location?: string + /** 人才 ID */ + talent_id?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 居民身份证件号码 */ + national_id_number?: string + /** 家庭地址 */ + family_address?: string + /** 出生国家/地区 */ + born_country_region?: string + /** 是否残疾 */ + is_disabled?: boolean + /** 残疾证号 */ + disable_card_number?: string + /** 是否烈属 */ + is_martyr_family?: boolean + /** 烈属证号 */ + martyr_card_number?: string + /** 是否孤老 */ + is_old_alone?: boolean + /** 居民身份信息 */ + resident_taxes?: ResidentTax[] + /** 首次入境日期 */ + first_entry_time?: string + /** 预计离境日期 */ + leave_time?: string + /** 护照号码 */ + passport_number?: string +} + +export interface PersonName { + /** 姓 - 本地文字 */ + local_primary?: string + /** 名 - 本地文字 */ + local_first_name?: string + /** 国家 / 地区- 详细信息可通过[查询国家/地区信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)接口查询获得 */ + country_region_id: string + /** 姓名类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：person_name - custom_api_name：name_type */ + name_type: Enum + /** 名 - 第二本地文字 */ + local_first_name_2?: string + /** 姓 - 第二本地文字 */ + local_primary_2?: string + /** 补充姓名类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：person_name - custom_api_name：additional_name_type */ + additional_name_type?: Enum + /** 名 */ + first_name?: string + /** 全名 */ + full_name?: string + /** 姓氏称谓 */ + hereditary?: string + /** 自定义姓名（未传入时，姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接） */ + custom_name?: string + /** 本地文字的自定义姓名（未传入时，本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接） */ + custom_local_name?: string + /** 中间名 */ + middle_name?: string + /** 姓 */ + name_primary?: string + /** 第二姓氏 */ + secondary?: string + /** 婚后姓氏 */ + tertiary?: string + /** 尊称- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：person_name - custom_api_name：social */ + social?: Enum + /** 头衔- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：person_name - custom_api_name：title */ + title?: Enum + /** 本地中间名 */ + local_middle_name?: string + /** 第二姓氏 - 本地文字 */ + local_secondary?: string +} + +export interface Phone { + /** 国家区号 */ + international_area_code?: Enum + /** 电话号码 */ + phone_number: string +} + +export interface PhoneForUpdate { + /** 国家区号,枚举值 */ + international_area_code: string + /** 电话号码 */ + phone_number: string + /** 设备类型，枚举值 */ + device_type: string + /** 电话用途,枚举值 */ + phone_usage: string + /** 主要电话,若有多个电话，只能有一个电话的「is_primary」为true */ + is_primary: boolean + /** 公开电话 */ + is_public: boolean +} + +export interface PhoneNumberAndAreaCode { + /** 区号 */ + area_code: Enum + /** 号码 */ + phone_number: string +} + +export interface Phrase { + /** 文本中切分出的百科词条名称 */ + name: string + /** 实体词 id 列表 */ + entity_ids: string[] + /** 实体词所在位置 */ + span: Span +} + +export interface Pin { + /** Pin的消息ID */ + message_id: string + /** Pin消息所在的群聊ID */ + chat_id?: string + /** Pin的操作人ID */ + operator_id?: string + /** Pin的操作人ID类型 */ + operator_id_type?: string + /** Pin的创建时间（毫秒级时间戳） */ + create_time?: string +} + +export interface PlanCondition { + /** 适用范围左值 */ + left_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 + /** 适用范围操作 */ + operator?: 1 | 2 + /** 适用范围右值 */ + right_value?: string[] +} + +export interface PlanDetail { + /** 薪资方案ID */ + id: string + /** 薪资方案TID */ + tid: string + /** 薪资方案名称 */ + name: string + /** 薪资方案描述 */ + description: string + /** 薪资方案生效时间 */ + effective_date: string + /** 薪资方案适用范围 */ + plan_scope?: PlanScope + /** 币种ID */ + currency_id?: string + /** 开启试用期薪酬状态 */ + probation_salary_status: boolean + /** 方案关联的薪资项 */ + plan_items: PlanItem[] + /** 方案关联的薪资统计指标 */ + plan_indicators: PlanIndicator[] + /** 多语言名称 */ + i18n_names: I18nContent[] + /** 多语言描述 */ + i18n_descriptions: I18nContent[] +} + +export interface PlanIndicator { + /** 薪资统计指标ID，详细信息可以通过[批量查询薪资统计指标](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list)接口查询获得 */ + indicator_id: string + /** 方案关联薪资统计指标逻辑配置 */ + plan_indicator_logic?: AdjustmentLogic +} + +export interface PlanItem { + /** 定薪方式 */ + adjustment_type?: 'manual' | 'formula' | 'fixed' + /** 薪酬项ID，详细信息可以通过[批量查询薪资项](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list)接口查询获得 */ + item_id?: string + /** 方案关联薪资项逻辑配置 */ + plan_item_logic?: AdjustmentLogic + /** 试用期薪酬类型 */ + probation_discount_type?: 'percentum' | 'manual_input' | 'none' | 'fixed' | 'formula' | 'not_set' + /** 试用期薪酬百分比 */ + probation_discount_percentum?: string +} + +export interface PlanScope { + /** 是否全部范围 */ + is_all?: boolean + /** 方案适用范围条件组 */ + plan_conditions?: PlanCondition[] +} + +export interface PlusMenu { + /** pc 端链接 */ + pc_app_link?: string + /** 移动端链接 */ + mobile_app_link?: string +} + +export interface PortalJobPost { + /** 职位广告 ID */ + id?: string + /** 标题 */ + title?: string + /** 职位 ID */ + job_id?: string + /** 职位编码 */ + job_code?: string + /** 职位过期时间，「null」代表「长期有效」 */ + job_expire_time?: string + /** 职位状态 */ + job_active_status?: 1 | 2 + /** 职位流程类型 */ + job_process_type?: 1 | 2 + /** 职位雇佣类型 */ + job_recruitment_type?: IdNameObject + /** 职位部门 */ + job_department?: IdNameObject + /** 职位类型 */ + job_type?: IdNameObject + /** 最低职级 */ + min_job_level?: IdNameObject + /** 最高职级 */ + max_job_level?: IdNameObject + /** 职位地址 */ + address?: CommonAddress + /** 月薪范围-最低薪资 */ + min_salary?: string + /** 月薪范围-最高薪资 */ + max_salary?: string + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 经验 */ + experience?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + /** 数量 */ + headcount?: number + /** 职位亮点 */ + high_light_list?: IdNameObject[] + /** 职位描述 */ + description?: string + /** 职位要求 */ + requirement?: string + /** 创建人 */ + creator?: IdNameObject + /** 创建时间 */ + create_time?: string + /** 修改时间 */ + modify_time?: string + /** 自定义字段 */ + customized_data_list?: WebsiteJobPostCustomizedData[] + /** 职能分类 */ + job_function?: IdNameObject + /** 职位广告地址列表 */ + address_list?: CommonAddress[] +} + +export interface Post { + /** 发帖用户ID */ + user_id?: string + /** 帖子内容 */ + content: string + /** 图片的key 列表 */ + image_key_list?: string[] + /** 媒体文件的 token */ + media_file_token?: string + /** 评论数 */ + comment_count?: number + /** 帖子的reaction及其数量 */ + reaction_set?: ReactionSet + /** 帖子ID */ + id?: string + /** 帖子创建时间 */ + create_time?: string + /** 视频封面图片 */ + media_cover_image_key?: string + /** 帖子所属板块 */ + category_ids?: string[] + /** 帖子链接 */ + link?: string + /** 发帖人类型 */ + user_type?: 1 | 2 | 3 | 4 + /** 点踩数量 */ + dislike_count?: number +} + +export interface PreHire { + /** 个人信息 */ + person_info?: PersonInfo + /** 工作信息 */ + employment_info?: PreHireEmploymentInfo + /** 入职信息 */ + onboarding_info?: PreHireOnboardingInfo + /** 试用期信息 */ + probation_info?: PreHireProbationInfo + /** 合同信息 */ + contract_info?: PreHireContractInfo + /** 待入职 id */ + pre_hire_id?: string +} + +export interface PreHireAbnormalReason { + /** 异常信息描述 */ + descriptions?: I18n[] +} + +export interface PreHireContractInfo { + /** 合同开始日期 */ + contract_start_date?: string + /** 合同结束日期 */ + contract_end_date?: string + /** -| 合同类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - object_api_name = "pre_hire" - custom_api_name = "contract_type" */ + contract_type?: string + /** -| 期限类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - object_api_name = "pre_hire" - custom_api_name = "duration_type" */ + duration_type?: string + /** -| 签订类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - object_api_name = "pre_hire" - custom_api_name = "duration_type" */ + signing_type?: string +} + +export interface PreHireEmploymentInfo { + /** 部门 ID ，可以通过【搜索部门信息】接口获取 */ + department_id?: string + /** 成本中心分摊信息 */ + cost_center_rates?: JobDataCostCenter[] + /** 办公地点id ，详细信息可通过【批量查询地点】接口获得 */ + office_location_id?: string + /** 工作地点id ，详细信息可通过【批量查询地点】接口获得 */ + work_location_id?: string + /** 工位 */ + work_station?: string + /** 工号 */ + worker_id?: string + /** -| 薪资类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：compensation_type - object_api_name：pre_hire */ + compensation_type?: Enum + /** 直属上级雇佣 ID ， 可以通过【搜索员工信息】接口获取 */ + direct_leader_id?: string + /** 虚线上级雇佣 ID ， 可以通过【搜索员工信息】接口获取 */ + dotted_line_manager_id?: string + /** 职务 ID ,可以通过【批量查询职务】接口获取 */ + job_id?: string + /** 序列 ID，可以通过【批量查询职务序列】接口获取 */ + job_family_id?: string + /** 职级 ID，可以通过【批量查询职务级别】接口获取 */ + job_level_id?: string + /** 职等 ID */ + job_grade_id?: string + /** 职务头衔 */ + job_title?: string + /** 人员类型 ID ，可以通过招聘【批量查询人员类型】接口获取 */ + employee_type_id?: string + /** 人员子类型 ID */ + employee_subtype_id?: string + /** -| 雇佣类型， 枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - object_api_name = "pre_hire" - custom_api_name = "employment_type" */ + employment_type?: string + /** 工作邮箱 */ + work_email?: string + /** 公司 ID , 详细信息可通过【批量查询公司】接口获得 */ + company_id?: string + /** 社保城市 ID ，详细信息可通过【批量查询地点】接口获得 */ + social_security_city_id?: string + /** 是否包含竞业条款 */ + non_compete_covenant?: boolean + /** 周工作时长（单位：小时） */ + weekly_working_hours?: number + /** 是否离职重聘 */ + rehire?: 'to_be_confirmed' | 'no' | 'yes' + /** -| 历史雇佣信息 ID ，雇佣信息详细信息可以通过「查询单个雇佣信息」API 获得，系统会检验当前雇佣信息的合法性，要求： - 雇佣信息为该人员最后一次雇佣记录 - 雇佣信息的雇员状态 = "terminated" - 该人员不存在其他待入职记录 */ + rehire_employment_id?: string + /** -| 工时制度 ID ，可通过【查询单个工时制度】接口获取 */ + working_hours_type?: string + /** 周工作时长v2（单位：小时） */ + weekly_working_hours_v2?: number + /** 办公地址 */ + office_address?: Address + /** 工作日历 */ + working_calendar_id?: string + /** 待入职信息 更新时间 */ + updated_at?: string + /** 是否疑似重聘 */ + suspected_rehiring?: boolean + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 岗位 ID */ + position_id?: string + /** 公司主体是否被手动修改 */ + company_manual_updated?: boolean + /** 薪资组信息 */ + pay_group?: PreHirePayGroupInfo + /** 是否信息异常 */ + whether_the_information_is_abnormal?: boolean + /** 异常原因列表 */ + abnormal_reason?: PreHireAbnormalReason[] + /** 是否有 Offer 薪酬 */ + has_offer_salary?: boolean + /** 招聘项目 ID */ + recruitment_project_id?: string + /** -| 排班类型，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：work_shift - object_api_name：pre_hire */ + work_shift?: Enum + /** 待入职信息 创建时间 */ + created_at?: string + /** 待入职信息 创建人 */ + created_by?: string + /** 待入职信息 更新人 */ + updated_by?: string + /** 司龄起算日期 */ + seniority_date?: string + /** 背调订单ID */ + background_check_order_id?: string + /** 背调名称 */ + background_check_order_name?: string + /** 背调套餐 */ + background_check_order_package_name?: string + /** 背调结果 */ + background_check_order_result?: string + /** 背调供应商 */ + background_check_order_supplier_name?: string + /** 背调账号名称 */ + background_check_order_account_name?: string + /** 背调开始时间 */ + background_check_order_start_time?: string + /** 背调完成时间 */ + background_check_order_complete_time?: string + /** -| 背调状态，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - custom_api_name：background_check_order_status - object_api_name：pre_hire */ + background_check_order_status?: Enum + /** 司龄调整信息 */ + seniority_adjust_information_list?: PrehireSeniorityAdjustInformationQuery[] +} + +export interface PreHireOnboardingInfo { + /** Offer id , 可以通过招聘【获取 Offer 列表】接口获取 */ + offer_id?: string + /** Offer hr 的 雇佣 ID */ + offer_hr_id?: string + /** -| 入职方式，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - object_api_name = "pre_hire" - custom_api_name = "onboarding_method" */ + entry_mode?: string + /** 入职日期 */ + onboarding_date?: string + /** 招聘投递 ID ，详细信息可以通过招聘【获取投递信息】接口查询获得 */ + ats_application_id?: string + /** -| 招聘来源 ，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - object_api_name = "pre_hire" - custom_api_name = "recruitment_type" */ + recruitment_type?: string + /** -| 入职地点id , 详细信息可通过【批量查询地点】接口获得 */ + onboarding_location_id?: string + /** -| 需要公司办理签证 */ + company_sponsored_visa?: boolean + /** -| 入职状态 */ + onboarding_status?: 'preboarding' | 'deleted' | 'day_one' | 'withdrawn' | 'completed' + /** 入职任务列表 */ + onboarding_task_list?: OnboardingTask[] + /** 入职地址 */ + onboarding_address?: Address + /** 入职流程 */ + flow_name?: I18n[] + /** 入职流程 ID */ + flow_id?: string + /** 签到时间 */ + check_in_time?: string + /** -| 招聘来源 ，枚举值可查询【获取字段详情】接口获取，按如下参数查询即可： - object_api_name = "pre_hire" - custom_api_name = "check_in_method" */ + check_in_method?: Enum +} + +export interface PreHirePayGroupInfo { + /** 薪资组名称 */ + name?: I18n[] + /** 薪资组 ID */ + id?: string +} + +export interface PreHireProbationInfo { + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期结束日期 */ + probation_end_date?: string + /** 试用期时长（单位：天） */ + probation_period?: number +} + +export interface PreHireQuery { + /** 招聘系统的候选人 ID */ + ats_application_id?: string + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 入职日期 */ + hire_date?: string + /** 雇佣类型 */ + employee_type: Enum + /** 人员编号 */ + worker_id?: string + /** 雇佣类型 */ + employee_type_id: string + /** 引用Person ID */ + person_id: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] + /** 入职状态 */ + onboarding_status: Enum + /** 成本中心分摊信息 */ + cost_center_rate?: SupportCostCenterItem[] + /** 工作邮箱 */ + work_email_list?: Email[] + /** 部门ID */ + department_id?: string +} + +export interface PrehireSeniorityAdjustInformation { + /** 调整值- 精确度：两位小数- 单位：年- 自动计算逻辑：如果这个值为空，司龄调整的开始日期和结束日期均不为空，会自动计算出调整值 */ + seniority_adjustment?: number + /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：seniority_adjust_information - custom_api_name：seniority_adjustment_type */ + seniority_adjustment_type: 'decrease' | 'increase' + /** 司龄调整原因 */ + reasons_for_seniority_adjustment?: string + /** 开始日期- 格式： yyyy-mm-dd */ + start_date?: string + /** 结束日期- 格式： yyyy-mm-dd */ + end_date?: string +} + +export interface PrehireSeniorityAdjustInformationQuery { + /** 调整值- 精确度：两位小数- 单位：年 */ + seniority_adjustment?: number + /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：seniority_adjust_information - custom_api_name：seniority_adjustment_type */ + seniority_adjustment_type?: Enum + /** 司龄调整原因 */ + reasons_for_seniority_adjustment?: string + /** 开始日期 */ + start_date?: string + /** 结束日期 */ + end_date?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] +} + +export interface PrehireSeniorityAdjustInformationUpdate { + /** 调整值- 精确度：两位小数- 单位：年- 自动计算逻辑：如果这个值为空，司龄调整的开始日期和结束日期均不为空，会自动计算出调整值 */ + seniority_adjustment?: number + /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：seniority_adjust_information - custom_api_name：seniority_adjustment_type */ + seniority_adjustment_type: 'decrease' | 'increase' + /** 司龄调整原因 */ + reasons_for_seniority_adjustment?: string + /** 开始日期- 格式： yyyy-mm-dd */ + start_date?: string + /** 结束日期- 格式： yyyy-mm-dd */ + end_date?: string +} + +export interface PreviewNode { + /** 节点id */ + node_id?: string + /** 节点名称 */ + node_name?: string + /** 节点类型 “AND":会签 “OR”:或签 */ + node_type?: string + /** 节点描述 */ + comments?: string[] + /** 租户节点id */ + custom_node_id?: string + /** 审批人id列表 */ + user_id_list?: string[] + /** 节点结束抄送人id列表 */ + end_cc_id_list?: string[] + /** 审批人是否为空 */ + is_empty_logic?: boolean + /** 是否是发起人自选类型 */ + is_approver_type_free?: boolean + /** 是否包含抄送人自选类型 */ + has_cc_type_free?: boolean +} + +export interface ProbationInfo { + /** 雇佣 ID */ + employment_id?: string + /** 试用期信息 ID */ + probation_id?: string + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期预计结束日期 */ + probation_expected_end_date?: string + /** 试用期实际结束日期 */ + actual_probation_end_date?: string + /** 转正发起日期 */ + initiating_time?: string + /** 发起方 */ + submission_type?: Enum + /** 转正发起人的雇佣 ID，当系统发起转正时该字段为空 */ + initiator_id?: string + /** 试用期状态 */ + probation_status?: Enum + /** 员工自评 */ + self_review?: string + /** 备注 */ + notes?: string + /** 流程实例 ID */ + process_id?: string + /** 是否通过 BPM 转正 */ + converted_via_bpm?: boolean + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 试用期考核最终状态 */ + final_assessment_status?: Enum + /** 试用期考核最终结果 */ + final_assessment_result?: Enum + /** 试用期考核最终得分 */ + final_assessment_score?: number + /** 试用期考核最终等级 */ + final_assessment_grade?: Enum + /** 试用期考核最终评语 */ + final_assessment_comment?: string + /** 最终考核结果页面超链接 */ + final_assessment_detail?: string + /** 试用期考核结果列表 */ + assessments?: Assessment[] + /** 试用期延长后的预计结束日期 */ + probation_extend_expected_end_date?: string + /** 试用期延长时间 */ + extended_probation_period_duration?: number + /** 试用期延长时间单位 */ + extended_probation_period_unit?: Enum + /** 试用期结果 */ + probation_outcome?: Enum +} + +export interface ProbationInfoForSubmit { + /** 雇佣 ID */ + employment_id?: string + /** 试用期信息 ID */ + probation_id?: string + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期预计结束日期 */ + probation_expected_end_date?: string + /** 试用期实际结束日期 */ + actual_probation_end_date?: string + /** 转正发起日期 */ + initiating_time?: string + /** 发起方 */ + submission_type?: Enum + /** 转正发起人的雇佣 ID，当系统发起转正时该字段为空 */ + initiator_id?: string + /** 试用期状态 */ + probation_status?: Enum + /** 员工自评 */ + self_review?: string + /** 备注 */ + notes?: string + /** 流程实例 ID */ + process_id?: string + /** 是否通过 BPM 转正 */ + converted_via_bpm?: boolean + /** 自定义字段 */ + custom_fields?: CustomFieldData[] + /** 试用期考核最终状态 */ + final_assessment_status?: Enum + /** 试用期考核最终结果 */ + final_assessment_result?: Enum + /** 试用期考核最终得分 */ + final_assessment_score?: number + /** 试用期考核最终等级 */ + final_assessment_grade?: Enum + /** 试用期考核最终评语 */ + final_assessment_comment?: string + /** 最终考核结果页面超链接 */ + final_assessment_detail?: string +} + +export interface ProcessAbstractItem { + /** 摘要标题 */ + name?: DataengineI18n + /** 摘要值 */ + value?: DataengineI18n +} + +export interface ProcessCcItem { + /** 单据ID */ + approver_id?: string + /** 单据地址 */ + links?: ProcessLink + /** 抄送人ID */ + operator_id?: string + /** 抄送人姓名 */ + operator_name?: DataengineI18n + /** 节点名称 */ + node_name?: DataengineI18n + /** 抄送时间，Unix毫秒时间戳 */ + create_time?: string + /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ + node_definition_id?: string +} + +export interface ProcessCommentInfo { + /** 评论人id */ + commentor_id?: string + /** 评论人姓名 */ + commentor_name?: DataengineI18n + /** 评论时间,Unix毫秒时间戳 */ + comment_time?: string + /** 评论内容 */ + comment_msg?: string +} + +export interface ProcessDoneItem { + /** 单据ID */ + approver_id?: string + /** 单据类型 */ + type?: 1 | 5 + /** 单据状态 */ + status?: 3 | 2 | 4 + /** 单据地址 */ + links?: ProcessLink + /** 操作人ID */ + operator_id?: string + /** 操作人姓名 */ + operator_name?: DataengineI18n + /** 节点名称 */ + node_name?: DataengineI18n + /** 创建时间，Unix毫秒时间戳 */ + create_time?: string + /** 完成时间，Unix毫秒时间戳 */ + complete_time?: string + /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ + node_definition_id?: string + /** 审批意见 */ + approval_opinion?: string +} + +export interface ProcessFormVariableV2 { + /** 变量唯一标识 */ + variable_api_name?: string + /** 变量值 */ + variable_value?: FieldVariableValueToForReview + /** 在list_values和record_values中引用的变量 */ + sub_values?: FieldVariableSubVlaueForReview[] +} + +export interface ProcessLink { + /** web端单据详情页地址 */ + web_link?: string + /** 飞书pc端单据详情页地址 */ + pc_link?: string + /** 飞书移动端单据详情页地址 */ + mobile_link?: string +} + +export interface ProcessSystemDoneItem { + /** 单据ID */ + approver_id?: string + /** 单据类型 */ + type?: 1 | 5 + /** 单据状态 */ + status?: 3 | 2 | 4 + /** 单据地址 */ + links?: ProcessLink + /** 操作人姓名 */ + operator_name?: DataengineI18n + /** 节点名称 */ + node_name?: DataengineI18n + /** 创建时间，Unix毫秒时间戳 */ + create_time?: string + /** 完成时间，Unix毫秒时间戳 */ + complete_time?: string + /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ + node_definition_id?: string + /** 审批意见 */ + approval_opinion?: string +} + +export interface ProcessSystemTodoItem { + /** 单据ID */ + approver_id?: string + /** 单据类型 */ + type?: 1 | 5 + /** 单据地址 */ + links?: ProcessLink + /** 操作人姓名 */ + operator_name?: DataengineI18n + /** 节点名称 */ + node_name?: DataengineI18n + /** 创建时间，Unix毫秒时间戳 */ + create_time?: string + /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ + node_definition_id?: string +} + +export interface ProcessTodoItem { + /** 单据ID */ + approver_id?: string + /** 单据类型 */ + type?: 1 | 5 + /** 单据地址 */ + links?: ProcessLink + /** 操作人ID */ + operator_id?: string + /** 操作人姓名 */ + operator_name?: DataengineI18n + /** 节点名称 */ + node_name?: DataengineI18n + /** 创建时间，Unix毫秒时间戳 */ + create_time?: string + /** 节点定义ID（注：在回退场景，同一个节点会对应多个节点实例） */ + node_definition_id?: string +} + +export interface ProductI18nName { + /** 商业化产品的中文名 */ + zh_cn?: string + /** 商业化产品的日文名 */ + ja_jp?: string + /** 商业化产品的英文名 */ + en_us?: string +} + +export interface ProfileSettingAddress { + /** 地址类型，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "address" custom_api_name = "address_type" */ + address_type?: string + /** 国家 / 地区ID */ + country_region?: string + /** 主要行政区ID */ + region?: string + /** 主要行政区往下细分 1 层的行政区 */ + region_subdivision_1?: string + /** 主要行政区往下细分 2 层的行政区 */ + region_subdivision_2?: string + /** 城市V2 ID */ + city_v2?: string + /** 城市（文本） */ + city_text?: string + /** 城市（仅文本，非拉丁语系的本地文字） */ + local_city_text?: string + /** 城市往下细分 1 层的行政区 */ + city_subdivision_1?: string + /** 城市往下细分 2 层的行政区 */ + city_subdivision_2?: string + /** 区/县V2 ID */ + district_v2?: string + /** 邮政编码 */ + postal_code?: string + /** 地址行 1 */ + address_line_1?: string + /** 地址行 1（非拉丁语系的本地文字） */ + local_address_line_1?: string + /** 地址行 2 */ + address_line_2?: string + /** 地址行 2（非拉丁语系的本地文字） */ + local_address_line_2?: string + /** 地址行 3 */ + address_line_3?: string + /** 地址行 3（非拉丁语系的本地文字） */ + local_address_line_3?: string + /** 地址行 4 */ + address_line_4?: string + /** 地址行 5（非拉丁语系的本地文字） */ + local_address_line_5?: string + /** 地址行 6 */ + address_line_6?: string + /** 地址行 6（非拉丁语系的本地文字） */ + local_address_line_6?: string + /** 地址行 7 */ + address_line_7?: string + /** 地址行 7（非拉丁语系的本地文字） */ + local_address_line_7?: string + /** 地址行 8 */ + address_line_8?: string + /** 地址行 8（非拉丁语系的本地文字） */ + local_address_line_8?: string + /** 地址行 9 */ + address_line_9?: string + /** 地址行 9（非拉丁语系的本地文字） */ + local_address_line_9?: string + /** 地址行 4（非拉丁语系的本地文字） */ + local_address_line_4?: string + /** 地址行 5 */ + address_line_5?: string +} + +export interface ProfileSettingBankAccount { + /** 国家 / 地区ID */ + country_region?: string + /** 银行名称 */ + bank_name?: string + /** 支行名称 */ + branch_name?: string + /** 开户人姓名 */ + account_holder?: string + /** 银行账号 */ + bank_account_number?: string + /** 银行卡用途，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "bank_account" custom_api_name = "bank_account_usage" */ + bank_account_usages?: string[] + /** 银行卡类型，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "bank_account" custom_api_name = "bank_account_type" */ + bank_account_type?: string + /** 银行ID */ + bank_id?: string + /** 银行支行ID */ + branch_id?: string + /** 分配方式，枚举值 */ + payment_type?: 'percent' | 'amount' | 'balance' + /** 分配比例，0～100，保留两位小数 */ + payment_rate?: string + /** 分配金额，保留两位小数 */ + payment_amount?: string + /** 优先级，不能低于0 */ + priority?: string +} + +export interface ProfileSettingCareer { + /** 教育经历 */ + educations?: ProfileSettingEducation[] + /** 工作经历 */ + work_experiences?: ProfileSettingWorkExperience[] + /** 自定义分组 */ + custom_groups?: ProfileSettingCustomGroup[] +} + +export interface ProfileSettingCitizenshipStatus { + /** 国家/地区ID */ + country_region?: string + /** 公民身份类型 */ + citizenship_status?: string +} + +export interface ProfileSettingCostCenter { + /** 100 */ + id?: string + /** 分摊比例 */ + rate?: number +} + +export interface ProfileSettingCustomField { + /** 字段名 */ + field_name: string + /** 字段值, 是 json 转义后的字符串，根据元数据定义不同，字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 */ + value?: string +} + +export interface ProfileSettingCustomGroup { + /** 分组名 */ + group_name?: string + /** 分组数据 */ + items?: ProfileSettingCustomGroupItem[] +} + +export interface ProfileSettingCustomGroupItem { + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface ProfileSettingDataAttachment { + /** 资料附件记录 */ + personal_records?: ProfileSettingPersonalRecord[] + /** 自定义分组 */ + custom_groups?: ProfileSettingCustomGroup[] +} + +export interface ProfileSettingDependent { + /** 姓名 */ + legal_name?: string + /** 生日 */ + date_of_birth?: string + /** 关系，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "dependent" custom_api_name ="relationship_with_dependent" */ + relationship_with_dependent?: string + /** 性别，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "dependent" custom_api_name = "gender" */ + gender?: string + /** 电话 */ + phone?: ProfileSettingPhone + /** 岗位 */ + job?: string + /** 出生证明 */ + child_birth_certificates?: ProfileSettingFile[] + /** 工作单位 */ + employer?: string + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] + /** 联系地址 */ + address?: ProfileSettingAddress +} + +export interface ProfileSettingEducation { + /** 学校 */ + school?: string + /** "学校, 枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = ""education"" custom_api_name = ""school_name""" */ + school_enum?: string + /** 开始日期 */ + start_date?: string + /** 结束日期 */ + end_date?: string + /** 学历, 枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "education" custom_api_name = "level_of_education" */ + level_of_education?: string + /** 专业 */ + field_of_study?: string + /** 学位,枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "education" custom_api_name = "degree" */ + degree?: string + /** "专业，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = ""education"" custom_api_name = ""field_of_study_name""" */ + field_of_study_enum?: string + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface ProfileSettingEmergencyContact { + /** 姓名 */ + legal_name?: string + /** 关系，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "emergency_contract" custom_api_name = "relationship" */ + relationship?: string + /** 主要联系人 */ + is_primary?: boolean + /** 电话 */ + phone?: ProfileSettingPhone + /** 邮箱 */ + email?: string + /** 地址 */ + address?: ProfileSettingAddress + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface ProfileSettingEmpContractRecord { + /** 合同协议编号 */ + contract_number?: string + /** 合同类型，枚举值可选项 可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "contract" custom_api_name = "contract_type" */ + contract_type?: string + /** 甲方公司 ID, 引用Company的ID，详细信息可通过【查询单个公司】接口查询获得 */ + first_party?: string + /** 合同开始日期 */ + effective_time?: string + /** 期限类型，枚举值可选项 可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "contract" custom_api_name = "duration_type" */ + duration_type?: string + /** 合同结束日期 */ + contract_end_date?: string +} + +export interface ProfileSettingEmploymentBasicInfo { + /** 员工编号 */ + employee_number?: string + /** 入职日期 */ + effective_time?: string + /** 转正式员工日期 */ + regular_employee_start_date?: string + /** 资历起算日期 */ + seniority_date?: string + /** 工作邮箱 */ + work_email?: string + /** 工作电话 */ + phone?: ProfileSettingPhone + /** 数据驻留地，开通了飞书数据驻留服务的企业，该字段为必填 */ + user_geo?: string + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface ProfileSettingEmploymentInfo { + /** 基本信息 */ + basic_info?: ProfileSettingEmploymentBasicInfo + /** 试用期信息 */ + probation_info?: ProfileSettingProbationInfo + /** 任职记录 */ + employment_record?: ProfileSettingEmploymentRecord + /** 合同记录 */ + emp_contract_record?: ProfileSettingEmpContractRecord + /** 自定义分组 */ + custom_groups?: ProfileSettingCustomGroup[] + /** 自定义组织记录 */ + custom_org_groups?: JobDataCustomOrg[] + /** 司龄调整信息 */ + seniority_adjust_informations?: SeniorityAdjustInformationEdit[] +} + +export interface ProfileSettingEmploymentRecord { + /** 人员类型 ID */ + employee_type?: string + /** 部门 ID */ + department?: string + /** 实线主管雇佣ID */ + direct_manager?: string + /** 工时制度 ID */ + working_hours_type?: string + /** 成本中心分摊信息 */ + cost_centers?: ProfileSettingCostCenter[] + /** 实线主管入职日期 */ + direct_manager_effective_time?: string + /** 虚线主管雇佣ID */ + dotted_line_manager?: string + /** 虚线主管入职日期 */ + dotted_line_manager_effective_time?: string + /** 职务 ID */ + job?: string + /** 职务序列 ID */ + job_family?: string + /** 职务级别 ID */ + job_level?: string + /** 职等 ID */ + job_grade?: string + /** 工作地点 ID */ + work_location?: string + /** 周工作时长 */ + weekly_working_hours?: number + /** 岗位ID */ + position?: string +} + +export interface ProfileSettingFile { + /** 文件ID */ + file_id?: string + /** 文件MIME类型 */ + mime_type?: string + /** 文件名 */ + name?: string + /** 文件大小(KB) */ + size?: string + /** 文件token */ + token?: string +} + +export interface ProfileSettingHukou { + /** 户口类型，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "person_info_chn" custom_api_name = "hukou_type" */ + hukou_type?: string + /** 户口所在地 */ + hukou_location?: string + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface ProfileSettingI18n { + /** 中文 */ + zh_cn?: string + /** 英文 */ + en_us?: string +} + +export interface ProfileSettingName { + /** 补充姓名类型, 枚举值。可选项可以通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "person_name" - custom_api_name = "additional_name_type" */ + additional_name_type?: string + /** 国家 / 地区 ID */ + country_region?: string + /** 全名 */ + full_name?: string + /** 姓氏称谓 */ + hereditary?: string + /** 中间名 */ + middle_name?: string + /** 第二姓氏 */ + secondary?: string + /** 尊称,枚举值。可选项可以通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "person_name" - custom_api_name = "social" */ + social?: string + /** 婚后姓氏 */ + tertiary?: string + /** 名 - 第二本地文字 */ + local_first_name_2?: string + /** 本地中间名 */ + local_middle_name?: string + /** 姓 - 本地文字 */ + local_primary?: string + /** 姓 - 第二本地文字 */ + local_primary_2?: string + /** 第二姓氏 - 本地文字 */ + local_secondary?: string + /** 头衔, 枚举值。可选项可以通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "person_name" - custom_api_name = "title" */ + title?: string + /** 名 - 本地文字 */ + local_first_name?: string + /** 自定义姓名（本地文字） */ + custom_local_name?: string + /** 自定义姓名（西方文字） */ + custom_western_name?: string + /** 名 */ + first_name?: string + /** 姓 */ + name_primary?: string +} + +export interface ProfileSettingNational { + /** 国家/地区ID */ + country_region?: string + /** 国家证件类型ID */ + national_id_type?: string + /** 证件号码 */ + national_id_number?: string + /** 证件签发日期 */ + issued_date?: string + /** 证件签发机构 */ + issued_by?: string + /** 证件到期日期 */ + expiration_date?: string + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface ProfileSettingPersonalBasicInfo { + /** 法定姓名 */ + legal_name?: ProfileSettingName + /** 常用姓名 */ + preferred_name?: ProfileSettingName + /** 性别，枚举值 。可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "person" custom_api_name = "gender" */ + gender?: string + /** 国籍ID */ + nationality_v2?: string + /** 民族 / 种族，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "person" custom_api_name = "ethnicity_race" */ + ethnicity_race?: string + /** 个人电话 */ + phone?: ProfileSettingPhone + /** 个人邮箱 */ + email?: string + /** 出生日期 */ + date_of_birth?: string + /** 婚姻状况，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "person" custom_api_name = "marital_status" */ + marital_status?: string + /** 是否残疾 */ + is_disabled?: boolean + /** 残疾证号，is_disabled 为 true 时必填 */ + disable_card_number?: string + /** 是否为烈属 */ + is_martyr_family?: boolean + /** 烈属证号，is_martyr_family 为 true 时必填 */ + martyr_card_number?: string + /** 是否为孤老 */ + is_old_alone?: boolean + /** 出生国家/地区 */ + born_country_region?: string + /** 政治面貌，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "person_info_chn" custom_api_name = "political_affiliation" */ + political_affiliation?: string + /** 籍贯(省份/行政区ID） */ + native_region?: string + /** 参加工作日期 */ + date_entered_workforce?: string + /** 首次入境日期 */ + first_entry_time?: string + /** 预计离境日期 */ + leave_time?: string + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] + /** 其他国籍（地区）ID */ + additional_nationalities?: string[] +} + +export interface ProfileSettingPersonalInfo { + /** 基本信息 */ + personal_basic_info?: ProfileSettingPersonalBasicInfo + /** 紧急联系人 */ + emergency_contacts?: ProfileSettingEmergencyContact[] + /** 银行账户 */ + bank_accounts?: ProfileSettingBankAccount[] + /** 证件 */ + nationals?: ProfileSettingNational[] + /** 居民身份信息 */ + resident_taxes?: ProfileSettingResidentTax[] + /** 家庭成员 */ + dependents?: ProfileSettingDependent[] + /** 户口 */ + hukou?: ProfileSettingHukou + /** 联系地址 */ + contact_addresses?: ProfileSettingAddress[] + /** 自定义分组 */ + custom_groups?: ProfileSettingCustomGroup[] + /** 公民身份列表 */ + citizenship_statuses?: ProfileSettingCitizenshipStatus[] +} + +export interface ProfileSettingPersonalRecord { + /** 资料类型，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "personal_profile" custom_api_name = "profile_type" */ + profile_type?: string + /** 文件列表 */ + files?: ProfileSettingFile[] +} + +export interface ProfileSettingPhone { + /** 国际电话区号，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "phone" custom_api_name = "international_area_code" */ + international_area_code?: string + /** 电话号码 */ + phone_number?: string +} + +export interface ProfileSettingProbationInfo { + /** 试用期开始日期 */ + probation_start_date?: string + /** 试用期预计结束日期 */ + probation_expected_end_date?: string + /** 试用期实际结束日期 */ + actual_probation_end_date?: string +} + +export interface ProfileSettingResidentTax { + /** 年度 */ + year_resident_tax?: string + /** 国家 / 地区ID */ + tax_country_region?: string + /** 居民身份，枚举值。 可选项可通过【获取字段详情】接口查询，查询参数如下： object_api_name = "resident_tax" custom_api_name = "resident_status" */ + resident_status?: string + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface ProfileSettingWorkExperience { + /** 公司 / 组织 */ + company_organization?: ProfileSettingI18n + /** 部门 */ + department?: ProfileSettingI18n + /** 开始日期 */ + start_date?: string + /** 结束日期 */ + end_date?: string + /** 岗位 */ + job?: ProfileSettingI18n + /** 工作描述 */ + description?: ProfileSettingI18n + /** 自定义字段 */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface Property { + /** 自定义属性键对象 */ + key: string + /** 自定义属性值对象 */ + value: string +} + +export interface ProviderIdNameObject { + /** 供应商ID */ + provider_id?: string + /** 供应商名称信息 */ + provider_name?: I18n +} + +export interface PstnSipInfo { + /** 给pstn/sip用户设置的临时昵称 */ + nickname?: string + /** pstn/sip主机号 */ + main_address: string +} + +export interface PublicMailbox { + /** 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 PublicMailboxMember { + /** The unique ID of a member in this public mailbox */ + member_id?: string + /** 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 PunchMember { + /** 圈人方式：0 无 1全部 2自定义 */ + rule_scope_type?: number + /** 圈人规则列表 */ + scope_group_list?: ScopeGroup +} + +export interface PunchSpecialDateShift { + /** 打卡日期 */ + punch_day: number + /** 班次 ID */ + shift_id: string +} + +export interface PunchTimeRule { + /** 上班时间 */ + on_time: string + /** 下班时间 */ + off_time: string + /** 晚到多久记为迟到 */ + late_minutes_as_late: number + /** 晚到多久记为缺卡 */ + late_minutes_as_lack: number + /** 最早多久可打上班卡 */ + on_advance_minutes: number + /** 早退多久记为早退 */ + early_minutes_as_early: number + /** 早退多久记为缺卡 */ + early_minutes_as_lack: number + /** 最晚多久可打下班卡 */ + off_delay_minutes: number + /** 晚到多久记为严重迟到 */ + late_minutes_as_serious_late?: number + /** 不需要打上班卡 */ + no_need_on?: boolean + /** 不需要打下班卡（优先级比原有字段高） */ + no_need_off?: boolean +} + +export interface PunchTimeSimpleRule { + /** 上班时间 */ + on_time: string + /** 下班时间 */ + off_time: string +} + +export interface QualityAudio { + /** 时间 */ + time?: string + /** 麦克风采集音量 */ + mic_input_volume?: string + /** 扬声器播放音量 */ + speaker_volume?: string + /** 码率（接收） */ + bitrate_received?: string + /** 延迟（接收） */ + latency_received?: string + /** 抖动（接收） */ + jitter_received?: string + /** 码率（发送） */ + bitrate_sent?: string + /** 延迟（发送） */ + latency_sent?: string + /** 抖动（发送） */ + jitter_sent?: string +} + +export interface QualityCpuUsage { + /** 时间 */ + time?: string + /** 客户端平均 CPU 占用 */ + client_avg_cpu_usage?: string + /** 客户端最大 CPU 占用 */ + client_max_cpu_usage?: string + /** 系统平均 CPU 占用 */ + system_avg_cpu_usage?: string + /** 系统最大 CPU 占用 */ + system_max_cpu_usage?: string +} + +export interface QualityNetwork { + /** 时间 */ + time?: string + /** 网络延迟 */ + network_delay?: string + /** 码率（接收） */ + bitrate_received?: string + /** 丢包 - 平均（接收） */ + packet_loss_avg_received?: string + /** 丢包 - 最大（接收） */ + packet_loss_max_received?: string + /** 码率（发送） */ + bitrate_sent?: string + /** 丢包 - 平均（发送） */ + packet_loss_avg_sent?: string + /** 丢包 - 最大（发送） */ + packet_loss_max_sent?: string +} + +export interface QualityVideoSharing { + /** 时间 */ + time?: string + /** 码率（接收） */ + bitrate_received?: string + /** 延迟（接收） */ + latency_received?: string + /** 抖动（接收） */ + jitter_received?: string + /** 最大分辨率（接收） */ + maximum_resolution_received?: string + /** 帧率（接收） */ + framerate_received?: string + /** 码率（发送） */ + bitrate_sent?: string + /** 延迟（发送） */ + latency_sent?: string + /** 抖动（发送） */ + jitter_sent?: string + /** 最大分辨率（发送） */ + maximum_resolution_sent?: string + /** 帧率（发送） */ + framerate_sent?: string +} + +export interface Question { + /** 题目 ID */ + question_id?: string + /** 题目中文名称 */ + question_name?: string + /** 题目英文名称 */ + question_en_name?: string + /** 题目中文描述 */ + question_desc?: string + /** 题目英文描述 */ + question_en_desc?: string + /** 题目类型 */ + question_type?: 1 | 2 | 3 | 4 + /** 是否必填 */ + is_required?: boolean + /** 选项题回答列表（单选题及多选题） */ + select_option_result_list?: SelectOptionResult[] + /** 评分题回答 */ + five_start_scoring_result?: FiveStartScoringResult + /** 描述题回答 */ + description_result?: string +} + +export interface QuestionAssessment { + /** 所关联面试题的类型 */ + question_type?: 1 | 2 + /** 关联面试题的名称 */ + title?: I18n + /** 关联面试题的描述 */ + description?: I18n + /** 面试者作答内容 */ + content?: string + /** 能力项列表 */ + abilities?: Ability[] +} + +export interface Questionnaire { + /** 问卷 ID */ + questionnaire_id?: string + /** 投递 ID */ + application_id?: string + /** 面试 ID */ + interview_id?: string + /** 问卷版本 */ + version?: number + /** 题目列表 */ + questions?: Question[] + /** 是否完成作答 */ + has_answers?: boolean + /** 更新时间 */ + update_time?: string +} + +export type QuoteContainer = unknown + +export interface RangeFilter { + /** 起始值 */ + from?: string + /** 终止值 */ + to?: string +} + +export interface Rating { + /** 评分字段的符号展示 */ + symbol?: string +} + +export interface ReactionList { + /** 表情类型 */ + type?: string + /** 回复该表情的人数 */ + count?: number +} + +export interface ReactionSet { + /** 表情列表 */ + reactions?: ReactionList[] + /** 全部表情计数 */ + total_count?: number +} + +export interface ReadUser { + /** 用户id类型 */ + user_id_type: string + /** 用户id */ + user_id: string + /** 阅读时间 */ + timestamp: string + /** tenant key */ + tenant_key?: string +} + +export interface RecognizedEntities { + /** 识别的实体列表 */ + entities?: RecognizedEntity[] +} + +export interface RecognizedEntity { + /** 识别的字段种类 */ + type?: 'contact_names' | 'company_names' | 'departments' | 'job_titles' | 'emails' | 'websites' | 'addresses' | 'mobile_phones' | 'work_phones' | 'other_phones' | 'faxes' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface RecommendedJobLevel { + /** 最低职级建议 */ + lower_limit_job_level_name?: I18n + /** 最低职级建议 */ + higher_limit_job_level_name?: I18n +} + +export interface RecordGroupByItem { + /** 字段唯一标识 */ + field: string +} + +export interface RecordingPermissionObject { + /** 授权对象ID */ + id?: string + /** 授权对象类型 */ + type: 1 | 2 | 3 | 4 + /** 授予权限 */ + permission: 1 +} + +export interface RecordResult { + /** 是否成功 */ + success: boolean + /** 记录 ID */ + id?: string + /** 权限错误时的细分 code */ + errors?: RecordResultError[] +} + +export interface RecordResultError { + /** 错误码 */ + code: string + /** success */ + message: string + /** 权限错误时的细分 code */ + sub_code?: string + /** 权限错误时的涉及的字段 APIID 集合 */ + fields?: string[] +} + +export interface RecordScore { + /** 分数，即面试评价得分，精确到小数点后两位 */ + score?: number + /** 满分，即面试评价的总分 */ + total_score?: number +} + +export interface ReferenceObject { + /** cpst_item(项目)、 cpst_indicator(指标) */ + api_name?: 'cpst_item' | 'cpst_indicator' + /** 值列表 例如部门ID */ + id?: string +} + +export interface ReferEntity { + /** 快捷方式指向的文档token */ + refer_token: string + /** 快捷方式指向的文档类型 */ + refer_type: 'file' | 'docx' | 'bitable' | 'doc' | 'sheet' | 'mindnote' | 'slides' +} + +export interface Referer { + /** 数据 id */ + id: string + /** 标题 */ + title?: string +} + +export interface Referral { + /** 内推的 ID */ + id: string + /** 投递 ID */ + application_id: string + /** 创建时间（ms） */ + create_time: number + /** 内推人的 ID */ + referral_user_id: string + /** 内推人信息 */ + referral_user?: IdNameObject +} + +export interface ReferralBasicInfo { + /** 内推 ID */ + id?: string + /** 投递 ID */ + application_id?: string + /** 内推类型 */ + referral_type?: 1 | 2 + /** 内推人信息 */ + user_info?: BasicUserInfo + /** 内推创建时间戳（单位：毫秒） */ + create_time?: string + /** 内推方法 */ + referral_method?: 1 | 2 | 3 | 4 | 5 +} + +export interface ReferralInfo { + /** 内推的 ID */ + id?: string + /** 投递 ID 列表,包含：原始内推的投递 ID、转移到其他职位后的投递 ID、不包含被HR复捞(加入职位）的投递 ID，第一个投递就是原始投递ID */ + application_ids?: string[] + /** 创建时间（ms） */ + create_time?: string + /** 内推人信息 */ + referral_user?: IdNameObject +} + +export interface ReferralInfoV2 { + /** 内推基本信息 */ + basic_info?: ReferralBasicInfo + /** 内推关联推荐信息 */ + recommend_info?: ReferralRecommendInfo +} + +export interface ReferralRecommendInfo { + /** 与内推人关系 */ + relationship?: 0 | 1 + /** 熟悉程度 */ + familiarity?: 0 | 1 + /** 推荐语 */ + comment?: string + /** 特殊关系 */ + specific_relationship?: SpecificRelationship + /** 工作能力熟悉程度 */ + work_ability_familiarity?: 1 | 2 | 3 | 4 + /** 匹配度 */ + match_degree?: 1 | 2 | 3 | 4 +} + +export interface RegionPlace { + /** 地理等级（国家｜省｜市｜区） */ + region_level?: string + /** 地理id */ + region_id?: string +} + +export interface RegistrationBasicInfo { + /** ID */ + id?: string + /** 创建时间 */ + registration_time?: number + /** 下载链接 */ + download_url?: string + /** 登记表场景 */ + scenario?: 5 | 6 | 14 +} + +export interface RegistrationInfo { + /** 面试登记表ID */ + schema_id?: string + /** 面试登记表名称 */ + name?: string +} + +export interface RegistrationSchema { + /** 信息登记表模板 ID */ + id?: string + /** 信息登记表模板名称 */ + name?: string + /** 登记表适用场景 */ + scenarios?: 5 | 6 | 14[] + /** 模块列表 */ + objects?: CommonSchema[] +} + +export interface RegistrationSchemaInfo { + /** 信息登记表ID */ + schema_id?: string + /** 信息登记表名称 */ + name?: string +} + +export interface RelatedMeta { + /** 关联用户信息 */ + users?: Referer[] + /** 关联群组信息 */ + chats?: Referer[] + /** 关联文档信息 */ + docs?: Referer[] + /** 关联值班者信息 */ + oncalls?: Referer[] + /** 关联链接信息 */ + links?: Referer[] + /** 相关词条信息 */ + abbreviations?: Abbreviation[] + /** 所属分类信息（不支持传入一级分类。词条不可同时属于同一个一级分类下的多个二级分类，一级分类下的二级分类互斥） */ + classifications?: Classification[] + /** 上传的相关图片 */ + images?: BaikeImage[] +} + +export interface Reminder { + /** 创建者用户 ID */ + create_user_id: string + /** 是否通知 */ + is_notify?: boolean + /** 是日期还是整点小时 */ + is_whole_day?: boolean + /** 事件发生的时间（毫秒级事件戳） */ + expire_time: string + /** 触发通知的时间（毫秒级时间戳） */ + notify_time: string + /** 文本局部样式 */ + text_element_style?: TextElementStyle +} + +export interface ReorganizationInfo { + /** 原部门名称 */ + original_department_names?: I18n[] + /** 调整后部门名称 */ + target_department_names?: I18n[] + /** 原部门编码 */ + original_department_code?: string + /** 调整后部门编码 */ + target_department_code?: string + /** 原部门类型，枚举值可通过文档【飞书人事枚举常量】部门子类型（department_sub_type）枚举定义部分获得 */ + original_sub_type?: Enum + /** 调整后部门类型，枚举值可通过文档【飞书人事枚举常量】部门子类型（department_sub_type）枚举定义部分获得 */ + target_sub_type?: Enum + /** 原部门负责人 */ + original_department_manager?: string + /** 调整后部门负责人 */ + target_department_manager?: string + /** 原描述 */ + original_descriptions?: I18n[] + /** 调整后描述 */ + target_descriptions?: I18n[] + /** 原默认成本中心 */ + original_cost_center?: CostCenter + /** 调整后默认成本中心 */ + target_cost_center?: CostCenter + /** 原是否保密 */ + original_is_confidential?: boolean + /** 调整后是否保密 */ + target_is_confidential?: boolean + /** 原岗职模式 */ + original_staffing_mode_option?: Enum + /** 调整后岗职模式 */ + target_staffing_mode_option?: Enum + /** 原上级部门 */ + original_parent_department_id?: string + /** 调整后上级部门 */ + target_parent_department_id?: string + /** 调整后上级部门 ID ，调整审批未生效前会返回格式为 td_xxx 的临时 ID */ + draft_target_parent_department_id?: string + /** 原部门全路径 */ + original_department_id_path?: OrgdraftDepartmentId[] + /** 调整后部门全路径 */ + target_department_id_path?: OrgdraftDepartmentId[] + /** 自定义字段 */ + custom_fields?: ChangeFieldPair[] +} + +export interface ReplaceFileRequest { + /** 附件 token */ + token: string +} + +export interface ReplaceImageRequest { + /** 图片 token */ + token: string + /** 图片宽度，单位 px */ + width?: number + /** 图片高度，单位 px */ + height?: number + /** 对齐方式 */ + align?: 1 | 2 | 3 +} + +export interface ReplyContent { + /** 回复内容的元素列表 */ + elements: ReplyElement[] +} + +export interface ReplyElement { + /** 回复内容的元素类型 */ + type: 'text_run' | 'docs_link' | 'person' + /** 文本内容 */ + text_run?: TextRun + /** 云文档链接 */ + docs_link?: DocsLink + /** 联系人 */ + person?: Person +} + +export interface ReplyExtra { + image_list?: string[] +} + +export interface ReplyList { + /** 回复列表 */ + replies: FileCommentReply[] +} + +export interface Repo { + /** 词库 id */ + id: string + /** 词库名 */ + name: string +} + +export interface Report { + /** 总会议数量 */ + total_meeting_count?: string + /** 总会议时长（单位sec） */ + total_meeting_duration?: string + /** 总参会人数 */ + total_participant_count?: string + /** 每日会议报告列表 */ + daily_report?: ReportMeetingDaily[] +} + +export interface ReportCustomData { + /** 名称 */ + name?: I18n + /** 值 */ + value?: I18n + /** 描述 */ + description?: I18n +} + +export interface ReportMeetingDaily { + /** 日期（unix时间，单位sec） */ + date?: string + /** 会议数量 */ + meeting_count?: string + /** 会议时长（单位sec） */ + meeting_duration?: string + /** 参会人数 */ + participant_count?: string +} + +export interface ReportTopUser { + /** 用户ID */ + id?: string + /** 用户名 */ + name?: string + /** 用户类型 */ + user_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 会议数量 */ + meeting_count?: string + /** 会议时长（单位sec） */ + meeting_duration?: string +} + +export interface ReqTable { + /** 数据表 名字 */ + name?: string + /** 默认表格视图的名称 */ + default_view_name?: string + /** 允许设置数据表的初始字段,默认第一个字段为索引列 */ + fields?: AppTableCreateHeader[] +} + +export interface RequestDoc { + /** 文件的 token，获取方式见[概述](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction) */ + doc_token: string + /** 文件类型 */ + doc_type: 'doc' | 'sheet' | 'bitable' | 'mindnote' | 'file' | 'wiki' | 'docx' | 'folder' | 'synced_block' | 'slides' +} + +export interface Reserve { + /** 预约ID */ + id?: string + /** 9位会议号 */ + meeting_no?: string + /** 会议密码 */ + password?: string + /** 会议链接 */ + url?: string + /** APPLink用于唤起飞书APP入会。"{?}"为占位符，用于配置入会参数，使用时需替换具体值：0表示关闭，1表示打开。preview为入会前的设置页，mic为麦克风，speaker为扬声器，camera为摄像头 */ + app_link?: string + /** 直播链接 */ + live_link?: string + /** 预约到期时间（unix时间，单位sec） */ + end_time?: string +} + +export interface ReserveActionPermission { + /** 权限项 */ + permission: 1 | 2 | 3 + /** 权限检查器列表，权限检查器之间为"逻辑或"的关系（即 有一个为true则拥有该权限） */ + permission_checkers: ReservePermissionChecker[] +} + +export interface ReserveAdminConfig { + /** 预定管理部门 */ + depts?: SubscribeDepartment[] + /** 预定管理用户 */ + users?: SubscribeUser[] +} + +export interface ReserveAssignHost { + /** 用户类型，仅支持设置同租户下的 Lark 用户 */ + user_type?: 1 + /** 用户ID */ + id?: string +} + +export interface ReserveCallee { + /** 用户ID */ + id?: string + /** 用户类型 */ + user_type: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** pstn/sip信息 */ + pstn_sip_info?: PstnSipInfo +} + +export interface ReserveCallSetting { + /** 被呼叫的用户 */ + callee: ReserveCallee +} + +export interface ReserveCorrectionCheckInfo { + /** 指定主持人无效id列表 */ + invalid_host_id_list?: string[] +} + +export interface ReservedRoom { + /** 会议室ID */ + room_id?: string + /** 会议室名称 */ + room_name?: string +} + +export interface ReserveFormConfig { + /** 是否覆盖子层级及会议室 */ + if_cover_child_scope?: boolean + /** 预定表单开关 */ + reserve_form: boolean + /** 通知人列表 */ + notified_users?: SubscribeUser[] + /** 最晚于会议开始前 notified_time收到通知(单位:分/时/天) */ + notified_time?: number + /** 时间单位,1为分钟;2为小时;3为天，默认为天 */ + time_unit?: number +} + +export interface ReserveMeetingSetting { + /** 会议主题 */ + topic?: string + /** 会议权限配置列表，如果存在相同的权限配置项则它们之间为"逻辑或"的关系（即 有一个为true则拥有该权限） */ + action_permissions?: ReserveActionPermission[] + /** 会议初始类型 */ + meeting_initial_type?: 1 | 2 + /** 该会议是否支持互通，不支持更新（注：该字段内测中） */ + meeting_connect?: boolean + /** 1v1呼叫相关参数 */ + call_setting?: ReserveCallSetting + /** 使用飞书视频会议时，是否开启自动录制，默认false */ + auto_record?: boolean + /** 指定主持人列表 */ + assign_host_list?: ReserveAssignHost[] + /** 设置会议密码，仅支持 4-9 位数字 */ + password?: string +} + +export interface ReservePermissionChecker { + /** 检查字段类型 */ + check_field: 1 | 2 | 3 + /** 检查方式 */ + check_mode: 1 | 2 + /** 检查字段列表 */ + check_list: string[] +} + +export interface ReserveScopeConfig { + /** 是否覆盖子层级及会议室 */ + if_cover_child_scope?: boolean + /** 可预定成员范围，0部分成员，1全部成员 */ + allow_all_users?: number + /** 可预定成员列表 */ + allow_users?: SubscribeUser[] + /** 可预定部门列表 */ + allow_depts?: SubscribeDepartment[] +} + +export interface ResidentTax { + /** 年度 */ + year_resident_tax: string + /** -| 居民身份，枚举值 api_name 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "resident_tax" - custom_api_name = "resident_status" */ + resident_status?: Enum + /** 国家/地区，可通过【查询国家/地区信息】 接口查询 */ + tax_country_region_id?: string + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface ResidentTaxForUpdate { + /** 国家 / 地区ID */ + tax_country_region?: string + /** 居民身份 */ + resident_status?: string + /** 纳税地址 */ + tax_address?: AddressForUpdate + /** 居民纳税身份说明 */ + resident_status_specification?: string + /** 年度 */ + year_resident_tax?: string +} + +export interface ResourceAcceptor { + /** 资源处理类型 */ + processing_type: '1' | '2' | '3' + /** 转移资源时，资源接收者 */ + acceptor_user_id?: string +} + +export interface RestrictedModeSetting { + /** 防泄密模式是否开启 */ + status?: boolean + /** 允许截屏录屏 */ + screenshot_has_permission_setting?: 'all_members' | 'not_anyone' + /** 允许下载消息中图片、视频和文件 */ + download_has_permission_setting?: 'all_members' | 'not_anyone' + /** 允许复制和转发消息 */ + message_has_permission_setting?: 'all_members' | 'not_anyone' +} + +export interface RestRule { + /** 休息开始 */ + rest_begin_time: string + /** 休息结束 */ + rest_end_time: string +} + +export interface RestTimeFlexibleConfig { + /** 是否开启休息弹性班次 */ + need_flexible?: boolean + /** 休息弹性向后弹的分钟数 */ + late_mins?: number +} + +export interface Resume { + /** 文件标识ID，依据文件内容自动生成 */ + file_md5?: string + /** 文本内容，当接口返回成功时，该字段才存在 */ + content?: string + /** 经过排序后的文本内容，当接口返回成功时，该字段才存在 */ + new_content?: string + /** 名称 */ + name?: string + /** 邮箱 */ + email?: string + /** 手机号码 */ + mobile?: string + /** 手机号码是否虚拟号码 */ + mobile_is_virtual?: boolean + /** 手机号码国家编码 */ + country_code?: string + /** 教育经历 */ + educations?: ResumeEducation[] + /** 职业经历 */ + careers?: ResumeCareer[] + /** 项目经历 */ + projects?: ResumeProject[] + /** 工作年限，为空表示工作年限未知，数字单位为年，整数 */ + work_year?: number + /** 生日，格式YYYY-MM-DD */ + date_of_birth?: string + /** 性别 */ + gender?: 0 | 1 | 2 + /** 希望获得的职位列表 */ + willing_positions?: string[] + /** 当前工作地点(城市) */ + current_location?: string + /** 希望工作地点列表 */ + willing_locations?: string[] + /** 家乡(城市) */ + home_location?: string + /** 语言 */ + languages?: ResumeLanguage[] + /** 获奖 */ + awards?: ResumeAward[] + /** 证书 */ + certificates?: ResumeCertificate[] + /** 竞赛 */ + competitions?: ResumeCompetition[] + /** 自我评价 */ + self_evaluation?: string + /** 链接列表 */ + urls?: string[] + /** 社交链接 */ + social_links?: string[] +} + +export interface ResumeAward { + /** 奖项 */ + award?: string + /** 获奖时间，格式：YYYY */ + date?: string + /** 描述 */ + description?: string +} + +export interface ResumeCareer { + /** 公司名称 */ + company?: string + /** 开始时间,格式：YYYY-MM-DD */ + start_date?: string + /** 始时间,格式：YYYY-MM-DD,跟start_date值一样 */ + start_time?: string + /** 结束时间,格式：YYYY-MM-DD */ + end_date?: string + /** 结束时间,格式：YYYY-MM-DD 或 “至今”，当值为“至今”时，end_date=="",值为其他时，end_date==end_time */ + end_time?: string + /** 职位 */ + title?: string + /** 工作类型 */ + type?: 1 | 2 + /** 工作类型——'实习'、'全职' */ + type_str?: string + /** 工作描述 */ + job_description?: string +} + +export interface ResumeCertificate { + /** 证书名称 */ + name?: string + /** 描述 */ + desc?: string +} + +export interface ResumeCompetition { + /** 竞赛名称 */ + name?: string + /** 描述 */ + desc?: string +} + +export interface ResumeEducation { + /** 学校名称 */ + school?: string + /** 开始时间,格式：YYYY-MM-DD */ + start_date?: string + /** 开始时间,格式：YYYY-MM-DD,跟start_date值一样 */ + start_time?: string + /** 结束时间,格式：YYYY-MM-DD */ + end_date?: string + /** 结束时间,格式：YYYY-MM-DD 或 “至今”，当值为“至今”时，end_date=="",值为其他时，end_date==end_time */ + end_time?: string + /** 专业 */ + major?: string + /** 学历——小学、初中、中职、高中、专科、本科、硕士、博士、其他 */ + degree?: string + /** 学历对应ID */ + qualification?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 +} + +export interface ResumeLanguage { + /** 语言等级 */ + level?: number + /** 语言描述 */ + description?: string +} + +export interface ResumeProject { + /** 项目名称 */ + name?: string + /** 项目岗位 */ + title?: string + /** 开始时间,格式：YYYY-MM-DD */ + start_date?: string + /** 开始时间,格式：YYYY-MM-DD,跟start_date值一样 */ + start_time?: string + /** 结束时间,格式：YYYY-MM-DD */ + end_date?: string + /** 结束时间,格式：YYYY-MM-DD 或 “至今”，当值为“至今”时，end_date=="",值 */ + end_time?: string + /** 项目描述 */ + description?: string +} + +export interface ResumeSource { + /** 来源id */ + id?: string + /** 中文名 */ + zh_name?: string + /** 英文名 */ + en_name?: string + /** 启用状态 */ + active_status?: 1 | 2 + /** 来源类型 */ + resume_source_type?: string +} + +export interface ReviewDetail { + /** 评估模板 ID */ + template_id?: string + /** 评估内容 ID */ + unit_id?: string + /** 评估控件 ID */ + field_id?: string + /** 评估人 ID */ + reviewer_user_id?: User + /** 最后提交时间 */ + submit_time?: string + /** 评估项 ID */ + indicator_id?: string + /** 评估项结果等级 ID */ + option_id?: string + /** 评分型评估项填写内容 */ + score?: string + /** 填写项填写内容 */ + text?: string + /** 绩效系数值 */ + perf_coefficient_result?: string + /** 富文本格式的填写内容，解析方式见 [editor](https://open.larkoffice.com/document/client-docs/gadget/component-component/basic-component/form/editor#51af2f4f) */ + richtext?: string +} + +export interface Reviewee { + /** 被评估人 ID */ + reviewee_user_id?: User + /** 被评估人参与的项目 */ + activity_ids?: string[] + /** 被评估人在该周期的个人绩效详情页链接。如果参与的项目未启动则为空 */ + reviewprofile_url?: string +} + +export interface RevieweeMetric { + /** 被评估人 */ + reviewee_user_id?: User + /** 被评估人在该周期所属的指标模板 ID */ + metric_template_id?: string + /** 被评估人在周期下的指标明细数据 */ + metric_details?: MetricDetail +} + +export interface ReviewProfile { + /** 被评估人 ID */ + user_id?: User + /** 绩效评估周期 ID */ + semester_id?: string + /** 绩效评估项目 ID */ + activity_id?: string + /** 本周期内各环节内容 */ + stages?: ReviewStage[] +} + +export interface ReviewStage { + /** 环节类型 */ + stage_type?: string + /** 环节状态 */ + progress?: 0 | 1 | 2 | 3 | 4 + /** 环节填写内容 */ + data?: ReviewDetail[] +} + +export interface ReviewTemplate { + /** 环节模板列表 */ + templates?: Template[] + /** 评估内容列表 */ + units?: Unit[] + /** 评估模板 ID */ + review_template_id?: string + /** 评估模板名称 */ + name?: I18n + /** 评估模板描述 */ + description?: I18n + /** 状态 */ + status?: string +} + +export interface Richtext { + /** 内容 */ + content?: string + /** 类型 */ + type?: string +} + +export interface Role { + /** 角色 ID */ + id?: string + /** 角色名称 */ + name?: I18n + /** 角色描述 */ + description?: I18n + /** 适用范围 */ + scope_of_application?: 1 | 2 | 3 + /** 更新时间 */ + modify_time?: string + /** 停启用状态 */ + role_status?: 1 | 2 + /** 角色类型 */ + role_type?: 1 | 2 | 5 +} + +export interface RoleAuthorization { + /** 雇员 ID */ + employment_id: string + /** 授权列表 */ + permission_detail_list: PermissionDetail[] +} + +export interface RoleDetail { + /** 角色ID */ + id?: string + /** 角色名称 */ + name?: I18n + /** 角色描述 */ + description?: I18n + /** 更新时间 */ + modify_time?: string + /** 停启用状态 */ + role_status?: 1 | 2 + /** 角色类型 */ + role_type?: 1 | 2 | 5 + /** 适用范围 */ + scope_of_application?: 1 | 2 | 3 + /** 是否在角色上配置业务管理范围 */ + has_business_management_scope?: boolean + /** 社招权限配置 */ + socail_permission_collection?: PermissionCollection + /** 校招权限配置 */ + campus_permission_collection?: PermissionCollection +} + +export interface RoleMember { + /** 角色唯一 ID，系统自动生成 */ + role_api_id?: string + /** 角色 API 名称 */ + role_api_name?: string + /** 授权用户 ID 列表 */ + users?: string[] + /** 授权部门 ID 列表 */ + departments?: string[] + /** 自定义授权用户规则 */ + user_filter?: Criterion + /** 授权用户姓名列表，入参 need_display_name = true时返回 */ + user_display_infos?: PermissionNameInfo[] + /** 授权部门名称列表，入参 need_display_name = true时返回 */ + department_display_infos?: PermissionNameInfo[] + /** 角色成员模式 */ + type?: 'all' | 'custom' + /** 更新人 ID */ + updated_by?: string + /** 更新时间 */ + updated_at?: number +} + +export interface Room { + /** 会议室ID */ + room_id?: string + /** 会议室名称 */ + name?: string + /** 会议室能容纳的人数 */ + capacity?: number + /** 会议室的相关描述 */ + description?: string + /** 会议室的展示ID */ + display_id?: string + /** 自定义的会议室ID */ + custom_room_id?: string + /** 层级ID */ + room_level_id?: string + /** 层级路径 */ + path?: string[] + /** 会议室状态 */ + room_status?: RoomStatus + /** 设施信息列表 */ + device?: Device[] +} + +export interface RoomConfig { + /** 飞书会议室背景图 */ + room_background?: string + /** 飞书签到板背景图 */ + display_background?: string + /** 飞书会议室数字标牌 */ + digital_signage?: RoomDigitalSignage + /** 飞书投屏盒子数字标牌 */ + room_box_digital_signage?: RoomDigitalSignage + /** 会议室状态 */ + room_status?: RoomStatus +} + +export interface RoomDigitalSignage { + /** 是否覆盖子层级及会议室 */ + if_cover_child_scope?: boolean + /** 是否开启数字标牌功能 */ + enable?: boolean + /** 是否静音播放 */ + mute?: boolean + /** 日程会议开始前n分钟结束播放 */ + start_display?: number + /** 会议结束后n分钟开始播放 */ + stop_display?: number + /** 素材列表 */ + materials?: RoomDigitalSignageMaterial[] +} + +export interface RoomDigitalSignageMaterial { + /** 素材ID */ + id?: string + /** 素材名称 */ + name?: string + /** 素材类型 */ + material_type?: 1 | 2 | 3 + /** 素材url */ + url?: string + /** 播放时长（单位sec） */ + duration?: number + /** 素材封面url */ + cover?: string + /** 素材文件md5 */ + md5?: string + /** 素材文件vid */ + vid?: string + /** 素材文件大小（单位byte） */ + size?: string +} + +export interface RoomLevel { + /** 层级ID */ + room_level_id?: string + /** 层级名称 */ + name?: string + /** 父层级ID */ + parent_id?: string + /** 层级路径 */ + path?: string[] + /** 是否有子层级 */ + has_child?: boolean + /** 自定义层级id */ + custom_group_id?: string +} + +export interface RoomMeetingReservation { + /** 会议室ID */ + room_id?: string + /** 会议室名称 */ + room_name?: string + /** 会议标题 */ + event_title?: string + /** 预定人 */ + reserver?: string + /** 预定人ID */ + reserver_user_id?: string + /** 预定人所属部门 */ + department_of_reserver?: string + /** 邀约人数 */ + guests_number?: string + /** 接受人数 */ + accepted_number?: string + /** 会议开始时间 */ + event_start_time?: string + /** 会议结束时间 */ + event_end_time?: string + /** 会议时长 */ + event_duration?: string + /** 会议室预定状态 */ + reservation_status?: string + /** 签到设备 */ + check_in_device?: string + /** 会议室签到状态 */ + room_check_in_status?: string + /** 会议室签到时间 */ + check_in_time?: string + /** 是否提前释放 */ + is_release_early?: string + /** 释放人 */ + releasing_person?: string + /** 释放时间 */ + releasing_time?: string +} + +export interface RoomStatus { + /** 是否启用会议室 */ + status: boolean + /** 会议室未来状态为启用或禁用 */ + schedule_status?: boolean + /** 禁用开始时间（unix时间，单位sec） */ + disable_start_time?: string + /** 禁用结束时间（unix时间，单位sec，数值0表示永久禁用） */ + disable_end_time?: string + /** 禁用原因 */ + disable_reason?: string + /** 联系人列表，id类型由user_id_type参数决定 */ + contact_ids?: string[] + /** 是否在禁用时发送通知给预定了该会议室的员工 */ + disable_notice?: boolean + /** 是否在恢复启用时发送通知给预定了该会议室的员工 */ + resume_notice?: boolean +} + +export interface Rule { + /** 权限组id */ + id?: string + /** 权限组名称 */ + name?: string + /** 权限组包含的设备 */ + devices?: DeviceExternal[] + /** 权限组包含的员工个数 */ + user_count?: string + /** 权限组包含的员工列表 */ + users?: UserExternal[] + /** 权限组包含的访客个数 */ + visitor_count?: string + /** 权限组包含的访客列表 */ + visitors?: UserExternal[] + /** 是否通知人员录入 */ + remind_face?: boolean + /** 开门时间段 */ + opening_time?: OpeningTimeExternal + /** 是否为临时权限组 */ + is_temp?: boolean +} + +export interface RuleDetail { + /** 开始生效的时间戳。1.手动设置有效期类型勋章，配置有效期限需要配置该字段；2.时间戳必须是所在时区当天的零点时间戳，如时区为Asia/Shanghai时区时的1649606400 */ + effective_time?: string + /** 结束生效的时间戳。1.手动设置有效期类型勋章，配置有效期限需要配置该字段；2.最大值：不得超过effective_time+100 年；3.非永久有效：时间戳必须是所在时区当天的23:59:59时间戳，如时区为Asia/Shanghai时区时的1649692799；4.永久有效：传值为0即可 */ + expiration_time?: string + /** 入职周年日。根据入职时间发放类型勋章，需要配置该字段。 */ + anniversary?: number + /** 有效期限。根据入职时间发放类型勋章，需要配置该字段。 */ + effective_period?: 1 | 2 +} + +export interface RuleDimension { + /** 维度的key */ + entity_key?: string + /** 维度名称 */ + entity_name?: Name +} + +export interface Run { + /** 运行 ID */ + id: string + /** 运行的创建时间，毫秒时间戳 */ + created_at: string + /** 应用 ID */ + app_id: string + /** 会话 ID */ + session_id: string + /** 状态 */ + status: RunStatus + /** 开始时间，毫秒时间戳 */ + started_at?: string + /** 结束时间，毫秒时间戳 */ + ended_at?: string + /** 失败时的错误信息 */ + error?: RunError + /** 其他透传信息 */ + metadata?: string +} + +export interface RunError { + /** 错误码 */ + code: string + /** 错误信息 */ + message: string +} + +export type RunStatus = 'QUEUED' | 'IN_PROGRESS' | 'REQUIRES_MESSAGE' | 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'EXPIRED' + +export interface Schema { + /** UI项名称 TODO文档 */ + ui_name?: string + /** UI项自定义状态 */ + ui_status?: 'hide' | 'readonly' | 'editable' | 'unknown' + /** 按钮点击后跳转的链接 */ + app_link?: string +} + +export interface SchemaDisplay { + /** 搜索数据的展示卡片 */ + card_key: 'search_common_card' + /** 数据字段名称和展示字段名称的映射关系。如果没有设置，则只会展示 与展示字段名称同名的 数据字段 */ + fields_mapping?: SchemaDisplayFieldMapping[] +} + +export interface SchemaDisplayFieldMapping { + /** 展示字段名称，与 card_key 有关，每个模版能展示的字段不同。该字段不能重复 */ + display_field: string + /** 数据字段的名称。需要确保该字段对应在 schema 属性定义中的 is_returnable 为 true，否则无法展示。需要使用 ${xxx} 的规则来描述 */ + data_field: string +} + +export interface SchemaFieldAnswerOption { + /** 是否用于搜索 */ + is_searchable?: boolean + /** 是否用于返回 */ + is_returnable?: boolean +} + +export interface SchemaFilterOptions { + /** 筛选器展示名称 */ + display_name: string + /** 筛选器展示名称国际化字段 */ + i18n_display_name?: I18nMeta + /** 指明该筛选器支持单选或多选，默认单选 */ + option_mode?: 'single' | 'multiple' + /** 关联的综合筛选器。只有 filter_type 为"user"和"time"时可以关联。"user" -> "from"；"time" -> "date"。 */ + associated_smart_filter?: 'from' | 'date' + /** 筛选器类型 */ + filter_type?: 'user' | 'time' | 'searchable' | 'predefine_enum' + /** 预定义的展示枚举值。在 filter_type 为 "predefine_enum" 时必须填写 */ + predefine_enum_values?: SchemaPredefineEnumStruct[] + /** 是否开启客户端筛选器 */ + enable_client_filter?: boolean + /** 可搜筛选器关联的数据源标识 */ + reference_datasource_id?: string +} + +export interface SchemaPredefineEnumStruct { + /** 枚举值的标识。在多枚举值定义中保持唯一 */ + name: string + /** 枚举值展示文案 */ + text: string +} + +export interface SchemaProperty { + /** 属性名 */ + name: string + /** 属性类型 */ + type: 'text' | 'int' | 'tag' | 'timestamp' | 'double' | 'tinytext' | 'user_ids' + /** 该属性是否可用作搜索，默认为 false */ + is_searchable?: boolean + /** 该属性是否可用作搜索结果排序，默认为 false。如果为 true，需要再配置 sortOptions */ + is_sortable?: boolean + /** 该属性是否可用作返回字段，为 false 时，该字段不会被召回和展示。默认为 false */ + is_returnable?: boolean + /** 属性排序的可选配置，当 is_sortable 为 true 时，该字段为必填字段 */ + sort_options?: SchemaSortOptions + /** 相关类型数据的定义和约束 */ + type_definitions?: SchemaTypeDefinitions + /** 属性搜索的可选配置，当 is_searchable 为 true 时，该字段为必填参数 */ + search_options?: SchemaSearchOptions + /** 该属性是否可用作返回字段，为 false 时，该字段不会被筛选。默认为 false */ + is_filterable?: boolean + /** 属性筛选的可选配置，当 is_searchable 为 true 时，该字段为必填参数 */ + filter_options?: SchemaFilterOptions + /** 问答产品设置，仅在datasource中enable_answer为true时生效 */ + answer_option?: SchemaFieldAnswerOption + /** 字段描述 */ + desc?: string +} + +export interface SchemaSearchOptions { + /** 是否支持语义切词召回。默认不支持（推荐使用在长文本的场景） */ + enable_semantic_match?: boolean + /** 是否支持精确匹配。默认不支持（推荐使用在短文本、需要精确查找的场景） */ + enable_exact_match?: boolean + /** 是否支持前缀匹配（短文本的默认的分词/召回策略。前缀长度为 1-12） */ + enable_prefix_match?: boolean + /** 是否支持数据后缀匹配。默认不支持（推荐使用在短文本、有数字后缀查找的场景。后缀长度为3-12） */ + enable_number_suffix_match?: boolean + /** 是否支持驼峰英文匹配。默认不支持（推荐使用在短文本，且包含驼峰形式英文的查找场景） */ + enable_camel_match?: boolean +} + +export interface SchemaSortOptions { + /** 排序的优先级，可选范围为 0~4，0为最高优先级。如果优先级相同，则随机进行排序。默认为0 */ + priority?: 0 | 1 | 2 | 3 | 4 + /** 排序的顺序。默认为 desc */ + order?: 'asc' | 'desc' +} + +export interface SchemaTagOptions { + /** tag 对应的枚举值名称 */ + name: string + /** 标签对应的颜色 */ + color: 'red' | 'green' | 'blue' | 'grey' | 'yellow' + /** 标签中展示的文本 */ + text: string +} + +export interface SchemaTypeDefinitions { + /** 标签类型的定义 */ + tag?: SchemaTagOptions[] + /** 用户身份标识 */ + user_ids?: SchemaUserIdsOption +} + +export interface SchemaUserIdsOption { + /** 用户身份类型 */ + id_type: 'open_id' | 'union_id' | 'user_id' +} + +export interface Scope { + /** 权限名称，形如 user.phone:readonly */ + scope_name: string + /** 租户应用权限授予状态 */ + grant_status: 1 | 2 + /** 权限的身份类型，形如 user(用户身份)、tenant(应用身份) */ + scope_type?: 'tenant' | 'user' +} + +export interface ScopeConfig { + /** 查询节点范围 */ + scope_type: 1 | 2 + /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */ + scope_id: string + /** 节点配置 */ + scope_config?: RoomConfig +} + +export interface ScopeGroup { + /** 类型： 1: 部门 2：人员 3:国家地区 4:员工类型 5:工作城市 6:职级 7:序列 8:职务（企业版）9:工时制度（企业版） 100:自定义字段（企业版） */ + scope_value_type?: number + /** 范围类型（是否包含） */ + operation_type?: number + /** 如果是人员/部门类型 不需要使用该字段 */ + right?: ScopeValue[] + /** 部门/人员id列表（具体类型根据scope_value_type判断） */ + member_ids?: string[] + /** 企业版自定义字段唯一键 ID, 需要从飞书人事那边获取 */ + custom_field_ID?: string + /** 企业版自定义字段对象类型 "employment":主数据对象，员工雇佣信息 , "person":主数据对象，个人 */ + custom_field_obj_type?: string +} + +export interface ScopeValue { + /** 标识Key */ + key?: string + /** 名称 */ + name?: string +} + +export interface ScoreCalculationConfig { + /** 是否启用 */ + enabled?: boolean + calculation_mode?: 1 | 2 +} + +export interface ScoreDimensionConfig { + /** 分数维度类型 */ + score_dimension_type?: 1 | 2 + /** 分数下限 */ + lower_limit_score?: number + /** 分数上限 */ + upper_limit_score?: number +} + +export interface SearchObjectParam { + /** 对象 APIName */ + api_name?: string + /** 搜索字段 SearchFields 列表 */ + search_fields?: string[] + /** 召回字段 APIID/APIName 列表 */ + select?: string[] + /** 过滤条件，序列化的结果{"filter": "「标准Criterion」"} */ + filter?: Criterion + /** 排序条件 */ + order_by?: OrderCondition +} + +export interface Section { + /** 分区标题 */ + title?: string +} + +export interface SectionSummary { + /** 自定义分组的全局唯一ID */ + guid?: string + /** 自定义分组的名称 */ + name?: string + /** 是否是默认分组 */ + is_default?: boolean +} + +export interface SecurityGroup { + /** 角色ID */ + id: string + /** 角色code */ + code: string + /** 角色名称 */ + name?: Name + /** 角色描述 */ + description?: Name + /** 组织管理维度 */ + org_truncation?: OrgTruncation[] +} + +export interface SelectOptionResult { + /** 选项 ID */ + option_id?: string + /** 选项中文名称 */ + option_name?: string + /** 选项英文名称 */ + option_en_name?: string + /** 选项中文描述 */ + option_desc?: string + /** 选项英文描述 */ + option_en_desc?: string + /** 是否选择 */ + is_selected?: boolean +} + +export interface SelectSetting { + /** 单选选项 */ + options?: Option[] +} + +export interface Semester { + /** 绩效评估周期 ID */ + id?: string + /** 年份 */ + year?: number + /** 周期类型分组 */ + type_group?: string + /** 周期类型 */ + type?: string + /** 绩效评估周期 名称 */ + name?: I18n + /** 绩效评估周期 状态 */ + progress?: 'initiating' | 'enabled' + /** 绩效评估周期 开始时间 */ + start_time?: string + /** 绩效评估周期 结束时间 */ + end_time?: string + /** 绩效评估周期 创建时间 */ + create_time?: string + /** 绩效评估周期 更新时间 */ + modify_time?: string + /** 绩效评估周期 创建人 ID */ + create_user_id?: string + /** 绩效评估周期 更新人 ID */ + modify_user_id?: string +} + +export interface SemesterBaseInfo { + /** 周期ID */ + semester_id?: string + /** 周期名称 */ + semester_name?: I18n + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string +} + +export interface Sender { + /** 该字段标识发送者的id */ + id: string + /** 该字段标识发送者的id类型 */ + id_type: string + /** 该字段标识发送者的类型 */ + sender_type: string + /** tenant key */ + tenant_key?: string +} + +export interface SeniorityAdjustInformationEdit { + /** 调整类型- 可通过[【获取字段详情】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下： - object_api_name：seniority_adjust_information - custom_api_name：seniority_adjustment_type */ + seniority_adjustment_type: 'increase' | 'decrease' + /** 开始日期- 格式： yyyy-mm-dd */ + start_date?: string + /** 结束日期- 格式： yyyy-mm-dd */ + end_date?: string + /** 调整原因 */ + reasons_for_seniority_adjustment?: string + /** 调整值- 精确度：两位小数- 单位：年 */ + seniority_adjustment: number + /** 自定义字段- 具体支持的对象请参考[【自定义字段说明】](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) */ + custom_fields?: ProfileSettingCustomField[] +} + +export interface Sentence { + /** 速记句子文本 */ + content?: string + /** 句子开始讲话时的毫秒级时间戳 */ + speak_time?: string + /** 该句子的说话人用户类型 */ + user_type?: 1 | 2 + /** 该句子的说话人名称 */ + speaker_name?: I18n +} + +export interface Setting { + /** 谁可以创建空间的一级页面： "admin_and_member" = 管理员和成员 "admin" - 仅管理员 */ + create_setting?: string + /** 可阅读用户可否创建副本/打印/导出/复制： "allow" - 允许 "not_allow" - 不允许 */ + security_setting?: string + /** 可阅读用户可否评论： "allow" - 允许 "not_allow" - 不允许 */ + comment_setting?: string +} + +export interface Sheet { + /** 电子表格文档 Token。格式为 {SpreadsheetToken}_{SheetID}，其中 SpreadsheetToken 是一篇电子表格的唯一标识，SheetID 是一张工作表的唯一标识，使用时请注意拆分。 */ + token?: string +} + +export interface SheetFilterInfo { + /** 筛选应用范围 */ + range: string + /** 筛选出来的行 */ + filtered_out_rows: number[] + /** sheet的筛选条件 */ + filter_infos: FilterInfo[] +} + +export interface Shift { + /** 班次Id */ + shift_id: string + /** 班次名称 */ + shift_name: string + /** 打卡次数 */ + punch_times: number + /** 排班组子负责人id列表 */ + sub_shift_leader_ids?: string[] + /** 是否弹性打卡 */ + is_flexible?: boolean + /** 弹性打卡时间，设置【上班最多可晚到】与【下班最多可早走】时间，如果不设置flexible_rule则生效 */ + flexible_minutes?: number + /** 弹性打卡时间设置 */ + flexible_rule?: FlexibleRule[] + /** 不需要打下班卡 */ + no_need_off?: boolean + /** 打卡规则 */ + punch_time_rule: PunchTimeRule[] + /** 晚走晚到规则 */ + late_off_late_on_rule?: LateOffLateOnRule[] + /** 休息规则 */ + rest_time_rule?: RestRule[] + /** 打卡规则 */ + overtime_rule?: OvertimeRule[] + /** 日期类型，【是否弹性打卡 = ture】时，不可设置为“休息日” 可选值：1：工作日 2：休息日 示例值：（默认值）1 */ + day_type?: number + /** 班外休息规则 */ + overtime_rest_time_rule?: RestRule[] + /** 晚到多久记为严重迟到（优先级比原有字段高） */ + late_minutes_as_serious_late?: number + /** 半天分割规则 */ + shift_middle_time_rule?: ShiftMiddleTimeRule + /** 应出勤配置 */ + shift_attendance_time_config?: ShiftAttendanceTimeConfig + /** 晚走次日晚到配置规则 */ + late_off_late_on_setting?: LateOffLateOnSetting + /** 班次id(更新班次时需要传递) */ + id?: string + /** 休息弹性设置 */ + rest_time_flexible_configs?: RestTimeFlexibleConfig[] +} + +export interface ShiftAttendanceTimeConfig { + /** 应出勤时长 */ + attendance_time?: number + /** 上半天应出勤时长 */ + on_attendance_time?: number + /** 下半天应出勤时长 */ + off_attendance_time?: number +} + +export interface ShiftMiddleTimeRule { + /** 半天分割类型 */ + middle_time_type?: 0 | 1 | 2 | 3 + /** 固定分割时间点（middle_time_type 为 3 时有效） */ + fixed_middle_time?: string +} + +export interface SignatureAttachment { + /** 文件 id */ + id?: string + /** 文件名称 */ + file_name?: string + /** 文件模板 id */ + file_template_id?: string + /** 文件模板名称 */ + file_template_name?: string + /** 文件模板类型 id */ + file_template_type_id?: string + /** 文件模板类型名称 */ + file_template_type_name?: string +} + +export interface Skill { + /** 技能 ID */ + id?: string + /** 技能名称 */ + label?: string + /** 技能描述 */ + description?: string + /** 用户提问示例 */ + samples?: string[] + /** 技能入参定义 */ + input_schema?: string + /** 技能出参定义 */ + output_schema?: string +} + +export interface SkillGlobalVariable { + /** 触发技能的消息文本 */ + query?: string + /** 触发技能的消息文件 */ + files?: string[] + /** 渠道信息 */ + channel?: Channel +} + +export interface Sort { + /** 字段名称 */ + field_name?: string + /** 是否倒序排序 */ + desc?: boolean +} + +export interface SortOption { + /** 排序字段 */ + sort_field?: string + /** 排序顺序 */ + sort_order?: 0 | 1 + /** 0=中文关键字;1=英文关键字;2=拼音 */ + sort_i18n?: 0 | 1 | 2 + /** 按某个字段的层级深度排序 */ + sort_by_strand_length?: boolean + /** 是否按照拼音排序 */ + sort_by_pinyin?: boolean + /** 是否按照枚举类型 value_order 排序 */ + sort_by_enum_value_order?: boolean +} + +export interface Space { + /** 知识空间名称 */ + name?: string + /** 知识空间描述 */ + description?: string + /** 知识空间id */ + space_id?: string + /** 表示知识空间类型（团队空间 或 个人空间） */ + space_type?: 'team' | 'person' + /** 表示知识空间可见性（公开空间 或 私有空间） */ + visibility?: 'public' | 'private' + /** 表示知识空间的分享状态 */ + open_sharing?: 'open' | 'closed' +} + +export interface Span { + /** 偏移量开始位置，从 0 开始计数（编码格式采用 utf-8） */ + start: number + /** 偏移量结束位置，从 0 开始计数（编码格式采用 utf-8） */ + end: number +} + +export interface SpecificRelationship { + /** 与候选人的关系 */ + relation_with_candidate?: 1 | 2 | 3 + /** 附加信息 */ + extra?: string +} + +export interface Speech { + /** 语音资源 */ + speech?: string +} + +export interface Spreadsheet { + /** 表格标题 */ + title?: string + /** 文件夹token */ + folder_token?: string + /** 表格 URL */ + url?: string + /** 表格token */ + spreadsheet_token?: string +} + +export interface StageTask { + /** 用户ID */ + user_id?: string + /** 状态数量列表 */ + stage_num_lists?: StageTaskStatusNum[] + /** 任务信息列表 */ + stage_task_info_lists?: StageTaskInfo[] +} + +export interface StageTaskInfo { + /** 环节ID */ + stage_id?: string + /** 环节名称 */ + name?: I18n + /** 环节截止时间 */ + deadline?: string + /** 环节任务数量 */ + need_todo_count?: number + /** 环节跳转链接 */ + jump_url?: string + /** 环节任务状态 */ + stage_task_status?: 'need_todo' | 'overdue' | 'all_done' | 'stage_pause' + /** 归属分类ID */ + task_option_id?: 1 | 2 | 3 + /** 环节已完成任务数量 */ + finished_count?: number +} + +export interface StageTaskStatusNum { + /** 支持的ID */ + task_option_id?: 1 | 2 | 3 + /** 对Stage分类聚合 */ + stage_num?: number +} + +export interface Start { + /** 开始时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果开始时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true */ + timestamp?: string + /** 是否开始于一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。 */ + is_all_day?: boolean +} + +export interface Statictics { + /** 用户浏览数 */ + user_view_count?: string + /** 页面浏览数量 */ + page_view_count?: string + /** 用户浏览列表 */ + user_view_list?: UserViewDetail[] +} + +export interface Statistics { + /** 点赞数量 */ + like_count: number + /** 点踩数量 */ + dislike_count: number +} + +export interface StreamConfig { + /** 仅包含字母数字和下划线的 16 位字符串作为同一数据流的标识，用户生成 */ + stream_id: string + /** 数据流分片的序号，序号从 0 开始，每次请求递增 1 */ + sequence_id: number + /** 数据流标记：1 首包，2 正常结束，等待结果返回，3 中断数据流不返回最终结果 */ + action: number + /** 语音格式，目前仅支持：pcm */ + format: string + /** 引擎类型，目前仅支持：16k_auto 中英混合 */ + engine_type: string +} + +export interface Style { + /** 填充透明度 */ + fill_opacity?: number + /** 边框样式 */ + border_style?: 'solid' | 'none' | 'dash' | 'dot' + /** 边框宽度 */ + border_width?: 'extra_narrow' | 'narrow' | 'medium' | 'wide' + /** 边框透明度 */ + border_opacity?: number + /** 水平翻折 */ + h_flip?: boolean + /** 垂直翻折 */ + v_flip?: boolean +} + +export interface Subdivision { + /** 省份/行政区id */ + id: string + /** 省份/行政区名称 */ + name: I18n[] + /** 所属国家/地区id，详细信息可通过【查询国家/地区信息】接口查询获得 */ + country_region_id: string + /** 行政区类型，枚举值可通过文档【飞书人事枚举常量】行政区类型（subdivision_type）枚举定义部分获得 */ + subdivision_type: Enum +} + +export interface Subject { + /** ID */ + id?: string + /** 名称 */ + name?: I18n + /** 创建时间 */ + create_time?: string + /** 状态 */ + active_status?: 1 | 2 + /** 投递职位数上限 */ + application_limit?: number + /** 创建人 */ + creator?: IdNameObject +} + +export interface Subregion { + /** 城市/区域id */ + id: string + /** 城市/区域名称 */ + name: I18n[] + /** 所属省份/行政区id，详细信息可通过【查询省份/行政区信息】接口查询获得 */ + subdivision_id: string + /** 上级城市/区域区id */ + superior_subregion_id?: string +} + +export interface SubscribeDepartment { + /** 预定部门id */ + department_id: string +} + +export interface SubscribeUser { + /** 预订人id */ + user_id: string +} + +export interface SupportCostCenterItem { + /** 支持的成本中心id */ + cost_center_id?: string + /** 分摊比例 */ + rate?: number +} + +export interface SystemFields { + /** 中文姓名 */ + name?: string + /** 英文姓名 */ + en_name?: string + /** 邮箱 */ + email?: string + /** 手机号码 */ + mobile?: string + /** 部门id */ + department_id?: string + /** 上级 */ + manager?: Manager + /** 职位 */ + job?: Job + /** 职级 */ + job_level?: JobLevel + /** 工作地点 */ + work_location?: WorkLocation + /** 性别 */ + gender?: 1 | 2 + /** 生日 */ + birthday?: string + /** 籍贯 */ + native_region?: NativeRegion + /** 民族 */ + ethnicity?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 + /** 婚姻状况 */ + marital_status?: 1 | 2 | 3 | 4 + /** 政治面貌 */ + political_status?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 + /** 参加工作日期 */ + entered_workforce_date?: string + /** 证件类型 */ + id_type?: 1 | 2 | 3 | 4 | 5 + /** 证件号 */ + id_number?: string + /** 户口类型 */ + hukou_type?: 1 | 2 | 3 | 4 + /** 户口所在地 */ + hukou_location?: string + /** 银行卡号 */ + bank_account_number?: string + /** 开户行 */ + bank_name?: string + /** 社保账号 */ + social_security_account?: string + /** 公积金账号 */ + provident_fund_account?: string + /** 工号 */ + employee_no?: string + /** 雇员类型 */ + employee_type?: 1 | 2 | 3 | 4 | 5 + /** 员工状态 */ + status?: 1 | 2 | 3 | 4 | 5 + /** 入职日期 */ + hire_date?: string + /** 试用期（月） */ + probation_months?: number + /** 转正日期 */ + conversion_date?: string + /** 转正申请 */ + application?: 1 | 2 | 3 | 4 + /** 转正状态 */ + application_status?: 1 | 2 | 3 + /** 离职日期 */ + last_day?: string + /** 离职类型 */ + departure_type?: 1 | 2 | 3 + /** 离职原因 */ + departure_reason?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 + /** 离职备注 */ + departure_notes?: string + /** 合同公司 */ + contract_company?: ContractCompany + /** 合同类型 */ + contract_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 合同开始日期 */ + contract_start_date?: string + /** 合同到期日期 */ + contract_expiration_date?: string + /** 劳动合同签订次数 */ + contract_sign_times?: number + /** 个人邮箱 */ + personal_email?: string + /** 家庭地址 */ + family_address?: string + /** 主要紧急联系人 */ + primary_emergency_contact?: EmergencyContact + /** 紧急联系人 */ + emergency_contact?: EmergencyContact[] + /** 最高学历 */ + highest_level_of_edu?: Education + /** 教育经历 */ + education?: Education[] + /** 前工作经历 */ + former_work_exp?: WorkExperience + /** 工作经历 */ + work_exp?: WorkExperience[] + /** 身份证照片（人像面） */ + id_photo_po_side?: Attachment[] + /** 身份证照片（国徽面） */ + id_photo_em_side?: Attachment[] + /** 证件照 */ + id_photo?: Attachment[] + /** 学位证书 */ + diploma_photo?: Attachment[] + /** 毕业证书 */ + graduation_cert?: Attachment[] + /** 奖励证明 */ + cert_of_merit?: Attachment[] + /** 离职证明 */ + offboarding_file?: Attachment[] + /** 取消入职原因 */ + cancel_onboarding_reason?: 1 | 2 | 3 | 4 + /** 取消入职备注 */ + cancel_onboarding_notes?: string + /** 入职登记表状态 */ + employee_form_status?: 1 | 2 | 3 + /** 创建时间 */ + create_time?: unknown + /** 更新时间 */ + update_time?: unknown +} + +export interface SystemStatus { + /** 系统状态ID */ + system_status_id?: string + /** 系统状态名称，名称字符数要在1到20范围内。 */ + title: string + /** 系统状态国际化名称，名称字符数要在1到20范围内。 */ + i18n_title?: SystemStatusI18nName + /** 图标 */ + icon_key: 'GeneralDoNotDisturb' | 'GeneralInMeetingBusy' | 'Coffee' | 'GeneralBusinessTrip' | 'GeneralWorkFromHome' | 'StatusEnjoyLife' | 'GeneralTravellingCar' | 'StatusBus' | 'StatusInFlight' | 'Typing' | 'EatingFood' | 'SICK' | 'GeneralSun' | 'GeneralMoonRest' | 'StatusReading' | 'Status_PrivateMessage' | 'StatusFlashOfInspiration' | 'GeneralVacation' + /** 颜色 */ + color?: 'BLUE' | 'GRAY' | 'INDIGO' | 'WATHET' | 'GREEN' | 'TURQUOISE' | 'YELLOW' | 'LIME' | 'RED' | 'ORANGE' | 'PURPLE' | 'VIOLET' | 'CARMINE' + /** 优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。 */ + priority?: number + /** 同步设置 */ + sync_setting?: SystemStatusSyncSetting +} + +export interface SystemStatusI18nName { + /** 中文名 */ + zh_cn?: string + /** 英文名 */ + en_us?: string + /** 日文名 */ + ja_jp?: string +} + +export interface SystemStatusSyncI18nExplain { + /** 中文名 */ + zh_cn?: string + /** 英文名 */ + en_us?: string + /** 日文名 */ + ja_jp?: string +} + +export interface SystemStatusSyncI18nName { + /** 中文名 */ + zh_cn?: string + /** 英文名 */ + en_us?: string + /** 日文名 */ + ja_jp?: string +} + +export interface SystemStatusSyncSetting { + /** 是否默认开启 */ + is_open_by_default?: boolean + /** 同步设置名称，名称字符数要在1到30范围内。 */ + title?: string + /** 同步设置国际化名称，名称字符数要在1到30范围内。 */ + i18n_title?: SystemStatusSyncI18nName + /** 同步设置解释文案，解释字符数要在1到60范围内。 */ + explain?: string + /** 同步设置国际化解释文案，解释字符数要在1到60范围内。 */ + i18n_explain?: SystemStatusSyncI18nExplain +} + +export interface SystemStatusUserCloseResultEntity { + /** 用户ID */ + user_id?: string + /** 关闭结果 */ + result?: 'success' | 'fail' | 'invisible_user_id' | 'invalid_user_id' | 'resign_user_id' +} + +export interface SystemStatusUserOpenParam { + /** 用户ID */ + user_id: string + /** 结束时间，传入的应为秒单位的时间戳，距当前的时间跨度不能超过365天。 */ + end_time: string +} + +export interface SystemStatusUserOpenResultEntity { + /** 用户ID */ + user_id: string + /** 结束时间，传入的应为秒单位的时间戳，距当前的时间跨度不能超过365天。 */ + end_time: string + /** 开启结果 */ + result?: 'success_show' | 'success_user_close_syn' | 'success_user_in_higher_priority_system_status' | 'fail' | 'invisible_user_id' | 'invalid_user_id' | 'resign_user_id' +} + +export interface Table { + /** 单元格数组，数组元素为 Table Cell Block 的 ID */ + cells?: string[] + /** 表格属性 */ + property: TableProperty +} + +export type TableCell = unknown + +export interface TableMergeInfo { + /** 从当前行索引起被合并的连续行数 */ + row_span?: number + /** 从当前列索引起被合并的连续列数 */ + col_span?: number +} + +export interface TableProperty { + /** 行数 */ + row_size: number + /** 列数 */ + column_size: number + /** 列宽，单位px */ + column_width?: number[] + /** 单元格合并信息 */ + merge_info?: TableMergeInfo[] + /** 设置首行为标题行 */ + header_row?: boolean + /** 设置首列为标题列 */ + header_column?: boolean +} + +export interface TagI18nName { + /** 语言 */ + locale: string + /** 名称 */ + name?: string +} + +export interface TagInfo { + /** id */ + id?: string + /** 标签类型 */ + tag_type?: string + /** name */ + name?: string + /** i18n name */ + i18n_names?: TagI18nName[] + /** 创建时间 */ + create_time?: string + /** 更新时间 */ + update_time?: string +} + +export interface TagInfoWithBindVersion { + /** 标签内容 */ + tag_info?: TagInfo + /** 绑定时间 */ + bind_version?: string +} + +export interface Talent { + /** 人才ID */ + id?: string + /** 是否在猎头保护期 */ + is_in_agency_period?: boolean + /** 是否已入职 */ + is_onboarded?: boolean + /** 基础信息 */ + basic_info?: TalentBasicInfo + /** 教育经历 */ + education_list?: TalentEducationInfo[] + /** 工作经历 */ + career_list?: TalentCareerInfo[] + /** 项目经历 */ + project_list?: TalentProjectInfo[] + /** 作品 */ + works_list?: TalentWorksInfo[] + /** 获奖 */ + award_list?: TalentAwardInfo[] + /** 语言能力 */ + language_list?: TalentLanguageInfo[] + /** 社交账号 */ + sns_list?: TalentSnsInfo[] + /** 简历来源 */ + resume_source_list?: TalentResumeSource[] + /** 面试登记表 */ + interview_registration_list?: TalentInterviewRegistrationSimple[] + /** 简历附件id列表（按照简历创建时间降序） */ + resume_attachment_id_list?: string[] + /** 最高学历 */ + top_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 第一学历 */ + first_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 +} + +export interface TalentAwardInfo { + /** ID */ + id?: string + /** 获奖名称 */ + title?: string + /** 获奖时间 */ + award_time?: string + /** 描述 */ + desc?: string +} + +export interface TalentBasicInfo { + /** 名字 */ + name: string + /** 手机 */ + mobile?: string + /** 手机国家区号 */ + mobile_code?: string + /** 手机国家代码 */ + mobile_country_code?: string + /** 邮箱 */ + email?: string + /** 工作年限 */ + experience_years?: number + /** 年龄 */ + age?: number + /** 国籍 */ + nationality?: TalentNationality + /** 性别 */ + gender?: 1 | 2 | 3 + /** 所在地点 */ + current_city?: TalentCityInfo + /** 家乡 */ + hometown_city?: TalentCityInfo + /** 意向地点 */ + preferred_city_list?: TalentCityInfo[] + /** 证件类型 */ + identification_type?: 1 | 2 | 3 | 4 | 5 | 6 | 9 + /** 证件号 */ + identification_number?: string + /** 生日 */ + birthday?: number + /** 创建人 */ + creator_id?: string + /** 婚姻状况 */ + marital_status?: 1 | 2 + /** 家庭住址 */ + current_home_address?: string + /** 修改时间 */ + modify_time?: string +} + +export interface TalentBasicInfoV2 { + /** 人才 ID */ + id?: string + /** 人才名字 */ + name?: string + /** 人才手机国家区号 */ + mobile_code?: string + /** 人才手机号 */ + mobile_number?: string + /** 人才邮箱 */ + email?: string +} + +export interface TalentBatchInfo { + /** 人才 ID */ + talent_id?: string + /** 手机国家区号 */ + mobile_code?: string + /** 手机号 */ + mobile_number?: string + /** 邮箱 */ + email?: string + /** 证件类型，可参考招聘枚举常量 IdentificationType 枚举定义 */ + identification_type?: number + /** 证件号 */ + identification_number?: string + /** 是否已入职 */ + is_onboarded?: boolean +} + +export interface TalentBlock { + /** 加入黑名单时间，毫秒级时间戳 */ + blocked_time?: string + /** 黑名单创建者 ID */ + creator_id?: string + /** 加入黑名单原因 */ + reason?: string +} + +export interface TalentCareerInfo { + /** ID */ + id?: string + /** 公司名称 */ + company?: string + /** 职位名称 */ + title?: string + /** 描述 */ + desc?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 经历类型 */ + career_type?: 1 | 2 | 3 | 4 + /** 工作经历标签 */ + tag_list?: 5 | 6 | 14[] +} + +export interface TalentCityInfo { + /** 城市码 */ + city_code?: string + /** 中文名 */ + zh_name?: string + /** 英文名 */ + en_name?: string +} + +export interface TalentCombinedAwardInfo { + /** ID */ + id?: string + /** 获奖名称 */ + title?: string + /** 获奖时间 */ + award_time?: string + /** 描述 */ + desc?: string + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCombinedBasicInfo { + /** 名字 */ + name: string + /** 手机号 */ + mobile?: string + /** 手机国家代码 */ + mobile_country_code?: string + /** 邮箱 */ + email?: string + /** 证件信息 */ + identification?: TalentIdentificationInfo + /** 开始工作时间 */ + start_work_time?: string + /** 出生日期 */ + birthday?: string + /** 性别 */ + gender?: 1 | 2 | 3 + /** 国籍编码 */ + nationality_id?: string + /** 所在地点编码 */ + current_city_code?: string + /** 家乡编码 */ + hometown_city_code?: string + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCombinedCareerInfo { + /** ID */ + id?: string + /** 公司名称 */ + company?: string + /** 职位名称 */ + title?: string + /** 描述 */ + desc?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 经历类型 */ + career_type?: 1 | 2 + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCombinedEducationInfo { + /** ID */ + id?: string + /** 学位 */ + degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 学校 */ + school?: string + /** 专业 */ + field_of_study?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 学历类型 */ + education_type?: 1 | 2 | 3 | 4 | 5 + /** 成绩排名 */ + academic_ranking?: 5 | 10 | 20 | 30 | 50 | -1 + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCombinedLanguageInfo { + /** ID */ + id?: string + /** 语言 */ + language?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 + /** 精通程度 */ + proficiency?: 1 | 2 | 3 | 4 | 5 + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCombinedProjectInfo { + /** ID */ + id?: string + /** 项目名称 */ + name?: string + /** 项目角色 */ + role?: string + /** 项目链接 */ + link?: string + /** 描述 */ + desc?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCombinedSnsInfo { + /** ID */ + id?: string + /** SNS名称 */ + sns_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** URL/ID */ + link?: string + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCombinedWorkInfo { + /** ID */ + id?: string + /** 作品链接 */ + link?: string + /** 描述 */ + desc?: string + /** 附件 ID */ + attachment_id?: string + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentCustomizedAttachment { + /** 附件 ID */ + file_id?: string + /** 附件名称 */ + file_name?: string + /** 附件类型 */ + content_type?: string + /** 附件大小 */ + file_size?: number +} + +export interface TalentCustomizedDataChild { + /** 自定义字段 ID */ + object_id?: string + /** 字段名称 */ + name?: I18n + /** 字段类型 */ + object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 13 + /** 自定义字段值 */ + value?: TalentCustomizedValue +} + +export interface TalentCustomizedDataObjectValue { + /** 自定义字段 ID */ + object_id?: string + /** 子字段列表 */ + children?: TalentCustomizedDataObjectValueChild[] +} + +export interface TalentCustomizedDataObjectValueChild { + /** 自定义字段 ID */ + object_id?: string + /** 自定义字段值 */ + value?: string +} + +export interface TalentCustomizedOption { + /** 选项 ID */ + key?: string + /** 选项名称 */ + name?: I18n +} + +export interface TalentCustomizedTimeRange { + /** 开始时间，秒级时间戳 */ + start_time?: string + /** 结束时间，当值为至今时，返回「-」，秒级时间戳 */ + end_time?: string +} + +export interface TalentCustomizedValue { + /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ + content?: string + /** 当字段类型为单选时，从此字段取值 */ + option?: TalentCustomizedOption + /** 当字段类型为多选时，从此字段取值 */ + option_list?: TalentCustomizedOption[] + /** 当字段类型为时间段时，从此字段取值 */ + time_range?: TalentCustomizedTimeRange + /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是秒级时间戳 */ + time?: string + /** 当字段类型为数字时，从此字段取值 */ + number?: string + /** 当字段类型为附件时，从此字段取值 */ + customized_attachment?: TalentCustomizedAttachment[] +} + +export interface TalentEducationInfo { + /** ID */ + id?: string + /** 学位 */ + degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 学校 */ + school?: string + /** 专业 */ + field_of_study?: string + /** 开始时间 */ + start_time?: string + /** 结束时间（历史字段） ,如果是至今传值 -1，传输「至今」投递进入系统后可正常查看字段，但进入编辑态后需要修改为一个具体时间 */ + end_time?: string + /** 结束时间-新，无「至今」传值。建议使用此字段，避免模糊的毕业时间影响候选人筛选 */ + end_time_v2?: string + /** 学历类型 */ + education_type?: 1 | 2 | 3 | 4 | 5 + /** 成绩排名 */ + academic_ranking?: 5 | 10 | 20 | 30 | 50 | -1 + /** 教育经历标签 */ + tag_list?: 1 | 2 | 3 | 4[] +} + +export interface TalentExternalInfo { + /** 人才 ID */ + talent_id?: string + /** 人才在外部系统的创建时间 */ + external_create_time?: string +} + +export interface TalentFolder { + /** 名称 */ + name?: string + /** 文件夹 ID */ + folder_id?: string + /** 所有者 ID */ + owner_id?: string + /** 文件夹加入时间,毫秒级时间戳 */ + add_time?: string +} + +export interface TalentFolderForList { + /** 文件夹ID */ + folder_id?: string + /** 名字 */ + folder_name: string + /** 所有者ID */ + owner_id?: string +} + +export interface TalentIdentificationInfo { + /** 证件类型 */ + identification_type?: 1 | 2 | 3 | 4 | 5 | 6 | 9 + /** 证件号 */ + identification_number?: string +} + +export interface TalentInterview { + /** 投递 ID */ + application_id?: string + /** 面试列表 */ + interview_list?: InterviewExtend[] +} + +export interface TalentInterviewRegistrationSimple { + /** ID */ + id?: string + /** 创建时间 */ + registration_time?: number +} + +export interface TalentLanguageInfo { + /** ID */ + id?: string + /** 语言 */ + language?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 + /** 精通程度 */ + proficiency?: 1 | 2 | 3 | 4 | 5 +} + +export interface TalentNationality { + /** 国家编码 */ + nationality_code?: string + /** 中文名 */ + zh_name?: string + /** 英文名 */ + en_name?: string +} + +export interface TalentNote { + /** 备注 ID */ + id?: string + /** 人才 ID */ + talent_id?: string + /** 投递 ID */ + application_id?: string + /** 人才备注创建时间,毫秒级时间戳 */ + create_time?: string + /** 人才备注更新时间,毫秒级时间戳 */ + update_time?: string + /** 创建人ID */ + creator_id?: string + /** 备注内容 */ + content?: string + /** 备注私密属性 */ + privacy?: 1 | 2 +} + +export interface TalentOperationLog { + /** 投递 ID */ + application_id?: string + /** 候选人 ID */ + talent_id?: string + /** 操作人 */ + operator?: IdNameObject + /** 操作类型 */ + operation_type?: number + /** 操作时间 */ + operation_time?: string + /** 操作人类型 */ + operator_type?: 1 +} + +export interface TalentPool { + /** 人才库ID */ + id?: string + /** 人才库名称 */ + i18n_name?: I18n + /** 人才库描述 */ + i18n_description?: I18n + /** 父级人才库ID */ + parent_id?: string + /** 是否「仅部分用户可见」 */ + is_private?: 1 | 2 + /** 创建时间，毫秒时间戳 */ + create_time?: string + /** 修改时间，毫秒时间戳 */ + modify_time?: string +} + +export interface TalentProjectInfo { + /** ID */ + id?: string + /** 项目名称 */ + name?: string + /** 项目角色 */ + role?: string + /** 项目链接 */ + link?: string + /** 描述 */ + desc?: string + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string +} + +export interface TalentResumeAttachment { + /** ID */ + id?: string + /** 附件名 */ + name?: string + /** 附件MIME类型 */ + mime?: string + /** 创建时间戳 */ + create_time?: string +} + +export interface TalentResumeSource { + /** ID */ + id?: string + /** 中文名 */ + zh_name?: string + /** 英文名 */ + en_name?: string +} + +export interface TalentSelfEvaluation { + /** ID */ + id?: string + /** 内容 */ + content?: string + /** 自定义模块 */ + customized_data?: TalentCustomizedDataObjectValue[] +} + +export interface TalentSimilar { + /** 是否相似人才 */ + is_similar_talent?: boolean + /** 相似人才 ID 列表 */ + similar_talent_id_list?: string[] +} + +export interface TalentSnsInfo { + /** ID */ + id?: string + /** SNS名称 */ + sns_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** URL/ID */ + link?: string +} + +export interface TalentTag { + /** 标签 ID */ + id?: string + /** 标签名称 */ + name?: I18n + /** 描述名称 */ + description?: I18n + /** 标签类型 */ + type?: 1 | 2 + /** 启停用状态 */ + active_status?: 1 | 2 +} + +export interface TalentWorksInfo { + /** ID */ + id?: string + /** 作品链接 */ + link?: string + /** 描述 */ + desc?: string + /** 作品附件名称，若需获取作品附件预览信息可调用「获取附件预览信息」接口 */ + name?: string +} + +export interface TargetMajorInfo { + /** 目标专业ID */ + id?: string + /** 目标专业中文名称 */ + zh_name?: string + /** 目标专业英文名称 */ + en_name?: string +} + +export interface Task { + /** 任务 ID */ + task_id?: string + /** 折叠状态 */ + folded?: boolean +} + +export interface TaskDependency { + /** 依赖类型 */ + type: 'prev' | 'next' + /** 依赖任务的GUID */ + task_guid: string +} + +export interface TaskInTasklistInfo { + /** 任务所在清单的guid */ + tasklist_guid?: string + /** 任务所在清单的自定义分组guid */ + section_guid?: string +} + +export interface Tasklist { + /** 清单的全局唯一ID */ + guid?: string + /** 清单名 */ + name?: string + /** 清单创建者 */ + creator?: Member + /** 清单负责人 */ + owner?: Member + /** 清单协作人 */ + members?: Member[] + /** 该清单分享的applink */ + url?: string + /** 清单创建时间戳(ms) */ + created_at?: string + /** 清单最后一次更新时间戳（ms) */ + updated_at?: string +} + +export interface TasklistActivitySubscription { + /** 订阅guid */ + guid?: string + /** 订阅名称 */ + name?: string + /** 订阅者 */ + subscribers?: Member[] + /** 要订阅的清单动态类型 */ + include_keys?: number[] + /** 该订阅是否为停用 */ + disabled?: boolean +} + +export interface TaskResult { + /** 任务id */ + task_id: string + /** MoveDocsToWiki任务结果 */ + move_result?: MoveResult[] +} + +export interface TaskSearchItem { + /** 审批定义 */ + approval?: InstanceSearchApproval + /** 审批定义分组 */ + group?: InstanceSearchGroup + /** 审批实例信息 */ + instance?: InstanceSearchNode + /** 审批任务 */ + task?: TaskSearchNode +} + +export interface TaskSearchNode { + /** 审批任务发起人 id */ + user_id?: string + /** 审批任务开始时间 */ + start_time?: string + /** 审批任务结束时间 */ + end_time?: string + /** 审批任务状态 */ + status?: 'rejected' | 'pending' | 'approved' | 'transferred' | 'done' | 'rm_repeat' | 'processed' | 'hidden' + /** 审批实例名称（只有第三方审批有） */ + title?: string + /** 审批任务扩展字段，string型json */ + extra?: string + /** 审批任务链接（只有第三方审批有） */ + link?: InstanceSearchLink + /** 任务id */ + task_id?: string + /** 审批任务更新时间 */ + update_time?: string + /** 三方审批扩展 ID */ + task_external_id?: string +} + +export interface TaskSummary { + /** 任务GUID */ + guid?: string + /** 任务的标题 */ + summary?: string + /** 任务完成的时间戳(ms)，为0表示未完成 */ + completed_at?: string + /** 任务开始时间 */ + start?: Start + /** 任务截止时间 */ + due?: Due + /** 任务成员列表 */ + members?: Member[] + /** 子任务的个数 */ + subtask_count?: number +} + +export interface TaxiEntity { + /** 识别的字段种类 */ + type?: 'car_number' | 'start_time' | 'end_time' | 'distance' | 'start_date' | 'total_amount' | 'invoice_code' | 'invoice_no' | 'price' | 'dispatch_fee' | 'additional_fee' | 'is_sealed' | 'seller_name_in_seal' | 'seller_taxpayer_no_in_seal' | 'title_trial' | 'invoice_special_seal' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface TaxiInvoice { + /** 识别出的实体类型 */ + entities?: TaxiEntity[] +} + +export interface Template { + /** 环节模板 ID */ + template_id: string + /** 环节模板对应的环节名称 */ + name?: I18n + /** 环节类型 */ + stage_type?: string + /** 环节执行角色 */ + review_stage_role?: string +} + +export interface Tenant { + /** 企业名称 */ + name: string + /** 企业编号 */ + display_id: string + /** 个人版/团队版标志 */ + tenant_tag: 0 | 2 + /** 企业标识 */ + tenant_key: string + /** 企业头像 */ + avatar: Avatar + /** 企业完整域名。企业域名可用于企业成员访问管理后台、云文档等含URL地址的网页。 */ + domain?: string +} + +export interface TenantAssignInfo { + /** 席位id */ + subscription_id?: string + /** license_plan_key */ + license_plan_key?: string + /** 商业化产品名称 */ + product_name?: string + /** 国际化名称 */ + i18n_name?: ProductI18nName + /** 席位总数 */ + total_seats?: string + /** 已分配席位数 */ + assigned_seats?: string + /** 席位起始时间 */ + start_time?: string + /** 席位结束时间 */ + end_time?: string +} + +export interface Term { + /** 原文 */ + from: string + /** 译文 */ + to: string +} + +export interface TerminationReason { + /** 终止原因 ID */ + id?: string + /** 终止原因名称 */ + name?: I18n + /** 内推渠道展示文案 */ + referral_name?: I18n + /** 终止原因类型 */ + termination_type?: 1 | 22 | 27 + /** 是否用于评估 */ + is_used_as_evaluation?: boolean + /** 状态 */ + active_status?: 1 | 2 +} + +export interface TerminationReasonChildInfo { + /** 终止原因 ID */ + id?: string + /** 终止原因名称 */ + name?: I18n +} + +export interface TerminationReasonInfo { + /** 终止原因 id */ + id?: string + /** 终止原因名称 */ + name?: I18n + /** 子级终止原因 */ + children?: TerminationReasonChildInfo[] +} + +export interface Test { + /** 笔试 ID */ + test_id?: string + /** 投递 ID */ + application_id?: string + /** 人才 ID */ + talent_id?: string + /** 职位 ID */ + job_id?: string + /** 试卷 ID */ + test_paper_id?: string + /** 试卷名称 */ + test_paper_name?: string + /** 试卷来源 ID */ + test_paper_source_id?: string + /** 试卷来源名称 */ + test_paper_source_name?: I18n + /** 笔试答复状态 */ + reply_status?: 1 | 2 | 3 + /** 笔试状态 */ + test_status?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 笔试时间 */ + test_schedule?: TestSchedule + /** 笔试作答完成时间 */ + test_complete_time?: string + /** 笔试报告链接列表 */ + report_url_list?: string[] + /** 笔试详细成绩 */ + result_detail_list?: TestResultDetail[] + /** 笔试结果上传时间（手动录入的笔试成绩具有） */ + result_upload_time?: string + /** 阅卷得分 */ + score?: string + /** 阅卷结果提交时间（若重复提交，则为最新提交时间） */ + score_submit_time?: string + /** 阅卷人，值类型由 user_id_type 查询参数决定 */ + reviewer?: string + /** 阅卷安排时间 */ + review_created_at?: string + /** 笔试创建时间 */ + created_at?: string +} + +export interface TestResultDetail { + /** 笔试科目 */ + subject?: string + /** 笔试科目结论 */ + result?: string +} + +export interface TestSchedule { + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string +} + +export interface Text { + /** 文本样式 */ + style?: TextStyle + /** 文本元素 */ + elements: TextElement[] +} + +export interface TextElement { + /** 文字 */ + text_run?: TextRun + /** @用户 */ + mention_user?: MentionUser + /** @文档 */ + mention_doc?: MentionDoc + /** 日期提醒 */ + reminder?: Reminder + /** 内联附件 */ + file?: InlineFile + /** 未支持的 TextElement */ + undefined?: UndefinedElement + /** 内联 block */ + inline_block?: InlineBlock + /** 公式 */ + equation?: Equation +} + +export interface TextElementStyle { + /** 加粗 */ + bold?: boolean + /** 斜体 */ + italic?: boolean + /** 删除线 */ + strikethrough?: boolean + /** 下划线 */ + underline?: boolean + /** inline 代码 */ + inline_code?: boolean + /** 背景色 */ + background_color?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 + /** 字体颜色 */ + text_color?: 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 链接 */ + link?: Link + /** 评论 id 列表 */ + comment_ids?: string[] +} + +export interface TextRun { + /** 文本内容 */ + content: string + /** 文本局部样式 */ + text_element_style?: TextElementStyle +} + +export type TextSetting = unknown + +export interface TextStyle { + /** 对齐方式 */ + align?: 1 | 2 | 3 + /** todo 的完成状态 */ + done?: boolean + /** 文本的折叠状态 */ + folded?: boolean + /** 代码块语言 */ + language?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 + /** 代码块是否自动换行 */ + wrap?: boolean + /** 块背景色 */ + background_color?: 'LightGrayBackground' | 'LightRedBackground' | 'LightOrangeBackground' | 'LightYellowBackground' | 'LightGreenBackground' | 'LightBlueBackground' | 'LightPurpleBackground' | 'PaleGrayBackground' | 'DarkGrayBackground' | 'DarkRedBackground' | 'DarkOrangeBackground' | 'DarkYellowBackground' | 'DarkGreenBackground' | 'DarkBlueBackground' | 'DarkPurpleBackground' + /** 首行缩进级别 */ + indentation_level?: 'NoIndent' | 'OneLevelIndent' + /** 用于确定有序列表项编号，为具体数值或'auto' */ + sequence?: string +} + +export interface Ticket { + /** ticket id */ + ticket_id: string + /** helpdesk id */ + helpdesk_id?: string + /** guest of this ticket */ + guest?: TicketUser + /** 备注 */ + comments?: Comments + /** ticket type */ + ticket_type?: number + /** ticket status */ + status?: number + /** ticket score */ + score?: number + /** the time when the ticket is created */ + created_at?: unknown + /** the time when the ticket is updated */ + updated_at?: unknown + /** the time when the ticket is closed */ + closed_at?: unknown + /** 不满意原因 */ + dissatisfaction_reason?: I18n + /** agents of this ticket */ + agents?: TicketUser[] + /** the ticket channel */ + channel?: number + /** if ticket is solved */ + solve?: number + /** closed user of this ticket */ + closed_by?: TicketUser + /** collaborators of this ticket */ + collaborators?: TicketUser[] + /** ticket customized fields */ + customized_fields?: CustomizedFieldDisplayItem[] + /** 客服服务时长，客服最后一次回复时间距离客服进入时间间隔，单位秒 */ + agent_service_duration?: number + /** 客服首次回复时间距离客服进入时间的间隔，单位秒 */ + agent_first_response_duration?: unknown + /** 机器人服务时间：客服进入时间距离工单创建时间的间隔，单位秒 */ + bot_service_duration?: unknown + /** 客服解决时长，关单时间距离客服进入时间的间隔，单位秒 */ + agent_resolution_time?: unknown + /** 工单实际处理时间：从客服进入到关单，单位秒 */ + actual_processing_time?: unknown + /** 客服进入时间，单位毫秒 */ + agent_entry_time?: unknown + /** 客服首次回复时间，单位毫秒 */ + agent_first_response_time?: unknown + /** 客服最后回复时间，单位毫秒 */ + agent_last_response_time?: unknown + /** 主责客服 */ + agent_owner?: TicketUser +} + +export interface TicketCustomizedField { + /** 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 TicketMessage { + /** message id in helpdesk */ + id?: string + /** open message id */ + message_id?: string + /** message type, text is the only supported type */ + message_type: string + /** create time */ + created_at?: number + /** message content */ + content: string + /** user name */ + user_name?: string + /** avatar url */ + avatar_url?: string + /** user id */ + user_id?: string +} + +export interface TicketUser { + /** user id */ + id?: string + /** user avartal url */ + avatar_url?: string + /** user name */ + name?: string + /** user email */ + email?: string + /** user department */ + department?: string + /** 城市 */ + city?: string + /** 国家代号(CountryCode)，参考：http://www.mamicode.com/info-detail-2186501.html */ + country?: string +} + +export interface TimeConfig { + /** 是否覆盖子层级及会议室 */ + if_cover_child_scope?: boolean + /** 预定时间开关，0关闭，1开启 */ + time_switch: number + /** 最早可提前#{days_in_advance}天预定会议室，以天为单位 */ + days_in_advance?: number + /** 开放当天可于#{opening_hour} 开始预定，以秒为单位 */ + opening_hour?: string + /** 每日可预定时间范围开始时间，以秒为单位 */ + start_time?: string + /** 每日可预定时间范围结束时间，以秒为单位 */ + end_time?: string + /** 单次可预定时长上限,以小时为单位 */ + max_duration?: number +} + +export interface TimeInfo { + /** 仅全天日程使用该字段，如2018-09-01。需满足 RFC3339 格式。不能与 time_stamp 同时指定 */ + date?: string + /** 秒级时间戳，如1602504000(表示2020/10/12 20:0:00 +8时区) */ + timestamp?: string + /** 时区名称，使用IANA Time Zone Database标准，如Asia/Shanghai；全天日程时区固定为UTC，非全天日程时区默认为Asia/Shanghai */ + timezone?: string +} + +export interface TimeZone { + /** 时区 ID */ + time_zone_id?: string + /** 时区名称 */ + name?: I18n[] + /** 编码 */ + time_zone_code?: string + /** UTC 时区偏移量 */ + utc_offset?: string + /** 状态 */ + status?: 1 | 0 +} + +export interface TmpDownloadUrl { + /** 文件标识符 */ + file_token: string + /** 文件临时下载链接 */ + tmp_download_url: string +} + +export interface Todo { + /** 简历评估待办信息，仅当 type=evaluation 时返回 */ + evaluation?: TodoCommon + /** Offer 待办信息，仅当 type=offer 时返回 */ + offer?: TodoCommon + /** 笔试待办信息，仅当 type=exam 时返回 */ + exam?: TodoCommon + /** 面试待办信息，仅当 type=interview 时返回 */ + interview?: TodoCommon +} + +export interface TodoCommon { + /** 候选人 ID */ + talent_id?: string + /** 职位 ID */ + job_id?: string + /** 投递 ID */ + application_id?: string + /** ID */ + id?: string +} + +export interface TradeDetail { + /** 账户ID */ + account_id: string + /** 时间段内该账户在积分商城的实际充值金额 */ + total_recharge_reward_info?: BonusAmount +} + +export interface TrainEntity { + /** 识别的字段种类 */ + type?: 'start_station' | 'end_station' | 'train_num' | 'name' | 'seat_num' | 'ticket_num' | 'total_amount' | 'time' | 'price' | 'seat_num' | 'seat_cls' | 'id_num' | 'sale_num' | 'sale_station' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface TrainInvoice { + /** 识别出的实体列表 */ + entities?: TrainEntity[] +} + +export interface TranferEmploymentInfo { + /** 转正式员工日期 */ + regular_employee_start_date?: string + /** 司龄起算日期 */ + seniority_date?: string + /** 员工编号 */ + employee_number?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] +} + +export interface TransferInfo { + /** 原部门 */ + original_department?: string + /** 新部门 */ + target_department?: string + /** 新部门，新建部门审批完成前会返回 td_xxx 的临时 ID */ + target_draft_department?: string + /** 原部门全路径 */ + original_department_id_path?: OrgdraftDepartmentId[] + /** 新部门全路径 */ + target_department_id_path?: OrgdraftDepartmentId[] + /** 原直属上级 */ + original_direct_manager?: string + /** 新直属上级 */ + target_direct_manager?: string + /** 原职务 */ + original_job?: string + /** 新职务 */ + target_job?: string + /** 原序列 */ + original_job_family?: string + /** 新序列 */ + target_job_family?: string + /** 原级别 */ + original_job_level?: string + /** 新级别 */ + target_job_level?: string + /** 原成本中心分摊方式 */ + original_cost_center_rate?: JobDataCostCenter[] + /** 新成本中心分摊方式 */ + target_cost_center_rate?: JobDataCostCenter[] + /** 原职等 */ + original_job_grade?: string + /** 新职等 */ + target_job_grade?: string + /** 原岗位 */ + original_position?: string + /** 新岗位 */ + target_position?: string + /** 新岗位，新建岗位审批完成前会返回 td_xxx 的临时 ID */ + target_draft_position?: string + /** 编制随人员一起调整 */ + is_transfer_with_workforce?: boolean +} + +export interface TransferReason { + /** 异动原因唯一标识 */ + transfer_reason_unique_identifier?: string + /** 内容 */ + name?: I18n[] + /** active */ + active?: boolean + /** 上级异动原因唯一标识 */ + parent_transfer_reason_unique_identifier?: string + /** 创建时间 */ + created_time?: string + /** 更新时间 */ + updated_time?: string +} + +export interface TransferType { + /** 异动类型唯一标识 */ + transfer_type_unique_identifier?: string + /** 异动类型名称 */ + name?: I18n[] + /** 异动类型状态 */ + active?: boolean + /** 关联流程唯一标识符 */ + flow_id?: string + /** 关联流程名称 */ + flow_name?: I18n[] + /** 创建时间 */ + created_time?: string + /** 更新时间 */ + updated_time?: string +} + +export interface TripartiteAgreementInfo { + /** 三方协议 ID */ + id?: string + /** 投递ID */ + application_id?: string + /** 三方协议状态 */ + state?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 + /** 三方协议创建时间，毫秒时间戳 */ + create_time?: string + /** 三方协议修改时间，毫秒时间戳 */ + modify_time?: string +} + +export interface TrusteeshipInstanceCacheConfig { + /** 托管预缓存策略 */ + form_policy?: 'DISABLE' | 'IMMUTABLE' | 'BY_NODE' | 'BY_USER' + /** 表单是否随国际化改变 */ + form_vary_with_locale?: boolean + /** 当前使用的表单版本号，保证表单改变后，版本号增加，实际值为int64整数 */ + form_version?: string +} + +export interface TrusteeshipUrls { + /** 获取表单schema相关数据的url地址 */ + form_detail_url?: string + /** 表示获取审批操作区数据的url地址 */ + action_definition_url?: string + /** 获取审批记录相关数据的url地址 */ + approval_node_url?: string + /** 进行审批操作时回调的url地址 */ + action_callback_url?: string + /** 获取托管动态数据URL,使用该接口时必须要保证历史托管单据的数据中都同步了该接口地址,如果历史单据中没有该接口需要重新同步历史托管单据的数据来更新该URL */ + pull_business_data_url?: string +} + +export interface TwMainlandTravelPermit { + /** 识别出的实体类型 */ + entities?: TwMainlandTravelPermitEntity[] +} + +export interface TwMainlandTravelPermitEntity { + /** 识别的字段种类 */ + type?: 'full_name_cn' | 'full_name_en' | 'date_of_birth' | 'date_of_expiry' | 'card_number' + /** 识别出字段的文本信息 */ + value?: string +} + +export type Undefined = unknown + +export type UndefinedElement = unknown + +export interface Unit { + /** 单位的自定义ID */ + unit_id: string + /** 单位的名字 */ + name: string + /** 单位的类型 */ + unit_type: string +} + +export interface UnitDepartment { + /** 单位ID */ + unit_id: string + /** 部门ID */ + department_id: string +} + +export interface UnmergeTableCellsRequest { + /** table 行索引 */ + row_index: number + /** table 列索引 */ + column_index: number +} + +export interface UpdateBlockRequest { + /** 更新文本元素请求 */ + update_text_elements?: UpdateTextElementsRequest + /** 更新文本样式请求 */ + update_text_style?: UpdateTextStyleRequest + /** 更新表格属性请求 */ + update_table_property?: UpdateTablePropertyRequest + /** 表格插入新行请求 */ + insert_table_row?: InsertTableRowRequest + /** 表格插入新列请求 */ + insert_table_column?: InsertTableColumnRequest + /** 表格批量删除行请求 */ + delete_table_rows?: DeleteTableRowsRequest + /** 表格批量删除列请求 */ + delete_table_columns?: DeleteTableColumnsRequest + /** 表格合并单元格请求 */ + merge_table_cells?: MergeTableCellsRequest + /** 表格取消单元格合并状态请求 */ + unmerge_table_cells?: UnmergeTableCellsRequest + /** 分栏插入新的分栏列请求 */ + insert_grid_column?: InsertGridColumnRequest + /** 分栏删除列请求 */ + delete_grid_column?: DeleteGridColumnRequest + /** 更新分栏列宽比例请求 */ + update_grid_column_width_ratio?: UpdateGridColumnWidthRatioRequest + /** 替换图片请求 */ + replace_image?: ReplaceImageRequest + /** 替换附件请求 */ + replace_file?: ReplaceFileRequest + /** Block 唯一标识 */ + block_id?: string + /** 更新文本元素及样式请求 */ + update_text?: UpdateTextRequest + /** 更新任务 Block 请求 */ + update_task?: UpdateTaskRequest +} + +export interface UpdateGridColumnWidthRatioRequest { + /** 更新列宽比例时，需要传入所有列宽占比 */ + width_ratios: number[] +} + +export interface UpdateTablePropertyRequest { + /** 表格列宽 */ + column_width?: number + /** 需要修改列宽的表格列的索引（修改表格列宽时必填） */ + column_index?: number + /** 设置首行为标题行 */ + header_row?: boolean + /** 设置首列为标题列 */ + header_column?: boolean +} + +export interface UpdateTaskRequest { + /** 任务 ID。该字段仅在首次更新 Task Block 时生效，更新成功后，后续请求中将忽略该字段。 */ + task_id?: string + /** 折叠状态，字段为空时不更新折叠状态 */ + folded?: boolean +} + +export interface UpdateTextElementsRequest { + /** 更新的文本元素列表，单次更新中 reminder 上限 30 个，mention_doc 上限 50 个，mention_user 上限 100 个 */ + elements: TextElement[] +} + +export interface UpdateTextRequest { + /** 更新的文本元素列表，单次更新中 reminder 上限 30 个，mention_doc 上限 50 个，mention_user 上限 100 个 */ + elements: TextElement[] + /** 更新的文本样式 */ + style: TextStyle + /** 文本样式中应更新的字段，必须至少指定一个字段。例如，要调整 Block 对齐方式，请设置 fields 为 [1]。 */ + fields: 1 | 2 | 3 | 4 | 5 | 6 | 7[] +} + +export interface UpdateTextStyleRequest { + style: TextStyle + /** 应更新的字段，必须至少指定一个字段。例如，要调整 Block 对齐方式，请设置 fields 为 [1]。 */ + fields: 1 | 2 | 3 | 4 | 5 | 6 | 7[] +} + +export interface User { + /** 用户的union_id */ + union_id?: string + /** 租户内用户的唯一标识 */ + user_id?: string + /** 用户的open_id */ + open_id?: string + /** 用户名 */ + name: string + /** 英文名 */ + en_name?: string + /** 别名 */ + nickname?: string + /** 邮箱 */ + email?: string + /** 手机号 */ + mobile: string + /** 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码 */ + mobile_visible?: boolean + /** 性别 */ + gender?: 0 | 1 | 2 | 3 + /** 头像的文件Key */ + avatar_key?: string + /** 用户头像信息 */ + avatar?: AvatarInfo + /** 用户状态 */ + status?: UserStatus + /** 用户所属部门的ID列表 */ + department_ids?: string[] + /** 用户的直接主管的用户ID */ + leader_user_id?: string + /** 城市 */ + city?: string + /** 国家 */ + country?: string + /** 工位 */ + work_station?: string + /** 入职时间 */ + join_time?: number + /** 是否是租户超级管理员 */ + is_tenant_manager?: boolean + /** 工号 */ + employee_no?: string + /** 员工类型 */ + employee_type?: number + /** 用户排序信息 */ + orders?: UserOrder[] + /** 自定义属性 */ + custom_attrs?: UserCustomAttr[] + /** 企业邮箱 */ + enterprise_email?: string + /** 职务 */ + job_title?: string + /** 是否冻结用户 */ + is_frozen?: boolean + /** 数据驻留地 */ + geo?: string + /** 职级ID */ + job_level_id?: string + /** 序列ID */ + job_family_id?: string + /** 虚线上级ID */ + dotted_line_leader_user_ids?: string[] +} + +export interface UserAllowedRemedy { + /** 用户id */ + user_id: string + /** 补卡日期 */ + remedy_date: number + /** 是否为自由班次 */ + is_free_punch?: boolean + /** 第几次上下班，可能值0，1，2 */ + punch_no?: number + /** 上班/下班，1是上班，2是下班 */ + work_type?: number + /** 打卡状态，可用值：Early（早退），Late（迟到），Lack（缺卡） */ + punch_status?: string + /** 正常应打卡时间 */ + normal_punch_time?: string + /** 可选补卡时间的最小值 */ + remedy_start_time?: string + /** 可选补卡时间的最大值 */ + remedy_end_time?: string +} + +export interface UserApproval { + /** 审批用户工号 */ + user_id: string + /** 审批作用日期 */ + date: string + /** 外出的信息 */ + outs?: UserOut[] + /** 请假的信息 */ + leaves?: UserLeave[] + /** 加班的信息 */ + overtime_works?: UserOvertimeWork[] + /** 出差 */ + trips?: UserTrip[] + /** 计算时间所用的时区信息，为空是0时区 */ + time_zone?: string +} + +export interface UserBase { + /** 用户 ID */ + user_id?: string + /** 该用户所属部门 ID 列表 */ + department_ids?: string[] +} + +export interface UserBusinessManagementScope { + /** 实体 */ + entity?: EntityInfo + /** 管理范围 */ + scope_rule?: PermissionScopeRule +} + +export interface UserCalendar { + /** 日历实体信息 */ + calendar?: Calendar + /** 日历的创建者user ID */ + user_id?: string +} + +export interface UserContactInfo { + /** 用户id，值为user_id_type所指定的类型。如果查询的手机号、邮箱不存在，或者无权限查看对应的用户，则此项为空。 */ + user_id?: string + /** 手机号 */ + mobile?: string + /** 邮箱 */ + email?: string + /** 用户状态 */ + status?: UserStatus +} + +export interface UserCustomAttr { + /** 自定义属性类型 */ + type?: string + /** 自定义属性ID */ + id?: string + /** 自定义属性取值 */ + value?: UserCustomAttrValue +} + +export interface UserCustomAttrValue { + /** 属性文本 */ + text?: string + /** URL */ + url?: string + /** PC上的URL */ + pc_url?: string + /** 选项id，自定义选项和图片此项必填 */ + option_id?: string + /** 用户信息 */ + generic_user?: CustomAttrGenericUser +} + +export interface UserCustomizedField { + /** user customized field id */ + user_customized_field_id?: string + /** user customized field id, for backward compatibility */ + id?: string + /** help desk id */ + helpdesk_id?: string + /** key name */ + key_name?: string + /** display name */ + display_name?: string + /** the position of user 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 +} + +export interface UserDailyShift { + /** 考勤组ID */ + group_id: string + /** 班次ID */ + shift_id: string + /** 月份 */ + month: number + /** 用户工号 */ + user_id: string + /** 日期 */ + day_no: number + /** 是否清空班次 (此字段优先于 shift_id，若为true ，shift_id 将失效) */ + is_clear_schedule?: boolean +} + +export interface UserDepartmentInfo { + /** 对应的部门ID */ + department_id: string + /** 用户在部门内的排序 */ + user_order?: number + /** 用户的部门间的排序 */ + department_order?: number +} + +export interface UserExternal { + /** 用户类型 */ + user_type: 1 | 2 | 10 | 11 + /** 用户id */ + user_id?: string + /** 用户名称 */ + user_name?: string + /** 电话号码 */ + phone_num?: string + /** 部门id */ + department_id?: string +} + +export interface UserFlow { + /** 用户工号 */ + user_id: string + /** 记录创建者的工号 */ + creator_id: string + /** 打卡位置名称信息 */ + location_name: string + /** 打卡时间，精确到秒的时间戳 */ + check_time: string + /** 打卡备注 */ + comment: string + /** 打卡记录ID */ + record_id?: string + /** 打卡wifi ssid */ + ssid?: string + /** 打卡wifi MAC地址 */ + bssid?: string + /** 是否为外勤打卡 */ + is_field?: boolean + /** 是否为wifi打卡 */ + is_wifi?: boolean + /** 记录生成方式 */ + type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 + /** 打卡照片列表 */ + photo_urls?: string[] + /** 打卡设备ID */ + device_id?: string + /** 打卡结果 */ + check_result?: 'NoNeedCheck' | 'SystemCheck' | 'Normal' | 'Early' | 'Late' | 'SeriousLate' | 'Lack' | 'Invalid' | 'None' | 'Todo' + /** 用户导入的外部打卡记录ID */ + external_id?: string + /** 唯一幂等键 */ + idempotent_id?: string +} + +export interface UserLeave { + /** 审批实例id */ + approval_id?: string + /** 假期类型唯一ID，代表一种假期类型，长度小于14 */ + uniq_id?: string + /** 假期时长单位。可用值：1：天；2：小时；3：半天；4：半小时。 */ + unit: 1 | 2 | 3 | 4 + /** 假期时长（单位秒） */ + interval: number + /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + start_time: string + /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + end_time: string + /** 假期多语言展示，格式为map，key为["ch"、"en"、"ja"]，其中ch代表中文，en 代表英文、ja代表日文 */ + i18n_names: I18nNames + /** 默认语言类型，由于飞书客户端支持中、英、日三种语言，如果用户切换语言时，假期名称没有对应语言的名称，会使用默认语言的名称 */ + default_locale: 'ch' | 'en' | 'ja' + /** 请假理由 */ + reason: string + /** 审批通过时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + approve_pass_time?: string + /** 审批申请时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + approve_apply_time?: string + /** 唯一幂等键 */ + idempotent_id?: string +} + +export interface UserOpenAppFeedCardDeleter { + /** 业务 ID */ + biz_id: string + /** 用户 ID */ + user_id: string +} + +export interface UserOpenAppFeedCardUpdater { + /** 应用消息卡片 */ + app_feed_card: OpenAppFeedCard + /** 用户 id */ + user_id: string + /** 更新字段列表 */ + update_fields: '1' | '2' | '3' | '10' | '11' | '12' | '13' | '101' | '102' | '103'[] +} + +export interface UserOrder { + /** 排序信息对应的部门ID */ + department_id?: string + /** 用户在部门内的排序 */ + user_order?: number + /** 用户的部门间的排序 */ + department_order?: number + /** 是否为用户主部门 */ + is_primary_dept?: boolean +} + +export interface UserOut { + /** 审批实例id */ + approval_id?: string + /** 外出类型唯一ID，代表一种假期类型，长度小于14 */ + uniq_id: string + /** 外出时长单位。可用值：1：上半天；2：下半天；3：全天；4：小时。 */ + unit: 1 | 2 | 3 | 4 + /** 外出时长（单位秒） */ + interval: number + /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + start_time: string + /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + end_time: string + /** 外出多语言展示，格式为map，key为["ch"、"en"、"ja"]，其中ch代表中文，en 代表英文、ja代表日文 */ + i18n_names: I18nNames + /** 默认语言类型，由于飞书客户端支持中、英、日三种语言，如果用户切换语言时，假期名称没有对应语言的名称，会使用默认语言的名称 */ + default_locale: string + /** 外出理由 */ + reason: string + /** 审批通过时间 */ + approve_pass_time?: string + /** 审批申请时间 */ + approve_apply_time?: string + /** 唯一幂等键 */ + idempotent_id?: string + /** 更正流程实例 ID */ + correct_process_id?: string[] + /** 撤销流程实例 ID */ + cancel_process_id?: string[] + /** 发起流程实例 ID */ + process_id?: string[] +} + +export interface UserOvertimeWork { + /** 审批实例id */ + approval_id?: string + /** 加班时长 */ + duration: number + /** 加班时长单位。可用值：1：天；2：小时。 */ + unit: 1 | 2 | 3 | 4 + /** 加班类型 */ + category: 1 | 2 | 3 + /** 加班规则类型 */ + type: 0 | 1 | 2 | 3 + /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + start_time: string + /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + end_time: string + /** 加班事由 */ + reason?: string + /** 唯一幂等键 */ + idempotent_id?: string + /** 更正流程实例 ID */ + correct_process_id?: string[] + /** 撤销流程实例 ID */ + cancel_process_id?: string[] + /** 发起流程实例 ID */ + process_id?: string[] +} + +export interface UserQueryFaqInfo { + /** faq id */ + id?: string + /** faq match score */ + score?: number +} + +export interface UserRole { + /** 用户 ID */ + user_id?: string + /** 角色 ID */ + role_id?: string + /** 修改时间 */ + modify_time?: string + /** 角色名称 */ + role_name?: I18n + /** 角色描述 */ + role_description?: I18n + /** 业务管理范围 */ + business_management_scopes?: UserBusinessManagementScope[] +} + +export interface UserSetting { + /** 用户id */ + user_id: string + /** 人脸Key */ + face_key: string + /** 人脸照片更新时间 */ + face_key_update_time?: string +} + +export interface UserStatsData { + /** 用户姓名 */ + name: string + /** 用户id */ + user_id: string + /** 用户的统计数据 */ + datas?: UserStatsDataCell[] +} + +export interface UserStatsDataCell { + /** code */ + code: string + /** value */ + value: string + /** 属性 */ + features?: UserStatsDataFeature[] + /** title */ + title?: string + /** 时长 */ + duration_num?: UserStatsDataDuration +} + +export interface UserStatsDataDuration { + /** 天 */ + day?: string + /** 半天 */ + half_day?: string + /** 小时 */ + hour?: string + /** 半小时 */ + half_hour?: string + /** 分钟 */ + minute?: string +} + +export interface UserStatsDataFeature { + /** 统计数据列附加属性的名称 */ + key: string + /** 统计数据列附加属性的值 */ + value: string +} + +export interface UserStatsField { + /** 视图类型 */ + stats_type: 'daily' | 'month' + /** 用户id */ + user_id: string + /** 字段名称 */ + fields: Field[] +} + +export interface UserStatsView { + /** 视图id */ + view_id: string + /** 视图类型 */ + stats_type: 'daily' | 'month' + /** 用户id */ + user_id: string + /** 用户设置字段 */ + items?: Item[] +} + +export interface UserStatus { + /** 是否冻结 */ + is_frozen?: boolean + /** 是否离职 */ + is_resigned?: boolean + /** 是否激活 */ + is_activated?: boolean + /** 是否主动退出，主动退出一段时间后用户会自动转为已离职 */ + is_exited?: boolean + /** 是否未加入，需要用户自主确认才能加入团队 */ + is_unjoin?: boolean +} + +export interface UserTask { + /** 打卡记录ID */ + result_id: string + /** 用户工号 */ + user_id: string + /** 用户姓名 */ + employee_name: string + /** 日期 */ + day: number + /** 考勤组ID */ + group_id: string + /** 班次ID */ + shift_id: string + /** 用户考勤记录 */ + records: TaskResult[] +} + +export interface UserTaskRemedy { + /** 用户工号 */ + user_id: string + /** 补卡日期 */ + remedy_date: number + /** 第几次上下班，可能值0，1，2 */ + punch_no: number + /** 上班/下班，1是上班，2是下班 */ + work_type: number + /** 审批id */ + approval_id?: string + /** 补卡时间 */ + remedy_time: string + /** 补卡状态 */ + status?: 0 | 1 | 2 | 3 | 4 + /** 补卡原因 */ + reason: string + /** 补卡时间戳，精确到秒的时间戳 */ + time?: string + /** 补卡时考勤组时区 */ + time_zone?: string + /** 补卡发起时间，精确到秒的时间戳 */ + create_time?: string + /** 补卡状态更新时间，精确到秒的时间戳 */ + update_time?: string +} + +export interface UserTmpDailyShift { + /** 考勤组 ID */ + group_id: string + /** 用户 ID */ + user_id: string + /** 日期 */ + date: number + /** 班次名称 */ + shift_name: string + /** 打卡规则 */ + punch_time_simple_rules: PunchTimeSimpleRule[] +} + +export interface UserTrip { + /** 审批实例id */ + approval_id?: string + /** 开始时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + start_time: string + /** 结束时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + end_time: string + /** 出差理由 */ + reason: string + /** 审批通过时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + approve_pass_time: string + /** 审批申请时间，时间格式为 yyyy-MM-dd HH:mm:ss */ + approve_apply_time: string + /** 唯一幂等键 */ + idempotent_id?: string + /** 更正流程实例 ID */ + correct_process_id?: string[] + /** 撤销流程实例 ID */ + cancel_process_id?: string[] + /** 发起流程实例 ID */ + process_id?: string[] + /** 出发地（只有一个） */ + departure?: RegionPlace + /** 目的地（可写多个） */ + destinations?: RegionPlace[] + /** 交通工具（1 飞机，2 火车，3 汽车，4 高铁/动车，5 船，6 其他） */ + transportation?: number[] + /** 出差类型(1:单程 2:往返) */ + trip_type?: number + /** 出差备注 */ + remarks?: string +} + +export interface UserViewDetail { + /** 用户ID */ + user_id?: string + /** 用户的最近查看时间timestamp（ms级别） */ + view_time?: string +} + +export interface VatEntity { + /** 识别的实体类型 */ + type?: 'invoice_name' | 'invoice_code' | 'invoice_no' | 'invoice_date' | 'total_price' | 'total_tax' | 'big_total_price_and_tax' | 'check_code' | 'total_price_and_tax' | 'buyer_name' | 'buyer_taxpayer_no' | 'buyer_address_phone' | 'buyer_account' | 'seller_name' | 'seller_taxpayer_no' | 'seller_address_phone' | 'seller_account' | 'payee' | 'invoice_date' | 'password_area' | 'remarks' | 'reviewer' | 'drawer' | 'is_sealed' | 'seller_name_in_seal' | 'seller_taxpayer_no_in_seal' | 'invoice_special_seal' | 'machine_num' + /** 识别出字段的文本信息 */ + value?: string + /** 识别出的票据详细信息 */ + items?: KvEntity[][] +} + +export interface VatInvoice { + /** 识别出的实体列表 */ + entities?: VatEntity[] +} + +export interface Vchat { + /** 视频会议类型 */ + vc_type?: 'vc' | 'third_party' | 'no_meeting' | 'lark_live' | 'unknown' + /** 第三方视频会议icon类型 */ + icon_type?: 'vc' | 'live' | 'default' + /** 第三方视频会议文案，可以为空，为空展示默认文案 */ + description?: string + /** 视频会议URL */ + meeting_url?: string + /** VC视频会议的会前设置 */ + meeting_settings?: MeetingSettings +} + +export interface VehicleEntity { + /** 识别的字段种类 */ + type?: 'plate_number' | 'vehicle_type' | 'owner' | 'address' | 'use_character' | 'model' | 'vin' | 'engine_number' | 'register_date' | 'issue_date' | 'license_issuing_authority' | 'document_id' | 'approved_passengers_capacity' | 'total_mass' | 'curb_weight' | 'ratified_load_capacity' | 'gabarite' | 'traction_mass' | 'remarks' | 'inspection_record' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface VehicleInvoice { + /** 识别出的实体类型 */ + entities?: VehicleInvoiceEntity[] +} + +export interface VehicleInvoiceEntity { + /** 识别的字段种类 */ + type?: 'invoice_code' | 'invoice_num' | 'date' | 'print_code' | 'print_num' | 'machine_num' | 'buyer_name' | 'buyer_id' | 'vehicle_type' | 'product_model' | 'certificate_num' | 'engine_num' | 'vin' | 'total_price' | 'total_price_little' | 'saler_name' | 'saler_id' | 'saler_addr' | 'tax_rate' | 'tax' | 'price' + /** 识别出字段的文本信息 */ + value?: string +} + +export interface VehicleLicense { + /** 识别出的实体类型 */ + entities?: VehicleEntity[] +} + +export interface Verification { + /** 企业主体名称 */ + name: string + /** 企业是否完成认证； true 表示已经完成认证，false 表示未认证 */ + has_verification: boolean +} + +export interface Version { + /** 版本文档标题，最大长度 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 View { + /** 视图类型 */ + view_type?: 1 | 2 | 3 +} + +export interface WebApp { + /** pc 端 url */ + pc_url?: string + /** 移动端 url */ + mobile_url?: string +} + +export interface Website { + /** ID */ + id?: string + /** 名称 */ + name?: I18n + /** 流程类型，1-社招，2-校招 */ + process_type_list?: number[] + /** 职位渠道ID */ + job_channel_id?: string +} + +export interface WebsiteChannelInfo { + /** 推广渠道 ID */ + id?: string + /** 推广渠道名称 */ + name?: string + /** 推广渠道链接 */ + link?: string + /** 推广渠道推广码 */ + code?: string +} + +export interface WebsiteDeliveryAttachmentIndentification { + /** 身份证件类型 */ + identification_type?: 1 | 2 | 3 | 4 | 5 | 6 | 9 + /** 身份证件号 */ + identification_number?: string +} + +export interface WebsiteDeliveryAward { + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] + /** 描述 */ + desc?: string + /** 奖项名称 */ + title?: string + /** 获奖时间 */ + award_time?: number +} + +export interface WebsiteDeliveryBasicInfo { + /** 国籍，可从「获取地址码」查询 */ + nationality_id?: string + /** 起始工作时间 */ + start_work_time?: number + /** 家庭住址 */ + current_home_address?: string + /** 家乡，可从「获取地址码」查询 */ + hometown_city_code?: string + /** 电话国际区号，可从「获取地址码」查询 */ + mobile_country_code?: string + /** 身份证件 */ + identification?: WebsiteDeliveryIdentification + /** 婚姻状况 */ + marital_status?: 1 | 2 + /** 电话 */ + mobile?: string + /** 所在城市，可从「获取地址码」查询 */ + current_city_code?: string + /** 工作年限 */ + experience_years?: number + /** 性别 */ + gender?: 1 | 2 | 3 + /** 出生日期 */ + birthday?: number + /** 姓名 */ + name: string + /** 意向城市，可从「获取地址码」查询 */ + preferred_city_code_list?: string[] + /** 简历来源，可从「获取简历来源列表」查询 */ + resume_source_id?: string + /** 年龄 */ + age?: number + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] + /** 邮箱 */ + email?: string +} + +export interface WebsiteDeliveryCareer { + /** 描述 */ + desc?: string + /** 结束时间, 如果是至今传值 -1 */ + end_time?: number + /** 开始时间 */ + start_time?: number + /** 职位名称 */ + title?: string + /** 公司 */ + company?: string + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] +} + +export interface WebsiteDeliveryCustomizedData { + /** 自定义字段 ID */ + object_id?: string + /** 自定义字段 value，格式见接口说明 */ + value?: string +} + +export interface WebsiteDeliveryCustomizedDataParent { + /** 自定义字段 ID */ + object_id?: string + /** 模块下的字段 */ + children?: WebsiteDeliveryCustomizedData[] +} + +export interface WebsiteDeliveryDto { + /** 投递 ID */ + application_id?: string + /** ID */ + id?: string + /** 职位 ID */ + job_id?: string + /** 职位广告 ID */ + job_post_id?: string + /** 官网简历 ID */ + portal_resume_id?: string + /** 官网用户 ID */ + user_id?: string + /** 人才 ID */ + talent_id?: string +} + +export interface WebsiteDeliveryEducation { + /** 学历类型 */ + education_type?: 1 | 2 | 3 | 4 | 5 + /** 结束时间 ,如果是「至今」传值 -1，传输「至今」，投递进入系统后可正常查看字段，但进入编辑态后需要修改为一个具体时间 */ + end_time?: number + /** 结束时间-新，无「至今」传值。建议使用此字段，避免模糊的毕业时间影响候选人筛选 */ + end_time_v2?: number + /** 专业 */ + field_of_study?: string + /** 学校 */ + school?: string + /** 开始时间 */ + start_time?: number + /** 专业排名 */ + academic_ranking?: 5 | 10 | 20 | 30 | 50 | 51 + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] + /** 学位 */ + degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 +} + +export interface WebsiteDeliveryIdentification { + /** 身份证件号码 */ + identification_number?: string + /** 身份证件类型 */ + identification_type?: 1 | 2 | 3 | 4 | 5 | 6 | 9 +} + +export interface WebsiteDeliveryInternship { + /** 描述 */ + desc?: string + /** 结束时间, 如果是至今传值 -1 */ + end_time?: number + /** 开始时间 */ + start_time?: number + /** 职位名称 */ + title?: string + /** 公司 */ + company?: string + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] +} + +export interface WebsiteDeliveryLanguage { + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] + /** 语言 */ + language?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 + /** 熟悉程度 */ + proficiency?: 1 | 2 | 3 | 4 | 5 +} + +export interface WebsiteDeliveryProject { + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] + /** 描述 */ + desc?: string + /** 结束时间, 如果是至今传值-1 */ + end_time?: number + /** 项目链接 */ + link?: string + /** 项目名称 */ + name?: string + /** 角色 */ + role?: string + /** 开始时间 */ + start_time?: number +} + +export interface WebsiteDeliveryResume { + /** 实习经历 */ + internship_list?: WebsiteDeliveryInternship[] + /** 基本信息 */ + basic_info: WebsiteDeliveryBasicInfo + /** 教育经历 */ + education_list?: WebsiteDeliveryEducation[] + /** 自我评价 */ + self_evaluation?: WebsiteDeliverySelfEvaluation + /** 工作经历 */ + career_list?: WebsiteDeliveryCareer[] + /** 自定义模块 */ + customized_data?: WebsiteDeliveryCustomizedDataParent[] + /** 简历附件ID，使用「创建附件」生成 */ + resume_attachment_id?: string + /** 社交账号 */ + sns_list?: WebsiteDeliverySns[] + /** 作品 */ + works_list?: WebsiteDeliveryWorks[] + /** 获奖记录 */ + award_list?: WebsiteDeliveryAward[] + /** 项目经历 */ + project_list?: WebsiteDeliveryProject[] + /** 语言能力 */ + language_list?: WebsiteDeliveryLanguage[] +} + +export interface WebsiteDeliverySelfEvaluation { + /** 内容 */ + content?: string + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] +} + +export interface WebsiteDeliverySns { + /** 社交账号类型 */ + sns_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] + /** 链接 */ + link?: string +} + +export interface WebsiteDeliveryWorks { + /** 作品描述 */ + desc?: string + /** 作品链接 */ + link?: string + /** 附件 */ + attachment?: WebsiteDeliveryWorksAttachment + /** 自定义字段 */ + customized_data?: WebsiteDeliveryCustomizedData[] +} + +export interface WebsiteDeliveryWorksAttachment { + /** 文件ID，使用「创建附件」生成 */ + file_id?: string +} + +export interface WebsiteJobPost { + /** 职位广告 ID */ + id?: string + /** 标题 */ + title?: string + /** 职位 ID */ + job_id?: string + /** 职位编码 */ + job_code?: string + /** 职位过期时间，「null」代表「长期有效」 */ + job_expire_time?: string + /** 职位状态 */ + job_active_status?: 1 | 2 + /** 职位流程类型 */ + job_process_type?: 1 | 2 + /** 职位雇佣类型 */ + job_recruitment_type?: IdNameObject + /** 职位部门 */ + job_department?: IdNameObject + /** 职位类型 */ + job_type?: IdNameObject + /** 最低职级 */ + min_job_level?: IdNameObject + /** 最高职级 */ + max_job_level?: IdNameObject + /** 职位地址 */ + address?: CommonAddress + /** 月薪范围-最低薪资 */ + min_salary?: string + /** 月薪范围-最高薪资 */ + max_salary?: string + /** 学历要求 */ + required_degree?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 20 + /** 经验 */ + experience?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 + /** 数量 */ + headcount?: number + /** 职位亮点 */ + high_light_list?: IdNameObject[] + /** 职位描述 */ + description?: string + /** 职位要求 */ + requirement?: string + /** 创建人 */ + creator?: IdNameObject + /** 创建时间 */ + create_time?: string + /** 修改时间 */ + modify_time?: string + /** 自定义字段 */ + customized_data_list?: WebsiteJobPostCustomizedData[] + /** 职位广告地址列表 */ + address_list?: CommonAddress[] + /** 职级序列 */ + job_sequence_info?: IdNameObject + /** 币种，可参考招聘「枚举常量介绍」 */ + currency?: number + /** 目标专业 */ + target_major_list?: IdNameObject[] +} + +export interface WebsiteJobPostCustomizedData { + /** 自定义字段 ID */ + object_id?: string + /** 字段名称 */ + name?: I18n + /** 字段类型 */ + object_type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 + /** 自定义字段值 */ + value?: WebsiteJobPostCustomizedValue +} + +export interface WebsiteJobPostCustomizedOption { + /** 选项 ID */ + key?: string + /** 选项名称 */ + name?: I18n +} + +export interface WebsiteJobPostCustomizedTimeRange { + /** 开始时间 */ + start_time?: string + /** 结束时间 */ + end_time?: string +} + +export interface WebsiteJobPostCustomizedValue { + /** 当字段类型为单行文本、多行文本、模块、默认字段时，从此字段取值 */ + content?: string + /** 当字段类型为单选时，从此字段取值 */ + option?: WebsiteJobPostCustomizedOption + /** 当字段类型为多选时，从此字段取值 */ + option_list?: WebsiteJobPostCustomizedOption[] + /** 当字段类型为时间段时，从此字段取值 */ + time_range?: WebsiteJobPostCustomizedTimeRange + /** 当字段类型为日期选择、月份选择、年份选择时，从此字段取值，该字段是毫秒级时间戳 */ + time?: string + /** 当字段类型为数字时，从此字段取值 */ + number?: string +} + +export interface WebsiteUser { + /** 用户 ID */ + user_id?: string + /** 姓名 */ + name?: string + /** 邮箱 */ + email?: string + /** 外部用户 ID */ + external_id: string + /** 电话，请和区号对应的国家码一并提供 */ + mobile?: string + /** 国家码，请和电话一并提供，可从「获取地址码」查询 */ + mobile_country_code?: string +} + +export interface WeekdaySchedule { + /** 开始时间, format 00:00 - 23:59 */ + start_time?: string + /** 结束时间, format 00:00 - 23:59 */ + end_time?: string + /** 星期几, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, 6 - Saturday, 7 - Sunday, 9 - Everday, 10 - Weekday, 11 - Weekend */ + weekday?: number +} + +export interface WhiteboardNode { + /** 节点 id */ + id: string + /** 节点图形类型，目前创建节点仅支持创建图片、文本、基础图形等类型，读取到不支持创建的图形时只返回一些基础信息，如 id、type、text、style 等 */ + type: 'image' | 'text_shape' | 'group' | 'composite_shape' | 'svg' | 'connector' | 'table' | 'life_line' | 'activation' | 'section' | 'table_uml' | 'table_er' | 'sticky_note' | 'mind_map' | 'paint' + /** 父节点 id */ + parent_id?: string + /** 子节点 */ + children?: string[] + /** 图形相对画布的 x 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px */ + x?: number + /** 图形相对画布的 y 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px */ + y?: number + /** 图形旋转角度 */ + angle?: number + /** 图形宽度，单位为 px */ + width?: number + /** 图形高度，单位为 px */ + height?: number + /** 图形内文字 */ + text?: Text + /** 图形样式 */ + style?: Style + /** 图片 */ + image?: Image + /** 基础图形属性 */ + composite_shape?: CompositeShape + /** 连线属性 */ + connector?: Connector + /** 分区属性 */ + section?: Section + /** 表格属性 */ + table?: Table + /** 思维导图属性 */ + mind_map?: MindMap +} + +export interface WikiCatalog { + /** 知识库 token */ + wiki_token?: string +} + +export interface WkCalendarDate { + /** 工作日历WKID */ + calendar_id?: string + /** 日期，格式："2006-01-02" */ + date?: string + /** 日期类型 */ + date_type?: 'day_off' | 'public_holiday' | 'workday' + /** 日期id */ + id?: string +} + +export interface WkCalendarI18n { + /** 中文值 */ + zh_cn?: string + /** 英文值 */ + en_us?: string +} + +export interface WkOption { + /** 是否返回符合条件的工作日历总数 */ + count?: boolean + /** 分页查询的位移，从0开始 */ + offset?: number + /** 分页查询 单次查询数量 */ + limit: number + /** 排序 */ + sort_options?: SortOption[] +} + +export interface WorkCalendarDetail { + /** 工作日历ID */ + calendar_id: string + /** 工作日历名称 */ + calendar_name?: WkCalendarI18n + /** 工作日历是否启用 */ + enable: boolean +} + +export interface WorkCity { + /** 工作城市ID */ + work_city_id?: string + /** 工作城市名称。1-100字符，支持中、英文及符号 */ + name?: string + /** 多语言工作城市 */ + i18n_name?: I18nContent[] + /** 是否启用 */ + status?: boolean +} + +export interface WorkExperience { + company?: string + department?: string + job?: string + start?: string + end?: string + description?: string +} + +export interface WorkExperienceInfo { + /** 公司 / 组织 */ + company_organization?: I18n[] + /** 部门 */ + department?: I18n[] + /** 岗位 */ + job?: I18n[] + /** 工作描述 */ + description?: I18n[] + /** 开始日期 */ + start_date?: string + /** 结束日期 */ + end_date?: string + /** 自定义字段 */ + custom_fields?: CustomFieldData[] +} + +export interface WorkforcePlan { + /** 编制规划方案 ID */ + workforce_plan_id: string + /** 编制规划方案名称 */ + workforce_plan_name?: I18n[] + /** 开始日期 */ + start_date?: string + /** 结束日期 */ + end_date?: string + /** 是否启用 */ + active?: boolean +} + +export interface WorkforcePlanDetail { + /** 编制规划明细 ID */ + workforce_plan_detail_id?: string + /** 部门信息 */ + department?: DimensionInfo + /** 人员类型信息 */ + employee_type?: DimensionInfo + /** 工作地点信息 */ + work_location?: DimensionInfo + /** 序列信息 */ + job_family?: DimensionInfo + /** 职级信息 */ + job_level?: DimensionInfo + /** 职务信息 */ + job?: DimensionInfo + /** 成本中心信息 */ + cost_center?: DimensionInfo + /** 编制规划值 */ + workforce_plan?: string + /** 预估在职人数明细 */ + estimated_active_individuals_detail?: WorkforcePlanEaiDetail[] +} + +export interface WorkforcePlanDetailRow { + /** 维度信息 */ + dimensions: DimensionEntity[] + /** 预估在职人数 */ + eai_details?: WorkforcePlanEaiDetail[] + /** 编制规划值 */ + plan_value?: string +} + +export interface WorkforcePlanEaiDetail { + /** 预估月份 */ + date?: string + /** 预估在职人数 */ + estimated_active_individuals?: string +} + +export interface WorkingHoursType { + /** 实体在CoreHR内部的唯一键 */ + id?: string + /** 编码 */ + code?: string + /** 名称 */ + name: I18n[] + /** 国家/地区 */ + country_region_id_list?: string[] + /** 职务默认值 */ + default_for_job: boolean + /** 启用 */ + active: boolean + /** 自定义字段 */ + custom_fields?: ObjectFieldData[] +} + +export interface WorkLocation { + id?: unknown + name?: string +} + +export interface WorkplaceAccessData { + /** 时间,精确到天,格式yyyy-MM-dd */ + date?: string + /** 全部工作台的访问数据 */ + all_workplace?: AccessData + /** 默认工作台的访问数据 */ + default_workplace?: AccessData +} + +export interface WorkplaceWidget { + /** 最低兼容 lark 版本号 */ + min_lark_version?: string +} + +export interface WriteUserGroupScopeData { + /** 写入成功员工user_id列表 */ + success_user_ids?: string[] + /** 失败的员工信息列表 */ + fail_user_datas?: WriteUserGroupScopeFailUserData[] +} + +export interface WriteUserGroupScopeFailUserData { + /** 员工user_id */ + user_id?: string + /** 失败原因枚举 */ + fail_code?: 1 +} diff --git a/adapters/lark/src/types/lingo.ts b/adapters/lark/src/types/lingo.ts new file mode 100644 index 00000000..4e499f85 --- /dev/null +++ b/adapters/lark/src/types/lingo.ts @@ -0,0 +1,360 @@ +import { Internal } from '../internal' +import { Classification, ClassificationFilter, Draft, Entity, I18nEntryDesc, MatchInfo, OuterInfo, Phrase, RelatedMeta, Repo, Term } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建草稿 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/draft/create + */ + createLingoDraft(body: CreateLingoDraftRequest, query?: CreateLingoDraftQuery): Promise + /** + * 更新草稿 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/draft/update + */ + updateLingoDraft(draft_id: string, body: UpdateLingoDraftRequest, query?: UpdateLingoDraftQuery): Promise + /** + * 创建免审词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/create + */ + createLingoEntity(body: CreateLingoEntityRequest, query?: CreateLingoEntityQuery): Promise + /** + * 更新免审词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/update + */ + updateLingoEntity(entity_id: string, body: UpdateLingoEntityRequest, query?: UpdateLingoEntityQuery): Promise + /** + * 删除免审词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/delete + */ + deleteLingoEntity(entity_id: string, query?: DeleteLingoEntityQuery): Promise + /** + * 获取词条详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/get + */ + getLingoEntity(entity_id: string, query?: GetLingoEntityQuery): Promise + /** + * 获取词条列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/list + */ + listLingoEntity(query?: ListLingoEntityQuery): Promise + /** + * 精准搜索词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/match + */ + matchLingoEntity(body: MatchLingoEntityRequest, query?: MatchLingoEntityQuery): Promise + /** + * 模糊搜索词条 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/search + */ + searchLingoEntity(body: SearchLingoEntityRequest, query?: SearchLingoEntityQuery): Promise + /** + * 词条高亮 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/highlight + */ + highlightLingoEntity(body: HighlightLingoEntityRequest): Promise + /** + * 获取词典分类 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/classification/list + */ + listLingoClassification(query?: ListLingoClassificationQuery): Promise + /** + * 获取词库列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/repo/list + */ + listLingoRepo(): Promise + /** + * 上传图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/file/upload + */ + uploadLingoFile(form: UploadLingoFileForm): Promise + /** + * 下载图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/file/download + */ + downloadLingoFile(file_token: string): Promise + } +} + +export interface CreateLingoDraftRequest { + /** 实体词 Id */ + id?: string + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 外部 id 关联数据 */ + outer_info?: OuterInfo + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string + /** 国际化的词条释义 */ + i18n_descs?: I18nEntryDesc[] +} + +export interface CreateLingoDraftQuery { + /** 词库ID */ + repo_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateLingoDraftRequest { + /** 实体词 Id */ + id?: string + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string + /** 国际化的词条释义 */ + i18n_descs?: I18nEntryDesc[] +} + +export interface UpdateLingoDraftQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateLingoEntityRequest { + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 外部 id 关联数据 */ + outer_info?: OuterInfo + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string + /** 国际化的词条释义 */ + i18n_descs?: I18nEntryDesc[] +} + +export interface CreateLingoEntityQuery { + /** 词库 ID */ + repo_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateLingoEntityRequest { + /** 词条名 */ + main_keys: Term[] + /** 别名 */ + aliases?: Term[] + /** 详情描述 */ + description?: string + /** 相关数据 */ + related_meta?: RelatedMeta + /** 外部 id 关联数据 */ + outer_info?: OuterInfo + /** 富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */ + rich_text?: string + /** 国际化的词条释义 */ + i18n_descs?: I18nEntryDesc[] +} + +export interface UpdateLingoEntityQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteLingoEntityQuery { + /** 数据提供方（使用时需要将路径中的词条 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ + provider?: string + /** 外部唯一 id（使用时需要将路径中的词条 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ + outer_id?: string +} + +export interface GetLingoEntityQuery { + /** 数据提供方（使用时需要将路径中的实体词 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ + provider?: string + /** 外部唯一 id（使用时需要将路径中的实体词 ID 固定为：enterprise_0，且提供 provider 和 outer_id） */ + outer_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListLingoEntityQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 数据提供方【可用来过滤数据】 */ + provider?: string + /** 词库 id */ + repo_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface MatchLingoEntityRequest { + /** 实体词主关键词、全称、别名全匹配 */ + word: string +} + +export interface MatchLingoEntityQuery { + /** 词库ID */ + repo_id?: string +} + +export interface SearchLingoEntityRequest { + /** 搜索关键词 */ + query?: string + /** 分类筛选 */ + classification_filter?: ClassificationFilter + /** 词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建 */ + sources?: number[] + /** 创建者 */ + creators?: string[] +} + +export interface SearchLingoEntityQuery { + /** 每页返回的词条量 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 词库ID */ + repo_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface HighlightLingoEntityRequest { + /** 需要被识别实体词内容的一句话（不要超过1000字） */ + text: string +} + +export interface ListLingoClassificationQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 词库ID */ + repo_id?: string +} + +export interface UploadLingoFileForm { + /** 文件名称，当前仅支持上传图片且图片格式为以下六种：icon、bmp、gif、png、jpeg、webp */ + name: string + /** 二进制文件内容，高宽像素在 320-4096 像素之间，大小在 3KB-10MB 的图片 */ + 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 ListLingoEntityResponse { + /** 词条列表 */ + entities?: Entity[] + /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface MatchLingoEntityResponse { + /** 匹配结果 */ + results?: MatchInfo[] +} + +export interface SearchLingoEntityResponse { + /** 数据数组 */ + entities?: Entity[] + /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface HighlightLingoEntityResponse { + /** 返回识别到的实体词信息 */ + phrases?: Phrase[] +} + +export interface ListLingoClassificationResponse { + /** 分类list */ + items?: Classification[] + /** 分页标记，当还有下一页时会返回新的 page_token，否则 page_token 为空 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +export interface ListLingoRepoResponse { + /** 词库列表 */ + items?: Repo[] +} + +export interface UploadLingoFileResponse { + /** 文件 token */ + file_token?: string +} + +Internal.define({ + '/open-apis/lingo/v1/drafts': { + POST: 'createLingoDraft', + }, + '/open-apis/lingo/v1/drafts/{draft_id}': { + PUT: 'updateLingoDraft', + }, + '/open-apis/lingo/v1/entities': { + POST: 'createLingoEntity', + GET: 'listLingoEntity', + }, + '/open-apis/lingo/v1/entities/{entity_id}': { + PUT: 'updateLingoEntity', + DELETE: 'deleteLingoEntity', + GET: 'getLingoEntity', + }, + '/open-apis/lingo/v1/entities/match': { + POST: 'matchLingoEntity', + }, + '/open-apis/lingo/v1/entities/search': { + POST: 'searchLingoEntity', + }, + '/open-apis/lingo/v1/entities/highlight': { + POST: 'highlightLingoEntity', + }, + '/open-apis/lingo/v1/classifications': { + GET: 'listLingoClassification', + }, + '/open-apis/lingo/v1/repos': { + GET: 'listLingoRepo', + }, + '/open-apis/lingo/v1/files/upload': { + POST: { name: 'uploadLingoFile', multipart: true }, + }, + '/open-apis/lingo/v1/files/{file_token}/download': { + GET: { name: 'downloadLingoFile', type: 'binary' }, + }, +}) diff --git a/adapters/lark/src/types/mail.ts b/adapters/lark/src/types/mail.ts new file mode 100644 index 00000000..853d6616 --- /dev/null +++ b/adapters/lark/src/types/mail.ts @@ -0,0 +1,935 @@ +import { Internal } from '../internal' +import { Attachment, EmailAlias, MailAddress, Mailgroup, MailgroupManager, MailgroupMember, MailgroupPermissionMember, PublicMailbox, PublicMailboxMember, User } from '.' + +declare module '../internal' { + interface Internal { + /** + * 发送邮件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/send + */ + sendMailUserMailboxMessage(user_mailbox_id: string, body: SendMailUserMailboxMessageRequest): Promise + /** + * 创建邮件组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/create + */ + createMailMailgroup(body: CreateMailMailgroupRequest): Promise + /** + * 删除邮件组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/delete + */ + deleteMailMailgroup(mailgroup_id: string): Promise + /** + * 修改邮件组部分信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/patch + */ + patchMailMailgroup(mailgroup_id: string, body: PatchMailMailgroupRequest): Promise + /** + * 修改邮件组全部信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/update + */ + updateMailMailgroup(mailgroup_id: string, body: UpdateMailMailgroupRequest): Promise + /** + * 查询指定邮件组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/get + */ + getMailMailgroup(mailgroup_id: string): Promise + /** + * 批量获取邮件组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list + */ + listMailMailgroup(query?: ListMailMailgroupQuery): Promise + /** + * 批量创建邮件组管理员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create + */ + batchCreateMailMailgroupManager(mailgroup_id: string, body: BatchCreateMailMailgroupManagerRequest, query?: BatchCreateMailMailgroupManagerQuery): Promise + /** + * 批量删除邮件组管理员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_delete + */ + batchDeleteMailMailgroupManager(mailgroup_id: string, body: BatchDeleteMailMailgroupManagerRequest, query?: BatchDeleteMailMailgroupManagerQuery): Promise + /** + * 批量获取邮件组管理员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list + */ + listMailMailgroupManager(mailgroup_id: string, query?: ListMailMailgroupManagerQuery): Promise + /** + * 创建邮件组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create + */ + createMailMailgroupMember(mailgroup_id: string, body: CreateMailMailgroupMemberRequest, query?: CreateMailMailgroupMemberQuery): Promise + /** + * 删除邮件组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/delete + */ + deleteMailMailgroupMember(mailgroup_id: string, member_id: string): Promise + /** + * 查询指定邮件组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/get + */ + getMailMailgroupMember(mailgroup_id: string, member_id: string, query?: GetMailMailgroupMemberQuery): Promise + /** + * 获取所有邮件组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list + */ + listMailMailgroupMember(mailgroup_id: string, query?: ListMailMailgroupMemberQuery): Promise + /** + * 批量创建邮件组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create + */ + batchCreateMailMailgroupMember(mailgroup_id: string, body: BatchCreateMailMailgroupMemberRequest, query?: BatchCreateMailMailgroupMemberQuery): Promise + /** + * 批量删除邮件组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_delete + */ + batchDeleteMailMailgroupMember(mailgroup_id: string, body: BatchDeleteMailMailgroupMemberRequest): Promise + /** + * 创建邮件组别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/create + */ + createMailMailgroupAlias(mailgroup_id: string, body: CreateMailMailgroupAliasRequest): Promise + /** + * 删除邮件组别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/delete + */ + deleteMailMailgroupAlias(mailgroup_id: string, alias_id: string): Promise + /** + * 获取邮件组所有别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/list + */ + listMailMailgroupAlias(mailgroup_id: string): Promise + /** + * 创建邮件组权限成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/create + */ + createMailMailgroupPermissionMember(mailgroup_id: string, body: CreateMailMailgroupPermissionMemberRequest, query?: CreateMailMailgroupPermissionMemberQuery): Promise + /** + * 删除邮件组权限成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/delete + */ + deleteMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string): Promise + /** + * 获取邮件组权限成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/get + */ + getMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string, query?: GetMailMailgroupPermissionMemberQuery): Promise + /** + * 批量获取邮件组权限成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list + */ + listMailMailgroupPermissionMember(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery): Promise + /** + * 批量创建邮件组权限成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create + */ + batchCreateMailMailgroupPermissionMember(mailgroup_id: string, body: BatchCreateMailMailgroupPermissionMemberRequest, query?: BatchCreateMailMailgroupPermissionMemberQuery): Promise + /** + * 批量删除邮件组权限成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_delete + */ + batchDeleteMailMailgroupPermissionMember(mailgroup_id: string, body: BatchDeleteMailMailgroupPermissionMemberRequest): Promise + /** + * 创建公共邮箱 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/create + */ + createMailPublicMailbox(body: CreateMailPublicMailboxRequest): Promise + /** + * 修改公共邮箱部分信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/patch + */ + patchMailPublicMailbox(public_mailbox_id: string, body: PatchMailPublicMailboxRequest): Promise + /** + * 修改公共邮箱全部信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/update + */ + updateMailPublicMailbox(public_mailbox_id: string, body: UpdateMailPublicMailboxRequest): Promise + /** + * 查询指定公共邮箱 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/get + */ + getMailPublicMailbox(public_mailbox_id: string): Promise + /** + * 查询所有公共邮箱 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list + */ + listMailPublicMailbox(query?: ListMailPublicMailboxQuery): Promise + /** + * 永久删除公共邮箱 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete + */ + deleteMailPublicMailbox(public_mailbox_id: string): Promise + /** + * 添加公共邮箱成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/create + */ + createMailPublicMailboxMember(public_mailbox_id: string, body: CreateMailPublicMailboxMemberRequest, query?: CreateMailPublicMailboxMemberQuery): Promise + /** + * 删除公共邮箱单个成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/delete + */ + deleteMailPublicMailboxMember(public_mailbox_id: string, member_id: string): Promise + /** + * 删除公共邮箱所有成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/clear + */ + clearMailPublicMailboxMember(public_mailbox_id: string): Promise + /** + * 查询指定公共邮箱成员信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/get + */ + getMailPublicMailboxMember(public_mailbox_id: string, member_id: string, query?: GetMailPublicMailboxMemberQuery): Promise + /** + * 查询所有公共邮箱成员信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list + */ + listMailPublicMailboxMember(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery): Promise + /** + * 批量添加公共邮箱成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create + */ + batchCreateMailPublicMailboxMember(public_mailbox_id: string, body: BatchCreateMailPublicMailboxMemberRequest, query?: BatchCreateMailPublicMailboxMemberQuery): Promise + /** + * 批量删除公共邮箱成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_delete + */ + batchDeleteMailPublicMailboxMember(public_mailbox_id: string, body: BatchDeleteMailPublicMailboxMemberRequest): Promise + /** + * 创建公共邮箱别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/create + */ + createMailPublicMailboxAlias(public_mailbox_id: string, body: CreateMailPublicMailboxAliasRequest): Promise + /** + * 删除公共邮箱别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/delete + */ + deleteMailPublicMailboxAlias(public_mailbox_id: string, alias_id: string): Promise + /** + * 查询公共邮箱的所有别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/list + */ + listMailPublicMailboxAlias(public_mailbox_id: string): Promise + /** + * 从回收站删除用户邮箱地址 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox/delete + */ + deleteMailUserMailbox(user_mailbox_id: string, query?: DeleteMailUserMailboxQuery): Promise + /** + * 创建用户邮箱别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/create + */ + createMailUserMailboxAlias(user_mailbox_id: string, body: CreateMailUserMailboxAliasRequest): Promise + /** + * 删除用户邮箱别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/delete + */ + deleteMailUserMailboxAlias(user_mailbox_id: string, alias_id: string): Promise + /** + * 获取用户邮箱所有别名 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/list + */ + listMailUserMailboxAlias(user_mailbox_id: string, query?: ListMailUserMailboxAliasQuery): Promise + /** + * 查询邮箱地址状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user/query + */ + queryMailUser(body: QueryMailUserRequest): Promise + } +} + +export interface SendMailUserMailboxMessageRequest { + /** MIME邮件数据，基于base64url编码 */ + raw?: string + /** 主题 */ + subject?: string + /** 收件人 */ + to?: MailAddress[] + /** 抄送 */ + cc?: MailAddress[] + /** 秘送 */ + bcc?: MailAddress[] + /** 发件人 */ + head_from?: MailAddress + /** 正文(base64url) */ + body_html?: string + /** 正文纯文本(base64url) */ + body_plain_text?: string + /** 邮件附件列表 */ + attachments?: Attachment[] + /** 会话id */ + thread_id?: string +} + +export interface CreateMailMailgroupRequest { + /** The mail group's email address */ + email?: string + /** The mail group's display name */ + name?: string + /** The mail group's description */ + description?: string + /** 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 + /** The mail group's display name */ + name?: string + /** The mail group's description */ + description?: string + /** 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 + /** The mail group's display name */ + name?: string + /** The mail group's description */ + description?: string + /** 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 { + /** 邮件组管理员用户ID，用于获取该用户有管理权限的邮件组 */ + manager_user_id?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface BatchCreateMailMailgroupManagerRequest { + /** 邮件组管理员列表 */ + mailgroup_manager_list?: MailgroupManager[] +} + +export interface BatchCreateMailMailgroupManagerQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchDeleteMailMailgroupManagerRequest { + /** 邮件组管理员列表 */ + mailgroup_manager_list?: MailgroupManager[] +} + +export interface BatchDeleteMailMailgroupManagerQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListMailMailgroupManagerQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateMailMailgroupMemberRequest { + /** 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 CreateMailMailgroupMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface GetMailMailgroupMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface ListMailMailgroupMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface BatchCreateMailMailgroupMemberRequest { + /** 本次添加的邮件组成员列表 */ + items?: MailgroupMember[] +} + +export interface BatchCreateMailMailgroupMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface BatchDeleteMailMailgroupMemberRequest { + /** 本次调用删除的成员ID列表 */ + member_id_list?: string[] +} + +export interface CreateMailMailgroupAliasRequest { + /** 邮箱别名 */ + email_alias?: string +} + +export interface CreateMailMailgroupPermissionMemberRequest { + /** 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 CreateMailMailgroupPermissionMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface GetMailMailgroupPermissionMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface ListMailMailgroupPermissionMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface BatchCreateMailMailgroupPermissionMemberRequest { + /** 本次添加的邮件组权限成员列表 */ + items?: MailgroupPermissionMember[] +} + +export interface BatchCreateMailMailgroupPermissionMemberQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 此次调用中使用的部门ID的类型 */ + department_id_type?: 'department_id' | 'open_department_id' +} + +export interface BatchDeleteMailMailgroupPermissionMemberRequest { + /** 本次调用删除的权限成员ID列表 */ + permission_member_id_list: string[] +} + +export interface CreateMailPublicMailboxRequest { + /** The public mailbox's email address */ + email?: string + /** The public mailbox's display name */ + name?: string + /** 数据驻留地 */ + geo?: string +} + +export interface PatchMailPublicMailboxRequest { + /** The public mailbox's new primary email address */ + email?: string + /** The public mailbox's display name */ + name?: string +} + +export interface UpdateMailPublicMailboxRequest { + /** The public mailbox's new primary email address */ + email?: string + /** The public mailbox's display name */ + name?: string +} + +export interface ListMailPublicMailboxQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +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 { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +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 ListMailUserMailboxAliasQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +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 ListMailMailgroupResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + items?: Mailgroup[] +} + +export interface ListMailMailgroupManagerResponse { + /** 邮件组管理员列表 */ + items?: MailgroupManager[] + /** 分页标识 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +export interface CreateMailMailgroupMemberResponse { + /** The unique ID of a member in this mail group */ + member_id?: string + /** 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 ListMailMailgroupMemberResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + items?: MailgroupMember[] +} + +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 ListMailMailgroupPermissionMemberResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + items?: MailgroupPermissionMember[] +} + +export interface BatchCreateMailMailgroupPermissionMemberResponse { + /** 添加成功后的邮件组权限成员信息列表 */ + items?: MailgroupPermissionMember[] +} + +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 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 +} + +export interface UpdateMailPublicMailboxResponse { + /** 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 +} + +export interface GetMailPublicMailboxResponse { + /** 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 ListMailPublicMailboxResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + /** 邮箱列表 */ + items?: PublicMailbox[] +} + +export interface CreateMailPublicMailboxMemberResponse { + /** The unique ID of a member in this public mailbox */ + member_id?: string + /** 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 GetMailPublicMailboxMemberResponse { + /** The unique ID of a member in this public mailbox */ + member_id?: string + /** 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 ListMailPublicMailboxMemberResponse { + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string + items?: PublicMailboxMember[] +} + +export interface BatchCreateMailPublicMailboxMemberResponse { + /** 添加成功后的公共邮箱成员信息列表 */ + items?: PublicMailboxMember[] +} + +export interface CreateMailPublicMailboxAliasResponse { + /** 公共邮箱别名 */ + public_mailbox_alias?: EmailAlias +} + +export interface ListMailPublicMailboxAliasResponse { + /** 公共邮箱别名 */ + items?: EmailAlias[] +} + +export interface CreateMailUserMailboxAliasResponse { + /** 用户邮箱别名 */ + user_mailbox_alias?: EmailAlias +} + +export interface ListMailUserMailboxAliasResponse { + /** 用户邮箱别名 */ + items?: EmailAlias[] +} + +export interface QueryMailUserResponse { + /** 邮箱地址返回 */ + user_list?: User[] +} + +Internal.define({ + '/open-apis/mail/v1/user_mailboxes/{user_mailbox_id}/messages/send': { + POST: 'sendMailUserMailboxMessage', + }, + '/open-apis/mail/v1/mailgroups': { + POST: 'createMailMailgroup', + GET: 'listMailMailgroup', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}': { + DELETE: 'deleteMailMailgroup', + PATCH: 'patchMailMailgroup', + PUT: 'updateMailMailgroup', + GET: 'getMailMailgroup', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/managers/batch_create': { + POST: 'batchCreateMailMailgroupManager', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/managers/batch_delete': { + POST: 'batchDeleteMailMailgroupManager', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/managers': { + GET: 'listMailMailgroupManager', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/members': { + POST: 'createMailMailgroupMember', + GET: 'listMailMailgroupMember', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/members/{member_id}': { + DELETE: 'deleteMailMailgroupMember', + GET: 'getMailMailgroupMember', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/members/batch_create': { + POST: 'batchCreateMailMailgroupMember', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/members/batch_delete': { + DELETE: 'batchDeleteMailMailgroupMember', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/aliases': { + POST: 'createMailMailgroupAlias', + GET: 'listMailMailgroupAlias', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/aliases/{alias_id}': { + DELETE: 'deleteMailMailgroupAlias', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/permission_members': { + POST: 'createMailMailgroupPermissionMember', + GET: 'listMailMailgroupPermissionMember', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/permission_members/{permission_member_id}': { + DELETE: 'deleteMailMailgroupPermissionMember', + GET: 'getMailMailgroupPermissionMember', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/permission_members/batch_create': { + POST: 'batchCreateMailMailgroupPermissionMember', + }, + '/open-apis/mail/v1/mailgroups/{mailgroup_id}/permission_members/batch_delete': { + DELETE: 'batchDeleteMailMailgroupPermissionMember', + }, + '/open-apis/mail/v1/public_mailboxes': { + POST: 'createMailPublicMailbox', + GET: 'listMailPublicMailbox', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}': { + PATCH: 'patchMailPublicMailbox', + PUT: 'updateMailPublicMailbox', + GET: 'getMailPublicMailbox', + DELETE: 'deleteMailPublicMailbox', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/members': { + POST: 'createMailPublicMailboxMember', + GET: 'listMailPublicMailboxMember', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/members/{member_id}': { + DELETE: 'deleteMailPublicMailboxMember', + GET: 'getMailPublicMailboxMember', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/members/clear': { + POST: 'clearMailPublicMailboxMember', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/members/batch_create': { + POST: 'batchCreateMailPublicMailboxMember', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/members/batch_delete': { + DELETE: 'batchDeleteMailPublicMailboxMember', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/aliases': { + POST: 'createMailPublicMailboxAlias', + GET: 'listMailPublicMailboxAlias', + }, + '/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/aliases/{alias_id}': { + DELETE: 'deleteMailPublicMailboxAlias', + }, + '/open-apis/mail/v1/user_mailboxes/{user_mailbox_id}': { + DELETE: 'deleteMailUserMailbox', + }, + '/open-apis/mail/v1/user_mailboxes/{user_mailbox_id}/aliases': { + POST: 'createMailUserMailboxAlias', + GET: 'listMailUserMailboxAlias', + }, + '/open-apis/mail/v1/user_mailboxes/{user_mailbox_id}/aliases/{alias_id}': { + DELETE: 'deleteMailUserMailboxAlias', + }, + '/open-apis/mail/v1/users/query': { + POST: 'queryMailUser', + }, +}) diff --git a/adapters/lark/src/types/mdm.ts b/adapters/lark/src/types/mdm.ts new file mode 100644 index 00000000..f8acbff5 --- /dev/null +++ b/adapters/lark/src/types/mdm.ts @@ -0,0 +1,57 @@ +import { Internal } from '../internal' + +declare module '../internal' { + interface Internal { + /** + * 用户数据维度绑定 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/bind + */ + bindMdmUserAuthDataRelation(body: BindMdmUserAuthDataRelationRequest, query?: BindMdmUserAuthDataRelationQuery): Promise + /** + * 用户数据维度解绑 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/unbind + */ + unbindMdmUserAuthDataRelation(body: UnbindMdmUserAuthDataRelationRequest, query?: UnbindMdmUserAuthDataRelationQuery): Promise + } +} + +export interface BindMdmUserAuthDataRelationRequest { + /** 数据类型编码 */ + root_dimension_type: string + /** 数据编码列表 */ + sub_dimension_types: string[] + /** 授权人的lark id */ + authorized_user_ids: string[] + /** uams系统中应用id */ + uams_app_id: string +} + +export interface BindMdmUserAuthDataRelationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UnbindMdmUserAuthDataRelationRequest { + /** 数据类型编码 */ + root_dimension_type: string + /** 数据编码列表 */ + sub_dimension_types: string[] + /** 授权人的lark id */ + authorized_user_ids: string[] + /** uams系统中应用id */ + uams_app_id: string +} + +export interface UnbindMdmUserAuthDataRelationQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +Internal.define({ + '/open-apis/mdm/v1/user_auth_data_relations/bind': { + POST: 'bindMdmUserAuthDataRelation', + }, + '/open-apis/mdm/v1/user_auth_data_relations/unbind': { + POST: 'unbindMdmUserAuthDataRelation', + }, +}) diff --git a/adapters/lark/src/types/message/index.ts b/adapters/lark/src/types/message/index.ts deleted file mode 100644 index 0b6191a9..00000000 --- a/adapters/lark/src/types/message/index.ts +++ /dev/null @@ -1,97 +0,0 @@ -import { Lark, MessageContent } from '..' - -export * from './content' - -declare module '../event' { - export interface Events { - /** - * Receive message event. - * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/receive - */ - 'im.message.receive_v1': { - sender: { - sender_id: Lark.UserIds - sender_type?: string - tenant_key: string - } - message: { - message_id: string - root_id: string - parent_id: string - thread_id: string - create_time: string - chat_id: string - chat_type: string - message_type: keyof MessageContent - content: string - mentions: { - key: string - id: Lark.UserIds - name: string - tenant_key: string - }[] - } - } - /** - * Message read event. - * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/message_read - */ - 'im.message.message_read_v1': { - reader: { - reader_id: Lark.UserIds - read_time: string - tenant_key: string - } - message_id_list: string[] - } - /** - * Message card callback event. - * @see https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-callback-communication - */ - 'card.action.trigger': { - operator: { - tenant_key: string - user_id: string - union_id: string - open_id: string - } - token: string - action: { - value: any - tag: string - timezone?: string - name?: string - form_value?: any - input_value?: string - option?: string - options?: string[] - checked?: boolean - } - host: string - /** 卡片分发类型，固定取值为 url_preview，表示链接预览卡片。仅链接预览卡片有此字段。 */ - delivery_type?: 'url_preview' - context: { - url?: string - preview_token?: string - open_message_id: string - open_chat_id: string - } - } - /** - * 机器人自定义菜单事件 - * @see https://open.feishu.cn/document/client-docs/bot-v3/events/menu - */ - 'application.bot.menu_v6': { - operator: { - operator_name: string - operator_id: { - union_id: string - user_id: string - open_id: string - } - } - event_key: string - timestamp: number - } - } -} diff --git a/adapters/lark/src/types/minutes.ts b/adapters/lark/src/types/minutes.ts new file mode 100644 index 00000000..b97944a5 --- /dev/null +++ b/adapters/lark/src/types/minutes.ts @@ -0,0 +1,46 @@ +import { Internal } from '../internal' +import { Minute, Statictics } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取妙记统计数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-statistics/get + */ + getMinutesMinuteStatistics(minute_token: string, query?: GetMinutesMinuteStatisticsQuery): Promise + /** + * 获取妙记信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute/get + */ + getMinutesMinute(minute_token: string, query?: GetMinutesMinuteQuery): Promise + } +} + +export interface GetMinutesMinuteStatisticsQuery { + /** 此次调用中使用的用户ID的类型 */ + 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 GetMinutesMinuteResponse { + /** 妙记基本信息 */ + minute?: Minute +} + +Internal.define({ + '/open-apis/minutes/v1/minutes/{minute_token}/statistics': { + GET: 'getMinutesMinuteStatistics', + }, + '/open-apis/minutes/v1/minutes/{minute_token}': { + GET: 'getMinutesMinute', + }, +}) diff --git a/adapters/lark/src/types/moments.ts b/adapters/lark/src/types/moments.ts new file mode 100644 index 00000000..03c8d4c0 --- /dev/null +++ b/adapters/lark/src/types/moments.ts @@ -0,0 +1,28 @@ +import { Internal } from '../internal' +import { Post } from '.' + +declare module '../internal' { + interface Internal { + /** + * 查询帖子信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/moments-v1/post/get + */ + getMomentsPost(post_id: string, query?: GetMomentsPostQuery): Promise + } +} + +export interface GetMomentsPostQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetMomentsPostResponse { + /** 帖子实体 */ + post?: Post +} + +Internal.define({ + '/open-apis/moments/v1/posts/{post_id}': { + GET: 'getMomentsPost', + }, +}) diff --git a/adapters/lark/src/types/okr.ts b/adapters/lark/src/types/okr.ts new file mode 100644 index 00000000..903518fd --- /dev/null +++ b/adapters/lark/src/types/okr.ts @@ -0,0 +1,277 @@ +import { Internal } from '../internal' +import { ContentBlock, OkrBatch, OkrReview, Period, PeriodRule } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建 OKR 周期 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create + */ + createOkrPeriod(body: CreateOkrPeriodRequest): Promise + /** + * 修改 OKR 周期状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch + */ + patchOkrPeriod(period_id: string, body: PatchOkrPeriodRequest): Promise + /** + * 获取 OKR 周期列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list + */ + listOkrPeriod(query?: ListOkrPeriodQuery): Promise + /** + * 获取 OKR 周期规则 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list + */ + listOkrPeriodRule(): Promise + /** + * 获取用户的 OKR 列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list + */ + listOkrUserOkr(user_id: string, query?: ListOkrUserOkrQuery): Promise + /** + * 批量获取 OKR + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/okr/batch_get + */ + batchGetOkr(query?: BatchGetOkrQuery): Promise + /** + * 创建 OKR 进展记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create + */ + createOkrProgressRecord(body: CreateOkrProgressRecordRequest, query?: CreateOkrProgressRecordQuery): Promise + /** + * 删除 OKR 进展记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete + */ + deleteOkrProgressRecord(progress_id: string): Promise + /** + * 更新 OKR 进展记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update + */ + updateOkrProgressRecord(progress_id: string, body: UpdateOkrProgressRecordRequest, query?: UpdateOkrProgressRecordQuery): Promise + /** + * 获取 OKR 进展记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get + */ + getOkrProgressRecord(progress_id: string, query?: GetOkrProgressRecordQuery): Promise + /** + * 上传进展记录图片 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload + */ + uploadOkrImage(form: UploadOkrImageForm): Promise + /** + * 查询复盘信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query + */ + queryOkrReview(query?: QueryOkrReviewQuery): Promise + } +} + +export interface CreateOkrPeriodRequest { + /** 周期规则 id */ + period_rule_id: string + /** 周期起始年月 */ + start_month: string +} + +export interface PatchOkrPeriodRequest { + /** 周期显示状态 */ + status: 1 | 2 | 3 +} + +export interface ListOkrPeriodQuery { + /** 分页标志page_token */ + page_token?: string + /** 分页大小，默认10 */ + page_size?: number +} + +export interface ListOkrUserOkrQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 请求列表的偏移，offset>=0 */ + offset: string + /** 列表长度，0-10 */ + limit: string + /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn */ + lang?: string + /** period_id列表，最多10个 */ + period_ids?: string[] +} + +export interface BatchGetOkrQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** OKR ID 列表，最多10个 */ + okr_ids: string[] + /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn，请求 Query中 */ + lang?: string +} + +export interface CreateOkrProgressRecordRequest { + /** 进展来源 */ + source_title: string + /** 进展来源链接 */ + source_url: string + /** 目标id，与target_type对应 */ + target_id: string + /** 目标类型 */ + target_type: 2 | 3 + /** 进展详情 富文本格式 */ + content: ContentBlock + /** pc进展来源链接 */ + source_url_pc?: string + /** mobile进展来源链接 */ + source_url_mobile?: string +} + +export interface CreateOkrProgressRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateOkrProgressRecordRequest { + /** 进展详情 富文本格式 */ + content: ContentBlock +} + +export interface UpdateOkrProgressRecordQuery { + /** 此次调用中使用的用户ID的类型 */ + 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 ListOkrPeriodResponse { + /** 分页标志 */ + page_token?: string + /** 是否有更多 */ + has_more?: boolean + /** 数据项 */ + items?: Period[] +} + +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 { + /** OKR 进展ID */ + progress_id?: string + /** 进展更新时间 毫秒 */ + modify_time?: string + /** 进展 对应的 Content 详细内容 */ + content?: ContentBlock +} + +export interface UpdateOkrProgressRecordResponse { + /** OKR 进展ID */ + progress_id?: string + /** 进展更新时间 毫秒 */ + modify_time?: string + /** 进展 对应的 Content 详细内容 */ + content?: ContentBlock +} + +export interface GetOkrProgressRecordResponse { + /** OKR 进展ID */ + progress_id?: string + /** 进展更新时间 毫秒 */ + modify_time?: string + /** 进展 对应的 Content 详细内容 */ + content?: ContentBlock +} + +export interface UploadOkrImageResponse { + /** 图片token */ + file_token?: string + /** 图片下载链接 */ + url?: string +} + +export interface QueryOkrReviewResponse { + /** OKR复盘 列表 */ + review_list?: OkrReview[] +} + +Internal.define({ + '/open-apis/okr/v1/periods': { + POST: 'createOkrPeriod', + GET: 'listOkrPeriod', + }, + '/open-apis/okr/v1/periods/{period_id}': { + PATCH: 'patchOkrPeriod', + }, + '/open-apis/okr/v1/period_rules': { + GET: 'listOkrPeriodRule', + }, + '/open-apis/okr/v1/users/{user_id}/okrs': { + GET: 'listOkrUserOkr', + }, + '/open-apis/okr/v1/okrs/batch_get': { + GET: 'batchGetOkr', + }, + '/open-apis/okr/v1/progress_records': { + POST: 'createOkrProgressRecord', + }, + '/open-apis/okr/v1/progress_records/{progress_id}': { + DELETE: 'deleteOkrProgressRecord', + PUT: 'updateOkrProgressRecord', + GET: 'getOkrProgressRecord', + }, + '/open-apis/okr/v1/images/upload': { + POST: { name: 'uploadOkrImage', multipart: true }, + }, + '/open-apis/okr/v1/reviews/query': { + GET: 'queryOkrReview', + }, +}) diff --git a/adapters/lark/src/types/optical_char_recognition.ts b/adapters/lark/src/types/optical_char_recognition.ts new file mode 100644 index 00000000..e15898c3 --- /dev/null +++ b/adapters/lark/src/types/optical_char_recognition.ts @@ -0,0 +1,27 @@ +import { Internal } from '../internal' + +declare module '../internal' { + interface Internal { + /** + * 识别图片中的文字 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize + */ + basicRecognizeOpticalCharRecognitionImage(body: BasicRecognizeOpticalCharRecognitionImageRequest): Promise + } +} + +export interface BasicRecognizeOpticalCharRecognitionImageRequest { + /** base64 后的图片数据 */ + image?: string +} + +export interface BasicRecognizeOpticalCharRecognitionImageResponse { + /** 按区域识别，返回文本列表 */ + text_list: string[] +} + +Internal.define({ + '/open-apis/optical_char_recognition/v1/image/basic_recognize': { + POST: 'basicRecognizeOpticalCharRecognitionImage', + }, +}) diff --git a/adapters/lark/src/types/passport.ts b/adapters/lark/src/types/passport.ts new file mode 100644 index 00000000..5294952b --- /dev/null +++ b/adapters/lark/src/types/passport.ts @@ -0,0 +1,61 @@ +import { Internal } from '../internal' +import { MaskSession } from '.' + +declare module '../internal' { + interface Internal { + /** + * 批量获取脱敏的用户登录信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/query + */ + queryPassportSession(body: QueryPassportSessionRequest, query?: QueryPassportSessionQuery): Promise + /** + * 退出登录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/logout + */ + logoutPassportSession(body: LogoutPassportSessionRequest, query?: LogoutPassportSessionQuery): Promise + } +} + +export interface QueryPassportSessionRequest { + /** 用户 ID */ + user_ids?: string[] +} + +export interface QueryPassportSessionQuery { + /** 用户id类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface LogoutPassportSessionRequest { + /** idp 侧的唯一标识 */ + idp_credential_id?: string + /** 登出的方式 */ + logout_type: 1 | 2 | 3 + /** 登出的客户端类型，默认全部登出，1-桌面端，2-网页端，3-安卓移动端，4-Apple移动端 5-服务端 6-旧版小程序端 8-其他移动端 */ + terminal_type?: number[] + /** user_id */ + user_id?: string + /** 登出原因 */ + logout_reason?: number + /** 需要精确登出的 session 标识符 */ + sid?: string +} + +export interface LogoutPassportSessionQuery { + /** user_id_type */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface QueryPassportSessionResponse { + /** session信息 */ + mask_sessions?: MaskSession[] +} + +Internal.define({ + '/open-apis/passport/v1/sessions/query': { + POST: 'queryPassportSession', + }, + '/open-apis/passport/v1/sessions/logout': { + POST: 'logoutPassportSession', + }, +}) diff --git a/adapters/lark/src/types/payroll.ts b/adapters/lark/src/types/payroll.ts new file mode 100644 index 00000000..ceb2de82 --- /dev/null +++ b/adapters/lark/src/types/payroll.ts @@ -0,0 +1,118 @@ +import { Internal } from '../internal' +import { AcctItem, CostAllocationPlan, CostAllocationReportData, I18nContent, Paygroup } from '.' + +declare module '../internal' { + interface Internal { + /** + * 批量查询算薪项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/acct_item/list + */ + listPayrollAcctItem(query?: ListPayrollAcctItemQuery): Promise + /** + * 查询成本分摊报表汇总数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_report/list + */ + listPayrollCostAllocationReport(query?: ListPayrollCostAllocationReportQuery): Promise + /** + * 批量查询成本分摊方案 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_plan/list + */ + listPayrollCostAllocationPlan(query?: ListPayrollCostAllocationPlanQuery): Promise + /** + * 获取薪资组基本信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list + */ + listPayrollPaygroup(query?: ListPayrollPaygroupQuery): Promise + } +} + +export interface ListPayrollAcctItemQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListPayrollCostAllocationReportQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 成本分摊方案ID */ + cost_allocation_plan_id: string + /** 期间 */ + pay_period: string + /** 报表类型 */ + report_type: 0 | 1 | 2 +} + +export interface ListPayrollCostAllocationPlanQuery { + /** 分页大小 */ + page_size: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 期间 */ + pay_period: string +} + +export interface ListPayrollPaygroupQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface ListPayrollAcctItemResponse { + /** 算薪项列表 */ + items?: AcctItem[] + /** 下一页开始 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface ListPayrollCostAllocationReportResponse { + /** 期间 */ + pay_period?: string + /** 下一页开始 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean + /** 报表名称 */ + cost_allocation_report_names?: I18nContent[] + /** 汇总数据 */ + cost_allocation_report_datas?: CostAllocationReportData[] +} + +export interface ListPayrollCostAllocationPlanResponse { + /** 方案 */ + items?: CostAllocationPlan[] + /** 下一页开始 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface ListPayrollPaygroupResponse { + /** 薪资组列表 */ + items?: Paygroup[] + /** 分页标识符 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +Internal.define({ + '/open-apis/payroll/v1/acct_items': { + GET: 'listPayrollAcctItem', + }, + '/open-apis/payroll/v1/cost_allocation_reports': { + GET: 'listPayrollCostAllocationReport', + }, + '/open-apis/payroll/v1/cost_allocation_plans': { + GET: 'listPayrollCostAllocationPlan', + }, + '/open-apis/payroll/v1/paygroups': { + GET: 'listPayrollPaygroup', + }, +}) diff --git a/adapters/lark/src/types/performance.ts b/adapters/lark/src/types/performance.ts new file mode 100644 index 00000000..0cda7086 --- /dev/null +++ b/adapters/lark/src/types/performance.ts @@ -0,0 +1,628 @@ +import { Internal } from '../internal' +import { Activity, AdditionalInformation, Field, ImportedMetric, Indicator, MetricField, MetricInLibrary, MetricTag, MetricTemplate, Question, ReviewProfile, ReviewTemplate, Reviewee, RevieweeMetric, Semester, SemesterBaseInfo, StageTask, Template, Unit, WriteUserGroupScopeData } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取周期列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/semester/list + */ + listPerformanceSemester(query?: ListPerformanceSemesterQuery): Promise + /** + * 获取项目列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/activity/query + */ + queryPerformanceActivity(body: QueryPerformanceActivityRequest, query?: QueryPerformanceActivityQuery): Promise + /** + * 批量查询补充信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/query + */ + queryPerformanceAdditionalInformation(body: QueryPerformanceAdditionalInformationRequest, query?: QueryPerformanceAdditionalInformationQuery): Promise + /** + * 批量导入补充信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/import + */ + importPerformanceAdditionalInformation(body: ImportPerformanceAdditionalInformationRequest, query?: ImportPerformanceAdditionalInformationQuery): Promise + /** + * 批量删除补充信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_informations-batch/delete + */ + deletePerformanceAdditionalInformationsBatch(body: DeletePerformanceAdditionalInformationsBatchRequest, query?: DeletePerformanceAdditionalInformationsBatchQuery): Promise + /** + * 更新人员组成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/user_group_user_rel/write + */ + writePerformanceUserGroupUserRel(body: WritePerformanceUserGroupUserRelRequest, query?: WritePerformanceUserGroupUserRelQuery): Promise + /** + * 获取被评估人信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/reviewee/query + */ + queryPerformanceReviewee(body: QueryPerformanceRevieweeRequest, query?: QueryPerformanceRevieweeQuery): Promise + /** + * 获取评估模板配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_template/query + */ + queryPerformanceReviewTemplate(body: QueryPerformanceReviewTemplateRequest, query?: QueryPerformanceReviewTemplateQuery): Promise + /** + * 获取评估项列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/indicator/query + */ + queryPerformanceIndicator(body: QueryPerformanceIndicatorRequest, query?: QueryPerformanceIndicatorQuery): Promise + /** + * 获取标签填写题配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/question/query + */ + queryPerformanceQuestion(body: QueryPerformanceQuestionRequest, query?: QueryPerformanceQuestionQuery): Promise + /** + * 获取指标列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_lib/query + */ + queryPerformanceMetricLib(body: QueryPerformanceMetricLibRequest, query?: QueryPerformanceMetricLibQuery): Promise + /** + * 获取指标模板列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_template/query + */ + queryPerformanceMetricTemplate(body: QueryPerformanceMetricTemplateRequest, query?: QueryPerformanceMetricTemplateQuery): Promise + /** + * 获取指标字段列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_field/query + */ + queryPerformanceMetricField(body: QueryPerformanceMetricFieldRequest): Promise + /** + * 获取指标标签列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_tag/list + */ + listPerformanceMetricTag(query?: ListPerformanceMetricTagQuery): Promise + /** + * 获取周期任务（指定用户） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_user_list + */ + findByUserListPerformanceStageTask(body: FindByUserListPerformanceStageTaskRequest, query?: FindByUserListPerformanceStageTaskQuery): Promise + /** + * 获取周期任务（全部用户） + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_page + */ + findByPagePerformanceStageTask(body: FindByPagePerformanceStageTaskRequest, query?: FindByPagePerformanceStageTaskQuery): Promise + /** + * 获取被评估人关键指标结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_detail/query + */ + queryPerformanceMetricDetail(body: QueryPerformanceMetricDetailRequest, query?: QueryPerformanceMetricDetailQuery): Promise + /** + * 录入被评估人关键指标数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_detail/import + */ + importPerformanceMetricDetail(body: ImportPerformanceMetricDetailRequest, query?: ImportPerformanceMetricDetailQuery): Promise + /** + * 获取绩效结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/review_data/query + */ + queryPerformanceReviewData(body: QueryPerformanceReviewDataRequest, query?: QueryPerformanceReviewDataQuery): Promise + /** + * 获取绩效详情数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_data/query + */ + queryPerformanceReviewData(body: QueryPerformanceReviewDataRequest, query?: QueryPerformanceReviewDataQuery): Promise + } +} + +export interface ListPerformanceSemesterQuery { + /** 周期开始时间 */ + start_time?: string + /** 周期结束时间 */ + end_time?: string + /** 年份 */ + year?: number + /** 周期类型分组 */ + type_group?: 'Annual' | 'Semi-annual' | 'Quarter' | 'Bimonth' | 'Month' | 'Non-standard' + /** 周期类型 */ + type?: 'Annual' | 'H1' | 'H2' | 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'January-February' | 'March-April' | 'May-June' | 'July-August' | 'September-October' | 'November-December' | 'January' | 'February' | 'March' | 'April' | 'May' | 'June' | 'July' | 'August' | 'September' | 'October' | 'November' | 'December' | 'Custom' + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface QueryPerformanceActivityRequest { + /** 评估周期 ID 列表，获取指定评估周期的项目 ID，semester_id 可通过【获取周期】接口获得 */ + semester_ids?: string[] + /** 项目 ID 列表，如果同时传了「semester_ids」，则优先以「activity_ids」进行查询 */ + activity_ids?: string[] +} + +export interface QueryPerformanceActivityQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface QueryPerformanceAdditionalInformationRequest { + /** 评估周期 ID 列表，semester_id 可通过【获取周期】接口获得 */ + semester_id: string + /** 事项 ID 列表，获取指定事项 ID 的信息。以下请求参数中「item_ids」、「external_ids」、「reviewee_user_ids」均为空时，返回该评估周期的所有补充信息。若单次请求中多个请求参数有值，按照【item_ids > external_ids > reviewee_user_ids】的顺序只识别第一个有值的请求参数 */ + item_ids?: string[] + /** 外部系统的事项 ID 列表，获取对应的飞书绩效事项 ID。「item_ids」参数有值时该参数不生效 */ + external_ids?: string[] + /** 被评估人 ID 列表，获取周期下被评估人的事项信息。「item_ids」、「external_ids」参数有值时该参数不生效 */ + reviewee_user_ids?: string[] +} + +export interface QueryPerformanceAdditionalInformationQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 示例值：30 默认值：20 数据校验规则：最大值：50 */ + page_size?: number +} + +export interface ImportPerformanceAdditionalInformationRequest { + /** 评估周期 ID 列表，semester_id 可通过【获取周期】接口获得 */ + semester_id: string + /** 补充信息列表，一次最多 1000 个 */ + additional_informations?: AdditionalInformation[] + /** 导入记录名称，管理员可在补充信息管理的导入记录中查看。不传则默认为 API 导入。 */ + import_record_name?: string +} + +export interface ImportPerformanceAdditionalInformationQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token: string + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface DeletePerformanceAdditionalInformationsBatchRequest { + /** 评估周期 ID 列表，semester_id 可通过【获取周期】接口获得 */ + semester_id: string + /** 补充信息列表，一次最多 100 个 */ + additional_informations: string[] +} + +export interface DeletePerformanceAdditionalInformationsBatchQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface WritePerformanceUserGroupUserRelRequest { + /** 分组id key */ + group_id?: string + /** 人员组查看人员名单可见性配置 */ + scope_visible_setting?: 0 | 1 + /** 人员列表 */ + user_ids?: string[] +} + +export interface WritePerformanceUserGroupUserRelQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token: string + /** 用户ID类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface QueryPerformanceRevieweeRequest { + /** 周期 ID，1 次只允许查询 1 个周期，semester_id 可通过【获取周期】接口获得 */ + semester_id: string + /** 用户 ID，类型需要与查询参数中的user_id_type保持一致。不传则默认返回该周期所有被评估人的信息。 */ + user_ids?: string[] + /** 项目 ID 列表，查询指定的项目下的被评估人数据 */ + activity_ids?: string[] +} + +export interface QueryPerformanceRevieweeQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface QueryPerformanceReviewTemplateRequest { + /** 评估模板 ID 列表，获取指定评估模板的配置数据。如果不传则返回所有 */ + review_template_ids?: string[] +} + +export interface QueryPerformanceReviewTemplateQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface QueryPerformanceIndicatorRequest { + /** 评估项 ID 列表，获取指定评估项的配置数据 */ + indicator_ids?: string[] +} + +export interface QueryPerformanceIndicatorQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface QueryPerformanceQuestionRequest { + /** 标签填写题 ID 列表，获取指定标签填写题的配置数据。如果不传则返回所有 */ + tag_based_question_ids?: string[] +} + +export interface QueryPerformanceQuestionQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface QueryPerformanceMetricLibRequest { + /** 状态是否为启用 */ + is_active?: boolean + /** 指标所属的标签 ID */ + tag_ids?: string[] + /** 所属的指标类型 ID */ + type_ids?: string[] + /** 可用范围 */ + range_of_availability?: 'admins_and_reviewees' | 'only_admins' + /** 评分设置类型 */ + scoring_setting_type?: 'score_manually' | 'score_by_formula' +} + +export interface QueryPerformanceMetricLibQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface QueryPerformanceMetricTemplateRequest { + /** 指标模板 ID 列表，metrics_template_id 可以通过指标模板的后台配置详情页的 url 获取，也可通过本接口的返回值获取。不填写则默认返回所有指标模板 */ + metrics_template_ids?: string[] + /** 状态 */ + status?: 'to_be_configured' | 'to_be_activated' | 'enabled' | 'disabled' +} + +export interface QueryPerformanceMetricTemplateQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface QueryPerformanceMetricFieldRequest { + /** 指标的字段 ID，不传则默认获取全部字段信息 */ + field_ids?: string[] +} + +export interface ListPerformanceMetricTagQuery { + /** 分页大小 */ + page_size?: number + /** 分页 Token */ + page_token?: string + /** 指标标签 ID 列表 */ + tag_ids?: string[] +} + +export interface FindByUserListPerformanceStageTaskRequest { + /** 周期ID，可以通过「查询周期」接口获得 */ + semester_id: string + /** 用户ID列表 */ + user_id_lists: string[] + /** 任务分类(不传默认包含所有) */ + task_option_lists?: number[] + /** 查询晚于当前时间截止的环节 */ + after_time?: string + /** 查询早于当前时间截止的环节 */ + before_time?: string +} + +export interface FindByUserListPerformanceStageTaskQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface FindByPagePerformanceStageTaskRequest { + /** 周期ID，可以通过「查询周期」接口获得 */ + semester_id: string + /** 任务分类(不传默认包含所有) */ + task_option_lists?: number[] + /** 查询晚于当前时间截止的环节 */ + after_time?: string + /** 查询早于当前时间截止的环节 */ + before_time?: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface FindByPagePerformanceStageTaskQuery { + /** 调用结果中用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface QueryPerformanceMetricDetailRequest { + /** 周期 ID，1 次只允许查询 1 个周期，semester_id 可通过【获取周期】接口获得 */ + semester_id: string + /** 被评估人 ID 列表。如果不传则返回该周期所有参与的被评估人的关键指标详情 */ + reviewee_user_ids: string[] +} + +export interface QueryPerformanceMetricDetailQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ImportPerformanceMetricDetailRequest { + /** 周期 ID，semester_id 可通过【获取周期】接口获得 */ + semester_id: string + /** 录入记录名称，数据源录入人在录入记录页面可以查看该记录名称。如果不传则默认为「API 录入」 */ + import_record_name?: string + /** 指标明细列表，一次最多50个 */ + imported_metrics: ImportedMetric[] +} + +export interface ImportPerformanceMetricDetailQuery { + /** 根据 client_token 是否一致来判断是否为同一请求 */ + client_token: string + /** 用户ID类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface QueryPerformanceReviewDataRequest { + /** 查询范围的开始日期，毫秒级时间戳，开始日期不能晚于截止日期 */ + start_time: string + /** 查询范围的截止日期，毫秒级时间戳，截止日期不能早于开始日期 */ + end_time: string + /** 评估环节类型，目前仅支持上级评估环节和结果沟通环节（不传默认包含所有的环节）**可选值有**：- `leader_review`：上级评估环节- `communication_and_open_result`：结果沟通环节 */ + stage_types: 'leader_review' | 'communication_and_open_result' | 'view_result'[] + /** 评估环节状态（不传默认包含所有的状态）**可选值有**：- `0`：未开始，任务的开始时间未到达- `1`：待完成，任务的开始时间到达而截止时间未到达，且任务未完成- `2`：已截止，任务的截止时间已到达，且任务未完成- `3`：已完成，任务已完成 */ + stage_progress?: 0 | 1 | 2 | 3 | 4[] + /** 评估周期 ID 列表，semester_id 是一个评估周期的唯一标识，可以通过「我的评估」页面 url 获取，也可通过本接口的返回值获取 */ + semester_id_list?: string[] + /** 被评估人 ID 列表 */ + reviewee_user_id_list: string[] + /** 环节更新时间晚于，可筛选出在此时间之后，有内容提交的环节数据 */ + updated_later_than?: string +} + +export interface QueryPerformanceReviewDataQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface QueryPerformanceReviewDataRequest { + /** 评估周期 ID 列表，semester_id 可通过【获取周期】 */ + semester_ids: string[] + /** 被评估人 ID 列表 */ + reviewee_user_ids: string[] + /** 环节类型 */ + stage_types?: 'summarize_key_outputs' | 'review' | 'communication_and_open_result' | 'view_result' | 'reconsideration' | 'leader_review'[] + /** 评估型环节的执行人角色，不传默认包含所有的执行人角色。当传入的环节类型中有评估型环节时，返回指定执行人角色的评估型环节数据 */ + review_stage_roles?: 'reviewee' | 'invited_reviewer' | 'solid_line_leader' | 'dotted_line_leader' | 'secondary_solid_line_leader' | 'direct_project_leader' | 'custom_review_role' | 'metric_reviewer'[] + /** 环节 ID，如果同时传了环节 ID 和环节类型，优先返回环节 ID 对应的绩效数据 */ + stage_ids?: string[] + /** 当要获取的绩效数据的环节类型包含终评环节时，可指定是否需要返回绩效终评数据的具体环节来源。不填则默认不返回 返回的来源枚举值为： 枚举值： review 产生终评结果的评估型环节 calibaration 校准环节 reconsideration 结果复议环节 */ + need_leader_review_data_source?: boolean + /** 环节更新时间晚于，可筛选出在此时间之后，有内容提交的环节数据 */ + updated_later_than?: string + /** 环节状态，不传默认包含所有状态。各类型的环节分别有以下环节状态： 绩效结果查看环节状态 可选值： 0：已开通，绩效结果已开通，未发起复议也无需确认结果 1：待确认，绩效结果已开通但被评估人还未确认结果，确认的截止时间还未到达 2：已截止，绩效结果已开通但被评估人还未确认结果，确认的截止时间已到达 3：已确认，绩效结果已开通，被评估人已确认结果 4：已复议，绩效结果已开通，且被评估人已发起 绩效结果复议环节状态 可选值： 1：待完成，任务未完成 2：已截止，任务的截止时间已到达，且任务未完成 3：已完成，任务已完成 除上述类型外的其他环节类型状态 可选值： 0：未开始，任务的开始时间未到达 1：待完成，任务的开始时间到达而截止时间未到达，且任务未完成 2：已截止，任务的截止时间已到达，且任务未完成 3：已完成，任务已完成 */ + stage_progresses?: number[] +} + +export interface QueryPerformanceReviewDataQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id' +} + +export interface ListPerformanceSemesterResponse { + /** 周期meta信息列表 */ + items?: Semester[] +} + +export interface QueryPerformanceActivityResponse { + /** 绩效评估项目列表。 */ + activities?: Activity[] +} + +export interface QueryPerformanceAdditionalInformationResponse { + /** 补充信息列表 */ + additional_informations?: AdditionalInformation[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface ImportPerformanceAdditionalInformationResponse { + /** 导入记录 ID */ + import_record_id?: string + /** 成功导入后的补充信息列表 */ + additional_informations?: AdditionalInformation[] +} + +export interface DeletePerformanceAdditionalInformationsBatchResponse { + /** 被删除的补充信息列表 */ + additional_informations?: string[] +} + +export interface WritePerformanceUserGroupUserRelResponse { + /** 写入员工范围响应 */ + data?: WriteUserGroupScopeData +} + +export interface QueryPerformanceRevieweeResponse { + /** 周期ID */ + semester_id?: string + /** 被评估人列表 */ + reviewees?: Reviewee[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface QueryPerformanceReviewTemplateResponse { + /** 评估模板信息 */ + review_templates?: ReviewTemplate[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface QueryPerformanceIndicatorResponse { + /** 评估项列表 */ + indicators?: Indicator[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface QueryPerformanceQuestionResponse { + /** 标签填写题 */ + tag_based_questions?: Question[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface QueryPerformanceMetricLibResponse { + /** 指标信息 */ + items?: MetricInLibrary[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface QueryPerformanceMetricTemplateResponse { + /** 指标模板信息 */ + items?: MetricTemplate[] + /** 是否还有更多项 */ + has_more?: boolean + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string +} + +export interface QueryPerformanceMetricFieldResponse { + /** 指标字段信息 */ + items?: MetricField[] +} + +export interface ListPerformanceMetricTagResponse { + /** 指标标签列表 */ + items?: MetricTag[] + /** 分页 Token */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +export interface FindByUserListPerformanceStageTaskResponse { + /** 周期基础信息 */ + base?: SemesterBaseInfo + /** 周期环节信息列表 */ + items?: StageTask[] +} + +export interface FindByPagePerformanceStageTaskResponse { + /** 周期基础信息 */ + base?: SemesterBaseInfo + /** 周期环节信息列表 */ + items?: StageTask[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string +} + +export interface QueryPerformanceMetricDetailResponse { + /** 周期ID */ + semester_id?: string + /** 指标明细列表 */ + reviewee_metrics?: RevieweeMetric[] +} + +export interface ImportPerformanceMetricDetailResponse { + /** 成功时返回导入记录 ID，失败时则为 null */ + import_record_id?: string +} + +export interface QueryPerformanceReviewDataResponse { + /** 绩效评估周期列表 */ + semesters?: Semester[] + /** 绩效评估项目列表 */ + activities?: Activity[] + /** 评估项列表 */ + indicators?: Indicator[] + /** 评估模板列表 */ + templates?: Template[] + /** 评估内容列表 */ + units?: Unit[] + /** 填写项列表 */ + fields?: Field[] + /** 评估数据列表 */ + datas?: ReviewProfile[] +} + +export interface QueryPerformanceReviewDataResponse { + /** 评估数据列表 */ + datas?: ReviewProfile[] +} + +Internal.define({ + '/open-apis/performance/v1/semesters': { + GET: 'listPerformanceSemester', + }, + '/open-apis/performance/v2/activity/query': { + POST: 'queryPerformanceActivity', + }, + '/open-apis/performance/v2/additional_informations/query': { + POST: 'queryPerformanceAdditionalInformation', + }, + '/open-apis/performance/v2/additional_informations/import': { + POST: 'importPerformanceAdditionalInformation', + }, + '/open-apis/performance/v2/additional_informations/batch': { + DELETE: 'deletePerformanceAdditionalInformationsBatch', + }, + '/open-apis/performance/v2/user_group_user_rels/write': { + POST: 'writePerformanceUserGroupUserRel', + }, + '/open-apis/performance/v2/reviewees/query': { + POST: 'queryPerformanceReviewee', + }, + '/open-apis/performance/v2/review_templates/query': { + POST: 'queryPerformanceReviewTemplate', + }, + '/open-apis/performance/v2/indicators/query': { + POST: 'queryPerformanceIndicator', + }, + '/open-apis/performance/v2/questions/query': { + POST: 'queryPerformanceQuestion', + }, + '/open-apis/performance/v2/metric_libs/query': { + POST: 'queryPerformanceMetricLib', + }, + '/open-apis/performance/v2/metric_templates/query': { + POST: 'queryPerformanceMetricTemplate', + }, + '/open-apis/performance/v2/metric_fields/query': { + POST: 'queryPerformanceMetricField', + }, + '/open-apis/performance/v2/metric_tags': { + GET: 'listPerformanceMetricTag', + }, + '/open-apis/performance/v1/stage_tasks/find_by_user_list': { + POST: 'findByUserListPerformanceStageTask', + }, + '/open-apis/performance/v1/stage_tasks/find_by_page': { + POST: 'findByPagePerformanceStageTask', + }, + '/open-apis/performance/v2/metric_details/query': { + POST: 'queryPerformanceMetricDetail', + }, + '/open-apis/performance/v2/metric_details/import': { + POST: 'importPerformanceMetricDetail', + }, + '/open-apis/performance/v1/review_datas/query': { + POST: 'queryPerformanceReviewData', + }, + '/open-apis/performance/v2/review_datas/query': { + POST: 'queryPerformanceReviewData', + }, +}) diff --git a/adapters/lark/src/types/personal_settings.ts b/adapters/lark/src/types/personal_settings.ts new file mode 100644 index 00000000..da641fac --- /dev/null +++ b/adapters/lark/src/types/personal_settings.ts @@ -0,0 +1,132 @@ +import { Internal } from '../internal' +import { SystemStatus, SystemStatusI18nName, SystemStatusSyncSetting, SystemStatusUserCloseResultEntity, SystemStatusUserOpenParam, SystemStatusUserOpenResultEntity } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建系统状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/create + */ + createPersonalSettingsSystemStatus(body: CreatePersonalSettingsSystemStatusRequest): Promise + /** + * 删除系统状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/delete + */ + deletePersonalSettingsSystemStatus(system_status_id: string): Promise + /** + * 修改系统状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/patch + */ + patchPersonalSettingsSystemStatus(system_status_id: string, body: PatchPersonalSettingsSystemStatusRequest): Promise + /** + * 获取系统状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list + */ + listPersonalSettingsSystemStatus(query?: ListPersonalSettingsSystemStatusQuery): Promise + /** + * 批量开启系统状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open + */ + batchOpenPersonalSettingsSystemStatus(system_status_id: string, body: BatchOpenPersonalSettingsSystemStatusRequest, query?: BatchOpenPersonalSettingsSystemStatusQuery): Promise + /** + * 批量关闭系统状态 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_close + */ + batchClosePersonalSettingsSystemStatus(system_status_id: string, body: BatchClosePersonalSettingsSystemStatusRequest, query?: BatchClosePersonalSettingsSystemStatusQuery): Promise + } +} + +export interface CreatePersonalSettingsSystemStatusRequest { + /** 系统状态名称，名称字符数要在1到20范围内。 */ + title: string + /** 系统状态国际化名称，名称字符数要在1到20范围内。 */ + i18n_title?: SystemStatusI18nName + /** 图标 */ + icon_key: 'GeneralDoNotDisturb' | 'GeneralInMeetingBusy' | 'Coffee' | 'GeneralBusinessTrip' | 'GeneralWorkFromHome' | 'StatusEnjoyLife' | 'GeneralTravellingCar' | 'StatusBus' | 'StatusInFlight' | 'Typing' | 'EatingFood' | 'SICK' | 'GeneralSun' | 'GeneralMoonRest' | 'StatusReading' | 'Status_PrivateMessage' | 'StatusFlashOfInspiration' | 'GeneralVacation' + /** 颜色 */ + color?: 'BLUE' | 'GRAY' | 'INDIGO' | 'WATHET' | 'GREEN' | 'TURQUOISE' | 'YELLOW' | 'LIME' | 'RED' | 'ORANGE' | 'PURPLE' | 'VIOLET' | 'CARMINE' + /** 优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。 */ + priority?: number + /** 同步设置 */ + sync_setting?: SystemStatusSyncSetting +} + +export interface PatchPersonalSettingsSystemStatusRequest { + /** 系统状态 */ + system_status: SystemStatus + /** 需要更新的字段 */ + update_fields: 'TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING'[] +} + +export interface ListPersonalSettingsSystemStatusQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface BatchOpenPersonalSettingsSystemStatusRequest { + /** 开启列表 */ + user_list: SystemStatusUserOpenParam[] +} + +export interface BatchOpenPersonalSettingsSystemStatusQuery { + /** 用户id类型 open_id/user_id/union_id */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchClosePersonalSettingsSystemStatusRequest { + /** 成员列表 */ + user_list: string[] +} + +export interface BatchClosePersonalSettingsSystemStatusQuery { + /** 用户id类型 open_id/user_id/union_id */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreatePersonalSettingsSystemStatusResponse { + /** 系统状态 */ + system_status?: SystemStatus +} + +export interface PatchPersonalSettingsSystemStatusResponse { + /** 系统状态 */ + system_status?: SystemStatus +} + +export interface ListPersonalSettingsSystemStatusResponse { + /** 租户系统状态 */ + items?: SystemStatus[] + /** 分页token */ + page_token?: string + /** 是否存在更多 */ + has_more?: boolean +} + +export interface BatchOpenPersonalSettingsSystemStatusResponse { + /** 开启结果 */ + result_list: SystemStatusUserOpenResultEntity[] +} + +export interface BatchClosePersonalSettingsSystemStatusResponse { + /** 关闭结果 */ + result_list: SystemStatusUserCloseResultEntity[] +} + +Internal.define({ + '/open-apis/personal_settings/v1/system_statuses': { + POST: 'createPersonalSettingsSystemStatus', + GET: 'listPersonalSettingsSystemStatus', + }, + '/open-apis/personal_settings/v1/system_statuses/{system_status_id}': { + DELETE: 'deletePersonalSettingsSystemStatus', + PATCH: 'patchPersonalSettingsSystemStatus', + }, + '/open-apis/personal_settings/v1/system_statuses/{system_status_id}/batch_open': { + POST: 'batchOpenPersonalSettingsSystemStatus', + }, + '/open-apis/personal_settings/v1/system_statuses/{system_status_id}/batch_close': { + POST: 'batchClosePersonalSettingsSystemStatus', + }, +}) diff --git a/adapters/lark/src/types/report.ts b/adapters/lark/src/types/report.ts new file mode 100644 index 00000000..37e76745 --- /dev/null +++ b/adapters/lark/src/types/report.ts @@ -0,0 +1,86 @@ +import { Internal } from '../internal' +import { Rule, Task } from '.' + +declare module '../internal' { + interface Internal { + /** + * 查询规则 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule/query + */ + queryReportRule(query?: QueryReportRuleQuery): Promise + /** + * 移除规则看板 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule-view/remove + */ + removeReportRuleView(rule_id: string, body: RemoveReportRuleViewRequest, query?: RemoveReportRuleViewQuery): Promise + /** + * 查询任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query + */ + queryReportTask(body: QueryReportTaskRequest, query?: QueryReportTaskQuery): Promise + } +} + +export interface QueryReportRuleQuery { + /** 规则名称 */ + rule_name: string + /** 是否包括已删除，默认未删除 */ + include_deleted?: 0 | 1 + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface RemoveReportRuleViewRequest { + /** 列表为空删除规则下全用户视图，列表不为空删除指定用户视图，大小限制200。 */ + user_ids?: string[] +} + +export interface RemoveReportRuleViewQuery { + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface QueryReportTaskRequest { + /** 提交开始时间时间戳 */ + commit_start_time: number + /** 提交结束时间时间戳 */ + commit_end_time: number + /** 汇报规则ID */ + rule_id?: string + /** 用户ID */ + user_id?: string + /** 分页标识符 */ + page_token: string + /** 单次分页返回的条数 */ + page_size: number +} + +export interface QueryReportTaskQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface QueryReportRuleResponse { + /** 规则列表 */ + rules?: Rule[] +} + +export interface QueryReportTaskResponse { + /** 任务列表 */ + items?: Task[] + /** 是否有下一页数据 */ + has_more?: boolean + /** 下一页分页的token */ + page_token?: string +} + +Internal.define({ + '/open-apis/report/v1/rules/query': { + GET: 'queryReportRule', + }, + '/open-apis/report/v1/rules/{rule_id}/views/remove': { + POST: 'removeReportRuleView', + }, + '/open-apis/report/v1/tasks/query': { + POST: 'queryReportTask', + }, +}) diff --git a/adapters/lark/src/types/search.ts b/adapters/lark/src/types/search.ts new file mode 100644 index 00000000..50bc1850 --- /dev/null +++ b/adapters/lark/src/types/search.ts @@ -0,0 +1,307 @@ +import { Internal } from '../internal' +import { Acl, ConnectorParam, DataSource, I18nMeta, Item, ItemContent, ItemMetadata, PatchSchemaProperty, Schema, SchemaDisplay, SchemaProperty } from '.' + +declare module '../internal' { + interface Internal { + /** + * 搜索消息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/message/create + */ + createSearchMessage(body: CreateSearchMessageRequest, query?: CreateSearchMessageQuery): Promise + /** + * 搜索应用 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/app/create + */ + createSearchApp(body: CreateSearchAppRequest, query?: CreateSearchAppQuery): Promise + /** + * 创建数据源 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/create + */ + createSearchDataSource(body: CreateSearchDataSourceRequest): Promise + /** + * 删除数据源 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/delete + */ + deleteSearchDataSource(data_source_id: string): Promise + /** + * 修改数据源 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/patch + */ + patchSearchDataSource(data_source_id: string, body: PatchSearchDataSourceRequest): Promise + /** + * 获取数据源 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/get + */ + getSearchDataSource(data_source_id: string): Promise + /** + * 批量获取数据源 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/list + */ + listSearchDataSource(query?: ListSearchDataSourceQuery): Promise + /** + * 为指定数据项创建索引 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/create + */ + createSearchDataSourceItem(data_source_id: string, body: CreateSearchDataSourceItemRequest): Promise + /** + * 删除数据项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/delete + */ + deleteSearchDataSourceItem(data_source_id: string, item_id: string): Promise + /** + * 查询指定数据项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/get + */ + getSearchDataSourceItem(data_source_id: string, item_id: string): Promise + /** + * 创建数据范式 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/create + */ + createSearchSchema(body: CreateSearchSchemaRequest, query?: CreateSearchSchemaQuery): Promise + /** + * 删除数据范式 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/delete + */ + deleteSearchSchema(schema_id: string): Promise + /** + * 修改数据范式 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/patch + */ + patchSearchSchema(schema_id: string, body: PatchSearchSchemaRequest): Promise + /** + * 获取数据范式 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/get + */ + getSearchSchema(schema_id: string): Promise + } +} + +export interface CreateSearchMessageRequest { + /** 搜索关键词 */ + query: string + /** 消息来自user_id列表 */ + from_ids?: string[] + /** 消息所在chat_id列表 */ + chat_ids?: string[] + /** 消息类型(file/image/media) */ + message_type?: 'file' | 'image' | 'media' + /** at用户user_id列表 */ + at_chatter_ids?: string[] + /** 消息来自类型(bot/user) */ + from_type?: 'bot' | 'user' + /** 会话类型(group_chat/p2p_chat) */ + chat_type?: 'group_chat' | 'p2p_chat' + /** 消息发送起始时间 */ + start_time?: string + /** 消息发送结束时间 */ + end_time?: string +} + +export interface CreateSearchMessageQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页大小 */ + page_size?: number + /** 分页token */ + page_token?: string +} + +export interface CreateSearchAppRequest { + /** 搜索关键词 */ + query: string +} + +export interface CreateSearchAppQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' + /** 分页大小 */ + page_size?: number + /** 分页token */ + page_token?: string +} + +export interface CreateSearchDataSourceRequest { + /** data_source的展示名称 */ + name: string + /** 数据源状态，0-已上线，1-未上线 */ + state?: 0 | 1 + /** 对于数据源的描述 */ + description?: string + /** 数据源在 search tab 上的展示图标路径 */ + icon_url?: string + /** 数据源采用的展示模版名称 */ + template?: string + /** 描述哪些字段可以被搜索 */ + searchable_fields?: string[] + /** 数据源的国际化展示名称 */ + i18n_name?: I18nMeta + /** 数据源的国际化描述 */ + i18n_description?: I18nMeta + /** 数据源关联的 schema 标识 */ + schema_id?: string + /** datasource对应的开放平台应用id */ + app_id?: string + /** 搜索请求的接入方式 */ + connect_type?: 0 | 1 + /** 根据连接器类型不同所需要提供的相关参数 */ + connector_param?: ConnectorParam + /** 是否使用问答服务 */ + enable_answer?: boolean +} + +export interface PatchSearchDataSourceRequest { + /** 数据源的展示名称 */ + name?: string + /** 数据源状态，0-已上线，1-未上线 */ + state?: 0 | 1 + /** 对于数据源的描述 */ + description?: string + /** 数据源在 search tab 上的展示图标路径 */ + icon_url?: string + /** 数据源名称多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"测试数据源", "en_us":"Test DataSource"} */ + i18n_name?: I18nMeta + /** 数据源描述多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"搜索测试数据源相关数据", "en_us":"Search data from Test DataSource"} */ + i18n_description?: I18nMeta + /** 修改connector的相关配置 */ + connector_param?: ConnectorParam + /** 是否使用问答服务 */ + enable_answer?: boolean +} + +export interface ListSearchDataSourceQuery { + /** 回包数据格式，0-全量数据；1-摘要数据。**注**：摘要数据仅包含"id"，"name"，"state"。 */ + view?: 0 | 1 + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateSearchDataSourceItemRequest { + /** item 在 datasource 中的唯一标识，只接受英文字母、数字和下划线 */ + id: string + /** item 的访问权限控制 */ + acl: Acl[] + /** item 的元信息 */ + metadata: ItemMetadata + /** 结构化数据 */ + structured_data: string + /** 非结构化数据，如文档文本 */ + content?: ItemContent +} + +export interface CreateSearchSchemaRequest { + /** 数据范式的属性定义 */ + properties: SchemaProperty[] + /** 数据展示相关配置 */ + display: SchemaDisplay + /** 用户自定义数据范式的唯一标识 */ + schema_id: string +} + +export interface CreateSearchSchemaQuery { + /** 是否只用来校验合法性 */ + validate_only?: boolean +} + +export interface PatchSearchSchemaRequest { + /** 数据展示相关配置 */ + display?: SchemaDisplay + /** 数据范式的属性定义 */ + properties?: PatchSchemaProperty[] +} + +export interface CreateSearchMessageResponse { + /** 消息id列表 */ + items?: string[] + /** 翻页 token，传入返回下一页，首页不需要传入 */ + page_token?: string + /** 是否还有下一页 */ + has_more?: boolean +} + +export interface CreateSearchAppResponse { + /** app_id列表 */ + items?: string[] + /** 翻页 token，传入返回下一页，首页不需要传入 */ + page_token?: string + /** 是否还有下一页 */ + has_more?: boolean +} + +export interface CreateSearchDataSourceResponse { + /** 数据源实例 */ + data_source?: DataSource +} + +export interface PatchSearchDataSourceResponse { + /** 数据源 */ + data_source?: DataSource +} + +export interface GetSearchDataSourceResponse { + /** 数据源实例 */ + data_source?: DataSource +} + +export interface ListSearchDataSourceResponse { + /** 是否有更多数据 */ + has_more?: boolean + /** 取数据的凭证 */ + page_token?: string + /** 返回的数据 */ + items?: DataSource[] +} + +export interface GetSearchDataSourceItemResponse { + /** 数据项实例 */ + item: Item +} + +export interface CreateSearchSchemaResponse { + /** 数据范式实例 */ + schema?: Schema +} + +export interface PatchSearchSchemaResponse { + /** 数据范式实例 */ + schema?: Schema +} + +export interface GetSearchSchemaResponse { + /** 数据范式 */ + schema?: Schema +} + +Internal.define({ + '/open-apis/search/v2/message': { + POST: 'createSearchMessage', + }, + '/open-apis/search/v2/app': { + POST: 'createSearchApp', + }, + '/open-apis/search/v2/data_sources': { + POST: 'createSearchDataSource', + GET: 'listSearchDataSource', + }, + '/open-apis/search/v2/data_sources/{data_source_id}': { + DELETE: 'deleteSearchDataSource', + PATCH: 'patchSearchDataSource', + GET: 'getSearchDataSource', + }, + '/open-apis/search/v2/data_sources/{data_source_id}/items': { + POST: 'createSearchDataSourceItem', + }, + '/open-apis/search/v2/data_sources/{data_source_id}/items/{item_id}': { + DELETE: 'deleteSearchDataSourceItem', + GET: 'getSearchDataSourceItem', + }, + '/open-apis/search/v2/schemas': { + POST: 'createSearchSchema', + }, + '/open-apis/search/v2/schemas/{schema_id}': { + DELETE: 'deleteSearchSchema', + PATCH: 'patchSearchSchema', + GET: 'getSearchSchema', + }, +}) diff --git a/adapters/lark/src/types/security_and_compliance.ts b/adapters/lark/src/types/security_and_compliance.ts new file mode 100644 index 00000000..82d7186f --- /dev/null +++ b/adapters/lark/src/types/security_and_compliance.ts @@ -0,0 +1,42 @@ +import { Internal } from '../internal' +import { OpenapiLog } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取OpenAPI审计日志数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v1/openapi_log/list_data + */ + listDataSecurityAndComplianceOpenapiLog(body: ListDataSecurityAndComplianceOpenapiLogRequest): Promise + } +} + +export interface ListDataSecurityAndComplianceOpenapiLogRequest { + /** 飞书开放平台定义的API */ + api_keys?: string[] + /** 以秒为单位的起始时间戳 */ + start_time?: number + /** 以秒为单位的终止时间戳 */ + end_time?: number + /** 在开发者后台——凭证与基础信息页面查看的app_id（cli_xxx），指调用openapi的应用 */ + app_id?: string + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据 */ + page_token?: string +} + +export interface ListDataSecurityAndComplianceOpenapiLogResponse { + /** openapi日志列表 */ + items?: OpenapiLog[] + /** 分页标记 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +Internal.define({ + '/open-apis/security_and_compliance/v1/openapi_logs/list_data': { + POST: 'listDataSecurityAndComplianceOpenapiLog', + }, +}) diff --git a/adapters/lark/src/types/sheets.ts b/adapters/lark/src/types/sheets.ts new file mode 100644 index 00000000..98f082b8 --- /dev/null +++ b/adapters/lark/src/types/sheets.ts @@ -0,0 +1,425 @@ +import { Internal } from '../internal' +import { Condition, Dimension, FilterView, FilterViewCondition, FindCondition, FindReplaceResult, FloatImage, GetSpreadsheet, Sheet, SheetFilterInfo, Spreadsheet } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建电子表格 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/create + */ + createSheetsSpreadsheet(body: CreateSheetsSpreadsheetRequest): Promise + /** + * 修改电子表格属性 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/patch + */ + patchSheetsSpreadsheet(spreadsheet_token: string, body: PatchSheetsSpreadsheetRequest): Promise + /** + * 获取电子表格信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/get + */ + getSheetsSpreadsheet(spreadsheet_token: string, query?: GetSheetsSpreadsheetQuery): Promise + /** + * 获取工作表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query + */ + querySheetsSpreadsheetSheet(spreadsheet_token: string): Promise + /** + * 查询工作表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/get + */ + getSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string): Promise + /** + * 移动行列 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/move_dimension + */ + moveDimensionSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, body: MoveDimensionSheetsSpreadsheetSheetRequest): Promise + /** + * 查找单元格 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/find + */ + findSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, body: FindSheetsSpreadsheetSheetRequest): Promise + /** + * 替换单元格 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/replace + */ + replaceSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, body: ReplaceSheetsSpreadsheetSheetRequest): Promise + /** + * 创建筛选 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/create + */ + createSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string, body: CreateSheetsSpreadsheetSheetFilterRequest): Promise + /** + * 更新筛选 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/update + */ + updateSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string, body: UpdateSheetsSpreadsheetSheetFilterRequest): Promise + /** + * 获取筛选 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/get + */ + getSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string): Promise + /** + * 删除筛选 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/delete + */ + deleteSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string): Promise + /** + * 创建筛选视图 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/create + */ + createSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, body: CreateSheetsSpreadsheetSheetFilterViewRequest): Promise + /** + * 更新筛选视图 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/patch + */ + patchSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string, body: PatchSheetsSpreadsheetSheetFilterViewRequest): Promise + /** + * 查询筛选视图 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/query + */ + querySheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string): Promise + /** + * 获取筛选视图 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/get + */ + getSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise + /** + * 删除筛选视图 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/delete + */ + deleteSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise + /** + * 创建筛选条件 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/create + */ + createSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, body: CreateSheetsSpreadsheetSheetFilterViewConditionRequest): Promise + /** + * 更新筛选条件 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/update + */ + updateSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string, body: UpdateSheetsSpreadsheetSheetFilterViewConditionRequest): Promise + /** + * 查询筛选条件 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/query + */ + querySheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise + /** + * 获取筛选条件 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/get + */ + getSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise + /** + * 删除筛选条件 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/delete + */ + deleteSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise + /** + * 创建浮动图片 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/create + */ + createSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, body: CreateSheetsSpreadsheetSheetFloatImageRequest): Promise + /** + * 更新浮动图片 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/patch + */ + patchSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string, body: PatchSheetsSpreadsheetSheetFloatImageRequest): Promise + /** + * 获取浮动图片 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/get + */ + getSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise + /** + * 查询浮动图片 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/query + */ + querySheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string): Promise + /** + * 删除浮动图片 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/delete + */ + deleteSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise + } +} + +export interface CreateSheetsSpreadsheetRequest { + /** 表格标题 */ + title?: string + /** 文件夹token */ + folder_token?: string +} + +export interface PatchSheetsSpreadsheetRequest { + /** 表格标题 */ + title?: string +} + +export interface GetSheetsSpreadsheetQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface MoveDimensionSheetsSpreadsheetSheetRequest { + /** 移动源位置参数 */ + source?: Dimension + /** 移动的目标位置行或者列号 */ + destination_index?: number +} + +export interface FindSheetsSpreadsheetSheetRequest { + /** 查找条件 */ + find_condition: FindCondition + /** 查找的字符串 */ + find: string +} + +export interface ReplaceSheetsSpreadsheetSheetRequest { + /** 查找条件 */ + find_condition: FindCondition + /** 查找的字符串 */ + find: string + /** 替换的字符串 */ + replacement: string +} + +export interface CreateSheetsSpreadsheetSheetFilterRequest { + /** 筛选应用范围 */ + range: string + /** 设置筛选条件的列 */ + col: string + /** 筛选的条件 */ + condition: Condition +} + +export interface UpdateSheetsSpreadsheetSheetFilterRequest { + /** 更新筛选条件的列 */ + col: string + /** 筛选条件 */ + condition: Condition +} + +export interface CreateSheetsSpreadsheetSheetFilterViewRequest { + /** 筛选视图 id */ + filter_view_id?: string + /** 筛选视图名字 */ + filter_view_name?: string + /** 筛选视图的筛选范围 */ + range?: string +} + +export interface PatchSheetsSpreadsheetSheetFilterViewRequest { + /** 筛选视图名字 */ + filter_view_name?: string + /** 筛选视图的筛选范围 */ + range?: string +} + +export interface CreateSheetsSpreadsheetSheetFilterViewConditionRequest { + /** 设置筛选条件的列，使用字母号 */ + condition_id?: string + /** 筛选类型 */ + filter_type?: string + /** 比较类型 */ + compare_type?: string + /** 筛选参数 */ + expected?: string[] +} + +export interface UpdateSheetsSpreadsheetSheetFilterViewConditionRequest { + /** 筛选类型 */ + filter_type?: string + /** 比较类型 */ + compare_type?: string + /** 筛选参数 */ + expected?: string[] +} + +export interface CreateSheetsSpreadsheetSheetFloatImageRequest { + /** 浮动图片 id */ + float_image_id?: string + /** 浮动图片 token，需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */ + float_image_token?: string + /** 浮动图片的左上角单元格定位，只支持一个单元格 */ + range?: string + /** 浮动图片的宽度，大于等于 20px */ + width?: number + /** 浮动图片的高度，大于等于 20px */ + height?: number + /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移，大于等于0且小于所在单元格的宽度 */ + offset_x?: number + /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移，大于等于0且小于所在单元格的高度 */ + offset_y?: number +} + +export interface PatchSheetsSpreadsheetSheetFloatImageRequest { + /** 浮动图片 token，需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */ + float_image_token?: string + /** 浮动图片的左上角单元格定位，只支持一个单元格 */ + range?: string + /** 浮动图片的宽度，大于等于 20px */ + width?: number + /** 浮动图片的高度，大于等于 20px */ + height?: number + /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移，大于等于0且小于所在单元格的宽度 */ + offset_x?: number + /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移，大于等于0且小于所在单元格的高度 */ + 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 +} + +export interface GetSheetsSpreadsheetSheetFloatImageResponse { + /** 浮动图片 */ + float_image?: FloatImage +} + +export interface QuerySheetsSpreadsheetSheetFloatImageResponse { + /** 子表的所有浮动图片信息 */ + items?: FloatImage[] +} + +Internal.define({ + '/open-apis/sheets/v3/spreadsheets': { + POST: 'createSheetsSpreadsheet', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}': { + PATCH: 'patchSheetsSpreadsheet', + GET: 'getSheetsSpreadsheet', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/query': { + GET: 'querySheetsSpreadsheetSheet', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}': { + GET: 'getSheetsSpreadsheetSheet', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/move_dimension': { + POST: 'moveDimensionSheetsSpreadsheetSheet', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/find': { + POST: 'findSheetsSpreadsheetSheet', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/replace': { + POST: 'replaceSheetsSpreadsheetSheet', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter': { + POST: 'createSheetsSpreadsheetSheetFilter', + PUT: 'updateSheetsSpreadsheetSheetFilter', + GET: 'getSheetsSpreadsheetSheetFilter', + DELETE: 'deleteSheetsSpreadsheetSheetFilter', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views': { + POST: 'createSheetsSpreadsheetSheetFilterView', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}': { + PATCH: 'patchSheetsSpreadsheetSheetFilterView', + GET: 'getSheetsSpreadsheetSheetFilterView', + DELETE: 'deleteSheetsSpreadsheetSheetFilterView', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/query': { + GET: 'querySheetsSpreadsheetSheetFilterView', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}/conditions': { + POST: 'createSheetsSpreadsheetSheetFilterViewCondition', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}/conditions/{condition_id}': { + PUT: 'updateSheetsSpreadsheetSheetFilterViewCondition', + GET: 'getSheetsSpreadsheetSheetFilterViewCondition', + DELETE: 'deleteSheetsSpreadsheetSheetFilterViewCondition', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter_views/{filter_view_id}/conditions/query': { + GET: 'querySheetsSpreadsheetSheetFilterViewCondition', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/float_images': { + POST: 'createSheetsSpreadsheetSheetFloatImage', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/float_images/{float_image_id}': { + PATCH: 'patchSheetsSpreadsheetSheetFloatImage', + GET: 'getSheetsSpreadsheetSheetFloatImage', + DELETE: 'deleteSheetsSpreadsheetSheetFloatImage', + }, + '/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/float_images/query': { + GET: 'querySheetsSpreadsheetSheetFloatImage', + }, +}) diff --git a/adapters/lark/src/types/speech_to_text.ts b/adapters/lark/src/types/speech_to_text.ts new file mode 100644 index 00000000..fa1a0e3f --- /dev/null +++ b/adapters/lark/src/types/speech_to_text.ts @@ -0,0 +1,54 @@ +import { Internal } from '../internal' +import { FileConfig, Speech, StreamConfig } from '.' + +declare module '../internal' { + interface Internal { + /** + * 识别语音文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/file_recognize + */ + fileRecognizeSpeechToTextSpeech(body: FileRecognizeSpeechToTextSpeechRequest): Promise + /** + * 识别流式语音 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/stream_recognize + */ + streamRecognizeSpeechToTextSpeech(body: StreamRecognizeSpeechToTextSpeechRequest): Promise + } +} + +export interface FileRecognizeSpeechToTextSpeechRequest { + /** 语音资源 */ + speech: Speech + /** 配置属性 */ + config: FileConfig +} + +export interface StreamRecognizeSpeechToTextSpeechRequest { + /** 语音资源 */ + speech: Speech + /** 配置属性 */ + config: StreamConfig +} + +export interface FileRecognizeSpeechToTextSpeechResponse { + /** 语音识别后的文本信息 */ + recognition_text: string +} + +export interface StreamRecognizeSpeechToTextSpeechResponse { + /** 16 位 String 随机串作为同一数据流的标识 */ + stream_id: string + /** 数据流分片的序号，序号从 0 开始，每次请求递增 1 */ + sequence_id: number + /** 语音流识别后的文本信息 */ + recognition_text: string +} + +Internal.define({ + '/open-apis/speech_to_text/v1/speech/file_recognize': { + POST: 'fileRecognizeSpeechToTextSpeech', + }, + '/open-apis/speech_to_text/v1/speech/stream_recognize': { + POST: 'streamRecognizeSpeechToTextSpeech', + }, +}) diff --git a/adapters/lark/src/types/task.ts b/adapters/lark/src/types/task.ts new file mode 100644 index 00000000..54e32c03 --- /dev/null +++ b/adapters/lark/src/types/task.ts @@ -0,0 +1,1649 @@ +import { Internal } from '../internal' +import { Attachment, Collaborator, Comment, CustomComplete, CustomField, DatetimeSetting, DocxSource, Due, Follower, InputComment, InputCustomField, InputCustomFieldValue, InputOption, InputSection, InputTask, InputTasklist, Member, MemberSetting, NumberSetting, Option, Origin, Reminder, Section, SectionSummary, SelectSetting, Start, Task, TaskDependency, TaskInTasklistInfo, TaskSummary, Tasklist, TasklistActivitySubscription, TextSetting } from '.' + +declare module '../internal' { + interface Internal { + /** + * 创建任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/create + */ + createTaskV2(body: CreateTaskV2Request, query?: CreateTaskV2Query): Promise + /** + * 获取任务详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/get + */ + getTaskV2(task_guid: string, query?: GetTaskV2Query): Promise + /** + * 更新任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/patch + */ + patchTaskV2(task_guid: string, body: PatchTaskV2Request, query?: PatchTaskV2Query): Promise + /** + * 删除任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/delete + */ + deleteTaskV2(task_guid: string): Promise + /** + * 添加任务成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_members + */ + addMembersTaskV2(task_guid: string, body: AddMembersTaskV2Request, query?: AddMembersTaskV2Query): Promise + /** + * 移除任务成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_members + */ + removeMembersTaskV2(task_guid: string, body: RemoveMembersTaskV2Request, query?: RemoveMembersTaskV2Query): Promise + /** + * 列取任务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list + */ + listTaskV2(query?: ListTaskV2Query): Promise + /** + * 列取任务所在清单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/tasklists + */ + tasklistsTaskV2(task_guid: string): Promise + /** + * 任务加入清单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_tasklist + */ + addTasklistTaskV2(task_guid: string, body: AddTasklistTaskV2Request, query?: AddTasklistTaskV2Query): Promise + /** + * 任务移出清单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_tasklist + */ + removeTasklistTaskV2(task_guid: string, body: RemoveTasklistTaskV2Request, query?: RemoveTasklistTaskV2Query): Promise + /** + * 添加任务提醒 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_reminders + */ + addRemindersTaskV2(task_guid: string, body: AddRemindersTaskV2Request, query?: AddRemindersTaskV2Query): Promise + /** + * 移除任务提醒 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_reminders + */ + removeRemindersTaskV2(task_guid: string, body: RemoveRemindersTaskV2Request, query?: RemoveRemindersTaskV2Query): Promise + /** + * 添加依赖 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_dependencies + */ + addDependenciesTaskV2(task_guid: string, body: AddDependenciesTaskV2Request): Promise + /** + * 移除依赖 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_dependencies + */ + removeDependenciesTaskV2(task_guid: string, body: RemoveDependenciesTaskV2Request): Promise + /** + * 创建子任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/create + */ + createTaskV2TaskSubtask(task_guid: string, body: CreateTaskV2TaskSubtaskRequest, query?: CreateTaskV2TaskSubtaskQuery): Promise + /** + * 获取任务的子任务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list + */ + listTaskV2TaskSubtask(task_guid: string, query?: ListTaskV2TaskSubtaskQuery): Promise + /** + * 创建清单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/create + */ + createTaskV2Tasklist(body: CreateTaskV2TasklistRequest, query?: CreateTaskV2TasklistQuery): Promise + /** + * 获取清单详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/get + */ + getTaskV2Tasklist(tasklist_guid: string, query?: GetTaskV2TasklistQuery): Promise + /** + * 更新清单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/patch + */ + patchTaskV2Tasklist(tasklist_guid: string, body: PatchTaskV2TasklistRequest, query?: PatchTaskV2TasklistQuery): Promise + /** + * 删除清单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/delete + */ + deleteTaskV2Tasklist(tasklist_guid: string): Promise + /** + * 添加清单成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/add_members + */ + addMembersTaskV2Tasklist(tasklist_guid: string, body: AddMembersTaskV2TasklistRequest, query?: AddMembersTaskV2TasklistQuery): Promise + /** + * 移除清单成员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/remove_members + */ + removeMembersTaskV2Tasklist(tasklist_guid: string, body: RemoveMembersTaskV2TasklistRequest, query?: RemoveMembersTaskV2TasklistQuery): Promise + /** + * 获取清单任务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks + */ + tasksTaskV2Tasklist(tasklist_guid: string, query?: TasksTaskV2TasklistQuery): Promise + /** + * 获取清单列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list + */ + listTaskV2Tasklist(query?: ListTaskV2TasklistQuery): Promise + /** + * 创建动态订阅 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/create + */ + createTaskV2TasklistActivitySubscription(tasklist_guid: string, body: CreateTaskV2TasklistActivitySubscriptionRequest, query?: CreateTaskV2TasklistActivitySubscriptionQuery): Promise + /** + * 获取动态订阅 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/get + */ + getTaskV2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string, query?: GetTaskV2TasklistActivitySubscriptionQuery): Promise + /** + * 列取动态订阅 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/list + */ + listTaskV2TasklistActivitySubscription(tasklist_guid: string, query?: ListTaskV2TasklistActivitySubscriptionQuery): Promise + /** + * 更新动态订阅 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/patch + */ + patchTaskV2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string, body: PatchTaskV2TasklistActivitySubscriptionRequest, query?: PatchTaskV2TasklistActivitySubscriptionQuery): Promise + /** + * 删除动态订阅 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/delete + */ + deleteTaskV2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string): Promise + /** + * 创建评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/create + */ + createTaskV2Comment(body: CreateTaskV2CommentRequest, query?: CreateTaskV2CommentQuery): Promise + /** + * 获取评论详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/get + */ + getTaskV2Comment(comment_id: string, query?: GetTaskV2CommentQuery): Promise + /** + * 更新评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/patch + */ + patchTaskV2Comment(comment_id: string, body: PatchTaskV2CommentRequest, query?: PatchTaskV2CommentQuery): Promise + /** + * 删除评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/delete + */ + deleteTaskV2Comment(comment_id: string): Promise + /** + * 获取评论列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list + */ + listTaskV2Comment(query?: ListTaskV2CommentQuery): Promise + /** + * 上传附件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/upload + */ + uploadTaskV2Attachment(form: UploadTaskV2AttachmentForm, query?: UploadTaskV2AttachmentQuery): Promise + /** + * 列取附件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list + */ + listTaskV2Attachment(query?: ListTaskV2AttachmentQuery): Promise + /** + * 获取附件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/get + */ + getTaskV2Attachment(attachment_guid: string, query?: GetTaskV2AttachmentQuery): Promise + /** + * 删除附件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/delete + */ + deleteTaskV2Attachment(attachment_guid: string): Promise + /** + * 创建自定义分组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/create + */ + createTaskV2Section(body: CreateTaskV2SectionRequest, query?: CreateTaskV2SectionQuery): Promise + /** + * 获取自定义分组详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/get + */ + getTaskV2Section(section_guid: string, query?: GetTaskV2SectionQuery): Promise + /** + * 更新自定义分组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/patch + */ + patchTaskV2Section(section_guid: string, body: PatchTaskV2SectionRequest, query?: PatchTaskV2SectionQuery): Promise + /** + * 删除自定义分组 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/delete + */ + deleteTaskV2Section(section_guid: string): Promise + /** + * 获取自定义分组列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list + */ + listTaskV2Section(query?: ListTaskV2SectionQuery): Promise + /** + * 获取自定义分组任务列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks + */ + tasksTaskV2Section(section_guid: string, query?: TasksTaskV2SectionQuery): Promise + /** + * 创建自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create + */ + createTaskV2CustomField(body: CreateTaskV2CustomFieldRequest, query?: CreateTaskV2CustomFieldQuery): Promise + /** + * 获取自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/get + */ + getTaskV2CustomField(custom_field_guid: string, query?: GetTaskV2CustomFieldQuery): Promise + /** + * 更新自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/patch + */ + patchTaskV2CustomField(custom_field_guid: string, body: PatchTaskV2CustomFieldRequest, query?: PatchTaskV2CustomFieldQuery): Promise + /** + * 列取自定义字段 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list + */ + listTaskV2CustomField(query?: ListTaskV2CustomFieldQuery): Promise + /** + * 将自定义字段加入资源 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/add + */ + addTaskV2CustomField(custom_field_guid: string, body: AddTaskV2CustomFieldRequest): Promise + /** + * 将自定义字段移出资源 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/remove + */ + removeTaskV2CustomField(custom_field_guid: string, body: RemoveTaskV2CustomFieldRequest): Promise + /** + * 创建自定义任务选项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/create + */ + createTaskV2CustomFieldOption(custom_field_guid: string, body: CreateTaskV2CustomFieldOptionRequest): Promise + /** + * 更新自定义字段选项 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/patch + */ + patchTaskV2CustomFieldOption(custom_field_guid: string, option_guid: string, body: PatchTaskV2CustomFieldOptionRequest): Promise + /** + * 创建任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/create + */ + createTaskV1(body: CreateTaskV1Request, query?: CreateTaskV1Query): Promise + /** + * 删除任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/delete + */ + deleteTaskV1(task_id: string): Promise + /** + * 更新任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/patch + */ + patchTaskV1(task_id: string, body: PatchTaskV1Request, query?: PatchTaskV1Query): Promise + /** + * 完成任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/complete + */ + completeTaskV1(task_id: string): Promise + /** + * 取消完成任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/uncomplete + */ + uncompleteTaskV1(task_id: string): Promise + /** + * 查询指定任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/get + */ + getTaskV1(task_id: string, query?: GetTaskV1Query): Promise + /** + * 查询所有任务 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/list + */ + listTaskV1(query?: ListTaskV1Query): Promise + /** + * 新增提醒时间 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/create + */ + createTaskV1TaskReminder(task_id: string, body: CreateTaskV1TaskReminderRequest): Promise + /** + * 删除提醒时间 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/delete + */ + deleteTaskV1TaskReminder(task_id: string, reminder_id: string): Promise + /** + * 查询提醒时间列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list + */ + listTaskV1TaskReminder(task_id: string, query?: ListTaskV1TaskReminderQuery): Promise + /** + * 创建评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/create + */ + createTaskV1TaskComment(task_id: string, body: CreateTaskV1TaskCommentRequest, query?: CreateTaskV1TaskCommentQuery): Promise + /** + * 删除评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/delete + */ + deleteTaskV1TaskComment(task_id: string, comment_id: string): Promise + /** + * 更新评论 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/update + */ + updateTaskV1TaskComment(task_id: string, comment_id: string, body: UpdateTaskV1TaskCommentRequest, query?: UpdateTaskV1TaskCommentQuery): Promise + /** + * 获取评论详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/get + */ + getTaskV1TaskComment(task_id: string, comment_id: string, query?: GetTaskV1TaskCommentQuery): Promise + /** + * 获取评论列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/list + */ + listTaskV1TaskComment(task_id: string, query?: ListTaskV1TaskCommentQuery): Promise + /** + * 新增关注人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/create + */ + createTaskV1TaskFollower(task_id: string, body: CreateTaskV1TaskFollowerRequest, query?: CreateTaskV1TaskFollowerQuery): Promise + /** + * 删除指定关注人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/delete + */ + deleteTaskV1TaskFollower(task_id: string, follower_id: string, query?: DeleteTaskV1TaskFollowerQuery): Promise + /** + * 批量删除关注人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_follower + */ + batchDeleteFollowerTaskV1(task_id: string, body: BatchDeleteFollowerTaskV1Request, query?: BatchDeleteFollowerTaskV1Query): Promise + /** + * 获取关注人列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/list + */ + listTaskV1TaskFollower(task_id: string, query?: ListTaskV1TaskFollowerQuery): Promise + /** + * 新增执行者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/create + */ + createTaskV1TaskCollaborator(task_id: string, body: CreateTaskV1TaskCollaboratorRequest, query?: CreateTaskV1TaskCollaboratorQuery): Promise + /** + * 删除指定执行者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/delete + */ + deleteTaskV1TaskCollaborator(task_id: string, collaborator_id: string, query?: DeleteTaskV1TaskCollaboratorQuery): Promise + /** + * 批量删除执行者 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_collaborator + */ + batchDeleteCollaboratorTaskV1(task_id: string, body: BatchDeleteCollaboratorTaskV1Request, query?: BatchDeleteCollaboratorTaskV1Query): Promise + /** + * 获取执行者列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/list + */ + listTaskV1TaskCollaborator(task_id: string, query?: ListTaskV1TaskCollaboratorQuery): Promise + } +} + +export interface CreateTaskV2Request { + /** 任务标题 */ + summary: string + /** 任务描述 */ + description?: string + /** 任务截止时间戳(ms)，截止时间戳和截止日期选择一个填写。 */ + due?: Due + /** 任务关联的第三方平台来源信息 */ + origin?: Origin + /** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */ + extra?: string + /** 任务的完成时刻时间戳(ms) */ + completed_at?: string + /** 任务成员列表 */ + members?: Member[] + /** 如果设置，则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */ + repeat_rule?: string + /** 如果设置，则将任务设计为“自定义完成”。用户在任务中心点击“完成”时，不会直接完成任务，而是跳转到第三方配置好的地址或者现实自定义提示。 */ + custom_complete?: CustomComplete + /** 任务所在清单的信息 */ + tasklists?: TaskInTasklistInfo[] + /** 幂等token，如果填写则触发幂等行为。 */ + client_token?: string + /** 任务的开始时间(ms) */ + start?: Start + /** 任务提醒 */ + reminders?: Reminder[] + /** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */ + mode?: number + /** 是否是里程碑任务 */ + is_milestone?: boolean + /** 自定义字段值 */ + custom_fields?: InputCustomFieldValue[] + /** 任务的新版云文档来源 */ + docx_source?: DocxSource +} + +export interface CreateTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface GetTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface PatchTaskV2Request { + /** 要更新的任务数据，只需要写明要更新的字段 */ + task?: InputTask + /** 要更新的字段名称。支持summary, description, due, start, completed_at, extra, repeat_rule, custom_complete, mode, is_milestone, custom_fields。 */ + update_fields: string[] +} + +export interface PatchTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface AddMembersTaskV2Request { + /** 要添加的members列表 */ + members: Member[] + /** 幂等token，如果提供则实现幂等行为 */ + client_token?: string +} + +export interface AddMembersTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface RemoveMembersTaskV2Request { + /** 要移除的member列表 */ + members: Member[] +} + +export interface RemoveMembersTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface ListTaskV2Query { + /** 每页的任务数量 */ + page_size?: number + /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ + page_token?: string + /** 是否按任务完成进行过滤。不填写表示不过滤。 */ + completed?: boolean + /** 查询任务的范围 */ + type?: string + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface AddTasklistTaskV2Request { + /** 要添加到的清单的全局唯一ID */ + tasklist_guid: string + /** 要添加到清单的自定义分组全局唯一ID，如不填写表示添加到默认分组 */ + section_guid?: string +} + +export interface AddTasklistTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface RemoveTasklistTaskV2Request { + /** 要移除的清单的全局唯一ID */ + tasklist_guid: string +} + +export interface RemoveTasklistTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface AddRemindersTaskV2Request { + /** 要添加的reminder的列表 */ + reminders: Reminder[] +} + +export interface AddRemindersTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface RemoveRemindersTaskV2Request { + /** 要移除的reminder的id列表 */ + reminder_ids: string[] +} + +export interface RemoveRemindersTaskV2Query { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface AddDependenciesTaskV2Request { + /** 要添加的依赖 */ + dependencies?: TaskDependency[] +} + +export interface RemoveDependenciesTaskV2Request { + /** 要移除的依赖 */ + dependencies: TaskDependency[] +} + +export interface CreateTaskV2TaskSubtaskRequest { + /** 任务标题 */ + summary: string + /** 任务描述 */ + description?: string + /** 任务截止时间戳(ms)，截止时间戳和截止日期选择一个填写。 */ + due?: Due + /** 任务关联的第三方平台来源信息 */ + origin?: Origin + /** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */ + extra?: string + /** 任务的完成时刻时间戳(ms) */ + completed_at?: string + /** 任务成员列表 */ + members?: Member[] + /** 如果设置，则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */ + repeat_rule?: string + /** 如果设置，则将任务设计为“自定义完成”。用户在任务中心点击“完成”时，不会直接完成任务，而是跳转到第三方配置好的地址或者现实自定义提示。 */ + custom_complete?: CustomComplete + /** 任务所在清单的信息 */ + tasklists?: TaskInTasklistInfo[] + /** 幂等token，如果填写则触发幂等行为。 */ + client_token?: string + /** 任务的开始时间(ms) */ + start?: Start + /** 任务提醒 */ + reminders?: Reminder[] + /** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */ + mode?: number + /** 是否是里程碑任务 */ + is_milestone?: boolean + /** 自定义字段值 */ + custom_fields?: InputCustomFieldValue[] + /** 任务的新版云文档来源 */ + docx_source?: DocxSource +} + +export interface CreateTaskV2TaskSubtaskQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface ListTaskV2TaskSubtaskQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface CreateTaskV2TasklistRequest { + /** 清单名称 */ + name: string + /** 清单的成员列表 */ + members?: Member[] +} + +export interface CreateTaskV2TasklistQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface GetTaskV2TasklistQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface PatchTaskV2TasklistRequest { + /** 要更新清单的数据 */ + tasklist: InputTasklist + /** 要更新的字段名，只支持更新"owner", "name"两个字段 */ + update_fields: string[] + /** 该字段表示如果更新了新的负责人，则将原负责人设为指定的协作人角色。仅在update_fields包含owner字段时生效。根据清单的角色设计方式，不允许提前为清单的负责人添加其他角色，但负责人更新后，原有负责人会无法访问该清单。该字段可以帮助避免原负责人彻底退出清单。 */ + origin_owner_to_role?: 'editor' | 'viewer' | 'none' +} + +export interface PatchTaskV2TasklistQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface AddMembersTaskV2TasklistRequest { + /** 要添加的成员列表 */ + members: Member[] +} + +export interface AddMembersTaskV2TasklistQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface RemoveMembersTaskV2TasklistRequest { + /** 要移除的member列表 */ + members: Member[] +} + +export interface RemoveMembersTaskV2TasklistQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface TasksTaskV2TasklistQuery { + /** 每页返回的任务数量 */ + page_size?: number + /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ + page_token?: string + /** 只查看特定完成状态的任务，不填写表示不按完成状态过滤 */ + completed?: boolean + /** 任务创建的起始时间戳（ms），闭区间，不填写默认为首个任务的创建时间戳 */ + created_from?: string + /** 任务创建的结束时间戳（ms），闭区间，不填写默认为最后创建任务的创建时间戳 */ + created_to?: string + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface ListTaskV2TasklistQuery { + /** 每页返回的清单数量 */ + page_size?: number + /** 分页标记。第一次请求不填该参数，表示从头开始查询；查询结果若还有更多数据时会同时返回新的 page_token。使用page_token重新调用本接口可以获取下一页数据。 */ + page_token?: string + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface CreateTaskV2TasklistActivitySubscriptionRequest { + /** 订阅名称 */ + name: string + /** 订阅者列表 */ + subscribers: Member[] + /** 订阅的事件key列表 */ + include_keys: number[] + /** 该订阅是否为停用 */ + disabled?: boolean +} + +export interface CreateTaskV2TasklistActivitySubscriptionQuery { + /** 用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface GetTaskV2TasklistActivitySubscriptionQuery { + /** 用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface ListTaskV2TasklistActivitySubscriptionQuery { + /** 返回结果的最大数量 */ + limit?: number + /** 用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface PatchTaskV2TasklistActivitySubscriptionRequest { + /** 要更新的订阅数据 */ + activity_subscription: TasklistActivitySubscription + /** 要更新的字段 */ + update_fields: 'name' | 'include_keys' | 'subscribers' | 'disabled'[] +} + +export interface PatchTaskV2TasklistActivitySubscriptionQuery { + /** 用户ID类型 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface CreateTaskV2CommentRequest { + /** 评论内容 */ + content: string + /** 回复给评论的id */ + reply_to_comment_id?: string + /** 评论归属的资源类型 */ + resource_type?: string + /** 评论归属的资源ID */ + resource_id?: string +} + +export interface CreateTaskV2CommentQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface GetTaskV2CommentQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface PatchTaskV2CommentRequest { + /** 要更新的评论数据，支持更新content, md_content */ + comment: InputComment + /** 要更新的字段 */ + update_fields: string[] +} + +export interface PatchTaskV2CommentQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface ListTaskV2CommentQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 要获取评论列表的资源类型 */ + resource_type?: string + /** 要获取评论的资源ID。例如要获取任务的评论列表，此处应该填写任务全局唯一ID */ + resource_id: string + /** 返回数据的排序方式 */ + direction?: 'asc' | 'desc' + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface UploadTaskV2AttachmentForm { + /** 附件归属资源的类型 */ + resource_type?: string + /** 附件要归属资源的id。例如，要给任务添加附件，这里要填入任务的全局唯一ID */ + resource_id: string + /** 要上传的文件 */ + file: Blob +} + +export interface UploadTaskV2AttachmentQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface ListTaskV2AttachmentQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 附件归属的资源类型 */ + resource_type?: string + /** 附件归属资源的id，配合resource_type使用。例如希望获取任务的附件，需要设置 resource_type为task， resource_id为任务的全局唯一ID */ + resource_id: string + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface GetTaskV2AttachmentQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface CreateTaskV2SectionRequest { + /** 自定义分组名称 */ + name: string + /** 自定义分组归属的资源类型，支持"tasklist"或者"my_tasks" */ + resource_type: string + /** 自定义分组要归属的资源id */ + resource_id?: string + /** 要将新分组插入到自定义分分组的前面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ + insert_before?: string + /** 要将新分组插入到自定义分分组的后面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */ + insert_after?: string +} + +export interface CreateTaskV2SectionQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface GetTaskV2SectionQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface PatchTaskV2SectionRequest { + /** 要更新的自定义分组的数据，仅支持name, insert_after, insert_before */ + section: InputSection + /** 要更新的字段名 */ + update_fields: string[] +} + +export interface PatchTaskV2SectionQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface ListTaskV2SectionQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 自定义分组所属的资源类型。支持"my_tasks"(我负责的）和"tasklist"（清单）。当使用"tasklist"时，需要用resource_id提供清单GUID。 */ + resource_type: string + /** 如`resource_type`为"tasklist"，这里需要填写要列取自定义分组的清单的GUID。 */ + resource_id?: string + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface TasksTaskV2SectionQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记 */ + page_token?: string + /** 按照任务状态过滤，如果不填写则表示不按完成状态过滤 */ + completed?: boolean + /** 按照创建时间筛选的起始时间戳（ms)，如不填写则为首个任务的创建时刻 */ + created_from?: string + /** 按照创建时间筛选的起始时间戳（ms)，如不填写则为最后任务的创建时刻 */ + created_to?: string + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: string +} + +export interface CreateTaskV2CustomFieldRequest { + /** 自定义字段要归属的资源类型，支持"tasklist" */ + resource_type: string + /** 自定义字段要归属的资源ID，可以填写清单的tasklist_guid */ + resource_id: string + /** 字段名称 */ + name: string + /** 自定义字段类型，支持"number", "datetime", "member", "single_select", "multi_select" */ + type: 'number' | 'datetime' | 'member' | 'single_select' | 'multi_select' | 'text' + /** 数字类型的字段设置 */ + number_setting?: NumberSetting + /** 人员类型的字段设置 */ + member_setting?: MemberSetting + /** 时间日期类型的字段设置 */ + datetime_setting?: DatetimeSetting + /** 单选设置 */ + single_select_setting?: SelectSetting + /** 多选设置 */ + multi_select_setting?: SelectSetting + /** 文本类型 */ + text_setting?: TextSetting +} + +export interface CreateTaskV2CustomFieldQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' +} + +export interface GetTaskV2CustomFieldQuery { + /** 表示user的ID的类型，支持open_id, user_id, union_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' +} + +export interface PatchTaskV2CustomFieldRequest { + /** 要修改的自定义字段数据 */ + custom_field?: InputCustomField + /** 要修改的自定义字段类型，支持name, member_setting, number_setting, datetime_setting, single_select_setting, multi_select_setting */ + update_fields?: string[] +} + +export interface PatchTaskV2CustomFieldQuery { + /** 用户ID格式 */ + user_id_type?: 'open_id' | 'union_id' | 'user_id' +} + +export interface ListTaskV2CustomFieldQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 用户ID格式，支持open_id, user_id, union_id */ + user_id_type?: 'open_id' | 'user_id' | 'union_id' + /** 资源类型，如提供表示仅查询特定资源下的自定义字段。目前只支持tasklist。 */ + resource_type?: string + /** 要查询自定义字段的归属resource_id */ + resource_id?: string +} + +export interface AddTaskV2CustomFieldRequest { + /** 要将自定义字段添加到一个资源的资源类型。目前只支持tasklist */ + resource_type: string + /** 要将自定义字段添加到的资源id，目前只支持tasklist_guid */ + resource_id: string +} + +export interface RemoveTaskV2CustomFieldRequest { + /** 要从某个资源移除自定义字段的资源类型，目前只支持清单"tasklist"。 */ + resource_type: string + /** 要从某个资源移除自定义字段的资源id，`resource_type`为"tasklist"时，需填写清单的GUID */ + resource_id: string +} + +export interface CreateTaskV2CustomFieldOptionRequest { + /** 选项名 */ + name: string + /** 颜色索引值，支持0～54中的一个数字。如果不填写，则会随机选一个。 */ + color_index?: number + /** 要放到某个option之前的option_guid */ + insert_before?: string + /** 要放到某个option之后的option_guid */ + insert_after?: string + /** 是否隐藏 */ + is_hidden?: boolean +} + +export interface PatchTaskV2CustomFieldOptionRequest { + /** 要更新的option数据 */ + option?: InputOption + /** 要更新的字段名，支持name,color,is_hidden,insert_before,insert_after */ + update_fields?: string[] +} + +export interface CreateTaskV1Request { + /** 任务标题。创建任务时，如果没有标题填充，将其视为无主题的任务。 */ + summary?: string + /** 任务备注 */ + description?: string + /** 接入方可以自定义的附属信息二进制格式，采用 base64 编码，解析方式由接入方自己决定 */ + extra?: string + /** 任务的截止时间设置 */ + due?: Due + /** 任务关联的第三方平台来源信息 */ + origin: Origin + /** 此字段用于控制该任务在任务中心是否可编辑，默认为false，若为true则第三方需考虑是否需要接入事件来接收任务在任务中心的变更信息 */ + can_edit?: boolean + /** 此字段用于存储第三方需透传到端上的自定义数据，Json格式。取值举例中custom_complete字段存储「完成」按钮的跳转链接（href）或提示信息（tip），pc、ios、android三端均可自定义，其中tip字段的key为语言类型，value为提示信息，可自行增加或减少语言类型，支持的各地区语言名：it_it, th_th, ko_kr, es_es, ja_jp, zh_cn, id_id, zh_hk, pt_br, de_de, fr_fr, zh_tw, ru_ru, en_us, hi_in, vi_vn。href的优先级高于tip，href和tip同时不为空时只跳转不提示。链接和提示信息可自定义，其余的key需按举例中的结构传递 */ + custom?: string + /** 创建任务时添加的执行者用户id列表 */ + collaborator_ids?: string[] + /** 创建任务时添加的关注者用户id列表 */ + follower_ids?: string[] + /** 重复任务重复规则 */ + repeat_rule?: string + /** 富文本任务标题。创建任务时，如果没有标题填充，将其视为无主题的任务。 */ + rich_summary?: string + /** 富文本任务备注 */ + rich_description?: string +} + +export interface CreateTaskV1Query { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchTaskV1Request { + /** 被更新的任务实体基础信息 */ + task: Task + /** 指定需要更新的字段（目前可选更新的字段为：summary, description, due, extra），否则服务端将不知道更新哪些字段 */ + update_fields: string[] +} + +export interface PatchTaskV1Query { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetTaskV1Query { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListTaskV1Query { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 范围查询任务时，查询的起始时间。不填时默认起始时间为第一个任务的创建时间。 */ + start_create_time?: string + /** 范围查询任务时，查询的结束时间。不填时默认结束时间为最后一个任务的创建时间。 */ + end_create_time?: string + /** 可用于查询时过滤任务完成状态。true表示只返回已完成的任务，false表示只返回未完成的任务。不填时表示同时返回两种完成状态的任务。 */ + task_completed?: boolean + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateTaskV1TaskReminderRequest { + /** 相对于截止时间的提醒时间（如提前 30 分钟，截止时间后 30 分钟，则为 -30） */ + relative_fire_minute: number +} + +export interface ListTaskV1TaskReminderQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateTaskV1TaskCommentRequest { + /** 评论内容 */ + content?: string + /** 评论的父ID，创建评论时若不为空则为某条评论的回复，若为空则不是回复 */ + parent_id?: string + /** 评论创建的时间戳，单位为毫秒，用于展示，创建时不用填写 */ + create_milli_time?: string + /** 富文本评论内容 */ + rich_content?: string +} + +export interface CreateTaskV1TaskCommentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateTaskV1TaskCommentRequest { + /** 新的评论内容 */ + content?: string + /** 新的富文本评论内容（优先使用） */ + rich_content?: string +} + +export interface UpdateTaskV1TaskCommentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetTaskV1TaskCommentQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListTaskV1TaskCommentQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token获取查询结果 */ + page_token?: string + /** 评论排序标记，可按照评论时间从小到大查询，或者评论时间从大到小查询，不填默认按照从小到大 */ + list_direction?: 0 | 1 + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateTaskV1TaskFollowerRequest { + /** 任务关注者 ID */ + id?: string + /** 要添加为关注人的user_id */ + id_list?: string[] +} + +export interface CreateTaskV1TaskFollowerQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteTaskV1TaskFollowerQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchDeleteFollowerTaskV1Request { + /** 要添加为关注人的user_id */ + id_list?: string[] +} + +export interface BatchDeleteFollowerTaskV1Query { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListTaskV1TaskFollowerQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface CreateTaskV1TaskCollaboratorRequest { + /** 任务协作者的 ID */ + id?: string + /** 协作人的用户ID列表 */ + id_list?: string[] +} + +export interface CreateTaskV1TaskCollaboratorQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface DeleteTaskV1TaskCollaboratorQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface BatchDeleteCollaboratorTaskV1Request { + /** 协作人的用户ID列表 */ + id_list?: string[] +} + +export interface BatchDeleteCollaboratorTaskV1Query { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListTaskV1TaskCollaboratorQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户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 ListTaskV2Response { + /** 返回的任务列表 */ + items?: Task[] + /** 获取下一次分页的分页标记 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +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 ListTaskV2TaskSubtaskResponse { + /** 子任务列表 */ + items?: Task[] + /** 用于返回下一个分页的token */ + page_token?: string + /** 是否还有下一页数据。 */ + has_more?: boolean +} + +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 TasksTaskV2TasklistResponse { + /** 任务摘要数据 */ + items?: TaskSummary[] + /** 用于获取下一页的分页标记，最后一页时发返回空 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +export interface ListTaskV2TasklistResponse { + /** 清单数据列表 */ + items?: Tasklist[] + /** 用于获取下一页的分页标记 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +export interface CreateTaskV2TasklistActivitySubscriptionResponse { + /** 清单动态订阅 */ + activity_subscription?: TasklistActivitySubscription +} + +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 ListTaskV2CommentResponse { + /** 评论列表数据 */ + items?: Comment[] + /** 用于获取下一页的分页标记，当has_more为false时为空 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface UploadTaskV2AttachmentResponse { + /** 上传的附件列表 */ + items?: Attachment[] +} + +export interface ListTaskV2AttachmentResponse { + /** 附件列表 */ + items?: Attachment[] + /** 获取下一页的分页标记，无更多数据时返回空 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +export interface GetTaskV2AttachmentResponse { + /** 附件详情 */ + attachment?: Attachment +} + +export interface CreateTaskV2SectionResponse { + /** 创建的自定义分组数据 */ + section?: Section +} + +export interface GetTaskV2SectionResponse { + /** 获取的自定义分组详情 */ + section?: Section +} + +export interface PatchTaskV2SectionResponse { + /** 更新后的自定义分组 */ + section?: Section +} + +export interface ListTaskV2SectionResponse { + /** 自定义分组的摘要列表 */ + items?: SectionSummary[] + /** 获取下一页数据的分页标记，没有更多数据时返回空 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +export interface TasksTaskV2SectionResponse { + /** 任务摘要信息 */ + items?: TaskSummary[] + /** 获取下一页的分页标记，无更多数据时返回空 */ + page_token?: string + /** 是否有更多数据 */ + has_more?: boolean +} + +export interface CreateTaskV2CustomFieldResponse { + /** 创建的自定义字段 */ + custom_field?: CustomField +} + +export interface GetTaskV2CustomFieldResponse { + /** 获取的自定义字段数据 */ + custom_field?: CustomField +} + +export interface PatchTaskV2CustomFieldResponse { + /** 修改后的自定义字段设置 */ + custom_field?: CustomField +} + +export interface ListTaskV2CustomFieldResponse { + /** 返回的自定义字段列表 */ + items?: CustomField[] + /** 用于获取下一页数据的page_token */ + page_token?: string + /** 是否有下一页的数据 */ + has_more?: boolean +} + +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 ListTaskV1Response { + /** 任务列表 */ + items?: Task[] + /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** true */ + has_more?: boolean +} + +export interface CreateTaskV1TaskReminderResponse { + /** 返回创建成功的提醒时间 */ + reminder?: Reminder +} + +export interface ListTaskV1TaskReminderResponse { + /** 返回提醒时间设置列表 */ + items?: Reminder[] + /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface CreateTaskV1TaskCommentResponse { + /** 返回创建好的任务评论 */ + comment?: Comment +} + +export interface UpdateTaskV1TaskCommentResponse { + /** 返回修改后的任务评论详情 */ + comment?: Comment +} + +export interface GetTaskV1TaskCommentResponse { + /** 返回新的任务评论详情 */ + comment?: Comment +} + +export interface ListTaskV1TaskCommentResponse { + /** 返回的评论列表 */ + items?: Comment[] + /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface CreateTaskV1TaskFollowerResponse { + /** 创建后的任务关注者 */ + follower: Follower +} + +export interface BatchDeleteFollowerTaskV1Response { + /** 实际删除的关注人用户ID列表 */ + followers?: string[] +} + +export interface ListTaskV1TaskFollowerResponse { + /** 返回的关注者列表 */ + items?: Follower[] + /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +export interface CreateTaskV1TaskCollaboratorResponse { + /** 返回创建成功后的任务协作者 */ + collaborator: Collaborator +} + +export interface BatchDeleteCollaboratorTaskV1Response { + /** 实际删除的执行人用户ID列表 */ + collaborators?: string[] +} + +export interface ListTaskV1TaskCollaboratorResponse { + /** 返回的协作者列表 */ + items?: Collaborator[] + /** 分页标记，分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 是否还有更多数据 */ + has_more?: boolean +} + +Internal.define({ + '/open-apis/task/v2/tasks': { + POST: 'createTaskV2', + GET: 'listTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}': { + GET: 'getTaskV2', + PATCH: 'patchTaskV2', + DELETE: 'deleteTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/add_members': { + POST: 'addMembersTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/remove_members': { + POST: 'removeMembersTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/tasklists': { + GET: 'tasklistsTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/add_tasklist': { + POST: 'addTasklistTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/remove_tasklist': { + POST: 'removeTasklistTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/add_reminders': { + POST: 'addRemindersTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/remove_reminders': { + POST: 'removeRemindersTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/add_dependencies': { + POST: 'addDependenciesTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/remove_dependencies': { + POST: 'removeDependenciesTaskV2', + }, + '/open-apis/task/v2/tasks/{task_guid}/subtasks': { + POST: 'createTaskV2TaskSubtask', + GET: 'listTaskV2TaskSubtask', + }, + '/open-apis/task/v2/tasklists': { + POST: 'createTaskV2Tasklist', + GET: 'listTaskV2Tasklist', + }, + '/open-apis/task/v2/tasklists/{tasklist_guid}': { + GET: 'getTaskV2Tasklist', + PATCH: 'patchTaskV2Tasklist', + DELETE: 'deleteTaskV2Tasklist', + }, + '/open-apis/task/v2/tasklists/{tasklist_guid}/add_members': { + POST: 'addMembersTaskV2Tasklist', + }, + '/open-apis/task/v2/tasklists/{tasklist_guid}/remove_members': { + POST: 'removeMembersTaskV2Tasklist', + }, + '/open-apis/task/v2/tasklists/{tasklist_guid}/tasks': { + GET: 'tasksTaskV2Tasklist', + }, + '/open-apis/task/v2/tasklists/{tasklist_guid}/activity_subscriptions': { + POST: 'createTaskV2TasklistActivitySubscription', + GET: 'listTaskV2TasklistActivitySubscription', + }, + '/open-apis/task/v2/tasklists/{tasklist_guid}/activity_subscriptions/{activity_subscription_guid}': { + GET: 'getTaskV2TasklistActivitySubscription', + PATCH: 'patchTaskV2TasklistActivitySubscription', + DELETE: 'deleteTaskV2TasklistActivitySubscription', + }, + '/open-apis/task/v2/comments': { + POST: 'createTaskV2Comment', + GET: 'listTaskV2Comment', + }, + '/open-apis/task/v2/comments/{comment_id}': { + GET: 'getTaskV2Comment', + PATCH: 'patchTaskV2Comment', + DELETE: 'deleteTaskV2Comment', + }, + '/open-apis/task/v2/attachments/upload': { + POST: { name: 'uploadTaskV2Attachment', multipart: true }, + }, + '/open-apis/task/v2/attachments': { + GET: 'listTaskV2Attachment', + }, + '/open-apis/task/v2/attachments/{attachment_guid}': { + GET: 'getTaskV2Attachment', + DELETE: 'deleteTaskV2Attachment', + }, + '/open-apis/task/v2/sections': { + POST: 'createTaskV2Section', + GET: 'listTaskV2Section', + }, + '/open-apis/task/v2/sections/{section_guid}': { + GET: 'getTaskV2Section', + PATCH: 'patchTaskV2Section', + DELETE: 'deleteTaskV2Section', + }, + '/open-apis/task/v2/sections/{section_guid}/tasks': { + GET: 'tasksTaskV2Section', + }, + '/open-apis/task/v2/custom_fields': { + POST: 'createTaskV2CustomField', + GET: 'listTaskV2CustomField', + }, + '/open-apis/task/v2/custom_fields/{custom_field_guid}': { + GET: 'getTaskV2CustomField', + PATCH: 'patchTaskV2CustomField', + }, + '/open-apis/task/v2/custom_fields/{custom_field_guid}/add': { + POST: 'addTaskV2CustomField', + }, + '/open-apis/task/v2/custom_fields/{custom_field_guid}/remove': { + POST: 'removeTaskV2CustomField', + }, + '/open-apis/task/v2/custom_fields/{custom_field_guid}/options': { + POST: 'createTaskV2CustomFieldOption', + }, + '/open-apis/task/v2/custom_fields/{custom_field_guid}/options/{option_guid}': { + PATCH: 'patchTaskV2CustomFieldOption', + }, + '/open-apis/task/v1/tasks': { + POST: 'createTaskV1', + GET: 'listTaskV1', + }, + '/open-apis/task/v1/tasks/{task_id}': { + DELETE: 'deleteTaskV1', + PATCH: 'patchTaskV1', + GET: 'getTaskV1', + }, + '/open-apis/task/v1/tasks/{task_id}/complete': { + POST: 'completeTaskV1', + }, + '/open-apis/task/v1/tasks/{task_id}/uncomplete': { + POST: 'uncompleteTaskV1', + }, + '/open-apis/task/v1/tasks/{task_id}/reminders': { + POST: 'createTaskV1TaskReminder', + GET: 'listTaskV1TaskReminder', + }, + '/open-apis/task/v1/tasks/{task_id}/reminders/{reminder_id}': { + DELETE: 'deleteTaskV1TaskReminder', + }, + '/open-apis/task/v1/tasks/{task_id}/comments': { + POST: 'createTaskV1TaskComment', + GET: 'listTaskV1TaskComment', + }, + '/open-apis/task/v1/tasks/{task_id}/comments/{comment_id}': { + DELETE: 'deleteTaskV1TaskComment', + PUT: 'updateTaskV1TaskComment', + GET: 'getTaskV1TaskComment', + }, + '/open-apis/task/v1/tasks/{task_id}/followers': { + POST: 'createTaskV1TaskFollower', + GET: 'listTaskV1TaskFollower', + }, + '/open-apis/task/v1/tasks/{task_id}/followers/{follower_id}': { + DELETE: 'deleteTaskV1TaskFollower', + }, + '/open-apis/task/v1/tasks/{task_id}/batch_delete_follower': { + POST: 'batchDeleteFollowerTaskV1', + }, + '/open-apis/task/v1/tasks/{task_id}/collaborators': { + POST: 'createTaskV1TaskCollaborator', + GET: 'listTaskV1TaskCollaborator', + }, + '/open-apis/task/v1/tasks/{task_id}/collaborators/{collaborator_id}': { + DELETE: 'deleteTaskV1TaskCollaborator', + }, + '/open-apis/task/v1/tasks/{task_id}/batch_delete_collaborator': { + POST: 'batchDeleteCollaboratorTaskV1', + }, +}) diff --git a/adapters/lark/src/types/tenant.ts b/adapters/lark/src/types/tenant.ts new file mode 100644 index 00000000..11d972a5 --- /dev/null +++ b/adapters/lark/src/types/tenant.ts @@ -0,0 +1,36 @@ +import { Internal } from '../internal' +import { Tenant, TenantAssignInfo } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取企业席位信息接口 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/tenant-v2/tenant-product_assign_info/query + */ + queryTenantTenantProductAssignInfo(): Promise + /** + * 获取企业信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/tenant-v2/tenant/query + */ + queryTenant(): Promise + } +} + +export interface QueryTenantTenantProductAssignInfoResponse { + /** 租户待分配席位列表 */ + assign_info_list?: TenantAssignInfo[] +} + +export interface QueryTenantResponse { + /** 企业信息 */ + tenant?: Tenant +} + +Internal.define({ + '/open-apis/tenant/v2/tenant/assign_info_list/query': { + GET: 'queryTenantTenantProductAssignInfo', + }, + '/open-apis/tenant/v2/tenant/query': { + GET: 'queryTenant', + }, +}) diff --git a/adapters/lark/src/types/translation.ts b/adapters/lark/src/types/translation.ts new file mode 100644 index 00000000..b3b1e529 --- /dev/null +++ b/adapters/lark/src/types/translation.ts @@ -0,0 +1,52 @@ +import { Internal } from '../internal' +import { Term } from '.' + +declare module '../internal' { + interface Internal { + /** + * 识别文本语种 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/detect + */ + detectTranslationText(body: DetectTranslationTextRequest): Promise + /** + * 翻译文本 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/translate + */ + translateTranslationText(body: TranslateTranslationTextRequest): Promise + } +} + +export interface DetectTranslationTextRequest { + /** 需要被识别语种的文本 */ + text: string +} + +export interface TranslateTranslationTextRequest { + /** 源语言 */ + source_language: string + /** 源文本 */ + text: string + /** 目标语言 */ + target_language: string + /** 请求级术语表，携带术语，仅在本次翻译中生效（最多能携带 128个术语词） */ + glossary?: Term[] +} + +export interface DetectTranslationTextResponse { + /** 识别的文本语种，返回符合 ISO 693-1 标准 */ + language: string +} + +export interface TranslateTranslationTextResponse { + /** 翻译后的文本 */ + text: string +} + +Internal.define({ + '/open-apis/translation/v1/text/detect': { + POST: 'detectTranslationText', + }, + '/open-apis/translation/v1/text/translate': { + POST: 'translateTranslationText', + }, +}) diff --git a/adapters/lark/src/types/vc.ts b/adapters/lark/src/types/vc.ts new file mode 100644 index 00000000..f2280d6b --- /dev/null +++ b/adapters/lark/src/types/vc.ts @@ -0,0 +1,1308 @@ +import { Internal } from '../internal' +import { Alert, ApprovalConfig, Device, DisableInformConfig, Meeting, MeetingInfo, MeetingInviteStatus, MeetingParticipantResult, MeetingRecording, MeetingUser, Participant, ParticipantQuality, RecordingPermissionObject, Report, ReportTopUser, Reserve, ReserveAdminConfig, ReserveCorrectionCheckInfo, ReserveFormConfig, ReserveMeetingSetting, ReserveScopeConfig, Room, RoomConfig, RoomDigitalSignage, RoomLevel, RoomMeetingReservation, RoomStatus, ScopeConfig, TimeConfig } from '.' + +declare module '../internal' { + interface Internal { + /** + * 预约会议 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply + */ + applyVcReserve(body: ApplyVcReserveRequest, query?: ApplyVcReserveQuery): Promise + /** + * 删除预约 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete + */ + deleteVcReserve(reserve_id: string): Promise + /** + * 更新预约 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update + */ + updateVcReserve(reserve_id: string, body: UpdateVcReserveRequest, query?: UpdateVcReserveQuery): Promise + /** + * 获取预约 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get + */ + getVcReserve(reserve_id: string, query?: GetVcReserveQuery): Promise + /** + * 获取活跃会议 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get_active_meeting + */ + getActiveMeetingVcReserve(reserve_id: string, query?: GetActiveMeetingVcReserveQuery): Promise + /** + * 邀请参会人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/invite + */ + inviteVcMeeting(meeting_id: string, body: InviteVcMeetingRequest, query?: InviteVcMeetingQuery): Promise + /** + * 移除参会人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/kickout + */ + kickoutVcMeeting(meeting_id: string, body: KickoutVcMeetingRequest, query?: KickoutVcMeetingQuery): Promise + /** + * 设置主持人 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/set_host + */ + setHostVcMeeting(meeting_id: string, body: SetHostVcMeetingRequest, query?: SetHostVcMeetingQuery): Promise + /** + * 结束会议 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/end + */ + endVcMeeting(meeting_id: string): Promise + /** + * 获取会议详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get + */ + getVcMeeting(meeting_id: string, query?: GetVcMeetingQuery): Promise + /** + * 获取与会议号关联的会议列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no + */ + listByNoVcMeeting(query?: ListByNoVcMeetingQuery): Promise + /** + * 开始录制 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start + */ + startVcMeetingRecording(meeting_id: string, body: StartVcMeetingRecordingRequest): Promise + /** + * 停止录制 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/stop + */ + stopVcMeetingRecording(meeting_id: string): Promise + /** + * 获取录制文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/get + */ + getVcMeetingRecording(meeting_id: string): Promise + /** + * 授权录制文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/set_permission + */ + setPermissionVcMeetingRecording(meeting_id: string, body: SetPermissionVcMeetingRecordingRequest, query?: SetPermissionVcMeetingRecordingQuery): Promise + /** + * 获取会议报告 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_daily + */ + getDailyVcReport(query?: GetDailyVcReportQuery): Promise + /** + * 获取 Top 用户列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_top_user + */ + getTopUserVcReport(query?: GetTopUserVcReportQuery): Promise + /** + * 导出会议明细 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/meeting_list + */ + meetingListVcExport(body: MeetingListVcExportRequest, query?: MeetingListVcExportQuery): Promise + /** + * 导出参会人明细 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_list + */ + participantListVcExport(body: ParticipantListVcExportRequest, query?: ParticipantListVcExportQuery): Promise + /** + * 导出参会人会议质量数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_quality_list + */ + participantQualityListVcExport(body: ParticipantQualityListVcExportRequest, query?: ParticipantQualityListVcExportQuery): Promise + /** + * 导出会议室预定数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list + */ + resourceReservationListVcExport(body: ResourceReservationListVcExportRequest): Promise + /** + * 查询导出任务结果 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/get + */ + getVcExport(task_id: string): Promise + /** + * 下载导出文件 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/download + */ + downloadVcExport(query?: DownloadVcExportQuery): Promise + /** + * 创建会议室层级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/create + */ + createVcRoomLevel(body: CreateVcRoomLevelRequest): Promise + /** + * 删除会议室层级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/del + */ + delVcRoomLevel(body: DelVcRoomLevelRequest): Promise + /** + * 更新会议室层级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/patch + */ + patchVcRoomLevel(room_level_id: string, body: PatchVcRoomLevelRequest): Promise + /** + * 查询会议室层级详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/get + */ + getVcRoomLevel(room_level_id: string): Promise + /** + * 批量查询会议室层级详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/mget + */ + mgetVcRoomLevel(body: MgetVcRoomLevelRequest): Promise + /** + * 查询会议室层级列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list + */ + listVcRoomLevel(query?: ListVcRoomLevelQuery): Promise + /** + * 搜索会议室层级 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search + */ + searchVcRoomLevel(query?: SearchVcRoomLevelQuery): Promise + /** + * 创建会议室 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/create + */ + createVcRoom(body: CreateVcRoomRequest, query?: CreateVcRoomQuery): Promise + /** + * 删除会议室 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/delete + */ + deleteVcRoom(room_id: string): Promise + /** + * 更新会议室 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/patch + */ + patchVcRoom(room_id: string, body: PatchVcRoomRequest, query?: PatchVcRoomQuery): Promise + /** + * 查询会议室详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/get + */ + getVcRoom(room_id: string, query?: GetVcRoomQuery): Promise + /** + * 批量查询会议室详情 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/mget + */ + mgetVcRoom(body: MgetVcRoomRequest, query?: MgetVcRoomQuery): Promise + /** + * 查询会议室列表 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list + */ + listVcRoom(query?: ListVcRoomQuery): Promise + /** + * 搜索会议室 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search + */ + searchVcRoom(body: SearchVcRoomRequest, query?: SearchVcRoomQuery): Promise + /** + * 查询会议室配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get + */ + getVcScopeConfig(query?: GetVcScopeConfigQuery): Promise + /** + * 设置会议室配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/create + */ + createVcScopeConfig(body: CreateVcScopeConfigRequest, query?: CreateVcScopeConfigQuery): Promise + /** + * 查询会议室预定限制 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/reserve_scope + */ + reserveScopeVcReserveConfig(query?: ReserveScopeVcReserveConfigQuery): Promise + /** + * 更新会议室预定限制 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/patch + */ + patchVcReserveConfig(reserve_config_id: string, body: PatchVcReserveConfigRequest, query?: PatchVcReserveConfigQuery): Promise + /** + * 查询会议室预定表单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/get + */ + getVcReserveConfigForm(reserve_config_id: string, query?: GetVcReserveConfigFormQuery): Promise + /** + * 更新会议室预定表单 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/patch + */ + patchVcReserveConfigForm(reserve_config_id: string, body: PatchVcReserveConfigFormRequest, query?: PatchVcReserveConfigFormQuery): Promise + /** + * 查询会议室预定管理员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/get + */ + getVcReserveConfigAdmin(reserve_config_id: string, query?: GetVcReserveConfigAdminQuery): Promise + /** + * 更新会议室预定管理员 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/patch + */ + patchVcReserveConfigAdmin(reserve_config_id: string, body: PatchVcReserveConfigAdminRequest, query?: PatchVcReserveConfigAdminQuery): Promise + /** + * 查询禁用状态变更通知 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/get + */ + getVcReserveConfigDisableInform(reserve_config_id: string, query?: GetVcReserveConfigDisableInformQuery): Promise + /** + * 更新禁用状态变更通知 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/patch + */ + patchVcReserveConfigDisableInform(reserve_config_id: string, body: PatchVcReserveConfigDisableInformRequest, query?: PatchVcReserveConfigDisableInformQuery): Promise + /** + * 查询会议明细 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get + */ + getVcMeetingList(query?: GetVcMeetingListQuery): Promise + /** + * 查询参会人明细 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get + */ + getVcParticipantList(query?: GetVcParticipantListQuery): Promise + /** + * 查询参会人会议质量数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get + */ + getVcParticipantQualityList(query?: GetVcParticipantQualityListQuery): Promise + /** + * 查询会议室预定数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get + */ + getVcResourceReservationList(query?: GetVcResourceReservationListQuery): Promise + /** + * 获取告警记录 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list + */ + listVcAlert(query?: ListVcAlertQuery): Promise + /** + * 创建签到板部署码 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_checkboard_access_code + */ + setCheckboardAccessCodeVcRoomConfig(body: SetCheckboardAccessCodeVcRoomConfigRequest): Promise + /** + * 创建会议室部署码 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_room_access_code + */ + setRoomAccessCodeVcRoomConfig(body: SetRoomAccessCodeVcRoomConfigRequest): Promise + /** + * 查询会议室配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/query + */ + queryVcRoomConfig(query?: QueryVcRoomConfigQuery): Promise + /** + * 设置会议室配置 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set + */ + setVcRoomConfig(body: SetVcRoomConfigRequest, query?: SetVcRoomConfigQuery): Promise + } +} + +export interface ApplyVcReserveRequest { + /** 预约到期时间（unix时间，单位sec），多人会议必填 */ + end_time?: string + /** 指定会议归属人，使用tenant_access_token时生效且必传，使用user_access_token时不生效，必须指定为同租户下的合法lark用户 */ + owner_id?: string + /** 会议设置 */ + meeting_settings: ReserveMeetingSetting +} + +export interface ApplyVcReserveQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface UpdateVcReserveRequest { + /** 预约到期时间（unix时间，单位sec） */ + end_time?: string + /** 会议设置 */ + meeting_settings?: ReserveMeetingSetting +} + +export interface UpdateVcReserveQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcReserveQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetActiveMeetingVcReserveQuery { + /** 是否需要参会人列表，默认为false */ + with_participants?: boolean + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface InviteVcMeetingRequest { + /** 被邀请的用户列表 */ + invitees: MeetingUser[] +} + +export interface InviteVcMeetingQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface KickoutVcMeetingRequest { + /** 需踢出的用户列表 */ + kickout_users: MeetingUser[] +} + +export interface KickoutVcMeetingQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SetHostVcMeetingRequest { + /** 将要设置的主持人 */ + host_user: MeetingUser + /** 当前主持人（CAS并发安全：如果和会中当前主持人不符则会设置失败，可使用返回的最新数据重新设置） */ + old_host_user?: MeetingUser +} + +export interface SetHostVcMeetingQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcMeetingQuery { + /** 是否需要参会人列表 */ + with_participants?: boolean + /** 是否需要会中使用能力统计（仅限tenant_access_token） */ + with_meeting_ability?: boolean + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListByNoVcMeetingQuery { + /** 9位会议号 */ + meeting_no: string + /** 查询开始时间（unix时间，单位sec） */ + start_time: string + /** 查询结束时间（unix时间，单位sec） */ + end_time: string + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface StartVcMeetingRecordingRequest { + /** 录制文件时间显示使用的时区[-12,12] */ + timezone?: number +} + +export interface SetPermissionVcMeetingRecordingRequest { + /** 授权对象列表 */ + permission_objects: RecordingPermissionObject[] + /** 授权或者取消授权，默认授权 */ + action_type?: 0 | 1 +} + +export interface SetPermissionVcMeetingRecordingQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetDailyVcReportQuery { + /** 开始时间（unix时间，单位sec） */ + start_time: string + /** 结束时间（unix时间，单位sec） */ + end_time: string + /** 数据驻留地 */ + unit?: 0 | 1 | 2 | 3 +} + +export interface GetTopUserVcReportQuery { + /** 开始时间（unix时间，单位sec） */ + start_time: string + /** 结束时间（unix时间，单位sec） */ + end_time: string + /** 取前多少位 */ + limit: number + /** 排序依据（降序） */ + order_by: 1 | 2 + /** 数据驻留地 */ + unit?: 0 | 1 | 2 | 3 + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface MeetingListVcExportRequest { + /** 查询开始时间（unix时间，单位sec） */ + start_time: string + /** 查询结束时间（unix时间，单位sec） */ + end_time: string + /** 会议状态（不传默认为已结束会议） */ + meeting_status?: 1 | 2 | 3 + /** 按9位会议号筛选（最多一个筛选条件） */ + meeting_no?: string + /** 按参会Lark用户筛选（最多一个筛选条件） */ + user_id?: string + /** 按参会Rooms筛选（最多一个筛选条件） */ + room_id?: string + /** 按会议类型筛选（最多一个筛选条件） */ + meeting_type?: 1 | 2 | 3 +} + +export interface MeetingListVcExportQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ParticipantListVcExportRequest { + /** 会议开始时间（unix时间，单位sec） */ + meeting_start_time: string + /** 会议结束时间（unix时间，单位sec） */ + meeting_end_time: string + /** 会议状态（不传默认为已结束会议） */ + meeting_status?: 1 | 2 | 3 + /** 9位会议号 */ + meeting_no: string + /** 按参会Lark用户筛选（最多一个筛选条件） */ + user_id?: string + /** 按参会Rooms筛选（最多一个筛选条件） */ + room_id?: string +} + +export interface ParticipantListVcExportQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ParticipantQualityListVcExportRequest { + /** 会议开始时间（unix时间，单位sec） */ + meeting_start_time: string + /** 会议结束时间（unix时间，单位sec） */ + meeting_end_time: string + /** 9位会议号 */ + meeting_no: string + /** 参会人入会时间（unix时间，单位sec） */ + join_time: string + /** 参会人为Lark用户时填入 */ + user_id?: string + /** 参会人为Rooms时填入 */ + room_id?: string +} + +export interface ParticipantQualityListVcExportQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ResourceReservationListVcExportRequest { + /** 层级id */ + room_level_id: string + /** 是否展示会议主题 */ + need_topic?: boolean + /** 查询开始时间（unix时间，单位sec） */ + start_time: string + /** 查询结束时间（unix时间，单位sec） */ + end_time: string + /** 待筛选的会议室id列表 */ + room_ids?: string[] + /** 若为true表示导出room_ids范围外的会议室，默认为false */ + is_exclude?: boolean +} + +export interface DownloadVcExportQuery { + /** 文档token */ + file_token: string +} + +export interface CreateVcRoomLevelRequest { + /** 层级名称 */ + name: string + /** 父层级ID */ + parent_id: string + /** 自定义层级ID */ + custom_group_id?: string +} + +export interface DelVcRoomLevelRequest { + /** 层级ID */ + room_level_id: string + /** 是否删除所有子层级 */ + delete_child?: boolean +} + +export interface PatchVcRoomLevelRequest { + /** 层级名称 */ + name: string + /** 父层级ID */ + parent_id: string + /** 自定义层级ID */ + custom_group_id?: string +} + +export interface MgetVcRoomLevelRequest { + /** 层级id列表 */ + level_ids: string[] +} + +export interface ListVcRoomLevelQuery { + /** 层级ID，不传则返回该租户下第一层级列表 */ + room_level_id?: string + /** 分页尺寸大小 */ + page_size?: number + /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ + page_token?: string +} + +export interface SearchVcRoomLevelQuery { + /** 用于查询指定会议室的租户自定义会议室ID */ + custom_level_ids: string +} + +export interface CreateVcRoomRequest { + /** 会议室名称 */ + name: string + /** 会议室能容纳的人数 */ + capacity: number + /** 会议室的相关描述 */ + description?: string + /** 自定义的会议室ID */ + custom_room_id?: string + /** 层级ID */ + room_level_id: string + /** 会议室状态 */ + room_status?: RoomStatus + /** 设施信息列表 */ + device?: Device[] +} + +export interface CreateVcRoomQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchVcRoomRequest { + /** 会议室名称 */ + name?: string + /** 会议室能容纳的人数 */ + capacity?: number + /** 会议室的相关描述 */ + description?: string + /** 自定义的会议室ID */ + custom_room_id?: string + /** 层级ID */ + room_level_id?: string + /** 会议室状态 */ + room_status?: RoomStatus + /** 设施信息列表 */ + device?: Device[] +} + +export interface PatchVcRoomQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcRoomQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface MgetVcRoomRequest { + /** 会议室id列表 */ + room_ids: string[] +} + +export interface MgetVcRoomQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ListVcRoomQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 层级ID，不传则返回该租户下的所有会议室 */ + room_level_id?: string + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SearchVcRoomRequest { + /** 用于查询指定会议室的租户自定义会议室ID列表，优先使用该字段进行查询 */ + custom_room_ids?: string[] + /** 会议室搜索关键词（当custom_room_ids为空时，使用该字段进行查询） */ + keyword?: string + /** 在该会议室层级下进行搜索 */ + room_level_id?: string + /** 搜索会议室是否包括层级名称 */ + search_level_name?: boolean + /** 分页大小，该值默认为10，最大为100 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SearchVcRoomQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcScopeConfigQuery { + /** 查询节点范围 */ + scope_type: 1 | 2 + /** 查询节点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 CreateVcScopeConfigRequest { + /** 查询节点范围 */ + scope_type: 1 | 2 + /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */ + scope_id: string + /** 节点配置 */ + scope_config?: RoomConfig +} + +export interface CreateVcScopeConfigQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface ReserveScopeVcReserveConfigQuery { + /** 会议室或层级id */ + scope_id: string + /** 1代表层级，2代表会议室 */ + scope_type: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchVcReserveConfigRequest { + /** 1代表层级，2代表会议室 */ + scope_type: string + /** 预定审批设置 */ + approval_config?: ApprovalConfig + /** 预定时间设置 */ + time_config?: TimeConfig + /** 预定范围设置 */ + reserve_scope_config?: ReserveScopeConfig +} + +export interface PatchVcReserveConfigQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcReserveConfigFormQuery { + /** 1代表层级，2代表会议室 */ + scope_type: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchVcReserveConfigFormRequest { + /** 1代表层级，2代表会议室 */ + scope_type: number + /** 预定表单设置 */ + reserve_form_config: ReserveFormConfig +} + +export interface PatchVcReserveConfigFormQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcReserveConfigAdminQuery { + /** 会议室或层级 */ + scope_type: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchVcReserveConfigAdminRequest { + /** 1代表层级，2代表会议室 */ + scope_type: number + /** 预定管理员或部门 */ + reserve_admin_config: ReserveAdminConfig +} + +export interface PatchVcReserveConfigAdminQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcReserveConfigDisableInformQuery { + /** 1表示层级，2表示会议室 */ + scope_type: number + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface PatchVcReserveConfigDisableInformRequest { + /** 1表示会议室层级，2表示会议室 */ + scope_type: number + /** 禁用通知配置 */ + disable_inform: DisableInformConfig +} + +export interface PatchVcReserveConfigDisableInformQuery { + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcMeetingListQuery { + /** 查询开始时间（unix时间，单位sec） */ + start_time: string + /** 查询结束时间（unix时间，单位sec） */ + end_time: string + /** 会议状态 */ + meeting_status?: 1 | 2 | 3 + /** 按9位会议号筛选（最多一个筛选条件） */ + meeting_no?: string + /** 按参会Lark用户筛选（最多一个筛选条件） */ + user_id?: string + /** 按参会Rooms筛选（最多一个筛选条件） */ + room_id?: string + /** 按会议类型筛选（最多一个筛选条件） */ + meeting_type?: 1 | 2 | 3 + /** 分页尺寸大小 */ + page_size?: number + /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcParticipantListQuery { + /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */ + meeting_start_time: string + /** 会议结束时间（unix时间，单位sec；对于进行中会议则传0） */ + meeting_end_time: string + /** 会议状态（不传默认为已结束会议） */ + meeting_status?: 1 | 2 | 3 + /** 9位会议号 */ + meeting_no: string + /** 按参会Lark用户筛选（最多一个筛选条件） */ + user_id?: string + /** 按参会Rooms筛选（最多一个筛选条件） */ + room_id?: string + /** 分页尺寸大小 */ + page_size?: number + /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcParticipantQualityListQuery { + /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */ + meeting_start_time: string + /** 会议结束时间（unix时间，单位sec） */ + meeting_end_time: string + /** 9位会议号 */ + meeting_no: string + /** 参会人入会时间（unix时间，单位sec） */ + join_time: string + /** 参会人为Lark用户时填入 */ + user_id?: string + /** 参会人为Rooms时填入 */ + room_id?: string + /** 分页尺寸大小 */ + page_size?: number + /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ + page_token?: string + /** 此次调用中使用的用户ID的类型 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface GetVcResourceReservationListQuery { + /** 层级id */ + room_level_id: string + /** 是否展示会议主题 */ + need_topic?: boolean + /** 查询开始时间（unix时间，单位sec） */ + start_time: string + /** 查询结束时间（unix时间，单位sec） */ + end_time: string + /** 待筛选的会议室id列表 */ + room_ids: string[] + /** 若为true表示导出room_ids范围外的会议室，默认为false */ + is_exclude?: boolean + /** 分页尺寸大小 */ + page_size?: number + /** 分页标记,第一次请求不填,表示从头开始遍历.下次遍历可采用该 page_token获取查询结果 */ + page_token?: string +} + +export interface ListVcAlertQuery { + /** 开始时间（unix时间，单位sec） */ + start_time: string + /** 结束时间（unix时间，单位sec） */ + end_time: string + /** 查询对象类型 */ + query_type?: 1 | 2 | 3 + /** 查询对象ID */ + query_value?: string + /** 请求期望返回的告警记录数量，不足则返回全部，该值默认为 100，最大为 1000 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface SetCheckboardAccessCodeVcRoomConfigRequest { + /** 设置节点范围 */ + scope: 1 | 2 | 3 | 4 | 5 | 6 + /** 国家/地区ID scope为2，3时需要此参数 */ + country_id?: string + /** 城市ID scope为3时需要此参数 */ + district_id?: string + /** 建筑ID scope为4，5时需要此参数 */ + building_id?: string + /** 楼层 scope为5时需要此参数 */ + floor_name?: string + /** 会议室ID scope为6时需要此参数 */ + room_id?: string + /** 有效天数 */ + valid_day: 1 | 7 | 30 +} + +export interface SetRoomAccessCodeVcRoomConfigRequest { + /** 设置节点范围 */ + scope: 1 | 2 | 3 | 4 | 5 | 6 + /** 国家/地区ID scope为2，3时需要此参数 */ + country_id?: string + /** 城市ID scope为3时需要此参数 */ + district_id?: string + /** 建筑ID scope为4，5时需要此参数 */ + building_id?: string + /** 楼层 scope为5时需要此参数 */ + floor_name?: string + /** 会议室ID scope为6时需要此参数 */ + room_id?: string + /** 有效天数 */ + valid_day: 1 | 7 | 30 +} + +export interface QueryVcRoomConfigQuery { + /** 查询节点范围 */ + scope: 1 | 2 | 3 | 4 | 5 | 6 + /** 国家/地区ID scope为2，3时需要此参数 */ + country_id?: string + /** 城市ID scope为3时需要此参数 */ + district_id?: string + /** 建筑ID scope为4，5时需要此参数 */ + building_id?: string + /** 楼层 scope为5时需要此参数 */ + floor_name?: string + /** 会议室ID scope为6时需要此参数 */ + room_id?: string + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + user_id_type?: 'user_id' | 'union_id' | 'open_id' +} + +export interface SetVcRoomConfigRequest { + /** 设置节点范围 */ + scope: 1 | 2 | 3 | 4 | 5 | 6 + /** 国家/地区ID scope为2，3时需要此参数 */ + country_id?: string + /** 城市ID scope为3时需要此参数 */ + district_id?: string + /** 建筑ID scope为4，5时需要此参数 */ + building_id?: string + /** 楼层 scope为5时需要此参数 */ + floor_name?: string + /** 会议室ID scope为6时需要此参数 */ + room_id?: string + /** 会议室设置 */ + room_config: RoomConfig +} + +export interface SetVcRoomConfigQuery { + /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */ + 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 ListByNoVcMeetingResponse { + /** 是否还有数据 */ + has_more?: boolean + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 会议简要信息列表 */ + meeting_briefs?: 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 ListVcRoomLevelResponse { + /** 层级列表 */ + items?: RoomLevel[] + page_token?: string + has_more?: boolean +} + +export interface SearchVcRoomLevelResponse { + /** 层级id列表 */ + level_ids?: string[] +} + +export interface CreateVcRoomResponse { + room?: Room +} + +export interface GetVcRoomResponse { + room?: Room +} + +export interface MgetVcRoomResponse { + /** 会议室列表 */ + items?: Room[] +} + +export interface ListVcRoomResponse { + /** 会议室列表 */ + rooms?: Room[] + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + +export interface SearchVcRoomResponse { + /** 会议室列表 */ + rooms?: Room[] + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + +export interface GetVcScopeConfigResponse { + /** 当前节点的配置，根据层级顺序从底向上进行合并计算后的结果；如果当前节点某个值已配置，则取该节点的值，否则会从该节点的父层级节点获取，如果父节点依然未配置，则继续向上递归获取；若所有节点均未配置，则该值返回为空 */ + current_config?: ScopeConfig + /** 所有节点的原始配置，按照层级顺序从底向上返回；如果某节点某个值未配置，则该值返回为空 */ + 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 GetVcMeetingListResponse { + /** 会议列表 */ + meeting_list?: MeetingInfo[] + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + +export interface GetVcParticipantListResponse { + /** 参会人列表 */ + participants?: Participant[] + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + +export interface GetVcParticipantQualityListResponse { + /** 参会人参会质量列表 */ + participant_quality_list?: ParticipantQuality[] + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + +export interface GetVcResourceReservationListResponse { + /** 会议室预定列表 */ + room_reservation_list?: RoomMeetingReservation[] + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + +export interface ListVcAlertResponse { + /** 是否还有数据 */ + has_more?: boolean + /** 下一页分页的token，下次请求时传入 */ + page_token?: string + /** 告警记录 */ + items?: Alert[] +} + +export interface SetCheckboardAccessCodeVcRoomConfigResponse { + /** 部署访问码 */ + access_code?: string +} + +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({ + '/open-apis/vc/v1/reserves/apply': { + POST: 'applyVcReserve', + }, + '/open-apis/vc/v1/reserves/{reserve_id}': { + DELETE: 'deleteVcReserve', + PUT: 'updateVcReserve', + GET: 'getVcReserve', + }, + '/open-apis/vc/v1/reserves/{reserve_id}/get_active_meeting': { + GET: 'getActiveMeetingVcReserve', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/invite': { + PATCH: 'inviteVcMeeting', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/kickout': { + POST: 'kickoutVcMeeting', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/set_host': { + PATCH: 'setHostVcMeeting', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/end': { + PATCH: 'endVcMeeting', + }, + '/open-apis/vc/v1/meetings/{meeting_id}': { + GET: 'getVcMeeting', + }, + '/open-apis/vc/v1/meetings/list_by_no': { + GET: 'listByNoVcMeeting', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/recording/start': { + PATCH: 'startVcMeetingRecording', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/recording/stop': { + PATCH: 'stopVcMeetingRecording', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/recording': { + GET: 'getVcMeetingRecording', + }, + '/open-apis/vc/v1/meetings/{meeting_id}/recording/set_permission': { + PATCH: 'setPermissionVcMeetingRecording', + }, + '/open-apis/vc/v1/reports/get_daily': { + GET: 'getDailyVcReport', + }, + '/open-apis/vc/v1/reports/get_top_user': { + GET: 'getTopUserVcReport', + }, + '/open-apis/vc/v1/exports/meeting_list': { + POST: 'meetingListVcExport', + }, + '/open-apis/vc/v1/exports/participant_list': { + POST: 'participantListVcExport', + }, + '/open-apis/vc/v1/exports/participant_quality_list': { + POST: 'participantQualityListVcExport', + }, + '/open-apis/vc/v1/exports/resource_reservation_list': { + POST: 'resourceReservationListVcExport', + }, + '/open-apis/vc/v1/exports/{task_id}': { + GET: 'getVcExport', + }, + '/open-apis/vc/v1/exports/download': { + GET: { name: 'downloadVcExport', type: 'binary' }, + }, + '/open-apis/vc/v1/room_levels': { + POST: 'createVcRoomLevel', + GET: 'listVcRoomLevel', + }, + '/open-apis/vc/v1/room_levels/del': { + POST: 'delVcRoomLevel', + }, + '/open-apis/vc/v1/room_levels/{room_level_id}': { + PATCH: 'patchVcRoomLevel', + GET: 'getVcRoomLevel', + }, + '/open-apis/vc/v1/room_levels/mget': { + POST: 'mgetVcRoomLevel', + }, + '/open-apis/vc/v1/room_levels/search': { + GET: 'searchVcRoomLevel', + }, + '/open-apis/vc/v1/rooms': { + POST: 'createVcRoom', + GET: 'listVcRoom', + }, + '/open-apis/vc/v1/rooms/{room_id}': { + DELETE: 'deleteVcRoom', + PATCH: 'patchVcRoom', + GET: 'getVcRoom', + }, + '/open-apis/vc/v1/rooms/mget': { + POST: 'mgetVcRoom', + }, + '/open-apis/vc/v1/rooms/search': { + POST: 'searchVcRoom', + }, + '/open-apis/vc/v1/scope_config': { + GET: 'getVcScopeConfig', + POST: 'createVcScopeConfig', + }, + '/open-apis/vc/v1/reserve_configs/reserve_scope': { + GET: 'reserveScopeVcReserveConfig', + }, + '/open-apis/vc/v1/reserve_configs/{reserve_config_id}': { + PATCH: 'patchVcReserveConfig', + }, + '/open-apis/vc/v1/reserve_configs/{reserve_config_id}/form': { + GET: 'getVcReserveConfigForm', + PATCH: 'patchVcReserveConfigForm', + }, + '/open-apis/vc/v1/reserve_configs/{reserve_config_id}/admin': { + GET: 'getVcReserveConfigAdmin', + PATCH: 'patchVcReserveConfigAdmin', + }, + '/open-apis/vc/v1/reserve_configs/{reserve_config_id}/disable_inform': { + GET: 'getVcReserveConfigDisableInform', + PATCH: 'patchVcReserveConfigDisableInform', + }, + '/open-apis/vc/v1/meeting_list': { + GET: 'getVcMeetingList', + }, + '/open-apis/vc/v1/participant_list': { + GET: 'getVcParticipantList', + }, + '/open-apis/vc/v1/participant_quality_list': { + GET: 'getVcParticipantQualityList', + }, + '/open-apis/vc/v1/resource_reservation_list': { + GET: 'getVcResourceReservationList', + }, + '/open-apis/vc/v1/alerts': { + GET: 'listVcAlert', + }, + '/open-apis/vc/v1/room_configs/set_checkboard_access_code': { + POST: 'setCheckboardAccessCodeVcRoomConfig', + }, + '/open-apis/vc/v1/room_configs/set_room_access_code': { + POST: 'setRoomAccessCodeVcRoomConfig', + }, + '/open-apis/vc/v1/room_configs/query': { + GET: 'queryVcRoomConfig', + }, + '/open-apis/vc/v1/room_configs/set': { + POST: 'setVcRoomConfig', + }, +}) diff --git a/adapters/lark/src/types/verification.ts b/adapters/lark/src/types/verification.ts new file mode 100644 index 00000000..3ae4e36d --- /dev/null +++ b/adapters/lark/src/types/verification.ts @@ -0,0 +1,23 @@ +import { Internal } from '../internal' +import { Verification } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取认证信息 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/verification-v1/verification/get + */ + getVerification(): Promise + } +} + +export interface GetVerificationResponse { + /** 认证信息 */ + verification?: Verification +} + +Internal.define({ + '/open-apis/verification/v1/verification': { + GET: 'getVerification', + }, +}) diff --git a/adapters/lark/src/types/wiki.ts b/adapters/lark/src/types/wiki.ts new file mode 100644 index 00000000..cdba7a5b --- /dev/null +++ b/adapters/lark/src/types/wiki.ts @@ -0,0 +1,371 @@ +import { Internal } from '../internal' +import { Member, Node, Setting, Space, TaskResult } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取知识空间列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list + */ + listWikiSpace(query?: ListWikiSpaceQuery): Promise + /** + * 获取知识空间信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get + */ + getWikiSpace(space_id: string, query?: GetWikiSpaceQuery): Promise + /** + * 创建知识空间 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/create + */ + createWikiSpace(body: CreateWikiSpaceRequest): Promise + /** + * 获取知识空间成员列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list + */ + listWikiSpaceMember(space_id: string, query?: ListWikiSpaceMemberQuery): Promise + /** + * 添加知识空间成员 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create + */ + createWikiSpaceMember(space_id: string, body: CreateWikiSpaceMemberRequest, query?: CreateWikiSpaceMemberQuery): Promise + /** + * 删除知识空间成员 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/delete + */ + deleteWikiSpaceMember(space_id: string, member_id: string, body: DeleteWikiSpaceMemberRequest): Promise + /** + * 更新知识空间设置 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-setting/update + */ + updateWikiSpaceSetting(space_id: string, body: UpdateWikiSpaceSettingRequest): Promise + /** + * 创建知识空间节点 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/create + */ + createWikiSpaceNode(space_id: string, body: CreateWikiSpaceNodeRequest): Promise + /** + * 获取知识空间节点信息 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node + */ + getNodeWikiSpace(query?: GetNodeWikiSpaceQuery): Promise + /** + * 获取知识空间子节点列表 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list + */ + listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery): Promise + /** + * 移动知识空间节点 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move + */ + moveWikiSpaceNode(space_id: string, node_token: string, body: MoveWikiSpaceNodeRequest): Promise + /** + * 更新知识空间节点标题 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/update_title + */ + updateTitleWikiSpaceNode(space_id: string, node_token: string, body: UpdateTitleWikiSpaceNodeRequest): Promise + /** + * 创建知识空间节点副本 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/copy + */ + copyWikiSpaceNode(space_id: string, node_token: string, body: CopyWikiSpaceNodeRequest): Promise + /** + * 移动云空间文档至知识空间 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move_docs_to_wiki + */ + moveDocsToWikiWikiSpaceNode(space_id: string, body: MoveDocsToWikiWikiSpaceNodeRequest): Promise + /** + * 获取任务结果 + * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/task/get + */ + getWikiTask(task_id: string, query?: GetWikiTaskQuery): Promise + /** + * 搜索 Wiki + * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki + */ + searchWikiNode(body: SearchWikiNodeRequest, query?: SearchWikiNodeQuery): Promise + } +} + +export interface ListWikiSpaceQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 当查询个人文档库时，指定返回的文档库名称展示语言。可选值有：zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */ + lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW' +} + +export interface GetWikiSpaceQuery { + /** 当查询个人文档库时，指定返回的文档库名称展示语言。可选值有：zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */ + lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW' +} + +export interface CreateWikiSpaceRequest { + /** 知识空间名称 */ + name?: string + /** 知识空间描述 */ + description?: string + /** 表示知识空间的分享状态 */ + open_sharing?: 'open' | 'closed' +} + +export interface ListWikiSpaceMemberQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string +} + +export interface CreateWikiSpaceMemberRequest { + /** 知识库协作者 ID 类型 */ + member_type: string + /** 知识库协作者 ID */ + member_id: string + /** 知识库协作者角色 */ + member_role: string +} + +export interface CreateWikiSpaceMemberQuery { + /** 添加权限后是否通知对方 */ + need_notification?: boolean +} + +export interface DeleteWikiSpaceMemberRequest { + /** 知识库协作者 ID 类型 */ + member_type: string + /** 知识库协作者角色 */ + member_role: string + /** 知识库协作者类型 */ + type?: 'user' | 'chat' | 'department' +} + +export interface UpdateWikiSpaceSettingRequest { + /** 谁可以创建空间的一级页面： "admin_and_member" = 管理员和成员 "admin" - 仅管理员 */ + create_setting?: string + /** 可阅读用户可否创建副本/打印/导出/复制： "allow" - 允许 "not_allow" - 不允许 */ + security_setting?: string + /** 可阅读用户可否评论： "allow" - 允许 "not_allow" - 不允许 */ + comment_setting?: string +} + +export interface CreateWikiSpaceNodeRequest { + /** 文档类型，对于快捷方式，该字段是对应的实体的obj_type。 */ + obj_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'docx' | 'slides' + /** 父节点 token。若当前节点为一级节点，父节点 token 为空。 */ + parent_node_token?: string + /** 节点类型 */ + node_type: 'origin' | 'shortcut' + /** 快捷方式对应的实体node_token，当节点为快捷方式时，该值不为空。 */ + origin_node_token?: string + /** 文档标题 */ + title?: string +} + +export interface GetNodeWikiSpaceQuery { + /** 文档的wiki token */ + token: string + /** 文档类型 */ + obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki' +} + +export interface ListWikiSpaceNodeQuery { + /** 分页大小 */ + page_size?: number + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */ + page_token?: string + /** 父节点token */ + parent_node_token?: string +} + +export interface MoveWikiSpaceNodeRequest { + /** 移动到的父节点token */ + target_parent_token?: string + /** 移动到的知识空间ID */ + target_space_id?: string +} + +export interface UpdateTitleWikiSpaceNodeRequest { + /** 节点新标题 */ + title: string +} + +export interface CopyWikiSpaceNodeRequest { + /** 目标父节点token */ + target_parent_token?: string + /** 目标知识空间id */ + target_space_id?: string + /** 复制后的新标题。如果填空，则新标题为空。如果不填，则使用原节点标题。 */ + title?: string +} + +export interface MoveDocsToWikiWikiSpaceNodeRequest { + /** 节点的父亲token */ + parent_wiki_token?: string + /** 文档类型 */ + obj_type: 'doc' | 'sheet' | 'bitable' | 'mindnote' | 'docx' | 'file' | 'slides' + /** 文档token */ + obj_token: string + /** 没有权限时，是否申请迁入文档 */ + 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 SearchWikiNodeQuery { + /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该page_token 获取查询结果 */ + page_token?: string + /** 分页大小 */ + page_size?: number +} + +export interface ListWikiSpaceResponse { + /** 知识空间列表 */ + items?: Space[] + /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */ + page_token?: string + /** 是否还有更多项 */ + has_more?: boolean +} + +export interface GetWikiSpaceResponse { + /** 知识空间 */ + space?: Space +} + +export interface CreateWikiSpaceResponse { + /** 知识空间信息 */ + space?: Space +} + +export interface ListWikiSpaceMemberResponse { + /** 空间成员列表 */ + members?: Member[] + /** 分页标记 */ + page_token?: string + /** 是否有下一页 */ + has_more?: boolean +} + +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 ListWikiSpaceNodeResponse { + /** 知识空间节点信息 */ + items?: Node[] + /** 分页Token */ + page_token?: string + /** 是否还有数据 */ + has_more?: boolean +} + +export interface MoveWikiSpaceNodeResponse { + /** 移动后的节点信息 */ + node?: Node +} + +export interface CopyWikiSpaceNodeResponse { + /** copy后的节点 */ + node: Node +} + +export interface MoveDocsToWikiWikiSpaceNodeResponse { + /** 移动后的知识库token */ + wiki_token?: string + /** 任务id */ + task_id?: string + /** 是否提交了文档迁入申请 */ + applied?: boolean +} + +export interface GetWikiTaskResponse { + /** 任务结果 */ + task: TaskResult +} + +export interface SearchWikiNodeResponse { + /** 搜索到 wiki */ + items: Node[] + /** 翻页 token，传入返回下一页，首页不需要传入 */ + page_token?: string + /** 是否还有下一页 */ + has_more: boolean +} + +Internal.define({ + '/open-apis/wiki/v2/spaces': { + GET: 'listWikiSpace', + POST: 'createWikiSpace', + }, + '/open-apis/wiki/v2/spaces/{space_id}': { + GET: 'getWikiSpace', + }, + '/open-apis/wiki/v2/spaces/{space_id}/members': { + GET: 'listWikiSpaceMember', + POST: 'createWikiSpaceMember', + }, + '/open-apis/wiki/v2/spaces/{space_id}/members/{member_id}': { + DELETE: 'deleteWikiSpaceMember', + }, + '/open-apis/wiki/v2/spaces/{space_id}/setting': { + PUT: 'updateWikiSpaceSetting', + }, + '/open-apis/wiki/v2/spaces/{space_id}/nodes': { + POST: 'createWikiSpaceNode', + GET: 'listWikiSpaceNode', + }, + '/open-apis/wiki/v2/spaces/get_node': { + GET: 'getNodeWikiSpace', + }, + '/open-apis/wiki/v2/spaces/{space_id}/nodes/{node_token}/move': { + POST: 'moveWikiSpaceNode', + }, + '/open-apis/wiki/v2/spaces/{space_id}/nodes/{node_token}/update_title': { + POST: 'updateTitleWikiSpaceNode', + }, + '/open-apis/wiki/v2/spaces/{space_id}/nodes/{node_token}/copy': { + POST: 'copyWikiSpaceNode', + }, + '/open-apis/wiki/v2/spaces/{space_id}/nodes/move_docs_to_wiki': { + POST: 'moveDocsToWikiWikiSpaceNode', + }, + '/open-apis/wiki/v2/tasks/{task_id}': { + GET: 'getWikiTask', + }, + '/open-apis/wiki/v1/nodes/search': { + POST: 'searchWikiNode', + }, +}) diff --git a/adapters/lark/src/types/workplace.ts b/adapters/lark/src/types/workplace.ts new file mode 100644 index 00000000..73a1aacb --- /dev/null +++ b/adapters/lark/src/types/workplace.ts @@ -0,0 +1,98 @@ +import { Internal } from '../internal' +import { BlockAccessData, CustomWorkplaceAccessData, WorkplaceAccessData } from '.' + +declare module '../internal' { + interface Internal { + /** + * 获取工作台访问数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search + */ + searchWorkplaceWorkplaceAccessData(query?: SearchWorkplaceWorkplaceAccessDataQuery): Promise + /** + * 获取定制工作台访问数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search + */ + searchWorkplaceCustomWorkplaceAccessData(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery): Promise + /** + * 获取定制工作台小组件访问数据 + * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search + */ + searchWorkplaceWorkplaceBlockAccessData(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery): Promise + } +} + +export interface SearchWorkplaceWorkplaceAccessDataQuery { + /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ + from_date: string + /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ + to_date: string + /** 分页大小，最小为 1，最大为 200，默认为 20。 */ + page_size: number + /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ + page_token?: string +} + +export interface SearchWorkplaceCustomWorkplaceAccessDataQuery { + /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */ + from_date: string + /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ + to_date: string + /** 分页大小，最小为 1，最大为 200，默认为 20。 */ + page_size: number + /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ + page_token?: string + /** 定制化工作台id.非必填,不填的时候,返回所有定制化工作台数据。 */ + custom_workplace_id?: string +} + +export interface SearchWorkplaceWorkplaceBlockAccessDataQuery { + /** 数据检索开始时间，精确到日。格式yyyy-MM-dd。 */ + from_date: string + /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */ + to_date: string + /** 分页大小，最小为 1，最大为 200，默认为 20。 */ + page_size: number + /** 用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。 */ + page_token?: string + /** 小组件id */ + block_id?: string +} + +export interface SearchWorkplaceWorkplaceAccessDataResponse { + /** 工作台访问数据 */ + items?: WorkplaceAccessData[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 分页标记，存在下一页时返回。 */ + page_token?: string +} + +export interface SearchWorkplaceCustomWorkplaceAccessDataResponse { + /** 定制工作台访问数据 */ + items?: CustomWorkplaceAccessData[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 分页标记，存在下一页时返回 */ + page_token?: string +} + +export interface SearchWorkplaceWorkplaceBlockAccessDataResponse { + /** 工作台中block的访问数据 */ + items?: BlockAccessData[] + /** 是否还有下一页数据 */ + has_more?: boolean + /** 分页标记，存在下一页时返回 */ + page_token?: string +} + +Internal.define({ + '/open-apis/workplace/v1/workplace_access_data/search': { + POST: 'searchWorkplaceWorkplaceAccessData', + }, + '/open-apis/workplace/v1/custom_workplace_access_data/search': { + POST: 'searchWorkplaceCustomWorkplaceAccessData', + }, + '/open-apis/workplace/v1/workplace_block_access_data/search': { + POST: 'searchWorkplaceWorkplaceBlockAccessData', + }, +}) diff --git a/adapters/lark/src/utils.ts b/adapters/lark/src/utils.ts index 55d07e4a..998fe1c6 100644 --- a/adapters/lark/src/utils.ts +++ b/adapters/lark/src/utils.ts @@ -1,15 +1,161 @@ import crypto from 'crypto' import { Context, h, pick, Session, Universal } from '@satorijs/core' import { LarkBot } from './bot' -import { EventPayload, Events, GetImChatResponse, Lark } from './types' +import { GetImChatResponse, ListChat, Message, User } from './types' +import { MessageContent } from './content' + +export interface EventHeader { + event_id: string + event_type: K + create_time: string + token: string + app_id: string + tenant_key: string +} + +export interface Events { + /** + * Receive message event. + * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/receive + */ + 'im.message.receive_v1': { + sender: { + sender_id: UserIds + sender_type?: string + tenant_key: string + } + message: { + message_id: string + root_id: string + parent_id: string + thread_id: string + create_time: string + chat_id: string + chat_type: string + message_type: keyof MessageContent + content: string + mentions: { + key: string + id: UserIds + name: string + tenant_key: string + }[] + } + } + /** + * Message read event. + * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/message_read + */ + 'im.message.message_read_v1': { + reader: { + reader_id: UserIds + read_time: string + tenant_key: string + } + message_id_list: string[] + } + /** + * Message card callback event. + * @see https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-callback-communication + */ + 'card.action.trigger': { + operator: { + tenant_key: string + user_id: string + union_id: string + open_id: string + } + token: string + action: { + value: any + tag: string + timezone?: string + name?: string + form_value?: any + input_value?: string + option?: string + options?: string[] + checked?: boolean + } + host: string + /** 卡片分发类型，固定取值为 url_preview，表示链接预览卡片。仅链接预览卡片有此字段。 */ + delivery_type?: 'url_preview' + context: { + url?: string + preview_token?: string + open_message_id: string + open_chat_id: string + } + } + /** + * 机器人自定义菜单事件 + * @see https://open.feishu.cn/document/client-docs/bot-v3/events/menu + */ + 'application.bot.menu_v6': { + operator: { + operator_name: string + operator_id: { + union_id: string + user_id: string + open_id: string + } + } + event_key: string + timestamp: number + } +} + +// In fact, this is the 2.0 version of the event sent by Lark. +// And only the 2.0 version has the `schema` field. +export type EventPayload = { + [K in keyof Events]: { + schema: '2.0' + // special added field for TypeScript + type: K + header: EventHeader + event: Events[K] + } +}[keyof Events] + +/** + * A user in Lark has several different IDs. + * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction + */ +export interface UserIds { + union_id: string + /** *user_id* only available when the app has permissions granted by the administrator */ + user_id?: string + open_id: string +} + +/** + * Identify a user in Lark. + * This behaves like {@link UserIds}, but it only contains *open_id*. + * (i.e. the id_type is always `open_id`) + */ +export interface UserIdentifiers { + id: string + id_type: string +} + +export type UserIdType = 'union_id' | 'user_id' | 'open_id' +/** + * The id type when specify a receiver, would be used in the request query. + * + * NOTE: we always use **open_id** to identify a user, use **chat_id** to identify a channel. + * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create + */ +export type ReceiveIdType = UserIdType | 'email' | 'chat_id' + +export type DepartmentIdType = 'department_id' | 'open_department_id' export type Sender = | { - sender_id: Lark.UserIds + sender_id: UserIds sender_type?: string tenant_key: string } - | (Lark.UserIdentifiers & { sender_type?: string; tenant_key: string }) + | (UserIdentifiers & { sender_type?: string; tenant_key: string }) export function adaptSender(sender: Sender, session: Session): Session { let userId: string | undefined @@ -140,7 +286,7 @@ export async function adaptSession(bot: LarkBot, body: Eve } // TODO: This function has many duplicated code with `adaptMessage`, should refactor them -export async function decodeMessage(bot: LarkBot, body: Lark.Message, details = true): Promise { +export async function decodeMessage(bot: LarkBot, body: Message, details = true): Promise { const json = JSON.parse(body.body.content) const content: h[] = [] switch (body.msg_type) { @@ -201,7 +347,7 @@ export async function decodeMessage(bot: LarkBot, body: Lark.Message, details = * Get ID type from id string * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction */ -export function extractIdType(id: string): Lark.ReceiveIdType { +export function extractIdType(id: string): ReceiveIdType { if (id.startsWith('ou')) return 'open_id' if (id.startsWith('on')) return 'union_id' if (id.startsWith('oc')) return 'chat_id' @@ -218,7 +364,7 @@ export function decodeChannel(channelId: string, guild: GetImChatResponse): Univ } } -export function decodeGuild(guild: Lark.ListChat): Universal.Guild { +export function decodeGuild(guild: ListChat): Universal.Guild { return { id: guild.chat_id, name: guild.name, @@ -226,7 +372,7 @@ export function decodeGuild(guild: Lark.ListChat): Universal.Guild { } } -export function decodeUser(user: Lark.User): Universal.User { +export function decodeUser(user: User): Universal.User { return { id: user.open_id, avatar: user.avatar?.avatar_origin,