import {z} from 'zod' export type GetApiEndUsersEndUserIdVerificationReportsVoeArgs = {end_user_id: string, 'Pinwheel-Version': '2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02'}; export type GetApiEndUsersEndUserIdVerificationReportsVoeOptions = {baseUrl?: string | undefined, apiSecret?: string | undefined, fetch?: typeof fetch | undefined}; export const employeeName = z.object({first_name: z.string().optional(), middle_name: z.string().optional(), last_name: z.string().optional(), full_name: z.string()}); export const addressGetResponseItem = z.object({raw: z.string(), line1: z.string().optional(), line2: z.string().optional(), city: z.string().optional(), state: z.string().optional(), postal_code: z.string().optional(), country: z.literal("US").optional()}); export const phoneNumberGetResponseItem = z.object({value: z.string(), type: z.enum(["home", "work", "mobile"]).optional()}); export const employeeResponseObj = z.object({name: employeeName, date_of_birth: z.string().optional(), last_four_ssn: z.string().optional(), address: addressGetResponseItem.optional(), phone_numbers: z.array(phoneNumberGetResponseItem).optional()}); export const employmentResponseObj = z.object({employer_name: z.string(), employer_address: addressGetResponseItem.optional(), start_date: z.string().optional(), employment_duration_months: z.number().int().optional(), employment_status: z.enum(["employed", "terminated", "furloughed"]).optional(), employment_type: z.string().optional(), termination_date: z.string().optional(), title: z.string().optional(), most_recent_pay_date: z.string().optional()}); export const documentObjPublicResponseItem = z.object({id: z.string(), download_url: z.string().optional(), download_url_expiration: z.string().optional()}); export const verificationReportsVOEObjResponse = z.object({id: z.string(), updated_at: z.string(), refreshed_at: z.string(), employee: employeeResponseObj, employments: z.array(employmentResponseObj), document: documentObjPublicResponseItem.optional(), report_type: z.enum(["voe", "voie", "base"])}); export const getApiEndUsersEndUserIdVerificationReportsVoeResponse = z.object({data: verificationReportsVOEObjResponse}); 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 Verification of Employment Report * * GET /end_users/{end_user_id}/verification_reports/voe */ export const getApiEndUsersEndUserIdVerificationReportsVoe = async (args: GetApiEndUsersEndUserIdVerificationReportsVoeArgs, options?: GetApiEndUsersEndUserIdVerificationReportsVoeOptions) => { const {baseUrl = "https://api.getpinwheel.com/v1", fetch: fetchFn = fetch, apiSecret} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['Pinwheel-Version'] != null) headers.set("Pinwheel-Version", String(args['Pinwheel-Version'])) if (apiSecret !== undefined) headers.set("X-API-SECRET", apiSecret) const url = `${baseUrl.replace(/\/+$/, '')}/end_users/${encodeURIComponent(String(args.end_user_id))}/verification_reports/voe${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(getApiEndUsersEndUserIdVerificationReportsVoeResponse, await res.json()) };