import {z} from 'zod' export type GetApiV2CampaignsCampaignIdSummaryArgs = {campaignId: number}; export type GetApiV2CampaignsCampaignIdSummaryOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const apiCampaignSummary = z.object({dateSent: z.string().optional(), numUniqueOpens: z.number().int().optional(), numUniqueTextOpens: z.number().int().optional(), numTotalUniqueOpens: z.number().int().optional(), numOpens: z.number().int().optional(), numTextOpens: z.number().int().optional(), numTotalOpens: z.number().int().optional(), numClicks: z.number().int().optional(), numTextClicks: z.number().int().optional(), numTotalClicks: z.number().int().optional(), numPageViews: z.number().int().optional(), numTotalPageViews: z.number().int().optional(), numTextPageViews: z.number().int().optional(), numForwards: z.number().int().optional(), numTextForwards: z.number().int().optional(), numEstimatedForwards: z.number().int().optional(), numTextEstimatedForwards: z.number().int().optional(), numTotalEstimatedForwards: z.number().int().optional(), numReplies: z.number().int().optional(), numTextReplies: z.number().int().optional(), numTotalReplies: z.number().int().optional(), numHardBounces: z.number().int().optional(), numTextHardBounces: z.number().int().optional(), numTotalHardBounces: z.number().int().optional(), numSoftBounces: z.number().int().optional(), numTextSoftBounces: z.number().int().optional(), numTotalSoftBounces: z.number().int().optional(), numUnsubscribes: z.number().int().optional(), numTextUnsubscribes: z.number().int().optional(), numTotalUnsubscribes: z.number().int().optional(), numIspComplaints: z.number().int().optional(), numTextIspComplaints: z.number().int().optional(), numTotalIspComplaints: z.number().int().optional(), numMailBlocks: z.number().int().optional(), numTextMailBlocks: z.number().int().optional(), numTotalMailBlocks: z.number().int().optional(), numSent: z.number().int().optional(), numTextSent: z.number().int().optional(), numTotalSent: z.number().int().optional(), numRecipientsClicked: z.number().int().optional(), numDelivered: z.number().int().optional(), numTextDelivered: z.number().int().optional(), numTotalDelivered: z.number().int().optional(), percentageDelivered: z.number().optional(), percentageUniqueOpens: z.number().optional(), percentageOpens: z.number().optional(), percentageUnsubscribes: z.number().optional(), percentageReplies: z.number().optional(), percentageHardBounces: z.number().optional(), percentageSoftBounces: z.number().optional(), percentageUsersClicked: z.number().optional(), percentageClicksToOpens: z.number().optional(), revenue: z.string().nullable().optional(), conversionRate: z.number().optional(), assistedRevenue: z.string().nullable().optional(), numOrders: z.number().int().optional(), numAssistedOrders: z.number().int().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 }; /** * Gets a summary of reporting information for a specified campaign. * * GET /v2/campaigns/{campaignId}/summary */ export const getApiV2CampaignsCampaignIdSummary = async (args: GetApiV2CampaignsCampaignIdSummaryArgs, options?: GetApiV2CampaignsCampaignIdSummaryOptions) => { const {baseUrl = "https://api.dotdigital.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/v2/campaigns/${encodeURIComponent(String(args.campaignId))}/summary${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(apiCampaignSummary, await res.json()) };