import {z} from 'zod' export type GetApiProductsNotifySendsSendIdStatusArgs = {sendId: string}; export type GetApiProductsNotifySendsSendIdStatusOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const notifyChannelOutcome = z.object({outcome: z.enum(["delivered", "retryable", "deferred", "skipped", "not_implemented", "failed", "bounced", "null"]).nullable().optional(), at: z.number().int().nullable().optional(), step: z.number().int().nullable().optional(), retry_at: z.number().int().nullable().optional(), reason: z.enum(["platform_rate", "platform_hourly", "account_hourly", "provider_throttled", "sending_paused", "sender_identity_unverified", "null"]).nullable().optional()}); export const notifyStatusRecipient = z.object({recipient_id: z.string(), state: z.enum(["pending", "delivered", "undeliverable", "failed", "suppressed", "rate_limited", "recalled"]), enqueued: z.boolean(), seen_at: z.number().int().nullable().optional(), read_at: z.number().int().nullable().optional(), archived_at: z.number().int().nullable().optional(), suppressed_at: z.number().int().nullable().optional(), suppressed_reason: z.enum(["no_channels", "unreachable", "global_off", "category_muted", "all_channels_opted_out", "site_blocked", "identifier_unsubscribed", "account_unavailable", "null"]).nullable().optional(), rate_limited_at: z.number().int().nullable().optional(), channel_outcomes: z.record(z.string(), notifyChannelOutcome), delivered: z.boolean(), undeliverable: z.boolean(), failed: z.boolean()}); export const notifySendStatus = z.object({send_id: z.string(), status: z.enum(["unknown", "pending", "sending", "delivered", "partial", "failed"]), channels: z.array(z.enum(["in_app", "email", "sms", "push", "web_push", "voice", "whatsapp", "rcs", "webhook", "slack", "teams"])).optional(), created_at: z.number().int().optional(), title: z.string().nullable().optional(), category: z.string().nullable().optional(), type: z.string().nullable().optional(), recipients: z.array(notifyStatusRecipient), counts: z.object({total: z.number().int(), enqueued: z.number().int(), seen: z.number().int(), read: z.number().int(), archived: z.number().int(), deferred: z.number().int(), pending: z.number().int(), delivered: z.number().int(), undeliverable: z.number().int(), failed: z.number().int(), suppressed: z.number().int(), rate_limited: z.number().int(), recalled: z.number().int()})}); export const responseMeta = z.object({api_version: z.string().optional(), request_id: z.string().optional(), response_ms: z.number().int().optional(), timestamp: z.number().int().optional(), pools: z.object({}).optional(), billing: z.object({past_due: z.boolean().optional()}).optional(), quota: z.object({limit: z.number().int().optional(), used: z.number().int().optional(), remaining: z.number().int().optional(), resets_at: z.number().int().optional()}).optional()}); export const getApiProductsNotifySendsSendIdStatusResponse = z.object({data: notifySendStatus, meta: responseMeta.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 }; /** * Read send status * * GET /products/notify/sends/{sendId}/status * * Also accepts auth: BearerAuth */ export const getApiProductsNotifySendsSendIdStatus = async (args: GetApiProductsNotifySendsSendIdStatusArgs, options?: GetApiProductsNotifySendsSendIdStatusOptions) => { const {baseUrl = "https://api.sparkvault.com/v1", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("X-API-Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/products/notify/sends/${encodeURIComponent(String(args.sendId))}/status${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(getApiProductsNotifySendsSendIdStatusResponse, await res.json()) };