import {z} from 'zod' export type GetApiV2MarketvalueArgs = {vin: string, state?: string | undefined, mileage?: number | undefined, condition?: ('excellent' | 'clean' | 'average' | 'rough') | undefined}; export type GetApiV2MarketvalueOptions = {baseUrl?: string | undefined, ApiKeyQuery?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiV2MarketvalueResponse = z.object({uid: z.string().optional(), input: z.object({vin: z.string().optional(), state: z.string().optional(), country: z.string().optional(), mileage: z.number().optional(), condition: z.string().optional()}).and(z.record(z.string(), z.unknown())).optional(), publish_date: z.string().optional(), data_freq: z.string().optional(), state: z.string().optional(), country: z.string().optional(), uvc: z.string().optional(), group_num: z.string().optional(), model_year: z.string().optional(), make: z.string().optional(), model: z.string().optional(), series: z.string().optional(), style: z.string().optional(), mileage_cat: z.string().optional(), class_code: z.string().optional(), class_name: z.string().optional(), description_score: z.string().optional(), first_values_flag: z.boolean().optional(), risk_score: z.string().optional(), whole_xclean: z.record(z.string(), z.number()).optional(), whole_clean: z.record(z.string(), z.number()).optional(), whole_avg: z.record(z.string(), z.number()).optional(), whole_rough: z.record(z.string(), z.number()).optional(), retail_xclean: z.record(z.string(), z.number()).optional(), retail_clean: z.record(z.string(), z.number()).optional(), retail_avg: z.record(z.string(), z.number()).optional(), retail_rough: z.record(z.string(), z.number()).optional(), trade_in_clean: z.record(z.string(), z.number()).optional(), trade_in_avg: z.record(z.string(), z.number()).optional(), trade_in_rough: z.record(z.string(), z.number()).optional(), region2: z.number().optional(), region3: z.number().optional(), region4: z.number().optional(), region5: z.number().optional(), region6: z.number().optional(), msrp: z.number().optional(), retail_equipped: z.number().optional(), price_includes: z.string().optional(), wheel_base: z.number().optional(), tire_size: z.string().optional(), gvw: z.number().optional(), payload_cap: z.number().optional(), seat_cap: z.string().optional(), seats: z.string().optional(), fuel_type: z.string().optional(), fuel_cap: z.string().optional(), fuel_delivery: z.string().optional(), hwy_mpg: z.string().optional(), city_mpg: z.string().optional(), engine_description: z.string().optional(), cylinders: z.string().optional(), engine_displacement: z.string().optional(), engine_turbocharged: z.string().optional(), base_hp: z.string().optional(), taxable_hp: z.number().optional(), torque: z.string().optional(), oil_cap: z.string().optional(), transmission: z.string().optional(), drivetrain: z.string().optional(), num_gears: z.string().optional(), ext_doors: z.string().optional(), navigation: z.string().optional(), airbags: z.string().optional(), anti_corrosion_warranty: z.string().optional(), basic_warranty: z.string().optional(), road_assist_warranty: z.string().optional(), add_deduct_list: z.array(z.object({uoc: z.string().optional(), name: z.string().optional(), xclean: z.number().optional(), clean: z.number().optional(), avg: z.number().optional(), rough: z.number().optional(), auto: z.string().optional(), resid12: z.number().optional(), resid24: z.number().optional(), resid30: z.number().optional(), resid36: z.number().optional(), resid42: z.number().optional(), resid48: z.number().optional(), resid60: z.number().optional(), resid72: z.number().optional()}).and(z.record(z.string(), z.unknown()))).optional(), model_number_list: z.array(z.string()).optional(), mileage_list: z.array(z.object({model_year: z.string().optional(), range_begin: z.number().optional(), range_end: z.number().optional(), xclean: z.number().optional(), clean: z.number().optional(), avg: z.number().optional(), rough: z.number().optional(), finadv: z.number().optional(), mileage_cat: z.string().optional()}).and(z.record(z.string(), z.unknown()))).optional(), retail: z.number().optional(), trade_in: z.number().optional(), rough_trade_in: z.number().optional(), average_trade_in: z.number().optional(), loan_value: z.number().optional(), trade_in_values: z.array(z.unknown()).optional(), auction_values: z.object({low_auction_value: z.number().optional(), average_auction_value: z.number().optional(), high_auction_value: z.number().optional(), date_range: z.string().optional()}).and(z.record(z.string(), z.unknown())).optional()}).and(z.record(z.string(), z.unknown())); 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 }; /** * Vehicle Market Value (v2) * * GET /v2/marketvalue * * Also accepts auth: X402Payment */ export const getApiV2Marketvalue = async (args: GetApiV2MarketvalueArgs, options?: GetApiV2MarketvalueOptions) => { const {baseUrl = "https://api.carsxe.com", fetch: fetchFn = fetch, ApiKeyQuery} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.vin != null) query.append("vin", String(args.vin)) if (args.state != null) query.append("state", String(args.state)) if (args.mileage != null) query.append("mileage", String(args.mileage)) if (args.condition != null) query.append("condition", String(args.condition)) if (ApiKeyQuery !== undefined) query.set("key", ApiKeyQuery) const url = `${baseUrl.replace(/\/+$/, '')}/v2/marketvalue${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(getApiV2MarketvalueResponse, await res.json()) };