ab-ecosystem-cpass 1.0.12 → 1.0.13

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

@@ -1 +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"}
+{"version":3,"file":"onboarding.js","sourceRoot":"","sources":["../../../src/resources/channels/onboarding.ts"],"names":[],"mappings":";;;AAYA,oCAAoC;AACpC,oEAAgH;AAEhH,MAAM,UAAU,GAAG,GAAG,gBAAQ,aAAa,CAAC;AAiB5C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,iBAAiB;IACC;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;OAIG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAsC,KAAK,EAAE,GAAG,UAAU,QAAQ,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,KAAyB;QAC3B,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,OAAO,CAAC,KAAa;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CACtB,KAAK,EACL,GAAG,UAAU,YAAY,kBAAkB,CAAC,KAAK,CAAC,EAAE,CACrD,CAAC;IACJ,CAAC;IAED;;;;OAIG;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;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,OAAuB;QACnC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAChE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;QAEhF,MAAM,QAAQ,GAAG,MAAM,IAAA,mCAAiB,EAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACpB,MAAM,IAAI,qCAAmB,CAAC,cAAc,EAAE,kDAAkD,CAAC,CAAC;QACpG,CAAC;QAED,gEAAgE;QAChE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAEpD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5ED,8CA4EC"}

package/dist/types/campaign.d.ts

@@ -108,6 +108,14 @@ export interface CampaignTriggerInfo {
 }
 export interface Campaign {
     id: string;
+    /**
+     * The team member who created the campaign, by psuid. Absent when the account
+     * holder created it, and on campaigns written before this was recorded.
+     *
+     * Who *wrote* it. Who armed it is `triggerInfo.psuid`, which can be someone
+     * else and is set a step later.
+     */
+    member?: string;
     version: string;
     crmVersion: string;
     name: string;

package/dist/types/channels.d.ts

@@ -49,6 +49,12 @@ export interface ChannelWallet {
  */
 export interface Channel {
     id: string;
+    /**
+     * The team member who connected the channel, by psuid. Absent when the
+     * account holder connected it, and on channels created before this was
+     * recorded.
+     */
+    member?: string;
     /** Enabled/disabled by the owner -- not the connection state. */
     active: boolean;
     ecom?: {
@@ -385,38 +391,68 @@ export interface ListActivityLogsQuery extends ListQuery {
 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. */
+/** One row of the "add a channel" picker. Only connectable families are listed. */
 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;
+    /**
+     * Which BSP to connect through, by provider code. Omit for whichever is
+     * active for this family -- pin one only when there is a reason to.
+     */
+    provider?: string;
+    /**
+     * Where the browser is handed back, with the outcome on it. **Required**: the
+     * callback has no session, so nothing else says where. Meta never sees it.
+     */
+    redirectUri: string;
 }
 export interface OnboardingUrlResult {
-    /** Open in a popup. Meta refuses to render the dialog in an iframe. */
+    /**
+     * Open in a popup, or navigate to it; it cannot be framed. A launcher on the
+     * app's own domain that forwards to `dialogUrl`, since Meta ties the dialog
+     * to that domain.
+     */
     url: string;
-    /** Opaque; hand back to `exchange()` unchanged. */
+    /** Meta's dialog, which `url` forwards to. Open `url`, not this. */
+    dialogUrl: string;
+    /** Opaque, and already carrying `redirectUri`. Our callback is what reads it. */
     state: string;
+    /** Where the browser will come back to. */
     redirectUri: string;
+    /** What Meta was given: the service's own callback, registered on the BSP app. */
+    callbackUri: string;
     expiresAt: IsoDate;
     provider: string;
     remaining?: number;
 }
+/** `ready`: one number, bound. `select`: several, so `complete()` names one. */
+export type OnboardingReturnStatus = 'ready' | 'select' | 'error';
+/** The query string the service appends to `redirectUri`. All values are strings. */
+export interface OnboardingReturn {
+    status: OnboardingReturnStatus;
+    /** Pass to `pending()`, and to `complete()` as `token`. */
+    token?: string;
+    /** How many numbers the authorisation covered; `"1"` for `ready`. */
+    numbers?: string;
+    wabaId?: string;
+    phoneNumberId?: string;
+    displayPhoneNumber?: string;
+    verifiedName?: string;
+    expiresAt?: string;
+    /** `status=error` only. */
+    code?: string;
+    message?: string;
+}
 /** What Meta reports about the number, for the confirmation card. */
 export interface OnboardingPhoneNumber {
     id: string;
@@ -434,21 +470,35 @@ export interface OnboardingExchangeInput {
     wabaId: string;
     phoneNumberId: string;
 }
+/** Prefill for the final form. Every field is overridable in `complete()`. */
+export interface OnboardingDefaults {
+    name: string;
+    color: string;
+    currency: ChannelCurrency;
+}
 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;
-    };
+    defaults: OnboardingDefaults;
+}
+/** A pending record, read back from the `token` on the return URL. */
+export interface OnboardingPendingResult {
+    id: string;
+    expiresAt: IsoDate;
+    type: OnboardingChannelType;
+    /** Every number the authorisation covers that is still free to connect. */
+    numbers: OnboardingPhoneNumber[];
+    /** Set when there was exactly one, and so already bound to the record. */
+    phoneNumber?: OnboardingPhoneNumber;
+    defaults: OnboardingDefaults;
 }
 export interface CompleteOnboardingInput {
-    /** The `id` from `exchange()`. */
+    /** The `id` from `exchange()`, or `token` off the return URL. */
     token: string;
+    /** Which number, when the record covers several -- `status=select`. */
+    phoneNumberId?: string;
     name: string;
     color?: string;
     currency?: ChannelCurrency;

package/dist/types/channels.js.map

@@ -1 +1 @@
-{"version":3,"file":"channels.js","sourceRoot":"","sources":["../../src/types/channels.ts"],"names":[],"mappings":";;;AA8KA;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,CAAC,aAAa,EAAE,kBAAkB,EAAE,cAAc,CAAU,CAAC;AAoIpF,QAAA,sBAAsB,GAAmC;IACpE,UAAU;IACV,MAAM;IACN,WAAW;IACX,MAAM;IACN,QAAQ;IACR,SAAS;IACT,UAAU;IACV,SAAS;IACT,cAAc;IACd,OAAO;CACR,CAAC"}
+{"version":3,"file":"channels.js","sourceRoot":"","sources":["../../src/types/channels.ts"],"names":[],"mappings":";;;AAoLA;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,CAAC,aAAa,EAAE,kBAAkB,EAAE,cAAc,CAAU,CAAC;AAoIpF,QAAA,sBAAsB,GAAmC;IACpE,UAAU;IACV,MAAM;IACN,WAAW;IACX,MAAM;IACN,QAAQ;IACR,SAAS;IACT,UAAU;IACV,SAAS;IACT,cAAc;IACd,OAAO;CACR,CAAC"}

package/docs/audience/contacts.md

@@ -41,6 +41,12 @@ 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.
 
+A contact a **team member** creates is assigned to that member as its `agent`,
+whatever their `data_scope` and whatever `agent` the body carried: they are the
+one working it. An account holder's create leaves `agent` as given — `null`
+unless they named someone — so a contact stays unassigned until it is handed
+over.
+
 
 ## The contact object
 
@@ -168,7 +174,7 @@ blank contact.
 | `whatsapp` | string | — | The contact's WhatsApp number, in any shape. Creates the channel identity. Create-only. |
 | `order` | string | — | Free-form external reference. |
 | `tags` | ObjectId[] | `[]` | Contact tag ids. |
-| `agent` | ObjectId \| null | — | Assigned agent. |
+| `agent` | ObjectId \| null | — | Assigned agent. **Ignored for a team member**: the member creating the contact is assigned it. |
 | `team` | ObjectId \| null | — | Assigned team. |
 | `lead_source` | `{ type?, module?, id? }` | — | Where the contact came from. |
 | `status` | `'live' \| 'trashed'` | `'live'` | |

package/docs/campaign/campaigns.md

@@ -67,8 +67,15 @@ named against it.
 | --- | --- | --- |
 | `scheduledAt` in the body | **`422`** | that is the point |
 | writes `triggerInfo` | no | yes |
+| writes `member` | on `create`, by a team member | no |
 | campaign becomes sendable | no | yes |
 
+`member` is the other half of that record: the team member who **wrote** the
+campaign, stamped at `create` from their token. `triggerInfo.psuid` is who armed
+it, which is a later act and can be somebody else. Both are server-set and
+refused from a body; an account holder's campaign carries no `member`, because
+the campaign is already theirs.
+
 **"Now" is not instant.** `trigger` with no time arms the campaign about a minute
 out (`CAMPAIGN_IMMEDIATE_DELAY_SECONDS`), and [`cancel`](#cancel) still stops it
 in that window. A second `trigger` on a campaign that is armed but not yet picked

package/docs/channels/channels.md

@@ -64,6 +64,7 @@ remains is safe to hand a console.
 ```ts
 interface Channel {
   id: string;
+  member?: string;                  // the team member who connected it; absent when the account holder did
   active: boolean;                  // enabled by the owner — NOT the connection state
   ecom?: { store_status: boolean; store?: string };
   basic_details: { name: string; color_code: string; channel_identity: string };