import {z} from 'zod' export type GetApiReportsSummaryReportsEmailCampaignSummariesArgs = {limit?: string | undefined}; export type GetApiReportsSummaryReportsEmailCampaignSummariesOptions = {baseUrl?: string | undefined, oauth2Implicit?: string | undefined, fetch?: typeof fetch | undefined}; export const uniqueEmailCounts = z.object({sends: z.number().int().optional(), opens: z.number().int().optional(), clicks: z.number().int().optional(), forwards: z.number().int().optional(), optouts: z.number().int().optional(), abuse: z.number().int().optional(), bounces: z.number().int().optional(), not_opened: z.number().int().optional()}); export const bulkEmailCampaignSummary = z.object({campaign_id: z.string(), campaign_type: z.string().optional(), last_sent_date: z.string().optional(), unique_counts: uniqueEmailCounts.optional()}); export const bulkEmailCampaignSummariesPercents = z.object({click: z.number().optional(), open: z.number().optional(), did_not_open: z.number().optional(), bounce: z.number().optional(), unsubscribe: z.number().optional()}); export const reportingNext = z.object({href: z.string().optional()}); export const reportingLinks = z.object({next: reportingNext.optional()}); export const bulkEmailCampaignSummariesPage = z.object({bulk_email_campaign_summaries: z.array(bulkEmailCampaignSummary).optional(), aggregate_percents: bulkEmailCampaignSummariesPercents.optional(), _links: reportingLinks.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 }; /** * GET an Email Campaigns Summary Report * * GET /reports/summary_reports/email_campaign_summaries * * Also accepts auth: oauth2_access_code */ export const getApiReportsSummaryReportsEmailCampaignSummaries = async (args: GetApiReportsSummaryReportsEmailCampaignSummariesArgs, options?: GetApiReportsSummaryReportsEmailCampaignSummariesOptions) => { const {baseUrl = "https://api.cc.email/v3", fetch: fetchFn = fetch, oauth2Implicit} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (oauth2Implicit !== undefined) headers.set('authorization', `Bearer ${oauth2Implicit}`) const url = `${baseUrl.replace(/\/+$/, '')}/reports/summary_reports/email_campaign_summaries${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(bulkEmailCampaignSummariesPage, await res.json()) };