@wildix/wilma-agents-client 1.0.1 → 1.0.2

package/dist-types/commands/UpdateAgentDeploymentCommand.d.ts

@@ -0,0 +1,120 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateAgentDeploymentInput, UpdateAgentDeploymentOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAgentDeploymentCommand}.
+ */
+export interface UpdateAgentDeploymentCommandInput extends UpdateAgentDeploymentInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAgentDeploymentCommand}.
+ */
+export interface UpdateAgentDeploymentCommandOutput extends UpdateAgentDeploymentOutput, __MetadataBearer {
+}
+declare const UpdateAgentDeploymentCommand_base: {
+    new (input: UpdateAgentDeploymentCommandInput): import("@smithy/core/client").CommandImpl<UpdateAgentDeploymentCommandInput, UpdateAgentDeploymentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateAgentDeploymentCommandInput): import("@smithy/core/client").CommandImpl<UpdateAgentDeploymentCommandInput, UpdateAgentDeploymentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Atomically updates deployment status or traffic allocation for new sessions. Existing sessions remain pinned to their resolved version.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaAgentsClient, UpdateAgentDeploymentCommand } from "@wildix/wilma-agents-client"; // ES Modules import
+ * // const { WilmaAgentsClient, UpdateAgentDeploymentCommand } = require("@wildix/wilma-agents-client"); // CommonJS import
+ * // import type { WilmaAgentsClientConfig } from "@wildix/wilma-agents-client";
+ * const config = {}; // type is WilmaAgentsClientConfig
+ * const client = new WilmaAgentsClient(config);
+ * const input = { // UpdateAgentDeploymentInput
+ *   company: "STRING_VALUE",
+ *   agentId: "STRING_VALUE", // required
+ *   deploymentName: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   status: "active" || "paused", // required
+ *   routing: [ // AgentDeploymentRoutesList // required
+ *     { // AgentDeploymentRoute
+ *       version: "STRING_VALUE", // required
+ *       percentage: Number("int"), // required
+ *     },
+ *   ],
+ *   revision: Number("int"), // required
+ * };
+ * const command = new UpdateAgentDeploymentCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateAgentDeploymentOutput
+ * //   deployment: { // AgentDeployment
+ * //     createdAt: "STRING_VALUE", // required
+ * //     createdBy: { // Actor
+ * //       type: "user" || "api_key" || "service", // required
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //     },
+ * //     updatedAt: "STRING_VALUE",
+ * //     updatedBy: {
+ * //       type: "user" || "api_key" || "service", // required
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //     },
+ * //     agentId: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     status: "active" || "paused", // required
+ * //     routing: [ // AgentDeploymentRoutesList // required
+ * //       { // AgentDeploymentRoute
+ * //         version: "STRING_VALUE", // required
+ * //         percentage: Number("int"), // required
+ * //       },
+ * //     ],
+ * //     revision: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateAgentDeploymentCommandInput - {@link UpdateAgentDeploymentCommandInput}
+ * @returns {@link UpdateAgentDeploymentCommandOutput}
+ * @see {@link UpdateAgentDeploymentCommandInput} for command's `input` shape.
+ * @see {@link UpdateAgentDeploymentCommandOutput} for command's `response` shape.
+ * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
+ *
+ * @throws {@link AgentNotFoundException} (client fault)
+ *
+ * @throws {@link AgentVersionNotFoundException} (client fault)
+ *
+ * @throws {@link AgentDeploymentNotFoundException} (client fault)
+ *
+ * @throws {@link RevisionConflictException} (client fault)
+ *  The resource was modified concurrently; re-read it and retry with the latest revision.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link WilmaAgentsServiceException}
+ * <p>Base exception class for all service exceptions from WilmaAgents service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateAgentDeploymentCommand extends UpdateAgentDeploymentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateAgentDeploymentInput;
+            output: UpdateAgentDeploymentOutput;
+        };
+        sdk: {
+            input: UpdateAgentDeploymentCommandInput;
+            output: UpdateAgentDeploymentCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,23 +1,19 @@
 export * from "./CompareAgentVersionsCommand";
 export * from "./CreateAgentApiKeyCommand";
 export * from "./CreateAgentCommand";
-export * from "./CreateGuardrailCommand";
-export * from "./DeleteAgentAliasCommand";
+export * from "./CreateAgentDeploymentCommand";
 export * from "./DeleteAgentApiKeyCommand";
 export * from "./DeleteAgentCommand";
-export * from "./DeleteGuardrailCommand";
-export * from "./ExecuteAgentCommand";
+export * from "./DeleteAgentDeploymentCommand";
 export * from "./GetAgentCommand";
+export * from "./GetAgentDeploymentCommand";
 export * from "./GetAgentVersionCommand";
-export * from "./GetGuardrailCommand";
-export * from "./ListAgentAliasesCommand";
 export * from "./ListAgentApiKeysCommand";
+export * from "./ListAgentDeploymentsCommand";
 export * from "./ListAgentVersionsCommand";
 export * from "./ListAgentsCommand";
 export * from "./ListAgentsNamesCommand";
-export * from "./ListAuditRecordsCommand";
-export * from "./ListGuardrailsCommand";
 export * from "./PublishAgentVersionCommand";
-export * from "./PutAgentAliasCommand";
+export * from "./RestoreAgentVersionToDraftCommand";
 export * from "./UpdateAgentCommand";
-export * from "./UpdateGuardrailCommand";
+export * from "./UpdateAgentDeploymentCommand";

package/dist-types/index.d.ts

@@ -1,11 +1,12 @@
 /**
- * Unified agent platform. A single agent configuration is deployed to multiple channels
- *     (in-app assistant, chat conversations, voice calls, API) while keeping channel-specific
- *     settings. Successor of the agent/bot configuration APIs of wim-wilma, xbees-users bots
- *     and wim-voicebots. Covers the agent lifecycle: draft editing, immutable versions with
- *     alias-based routing (rollback, canary), guardrail policies, API keys and a company-wide
- *     audit trail. Durable runtime sessions live in the companion wilma-sessions service and
- *     skills in wilma-skills. Evaluations live in wilma-evaluations; observability in
+ * Unified agent platform. Each agent has a single type (voice, chat, assistant or
+ *     autonomous) carrying the matching channel settings; autonomous agents have no
+ *     delivery channel and are invoked by other agents or as automation triggers.
+ *     Successor of the agent/bot configuration APIs of wim-wilma, xbees-users bots
+ *     and wim-voicebots. Covers the agent lifecycle: draft editing, immutable versions,
+ *     deployment traffic routing (rollback, canary) and API keys. Durable runtime sessions live in
+ *     the companion wilma-sessions service and skills in wilma-skills. The company-wide
+ *     audit trail lives in wilma-audit; evaluations in wilma-evaluations; observability in
  *     wilma-traces; analytics in wilma-analytics.
  *
  * @packageDocumentation

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

@@ -1,35 +1,15 @@
-/**
- * @public
- * @enum
- */
-export declare const ActorType: {
-    readonly API_KEY: "api_key";
-    readonly SERVICE: "service";
-    readonly USER: "user";
-};
-/**
- * @public
- */
-export type ActorType = (typeof ActorType)[keyof typeof ActorType];
-/**
- * @public
- * @enum
- */
-export declare const AgentGrantPermission: {
-    readonly EDIT: "edit";
-    readonly USE: "use";
-    readonly VIEW: "view";
-};
-/**
- * @public
- */
-export type AgentGrantPermission = (typeof AgentGrantPermission)[keyof typeof AgentGrantPermission];
 /**
  * @public
  * @enum
  */
 export declare const AgentVisibility: {
+    /**
+     * Only the users and groups listed in `grants` can use the agent.
+     */
     readonly EXPLICIT: "explicit";
+    /**
+     * Everyone in the organization can use the agent.
+     */
     readonly ORGANIZATION: "organization";
 };
 /**
@@ -40,262 +20,247 @@ export type AgentVisibility = (typeof AgentVisibility)[keyof typeof AgentVisibil
  * @public
  * @enum
  */
-export declare const SpeechProvider: {
-    readonly ELEVENLABS: "elevenlabs";
-    readonly GOOGLE: "google";
-};
-/**
- * @public
- */
-export type SpeechProvider = (typeof SpeechProvider)[keyof typeof SpeechProvider];
-/**
- * @public
- * @enum
- */
-export declare const WebhookMethod: {
-    readonly DELETE: "delete";
-    readonly GET: "get";
-    readonly PATCH: "patch";
-    readonly POST: "post";
-    readonly PUT: "put";
+export declare const ActorType: {
+    readonly API_KEY: "api_key";
+    readonly SERVICE: "service";
+    readonly USER: "user";
 };
 /**
  * @public
  */
-export type WebhookMethod = (typeof WebhookMethod)[keyof typeof WebhookMethod];
+export type ActorType = (typeof ActorType)[keyof typeof ActorType];
 /**
  * @public
  * @enum
  */
-export declare const SandboxNetworkAccess: {
-    readonly ALL: "allow-all";
-    readonly ALLOWLIST: "allowlist";
-    readonly NONE: "deny-all";
+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 SandboxNetworkAccess = (typeof SandboxNetworkAccess)[keyof typeof SandboxNetworkAccess];
+export type AgentDeploymentStatus = (typeof AgentDeploymentStatus)[keyof typeof AgentDeploymentStatus];
 /**
  * @public
  * @enum
  */
-export declare const WebSearchContextSize: {
-    readonly HIGH: "high";
-    readonly LOW: "low";
-    readonly MEDIUM: "medium";
+export declare const AgentHandoverPipelineType: {
+    /**
+     * Hand over immediately without a model reply.
+     */
+    readonly HANDOVER: "handover";
+    /**
+     * Reply to the user, then hand over.
+     */
+    readonly REPLY_AND_HANDOVER: "reply_and_handover";
+    /**
+     * Reply using pipeline instructions, then hand over.
+     */
+    readonly REPLY_INSTRUCTED_AND_HANDOVER: "reply_instructed_and_handover";
 };
 /**
  * @public
  */
-export type WebSearchContextSize = (typeof WebSearchContextSize)[keyof typeof WebSearchContextSize];
+export type AgentHandoverPipelineType = (typeof AgentHandoverPipelineType)[keyof typeof AgentHandoverPipelineType];
 /**
  * @public
  * @enum
  */
-export declare const AgentVariableType: {
-    readonly BOOLEAN: "boolean";
-    readonly NUMBER: "number";
-    readonly NUMBER_ARRAY: "number_array";
-    readonly STRING: "string";
-    readonly STRING_ARRAY: "string_array";
+export declare const AgentHandoverVariant: {
+    /**
+     * Hand over to another Wilma agent.
+     */
+    readonly AGENT: "agent";
+    /**
+     * Hand over to an x-bees service desk.
+     */
+    readonly SERVICE: "service";
 };
 /**
  * @public
  */
-export type AgentVariableType = (typeof AgentVariableType)[keyof typeof AgentVariableType];
+export type AgentHandoverVariant = (typeof AgentHandoverVariant)[keyof typeof AgentHandoverVariant];
 /**
  * @public
  * @enum
  */
-export declare const AgentStatus: {
+export declare const AgentHangupPipelineType: {
     /**
-     * Has at least one published version.
+     * Hang up immediately without a model reply.
      */
-    readonly ACTIVE: "active";
+    readonly HANGUP: "hangup";
     /**
-     * Kept for history; not serving any traffic.
+     * Reply to the caller, then hang up.
      */
-    readonly ARCHIVED: "archived";
+    readonly REPLY_AND_HANGUP: "reply_and_hangup";
     /**
-     * Being edited; never published yet.
+     * Reply using pipeline instructions, then hang up.
      */
-    readonly DRAFT: "draft";
+    readonly REPLY_INSTRUCTED_AND_HANGUP: "reply_instructed_and_hangup";
 };
 /**
  * @public
  */
-export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
+export type AgentHangupPipelineType = (typeof AgentHangupPipelineType)[keyof typeof AgentHangupPipelineType];
 /**
  * @public
  * @enum
  */
-export declare const AgentFileScope: {
-    /**
-     * Shared to other agents only (not surfaced to the end user).
-     */
-    readonly AGENT: "agent";
-    /**
-     * Visible and downloadable by the end user.
-     */
-    readonly USER: "user";
+export declare const SandboxNetworkAccess: {
+    readonly ALL: "allow-all";
+    readonly ALLOWLIST: "allowlist";
+    readonly NONE: "deny-all";
 };
 /**
  * @public
  */
-export type AgentFileScope = (typeof AgentFileScope)[keyof typeof AgentFileScope];
+export type SandboxNetworkAccess = (typeof SandboxNetworkAccess)[keyof typeof SandboxNetworkAccess];
 /**
  * @public
  * @enum
  */
-export declare const ChannelType: {
+export declare const AgentToolPipelineType: {
     /**
-     * Programmatic execution over the API.
+     * Fire-and-forget; do not synthesize a reply.
      */
-    readonly API: "api";
+    readonly ASYNC_REQUEST: "async_request";
     /**
-     * In-app assistant (x-bees / x-hoppers / Collaboration).
+     * Fire-and-forget; synthesize a reply using `instructions`.
      */
-    readonly ASSISTANT: "assistant";
+    readonly ASYNC_REQUEST_GUIDED: "async_request_guided";
     /**
-     * Bot member of chat conversations.
+     * Wait for the tool; do not synthesize a reply from its result.
      */
-    readonly CHAT: "chat";
+    readonly BLOCKING_REQUEST: "blocking_request";
     /**
-     * Voice calls on the PBX.
+     * Wait for the tool; synthesize a reply from its result using `instructions`.
      */
-    readonly VOICE: "voice";
+    readonly BLOCKING_REQUEST_GUIDED: "blocking_request_guided";
 };
 /**
  * @public
  */
-export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];
+export type AgentToolPipelineType = (typeof AgentToolPipelineType)[keyof typeof AgentToolPipelineType];
 /**
  * @public
  * @enum
  */
-export declare const AuditAction: {
-    readonly ALIAS_DELETED: "alias_deleted";
-    readonly ALIAS_UPDATED: "alias_updated";
-    readonly API_KEY_CREATED: "api_key_created";
-    readonly API_KEY_DELETED: "api_key_deleted";
-    readonly ARCHIVED: "archived";
-    readonly CREATED: "created";
-    readonly DELETED: "deleted";
-    readonly EVALUATION_CANCELLED: "evaluation_cancelled";
-    readonly EVALUATION_STARTED: "evaluation_started";
-    readonly PUBLISHED: "published";
-    readonly UPDATED: "updated";
+export declare const AgentTransferPipelineType: {
+    /**
+     * Reply to the caller, then transfer.
+     */
+    readonly REPLY_AND_TRANSFER: "reply_and_transfer";
+    /**
+     * Reply using pipeline instructions, then transfer.
+     */
+    readonly REPLY_INSTRUCTED_AND_TRANSFER: "reply_instructed_and_transfer";
+    /**
+     * Transfer immediately without a model reply.
+     */
+    readonly TRANSFER: "transfer";
 };
 /**
  * @public
  */
-export type AuditAction = (typeof AuditAction)[keyof typeof AuditAction];
+export type AgentTransferPipelineType = (typeof AgentTransferPipelineType)[keyof typeof AgentTransferPipelineType];
 /**
  * @public
  * @enum
  */
-export declare const AuditResourceType: {
-    readonly AGENT: "agent";
-    readonly AGENT_ALIAS: "agent_alias";
-    readonly AGENT_API_KEY: "agent_api_key";
-    readonly AGENT_VERSION: "agent_version";
-    readonly DATASET: "dataset";
-    readonly EVALUATION: "evaluation";
-    readonly EVALUATOR: "evaluator";
-    readonly GUARDRAIL: "guardrail";
-    readonly SKILL: "skill";
-    readonly TEST_CASE: "test_case";
+export declare const AgentTransferVariant: {
+    /**
+     * Resolve the transfer target from the PBX directory using caller speech.
+     */
+    readonly DIRECTORY: "directory";
+    /**
+     * Transfer to an extension chosen by the model at runtime.
+     */
+    readonly DYNAMIC: "dynamic";
+    /**
+     * Transfer to a fixed PBX destination (context + extension).
+     */
+    readonly PREDEFINED: "predefined";
 };
 /**
  * @public
  */
-export type AuditResourceType = (typeof AuditResourceType)[keyof typeof AuditResourceType];
+export type AgentTransferVariant = (typeof AgentTransferVariant)[keyof typeof AgentTransferVariant];
 /**
  * @public
  * @enum
  */
-export declare const GuardrailContentCategory: {
-    readonly HATE: "hate";
-    readonly INSULTS: "insults";
-    readonly MISCONDUCT: "misconduct";
-    readonly PROMPT_ATTACK: "prompt_attack";
-    readonly SEXUAL: "sexual";
-    readonly VIOLENCE: "violence";
+export declare const WebSearchContextSize: {
+    readonly HIGH: "high";
+    readonly LOW: "low";
+    readonly MEDIUM: "medium";
 };
 /**
  * @public
  */
-export type GuardrailContentCategory = (typeof GuardrailContentCategory)[keyof typeof GuardrailContentCategory];
+export type WebSearchContextSize = (typeof WebSearchContextSize)[keyof typeof WebSearchContextSize];
 /**
  * @public
  * @enum
  */
-export declare const GuardrailFilterStrength: {
-    readonly HIGH: "high";
-    readonly LOW: "low";
-    readonly MEDIUM: "medium";
-    readonly NONE: "none";
+export declare const AgentVariableType: {
+    readonly BOOLEAN: "boolean";
+    readonly NUMBER: "number";
+    readonly NUMBER_ARRAY: "number_array";
+    readonly STRING: "string";
+    readonly STRING_ARRAY: "string_array";
 };
 /**
  * @public
  */
-export type GuardrailFilterStrength = (typeof GuardrailFilterStrength)[keyof typeof GuardrailFilterStrength];
+export type AgentVariableType = (typeof AgentVariableType)[keyof typeof AgentVariableType];
 /**
  * @public
  * @enum
  */
-export declare const GuardrailPiiAction: {
+export declare const AgentStatus: {
     /**
-     * Replace the entity with a placeholder, e.g. {EMAIL}.
+     * Has at least one published version.
      */
-    readonly ANONYMIZE: "anonymize";
+    readonly ACTIVE: "active";
     /**
-     * Block the message entirely.
+     * Being edited; never published yet.
      */
-    readonly BLOCK: "block";
+    readonly DRAFT: "draft";
 };
 /**
  * @public
  */
-export type GuardrailPiiAction = (typeof GuardrailPiiAction)[keyof typeof GuardrailPiiAction];
+export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
 /**
  * @public
  * @enum
  */
-export declare const GuardrailPiiEntityType: {
-    readonly ADDRESS: "address";
-    readonly CREDIT_CARD: "credit_card";
+export declare const ChannelType: {
     /**
-     * Custom entity matched by the regex in `pattern`.
+     * In-app assistant (x-bees / x-hoppers / Collaboration).
      */
-    readonly CUSTOM: "custom";
-    readonly EMAIL: "email";
-    readonly IBAN: "iban";
-    readonly NAME: "name";
-    readonly NATIONAL_ID: "national_id";
-    readonly PASSWORD: "password";
-    readonly PHONE_NUMBER: "phone_number";
-};
-/**
- * @public
- */
-export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
-/**
- * @public
- * @enum
- */
-export declare const GuardrailAction: {
+    readonly ASSISTANT: "assistant";
     /**
-     * Block the message and answer with the configured blocked message.
+     * No delivery channel: invoked by other agents (call / delegation / handover) or as an automation trigger, and runnable over the API.
      */
-    readonly BLOCK: "block";
+    readonly AUTONOMOUS: "autonomous";
     /**
-     * Record the violation in the trace but let the message through.
+     * Bot member of chat conversations.
      */
-    readonly DETECT: "detect";
+    readonly CHAT: "chat";
+    /**
+     * Voice calls on the PBX.
+     */
+    readonly VOICE: "voice";
 };
 /**
  * @public
  */
-export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction];
+export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];