import {z} from 'zod' export type GetApiV3MetricsTrackingArgs = {group_by?: ('sending_domain' | 'agent_account') | undefined, sort?: string | undefined, limit?: number | undefined, start?: string | undefined, end?: string | undefined, sending_domain?: string | undefined}; export type GetApiV3MetricsTrackingOptions = {baseUrl?: string | undefined, NYLASAPIKEY?: string | undefined, fetch?: typeof fetch | undefined}; export const window = z.object({start: z.string().optional(), end: z.string().optional()}); export const trackingBreakdown = z.object({group_by: z.enum(["sending_domain", "agent_account"]).optional(), window: window.optional(), rows: z.array(z.object({key: z.string().optional(), tracked_opens: z.number().int().optional(), tracked_links: z.number().int().optional(), opened: z.number().int().optional(), clicked: z.number().int().optional(), opens_total: z.number().int().optional(), clicks_total: z.number().int().optional(), open_rate: z.number().nullable().optional(), click_rate: z.number().nullable().optional(), is_others: z.boolean().optional()})).optional()}); export const getApiV3MetricsTrackingResponse = z.object({request_id: z.string().optional(), data: trackingBreakdown.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 }; /** * Return engagement by domain or sender * * GET /v3/metrics/tracking */ export const getApiV3MetricsTracking = async (args: GetApiV3MetricsTrackingArgs, options?: GetApiV3MetricsTrackingOptions) => { const {baseUrl = "https://api.us.nylas.com", fetch: fetchFn = fetch, NYLASAPIKEY} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.group_by != null) query.append("group_by", String(args.group_by)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.start != null) query.append("start", String(args.start)) if (args.end != null) query.append("end", String(args.end)) if (args.sending_domain != null) query.append("sending_domain", String(args.sending_domain)) if (NYLASAPIKEY !== undefined) headers.set('authorization', `Bearer ${NYLASAPIKEY}`) const url = `${baseUrl.replace(/\/+$/, '')}/v3/metrics/tracking${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(getApiV3MetricsTrackingResponse, await res.json()) };