import {z} from 'zod' export type UpdateApiV1CompaniesCompanyIdPayrollsPayrollIdPrepareArgs = {'X-Gusto-API-Version'?: '2026-06-15' | undefined, company_id: string, payroll_id: string, page?: number | undefined, per?: number | undefined, sort_by?: string | undefined, body: {employee_uuids?: (Array | null) | undefined}}; export type UpdateApiV1CompaniesCompanyIdPayrollsPayrollIdPrepareOptions = {baseUrl?: string | undefined, CompanyAccessAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const payrollDeadlineType = z.string(); export const payrollCheckDateType = z.string(); export const payrollProcessedType = z.boolean(); export const payrollProcessedDateType = z.string().nullable(); export const payrollCalculatedAtType = z.string().nullable(); export const payrollPayrollUuidType = z.string(); export const payrollCompanyUuidType = z.string(); export const payrollOffCycleType = z.boolean(); export const offCycleReasonType = z.enum(["Adhoc", "Benefit reversal", "Bonus", "Correction", "Dismissed employee", "Hired employee", "Wage correction", "Tax reconciliation", "Reversal", "Disability insurance distribution", "Transition from old pay schedule"]).nullable(); export const autoPilotType = z.boolean(); export const payrollExternalType = z.boolean(); export const payrollFinalTerminationPayrollType = z.boolean(); export const payrollWithholdingPayPeriodType = z.enum(["Every week", "Every other week", "Twice per month", "Monthly", "Quarterly", "Semiannually", "Annually"]).nullable(); export const payrollSkipRegularDeductionsType = z.boolean().nullable(); export const payrollFixedWithholdingRateType = z.boolean().nullable(); export const payrollPayPeriodType = z.object({start_date: z.string().nullable().optional(), end_date: z.string().nullable().optional(), pay_schedule_uuid: z.string().nullable().optional()}); export const payrollPayrollStatusMetaType = z.object({cancellable: z.boolean().optional(), expected_check_date: z.string().optional(), initial_check_date: z.string().nullable().optional(), expected_debit_time: z.string().optional(), payroll_late: z.boolean().nullable().optional(), initial_debit_cutoff_time: z.string().optional()}); export const payrollEmployeeCompensationsType = z.object({employee_uuid: z.string().optional(), excluded: z.boolean().optional(), first_name: z.string().nullable().optional(), preferred_first_name: z.string().nullable().optional(), last_name: z.string().nullable().optional(), gross_pay: z.string().nullable().optional(), net_pay: z.string().nullable().optional(), check_amount: z.string().nullable().optional(), payment_method: z.enum(["Direct Deposit", "Check", "Historical"]).nullable().optional(), memo: z.string().nullable().optional(), fixed_compensations: z.array(z.object({name: z.string().optional(), amount: z.string().optional(), job_uuid: z.string().optional(), breakdowns: z.array(z.object({start_date: z.string().optional(), end_date: z.string().optional(), amount: z.string().optional()})).optional()})).optional(), hourly_compensations: z.array(z.object({name: z.string().optional(), hours: z.string().optional(), amount: z.string().optional(), job_uuid: z.string().optional(), compensation_multiplier: z.number().optional(), flsa_status: z.string().optional(), breakdowns: z.array(z.object({start_date: z.string().optional(), end_date: z.string().optional(), hours: z.string().optional()})).optional()})).optional(), paid_time_off: z.array(z.object({name: z.string().optional(), hours: z.string().optional(), amount: z.string().nullable().optional(), final_payout_unused_hours_input: z.string().nullable().optional(), approved_request_hours: z.string().nullable().optional()})).optional(), reimbursements: z.array(z.object({amount: z.string(), description: z.string().nullable(), uuid: z.string().nullable().optional(), recurring: z.boolean().optional()})).optional(), custom_withholdings: z.object({federal: z.object({override_type: z.literal("one_time").optional(), amount: z.string().optional(), amount_type: z.enum(["fixed", "percent"]).optional()}).nullable().optional(), state: z.array(z.object({employee_state_field_uuid: z.string().optional(), override_type: z.literal("one_time").optional(), amount: z.string().optional(), amount_type: z.enum(["fixed", "percent"]).optional()})).optional()}).optional(), version: z.string().optional(), deductions: z.array(z.object({name: z.string().optional(), amount: z.number().optional(), amount_type: z.enum(["fixed", "percent"]).optional(), uuid: z.string().optional(), updatable_via_payroll: z.boolean().optional()})).optional()}); export const payrollPaymentSpeedChangedType = z.object({original_check_date: z.string().optional(), current_check_date: z.string().optional(), original_debit_date: z.string().optional(), current_debit_date: z.string().optional(), reason: z.string().optional()}); export const createdAtType = z.string(); export const payrollFixedCompensationTypesType = z.array(z.object({name: z.string().optional()})); export const metadataWithOneEntity = z.object({entity_type: z.string().optional(), entity_uuid: z.string().optional(), valid_from: z.string().nullable().optional(), valid_up_to: z.string().nullable().optional(), key: z.string().nullable().optional(), state: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const entityErrorObject = z.object({error_key: z.string(), category: z.string(), message: z.string().optional(), metadata: z.union([z.object({entities: z.array(metadataWithOneEntity)}), z.object({entity_type: z.string().optional(), entity_uuid: z.string().optional(), valid_from: z.string().nullable().optional(), valid_up_to: z.string().nullable().optional(), key: z.string().nullable().optional(), state: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown()))]).optional(), errors: z.array(z.object({error_key: z.string().optional(), category: z.string().optional(), message: z.string().optional(), metadata: z.object({}).optional()})).optional()}); export const payrollProcessingRequest = z.object({status: z.enum(["calculating", "calculate_success", "submitting", "submit_success", "processing_failed"]).optional(), errors: z.array(entityErrorObject).optional()}).nullable(); export const payrollPartnerOwnedDisbursementType = z.boolean().nullable(); export const payrollPrepared = z.object({payroll_deadline: payrollDeadlineType.optional(), check_date: payrollCheckDateType.optional(), processed: payrollProcessedType.optional(), processed_date: payrollProcessedDateType.optional(), calculated_at: payrollCalculatedAtType.optional(), uuid: payrollPayrollUuidType.optional(), payroll_uuid: payrollPayrollUuidType.optional(), company_uuid: payrollCompanyUuidType.optional(), off_cycle: payrollOffCycleType.optional(), off_cycle_reason: offCycleReasonType.optional(), auto_payroll: autoPilotType.optional(), external: payrollExternalType.optional(), final_termination_payroll: payrollFinalTerminationPayrollType.optional(), withholding_pay_period: payrollWithholdingPayPeriodType.optional(), skip_regular_deductions: payrollSkipRegularDeductionsType.optional(), fixed_withholding_rate: payrollFixedWithholdingRateType.optional(), pay_period: payrollPayPeriodType.optional(), workweeks: z.array(z.object({start_date: z.string().optional(), end_date: z.string().optional()})).nullable().optional(), payroll_status_meta: payrollPayrollStatusMetaType.optional(), employee_compensations: z.array(payrollEmployeeCompensationsType).optional(), payment_speed_changed: payrollPaymentSpeedChangedType.optional(), created_at: createdAtType.optional(), fixed_compensation_types: payrollFixedCompensationTypesType.optional(), processing_request: payrollProcessingRequest.optional(), partner_owned_disbursement: payrollPartnerOwnedDisbursementType.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 }; /** * Prepare a payroll for update * * PUT /v1/companies/{company_id}/payrolls/{payroll_id}/prepare */ export const updateApiV1CompaniesCompanyIdPayrollsPayrollIdPrepare = async (args: UpdateApiV1CompaniesCompanyIdPayrollsPayrollIdPrepareArgs, options?: UpdateApiV1CompaniesCompanyIdPayrollsPayrollIdPrepareOptions) => { const {baseUrl = "https://api.gusto-demo.com", fetch: fetchFn = fetch, CompanyAccessAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args['X-Gusto-API-Version'] != null) headers.set("X-Gusto-API-Version", String(args['X-Gusto-API-Version'])) if (args.page != null) query.append("page", String(args.page)) if (args.per != null) query.append("per", String(args.per)) if (args.sort_by != null) query.append("sort_by", String(args.sort_by)) if (CompanyAccessAuth !== undefined) headers.set('authorization', `Bearer ${CompanyAccessAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/companies/${encodeURIComponent(String(args.company_id))}/payrolls/${encodeURIComponent(String(args.payroll_id))}/prepare${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "PUT", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(payrollPrepared, await res.json()) };