import {z} from 'zod' export type GetApiBrandIdSiteOptimizationRecommendationsByPageArgs = {brand_id: number, path?: (Array | null) | undefined, limit?: number | undefined, offset?: number | undefined}; export type GetApiBrandIdSiteOptimizationRecommendationsByPageOptions = {baseUrl?: string | undefined, HTTPBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const pageScores = z.object({retrievability: z.number(), citeability: z.number()}); export const diagnosticOpportunity = z.object({best_practice_id: z.string().nullable().optional(), label: z.string().nullable().optional(), bucket: z.enum(["hygiene", "transformation", "enrichment"]), bucket_label: z.string().nullable().optional(), recommended_change: z.string(), expected_lift_pp: z.number(), severity: z.enum(["low", "medium", "high"]), heading_path: z.array(z.string()).optional()}); export const diagnosticStrength = z.object({best_practice_id: z.string().nullable().optional(), label: z.string().nullable().optional(), message: z.string(), contribution_pp: z.number(), heading_path: z.array(z.string()).optional()}); export const pathDiagnostics = z.object({path: z.string(), generated_at: z.string(), content_sha1: z.string().nullable().optional(), model_version: z.string(), scores: pageScores, opportunities: z.array(diagnosticOpportunity).optional(), strengths: z.array(diagnosticStrength).optional(), optimization_status: z.enum(["pending", "completed", "staged", "deployed", "retired", "outdated", "acknowledged"]).nullable().optional(), acknowledged_at: z.string().nullable().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 collectionResponsePathDiagnostics = z.object({total: z.number().int(), offset: z.number().int().optional(), limit: z.number().int().nullable().optional(), items: z.array(pathDiagnostics), 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 Page Recommendations * * GET /{brand_id}/site-optimization/recommendations/by-page */ export const getApiBrandIdSiteOptimizationRecommendationsByPage = async (args: GetApiBrandIdSiteOptimizationRecommendationsByPageArgs, options?: GetApiBrandIdSiteOptimizationRecommendationsByPageOptions) => { 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") for (const item of args.path ?? []) query.append("path", String(item)) 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))}/site-optimization/recommendations/by-page${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(collectionResponsePathDiagnostics, await res.json()) };