import {z} from 'zod' export type GetApiApiV1CompensationBenchmarksDetailsArgs = {jobId: string, locationId?: string | undefined}; export type GetApiApiV1CompensationBenchmarksDetailsOptions = {baseUrl?: string | undefined, oauth?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiApiV1CompensationBenchmarksDetailsResponse = z.object({jobId: z.string().optional(), jobTitle: z.string().optional(), locationId: z.string().nullable().optional(), location: z.string().nullable().optional(), mercerBenchmarkDetails: z.object({id: z.string().optional(), source: z.string().optional(), jobCode: z.string().optional(), jobTitle: z.string().optional(), jobLocation: z.string().optional(), jobLevel: z.string().nullable().optional(), jobDescription: z.string().nullable().optional(), formattedJobDescription: z.array(z.string()).nullable().optional(), companiesSurveyed: z.number().int().nullable().optional(), employeesSurveyed: z.number().int().nullable().optional(), lastReviewed: z.string().nullable().optional(), values: z.object({median: z.number().optional(), min: z.number().optional(), max: z.number().optional(), currencyCode: z.string().optional(), originalMedian: z.number().nullable().optional(), originalMin: z.number().nullable().optional(), originalMax: z.number().nullable().optional(), originalCurrencyCode: z.string().nullable().optional(), description: z.string().nullable().optional()}).optional(), createdYmdt: z.string().nullable().optional(), updatedYmdt: z.string().nullable().optional(), dataYear: z.string().nullable().optional()}).nullable().optional(), companyPayRange: z.object({median: z.number().optional(), min: z.number().optional(), max: z.number().optional(), currencyCode: z.string().optional(), originalMedian: z.number().nullable().optional(), originalMin: z.number().nullable().optional(), originalMax: z.number().nullable().optional(), originalCurrencyCode: z.string().nullable().optional()}).nullable().optional(), internalJobPayBand: z.object({median: z.number().optional(), min: z.number().optional(), max: z.number().optional(), currencyCode: z.string().optional(), originalMedian: z.number().nullable().optional(), originalMin: z.number().nullable().optional(), originalMax: z.number().nullable().optional(), originalCurrencyCode: z.string().nullable().optional(), description: z.string().nullable().optional()}).nullable().optional(), benchmarkValues: z.array(z.object({id: z.number().int().optional(), jobTitle: z.string().nullable().optional(), lastEdited: z.string().nullable().optional(), sourceColorCode: z.string().nullable().optional(), sourceDate: z.string().nullable().optional(), createdYmdt: z.string().nullable().optional(), updatedYmdt: z.string().nullable().optional(), dataYear: z.string().nullable().optional(), median: z.number().optional(), min: z.number().optional(), max: z.number().optional(), currencyCode: z.string().optional()})).optional(), employees: z.array(z.object({id: z.number().int().optional(), name: z.string().optional(), jobTitle: z.object({id: z.string().optional(), value: z.string().optional(), jobTitle: z.string().optional()}).optional(), location: z.object({id: z.string().optional(), value: z.string().optional(), name: z.string().optional()}).nullable().optional(), salary: z.object({amount: z.number().optional(), currencyCode: z.string().optional()}).optional(), varianceFromPayBand: z.object({amount: z.number().optional(), currencyCode: z.string().optional()}).nullable().optional(), yearsAtCompany: z.number().int().optional(), rangePenetration: z.number().nullable().optional(), compaRatio: z.number().nullable().optional(), compaRatioStatus: z.string().nullable().optional(), photoUrl: z.string().optional(), country: z.string().nullable().optional(), isRemote: z.boolean().nullable().optional(), paidPer: z.string().optional(), currencyConversionFailed: z.boolean().optional(), annualizationFailed: z.boolean().optional()})).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 Compensation Benchmark Details * * GET /api/v1/compensation/benchmarks/details */ export const getApiApiV1CompensationBenchmarksDetails = async (args: GetApiApiV1CompensationBenchmarksDetailsArgs, options?: GetApiApiV1CompensationBenchmarksDetailsOptions) => { 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 (args.jobId != null) query.append("jobId", String(args.jobId)) if (args.locationId != null) query.append("locationId", String(args.locationId)) if (oauth !== undefined) headers.set('authorization', `Bearer ${oauth}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/compensation/benchmarks/details${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(getApiApiV1CompensationBenchmarksDetailsResponse, await res.json()) };