import {z} from 'zod' export type GetApiV2PropertyPropertyIdArgs = {property_id: string}; export type GetApiV2PropertyPropertyIdOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const propertyAddressDto = z.object({full_address: z.string(), line1: z.string(), city: z.string(), state: z.string(), zip: z.string(), house: z.string(), street: z.string(), street_type: z.string().nullable().optional(), county: z.string().nullable().optional()}); export const geolocationDto = z.object({lat: z.number(), lng: z.number()}); export const ownerOccupancyEnum = z.enum(["OwnerOccupied", "AbsenteeOwner", "Unknown"]); export const assessedInfoDto = z.object({market_value: z.number().int().nullable().optional(), assessed_value: z.number().int().nullable().optional(), property_tax_amount: z.number().nullable().optional(), property_tax_percent: z.number().nullable().optional()}); export const mortgageDto = z.object({amount: z.number().int().nullable().optional(), date: z.string().nullable().optional(), due_date: z.string().nullable().optional(), term: z.number().int().nullable().optional(), rate: z.number().nullable().optional(), rate_type: z.string().nullable().optional()}); export const businessOwnerDto = z.object({name: z.string()}); export const addressDto = z.object({address_id: z.string(), full_address: z.string(), city: z.string(), state: z.string(), line1: z.string(), zip: z.string()}); export const phoneNumberTypeEnum = z.enum(["mobile", "landline", "voip", "tollfree", "unknown"]); export const phoneNumber = z.object({number: z.string(), type: phoneNumberTypeEnum, score: z.number().int().nullable()}); export const personEmailDto = z.object({email: z.string(), score: z.number().int().nullable().optional()}); export const listCountDto = z.object({displayed: z.number().int(), additional: z.number().int()}); export const personDisplayMetadataDto = z.object({details_url: z.string(), phones: listCountDto, emails: listCountDto, owned_properties: listCountDto}); export const personOwnerDto = z.object({id: z.string(), name: z.string(), age: z.number().int().nullable().optional(), current_addresses: z.array(addressDto).optional(), phones: z.array(phoneNumber).optional(), emails: z.array(personEmailDto).optional(), company_name: z.string().nullable().optional(), job_title: z.string().nullable().optional(), person_owner_metadata: personDisplayMetadataDto.nullable().optional()}); export const ownershipInfoDetailsDto = z.object({owner_type: z.string().nullable().optional(), sale_date: z.string().nullable().optional(), last_sale_amount: z.number().int().nullable().optional(), mortgages: z.array(mortgageDto).optional(), business_owners: z.array(businessOwnerDto).optional(), person_owners: z.array(personOwnerDto).optional()}); export const residentDto = z.object({id: z.string(), name: z.string(), age: z.number().int().nullable().optional(), current_addresses: z.array(addressDto).optional(), phones: z.array(phoneNumber).optional(), emails: z.array(personEmailDto).optional(), company_name: z.string().nullable().optional(), job_title: z.string().nullable().optional(), resident_metadata: personDisplayMetadataDto.nullable().optional()}); export const propertyDetailsV2Dto = z.object({property_id: z.string(), address_id: z.string().nullable().optional(), apn: z.string().nullable().optional(), property_address: propertyAddressDto, mailing_address: propertyAddressDto.nullable().optional(), geolocation: geolocationDto.nullable().optional(), year_built: z.number().int().nullable().optional(), effective_year_built: z.number().int().nullable().optional(), property_purpose: z.string().nullable().optional(), living_sqft: z.number().int().nullable().optional(), lot_sqft: z.number().int().nullable().optional(), ground_floor_sqft: z.number().int().nullable().optional(), basement_sqft: z.number().int().nullable().optional(), basement_type: z.string().nullable().optional(), stories: z.number().int().nullable().optional(), bedrooms: z.number().int().nullable().optional(), bathrooms: z.number().int().nullable().optional(), has_pool: z.boolean().nullable().optional(), garage_type: z.string().nullable().optional(), roof_covering: z.string().nullable().optional(), heating_fuel: z.string().nullable().optional(), condition: z.string().nullable().optional(), build_quality: z.string().nullable().optional(), owner_occupied: ownerOccupancyEnum.nullable().optional(), is_vacant: z.boolean().nullable().optional(), assessed_info: assessedInfoDto.nullable().optional(), ownership_info: ownershipInfoDetailsDto.nullable().optional(), residents: z.array(residentDto).optional()}); export const detailResponseDtoPropertyDetailsV2Dto = z.object({result: propertyDetailsV2Dto}); 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 property details by ID * * GET /v2/property/{property_id} */ export const getApiV2PropertyPropertyId = async (args: GetApiV2PropertyPropertyIdArgs, options?: GetApiV2PropertyPropertyIdOptions) => { const {baseUrl = "https://api.whitepages.com", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("x-api-key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v2/property/${encodeURIComponent(String(args.property_id))}${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(detailResponseDtoPropertyDetailsV2Dto, await res.json()) };