@cosmoops/connect-sdk 0.40.0 → 0.42.0

package/dist/types/types.d.ts

@@ -1269,12 +1269,29 @@ export interface CallCompletedEvent {
      * for presence.
      */
     extraction: Record<string, unknown>;
+    /**
+     * `member` when a person placed this call from a browser - `<ConnectCallButton>`
+     * or Connect's own portal - rather than an agent handling it. Absent on
+     * events sent before member calling existed; treat absent as `agent`.
+     */
+    handler?: CallHandler;
+    /**
+     * The member who placed a `member` call - their Connect user id, the same id
+     * a workspace roster carries. The one to attribute the call to. `null` on an
+     * agent's call.
+     */
+    placedByUserId?: string | null;
+    /** That member's display name, else their email - so the call can be attributed without a roster read. */
+    placedByName?: string | null;
     /** ISO-8601. */
     occurredAt: string;
 }
 /**
  * A call reached a channel and nothing answered it.
  *
+ * Also raised for a call a member placed that the person rang did not pick
+ * up (`handler: "member"`, `direction: "outbound"`) - somebody to try again.
+ *
  * Its own event rather than an `outcome` on the one above, because the action
  * differs in kind: a completed call is something to file, a missed one is
  * somebody to ring back. Treating this as a lead is the right thing to do
@@ -1287,6 +1304,20 @@ export interface CallMissedEvent {
     /** E.164, and the only identity this carries - see `CallCompletedEvent.contactPhone`. */
     contactPhone: string | null;
     direction: ConnectCallDirection;
+    /**
+     * `member` when a person placed this call from a browser - `<ConnectCallButton>`
+     * or Connect's own portal - rather than an agent handling it. Absent on
+     * events sent before member calling existed; treat absent as `agent`.
+     */
+    handler?: CallHandler;
+    /**
+     * The member who placed a `member` call - their Connect user id, the same id
+     * a workspace roster carries. The one to attribute the call to. `null` on an
+     * agent's call.
+     */
+    placedByUserId?: string | null;
+    /** That member's display name, else their email - so the call can be attributed without a roster read. */
+    placedByName?: string | null;
     /** ISO-8601. */
     occurredAt: string;
 }
@@ -2696,8 +2727,16 @@ export type CallDirection = "inbound" | "outbound";
  * `rejected` means Connect never connected it - see `rejectReason`.
  * `answered` is a call still in progress; `completed` is one that ran and
  * ended.
+ *
+ * `dialing` and `unanswered` are an outbound call's: ringing, and nobody
+ * picked up - see `unansweredReason`. A call your `<ConnectCallButton>`
+ * placed passes through `dialing` on its way to one of the other two.
  */
-export type CallStatus = "answered" | "rejected" | "completed";
+export type CallStatus = "dialing" | "answered" | "rejected" | "unanswered" | "completed";
+/** Who was on Connect's end of a call: one of the workspace's agents, or a member calling from a browser. */
+export type CallHandler = "agent" | "member";
+/** Why an outbound call reached nobody. Widened at its use site like `CallRejectReason`. */
+export type CallUnansweredReason = "no_answer" | "busy" | "failed" | "cancelled";
 /**
  * Why a call was refused. Widened at the point of use with `(string & {})`,
  * the same way `ReadinessBlocker.code` is: Connect adds reasons as it learns
@@ -2765,6 +2804,76 @@ export interface ConnectCall {
     extraction: Record<string, unknown> | null;
     agentId: string | null;
     agentVersion: number | null;
+    /** `member` for a call a person placed with `<ConnectCallButton>`; such a call has no agent, transcript or recording. */
+    handler: CallHandler;
+    /** The member who placed a `member` call - their Connect user id. */
+    placedByUserId: string | null;
+    /**
+     * How long the person called was on the line, for a `member` call. Read this
+     * rather than `durationSeconds`, which there measures the member's own leg,
+     * ringing included. `null` until the carrier reports it, and for a call
+     * nobody answered.
+     */
+    talkSeconds: number | null;
+    /** Why nobody answered - set only when `status` is `unanswered`. */
+    unansweredReason: CallUnansweredReason | (string & {}) | null;
+}
+/**
+ * What the browser needs to place one approved call - see
+ * `calls.startBrowserCall`. `headers` are SIP headers to send with it; they
+ * carry a one-time key, valid for two minutes, that lets the call be placed
+ * once and by nobody else.
+ */
+export interface StartedBrowserCall {
+    callId: string;
+    /** The number being rung, E.164. */
+    toNumber: string;
+    /** The workspace's own number, which the person called will see. */
+    fromNumber: string;
+    headers: Record<string, string>;
+}
+/**
+ * Why a member can or cannot call - see `calls.getCallingAvailability`.
+ *
+ * - `no_permission` - they lack "Make calls". Don't offer calling.
+ * - `no_number` - the workspace has no business number. `offer` says where to
+ *   buy one (a "Business number" add-on on one of its subscriptions).
+ * - `number_pending` - one was bought but Connect's pool was empty; an admin
+ *   can retry from Connect's Calling page.
+ * - `no_balance` - a number, but not a minute's worth of prepaid minutes.
+ * - `available`.
+ */
+export type CallingAvailabilityStatus = "available" | "no_permission" | "no_number" | "number_pending" | "no_balance";
+export interface CallingAvailability {
+    status: CallingAvailabilityStatus;
+    /** The workspace's business number, E.164, when it holds one. */
+    number: string | null;
+    /** Prepaid balance a new call may spend, in paise, pre-tax. */
+    available: number;
+    /** About how many minutes that buys. */
+    availableMinutes: number;
+    ratePaisePerMinute: number;
+    /** Under about 55 minutes - worth a warning. */
+    lowBalance: boolean;
+    /** Whether this member may buy minutes. */
+    canTopUp: boolean;
+    /** Whether this member may add the number add-on or retry a pending number. */
+    canManageNumber: boolean;
+    /** Where a business number can be bought, when the workspace has none. */
+    offer: {
+        subscriptionId: string;
+        applicationId: string;
+        addonId: string;
+        addonName: string;
+        /** Pre-tax, paise, per billing cycle. */
+        price: number;
+    } | null;
+}
+/** A carrier access token a member's browser signs in to the phone network with. Valid for an hour. */
+export interface BrowserCallingToken {
+    token: string;
+    /** ISO-8601. */
+    expiresAt: string;
 }
 /** Who spoke. */
 export type CallTurnRole = "user" | "agent";
@@ -2873,6 +2982,48 @@ export interface ConversationsPage {
     nextCursor: string | null;
     hasMore: boolean;
 }
+/**
+ * One of your application's own Meta-approved templates, to one customer.
+ *
+ * Hand-written here like every wire type in this file - see `SendPushInput`.
+ */
+export interface SendWhatsAppInput {
+    /** The subscribing workspace this is sent on behalf of. */
+    workspaceId: string;
+    /** The template's slug within your application, e.g. `quote-issued` - never its Meta name. */
+    template: string;
+    /** Meta language code the template was approved in. Defaults to `en`. */
+    language?: string;
+    /** E.164, e.g. `+919876543210`. */
+    to: string;
+    /** One value per template variable, by name. A missing one refuses the send. */
+    values?: Record<string, string>;
+    /**
+     * The opt-in your application collected, recorded only when Connect has
+     * none on file for the number. A number that withdrew stays withdrawn.
+     */
+    consent?: {
+        collectedVia: string;
+    };
+}
+export interface SendWhatsAppResponse {
+    status: "sent";
+    messageId: string;
+}
+/** Meta's review state for a template. Only `APPROVED` sends. */
+export type WhatsAppTemplateReviewStatus = "DRAFT" | "PENDING" | "APPROVED" | "REJECTED" | "PAUSED" | "DISABLED";
+/** Whether one of your templates would send right now. Branch on `live`. */
+export interface WhatsAppTemplateState {
+    slug: string;
+    language: string;
+    /** Meta's name for it: `app_<applicationKey>_<slug>`. */
+    name: string;
+    status: WhatsAppTemplateReviewStatus;
+    /** Approved by Meta *and* currently served. */
+    live: boolean;
+    /** The values a send must carry, from the approved content. */
+    variables: string[];
+}
 /**
  * One notification, to members of one workspace.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmoops/connect-sdk",
-  "version": "0.40.0",
+  "version": "0.42.0",
   "description": "Official server-side SDK for the CosmoOps Connect platform API - Login with Connect, entitlements, billing and metering.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "commonjs",
@@ -136,5 +136,8 @@
     "streamdown": {
       "optional": true
     }
+  },
+  "dependencies": {
+    "plivo-browser-sdk": "2.2.21"
   }
 }