@larksuiteoapi/lark-mcp
Version:
Feishu/Lark OpenAPI MCP
931 lines (930 loc) • 301 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.corehrV1JobFamilyList = exports.corehrV1JobFamilyGet = exports.corehrV1JobFamilyDelete = exports.corehrV1JobFamilyCreate = exports.corehrV1JobDataPatch = exports.corehrV1JobDataList = exports.corehrV1JobDataGet = exports.corehrV1JobDataDelete = exports.corehrV1JobDataCreate = exports.corehrV1JobChangeCreate = exports.corehrV1EmploymentPatch = exports.corehrV1EmploymentDelete = exports.corehrV1EmploymentCreate = exports.corehrV1EmployeeTypePatch = exports.corehrV1EmployeeTypeList = exports.corehrV1EmployeeTypeGet = exports.corehrV1EmployeeTypeDelete = exports.corehrV1EmployeeTypeCreate = exports.corehrV1DepartmentPatch = exports.corehrV1DepartmentList = exports.corehrV1DepartmentGet = exports.corehrV1DepartmentDelete = exports.corehrV1DepartmentCreate = exports.corehrV1CustomFieldQuery = exports.corehrV1CustomFieldListObjectApiName = exports.corehrV1CustomFieldGetByParam = exports.corehrV1CurrencyList = exports.corehrV1CurrencyGet = exports.corehrV1CountryRegionList = exports.corehrV1CountryRegionGet = exports.corehrV1ContractPatch = exports.corehrV1ContractList = exports.corehrV1ContractGet = exports.corehrV1ContractDelete = exports.corehrV1ContractCreate = exports.corehrV1CompensationStandardMatch = exports.corehrV1CompanyPatch = exports.corehrV1CompanyList = exports.corehrV1CompanyGet = exports.corehrV1CompanyDelete = exports.corehrV1CompanyCreate = exports.corehrV1CommonDataMetaDataEditEnumOption = exports.corehrV1CommonDataMetaDataAddEnumOption = exports.corehrV1CommonDataIdConvert = exports.corehrV1AuthorizationUpdateRoleAssign = exports.corehrV1AuthorizationRemoveRoleAssign = exports.corehrV1AuthorizationQuery = exports.corehrV1AuthorizationGetByParam = exports.corehrV1AuthorizationAddRoleAssign = exports.corehrV1AssignedUserSearch = void 0;
exports.corehrV1WorkingHoursTypeDelete = exports.corehrV1WorkingHoursTypeCreate = exports.corehrV1TransferTypeQuery = exports.corehrV1TransferReasonQuery = exports.corehrV1SubregionList = exports.corehrV1SubregionGet = exports.corehrV1SubdivisionList = exports.corehrV1SubdivisionGet = exports.corehrV1SecurityGroupQuery = exports.corehrV1SecurityGroupList = exports.corehrV1ProcessFormVariableDataGet = exports.corehrV1PreHirePatch = exports.corehrV1PreHireList = exports.corehrV1PreHireGet = exports.corehrV1PreHireDelete = exports.corehrV1PersonPatch = exports.corehrV1PersonGet = exports.corehrV1PersonDelete = exports.corehrV1PersonCreate = exports.corehrV1OffboardingSubmit = exports.corehrV1OffboardingSearch = exports.corehrV1OffboardingQuery = exports.corehrV1NationalIdTypePatch = exports.corehrV1NationalIdTypeList = exports.corehrV1NationalIdTypeGet = exports.corehrV1NationalIdTypeDelete = exports.corehrV1NationalIdTypeCreate = exports.corehrV1LocationList = exports.corehrV1LocationGet = exports.corehrV1LocationDelete = exports.corehrV1LocationCreate = exports.corehrV1LeaveWorkCalendarDate = exports.corehrV1LeaveWorkCalendar = exports.corehrV1LeaveLeaveTypes = exports.corehrV1LeaveLeaveRequestHistory = exports.corehrV1LeaveLeaveBalances = exports.corehrV1LeaveCalendarByScope = exports.corehrV1LeaveGrantingRecordDelete = exports.corehrV1LeaveGrantingRecordCreate = exports.corehrV1JobPatch = exports.corehrV1JobList = exports.corehrV1JobGet = exports.corehrV1JobDelete = exports.corehrV1JobCreate = exports.corehrV1JobLevelPatch = exports.corehrV1JobLevelList = exports.corehrV1JobLevelGet = exports.corehrV1JobLevelDelete = exports.corehrV1JobLevelCreate = exports.corehrV1JobFamilyPatch = void 0;
exports.corehrV1Tools = exports.corehrV1WorkingHoursTypePatch = exports.corehrV1WorkingHoursTypeList = exports.corehrV1WorkingHoursTypeGet = void 0;
const zod_1 = require("zod");
exports.corehrV1AssignedUserSearch = {
project: 'corehr',
name: 'corehr.v1.assignedUser.search',
sdkName: 'corehr.v1.assignedUser.search',
path: '/open-apis/corehr/v1/assigned_users/search',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-权限-获取组织类角色授权列表-查询组织类角色的授权信息,返回的授权列表中包含被授权的用户ID和被授权的管理维度等信息',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
role_id: zod_1.z
.string()
.describe('角色 ID,仅支持组织类角色, 角色 ID 可通过接口获取'),
management_scope_list: zod_1.z
.array(zod_1.z.object({
management_dimension: zod_1.z
.string()
.describe('管理维度可选值有:- department:部门- work_location:工作地点- company:公司- social_security_location:社保城市'),
obj_id: zod_1.z.string().describe('被授权部门/工作地点/公司/社保城市 ID'),
}))
.describe('管理范围信息'),
search_method: zod_1.z
.string()
.describe('查找方式可选值有:- 1:只查找指定 部门/工作地点/公司/社保城市,如无授权信息则返回为空- 2:当指定的 部门/工作地点/公司/社保城市 无授权信息,向上查找第一个授权记录并直接返回'),
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.string().describe('分页大小,最大100'),
}),
params: zod_1.z.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_corehr_id']).describe('用户ID类型').optional(),
}),
},
};
exports.corehrV1AuthorizationAddRoleAssign = {
project: 'corehr',
name: 'corehr.v1.authorization.addRoleAssign',
sdkName: 'corehr.v1.authorization.addRoleAssign',
path: '/open-apis/corehr/v1/authorizations/add_role_assign',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-权限-为用户授权角色-为用户授权角色及管理范围 对已被授权某个角色的用户继续授权,将在原授权的数据范围基础上追加数据范围',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
assigned_organization_items: zod_1.z
.array(zod_1.z
.array(zod_1.z.object({
org_key: zod_1.z.string().describe('管理对象key'),
org_ids: zod_1.z.array(zod_1.z.string()).describe('管理对象id列表').optional(),
org_codes: zod_1.z.array(zod_1.z.string()).describe('管理对象code列表').optional(),
}))
.describe('指定管理对象'))
.describe('被授权角色的授权范围。你需要按照请求体示例构造结构体。 它是一个二维数组,你可以使用它来授权具有多个管理维度的角色,例如属地 HRBP。 - ==org_key==:管理维度。可选项有 - 部门:==department== - 工作地点:==work_location== - 公司:==company== - 成本中心:==organization_id_strand== - 社保城市:==social_security_location== - 入职地点:==onboarding_location== - 薪资组:==pay_group== - 人才池:==talent_pool== - 自定义组织:可在「-设置-组织设置」中相应的自定义组织目录下查看对应的组织类型编码,例如==custom_org_01==、==custom_org_02==、==custom_org_03==、==custom_org_04==、==custom_org_05==- ==org_ids==:组织 ID。组织 ID 和组织编码只需要填写一个- ==org_codes==:组织编码。组织 ID 和组织编码只需要填写一个'),
}),
params: zod_1.z.object({
employment_id: zod_1.z
.string()
.describe('被授权用户的 ID,ID类型与user_id_type的取值意义一致。默认为飞书人事中的 ==employment_id==。 > 如果你需要不同类型的ID进行转换,可以使用 换取 ==employment_id=='),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_corehr_id']).describe('用户ID类型').optional(),
role_id: zod_1.z
.string()
.describe('被授权角色的 ID,一次仅可授权一个角色。你可以使用 获取,或者在角色详情中获取(URL 末的数字)'),
}),
},
};
exports.corehrV1AuthorizationGetByParam = {
project: 'corehr',
name: 'corehr.v1.authorization.getByParam',
sdkName: 'corehr.v1.authorization.getByParam',
path: '/open-apis/corehr/v1/authorizations/get_by_param',
httpMethod: 'GET',
description: '[Feishu/Lark]-飞书人事(企业版)-权限-查询单个用户授权-查询里 -「设置」-「权限设置」中的单个用户授权信息。授权信息中包括员工ID、被授权的角色等信息',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
employment_id: zod_1.z
.string()
.describe('被授权用户的 ID,ID类型与user_id_type的取值意义一致。默认为飞书人事中的 ==employment_id==。 > 如果你需要不同类型的ID进行转换,可以使用 换取 ==employment_id=='),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_corehr_id']).describe('用户ID类型').optional(),
}),
},
};
exports.corehrV1AuthorizationQuery = {
project: 'corehr',
name: 'corehr.v1.authorization.query',
sdkName: 'corehr.v1.authorization.query',
path: '/open-apis/corehr/v1/authorizations/query',
httpMethod: 'GET',
description: '[Feishu/Lark]-飞书人事(企业版)-权限-批量查询用户授权-批量查询 -「设置」-「权限设置」中的用户授权信息。授权列表信息中包括员工ID、被授权的角色等信息',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
employment_id_list: zod_1.z
.array(zod_1.z.string())
.describe('员工ID列表,最大100个(不传则默认查询全部员工)。ID类型与user_id_type的取值意义一致。默认为飞书人事中的 ==employment_id==。 > 如果你需要不同类型的ID进行转换,可以使用 换取 ==employment_id==')
.optional(),
role_id_list: zod_1.z
.array(zod_1.z.string())
.describe('角色 ID 列表,最大 100 个。当传该参数时,会根据rold_id过滤,只返回包含该角色的授权信息。>你可以使用 获取,或者在角色详情中获取(URL 末的数字)')
.optional(),
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.string().describe('每页获取记录数量,最大20(不传该参数,默认为20)').optional(),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_corehr_id']).describe('用户ID类型').optional(),
updated_at_gte: zod_1.z.string().describe('授权时间大于').optional(),
updated_at_lte: zod_1.z.string().describe('授权时间小于').optional(),
}),
},
};
exports.corehrV1AuthorizationRemoveRoleAssign = {
project: 'corehr',
name: 'corehr.v1.authorization.removeRoleAssign',
sdkName: 'corehr.v1.authorization.removeRoleAssign',
path: '/open-apis/corehr/v1/authorizations/remove_role_assign',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-权限-移除用户被授权的角色-移除用户被授权的指定角色及授权范围,已经存在授权可通过获得。或者在里 -「设置」-「权限设置」中的查看已有用户授权信息',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
employment_id: zod_1.z
.string()
.describe('用户的 ID,ID类型与user_id_type的取值意义一致。默认为飞书人事中的 ==employment_id==。 > 如果你需要不同类型的ID进行转换,可以使用 换取 ==employment_id=='),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_corehr_id']).describe('用户ID类型').optional(),
role_id: zod_1.z
.string()
.describe('移除的角色的 ID,一次仅可移除一个角色。>你可以使用 获取,或者在飞书人事角色详情页的url中获取(URL 末的数字)role_id'),
}),
},
};
exports.corehrV1AuthorizationUpdateRoleAssign = {
project: 'corehr',
name: 'corehr.v1.authorization.updateRoleAssign',
sdkName: 'corehr.v1.authorization.updateRoleAssign',
path: '/open-apis/corehr/v1/authorizations/update_role_assign',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-权限-更新用户被授权的数据范围-更新角色被授权的管理范围 更新后的数据范围,以本次提交的数据范围为准,本次未提交的部分将被移除',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
assigned_organization_items: zod_1.z
.array(zod_1.z
.array(zod_1.z.object({
org_key: zod_1.z.string().describe('管理对象key'),
org_ids: zod_1.z.array(zod_1.z.string()).describe('管理对象id列表').optional(),
org_codes: zod_1.z.array(zod_1.z.string()).describe('管理对象code列表').optional(),
}))
.describe('指定管理对象'))
.describe('被授权角色的授权范围。你需要按照请求体示例构造结构体。 它是一个二维数组,你可以使用它来授权具有多个管理维度的角色,例如属地 HRBP。 - ==org_key==:管理维度。可选项有 - 部门:==department== - 工作地点:==work_location== - 公司:==company== - 成本中心:==organization_id_strand== - 社保城市:==social_security_location== - 入职地点:==onboarding_location== - 薪资组:==pay_group== - 人才池:==talent_pool== - 自定义组织:可在「-设置-组织设置」中相应的自定义组织目录下查看对应的组织类型编码,例如==custom_org_01==、==custom_org_02==、==custom_org_03==、==custom_org_04==、==custom_org_05==- ==org_ids==:组织 ID。组织 ID 和组织编码只需要填写一个- ==org_codes==:组织编码。组织 ID 和组织编码只需要填写一个'),
}),
params: zod_1.z.object({
employment_id: zod_1.z
.string()
.describe('被授权用户的 ID,ID类型与user_id_type的取值意义一致。默认为飞书人事中的 ==employment_id==。 > 如果你需要不同类型的ID进行转换,可以使用 换取 ==employment_id=='),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_corehr_id']).describe('用户ID类型').optional(),
role_id: zod_1.z
.string()
.describe('被授权角色的 ID,一次仅可授权一个角色。你可以使用 获取,或者在角色详情中获取(URL 末的数字)'),
}),
},
};
exports.corehrV1CommonDataIdConvert = {
project: 'corehr',
name: 'corehr.v1.commonDataId.convert',
sdkName: 'corehr.v1.commonDataId.convert',
path: '/open-apis/corehr/v1/common_data/id/convert',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-ID 服务-ID 转换-该接口用来进行飞书人事和飞书通讯录、people admin 的各种 ID 转换(仅适用于飞书人事新链路租户)',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({ ids: zod_1.z.array(zod_1.z.string()).describe('ID 列表(最多传入 100 个 ID,ID 长度限制 50 个字符)') }),
params: zod_1.z.object({
id_transform_type: zod_1.z
.number()
.describe('ID 转换类型 Options:1(CoreHR2Feishu 飞书人事 -> 飞书通讯录),2(Feishu2CoreHR 飞书通讯录 -> 飞书人事),3(Admin2Feishu people admin -> 飞书通讯录),4(Admin2CoreHR people admin -> 飞书人事)'),
id_type: zod_1.z
.enum(['user_id', 'department_id', 'job_level_id', 'job_family_id', 'employee_type_id'])
.describe('要转换的ID类型 Options:user_id(EmploymentID 员工ID,当选择 user_id 且 id_transform_type 为 1、2、4 时,feishu_user_id_type 必填),department_id(DepartmentID 部门ID,当选择 department_id 且 id_transform_type 为 1、2、4 时,feishu_department_id_type 必填),job_level_id(JobLevelID 职级ID),job_family_id(JobFamilyID 序列ID),employee_type_id(EmployeeTypeID 人员类型ID,people admin 的人员类型ID 即为飞书通讯录人员类型的 enum_value,因此id_transform_type 为 3 时无须转换)'),
feishu_user_id_type: zod_1.z
.enum(['open_id', 'union_id', 'user_id'])
.describe('用户 ID 类型 Options:open_id(标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。),union_id(标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。),user_id(标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。)')
.optional(),
feishu_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(),
}),
},
};
exports.corehrV1CommonDataMetaDataAddEnumOption = {
project: 'corehr',
name: 'corehr.v1.commonDataMetaData.addEnumOption',
sdkName: 'corehr.v1.commonDataMetaData.addEnumOption',
path: '/open-apis/corehr/v1/common_data/meta_data/add_enum_option',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-基础数据-元数据信息-增加字段枚举值选项-对于当前已有的所有自定义枚举字段,以及部分系统预置枚举字段,通过本接口可在字段中批量新增可选项',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
object_api_name: zod_1.z
.string()
.describe('所属对象 API name,可通过接口中返回的 `object_api_name` 字段获取'),
enum_field_api_name: zod_1.z
.string()
.describe('枚举字段 API name,可通过接口中返回的 `custom_api_name` 字段获取'),
enum_field_options: zod_1.z
.array(zod_1.z.object({
option_api_name: zod_1.z
.string()
.describe('枚举值选项 API Name,即选项的唯一标识,创建后无法修改。由用户自拟,需以英文字母开头,并仅允许包含小写英文字母、数字和下划线'),
name: zod_1.z
.object({ zh_cn: zod_1.z.string().describe('中文').optional(), en_us: zod_1.z.string().describe('英文').optional() })
.describe('选项名称(需填写至少一个语种)'),
}))
.describe('新增枚举选项列表'),
}),
params: zod_1.z.object({
client_token: zod_1.z
.string()
.describe('用户若希望避免重试导致多次重复请求,可填写随机字符串,系统根据 client_token 是否一致来判断是否为同一请求')
.optional(),
}),
},
};
exports.corehrV1CommonDataMetaDataEditEnumOption = {
project: 'corehr',
name: 'corehr.v1.commonDataMetaData.editEnumOption',
sdkName: 'corehr.v1.commonDataMetaData.editEnumOption',
path: '/open-apis/corehr/v1/common_data/meta_data/edit_enum_option',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-基础数据-元数据信息-修改字段枚举值选项-对于当前已有的所有自定义枚举字段,以及部分系统预置枚举字段,通过本接口可修改字段中已有可选项的展示名称、停启用状态',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
object_api_name: zod_1.z
.string()
.describe('所属对象 API name,可通过接口中返回的 `object_api_name` 字段获取'),
enum_field_api_name: zod_1.z
.string()
.describe('枚举字段 API name,可通过接口中返回的 `custom_api_name` 字段获取'),
enum_field_option: zod_1.z
.object({
option_api_name: zod_1.z.string().describe('枚举值选项 API Name,即选项的唯一标识'),
active: zod_1.z.boolean().describe('是否启用'),
name: zod_1.z
.object({ zh_cn: zod_1.z.string().describe('中文').optional(), en_us: zod_1.z.string().describe('英文').optional() })
.describe('选项名称(需填写至少一个语种)'),
})
.describe('枚举选项'),
}),
params: zod_1.z.object({
client_token: zod_1.z
.string()
.describe('用户若希望避免重试导致多次重复请求,可填写随机字符串,系统根据 client_token 是否一致来判断是否为同一请求')
.optional(),
}),
},
};
exports.corehrV1CompanyCreate = {
project: 'corehr',
name: 'corehr.v1.company.create',
sdkName: 'corehr.v1.company.create',
path: '/open-apis/corehr/v1/companies',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-组织管理-公司-创建公司-支持在单个接口中进行公司信息添加,包括公司基本信息、注册地址信息、工作地址信息等',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
hiberarchy_common: zod_1.z
.object({
parent_id: zod_1.z
.string()
.describe('上级公司ID,在创建场景下, 该字段必填,枚举值及详细信息可通过接口查询获得')
.optional(),
name: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('名称信息的语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('名称信息的内容,支持中文和英文'),
}))
.describe('公司名称- 名称不能包含「/」「;」「;」字符。- xx中英文名称会有全局唯一校验'),
active: zod_1.z.boolean().describe('是否启用该公司'),
effective_time: zod_1.z
.string()
.describe('版本生效日期- 填写格式:YYYY-MM-DD 00:00:00(系统会自动将时分秒改为00:00:00)- 系统默认为填写日期当天的 00:00:00 生效 - 该接口只支持到最小单位为日- 日期范围要求:1900-01-01 00:00:00~9999-12-31 23:59:59')
.optional(),
code: zod_1.z
.string()
.describe('公司编码 (不能与其他记录的编码重复)- 开启自动编码时,如果不传值会自动生成编码,否则以传入值为准- 未开启自动编码时,不传值不会自动生成编码')
.optional(),
description: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('名称信息的语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('名称信息的内容,支持中文和英文'),
}))
.describe('描述')
.optional(),
custom_fields: zod_1.z
.array(zod_1.z.object({
field_name: zod_1.z.string().describe('自定义字段 API Name,即自定义字段的唯一标识'),
value: zod_1.z
.string()
.describe('字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", [\\"id1\\",\\"id2\\"], "2006-01-02 15:04:05")'),
}))
.describe('自定义字段(该功能暂不支持)')
.optional(),
})
.describe('公司基本信息,该结构维护了公司的名称、编码、启用状态、上级公司等基础信息'),
type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('公司性质,通过查询获取。请求参数:object_api_name=company;custom_api_name=type')
.optional(),
industry_list: zod_1.z
.array(zod_1.z.object({ enum_name: zod_1.z.string().describe('枚举值') }))
.describe('所在行业,通过查询获取。请求参数:object_api_name=company;custom_api_name=industry')
.optional(),
legal_representative: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('名称信息的语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('名称信息的内容,支持中文和英文'),
}))
.describe('法定代表人。仅注册地址中的 国家 / 地区为中国大陆时,法人字段填入才有效。若注册地址中的 国家 / 地区 不为中国大陆时,则填入法人字段无效')
.optional(),
post_code: zod_1.z.string().describe('邮编').optional(),
tax_payer_id: zod_1.z.string().describe('纳税人识别号').optional(),
confidential: zod_1.z.boolean().describe('是否保密,该功能暂不支持,可以忽略').optional(),
sub_type_list: zod_1.z
.array(zod_1.z.object({ enum_name: zod_1.z.string().describe('枚举值') }))
.describe('公司主体类型,通过查询获取。请求参数:object_api_name=company;custom_api_name=subtype')
.optional(),
branch_company: zod_1.z.boolean().describe('是否为分公司').optional(),
primary_manager: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('名称信息的语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('名称信息的内容,支持中文和英文'),
}))
.describe('主要负责人')
.optional(),
custom_fields: zod_1.z
.array(zod_1.z.object({
field_name: zod_1.z.string().describe('字段名'),
value: zod_1.z
.string()
.describe('字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", [\\"id1\\",\\"id2\\"], "2006-01-02 15:04:05")'),
}))
.describe('自定义字段(暂时不支持该功能)')
.optional(),
currency: zod_1.z
.object({
currency_name: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('内容,支持中文和英文'),
}))
.describe('货币名称')
.optional(),
numeric_code: zod_1.z
.number()
.describe('对应币种的指代代码,通过查询获取')
.optional(),
currency_alpha_3_code: zod_1.z
.string()
.describe('法定货币对应代码,如CNY、USD等,通过查询获取')
.optional(),
})
.describe('默认币种')
.optional(),
phone: zod_1.z
.object({
area_code: zod_1.z
.object({ enum_name: zod_1.z.string().describe('区号对应名称') })
.describe('区号对应的数字,可通过查询获取。请求参数:object_api_name=phone;custom_api_name=international_area_code'),
phone_number: zod_1.z.string().describe('号码'),
})
.describe('电话')
.optional(),
fax: zod_1.z
.object({
area_code: zod_1.z
.object({ enum_name: zod_1.z.string().describe('区号对应的名称') })
.describe('区号对应的数字,可通过查询获取。请求参数:object_api_name=phone;custom_api_name=international_area_code'),
phone_number: zod_1.z.string().describe('号码'),
})
.describe('传真')
.optional(),
registered_office_address_info: zod_1.z
.object({
country_region_id: zod_1.z
.string()
.describe('国家 / 地区id。各国家/地区填写字段可参考查询。国家/地区id可通过查询获取'),
region_id: zod_1.z
.string()
.describe('主要行政区id。可通过查询获取')
.optional(),
city_id: zod_1.z
.string()
.describe('城市id,可通过查询获取')
.optional(),
distinct_id: zod_1.z
.string()
.describe('区/县id,可通过查询获取')
.optional(),
address_line1: zod_1.z.string().describe('地址行 1').optional(),
address_line2: zod_1.z.string().describe('地址行 2').optional(),
address_line3: zod_1.z.string().describe('地址行 3').optional(),
address_line4: zod_1.z.string().describe('地址行 4').optional(),
address_line5: zod_1.z.string().describe('地址行 5').optional(),
address_line6: zod_1.z.string().describe('地址行 6').optional(),
address_line7: zod_1.z.string().describe('地址行 7').optional(),
address_line8: zod_1.z.string().describe('地址行 8').optional(),
address_line9: zod_1.z.string().describe('地址行 9').optional(),
local_address_line1: zod_1.z.string().describe('地址行 1(非拉丁语系的本地文字)').optional(),
local_address_line2: zod_1.z.string().describe('地址行 2(非拉丁语系的本地文字)').optional(),
local_address_line3: zod_1.z.string().describe('地址行 3(非拉丁语系的本地文字)').optional(),
local_address_line4: zod_1.z.string().describe('地址行 4(非拉丁语系的本地文字)').optional(),
local_address_line5: zod_1.z.string().describe('地址行 5(非拉丁语系的本地文字)').optional(),
local_address_line6: zod_1.z.string().describe('地址行 6(非拉丁语系的本地文字)').optional(),
local_address_line7: zod_1.z.string().describe('地址行 7(非拉丁语系的本地文字)').optional(),
local_address_line8: zod_1.z.string().describe('地址行 8(非拉丁语系的本地文字)').optional(),
local_address_line9: zod_1.z.string().describe('地址行 9(非拉丁语系的本地文字)').optional(),
postal_code: zod_1.z.string().describe('邮政编码').optional(),
})
.describe('注册地址详细信息,该字段在OpenAPI为非必填字段,在页面管理端为必填字段。如果此处不填写该字段,可通过页面管理端补齐该字段')
.optional(),
office_address_info: zod_1.z
.object({
country_region_id: zod_1.z
.string()
.describe('国家 / 地区id。各国家/地区填写字段可参考查询。国家/地区id可通过查询获取'),
region_id: zod_1.z
.string()
.describe('主要行政区id。可通过查询获取')
.optional(),
city_id: zod_1.z
.string()
.describe('城市id,可通过查询获取')
.optional(),
distinct_id: zod_1.z
.string()
.describe('区/县id,可通过查询获取')
.optional(),
address_line1: zod_1.z.string().describe('地址行 1').optional(),
address_line2: zod_1.z.string().describe('地址行 2').optional(),
address_line3: zod_1.z.string().describe('地址行 3').optional(),
address_line4: zod_1.z.string().describe('地址行 4').optional(),
address_line5: zod_1.z.string().describe('地址行 5').optional(),
address_line6: zod_1.z.string().describe('地址行 6').optional(),
address_line7: zod_1.z.string().describe('地址行 7').optional(),
address_line8: zod_1.z.string().describe('地址行 8').optional(),
address_line9: zod_1.z.string().describe('地址行 9').optional(),
local_address_line1: zod_1.z.string().describe('地址行 1(非拉丁语系的本地文字)').optional(),
local_address_line2: zod_1.z.string().describe('地址行 2(非拉丁语系的本地文字)').optional(),
local_address_line3: zod_1.z.string().describe('地址行 3(非拉丁语系的本地文字)').optional(),
local_address_line4: zod_1.z.string().describe('地址行 4(非拉丁语系的本地文字)').optional(),
local_address_line5: zod_1.z.string().describe('地址行 5(非拉丁语系的本地文字)').optional(),
local_address_line6: zod_1.z.string().describe('地址行 6(非拉丁语系的本地文字)').optional(),
local_address_line7: zod_1.z.string().describe('地址行 7(非拉丁语系的本地文字)').optional(),
local_address_line8: zod_1.z.string().describe('地址行 8(非拉丁语系的本地文字)').optional(),
local_address_line9: zod_1.z.string().describe('地址行 9(非拉丁语系的本地文字)').optional(),
postal_code: zod_1.z.string().describe('邮政编码').optional(),
})
.describe('办公地址详细信息,该字段在OpenAPI为非必填字段,在页面管理端为必填字段。若此处不填写该字段,可通过页面管理端补齐该字段')
.optional(),
}),
params: zod_1.z.object({
client_token: zod_1.z
.string()
.describe('操作的唯一标识,用于幂等的进行更新操作,根据client_token是否一致来判断是否为同一请求。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作')
.optional(),
}),
},
};
exports.corehrV1CompanyDelete = {
project: 'corehr',
name: 'corehr.v1.company.delete',
sdkName: 'corehr.v1.company.delete',
path: '/open-apis/corehr/v1/companies/:company_id',
httpMethod: 'DELETE',
description: '[Feishu/Lark]-飞书人事(企业版)-组织管理-公司-删除公司-删除公司',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({
company_id: zod_1.z
.string()
.describe('需要删除的公司ID。ID获取方式:- 调用等接口可以返回部门ID'),
}),
},
};
exports.corehrV1CompanyGet = {
project: 'corehr',
name: 'corehr.v1.company.get',
sdkName: 'corehr.v1.company.get',
path: '/open-apis/corehr/v1/companies/:company_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-飞书人事(企业版)-组织管理-公司-查询单个公司-根据 ID 查询单个公司',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({
company_id: zod_1.z
.string()
.describe('需要查询的公司ID。ID获取方式:- 调用等接口可以返回部门ID'),
}),
},
};
exports.corehrV1CompanyList = {
project: 'corehr',
name: 'corehr.v1.company.list',
sdkName: 'corehr.v1.company.list',
path: '/open-apis/corehr/v1/companies',
httpMethod: 'GET',
description: '[Feishu/Lark]-飞书人事(企业版)-组织管理-公司-批量查询公司-分页查询公司,可分页遍历全量公司数据',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.string().describe('分页大小'),
}),
},
};
exports.corehrV1CompanyPatch = {
project: 'corehr',
name: 'corehr.v1.company.patch',
sdkName: 'corehr.v1.company.patch',
path: '/open-apis/corehr/v1/companies/:company_id',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-飞书人事(企业版)-组织管理-公司-更新公司-更新公司信息,包括基本信息、注册地址、办公地址等',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
hiberarchy_common: zod_1.z
.object({
parent_id: zod_1.z.string().describe('上级组织').optional(),
name: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('内容,支持中文和英文'),
}))
.describe('公司名称- 名称不能包含「/」「;」「;」字符。- 公司中英文名称会有全局唯一校验')
.optional(),
active: zod_1.z.boolean().describe('是否启用该公司').optional(),
effective_time: zod_1.z
.string()
.describe('版本生效日期- 填写格式:YYYY-MM-DD 00:00:00(系统会自动将时分秒改为00:00:00)- 系统默认为填写日期当天的 00:00:00 生效 - 该接口只支持到最小单位为日- 日期范围要求:1900-01-01 00:00:00~9999-12-31 23:59:59'),
code: zod_1.z.string().describe('公司编码 (不能与其他记录的编码重复),如果不传值则不更新').optional(),
description: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('内容,支持中文和英文'),
}))
.describe('描述')
.optional(),
})
.describe('组织实体公共字段,包括名称、描述、上级、启停用状态、生效日期、编码等基础信息')
.optional(),
type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('公司性质,通过查询获取。请求参数:object_api_name=company;custom_api_name=type')
.optional(),
industry_list: zod_1.z
.array(zod_1.z.object({ enum_name: zod_1.z.string().describe('枚举值') }))
.describe('所在行业,通过查询获取。请求参数:object_api_name=company;custom_api_name=industry')
.optional(),
legal_representative: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('内容,支持中文和英文'),
}))
.describe('法定代表人。仅注册地址中的 国家 / 地区 为中国大陆时,法人字段填入才有效。若注册地址中的 国家 / 地区 不为中国大陆时,则填入法人字段无效')
.optional(),
post_code: zod_1.z.string().describe('邮编').optional(),
tax_payer_id: zod_1.z.string().describe('纳税人识别号').optional(),
confidential: zod_1.z.boolean().describe('是否保密,该功能暂不支持,可以忽略').optional(),
sub_type_list: zod_1.z
.array(zod_1.z.object({ enum_name: zod_1.z.string().describe('枚举值') }))
.describe('公司主体类型,通过查询获取。请求参数:object_api_name=company;custom_api_name=subtype')
.optional(),
branch_company: zod_1.z.boolean().describe('是否为分公司').optional(),
primary_manager: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('内容,支持中文和英文'),
}))
.describe('主要负责人')
.optional(),
currency: zod_1.z
.object({
currency_name: zod_1.z
.array(zod_1.z.object({
lang: zod_1.z.string().describe('语言,支持中文和英文。中文用zh-CN;英文用en-US'),
value: zod_1.z.string().describe('内容,支持中文和英文'),
}))
.describe('货币名称')
.optional(),
numeric_code: zod_1.z
.number()
.describe('对应币种的指代代码,通过系统内部查找,通过查询获取')
.optional(),
currency_alpha_3_code: zod_1.z
.string()
.describe('法定货币对应代码,如CNY 、USD等.通过查询获取')
.optional(),
})
.describe('默认币种')
.optional(),
phone: zod_1.z
.object({
area_code: zod_1.z
.object({ enum_name: zod_1.z.string().describe('区号对应名称') })
.describe('区号对应的数字,可通过查询获取。请求参数:object_api_name=phone;custom_api_name=international_area_code'),
phone_number: zod_1.z.string().describe('号码'),
})
.describe('电话')
.optional(),
fax: zod_1.z
.object({
area_code: zod_1.z
.object({ enum_name: zod_1.z.string().describe('区号对应的名称') })
.describe('区号对应的数字,可通过查询获取。请求参数:object_api_name=phone;custom_api_name=international_area_code'),
phone_number: zod_1.z.string().describe('号码'),
})
.describe('传真')
.optional(),
registered_office_address_info: zod_1.z
.object({
country_region_id: zod_1.z
.string()
.describe('国家 / 地区 ID。各国家/地区填写字段可参考查询。可通过查询获取'),
region_id: zod_1.z
.string()
.describe('主要行政区ID.可通过查询获取')
.optional(),
city_id: zod_1.z
.string()
.describe('城市ID.可通过查询获取')
.optional(),
distinct_id: zod_1.z
.string()
.describe('区/县ID.可通过查询获取')
.optional(),
address_line1: zod_1.z.string().describe('地址行 1').optional(),
address_line2: zod_1.z.string().describe('地址行 2').optional(),
address_line3: zod_1.z.string().describe('地址行 3').optional(),
address_line4: zod_1.z.string().describe('地址行 4').optional(),
address_line5: zod_1.z.string().describe('地址行 5').optional(),
address_line6: zod_1.z.string().describe('地址行 6').optional(),
address_line7: zod_1.z.string().describe('地址行 7').optional(),
address_line8: zod_1.z.string().describe('地址行 8').optional(),
address_line9: zod_1.z.string().describe('地址行 9').optional(),
local_address_line1: zod_1.z.string().describe('地址行 1(非拉丁语系的本地文字)').optional(),
local_address_line2: zod_1.z.string().describe('地址行 2(非拉丁语系的本地文字)').optional(),
local_address_line3: zod_1.z.string().describe('地址行 3(非拉丁语系的本地文字)').optional(),
local_address_line4: zod_1.z.string().describe('地址行 4(非拉丁语系的本地文字)').optional(),
local_address_line5: zod_1.z.string().describe('地址行 5(非拉丁语系的本地文字)').optional(),
local_address_line6: zod_1.z.string().describe('地址行 6(非拉丁语系的本地文字)').optional(),
local_address_line7: zod_1.z.string().describe('地址行 7(非拉丁语系的本地文字)').optional(),
local_address_line8: zod_1.z.string().describe('地址行 8(非拉丁语系的本地文字)').optional(),
local_address_line9: zod_1.z.string().describe('地址行 9(非拉丁语系的本地文字)').optional(),
postal_code: zod_1.z.string().describe('邮政编码').optional(),
})
.describe('注册地址详细信息。公共字段,若请求对象为公司,则该字段必填')
.optional(),
office_address_info: zod_1.z
.object({
country_region_id: zod_1.z
.string()
.describe('国家 / 地区 ID。各国家/地区填写字段可参考查询.可通过查询获取'),
region_id: zod_1.z
.string()
.describe('主要行政区ID.可通过查询获取')
.optional(),
city_id: zod_1.z
.string()
.describe('城市ID.可通过查询获取')
.optional(),
distinct_id: zod_1.z
.string()
.describe('区/县ID.可通过查询获取')
.optional(),
address_line1: zod_1.z.string().describe('地址行 1').optional(),
address_line2: zod_1.z.string().describe('地址行 2').optional(),
address_line3: zod_1.z.string().describe('地址行 3').optional(),
address_line4: zod_1.z.string().describe('地址行 4').optional(),
address_line5: zod_1.z.string().describe('地址行 5').optional(),
address_line6: zod_1.z.string().describe('地址行 6').optional(),
address_line7: zod_1.z.string().describe('地址行 7').optional(),
address_line8: zod_1.z.string().describe('地址行 8').optional(),
address_line9: zod_1.z.string().describe('地址行 9').optional(),
local_address_line1: zod_1.z.string().describe('地址行 1(非拉丁语系的本地文字)').optional(),
local_address_line2: zod_1.z.string().describe('地址行 2(非拉丁语系的本地文字)').optional(),
local_address_line3: zod_1.z.string().describe('地址行 3(非拉丁语系的本地文字)').optional(),
local_address_line4: zod_1.z.string().describe('地址行 4(非拉丁语系的本地文字)').optional(),
local_address_line5: zod_1.z.string().describe('地址行 5(非拉丁语系的本地文字)').optional(),
local_address_line6: zod_1.z.string().describe('地址行 6(非拉丁语系的本地文字)').optional(),
local_address_line7: zod_1.z.string().describe('地址行 7(非拉丁语系的本地文字)').optional(),
local_address_line8: zod_1.z.string().describe('地址行 8(非拉丁语系的本地文字)').optional(),
local_address_line9: zod_1.z.string().describe('地址行 9(非拉丁语系的本地文字)').optional(),
postal_code: zod_1.z.string().describe('邮政编码').optional(),
})
.describe('办公地址详细信息。公共字段,若请求对象为公司,则该字段必填')
.optional(),
}),
params: zod_1.z.object({ client_token: zod_1.z.string().describe('根据client_token是否一致来判断是否为同一请求').optional() }),
path: zod_1.z.object({
company_id: zod_1.z
.string()
.describe('需要更新的公司 ID。ID获取方式:- 调用等接口可以返回部门ID'),
}),
useUAT: zod_1.z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
exports.corehrV1CompensationStandardMatch = {
project: 'corehr',
name: 'corehr.v1.compensationStandard.match',
sdkName: 'corehr.v1.compensationStandard.match',
path: '/open-apis/corehr/v1/compensation_standards/match',
httpMethod: 'GET',
description: '[Feishu/Lark]-飞书人事(企业版)-基础薪酬-薪资标准-获取员工薪资标准-- 调用此接口来获取员工匹配的薪资标准信息- 请求时,可选传递员工的部门 ID、职级 ID 、序列 ID 等筛选条件,用于匹配薪资标准- 此接口将返回员工可匹配到的薪资标准全部信息,包括薪资标准表 ID、薪级薪等、薪资带宽、薪资标准值等',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id', 'people_corehr_id']).describe('用户ID类型').optional(),
department_id_type: zod_1.z
.enum(['open_department_id', 'department_id', 'people_corehr_department_id'])
.describe('此次调用中使用的部门 ID 类型,传入部门ID时传入 Options:open_department_id(【飞书】用来在具体某个应用中标识一个部门,同一个department_id 在不同应用中的 open_department_id 相同。),department_id(【飞书】用来标识租户内一个唯一的部门。),people_corehr_department_id(【飞书人事】用来标识「飞书人事」中的部门。)')
.optional(),
employment_id: zod_1.z
.string()
.describe('雇员ID,可通过接口获取'),
reference_object_api: zod_1.z
.enum(['cpst_item', 'cpst_indicator'])
.describe('薪资标准的关联对象,项目或者指标 Options:cpst_item(薪资项目),cpst_indicator(薪资统计指标)')
.optional(),
reference_object_id: zod_1.z
.string()
.describe('薪资标准表关联对象ID,即薪资项目/统计指标ID,可通过接口、获取'),
department_id: zod_1.z
.string()
.describe('部门ID,可通过接口获取')
.optional(),
work_location_id: zod_1.z
.string()
.describe('工作地点ID,可通过接口获取')
.optional(),
company_id: zod_1.z
.string()
.describe('公司ID,可通过接口获取')
.optional(),
job_family_id: zod_1.z
.string()
.describe('职务序列ID,可通过接口获取')
.optional(),
job_level_id: zod_1.z
.string()
.describe('职级ID,可通过接口获取')
.optional(),
employee_type_id: zod_1.z
.string()
.describe('人员类型ID,可通过接口获取')
.optional(),
recruitment_type: zod_1.z
.enum(['experienced_professionals', 'recent_graduates', 'routine_intern'])
.describe('招聘类型 Options:experienced_professionals(社招),recent_graduates(校招),routine_intern(日常实习)')
.optional(),
cpst_change_reason_id: zod_1.z
.string()
.describe('定调薪原因ID,可通过接口获取')
.optional(),
cpst_plan_id: zod_1.z
.string()
.describe('薪资方案ID,可通过接口获取')
.optional(),
cpst_salary_level_id: zod_1.z.string().describe('薪级薪等ID').optional(),
effective_time: zod_1.z.string().describe('生效时间(毫秒级时间戳)').optional(),
}),
},
};
exports.corehrV1ContractCreate = {
project: 'corehr',
name: 'corehr.v1.contract.create',
sdkName: 'corehr.v1.contract.create',
path: '/open-apis/corehr/v1/contracts',
httpMethod: 'POST',
description: '[Feishu/Lark]-飞书人事(企业版)-合同-新建合同-通过本接口可以为员工创建一份新合同',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
effective_time: zod_1.z.string().describe('合同开始日期,格式:"YYYY-MM-DD HH-mm-ss"'),
expiration_time: zod_1.z.string().describe('实际结束日期,格式:"YYYY-MM-DD HH-mm-ss"').optional(),
employment_id: zod_1.z
.string()
.describe('雇佣 ID,详细信息可通过接口查询获得'),
contract_type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('合同类型,枚举值可查询接口获取,按如下参数查询即可:- object_api_name:contract- custom_api_name:contract_type'),
first_party_company_id: zod_1.z
.string()
.describe('合同签约公司, 引用的公司ID,详细信息可通过接口查询获得'),
person_id: zod_1.z
.string()
.describe('合同签约人ID,详细信息可通过接口查询获得')
.optional(),
custom_fields: zod_1.z
.array(zod_1.z.object({
field_name: zod_1.z.string().describe('字段名'),
value: zod_1.z
.string()
.describe('字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", [\\"id1\\",\\"id2\\"], "2006-01-02 15:04:05")'),
}))
.describe('自定义字段,预留字段,暂时不支持')
.optional(),
duration_type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('期限类型,枚举值可通过文档合同期限类型(duration_type)枚举定义部分获得')
.optional(),
contract_end_date: zod_1.z.string().describe('合同结束日期,格式:"YYYY-MM-DD"').optional(),
contract_number: zod_1.z.string().describe('合同编号').optional(),
signing_type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('签订类型,枚举值可通过文档签订类型(signing_type)枚举定义部分获得')
.optional(),
}),
params: zod_1.z.object({
client_token: zod_1.z.string().describe('自定义值,根据client_token是否一致来判断是否为同一请求').optional(),
}),
},
};
exports.corehrV1ContractDelete = {
project: 'corehr',
name: 'corehr.v1.contract.delete',
sdkName: 'corehr.v1.contract.delete',
path: '/open-apis/corehr/v1/contracts/:contract_id',
httpMethod: 'DELETE',
description: '[Feishu/Lark]-飞书人事(企业版)-合同-删除合同-通过本接口可以删除合同数据,删除后即无法查询到',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({
contract_id: zod_1.z
.string()
.describe('需要删除的合同 ID,该ID可以通过接口获取'),
}),
},
};
exports.corehrV1ContractGet = {
project: 'corehr',
name: 'corehr.v1.contract.get',
sdkName: 'corehr.v1.contract.get',
path: '/open-apis/corehr/v1/contracts/:contract_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-飞书人事(企业版)-合同-查询单个合同-该接口用于根据合同 ID 查询单个合同详细信息,包括合同开始日期、结束日期、公司主体等信息',
accessTokens: ['tenant'],
schema: {
path: zod_1.z.object({
contract_id: zod_1.z
.string()
.describe('合同ID,该ID可以通过接口获取'),
}),
},
};
exports.corehrV1ContractList = {
project: 'corehr',
name: 'corehr.v1.contract.list',
sdkName: 'corehr.v1.contract.list',
path: '/open-apis/corehr/v1/contracts',
httpMethod: 'GET',
description: '[Feishu/Lark]-飞书人事(企业版)-合同-批量查询合同-通过接口可以批量查询合同列表信息,目前暂不支持其他筛选条件且一次查询最多支持50条数据',
accessTokens: ['tenant'],
schema: {
params: zod_1.z.object({
page_token: zod_1.z
.string()
.describe('分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果')
.optional(),
page_size: zod_1.z.string().describe('分页大小;范围:0~50'),
}),
},
};
exports.corehrV1ContractPatch = {
project: 'corehr',
name: 'corehr.v1.contract.patch',
sdkName: 'corehr.v1.contract.patch',
path: '/open-apis/corehr/v1/contracts/:contract_id',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-飞书人事(企业版)-合同-更新合同-通过该接口可以更新员工合同相关信息,没有修改的参数会保留原值',
accessTokens: ['tenant'],
schema: {
data: zod_1.z.object({
effective_time: zod_1.z.string().describe('合同开始日期').optional(),
expiration_time: zod_1.z.string().describe('合同实际结束日期,合同实际结束日期小于等于合同结束日期').optional(),
employment_id: zod_1.z.string().describe('该接口不能传递该参数,否则会更新失败').optional(),
contract_type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('合同类型,枚举值可通过文档合同类型(contract_type)枚举定义部分获得')
.optional(),
first_party_company_id: zod_1.z
.string()
.describe('甲方, 引用Company的ID,详细信息可通过接口查询获得')
.optional(),
person_id: zod_1.z.string().describe('该接口不能传递该参数,否则会更新失败').optional(),
custom_fields: zod_1.z
.array(zod_1.z.object({
field_name: zod_1.z.string().describe('字段名'),
value: zod_1.z
.string()
.describe('字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", [\\"id1\\",\\"id2\\"], "2006-01-02 15:04:05")'),
}))
.describe('自定义字段,预留,暂时不支持')
.optional(),
duration_type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('期限类型,枚举值可通过文档合同期限类型(duration_type)枚举定义部分获得')
.optional(),
contract_end_date: zod_1.z.string().describe('合同预计的结束日期').optional(),
contract_number: zod_1.z.string().describe('合同编号').optional(),
signing_type: zod_1.z
.object({ enum_name: zod_1.z.string().describe('枚举值') })
.describe('签订类型,枚举值可通过文档签订类型(signing_type)枚举定义部分获得')
.optional(),
}),
params: zod_1.z.object({
client_token: zod_1.z.string().describe('自定义值,根据client_token是否一致来判断是否为同一请求').optional(),