@upon-ai/sdk 0.1.2 → 0.1.4

package/README.md

@@ -6,7 +6,7 @@ Requires Node >=22.14. ESM package; CommonJS consumers can use dynamic `import()
 ## Install
 
 ```sh
-npm install @upon-ai/sdk@0.1.2
+npm install @upon-ai/sdk@0.1.4
 ```
 
 ```ts
@@ -25,7 +25,7 @@ Keep the API key on your server. Do not embed customer credentials in browser
 bundles. Each client keeps its own credential; an async `apiKey` callback can
 supply a rotated token. There are no global credentials or privileged header overrides.
 
-All 75 reviewed public operations have named methods. Inputs use `path`, `query`
+All 110 reviewed public operations have named methods. Inputs use `path`, `query`
 and `body` groups matching the public OpenAPI contract. Types include
 `OperationInput`, `OperationOutput`, `operations` and `components`.
 Multipart bodies use native `FormData`; binary endpoints return `Blob`.
@@ -58,3 +58,23 @@ pages fail instead of looping indefinitely. No universal cursor format is assume
 Use `baseUrl` only for a trusted HTTPS API origin, such as your staging deployment.
 The optional injected `fetch` is trusted application code, primarily for tests.
 Types describe the reviewed contract; responses are not runtime schema-validated.
+
+## Agent webhook settings
+
+The contract types all eight voice events and three chat events. Use
+`updateAgent` or `updateChatAgent` with `body.workspaceId`, `body.webhook_url`, and
+`body.webhook_events`; set `query.version` to the editable version when changing
+subscriptions. The platform saves the customer destination and routes delivery
+through its proxy. Omitted fields are preserved. `webhook_url: null` clears the
+destination; `webhook_events: []` disables customer event delivery. Read back with
+`getAgent` or `getChatAgent` to verify the current saved customer settings.
+Subscription changes on published versions return 409; publish the edited draft
+separately to activate.
+
+```ts
+await client.updateAgent({
+  path: { agentId: 'agent_example' },
+  query: { version: 3 },
+  body: { workspaceId: 123, webhook_events: ['transcript_updated', 'transfer_ended'] },
+});
+```

package/dist/index.d.ts

@@ -115,4 +115,5 @@ export declare class UponAI extends ClientCore {
     getVoiceSimulationSchedule(args: OperationInput<'getVoiceSimulationSchedule'>, options?: RequestOptions): Promise<OperationOutput<'getVoiceSimulationSchedule'>>;
     saveVoiceSimulationSchedule(args: OperationInput<'saveVoiceSimulationSchedule'>, options?: RequestOptions): Promise<OperationOutput<'saveVoiceSimulationSchedule'>>;
     pauseVoiceSimulationSchedule(args: OperationInput<'pauseVoiceSimulationSchedule'>, options?: RequestOptions): Promise<OperationOutput<'pauseVoiceSimulationSchedule'>>;
+    createCallMonitorSession(args: OperationInput<'createCallMonitorSession'>, options?: RequestOptions): Promise<OperationOutput<'createCallMonitorSession'>>;
 }

package/dist/index.js

@@ -114,4 +114,5 @@ export class UponAI extends ClientCore {
     getVoiceSimulationSchedule(args, options) { return this.execute('getVoiceSimulationSchedule', args, options); }
     saveVoiceSimulationSchedule(args, options) { return this.execute('saveVoiceSimulationSchedule', args, options); }
     pauseVoiceSimulationSchedule(args, options) { return this.execute('pauseVoiceSimulationSchedule', args, options); }
+    createCallMonitorSession(args, options) { return this.execute('createCallMonitorSession', args, options); }
 }

package/dist/metadata.d.ts

@@ -2290,6 +2290,10 @@ export declare const metadata: {
                     readonly minItems: 1;
                     readonly maxItems: 100;
                 };
+                readonly ai_model: {
+                    readonly type: "string";
+                    readonly description: "Optional allowed AI model ID from settings. Overrides scenario scoring models and selects their per-run tier price. Aliases are display labels, not IDs.";
+                };
                 readonly repetitions: {
                     readonly type: "integer";
                     readonly minimum: 1;
@@ -3030,4 +3034,29 @@ export declare const metadata: {
         readonly bodyType: null;
         readonly bodySchema: null;
     };
+    readonly createCallMonitorSession: {
+        readonly path: "/api/v1/calls/{callId}/monitor";
+        readonly method: "post";
+        readonly summary: "Open a live call monitoring session";
+        readonly parameters: readonly [{
+            readonly name: "callId";
+            readonly in: "path";
+            readonly required: true;
+            readonly schema: {
+                readonly type: "string";
+            };
+        }];
+        readonly bodyRequired: false;
+        readonly bodyType: "application/json";
+        readonly bodySchema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly audio: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "Request live audio in addition to transcripts.";
+                };
+            };
+        };
+    };
 };

package/dist/metadata.js

@@ -2544,6 +2544,10 @@ export const metadata = {
                     "minItems": 1,
                     "maxItems": 100
                 },
+                "ai_model": {
+                    "type": "string",
+                    "description": "Optional allowed AI model ID from settings. Overrides scenario scoring models and selects their per-run tier price. Aliases are display labels, not IDs."
+                },
                 "repetitions": {
                     "type": "integer",
                     "minimum": 1,
@@ -3377,5 +3381,32 @@ export const metadata = {
         "bodyRequired": false,
         "bodyType": null,
         "bodySchema": null
+    },
+    "createCallMonitorSession": {
+        "path": "/api/v1/calls/{callId}/monitor",
+        "method": "post",
+        "summary": "Open a live call monitoring session",
+        "parameters": [
+            {
+                "name": "callId",
+                "in": "path",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "bodyRequired": false,
+        "bodyType": "application/json",
+        "bodySchema": {
+            "type": "object",
+            "properties": {
+                "audio": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Request live audio in addition to transcripts."
+                }
+            }
+        }
     }
 };

package/dist/schema.d.ts

@@ -104,7 +104,7 @@ export interface paths {
         head?: never;
         /**
          * Update agent
-         * @description Apply partial updates to an existing agent configuration.
+         * @description Apply partial updates. Customer webhook URLs and event selections are stored by the platform; delivery uses the platform proxy. Omitted webhook fields are preserved. Subscription changes require an editable version; publish it separately to activate.
          */
         patch: operations["updateAgent"];
         trace?: never;
@@ -236,7 +236,7 @@ export interface paths {
         head?: never;
         /**
          * Update chat agent
-         * @description Apply partial updates to an existing chat agent configuration.
+         * @description Apply partial updates. Customer webhook URLs and event selections are stored by the platform; delivery uses the platform proxy. Omitted webhook fields are preserved. Subscription changes require an editable version; publish it separately to activate.
          */
         patch: operations["updateChatAgent"];
         trace?: never;
@@ -1786,6 +1786,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/calls/{callId}/monitor": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Open a live call monitoring session
+         * @description Create a single-use ticket valid for 60 seconds for a call-scoped WebSocket. Connect to websocket_path on the same API origin using wss. The stream sends ready, transcript_snapshot, transcript_updated and call_ended JSON events. Transcript events contain the complete current transcripts array; replace items by id. Optional audio uses audio_started, audio_chunk, audio_stopped and audio_error events. Audio chunks contain base64 signed 16-bit little-endian PCM; audio_started supplies sample_rate and channels. Audio requires workspace live-audio access and a supported active media connection. Audio startup failure leaves transcripts available. Access is rechecked on connection and every 15 seconds. Reconnect by creating a new session. Tickets are credentials; keep them out of logs. Live transcripts are raw, before post-call privacy processing. No client messages are required.
+         */
+        post: operations["createCallMonitorSession"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -2091,9 +2111,13 @@ export interface components {
             /** @default en-US */
             language?: string;
             response_engine: components["schemas"]["ResponseEngine"];
-            /** Format: uri */
+            /**
+             * Format: uri
+             * @description Customer receiving URL saved by the platform. Delivery uses the platform proxy. Null disables customer forwarding; omitted PATCH fields are preserved. Responses include the current agent-level destination, even for historical versions.
+             */
             webhook_url?: string | null;
-            webhook_events?: string[];
+            /** @description Customer event selections. Omission preserves selections on update and defaults to the three lifecycle events on creation. An empty array disables customer event delivery. Optional subscriptions are enabled only when selected. Subscription changes require an editable version and publication to activate for production calls or chats. */
+            webhook_events?: components["schemas"]["VoiceWebhookEvent"][];
             webhook_timeout_ms?: number;
             response_threshold?: number;
             interruption_sensitivity?: number;
@@ -2135,6 +2159,8 @@ export interface components {
             type: string;
             llm_id?: string;
         };
+        /** @enum {string} */
+        VoiceWebhookEvent: "call_started" | "call_ended" | "call_analyzed" | "transcript_updated" | "transfer_started" | "transfer_bridged" | "transfer_cancelled" | "transfer_ended";
         CustomSttConfig: ({
             /**
              * @description Realtime transcription provider used when stt_mode is custom.
@@ -2152,9 +2178,13 @@ export interface components {
             fallback_voice_ids?: string[] | null;
             language?: string | null;
             response_engine?: components["schemas"]["ResponseEngine"];
-            /** Format: uri */
+            /**
+             * Format: uri
+             * @description Customer receiving URL saved by the platform. Delivery uses the platform proxy. Null disables customer forwarding; omitted PATCH fields are preserved. Responses include the current agent-level destination, even for historical versions.
+             */
             webhook_url?: string | null;
-            webhook_events?: string[];
+            /** @description Customer event selections. Omission preserves selections on update and defaults to the three lifecycle events on creation. An empty array disables customer event delivery. Optional subscriptions are enabled only when selected. Subscription changes require an editable version and publication to activate for production calls or chats. */
+            webhook_events?: components["schemas"]["VoiceWebhookEvent"][];
             webhook_timeout_ms?: number | null;
             response_threshold?: number | null;
             interruption_sensitivity?: number | null;
@@ -2195,6 +2225,13 @@ export interface components {
             voice_model?: components["schemas"]["VoiceModel"];
             fallback_voice_ids?: string[] | null;
             language?: string;
+            /**
+             * Format: uri
+             * @description Customer receiving URL saved by the platform. Delivery uses the platform proxy. Null disables customer forwarding; omitted PATCH fields are preserved. Responses include the current agent-level destination, even for historical versions.
+             */
+            webhook_url?: string | null;
+            /** @description Customer event selections. Omission preserves selections on update and defaults to the three lifecycle events on creation. An empty array disables customer event delivery. Optional subscriptions are enabled only when selected. Subscription changes require an editable version and publication to activate for production calls or chats. */
+            webhook_events?: components["schemas"]["VoiceWebhookEvent"][];
             response_engine?: components["schemas"]["ResponseEngine"];
             interruption_sensitivity?: number;
             max_call_duration_ms?: number;
@@ -2279,9 +2316,13 @@ export interface components {
             auto_close_message?: string | null;
             end_chat_after_silence_ms?: number;
             timezone?: string;
-            /** Format: uri */
+            /**
+             * Format: uri
+             * @description Customer receiving URL saved by the platform. Delivery uses the platform proxy. Null disables customer forwarding; omitted PATCH fields are preserved. Responses include the current agent-level destination, even for historical versions.
+             */
             webhook_url?: string | null;
-            webhook_events?: string[];
+            /** @description Customer event selections. Omission preserves selections on update and defaults to the three lifecycle events on creation. An empty array disables customer event delivery. Optional subscriptions are enabled only when selected. Subscription changes require an editable version and publication to activate for production calls or chats. */
+            webhook_events?: components["schemas"]["ChatWebhookEvent"][];
             webhook_timeout_ms?: number;
             /** @enum {string} */
             data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only";
@@ -2302,6 +2343,8 @@ export interface components {
                 [key: string]: string;
             };
         };
+        /** @enum {string} */
+        ChatWebhookEvent: "chat_started" | "chat_ended" | "chat_analyzed";
         ChatAgentAnalysisField: {
             /** @example chat_summary */
             type: string;
@@ -2314,9 +2357,13 @@ export interface components {
         ChatAgent: components["schemas"]["ChatAgentSummary"] & {
             end_chat_after_silence_ms?: number | null;
             timezone?: string | null;
-            /** Format: uri */
+            /**
+             * Format: uri
+             * @description Customer receiving URL saved by the platform. Delivery uses the platform proxy. Null disables customer forwarding; omitted PATCH fields are preserved. Responses include the current agent-level destination, even for historical versions.
+             */
             webhook_url?: string | null;
-            webhook_events?: string[];
+            /** @description Customer event selections. Omission preserves selections on update and defaults to the three lifecycle events on creation. An empty array disables customer event delivery. Optional subscriptions are enabled only when selected. Subscription changes require an editable version and publication to activate for production calls or chats. */
+            webhook_events?: components["schemas"]["ChatWebhookEvent"][];
             webhook_timeout_ms?: number | null;
             /** @enum {string|null} */
             data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only" | null;
@@ -2348,9 +2395,13 @@ export interface components {
             auto_close_message?: string | null;
             end_chat_after_silence_ms?: number;
             timezone?: string;
-            /** Format: uri */
+            /**
+             * Format: uri
+             * @description Customer receiving URL saved by the platform. Delivery uses the platform proxy. Null disables customer forwarding; omitted PATCH fields are preserved. Responses include the current agent-level destination, even for historical versions.
+             */
             webhook_url?: string | null;
-            webhook_events?: string[];
+            /** @description Customer event selections. Omission preserves selections on update and defaults to the three lifecycle events on creation. An empty array disables customer event delivery. Optional subscriptions are enabled only when selected. Subscription changes require an editable version and publication to activate for production calls or chats. */
+            webhook_events?: components["schemas"]["ChatWebhookEvent"][];
             webhook_timeout_ms?: number;
             /** @enum {string} */
             data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only";
@@ -3456,6 +3507,8 @@ export interface components {
             model_options?: {
                 counterpart?: string[];
                 ai?: string[];
+                /** @description Retail-facing labels and effective per-connected-run prices for allowed AI model IDs. Blank configuration inherits the workspace surcharge. */
+                ai_details?: components["schemas"]["VoiceSimulationModelOption"][];
                 defaults?: {
                     counterpart?: string | null;
                     ai?: string | null;
@@ -3483,6 +3536,15 @@ export interface components {
                 }[];
             };
         };
+        VoiceSimulationModelOption: {
+            /** @description Stable allowed AI model ID used in requests. */
+            id: string;
+            /** @description Configured alias */
+            label: string;
+            alias?: string | null;
+            tier?: string | null;
+            per_run_price: number;
+        };
         VoiceSimulationProject: {
             /** Format: uuid */
             id: string;
@@ -3561,7 +3623,17 @@ export interface components {
         VoiceSimulationEstimate: {
             currency: string;
             run_count: number;
+            /** @description Highest per-run surcharge in this session. For mixed models, use model_prices and maximum_surcharge for exact amounts. */
             per_run_price?: number;
+            /** @description Server-computed per-scenario pricing, frozen when the session is launched. Each connected repetition incurs this surcharge; voice usage and Agent IQ interactions remain separate. */
+            model_prices?: {
+                /** Format: uuid */
+                scenario_id?: string;
+                ai_model?: string;
+                label?: string;
+                tier?: string | null;
+                per_run_price?: number;
+            }[];
             maximum_surcharge: number;
             monthly_price?: number;
             max_audio_seconds?: number;
@@ -3569,6 +3641,8 @@ export interface components {
         };
         VoiceSimulationLaunchInput: {
             scenario_ids: string[];
+            /** @description Use the same optional AI model ID as the estimate. Selects scoring and per-run tier pricing; changing it requires a new idempotency key. */
+            ai_model?: string;
             /** @default 1 */
             repetitions?: number;
             max_surcharge: number;
@@ -4261,6 +4335,34 @@ export interface operations {
                     "application/json": components["schemas"]["Agent"];
                 };
             };
+            /** @description Invalid webhook URL or event selection for this agent channel. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Agent or workspace not found or inaccessible. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The selected version is published. Create an editable version before changing subscriptions. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The webhook subscription could not be verified. Customer settings were not saved. */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     listAgentVersions: {
@@ -4504,6 +4606,34 @@ export interface operations {
                     "application/json": components["schemas"]["ChatAgent"];
                 };
             };
+            /** @description Invalid webhook URL or event selection for this agent channel. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Agent or workspace not found or inaccessible. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The selected version is published. Create an editable version before changing subscriptions. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The webhook subscription could not be verified. Customer settings were not saved. */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     listChatAgentVersions: {
@@ -7170,6 +7300,8 @@ export interface operations {
             content: {
                 "application/json": {
                     scenario_ids: string[];
+                    /** @description Optional allowed AI model ID from settings. Overrides scenario scoring models and selects their per-run tier price. Aliases are display labels, not IDs. */
+                    ai_model?: string;
                     repetitions?: number;
                 };
             };
@@ -9291,4 +9423,91 @@ export interface operations {
             };
         };
     };
+    createCallMonitorSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                callId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Request live audio in addition to transcripts.
+                     * @default false
+                     */
+                    audio?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Single-use monitoring ticket created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Relative WebSocket path on the same API origin, including the single-use ticket. */
+                        websocket_path: string;
+                        /** @constant */
+                        expires_in: 60;
+                        audio: boolean;
+                    };
+                };
+            };
+            /** @description Invalid audio option */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid or missing API token */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Live audio access is not enabled */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Live call not found or inaccessible */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Call is no longer live */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Too many pending monitoring sessions */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Monitoring temporarily unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const publicContractSha256 = "d8b4def3f123e951857909aaf9eb3036093aefb07a1c377d99bcfe50306c6504";
+export declare const publicContractSha256 = "b8eea77cb224ea7c17770bd9a1707b5410f6863875206f579d2a57db5a82d7b0";

package/dist/version.js

@@ -1 +1 @@
-export const publicContractSha256 = 'd8b4def3f123e951857909aaf9eb3036093aefb07a1c377d99bcfe50306c6504';
+export const publicContractSha256 = 'b8eea77cb224ea7c17770bd9a1707b5410f6863875206f579d2a57db5a82d7b0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upon-ai/sdk",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Typed customer API client for UponAI",
   "license": "MIT",
   "type": "module",