@cosmoops/connect-sdk 0.42.0 → 0.43.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 `@cosmoops/connect-sdk` follows semver, with the 0.x convention that **minor
 versions may carry breaking changes** and patch versions never do.
 
+## 0.43.0
+
+### Recorded calls: transcript, summary, intent and action items
+
+A workspace can now switch on **call recording** (Connect > Calling). Calls
+placed with `<ConnectCallButton>` are then recorded, the person called hears
+"This call may be recorded" as they answer, and a few minutes after the call
+Connect has transcribed it and read it.
+
+- **`call.analyzed`** - a new webhook event, sent after `call.completed` for a
+  recorded call. It carries `summary`, `intent` (a few words, e.g.
+  `"pricing enquiry"`), `sentiment`, `language`, `actionItems` (`title`,
+  `dueDate` as `YYYY-MM-DD` or `null`, and `owner`: `rep` or `customer`) and
+  `recordingFileId`. Subscribe to it on your webhook in Connect. Typed as
+  `CallAnalyzedEvent`.
+- **`calls.get(callId)`** returns the same reading as `call.analysis`, and
+  the transcript as the call's `turns` - your user as `agent`, the person
+  called as `user`. `analysis` is `null` for a call that was not recorded.
+- **The recording** is a Drive file: `connect.drive.getFileUrl(recordingFileId, { workspaceId })` with a
+  `drive:read` key plays it.
+
+Recording is the workspace's choice, off by default, and adds ₹0.30 + GST per
+minute to the call - nothing to wire on your side to offer it.
+
 ## 0.42.0
 
 ### Ask AI explains failures instead of printing them

package/dist/cjs/server/client.js

@@ -183,4 +183,4 @@ class ConnectClient {
 }
 exports.ConnectClient = ConnectClient;
 /** Kept in step with `package.json` by `sdk.test.ts`. */
-exports.SDK_VERSION = "0.42.0";
+exports.SDK_VERSION = "0.43.0";

package/dist/cjs/server/resources/calls.js

@@ -60,8 +60,11 @@ class CallsResource {
      * All three need the `calls:place` scope **and** a signed-in member
      * (`asUser`), whose own "Make calls" permission Connect checks. None works
      * server-to-server: a call is placed by a person, from the workspace's own
-     * number, and is not recorded. Read how one went with `get(callId)`, which
-     * needs `calls:read` - a call your application placed is readable by it.
+     * number. It is recorded only when the workspace has switched recording on
+     * (the person called hears a notice); `call.analyzed` then follows with the
+     * summary, intent and action items. Read how one went with `get(callId)`,
+     * which needs `calls:read` - a call your application placed is readable by
+     * it, transcript included.
      */
     /**
      * Whether the member can call, and if not why - what `<ConnectCallButton>`

package/dist/esm/server/client.js

@@ -179,4 +179,4 @@ export class ConnectClient {
     }
 }
 /** Kept in step with `package.json` by `sdk.test.ts`. */
-export const SDK_VERSION = "0.42.0";
+export const SDK_VERSION = "0.43.0";

package/dist/esm/server/resources/calls.js

@@ -57,8 +57,11 @@ export class CallsResource {
      * All three need the `calls:place` scope **and** a signed-in member
      * (`asUser`), whose own "Make calls" permission Connect checks. None works
      * server-to-server: a call is placed by a person, from the workspace's own
-     * number, and is not recorded. Read how one went with `get(callId)`, which
-     * needs `calls:read` - a call your application placed is readable by it.
+     * number. It is recorded only when the workspace has switched recording on
+     * (the person called hears a notice); `call.analyzed` then follows with the
+     * summary, intent and action items. Read how one went with `get(callId)`,
+     * which needs `calls:read` - a call your application placed is readable by
+     * it, transcript included.
      */
     /**
      * Whether the member can call, and if not why - what `<ConnectCallButton>`

package/dist/types/server/client.d.ts

@@ -141,4 +141,4 @@ export declare class ConnectClient {
     constructor(options: ConnectClientOptions);
 }
 /** Kept in step with `package.json` by `sdk.test.ts`. */
-export declare const SDK_VERSION = "0.42.0";
+export declare const SDK_VERSION = "0.43.0";

package/dist/types/types.d.ts

@@ -1114,7 +1114,7 @@ export interface EmitEventsResponse {
  * `createConnectWebhookHandler` simply ignores anything you have not
  * registered a handler for.
  */
-export type ConnectWebhookEventType = "workspace.deletion_scheduled" | "workspace.deletion_cancelled" | "workspace.deleted" | "subscription.cancelled" | "call.completed" | "call.missed" | "booking.confirmed" | "booking.cancelled" | "booking.rescheduled" | "contact.created" | "contact.updated";
+export type ConnectWebhookEventType = "workspace.deletion_scheduled" | "workspace.deletion_cancelled" | "workspace.deleted" | "subscription.cancelled" | "call.completed" | "call.missed" | "call.analyzed" | "booking.confirmed" | "booking.cancelled" | "booking.rescheduled" | "contact.created" | "contact.updated";
 /** What becomes of one class of data when the workspace is purged. */
 export type ConnectDataDisposition = "erase" | "anonymize" | "retain";
 /** Who answers for your copy of the customer's data. See the deletion-policy guide. */
@@ -1321,6 +1321,48 @@ export interface CallMissedEvent {
     /** ISO-8601. */
     occurredAt: string;
 }
+/** How the person called came across, by the end of the call. */
+export type CallSentiment = "positive" | "neutral" | "negative";
+/**
+ * Something somebody committed to on a recorded call. `owner` is who said
+ * they would do it - `rep` for your user's side, `customer` for the person
+ * called. Both are worth a follow-up: one to do, one to chase.
+ */
+export interface CallActionItem {
+    title: string;
+    /** `YYYY-MM-DD` when a day was named or clearly implied, else `null`. */
+    dueDate: string | null;
+    owner: "rep" | "customer";
+}
+/**
+ * A recorded call, transcribed and read. Sent minutes after `call.completed`,
+ * and only for calls placed while the workspace records them - file the call
+ * on `call.completed` and enrich that row here. The transcript itself is the
+ * call's turns on `calls.get`.
+ */
+export interface CallAnalyzedEvent {
+    workspaceId: string;
+    callId: string;
+    channelId: string | null;
+    /** E.164 - the person called on an outbound call, the caller on an inbound one. */
+    contactPhone: string | null;
+    direction: ConnectCallDirection;
+    handler: CallHandler;
+    placedByUserId: string | null;
+    placedByName: string | null;
+    /** Two or three sentences, in English whatever language was spoken. */
+    summary: string | null;
+    /** Why they were on the call, in a few lowercase words - "pricing enquiry". */
+    intent: string | null;
+    sentiment: CallSentiment | null;
+    /** The main language spoken, BCP-47 - `hi-IN`, `en-IN`. */
+    language: string | null;
+    actionItems: CallActionItem[];
+    /** The audio in the workspace's Drive - read it with a `drive:read` key. */
+    recordingFileId: string | null;
+    /** ISO-8601 - when the call started. */
+    occurredAt: string;
+}
 /**
  * An appointment was booked and is holding its slot.
  *
@@ -1446,6 +1488,7 @@ export interface ConnectWebhookEventMap {
     "subscription.cancelled": SubscriptionCancelledEvent;
     "call.completed": CallCompletedEvent;
     "call.missed": CallMissedEvent;
+    "call.analyzed": CallAnalyzedEvent;
     "booking.confirmed": BookingConfirmedEvent;
     "booking.cancelled": BookingCancelledEvent;
     "booking.rescheduled": BookingRescheduledEvent;
@@ -2804,7 +2847,7 @@ 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. */
+    /** `member` for a call a person placed with `<ConnectCallButton>`. Such a call has no agent; it has a recording, a transcript and an `analysis` only when the workspace records calls. */
     handler: CallHandler;
     /** The member who placed a `member` call - their Connect user id. */
     placedByUserId: string | null;
@@ -2817,6 +2860,21 @@ export interface ConnectCall {
     talkSeconds: number | null;
     /** Why nobody answered - set only when `status` is `unanswered`. */
     unansweredReason: CallUnansweredReason | (string & {}) | null;
+    /**
+     * The reading of a recorded member call - summary, intent, action items.
+     * `null` for a call that was not recorded; `status: "pending"` while it is
+     * being read. The transcript is `CallDetail.turns`, the member as `agent`
+     * and the person called as `user`.
+     */
+    analysis: ConnectCallAnalysis | null;
+}
+export interface ConnectCallAnalysis {
+    status: "pending" | "done" | "failed";
+    summary: string | null;
+    intent: string | null;
+    sentiment: CallSentiment | null;
+    actionItems: CallActionItem[];
+    language: string | null;
 }
 /**
  * What the browser needs to place one approved call - see

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmoops/connect-sdk",
-  "version": "0.42.0",
+  "version": "0.43.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",