import {z} from 'zod' export type StartDate = string; export type EndDate = string; export type ApiId = string; export type IncludeMetadata = boolean; export type VmFilterObject = {audienceType?: (Array<'visitors' | 'employees' | 'residents'>) | undefined, dwellTime?: ({operator?: ('<' | '>=') | undefined, value?: number | undefined}) | undefined, hoursRange?: {fromHour: string, toHour: string} | undefined, daysOfWeek?: Array | undefined, distance?: ({from?: ('home' | 'work') | undefined, values?: ({le?: number | undefined, ge?: number | undefined, lt?: number | undefined, gt?: number | undefined, eq?: number | undefined}) | undefined}) | undefined}; export type NearbyRadius = 100 | 250 | 500 | 750 | 1000; export type VisitMetricsSummaryRequest = {startDate: StartDate, endDate: EndDate, apiIds: Array, includeMetadata?: IncludeMetadata | undefined, filters?: VmFilterObject | undefined, nearbyRadius?: NearbyRadius | undefined}; export type CreateApiV1ReportsVisitMetricsArgs = {body: VisitMetricsSummaryRequest}; export type CreateApiV1ReportsVisitMetricsOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const apiId = z.string(); export const nearbyRadius = z.union([z.literal(100), z.literal(250), z.literal(500), z.literal(750), z.literal(1000)]); export const visitDurationSegmentationRespRanking = z.enum(["under10Min", "10MinOrLonger", "allVisits", "mixedSegments"]).nullable(); export const entityId = z.string(); export const entityType = z.enum(["venue", "complex", "chain"]); export const categoryInfo = z.object({category: z.string().optional(), group: z.string().optional(), subCategory: z.string().optional()}); export const baseEntityInfo = z.object({apiId: apiId.optional(), name: z.string().optional(), entityId: entityId.optional(), entityType: entityType.optional(), categoryInfo: categoryInfo.optional()}); export const visitMetricsSummaryResponse = z.object({apiId: apiId.optional(), data: z.object({panelVisitors: z.number().int().optional(), panelVisits: z.number().int().optional(), visits: z.number().int().optional(), visitors: z.number().int().optional(), nearbyRadius: nearbyRadius.optional(), visitDurationSegmentation: visitDurationSegmentationRespRanking.optional(), metadata: baseEntityInfo.optional()}).optional()}); export const bulkVisitMetricsSummary = z.object({requestId: z.string().optional(), items: z.array(visitMetricsSummaryResponse).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 }; /** * Visit Metrics Summary Report * * POST /v1/reports/visit-metrics */ export const createApiV1ReportsVisitMetrics = async (args: CreateApiV1ReportsVisitMetricsArgs, options?: CreateApiV1ReportsVisitMetricsOptions) => { const {baseUrl = "https://papi.placer.ai", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (apiKey !== undefined) headers.set("x-api-key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/reports/visit-metrics${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(bulkVisitMetricsSummary, await res.json()) };