import {z} from 'zod' export type ApiId = string; export type PeriodPreset = 'last3Months' | 'last6Months' | 'last12Months' | 'lastWeek' | 'lastMonth' | 'lastQuarter' | 'yearToDate' | 'year2018' | 'year2019' | 'year2020' | 'year2021' | 'year2022' | 'year2023' | 'year2024' | 'year2025' | null; export type RankingRequestMulti = {apiIds: Array, period: PeriodPreset, scope: 'chain' | 'category' | 'groupCategory', metric: 'visitsPerSqft' | 'visits'}; export type CreateApiV1ReportsRankingOverviewMultiArgs = {body: RankingRequestMulti}; export type CreateApiV1ReportsRankingOverviewMultiOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const apiId = z.string(); 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 rankingEntityInfo = z.object({name: z.string().optional(), entityId: entityId.optional(), entityType: entityType.optional(), flagged: z.boolean().optional(), rankedBy: z.string().optional(), categoryInfo: categoryInfo.optional(), parentChain: z.string().optional()}); export const rankingRegionObjectNationwide = z.object({rank: z.number().int().optional(), percentile: z.number().int().optional(), rankedOutOf: z.number().int().optional(), regionCode: z.string().optional()}); export const rankingRegionObjectState = z.object({rank: z.number().int().optional(), percentile: z.number().int().optional(), rankedOutOf: z.number().int().optional(), regionCode: z.string().optional()}); export const rankingRegionObjectDma = z.object({rank: z.number().int().optional(), percentile: z.number().int().optional(), rankedOutOf: z.number().int().optional(), regionCode: z.string().optional()}); export const rankingRegionObjectCbsa = z.object({rank: z.number().int().optional(), percentile: z.number().int().optional(), rankedOutOf: z.number().int().optional(), regionCode: z.string().optional()}); export const rankingMetrics = z.object({nationwide: rankingRegionObjectNationwide.optional(), state: rankingRegionObjectState.optional(), dma: rankingRegionObjectDma.optional(), cbsa: rankingRegionObjectCbsa.optional()}); export const visitDurationSegmentationRespRanking = z.enum(["under10Min", "10MinOrLonger", "allVisits", "mixedSegments"]).nullable(); export const rankingResponseMulti = z.object({apiId: apiId.optional(), metricType: z.string().optional(), info: rankingEntityInfo.optional(), ranking: z.union([rankingMetrics, z.object({rankError: z.string().optional()})]).optional(), visitDurationSegmentation: visitDurationSegmentationRespRanking.optional()}); export const createApiV1ReportsRankingOverviewMultiResponse = z.array(rankingResponseMulti); 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 }; /** * Ranking Metrics For Multiple Properties * * POST /v1/reports/ranking-overview/multi */ export const createApiV1ReportsRankingOverviewMulti = async (args: CreateApiV1ReportsRankingOverviewMultiArgs, options?: CreateApiV1ReportsRankingOverviewMultiOptions) => { 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/ranking-overview/multi${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(createApiV1ReportsRankingOverviewMultiResponse, await res.json()) };