import {z} from 'zod' export type GetApiV2CampaignsMetricsArgs = {startDate?: string | undefined, endDate?: string | undefined, select?: number | undefined, skip?: number | undefined}; export type GetApiV2CampaignsMetricsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const campaignType = z.enum(["Standard", "Triggered", "Template"]); export const apiCampaignReportModelExtended = z.object({campaignId: z.number().int().optional(), dateSent: z.string().optional(), campaignName: z.string().optional(), campaignType: campaignType.optional(), sent: z.number().int().optional(), delivered: z.number().int().optional(), uniqueOpens: z.number().int().optional(), clicks: z.number().int().optional(), hardBounces: z.number().int().optional(), softBounces: z.number().int().optional(), replies: z.number().int().optional(), unsubscribes: z.number().int().optional(), forwards: z.number().int().optional(), uniqueClicks: z.number().int().optional(), sendStatusFails: z.number().int().optional(), mailBlocks: z.number().int().optional(), opens: z.number().int().optional(), complaints: z.number().int().optional(), pageViews: z.number().int().optional(), percentageDelivered: z.number().optional(), percentageUniqueOpens: z.number().optional(), percentageHardBounces: z.number().optional(), percentageSoftBounces: z.number().optional(), percentageReplies: z.number().optional(), percentageUnsubscribes: z.number().optional(), percentageUniqueClicks: z.number().optional(), percentageUniqueClicksToOpens: z.number().optional(), revenue: z.number().optional(), conversionRate: z.number().optional(), assistedRevenue: z.number().optional(), orders: z.number().int().optional(), assistedOrders: z.number().int().optional(), tags: z.array(z.string()).optional(), subjectLine: z.string().nullable().optional(), fromName: z.string().nullable().optional(), fromAddress: z.string().nullable().optional(), isSplitTest: z.boolean().optional()}); export const getApiV2CampaignsMetricsResponse = z.array(apiCampaignReportModelExtended); 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 all sent campaigns daily metrics for the specified date range. * * GET /v2/campaigns/metrics */ export const getApiV2CampaignsMetrics = async (args: GetApiV2CampaignsMetricsArgs, options?: GetApiV2CampaignsMetricsOptions) => { const {baseUrl = "https://api.dotdigital.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.startDate != null) query.append("startDate", String(args.startDate)) if (args.endDate != null) query.append("endDate", String(args.endDate)) if (args.select != null) query.append("select", String(args.select)) if (args.skip != null) query.append("skip", String(args.skip)) const url = `${baseUrl.replace(/\/+$/, '')}/v2/campaigns/metrics${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(getApiV2CampaignsMetricsResponse, await res.json()) };