silon-sdk 0.2.0

package/dist/resources/clients.js

@@ -0,0 +1,99 @@
+/** The Clients resource — CRM contact profiles. */
+import { dropNull, emitDeprecationWarning } from "../internal/utils.js";
+import { Page } from "../pagination.js";
+// Canonical plural route (C2): cursor-paginated LIST + all single-object CRUD.
+const CLIENTS_PATH = "/api/v1/crm/clients/";
+// Deprecated singular route, frozen: its LIST returns a bare JSON array.
+const CLIENTS_LEGACY_PATH = "/api/v1/crm/client/";
+/** Build a client-profile body, omitting absent fields (SPEC 7). */
+function clientBody(params) {
+    return dropNull({
+        client_id: params.client_id,
+        first_name: params.first_name,
+        last_name: params.last_name,
+        email: params.email,
+        phone_number: params.phone_number,
+        civil_id: params.civil_id,
+        notes: params.notes,
+        default_language: params.default_language,
+        default_channel: params.default_channel,
+    });
+}
+/** `client.clients` — manage CRM contact profiles. */
+export class Clients {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /**
+     * List every contact as a bare array (`GET /api/v1/crm/client/`).
+     *
+     * This eagerly returns ALL contacts as a plain `ClientProfile[]` from the
+     * deprecated singular route (frozen: never cursor-paginated). Its call
+     * signature and return type are preserved for back-compat.
+     *
+     * @deprecated Prefer {@link Clients.listPaginated}, which pages the canonical
+     *   `GET /api/v1/crm/clients/` route lazily and scales past the singular
+     *   route's unbounded response. Calling this emits a one-time
+     *   `DeprecationWarning`.
+     */
+    async list() {
+        emitDeprecationWarning("SILON_CRM_CLIENTS_LIST", "silon: clients.list() (GET /api/v1/crm/client/) returns a bare, " +
+            "unpaginated array from the deprecated singular route - prefer " +
+            "clients.listPaginated() (GET /api/v1/crm/clients/), which is cursor-paginated.");
+        const data = await this.#client.request("GET", CLIENTS_LEGACY_PATH);
+        return data;
+    }
+    /**
+     * List contacts, cursor-paginated, newest first
+     * (`GET /api/v1/crm/clients/` — the canonical C2 route). Returns a
+     * {@link Page} you can walk manually or drain with `autoPaging()`.
+     *
+     * ```ts
+     * const page = await client.clients.listPaginated({ limit: 100 });
+     * for (const contact of page.results) { ... }          // this page only
+     * for await (const contact of page.autoPaging()) { ... } // every page, lazily
+     * ```
+     */
+    async listPaginated(params = {}) {
+        const query = dropNull({
+            cursor: params.cursor,
+            limit: params.limit,
+        });
+        const data = (await this.#client.request("GET", CLIENTS_PATH, {
+            query,
+        }));
+        return new Page(this.#client, CLIENTS_PATH, query, data);
+    }
+    /** Create a contact (`POST /api/v1/crm/clients/`). */
+    async create(params) {
+        const data = await this.#client.request("POST", CLIENTS_PATH, { body: clientBody(params) });
+        return data;
+    }
+    /** Fetch one contact (`GET /api/v1/crm/clients/{client_id}/`). */
+    async retrieve(clientId) {
+        const data = await this.#client.request("GET", `${CLIENTS_PATH}${encodeURIComponent(clientId)}/`);
+        return data;
+    }
+    /**
+     * Partial update (`PATCH /api/v1/crm/clients/{client_id}/`) — only the
+     * given fields change.
+     */
+    async update(clientId, params = {}) {
+        const data = await this.#client.request("PATCH", `${CLIENTS_PATH}${encodeURIComponent(clientId)}/`, { body: clientBody(params) });
+        return data;
+    }
+    /**
+     * Full replace (`PUT /api/v1/crm/clients/{client_id}/`). `client_id` itself
+     * is immutable.
+     */
+    async replace(clientId, params = {}) {
+        const data = await this.#client.request("PUT", `${CLIENTS_PATH}${encodeURIComponent(clientId)}/`, { body: clientBody(params) });
+        return data;
+    }
+    /** Delete a contact (`DELETE /api/v1/crm/clients/{client_id}/`, 204). */
+    async delete(clientId) {
+        await this.#client.request("DELETE", `${CLIENTS_PATH}${encodeURIComponent(clientId)}/`);
+    }
+}
+//# sourceMappingURL=clients.js.map

package/dist/resources/clients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/resources/clients.ts"],"names":[],"mappings":"AAAA,mDAAmD;AAGnD,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAQ7D,+EAA+E;AAC/E,MAAM,YAAY,GAAG,sBAAsB,CAAC;AAC5C,yEAAyE;AACzE,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;AAElD,oEAAoE;AACpE,SAAS,UAAU,CAAC,MAAmD;IACrE,OAAO,QAAQ,CAAC;QACd,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,eAAe,EAAE,MAAM,CAAC,eAAe;KACxC,CAAC,CAAC;AACL,CAAC;AAED,sDAAsD;AACtD,MAAM,OAAO,OAAO;IACT,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI;QACR,sBAAsB,CACpB,wBAAwB,EACxB,kEAAkE;YAChE,gEAAgE;YAChE,gFAAgF,CACnF,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;QACpE,OAAO,IAAuB,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CAAC,SAA2B,EAAE;QAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAgB,CAAC;QAClB,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE;YAC5D,KAAK;SACN,CAAC,CAAkC,CAAC;QACrC,OAAO,IAAI,IAAI,CAAgB,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,MAAM,CAAC,MAA0B;QACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED,kEAAkE;IAClE,KAAK,CAAC,QAAQ,CAAC,QAAgB;QAC7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,KAAK,EACL,GAAG,YAAY,GAAG,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAClD,CAAC;QACF,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,SAA6B,EAAE;QAC5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,OAAO,EACP,GAAG,YAAY,GAAG,kBAAkB,CAAC,QAAQ,CAAC,GAAG,EACjD,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAC7B,CAAC;QACF,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,SAA6B,EAAE;QAC7D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,KAAK,EACL,GAAG,YAAY,GAAG,kBAAkB,CAAC,QAAQ,CAAC,GAAG,EACjD,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAC7B,CAAC;QACF,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,MAAM,CAAC,QAAgB;QAC3B,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,YAAY,GAAG,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC1F,CAAC;CACF"}

package/dist/resources/events.d.ts

@@ -0,0 +1,22 @@
+/** The Events resource — the stream your webhooks are fed from. */
+import type { Silon } from "../client.js";
+import { Page } from "../pagination.js";
+import type { Event, EventListParams } from "../types/events.js";
+/** `client.events` — read the event stream (newest first). */
+export declare class Events {
+    #private;
+    constructor(client: Silon);
+    /**
+     * List events, cursor-paginated (`GET /api/v1/events`). Filter with
+     * `type`, e.g. `{type: "message.failed"}`.
+     *
+     * ```ts
+     * const page = await client.events.list({ type: "message.failed" });
+     * for await (const event of page.autoPaging()) { ... }
+     * ```
+     */
+    list(params?: EventListParams): Promise<Page<Event>>;
+    /** Fetch a single event envelope by id (`GET /api/v1/events/{id}`). */
+    retrieve(eventId: string): Promise<Event>;
+}
+//# sourceMappingURL=events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/resources/events.ts"],"names":[],"mappings":"AAAA,mEAAmE;AAEnE,OAAO,KAAK,EAAe,KAAK,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAKjE,8DAA8D;AAC9D,qBAAa,MAAM;;gBAGL,MAAM,EAAE,KAAK;IAIzB;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,GAAE,eAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAY9D,uEAAuE;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;CAOhD"}

package/dist/resources/events.js

@@ -0,0 +1,38 @@
+/** The Events resource — the stream your webhooks are fed from. */
+import { dropNull } from "../internal/utils.js";
+import { Page } from "../pagination.js";
+// NOTE: no trailing slashes on this resource (SPEC 7).
+const EVENTS_PATH = "/api/v1/events";
+/** `client.events` — read the event stream (newest first). */
+export class Events {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /**
+     * List events, cursor-paginated (`GET /api/v1/events`). Filter with
+     * `type`, e.g. `{type: "message.failed"}`.
+     *
+     * ```ts
+     * const page = await client.events.list({ type: "message.failed" });
+     * for await (const event of page.autoPaging()) { ... }
+     * ```
+     */
+    async list(params = {}) {
+        const query = dropNull({
+            type: params.type,
+            cursor: params.cursor,
+            limit: params.limit,
+        });
+        const data = (await this.#client.request("GET", EVENTS_PATH, {
+            query,
+        }));
+        return new Page(this.#client, EVENTS_PATH, query, data);
+    }
+    /** Fetch a single event envelope by id (`GET /api/v1/events/{id}`). */
+    async retrieve(eventId) {
+        const data = await this.#client.request("GET", `${EVENTS_PATH}/${encodeURIComponent(eventId)}`);
+        return data;
+    }
+}
+//# sourceMappingURL=events.js.map

package/dist/resources/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/resources/events.ts"],"names":[],"mappings":"AAAA,mEAAmE;AAGnE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAG7D,uDAAuD;AACvD,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAErC,8DAA8D;AAC9D,MAAM,OAAO,MAAM;IACR,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,SAA0B,EAAE;QACrC,MAAM,KAAK,GAAG,QAAQ,CAAC;YACrB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAgB,CAAC;QAClB,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE;YAC3D,KAAK;SACN,CAAC,CAA0B,CAAC;QAC7B,OAAO,IAAI,IAAI,CAAQ,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;IAED,uEAAuE;IACvE,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,KAAK,EACL,GAAG,WAAW,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAChD,CAAC;QACF,OAAO,IAAa,CAAC;IACvB,CAAC;CACF"}

package/dist/resources/messages.d.ts

@@ -0,0 +1,99 @@
+/** The Messages resource — unified send across every channel. */
+import type { Silon } from "../client.js";
+import type { BatchAccepted, MessageAccepted, MessageBatchParams, MessageSendParams, MessageStatus } from "../types/messages.js";
+/** `client.messages` — send messages and look up their delivery status. */
+export declare class Messages {
+    #private;
+    constructor(client: Silon);
+    /**
+     * Send a message on any channel (`POST /api/v1/messages/`).
+     *
+     * Exactly one of `to` (single recipient, e.g. `{client_id}`,
+     * `{phone_number}`, `{email}`, `{device_token}`) or `audience` (broadcast
+     * selector, e.g. `{type: "client_group", slug}` /
+     * `{type: "client_ids", client_ids: [...]}`) is required — enforced
+     * client-side.
+     *
+     * Pass `send_at` (an ISO-8601 date-time string with a UTC offset, strictly
+     * in the future, at most 90 days ahead — else `422 send-at-invalid`) to
+     * schedule the send: the envelope answers `status: "scheduled"` and the
+     * same `id` tracks it through dispatch; cancel while still scheduled via
+     * {@link cancel}.
+     *
+     * Sending to an address on the suppression list (`client.suppressions`)
+     * rejects `422 recipient-suppressed`. Transactional/legal sends may pass
+     * `override_suppression: true` to bypass it — single-recipient sends only,
+     * and the key must carry the `suppressions:override` scope (else
+     * `403 missing-scope`); the delivery row is then flagged
+     * `suppression_overridden: true`.
+     *
+     * An `Idempotency-Key` header is always sent (auto-generated UUIDv4 when
+     * `idempotency_key` is not given), which makes automatic retries safe.
+     * Channel-specific fields not covered by the typed params can be passed
+     * through `extra_body`, which is merged into the JSON body last.
+     *
+     * @throws {SilonError} when neither or both of `to` / `audience` are given.
+     */
+    send(params: MessageSendParams): Promise<MessageAccepted>;
+    /**
+     * Send a batch of independent, personalised messages in one call
+     * (`POST /api/v1/messages/batch/`).
+     *
+     * Exactly one of `messages` (inline rows) or `file` (the saved name of a
+     * CSV uploaded via `client.bulk.files.upload`) is required — enforced
+     * client-side. Request-level fields (`channel`, `content`, `template`,
+     * `provider`, `sender`, `application`, `widget_key`, `priority`, `ttl`,
+     * `whatsapp`, `whatsapp_template`) act as row defaults on both forms; a
+     * row's own field (or CSV column) always wins.
+     *
+     * INLINE form: up to 500 rows, each a free-form map with the same shape as
+     * a {@link send} body minus `audience` (rows are single-recipient by
+     * definition): `to` is required. Validation is all-or-nothing: any invalid
+     * row fails the whole batch with a `422` whose `attr` carries a per-index
+     * path (`messages[3].to.phone_number`) and nothing is queued. The 202
+     * response carries per-row envelopes in request order; each `id` is
+     * individually pollable via {@link retrieve}. Inline batches have no GET
+     * endpoint — for one content fanned out to an audience, use
+     * `client.broadcasts.create` instead.
+     *
+     * FILE form: rows expand asynchronously through the bulk pipeline. The 202
+     * response is the aggregate batch object (`status: "queued"`, `row_count`
+     * when cheaply known) WITHOUT per-row `messages`; the returned `id` is the
+     * bulk batch id — per-row status via `client.bulk.retrieve(id)` and the
+     * bulk reports. An unknown `file` name is a 404 (`file-not-found`). The
+     * file form also accepts `send_at` (ISO-8601 with a UTC offset, future,
+     * at most 90 days ahead) to schedule the batch — the envelope answers
+     * `status: "scheduled"` and rows expand + send at dispatch time; `send_at`
+     * with inline `messages` is rejected `422 batch-invalid` (schedule those
+     * individually via {@link send}, which supports per-message cancel).
+     *
+     * An `Idempotency-Key` header is always sent (auto-generated UUIDv4 when
+     * `idempotency_key` is not given), which makes automatic retries safe.
+     * Extra top-level fields can be passed through `extra_body`, which is
+     * merged into the JSON body last.
+     *
+     * @throws {SilonError} when neither or both of `messages` / `file` are given.
+     */
+    sendBatch(params: MessageBatchParams): Promise<BatchAccepted>;
+    /**
+     * Look up a queued/sent message batch by its tracking id
+     * (`GET /api/v1/messages/{event_id}/`). A send created with `send_at`
+     * answers `status: "scheduled"` (with empty `messages`) until dispatch,
+     * then the normal lifecycle — the id is stable across it.
+     */
+    retrieve(eventId: string): Promise<MessageStatus>;
+    /**
+     * Cancel a scheduled message
+     * (`POST /api/v1/messages/{event_id}/cancel/`).
+     *
+     * Allowed only while the send is still `"scheduled"`: resolves with the
+     * envelope showing `status: "canceled"`; a canceled send never dispatches
+     * and emits a `message.canceled` event. Canceling an already-canceled send
+     * is safe and resolves with the same envelope again (cancel is idempotent
+     * by nature — no `Idempotency-Key` is sent). Once dispatched (or for an
+     * immediate send's id) the server rejects with `409 not-cancellable`; an
+     * unknown id rejects with `404`.
+     */
+    cancel(eventId: string): Promise<MessageAccepted>;
+}
+//# sourceMappingURL=messages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/resources/messages.ts"],"names":[],"mappings":"AAAA,iEAAiE;AAIjE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAG1C,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAK9B,2EAA2E;AAC3E,qBAAa,QAAQ;;gBAGP,MAAM,EAAE,KAAK;IAIzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC;IAgC/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IA+BnE;;;;;OAKG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAQvD;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;CAOxD"}

package/dist/resources/messages.js

@@ -0,0 +1,167 @@
+/** The Messages resource — unified send across every channel. */
+import { randomUUID } from "node:crypto";
+import { SilonError } from "../errors.js";
+import { dropNull } from "../internal/utils.js";
+const MESSAGES_PATH = "/api/v1/messages/";
+const MESSAGES_BATCH_PATH = "/api/v1/messages/batch/";
+/** `client.messages` — send messages and look up their delivery status. */
+export class Messages {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /**
+     * Send a message on any channel (`POST /api/v1/messages/`).
+     *
+     * Exactly one of `to` (single recipient, e.g. `{client_id}`,
+     * `{phone_number}`, `{email}`, `{device_token}`) or `audience` (broadcast
+     * selector, e.g. `{type: "client_group", slug}` /
+     * `{type: "client_ids", client_ids: [...]}`) is required — enforced
+     * client-side.
+     *
+     * Pass `send_at` (an ISO-8601 date-time string with a UTC offset, strictly
+     * in the future, at most 90 days ahead — else `422 send-at-invalid`) to
+     * schedule the send: the envelope answers `status: "scheduled"` and the
+     * same `id` tracks it through dispatch; cancel while still scheduled via
+     * {@link cancel}.
+     *
+     * Sending to an address on the suppression list (`client.suppressions`)
+     * rejects `422 recipient-suppressed`. Transactional/legal sends may pass
+     * `override_suppression: true` to bypass it — single-recipient sends only,
+     * and the key must carry the `suppressions:override` scope (else
+     * `403 missing-scope`); the delivery row is then flagged
+     * `suppression_overridden: true`.
+     *
+     * An `Idempotency-Key` header is always sent (auto-generated UUIDv4 when
+     * `idempotency_key` is not given), which makes automatic retries safe.
+     * Channel-specific fields not covered by the typed params can be passed
+     * through `extra_body`, which is merged into the JSON body last.
+     *
+     * @throws {SilonError} when neither or both of `to` / `audience` are given.
+     */
+    async send(params) {
+        const { idempotency_key, extra_body, ...fields } = params;
+        if ((fields.to == null) === (fields.audience == null)) {
+            throw new SilonError("Provide exactly one of 'to' (single recipient) or 'audience' (broadcast).");
+        }
+        const body = dropNull({
+            channel: fields.channel,
+            to: fields.to,
+            audience: fields.audience,
+            content: fields.content,
+            template: fields.template,
+            provider: fields.provider,
+            sender: fields.sender,
+            application: fields.application,
+            widget_key: fields.widget_key,
+            priority: fields.priority,
+            ttl: fields.ttl,
+            whatsapp: fields.whatsapp,
+            whatsapp_template: fields.whatsapp_template,
+            send_at: fields.send_at,
+            override_suppression: fields.override_suppression,
+        });
+        if (extra_body)
+            Object.assign(body, extra_body);
+        const data = await this.#client.request("POST", MESSAGES_PATH, {
+            body,
+            headers: { "Idempotency-Key": idempotency_key ?? randomUUID() },
+        });
+        return data;
+    }
+    /**
+     * Send a batch of independent, personalised messages in one call
+     * (`POST /api/v1/messages/batch/`).
+     *
+     * Exactly one of `messages` (inline rows) or `file` (the saved name of a
+     * CSV uploaded via `client.bulk.files.upload`) is required — enforced
+     * client-side. Request-level fields (`channel`, `content`, `template`,
+     * `provider`, `sender`, `application`, `widget_key`, `priority`, `ttl`,
+     * `whatsapp`, `whatsapp_template`) act as row defaults on both forms; a
+     * row's own field (or CSV column) always wins.
+     *
+     * INLINE form: up to 500 rows, each a free-form map with the same shape as
+     * a {@link send} body minus `audience` (rows are single-recipient by
+     * definition): `to` is required. Validation is all-or-nothing: any invalid
+     * row fails the whole batch with a `422` whose `attr` carries a per-index
+     * path (`messages[3].to.phone_number`) and nothing is queued. The 202
+     * response carries per-row envelopes in request order; each `id` is
+     * individually pollable via {@link retrieve}. Inline batches have no GET
+     * endpoint — for one content fanned out to an audience, use
+     * `client.broadcasts.create` instead.
+     *
+     * FILE form: rows expand asynchronously through the bulk pipeline. The 202
+     * response is the aggregate batch object (`status: "queued"`, `row_count`
+     * when cheaply known) WITHOUT per-row `messages`; the returned `id` is the
+     * bulk batch id — per-row status via `client.bulk.retrieve(id)` and the
+     * bulk reports. An unknown `file` name is a 404 (`file-not-found`). The
+     * file form also accepts `send_at` (ISO-8601 with a UTC offset, future,
+     * at most 90 days ahead) to schedule the batch — the envelope answers
+     * `status: "scheduled"` and rows expand + send at dispatch time; `send_at`
+     * with inline `messages` is rejected `422 batch-invalid` (schedule those
+     * individually via {@link send}, which supports per-message cancel).
+     *
+     * An `Idempotency-Key` header is always sent (auto-generated UUIDv4 when
+     * `idempotency_key` is not given), which makes automatic retries safe.
+     * Extra top-level fields can be passed through `extra_body`, which is
+     * merged into the JSON body last.
+     *
+     * @throws {SilonError} when neither or both of `messages` / `file` are given.
+     */
+    async sendBatch(params) {
+        const { idempotency_key, extra_body, ...fields } = params;
+        if ((fields.messages == null) === (fields.file == null)) {
+            throw new SilonError("Provide exactly one of 'messages' (inline rows) or 'file' (a saved CSV name).");
+        }
+        const body = dropNull({
+            channel: fields.channel,
+            messages: fields.messages,
+            file: fields.file,
+            content: fields.content,
+            template: fields.template,
+            provider: fields.provider,
+            sender: fields.sender,
+            application: fields.application,
+            widget_key: fields.widget_key,
+            priority: fields.priority,
+            ttl: fields.ttl,
+            whatsapp: fields.whatsapp,
+            whatsapp_template: fields.whatsapp_template,
+            send_at: fields.send_at,
+        });
+        if (extra_body)
+            Object.assign(body, extra_body);
+        const data = await this.#client.request("POST", MESSAGES_BATCH_PATH, {
+            body,
+            headers: { "Idempotency-Key": idempotency_key ?? randomUUID() },
+        });
+        return data;
+    }
+    /**
+     * Look up a queued/sent message batch by its tracking id
+     * (`GET /api/v1/messages/{event_id}/`). A send created with `send_at`
+     * answers `status: "scheduled"` (with empty `messages`) until dispatch,
+     * then the normal lifecycle — the id is stable across it.
+     */
+    async retrieve(eventId) {
+        const data = await this.#client.request("GET", `${MESSAGES_PATH}${encodeURIComponent(eventId)}/`);
+        return data;
+    }
+    /**
+     * Cancel a scheduled message
+     * (`POST /api/v1/messages/{event_id}/cancel/`).
+     *
+     * Allowed only while the send is still `"scheduled"`: resolves with the
+     * envelope showing `status: "canceled"`; a canceled send never dispatches
+     * and emits a `message.canceled` event. Canceling an already-canceled send
+     * is safe and resolves with the same envelope again (cancel is idempotent
+     * by nature — no `Idempotency-Key` is sent). Once dispatched (or for an
+     * immediate send's id) the server rejects with `409 not-cancellable`; an
+     * unknown id rejects with `404`.
+     */
+    async cancel(eventId) {
+        const data = await this.#client.request("POST", `${MESSAGES_PATH}${encodeURIComponent(eventId)}/cancel/`);
+        return data;
+    }
+}
+//# sourceMappingURL=messages.js.map

package/dist/resources/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/resources/messages.ts"],"names":[],"mappings":"AAAA,iEAAiE;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAShD,MAAM,aAAa,GAAG,mBAAmB,CAAC;AAC1C,MAAM,mBAAmB,GAAG,yBAAyB,CAAC;AAEtD,2EAA2E;AAC3E,MAAM,OAAO,QAAQ;IACV,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,IAAI,CAAC,MAAyB;QAClC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,UAAU,CAClB,2EAA2E,CAC5E,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC;YACpB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;YAC3C,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;SAClD,CAAC,CAAC;QACH,IAAI,UAAU;YAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE;YAC7D,IAAI;YACJ,OAAO,EAAE,EAAE,iBAAiB,EAAE,eAAe,IAAI,UAAU,EAAE,EAAE;SAChE,CAAC,CAAC;QACH,OAAO,IAAuB,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,SAAS,CAAC,MAA0B;QACxC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,UAAU,CAClB,+EAA+E,CAChF,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC;YACpB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;YAC3C,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC,CAAC;QACH,IAAI,UAAU;YAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,mBAAmB,EAAE;YACnE,IAAI;YACJ,OAAO,EAAE,EAAE,iBAAiB,EAAE,eAAe,IAAI,UAAU,EAAE,EAAE;SAChE,CAAC,CAAC;QACH,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,KAAK,EACL,GAAG,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAClD,CAAC;QACF,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,MAAM,EACN,GAAG,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CACzD,CAAC;QACF,OAAO,IAAuB,CAAC;IACjC,CAAC;CACF"}

package/dist/resources/otp.d.ts

@@ -0,0 +1,26 @@
+/** The OTP resource — send and verify one-time passwords. */
+import type { Silon } from "../client.js";
+import type { OtpSendParams, OtpSendResult, OtpVerifyParams, OtpVerifyResult } from "../types/otp.js";
+/** `client.otp` — one-time-password dispatch and verification. */
+export declare class Otp {
+    #private;
+    constructor(client: Silon);
+    /**
+     * Dispatch a one-time password (`POST /api/v1/otp/send/`, 202).
+     *
+     * `to` must contain exactly one of `client_id` / `phone_number` / `email`;
+     * the delivery channel is decided by the configured `purpose`. An
+     * `Idempotency-Key` header is always sent (auto-generated UUIDv4 when
+     * `idempotency_key` is not given), which makes automatic retries safe.
+     */
+    send(params: OtpSendParams): Promise<OtpSendResult>;
+    /**
+     * Verify a code (`POST /api/v1/otp/verify/`).
+     *
+     * A wrong code rejects with {@link BadRequestError} whose `.body` carries
+     * `{verified: false, remaining_attempts: N}`; an expired one rejects with
+     * {@link GoneError} (410).
+     */
+    verify(params: OtpVerifyParams): Promise<OtpVerifyResult>;
+}
+//# sourceMappingURL=otp.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"otp.d.ts","sourceRoot":"","sources":["../../src/resources/otp.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAI7D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAKtG,kEAAkE;AAClE,qBAAa,GAAG;;gBAGF,MAAM,EAAE,KAAK;IAIzB;;;;;;;OAOG;IACG,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAQzD;;;;;;OAMG;IACG,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAMhE"}

package/dist/resources/otp.js

@@ -0,0 +1,40 @@
+/** The OTP resource — send and verify one-time passwords. */
+import { randomUUID } from "node:crypto";
+const SEND_PATH = "/api/v1/otp/send/";
+const VERIFY_PATH = "/api/v1/otp/verify/";
+/** `client.otp` — one-time-password dispatch and verification. */
+export class Otp {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /**
+     * Dispatch a one-time password (`POST /api/v1/otp/send/`, 202).
+     *
+     * `to` must contain exactly one of `client_id` / `phone_number` / `email`;
+     * the delivery channel is decided by the configured `purpose`. An
+     * `Idempotency-Key` header is always sent (auto-generated UUIDv4 when
+     * `idempotency_key` is not given), which makes automatic retries safe.
+     */
+    async send(params) {
+        const data = await this.#client.request("POST", SEND_PATH, {
+            body: { purpose: params.purpose, to: params.to },
+            headers: { "Idempotency-Key": params.idempotency_key ?? randomUUID() },
+        });
+        return data;
+    }
+    /**
+     * Verify a code (`POST /api/v1/otp/verify/`).
+     *
+     * A wrong code rejects with {@link BadRequestError} whose `.body` carries
+     * `{verified: false, remaining_attempts: N}`; an expired one rejects with
+     * {@link GoneError} (410).
+     */
+    async verify(params) {
+        const data = await this.#client.request("POST", VERIFY_PATH, {
+            body: { otp_id: params.otp_id, code: params.code },
+        });
+        return data;
+    }
+}
+//# sourceMappingURL=otp.js.map

package/dist/resources/otp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otp.js","sourceRoot":"","sources":["../../src/resources/otp.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,MAAM,SAAS,GAAG,mBAAmB,CAAC;AACtC,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAE1C,kEAAkE;AAClE,MAAM,OAAO,GAAG;IACL,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CAAC,MAAqB;QAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE;YACzD,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE;YAChD,OAAO,EAAE,EAAE,iBAAiB,EAAE,MAAM,CAAC,eAAe,IAAI,UAAU,EAAE,EAAE;SACvE,CAAC,CAAC;QACH,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,MAAuB;QAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE;YAC3D,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;SACnD,CAAC,CAAC;QACH,OAAO,IAAuB,CAAC;IACjC,CAAC;CACF"}

package/dist/resources/profile.d.ts

@@ -0,0 +1,18 @@
+/** The Profile resource — the authenticated user's own profile. */
+import type { Silon } from "../client.js";
+import type { ProfileReplaceParams, ProfileUpdateParams, UserProfile } from "../types/profile.js";
+/** `client.profile` — the authenticated user's own profile. */
+export declare class Profile {
+    #private;
+    constructor(client: Silon);
+    /** Fetch the profile (`GET /api/v1/profile/`). */
+    retrieve(): Promise<UserProfile>;
+    /**
+     * Partial update (`PATCH /api/v1/profile/`) — only the given fields
+     * change.
+     */
+    update(params?: ProfileUpdateParams): Promise<UserProfile>;
+    /** Full replace (`PUT /api/v1/profile/`). */
+    replace(params: ProfileReplaceParams): Promise<UserProfile>;
+}
+//# sourceMappingURL=profile.d.ts.map

package/dist/resources/profile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../../src/resources/profile.ts"],"names":[],"mappings":"AAAA,mEAAmE;AAEnE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAgB7B,+DAA+D;AAC/D,qBAAa,OAAO;;gBAGN,MAAM,EAAE,KAAK;IAIzB,kDAAkD;IAC5C,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;IAKtC;;;OAGG;IACG,MAAM,CAAC,MAAM,GAAE,mBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAKpE,6CAA6C;IACvC,OAAO,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC;CAIlE"}

package/dist/resources/profile.js

@@ -0,0 +1,40 @@
+/** The Profile resource — the authenticated user's own profile. */
+import { dropNull } from "../internal/utils.js";
+const PROFILE_PATH = "/api/v1/profile/";
+/** Build a profile body, omitting absent fields (SPEC 7). */
+function profileBody(params) {
+    return dropNull({
+        email: params.email,
+        first_name: params.first_name,
+        last_name: params.last_name,
+        phone_number: params.phone_number,
+        civil_id: params.civil_id,
+        default_language: params.default_language,
+    });
+}
+/** `client.profile` — the authenticated user's own profile. */
+export class Profile {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /** Fetch the profile (`GET /api/v1/profile/`). */
+    async retrieve() {
+        const data = await this.#client.request("GET", PROFILE_PATH);
+        return data;
+    }
+    /**
+     * Partial update (`PATCH /api/v1/profile/`) — only the given fields
+     * change.
+     */
+    async update(params = {}) {
+        const data = await this.#client.request("PATCH", PROFILE_PATH, { body: profileBody(params) });
+        return data;
+    }
+    /** Full replace (`PUT /api/v1/profile/`). */
+    async replace(params) {
+        const data = await this.#client.request("PUT", PROFILE_PATH, { body: profileBody(params) });
+        return data;
+    }
+}
+//# sourceMappingURL=profile.js.map

package/dist/resources/profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.js","sourceRoot":"","sources":["../../src/resources/profile.ts"],"names":[],"mappings":"AAAA,mEAAmE;AAGnE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAOhD,MAAM,YAAY,GAAG,kBAAkB,CAAC;AAExC,6DAA6D;AAC7D,SAAS,WAAW,CAAC,MAA2B;IAC9C,OAAO,QAAQ,CAAC;QACd,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;KAC1C,CAAC,CAAC;AACL,CAAC;AAED,+DAA+D;AAC/D,MAAM,OAAO,OAAO;IACT,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,kDAAkD;IAClD,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAC7D,OAAO,IAAmB,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,SAA8B,EAAE;QAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC9F,OAAO,IAAmB,CAAC;IAC7B,CAAC;IAED,6CAA6C;IAC7C,KAAK,CAAC,OAAO,CAAC,MAA4B;QACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAmB,CAAC;IAC7B,CAAC;CACF"}

package/dist/resources/push.d.ts

@@ -0,0 +1,45 @@
+/** The Push resource — device registration and native notification feeds. */
+import type { Silon } from "../client.js";
+import type { MarkReadResult, PushClientDevices, PushListNotificationsOptions, PushMarkReadParams, PushNotification, PushSubscribeAndroidParams, PushSubscribeIosParams, PushSubscribeWebParams, PushUpsertDevicesParams, SubscribeResult, WebPushSubscription } from "../types/push.js";
+/** `client.push` — mobile / web push registration and notification feeds. */
+export declare class Push {
+    #private;
+    constructor(client: Silon);
+    /**
+     * Register an Android device token for the app `slug`
+     * (`POST /api/v1/subscribe/android/`).
+     */
+    subscribeAndroid(params: PushSubscribeAndroidParams): Promise<SubscribeResult>;
+    /**
+     * Register an iOS device token (`POST /api/v1/subscribe/ios/`).
+     * `environment`: `"dev"` or `"prod"`.
+     */
+    subscribeIos(params: PushSubscribeIosParams): Promise<SubscribeResult>;
+    /**
+     * Register (or prune, with `keep_devices: false`) a client's devices
+     * (`POST /api/v1/push/client/`).
+     */
+    upsertDevices(params: PushUpsertDevicesParams): Promise<PushClientDevices>;
+    /** Mark a native push notification as read (`POST /api/v1/push/read/`). */
+    markRead(params: PushMarkReadParams): Promise<MarkReadResult>;
+    /**
+     * List native push notifications (`GET /api/v1/push/android/{slug}/`,
+     * `/api/v1/push/ios/{slug}/`, or the combined `/api/v1/push/list/{slug}/`
+     * when `platform` is omitted) — a bare JSON array.
+     *
+     * @deprecated The native push notification list endpoints are legacy;
+     * calling this emits a one-time `DeprecationWarning`.
+     * @throws {SilonError} when `platform` is anything other than
+     *   `"android"`, `"ios"` or omitted.
+     */
+    listNotifications(slug: string, options?: PushListNotificationsOptions): Promise<PushNotification[]>;
+    /**
+     * Register a browser subscription for a client
+     * (`POST /api/v1/webpush/client/`).
+     *
+     * @deprecated Legacy endpoint — register web push subscriptions through
+     * the widget instead. Calling this emits a one-time `DeprecationWarning`.
+     */
+    subscribeWeb(params: PushSubscribeWebParams): Promise<WebPushSubscription>;
+}
+//# sourceMappingURL=push.d.ts.map