ab-ecosystem-cpass 1.0.11 → 1.0.12

package/README.md

@@ -229,6 +229,7 @@ same pages ship inside the package, so they are readable offline at
 | --- | --- | --- |
 | `crm.channels` | [channels](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/channels/channels.md) | `list` `get` `updateDetails` `disable` `rotateToken` `getProp` `setProp` |
 | — | [channel properties](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/channels/channel-props.md) | every `prop` `getProp`/`setProp` accepts |
+| `crm.channelOnboarding` | [connecting a channel](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/channels/onboarding.md) | `types` `url` `exchange` `complete` `connect` |
 | `crm.templates` | [templates](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/channels/templates.md) | `list` `get` `create` `update` `delete` `sync` |
 | `crm.channelWebhooks` | [channel webhooks](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/channels/webhooks.md) | `list` `get` `create` `update` `delete` |
 | `crm.billing` | [conversation billing](https://github.com/udghatan-dev/crm-sdk/blob/main/packages/sdk-js/docs/channels/billing.md) | `list` `stats` |

package/dist/client.d.ts

@@ -14,6 +14,7 @@ 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 { ChannelOnboarding } from './resources/channels/onboarding';
 import { Templates } from './resources/channels/templates';
 import { ChannelWebhooks } from './resources/channels/webhooks';
 import { Billing } from './resources/channels/billing';
@@ -95,6 +96,11 @@ export declare class CrmClient {
     readonly dataStoreRecords: DataStoreRecords;
     /** Channels, and the provider properties that hang off them. */
     readonly channels: Channels;
+    /**
+     * Connecting a new channel. Separate from `channels` because it is the one
+     * channel operation that walks a person through a dialog on Meta's own site.
+     */
+    readonly channelOnboarding: ChannelOnboarding;
     /** WhatsApp message templates, per channel. */
     readonly templates: Templates;
     /** Channel webhooks: where a channel's message traffic is delivered. */

package/dist/client.js

@@ -19,6 +19,7 @@ const notifications_1 = require("./resources/audience/notifications");
 const data_stores_1 = require("./resources/data-stores");
 // Channels
 const channels_1 = require("./resources/channels/channels");
+const onboarding_1 = require("./resources/channels/onboarding");
 const templates_1 = require("./resources/channels/templates");
 const webhooks_2 = require("./resources/channels/webhooks");
 const billing_1 = require("./resources/channels/billing");
@@ -103,6 +104,11 @@ class CrmClient {
     // -- Channels -------------------------------------------------------------
     /** Channels, and the provider properties that hang off them. */
     channels;
+    /**
+     * Connecting a new channel. Separate from `channels` because it is the one
+     * channel operation that walks a person through a dialog on Meta's own site.
+     */
+    channelOnboarding;
     /** WhatsApp message templates, per channel. */
     templates;
     /** Channel webhooks: where a channel's message traffic is delivered. */
@@ -148,6 +154,7 @@ class CrmClient {
         this.dataStoreCollections = new data_stores_1.DataStoreCollections(http);
         this.dataStoreRecords = new data_stores_1.DataStoreRecords(http);
         this.channels = new channels_1.Channels(http);
+        this.channelOnboarding = new onboarding_1.ChannelOnboarding(http);
         this.templates = new templates_1.Templates(http);
         this.channelWebhooks = new webhooks_2.ChannelWebhooks(http);
         this.billing = new billing_1.Billing(http);

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,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"}
+{"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,gEAAoE;AACpE,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;;;OAGG;IACM,iBAAiB,CAAoB;IAC9C,+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,iBAAiB,GAAG,IAAI,8BAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,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;AA1ID,8BA0IC"}

package/dist/index.d.ts

@@ -25,6 +25,9 @@ export { CampaignMessages } from './resources/campaign-messages';
  */
 export { MAX_BULK_RECEIVERS, buildReceivers, normaliseColumn, normaliseNumbers, parseDelimited, resolveAudience, type BulkAudienceInput, type CampaignReceiver, type ResolvedAudience, } from './resources/campaign-audience';
 export { Channels, type SetPropOptions } from './resources/channels/channels';
+export { ChannelOnboarding, type ConnectOptions } from './resources/channels/onboarding';
+/** The popup driver on its own, for a console that calls `url()` itself. */
+export { openSignup, EmbeddedSignupError, type OpenSignupOptions, } from './internal/embedded-signup';
 export { Templates } from './resources/channels/templates';
 export { ChannelWebhooks } from './resources/channels/webhooks';
 export { Billing } from './resources/channels/billing';

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.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;
+exports.Activity = exports.Wallet = exports.Billing = exports.ChannelWebhooks = exports.Templates = exports.EmbeddedSignupError = exports.openSignup = exports.ChannelOnboarding = 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);
@@ -71,6 +71,12 @@ Object.defineProperty(exports, "resolveAudience", { enumerable: true, get: funct
 // Channels
 var channels_1 = require("./resources/channels/channels");
 Object.defineProperty(exports, "Channels", { enumerable: true, get: function () { return channels_1.Channels; } });
+var onboarding_1 = require("./resources/channels/onboarding");
+Object.defineProperty(exports, "ChannelOnboarding", { enumerable: true, get: function () { return onboarding_1.ChannelOnboarding; } });
+/** The popup driver on its own, for a console that calls `url()` itself. */
+var embedded_signup_1 = require("./internal/embedded-signup");
+Object.defineProperty(exports, "openSignup", { enumerable: true, get: function () { return embedded_signup_1.openSignup; } });
+Object.defineProperty(exports, "EmbeddedSignupError", { enumerable: true, get: function () { return embedded_signup_1.EmbeddedSignupError; } });
 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");

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,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"}
+{"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,8DAAyF;AAAhF,+GAAA,iBAAiB,OAAA;AAC1B,4EAA4E;AAC5E,8DAIoC;AAHlC,6GAAA,UAAU,OAAA;AACV,sHAAA,mBAAmB,OAAA;AAGrB,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/internal/embedded-signup.d.ts

@@ -0,0 +1,29 @@
+import type { SignupCredentials } from '../types';
+/**
+ * The dialog answers in two halves -- the code on the redirect, the ids by
+ * `postMessage` -- and neither is usable alone, so `openSignup` waits for both.
+ */
+/** How the popup is opened, and how to follow its progress. */
+export interface OpenSignupOptions {
+    /** Window name, so a second call reuses the popup rather than opening two. */
+    name?: string;
+    width?: number;
+    height?: number;
+    /** How long to wait for both halves. Default 15 minutes. */
+    timeoutMs?: number;
+    /** For a console showing more than a spinner. `step` is Meta's own `current_step`. */
+    onProgress?: (event: {
+        phase: 'opened' | 'step' | 'code' | 'ids';
+        step?: string;
+    }) => void;
+}
+/** Thrown for every way the dialog can fail to produce credentials. */
+export declare class EmbeddedSignupError extends Error {
+    readonly code: 'unsupported_environment' | 'popup_blocked' | 'popup_closed' | 'cancelled' | 'signup_error' | 'timeout';
+    constructor(code: 'unsupported_environment' | 'popup_blocked' | 'popup_closed' | 'cancelled' | 'signup_error' | 'timeout', message: string);
+}
+/**
+ * Call this **straight from a click handler**: a `window.open` a browser does not
+ * attribute to a gesture is blocked, and that looks like the user's popup blocker.
+ */
+export declare const openSignup: (url: string, options?: OpenSignupOptions) => Promise<SignupCredentials>;

package/dist/internal/embedded-signup.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openSignup = exports.EmbeddedSignupError = void 0;
+/** Thrown for every way the dialog can fail to produce credentials. */
+class EmbeddedSignupError extends Error {
+    code;
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+        this.name = 'EmbeddedSignupError';
+    }
+}
+exports.EmbeddedSignupError = EmbeddedSignupError;
+/** Origins Meta posts the signup events from. */
+const META_ORIGINS = ['https://www.facebook.com', 'https://web.facebook.com', 'https://business.facebook.com'];
+const DEFAULT_TIMEOUT_MS = 15 * 60 * 1000;
+const browser = () => {
+    const candidate = globalThis.window;
+    return candidate && typeof candidate.open === 'function' ? candidate : undefined;
+};
+/** An object in most browsers, a JSON string in some. */
+const parsePayload = (data) => {
+    if (typeof data === 'string') {
+        try {
+            const parsed = JSON.parse(data);
+            return typeof parsed === 'object' && parsed !== null ? parsed : undefined;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    return typeof data === 'object' && data !== null ? data : undefined;
+};
+/**
+ * Call this **straight from a click handler**: a `window.open` a browser does not
+ * attribute to a gesture is blocked, and that looks like the user's popup blocker.
+ */
+const openSignup = (url, options = {}) => {
+    const win = browser();
+    if (!win) {
+        return Promise.reject(new EmbeddedSignupError('unsupported_environment', 'Embedded signup needs a browser; drive the three onboarding calls yourself outside one'));
+    }
+    const width = options.width ?? 620;
+    const height = options.height ?? 760;
+    const left = Math.max(0, ((win.screen?.width ?? width) - width) / 2);
+    const top = Math.max(0, ((win.screen?.height ?? height) - height) / 2);
+    const popup = win.open(url, options.name ?? 'wa_embedded_signup', `popup=1,width=${width},height=${height},left=${left},top=${top},scrollbars=1,resizable=1`);
+    if (!popup) {
+        return Promise.reject(new EmbeddedSignupError('popup_blocked', 'The signup window was blocked; allow popups and try again'));
+    }
+    return new Promise((resolve, reject) => {
+        let code;
+        let state;
+        let wabaId;
+        let phoneNumberId;
+        let settled = false;
+        const progress = (phase, step) => {
+            try {
+                options.onProgress?.({ phase, step });
+            }
+            catch {
+                // A console's callback is not allowed to break the flow.
+            }
+        };
+        const finish = (outcome) => {
+            if (settled)
+                return;
+            settled = true;
+            win.removeEventListener('message', onMessage);
+            win.clearInterval(poll);
+            win.clearTimeout(timer);
+            // On success too: the console is about to render that confirmation properly.
+            try {
+                if (!popup.closed)
+                    popup.close();
+            }
+            catch {
+                // Cross-origin as it closed; the window is the user's problem now.
+            }
+            outcome();
+        };
+        /** Resolves only once both halves are in. */
+        const settleIfComplete = () => {
+            if (code && state && wabaId && phoneNumberId) {
+                const credentials = { code, state, wabaId, phoneNumberId };
+                finish(() => resolve(credentials));
+            }
+        };
+        const onMessage = (event) => {
+            const payload = parsePayload(event.data);
+            if (!payload)
+                return;
+            // Our own redirect page posting back, rather than the poll reading its URL.
+            if (event.origin === win.location.origin && payload.type === 'CRM_CHANNEL_ONBOARDING') {
+                if (typeof payload.code === 'string')
+                    code = payload.code;
+                if (typeof payload.state === 'string')
+                    state = payload.state;
+                if (code)
+                    progress('code');
+                settleIfComplete();
+                return;
+            }
+            if (!META_ORIGINS.includes(event.origin))
+                return;
+            if (payload.type !== 'WA_EMBEDDED_SIGNUP')
+                return;
+            const data = (payload.data ?? {});
+            // Backing out is not worth a stack trace, but it has to reject or the
+            // promise never settles.
+            if (payload.event === 'CANCEL') {
+                const step = typeof data.current_step === 'string' ? data.current_step : undefined;
+                finish(() => reject(new EmbeddedSignupError('cancelled', step ? `Signup was cancelled at the "${step}" step` : 'Signup was cancelled')));
+                return;
+            }
+            if (payload.event === 'ERROR') {
+                const message = typeof data.error_message === 'string' ? data.error_message : 'Meta reported an error';
+                finish(() => reject(new EmbeddedSignupError('signup_error', message)));
+                return;
+            }
+            if (typeof data.waba_id === 'string')
+                wabaId = data.waba_id;
+            if (typeof data.phone_number_id === 'string')
+                phoneNumberId = data.phone_number_id;
+            if (wabaId && phoneNumberId)
+                progress('ids');
+            else if (typeof data.current_step === 'string')
+                progress('step', data.current_step);
+            settleIfComplete();
+        };
+        /**
+         * Same-origin once the dialog redirects to our `redirect_uri`; before that
+         * reading `location` throws. Also the only signal that the window was closed.
+         */
+        const poll = win.setInterval(() => {
+            if (popup.closed) {
+                finish(() => reject(new EmbeddedSignupError('popup_closed', code || wabaId
+                    ? 'The signup window was closed before it finished'
+                    : 'The signup window was closed')));
+                return;
+            }
+            if (code)
+                return;
+            try {
+                const search = popup.location.search;
+                if (!search)
+                    return;
+                const params = new URLSearchParams(search);
+                const returned = params.get('code');
+                if (!returned) {
+                    // A refusal arrives here and never as a message; without this the
+                    // popup just sits there.
+                    const error = params.get('error_description') ?? params.get('error');
+                    if (error)
+                        finish(() => reject(new EmbeddedSignupError('signup_error', error)));
+                    return;
+                }
+                code = returned;
+                state = params.get('state') ?? state;
+                progress('code');
+                settleIfComplete();
+            }
+            catch {
+                // Still on Meta's origin, so there is nothing to read yet.
+            }
+        }, 400);
+        const timer = win.setTimeout(() => {
+            finish(() => reject(new EmbeddedSignupError('timeout', 'The signup window was not completed in time')));
+        }, options.timeoutMs ?? DEFAULT_TIMEOUT_MS);
+        win.addEventListener('message', onMessage);
+        progress('opened');
+    });
+};
+exports.openSignup = openSignup;
+//# sourceMappingURL=embedded-signup.js.map

package/dist/internal/embedded-signup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedded-signup.js","sourceRoot":"","sources":["../../src/internal/embedded-signup.ts"],"names":[],"mappings":";;;AAmBA,uEAAuE;AACvE,MAAa,mBAAoB,SAAQ,KAAK;IAEjC;IADX,YACW,IAMI,EACb,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAC;QATN,SAAI,GAAJ,IAAI,CAMA;QAIb,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAdD,kDAcC;AAED,iDAAiD;AACjD,MAAM,YAAY,GAAG,CAAC,0BAA0B,EAAE,0BAA0B,EAAE,+BAA+B,CAAC,CAAC;AAE/G,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAoB1C,MAAM,OAAO,GAAG,GAA8B,EAAE;IAC9C,MAAM,SAAS,GAAI,UAAmC,CAAC,MAAmC,CAAC;IAC3F,OAAO,SAAS,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;AACnF,CAAC,CAAC;AAEF,yDAAyD;AACzD,MAAM,YAAY,GAAG,CAAC,IAAa,EAAuC,EAAE;IAC1E,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,CAAC;YAC3C,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,CAAC,CAAC,CAAE,MAAkC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzG,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAE,IAAgC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnG,CAAC,CAAC;AAEF;;;GAGG;AACI,MAAM,UAAU,GAAG,CACxB,GAAW,EACX,UAA6B,EAAE,EACH,EAAE;IAC9B,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IACtB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,mBAAmB,CACrB,yBAAyB,EACzB,wFAAwF,CACzF,CACF,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC;IACnC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAEvE,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,GAAG,EACH,OAAO,CAAC,IAAI,IAAI,oBAAoB,EACpC,iBAAiB,KAAK,WAAW,MAAM,SAAS,IAAI,QAAQ,GAAG,2BAA2B,CAC3F,CAAC;IAEF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,mBAAmB,CAAC,eAAe,EAAE,2DAA2D,CAAC,CACtG,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxD,IAAI,IAAwB,CAAC;QAC7B,IAAI,KAAyB,CAAC;QAC9B,IAAI,MAA0B,CAAC;QAC/B,IAAI,aAAiC,CAAC;QACtC,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,MAAM,QAAQ,GAAG,CAAC,KAAyC,EAAE,IAAa,EAAE,EAAE;YAC5E,IAAI,CAAC;gBACH,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,yDAAyD;YAC3D,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,CAAC,OAAmB,EAAE,EAAE;YACrC,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YAEf,GAAG,CAAC,mBAAmB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YAC9C,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACxB,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACxB,6EAA6E;YAC7E,IAAI,CAAC;gBACH,IAAI,CAAC,KAAK,CAAC,MAAM;oBAAE,KAAK,CAAC,KAAK,EAAE,CAAC;YACnC,CAAC;YAAC,MAAM,CAAC;gBACP,mEAAmE;YACrE,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QAEF,6CAA6C;QAC7C,MAAM,gBAAgB,GAAG,GAAG,EAAE;YAC5B,IAAI,IAAI,IAAI,KAAK,IAAI,MAAM,IAAI,aAAa,EAAE,CAAC;gBAC7C,MAAM,WAAW,GAAsB,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;gBAC9E,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;YACrC,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,SAAS,GAAG,CAAC,KAAmB,EAAE,EAAE;YACxC,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO;gBAAE,OAAO;YAErB,4EAA4E;YAC5E,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,KAAK,wBAAwB,EAAE,CAAC;gBACtF,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;oBAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;gBAC1D,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ;oBAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;gBAC7D,IAAI,IAAI;oBAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAC3B,gBAAgB,EAAE,CAAC;gBACnB,OAAO;YACT,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,OAAO;YACjD,IAAI,OAAO,CAAC,IAAI,KAAK,oBAAoB;gBAAE,OAAO;YAElD,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAA4B,CAAC;YAE7D,sEAAsE;YACtE,yBAAyB;YACzB,IAAI,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;gBACnF,MAAM,CAAC,GAAG,EAAE,CACV,MAAM,CACJ,IAAI,mBAAmB,CACrB,WAAW,EACX,IAAI,CAAC,CAAC,CAAC,gCAAgC,IAAI,QAAQ,CAAC,CAAC,CAAC,sBAAsB,CAC7E,CACF,CACF,CAAC;gBACF,OAAO;YACT,CAAC;YAED,IAAI,OAAO,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC9B,MAAM,OAAO,GAAG,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,wBAAwB,CAAC;gBACvG,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,mBAAmB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;gBACvE,OAAO;YACT,CAAC;YAED,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;gBAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC5D,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ;gBAAE,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC;YAEnF,IAAI,MAAM,IAAI,aAAa;gBAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACxC,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ;gBAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAEpF,gBAAgB,EAAE,CAAC;QACrB,CAAC,CAAC;QAEF;;;WAGG;QACH,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE;YAChC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBACjB,MAAM,CAAC,GAAG,EAAE,CACV,MAAM,CACJ,IAAI,mBAAmB,CACrB,cAAc,EACd,IAAI,IAAI,MAAM;oBACZ,CAAC,CAAC,iDAAiD;oBACnD,CAAC,CAAC,8BAA8B,CACnC,CACF,CACF,CAAC;gBACF,OAAO;YACT,CAAC;YAED,IAAI,IAAI;gBAAE,OAAO;YAEjB,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACrC,IAAI,CAAC,MAAM;oBAAE,OAAO;gBAEpB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,kEAAkE;oBAClE,yBAAyB;oBACzB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBACrE,IAAI,KAAK;wBAAE,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,mBAAmB,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;oBAChF,OAAO;gBACT,CAAC;gBAED,IAAI,GAAG,QAAQ,CAAC;gBAChB,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC;gBACrC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBACjB,gBAAgB,EAAE,CAAC;YACrB,CAAC;YAAC,MAAM,CAAC;gBACP,2DAA2D;YAC7D,CAAC;QACH,CAAC,EAAE,GAAG,CAAC,CAAC;QAER,MAAM,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE;YAChC,MAAM,CAAC,GAAG,EAAE,CACV,MAAM,CAAC,IAAI,mBAAmB,CAAC,SAAS,EAAE,6CAA6C,CAAC,CAAC,CAC1F,CAAC;QACJ,CAAC,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC,CAAC;QAE5C,GAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC3C,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA3KW,QAAA,UAAU,cA2KrB"}

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

@@ -0,0 +1,62 @@
+import type { ChannelOnboardingOption, ChannelResponse, CompleteOnboardingInput, OnboardingChannelType, OnboardingExchangeInput, OnboardingExchangeResult, OnboardingUrlInput, OnboardingUrlResult } from '../../types';
+import type { HttpClient } from '../../http';
+import { type OpenSignupOptions } from '../../internal/embedded-signup';
+/** Options for the one-call driver. */
+export interface ConnectOptions extends OpenSignupOptions {
+    /** Which family to connect. Only `whatsapp` today, and the default. */
+    type?: OnboardingChannelType;
+    /** The inclusion to spend, when the plan carries more than one. */
+    slug?: string;
+    /** A non-default redirect, which must be one the service is configured for. */
+    redirectUri?: string;
+}
+/**
+ * Connecting a channel. `connect()` does steps 1 to 3 and hands back the number
+ * to confirm; or call `url()`, open the dialog yourself, then `exchange()`.
+ * Either way the browser never sees a Meta credential.
+ *
+ * ```ts
+ * // In the click handler for "Connect WhatsApp" -- not after an await.
+ * const candidate = await crm.channelOnboarding.connect();
+ * // Show candidate.phoneNumber, prefill a form from candidate.defaults...
+ * const { data: channel } = await crm.channelOnboarding.complete({
+ *   token: candidate.id,
+ *   name: form.name,
+ * });
+ * ```
+ */
+export declare class ChannelOnboarding {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * `GET /v1/channels/onboarding/types` -- every family, available or not, so a
+     * picker greys rows out. Check `available`, show `reason`. Scope: `channels:read`.
+     */
+    types(): Promise<{
+        data: ChannelOnboardingOption[];
+    }>;
+    /**
+     * `POST /v1/channels/onboarding/url` -- the dialog URL and the `state` to hand
+     * back. **Meta refuses to be framed**: use a popup. 402 if the plan has no room.
+     */
+    url(input?: OnboardingUrlInput): Promise<{
+        data: OnboardingUrlResult;
+    }>;
+    /**
+     * `POST /v1/channels/onboarding/exchange` -- redeems the code. **Creates
+     * nothing**: show `phoneNumber`, Meta's own description, and let them confirm.
+     */
+    exchange(input: OnboardingExchangeInput): Promise<{
+        data: OnboardingExchangeResult;
+    }>;
+    /**
+     * `POST /v1/channels/onboarding/complete` -- creates the channel, **inactive**:
+     * `setProp(id, 'wa_pin_update')` brings it up, or `wa_biz_update` for a WA Biz number.
+     */
+    complete(input: CompleteOnboardingInput): Promise<ChannelResponse>;
+    /**
+     * The URL, the dialog and the exchange in one call. **Call it straight from the
+     * click handler**, or the popup is blocked. Rejects with `EmbeddedSignupError`.
+     */
+    connect(options?: ConnectOptions): Promise<OnboardingExchangeResult>;
+}

package/dist/resources/channels/onboarding.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChannelOnboarding = void 0;
+const paths_1 = require("../paths");
+const embedded_signup_1 = require("../../internal/embedded-signup");
+const ONBOARDING = `${paths_1.CHANNELS}/onboarding`;
+/**
+ * Connecting a channel. `connect()` does steps 1 to 3 and hands back the number
+ * to confirm; or call `url()`, open the dialog yourself, then `exchange()`.
+ * Either way the browser never sees a Meta credential.
+ *
+ * ```ts
+ * // In the click handler for "Connect WhatsApp" -- not after an await.
+ * const candidate = await crm.channelOnboarding.connect();
+ * // Show candidate.phoneNumber, prefill a form from candidate.defaults...
+ * const { data: channel } = await crm.channelOnboarding.complete({
+ *   token: candidate.id,
+ *   name: form.name,
+ * });
+ * ```
+ */
+class ChannelOnboarding {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/channels/onboarding/types` -- every family, available or not, so a
+     * picker greys rows out. Check `available`, show `reason`. Scope: `channels:read`.
+     */
+    types() {
+        return this.http.request('GET', `${ONBOARDING}/types`);
+    }
+    /**
+     * `POST /v1/channels/onboarding/url` -- the dialog URL and the `state` to hand
+     * back. **Meta refuses to be framed**: use a popup. 402 if the plan has no room.
+     */
+    url(input = {}) {
+        return this.http.request('POST', `${ONBOARDING}/url`, { body: input });
+    }
+    /**
+     * `POST /v1/channels/onboarding/exchange` -- redeems the code. **Creates
+     * nothing**: show `phoneNumber`, Meta's own description, and let them confirm.
+     */
+    exchange(input) {
+        return this.http.request('POST', `${ONBOARDING}/exchange`, {
+            body: input,
+        });
+    }
+    /**
+     * `POST /v1/channels/onboarding/complete` -- creates the channel, **inactive**:
+     * `setProp(id, 'wa_pin_update')` brings it up, or `wa_biz_update` for a WA Biz number.
+     */
+    complete(input) {
+        return this.http.request('POST', `${ONBOARDING}/complete`, { body: input });
+    }
+    /**
+     * The URL, the dialog and the exchange in one call. **Call it straight from the
+     * click handler**, or the popup is blocked. Rejects with `EmbeddedSignupError`.
+     */
+    async connect(options = {}) {
+        const { type, slug, redirectUri, ...popup } = options;
+        const { data: session } = await this.url({ type, slug, redirectUri });
+        const credentials = await (0, embedded_signup_1.openSignup)(session.url, popup);
+        const { data } = await this.exchange({
+            // The one we issued, since the dialog may or may not return it.
+            state: session.state,
+            code: credentials.code,
+            wabaId: credentials.wabaId,
+            phoneNumberId: credentials.phoneNumberId,
+        });
+        return data;
+    }
+}
+exports.ChannelOnboarding = ChannelOnboarding;
+//# sourceMappingURL=onboarding.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.js","sourceRoot":"","sources":["../../../src/resources/channels/onboarding.ts"],"names":[],"mappings":";;;AAYA,oCAAoC;AACpC,oEAAoF;AAEpF,MAAM,UAAU,GAAG,GAAG,gBAAQ,aAAa,CAAC;AAY5C;;;;;;;;;;;;;;GAcG;AACH,MAAa,iBAAiB;IACC;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;OAGG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAsC,KAAK,EAAE,GAAG,UAAU,QAAQ,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,QAA4B,EAAE;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC,MAAM,EAAE,GAAG,UAAU,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,KAA8B;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAqC,MAAM,EAAE,GAAG,UAAU,WAAW,EAAE;YAC7F,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,KAA8B;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkB,MAAM,EAAE,GAAG,UAAU,WAAW,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,UAA0B,EAAE;QACxC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QACtD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QAEtE,MAAM,WAAW,GAAsB,MAAM,IAAA,4BAAU,EAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAE5E,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC;YACnC,gEAAgE;YAChE,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,aAAa,EAAE,WAAW,CAAC,aAAa;SACzC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAzDD,8CAyDC"}

package/dist/types/channels.d.ts

@@ -381,3 +381,82 @@ export interface ListActivityLogsQuery extends ListQuery {
     /** Restrict to a period. */
     range?: UnixRange;
 }
+/** Channel families the onboarding endpoints can connect today. */
+export type OnboardingChannelType = 'whatsapp';
+/** Every family the picker shows, implemented or not. */
+export type OfferableChannelType = 'whatsapp' | 'facebook' | 'instagram';
+/** Why a family cannot be connected right now. */
+export type OnboardingUnavailableReason = 'not_included' | 'quota_exceeded' | 'not_supported' | 'provider_not_configured' | 'not_permitted';
+/** One row of the "add a channel" picker. */
+export interface ChannelOnboardingOption {
+    type: OfferableChannelType;
+    label: string;
+    available: boolean;
+    /** The inclusion a channel would be created against. Pass back to `url()`. */
+    slug?: string;
+    limit?: number;
+    used?: number;
+    remaining?: number;
+    /** Set only when `available` is false. */
+    reason?: OnboardingUnavailableReason;
+}
+export interface OnboardingUrlInput {
+    type?: OnboardingChannelType;
+    /** Only needed when the plan carries more than one channel inclusion. */
+    slug?: string;
+    /** Must be one of the service's configured redirects. Omit for the default. */
+    redirectUri?: string;
+}
+export interface OnboardingUrlResult {
+    /** Open in a popup. Meta refuses to render the dialog in an iframe. */
+    url: string;
+    /** Opaque; hand back to `exchange()` unchanged. */
+    state: string;
+    redirectUri: string;
+    expiresAt: IsoDate;
+    provider: string;
+    remaining?: number;
+}
+/** What Meta reports about the number, for the confirmation card. */
+export interface OnboardingPhoneNumber {
+    id: string;
+    wabaId: string;
+    /** Formatted, e.g. `+91 93116 36081`. */
+    displayPhoneNumber: string;
+    verifiedName: string;
+    status?: string;
+    codeVerificationStatus?: string;
+    qualityRating?: string;
+}
+export interface OnboardingExchangeInput {
+    state: string;
+    code: string;
+    wabaId: string;
+    phoneNumberId: string;
+}
+export interface OnboardingExchangeResult {
+    /** The pending record's id. Pass to `complete()` as `token`. */
+    id: string;
+    expiresAt: IsoDate;
+    phoneNumber: OnboardingPhoneNumber;
+    /** Prefill for the final form. */
+    defaults: {
+        name: string;
+        color: string;
+        currency: ChannelCurrency;
+    };
+}
+export interface CompleteOnboardingInput {
+    /** The `id` from `exchange()`. */
+    token: string;
+    name: string;
+    color?: string;
+    currency?: ChannelCurrency;
+}
+/** What the Meta dialog hands back, once both halves of it have arrived. */
+export interface SignupCredentials {
+    code: string;
+    state: string;
+    wabaId: string;
+    phoneNumberId: string;
+}

package/docs/audience/canned-replies.md

@@ -22,6 +22,9 @@ Two kinds, and the difference is who gets the last word:
 | [`update`](#update) | `PATCH /v1/audience/canned-replies/:reply` | `canned_replies:write` |
 | [`delete`](#delete) | `DELETE /v1/audience/canned-replies/:reply` | `canned_replies:write` |
 
+**Permissions** — `CRM.CHAT.CANNED_REPLY`: `LIST`, `READ`, `CREATE`, `UPDATE`,
+`DELETE`. Account-level, so `data_scope` does not narrow it.
+
 ## Addressing a reply: `:reply` is an id **or** a name
 
 A 24-hex-character path segment is read as an **id**; anything else as a

package/docs/audience/contact-tags.md

@@ -14,6 +14,10 @@ tag **ids** on a write, and hands back the full tag documents resolved into
 | [`update`](#update) | `PATCH /v1/audience/contact-tags/:id` | `contact_tags:write` |
 | [`delete`](#delete) | `DELETE /v1/audience/contact-tags/:id` | `contact_tags:write` |
 
+**Permissions** — `CRM.CONTACT.TAG`: `LIST` to list, `READ` to read one,
+`CREATE`, `UPDATE`, `DELETE`. A tag is account-level, so a role's `data_scope`
+does not narrow this list — a member who holds `LIST` sees the account's tags.
+
 ## The tag object
 
 ```ts

package/docs/audience/contacts.md

@@ -19,6 +19,29 @@ land on the caller's own.
 | [`delete`](#delete) | `DELETE /v1/audience/contacts/:id` | `contacts:write` |
 | [`iterate`](#iterate) | — (walks `list`) | `contacts:read` |
 
+**Permissions** — each route also names a permission key, and a team member
+needs it. An owner does not.
+
+| Action | Key |
+| --- | --- |
+| `list` | `CRM.CONTACT.LIST` |
+| `get` | `CRM.CONTACT.READ` |
+| `create` | `CRM.CONTACT.CREATE` |
+| `update` | `CRM.CONTACT.UPDATE` |
+| `delete` | `CRM.CONTACT.DELETE` |
+
+A refusal is `403` with code `A403` (the role does not hold the key) or `E403`
+(the account's plan does not cover contacts — `details.feature` names it). An
+owner can meet `E403` but never `A403`.
+
+Separately from that, how many contacts a member can see is their role's
+`data_scope`: `own` — the default — returns the contacts assigned to them as
+`agent`, and `all` returns the account's. A contact assigned to nobody is the
+account's and not visible to an `own`-scoped member. Reading, updating or
+deleting a contact outside that scope is `404`, never `403`: a `403` would
+confirm the contact exists, which is what the scope is hiding.
+
+
 ## The contact object
 
 ```ts

package/docs/audience/crm-triggers.md

@@ -25,6 +25,9 @@ mean on the list.
 | [`delete`](#delete) | `DELETE /v1/audience/crm-triggers/:id` | `crm_triggers:write` |
 | [`logs`](#logs) | `GET /v1/audience/crm-triggers/logs` | `crm_triggers:read` |
 
+**Permissions** — `CRM.TRIGGER`: `LIST`, `READ` (one trigger, and the log
+endpoint), `CREATE`, `UPDATE`, `DELETE`.
+
 ## The trigger object
 
 ```ts