@vuevox/sdk 0.5.0 → 0.7.0

package/README.md

@@ -32,6 +32,8 @@ spaces:read
 agents:read
 calls:read
 leads:read
+leads:write
+lead_custom_fields:manage
 ```
 
 The token request can only request scopes that were granted to that API client.
@@ -105,7 +107,12 @@ vuevox.calls.get("call-id");
 vuevox.calls.paginate();
 vuevox.leads.list();
 vuevox.leads.get("lead-id");
+vuevox.leads.update("lead-id", { customFields: { crm_stage: "qualified" } });
+vuevox.leads.upsertByExternalId("crm-lead-id", { firstName: "Ada", lastName: "Lovelace" });
 vuevox.leads.paginate();
+vuevox.leadCustomFields.list();
+vuevox.leadCustomFields.create({ key: "crm_stage", label: "CRM Stage", type: "select", options: ["new", "qualified"] });
+vuevox.leadCustomFields.update("crm_stage", { label: "CRM Stage" });
 vuevox.raw.GET("/v1/hello", { headers: { Authorization: `Bearer ${await vuevox.getAccessToken()}` } });
 ```
 
@@ -218,6 +225,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 +241,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 +257,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);
 }
 ```
 
@@ -271,12 +280,16 @@ Options: `ListCallsOptions`
 | `agentId` | `string` | Optional agent ID filter. |
 | `createdAfter` | `string` | Optional ISO 8601 lower bound for call creation time. |
 | `createdBefore` | `string` | Optional ISO 8601 upper bound for call creation time. |
+| `leadCustomFields` | `Record<string, CustomFieldFilterValue>` | Optional filters on lead custom fields attached to calls. |
 
 ```ts
 const response = await vuevox.calls.list({
   limit: 50,
   spaceId: "space-id",
   createdAfter: "2026-01-01T00:00:00.000Z",
+  leadCustomFields: {
+    crm_stage: "qualified",
+  },
 });
 
 for (const call of response.data.data) {
@@ -319,6 +332,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, and a `customFields` object for organization-defined CRM fields.
+
 Required scope: `leads:read`.
 
 Options: `ListLeadsOptions`
@@ -330,12 +345,20 @@ Options: `ListLeadsOptions`
 | `spaceId` | `string` | Optional space ID filter. |
 | `createdAfter` | `string` | Optional ISO 8601 lower bound for lead creation time. |
 | `createdBefore` | `string` | Optional ISO 8601 upper bound for lead creation time. |
+| `customFields` | `Record<string, CustomFieldFilterValue>` | Optional filters on lead custom fields. |
 
 ```ts
-const response = await vuevox.leads.list({ limit: 50, spaceId: "space-id" });
+const response = await vuevox.leads.list({
+  limit: 50,
+  spaceId: "space-id",
+  customFields: {
+    crm_stage: "qualified",
+    deal_value: { gte: 10000 },
+  },
+});
 
 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, lead.customFields);
 }
 ```
 
@@ -349,7 +372,53 @@ 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.data.externalId, response.data.data.email, response.data.data.phone, response.data.data.customFields);
+```
+
+Returns: `Promise<VueVoxApiResponse<LeadDetailResponse>>`.
+
+### `vuevox.leads.update(leadId, input)`
+
+Updates a lead and/or its custom fields.
+
+Required scope: `leads:write`.
+
+Input: `LeadUpdateRequest`
+
+```ts
+const response = await vuevox.leads.update("lead-id", {
+  email: "ada@example.com",
+  customFields: {
+    crm_stage: "qualified",
+    renewal_date: "2026-09-01",
+  },
+});
+
+console.log(response.data.data.customFields);
+```
+
+Returns: `Promise<VueVoxApiResponse<LeadDetailResponse>>`.
+
+### `vuevox.leads.upsertByExternalId(externalId, input)`
+
+Creates or updates a lead by the integrating CRM/system ID. This is the preferred write method for CRM integrations because callers can use their own stable lead ID.
+
+Required scope: `leads:write`.
+
+Input: `LeadUpsertRequest`
+
+```ts
+const response = await vuevox.leads.upsertByExternalId("hubspot_123", {
+  firstName: "Ada",
+  lastName: "Lovelace",
+  email: "ada@example.com",
+  customFields: {
+    crm_stage: "qualified",
+    deal_value: 12000,
+  },
+});
+
+console.log(response.data.data.id, response.data.data.customFields);
 ```
 
 Returns: `Promise<VueVoxApiResponse<LeadDetailResponse>>`.
@@ -364,12 +433,70 @@ 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);
 }
 ```
 
 Returns: `AsyncGenerator<Lead>`.
 
+### `vuevox.leadCustomFields.list(options?)`
+
+Lists organization lead custom field definitions.
+
+Required scope: `leads:read`.
+
+Options: `ListLeadCustomFieldsOptions`
+
+| Option | Type | Description |
+| --- | --- | --- |
+| `includeArchived` | `boolean` | Include archived definitions. Defaults to `false`. |
+
+```ts
+const response = await vuevox.leadCustomFields.list();
+console.log(response.data.data);
+```
+
+Returns: `Promise<VueVoxApiResponse<LeadCustomFieldsListResponse>>`.
+
+### `vuevox.leadCustomFields.create(input)`
+
+Creates a lead custom field definition. Supported types are `text`, `number`, `boolean`, `date`, `datetime`, `select`, and `multi_select`.
+
+Required scope: `lead_custom_fields:manage`.
+
+Input: `LeadCustomFieldCreateRequest`
+
+```ts
+const response = await vuevox.leadCustomFields.create({
+  key: "crm_stage",
+  label: "CRM Stage",
+  type: "select",
+  options: ["new", "qualified", "customer"],
+  isFilterable: true,
+});
+
+console.log(response.data.data.key);
+```
+
+Returns: `Promise<VueVoxApiResponse<LeadCustomFieldResponse>>`.
+
+### `vuevox.leadCustomFields.update(key, input)`
+
+Updates mutable metadata for a lead custom field definition. Field keys and types are immutable.
+
+Required scope: `lead_custom_fields:manage`.
+
+Input: `LeadCustomFieldUpdateRequest`
+
+```ts
+await vuevox.leadCustomFields.update("crm_stage", {
+  label: "CRM Pipeline Stage",
+  archived: false,
+});
+```
+
+Returns: `Promise<VueVoxApiResponse<LeadCustomFieldResponse>>`.
+
 ## Lower-Level Calls
 
 For advanced integrations, `raw` exposes a typed lower-level OpenAPI client. You must attach authorization yourself.
@@ -425,6 +552,8 @@ rate_limited
 invalid_request
 call_not_found
 lead_not_found
+custom_field_not_found
+custom_field_conflict
 ```
 
 ## Retries
@@ -481,12 +610,22 @@ import type {
   CallDetailResponse,
   CallsListResponse,
   CallSummary,
+  CustomFieldFilters,
+  CustomFieldFilterValue,
   HelloResponse,
   Lead,
+  LeadCustomField,
+  LeadCustomFieldCreateRequest,
+  LeadCustomFieldResponse,
+  LeadCustomFieldUpdateRequest,
+  LeadCustomFieldsListResponse,
   LeadDetailResponse,
+  LeadUpdateRequest,
+  LeadUpsertRequest,
   LeadsListResponse,
   ListAgentsOptions,
   ListCallsOptions,
+  ListLeadCustomFieldsOptions,
   ListLeadsOptions,
   ListSpacesOptions,
   Space,

package/dist/client.d.ts

@@ -1,15 +1,33 @@
 import type { components, paths } from "./generated/schema.js";
-type HelloResponse = components["schemas"]["HelloResponse"];
-type SpacesListResponse = components["schemas"]["SpacesListResponse"];
-type AgentsListResponse = components["schemas"]["AgentsListResponse"];
-type CallsListResponse = components["schemas"]["CallsListResponse"];
-type CallDetailResponse = components["schemas"]["CallDetailResponse"];
-type LeadsListResponse = components["schemas"]["LeadsListResponse"];
-type LeadDetailResponse = components["schemas"]["LeadDetailResponse"];
-type Space = components["schemas"]["Space"];
-type Agent = components["schemas"]["Agent"];
-type CallSummary = components["schemas"]["CallSummary"];
-type Lead = components["schemas"]["Lead"];
+export type HelloResponse = components["schemas"]["HelloResponse"];
+export type SpacesListResponse = components["schemas"]["SpacesListResponse"];
+export type AgentsListResponse = components["schemas"]["AgentsListResponse"];
+export type CallsListResponse = components["schemas"]["CallsListResponse"];
+export type CallDetailResponse = components["schemas"]["CallDetailResponse"];
+export type LeadsListResponse = components["schemas"]["LeadsListResponse"];
+export type LeadDetailResponse = components["schemas"]["LeadDetailResponse"];
+export type LeadCustomFieldsListResponse = components["schemas"]["LeadCustomFieldsListResponse"];
+export type LeadCustomFieldResponse = components["schemas"]["LeadCustomFieldResponse"];
+export type LeadCustomFieldCreateRequest = components["schemas"]["LeadCustomFieldCreateRequest"];
+export type LeadCustomFieldUpdateRequest = components["schemas"]["LeadCustomFieldUpdateRequest"];
+export type LeadUpsertRequest = components["schemas"]["LeadUpsertRequest"];
+export type LeadUpdateRequest = components["schemas"]["LeadUpdateRequest"];
+export type Space = components["schemas"]["Space"];
+export type Agent = components["schemas"]["Agent"];
+export type CallSummary = components["schemas"]["CallSummary"];
+export type Lead = components["schemas"]["Lead"];
+export type LeadCustomField = components["schemas"]["LeadCustomField"];
+export type CustomFieldFilterValue = string | number | boolean | {
+    eq?: string | number | boolean;
+    gt?: string | number;
+    gte?: string | number;
+    lt?: string | number;
+    lte?: string | number;
+    before?: string;
+    after?: string;
+    contains?: string;
+};
+export type CustomFieldFilters = Record<string, CustomFieldFilterValue>;
 export interface ListSpacesOptions {
     limit?: number;
     cursor?: string;
@@ -20,6 +38,7 @@ export interface ListCallsOptions extends ListSpacesOptions {
     agentId?: string;
     createdAfter?: string;
     createdBefore?: string;
+    leadCustomFields?: CustomFieldFilters;
 }
 export interface ListAgentsOptions extends ListSpacesOptions {
     spaceId?: string;
@@ -28,6 +47,10 @@ export interface ListLeadsOptions extends ListSpacesOptions {
     spaceId?: string;
     createdAfter?: string;
     createdBefore?: string;
+    customFields?: CustomFieldFilters;
+}
+export interface ListLeadCustomFieldsOptions {
+    includeArchived?: boolean;
 }
 export interface VueVoxResponseMetadata {
     requestId?: string;
@@ -71,6 +94,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 +108,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;
@@ -97,17 +121,25 @@ export declare function createVueVoxClient(options: VueVoxClientOptions): {
     leads: {
         list: (listOptions?: ListLeadsOptions) => Promise<VueVoxApiResponse<LeadsListResponse>>;
         get: (leadId: string) => Promise<VueVoxApiResponse<LeadDetailResponse>>;
+        update: (leadId: string, input: LeadUpdateRequest) => Promise<VueVoxApiResponse<LeadDetailResponse>>;
+        upsertByExternalId: (externalId: string, input: LeadUpsertRequest) => Promise<VueVoxApiResponse<LeadDetailResponse>>;
         paginate: (listOptions?: ListLeadsOptions) => AsyncGenerator<{
             id: string;
+            externalId: string | null;
             firstName: string;
             lastName: string;
             email: string | null;
             phone: string | null;
+            customFields: components["schemas"]["CustomFields"];
             space: components["schemas"]["ResourceSummary"];
             createdAt: string;
             updatedAt: string;
         }, any, any>;
     };
+    leadCustomFields: {
+        list: (listOptions?: ListLeadCustomFieldsOptions) => Promise<VueVoxApiResponse<LeadCustomFieldsListResponse>>;
+        create: (input: LeadCustomFieldCreateRequest) => Promise<VueVoxApiResponse<LeadCustomFieldResponse>>;
+        update: (key: string, input: LeadCustomFieldUpdateRequest) => Promise<VueVoxApiResponse<LeadCustomFieldResponse>>;
+    };
     raw: import("openapi-fetch").Client<paths, `${string}/${string}`>;
 };
-export type { Agent, AgentsListResponse, CallDetailResponse, CallsListResponse, CallSummary, HelloResponse, Lead, LeadDetailResponse, LeadsListResponse, Space, SpacesListResponse };

package/dist/client.js

@@ -52,6 +52,21 @@ export function createVueVoxClient(options) {
     async function getLead(leadId) {
         return apiGet(`/v1/leads/${encodeURIComponent(leadId)}`);
     }
+    async function updateLead(leadId, input) {
+        return apiJson("PATCH", `/v1/leads/${encodeURIComponent(leadId)}`, input);
+    }
+    async function upsertLeadByExternalId(externalId, input) {
+        return apiJson("PUT", `/v1/leads/by-external-id/${encodeURIComponent(externalId)}`, input);
+    }
+    async function listLeadCustomFields(listOptions = {}) {
+        return apiGet("/v1/lead-custom-fields", listOptions);
+    }
+    async function createLeadCustomField(input) {
+        return apiJson("POST", "/v1/lead-custom-fields", input);
+    }
+    async function updateLeadCustomField(key, input) {
+        return apiJson("PATCH", `/v1/lead-custom-fields/${encodeURIComponent(key)}`, input);
+    }
     async function apiGet(path, query) {
         const accessToken = await getAccessToken();
         const result = await requestJson("GET", path, {
@@ -63,6 +78,18 @@ export function createVueVoxClient(options) {
         });
         return withMetadata(result.data, result.response, result.requestId);
     }
+    async function apiJson(method, path, body) {
+        const accessToken = await getAccessToken();
+        const result = await requestJson(method, path, {
+            method,
+            headers: {
+                Authorization: `Bearer ${accessToken}`,
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(body),
+        });
+        return withMetadata(result.data, result.response, result.requestId);
+    }
     async function requestJson(method, path, init) {
         for (let attempt = 0;; attempt++) {
             const response = await fetchFn(buildUrl(baseUrl, path, init.query), init);
@@ -76,7 +103,7 @@ export function createVueVoxClient(options) {
                 }
                 return { data: body, requestId, response };
             }
-            if (attempt < retries && shouldRetry(response.status)) {
+            if (attempt < retries && (method === "GET" || path === "/oauth/token") && shouldRetry(response.status)) {
                 await sleep(retryDelayMs(attempt, retryAfter));
                 continue;
             }
@@ -111,8 +138,15 @@ export function createVueVoxClient(options) {
         leads: {
             list: listLeads,
             get: getLead,
+            update: updateLead,
+            upsertByExternalId: upsertLeadByExternalId,
             paginate: (listOptions = {}) => paginate(listLeads, listOptions),
         },
+        leadCustomFields: {
+            list: listLeadCustomFields,
+            create: createLeadCustomField,
+            update: updateLeadCustomField,
+        },
         raw,
     };
 }
@@ -127,12 +161,27 @@ function trimTrailingSlash(value) {
 }
 function buildUrl(baseUrl, path, query) {
     const url = new URL(`${baseUrl}${path}`);
-    for (const [key, value] of Object.entries(query ?? {})) {
-        if ((typeof value === "string" || typeof value === "number") && value !== "") {
-            url.searchParams.set(key, String(value));
+    appendQueryParams(url.searchParams, query ?? {});
+    return url.toString();
+}
+function appendQueryParams(searchParams, query, prefix) {
+    for (const [rawKey, value] of Object.entries(query)) {
+        if (value === undefined || value === null || value === "") {
+            continue;
+        }
+        const key = queryKey(rawKey, prefix);
+        if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+            searchParams.set(key, String(value));
+            continue;
+        }
+        if (typeof value === "object" && !Array.isArray(value)) {
+            appendQueryParams(searchParams, value, key);
         }
     }
-    return url.toString();
+}
+function queryKey(key, prefix) {
+    const publicKey = key === "customFields" ? "custom" : key === "leadCustomFields" ? "leadCustom" : key;
+    return prefix ? `${prefix}[${publicKey}]` : publicKey;
 }
 async function parseJson(response) {
     try {

package/dist/generated/schema.d.ts

@@ -161,9 +161,77 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
+        /**
+         * Update a lead
+         * @description Updates an organization-scoped lead and its custom fields.
+         */
+        patch: operations["updateLead"];
+        trace?: never;
+    };
+    "/v1/leads/by-external-id/{externalId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Upsert a lead by external ID
+         * @description Creates or updates a lead identified by the CRM/system external ID.
+         */
+        put: operations["upsertLeadByExternalId"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
         patch?: never;
         trace?: never;
     };
+    "/v1/lead-custom-fields": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List lead custom field definitions
+         * @description Returns lead custom field definitions for the API client's organization.
+         */
+        get: operations["listLeadCustomFields"];
+        put?: never;
+        /**
+         * Create a lead custom field definition
+         * @description Creates a typed lead custom field definition for CRM integrations and platform filters.
+         */
+        post: operations["createLeadCustomField"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/lead-custom-fields/{key}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Update a lead custom field definition
+         * @description Updates mutable metadata for a lead custom field definition. Keys and types are immutable.
+         */
+        patch: operations["updateLeadCustomField"];
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -175,7 +243,7 @@ export interface components {
             client_secret: string;
             /**
              * @description Space-separated scopes requested for the access token.
-             * @example hello:read spaces:read agents:read calls:read leads:read
+             * @example hello:read spaces:read agents:read calls:read leads:read leads:write lead_custom_fields:manage
              */
             scope?: string;
         };
@@ -185,7 +253,7 @@ export interface components {
             token_type: "Bearer";
             /** @example 3600 */
             expires_in: number;
-            /** @example hello:read spaces:read agents:read calls:read leads:read */
+            /** @example hello:read spaces:read agents:read calls:read leads:read leads:write lead_custom_fields:manage */
             scope: string;
         };
         HelloResponse: {
@@ -211,6 +279,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 +301,25 @@ export interface components {
         LeadSummary: {
             /** Format: uuid */
             id: string;
+            /** @description Optional ID from an external system. */
+            externalId: string | null;
             firstName: string;
             lastName: string;
+            customFields: components["schemas"]["CustomFields"];
+        } | 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,11 +360,14 @@ export interface components {
         Lead: {
             /** Format: uuid */
             id: string;
+            /** @description Optional ID from an external system. */
+            externalId: string | null;
             firstName: string;
             lastName: string;
             /** Format: email */
             email: string | null;
             phone: string | null;
+            customFields: components["schemas"]["CustomFields"];
             space: components["schemas"]["ResourceSummary"];
             /** Format: date-time */
             createdAt: string;
@@ -298,6 +381,72 @@ export interface components {
         LeadDetailResponse: {
             data: components["schemas"]["Lead"];
         };
+        LeadUpsertRequest: {
+            firstName: string;
+            lastName: string;
+            /** Format: email */
+            email?: string | null;
+            phone?: string | null;
+            /** Format: uuid */
+            spaceId?: string | null;
+            customFields?: components["schemas"]["CustomFields"];
+        };
+        LeadUpdateRequest: {
+            firstName?: string;
+            lastName?: string;
+            /** Format: email */
+            email?: string | null;
+            phone?: string | null;
+            /** Format: uuid */
+            spaceId?: string | null;
+            customFields?: components["schemas"]["CustomFields"];
+        };
+        /** @description Lead custom field values keyed by custom field key. */
+        CustomFields: {
+            [key: string]: string | number | boolean | string[] | null;
+        };
+        /** @description Custom field filters keyed by custom field key. Scalar values use equality; objects specify one operator. */
+        CustomFieldFilters: {
+            [key: string]: string | number | boolean | {
+                [key: string]: string | number | boolean;
+            };
+        };
+        LeadCustomField: {
+            /** @example crm_stage */
+            key: string;
+            /** @example CRM Stage */
+            label: string;
+            /** @enum {string} */
+            type: "text" | "number" | "boolean" | "date" | "datetime" | "select" | "multi_select";
+            options: string[];
+            isFilterable: boolean;
+            archived: boolean;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        LeadCustomFieldsListResponse: {
+            data: components["schemas"]["LeadCustomField"][];
+        };
+        LeadCustomFieldResponse: {
+            data: components["schemas"]["LeadCustomField"];
+        };
+        LeadCustomFieldCreateRequest: {
+            key: string;
+            label: string;
+            /** @enum {string} */
+            type: "text" | "number" | "boolean" | "date" | "datetime" | "select" | "multi_select";
+            options?: string[];
+            /** @default true */
+            isFilterable: boolean;
+        };
+        LeadCustomFieldUpdateRequest: {
+            label?: string;
+            options?: string[];
+            isFilterable?: boolean;
+            archived?: boolean;
+        };
         CursorPagination: {
             /** @example 50 */
             limit: number;
@@ -580,6 +729,8 @@ export interface operations {
                 createdAfter?: string;
                 /** @description Return calls created at or before this timestamp. */
                 createdBefore?: string;
+                /** @description Filter calls by lead custom fields. Use equality by default, or one operator such as gte, lte, contains, before, or after. */
+                leadCustom?: components["schemas"]["CustomFieldFilters"];
             };
             header?: never;
             path?: never;
@@ -714,6 +865,8 @@ export interface operations {
                 createdAfter?: string;
                 /** @description Return leads created at or before this timestamp. */
                 createdBefore?: string;
+                /** @description Filter leads by custom fields. Use equality by default, or one operator such as gte, lte, contains, before, or after. */
+                custom?: components["schemas"]["CustomFieldFilters"];
             };
             header?: never;
             path?: never;
@@ -835,4 +988,294 @@ export interface operations {
             };
         };
     };
+    updateLead: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Lead ID. */
+                leadId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LeadUpdateRequest"];
+            };
+        };
+        responses: {
+            /** @description Lead updated. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadDetailResponse"];
+                };
+            };
+            /** @description Bearer token is missing, invalid, or expired. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Bearer token does not include the required scope. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Lead was not found in the API client's organization. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Request body failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    upsertLeadByExternalId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description External lead ID from the integrating system. */
+                externalId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LeadUpsertRequest"];
+            };
+        };
+        responses: {
+            /** @description Existing lead updated. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadDetailResponse"];
+                };
+            };
+            /** @description New lead created. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadDetailResponse"];
+                };
+            };
+            /** @description Bearer token is missing, invalid, or expired. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Bearer token does not include the required scope. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Request body failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    listLeadCustomFields: {
+        parameters: {
+            query?: {
+                /** @description Include archived field definitions. */
+                includeArchived?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Lead custom field definitions. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadCustomFieldsListResponse"];
+                };
+            };
+            /** @description Bearer token is missing, invalid, or expired. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Bearer token does not include the required scope. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    createLeadCustomField: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LeadCustomFieldCreateRequest"];
+            };
+        };
+        responses: {
+            /** @description Lead custom field created. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadCustomFieldResponse"];
+                };
+            };
+            /** @description Bearer token is missing, invalid, or expired. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Bearer token does not include the required scope. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description A custom field with this key already exists. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Request body failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    updateLeadCustomField: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Custom field key. */
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LeadCustomFieldUpdateRequest"];
+            };
+        };
+        responses: {
+            /** @description Lead custom field updated. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadCustomFieldResponse"];
+                };
+            };
+            /** @description Bearer token is missing, invalid, or expired. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Bearer token does not include the required scope. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Custom field was not found in the API client's organization. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Request body failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
 }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { createVueVoxClient } from "./client.js";
-export type { Agent, AgentsListResponse, CallDetailResponse, CallsListResponse, CallSummary, HelloResponse, Lead, LeadDetailResponse, LeadsListResponse, ListAgentsOptions, ListCallsOptions, ListLeadsOptions, ListSpacesOptions, Space, SpacesListResponse, VueVoxApiResponse, VueVoxClientOptions, VueVoxResponseEvent, VueVoxResponseMetadata, } from "./client.js";
+export type { Agent, AgentsListResponse, CallDetailResponse, CallsListResponse, CallSummary, CustomFieldFilters, CustomFieldFilterValue, HelloResponse, Lead, LeadCustomField, LeadCustomFieldCreateRequest, LeadCustomFieldResponse, LeadCustomFieldUpdateRequest, LeadCustomFieldsListResponse, LeadDetailResponse, LeadUpdateRequest, LeadUpsertRequest, LeadsListResponse, ListAgentsOptions, ListCallsOptions, ListLeadCustomFieldsOptions, ListLeadsOptions, ListSpacesOptions, Space, SpacesListResponse, VueVoxApiResponse, VueVoxClientOptions, VueVoxResponseEvent, VueVoxResponseMetadata, } from "./client.js";
 export { VueVoxApiError } from "./errors.js";
 export type { VueVoxErrorResponse } from "./errors.js";

package/package.json

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