import {z} from 'zod' export type GetApiApiV4ListingsScansArgs = {page?: number | undefined, perPage?: number | undefined}; export type GetApiApiV4ListingsScansOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const offsetBasedPageInfo = z.object({totalPages: z.number().int(), hasNextPage: z.boolean().optional(), hasPreviousPage: z.boolean().optional(), totalRecords: z.number().int()}); export const listingScanQuota = z.object({limit: z.number().int(), remaining: z.number().int(), resetsAt: z.string(), used: z.number().int()}); export const listingScanBusiness = z.object({city: z.string(), countryIso: z.string(), name: z.string(), phone: z.string(), postalCode: z.string().optional(), stateIso: z.string().optional(), street: z.string()}); export const listingScanFailure = z.object({code: z.string(), field: z.string().optional(), message: z.string()}); export const listingScanFieldStatus = z.enum(["ACCURATE", "INACCURATE", "MISSING"]); export const listingScanFieldCheck = z.object({message: z.string().optional(), status: listingScanFieldStatus}); export const listingScanAccuracy = z.object({address: listingScanFieldCheck, name: listingScanFieldCheck, phone: listingScanFieldCheck}); export const listingScanAccuracySource = z.enum(["DIRECTORY_MATCH", "SYNC_STATUS"]); export const listingScanDirectory = z.object({id: z.number().int().optional(), name: z.string(), url: z.string()}); export const listingScanListing = z.object({city: z.string().optional(), country: z.string().optional(), fullAddress: z.string().optional(), name: z.string().optional(), phones: z.array(z.string()), postalCode: z.string().optional(), state: z.string().optional(), street: z.string().optional(), url: z.string().optional()}); export const listingScanResultStatus = z.enum(["PENDING", "FOUND", "NOT_FOUND", "UNAVAILABLE"]); export const listingScanSyncStatus = z.enum(["SYNCED", "IN_PROGRESS", "REQUIRING_ACTION", "FAILED", "AVAILABLE", "COMPLETED", "PENDING_APPROVAL", "CANNOT_SUBMIT"]); export const listingScanResult = z.object({accuracy: listingScanAccuracy.optional(), accuracySource: listingScanAccuracySource, accurate: z.boolean().optional(), directory: listingScanDirectory, listing: listingScanListing.optional(), status: listingScanResultStatus, syncStatus: listingScanSyncStatus.optional()}); export const listingScanSource = z.enum(["DIRECTORY_SEARCH", "RECENT_SCAN", "LOCATION_LISTINGS"]); export const listingScanStatus = z.enum(["QUEUED", "IN_PROGRESS", "COMPLETED", "FAILED"]); export const listingScanSummary = z.object({accurate: z.number().int(), found: z.number().int(), inaccurate: z.number().int(), notFound: z.number().int(), pending: z.number().int(), total: z.number().int(), unavailable: z.number().int()}); export const listingScan = z.object({business: listingScanBusiness, completedAt: z.string().optional(), createdAt: z.string(), failure: listingScanFailure.optional(), id: z.string(), locationId: z.string().optional(), results: z.array(listingScanResult), resultsAsOf: z.string().optional(), source: listingScanSource, startedAt: z.string().optional(), status: listingScanStatus, summary: listingScanSummary}); export const listingScanList = z.object({pageInfo: offsetBasedPageInfo, quota: listingScanQuota.optional(), scans: z.array(listingScan)}); export const apiError = z.object({message: z.string(), code: z.string().optional(), contextInfo: z.array(z.object({key: z.string().optional(), value: z.string().optional()})).optional()}); export const getApiApiV4ListingsScansResponse = z.object({data: z.object({listingScans: listingScanList.optional()}), errors: z.array(apiError).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 }; /** * List listings scans * * GET /api/v4/listings/scans * * Also accepts auth: rapidApiKey + rapidApiHost */ export const getApiApiV4ListingsScans = async (args: GetApiApiV4ListingsScansArgs, options?: GetApiApiV4ListingsScansOptions) => { const {baseUrl = "https://listingsapi.com", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.perPage != null) query.append("perPage", String(args.perPage)) if (apiKey !== undefined) headers.set("Authorization", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/api/v4/listings/scans${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(getApiApiV4ListingsScansResponse, await res.json()) };