silon-sdk 0.2.0

package/dist/resources/broadcasts.d.ts

@@ -0,0 +1,63 @@
+/** The Broadcasts resource — create, aggregate status and per-recipient deliveries. */
+import type { Silon } from "../client.js";
+import { Page } from "../pagination.js";
+import type { Broadcast, BroadcastAccepted, BroadcastCreateParams, BroadcastDeliveriesParams, BroadcastDelivery } from "../types/broadcasts.js";
+/** `client.broadcasts` — send one piece of content to an audience and track it. */
+export declare class Broadcasts {
+    #private;
+    constructor(client: Silon);
+    /**
+     * Send a broadcast — one piece of content fanned out to an audience — on
+     * any channel (`POST /api/v1/broadcasts/`).
+     *
+     * `audience` selects the recipients: `{type: "client_group", slug}`,
+     * `{type: "client_ids", client_ids: [...]}` or `{type: "recipients",
+     * recipients: [{phone_number} | {email} | {client_id}, ...]}` (max 1,000
+     * rows; a malformed row fails the whole request with a per-index pointer
+     * like `audience.recipients[3].phone_number`).
+     *
+     * 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 broadcast: the envelope answers `status: "scheduled"`
+     * (`target_count` / `skipped_count` may be null when the audience resolves
+     * at dispatch time) and the same `id` tracks it through dispatch; cancel
+     * while still scheduled via {@link cancel}.
+     *
+     * 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.
+     */
+    create(params: BroadcastCreateParams): Promise<BroadcastAccepted>;
+    /**
+     * Aggregate delivery counts for a broadcast
+     * (`GET /api/v1/broadcasts/{broadcast_id}/`). A broadcast created with
+     * `send_at` answers `status: "scheduled"` until dispatch, then the normal
+     * lifecycle — the id is stable across it.
+     */
+    retrieve(broadcastId: string): Promise<Broadcast>;
+    /**
+     * Cancel a scheduled broadcast
+     * (`POST /api/v1/broadcasts/{broadcast_id}/cancel/`).
+     *
+     * Allowed only while the broadcast is still `"scheduled"`: resolves with
+     * the envelope showing `status: "canceled"`; a canceled broadcast never
+     * dispatches and emits a `broadcast.canceled` event. Canceling an
+     * already-canceled broadcast 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 broadcast's id) the server rejects
+     * with `409 not-cancellable`; an unknown id rejects with `404`.
+     */
+    cancel(broadcastId: string): Promise<BroadcastAccepted>;
+    /**
+     * Per-recipient delivery rows for a broadcast, cursor-paginated
+     * (`GET /api/v1/broadcasts/{broadcast_id}/deliveries/`).
+     *
+     * ```ts
+     * const page = await client.broadcasts.deliveries("br_01J1", { limit: 100 });
+     * for await (const delivery of page.autoPaging()) { ... }
+     * ```
+     */
+    deliveries(broadcastId: string, params?: BroadcastDeliveriesParams): Promise<Page<BroadcastDelivery>>;
+}
+//# sourceMappingURL=broadcasts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"broadcasts.d.ts","sourceRoot":"","sources":["../../src/resources/broadcasts.ts"],"names":[],"mappings":"AAAA,uFAAuF;AAIvF,OAAO,KAAK,EAAe,KAAK,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EACV,SAAS,EACT,iBAAiB,EACjB,qBAAqB,EACrB,yBAAyB,EACzB,iBAAiB,EAClB,MAAM,wBAAwB,CAAC;AAIhC,mFAAmF;AACnF,qBAAa,UAAU;;gBAGT,MAAM,EAAE,KAAK;IAIzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyBvE;;;;;OAKG;IACG,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQvD;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ7D;;;;;;;;OAQG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,yBAA8B,GACrC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;CAQpC"}

package/dist/resources/broadcasts.js

@@ -0,0 +1,103 @@
+/** The Broadcasts resource — create, aggregate status and per-recipient deliveries. */
+import { randomUUID } from "node:crypto";
+import { dropNull } from "../internal/utils.js";
+import { Page } from "../pagination.js";
+const BROADCASTS_PATH = "/api/v1/broadcasts/";
+/** `client.broadcasts` — send one piece of content to an audience and track it. */
+export class Broadcasts {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /**
+     * Send a broadcast — one piece of content fanned out to an audience — on
+     * any channel (`POST /api/v1/broadcasts/`).
+     *
+     * `audience` selects the recipients: `{type: "client_group", slug}`,
+     * `{type: "client_ids", client_ids: [...]}` or `{type: "recipients",
+     * recipients: [{phone_number} | {email} | {client_id}, ...]}` (max 1,000
+     * rows; a malformed row fails the whole request with a per-index pointer
+     * like `audience.recipients[3].phone_number`).
+     *
+     * 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 broadcast: the envelope answers `status: "scheduled"`
+     * (`target_count` / `skipped_count` may be null when the audience resolves
+     * at dispatch time) and the same `id` tracks it through dispatch; cancel
+     * while still scheduled via {@link cancel}.
+     *
+     * 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.
+     */
+    async create(params) {
+        const { idempotency_key, extra_body, ...fields } = params;
+        const body = dropNull({
+            channel: fields.channel,
+            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,
+        });
+        if (extra_body)
+            Object.assign(body, extra_body);
+        const data = await this.#client.request("POST", BROADCASTS_PATH, {
+            body,
+            headers: { "Idempotency-Key": idempotency_key ?? randomUUID() },
+        });
+        return data;
+    }
+    /**
+     * Aggregate delivery counts for a broadcast
+     * (`GET /api/v1/broadcasts/{broadcast_id}/`). A broadcast created with
+     * `send_at` answers `status: "scheduled"` until dispatch, then the normal
+     * lifecycle — the id is stable across it.
+     */
+    async retrieve(broadcastId) {
+        const data = await this.#client.request("GET", `${BROADCASTS_PATH}${encodeURIComponent(broadcastId)}/`);
+        return data;
+    }
+    /**
+     * Cancel a scheduled broadcast
+     * (`POST /api/v1/broadcasts/{broadcast_id}/cancel/`).
+     *
+     * Allowed only while the broadcast is still `"scheduled"`: resolves with
+     * the envelope showing `status: "canceled"`; a canceled broadcast never
+     * dispatches and emits a `broadcast.canceled` event. Canceling an
+     * already-canceled broadcast 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 broadcast's id) the server rejects
+     * with `409 not-cancellable`; an unknown id rejects with `404`.
+     */
+    async cancel(broadcastId) {
+        const data = await this.#client.request("POST", `${BROADCASTS_PATH}${encodeURIComponent(broadcastId)}/cancel/`);
+        return data;
+    }
+    /**
+     * Per-recipient delivery rows for a broadcast, cursor-paginated
+     * (`GET /api/v1/broadcasts/{broadcast_id}/deliveries/`).
+     *
+     * ```ts
+     * const page = await client.broadcasts.deliveries("br_01J1", { limit: 100 });
+     * for await (const delivery of page.autoPaging()) { ... }
+     * ```
+     */
+    async deliveries(broadcastId, params = {}) {
+        const path = `${BROADCASTS_PATH}${encodeURIComponent(broadcastId)}/deliveries/`;
+        const query = dropNull({ cursor: params.cursor, limit: params.limit });
+        const data = (await this.#client.request("GET", path, {
+            query,
+        }));
+        return new Page(this.#client, path, query, data);
+    }
+}
+//# sourceMappingURL=broadcasts.js.map

package/dist/resources/broadcasts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcasts.js","sourceRoot":"","sources":["../../src/resources/broadcasts.ts"],"names":[],"mappings":"AAAA,uFAAuF;AAEvF,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAS7D,MAAM,eAAe,GAAG,qBAAqB,CAAC;AAE9C,mFAAmF;AACnF,MAAM,OAAO,UAAU;IACZ,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAM,CAAC,MAA6B;QACxC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1D,MAAM,IAAI,GAAG,QAAQ,CAAC;YACpB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,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;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,eAAe,EAAE;YAC/D,IAAI;YACJ,OAAO,EAAE,EAAE,iBAAiB,EAAE,eAAe,IAAI,UAAU,EAAE,EAAE;SAChE,CAAC,CAAC;QACH,OAAO,IAAyB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,WAAmB;QAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,KAAK,EACL,GAAG,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,GAAG,CACxD,CAAC;QACF,OAAO,IAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB;QAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,MAAM,EACN,GAAG,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,UAAU,CAC/D,CAAC;QACF,OAAO,IAAyB,CAAC;IACnC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CACd,WAAmB,EACnB,SAAoC,EAAE;QAEtC,MAAM,IAAI,GAAG,GAAG,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,cAAc,CAAC;QAChF,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAgB,CAAC;QACtF,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE;YACpD,KAAK;SACN,CAAC,CAAsC,CAAC;QACzC,OAAO,IAAI,IAAI,CAAoB,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;CACF"}

package/dist/resources/bulk.d.ts

@@ -0,0 +1,60 @@
+/** The Bulk resource — CSV batches, saved files, and per-recipient rows. */
+import type { Silon } from "../client.js";
+import type { BulkBatch, BulkBatchDetail, BulkFileInput, BulkFileList, BulkFileUpload, BulkFileUploadOptions, BulkRecipientDetail, BulkSendParams, BulkSendResult } from "../types/bulk.js";
+/** `client.bulk.files` — CSVs saved for later bulk sends. */
+export declare class BulkFiles {
+    #private;
+    constructor(client: Silon);
+    /** List saved CSVs (`GET /api/v1/bulk/files/` -> `{count, results}`). */
+    list(): Promise<BulkFileList>;
+    /**
+     * Upload a CSV for later bulk sends (`POST /api/v1/bulk/files/`,
+     * multipart field `file`, content type `text/csv`).
+     *
+     * `file` may be raw content (`string`, `Uint8Array`/`Buffer`) or a
+     * `{filename, content}` pair; the filename defaults to `recipients.csv`
+     * and can be overridden via `options.filename`. The response `name` is
+     * the saved filename to pass as `bulk_file` to {@link Bulk.send}.
+     */
+    upload(file: BulkFileInput, options?: BulkFileUploadOptions): Promise<BulkFileUpload>;
+}
+/** `client.bulk.recipients` — per-recipient rows of a bulk batch. */
+export declare class BulkRecipients {
+    #private;
+    constructor(client: Silon);
+    /** Fetch one recipient row (`GET /api/v1/bulk/recipient/{id}/`). */
+    retrieve(recipientId: number): Promise<BulkRecipientDetail>;
+}
+/** `client.bulk` — bulk (CSV) sends: batches, saved files, recipients. */
+export declare class Bulk {
+    #private;
+    /** Saved CSV files for bulk sends. */
+    readonly files: BulkFiles;
+    /** Per-recipient rows of a batch. */
+    readonly recipients: BulkRecipients;
+    constructor(client: Silon);
+    /** List batches (`GET /api/v1/bulk/` — a bare JSON array). */
+    list(): Promise<BulkBatch[]>;
+    /** Full batch detail incl. recipients (`GET /api/v1/bulk/{id}/`). */
+    retrieve(bulkId: number): Promise<BulkBatchDetail>;
+    /**
+     * Start a bulk batch (`POST /api/v1/bulk/send/`).
+     *
+     * Supply recipients either inline via `recipients` (each row a
+     * column->value map) or by referencing a previously uploaded CSV via
+     * `bulk_file` — exactly one of the two, enforced client-side. The
+     * WhatsApp template fields (`provider`, `whatsapp_template`,
+     * `whatsapp_template_language`, `whatsapp_template_variables`) are sent
+     * as query parameters, everything else in the JSON body.
+     *
+     * @deprecated Prefer `client.messages.sendBatch` — inline rows via
+     * `messages`, or an uploaded CSV via `file` (`bulk.files.upload` stays
+     * the ingestion path). Calling this emits a one-time
+     * `DeprecationWarning`.
+     *
+     * @throws {SilonError} when neither or both of `recipients` / `bulk_file`
+     *   are given.
+     */
+    send(params: BulkSendParams): Promise<BulkSendResult>;
+}
+//# sourceMappingURL=bulk.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/bulk.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAE5E,OAAO,KAAK,EAAe,KAAK,EAAE,MAAM,cAAc,CAAC;AAGvD,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EACf,aAAa,EACb,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACf,MAAM,kBAAkB,CAAC;AAS1B,6DAA6D;AAC7D,qBAAa,SAAS;;gBAGR,MAAM,EAAE,KAAK;IAIzB,yEAAyE;IACnE,IAAI,IAAI,OAAO,CAAC,YAAY,CAAC;IAKnC;;;;;;;;OAQG;IACG,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,cAAc,CAAC;CAmBhG;AAED,qEAAqE;AACrE,qBAAa,cAAc;;gBAGb,MAAM,EAAE,KAAK;IAIzB,oEAAoE;IAC9D,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAIlE;AAED,0EAA0E;AAC1E,qBAAa,IAAI;;IAGf,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,qCAAqC;IACrC,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;gBAExB,MAAM,EAAE,KAAK;IAMzB,8DAA8D;IACxD,IAAI,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAKlC,qEAAqE;IAC/D,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAKxD;;;;;;;;;;;;;;;;;OAiBG;IACG,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;CAwC5D"}

package/dist/resources/bulk.js

@@ -0,0 +1,137 @@
+/** The Bulk resource — CSV batches, saved files, and per-recipient rows. */
+import { SilonError } from "../errors.js";
+import { dropNull, emitDeprecationWarning } from "../internal/utils.js";
+const BULK_PATH = "/api/v1/bulk/";
+const FILES_PATH = "/api/v1/bulk/files/";
+const SEND_PATH = "/api/v1/bulk/send/";
+const RECIPIENT_PATH = "/api/v1/bulk/recipient/";
+const DEFAULT_UPLOAD_FILENAME = "recipients.csv";
+/** `client.bulk.files` — CSVs saved for later bulk sends. */
+export class BulkFiles {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /** List saved CSVs (`GET /api/v1/bulk/files/` -> `{count, results}`). */
+    async list() {
+        const data = await this.#client.request("GET", FILES_PATH);
+        return data;
+    }
+    /**
+     * Upload a CSV for later bulk sends (`POST /api/v1/bulk/files/`,
+     * multipart field `file`, content type `text/csv`).
+     *
+     * `file` may be raw content (`string`, `Uint8Array`/`Buffer`) or a
+     * `{filename, content}` pair; the filename defaults to `recipients.csv`
+     * and can be overridden via `options.filename`. The response `name` is
+     * the saved filename to pass as `bulk_file` to {@link Bulk.send}.
+     */
+    async upload(file, options = {}) {
+        let content;
+        let inputName;
+        if (typeof file === "object" && !(file instanceof Uint8Array)) {
+            content = file.content;
+            inputName = file.filename;
+        }
+        else {
+            content = file;
+        }
+        const filename = options.filename ?? inputName ?? DEFAULT_UPLOAD_FILENAME;
+        // Copy byte input so the Blob part is backed by a plain ArrayBuffer
+        // (Uint8Array views over SharedArrayBuffer are not valid BlobParts).
+        const part = typeof content === "string" ? content : new Uint8Array(content);
+        const formData = new FormData();
+        formData.append("file", new Blob([part], { type: "text/csv" }), filename);
+        const data = await this.#client.request("POST", FILES_PATH, { formData });
+        return data;
+    }
+}
+/** `client.bulk.recipients` — per-recipient rows of a bulk batch. */
+export class BulkRecipients {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /** Fetch one recipient row (`GET /api/v1/bulk/recipient/{id}/`). */
+    async retrieve(recipientId) {
+        const data = await this.#client.request("GET", `${RECIPIENT_PATH}${recipientId}/`);
+        return data;
+    }
+}
+/** `client.bulk` — bulk (CSV) sends: batches, saved files, recipients. */
+export class Bulk {
+    #client;
+    /** Saved CSV files for bulk sends. */
+    files;
+    /** Per-recipient rows of a batch. */
+    recipients;
+    constructor(client) {
+        this.#client = client;
+        this.files = new BulkFiles(client);
+        this.recipients = new BulkRecipients(client);
+    }
+    /** List batches (`GET /api/v1/bulk/` — a bare JSON array). */
+    async list() {
+        const data = await this.#client.request("GET", BULK_PATH);
+        return data;
+    }
+    /** Full batch detail incl. recipients (`GET /api/v1/bulk/{id}/`). */
+    async retrieve(bulkId) {
+        const data = await this.#client.request("GET", `${BULK_PATH}${bulkId}/`);
+        return data;
+    }
+    /**
+     * Start a bulk batch (`POST /api/v1/bulk/send/`).
+     *
+     * Supply recipients either inline via `recipients` (each row a
+     * column->value map) or by referencing a previously uploaded CSV via
+     * `bulk_file` — exactly one of the two, enforced client-side. The
+     * WhatsApp template fields (`provider`, `whatsapp_template`,
+     * `whatsapp_template_language`, `whatsapp_template_variables`) are sent
+     * as query parameters, everything else in the JSON body.
+     *
+     * @deprecated Prefer `client.messages.sendBatch` — inline rows via
+     * `messages`, or an uploaded CSV via `file` (`bulk.files.upload` stays
+     * the ingestion path). Calling this emits a one-time
+     * `DeprecationWarning`.
+     *
+     * @throws {SilonError} when neither or both of `recipients` / `bulk_file`
+     *   are given.
+     */
+    async send(params) {
+        emitDeprecationWarning("SILON_BULK_SEND", "silon: bulk.send() (POST /api/v1/bulk/send/) is deprecated - prefer " +
+            "messages.sendBatch() (POST /api/v1/messages/batch/) with inline 'messages' " +
+            "rows or an uploaded CSV via 'file'.");
+        if ((params.recipients == null) === (params.bulk_file == null)) {
+            throw new SilonError("Provide exactly one of 'recipients' (inline rows) or 'bulk_file' (a saved CSV name).");
+        }
+        const body = dropNull({
+            recipients: params.recipients,
+            bulk_file: params.bulk_file,
+            channel: params.channel,
+            message: params.message,
+            template: params.template,
+            subject: params.subject,
+            sender: params.sender,
+            group: params.group,
+            application: params.application,
+            web_application: params.web_application,
+            language: params.language,
+            files: params.files,
+            name: params.name,
+            expire: params.expire,
+            remove_duplicates: params.remove_duplicates,
+            scheduled_at: params.scheduled_at,
+            timezone: params.timezone,
+        });
+        const query = dropNull({
+            provider: params.provider,
+            whatsapp_template: params.whatsapp_template,
+            whatsapp_template_language: params.whatsapp_template_language,
+            whatsapp_template_variables: params.whatsapp_template_variables,
+        });
+        const data = await this.#client.request("POST", SEND_PATH, { body, query });
+        return data;
+    }
+}
+//# sourceMappingURL=bulk.js.map

package/dist/resources/bulk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/bulk.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAG5E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAaxE,MAAM,SAAS,GAAG,eAAe,CAAC;AAClC,MAAM,UAAU,GAAG,qBAAqB,CAAC;AACzC,MAAM,SAAS,GAAG,oBAAoB,CAAC;AACvC,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAEjD,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;AAEjD,6DAA6D;AAC7D,MAAM,OAAO,SAAS;IACX,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC3D,OAAO,IAAoB,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,IAAmB,EAAE,UAAiC,EAAE;QACnE,IAAI,OAA4B,CAAC;QACjC,IAAI,SAA6B,CAAC;QAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC,EAAE,CAAC;YAC9D,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YACvB,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,SAAS,IAAI,uBAAuB,CAAC;QAC1E,oEAAoE;QACpE,qEAAqE;QACrE,MAAM,IAAI,GACR,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC1E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1E,OAAO,IAAsB,CAAC;IAChC,CAAC;CACF;AAED,qEAAqE;AACrE,MAAM,OAAO,cAAc;IAChB,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,QAAQ,CAAC,WAAmB;QAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,cAAc,GAAG,WAAW,GAAG,CAAC,CAAC;QACnF,OAAO,IAA2B,CAAC;IACrC,CAAC;CACF;AAED,0EAA0E;AAC1E,MAAM,OAAO,IAAI;IACN,OAAO,CAAQ;IAExB,sCAAsC;IAC7B,KAAK,CAAY;IAC1B,qCAAqC;IAC5B,UAAU,CAAiB;IAEpC,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC1D,OAAO,IAAmB,CAAC;IAC7B,CAAC;IAED,qEAAqE;IACrE,KAAK,CAAC,QAAQ,CAAC,MAAc;QAC3B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,SAAS,GAAG,MAAM,GAAG,CAAC,CAAC;QACzE,OAAO,IAAuB,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,IAAI,CAAC,MAAsB;QAC/B,sBAAsB,CACpB,iBAAiB,EACjB,sEAAsE;YACpE,6EAA6E;YAC7E,qCAAqC,CACxC,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,UAAU,CAClB,sFAAsF,CACvF,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC;YACpB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;YAC3C,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,QAAQ,CAAC;YACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;YAC3C,0BAA0B,EAAE,MAAM,CAAC,0BAA0B;YAC7D,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;SAChE,CAAgB,CAAC;QAClB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5E,OAAO,IAAsB,CAAC;IAChC,CAAC;CACF"}

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

@@ -0,0 +1,50 @@
+/** The ClientGroups resource — CRM client groups (broadcast audiences). */
+import type { Silon } from "../client.js";
+import { Page } from "../pagination.js";
+import type { ClientGroup, ClientGroupCreateParams, ClientGroupListParams, ClientGroupReplaceParams, ClientGroupUpdateParams } from "../types/client-groups.js";
+/** `client.clientGroups` — group contacts into broadcast audiences. */
+export declare class ClientGroups {
+    #private;
+    constructor(client: Silon);
+    /**
+     * List every group as a bare array (`GET /api/v1/crm/group/`).
+     *
+     * This eagerly returns ALL groups as a plain `ClientGroup[]` from the
+     * deprecated singular route (frozen: never cursor-paginated). Its call
+     * signature and return type are preserved for back-compat.
+     *
+     * @deprecated Prefer {@link ClientGroups.listPaginated}, which pages the
+     *   canonical `GET /api/v1/crm/groups/` route lazily. Calling this emits a
+     *   one-time `DeprecationWarning`.
+     */
+    list(): Promise<ClientGroup[]>;
+    /**
+     * List groups, cursor-paginated, newest first
+     * (`GET /api/v1/crm/groups/` — the canonical C2 route). Returns a
+     * {@link Page} you can walk manually or drain with `autoPaging()`.
+     *
+     * ```ts
+     * const page = await client.clientGroups.listPaginated({ limit: 100 });
+     * for (const group of page.results) { ... }          // this page only
+     * for await (const group of page.autoPaging()) { ... } // every page, lazily
+     * ```
+     */
+    listPaginated(params?: ClientGroupListParams): Promise<Page<ClientGroup>>;
+    /**
+     * Create a group (`POST /api/v1/crm/groups/`). Membership is written via
+     * the write-only `client_ids` list; the response echoes full `clients`.
+     */
+    create(params: ClientGroupCreateParams): Promise<ClientGroup>;
+    /** Fetch one group (`GET /api/v1/crm/groups/{id}/`). */
+    retrieve(groupId: number): Promise<ClientGroup>;
+    /**
+     * Partial update (`PATCH /api/v1/crm/groups/{id}/`). When `client_ids` is
+     * given it REPLACES the whole membership.
+     */
+    update(groupId: number, params?: ClientGroupUpdateParams): Promise<ClientGroup>;
+    /** Full replace (`PUT /api/v1/crm/groups/{id}/`). */
+    replace(groupId: number, params: ClientGroupReplaceParams): Promise<ClientGroup>;
+    /** Delete a group (`DELETE /api/v1/crm/groups/{id}/`, 204). */
+    delete(groupId: number): Promise<void>;
+}
+//# sourceMappingURL=client-groups.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client-groups.d.ts","sourceRoot":"","sources":["../../src/resources/client-groups.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAE3E,OAAO,KAAK,EAAe,KAAK,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EACV,WAAW,EACX,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,2BAA2B,CAAC;AAiBnC,uEAAuE;AACvE,qBAAa,YAAY;;gBAGX,MAAM,EAAE,KAAK;IAIzB;;;;;;;;;;OAUG;IACG,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAWpC;;;;;;;;;;OAUG;IACG,aAAa,CAAC,MAAM,GAAE,qBAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAWnF;;;OAGG;IACG,MAAM,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IAKnE,wDAAwD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKrD;;;OAGG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,uBAA4B,GAAG,OAAO,CAAC,WAAW,CAAC;IAOzF,qDAAqD;IAC/C,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAOtF,+DAA+D;IACzD,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG7C"}

package/dist/resources/client-groups.js

@@ -0,0 +1,97 @@
+/** The ClientGroups resource — CRM client groups (broadcast audiences). */
+import { dropNull, emitDeprecationWarning } from "../internal/utils.js";
+import { Page } from "../pagination.js";
+// Canonical plural route (C2): cursor-paginated LIST + all single-object CRUD.
+const GROUPS_PATH = "/api/v1/crm/groups/";
+// Deprecated singular route, frozen: its LIST returns a bare JSON array.
+const GROUPS_LEGACY_PATH = "/api/v1/crm/group/";
+/** Build a group body, omitting absent fields (SPEC 7). */
+function groupBody(params) {
+    return dropNull({
+        name: params.name,
+        slug: params.slug,
+        client_ids: params.client_ids,
+        is_active: params.is_active,
+    });
+}
+/** `client.clientGroups` — group contacts into broadcast audiences. */
+export class ClientGroups {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /**
+     * List every group as a bare array (`GET /api/v1/crm/group/`).
+     *
+     * This eagerly returns ALL groups as a plain `ClientGroup[]` from the
+     * deprecated singular route (frozen: never cursor-paginated). Its call
+     * signature and return type are preserved for back-compat.
+     *
+     * @deprecated Prefer {@link ClientGroups.listPaginated}, which pages the
+     *   canonical `GET /api/v1/crm/groups/` route lazily. Calling this emits a
+     *   one-time `DeprecationWarning`.
+     */
+    async list() {
+        emitDeprecationWarning("SILON_CRM_GROUPS_LIST", "silon: clientGroups.list() (GET /api/v1/crm/group/) returns a bare, " +
+            "unpaginated array from the deprecated singular route - prefer " +
+            "clientGroups.listPaginated() (GET /api/v1/crm/groups/), which is cursor-paginated.");
+        const data = await this.#client.request("GET", GROUPS_LEGACY_PATH);
+        return data;
+    }
+    /**
+     * List groups, cursor-paginated, newest first
+     * (`GET /api/v1/crm/groups/` — the canonical C2 route). Returns a
+     * {@link Page} you can walk manually or drain with `autoPaging()`.
+     *
+     * ```ts
+     * const page = await client.clientGroups.listPaginated({ limit: 100 });
+     * for (const group of page.results) { ... }          // this page only
+     * for await (const group 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", GROUPS_PATH, {
+            query,
+        }));
+        return new Page(this.#client, GROUPS_PATH, query, data);
+    }
+    /**
+     * Create a group (`POST /api/v1/crm/groups/`). Membership is written via
+     * the write-only `client_ids` list; the response echoes full `clients`.
+     */
+    async create(params) {
+        const data = await this.#client.request("POST", GROUPS_PATH, { body: groupBody(params) });
+        return data;
+    }
+    /** Fetch one group (`GET /api/v1/crm/groups/{id}/`). */
+    async retrieve(groupId) {
+        const data = await this.#client.request("GET", `${GROUPS_PATH}${groupId}/`);
+        return data;
+    }
+    /**
+     * Partial update (`PATCH /api/v1/crm/groups/{id}/`). When `client_ids` is
+     * given it REPLACES the whole membership.
+     */
+    async update(groupId, params = {}) {
+        const data = await this.#client.request("PATCH", `${GROUPS_PATH}${groupId}/`, {
+            body: groupBody(params),
+        });
+        return data;
+    }
+    /** Full replace (`PUT /api/v1/crm/groups/{id}/`). */
+    async replace(groupId, params) {
+        const data = await this.#client.request("PUT", `${GROUPS_PATH}${groupId}/`, {
+            body: groupBody(params),
+        });
+        return data;
+    }
+    /** Delete a group (`DELETE /api/v1/crm/groups/{id}/`, 204). */
+    async delete(groupId) {
+        await this.#client.request("DELETE", `${GROUPS_PATH}${groupId}/`);
+    }
+}
+//# sourceMappingURL=client-groups.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client-groups.js","sourceRoot":"","sources":["../../src/resources/client-groups.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAG3E,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAS7D,+EAA+E;AAC/E,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAC1C,yEAAyE;AACzE,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AAEhD,2DAA2D;AAC3D,SAAS,SAAS,CAAC,MAA+B;IAChD,OAAO,QAAQ,CAAC;QACd,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;KAC5B,CAAC,CAAC;AACL,CAAC;AAED,uEAAuE;AACvE,MAAM,OAAO,YAAY;IACd,OAAO,CAAQ;IAExB,YAAY,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI;QACR,sBAAsB,CACpB,uBAAuB,EACvB,sEAAsE;YACpE,gEAAgE;YAChE,oFAAoF,CACvF,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;QACnE,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CAAC,SAAgC,EAAE;QACpD,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,WAAW,EAAE;YAC3D,KAAK;SACN,CAAC,CAAgC,CAAC;QACnC,OAAO,IAAI,IAAI,CAAc,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,MAA+B;QAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,IAAmB,CAAC;IAC7B,CAAC;IAED,wDAAwD;IACxD,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,WAAW,GAAG,OAAO,GAAG,CAAC,CAAC;QAC5E,OAAO,IAAmB,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,SAAkC,EAAE;QAChE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,WAAW,GAAG,OAAO,GAAG,EAAE;YAC5E,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;SACxB,CAAC,CAAC;QACH,OAAO,IAAmB,CAAC;IAC7B,CAAC;IAED,qDAAqD;IACrD,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,MAAgC;QAC7D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,WAAW,GAAG,OAAO,GAAG,EAAE;YAC1E,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;SACxB,CAAC,CAAC;QACH,OAAO,IAAmB,CAAC;IAC7B,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,WAAW,GAAG,OAAO,GAAG,CAAC,CAAC;IACpE,CAAC;CACF"}

package/dist/resources/clients.d.ts

@@ -0,0 +1,51 @@
+/** The Clients resource — CRM contact profiles. */
+import type { Silon } from "../client.js";
+import { Page } from "../pagination.js";
+import type { ClientCreateParams, ClientListParams, ClientProfile, ClientUpdateParams } from "../types/clients.js";
+/** `client.clients` — manage CRM contact profiles. */
+export declare class Clients {
+    #private;
+    constructor(client: Silon);
+    /**
+     * 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`.
+     */
+    list(): Promise<ClientProfile[]>;
+    /**
+     * 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
+     * ```
+     */
+    listPaginated(params?: ClientListParams): Promise<Page<ClientProfile>>;
+    /** Create a contact (`POST /api/v1/crm/clients/`). */
+    create(params: ClientCreateParams): Promise<ClientProfile>;
+    /** Fetch one contact (`GET /api/v1/crm/clients/{client_id}/`). */
+    retrieve(clientId: string): Promise<ClientProfile>;
+    /**
+     * Partial update (`PATCH /api/v1/crm/clients/{client_id}/`) — only the
+     * given fields change.
+     */
+    update(clientId: string, params?: ClientUpdateParams): Promise<ClientProfile>;
+    /**
+     * Full replace (`PUT /api/v1/crm/clients/{client_id}/`). `client_id` itself
+     * is immutable.
+     */
+    replace(clientId: string, params?: ClientUpdateParams): Promise<ClientProfile>;
+    /** Delete a contact (`DELETE /api/v1/crm/clients/{client_id}/`, 204). */
+    delete(clientId: string): Promise<void>;
+}
+//# sourceMappingURL=clients.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/resources/clients.ts"],"names":[],"mappings":"AAAA,mDAAmD;AAEnD,OAAO,KAAK,EAAe,KAAK,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EAAE,IAAI,EAAuB,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EACV,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAsB7B,sDAAsD;AACtD,qBAAa,OAAO;;gBAGN,MAAM,EAAE,KAAK;IAIzB;;;;;;;;;;;OAWG;IACG,IAAI,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAWtC;;;;;;;;;;OAUG;IACG,aAAa,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAWhF,sDAAsD;IAChD,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAKhE,kEAAkE;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAQxD;;;OAGG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,aAAa,CAAC;IASvF;;;OAGG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,aAAa,CAAC;IASxF,yEAAyE;IACnE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG9C"}