import {z} from 'zod' export type AnalysisStatus = 'active' | 'deleted'; export type AnalysisReadinessStatus = 'pending' | 'failed' | 'ready' | 'stale'; export type Interval = 'day' | 'week'; export type Industry = 'accommodation' | 'cpg' | 'tourism' | 'marketing' | 'parking' | 'restaurants' | 'retail' | 'transportation' | 'other'; export type AnalysisSortField = 'name' | 'created' | 'updated' | '-name' | '-created' | '-updated'; export type GetApiV1BeamAnalysesArgs = {status?: Array | undefined, readiness_status?: Array | undefined, group_id?: Array | undefined, 'demand_type.interval'?: Array | undefined, 'demand_type.industry'?: Array | undefined, external_id?: Array | undefined, label?: Array | undefined, 'location.saved_location_id'?: Array | undefined, sort?: Array | undefined, limit?: number | undefined, offset?: number | undefined, 'updated.gt'?: string | undefined, 'updated.gte'?: string | undefined, 'updated.lt'?: string | undefined, 'updated.lte'?: string | undefined, q?: string | undefined}; export type GetApiV1BeamAnalysesOptions = {baseUrl?: string | undefined, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const geoPointResponse = z.object({lat: z.string(), lon: z.string()}); export const locationResponse = z.object({geopoint: geoPointResponse.optional(), radius: z.number().gte(0).optional(), unit: z.enum(["m", "mi", "km", "ft"]).optional(), saved_location_id: z.string().min(1).optional()}); export const rankTypeResponse = z.enum(["phq", "local"]); export const rankLevel = z.object({min: z.number().int().gte(0).lte(100), max: z.number().int().gte(0).lte(100).optional()}); export const rankLevelsResponse = z.object({phq: rankLevel.optional(), local: rankLevel.optional()}); export const rankResponse = z.object({type: rankTypeResponse, levels: rankLevelsResponse.optional()}); export const accessType = z.enum(["full", "limited"]); export const analysisStatus = z.enum(["active", "deleted"]); export const analysisReadinessStatus = z.enum(["pending", "failed", "ready", "stale"]); export const analysisDateRange = z.object({start: z.string(), end: z.string()}); export const bestPracticeChecks = z.object({industry: z.boolean().optional(), rank: z.boolean().optional(), radius: z.boolean().optional()}); export const analysisReadinessChecks = z.object({date_range: analysisDateRange.optional(), error_code: z.string().optional(), missing_dates: z.array(z.string()).optional(), validation_response: z.record(z.string(), z.unknown()).optional(), best_practice: z.boolean().optional(), best_practice_checks: bestPracticeChecks.optional()}); export const analysisProcessingCompleted = z.object({correlation: z.boolean().optional(), feature_importance: z.boolean().optional(), value_quant: z.boolean().optional()}); export const industry = z.enum(["accommodation", "cpg", "tourism", "marketing", "parking", "restaurants", "retail", "transportation", "other"]); export const interval = z.enum(["day", "week"]); export const weekday = z.enum(["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]); export const currencyCode = z.enum(["USD", "EUR", "GBP", "AUD", "CAD"]); export const demandTypeResponse = z.object({industry: industry.optional(), interval: interval.optional(), week_start_day: weekday.optional(), unit_descriptor: z.string().optional(), currency_code: currencyCode.optional(), unit_currency_multiplier: z.number().optional()}); export const radiusUnit = z.enum(["m", "km", "mi", "ft"]); export const geoJsonProperties = z.object({radius: z.number().gt(0), radius_unit: radiusUnit}); export const geoJsonGeometryType = z.enum(["Point", "Polygon", "MultiPolygon", "LineString", "MultiLineString"]); export const geoJsonGeometry = z.object({type: geoJsonGeometryType, coordinates: z.array(z.unknown())}); export const geoJsonResponse = z.object({type: z.string(), properties: geoJsonProperties.optional(), geometry: geoJsonGeometry}); export const placeResponse = z.object({place_id: z.number().int(), type: z.string(), name: z.string(), county: z.string().optional(), region: z.string().optional(), country: z.string().optional(), geojson: geoJsonResponse}); export const subscriptionValidType = z.enum(["broadcasts", "events", "features_api"]); export const savedLocationResponse = z.object({name: z.string().optional(), formatted_address: z.string().optional(), geojson: geoJsonResponse.optional(), h3: z.array(z.string()).optional(), place_ids: z.array(z.number().int()).optional(), place_hierarchies: z.array(z.string()).optional(), places: z.array(placeResponse).optional(), subscription_valid_types: z.array(subscriptionValidType).optional(), location_id: z.string(), origin_geojson: z.object({type: z.literal("Feature").optional(), geometry: z.object({type: z.literal("Point"), coordinates: z.array(z.number())})}).optional()}); export const analysisResponse = z.object({name: z.string().min(1), location: locationResponse.optional(), rank: rankResponse.optional(), user_id: z.string().optional(), access_type: accessType.optional(), status: analysisStatus.optional(), readiness_status: analysisReadinessStatus.optional(), readiness_checks: analysisReadinessChecks.optional(), processing_completed: analysisProcessingCompleted.optional(), demand_type: demandTypeResponse.optional(), group_ids: z.array(z.string()).optional(), tz: z.string().optional(), create_dt: z.string().optional(), update_dt: z.string().optional(), processed_dt: z.string().optional(), external_id: z.string().optional(), label: z.array(z.string()).optional(), saved_location: savedLocationResponse.optional()}); export const multiAnalysisResponse = z.object({count: z.number().int(), analyses: z.array(analysisResponse)}); 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 }; /** * Search Analyses * * GET /v1/beam/analyses */ export const getApiV1BeamAnalyses = async (args: GetApiV1BeamAnalysesArgs, options?: GetApiV1BeamAnalysesOptions) => { const {baseUrl = "https://api.predicthq.com", fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.status != null) query.append("status", args.status.join(',')) if (args.readiness_status != null) query.append("readiness_status", args.readiness_status.join(',')) for (const item of args.group_id ?? []) query.append("group_id", String(item)) if (args['demand_type.interval'] != null) query.append("demand_type.interval", args['demand_type.interval'].join(',')) if (args['demand_type.industry'] != null) query.append("demand_type.industry", args['demand_type.industry'].join(',')) if (args.external_id != null) query.append("external_id", args.external_id.join(',')) if (args.label != null) query.append("label", args.label.join(',')) if (args['location.saved_location_id'] != null) query.append("location.saved_location_id", args['location.saved_location_id'].join(',')) if (args.sort != null) query.append("sort", args.sort.join(',')) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args['updated.gt'] != null) query.append("updated.gt", String(args['updated.gt'])) if (args['updated.gte'] != null) query.append("updated.gte", String(args['updated.gte'])) if (args['updated.lt'] != null) query.append("updated.lt", String(args['updated.lt'])) if (args['updated.lte'] != null) query.append("updated.lte", String(args['updated.lte'])) if (args.q != null) query.append("q", String(args.q)) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/beam/analyses${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(multiAnalysisResponse, await res.json()) };