ab-ecosystem-cpass 0.1.0 → 1.0.0

package/dist/resources/audience/contact-notes.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContactNotes = void 0;
+const paths_1 = require("../paths");
+const base = (contactId) => `${paths_1.AUDIENCE}/contacts/${(0, paths_1.seg)(contactId)}/notes`;
+/**
+ * Internal notes on a contact: free text, attachments, and team members
+ * mentioned in them. Notes are never shown to the contact.
+ *
+ * Every method takes the contact id first -- notes are addressed under their
+ * contact, and a note id from another contact is a 404 rather than a match.
+ *
+ * NOTE: these routes are currently commented out in the audience service's
+ * `routes.ts`, so they answer 404 until that line is restored. The contract and
+ * the service behind them are complete.
+ */
+class ContactNotes {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/contacts/:contactId/notes` -- cursor paginated, newest
+     * first. Notes are appended, so an offset would shift under a caller
+     * mid-walk; page with `cursor` from the previous response's `nextCursor`.
+     *
+     * Scope: `contacts:read`.
+     */
+    list(contactId, query = {}) {
+        return this.http.request('GET', base(contactId), { query });
+    }
+    /**
+     * `GET /v1/audience/contacts/:contactId/notes/:noteId`.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(contactId, noteId) {
+        return this.http.request('GET', `${base(contactId)}/${(0, paths_1.seg)(noteId)}`);
+    }
+    /**
+     * `POST /v1/audience/contacts/:contactId/notes` -- 201 with the created note.
+     *
+     * Scope: `contacts:write`.
+     */
+    create(contactId, input) {
+        return this.http.request('POST', base(contactId), { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/contacts/:contactId/notes/:noteId` -- a partial update.
+     * `attachments` and `mentions` replace their stored value rather than
+     * appending to it.
+     *
+     * Scope: `contacts:write`.
+     */
+    update(contactId, noteId, input) {
+        return this.http.request('PATCH', `${base(contactId)}/${(0, paths_1.seg)(noteId)}`, {
+            body: input,
+        });
+    }
+    /**
+     * `DELETE /v1/audience/contacts/:contactId/notes/:noteId` -- 204, no body.
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(contactId, noteId) {
+        return this.http.request('DELETE', `${base(contactId)}/${(0, paths_1.seg)(noteId)}`);
+    }
+}
+exports.ContactNotes = ContactNotes;
+//# sourceMappingURL=contact-notes.js.map

package/dist/resources/audience/contact-notes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact-notes.js","sourceRoot":"","sources":["../../../src/resources/audience/contact-notes.ts"],"names":[],"mappings":";;;AAQA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC,GAAG,gBAAQ,aAAa,IAAA,WAAG,EAAC,SAAS,CAAC,QAAQ,CAAC;AAEnF;;;;;;;;;;GAUG;AACH,MAAa,YAAY;IACM;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;OAMG;IACH,IAAI,CAAC,SAAiB,EAAE,QAAwC,EAAE;QAChE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,SAAiB,EAAE,MAAc;QACnC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc,KAAK,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAA,WAAG,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB,EAAE,KAA6B;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,MAAc,EAAE,KAA6B;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAA,WAAG,EAAC,MAAM,CAAC,EAAE,EAAE;YAClF,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB,EAAE,MAAc;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAA,WAAG,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AArDD,oCAqDC"}

package/dist/resources/audience/contact-tags.d.ts

@@ -0,0 +1,43 @@
+import type { ContactTag, CreateContactTagInput, ListContactTagsQuery, Paginated, UpdateContactTagInput } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Contact tags: the labels a contact can carry. A tag is its own resource --
+ * `contacts.update` takes tag ids, and a contact reads back with the full tag
+ * documents resolved into `contact.tags`.
+ */
+export declare class ContactTags {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/contact-tags` -- offset paginated. `search` matches the
+     * tag name.
+     *
+     * Scope: `contact_tags:read`.
+     */
+    list(query?: Partial<ListContactTagsQuery>): Promise<Paginated<ContactTag>>;
+    /**
+     * `GET /v1/audience/contact-tags/:id`. 404 `not_found` if the tag is not the
+     * caller's.
+     *
+     * Scope: `contact_tags:read`.
+     */
+    get(id: string): Promise<ContactTag>;
+    /**
+     * `POST /v1/audience/contact-tags` -- 201 with the created tag.
+     *
+     * Scope: `contact_tags:write`.
+     */
+    create(input: CreateContactTagInput): Promise<ContactTag>;
+    /**
+     * `PATCH /v1/audience/contact-tags/:id` -- a partial update.
+     *
+     * Scope: `contact_tags:write`.
+     */
+    update(id: string, input: UpdateContactTagInput): Promise<ContactTag>;
+    /**
+     * `DELETE /v1/audience/contact-tags/:id` -- 204, no body.
+     *
+     * Scope: `contact_tags:write`.
+     */
+    delete(id: string): Promise<void>;
+}

package/dist/resources/audience/contact-tags.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContactTags = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/contact-tags`;
+/**
+ * Contact tags: the labels a contact can carry. A tag is its own resource --
+ * `contacts.update` takes tag ids, and a contact reads back with the full tag
+ * documents resolved into `contact.tags`.
+ */
+class ContactTags {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/contact-tags` -- offset paginated. `search` matches the
+     * tag name.
+     *
+     * Scope: `contact_tags:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/contact-tags/:id`. 404 `not_found` if the tag is not the
+     * caller's.
+     *
+     * Scope: `contact_tags:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/contact-tags` -- 201 with the created tag.
+     *
+     * Scope: `contact_tags:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/contact-tags/:id` -- a partial update.
+     *
+     * Scope: `contact_tags:write`.
+     */
+    update(id, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(id)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/contact-tags/:id` -- 204, no body.
+     *
+     * Scope: `contact_tags:write`.
+     */
+    delete(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+}
+exports.ContactTags = ContactTags;
+//# sourceMappingURL=contact-tags.js.map

package/dist/resources/audience/contact-tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact-tags.js","sourceRoot":"","sources":["../../../src/resources/audience/contact-tags.ts"],"names":[],"mappings":";;;AAQA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,eAAe,CAAC;AAExC;;;;GAIG;AACH,MAAa,WAAW;IACO;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;OAKG;IACH,IAAI,CAAC,QAAuC,EAAE;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAwB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAA4B;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,KAA4B;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa,OAAO,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;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;AAjDD,kCAiDC"}

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

@@ -0,0 +1,76 @@
+import type { Contact, ContactDeleteResult, CreateContactInput, ListContactsQuery, Paginated, UpdateContactInput } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Contacts: the people an account talks to, and the resource everything else in
+ * the audience module hangs off.
+ *
+ * Scoping: contacts belong to an account, and a request carries two identities
+ * -- the caller and the account they act for. Reads match either; writes land
+ * on the caller's own.
+ */
+export declare class Contacts {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/contacts` -- offset paginated.
+     *
+     * `search` matches the first and last name plus the name and identifier of
+     * every channel identity. `segment` replays a saved filter; `filter` carries
+     * ad-hoc conditions, serialised to JSON on the query string by the SDK.
+     * Sending both narrows the segment rather than replacing it, and `tag`,
+     * `agent` and `status` narrow whatever those produce.
+     *
+     * Defaults to `status: 'live'`, so the trash needs an explicit
+     * `status: 'trashed'`.
+     *
+     * Scope: `contacts:read`.
+     */
+    list(query?: Partial<ListContactsQuery>): Promise<Paginated<Contact>>;
+    /**
+     * `GET /v1/audience/contacts/:id` -- one contact with its tags resolved.
+     * 404 `not_found` if no contact with that id belongs to the caller.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(id: string): Promise<Contact>;
+    /**
+     * `POST /v1/audience/contacts` -- 201 with the created contact.
+     *
+     * Every field is optional: an empty body creates a blank contact. Channel
+     * identities are not settable here; they are written when a conversation
+     * starts on a channel.
+     *
+     * Scope: `contacts:write`.
+     */
+    create(input?: CreateContactInput): Promise<Contact>;
+    /**
+     * `PATCH /v1/audience/contacts/:id` -- a partial update; anything left out is
+     * untouched. `tags` and `custom_field_hash` replace their stored value rather
+     * than merging into it.
+     *
+     * Scope: `contacts:write`.
+     */
+    update(id: string, input: UpdateContactInput): Promise<Contact>;
+    /**
+     * `DELETE /v1/audience/contacts/:id` -- two-stage, and 200 rather than 204
+     * both times: the body is what says which stage ran.
+     *
+     * The first call moves the contact to the trash (`status: 'trashed'`); a
+     * second call on an already-trashed contact destroys it along with its notes
+     * and channel identities (`status: 'deleted'`).
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(id: string): Promise<ContactDeleteResult>;
+    /**
+     * Walks every page of `list`, yielding one contact at a time. Takes the same
+     * query as `list`; `page` is managed here and is ignored if passed.
+     *
+     * ```ts
+     * for await (const contact of crm.contacts.iterate({ tag: tagId })) {
+     *   console.log(contact.id);
+     * }
+     * ```
+     */
+    iterate(query?: Partial<ListContactsQuery>): AsyncGenerator<Contact>;
+}

package/dist/resources/audience/contacts.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contacts = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/contacts`;
+/**
+ * Contacts: the people an account talks to, and the resource everything else in
+ * the audience module hangs off.
+ *
+ * Scoping: contacts belong to an account, and a request carries two identities
+ * -- the caller and the account they act for. Reads match either; writes land
+ * on the caller's own.
+ */
+class Contacts {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/contacts` -- offset paginated.
+     *
+     * `search` matches the first and last name plus the name and identifier of
+     * every channel identity. `segment` replays a saved filter; `filter` carries
+     * ad-hoc conditions, serialised to JSON on the query string by the SDK.
+     * Sending both narrows the segment rather than replacing it, and `tag`,
+     * `agent` and `status` narrow whatever those produce.
+     *
+     * Defaults to `status: 'live'`, so the trash needs an explicit
+     * `status: 'trashed'`.
+     *
+     * Scope: `contacts:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/contacts/:id` -- one contact with its tags resolved.
+     * 404 `not_found` if no contact with that id belongs to the caller.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/contacts` -- 201 with the created contact.
+     *
+     * Every field is optional: an empty body creates a blank contact. Channel
+     * identities are not settable here; they are written when a conversation
+     * starts on a channel.
+     *
+     * Scope: `contacts:write`.
+     */
+    create(input = {}) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/contacts/:id` -- a partial update; anything left out is
+     * untouched. `tags` and `custom_field_hash` replace their stored value rather
+     * than merging into it.
+     *
+     * Scope: `contacts:write`.
+     */
+    update(id, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(id)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/contacts/:id` -- two-stage, and 200 rather than 204
+     * both times: the body is what says which stage ran.
+     *
+     * The first call moves the contact to the trash (`status: 'trashed'`); a
+     * second call on an already-trashed contact destroys it along with its notes
+     * and channel identities (`status: 'deleted'`).
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * Walks every page of `list`, yielding one contact at a time. Takes the same
+     * query as `list`; `page` is managed here and is ignored if passed.
+     *
+     * ```ts
+     * for await (const contact of crm.contacts.iterate({ tag: tagId })) {
+     *   console.log(contact.id);
+     * }
+     * ```
+     */
+    async *iterate(query = {}) {
+        let page = 1;
+        for (;;) {
+            const result = await this.list({ ...query, page });
+            for (const contact of result.data)
+                yield contact;
+            if (page >= result.pagination.pages || result.data.length === 0)
+                return;
+            page += 1;
+        }
+    }
+}
+exports.Contacts = Contacts;
+//# sourceMappingURL=contacts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../../src/resources/audience/contacts.ts"],"names":[],"mappings":";;;AASA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,WAAW,CAAC;AAEpC;;;;;;;GAOG;AACH,MAAa,QAAQ;IACU;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;;;;;;;;OAaG;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;;;;;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;;;;;;;;OAQG;IACH,MAAM,CAAC,QAA4B,EAAE;QACnC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAU,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACnE,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;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,CAAC,OAAO,CAAC,QAAoC,EAAE;QACnD,IAAI,IAAI,GAAG,CAAC,CAAC;QAEb,SAAS,CAAC;YACR,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACnD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI;gBAAE,MAAM,OAAO,CAAC;YACjD,IAAI,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YACxE,IAAI,IAAI,CAAC,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AAzFD,4BAyFC"}

package/dist/resources/audience/crm-triggers.d.ts

@@ -0,0 +1,67 @@
+import type { CreateCrmTriggerInput, CrmTrigger, CrmTriggerLog, ListCrmTriggerLogsQuery, ListCrmTriggersQuery, Paginated, UpdateCrmTriggerInput } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * CRM triggers: fire a webhook when a contact changes.
+ *
+ * A trigger is three questions. `trigger` is which contact event to watch;
+ * `when` narrows it to the fields that moved; `filters` requires the contact
+ * itself to match a set of conditions -- the same DSL segments speak, flat
+ * rather than wrapped. All three have to pass before `action` runs.
+ *
+ * `type: 'time'` triggers are stored and served but not dispatched: nothing
+ * schedules them yet.
+ */
+export declare class CrmTriggers {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/crm-triggers` -- offset paginated. `search` matches the
+     * trigger name.
+     *
+     * Scope: `crm_triggers:read`.
+     */
+    list(query?: Partial<ListCrmTriggersQuery>): Promise<Paginated<CrmTrigger>>;
+    /**
+     * `GET /v1/audience/crm-triggers/:id`.
+     *
+     * Scope: `crm_triggers:read`.
+     */
+    get(id: string): Promise<CrmTrigger>;
+    /**
+     * `POST /v1/audience/crm-triggers` -- 201 with the created trigger.
+     *
+     * Only `name` and `action` are required; the rest default to an active
+     * `event` trigger on `edited` with no field narrowing and no filters, which
+     * fires on every change to every contact.
+     *
+     * Scope: `crm_triggers:write`.
+     */
+    create(input: CreateCrmTriggerInput): Promise<CrmTrigger>;
+    /**
+     * `PATCH /v1/audience/crm-triggers/:id` -- a partial update. `when`,
+     * `filters` and `action` replace their stored value rather than merging.
+     * Pause a trigger with `{ active: false }` instead of deleting it; the
+     * delivery history stays readable either way.
+     *
+     * Scope: `crm_triggers:write`.
+     */
+    update(id: string, input: UpdateCrmTriggerInput): Promise<CrmTrigger>;
+    /**
+     * `DELETE /v1/audience/crm-triggers/:id` -- 204, no body.
+     *
+     * Scope: `crm_triggers:write`.
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * `GET /v1/audience/crm-triggers/logs` -- delivery history across every
+     * trigger, or one trigger's with `{ trigger: id }`. Offset paginated,
+     * newest first.
+     *
+     * Logs are written by the dispatcher, never by a caller, and the collection
+     * expires them after 30 days -- there is no way to write or delete one.
+     * Note the path: `logs` is a sibling of `:id`, not a child of it.
+     *
+     * Scope: `crm_triggers:read`.
+     */
+    logs(query?: Partial<ListCrmTriggerLogsQuery>): Promise<Paginated<CrmTriggerLog>>;
+}

package/dist/resources/audience/crm-triggers.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrmTriggers = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/crm-triggers`;
+/**
+ * CRM triggers: fire a webhook when a contact changes.
+ *
+ * A trigger is three questions. `trigger` is which contact event to watch;
+ * `when` narrows it to the fields that moved; `filters` requires the contact
+ * itself to match a set of conditions -- the same DSL segments speak, flat
+ * rather than wrapped. All three have to pass before `action` runs.
+ *
+ * `type: 'time'` triggers are stored and served but not dispatched: nothing
+ * schedules them yet.
+ */
+class CrmTriggers {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/crm-triggers` -- offset paginated. `search` matches the
+     * trigger name.
+     *
+     * Scope: `crm_triggers:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/crm-triggers/:id`.
+     *
+     * Scope: `crm_triggers:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/crm-triggers` -- 201 with the created trigger.
+     *
+     * Only `name` and `action` are required; the rest default to an active
+     * `event` trigger on `edited` with no field narrowing and no filters, which
+     * fires on every change to every contact.
+     *
+     * Scope: `crm_triggers:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/crm-triggers/:id` -- a partial update. `when`,
+     * `filters` and `action` replace their stored value rather than merging.
+     * Pause a trigger with `{ active: false }` instead of deleting it; the
+     * delivery history stays readable either way.
+     *
+     * Scope: `crm_triggers:write`.
+     */
+    update(id, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(id)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/crm-triggers/:id` -- 204, no body.
+     *
+     * Scope: `crm_triggers:write`.
+     */
+    delete(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `GET /v1/audience/crm-triggers/logs` -- delivery history across every
+     * trigger, or one trigger's with `{ trigger: id }`. Offset paginated,
+     * newest first.
+     *
+     * Logs are written by the dispatcher, never by a caller, and the collection
+     * expires them after 30 days -- there is no way to write or delete one.
+     * Note the path: `logs` is a sibling of `:id`, not a child of it.
+     *
+     * Scope: `crm_triggers:read`.
+     */
+    logs(query = {}) {
+        return this.http.request('GET', `${BASE}/logs`, { query });
+    }
+}
+exports.CrmTriggers = CrmTriggers;
+//# sourceMappingURL=crm-triggers.js.map

package/dist/resources/audience/crm-triggers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crm-triggers.js","sourceRoot":"","sources":["../../../src/resources/audience/crm-triggers.ts"],"names":[],"mappings":";;;AAUA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,eAAe,CAAC;AAExC;;;;;;;;;;GAUG;AACH,MAAa,WAAW;IACO;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;OAKG;IACH,IAAI,CAAC,QAAuC,EAAE;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAwB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,KAA4B;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,KAA4B;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa,OAAO,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;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;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA0C,EAAE;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA2B,KAAK,EAAE,GAAG,IAAI,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AAtED,kCAsEC"}

package/dist/resources/audience/custom-fields.d.ts

@@ -0,0 +1,54 @@
+import type { CreateCustomFieldInput, CustomField, ListCustomFieldsQuery, Paginated, UpdateCustomFieldInput } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Custom fields: the per-account schema for contacts. A field's `slug` is the
+ * key its values are stored under in `contact.custom_field_hash`, and the
+ * `field_id` the contact filter addresses it by.
+ *
+ * Every route below takes either the field's id or its slug, so a caller that
+ * knows the schema never has to look an id up first.
+ */
+export declare class CustomFields {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/custom-fields` -- offset paginated. `search` matches the
+     * slug, the label and the caption. `type` filters by who owns the field
+     * (`system` for platform-provisioned, `user` for the account's own).
+     *
+     * Scope: `custom_fields:read`.
+     */
+    list(query?: Partial<ListCustomFieldsQuery>): Promise<Paginated<CustomField>>;
+    /**
+     * `GET /v1/audience/custom-fields/:ref` -- `ref` is the field's id or its
+     * slug. A value that reads as an id is looked up as one; anything else is
+     * read as a slug.
+     *
+     * Scope: `custom_fields:read`.
+     */
+    get(ref: string): Promise<CustomField>;
+    /**
+     * `POST /v1/audience/custom-fields` -- 201 with the created field.
+     *
+     * The slug must be snake_case and unclaimed: a name that would shadow a
+     * contact document path (`name`, `tags`, `status`), a channel key
+     * (`whatsapp`, `email`) or a built-in filter field is rejected with 422.
+     * A slug already in use on the account is a 409 `conflict`.
+     *
+     * Scope: `custom_fields:write`.
+     */
+    create(input: CreateCustomFieldInput): Promise<CustomField>;
+    /**
+     * `PATCH /v1/audience/custom-fields/:ref` -- a partial update. The slug is
+     * not updatable: values already stored under it would be orphaned.
+     *
+     * Scope: `custom_fields:write`.
+     */
+    update(ref: string, input: UpdateCustomFieldInput): Promise<CustomField>;
+    /**
+     * `DELETE /v1/audience/custom-fields/:ref` -- 204, no body.
+     *
+     * Scope: `custom_fields:write`.
+     */
+    delete(ref: string): Promise<void>;
+}

package/dist/resources/audience/custom-fields.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFields = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/custom-fields`;
+/**
+ * Custom fields: the per-account schema for contacts. A field's `slug` is the
+ * key its values are stored under in `contact.custom_field_hash`, and the
+ * `field_id` the contact filter addresses it by.
+ *
+ * Every route below takes either the field's id or its slug, so a caller that
+ * knows the schema never has to look an id up first.
+ */
+class CustomFields {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/custom-fields` -- offset paginated. `search` matches the
+     * slug, the label and the caption. `type` filters by who owns the field
+     * (`system` for platform-provisioned, `user` for the account's own).
+     *
+     * Scope: `custom_fields:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/custom-fields/:ref` -- `ref` is the field's id or its
+     * slug. A value that reads as an id is looked up as one; anything else is
+     * read as a slug.
+     *
+     * Scope: `custom_fields:read`.
+     */
+    get(ref) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(ref)}`);
+    }
+    /**
+     * `POST /v1/audience/custom-fields` -- 201 with the created field.
+     *
+     * The slug must be snake_case and unclaimed: a name that would shadow a
+     * contact document path (`name`, `tags`, `status`), a channel key
+     * (`whatsapp`, `email`) or a built-in filter field is rejected with 422.
+     * A slug already in use on the account is a 409 `conflict`.
+     *
+     * Scope: `custom_fields:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/custom-fields/:ref` -- a partial update. The slug is
+     * not updatable: values already stored under it would be orphaned.
+     *
+     * Scope: `custom_fields:write`.
+     */
+    update(ref, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(ref)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/custom-fields/:ref` -- 204, no body.
+     *
+     * Scope: `custom_fields:write`.
+     */
+    delete(ref) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(ref)}`);
+    }
+}
+exports.CustomFields = CustomFields;
+//# sourceMappingURL=custom-fields.js.map

package/dist/resources/audience/custom-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.js","sourceRoot":"","sources":["../../../src/resources/audience/custom-fields.ts"],"names":[],"mappings":";;;AAQA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,gBAAgB,CAAC;AAEzC;;;;;;;GAOG;AACH,MAAa,YAAY;IACM;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;OAMG;IACH,IAAI,CAAC,QAAwC,EAAE;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,GAAW;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAA6B;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAW,EAAE,KAA6B;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc,OAAO,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,GAAG,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAzDD,oCAyDC"}