@wildix/wilma-agents-client 1.0.15 → 1.0.17

package/dist-types/models/enums.d.ts

@@ -29,24 +29,6 @@ export declare const ActorType: {
  * @public
  */
 export type ActorType = (typeof ActorType)[keyof typeof ActorType];
-/**
- * @public
- * @enum
- */
-export declare const AgentDeploymentStatus: {
-    /**
-     * The deployment accepts new sessions.
-     */
-    readonly ACTIVE: "active";
-    /**
-     * The deployment rejects new sessions without changing its routing configuration.
-     */
-    readonly PAUSED: "paused";
-};
-/**
- * @public
- */
-export type AgentDeploymentStatus = (typeof AgentDeploymentStatus)[keyof typeof AgentDeploymentStatus];
 /**
  * @public
  * @enum
@@ -148,6 +130,32 @@ export declare const SandboxNetworkAccess: {
  * @public
  */
 export type SandboxNetworkAccess = (typeof SandboxNetworkAccess)[keyof typeof SandboxNetworkAccess];
+/**
+ * @public
+ * @enum
+ */
+export declare const SandboxSize: {
+    /**
+     * Large allocation for heavier builds and data processing.
+     */
+    readonly LARGE: "large";
+    /**
+     * Largest allocation available.
+     */
+    readonly MAX: "max";
+    /**
+     * Smallest allocation; enough for light scripting.
+     */
+    readonly MIN: "min";
+    /**
+     * Small allocation for typical tool runs.
+     */
+    readonly SMALL: "small";
+};
+/**
+ * @public
+ */
+export type SandboxSize = (typeof SandboxSize)[keyof typeof SandboxSize];
 /**
  * @public
  * @enum
@@ -256,7 +264,7 @@ export declare const ChannelType: {
      */
     readonly VOICE: "voice";
     /**
-     * No delivery channel: runs as background tasks via wilma-workflows — invoked by other agents (call / delegation / handover), by automations or over the API.
+     * No delivery channel: runs as background tasks — invoked by other agents (call / delegation / handover), by automations or over the API.
      */
     readonly WORKFLOW: "workflow";
 };

package/dist-types/models/models_0.d.ts

@@ -1,5 +1,5 @@
 import type { DocumentType as __DocumentType } from "@smithy/types";
-import type { ActorType, AgentDeploymentStatus, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, ChannelType, SandboxNetworkAccess, WebSearchContextSize } from "./enums";
+import type { ActorType, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, ChannelType, SandboxNetworkAccess, SandboxSize, WebSearchContextSize } from "./enums";
 /**
  * A user or group that access is granted to.
  * @public
@@ -71,15 +71,10 @@ export interface AssistantChannelSettings {
  */
 export interface ChatChannelSettings {
     /**
-     * Whether users can find and add this agent to conversations. Maps from the legacy xbees-users bot `searchable`.
+     * Whether users can find and add this agent to conversations.
      * @public
      */
     discoverable?: boolean | undefined;
-    /**
-     * Whether the agent can produce artifacts (wilma-artifacts). When an artifact is created the chat runtime shares it company-wide by link before posting the link into the conversation, so every signed-in colleague can open it. Artifacts are company-internal: recipients on external transports (sms / whatsapp) or outside the company cannot open the links, so keep this disabled for customer-facing agents. Defaults to false.
-     * @public
-     */
-    artifacts?: boolean | undefined;
 }
 /**
  * Caller context injected into the model prompt.
@@ -107,15 +102,10 @@ export interface VoiceCallerMetadataSettings {
      */
     callerCompany?: boolean | undefined;
     /**
-     * Include the current time. Defaults to false.
+     * Include the current time, rendered in the agent's `engine.ai.timeZone`. Defaults to false.
      * @public
      */
     time?: boolean | undefined;
-    /**
-     * IANA timezone used when time is enabled. Defaults to 'UTC'.
-     * @public
-     */
-    timeZone?: string | undefined;
 }
 /**
  * @public
@@ -234,7 +224,7 @@ export interface VoiceSilenceTimeoutSettings {
  */
 export interface VoiceChannelSettings {
     /**
-     * Message spoken when the call starts. Maps from the legacy wim-voicebots `message`.
+     * Message spoken when the call starts.
      * @public
      */
     greeting?: string | undefined;
@@ -249,6 +239,7 @@ export interface VoiceChannelSettings {
     callerMetadata?: VoiceCallerMetadataSettings | undefined;
 }
 /**
+ * Workflow channel settings. Currently empty; presence enables the workflow channel.
  * @public
  */
 export interface WorkflowChannelSettings {
@@ -265,6 +256,10 @@ export interface AgentChannels {
     voice?: VoiceChannelSettings | undefined;
     chat?: ChatChannelSettings | undefined;
     assistant?: AssistantChannelSettings | undefined;
+    /**
+     * Workflow channel settings. Currently empty; presence enables the workflow channel.
+     * @public
+     */
     workflow?: WorkflowChannelSettings | undefined;
 }
 /**
@@ -294,55 +289,11 @@ export interface AgentDeploymentRoute {
      */
     version: number;
     /**
-     * Percentage of eligible new sessions routed to this version. Percentages in a deployment must sum to 100.
+     * Percentage of new sessions routed to this version. Percentages must sum to 100.
      * @public
      */
     percentage: number;
 }
-/**
- * Standard audit fields carried by every managed resource.
- * @public
- */
-export interface AgentDeployment {
-    /**
-     * ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
-     * @public
-     */
-    createdAt: string;
-    /**
-     * Who performed an action: an interactive user, an API key or an internal service.
-     * @public
-     */
-    createdBy: Actor;
-    /**
-     * ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
-     * @public
-     */
-    updatedAt?: string | undefined;
-    /**
-     * Who performed an action: an interactive user, an API key or an internal service.
-     * @public
-     */
-    updatedBy?: Actor | undefined;
-    agentId: string;
-    /**
-     * Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
-     * @public
-     */
-    name: string;
-    description?: string | undefined;
-    status: AgentDeploymentStatus;
-    /**
-     * Weighted routing over distinct published versions. Percentages must sum to 100. Selection is deterministic for a session, and the resolved version is pinned for the session lifetime.
-     * @public
-     */
-    routing: AgentDeploymentRoute[];
-    /**
-     * Monotonic revision incremented on every deployment update. Used for optimistic locking.
-     * @public
-     */
-    revision: number;
-}
 /**
  * The model fills this variable itself, from conversation context. Included in the tool's input schema.
  * @public
@@ -439,15 +390,10 @@ export interface AgentToolVariable {
 export interface AgentCallCapability {
     agentId: string;
     /**
-     * Pin a specific published version of the called agent. Mutually exclusive with agentDeployment.
+     * Pin a specific published version of the called agent. When absent, the called agent's deployment configuration selects the version at invocation time.
      * @public
      */
     agentVersion?: number | undefined;
-    /**
-     * Resolve the called agent through this deployment. When neither agentVersion nor agentDeployment is set, the called agent's 'production' deployment is resolved at invocation time.
-     * @public
-     */
-    agentDeployment?: string | undefined;
     /**
      * Who may invoke this sub-agent tool. Evaluated per invoking user when the calling agent (chat / assistant) builds its
      *         toolset: if the user is not granted, this capability is omitted from the tools offered to the model for that session.
@@ -603,7 +549,7 @@ export interface AgentToolApproval {
  */
 export interface AgentToolPipeline {
     /**
-     * How the model waits for a tool and whether it synthesizes a reply from the result. Mirrors the legacy VoiceBot/Bot capability-tool pipeline.
+     * How the model waits for a tool and whether it synthesizes a reply from the result.
      * @public
      */
     type?: AgentToolPipelineType | undefined;
@@ -622,7 +568,7 @@ export interface AgentToolPipeline {
  */
 export interface AgentConnectorCapability {
     /**
-     * Configured connector instance in wilma-tools. Its pinned definition, permission `grant` and authorization govern what the model can discover via `help` and call.
+     * Configured connector instance in wilma-tools. Its pinned definition, permission `grant` and authorization govern what the model can discover via `help` and call. There is no version pin here, unlike `AgentTool.toolVersion`: the action catalogue and its schemas are already frozen by the connector's pinned definition, while `grant` and authorization are read live so permission changes apply at once.
      * @public
      */
     id: string;
@@ -664,15 +610,10 @@ export interface AgentDelegationCapability {
      */
     id: string;
     /**
-     * Pin a specific published version of the delegate agent. Mutually exclusive with agentDeployment.
+     * Pin a specific published version of the delegate agent. When absent, the delegate's deployment configuration selects the version at delegation time.
      * @public
      */
     agentVersion?: number | undefined;
-    /**
-     * Resolve the delegate agent through this deployment. When neither agentVersion nor agentDeployment is set, the delegate's 'production' deployment is resolved at delegation time.
-     * @public
-     */
-    agentDeployment?: string | undefined;
     annotations?: AgentToolAnnotation[] | undefined;
 }
 /**
@@ -708,15 +649,10 @@ export interface AgentHandoverCapability {
      */
     agent?: string | undefined;
     /**
-     * Pin a specific published version of the target agent when variant = AGENT. Mutually exclusive with agentDeployment.
+     * Pin a specific published version of the target agent when variant = AGENT. When absent, the target's deployment configuration selects the version at handover time.
      * @public
      */
     agentVersion?: number | undefined;
-    /**
-     * Resolve the target agent through this deployment when variant = AGENT. When neither agentVersion nor agentDeployment is set, the target's 'production' deployment is resolved at handover time.
-     * @public
-     */
-    agentDeployment?: string | undefined;
     /**
      * x-bees service id to hand over to when variant = SERVICE.
      * @public
@@ -742,7 +678,7 @@ export interface AgentHangupPipeline {
     instructions?: string | undefined;
 }
 /**
- * Let the model end the call. Honoured on the voice channel. Maps from the wim-voicebots HANGUP embedded tool.
+ * Let the model end the call. Honoured on the voice channel.
  * @public
  */
 export interface AgentHangupCapability {
@@ -792,10 +728,10 @@ export interface AgentSnapshotSandboxOptions {
      */
     allowedDomains?: string[] | undefined;
     /**
-     * Override the number of vCPUs allocated. Defaults to the snapshot's resources.
+     * Override the compute size for this agent. Defaults to the snapshot's size.
      * @public
      */
-    vcpus?: number | undefined;
+    size?: SandboxSize | undefined;
 }
 /**
  * Vercel Sandbox configuration.
@@ -954,18 +890,23 @@ export interface AgentTool {
      * @public
      */
     id: string;
+    /**
+     * Pin a specific published tool version. When omitted, the tool's latestVersion is resolved at load, so a republished tool reaches this agent without a new agent version. Pin it when `fields` must keep aiming at an exact input schema.
+     * @public
+     */
+    toolVersion?: number | undefined;
     /**
      * Override the tool's description for this agent. When omitted, the tool's own description is used.
      * @public
      */
     description?: string | undefined;
     /**
-     * Per-field overrides on the tool input schema: pin fixed values (hidden from the model) or refine field descriptions. Fields not listed are filled by the model per the tool schema.
+     * Per-field overrides on the tool input schema: pin fixed values (hidden from the model) or refine field descriptions. Fields not listed are filled by the model per the tool schema. Paths are resolved against the input schema of the tool version in effect — pin `toolVersion` when they must not move.
      * @public
      */
     fields?: AgentToolField[] | undefined;
     /**
-     * Message spoken when the tool call starts. Honoured on the voice channel. Maps from the legacy wim-voicebots capability-tool `startMessage`.
+     * Message spoken when the tool call starts. Honoured on the voice channel.
      * @public
      */
     startMessage?: string | undefined;
@@ -975,7 +916,7 @@ export interface AgentTool {
      */
     pipeline?: AgentToolPipeline | undefined;
     /**
-     * When present, the tool requires inline approval from the session user before it runs. New feature; no legacy equivalent.
+     * When present, the tool requires inline approval from the session user before it runs.
      * @public
      */
     approval?: AgentToolApproval | undefined;
@@ -1022,7 +963,7 @@ export interface AgentTransferCapability {
     annotations?: AgentToolAnnotation[] | undefined;
 }
 /**
- * Let the model hold the call while it works (e.g. a lookup), keeping the caller on the line. Honoured on the voice channel. Maps from the wim-voicebots WAIT embedded tool.
+ * Let the model hold the call while it works (e.g. a lookup), keeping the caller on the line. Honoured on the voice channel.
  * @public
  */
 export interface AgentWaitCapability {
@@ -1312,7 +1253,7 @@ export declare namespace AgentCapability {
         $unknown?: never;
     }
     /**
-     * Let the model end the call. Honoured on the voice channel. Maps from the wim-voicebots HANGUP embedded tool.
+     * Let the model end the call. Honoured on the voice channel.
      * @public
      */
     interface HangupMember {
@@ -1332,7 +1273,7 @@ export declare namespace AgentCapability {
         $unknown?: never;
     }
     /**
-     * Let the model hold the call while it works (e.g. a lookup), keeping the caller on the line. Honoured on the voice channel. Maps from the wim-voicebots WAIT embedded tool.
+     * Let the model hold the call while it works (e.g. a lookup), keeping the caller on the line. Honoured on the voice channel.
      * @public
      */
     interface WaitMember {
@@ -1433,7 +1374,17 @@ export interface AgentAiEngine {
      */
     model?: string | undefined;
     /**
-     * Skills attached to this agent (progressive disclosure).
+     * IANA timezone the agent reasons about time in: it anchors the current date and time given to the model and how times are read from and written to tool arguments and replies. Shared by every channel the agent serves. Defaults to 'UTC'.
+     * @public
+     */
+    timeZone?: string | undefined;
+    /**
+     * Whether the agent can produce artifacts (wilma-artifacts): documents, code files, HTML pages or diagrams it writes and shares back during a session, on any channel it serves. When an artifact is created the channel runtime shares it company-wide by link, so every signed-in colleague can open it. Artifacts are company-internal: recipients on external transports (sms / whatsapp) or outside the company cannot open the links, so keep this disabled for customer-facing agents. Defaults to false.
+     * @public
+     */
+    artifacts?: boolean | undefined;
+    /**
+     * Skills attached to this agent (progressive disclosure). A skill may carry its own tools, which join this agent's toolset while that skill is active.
      * @public
      */
     skills?: AgentSkillReference[] | undefined;
@@ -1479,7 +1430,7 @@ export interface AgentWebhookEngine {
     timeout?: number | undefined;
 }
 /**
- * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
+ * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend.
  * @public
  */
 export type AgentEngine = AgentEngine.AiMember | AgentEngine.SqsMember | AgentEngine.WebhookMember | AgentEngine.$UnknownMember;
@@ -1543,7 +1494,7 @@ export declare namespace AgentEngine {
  */
 export interface AgentSettings {
     /**
-     * PBX group used for data ACL (e.g. Sales Intelligence lookups). Maps from the legacy wim-voicebots / xbees-users bot `groupId`.
+     * PBX group used for data ACL (e.g. Sales Intelligence lookups).
      * @public
      */
     pbxGroupId?: string | undefined;
@@ -1571,7 +1522,7 @@ export interface Agent {
      */
     channels: AgentChannels;
     /**
-     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
+     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend.
      * @public
      */
     engine: AgentEngine;
@@ -1626,10 +1577,10 @@ export interface Agent {
      */
     draftBaseVersion?: number | undefined;
     /**
-     * Named deployment configurations routing new sessions to published versions.
+     * How new sessions are split across published versions. Absent while the agent is still a draft.
      * @public
      */
-    deployments?: AgentDeployment[] | undefined;
+    deployment?: AgentDeploymentRoute[] | undefined;
 }
 /**
  * @public
@@ -1686,7 +1637,7 @@ export interface AgentDefinitionSnapshot {
      */
     channels: AgentChannels;
     /**
-     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
+     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend.
      * @public
      */
     engine: AgentEngine;
@@ -1816,11 +1767,6 @@ export interface AgentVersionInfo {
      * @public
      */
     publishedBy: Actor;
-    /**
-     * Names of the deployments currently routing traffic to this version.
-     * @public
-     */
-    deployments?: string[] | undefined;
 }
 /**
  * @public
@@ -1834,7 +1780,7 @@ export interface CompareAgentVersionsInput {
      */
     from?: number | undefined;
     /**
-     * Compare against the current draft instead of a published version.
+     * Use the current draft as the base instead of a published version.
      * @public
      */
     fromDraft?: boolean | undefined;
@@ -1844,7 +1790,7 @@ export interface CompareAgentVersionsInput {
      */
     to?: number | undefined;
     /**
-     * Compare against the current draft instead of a published version.
+     * Use the current draft as the target instead of a published version.
      * @public
      */
     toDraft?: boolean | undefined;
@@ -1878,7 +1824,7 @@ export interface CreateAgentInput {
      */
     channels: AgentChannels;
     /**
-     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
+     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend.
      * @public
      */
     engine: AgentEngine;
@@ -1931,31 +1877,6 @@ export interface CreateAgentApiKeyOutput {
      */
     secret: string;
 }
-/**
- * @public
- */
-export interface CreateAgentDeploymentInput {
-    company?: string | undefined;
-    agentId: string;
-    /**
-     * Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
-     * @public
-     */
-    name: string;
-    description?: string | undefined;
-    status: AgentDeploymentStatus;
-    routing: AgentDeploymentRoute[];
-}
-/**
- * @public
- */
-export interface CreateAgentDeploymentOutput {
-    /**
-     * Standard audit fields carried by every managed resource.
-     * @public
-     */
-    deployment: AgentDeployment;
-}
 /**
  * @public
  */
@@ -1981,23 +1902,6 @@ export interface DeleteAgentApiKeyInput {
  */
 export interface DeleteAgentApiKeyOutput {
 }
-/**
- * @public
- */
-export interface DeleteAgentDeploymentInput {
-    company?: string | undefined;
-    agentId: string;
-    /**
-     * Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
-     * @public
-     */
-    deploymentName: string;
-}
-/**
- * @public
- */
-export interface DeleteAgentDeploymentOutput {
-}
 /**
  * @public
  */
@@ -2021,21 +1925,16 @@ export interface GetAgentOutput {
 export interface GetAgentDeploymentInput {
     company?: string | undefined;
     agentId: string;
-    /**
-     * Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
-     * @public
-     */
-    deploymentName: string;
 }
 /**
  * @public
  */
 export interface GetAgentDeploymentOutput {
     /**
-     * Standard audit fields carried by every managed resource.
+     * Absent while the agent has no published version serving traffic.
      * @public
      */
-    deployment: AgentDeployment;
+    deployment?: AgentDeploymentRoute[] | undefined;
 }
 /**
  * @public
@@ -2068,19 +1967,6 @@ export interface ListAgentApiKeysInput {
 export interface ListAgentApiKeysOutput {
     keys: AgentApiKey[];
 }
-/**
- * @public
- */
-export interface ListAgentDeploymentsInput {
-    company?: string | undefined;
-    agentId: string;
-}
-/**
- * @public
- */
-export interface ListAgentDeploymentsOutput {
-    deployments: AgentDeployment[];
-}
 /**
  * @public
  */
@@ -2184,6 +2070,45 @@ export interface PublishAgentVersionInput {
 export interface PublishAgentVersionOutput {
     version: AgentVersion;
 }
+/**
+ * @public
+ */
+export interface PutAgentDeploymentInput {
+    company?: string | undefined;
+    agentId: string;
+    /**
+     * Weighted routing over distinct published versions. Percentages must sum to 100; a single entry at 100 serves one version to everyone.
+     * @public
+     */
+    deployment: AgentDeploymentRoute[];
+}
+/**
+ * @public
+ */
+export interface PutAgentDeploymentOutput {
+    /**
+     * Weighted routing over distinct published versions. Percentages must sum to 100; a single entry at 100 serves one version to everyone.
+     * @public
+     */
+    deployment: AgentDeploymentRoute[];
+}
+/**
+ * @public
+ */
+export interface ResetAgentDeploymentInput {
+    company?: string | undefined;
+    agentId: string;
+}
+/**
+ * @public
+ */
+export interface ResetAgentDeploymentOutput {
+    /**
+     * Weighted routing over distinct published versions. Percentages must sum to 100; a single entry at 100 serves one version to everyone.
+     * @public
+     */
+    deployment: AgentDeploymentRoute[];
+}
 /**
  * @public
  */
@@ -2234,7 +2159,7 @@ export interface UpdateAgentInput {
      */
     channels: AgentChannels;
     /**
-     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
+     * How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend.
      * @public
      */
     engine: AgentEngine;
@@ -2269,33 +2194,3 @@ export interface UpdateAgentOutput {
      */
     agent: Agent;
 }
-/**
- * @public
- */
-export interface UpdateAgentDeploymentInput {
-    company?: string | undefined;
-    agentId: string;
-    /**
-     * Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
-     * @public
-     */
-    deploymentName: string;
-    description?: string | undefined;
-    status: AgentDeploymentStatus;
-    routing: AgentDeploymentRoute[];
-    /**
-     * Deployment revision this update is based on (optimistic locking).
-     * @public
-     */
-    revision: number;
-}
-/**
- * @public
- */
-export interface UpdateAgentDeploymentOutput {
-    /**
-     * Standard audit fields carried by every managed resource.
-     * @public
-     */
-    deployment: AgentDeployment;
-}