ab-ecosystem-cpass 0.1.0 → 1.0.0

package/README.md

@@ -1,6 +1,14 @@
-# CRM SDK
+# ab-ecosystem-cpass
 
-JavaScript/TypeScript client for the CRM gateway.
+JavaScript/TypeScript client for the CRM gateway. Covers the **audience** module
+(contacts and everything hanging off them) and the **channels** module
+(connections, templates, webhooks and the log feeds).
+
+- [Install](#install)
+- [Quick start](#quick-start)
+- [Client options](#client-options)
+- [Conventions](#conventions) — pagination, search, filters, scopes, errors
+- [Modules](#modules) — one reference page per resource
 
 ## Install
 
@@ -8,7 +16,10 @@ JavaScript/TypeScript client for the CRM gateway.
 npm install ab-ecosystem-cpass
 ```
 
-## Usage
+Node 18 or newer. The package is dependency-free and ships its own types; it
+uses the global `fetch`, or one you pass in.
+
+## Quick start
 
 ```ts
 import { CrmClient } from 'ab-ecosystem-cpass';
@@ -19,38 +30,45 @@ const crm = new CrmClient({
   authToken: '<ecosystem bearer token>',
 });
 
-const { data, nextCursor } = await crm.channels.list({ limit: 20 });
-const channel = await crm.channels.get('64ba85075f89cb9bbe30d749');
+// Audience
+const contacts = await crm.contacts.list({ search: 'acme', rows: 50 });
+const tag = await crm.contactTags.create({ name: 'VIP', color: '#f59e0b' });
+await crm.contacts.update(contacts.data[0].id, { tags: [tag.id] });
+
+// Channels
+const channels = await crm.channels.list({ type: 'whatsapp', active: true });
+const templates = await crm.templates.list(channels.data[0].id, { status: 'approved' });
 ```
 
-Every request carries `authorization: Bearer <authToken>`, `client-id` and `origin`.
+Every request carries `authorization: Bearer <authToken>`, `client-id` and
+`origin`.
+
+## Client options
 
 | Option | Required | Description |
 | --- | --- | --- |
-| `gatewayUrl` | yes | Base URL of the gateway. |
+| `gatewayUrl` | yes | Base URL of the gateway, without a trailing slash. |
 | `clientId` | yes | Sent as the `client-id` header. |
-| `authToken` | yes | String, or a function returning one per request. |
-| `origin` | on Node | Sent as the `origin` header. Browsers set this themselves; on Node the gateway rejects the call without it. |
-| `fetch` | no | Custom fetch implementation. |
-| `timeoutMs` | no | Request timeout, default 30000. |
+| `authToken` | yes | A string, or a function returning one per request — sync or async. |
+| `origin` | on Node | Sent as the `origin` header, and must match the token's referer claim. Browsers set this themselves and ignore any override; on Node the gateway rejects the call without it. |
+| `fetch` | no | Custom fetch implementation. Defaults to the global one. |
+| `timeoutMs` | no | Request timeout in milliseconds. Default `30000`. |
 
 ### Node
 
-Browsers attach `Origin` automatically and ignore any override, so `origin` only
-needs setting outside the browser:
-
 ```ts
 const crm = new CrmClient({
   gatewayUrl: 'https://api.example.com',
   clientId: 'tpc_xxxxxxxxxxxxxxxx',
   authToken: process.env.CRM_TOKEN!,
-  origin: 'https://app.example.com', // must match the token's referer claim
+  origin: 'https://app.example.com',
 });
 ```
 
 ### Refreshing tokens
 
-Pass a function to resolve the token per request:
+Pass a function and it is called before every request, so a rotating token never
+needs the client rebuilt:
 
 ```ts
 const crm = new CrmClient({
@@ -60,7 +78,67 @@ const crm = new CrmClient({
 });
 ```
 
-## Errors
+## Conventions
+
+### Two kinds of pagination
+
+Most lists are **offset paginated** and answer `Paginated<T>`:
+
+```ts
+{ data: T[], pagination: { page, rows, total, pages } }
+```
+
+Send `{ page, rows, search }`. `page` is 1-based and defaults to `1`; `rows`
+defaults to `25` and caps at `100`; `search` is trimmed and must be 1–120
+characters. Which fields `search` matches is per resource and is stated on each
+page.
+
+Two endpoints — **contact notes** and **audience webhooks** — are **cursor
+paginated** and answer `Page<T>`:
+
+```ts
+{ data: T[], nextCursor: string | null }
+```
+
+Send `{ limit, cursor }`. `limit` defaults to `50` and caps at `100`; pass the
+previous response's `nextCursor` to continue, and stop when it is `null`. These
+two page through rows that are appended constantly, where an offset would shift
+under a caller mid-walk.
+
+`crm.contacts.iterate(query)` walks every page of the contact list for you.
+
+### Query values that are objects
+
+`filter`, `range`, and the billing list's `template` / `country` / `campaign`
+arrays are sent as JSON on the query string. Pass them as real values — the SDK
+serialises them:
+
+```ts
+await crm.billing.list('all', {
+  range: { start: 1767225600, end: 1769817600 },
+  country: ['IN', 'US'],
+});
+```
+
+### The contact filter
+
+One condition DSL is shared by four places: `contacts.list({ filter })`, a saved
+`Segment`, a CRM trigger's `filters`, and an export's `config.filter`. It has
+its own page: **[contact filter](docs/contact-filter.md)**.
+
+### Scoping
+
+Audience rows 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. Audience webhooks are the exception — they are scoped by tenant.
+
+### Scopes
+
+Every method documents the scope its route requires, such as `contacts:read` or
+`channels:write`. They are listed for planning; the gateway does not enforce
+them yet.
+
+### Errors
 
 | Error | When |
 | --- | --- |
@@ -71,18 +149,42 @@ const crm = new CrmClient({
 import { CrmApiError, CrmConfigError } from 'ab-ecosystem-cpass';
 
 try {
-  await crm.channels.list();
+  await crm.contacts.get(id);
 } catch (err) {
   if (err instanceof CrmConfigError) console.error('bad SDK setup:', err.message);
-  else if (err instanceof CrmApiError) console.error(err.status, err.code, err.message);
+  else if (err instanceof CrmApiError) console.error(err.status, err.code, err.message, err.details);
 }
 ```
 
-## API
+Common codes: `422` for a body or query that fails validation (`details` lists
+the paths), `404 not_found`, `409 conflict` for a name or slug already taken.
 
-Only the channel module ships in this release.
+## Modules
 
-| Method | Endpoint |
-| --- | --- |
-| `crm.channels.list(query?)` | `GET /v1/channels` |
-| `crm.channels.get(id)` | `GET /v1/channels/:id` |
+### Audience — `/v1/audience`
+
+| Resource | Page | Actions |
+| --- | --- | --- |
+| `crm.contacts` | [contacts](docs/audience/contacts.md) | `list` `get` `create` `update` `delete` `iterate` |
+| `crm.contactTags` | [contact tags](docs/audience/contact-tags.md) | `list` `get` `create` `update` `delete` |
+| `crm.contactNotes` | [contact notes](docs/audience/contact-notes.md) | `list` `get` `create` `update` `delete` |
+| `crm.customFields` | [custom fields](docs/audience/custom-fields.md) | `list` `get` `create` `update` `delete` |
+| `crm.segments` | [segments](docs/audience/segments.md) | `list` `get` `create` `update` `delete` |
+| `crm.crmTriggers` | [CRM triggers](docs/audience/crm-triggers.md) | `list` `get` `create` `update` `delete` `logs` |
+| `crm.imports` | [import history](docs/audience/imports.md) | `list` `get` `create` `delete` |
+| `crm.exports` | [export history](docs/audience/exports.md) | `list` `get` `create` `delete` |
+| `crm.webhooks` | [audience webhooks](docs/audience/webhooks.md) | `list` `get` `create` `update` `delete` |
+
+### Channels — `/v1/channels`
+
+| Resource | Page | Actions |
+| --- | --- | --- |
+| `crm.channels` | [channels](docs/channels/channels.md) | `list` `get` `updateDetails` `disable` `rotateToken` `getProp` `setProp` |
+| — | [channel properties](docs/channels/channel-props.md) | every `prop` `getProp`/`setProp` accepts |
+| `crm.templates` | [templates](docs/channels/templates.md) | `list` `get` `create` `update` `delete` `sync` |
+| `crm.channelWebhooks` | [channel webhooks](docs/channels/webhooks.md) | `list` `get` `create` `update` `delete` |
+| `crm.billing` | [conversation billing](docs/channels/billing.md) | `list` `stats` |
+| `crm.wallet` | [wallet ledger](docs/channels/wallet.md) | `list` |
+| `crm.activity` | [activity log](docs/channels/activity.md) | `list` |
+
+The campaign module is not in this release.

package/dist/client.d.ts

@@ -1,6 +1,61 @@
 import { type ClientOptions } from './http';
-import { Channels } from './resources/channels';
+import { Contacts } from './resources/audience/contacts';
+import { ContactTags } from './resources/audience/contact-tags';
+import { ContactNotes } from './resources/audience/contact-notes';
+import { CustomFields } from './resources/audience/custom-fields';
+import { Segments } from './resources/audience/segments';
+import { CrmTriggers } from './resources/audience/crm-triggers';
+import { Imports } from './resources/audience/import-history';
+import { Exports } from './resources/audience/export-history';
+import { Webhooks } from './resources/audience/webhooks';
+import { Channels } from './resources/channels/channels';
+import { Templates } from './resources/channels/templates';
+import { ChannelWebhooks } from './resources/channels/webhooks';
+import { Billing } from './resources/channels/billing';
+import { Wallet } from './resources/channels/wallet';
+import { Activity } from './resources/channels/activity';
+/**
+ * One client for the whole gateway. Construct it once and share it: it holds no
+ * per-request state, and every resource below runs over the same HTTP client,
+ * so options such as the token resolver and the timeout apply everywhere.
+ *
+ * ```ts
+ * const crm = new CrmClient({ gatewayUrl, clientId, authToken });
+ *
+ * const contacts = await crm.contacts.list({ search: 'acme' });
+ * const channels = await crm.channels.list({ type: 'whatsapp' });
+ * ```
+ */
 export declare class CrmClient {
+    /** Contacts: the people an account talks to. */
+    readonly contacts: Contacts;
+    /** Contact tags: the labels a contact can carry. */
+    readonly contactTags: ContactTags;
+    /** Internal notes on a contact. Addressed under their contact. */
+    readonly contactNotes: ContactNotes;
+    /** Custom fields: the per-account contact schema. */
+    readonly customFields: CustomFields;
+    /** Segments: saved contact filters. */
+    readonly segments: Segments;
+    /** CRM triggers: fire a webhook when a contact changes, plus their delivery logs. */
+    readonly crmTriggers: CrmTriggers;
+    /** Import history: bulk loads of contacts, and their progress. */
+    readonly imports: Imports;
+    /** Export history: bulk extracts, and their progress. */
+    readonly exports: Exports;
+    /** Audience webhooks: subscriptions to contact events. */
+    readonly webhooks: Webhooks;
+    /** Channels, and the provider properties that hang off them. */
     readonly channels: Channels;
+    /** WhatsApp message templates, per channel. */
+    readonly templates: Templates;
+    /** Channel webhooks: where a channel's message traffic is delivered. */
+    readonly channelWebhooks: ChannelWebhooks;
+    /** Conversation billing: what each conversation cost. */
+    readonly billing: Billing;
+    /** Channel wallet ledger. */
+    readonly wallet: Wallet;
+    /** Channel activity feed. */
+    readonly activity: Activity;
     constructor(options: ClientOptions);
 }

package/dist/client.js

@@ -2,44 +2,90 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CrmClient = void 0;
 const http_1 = require("./http");
-const channels_1 = require("./resources/channels");
-// Only the channel module ships in the MVP. The rest stay commented out until
-// their services are live behind the gateway.
-// import { Contacts } from './resources/contacts';
-// import { CustomFields } from './resources/custom-fields';
-// import { Segments } from './resources/segments';
-// import { CrmTriggers } from './resources/crm-triggers';
-// import { ContactImports } from './resources/contact-imports';
-// import { ContactExports } from './resources/contact-exports';
-// import { Webhooks } from './resources/webhooks';
+// Audience
+const contacts_1 = require("./resources/audience/contacts");
+const contact_tags_1 = require("./resources/audience/contact-tags");
+const contact_notes_1 = require("./resources/audience/contact-notes");
+const custom_fields_1 = require("./resources/audience/custom-fields");
+const segments_1 = require("./resources/audience/segments");
+const crm_triggers_1 = require("./resources/audience/crm-triggers");
+const import_history_1 = require("./resources/audience/import-history");
+const export_history_1 = require("./resources/audience/export-history");
+const webhooks_1 = require("./resources/audience/webhooks");
+// Channels
+const channels_1 = require("./resources/channels/channels");
+const templates_1 = require("./resources/channels/templates");
+const webhooks_2 = require("./resources/channels/webhooks");
+const billing_1 = require("./resources/channels/billing");
+const wallet_1 = require("./resources/channels/wallet");
+const activity_1 = require("./resources/channels/activity");
+// The campaign module is not wired up yet; its resources are still excluded
+// from the build.
 // import { Campaigns } from './resources/campaigns';
 // import { CampaignReports } from './resources/campaign-reports';
 // import { CampaignReportExports } from './resources/campaign-report-exports';
+/**
+ * One client for the whole gateway. Construct it once and share it: it holds no
+ * per-request state, and every resource below runs over the same HTTP client,
+ * so options such as the token resolver and the timeout apply everywhere.
+ *
+ * ```ts
+ * const crm = new CrmClient({ gatewayUrl, clientId, authToken });
+ *
+ * const contacts = await crm.contacts.list({ search: 'acme' });
+ * const channels = await crm.channels.list({ type: 'whatsapp' });
+ * ```
+ */
 class CrmClient {
+    // -- Audience -------------------------------------------------------------
+    /** Contacts: the people an account talks to. */
+    contacts;
+    /** Contact tags: the labels a contact can carry. */
+    contactTags;
+    /** Internal notes on a contact. Addressed under their contact. */
+    contactNotes;
+    /** Custom fields: the per-account contact schema. */
+    customFields;
+    /** Segments: saved contact filters. */
+    segments;
+    /** CRM triggers: fire a webhook when a contact changes, plus their delivery logs. */
+    crmTriggers;
+    /** Import history: bulk loads of contacts, and their progress. */
+    imports;
+    /** Export history: bulk extracts, and their progress. */
+    exports;
+    /** Audience webhooks: subscriptions to contact events. */
+    webhooks;
+    // -- Channels -------------------------------------------------------------
+    /** Channels, and the provider properties that hang off them. */
     channels;
-    // readonly contacts: Contacts;
-    // readonly customFields: CustomFields;
-    // readonly segments: Segments;
-    // readonly crmTriggers: CrmTriggers;
-    // readonly contactImports: ContactImports;
-    // readonly contactExports: ContactExports;
-    // readonly webhooks: Webhooks;
-    // readonly campaigns: Campaigns;
-    // readonly campaignReports: CampaignReports;
-    // readonly campaignReportExports: CampaignReportExports;
+    /** WhatsApp message templates, per channel. */
+    templates;
+    /** Channel webhooks: where a channel's message traffic is delivered. */
+    channelWebhooks;
+    /** Conversation billing: what each conversation cost. */
+    billing;
+    /** Channel wallet ledger. */
+    wallet;
+    /** Channel activity feed. */
+    activity;
     constructor(options) {
         const http = new http_1.HttpClient(options);
+        this.contacts = new contacts_1.Contacts(http);
+        this.contactTags = new contact_tags_1.ContactTags(http);
+        this.contactNotes = new contact_notes_1.ContactNotes(http);
+        this.customFields = new custom_fields_1.CustomFields(http);
+        this.segments = new segments_1.Segments(http);
+        this.crmTriggers = new crm_triggers_1.CrmTriggers(http);
+        this.imports = new import_history_1.Imports(http);
+        this.exports = new export_history_1.Exports(http);
+        this.webhooks = new webhooks_1.Webhooks(http);
         this.channels = new channels_1.Channels(http);
-        // this.contacts = new Contacts(http);
-        // this.customFields = new CustomFields(http);
-        // this.segments = new Segments(http);
-        // this.crmTriggers = new CrmTriggers(http);
-        // this.contactImports = new ContactImports(http);
-        // this.contactExports = new ContactExports(http);
-        // this.webhooks = new Webhooks(http);
-        // this.campaigns = new Campaigns(http);
-        // this.campaignReports = new CampaignReports(http);
-        // this.campaignReportExports = new CampaignReportExports(http);
+        this.templates = new templates_1.Templates(http);
+        this.channelWebhooks = new webhooks_2.ChannelWebhooks(http);
+        this.billing = new billing_1.Billing(http);
+        this.wallet = new wallet_1.Wallet(http);
+        this.activity = new activity_1.Activity(http);
     }
 }
 exports.CrmClient = CrmClient;

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,iCAAwD;AACxD,mDAAgD;AAEhD,8EAA8E;AAC9E,8CAA8C;AAC9C,mDAAmD;AACnD,4DAA4D;AAC5D,mDAAmD;AACnD,0DAA0D;AAC1D,gEAAgE;AAChE,gEAAgE;AAChE,mDAAmD;AACnD,qDAAqD;AACrD,kEAAkE;AAClE,+EAA+E;AAE/E,MAAa,SAAS;IACX,QAAQ,CAAW;IAE5B,+BAA+B;IAC/B,uCAAuC;IACvC,+BAA+B;IAC/B,qCAAqC;IACrC,2CAA2C;IAC3C,2CAA2C;IAC3C,+BAA+B;IAC/B,iCAAiC;IACjC,6CAA6C;IAC7C,yDAAyD;IAEzD,YAAY,OAAsB;QAChC,MAAM,IAAI,GAAG,IAAI,iBAAU,CAAC,OAAO,CAAC,CAAC;QAErC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAEnC,sCAAsC;QACtC,8CAA8C;QAC9C,sCAAsC;QACtC,4CAA4C;QAC5C,kDAAkD;QAClD,kDAAkD;QAClD,sCAAsC;QACtC,wCAAwC;QACxC,oDAAoD;QACpD,gEAAgE;IAClE,CAAC;CACF;AA9BD,8BA8BC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,iCAAwD;AAExD,WAAW;AACX,4DAAyD;AACzD,oEAAgE;AAChE,sEAAkE;AAClE,sEAAkE;AAClE,4DAAyD;AACzD,oEAAgE;AAChE,wEAA8D;AAC9D,wEAA8D;AAC9D,4DAAyD;AAEzD,WAAW;AACX,4DAAyD;AACzD,8DAA2D;AAC3D,4DAAgE;AAChE,0DAAuD;AACvD,wDAAqD;AACrD,4DAAyD;AAEzD,4EAA4E;AAC5E,kBAAkB;AAClB,qDAAqD;AACrD,kEAAkE;AAClE,+EAA+E;AAE/E;;;;;;;;;;;GAWG;AACH,MAAa,SAAS;IACpB,4EAA4E;IAE5E,gDAAgD;IACvC,QAAQ,CAAW;IAC5B,oDAAoD;IAC3C,WAAW,CAAc;IAClC,kEAAkE;IACzD,YAAY,CAAe;IACpC,qDAAqD;IAC5C,YAAY,CAAe;IACpC,uCAAuC;IAC9B,QAAQ,CAAW;IAC5B,qFAAqF;IAC5E,WAAW,CAAc;IAClC,kEAAkE;IACzD,OAAO,CAAU;IAC1B,yDAAyD;IAChD,OAAO,CAAU;IAC1B,0DAA0D;IACjD,QAAQ,CAAW;IAE5B,4EAA4E;IAE5E,gEAAgE;IACvD,QAAQ,CAAW;IAC5B,+CAA+C;IACtC,SAAS,CAAY;IAC9B,wEAAwE;IAC/D,eAAe,CAAkB;IAC1C,yDAAyD;IAChD,OAAO,CAAU;IAC1B,6BAA6B;IACpB,MAAM,CAAS;IACxB,6BAA6B;IACpB,QAAQ,CAAW;IAE5B,YAAY,OAAsB;QAChC,MAAM,IAAI,GAAG,IAAI,iBAAU,CAAC,OAAO,CAAC,CAAC;QAErC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAO,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAO,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAEnC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,IAAI,0BAAe,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;CACF;AAzDD,8BAyDC"}

package/dist/http.d.ts

@@ -17,8 +17,16 @@ export interface ClientOptions {
     timeoutMs?: number;
 }
 export interface RequestInitOptions {
+    /** Serialised as JSON unless `raw` is set. */
     body?: unknown;
     query?: Record<string, unknown>;
+    /**
+     * Request body sent verbatim, for the endpoints that take file bytes rather
+     * than JSON. Takes precedence over `body`.
+     */
+    raw?: BodyInit;
+    /** Overrides `content-type`; required alongside `raw`. */
+    contentType?: string;
 }
 export declare class HttpClient {
     private readonly options;

package/dist/http.js

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpClient = void 0;
 const errors_1 = require("./errors");
+/**
+ * Query values the API reads as JSON rather than as a scalar: the contact
+ * filter, the unix ranges, and the billing list filters. Anything else is
+ * stringified the plain way, and `true`/`false` stay the literals the server
+ * parses them back from.
+ */
+const queryValue = (value) => typeof value === 'object' ? JSON.stringify(value) : String(value);
 const browserOrigin = () => typeof globalThis !== 'undefined' &&
     typeof globalThis.location?.origin === 'string'
     ? globalThis.location.origin
@@ -38,19 +45,19 @@ class HttpClient {
         const url = new URL(`${this.gatewayUrl}${path}`);
         for (const [key, value] of Object.entries(init.query ?? {})) {
             if (value !== undefined && value !== null)
-                url.searchParams.set(key, String(value));
+                url.searchParams.set(key, queryValue(value));
         }
         const origin = this.options.origin ?? browserOrigin();
         const send = this.options.fetch ?? fetch;
         const response = await send(url.toString(), {
             method,
             headers: {
-                'content-type': 'application/json',
+                'content-type': init.contentType ?? 'application/json',
                 authorization: `Bearer ${token}`,
                 'client-id': this.options.clientId.trim(),
                 ...(origin ? { origin } : {}),
             },
-            body: init.body === undefined ? undefined : JSON.stringify(init.body),
+            body: init.raw ?? (init.body === undefined ? undefined : JSON.stringify(init.body)),
             signal: AbortSignal.timeout(this.options.timeoutMs ?? 30_000),
         });
         if (!response.ok)

package/dist/http.js.map

@@ -1 +1 @@
-{"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":";;;AAAA,qCAAuD;AA0BvD,MAAM,aAAa,GAAG,GAAuB,EAAE,CAC7C,OAAO,UAAU,KAAK,WAAW;IACjC,OAAQ,UAAiD,CAAC,QAAQ,EAAE,MAAM,KAAK,QAAQ;IACrF,CAAC,CAAE,UAA0D,CAAC,QAAQ,CAAC,MAAM;IAC7E,CAAC,CAAC,SAAS,CAAC;AAEhB,MAAa,UAAU;IAGQ;IAFZ,UAAU,CAAS;IAEpC,YAA6B,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;QACjD,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,uBAAc,CAAC,wBAAwB,CAAC,CAAC;QACrF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,uBAAc,CAAC,sBAAsB,CAAC,CAAC;QAChF,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC;YACvE,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAClE,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,2FAA2F;IACnF,KAAK,CAAC,KAAK;QACjB,MAAM,KAAK,GACT,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,UAAU;YAC1C,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAChC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAE7B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,MAAc,EAAE,IAAY,EAAE,OAA2B,EAAE;QAC1E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEjC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;QACjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5D,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;gBAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,aAAa,EAAE,CAAC;QAEtD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC1C,MAAM;YACN,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,KAAK,EAAE;gBAChC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBACzC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9B;YACD,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACrE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC;SAC9D,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,MAAM,oBAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;IAC5E,CAAC;CACF;AAvDD,gCAuDC"}
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":";;;AAAA,qCAAuD;AAkCvD;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,KAAc,EAAU,EAAE,CAC5C,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAEpE,MAAM,aAAa,GAAG,GAAuB,EAAE,CAC7C,OAAO,UAAU,KAAK,WAAW;IACjC,OAAQ,UAAiD,CAAC,QAAQ,EAAE,MAAM,KAAK,QAAQ;IACrF,CAAC,CAAE,UAA0D,CAAC,QAAQ,CAAC,MAAM;IAC7E,CAAC,CAAC,SAAS,CAAC;AAEhB,MAAa,UAAU;IAGQ;IAFZ,UAAU,CAAS;IAEpC,YAA6B,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;QACjD,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,uBAAc,CAAC,wBAAwB,CAAC,CAAC;QACrF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,uBAAc,CAAC,sBAAsB,CAAC,CAAC;QAChF,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC;YACvE,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAClE,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,2FAA2F;IACnF,KAAK,CAAC,KAAK;QACjB,MAAM,KAAK,GACT,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,UAAU;YAC1C,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAChC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAE7B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,MAAc,EAAE,IAAY,EAAE,OAA2B,EAAE;QAC1E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEjC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;QACjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5D,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;gBAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1F,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,aAAa,EAAE,CAAC;QAEtD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC1C,MAAM;YACN,OAAO,EAAE;gBACP,cAAc,EAAE,IAAI,CAAC,WAAW,IAAI,kBAAkB;gBACtD,aAAa,EAAE,UAAU,KAAK,EAAE;gBAChC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBACzC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9B;YACD,IAAI,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnF,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC;SAC9D,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,MAAM,oBAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;IAC5E,CAAC;CACF;AAvDD,gCAuDC"}

package/dist/index.d.ts

@@ -2,4 +2,19 @@ export * from './client';
 export * from './http';
 export * from './errors';
 export * from './types';
-export { Channels } from './resources/channels';
+export { AUDIENCE, CHANNELS } from './resources/paths';
+export { Contacts } from './resources/audience/contacts';
+export { ContactTags } from './resources/audience/contact-tags';
+export { ContactNotes } from './resources/audience/contact-notes';
+export { CustomFields } from './resources/audience/custom-fields';
+export { Segments } from './resources/audience/segments';
+export { CrmTriggers } from './resources/audience/crm-triggers';
+export { Imports } from './resources/audience/import-history';
+export { Exports } from './resources/audience/export-history';
+export { Webhooks } from './resources/audience/webhooks';
+export { Channels, type SetPropOptions } from './resources/channels/channels';
+export { Templates } from './resources/channels/templates';
+export { ChannelWebhooks } from './resources/channels/webhooks';
+export { Billing } from './resources/channels/billing';
+export { Wallet } from './resources/channels/wallet';
+export { Activity } from './resources/channels/activity';

package/dist/index.js

@@ -14,11 +14,44 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Channels = void 0;
+exports.Activity = exports.Wallet = exports.Billing = exports.ChannelWebhooks = exports.Templates = exports.Channels = exports.Webhooks = exports.Exports = exports.Imports = exports.CrmTriggers = exports.Segments = exports.CustomFields = exports.ContactNotes = exports.ContactTags = exports.Contacts = exports.CHANNELS = exports.AUDIENCE = void 0;
 __exportStar(require("./client"), exports);
 __exportStar(require("./http"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./types"), exports);
-var channels_1 = require("./resources/channels");
+var paths_1 = require("./resources/paths");
+Object.defineProperty(exports, "AUDIENCE", { enumerable: true, get: function () { return paths_1.AUDIENCE; } });
+Object.defineProperty(exports, "CHANNELS", { enumerable: true, get: function () { return paths_1.CHANNELS; } });
+// Audience
+var contacts_1 = require("./resources/audience/contacts");
+Object.defineProperty(exports, "Contacts", { enumerable: true, get: function () { return contacts_1.Contacts; } });
+var contact_tags_1 = require("./resources/audience/contact-tags");
+Object.defineProperty(exports, "ContactTags", { enumerable: true, get: function () { return contact_tags_1.ContactTags; } });
+var contact_notes_1 = require("./resources/audience/contact-notes");
+Object.defineProperty(exports, "ContactNotes", { enumerable: true, get: function () { return contact_notes_1.ContactNotes; } });
+var custom_fields_1 = require("./resources/audience/custom-fields");
+Object.defineProperty(exports, "CustomFields", { enumerable: true, get: function () { return custom_fields_1.CustomFields; } });
+var segments_1 = require("./resources/audience/segments");
+Object.defineProperty(exports, "Segments", { enumerable: true, get: function () { return segments_1.Segments; } });
+var crm_triggers_1 = require("./resources/audience/crm-triggers");
+Object.defineProperty(exports, "CrmTriggers", { enumerable: true, get: function () { return crm_triggers_1.CrmTriggers; } });
+var import_history_1 = require("./resources/audience/import-history");
+Object.defineProperty(exports, "Imports", { enumerable: true, get: function () { return import_history_1.Imports; } });
+var export_history_1 = require("./resources/audience/export-history");
+Object.defineProperty(exports, "Exports", { enumerable: true, get: function () { return export_history_1.Exports; } });
+var webhooks_1 = require("./resources/audience/webhooks");
+Object.defineProperty(exports, "Webhooks", { enumerable: true, get: function () { return webhooks_1.Webhooks; } });
+// Channels
+var channels_1 = require("./resources/channels/channels");
 Object.defineProperty(exports, "Channels", { enumerable: true, get: function () { return channels_1.Channels; } });
+var templates_1 = require("./resources/channels/templates");
+Object.defineProperty(exports, "Templates", { enumerable: true, get: function () { return templates_1.Templates; } });
+var webhooks_2 = require("./resources/channels/webhooks");
+Object.defineProperty(exports, "ChannelWebhooks", { enumerable: true, get: function () { return webhooks_2.ChannelWebhooks; } });
+var billing_1 = require("./resources/channels/billing");
+Object.defineProperty(exports, "Billing", { enumerable: true, get: function () { return billing_1.Billing; } });
+var wallet_1 = require("./resources/channels/wallet");
+Object.defineProperty(exports, "Wallet", { enumerable: true, get: function () { return wallet_1.Wallet; } });
+var activity_1 = require("./resources/channels/activity");
+Object.defineProperty(exports, "Activity", { enumerable: true, get: function () { return activity_1.Activity; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,2CAAyB;AACzB,0CAAwB;AACxB,iDAAgD;AAAvC,oGAAA,QAAQ,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,2CAAyB;AACzB,0CAAwB;AAExB,2CAAuD;AAA9C,iGAAA,QAAQ,OAAA;AAAE,iGAAA,QAAQ,OAAA;AAE3B,WAAW;AACX,0DAAyD;AAAhD,oGAAA,QAAQ,OAAA;AACjB,kEAAgE;AAAvD,2GAAA,WAAW,OAAA;AACpB,oEAAkE;AAAzD,6GAAA,YAAY,OAAA;AACrB,oEAAkE;AAAzD,6GAAA,YAAY,OAAA;AACrB,0DAAyD;AAAhD,oGAAA,QAAQ,OAAA;AACjB,kEAAgE;AAAvD,2GAAA,WAAW,OAAA;AACpB,sEAA8D;AAArD,yGAAA,OAAO,OAAA;AAChB,sEAA8D;AAArD,yGAAA,OAAO,OAAA;AAChB,0DAAyD;AAAhD,oGAAA,QAAQ,OAAA;AAEjB,WAAW;AACX,0DAA8E;AAArE,oGAAA,QAAQ,OAAA;AACjB,4DAA2D;AAAlD,sGAAA,SAAS,OAAA;AAClB,0DAAgE;AAAvD,2GAAA,eAAe,OAAA;AACxB,wDAAuD;AAA9C,kGAAA,OAAO,OAAA;AAChB,sDAAqD;AAA5C,gGAAA,MAAM,OAAA;AACf,0DAAyD;AAAhD,oGAAA,QAAQ,OAAA"}

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

@@ -0,0 +1,51 @@
+import type { ContactNote, CreateContactNoteInput, ListContactNotesQuery, Page, UpdateContactNoteInput } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * 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.
+ */
+export declare class ContactNotes {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `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: string, query?: Partial<ListContactNotesQuery>): Promise<Page<ContactNote>>;
+    /**
+     * `GET /v1/audience/contacts/:contactId/notes/:noteId`.
+     *
+     * Scope: `contacts:read`.
+     */
+    get(contactId: string, noteId: string): Promise<ContactNote>;
+    /**
+     * `POST /v1/audience/contacts/:contactId/notes` -- 201 with the created note.
+     *
+     * Scope: `contacts:write`.
+     */
+    create(contactId: string, input: CreateContactNoteInput): Promise<ContactNote>;
+    /**
+     * `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: string, noteId: string, input: UpdateContactNoteInput): Promise<ContactNote>;
+    /**
+     * `DELETE /v1/audience/contacts/:contactId/notes/:noteId` -- 204, no body.
+     *
+     * Scope: `contacts:write`.
+     */
+    delete(contactId: string, noteId: string): Promise<void>;
+}