import {z} from 'zod' export type GetApiBroadcastsIdReportArgs = {id: string}; export type GetApiBroadcastsIdReportOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiBroadcastsIdReportResponse = z.object({stats: z.object({sent: z.number().int(), delivered: z.number().int(), opened: z.number().int(), clicked: z.number().int(), bounced: z.number().int(), complained: z.number().int(), unsubscribed: z.number().int(), opens: z.number().int(), clicks: z.number().int(), rates: z.object({delivery: z.number().int(), open: z.number(), click: z.number(), clickToOpen: z.number(), bounce: z.number(), complaint: z.number().int(), unsubscribe: z.number()})}), providers: z.array(z.object({provider: z.string(), label: z.string(), sent: z.number().int(), delivered: z.number().int(), opened: z.number().int(), clicked: z.number().int(), bounced: z.number().int(), complained: z.number().int(), openRate: z.number(), clickRate: z.number()})), links: z.array(z.object({position: z.number().int(), url: z.string(), uniqueClicks: z.number().int(), clicks: z.number().int(), share: z.number()})), timeline: z.array(z.object({hour: z.string(), opened: z.number().int(), clicked: z.number().int()})), average: z.object({basedOn: z.number().int(), open: z.number(), click: z.number(), bounce: z.number(), unsubscribe: z.number(), delivery: z.number()}), machine: z.object({opens: z.number().int(), clicks: z.number().int()}), tracking: z.object({opens: z.boolean(), clicks: z.boolean()}), totals: z.object({queued: z.number().int(), sending: z.number().int(), sent: z.number().int(), held: z.number().int(), skipped: z.number().int(), failed: z.number().int(), total: z.number().int()}), remaining: z.number().int()}); 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 broadcast's engagement report * * GET /broadcasts/{id}/report */ export const getApiBroadcastsIdReport = async (args: GetApiBroadcastsIdReportArgs, options?: GetApiBroadcastsIdReportOptions) => { const {baseUrl = "https://sendhq.cc/api/v1", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/broadcasts/${encodeURIComponent(String(args.id))}/report${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(getApiBroadcastsIdReportResponse, await res.json()) };