import {z} from 'zod' export type GetApiMessagesMetricsArgs = {period_start_at?: string | undefined, period_end_at?: string | undefined, granularity?: ('hour' | 'day') | undefined, time_zone?: string | undefined, phone_id?: string | undefined, conversation_id?: string | undefined}; export type GetApiMessagesMetricsOptions = {baseUrl?: string | undefined, apiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const phoneMessageOutcomes = z.object({delivered: z.number().int(), failed: z.number().int(), no_report: z.number().int(), queued: z.number().int(), unconfirmed: z.number().int()}); export const phoneMessageLatency = z.object({p50: z.number().int(), p95: z.number().int()}); export const phoneMessageConversationMetrics = z.object({active: z.number().int(), by_outcome: phoneMessageOutcomes, replied: z.number().int(), reply_latency_ms: phoneMessageLatency, reply_rate: z.number().gte(0).lte(1).nullable(), response_latency_ms: phoneMessageLatency, started: z.number().int(), texted: z.number().int()}); export const phoneMessageFailurePhone = z.object({count: z.number().int(), phone_id: z.string()}); export const phoneMessageFailure = z.object({conversations: z.number().int(), count: z.number().int(), error_code: z.enum(["phone_unreachable", "no_result", "policy_off", "expired", "no_subscription", "no_service", "radio_off", "carrier_rejected", "phone_rate_limited", "media_fetch_failed", "connection_lost", "queue_full", "send_failed"]), numbers: z.number().int(), phones: z.array(phoneMessageFailurePhone).nullable()}); export const phoneMessagePhoneMetrics = z.object({conversations: z.number().int(), delivered: z.number().int(), delivery_rate: z.number().gte(0).lte(1).nullable(), failed: z.number().int(), no_report: z.number().int(), peak_at: z.string().nullable(), peak_sent_30m: z.number().int(), phone_id: z.string(), queued: z.number().int(), received: z.number().int(), sent: z.number().int(), unconfirmed: z.number().int()}); export const phoneMessageMetricsPoint = z.object({delivered: z.number().int(), failed: z.number().int(), no_report: z.number().int(), period_start_at: z.string(), queued: z.number().int(), received: z.number().int(), send_p50_ms: z.number().int().nullable(), send_p95_ms: z.number().int().nullable(), sent: z.number().int(), unconfirmed: z.number().int()}); export const phoneMessageSendLimit = z.object({count: z.number().int(), window_seconds: z.number().int()}); export const phoneMessageMetricsTotals = z.object({delivered: z.number().int(), failed: z.number().int(), no_report: z.number().int(), numbers_received_from: z.number().int(), numbers_texted: z.number().int(), phones_sending: z.number().int(), queued: z.number().int(), received: z.number().int(), sent: z.number().int(), unconfirmed: z.number().int()}); export const phoneMessageMetrics = z.object({conversations: phoneMessageConversationMetrics, delivery_latency_ms: phoneMessageLatency, delivery_rate: z.number().gte(0).lte(1).nullable(), failures: z.array(phoneMessageFailure).nullable(), period_end_at: z.string(), period_start_at: z.string(), phones: z.array(phoneMessagePhoneMetrics).nullable(), points: z.array(phoneMessageMetricsPoint).nullable(), send_latency_ms: phoneMessageLatency, send_limit: phoneMessageSendLimit, totals: phoneMessageMetricsTotals}); 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 }; /** * Get message metrics * * GET /messages/metrics */ export const getApiMessagesMetrics = async (args: GetApiMessagesMetricsArgs, options?: GetApiMessagesMetricsOptions) => { const {baseUrl = "https://api.axilio.ai/api/v1", fetch: fetchFn = fetch, apiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.period_start_at != null) query.append("period_start_at", String(args.period_start_at)) if (args.period_end_at != null) query.append("period_end_at", String(args.period_end_at)) if (args.granularity != null) query.append("granularity", String(args.granularity)) if (args.time_zone != null) query.append("time_zone", String(args.time_zone)) if (args.phone_id != null) query.append("phone_id", String(args.phone_id)) if (args.conversation_id != null) query.append("conversation_id", String(args.conversation_id)) if (apiKeyAuth !== undefined) headers.set("X-Axilio-Api-Key", apiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/messages/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(phoneMessageMetrics, await res.json()) };