import {z} from 'zod' export type CollateralScoreRequest = {vin: string, mileage: number, zip: string, loan_term_months?: number | undefined}; export type CreateApiV1VehicleCollateralScoreArgs = {body: CollateralScoreRequest}; export type CreateApiV1VehicleCollateralScoreOptions = {baseUrl?: string | undefined, ApiKeyQuery?: string | undefined, fetch?: typeof fetch | undefined}; export const collateralScoreRequest = z.object({vin: z.string().min(17).max(17), mileage: z.number().int().gte(0).lte(1000000), zip: z.string(), loan_term_months: z.number().int().gte(1).lte(96).optional()}); export const collateralForecastPoint = z.object({months: z.number().int().optional(), projected_value: z.number().int().optional(), depreciation_pct: z.number().optional()}).nullable(); export const createApiV1VehicleCollateralScoreResponse = z.object({success: z.literal(true).optional(), input: collateralScoreRequest.optional(), timestamp: z.string().optional(), vin: z.string().optional(), vehicle: z.object({year: z.number().int().nullable().optional(), make: z.string().nullable().optional(), model: z.string().nullable().optional(), trim: z.string().nullable().optional()}).optional(), current_values: z.object({retail: z.number().int().nullable().optional(), wholesale: z.number().int().nullable().optional(), trade_in: z.number().int().nullable().optional(), msrp: z.number().int().nullable().optional(), confidence: z.enum(["high", "medium", "low"]).optional(), publish_date: z.string().nullable().optional()}).optional(), depreciation_forecast: z.object({"12_month": collateralForecastPoint.optional(), "24_month": collateralForecastPoint.optional(), "36_month": collateralForecastPoint.optional(), "48_month": collateralForecastPoint.optional(), at_loan_maturity: collateralForecastPoint.optional(), base_value: z.literal("retail").optional(), curve_source: z.enum(["model", "segment", "null"]).nullable().optional(), curve_key: z.string().nullable().optional(), curve_min_sample_size: z.number().int().nullable().optional(), curve_refreshed_at: z.string().nullable().optional()}).optional(), depreciation_velocity: z.object({percentile_vs_segment: z.number().int().nullable().optional(), segment: z.string().nullable().optional(), segment_name: z.string().nullable().optional(), annual_depreciation_pct: z.number().nullable().optional(), peer_count: z.number().int().optional(), interpretation: z.string().nullable().optional()}).optional(), risk_flags: z.object({salvage_title: z.boolean().nullable().optional(), flood_damage: z.boolean().nullable().optional(), lemon_law_buyback: z.boolean().nullable().optional(), odometer_anomaly: z.boolean().nullable().optional(), other_title_brands: z.array(z.string()).nullable().optional(), total_loss_reported: z.boolean().nullable().optional(), open_recalls_high_severity: z.number().int().nullable().optional(), accident_count: z.number().int().nullable().optional(), total_flags: z.number().int().optional()}).optional(), lending_recommendation: z.object({risk_tier: z.enum(["A", "B", "C", "D"]).optional(), suggested_max_ltv: z.union([z.literal(120), z.literal(110), z.literal(95), z.literal(80)]).optional(), manual_review_recommended: z.boolean().optional(), reasons: z.array(z.string()).optional(), rationale: z.string().optional(), confidence: z.enum(["high", "medium", "low"]).optional()}).optional(), data_gaps: z.array(z.enum(["accident_history", "vehicle_history", "recalls", "depreciation_curve", "segment_percentile"])).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 }; /** * Collateral Score * * POST /v1/vehicle/collateral-score */ export const createApiV1VehicleCollateralScore = async (args: CreateApiV1VehicleCollateralScoreArgs, options?: CreateApiV1VehicleCollateralScoreOptions) => { const {baseUrl = "https://api.carsxe.com", fetch: fetchFn = fetch, ApiKeyQuery} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (ApiKeyQuery !== undefined) query.set("key", ApiKeyQuery) const url = `${baseUrl.replace(/\/+$/, '')}/v1/vehicle/collateral-score${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", 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(createApiV1VehicleCollateralScoreResponse, await res.json()) };