import {z} from 'zod' export type GetApiCampaignsOverviewArgs = {days?: number | undefined}; export type GetApiCampaignsOverviewOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiCampaignsOverviewResponse = z.object({subscribers: z.object({active: z.number().int(), dormant: z.number().int(), pending: z.number().int(), joined: z.number().int(), left: z.number().int()}), series: z.array(z.object({day: z.string(), subscribers: z.number().int(), joined: z.number().int(), left: z.number().int()})), recent: z.array(z.object({id: z.string(), name: z.string(), subject: z.string(), status: z.string(), startedAt: z.string(), sent: z.number().int(), openRate: z.number(), clickRate: z.number()})), averages: z.object({openRate: z.number(), clickRate: z.number()})}); 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 subscriber growth and recent broadcast performance * * GET /campaigns/overview */ export const getApiCampaignsOverview = async (args: GetApiCampaignsOverviewArgs, options?: GetApiCampaignsOverviewOptions) => { 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 (args.days != null) query.append("days", String(args.days)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/campaigns/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(getApiCampaignsOverviewResponse, await res.json()) };