import {z} from 'zod' export type CreateApiApiStatsNameArgs = {name: 'overview' | 'total-tickets-created' | 'total-tickets-replied' | 'total-tickets-closed' | 'total-messages-sent' | 'total-messages-received' | 'median-first-response-time' | 'median-resolution-time' | 'total-one-touch-tickets' | 'support-volume' | 'resolution-time' | 'first-response-time' | 'tickets-created-per-hour-per-weekday' | 'tickets-per-tag' | 'tickets-created-per-channel' | 'tickets-created-per-channel-per-day' | 'tickets-closed-per-agent' | 'tickets-closed-per-agent-per-day' | 'messages-sent-per-macro' | 'satisfaction-surveys' | 'latest-satisfaction-surveys' | 'intents-occurrence' | 'intents-overview' | 'intents-breakdown-per-day' | 'revenue-overview' | 'revenue-per-agent' | 'revenue-per-day' | 'revenue-per-ticket' | 'self-service-volume-per-flow' | 'self-service-article-recommendation-performance' | 'self-service-top-reported-issues' | 'self-service-products-with-most-issues-and-return-requests' | 'self-service-workflows-performance', body: {filters: {period?: {start_datetime: string, end_datetime: string} | undefined, agents?: Array | undefined, channels?: Array | undefined, campaigns?: Array | undefined, tags?: Array | undefined, integrations?: Array | undefined, score?: Array | undefined}}}; export type CreateApiApiStatsNameOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const statistic = z.object({data: z.object({}).optional(), meta: z.object({end_datetime: z.string(), previous_end_datetime: z.string().optional(), previous_start_datetime: z.string().optional(), start_datetime: z.string()}).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 }; /** * Retrieve a statistic * * POST /api/stats/{name} */ export const createApiApiStatsName = async (args: CreateApiApiStatsNameArgs, options?: CreateApiApiStatsNameOptions) => { const {baseUrl = "https://your-domain.gorgias.com", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/stats/${encodeURIComponent(String(args.name))}${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(statistic, await res.json()) };