import {z} from 'zod' export type GetApiMessagesOutboundClicksArgs = {'X-Postmark-Server-Token': string, count: number, offset: number, recipient?: string | undefined, tag?: string | undefined, client_name?: string | undefined, client_company?: string | undefined, client_family?: string | undefined, os_name?: string | undefined, os_family?: string | undefined, os_company?: string | undefined, platform?: string | undefined, country?: string | undefined, region?: string | undefined, city?: string | undefined}; export type GetApiMessagesOutboundClicksOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const extendedMessageClickEventInformation = z.object({ClickLocation: z.string().optional(), Client: z.object({Name: z.string().optional(), Company: z.string().optional(), Family: z.string().optional()}).optional(), OS: z.object({Name: z.string().optional(), Company: z.string().optional(), Family: z.string().optional()}).optional(), Platform: z.string().optional(), UserAgent: z.string().optional(), OriginalLink: z.string().optional(), Geo: z.object({CountryISOCode: z.string().optional(), Country: z.string().optional(), RegionISOCode: z.string().optional(), Region: z.string().optional(), City: z.string().optional(), Zip: z.string().optional(), Coords: z.string().optional(), IP: z.string().optional()}).optional(), MessageID: z.string().optional(), ReceivedAt: z.string().optional(), Tag: z.string().optional(), Recipient: z.string().optional()}); export const messageClickSearchResponse = z.object({TotalCount: z.number().int().optional(), Clicks: z.array(extendedMessageClickEventInformation).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 }; /** * Clicks for a all messages * * GET /messages/outbound/clicks */ export const getApiMessagesOutboundClicks = async (args: GetApiMessagesOutboundClicksArgs, options: GetApiMessagesOutboundClicksOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['X-Postmark-Server-Token'] != null) headers.set("X-Postmark-Server-Token", String(args['X-Postmark-Server-Token'])) if (args.count != null) query.append("count", String(args.count)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.recipient != null) query.append("recipient", String(args.recipient)) if (args.tag != null) query.append("tag", String(args.tag)) if (args.client_name != null) query.append("client_name", String(args.client_name)) if (args.client_company != null) query.append("client_company", String(args.client_company)) if (args.client_family != null) query.append("client_family", String(args.client_family)) if (args.os_name != null) query.append("os_name", String(args.os_name)) if (args.os_family != null) query.append("os_family", String(args.os_family)) if (args.os_company != null) query.append("os_company", String(args.os_company)) if (args.platform != null) query.append("platform", String(args.platform)) if (args.country != null) query.append("country", String(args.country)) if (args.region != null) query.append("region", String(args.region)) if (args.city != null) query.append("city", String(args.city)) const url = `${baseUrl.replace(/\/+$/, '')}/messages/outbound/clicks${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(messageClickSearchResponse, await res.json()) };