ab-ecosystem-cpass 0.1.0 → 1.0.0

package/dist/resources/audience/export-history.d.ts

@@ -0,0 +1,52 @@
+import type { CreateExportHistoryInput, ExportHistory, ListExportHistoryQuery, Paginated } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Export history: one row per bulk extract, moved by a worker through
+ * `pending -> processing -> completed | failed`.
+ *
+ * `config` says what to write out, in the same vocabulary the contact list
+ * speaks: a saved `segment`, an ad-hoc `filter`, or both -- sending both
+ * narrows the segment. `fields` picks the columns; empty means the worker's
+ * default set.
+ *
+ * When the run completes, `file` holds the storage key of the written file and
+ * `count` the number of rows in it.
+ */
+export declare class Exports {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/exports` -- offset paginated, newest first. `search`
+     * matches the title; `module` and `status` are quick filters.
+     *
+     * Scope: `contacts:read`.
+     */
+    list(query?: Partial<ListExportHistoryQuery>): Promise<Paginated<ExportHistory>>;
+    /**
+     * `GET /v1/audience/exports/:id` -- the row with its current `status`,
+     * `count` and, once finished, `file`. This is the progress endpoint; a failed
+     * run carries its reason in `error`.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(id: string): Promise<ExportHistory>;
+    /**
+     * `POST /v1/audience/exports` -- **202**, not 201: the row exists, but no
+     * file has been written yet. The response is the row at `status: 'pending'`
+     * with `count: 0` and no `file`.
+     *
+     * Creating an export needs only a title: the default config exports every
+     * contact with the worker's default columns.
+     *
+     * Scope: `contacts:read` -- reading contacts out is a read, so an export can
+     * be started with read-only access.
+     */
+    create(input: CreateExportHistoryInput): Promise<ExportHistory>;
+    /**
+     * `DELETE /v1/audience/exports/:id` -- 204, no body. Removes the history row;
+     * a file already written to storage is not deleted with it.
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(id: string): Promise<void>;
+}

package/dist/resources/audience/export-history.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Exports = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/exports`;
+/**
+ * Export history: one row per bulk extract, moved by a worker through
+ * `pending -> processing -> completed | failed`.
+ *
+ * `config` says what to write out, in the same vocabulary the contact list
+ * speaks: a saved `segment`, an ad-hoc `filter`, or both -- sending both
+ * narrows the segment. `fields` picks the columns; empty means the worker's
+ * default set.
+ *
+ * When the run completes, `file` holds the storage key of the written file and
+ * `count` the number of rows in it.
+ */
+class Exports {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/exports` -- offset paginated, newest first. `search`
+     * matches the title; `module` and `status` are quick filters.
+     *
+     * Scope: `contacts:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/exports/:id` -- the row with its current `status`,
+     * `count` and, once finished, `file`. This is the progress endpoint; a failed
+     * run carries its reason in `error`.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/exports` -- **202**, not 201: the row exists, but no
+     * file has been written yet. The response is the row at `status: 'pending'`
+     * with `count: 0` and no `file`.
+     *
+     * Creating an export needs only a title: the default config exports every
+     * contact with the worker's default columns.
+     *
+     * Scope: `contacts:read` -- reading contacts out is a read, so an export can
+     * be started with read-only access.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/exports/:id` -- 204, no body. Removes the history row;
+     * a file already written to storage is not deleted with it.
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+}
+exports.Exports = Exports;
+//# sourceMappingURL=export-history.js.map

package/dist/resources/audience/export-history.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-history.js","sourceRoot":"","sources":["../../../src/resources/audience/export-history.ts"],"names":[],"mappings":";;;AAOA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,UAAU,CAAC;AAEnC;;;;;;;;;;;GAWG;AACH,MAAa,OAAO;IACW;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;OAKG;IACH,IAAI,CAAC,QAAyC,EAAE;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA2B,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgB,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAA+B;QACpC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgB,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,EAAU;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAhDD,0BAgDC"}

package/dist/resources/audience/import-history.d.ts

@@ -0,0 +1,51 @@
+import type { CreateImportHistoryInput, ImportHistory, ListImportHistoryQuery, Paginated } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Import history: one row per bulk load of contacts, and the record a worker
+ * moves through `pending -> processing -> completed | failed`.
+ *
+ * Creating a row queues the work; the file itself is uploaded out of band and
+ * named here by its storage key. `statistics` fills in as the worker walks the
+ * file, so poll `get` to follow a run.
+ *
+ * The module is `contact` or `datastore` -- these rows are not contact-only,
+ * which is why the route is `/imports` rather than `/contact-imports`.
+ */
+export declare class Imports {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/imports` -- offset paginated, newest first. `search`
+     * matches the title; `module` and `status` are quick filters.
+     *
+     * Scope: `contacts:read`.
+     */
+    list(query?: Partial<ListImportHistoryQuery>): Promise<Paginated<ImportHistory>>;
+    /**
+     * `GET /v1/audience/imports/:id` -- the row with its current `status` and
+     * `statistics`. This is the progress endpoint.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(id: string): Promise<ImportHistory>;
+    /**
+     * `POST /v1/audience/imports` -- **202**, not 201: the row exists, but
+     * nothing has been read out of the file yet. The response is the row at
+     * `status: 'pending'` with every counter at zero.
+     *
+     * `config.mapping` maps column headers to contact fields, and
+     * `config.duplicateStrategy` decides what a row matching an existing contact
+     * does. Unknown keys in `config` and `extra` are stored and handed back
+     * untouched.
+     *
+     * Scope: `contacts:write`.
+     */
+    create(input: CreateImportHistoryInput): Promise<ImportHistory>;
+    /**
+     * `DELETE /v1/audience/imports/:id` -- 204, no body. Removes the history row.
+     * Contacts the import already created are not touched.
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(id: string): Promise<void>;
+}

package/dist/resources/audience/import-history.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Imports = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/imports`;
+/**
+ * Import history: one row per bulk load of contacts, and the record a worker
+ * moves through `pending -> processing -> completed | failed`.
+ *
+ * Creating a row queues the work; the file itself is uploaded out of band and
+ * named here by its storage key. `statistics` fills in as the worker walks the
+ * file, so poll `get` to follow a run.
+ *
+ * The module is `contact` or `datastore` -- these rows are not contact-only,
+ * which is why the route is `/imports` rather than `/contact-imports`.
+ */
+class Imports {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/imports` -- offset paginated, newest first. `search`
+     * matches the title; `module` and `status` are quick filters.
+     *
+     * Scope: `contacts:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/imports/:id` -- the row with its current `status` and
+     * `statistics`. This is the progress endpoint.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/imports` -- **202**, not 201: the row exists, but
+     * nothing has been read out of the file yet. The response is the row at
+     * `status: 'pending'` with every counter at zero.
+     *
+     * `config.mapping` maps column headers to contact fields, and
+     * `config.duplicateStrategy` decides what a row matching an existing contact
+     * does. Unknown keys in `config` and `extra` are stored and handed back
+     * untouched.
+     *
+     * Scope: `contacts:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/imports/:id` -- 204, no body. Removes the history row.
+     * Contacts the import already created are not touched.
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+}
+exports.Imports = Imports;
+//# sourceMappingURL=import-history.js.map

package/dist/resources/audience/import-history.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-history.js","sourceRoot":"","sources":["../../../src/resources/audience/import-history.ts"],"names":[],"mappings":";;;AAOA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,UAAU,CAAC;AAEnC;;;;;;;;;;GAUG;AACH,MAAa,OAAO;IACW;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;OAKG;IACH,IAAI,CAAC,QAAyC,EAAE;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA2B,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgB,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAA+B;QACpC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgB,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,EAAU;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAhDD,0BAgDC"}

package/dist/resources/audience/segments.d.ts

@@ -0,0 +1,49 @@
+import type { CreateSegmentInput, ListSegmentsQuery, Paginated, Segment, UpdateSegmentInput } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Segments: a saved contact filter under a name.
+ *
+ * Nothing is materialised -- a segment holds no contact ids. It covers whatever
+ * its conditions match at the moment it is next run, whether that is
+ * `contacts.list({ segment })`, an export, or a campaign.
+ */
+export declare class Segments {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/segments` -- offset paginated. `search` matches the
+     * segment name and description.
+     *
+     * Scope: `segments:read`.
+     */
+    list(query?: Partial<ListSegmentsQuery>): Promise<Paginated<Segment>>;
+    /**
+     * `GET /v1/audience/segments/:id`.
+     *
+     * Scope: `segments:read`.
+     */
+    get(id: string): Promise<Segment>;
+    /**
+     * `POST /v1/audience/segments` -- 201 with the created segment.
+     *
+     * The filter is validated on write rather than when first run, so a segment
+     * that stores cannot fail later for a condition that never parsed.
+     *
+     * Scope: `segments:write`.
+     */
+    create(input: CreateSegmentInput): Promise<Segment>;
+    /**
+     * `PATCH /v1/audience/segments/:id` -- a partial update. Sending `filter`
+     * replaces the whole condition list; there is no per-condition edit.
+     *
+     * Scope: `segments:write`.
+     */
+    update(id: string, input: UpdateSegmentInput): Promise<Segment>;
+    /**
+     * `DELETE /v1/audience/segments/:id` -- 204, no body. Contacts are untouched:
+     * a segment never owned them.
+     *
+     * Scope: `segments:write`.
+     */
+    delete(id: string): Promise<void>;
+}

package/dist/resources/audience/segments.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Segments = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/segments`;
+/**
+ * Segments: a saved contact filter under a name.
+ *
+ * Nothing is materialised -- a segment holds no contact ids. It covers whatever
+ * its conditions match at the moment it is next run, whether that is
+ * `contacts.list({ segment })`, an export, or a campaign.
+ */
+class Segments {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/segments` -- offset paginated. `search` matches the
+     * segment name and description.
+     *
+     * Scope: `segments:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/segments/:id`.
+     *
+     * Scope: `segments:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/segments` -- 201 with the created segment.
+     *
+     * The filter is validated on write rather than when first run, so a segment
+     * that stores cannot fail later for a condition that never parsed.
+     *
+     * Scope: `segments:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/segments/:id` -- a partial update. Sending `filter`
+     * replaces the whole condition list; there is no per-condition edit.
+     *
+     * Scope: `segments:write`.
+     */
+    update(id, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(id)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/segments/:id` -- 204, no body. Contacts are untouched:
+     * a segment never owned them.
+     *
+     * Scope: `segments:write`.
+     */
+    delete(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+}
+exports.Segments = Segments;
+//# sourceMappingURL=segments.js.map

package/dist/resources/audience/segments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"segments.js","sourceRoot":"","sources":["../../../src/resources/audience/segments.ts"],"names":[],"mappings":";;;AAQA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,WAAW,CAAC;AAEpC;;;;;;GAMG;AACH,MAAa,QAAQ;IACU;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;OAKG;IACH,IAAI,CAAC,QAAoC,EAAE;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAqB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAU,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAyB;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAU,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,EAAU,EAAE,KAAyB;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAU,OAAO,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,EAAU;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AArDD,4BAqDC"}

package/dist/resources/audience/webhooks.d.ts

@@ -0,0 +1,68 @@
+import type { CreateWebhookInput, ListWebhooksQuery, Page, UpdateWebhookInput, Webhook } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Audience webhooks: HTTPS endpoints the platform POSTs contact events to.
+ *
+ * Distinct from `crm.crmTriggers`, which fires a single configured request per
+ * rule, and from `crm.channelWebhooks`, which carries message traffic. This one
+ * is a plain subscription to `contact.created`, `contact.updated` and
+ * `contact.deleted`, delivered as a `WebhookEnvelope`.
+ *
+ * Deliveries are signed. The body arrives with `x-crm-timestamp` and
+ * `x-crm-signature: v1=<hex>`, where the digest is
+ * `HMAC-SHA256(secret, "<timestamp>.<raw body>")`. Compare against the raw
+ * bytes, before any JSON parsing.
+ *
+ * Unlike the rest of the audience module, these rows are scoped by tenant
+ * rather than by the calling user.
+ */
+export declare class Webhooks {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/webhooks` -- cursor paginated; page with `cursor` from
+     * the previous response's `nextCursor`.
+     *
+     * `enabled` is accepted by the contract but not yet applied by the service:
+     * the list comes back unfiltered. Filter client-side until that lands.
+     *
+     * Scope: `webhooks:read`.
+     */
+    list(query?: Partial<ListWebhooksQuery>): Promise<Page<Webhook>>;
+    /**
+     * `GET /v1/audience/webhooks/:id`. The signing secret is never returned here
+     * -- it is shown once, by `create`.
+     *
+     * Scope: `webhooks:read`.
+     */
+    get(id: string): Promise<Webhook>;
+    /**
+     * `POST /v1/audience/webhooks` -- 201 with the created webhook **plus its
+     * `secret`**. This is the only response that carries the secret; store it
+     * when you get it.
+     *
+     * The URL has to be public https: a non-https URL, or a hostname resolving
+     * to a loopback, link-local or private address, is rejected with
+     * 422 `invalid_webhook_url`.
+     *
+     * Scope: `webhooks:write`.
+     */
+    create(input: CreateWebhookInput): Promise<Webhook & {
+        secret: string;
+    }>;
+    /**
+     * `PATCH /v1/audience/webhooks/:id` -- a partial update. A new `url` is
+     * checked the same way as on create; `events` replaces the subscription list.
+     * The secret does not change, and cannot be rotated through this route.
+     *
+     * Scope: `webhooks:write`.
+     */
+    update(id: string, input: UpdateWebhookInput): Promise<Webhook>;
+    /**
+     * `DELETE /v1/audience/webhooks/:id` -- 204, no body. Delivery stops
+     * immediately; queued attempts are dropped.
+     *
+     * Scope: `webhooks:write`.
+     */
+    delete(id: string): Promise<void>;
+}

package/dist/resources/audience/webhooks.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webhooks = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/webhooks`;
+/**
+ * Audience webhooks: HTTPS endpoints the platform POSTs contact events to.
+ *
+ * Distinct from `crm.crmTriggers`, which fires a single configured request per
+ * rule, and from `crm.channelWebhooks`, which carries message traffic. This one
+ * is a plain subscription to `contact.created`, `contact.updated` and
+ * `contact.deleted`, delivered as a `WebhookEnvelope`.
+ *
+ * Deliveries are signed. The body arrives with `x-crm-timestamp` and
+ * `x-crm-signature: v1=<hex>`, where the digest is
+ * `HMAC-SHA256(secret, "<timestamp>.<raw body>")`. Compare against the raw
+ * bytes, before any JSON parsing.
+ *
+ * Unlike the rest of the audience module, these rows are scoped by tenant
+ * rather than by the calling user.
+ */
+class Webhooks {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/webhooks` -- cursor paginated; page with `cursor` from
+     * the previous response's `nextCursor`.
+     *
+     * `enabled` is accepted by the contract but not yet applied by the service:
+     * the list comes back unfiltered. Filter client-side until that lands.
+     *
+     * Scope: `webhooks:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/webhooks/:id`. The signing secret is never returned here
+     * -- it is shown once, by `create`.
+     *
+     * Scope: `webhooks:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/webhooks` -- 201 with the created webhook **plus its
+     * `secret`**. This is the only response that carries the secret; store it
+     * when you get it.
+     *
+     * The URL has to be public https: a non-https URL, or a hostname resolving
+     * to a loopback, link-local or private address, is rejected with
+     * 422 `invalid_webhook_url`.
+     *
+     * Scope: `webhooks:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/webhooks/:id` -- a partial update. A new `url` is
+     * checked the same way as on create; `events` replaces the subscription list.
+     * The secret does not change, and cannot be rotated through this route.
+     *
+     * Scope: `webhooks:write`.
+     */
+    update(id, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(id)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/webhooks/:id` -- 204, no body. Delivery stops
+     * immediately; queued attempts are dropped.
+     *
+     * Scope: `webhooks:write`.
+     */
+    delete(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+}
+exports.Webhooks = Webhooks;
+//# sourceMappingURL=webhooks.js.map

package/dist/resources/audience/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../../src/resources/audience/webhooks.ts"],"names":[],"mappings":";;;AAQA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,WAAW,CAAC;AAEpC;;;;;;;;;;;;;;;GAeG;AACH,MAAa,QAAQ;IACU;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;;;OAQG;IACH,IAAI,CAAC,QAAoC,EAAE;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAU,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAyB;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA+B,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,EAAU,EAAE,KAAyB;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAU,OAAO,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,EAAU;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AA7DD,4BA6DC"}

package/dist/resources/channels/activity.d.ts

@@ -0,0 +1,25 @@
+import type { ActivityLog, ListActivityLogsQuery, Paginated } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Channel activity feed: what happened to a channel and who did it -- the
+ * owner, the agency, or the platform itself.
+ *
+ * Read-only, and written by the services as they work. Wallet movements share
+ * the feed with ordinary activity, so `type: 'activity'` is the filter for
+ * "everything except money".
+ */
+export declare class Activity {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/channels/:channelId/logs` -- offset paginated, newest first.
+     *
+     * `search` matches the event name and the message. `type`, `source` and
+     * `event` are quick filters, where `event` is an exact machine name such as
+     * `template.approved`. `range` restricts to a window in unix seconds, where
+     * `0` on either end means no bound.
+     *
+     * Scope: `channels:read`.
+     */
+    list(channelId: string, query?: Partial<ListActivityLogsQuery>): Promise<Paginated<ActivityLog>>;
+}

package/dist/resources/channels/activity.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Activity = void 0;
+const paths_1 = require("../paths");
+const base = (channelId) => `${paths_1.CHANNELS}/${(0, paths_1.seg)(channelId)}/logs`;
+/**
+ * Channel activity feed: what happened to a channel and who did it -- the
+ * owner, the agency, or the platform itself.
+ *
+ * Read-only, and written by the services as they work. Wallet movements share
+ * the feed with ordinary activity, so `type: 'activity'` is the filter for
+ * "everything except money".
+ */
+class Activity {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/channels/:channelId/logs` -- offset paginated, newest first.
+     *
+     * `search` matches the event name and the message. `type`, `source` and
+     * `event` are quick filters, where `event` is an exact machine name such as
+     * `template.approved`. `range` restricts to a window in unix seconds, where
+     * `0` on either end means no bound.
+     *
+     * Scope: `channels:read`.
+     */
+    list(channelId, query = {}) {
+        return this.http.request('GET', base(channelId), { query });
+    }
+}
+exports.Activity = Activity;
+//# sourceMappingURL=activity.js.map

package/dist/resources/channels/activity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activity.js","sourceRoot":"","sources":["../../../src/resources/channels/activity.ts"],"names":[],"mappings":";;;AAEA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC,GAAG,gBAAQ,IAAI,IAAA,WAAG,EAAC,SAAS,CAAC,OAAO,CAAC;AAEzE;;;;;;;GAOG;AACH,MAAa,QAAQ;IACU;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;;;;OASG;IACH,IAAI,CAAC,SAAiB,EAAE,QAAwC,EAAE;QAChE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAhBD,4BAgBC"}

package/dist/resources/channels/billing.d.ts

@@ -0,0 +1,46 @@
+import type { BillingLog, BillingStats, ListBillingLogsQuery, Paginated } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Conversation billing: what each conversation on a channel cost.
+ *
+ * The endpoint answers in two shapes off one route. Without `stat` it pages
+ * through individual charges; with `stat` it returns aggregates instead, which
+ * is why `list` and `stats` are separate methods here.
+ *
+ * Pass `'all'` as the channel id to read across every channel the caller owns.
+ * `summary` then totals by currency; on a single channel it totals by message
+ * category.
+ */
+export declare class Billing {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/channels/:channelId/conversations` -- offset paginated, one row
+     * per billed conversation.
+     *
+     * `search` matches the recipient identifier and the provider detail in
+     * `meta`: recipient, category, country and message id. `range` restricts to
+     * a window in unix seconds, where `0` on either end means no bound.
+     * `template`, `country` and `campaign` take arrays and are serialised to
+     * JSON by the SDK.
+     *
+     * `channelId` may be `'all'`.
+     *
+     * Scope: `channels:read`.
+     */
+    list(channelId: string, query?: Partial<Omit<ListBillingLogsQuery, 'stat'>>): Promise<Paginated<BillingLog>>;
+    /**
+     * `GET /v1/channels/:channelId/conversations?stat=...` -- the same filters,
+     * aggregated instead of paged. Returns `{ data, stat }`, where each row is
+     * `{ group, totalRecords, totalDeductionAmount }`.
+     *
+     * `group` is what the totals are cut by: currency for `summary` across all
+     * channels, message category for `summary` on one channel, and the calendar
+     * date for `day_wise`.
+     *
+     * Pagination does not apply -- every group is returned.
+     *
+     * Scope: `channels:read`.
+     */
+    stats(channelId: string, stat?: NonNullable<ListBillingLogsQuery['stat']>, query?: Partial<Omit<ListBillingLogsQuery, 'stat'>>): Promise<BillingStats>;
+}