import {z} from 'zod' export type GetApiV1ProjectsProjectIdGeoVisibilityOverviewArgs = {projectId: string, days?: number | undefined, from?: string | undefined, to?: string | undefined}; export type GetApiV1ProjectsProjectIdGeoVisibilityOverviewOptions = {baseUrl?: string | undefined, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const geoVisibilityOverviewResponse = z.object({configured: z.boolean(), engines: z.array(z.object({engine: z.string(), checks: z.number().int(), mentions: z.number().int(), mentionRate: z.number(), citations: z.number().int(), visibility: z.number().int(), visibilityRate: z.number(), avgPosition: z.number().nullable(), lastCheckedAt: z.string()})), organization: z.object({id: z.string(), slug: z.string(), name: z.string(), logo: z.string().nullable()})}); 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 }; /** * Get mention rates per engine * * GET /v1/projects/{projectId}/geo/visibility/overview */ export const getApiV1ProjectsProjectIdGeoVisibilityOverview = async (args: GetApiV1ProjectsProjectIdGeoVisibilityOverviewArgs, options?: GetApiV1ProjectsProjectIdGeoVisibilityOverviewOptions) => { const {baseUrl = "https://api.usenotra.com", fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.days != null) query.append("days", String(args.days)) if (args.from != null) query.append("from", String(args.from)) if (args.to != null) query.append("to", String(args.to)) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/projects/${encodeURIComponent(String(args.projectId))}/geo/visibility/overview${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(geoVisibilityOverviewResponse, await res.json()) };