silon-sdk 0.2.0

package/dist/types/client-groups.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Types for the ClientGroups (CRM) resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+import type { ClientProfile } from "./clients.js";
+/** A CRM client group (`/api/v1/crm/group/`). */
+export interface ClientGroup {
+    id: number;
+    name: string;
+    /** Pass as `audience.slug` with `audience.type: "client_group"`. */
+    slug: string;
+    is_active?: boolean;
+    /** Member profiles (read-only; write membership via `client_ids`). */
+    clients?: ClientProfile[];
+}
+/**
+ * Query parameters for {@link ClientGroups.listPaginated} — the canonical,
+ * cursor-paginated list at `GET /api/v1/crm/groups/` (newest first by id).
+ */
+export interface ClientGroupListParams {
+    /** Opaque pagination cursor from a previous page. */
+    cursor?: string | null;
+    /** Page size (default 50, max 100). */
+    limit?: number | null;
+}
+/** Parameters for {@link ClientGroups.create} (`POST /api/v1/crm/groups/`). */
+export interface ClientGroupCreateParams {
+    name: string;
+    slug: string;
+    /** Write-only: `client_id`s that make up the membership. */
+    client_ids?: string[] | null;
+    is_active?: boolean | null;
+}
+/** Parameters for {@link ClientGroups.update} (PATCH — partial). */
+export interface ClientGroupUpdateParams {
+    name?: string | null;
+    slug?: string | null;
+    /** Write-only: REPLACES the whole membership when given. */
+    client_ids?: string[] | null;
+    is_active?: boolean | null;
+}
+/** Parameters for {@link ClientGroups.replace} (PUT — full replace). */
+export interface ClientGroupReplaceParams {
+    name: string;
+    slug: string;
+    /** Write-only: the complete membership after the replace. */
+    client_ids: string[];
+    is_active?: boolean | null;
+}
+//# sourceMappingURL=client-groups.d.ts.map

package/dist/types/client-groups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-groups.d.ts","sourceRoot":"","sources":["../../src/types/client-groups.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,iDAAiD;AACjD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,sEAAsE;IACtE,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,+EAA+E;AAC/E,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AAED,oEAAoE;AACpE,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AAED,wEAAwE;AACxE,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B"}

package/dist/types/client-groups.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the ClientGroups (CRM) resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=client-groups.js.map

package/dist/types/client-groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-groups.js","sourceRoot":"","sources":["../../src/types/client-groups.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/clients.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Types for the Clients (CRM) resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/** A CRM contact (`/api/v1/crm/client/`). */
+export interface ClientProfile {
+    /**
+     * Your stable identifier for this contact — the value passed as
+     * `to.client_id` (or inside an `audience`) when sending a message.
+     */
+    client_id: string;
+    first_name?: string;
+    last_name?: string;
+    email?: string;
+    phone_number?: string;
+    civil_id?: string | null;
+    notes?: string;
+    /** Preferred content language, e.g. `"en"`, `"ar"`. */
+    default_language?: string;
+    /** Channel used when a send does not specify one, e.g. `"whatsapp"`. */
+    default_channel?: string;
+}
+/** Parameters for {@link Clients.create} (`POST /api/v1/crm/client/`). */
+export interface ClientCreateParams {
+    /** Your stable identifier for the contact. Required, immutable. */
+    client_id: string;
+    first_name?: string | null;
+    last_name?: string | null;
+    email?: string | null;
+    phone_number?: string | null;
+    civil_id?: string | null;
+    notes?: string | null;
+    default_language?: string | null;
+    default_channel?: string | null;
+}
+/**
+ * Query parameters for {@link Clients.listPaginated} — the canonical,
+ * cursor-paginated list at `GET /api/v1/crm/clients/` (newest first by
+ * registration date).
+ */
+export interface ClientListParams {
+    /** Opaque pagination cursor from a previous page. */
+    cursor?: string | null;
+    /** Page size (default 50, max 100). */
+    limit?: number | null;
+}
+/**
+ * Parameters for {@link Clients.update} (PATCH — partial) and
+ * {@link Clients.replace} (PUT — full replace). `client_id` itself is
+ * immutable and never part of the body.
+ */
+export interface ClientUpdateParams {
+    first_name?: string | null;
+    last_name?: string | null;
+    email?: string | null;
+    phone_number?: string | null;
+    civil_id?: string | null;
+    notes?: string | null;
+    default_language?: string | null;
+    default_channel?: string | null;
+}
+//# sourceMappingURL=clients.d.ts.map

package/dist/types/clients.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/types/clients.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,6CAA6C;AAC7C,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wEAAwE;IACxE,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,0EAA0E;AAC1E,MAAM,WAAW,kBAAkB;IACjC,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC"}

package/dist/types/clients.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the Clients (CRM) resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=clients.js.map

package/dist/types/clients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/types/clients.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/events.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Event envelope types — the exact JSON returned by the Events API and
+ * POSTed to subscribed webhook endpoints.
+ *
+ * Field names mirror the wire format (snake_case); date-times are ISO-8601
+ * strings.
+ */
+/**
+ * The `data` payload carried inside an event envelope.
+ *
+ * The shape varies by the envelope's `type` — `message.delivered` /
+ * `message.failed` carry a settled-message snapshot, while
+ * `broadcast.completed` carries aggregate counts. Every field is therefore
+ * optional; branch on the parent envelope's `type`.
+ */
+export interface EventData {
+    id?: string | null;
+    object?: string | null;
+    channel?: string | null;
+    recipient?: string | null;
+    client_id?: string | null;
+    status?: string | null;
+    error?: string | null;
+    broadcast_id?: string | null;
+    provider?: string | null;
+    external_id?: string | null;
+    /** ISO-8601 date-time string. */
+    sent_at?: string | null;
+    /** ISO-8601 date-time string. */
+    created_at?: string | null;
+    /** `false` when the underlying send ran in test mode. */
+    livemode?: boolean | null;
+    target_count?: number | null;
+    sent?: number | null;
+    failed?: number | null;
+}
+/** Query parameters for {@link Events.list}. */
+export interface EventListParams {
+    /** Only return events of this type, e.g. `"message.failed"`. */
+    type?: string | null;
+    /** Opaque pagination cursor from a previous page. */
+    cursor?: string | null;
+    /** Page size. */
+    limit?: number | null;
+}
+/** An event envelope. */
+export interface Event {
+    /** Opaque event id, `evt_` prefixed. */
+    id: string;
+    object: string;
+    /** `message.delivered` / `message.failed` / `broadcast.completed`. */
+    type: string;
+    /**
+     * `false` when the event was produced by a test-mode (`sk_test_`) send;
+     * `true` for live traffic. Test events deliver only to `livemode: false`
+     * webhook endpoints, live events only to `livemode: true` ones.
+     */
+    livemode?: boolean;
+    api_version?: string;
+    /** ISO-8601 date-time string. */
+    created?: string | null;
+    data?: EventData;
+}
+//# sourceMappingURL=events.d.ts.map

package/dist/types/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,yDAAyD;IACzD,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAG1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAyB;AACzB,MAAM,WAAW,KAAK;IACpB,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB"}

package/dist/types/events.js

@@ -0,0 +1,9 @@
+/**
+ * Event envelope types — the exact JSON returned by the Events API and
+ * POSTed to subscribed webhook endpoints.
+ *
+ * Field names mirror the wire format (snake_case); date-times are ISO-8601
+ * strings.
+ */
+export {};
+//# sourceMappingURL=events.js.map

package/dist/types/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/types/messages.d.ts

@@ -0,0 +1,334 @@
+/**
+ * Types for the Messages resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+import type { SkippedBreakdown } from "./broadcasts.js";
+/** Parameters for {@link Messages.send} (`POST /api/v1/messages/`). */
+export interface MessageSendParams {
+    /** Delivery channel, e.g. `"sms"`, `"whatsapp"`, `"email"`, `"push"`, `"web_push"`. Required. */
+    channel: string;
+    /**
+     * Single recipient, e.g. `{client_id}`, `{phone_number}`, `{email}` or
+     * `{device_token}`. Exactly one of `to` / `audience` is required.
+     */
+    to?: Record<string, unknown> | null;
+    /**
+     * Broadcast selector, e.g. `{type: "client_group", slug}` or
+     * `{type: "client_ids", client_ids: [...]}`. Exactly one of `to` /
+     * `audience` is required.
+     */
+    audience?: Record<string, unknown> | null;
+    /** Message content, e.g. `{body}` or `{subject, body}` for email. */
+    content?: Record<string, unknown> | null;
+    /**
+     * Stored-template reference (`client.templates`), e.g.
+     * `{slug, context}`. Pin an older immutable revision with an optional
+     * `version` (int): `{slug, version: 3}` — an unknown pinned version rejects
+     * `422 template-version-not-found`; omit `version` to render the latest.
+     */
+    template?: Record<string, unknown> | null;
+    /** Provider override, e.g. `"meta_cloud"`, `"twilio"`, `"fcm"`. */
+    provider?: string | null;
+    /** Sender override (honoured only by providers that support it). */
+    sender?: string | null;
+    /** Push only: application slug the device tokens belong to. */
+    application?: string | null;
+    /** Web-widget messages: the widget key. */
+    widget_key?: string | null;
+    /** Push priority, e.g. `"high"`. */
+    priority?: string | null;
+    /** Push time-to-live, in seconds. */
+    ttl?: number | null;
+    /** WhatsApp-specific free-form options. */
+    whatsapp?: Record<string, unknown> | null;
+    /** WhatsApp template block, e.g. `{name, language, variables}`. */
+    whatsapp_template?: Record<string, unknown> | null;
+    /**
+     * Schedule the send: an ISO-8601 date-time string WITH a UTC offset
+     * (e.g. `"2026-07-15T09:00:00+03:00"`), strictly in the future and at most
+     * 90 days ahead — otherwise the server rejects with `422 send-at-invalid`
+     * (naive date-times are rejected too). The string is passed through
+     * verbatim (this SDK performs no date transformation — for a `Date`, call
+     * `.toISOString()` yourself). The envelope answers `status: "scheduled"`
+     * and the same `id` tracks the send through dispatch; cancel while still
+     * scheduled via {@link Messages.cancel}.
+     */
+    send_at?: string | null;
+    /**
+     * Transactional/legal bypass: deliver even if the recipient is on the
+     * suppression list (`client.suppressions`). Single-recipient sends ONLY,
+     * and the API key must carry the `suppressions:override` scope (in no
+     * default preset — granted explicitly): without it the server rejects
+     * `403 missing-scope`; sent alongside `audience` (or on batches /
+     * broadcasts) it is rejected `422 override-not-allowed`. An overridden
+     * send proceeds and its delivery row is flagged
+     * `suppression_overridden: true`.
+     */
+    override_suppression?: boolean | null;
+    /**
+     * Sent as the `Idempotency-Key` request header — NOT part of the JSON
+     * body. Auto-generated UUIDv4 when omitted, so retries never double-send.
+     */
+    idempotency_key?: string | null;
+    /**
+     * Extra JSON fields merged into the request body last (forward
+     * compatibility escape hatch) — NOT itself a wire field.
+     */
+    extra_body?: Record<string, unknown> | null;
+}
+/** Parameters for {@link Messages.sendBatch} (`POST /api/v1/messages/batch/`). */
+export interface MessageBatchParams {
+    /**
+     * 1–500 message rows, each a free-form map with the same shape as a
+     * {@link Messages.send} body minus `audience` (rows are single-recipient by
+     * definition): `to` (required), optional `channel` (overrides the top-level
+     * default), `content` / `template`, `provider`, `sender`, `application`,
+     * `widget_key`, `priority`, `ttl`, `whatsapp`, `whatsapp_template`.
+     * Exactly one of `messages` / `file` is required.
+     */
+    messages?: Record<string, unknown>[] | null;
+    /**
+     * The saved server-side name of a CSV uploaded via
+     * `client.bulk.files.upload` (the response `name`). Rows expand
+     * asynchronously through the bulk pipeline; CSV columns override the
+     * request-level defaults per row. Exactly one of `messages` / `file` is
+     * required.
+     */
+    file?: string | null;
+    /**
+     * Default channel for every row that doesn't set its own, e.g. `"sms"`,
+     * `"email"`, `"whatsapp"`. A row's own `channel` (or CSV column) wins; one
+     * of the two must yield a channel for every row.
+     */
+    channel?: string | null;
+    /** Default message content for rows without their own, e.g. `{body}`. */
+    content?: Record<string, unknown> | null;
+    /**
+     * Default stored-template reference (`client.templates`), e.g.
+     * `{slug, context}`; pin a revision with an optional `version` (int)
+     * `{slug, version: 3}`. Applies to every row (or CSV column) that doesn't
+     * set its own.
+     */
+    template?: Record<string, unknown> | null;
+    /** Default provider override, e.g. `"meta_cloud"`, `"twilio"`, `"fcm"`. */
+    provider?: string | null;
+    /** Default sender override (honoured only by providers that support it). */
+    sender?: string | null;
+    /** Push only: default application slug the device tokens belong to. */
+    application?: string | null;
+    /** Web-widget messages: default widget key. */
+    widget_key?: string | null;
+    /** Default push priority, e.g. `"high"`. */
+    priority?: string | null;
+    /** Default push time-to-live, in seconds. */
+    ttl?: number | null;
+    /** Default WhatsApp-specific free-form options. */
+    whatsapp?: Record<string, unknown> | null;
+    /** Default WhatsApp template block, e.g. `{name, language, variables}`. */
+    whatsapp_template?: Record<string, unknown> | null;
+    /**
+     * FILE form only: schedule the batch — an ISO-8601 date-time string WITH a
+     * UTC offset, strictly in the future, at most 90 days ahead (otherwise
+     * `422 send-at-invalid`). The envelope answers `status: "scheduled"` and
+     * rows expand + send at dispatch time. Rejected `422 batch-invalid` with
+     * inline `messages` (schedule those individually via {@link Messages.send},
+     * which supports per-message cancel); not a row default. The string is
+     * passed through verbatim (no date transformation).
+     */
+    send_at?: string | null;
+    /**
+     * Sent as the `Idempotency-Key` request header — NOT part of the JSON
+     * body. Auto-generated UUIDv4 when omitted, so retries never double-send.
+     */
+    idempotency_key?: string | null;
+    /**
+     * Extra JSON fields merged into the request body last (forward
+     * compatibility escape hatch) — NOT itself a wire field.
+     */
+    extra_body?: Record<string, unknown> | null;
+}
+/**
+ * Envelope from `POST /api/v1/messages/` (202) — also returned by
+ * {@link Messages.cancel} (200, with `status: "canceled"`).
+ */
+export interface MessageAccepted {
+    /**
+     * Tracking id for the message, or the broadcast id. Stable across the
+     * lifecycle of a scheduled send: the same id resolves before and after
+     * dispatch.
+     */
+    id: string;
+    /** `"message"` for a single recipient, `"broadcast"` for an audience fan-out. */
+    object: string;
+    channel: string;
+    /**
+     * `"queued"` — or `"scheduled"` when the request carried `send_at`
+     * (`"canceled"` from the cancel endpoint).
+     */
+    status: string;
+    /**
+     * `false` when the request ran in test mode (an `sk_test_` key): nothing
+     * reaches a provider and nothing is billed. `true` for live traffic.
+     */
+    livemode?: boolean;
+    /**
+     * Broadcast only: number of recipients targeted (null on scheduled
+     * broadcasts whose audience resolves at dispatch time).
+     */
+    target_count?: number | null;
+    /**
+     * Broadcast only: number of recipients skipped (suppressed, wrong channel,
+     * duplicates) — the sum of the {@link skipped} breakdown.
+     */
+    skipped_count?: number | null;
+    /**
+     * Broadcast only: itemised skip counts summing to `skipped_count` — null
+     * when `target_count` is null (scheduled audience resolves at dispatch);
+     * absent on servers predating the suppression feature.
+     */
+    skipped?: SkippedBreakdown | null;
+}
+/** One per-row message envelope inside a {@link BatchAccepted}. */
+export interface BatchMessage {
+    /** Tracking id for this row — pollable at `GET /api/v1/messages/{id}/`. */
+    id: string;
+    /** Always `"message"`. */
+    object: string;
+    channel: string;
+    status: string;
+}
+/** 202 envelope from `POST /api/v1/messages/batch/`. */
+export interface BatchAccepted {
+    /**
+     * The batch id. On the inline form, poll the per-row message ids instead
+     * (inline batches have no GET endpoint); on the file form this IS the bulk
+     * batch id — per-row status reads via `client.bulk.retrieve(id)` and the
+     * bulk reports.
+     */
+    id: string;
+    /** Always `"batch"`. */
+    object: string;
+    /**
+     * `false` when the batch ran in test mode (an `sk_test_` key): no row
+     * reaches a provider and nothing is billed. `true` for live traffic.
+     */
+    livemode?: boolean;
+    /**
+     * File form only: aggregate batch status — `"queued"`, or `"scheduled"`
+     * when the request carried `send_at` (expansion + send both run at
+     * dispatch time).
+     */
+    status?: string;
+    /**
+     * File form only: number of data rows in the CSV, present only when
+     * cheaply known.
+     */
+    row_count?: number | null;
+    /**
+     * Inline form only: per-row message envelopes, in request order —
+     * suppressed rows are omitted (skipped, never an error). Absent on the
+     * file form (rows expand asynchronously).
+     */
+    messages?: BatchMessage[];
+    /**
+     * Inline form only: number of rows skipped instead of queued — the sum of
+     * the {@link skipped} breakdown. The file form reports its skips on the
+     * bulk read side (`client.bulk.retrieve(id)`) once async expansion runs.
+     */
+    skipped_count?: number | null;
+    /**
+     * Inline form only: itemised skip counts summing to `skipped_count`;
+     * absent on the file form and on servers predating the suppression
+     * feature.
+     */
+    skipped?: SkippedBreakdown | null;
+}
+/** One recipient row inside a message-status batch. */
+export interface MessageStatusItem {
+    client_id?: string;
+    phone_number?: string;
+    email?: string;
+    is_read?: boolean;
+    read_count?: number;
+    /**
+     * `true` when the send bypassed a matching suppression via
+     * `override_suppression` (see {@link MessageSendParams}).
+     */
+    suppression_overridden?: boolean | null;
+}
+/**
+ * One attested status transition in a message's {@link MessageStatus.timeline}.
+ */
+export interface MessageTimelineEntry {
+    /**
+     * The transition's status. Adds `"delivered"` to the aggregate vocabulary:
+     * `"scheduled"`, `"queued"`, `"sent"`, `"delivered"`, `"failed"` or
+     * `"canceled"`. `"delivered"` is per-recipient granularity and appears ONLY
+     * in the timeline (never as the top-level {@link MessageStatus.status}),
+     * only on single-recipient sends whose channel reports receipts.
+     */
+    status: string;
+    /** ISO-8601 date-time the transition was attested at. */
+    at: string;
+    /** The provider that attested it, when known. */
+    provider?: string | null;
+}
+/**
+ * Body of `GET /api/v1/messages/{event_id}/`.
+ *
+ * Prefer the modern keys (`id`, `object`, `channel`, `timeline`). The legacy
+ * keys (`event_id`, `is_sent`, `messages`) remain populated but are
+ * DEPRECATED — see each field.
+ */
+export interface MessageStatus {
+    /**
+     * Tracking id — the same value as the path id (and the create envelope's
+     * `id`). Stable across a scheduled send's lifecycle.
+     */
+    id: string;
+    /** Always `"message"`. */
+    object: string;
+    /**
+     * The resolved channel, or `null` when the delivery rows don't agree on
+     * one.
+     */
+    channel: string | null;
+    /**
+     * Ordered status transitions (ASCENDING by `at`). A scheduled send answers
+     * `[{status: "scheduled", at}]` until dispatch; the timeline's status
+     * vocabulary adds the per-recipient `"delivered"` (see
+     * {@link MessageTimelineEntry}).
+     */
+    timeline: MessageTimelineEntry[];
+    /**
+     * `false` when the send ran in test mode (an `sk_test_` key) — its status
+     * transitions are simulated.
+     */
+    livemode?: boolean;
+    /**
+     * Aggregate lifecycle status: `"scheduled"` (created with `send_at`, not
+     * yet dispatched), `"queued"`, `"sent"`, `"failed"`, or `"canceled"` after
+     * a successful {@link Messages.cancel}. Never `"delivered"` (that appears
+     * only in the {@link timeline}).
+     */
+    status?: string;
+    /** Scheduled sends only: ISO-8601 date-time the send will dispatch at. */
+    send_at?: string | null;
+    /**
+     * @deprecated Alias of {@link id} — prefer `id`. Kept for back-compat.
+     */
+    event_id: string;
+    /**
+     * @deprecated Prefer {@link status} / {@link timeline}. Kept for back-compat.
+     */
+    is_sent: boolean;
+    /**
+     * @deprecated Per-recipient delivery rows — prefer {@link timeline}. Kept
+     * for back-compat; empty while the send is still `"scheduled"` (or was
+     * `"canceled"`).
+     */
+    messages?: MessageStatusItem[];
+}
+//# sourceMappingURL=messages.d.ts.map

package/dist/types/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/types/messages.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,uEAAuE;AACvE,MAAM,WAAW,iBAAiB;IAChC,iGAAiG;IACjG,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1C,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEzC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1C,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1C,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEnD;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,kFAAkF;AAClF,MAAM,WAAW,kBAAkB;IACjC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC;IAE5C;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEzC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1C,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,4EAA4E;IAC5E,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,uEAAuE;IACvE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1C,2EAA2E;IAC3E,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEnD;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,iFAAiF;IACjF,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACnC;AAED,mEAAmE;AACnE,MAAM,WAAW,YAAY;IAC3B,2EAA2E;IAC3E,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wDAAwD;AACxD,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACnC;AAED,uDAAuD;AACvD,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;;;OAKG;IACH,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAChC"}

package/dist/types/messages.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the Messages resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=messages.js.map

package/dist/types/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/types/messages.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/otp.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Types for the OTP resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/** Parameters for {@link Otp.send} (`POST /api/v1/otp/send/`). */
+export interface OtpSendParams {
+    /** Configured OTP purpose slug, e.g. `"login"` — decides the channel. */
+    purpose: string;
+    /**
+     * Recipient — exactly one of `client_id` / `phone_number` / `email`
+     * (validated server-side).
+     */
+    to: Record<string, unknown>;
+    /**
+     * Sent as the `Idempotency-Key` request header — NOT part of the JSON
+     * body. Auto-generated UUIDv4 when omitted, so retries never double-send.
+     */
+    idempotency_key?: string | null;
+}
+/** 202 body of `POST /api/v1/otp/send/`. */
+export interface OtpSendResult {
+    /** Opaque id for this OTP; pass it back to {@link Otp.verify}. */
+    otp_id: string;
+    /**
+     * ISO-8601 date-time string. Verifying after this rejects with
+     * {@link GoneError} (410).
+     */
+    expires_at: string;
+    /** Channel the code was dispatched over (decided by the purpose). */
+    channel: string;
+    /**
+     * `false` when the OTP was issued by a test-mode (`sk_test_`) request —
+     * never dispatched; the magic code `"000000"` verifies.
+     */
+    livemode?: boolean;
+    task_ids?: string[];
+}
+/** Parameters for {@link Otp.verify} (`POST /api/v1/otp/verify/`). */
+export interface OtpVerifyParams {
+    /** The `otp_id` returned by {@link Otp.send}. */
+    otp_id: string;
+    /** The code the user entered (sent verbatim). */
+    code: string;
+}
+/**
+ * 200 body of `POST /api/v1/otp/verify/`.
+ *
+ * A wrong code rejects with {@link BadRequestError} whose `.body` carries
+ * `{"verified": false, "remaining_attempts": N}`.
+ */
+export interface OtpVerifyResult {
+    verified: boolean;
+    purpose: string;
+    /** `false` when the OTP was issued by a test-mode (`sk_test_`) request. */
+    livemode?: boolean;
+    /** ISO-8601 date-time string. */
+    verified_at: string;
+}
+//# sourceMappingURL=otp.d.ts.map

package/dist/types/otp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otp.d.ts","sourceRoot":"","sources":["../../src/types/otp.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,4CAA4C;AAC5C,MAAM,WAAW,aAAa;IAC5B,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,sEAAsE;AACtE,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;CACrB"}