import {z} from 'zod' export type GetApiBrandIdResponsesArgs = {brand_id: number, platform?: ('chatgpt' | 'claude' | 'google_ai_overviews' | 'perplexity' | 'meta' | 'google_ai_mode' | 'google_gemini' | 'copilot' | 'grok' | null) | undefined, prompt_id?: (number | null) | undefined, persona_id?: (number | null) | undefined, stage?: (string | null) | undefined, start_date?: (string | null) | undefined, end_date?: (string | null) | undefined, has_shopping_data?: (boolean | null) | undefined, limit?: number | undefined, offset?: number | undefined}; export type GetApiBrandIdResponsesOptions = {baseUrl?: string | undefined, HTTPBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const responseCitation = z.object({url: z.string(), domain: z.string(), source_type: z.string(), title: z.string().nullable().optional(), snippet: z.string().nullable().optional()}); export const responseCompetitorListing = z.object({id: z.number().int(), name: z.string(), present: z.boolean(), position: z.enum(["top", "middle", "bottom"]).nullable().optional(), sentiment: z.enum(["positive", "mixed", "negative", "none"]).nullable().optional()}); export const queryFanout = z.object({queries: z.array(z.string()), engine_metadata: z.record(z.string(), z.unknown()).nullable().optional()}); export const shoppingPurchasingOption = z.object({price: z.number().nullable().optional(), currency: z.string().nullable().optional(), url: z.string().nullable().optional(), merchant: z.string().nullable().optional()}); export const shoppingResult = z.object({url: z.string(), title: z.string(), image: z.string().nullable().optional(), all_images: z.array(z.string()).nullable().optional(), description: z.string().nullable().optional(), rating: z.number().nullable().optional(), reviews: z.number().int().nullable().optional(), purchasing_options: z.array(shoppingPurchasingOption).nullable().optional()}); export const responseListing = z.object({id: z.number().int(), created_at: z.string(), prompt_id: z.number().int(), prompt: z.string(), persona_id: z.number().int().nullable(), persona_name: z.string().nullable().optional(), country: z.string().nullable().optional(), stage: z.string(), branded: z.boolean(), tags: z.array(z.string()).optional(), key_topics: z.array(z.string()).optional(), platform: z.string(), brand_present: z.boolean(), brand_sentiment: z.string().nullable().optional(), brand_position: z.string().nullable().optional(), competitors_present: z.array(z.string()).optional(), response_text: z.string(), citations: z.array(responseCitation).optional(), competitors: z.array(responseCompetitorListing).optional(), query_fanout: queryFanout.nullable().optional(), shopping_results: z.array(shoppingResult).optional()}); export const aggregationGranularity = z.enum(["daily", "weekly", "monthly"]); export const topDomainSummary = z.object({domain: z.string(), domain_owner: z.string(), observation_count: z.number().int()}); export const ownerTimeSeriesPoint = z.object({time_bucket: z.string(), brand: z.number().int(), competitor: z.number().int(), other: z.number().int()}); export const segmentTotal = z.object({name: z.string(), observation_count: z.number().int()}); export const topDomainsMetadata = z.object({domains: z.array(topDomainSummary), grand_total: z.number().int(), owner_totals: z.record(z.string(), z.number().int()), owner_time_series: z.array(ownerTimeSeriesPoint).nullable().optional(), segment_totals: z.array(segmentTotal).optional()}); export const timeSeriesMetadata = z.object({aggregation_granularity: aggregationGranularity, period_count: z.number().int(), start_date: z.string(), end_date: z.string(), top_domains: topDomainsMetadata.nullable().optional()}); export const collectionResponseResponseListing = z.object({total: z.number().int(), offset: z.number().int().optional(), limit: z.number().int().nullable().optional(), items: z.array(responseListing), metadata: timeSeriesMetadata.nullable().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 Responses * * GET /{brand_id}/responses */ export const getApiBrandIdResponses = async (args: GetApiBrandIdResponsesArgs, options?: GetApiBrandIdResponsesOptions) => { const {baseUrl = "https://api.scrunchai.com/v1", fetch: fetchFn = fetch, HTTPBearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.platform != null) query.append("platform", String(args.platform)) if (args.prompt_id != null) query.append("prompt_id", String(args.prompt_id)) if (args.persona_id != null) query.append("persona_id", String(args.persona_id)) if (args.stage != null) query.append("stage", String(args.stage)) if (args.start_date != null) query.append("start_date", String(args.start_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (args.has_shopping_data != null) query.append("has_shopping_data", String(args.has_shopping_data)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (HTTPBearer !== undefined) headers.set('authorization', `Bearer ${HTTPBearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/${encodeURIComponent(String(args.brand_id))}/responses${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(collectionResponseResponseListing, await res.json()) };