@larksuiteoapi/lark-mcp
Version:
Feishu/Lark OpenAPI MCP
933 lines • 377 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.hireV1ExternalApplicationDelete = exports.hireV1ExternalApplicationCreate = exports.hireV1ExamCreate = exports.hireV1ExamMarkingTaskList = exports.hireV1EvaluationList = exports.hireV1EvaluationTaskList = exports.hireV1EmployeePatch = exports.hireV1EmployeeGetByApplication = exports.hireV1EmployeeGet = exports.hireV1EhrImportTaskPatch = exports.hireV1EcoExamUpdateResult = exports.hireV1EcoExamLoginInfo = exports.hireV1EcoExamPaperCreate = exports.hireV1EcoExamPaperBatchUpdate = exports.hireV1EcoExamPaperBatchDelete = exports.hireV1EcoBackgroundCheckUpdateResult = exports.hireV1EcoBackgroundCheckUpdateProgress = exports.hireV1EcoBackgroundCheckCancel = exports.hireV1EcoBackgroundCheckPackageCreate = exports.hireV1EcoBackgroundCheckPackageBatchUpdate = exports.hireV1EcoBackgroundCheckPackageBatchDelete = exports.hireV1EcoBackgroundCheckCustomFieldCreate = exports.hireV1EcoBackgroundCheckCustomFieldBatchUpdate = exports.hireV1EcoBackgroundCheckCustomFieldBatchDelete = exports.hireV1EcoAccountCustomFieldCreate = exports.hireV1EcoAccountCustomFieldBatchUpdate = exports.hireV1EcoAccountCustomFieldBatchDelete = exports.hireV1DiversityInclusionSearch = exports.hireV1BackgroundCheckOrderList = exports.hireV1AttachmentPreview = exports.hireV1AttachmentGet = exports.hireV1ApplicationTransferStage = exports.hireV1ApplicationTransferOnboard = exports.hireV1ApplicationTerminate = exports.hireV1ApplicationRecover = exports.hireV1ApplicationOffer = exports.hireV1ApplicationList = exports.hireV1ApplicationInterviewList = exports.hireV1ApplicationGetDetail = exports.hireV1ApplicationGet = exports.hireV1ApplicationCreate = exports.hireV1ApplicationCancelOnboard = exports.hireV1AgencyQuery = exports.hireV1AgencyProtectSearch = exports.hireV1AgencyProtect = exports.hireV1AgencyOperateAgencyAccount = exports.hireV1AgencyGetAgencyAccount = exports.hireV1AgencyGet = exports.hireV1AgencyBatchQuery = exports.hireV1AdvertisementPublish = void 0;
exports.hireV1JobOpen = exports.hireV1JobManagerGet = exports.hireV1JobManagerBatchUpdate = exports.hireV1JobList = exports.hireV1JobGetDetail = exports.hireV1JobGet = exports.hireV1JobConfig = exports.hireV1JobCombinedUpdate = exports.hireV1JobCombinedCreate = exports.hireV1JobClose = exports.hireV1JobTypeList = exports.hireV1JobSchemaList = exports.hireV1JobRequirementUpdate = exports.hireV1JobRequirementListById = exports.hireV1JobRequirementList = exports.hireV1JobRequirementDelete = exports.hireV1JobRequirementCreate = exports.hireV1JobRequirementSchemaList = exports.hireV1JobPublishRecordSearch = exports.hireV1JobProcessList = exports.hireV1JobFunctionList = exports.hireV1InterviewerPatch = exports.hireV1InterviewerList = exports.hireV1InterviewList = exports.hireV1InterviewGetByTalent = exports.hireV1InterviewTaskList = exports.hireV1InterviewRoundTypeList = exports.hireV1InterviewRegistrationSchemaList = exports.hireV1InterviewRecordList = exports.hireV1InterviewRecordGet = exports.hireV1InterviewRecordAttachmentGet = exports.hireV1InterviewFeedbackFormList = exports.hireV1ExternalReferralRewardDelete = exports.hireV1ExternalReferralRewardCreate = exports.hireV1ExternalOfferUpdate = exports.hireV1ExternalOfferDelete = exports.hireV1ExternalOfferCreate = exports.hireV1ExternalOfferBatchQuery = exports.hireV1ExternalInterviewUpdate = exports.hireV1ExternalInterviewDelete = exports.hireV1ExternalInterviewCreate = exports.hireV1ExternalInterviewBatchQuery = exports.hireV1ExternalInterviewAssessmentPatch = exports.hireV1ExternalInterviewAssessmentCreate = exports.hireV1ExternalBackgroundCheckUpdate = exports.hireV1ExternalBackgroundCheckDelete = exports.hireV1ExternalBackgroundCheckCreate = exports.hireV1ExternalBackgroundCheckBatchQuery = exports.hireV1ExternalApplicationUpdate = exports.hireV1ExternalApplicationList = void 0;
exports.hireV1TalentExternalInfoUpdate = exports.hireV1TalentExternalInfoCreate = exports.hireV1TalentCombinedUpdate = exports.hireV1TalentCombinedCreate = exports.hireV1TalentBatchGetId = exports.hireV1TalentAddToFolder = exports.hireV1TalentTagList = exports.hireV1TalentPoolSearch = exports.hireV1TalentPoolMoveTalent = exports.hireV1TalentPoolBatchChangeTalentPool = exports.hireV1TalentOperationLogSearch = exports.hireV1TalentObjectQuery = exports.hireV1TalentFolderList = exports.hireV1TalentBlocklistChangeTalentBlock = exports.hireV1SubjectList = exports.hireV1RoleList = exports.hireV1RoleGet = exports.hireV1ResumeSourceList = exports.hireV1RegistrationSchemaList = exports.hireV1ReferralSearch = exports.hireV1ReferralGetByApplication = exports.hireV1ReferralWebsiteJobPostList = exports.hireV1ReferralWebsiteJobPostGet = exports.hireV1ReferralAccountWithdraw = exports.hireV1ReferralAccountReconciliation = exports.hireV1ReferralAccountGetAccountAssets = exports.hireV1ReferralAccountEnable = exports.hireV1ReferralAccountDeactivate = exports.hireV1ReferralAccountCreate = exports.hireV1QuestionnaireList = exports.hireV1OfferUpdate = exports.hireV1OfferOfferStatus = exports.hireV1OfferList = exports.hireV1OfferInternOfferStatus = exports.hireV1OfferGet = exports.hireV1OfferCreate = exports.hireV1OfferSchemaGet = exports.hireV1OfferCustomFieldUpdate = exports.hireV1OfferApplicationFormList = exports.hireV1OfferApplicationFormGet = exports.hireV1NotePatch = exports.hireV1NoteList = exports.hireV1NoteGet = exports.hireV1NoteDelete = exports.hireV1NoteCreate = exports.hireV1MinutesGet = exports.hireV1LocationQuery = exports.hireV1LocationList = exports.hireV1JobUpdateConfig = exports.hireV1JobRecruiter = void 0;
exports.hireV1Tools = exports.hireV1WebsiteSiteUserCreate = exports.hireV1WebsiteList = exports.hireV1WebsiteJobPostSearch = exports.hireV1WebsiteJobPostList = exports.hireV1WebsiteJobPostGet = exports.hireV1WebsiteDeliveryCreateByResume = exports.hireV1WebsiteDeliveryCreateByAttachment = exports.hireV1WebsiteDeliveryTaskGet = exports.hireV1WebsiteChannelUpdate = exports.hireV1WebsiteChannelList = exports.hireV1WebsiteChannelDelete = exports.hireV1WebsiteChannelCreate = exports.hireV1UserRoleList = exports.hireV1TripartiteAgreementUpdate = exports.hireV1TripartiteAgreementList = exports.hireV1TripartiteAgreementDelete = exports.hireV1TripartiteAgreementCreate = exports.hireV1TodoList = exports.hireV1TestSearch = exports.hireV1TerminationReasonList = exports.hireV1TalentTag = exports.hireV1TalentRemoveToFolder = exports.hireV1TalentOnboardStatus = exports.hireV1TalentList = exports.hireV1TalentGet = void 0;
const zod_1 = require("zod");
exports.hireV1AdvertisementPublish = {
project: 'hire',
name: 'hire.v1.advertisement.publish',
sdkName: 'hire.v1.advertisement.publish',
path: '/open-apis/hire/v1/advertisements/:advertisement_id/publish',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-招聘相关配置-职位-发布职位广告-支持把职位广告发布上线至招聘官网、内推平台',
accessTokens: ['tenant'],
schema: {
data: zod_1.z
.object({
job_channel_id: zod_1.z
.string()
.describe('招聘渠道 ID,选择要发布的招聘官网,单次仅可发布 1 个渠道:- 当发布内推平台时,可使用 job_channel_id = 3 来发布- 官网渠道的 ID 可通过[获取招聘官网列表]」接口获取')
.optional(),
})
.optional(),
path: zod_1.z.object({ advertisement_id: zod_1.z.string().describe('职位广告 ID,可由[新建职位]接口创建职位后返回获取') }),
},
};
exports.hireV1AgencyBatchQuery = {
project: 'hire',
name: 'hire.v1.agency.batchQuery',
sdkName: 'hire.v1.agency.batchQuery',
path: '/open-apis/hire/v1/agencies/batch_query',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-获取候选人-猎头-搜索猎头供应商列表-可根据猎头供应商 ID 列表或关键字、筛选项查询供应商信息',
accessTokens: ['tenant'],
schema: {
data: zod_1.z
.object({
agency_supplier_id_list: zod_1.z
.array(zod_1.z.string())
.describe('猎头供应商 ID 列表,当传递此值,以此值为准,其余查询字段失效')
.optional(),
keyword: zod_1.z.string().describe('搜索关键字,可传入名称或邮箱').optional(),
filter_list: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('筛选项 key,使用筛选项查询时必填'),
value_type: zod_1.z
.number()
.describe('筛选项值类型,使用筛选项查询时必填 Options:1(值过滤,填充 value_list 字段),2(范围过滤,填充 range_filter 字段)'),
value_list: zod_1.z.array(zod_1.z.string()).describe('筛选项值列表,当`value_type`为`1`时必填').optional(),
range_filter: zod_1.z
.object({
from: zod_1.z.string().describe('起始值').optional(),
to: zod_1.z.string().describe('终止值').optional(),
})
.describe('范围筛选,当`value_type`为`2`时必填')
.optional(),
}))
.describe('筛选项,相同的 Key 仅可传一次,字段取值可查看本文`筛选字段说明`节')
.optional(),
})
.optional(),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.number().describe('每页获取记录数量').optional(),
})
.optional(),
},
};
exports.hireV1AgencyGet = {
project: 'hire',
name: 'hire.v1.agency.get',
sdkName: 'hire.v1.agency.get',
path: '/open-apis/hire/v1/agencies/:agency_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-获取候选人-猎头-获取猎头供应商信息-根据猎头供应商 ID 获取有合作关系的猎头供应商信息,包含猎头供应商ID、名称、联系人等',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_admin_id']).describe('用户ID类型').optional(),
})
.optional(),
path: zod_1.z.object({ agency_id: zod_1.z.string().describe('猎头供应商ID').optional() }).optional(),
},
};
exports.hireV1AgencyGetAgencyAccount = {
project: 'hire',
name: 'hire.v1.agency.getAgencyAccount',
sdkName: 'hire.v1.agency.getAgencyAccount',
path: '/open-apis/hire/v1/agencies/get_agency_account',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-获取候选人-猎头-查询猎头供应商下猎头列表-根据猎头供应商 ID 查询该猎头供应商下的猎头列表',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
supplier_id: zod_1.z.string().describe('猎头供应商 ID,可通过[搜索猎头供应商列表]接口获取'),
status: zod_1.z
.number()
.describe('猎头状态 Options:0(Normal 正常),1(Enabled 已禁用),2(DisabledBySupplier 已被猎头供应商停用)')
.optional(),
role: zod_1.z.number().describe('角色 Options:0(Manager 管理员),1(Consultant 顾问)').optional(),
}),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id']).describe('用户ID类型').optional(),
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.number().describe('每页获取记录数量').optional(),
})
.optional(),
},
};
exports.hireV1AgencyOperateAgencyAccount = {
project: 'hire',
name: 'hire.v1.agency.operateAgencyAccount',
sdkName: 'hire.v1.agency.operateAgencyAccount',
path: '/open-apis/hire/v1/agencies/operate_agency_account',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-获取候选人-猎头-禁用/取消禁用猎头-可根据猎头 ID 对猎头执行禁用/取消禁用操作。被禁用的猎头,不能推荐候选人与被分配职位',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
option: zod_1.z.number().describe('操作类型 Options:1(Add 禁用),2(Remove 取消禁用)'),
id: zod_1.z.string().describe('猎头 ID,可通过[查询猎头供应商下猎头列表]接口获取'),
reason: zod_1.z.string().describe('禁用原因,仅当`option`为`1`时,必填').optional(),
}),
},
};
exports.hireV1AgencyProtect = {
project: 'hire',
name: 'hire.v1.agency.protect',
sdkName: 'hire.v1.agency.protect',
path: '/open-apis/hire/v1/agencies/protect',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-获取候选人-猎头-设置猎头保护期-设置指定人才的猎头保护期,当「飞书招聘」内置的保护期功能不满足需求时,客户可通过此接口自定义人才的保护期',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
talent_id: zod_1.z.string().describe('人才ID,可通过[通过手机号或邮箱获取人才 ID]、[获取人才列表]接口获取'),
supplier_id: zod_1.z.string().describe('猎头供应商ID'),
consultant_id: zod_1.z.string().describe('猎头顾问ID,需与`user_id_type`类型一致'),
protect_create_time: zod_1.z.number().describe('保护期创建时间(int64类型),毫秒时间戳'),
protect_expire_time: zod_1.z.number().describe('保护期过期时间(int64类型),毫秒时间戳'),
comment: zod_1.z.string().describe('推荐语').optional(),
current_salary: zod_1.z.string().describe('当前薪资').optional(),
expected_salary: zod_1.z.string().describe('预期薪资').optional(),
}),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_admin_id']).describe('用户ID类型').optional(),
})
.optional(),
},
};
exports.hireV1AgencyProtectSearch = {
project: 'hire',
name: 'hire.v1.agency.protectSearch',
sdkName: 'hire.v1.agency.protectSearch',
path: '/open-apis/hire/v1/agencies/protection_period/search',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-获取候选人-猎头-查询猎头保护期信息-查询指定人才的猎头保护期信息列表,包含保护期起止时间、猎头供应商、猎头顾问信息等。若人才已经入职,还会返回入职时所在的保护期信息',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
talent_id: zod_1.z.string().describe('人才 ID,可通过[通过手机号或邮箱获取人才 ID]、[获取人才列表]接口获取'),
}),
},
};
exports.hireV1AgencyQuery = {
project: 'hire',
name: 'hire.v1.agency.query',
sdkName: 'hire.v1.agency.query',
path: '/open-apis/hire/v1/agencies/query',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-获取候选人-猎头-查询猎头供应商信息-根据猎头供应商名称查询有合作关系的猎头供应商信息,包含猎头供应商ID、名称、联系人等',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
name: zod_1.z.string().describe('猎头供应商名称,精准匹配查询(区分大小写)'),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
},
};
exports.hireV1ApplicationCancelOnboard = {
project: 'hire',
name: 'hire.v1.application.cancelOnboard',
sdkName: 'hire.v1.application.cancelOnboard',
path: '/open-apis/hire/v1/applications/:application_id/cancel_onboard',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-入职-取消候选人入职-取消待入职状态的候选人入职',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
termination_type: zod_1.z.number().describe('终止类型 Options:1(我们拒绝了候选人),22(候选人拒绝了我们),27(其他)'),
termination_reason_id_list: zod_1.z
.array(zod_1.z.string())
.describe('终止的具体原因的id列表,详细信息请参考[获取终止投递原因]')
.optional(),
termination_reason_notes: zod_1.z.string().describe('备注').optional(),
}),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递 ID,如何获取投递 ID 请参考[获取投递列表]') }),
},
};
exports.hireV1ApplicationCreate = {
project: 'hire',
name: 'hire.v1.application.create',
sdkName: 'hire.v1.application.create',
path: '/open-apis/hire/v1/applications',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-创建投递-为人才在特定职位上创建投递',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
talent_id: zod_1.z.string().describe('人才 ID,可通过[获取人才列表]获取'),
job_id: zod_1.z.string().describe('职位 ID,可通过[获取职位列表]获取'),
user_id: zod_1.z
.string()
.describe('人员 ID,与入参 `user_id_type` 类型一致。**注意**:若投递来源为属于「员工转岗」或「实习生转正」时必填,创建投递成功后会将该员工和对应人才进行绑定;创建其他来源投递时,不会进行人员与人才绑定')
.optional(),
resume_source_id: zod_1.z.string().describe('简历来源 ID,可通过[获取简历来源列表]获取').optional(),
application_preferred_city_code_list: zod_1.z
.array(zod_1.z.string())
.describe('意向投递城市列表,可通过[查询地点列表]获取到对应的城市编码')
.optional(),
delivery_type: zod_1.z
.number()
.describe('投递方式 Options:1(HR_visit HR 寻访),2(candidate_delivery 候选人主动投递)')
.optional(),
}),
params: zod_1.z
.object({ user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional() })
.optional(),
},
};
exports.hireV1ApplicationGet = {
project: 'hire',
name: 'hire.v1.application.get',
sdkName: 'hire.v1.application.get',
path: '/open-apis/hire/v1/applications/:application_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-获取投递信息-根据投递 ID 获取单个投递信息',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
options: zod_1.z
.array(zod_1.z
.literal('get_latest_application_on_chain')
.describe('Options:get_latest_application_on_chain(GetLatestApplicationOnChain 仅对当前投递是虚拟职位投递时生效。 - 若投递未分配,虚拟职位投递即为最新投递,返回请求中指定的虚拟职位投递的信息 - 若投递已分配,会返回分配链上最新一个实体职位投递的信息,而非请求中指定的投递。)'))
.describe('请求控制参数,用于控制接口响应逻辑。如需一次查询多个用户ID,可通过将同一参数名多次传递,并且每次传递不同的参数值。例如:https://{url}?options={option1}&options={option2}')
.optional(),
})
.optional(),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递 ID,可通过[获取投递列表]获取') }),
},
};
exports.hireV1ApplicationGetDetail = {
project: 'hire',
name: 'hire.v1.application.getDetail',
sdkName: 'hire.v1.application.getDetail',
path: '/open-apis/hire/v1/applications/:application_id/get_detail',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-获取投递详情-根据投递 ID 获取投递信息并通过参数按需获取该投递相关的实体信息,如「职位」、「人才」、「评估」、「面试」、「Offer」、「猎头」、「内推」、「官网」等实体的信息',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_admin_id']).describe('用户ID类型').optional(),
department_id_type: zod_1.z
.enum(['open_department_id', 'department_id'])
.describe('此次调用中使用的部门 ID 类型 Options:open_department_id(以 open_department_id 来标识部门,通过[批量获取部门信息]接口获取),department_id(以 department_id 来标识部门,通过[批量获取部门信息]接口获取)')
.optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('此次调用中使用的「职级 ID」的类型 Options:people_admin_job_level_id(「人力系统管理后台」适用的职级 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),job_level_id(「飞书管理后台」适用的职级 ID,通过[获取租户职级列表]接口获取)')
.optional(),
job_family_id_type: zod_1.z
.enum(['people_admin_job_category_id', 'job_family_id'])
.describe('此次调用中使用的「序列 ID」的类型 Options:people_admin_job_category_id(「人力系统管理后台」适用的序列 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),job_family_id(「飞书管理后台」适用的序列 ID,通过[获取租户序列列表]接口获取)')
.optional(),
employee_type_id_type: zod_1.z
.enum(['people_admin_employee_type_id', 'employee_type_enum_id'])
.describe('此次调用中使用的「人员类型 ID」的类型 Options:people_admin_employee_type_id(「人力系统管理后台」适用的人员类型 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),employee_type_enum_id(「飞书管理后台」适用的人员类型 ID,通过[查询人员类型]接口获取)')
.optional(),
options: zod_1.z
.array(zod_1.z
.enum([
'with_job',
'with_talent',
'with_interview',
'with_offer',
'with_evaluation',
'with_employee',
'with_agency',
'with_referral',
'with_portal',
])
.describe('Options:with_job(返回职位实体信息),with_talent(返回人才实体信息),with_interview(返回面试聚合实体信息),with_offer(返回 Offer 实体信息),with_evaluation(返回评估实体信息),with_employee(返回员工实体信息),with_agency(返回猎头实体信息),with_referral(返回内推实体信息),with_portal(返回官网实体信息)'))
.describe('关联实体信息获取参数,用于指定获取哪些关联实体信息,不传时默认只返回投递基本信息(`basic_info`)。如需一次查询多个实体信息,可通过将同一参数名多次传递,并且每次传递不同的参数值。 例如:https://{url}?options=with_job&options=with_talent')
.optional(),
})
.optional(),
path: zod_1.z
.object({ application_id: zod_1.z.string().describe('投递 ID,可通过[获取投递列表]接口获取').optional() })
.optional(),
},
};
exports.hireV1ApplicationInterviewList = {
project: 'hire',
name: 'hire.v1.applicationInterview.list',
sdkName: 'hire.v1.applicationInterview.list',
path: '/open-apis/hire/v1/applications/:application_id/interviews',
httpMethod: 'GET',
description: '[Feishu/Lark]-历史版本(不推荐)-招聘-面试-获取面试记录列表',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
page_size: zod_1.z.number().describe('分页大小,不能超过 50'),
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
user_id_type: zod_1.z.enum(['user_id', 'union_id', 'open_id', 'people_admin_id']).describe('用户ID类型').optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('此次调用中使用的「职级 ID」的类型 Options:people_admin_job_level_id(「人力系统管理后台」适用的职级 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),job_level_id(「飞书管理后台」适用的职级 ID,通过「获取租户职级列表」接口获取)')
.optional(),
}),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递ID') }),
},
};
exports.hireV1ApplicationList = {
project: 'hire',
name: 'hire.v1.application.list',
sdkName: 'hire.v1.application.list',
path: '/open-apis/hire/v1/applications',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-获取投递列表-获取投递列表信息。可根据「招聘流程 ID」、「招聘阶段 ID」、「人才 ID」、「职位 ID」、「投递活跃状态」以及「投递更新时间」进行条件筛选',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
process_id: zod_1.z.string().describe('招聘流程 ID,可通过[获取招聘流程信息]接口中的「流程 ID」获取').optional(),
stage_id: zod_1.z
.string()
.describe('招聘阶段 ID,可通过[获取招聘流程信息]接口每个流程下的「阶段列表」获取')
.optional(),
talent_id: zod_1.z.string().describe('人才 ID,可通过[获取人才列表]接口获取').optional(),
active_status: zod_1.z
.string()
.describe('投递活跃状态,不传该参数则默认为“全部”**可选值有**:- `1`:活跃投递- `2`:非活跃投递- `3`:全部')
.optional(),
job_id: zod_1.z.string().describe('职位 ID,可通过[获取职位列表]接口获取').optional(),
lock_status: zod_1.z
.array(zod_1.z.number().describe('Options:1(未锁定),2(锁定在其他职位),3(锁定在当前职位)'))
.describe('锁定状态,无默认值,不传该参数则不对锁定状态进行筛选')
.optional(),
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.number().describe('分页大小**最大值**:200').optional(),
update_start_time: zod_1.z.string().describe('最早更新时间,毫秒时间戳').optional(),
update_end_time: zod_1.z.string().describe('最晚更新时间,毫秒时间戳').optional(),
})
.optional(),
},
};
exports.hireV1ApplicationOffer = {
project: 'hire',
name: 'hire.v1.application.offer',
sdkName: 'hire.v1.application.offer',
path: '/open-apis/hire/v1/applications/:application_id/offer',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-Offer-获取 Offer 信息-根据投递 ID 获取 Offer 信息',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
department_id_type: zod_1.z
.enum(['open_department_id', 'department_id'])
.describe('此次调用中使用的部门 ID 类型。 Options:open_department_id(【飞书】用来在具体某个应用中标识一个部门,同一个department_id 在不同应用中的 open_department_id 相同),department_id(【飞书】用来标识租户内一个唯一的部门)')
.optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('此次调用中使用的「职级 ID」的类型 Options:people_admin_job_level_id(「人力系统管理后台」适用的职级 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),job_level_id(「飞书管理后台」适用的职级 ID,通过[获取租户职级列表]接口获取)')
.optional(),
job_family_id_type: zod_1.z
.enum(['people_admin_job_category_id', 'job_family_id'])
.describe('此次调用中使用的「序列 ID」的类型 Options:people_admin_job_category_id(「人力系统管理后台」适用的序列 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),job_family_id(「飞书管理后台」适用的序列 ID,通过[获取租户序列列表]接口获取)')
.optional(),
employee_type_id_type: zod_1.z
.enum(['people_admin_employee_type_id', 'employee_type_enum_id'])
.describe('此次调用中使用的「人员类型 ID」的类型 Options:people_admin_employee_type_id(「人力系统管理后台」适用的人员类型 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),employee_type_enum_id(「飞书管理后台」适用的人员类型 ID,通过[查询人员类型]接口获取)')
.optional(),
})
.optional(),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递ID,可通过[获取投递列表]获取') }),
},
};
exports.hireV1ApplicationRecover = {
project: 'hire',
name: 'hire.v1.application.recover',
sdkName: 'hire.v1.application.recover',
path: '/open-apis/hire/v1/applications/:application_id/recover',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-恢复投递-根据投递 ID 将「已终止」投递进行恢复',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递ID,详情请参考:[获取投递列表]') }),
},
};
exports.hireV1ApplicationTerminate = {
project: 'hire',
name: 'hire.v1.application.terminate',
sdkName: 'hire.v1.application.terminate',
path: '/open-apis/hire/v1/applications/:application_id/terminate',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-终止投递-根据投递 ID 修改投递状态为「已终止」',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
termination_type: zod_1.z.number().describe('终止原因的类型 Options:1(我们拒绝了候选人),22(候选人拒绝了我们),27(其他)'),
termination_reason_list: zod_1.z
.array(zod_1.z.string())
.describe('终止的具体原因的id列表,可通过[获取终止投递原因]接口获取')
.optional(),
termination_reason_note: zod_1.z.string().describe('终止备注').optional(),
}),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递ID,可通过[获取投递列表]接口获取') }),
},
};
exports.hireV1ApplicationTransferOnboard = {
project: 'hire',
name: 'hire.v1.application.transferOnboard',
sdkName: 'hire.v1.application.transferOnboard',
path: '/open-apis/hire/v1/applications/:application_id/transfer_onboard',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-入职-操作候选人入职-根据投递 ID 操作候选人入职并创建员工,后续可通过 [通过员工 ID 获取入职信息] 接口获取入职信息',
accessTokens: ['tenant'],
schema: {
data: zod_1.z
.object({
actual_onboard_time: zod_1.z
.number()
.describe('实际入职时间,毫秒时间戳(int64类型),不能晚于当前时间,不传则默认为当前时间')
.optional(),
expected_conversion_time: zod_1.z
.number()
.describe('预期转正时间,毫秒时间戳(int64类型),不传则默认为0')
.optional(),
job_requirement_id: zod_1.z
.string()
.describe('招聘需求 ID,可通过接口 [获取招聘需求列表] 获取。是否必须传入取决于管理员在系统后台「招聘需求关联设置」的配置。入职完成后招聘需求的「已入职」人数会加1')
.optional(),
operator_id: zod_1.z.string().describe('操作人ID,与入参 `user_id_type` 类型一致').optional(),
onboard_city_code: zod_1.z
.string()
.describe('候选人办公地点 ID,将用于候选人内推奖规则判断,数据源可通过接口[获取地址列表]获取')
.optional(),
department: zod_1.z
.string()
.describe('候选人入职部门 ID ,将用于候选人内推奖规则判断,可通过接口[搜索部门]获取,与入参 `department_id_type ` 类型一致')
.optional(),
leader: zod_1.z
.string()
.describe('候选人直属上级 UserID ,将用于候选人内推奖规则判断,与入参 `user_id_type` 类型一致')
.optional(),
sequence: zod_1.z
.string()
.describe('候选人序列 ID ,将用于候选人内推奖规则判断,与入参 `job_family_id_type ` 类型一致')
.optional(),
level: zod_1.z
.string()
.describe('候选人职级 ID ,将用于候选人内推奖规则判断,与入参 `job_level_id_type ` 类型一致')
.optional(),
employee_type: zod_1.z
.string()
.describe('候选人入职人员类型 ID,将用于候选人内推奖规则判断,与入参 `employee_type_id_type ` 类型一致')
.optional(),
})
.optional(),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
department_id_type: zod_1.z
.enum(['open_department_id', 'department_id', 'people_admin_department_id'])
.describe('指定查询结果中的部门 ID 类型。关于部门 ID 的详细介绍,可参见[部门资源介绍]。 Options:open_department_id(以 open_department_id 来标识部门由系统自动生成的部门 ID,ID 前缀固定为 `od-`,在租户内全局唯一。),department_id(支持用户自定义配置的部门 ID。自定义配置时可复用已删除的 department_id,因此在未删除的部门范围内 department_id 具有唯一性。),people_admin_department_id(以 people_admin_department_id 来标识部门)')
.optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('此次调用中使用的「职级 ID」的类型 Options:people_admin_job_level_id(「人力系统管理后台」适用的职级 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),job_level_id(「飞书管理后台」适用的职级 ID,通过[「获取租户职级列表」]接口获取)')
.optional(),
job_family_id_type: zod_1.z
.enum(['people_admin_job_category_id', 'job_family_id'])
.describe('此次调用中使用的「序列 ID」的类型 Options:people_admin_job_category_id(「人力系统管理后台」适用的序列 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),job_family_id(「飞书管理后台」适用的序列 ID,通过[「获取租户序列列表」]接口获取)')
.optional(),
employee_type_id_type: zod_1.z
.enum(['people_admin_employee_type_id', 'employee_type_enum_id'])
.describe('此次调用中使用的「人员类型 ID」的类型 Options:people_admin_employee_type_id(「人力系统管理后台」适用的人员类型 ID。人力系统管理后台逐步下线中,建议不继续使用此 ID。),employee_type_enum_id(「飞书管理后台」适用的人员类型 ID,通过[「查询人员类型」]接口获取)')
.optional(),
})
.optional(),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递ID,可通过接口 [获取投递列表] 获取') }),
},
};
exports.hireV1ApplicationTransferStage = {
project: 'hire',
name: 'hire.v1.application.transferStage',
sdkName: 'hire.v1.application.transferStage',
path: '/open-apis/hire/v1/applications/:application_id/transfer_stage',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-转移投递阶段-根据投递 ID 和投递阶段 ID 转移投递阶段',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({ stage_id: zod_1.z.string().describe('要转移到的阶段 ID,可通过[获取招聘流程信息]接口获取') }),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('投递 ID,可通过[获取投递列表]接口获取') }),
},
};
exports.hireV1AttachmentGet = {
project: 'hire',
name: 'hire.v1.attachment.get',
sdkName: 'hire.v1.attachment.get',
path: '/open-apis/hire/v1/attachments/:attachment_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-附件-获取附件信息-根据附件 ID 和附件类型获取招聘系统中附件的信息,比如附件名称、附件创建时间、附件下载地址等',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
type: zod_1.z
.number()
.describe('附件类型 Options:1(附件简历 简历附件,人才上的简历附件。),2(候选人作品 作品附件,人才上的作品附件。),3(自定义附件 通用附件,通过[创建附件]、[获取 Offer 详情]、[获取 Offer 信息]接口获取。)')
.optional(),
})
.optional(),
path: zod_1.z.object({
attachment_id: zod_1.z
.string()
.describe('附件 ID,获取方式如下:- 简历附件 ID/作品附件 ID:通过[获取人才信息 V1]接口获取- 通用附件 ID:通过[创建附件]、[获取 Offer 详情]、[获取 Offer 信息]接口获取'),
}),
},
};
exports.hireV1AttachmentPreview = {
project: 'hire',
name: 'hire.v1.attachment.preview',
sdkName: 'hire.v1.attachment.preview',
path: '/open-apis/hire/v1/attachments/:attachment_id/preview',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-附件-获取附件 PDF 格式下载链接-根据人才简历附件 ID 获取该简历附件对应的 PDF 文件的下载地址',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({
attachment_id: zod_1.z.string().describe('附件 ID,可通过[获取人才信息]接口返回数据中获取人才简历附件 ID'),
}),
},
};
exports.hireV1BackgroundCheckOrderList = {
project: 'hire',
name: 'hire.v1.backgroundCheckOrder.list',
sdkName: 'hire.v1.backgroundCheckOrder.list',
path: '/open-apis/hire/v1/background_check_orders',
httpMethod: 'GET',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-背调-获取背调信息列表-根据投递 ID 或背调更新时间批量获取背调订单信息',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.number().describe('分页大小').optional(),
application_id: zod_1.z.string().describe('投递 ID。可通过[获取投递列表]接口获取').optional(),
update_start_time: zod_1.z.string().describe('最早更新时间。毫秒时间戳').optional(),
update_end_time: zod_1.z.string().describe('最晚更新时间。毫秒时间戳').optional(),
})
.optional(),
},
};
exports.hireV1DiversityInclusionSearch = {
project: 'hire',
name: 'hire.v1.diversityInclusion.search',
sdkName: 'hire.v1.diversityInclusion.search',
path: '/open-apis/hire/v1/applications/diversity_inclusions/search',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-候选人管理-投递流程-投递管理-获取申请表附加信息-获取候选人的申请表附加信息。支持通过投递 ID 或者人才 ID 进行查询',
accessTokens: ['tenant'],
schema: {
data: zod_1.z
.object({
talent_ids: zod_1.z
.array(zod_1.z.string())
.describe('人才 ID 列表,如何获取人才 ID 请参考[获取人才列表]**特殊说明:**- 当通过人才 ID 列表查询时会返回对应人才最新投递的申请表附加信息。- 当人才 ID 列表或投递 ID 列表同时存在将以人才 ID 列表为准。- 当人才 ID 列表和投递 ID 列表都没有填写时则返回空数据')
.optional(),
application_ids: zod_1.z.array(zod_1.z.string()).describe('投递 ID 列表,如何获取投递 ID 请参考[获取投递列表]').optional(),
})
.optional(),
},
};
exports.hireV1EcoAccountCustomFieldBatchDelete = {
project: 'hire',
name: 'hire.v1.ecoAccountCustomField.batchDelete',
sdkName: 'hire.v1.ecoAccountCustomField.batchDelete',
path: '/open-apis/hire/v1/eco_account_custom_fields/batch_delete',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-账号-删除账号自定义字段-飞书招聘的背调或笔试服务商,可通过此接口删除账号自定义字段(如客户在服务商处的租户 ID、账号 ID等)',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
scope: zod_1.z.number().describe('适用范围 Options:1(背调),2(笔试)'),
custom_field_key_list: zod_1.z.array(zod_1.z.string()).describe('要删除的自定义字段的 key 列表').optional(),
}),
},
};
exports.hireV1EcoAccountCustomFieldBatchUpdate = {
project: 'hire',
name: 'hire.v1.ecoAccountCustomField.batchUpdate',
sdkName: 'hire.v1.ecoAccountCustomField.batchUpdate',
path: '/open-apis/hire/v1/eco_account_custom_fields/batch_update',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-招聘-生态对接-账号-更新账号自定义字段-飞书招聘的背调或笔试服务商,可通过此接口更新账号自定义字段(比如客户在服务商处的租户 ID、账号 ID等)的名称和描述',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
scope: zod_1.z.number().describe('适用范围 Options:1(背调),2(笔试)'),
custom_field_list: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('当前`scope`下已存在的自定义字段的标识'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('自定义字段中文名称').optional(),
en_us: zod_1.z.string().describe('自定义字段英文名称').optional(),
})
.describe('自定义字段的名称。用户在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」下添加账号时看到的表单控件标题'),
is_required: zod_1.z
.boolean()
.describe('是否必填。**可选值有**:* `true`:必填* `false`:非必填**注意**:该字段在当前接口暂不生效'),
description: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文名称').optional(),
en_us: zod_1.z.string().describe('英文名称').optional(),
})
.describe('自定义字段的描述。用户在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」下添加账号时看到的控件提示信息')
.optional(),
}))
.describe('自定义字段列表'),
}),
},
};
exports.hireV1EcoAccountCustomFieldCreate = {
project: 'hire',
name: 'hire.v1.ecoAccountCustomField.create',
sdkName: 'hire.v1.ecoAccountCustomField.create',
path: '/open-apis/hire/v1/eco_account_custom_fields',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-账号-创建账号自定义字段-飞书招聘的背调或笔试服务商,可通过此接口创建账号自定义字段,用来标识飞书招聘客户在服务商处的身份(比如客户在服务商处的租户 ID、账号 ID等字段)',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
scope: zod_1.z.number().describe('适用范围 Options:1(背调),2(笔试)'),
custom_field_list: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('自定义字段的标识。在同一`scope`内须唯一'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('自定义字段中文名称').optional(),
en_us: zod_1.z.string().describe('自定义字段英文名称').optional(),
})
.describe('自定义字段的名称。用户在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」下添加账号时看到的表单控件标题'),
is_required: zod_1.z.boolean().describe('是否必填。**可选值有**:* `true`:必填* `false`:非必填'),
description: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文名称').optional(),
en_us: zod_1.z.string().describe('英文名称').optional(),
})
.describe('自定义字段的描述。用户在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」下添加账号时看到的控件提示信息')
.optional(),
}))
.describe('自定义字段列表'),
}),
},
};
exports.hireV1EcoBackgroundCheckCustomFieldBatchDelete = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheckCustomField.batchDelete',
sdkName: 'hire.v1.ecoBackgroundCheckCustomField.batchDelete',
path: '/open-apis/hire/v1/eco_background_check_custom_fields/batch_delete',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-背调-删除背调自定义字段-删除用户在发起背调时展示的表单自定义字段',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({ account_id: zod_1.z.string().describe('背调账号 ID,可通过[账号绑定]事件获取') }),
},
};
exports.hireV1EcoBackgroundCheckCustomFieldBatchUpdate = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheckCustomField.batchUpdate',
sdkName: 'hire.v1.ecoBackgroundCheckCustomField.batchUpdate',
path: '/open-apis/hire/v1/eco_background_check_custom_fields/batch_update',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-招聘-生态对接-背调-更新背调自定义字段-更新用户在发起背调时展示的表单自定义字段名称和描述',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
account_id: zod_1.z.string().describe('背调账号 ID,可通过[账号绑定]事件获取'),
custom_field_list: zod_1.z
.array(zod_1.z.object({
type: zod_1.z
.enum(['text', 'textarea', 'number', 'boolean', 'select', 'multiselect', 'date', 'file', 'resume'])
.describe('自定义字段类型 Options:text(单行文本,最多100个汉字),textarea(MultiText 多行文本,最多200个汉字),number(数字),boolean(布尔),select(Choice 单选),multiselect(MultiChoice 多选),date(日期),file(Attachment 附件),resume(候选人简历)'),
key: zod_1.z.string().describe('自定义字段的标识,在同一账号内唯一'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文名称').optional(),
en_us: zod_1.z.string().describe('英文名称').optional(),
})
.describe('自定义字段的名称,用户在安排背调表单看到的控件标题'),
is_required: zod_1.z.boolean().describe('是否必填'),
description: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文描述').optional(),
en_us: zod_1.z.string().describe('英文描述').optional(),
})
.describe('自定义字段的描述,如果是输入控件,为用户在安排背调表单看到的 placeholder 或 提示文字')
.optional(),
options: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('选项的唯一标识'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文名称').optional(),
en_us: zod_1.z.string().describe('英文名称').optional(),
})
.describe('选项的名称'),
}))
.describe('type 为 select 或 multiselect 时必填,单选或多选的选项')
.optional(),
}))
.describe('自定义字段列表。**注意**:列表长度须与[创建背调自定义字段]时传入的一致'),
}),
},
};
exports.hireV1EcoBackgroundCheckCustomFieldCreate = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheckCustomField.create',
sdkName: 'hire.v1.ecoBackgroundCheckCustomField.create',
path: '/open-apis/hire/v1/eco_background_check_custom_fields',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-背调-创建背调自定义字段-创建用户在发起背调时展示的表单自定义字段。自定义字段支持多种类型如单行文本、单选等,可以设置为必填或非必填',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
account_id: zod_1.z.string().describe('背调账号 ID,可在[账号绑定]事件中获取'),
custom_field_list: zod_1.z
.array(zod_1.z.object({
type: zod_1.z
.enum(['text', 'textarea', 'number', 'boolean', 'select', 'multiselect', 'date', 'file', 'resume'])
.describe('自定义字段类型 Options:text(单行文本,最多100个汉字),textarea(MultiText 多行文本,最多200个汉字),number(数字),boolean(布尔),select(Choice 单选),multiselect(MultiChoice 多选),date(日期),file(Attachment 附件),resume(候选人简历)'),
key: zod_1.z.string().describe('自定义字段的标识,在同一账号内唯一'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文名称').optional(),
en_us: zod_1.z.string().describe('英文名称').optional(),
})
.describe('自定义字段的名称,用户在安排背调表单看到的控件标题'),
is_required: zod_1.z.boolean().describe('是否必填'),
description: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文描述').optional(),
en_us: zod_1.z.string().describe('英文描述').optional(),
})
.describe('自定义字段的描述。如果是输入控件(type=text 或 type=textarea),为用户在安排背调表单看到的 placeholder 或 提示文字')
.optional(),
options: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('选项的唯一标识'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('中文名称').optional(),
en_us: zod_1.z.string().describe('英文名称').optional(),
})
.describe('选项的名称'),
}))
.describe('type 为`select`或`multiselect`时必填,单选或多选的选项')
.optional(),
}))
.describe('自定义字段列表'),
}),
},
};
exports.hireV1EcoBackgroundCheckPackageBatchDelete = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheckPackage.batchDelete',
sdkName: 'hire.v1.ecoBackgroundCheckPackage.batchDelete',
path: '/open-apis/hire/v1/eco_background_check_packages/batch_delete',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-背调-删除背调套餐和附加调查项-删除背调帐号下的背调套餐和附加调查项信息。删除操作不会影响已创建的背调',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
account_id: zod_1.z.string().describe('背调账号 ID,可通过[账号绑定]事件获取'),
package_id_list: zod_1.z.array(zod_1.z.string()).describe('要删除的套餐 ID 列表。删除套餐不影响已安排的背调').optional(),
additional_item_id_list: zod_1.z
.array(zod_1.z.string())
.describe('要删除的附加调查项 ID 列表。删除附加调查项不影响已安排的背调')
.optional(),
}),
},
};
exports.hireV1EcoBackgroundCheckPackageBatchUpdate = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheckPackage.batchUpdate',
sdkName: 'hire.v1.ecoBackgroundCheckPackage.batchUpdate',
path: '/open-apis/hire/v1/eco_background_check_packages/batch_update',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-招聘-生态对接-背调-更新背调套餐和附加调查项-更新指定背调帐号下的背调套餐和附加调查项信息。如需新增背调套餐、附加调查项请使用[创建背调套餐和附加调查项]进行添加',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
account_id: zod_1.z.string().describe('背调账号 ID,可通过[账号绑定]事件获取'),
package_list: zod_1.z
.array(zod_1.z.object({
id: zod_1.z.string().describe('账号下已有的套餐 ID'),
name: zod_1.z.string().describe('套餐名称'),
description: zod_1.z.string().describe('套餐描述').optional(),
}))
.describe('背调套餐列表'),
additional_item_list: zod_1.z
.array(zod_1.z.object({
id: zod_1.z.string().describe('账号下已有的附加调查项 ID'),
name: zod_1.z.string().describe('附加调查项名称'),
description: zod_1.z.string().describe('附加调查项描述').optional(),
}))
.describe('附加调查项列表')
.optional(),
}),
},
};
exports.hireV1EcoBackgroundCheckPackageCreate = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheckPackage.create',
sdkName: 'hire.v1.ecoBackgroundCheckPackage.create',
path: '/open-apis/hire/v1/eco_background_check_packages',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-背调-创建背调套餐和附加调查项-在指定背调帐号下创建可用的背调套餐列表和附加调查项信息列表。该接口为增量创建,每次调用会在原有的套餐列表和附加调查项列表基础上新增',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
account_id: zod_1.z.string().describe('背调账号 ID,可通过[账号绑定]事件获取'),
package_list: zod_1.z
.array(zod_1.z.object({
id: zod_1.z.string().describe('套餐 ID。由调用方自定义**注意**:长度不超过`36`字符'),
name: zod_1.z.string().describe('套餐名称'),
description: zod_1.z.string().describe('套餐描述').optional(),
}))
.describe('背调套餐列表'),
additional_item_list: zod_1.z
.array(zod_1.z.object({
id: zod_1.z.string().describe('附件调查项 ID。由调用方自定义**注意**:长度不超过`36`字符'),
name: zod_1.z.string().describe('附加调查项名称'),
description: zod_1.z.string().describe('附加调查项描述').optional(),
}))
.describe('附加调查项列表')
.optional(),
}),
},
};
exports.hireV1EcoBackgroundCheckCancel = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheck.cancel',
sdkName: 'hire.v1.ecoBackgroundCheck.cancel',
path: '/open-apis/hire/v1/eco_background_checks/cancel',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-背调-终止背调订单-调用此接口将会将背调订单状态变成已终止,已终止订单将将无法通过[更新背调订单进度]和[回传背调订单的最终结果]修改订单进度和最终结果。 调用此接口前,建议先调用[更新背调订单进度]接口将订单进度更新为「已终止」',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({ background_check_id: zod_1.z.string().describe('背调 ID。可通过[创建背调]事件获取') }),
},
};
exports.hireV1EcoBackgroundCheckUpdateProgress = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheck.updateProgress',
sdkName: 'hire.v1.ecoBackgroundCheck.updateProgress',
path: '/open-apis/hire/v1/eco_background_checks/update_progress',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-背调-更新背调订单进度-更新指定背调订单的进度信息和阶段性报告,进度信息将会被展示在「飞书招聘」-「投递详情页」-「背调卡片」上,告知用户目前背调订单的流转状态',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
background_check_id: zod_1.z.string().describe('背调 ID。可通过[创建背调]事件获取'),
stage_id: zod_1.z.string().describe('阶段 ID。同一背调订单此 ID 不能重复,由调用方自定义'),
stage_en_name: zod_1.z.string().describe('背调阶段英文名称').optional(),
stage_name: zod_1.z.string().describe('背调阶段名称'),
stage_time: zod_1.z.string().describe('阶段进度更新时间。 毫秒时间戳,每次调用此字段应严格递增'),
result: zod_1.z
.string()
.describe('背调结果(阶段性背调结果)。**注意**:若需回传该字段,report_file_list为必填')
.optional(),
report_file_list: zod_1.z
.array(zod_1.z.object({
report_name: zod_1.z.string().describe('报告名称'),
report_url: zod_1.z
.string()
.describe('报告地址;当report_url_type 为空或为 1 时需为可下载的 pdf 链接;为 2 时为预览型链接'),
report_url_type: zod_1.z
.number()
.describe('报告地址类型;枚举值为空或 1 时为可下载的 pdf 链接,2 为预览型链接 Options:1(DownloadLink 可下载的链接),2(ExternalLink 预览型链接)')
.optional(),
}))
.describe('报告列表')
.optional(),
}),
},
};
exports.hireV1EcoBackgroundCheckUpdateResult = {
project: 'hire',
name: 'hire.v1.ecoBackgroundCheck.updateResult',
sdkName: 'hire.v1.ecoBackgroundCheck.updateResult',
path: '/open-apis/hire/v1/eco_background_checks/update_result',
httpMethod: 'POST',
description: '[Feishu/Lark]-招聘-生态对接-背调-回传背调订单的最终结果-回传背调的最终结果和终版报告。回传后,若租户未启用背调报告审