@wildix/wilma-agents-client 1.0.1 → 1.0.2

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

@@ -0,0 +1,116 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateAgentDeploymentInput, CreateAgentDeploymentOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateAgentDeploymentCommand}.
+ */
+export interface CreateAgentDeploymentCommandInput extends CreateAgentDeploymentInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateAgentDeploymentCommand}.
+ */
+export interface CreateAgentDeploymentCommandOutput extends CreateAgentDeploymentOutput, __MetadataBearer {
+}
+declare const CreateAgentDeploymentCommand_base: {
+    new (input: CreateAgentDeploymentCommandInput): import("@smithy/core/client").CommandImpl<CreateAgentDeploymentCommandInput, CreateAgentDeploymentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateAgentDeploymentCommandInput): import("@smithy/core/client").CommandImpl<CreateAgentDeploymentCommandInput, CreateAgentDeploymentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Creates a named deployment routing new sessions to published agent versions. Route percentages must total 100.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaAgentsClient, CreateAgentDeploymentCommand } from "@wildix/wilma-agents-client"; // ES Modules import
+ * // const { WilmaAgentsClient, CreateAgentDeploymentCommand } = 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 = { // CreateAgentDeploymentInput
+ *   company: "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
+ *     },
+ *   ],
+ * };
+ * const command = new CreateAgentDeploymentCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateAgentDeploymentOutput
+ * //   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 CreateAgentDeploymentCommandInput - {@link CreateAgentDeploymentCommandInput}
+ * @returns {@link CreateAgentDeploymentCommandOutput}
+ * @see {@link CreateAgentDeploymentCommandInput} for command's `input` shape.
+ * @see {@link CreateAgentDeploymentCommandOutput} 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 AgentDeploymentNonUniqueNameException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link WilmaAgentsServiceException}
+ * <p>Base exception class for all service exceptions from WilmaAgents service.</p>
+ *
+ *
+ * @public
+ */
+export declare class CreateAgentDeploymentCommand extends CreateAgentDeploymentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateAgentDeploymentInput;
+            output: CreateAgentDeploymentOutput;
+        };
+        sdk: {
+            input: CreateAgentDeploymentCommandInput;
+            output: CreateAgentDeploymentCommandOutput;
+        };
+    };
+}

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

@@ -24,9 +24,7 @@ export interface DeleteAgentApiKeyCommandOutput extends DeleteAgentApiKeyOutput,
 declare const DeleteAgentApiKeyCommand_base: {
     new (input: DeleteAgentApiKeyCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentApiKeyCommandInput, DeleteAgentApiKeyCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     new (input: DeleteAgentApiKeyCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentApiKeyCommandInput, DeleteAgentApiKeyCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): {
-        [x: string]: unknown;
-    };
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
  * Revokes an API key.

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

@@ -24,12 +24,10 @@ export interface DeleteAgentCommandOutput extends DeleteAgentOutput, __MetadataB
 declare const DeleteAgentCommand_base: {
     new (input: DeleteAgentCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentCommandInput, DeleteAgentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     new (input: DeleteAgentCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentCommandInput, DeleteAgentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): {
-        [x: string]: unknown;
-    };
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * Deletes an agent, its versions, API keys and channel deployments.
+ * Deletes an agent, its draft, versions, deployments and API keys. Fails with AgentInUseException while the agent has active sessions or is referenced by other agents.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -54,6 +52,9 @@ declare const DeleteAgentCommand_base: {
  * @see {@link DeleteAgentCommandOutput} for command's `response` shape.
  * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
  *
+ * @throws {@link AgentInUseException} (client fault)
+ *  The agent cannot be deleted because it has active sessions or is referenced by other agents (delegation, handover or agent-call capabilities). Recent invocations can be inspected via the wilma-traces QueryUsage operation filtered by agent.id.
+ *
  * @throws {@link ValidationException} (client fault)
  *
  * @throws {@link WilmaAgentsServiceException}

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

@@ -0,0 +1,83 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DeleteAgentDeploymentInput, DeleteAgentDeploymentOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteAgentDeploymentCommand}.
+ */
+export interface DeleteAgentDeploymentCommandInput extends DeleteAgentDeploymentInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteAgentDeploymentCommand}.
+ */
+export interface DeleteAgentDeploymentCommandOutput extends DeleteAgentDeploymentOutput, __MetadataBearer {
+}
+declare const DeleteAgentDeploymentCommand_base: {
+    new (input: DeleteAgentDeploymentCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentDeploymentCommandInput, DeleteAgentDeploymentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: DeleteAgentDeploymentCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentDeploymentCommandInput, DeleteAgentDeploymentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Deletes a deployment that is not required as the 'production' deployment for an enabled channel and is not referenced by another agent.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaAgentsClient, DeleteAgentDeploymentCommand } from "@wildix/wilma-agents-client"; // ES Modules import
+ * // const { WilmaAgentsClient, DeleteAgentDeploymentCommand } = 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 = { // DeleteAgentDeploymentInput
+ *   company: "STRING_VALUE",
+ *   agentId: "STRING_VALUE", // required
+ *   deploymentName: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteAgentDeploymentCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteAgentDeploymentCommandInput - {@link DeleteAgentDeploymentCommandInput}
+ * @returns {@link DeleteAgentDeploymentCommandOutput}
+ * @see {@link DeleteAgentDeploymentCommandInput} for command's `input` shape.
+ * @see {@link DeleteAgentDeploymentCommandOutput} for command's `response` shape.
+ * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
+ *
+ * @throws {@link AgentNotFoundException} (client fault)
+ *
+ * @throws {@link AgentDeploymentNotFoundException} (client fault)
+ *
+ * @throws {@link AgentDeploymentInUseException} (client fault)
+ *  The deployment cannot be deleted because it is the agent's required 'production' deployment or is referenced by another agent capability.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link WilmaAgentsServiceException}
+ * <p>Base exception class for all service exceptions from WilmaAgents service.</p>
+ *
+ *
+ * @public
+ */
+export declare class DeleteAgentDeploymentCommand extends DeleteAgentDeploymentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteAgentDeploymentInput;
+            output: {};
+        };
+        sdk: {
+            input: DeleteAgentDeploymentCommandInput;
+            output: DeleteAgentDeploymentCommandOutput;
+        };
+    };
+}