@vuevox/sdk 0.5.0 → 0.6.0

package/README.md

@@ -218,6 +218,8 @@ Returns: `AsyncGenerator<Space>`.
 
 Lists organization agents.
 
+Agent records include nullable `externalId` when you store an ID from another system.
+
 Required scope: `agents:read`.
 
 Options: `ListAgentsOptions`
@@ -232,7 +234,7 @@ Options: `ListAgentsOptions`
 const response = await vuevox.agents.list({ limit: 50, spaceId: "space-id" });
 
 for (const agent of response.data.data) {
-  console.log(agent.id, agent.name);
+  console.log(agent.id, agent.externalId, agent.name);
 }
 ```
 
@@ -248,7 +250,7 @@ Options: `ListAgentsOptions`
 
 ```ts
 for await (const agent of vuevox.agents.paginate({ spaceId: "space-id" })) {
-  console.log(agent.id, agent.name);
+  console.log(agent.id, agent.externalId, agent.name);
 }
 ```
 
@@ -319,6 +321,8 @@ Returns: `AsyncGenerator<CallSummary>`.
 
 Lists organization leads. The `leads:read` scope includes lead email and phone contact details.
 
+Lead records include nullable `externalId` when you store an ID from another system.
+
 Required scope: `leads:read`.
 
 Options: `ListLeadsOptions`
@@ -335,7 +339,7 @@ Options: `ListLeadsOptions`
 const response = await vuevox.leads.list({ limit: 50, spaceId: "space-id" });
 
 for (const lead of response.data.data) {
-  console.log(lead.id, lead.email, lead.phone);
+  console.log(lead.id, lead.externalId, lead.email, lead.phone);
 }
 ```
 
@@ -349,7 +353,7 @@ Required scope: `leads:read`.
 
 ```ts
 const response = await vuevox.leads.get("lead-id");
-console.log(response.data.email, response.data.phone);
+console.log(response.data.externalId, response.data.email, response.data.phone);
 ```
 
 Returns: `Promise<VueVoxApiResponse<LeadDetailResponse>>`.
@@ -364,7 +368,7 @@ Options: `ListLeadsOptions`
 
 ```ts
 for await (const lead of vuevox.leads.paginate({ createdAfter: "2026-01-01T00:00:00.000Z" })) {
-  console.log(lead.id);
+  console.log(lead.id, lead.externalId);
 }
 ```
 

package/dist/client.d.ts

@@ -71,6 +71,7 @@ export declare function createVueVoxClient(options: VueVoxClientOptions): {
         list: (listOptions?: ListAgentsOptions) => Promise<VueVoxApiResponse<AgentsListResponse>>;
         paginate: (listOptions?: ListAgentsOptions) => AsyncGenerator<{
             id: string;
+            externalId: string | null;
             name: string;
             spaces: components["schemas"]["ResourceSummary"][];
             createdAt: string;
@@ -84,7 +85,7 @@ export declare function createVueVoxClient(options: VueVoxClientOptions): {
             id: string;
             space: components["schemas"]["ResourceSummary"];
             lead: components["schemas"]["LeadSummary"];
-            agent: components["schemas"]["ResourceSummary"];
+            agent: components["schemas"]["AgentSummary"];
             duration: number;
             score: number | null;
             sentiment: string | null;
@@ -99,6 +100,7 @@ export declare function createVueVoxClient(options: VueVoxClientOptions): {
         get: (leadId: string) => Promise<VueVoxApiResponse<LeadDetailResponse>>;
         paginate: (listOptions?: ListLeadsOptions) => AsyncGenerator<{
             id: string;
+            externalId: string | null;
             firstName: string;
             lastName: string;
             email: string | null;

package/dist/generated/schema.d.ts

@@ -211,6 +211,8 @@ export interface components {
         Agent: {
             /** Format: uuid */
             id: string;
+            /** @description Optional ID from an external system. */
+            externalId: string | null;
             /** @example Morgan Agent */
             name: string;
             spaces: components["schemas"]["ResourceSummary"][];
@@ -231,15 +233,24 @@ export interface components {
         LeadSummary: {
             /** Format: uuid */
             id: string;
+            /** @description Optional ID from an external system. */
+            externalId: string | null;
             firstName: string;
             lastName: string;
         } | null;
+        AgentSummary: {
+            /** Format: uuid */
+            id: string;
+            /** @description Optional ID from an external system. */
+            externalId: string | null;
+            name: string;
+        } | null;
         CallSummary: {
             /** Format: uuid */
             id: string;
             space: components["schemas"]["ResourceSummary"];
             lead: components["schemas"]["LeadSummary"];
-            agent: components["schemas"]["ResourceSummary"];
+            agent: components["schemas"]["AgentSummary"];
             /** @description Call duration in seconds. */
             duration: number;
             score: number | null;
@@ -280,6 +291,8 @@ export interface components {
         Lead: {
             /** Format: uuid */
             id: string;
+            /** @description Optional ID from an external system. */
+            externalId: string | null;
             firstName: string;
             lastName: string;
             /** Format: email */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuevox/sdk",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "TypeScript SDK for the VueVox Developer API.",
   "type": "module",
   "main": "./dist/index.js",