@upon-ai/sdk 0.1.2 → 0.1.3

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.3
 ```
 
 ```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/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;

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,

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;
@@ -2091,9 +2091,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 +2139,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 +2158,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 +2205,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 +2296,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 +2323,8 @@ export interface components {
                 [key: string]: string;
             };
         };
+        /** @enum {string} */
+        ChatWebhookEvent: "chat_started" | "chat_ended" | "chat_analyzed";
         ChatAgentAnalysisField: {
             /** @example chat_summary */
             type: string;
@@ -2314,9 +2337,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 +2375,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 +3487,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 +3516,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 +3603,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 +3621,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 +4315,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 +4586,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 +7280,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;
                 };
             };

package/dist/version.d.ts

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

package/dist/version.js

@@ -1 +1 @@
-export const publicContractSha256 = 'd8b4def3f123e951857909aaf9eb3036093aefb07a1c377d99bcfe50306c6504';
+export const publicContractSha256 = '7f23a8c8fb2cda3db95301c41e2b7d95dbdb40419d2dd2e2878d5299eb3d5a9d';

package/package.json

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