import {z} from 'zod' export type GetApiApiV1CompensationTotalRewardsEmployeeIdStatementArgs = {employeeId: string}; export type GetApiApiV1CompensationTotalRewardsEmployeeIdStatementOptions = {baseUrl?: string | undefined, oauth?: string | undefined, fetch?: typeof fetch | undefined}; export const totalRewardsOverviewSectionValues = z.object({estimatedTotalCompValue: z.string().nullable().optional(), paidPer: z.string().nullable().optional(), multiplierValue: z.number().nullable().optional()}); export const totalRewardsCompSummaryValues = z.object({title: z.string().optional(), subtitle: z.string().nullable().optional(), value: z.string().nullable().optional(), subvalue: z.string().nullable().optional()}); export const totalRewardsTimelineItem = z.object({value: z.string().nullable().optional(), subvalue: z.string().nullable().optional(), label: z.union([z.string(), z.array(z.string())]).optional()}); export const totalRewardsTimelineSectionValues = z.object({compSummary: totalRewardsCompSummaryValues.optional(), timelineData: z.array(totalRewardsTimelineItem).optional(), placeholderText: z.string().nullable().optional()}); export const totalRewardsBenefitDetailsValues = z.object({name: z.string().optional(), companyContributionAmount: z.string().optional(), companyContributionSubvalue: z.string().nullable().optional(), summary: z.string().nullable().optional(), url: z.string().nullable().optional(), benefitModalValuesLink: z.string().nullable().optional()}); export const totalRewardsBenefitSectionValues = z.object({compSummary: totalRewardsCompSummaryValues.optional(), benefitDetails: z.array(totalRewardsBenefitDetailsValues).optional()}); export const totalRewardsEquityGrowthChartItem = z.object({label: z.string().optional(), estimatedNetValue: z.string().optional(), subvalue: z.string().nullable().optional(), vested: z.number().nullable().optional(), current: z.number().nullable().optional(), unvested: z.number().nullable().optional()}); export const totalRewardsEquityDetailsValues = z.object({cliffMonths: z.number().int().nullable().optional(), estimatedExerciseCost: z.string().nullable().optional(), estimatedExerciseCostSubvalue: z.string().nullable().optional(), estimatedSharePrice: z.string().optional(), estimatedSharePriceSubvalue: z.string().nullable().optional(), estimatedTotalValue: z.string().optional(), estimatedTotalValueSubvalue: z.string().nullable().optional(), grantDate: z.string().optional(), grantType: z.string().optional(), grantName: z.string().nullable().optional(), equityGrowthChartData: z.array(totalRewardsEquityGrowthChartItem).nullable().optional(), numShares: z.number().int().optional(), numVestedShares: z.number().int().optional(), percentVested: z.number().optional(), strikePrice: z.string().nullable().optional(), strikePriceSubvalue: z.string().nullable().optional(), vestingMonths: z.number().int().nullable().optional(), vestingSchedule: z.string().optional(), vestingStartDate: z.string().optional(), vestedValue: z.string().optional(), vestedValueSubvalue: z.string().nullable().optional()}); export const totalRewardsEquityGrowthEstimation = z.object({stop: z.number().int().optional(), companyValuation: z.string().optional(), companyValuationSubvalue: z.string().nullable().optional(), totalValue: z.string().optional(), totalValueSubvalue: z.string().nullable().optional(), vestedValue: z.string().optional(), vestedValueSubvalue: z.string().nullable().optional()}); export const totalRewardsEquityEstimatedValuationValues = z.object({equityGrowthEstimationItems: z.array(totalRewardsEquityGrowthEstimation).optional(), numberOfVestedShares: z.number().int().optional(), numberOfTotalShares: z.number().int().optional(), equityGrowthSliderMax: z.number().int().nullable().optional(), equityGrowthSliderMin: z.number().int().nullable().optional()}); export const totalRewardsEquitySectionValues = z.object({compSummary: totalRewardsCompSummaryValues.optional(), conditions: z.string().nullable().optional(), disclaimers: z.string().nullable().optional(), equityDetails: z.array(totalRewardsEquityDetailsValues).optional(), equityEstimatedValuation: totalRewardsEquityEstimatedValuationValues.optional()}); export const totalRewardsHolidayValue = z.object({title: z.string().optional(), startDate: z.string().optional(), endDate: z.string().nullable().optional()}); export const totalRewardsTimeOffPolicyValue = z.object({title: z.string().optional(), value: z.string().optional(), showDisclaimer: z.boolean().nullable().optional(), showEligible: z.boolean().nullable().optional()}); export const totalRewardsCalendarSectionValues = z.object({holidays: z.array(totalRewardsHolidayValue).optional(), timeOffPolicies: z.array(totalRewardsTimeOffPolicyValue).optional(), hourlyAccrualDisclaimer: z.string().nullable().optional()}); export const totalRewardsExtraPayDetailsValues = z.object({name: z.string().optional(), amount: z.string().optional(), amountSubvalue: z.string().nullable().optional(), frequency: z.string().optional(), formattedDateString: z.string().optional(), annualizedAmount: z.string().optional(), annualizedSubvalue: z.string().nullable().optional()}); export const totalRewardsExtraPaySectionValues = z.object({title: z.string().optional(), compSummary: totalRewardsCompSummaryValues.optional(), extraPayDetails: z.array(totalRewardsExtraPayDetailsValues).optional()}); export const totalRewardsCustomDisclaimerInfo = z.object({isViewerAdmin: z.boolean().optional(), customDisclaimer: z.string().nullable().optional()}); export const totalRewardsEmployeeStatement = z.object({employeeId: z.string().nullable().optional(), employeeName: z.string().optional(), jobTitle: z.string().nullable().optional(), hasMixedCurrencyTypes: z.boolean().nullable().optional(), overviewSection: totalRewardsOverviewSectionValues.optional(), paySection: totalRewardsTimelineSectionValues.optional(), bonusSection: totalRewardsTimelineSectionValues.optional(), commissionSection: totalRewardsTimelineSectionValues.optional(), benefitSection: totalRewardsBenefitSectionValues.optional(), equitySection: totalRewardsEquitySectionValues.optional(), calendarSection: totalRewardsCalendarSectionValues.optional(), extraPaySection: totalRewardsExtraPaySectionValues.optional(), customDisclaimerInfo: totalRewardsCustomDisclaimerInfo.optional(), companyName: z.string().nullable().optional(), companyLogoUrl: z.string().nullable().optional(), statementYear: z.number().int().nullable().optional(), minStatementYear: z.number().int().nullable().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get Total Rewards Statement * * GET /api/v1/compensation/total_rewards/{employeeId}/statement */ export const getApiApiV1CompensationTotalRewardsEmployeeIdStatement = async (args: GetApiApiV1CompensationTotalRewardsEmployeeIdStatementArgs, options?: GetApiApiV1CompensationTotalRewardsEmployeeIdStatementOptions) => { const {baseUrl = "https://companySubDomain.bamboohr.com", fetch: fetchFn = fetch, oauth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (oauth !== undefined) headers.set('authorization', `Bearer ${oauth}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/compensation/total_rewards/${encodeURIComponent(String(args.employeeId))}/statement${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(totalRewardsEmployeeStatement, await res.json()) };