ab-ecosystem-cpass 1.0.6 → 1.0.8

package/README.md

@@ -173,6 +173,7 @@ same pages ship inside the package, so they are readable offline at
 | `crm.contactTags` | [contact tags](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/contact-tags.md) | `list` `get` `create` `update` `delete` |
 | `crm.contactNotes` | [contact notes](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/contact-notes.md) | `list` `get` `create` `update` `delete` |
 | `crm.customFields` | [custom fields](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/custom-fields.md) | `list` `get` `create` `update` `delete` |
+| `crm.cannedReplies` | [canned replies](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/canned-replies.md) | `list` `get` `create` `update` `delete` — addressed by id **or** name |
 | `crm.segments` | [segments](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/segments.md) | `list` `get` `create` `update` `delete` |
 | `crm.crmTriggers` | [CRM triggers](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/crm-triggers.md) | `list` `get` `create` `update` `delete` `logs` |
 | `crm.imports` | [import history](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/imports.md) | `list` `get` `create` `delete` |
@@ -180,6 +181,9 @@ same pages ship inside the package, so they are readable offline at
 | `crm.webhooks` | [audience webhooks](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/webhooks.md) | `list` `get` `create` `update` `delete` |
 | `crm.scheduledMessages` | [scheduled messages](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/scheduled-messages.md) | `list` `get` `create` `createSeries` `createRepeating` `reschedule` `cancel` `cancelSeries` `sendNow` |
 | `crm.notifications` | [push notifications](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/audience/notifications.md) | `subscribe` `unsubscribe` `devices` — the devices a user wants notified |
+| `crm.dataStores` | [data store](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/data-store.md) | `list` `get` `create` `update` `remove` `test` — a MongoDB you own, registered with the platform |
+| `crm.dataStoreCollections` | [data store](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/data-store.md) | `list` `get` `create` `update` `remove` — the schemas declared over it |
+| `crm.dataStoreRecords` | [data store](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/data-store.md) | `insert` `list` `search` `get` `update` `bulkUpdate` `remove` `bulkRemove` — documents in your own database |
 
 ### Channels — `/v1/channels`
 
@@ -275,8 +279,7 @@ to show a user.
 | Resource | Page | Actions |
 | --- | --- | --- |
 | `crm.campaigns` | [campaigns](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/campaign/campaigns.md) | `list` `get` `create` `createBulk` `createGroup` `uploadReceivers` `update` `schedule` `cancel` `delete` |
-| `crm.campaignReports` | [campaigns](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/campaign/campaigns.md#campaign-reports) | `list` `getByCampaign` |
-| `crm.campaignReportExports` | [campaigns](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/campaign/campaigns.md#campaign-reports) | `list` `get` `create` |
+| `crm.campaignMessages` | [campaign reporting](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/campaign/campaign-messages.md) | `stats` `list` `iterate` `replies` — `/v1/campaigns/:id/report`, counted off the per-recipient rows |
 
 The audience helpers are exported too, so a UI can show "12,480 recipients, 3
 duplicates dropped" before anything is uploaded:

package/dist/client.d.ts

@@ -2,6 +2,7 @@ import { type ClientOptions } from './http';
 import { Contacts } from './resources/audience/contacts';
 import { ContactTags } from './resources/audience/contact-tags';
 import { ContactNotes } from './resources/audience/contact-notes';
+import { CannedReplies } from './resources/audience/canned-replies';
 import { CustomFields } from './resources/audience/custom-fields';
 import { Segments } from './resources/audience/segments';
 import { CrmTriggers } from './resources/audience/crm-triggers';
@@ -11,6 +12,7 @@ import { Webhooks } from './resources/audience/webhooks';
 import { ScheduledMessages } from './resources/audience/scheduled-messages';
 import { InboxMedia } from './resources/audience/inbox-media';
 import { Notifications } from './resources/audience/notifications';
+import { DataStoreCollections, DataStoreRecords, DataStores } from './resources/data-stores';
 import { Channels } from './resources/channels/channels';
 import { Templates } from './resources/channels/templates';
 import { ChannelWebhooks } from './resources/channels/webhooks';
@@ -18,8 +20,7 @@ import { Billing } from './resources/channels/billing';
 import { Wallet } from './resources/channels/wallet';
 import { Activity } from './resources/channels/activity';
 import { Campaigns } from './resources/campaigns';
-import { CampaignReports } from './resources/campaign-reports';
-import { CampaignReportExports } from './resources/campaign-report-exports';
+import { CampaignMessages } from './resources/campaign-messages';
 /**
  * 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,
@@ -41,6 +42,15 @@ export declare class CrmClient {
     readonly contactNotes: ContactNotes;
     /** Custom fields: the per-account contact schema. */
     readonly customFields: CustomFields;
+    /**
+     * Canned replies: stored message payloads an agent sends without retyping
+     * them. A `CANNED` reply fires its messages as stored; a `QUICK` one lands in
+     * the composer to edit first.
+     *
+     * Addressed by id or by name -- names are unique per account, and the name is
+     * what an agent types after `/` to pick one.
+     */
+    readonly cannedReplies: CannedReplies;
     /** Segments: saved contact filters. */
     readonly segments: Segments;
     /** CRM triggers: fire a webhook when a contact changes, plus their delivery logs. */
@@ -70,6 +80,19 @@ export declare class CrmClient {
      * token, `unsubscribe()` on logout.
      */
     readonly notifications: Notifications;
+    /**
+     * Data stores: a MongoDB you own, registered with the platform.
+     *
+     * The platform holds the credential -- encrypted -- and the schemas you
+     * declare over it. It holds none of your data: every record call is a live
+     * round trip to your own cluster. Deleting a store or a collection forgets
+     * our side of it and leaves your database untouched.
+     */
+    readonly dataStores: DataStores;
+    /** The collections declared over a data store: a name, and the fields in it. */
+    readonly dataStoreCollections: DataStoreCollections;
+    /** The records inside one -- documents in your database, read and written live. */
+    readonly dataStoreRecords: DataStoreRecords;
     /** Channels, and the provider properties that hang off them. */
     readonly channels: Channels;
     /** WhatsApp message templates, per channel. */
@@ -91,9 +114,11 @@ export declare class CrmClient {
      * has to get exactly right.
      */
     readonly campaigns: Campaigns;
-    /** Per-campaign delivery metrics. */
-    readonly campaignReports: CampaignReports;
-    /** Report extracts as CSV or XLSX, generated asynchronously. */
-    readonly campaignReportExports: CampaignReportExports;
+    /**
+     * Campaign reporting: the funnel, the per-recipient rows behind it, and what
+     * people replied -- all counted off the message rows when asked for, so there
+     * is no roll-up to wait for and no export job to poll.
+     */
+    readonly campaignMessages: CampaignMessages;
     constructor(options: ClientOptions);
 }

package/dist/client.js

@@ -6,6 +6,7 @@ const http_1 = require("./http");
 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 canned_replies_1 = require("./resources/audience/canned-replies");
 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");
@@ -15,6 +16,7 @@ const webhooks_1 = require("./resources/audience/webhooks");
 const scheduled_messages_1 = require("./resources/audience/scheduled-messages");
 const inbox_media_1 = require("./resources/audience/inbox-media");
 const notifications_1 = require("./resources/audience/notifications");
+const data_stores_1 = require("./resources/data-stores");
 // Channels
 const channels_1 = require("./resources/channels/channels");
 const templates_1 = require("./resources/channels/templates");
@@ -24,8 +26,7 @@ const wallet_1 = require("./resources/channels/wallet");
 const activity_1 = require("./resources/channels/activity");
 // Campaign
 const campaigns_1 = require("./resources/campaigns");
-const campaign_reports_1 = require("./resources/campaign-reports");
-const campaign_report_exports_1 = require("./resources/campaign-report-exports");
+const campaign_messages_1 = require("./resources/campaign-messages");
 /**
  * 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,
@@ -48,6 +49,15 @@ class CrmClient {
     contactNotes;
     /** Custom fields: the per-account contact schema. */
     customFields;
+    /**
+     * Canned replies: stored message payloads an agent sends without retyping
+     * them. A `CANNED` reply fires its messages as stored; a `QUICK` one lands in
+     * the composer to edit first.
+     *
+     * Addressed by id or by name -- names are unique per account, and the name is
+     * what an agent types after `/` to pick one.
+     */
+    cannedReplies;
     /** Segments: saved contact filters. */
     segments;
     /** CRM triggers: fire a webhook when a contact changes, plus their delivery logs. */
@@ -77,6 +87,19 @@ class CrmClient {
      * token, `unsubscribe()` on logout.
      */
     notifications;
+    /**
+     * Data stores: a MongoDB you own, registered with the platform.
+     *
+     * The platform holds the credential -- encrypted -- and the schemas you
+     * declare over it. It holds none of your data: every record call is a live
+     * round trip to your own cluster. Deleting a store or a collection forgets
+     * our side of it and leaves your database untouched.
+     */
+    dataStores;
+    /** The collections declared over a data store: a name, and the fields in it. */
+    dataStoreCollections;
+    /** The records inside one -- documents in your database, read and written live. */
+    dataStoreRecords;
     // -- Channels -------------------------------------------------------------
     /** Channels, and the provider properties that hang off them. */
     channels;
@@ -100,16 +123,19 @@ class CrmClient {
      * has to get exactly right.
      */
     campaigns;
-    /** Per-campaign delivery metrics. */
-    campaignReports;
-    /** Report extracts as CSV or XLSX, generated asynchronously. */
-    campaignReportExports;
+    /**
+     * Campaign reporting: the funnel, the per-recipient rows behind it, and what
+     * people replied -- all counted off the message rows when asked for, so there
+     * is no roll-up to wait for and no export job to poll.
+     */
+    campaignMessages;
     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.cannedReplies = new canned_replies_1.CannedReplies(http);
         this.segments = new segments_1.Segments(http);
         this.crmTriggers = new crm_triggers_1.CrmTriggers(http);
         this.imports = new import_history_1.Imports(http);
@@ -118,6 +144,9 @@ class CrmClient {
         this.scheduledMessages = new scheduled_messages_1.ScheduledMessages(http);
         this.inboxMedia = new inbox_media_1.InboxMedia(http);
         this.notifications = new notifications_1.Notifications(http);
+        this.dataStores = new data_stores_1.DataStores(http);
+        this.dataStoreCollections = new data_stores_1.DataStoreCollections(http);
+        this.dataStoreRecords = new data_stores_1.DataStoreRecords(http);
         this.channels = new channels_1.Channels(http);
         this.templates = new templates_1.Templates(http);
         this.channelWebhooks = new webhooks_2.ChannelWebhooks(http);
@@ -128,8 +157,7 @@ class CrmClient {
         // audience is uploaded through the media endpoint before the campaign is
         // created.
         this.campaigns = new campaigns_1.Campaigns(http);
-        this.campaignReports = new campaign_reports_1.CampaignReports(http);
-        this.campaignReportExports = new campaign_report_exports_1.CampaignReportExports(http);
+        this.campaignMessages = new campaign_messages_1.CampaignMessages(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;AAExD,WAAW;AACX,4DAAyD;AACzD,oEAAgE;AAChE,sEAAkE;AAClE,sEAAkE;AAClE,4DAAyD;AACzD,oEAAgE;AAChE,wEAA8D;AAC9D,wEAA8D;AAC9D,4DAAyD;AACzD,gFAA4E;AAC5E,kEAA8D;AAC9D,sEAAmE;AAEnE,WAAW;AACX,4DAAyD;AACzD,8DAA2D;AAC3D,4DAAgE;AAChE,0DAAuD;AACvD,wDAAqD;AACrD,4DAAyD;AAEzD,WAAW;AACX,qDAAkD;AAClD,mEAA+D;AAC/D,iFAA4E;AAE5E;;;;;;;;;;;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;IAC5B;;;OAGG;IACM,iBAAiB,CAAoB;IAE9C;;;;;;OAMG;IACM,UAAU,CAAa;IAEhC;;;;OAIG;IACM,aAAa,CAAgB;IAEtC,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,4EAA4E;IAE5E;;;;;;;OAOG;IACM,SAAS,CAAY;IAC9B,qCAAqC;IAC5B,eAAe,CAAkB;IAC1C,gEAAgE;IACvD,qBAAqB,CAAwB;IAEtD,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;QACnC,IAAI,CAAC,iBAAiB,GAAG,IAAI,sCAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAE7C,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;QAEnC,uEAAuE;QACvE,yEAAyE;QACzE,WAAW;QACX,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,IAAI,kCAAe,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,qBAAqB,GAAG,IAAI,+CAAqB,CAAC,IAAI,CAAC,CAAC;IAC/D,CAAC;CACF;AAxGD,8BAwGC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,iCAAwD;AAExD,WAAW;AACX,4DAAyD;AACzD,oEAAgE;AAChE,sEAAkE;AAClE,wEAAoE;AACpE,sEAAkE;AAClE,4DAAyD;AACzD,oEAAgE;AAChE,wEAA8D;AAC9D,wEAA8D;AAC9D,4DAAyD;AACzD,gFAA4E;AAC5E,kEAA8D;AAC9D,sEAAmE;AACnE,yDAIiC;AAEjC,WAAW;AACX,4DAAyD;AACzD,8DAA2D;AAC3D,4DAAgE;AAChE,0DAAuD;AACvD,wDAAqD;AACrD,4DAAyD;AAEzD,WAAW;AACX,qDAAkD;AAClD,qEAAiE;AAEjE;;;;;;;;;;;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;;;;;;;OAOG;IACM,aAAa,CAAgB;IACtC,uCAAuC;IAC9B,QAAQ,CAAW;IAC5B,qFAAqF;IAC5E,WAAW,CAAc;IAClC,kEAAkE;IACzD,OAAO,CAAU;IAC1B,yDAAyD;IAChD,OAAO,CAAU;IAC1B,0DAA0D;IACjD,QAAQ,CAAW;IAC5B;;;OAGG;IACM,iBAAiB,CAAoB;IAE9C;;;;;;OAMG;IACM,UAAU,CAAa;IAEhC;;;;OAIG;IACM,aAAa,CAAgB;IAEtC;;;;;;;OAOG;IACM,UAAU,CAAa;IAChC,gFAAgF;IACvE,oBAAoB,CAAuB;IACpD,mFAAmF;IAC1E,gBAAgB,CAAmB;IAE5C,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,4EAA4E;IAE5E;;;;;;;OAOG;IACM,SAAS,CAAY;IAC9B;;;;OAIG;IACM,gBAAgB,CAAmB;IAE5C,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,aAAa,GAAG,IAAI,8BAAa,CAAC,IAAI,CAAC,CAAC;QAC7C,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;QACnC,IAAI,CAAC,iBAAiB,GAAG,IAAI,sCAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,IAAI,kCAAoB,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,8BAAgB,CAAC,IAAI,CAAC,CAAC;QAEnD,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;QAEnC,uEAAuE;QACvE,yEAAyE;QACzE,WAAW;QACX,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,IAAI,oCAAgB,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;CACF;AApID,8BAoIC"}

package/dist/index.d.ts

@@ -6,6 +6,7 @@ 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 { CannedReplies } from './resources/audience/canned-replies';
 export { CustomFields } from './resources/audience/custom-fields';
 export { Segments } from './resources/audience/segments';
 export { CrmTriggers } from './resources/audience/crm-triggers';
@@ -13,10 +14,10 @@ export { Imports } from './resources/audience/import-history';
 export { Exports } from './resources/audience/export-history';
 export { Webhooks } from './resources/audience/webhooks';
 export { Notifications } from './resources/audience/notifications';
+export { DataStores, DataStoreCollections, DataStoreRecords, } from './resources/data-stores';
 export { InboxMedia, type UploadMediaOptions, type UploadMediaSource, } from './resources/audience/inbox-media';
 export { Campaigns, type CreateBulkCampaignInput, type BulkCampaignResult, type CreateGroupCampaignInput, type GroupBucket, type GroupBucketResult, type GroupCampaignResult, type ReceiverUploader, } from './resources/campaigns';
-export { CampaignReports } from './resources/campaign-reports';
-export { CampaignReportExports } from './resources/campaign-report-exports';
+export { CampaignMessages } from './resources/campaign-messages';
 /**
  * The audience helpers, exported because they are useful before a campaign
  * exists: a UI can parse a CSV, show "12,480 recipients, 3 duplicates dropped",

package/dist/index.js

@@ -14,7 +14,7 @@ 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.Activity = exports.Wallet = exports.Billing = exports.ChannelWebhooks = exports.Templates = exports.Channels = exports.resolveAudience = exports.parseDelimited = exports.normaliseNumbers = exports.normaliseColumn = exports.buildReceivers = exports.MAX_BULK_RECEIVERS = exports.CampaignReportExports = exports.CampaignReports = exports.Campaigns = exports.InboxMedia = exports.Notifications = exports.Webhooks = exports.Exports = exports.Imports = exports.CrmTriggers = exports.Segments = exports.CustomFields = exports.ContactNotes = exports.ContactTags = exports.Contacts = exports.CHANNELS = exports.AUDIENCE = void 0;
+exports.Activity = exports.Wallet = exports.Billing = exports.ChannelWebhooks = exports.Templates = exports.Channels = exports.resolveAudience = exports.parseDelimited = exports.normaliseNumbers = exports.normaliseColumn = exports.buildReceivers = exports.MAX_BULK_RECEIVERS = exports.CampaignMessages = exports.Campaigns = exports.InboxMedia = exports.DataStoreRecords = exports.DataStoreCollections = exports.DataStores = exports.Notifications = exports.Webhooks = exports.Exports = exports.Imports = exports.CrmTriggers = exports.Segments = exports.CustomFields = exports.CannedReplies = exports.ContactNotes = exports.ContactTags = exports.Contacts = exports.CHANNELS = exports.AUDIENCE = void 0;
 __exportStar(require("./client"), exports);
 __exportStar(require("./http"), exports);
 __exportStar(require("./errors"), exports);
@@ -29,6 +29,8 @@ 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 canned_replies_1 = require("./resources/audience/canned-replies");
+Object.defineProperty(exports, "CannedReplies", { enumerable: true, get: function () { return canned_replies_1.CannedReplies; } });
 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");
@@ -43,15 +45,17 @@ var webhooks_1 = require("./resources/audience/webhooks");
 Object.defineProperty(exports, "Webhooks", { enumerable: true, get: function () { return webhooks_1.Webhooks; } });
 var notifications_1 = require("./resources/audience/notifications");
 Object.defineProperty(exports, "Notifications", { enumerable: true, get: function () { return notifications_1.Notifications; } });
+var data_stores_1 = require("./resources/data-stores");
+Object.defineProperty(exports, "DataStores", { enumerable: true, get: function () { return data_stores_1.DataStores; } });
+Object.defineProperty(exports, "DataStoreCollections", { enumerable: true, get: function () { return data_stores_1.DataStoreCollections; } });
+Object.defineProperty(exports, "DataStoreRecords", { enumerable: true, get: function () { return data_stores_1.DataStoreRecords; } });
 var inbox_media_1 = require("./resources/audience/inbox-media");
 Object.defineProperty(exports, "InboxMedia", { enumerable: true, get: function () { return inbox_media_1.InboxMedia; } });
 // Campaign
 var campaigns_1 = require("./resources/campaigns");
 Object.defineProperty(exports, "Campaigns", { enumerable: true, get: function () { return campaigns_1.Campaigns; } });
-var campaign_reports_1 = require("./resources/campaign-reports");
-Object.defineProperty(exports, "CampaignReports", { enumerable: true, get: function () { return campaign_reports_1.CampaignReports; } });
-var campaign_report_exports_1 = require("./resources/campaign-report-exports");
-Object.defineProperty(exports, "CampaignReportExports", { enumerable: true, get: function () { return campaign_report_exports_1.CampaignReportExports; } });
+var campaign_messages_1 = require("./resources/campaign-messages");
+Object.defineProperty(exports, "CampaignMessages", { enumerable: true, get: function () { return campaign_messages_1.CampaignMessages; } });
 /**
  * The audience helpers, exported because they are useful before a campaign
  * exists: a UI can parse a CSV, show "12,480 recipients, 3 duplicates dropped",

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;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;AACjB,oEAAmE;AAA1D,8GAAA,aAAa,OAAA;AACtB,gEAI0C;AAHxC,yGAAA,UAAU,OAAA;AAKZ,WAAW;AACX,mDAS+B;AAR7B,sGAAA,SAAS,OAAA;AASX,iEAA+D;AAAtD,mHAAA,eAAe,OAAA;AACxB,+EAA4E;AAAnE,gIAAA,qBAAqB,OAAA;AAC9B;;;;GAIG;AACH,mEAUuC;AATrC,uHAAA,kBAAkB,OAAA;AAClB,mHAAA,cAAc,OAAA;AACd,oHAAA,eAAe,OAAA;AACf,qHAAA,gBAAgB,OAAA;AAChB,mHAAA,cAAc,OAAA;AACd,oHAAA,eAAe,OAAA;AAMjB,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"}
+{"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,sEAAoE;AAA3D,+GAAA,aAAa,OAAA;AACtB,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;AACjB,oEAAmE;AAA1D,8GAAA,aAAa,OAAA;AACtB,uDAIiC;AAH/B,yGAAA,UAAU,OAAA;AACV,mHAAA,oBAAoB,OAAA;AACpB,+GAAA,gBAAgB,OAAA;AAElB,gEAI0C;AAHxC,yGAAA,UAAU,OAAA;AAKZ,WAAW;AACX,mDAS+B;AAR7B,sGAAA,SAAS,OAAA;AASX,mEAAiE;AAAxD,qHAAA,gBAAgB,OAAA;AACzB;;;;GAIG;AACH,mEAUuC;AATrC,uHAAA,kBAAkB,OAAA;AAClB,mHAAA,cAAc,OAAA;AACd,oHAAA,eAAe,OAAA;AACf,qHAAA,gBAAgB,OAAA;AAChB,mHAAA,cAAc,OAAA;AACd,oHAAA,eAAe,OAAA;AAMjB,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/canned-replies.d.ts

@@ -0,0 +1,95 @@
+import type { CannedReply, CreateCannedReplyInput, ListCannedRepliesQuery, Paginated, UpdateCannedReplyInput } from '../../types';
+import type { HttpClient } from '../../http';
+/**
+ * Canned replies: message payloads an agent sends into a chat without retyping
+ * them.
+ *
+ * Two kinds. A `CANNED` reply sends every message it holds, as stored, in order,
+ * the moment it is picked -- so a three-message reply is three messages on the
+ * contact's phone from one keystroke. A `QUICK` reply drops its text into the
+ * agent's composer to edit first, which is why it holds exactly one text message
+ * and nothing else.
+ *
+ * ```ts
+ * await crm.cannedReplies.create({
+ *   name: 'price list',
+ *   type: 'CANNED',
+ *   channel: 'whatsapp',
+ *   messages: [
+ *     { version: '2', whatsapp_api: { type: 'text', text: { body: 'Here you go' } } },
+ *     { version: '2', whatsapp_api: {
+ *         type: 'document',
+ *         document: { link: 'https://.../prices.pdf', filename: 'prices.pdf' } } },
+ *   ],
+ * });
+ * ```
+ *
+ * The payload under `whatsapp_api` is the same object `inbox.messages.send()`
+ * takes as `content`, which is the point: picking a reply is sending its
+ * payloads, with no translation step in between.
+ *
+ * Variable placeholders in a body are stored literally and substituted by the
+ * sender against the contact in front of the agent. There is no contact at the
+ * time a reply is written, so nothing is substituted here.
+ */
+export declare class CannedReplies {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/audience/canned-replies` -- offset paginated, newest first, with
+     * `messages` included on every row.
+     *
+     * Query: `page` (default 1), `rows` (1-100, default 25), `search` (matches the
+     * name, case-insensitive, substring, the term escaped), `type` (`CANNED` |
+     * `QUICK`), `channel` (a channel *type*, e.g. `whatsapp` -- not a channel id).
+     *
+     * To count without fetching, ask for `rows: 1` and read `pagination.total`.
+     *
+     * Scope: `canned_replies:read`.
+     */
+    list(query?: Partial<ListCannedRepliesQuery>): Promise<Paginated<CannedReply>>;
+    /**
+     * `GET /v1/audience/canned-replies/:reply` -- by **id or name**.
+     *
+     * A 24-hex-character value is read as an id, anything else as a name. Names are
+     * unique per account, which is what makes addressing by the name an agent typed
+     * safe. 404 `not_found` if it is not the caller's.
+     *
+     * Scope: `canned_replies:read`.
+     */
+    get(ref: string): Promise<CannedReply>;
+    /**
+     * `POST /v1/audience/canned-replies` -- 201 with the created reply.
+     *
+     * Body: `name` (1-120 chars, unique per account), `type`, `channel` (default
+     * `whatsapp`), `messages` (1-10, each `{ version: '2', whatsapp_api, internal? }`).
+     *
+     * Errors: 409 `conflict` if the name is taken. 422 `invalid_canned_reply` if a
+     * `QUICK` reply holds more than one message or a non-text one -- which legacy
+     * accepted and the panel then refused to use.
+     *
+     * Scope: `canned_replies:write`.
+     */
+    create(input: CreateCannedReplyInput): Promise<CannedReply>;
+    /**
+     * `PATCH /v1/audience/canned-replies/:reply` -- by id or name, any subset of
+     * the create body.
+     *
+     * `messages` is replaced whole, never merged: send the array you want stored.
+     * Renaming works (it silently did not in legacy, which `$set` only `messages`).
+     *
+     * Errors: 404 `not_found`; 409 `conflict` on a rename into a taken name; 422
+     * `invalid_canned_reply` if the *merged* result breaks the `QUICK` rule -- so
+     * flipping a three-message reply to `QUICK` is refused, while renaming one that
+     * already breaks the rule is not.
+     *
+     * Scope: `canned_replies:write`.
+     */
+    update(ref: string, input: UpdateCannedReplyInput): Promise<CannedReply>;
+    /**
+     * `DELETE /v1/audience/canned-replies/:reply` -- by id or name. 204, no body.
+     *
+     * Scope: `canned_replies:write`.
+     */
+    delete(ref: string): Promise<void>;
+}

package/dist/resources/audience/canned-replies.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CannedReplies = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/canned-replies`;
+/**
+ * Canned replies: message payloads an agent sends into a chat without retyping
+ * them.
+ *
+ * Two kinds. A `CANNED` reply sends every message it holds, as stored, in order,
+ * the moment it is picked -- so a three-message reply is three messages on the
+ * contact's phone from one keystroke. A `QUICK` reply drops its text into the
+ * agent's composer to edit first, which is why it holds exactly one text message
+ * and nothing else.
+ *
+ * ```ts
+ * await crm.cannedReplies.create({
+ *   name: 'price list',
+ *   type: 'CANNED',
+ *   channel: 'whatsapp',
+ *   messages: [
+ *     { version: '2', whatsapp_api: { type: 'text', text: { body: 'Here you go' } } },
+ *     { version: '2', whatsapp_api: {
+ *         type: 'document',
+ *         document: { link: 'https://.../prices.pdf', filename: 'prices.pdf' } } },
+ *   ],
+ * });
+ * ```
+ *
+ * The payload under `whatsapp_api` is the same object `inbox.messages.send()`
+ * takes as `content`, which is the point: picking a reply is sending its
+ * payloads, with no translation step in between.
+ *
+ * Variable placeholders in a body are stored literally and substituted by the
+ * sender against the contact in front of the agent. There is no contact at the
+ * time a reply is written, so nothing is substituted here.
+ */
+class CannedReplies {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/canned-replies` -- offset paginated, newest first, with
+     * `messages` included on every row.
+     *
+     * Query: `page` (default 1), `rows` (1-100, default 25), `search` (matches the
+     * name, case-insensitive, substring, the term escaped), `type` (`CANNED` |
+     * `QUICK`), `channel` (a channel *type*, e.g. `whatsapp` -- not a channel id).
+     *
+     * To count without fetching, ask for `rows: 1` and read `pagination.total`.
+     *
+     * Scope: `canned_replies:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/canned-replies/:reply` -- by **id or name**.
+     *
+     * A 24-hex-character value is read as an id, anything else as a name. Names are
+     * unique per account, which is what makes addressing by the name an agent typed
+     * safe. 404 `not_found` if it is not the caller's.
+     *
+     * Scope: `canned_replies:read`.
+     */
+    get(ref) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(ref)}`);
+    }
+    /**
+     * `POST /v1/audience/canned-replies` -- 201 with the created reply.
+     *
+     * Body: `name` (1-120 chars, unique per account), `type`, `channel` (default
+     * `whatsapp`), `messages` (1-10, each `{ version: '2', whatsapp_api, internal? }`).
+     *
+     * Errors: 409 `conflict` if the name is taken. 422 `invalid_canned_reply` if a
+     * `QUICK` reply holds more than one message or a non-text one -- which legacy
+     * accepted and the panel then refused to use.
+     *
+     * Scope: `canned_replies:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/canned-replies/:reply` -- by id or name, any subset of
+     * the create body.
+     *
+     * `messages` is replaced whole, never merged: send the array you want stored.
+     * Renaming works (it silently did not in legacy, which `$set` only `messages`).
+     *
+     * Errors: 404 `not_found`; 409 `conflict` on a rename into a taken name; 422
+     * `invalid_canned_reply` if the *merged* result breaks the `QUICK` rule -- so
+     * flipping a three-message reply to `QUICK` is refused, while renaming one that
+     * already breaks the rule is not.
+     *
+     * Scope: `canned_replies:write`.
+     */
+    update(ref, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(ref)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/canned-replies/:reply` -- by id or name. 204, no body.
+     *
+     * Scope: `canned_replies:write`.
+     */
+    delete(ref) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(ref)}`);
+    }
+}
+exports.CannedReplies = CannedReplies;
+//# sourceMappingURL=canned-replies.js.map

package/dist/resources/audience/canned-replies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canned-replies.js","sourceRoot":"","sources":["../../../src/resources/audience/canned-replies.ts"],"names":[],"mappings":";;;AAQA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,iBAAiB,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,aAAa;IACK;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,QAAyC,EAAE;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;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;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;OAaG;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;AA1ED,sCA0EC"}

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

@@ -38,6 +38,20 @@ import type { HttpClient } from '../../http';
  * the platform resolves it from the client the call arrives on and stamps it onto
  * the row, because a token is only sendable through the project that minted it
  * and nothing in the token says which.
+ *
+ * ## What a subscribed device then receives
+ *
+ * One notification per **message the business did not send itself** -- a
+ * contact's reply, or an echo of somebody answering from the WhatsApp Business
+ * app -- on a chat the device's owner is responsible for: the assigned agent, or
+ * the account owner while the chat is unassigned. An agent's own reply, a bot's,
+ * a campaign send and a delivery receipt all notify nobody.
+ *
+ * The title is who wrote; the body is the message text, or `Image Message` and
+ * the like for media. `data.chat` is the chat id, `webpush.fcmOptions.link` is
+ * what a browser opens on click, and `data.click_action` is that same URL on web
+ * and the bare chat id on a native app. The payload is documented key by key in
+ * `docs/audience/notifications.md`.
  */
 export declare class Notifications {
     private readonly http;

package/dist/resources/audience/notifications.js

@@ -47,6 +47,20 @@ const MAX_LABEL = 200;
  * the platform resolves it from the client the call arrives on and stamps it onto
  * the row, because a token is only sendable through the project that minted it
  * and nothing in the token says which.
+ *
+ * ## What a subscribed device then receives
+ *
+ * One notification per **message the business did not send itself** -- a
+ * contact's reply, or an echo of somebody answering from the WhatsApp Business
+ * app -- on a chat the device's owner is responsible for: the assigned agent, or
+ * the account owner while the chat is unassigned. An agent's own reply, a bot's,
+ * a campaign send and a delivery receipt all notify nobody.
+ *
+ * The title is who wrote; the body is the message text, or `Image Message` and
+ * the like for media. `data.chat` is the chat id, `webpush.fcmOptions.link` is
+ * what a browser opens on click, and `data.click_action` is that same URL on web
+ * and the bare chat id on a native app. The payload is documented key by key in
+ * `docs/audience/notifications.md`.
  */
 class Notifications {
     http;

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

@@ -1 +1 @@
-{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../../src/resources/audience/notifications.ts"],"names":[],"mappings":";;;AAEA,yCAA2C;AAC3C,kDAAuE;AACvE,oCAAoC;AAEpC,MAAM,IAAI,GAAG,GAAG,gBAAQ,UAAU,CAAC;AAEnC,6FAA6F;AAC7F,MAAM,YAAY,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAE5C,wFAAwF;AACxF,MAAM,SAAS,GAAG,GAAG,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAa,aAAa;IACK;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACH,SAAS,CAAC,KAAkC;QAC1C,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAEzC,IAAI,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,GAAG,EAAE,CAAC;YACvE,MAAM,IAAI,oBAAW,CACnB,GAAG,EACH,mBAAmB,EACnB,kDAAkD,YAAY,CAAC,GAAG,KAAK,YAAY,CAAC,GAAG,aAAa,CACrG,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAA,uBAAc,GAAE,CAAC;QAEpD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,wEAAwE;YACxE,oEAAoE;YACpE,yCAAyC;YACzC,MAAM,IAAI,oBAAW,CACnB,GAAG,EACH,mBAAmB,EACnB,oFAAoF,CACrF,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,YAAY,IAAI,IAAA,uBAAc,GAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAS,MAAM,EAAE,IAAI,EAAE;YAC7C,IAAI,EAAE;gBACJ,KAAK;gBACL,QAAQ;gBACR,uEAAuE;gBACvE,0EAA0E;gBAC1E,4CAA4C;gBAC5C,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACzD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,WAAW,CAAC,KAAa;QACvB,MAAM,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,oBAAW,CAAC,GAAG,EAAE,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;QAEjF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,MAAM,EAAE,GAAG,IAAI,aAAa,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,OAAO,CAAC,QAAmC,EAAE;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAhLD,sCAgLC"}
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../../src/resources/audience/notifications.ts"],"names":[],"mappings":";;;AAEA,yCAA2C;AAC3C,kDAAuE;AACvE,oCAAoC;AAEpC,MAAM,IAAI,GAAG,GAAG,gBAAQ,UAAU,CAAC;AAEnC,6FAA6F;AAC7F,MAAM,YAAY,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAE5C,wFAAwF;AACxF,MAAM,SAAS,GAAG,GAAG,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAa,aAAa;IACK;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACH,SAAS,CAAC,KAAkC;QAC1C,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAEzC,IAAI,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,GAAG,EAAE,CAAC;YACvE,MAAM,IAAI,oBAAW,CACnB,GAAG,EACH,mBAAmB,EACnB,kDAAkD,YAAY,CAAC,GAAG,KAAK,YAAY,CAAC,GAAG,aAAa,CACrG,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAA,uBAAc,GAAE,CAAC;QAEpD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,wEAAwE;YACxE,oEAAoE;YACpE,yCAAyC;YACzC,MAAM,IAAI,oBAAW,CACnB,GAAG,EACH,mBAAmB,EACnB,oFAAoF,CACrF,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,YAAY,IAAI,IAAA,uBAAc,GAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAS,MAAM,EAAE,IAAI,EAAE;YAC7C,IAAI,EAAE;gBACJ,KAAK;gBACL,QAAQ;gBACR,uEAAuE;gBACvE,0EAA0E;gBAC1E,4CAA4C;gBAC5C,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACzD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,WAAW,CAAC,KAAa;QACvB,MAAM,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,oBAAW,CAAC,GAAG,EAAE,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;QAEjF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,MAAM,EAAE,GAAG,IAAI,aAAa,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,OAAO,CAAC,QAAmC,EAAE;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAhLD,sCAgLC"}