@larksuiteoapi/lark-mcp
Version:
Feishu/Lark OpenAPI MCP
714 lines • 373 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]-Hire-Recruitment related configuration-Job-Publish job post-Publish advertisement',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({ job_channel_id: zod_1.z.string().describe('Job channel ID').optional() }).optional(),
path: zod_1.z.object({ advertisement_id: zod_1.z.string().describe('Job 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]-Hire-Get candidates-Agency-Search supplier list-Supplier information can be queried according to headhunting supplier ID list or keywords and filters',
accessTokens: ['tenant'],
schema: {
data: zod_1.z
.object({
agency_supplier_id_list: zod_1.z
.array(zod_1.z.string())
.describe('Headhunting supplier ID list, when passing this value, this value shall prevail, and the rest of the query fields shall be invalid')
.optional(),
keyword: zod_1.z.string().describe('Search for keywords, you can pass in a name or email address').optional(),
filter_list: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('Filter key'),
value_type: zod_1.z
.number()
.describe('filter value type Options:1(Value filtering, populating value_list fields),2(Range filtering, populating range_filter fields)'),
value_list: zod_1.z.array(zod_1.z.string()).describe('list of filter values').optional(),
range_filter: zod_1.z
.object({
from: zod_1.z.string().describe('starting value').optional(),
to: zod_1.z.string().describe('stop value').optional(),
})
.describe('range filter')
.optional(),
}))
.describe('Filter items, the same Key can only be passed once, and the field value can be viewed in the "Filter Field Description" section of this article')
.optional(),
})
.optional(),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
page_size: zod_1.z.number().describe('number of records fetched per page').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]-Hire-Get candidates-Agency-Get agency information-Get agency information by 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('User ID type').optional(),
})
.optional(),
path: zod_1.z.object({ agency_id: zod_1.z.string().describe('Agency Supplier 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]-Hire-Get candidates-Agency-Query the headhunting list of suppliers-Query the headhunting list according to the headhunting supplier ID',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
supplier_id: zod_1.z
.string()
.describe('The headhunting supplier ID can be obtained through the [Search headhunting supplier list] interface'),
status: zod_1.z
.number()
.describe('headhunting status Options:0(Normal),1(Enabled disabled),2(DisabledBySupplier Deactivated by headhunters)')
.optional(),
role: zod_1.z.number().describe('role Options:0(Manager administrator),1(Consultant)').optional(),
}),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id']).describe('User ID type').optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
page_size: zod_1.z.number().describe('number of records fetched per page').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]-Hire-Get candidates-Agency-Disable/undisable headhunting under headhunting supplier-The headhunter can be disabled/undisabled according to the headhunter ID',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
option: zod_1.z.number().describe('operation type Options:1(Add disable),2(Remove cancel the ban)'),
id: zod_1.z
.string()
.describe('The headhunting ID can be obtained through the [Query the headhunting list under the headhunting supplier] interface'),
reason: zod_1.z.string().describe("Disable reason, required only if'option 'is'disabled'").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]-Hire-Get candidates-Agency-Set agency protection period-Set agency protection period',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
talent_id: zod_1.z.string().describe('Talent ID'),
supplier_id: zod_1.z.string().describe('Supplier ID'),
consultant_id: zod_1.z.string().describe('Agency Consultant ID'),
protect_create_time: zod_1.z.number().describe('Protection period creation time'),
protect_expire_time: zod_1.z.number().describe('Protection expiration time'),
comment: zod_1.z.string().describe('Recommendation').optional(),
current_salary: zod_1.z.string().describe('Current salary').optional(),
expected_salary: zod_1.z.string().describe('Expected salary').optional(),
}),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_admin_id']).describe('User ID type').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]-Hire-Get candidates-Agency-Query agency protection period information-Query agency protection period information',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({ talent_id: zod_1.z.string().describe('Talent ID, [「Get talent ID by mobile or email」]') }),
},
};
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]-Hire-Get candidates-Agency-Query agency information-Query agency information by name',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
name: zod_1.z.string().describe('Agency Name'),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').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]-Hire-Candidate management-Delivery process-Onboard-Cancel candidate enrollment-The operation candidate cancels the entry, which is applicable to cancel the entry in the waiting stage',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
termination_type: zod_1.z
.number()
.describe('Termination type Options:1(我们拒绝了候选人 We rejected the candidate),22(候选人拒绝了我们 The candidate rejected us),27(其他 Other)'),
termination_reason_id_list: zod_1.z
.array(zod_1.z.string())
.describe('The id list of the specific reason for termination, please refer to [Get the reason for termination of application]')
.optional(),
termination_reason_notes: zod_1.z.string().describe('Remarks').optional(),
}),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('Delivery 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]-Hire-Candidate management-Delivery process-Delivery management-Create application-Create application by job ID and talent ID',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
talent_id: zod_1.z.string().describe('12312312312'),
job_id: zod_1.z.string().describe('Job ID'),
user_id: zod_1.z
.string()
.describe('User ID，this field needs to be entered only when the delivery source is "employee transfer" or "intern transfer". After the verification data is correct, it will become a talent and employee relationship record maintained by the recruiter; when creating delivery from other sources, personnel and talents will not be bound')
.optional(),
resume_source_id: zod_1.z
.string()
.describe('The resume source ID can be queried through the interface of 「obtaining the resume source list」. If the source type of resume belongs to "employee transfer" or "intern transfer", the talent must be in the on-the-job status')
.optional(),
application_preferred_city_code_list: zod_1.z
.array(zod_1.z.string())
.describe('The list of intended delivery cities can be obtained from the list of work locations returned by "Get Job Information"')
.optional(),
delivery_type: zod_1.z
.number()
.describe('Application method Options:1(HR_visit Sourced by HR),2(candidate_delivery Talent applied)')
.optional(),
}),
params: zod_1.z
.object({ user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').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]-Hire-Candidate management-Delivery process-Delivery management-Get application information-Get application by application ID',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').optional(),
options: zod_1.z
.array(zod_1.z
.literal('get_latest_application_on_chain')
.describe('Options:get_latest_application_on_chain(GetLatestApplicationOnChain Only effective for virtual job applications. - If the application is not assigned, the virtual job application is considered the latest application. The information of the specified virtual job application in the request will be returned. - If the application is assigned, it will return the information of the latest real job application on the assignment chain, not the specified application in the request.)'))
.describe('Request control parameters to control the interface response logic.If you need to query multiple user IDs at once, you can pass the same parameter name multiple times, each time with a different parameter value. For example: https://{url}?options={option1}&options={option2}')
.optional(),
})
.optional(),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('Application 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]-Hire-Candidate management-Delivery process-Delivery management-Get application detail-Call the interface to obtain the application information and other entity information related to the delivery according to the delivery ID. The information of which related entities can be obtained on demand through the options parameter',
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('User ID type').optional(),
department_id_type: zod_1.z
.enum(['open_department_id', 'department_id'])
.describe('The department ID type used in this call Options:open_department_id(Identify the department by open_department_id, and get it through the [batch acquisition department information] interface),department_id(Identify the department by department_id, and get it through the [batch acquisition department information] interface)')
.optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('The type of "rank ID" used in this call Options:people_admin_job_level_id("HR system management background" applicable rank ID. HR system management background is gradually offline, it is recommended not to continue to use this ID.),job_level_id(The rank ID applicable to "Feishu Management Background" is obtained through the [Get Tenant Rank List] interface)')
.optional(),
job_family_id_type: zod_1.z
.enum(['people_admin_job_category_id', 'job_family_id'])
.describe('The type of "sequence ID" used in this call Options:people_admin_job_category_id("HR system management background" applicable serial ID. HR system management background is gradually offline, it is recommended not to continue to use this ID.),job_family_id(The sequence ID applicable to "Feishu Management Background" is obtained through the [Get Tenant Sequence List] interface)')
.optional(),
employee_type_id_type: zod_1.z
.enum(['people_admin_employee_type_id', 'employee_type_enum_id'])
.describe('The type of "person type ID" used in this call Options:people_admin_employee_type_id("HR system management background" applicable personnel type ID. HR system management background is gradually offline, it is recommended not to continue to use this ID.),employee_type_enum_id(The person type ID applicable to "Feishu Management Background" is obtained through the [Query Person Type] interface)')
.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(Return to job entity information),with_talent(Return to talent entity information),with_interview(Return to Interview Aggregate Entity Information),with_offer(Return Offer Entity Information),with_evaluation(Return to evaluation entity information),with_employee(Return to employee entity information),with_agency(Return to headhunter entity information),with_referral(Return referral entity information),with_portal(Return to the official website entity information)'))
.describe('The associated entity information acquisition parameter is used to specify which associated entity information to obtain. When not transmitted, only the delivery information is returned by default. If you need to query multiple entity information at one time, you can pass the same parameter name multiple times and pass different parameter values each time.For example: https://{url}? options = {option1} & options = {option2}')
.optional(),
})
.optional(),
path: zod_1.z
.object({
application_id: zod_1.z
.string()
.describe('Delivery ID, which can be obtained through the [Get Delivery List] interface')
.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]-Deprecated Version (Not Recommended)-Hire-Interview-Get Interview List',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
page_size: zod_1.z.number().describe('Page size'),
page_token: zod_1.z
.string()
.describe('Pagination mark, the first request is not filled in, indicating the traversal from scratch; the paged query result will return a new page_token at the same time when there are more items, the next traversal can use this page_token to obtain the query result')
.optional(),
user_id_type: zod_1.z.enum(['user_id', 'union_id', 'open_id', 'people_admin_id']).describe('User ID type').optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('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('Application 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]-Hire-Candidate management-Delivery process-Delivery management-Get application list-Get application list by query condition',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
process_id: zod_1.z.string().describe('Filter by process').optional(),
stage_id: zod_1.z.string().describe('Filter by stage').optional(),
talent_id: zod_1.z.string().describe('Filter by talent').optional(),
active_status: zod_1.z
.string()
.describe('Filter by active status 1 = active application, 2 = inactive application, 3 = all,')
.optional(),
job_id: zod_1.z.string().describe('Job ID').optional(),
lock_status: zod_1.z
.array(zod_1.z.number().describe('Options:1(Not locked),2(Locking in other jobs),3(Locking in the current job)'))
.describe('Locking status')
.optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
page_size: zod_1.z.number().describe('Page size').optional(),
update_start_time: zod_1.z.string().describe('The earliest update time, millisecond timestamp').optional(),
update_end_time: zod_1.z.string().describe('Latest update time, millisecond timestamp').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]-Hire-Candidate management-Delivery process-Offer-Get offer information-Get offer information application ID',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').optional(),
department_id_type: zod_1.z
.enum(['open_department_id', 'department_id'])
.describe('The Type Of Department ID Used In This Call Options:open_department_id(Identify Departments By open_department_id),department_id(Identify Departments By department_id)')
.optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('The type of "rank ID" used in this call Options:people_admin_job_level_id(The Job Level ID applicable to "HCM Platform". The HCM Platform is gradually being offline. It is recommended not to continue using this ID type.),job_level_id(The Job Level ID applicable to "Feishu Management Backend" can be obtained through the [Query the list of job level] interface.)')
.optional(),
job_family_id_type: zod_1.z
.enum(['people_admin_job_category_id', 'job_family_id'])
.describe('The type of "Job Family ID" used in this request Options:people_admin_job_category_id(The Job Family ID applicable to "HCM Platform". The HCM Platform is gradually being offline. It is recommended not to continue using this ID type.),job_family_id(The Job Family ID applicable to "Feishu Management Backend" can be obtained through the [Query the list of job family] interface.)')
.optional(),
employee_type_id_type: zod_1.z
.enum(['people_admin_employee_type_id', 'employee_type_enum_id'])
.describe('The type of "Workforce Type ID" used in this request Options:people_admin_employee_type_id(The Workforce Type ID applicable to "HCM Platform". The HCM Platform is gradually being offline. It is recommended not to continue using this ID type.),employee_type_enum_id(The Workforce Type ID applicable to "Feishu Management Backend" can be obtained through the [Query the workforce type] interface.)')
.optional(),
})
.optional(),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('Application ID,please refer to: [Get application list]') }),
},
};
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]-Hire-Candidate management-Delivery process-Delivery management-Recover Application-Recover "terminated" deliveries according to the application ID',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({ application_id: zod_1.z.string().describe('Application ID, please refer to: [Get application list]') }),
},
};
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]-Hire-Candidate management-Delivery process-Delivery management-Terminate application-Modify the application status to "terminated" according to the application ID',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
termination_type: zod_1.z
.number()
.describe('Type of termination reason Options:1(我们拒绝了候选人 We rejected the candidate),22(候选人拒绝了我们 The candidate rejected us),27(其他 Other)'),
termination_reason_list: zod_1.z
.array(zod_1.z.string())
.describe('The id list of the specific reason for termination, please refer to [Get the termination reason for application]')
.optional(),
termination_reason_note: zod_1.z.string().describe('Termination remarks').optional(),
}),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('Application ID, please refer to [Get Application List]') }),
},
};
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]-Hire-Candidate management-Delivery process-Onboard-Transfer talent to onboarding-Manage candidate onboarding and create employees according to the delivery ID. The delivery must be in the "Prehire" stage, and the delivery status can be changed through the "Transfer Stage" interface',
accessTokens: ['tenant'],
schema: {
data: zod_1.z
.object({
actual_onboard_time: zod_1.z.number().describe('Actual onboard time').optional(),
expected_conversion_time: zod_1.z.number().describe('Expected confirmation time').optional(),
job_requirement_id: zod_1.z
.string()
.describe('Job requirement ID. It can be obtained through the interface [Get job requirement list]. Whether it must be entered depends on the configuration of "Recruitment request association settings" by the admin in the system backend. After onboarding is completed, the "Onboarded" number for the recruitment request will increase by 1')
.optional(),
operator_id: zod_1.z
.string()
.describe('Operator UserID，Consistent with the type of the entry `user_id_type`')
.optional(),
onboard_city_code: zod_1.z.string().describe('Office location').optional(),
department: zod_1.z.string().describe('Entry Department').optional(),
leader: zod_1.z.string().describe('Direct manager，Consistent with the type of the entry `user_id_type`').optional(),
sequence: zod_1.z.string().describe('Sequence').optional(),
level: zod_1.z.string().describe('Rank').optional(),
employee_type: zod_1.z
.string()
.describe('Candidate entry type ID, which can be obtained through the interface human resource planning platform "Get Employee Type List", which will be used for candidate referral award rule judgment')
.optional(),
})
.optional(),
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').optional(),
department_id_type: zod_1.z
.enum(['open_department_id', 'department_id', 'people_admin_department_id'])
.describe('The type of department ID used in this call Options:open_department_id(Identify departments by open_department_id),department_id(Identify departments by department_id),people_admin_department_id(Identify departments by people_admin_department_id)')
.optional(),
job_level_id_type: zod_1.z
.enum(['people_admin_job_level_id', 'job_level_id'])
.describe('The type of "Job Level ID" used in this request Options:people_admin_job_level_id(The Job Level ID applicable to "HCM Platform". The HCM Platform is gradually being offline. It is recommended not to continue using this ID type.),job_level_id(The Job Level ID applicable to "Feishu Management Backend" can be obtained through the [Query the list of job level] interface.)')
.optional(),
job_family_id_type: zod_1.z
.enum(['people_admin_job_category_id', 'job_family_id'])
.describe('The type of "Job Family ID" used in this request Options:people_admin_job_category_id(The Job Family ID applicable to "HCM Platform". The HCM Platform is gradually being offline. It is recommended not to continue using this ID type.),job_family_id(The Job Family ID applicable to "Feishu Management Backend" can be obtained through the [Query the list of job family] interface.)')
.optional(),
employee_type_id_type: zod_1.z
.enum(['people_admin_employee_type_id', 'employee_type_enum_id'])
.describe('The type of "Workforce Type ID" used in this request Options:people_admin_employee_type_id(The Workforce Type ID applicable to "HCM Platform". The HCM Platform is gradually being offline. It is recommended not to continue using this ID type.),employee_type_enum_id(The Workforce Type ID applicable to "Feishu Management Backend" can be obtained through the [Query the workforce type] interface.)')
.optional(),
})
.optional(),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('Application 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]-Hire-Candidate management-Delivery process-Delivery management-Transfer delivery stage-Transfer delivery stage. When "All positions require offer approval" is turned on, the offer will be transferred to the waiting stage that requires approval',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
stage_id: zod_1.z
.string()
.describe('The stage ID to transfer to, you can get the stage ID enumeration through the "Get Recruitment Process Information" interface'),
}),
path: zod_1.z.object({ application_id: zod_1.z.string().describe('Delivery 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]-Hire-Attachment-Get attachment information-Obtain the meta-information of the attachment in the recruitment system according to the ID of the talent resume attachment, such as file name, creation time, file URL, etc., The resume attachment of the talent can be obtained through the [Access Talent Information] Interface',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
type: zod_1.z
.number()
.describe('Attachment type Options:1(附件简历 Attachment Resume),2(候选人作品 Candidate works),3(自定义附件 Custom attachments)')
.optional(),
})
.optional(),
path: zod_1.z.object({ attachment_id: zod_1.z.string().describe('Attachment id') }),
},
};
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]-Hire-Attachment-Get attachment PDF download link-Obtain the attachment preview information according to the ID of the talent resume attachment, and obtain the resume attachment of the talent through the [Get talent] api',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({ attachment_id: zod_1.z.string().describe('Attachment id, please refer to [Get talent]') }),
},
};
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]-Hire-Candidate management-Delivery process-Background check-Get background check info list-Get the background check order information in batches according to the application ID or background check update time',
accessTokens: ['tenant'],
schema: {
params: zod_1.z
.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
page_size: zod_1.z.number().describe('Page size').optional(),
application_id: zod_1.z.string().describe('Delivery ID').optional(),
update_start_time: zod_1.z.string().describe('The earliest update time, millisecond timestamp').optional(),
update_end_time: zod_1.z.string().describe('Latest update time, millisecond timestamp').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]-Hire-Candidate management-Delivery process-Delivery management-Get Additional Info in Application Form-Get application form additional information of candidates. You can query by Application ID or Talent ID',
accessTokens: ['tenant'],
schema: {
data: zod_1.z
.object({
talent_ids: zod_1.z
.array(zod_1.z.string())
.describe('List of talent IDs that need to query DI data, please refer to [Get talent list] to get talent IDs')
.optional(),
application_ids: zod_1.z
.array(zod_1.z.string())
.describe('List of application IDs that need to query DI data, please refer to[Get application list] to get application IDs')
.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]-Hire-Ecological docking-account-Delete account customized fields-Feishu Hire's back check or written test service provider can delete account customization fields (such as the customer's tenant ID, account ID, etc.) at the service provider through this interface",
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
scope: zod_1.z.number().describe('scope Options:1(背调 Background Check),2(笔试 Exam)'),
custom_field_key_list: zod_1.z.array(zod_1.z.string()).describe('List of keys for custom fields to delete').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]-Hire-Ecological docking-account-Update account customized fields-Feishu Hire's back-end or written test service provider can update the name and description of account customization fields (such as the customer's tenant ID at the service provider, account ID, etc.) through this interface",
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
scope: zod_1.z.number().describe('Account Custom Field Scope Options:1(背调 Background Check),2(笔试 Exam)'),
custom_field_list: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('The identity of a custom field that already exists under the current `scope`'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('Custom field Chinese name').optional(),
en_us: zod_1.z.string().describe('Custom field English name').optional(),
})
.describe('The name of the custom field. The title of the form control that users see when adding an account under "Feishu Hire" - "Settings" - "Ecological Docking" - "Written Test/Background Check"'),
is_required: zod_1.z
.boolean()
.describe('Is it required?**Optional values are**:* `true`: required* `false`: not required**NOTE**: This field is not valid in the current interface'),
description: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('Chinese name').optional(),
en_us: zod_1.z.string().describe('English name').optional(),
})
.describe('Description')
.optional(),
}))
.describe('Custom Field List'),
}),
},
};
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]-Hire-Ecological docking-account-Create account customized field-Feishu Hire's back check or written test service provider can create account customization fields through this interface to identify the identity of Feishu Hire customers at the service provider (such as the customer's tenant ID, account ID, etc.)",
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
scope: zod_1.z.number().describe('Account Custom Field Scope Options:1(背调 Background Check),2(笔试 Exam)'),
custom_field_list: zod_1.z
.array(zod_1.z.object({
key: zod_1.z.string().describe('The identity of the custom field. It must be unique within the same `scope`'),
name: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('Custom field Chinese name').optional(),
en_us: zod_1.z.string().describe('Custom field English name').optional(),
})
.describe('Name'),
is_required: zod_1.z
.boolean()
.describe('Is it required?**Optional values are**:* `true`: required* `false`: not required'),
description: zod_1.z
.object({
zh_cn: zod_1.z.string().describe('Chinese name').optional(),
en_us: zod_1.z.string().describe('English name').optional(),
})
.describe('Description')
.optional(),
}))
.describe('Custom Field List'),
}),
},
};
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]-Hire-Ecological docking-background check-Delete background check customized fields-Delete the form custom fields that the user displays when initiating a back call',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
account_id: zod_1.z.string().describe('The account ID can be obtained through the [account binding] event'),
}),
},
};
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]-Hire-Ecological docking-background check-Update background check customized fields-Updates the form custom field names and descriptions that the user displays when initiating a back call',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
account_id: zod_1.z.string().describe('The account ID can be obtained through the [account binding] event'),
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('Custom Field Data Options:text(Single line of text, up to 100 Chinese characters),textarea(MultiText Multi-line text, up to 200 Chinese characters),number(number),boolean(Boolean),select(Choice radio),multiselect(MultiChoice multiple choice),date(date),file(Attachment Annex),resume(Candidate resume)'),
key: zod_1.z.string().describe('The identity of a