import {z} from 'zod' export type GetApi30ReportsArgs = {fields?: Array | undefined, exclude_fields?: Array | undefined, count?: number | undefined, offset?: number | undefined, type?: ('regular' | 'plaintext' | 'absplit' | 'rss' | 'variate') | undefined, before_send_time?: string | undefined, since_send_time?: string | undefined}; export type GetApi30ReportsOptions = {baseUrl?: string | undefined, bearerToken?: string | undefined, fetch?: typeof fetch | undefined}; export const getApi30ReportsResponse = z.object({_links: z.array(z.object({href: z.string().optional(), method: z.enum(["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"]).optional(), rel: z.string().optional(), schema: z.string().optional(), targetSchema: z.string().optional()})).optional(), reports: z.array(z.object({_links: z.array(z.object({href: z.string().optional(), method: z.enum(["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"]).optional(), rel: z.string().optional(), schema: z.string().optional(), targetSchema: z.string().optional()})).optional(), ab_split: z.object({a: z.object({abuse_reports: z.number().int().optional(), bounces: z.number().int().optional(), forwards: z.number().int().optional(), forwards_opens: z.number().int().optional(), last_open: z.string().optional(), opens: z.number().int().optional(), recipient_clicks: z.number().int().optional(), unique_opens: z.number().int().optional(), unsubs: z.number().int().optional()}).optional(), b: z.object({abuse_reports: z.number().int().optional(), bounces: z.number().int().optional(), forwards: z.number().int().optional(), forwards_opens: z.number().int().optional(), last_open: z.string().optional(), opens: z.number().int().optional(), recipient_clicks: z.number().int().optional(), unique_opens: z.number().int().optional(), unsubs: z.number().int().optional()}).optional()}).optional(), abuse_reports: z.number().int().optional(), bounces: z.object({hard_bounces: z.number().int().optional(), soft_bounces: z.number().int().optional(), syntax_errors: z.number().int().optional()}).optional(), campaign_title: z.string().optional(), clicks: z.object({click_rate: z.number().optional(), clicks_total: z.number().int().optional(), last_click: z.string().optional(), unique_clicks: z.number().int().optional(), unique_subscriber_clicks: z.number().int().optional()}).optional(), delivery_status: z.object({can_cancel: z.boolean().optional(), emails_canceled: z.number().int().optional(), emails_sent: z.number().int().optional(), enabled: z.boolean().optional(), status: z.enum(["delivering", "delivered", "canceling", "canceled"]).optional()}).optional(), ecommerce: z.object({currency_code: z.string().optional(), total_orders: z.number().int().optional(), total_revenue: z.number().optional(), total_spent: z.number().optional()}).optional(), emails_sent: z.number().int().optional(), facebook_likes: z.object({facebook_likes: z.number().int().optional(), recipient_likes: z.number().int().optional(), unique_likes: z.number().int().optional()}).optional(), forwards: z.object({forwards_count: z.number().int().optional(), forwards_opens: z.number().int().optional()}).optional(), id: z.string().optional(), industry_stats: z.object({abuse_rate: z.number().optional(), bounce_rate: z.number().optional(), click_rate: z.number().optional(), open_rate: z.number().optional(), type: z.string().optional(), unopen_rate: z.number().optional(), unsub_rate: z.number().optional()}).optional(), list_id: z.string().optional(), list_is_active: z.boolean().optional(), list_name: z.string().optional(), list_stats: z.object({click_rate: z.number().optional(), open_rate: z.number().optional(), proxy_excluded_open_rate: z.number().optional(), sub_rate: z.number().optional(), unsub_rate: z.number().optional()}).optional(), opens: z.object({last_open: z.string().optional(), open_rate: z.number().optional(), opens_total: z.number().int().optional(), proxy_excluded_open_rate: z.number().optional(), proxy_excluded_opens: z.number().int().optional(), proxy_excluded_unique_opens: z.number().int().optional(), unique_opens: z.number().int().optional()}).optional(), preview_text: z.string().optional(), rss_last_send: z.string().optional(), send_time: z.string().optional(), share_report: z.object({share_password: z.string().optional(), share_url: z.string().optional()}).optional(), subject_line: z.string().optional(), timeseries: z.array(z.object({emails_sent: z.number().int().optional(), proxy_excluded_unique_opens: z.number().int().optional(), recipients_clicks: z.number().int().optional(), timestamp: z.string().optional(), unique_opens: z.number().int().optional()})).optional(), timewarp: z.array(z.object({bounces: z.number().int().optional(), clicks: z.number().int().optional(), gmt_offset: z.number().int().optional(), last_click: z.string().optional(), last_open: z.string().optional(), opens: z.number().int().optional(), unique_clicks: z.number().int().optional(), unique_opens: z.number().int().optional()})).optional(), type: z.string().optional(), unsubscribed: z.number().int().optional()})).optional(), total_items: 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 }; /** * List campaign reports * * GET /3.0/reports * * Also accepts auth: oauth2 */ export const getApi30Reports = async (args: GetApi30ReportsArgs, options?: GetApi30ReportsOptions) => { const {baseUrl = "https://api.mailchimp.com", fetch: fetchFn = fetch, bearerToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.fields != null) query.append("fields", args.fields.join(',')) if (args.exclude_fields != null) query.append("exclude_fields", args.exclude_fields.join(',')) if (args.count != null) query.append("count", String(args.count)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.type != null) query.append("type", String(args.type)) if (args.before_send_time != null) query.append("before_send_time", String(args.before_send_time)) if (args.since_send_time != null) query.append("since_send_time", String(args.since_send_time)) if (bearerToken !== undefined) headers.set('authorization', `Bearer ${bearerToken}`) const url = `${baseUrl.replace(/\/+$/, '')}/3.0/reports${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(getApi30ReportsResponse, await res.json()) };