@wildix/wilma-agents-client 1.0.1 → 1.0.2

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

@@ -0,0 +1,460 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { RestoreAgentVersionToDraftInput, RestoreAgentVersionToDraftOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RestoreAgentVersionToDraftCommand}.
+ */
+export interface RestoreAgentVersionToDraftCommandInput extends RestoreAgentVersionToDraftInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link RestoreAgentVersionToDraftCommand}.
+ */
+export interface RestoreAgentVersionToDraftCommandOutput extends RestoreAgentVersionToDraftOutput, __MetadataBearer {
+}
+declare const RestoreAgentVersionToDraftCommand_base: {
+    new (input: RestoreAgentVersionToDraftCommandInput): import("@smithy/core/client").CommandImpl<RestoreAgentVersionToDraftCommandInput, RestoreAgentVersionToDraftCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: RestoreAgentVersionToDraftCommandInput): import("@smithy/core/client").CommandImpl<RestoreAgentVersionToDraftCommandInput, RestoreAgentVersionToDraftCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Replaces the mutable draft with a published version's definition. The draft revision is incremented; published versions and deployments are unchanged.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaAgentsClient, RestoreAgentVersionToDraftCommand } from "@wildix/wilma-agents-client"; // ES Modules import
+ * // const { WilmaAgentsClient, RestoreAgentVersionToDraftCommand } = 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 = { // RestoreAgentVersionToDraftInput
+ *   company: "STRING_VALUE",
+ *   agentId: "STRING_VALUE", // required
+ *   version: "STRING_VALUE", // required
+ *   revision: Number("int"), // required
+ * };
+ * const command = new RestoreAgentVersionToDraftCommand(input);
+ * const response = await client.send(command);
+ * // { // RestoreAgentVersionToDraftOutput
+ * //   agent: { // Agent
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     category: "STRING_VALUE",
+ * //     picture: "STRING_VALUE",
+ * //     channels: { // AgentChannels
+ * //       voice: { // VoiceChannelSettings
+ * //         greeting: "STRING_VALUE",
+ * //         interruptions: { // VoiceInterruptionSettings
+ * //           enabled: true || false, // required
+ * //           minWords: Number("int"),
+ * //         },
+ * //         silenceTimeout: { // VoiceSilenceTimeoutSettings
+ * //           seconds: Number("int"), // required
+ * //           action: { // VoiceTerminateAction Union: only one key present
+ * //             hangup: { // VoiceTerminateHangupAction
+ * //               message: "STRING_VALUE",
+ * //             },
+ * //             transfer: { // VoiceTransferTarget
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               context: "STRING_VALUE", // required
+ * //               extension: "STRING_VALUE", // required
+ * //             },
+ * //           },
+ * //         },
+ * //         maxDuration: { // VoiceMaxDurationSettings
+ * //           seconds: Number("int"), // required
+ * //           action: {//  Union: only one key present
+ * //             hangup: {
+ * //               message: "STRING_VALUE",
+ * //             },
+ * //             transfer: {
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               context: "STRING_VALUE", // required
+ * //               extension: "STRING_VALUE", // required
+ * //             },
+ * //           },
+ * //         },
+ * //         endCall: { // VoiceEndCallSettings
+ * //           enabled: true || false, // required
+ * //           phrases: "STRING_VALUE",
+ * //         },
+ * //         callerMetadata: { // VoiceCallerMetadataSettings
+ * //           callerName: true || false,
+ * //           callerNumber: true || false,
+ * //           callerEmail: true || false,
+ * //           callerCompany: true || false,
+ * //           time: true || false,
+ * //           timeZone: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       chat: { // ChatChannelSettings
+ * //         discoverable: true || false,
+ * //       },
+ * //       assistant: { // AssistantChannelSettings
+ * //         default: true || false,
+ * //       },
+ * //       autonomous: {},
+ * //     },
+ * //     engine: { // AgentEngine Union: only one key present
+ * //       ai: { // AgentAiEngine
+ * //         instructions: "STRING_VALUE", // required
+ * //         model: "STRING_VALUE",
+ * //         skills: [ // AgentSkillsList
+ * //           { // AgentSkillReference
+ * //             id: "STRING_VALUE", // required
+ * //             skillVersion: "STRING_VALUE",
+ * //             access: { // AgentAccess
+ * //               visibility: "explicit" || "organization",
+ * //               grants: [ // AgentGrantPrincipalList
+ * //                 { // AgentGrantPrincipal Union: only one key present
+ * //                   userId: "STRING_VALUE",
+ * //                   groupId: "STRING_VALUE",
+ * //                 },
+ * //               ],
+ * //             },
+ * //           },
+ * //         ],
+ * //         capabilities: [ // AgentCapabilitiesList
+ * //           { // AgentCapability Union: only one key present
+ * //             tool: { // AgentTool
+ * //               id: "STRING_VALUE", // required
+ * //               variables: [ // AgentToolVariablesList
+ * //                 { // AgentToolVariable
+ * //                   name: "STRING_VALUE", // required
+ * //                   handler: { // AgentToolVariableHandler Union: only one key present
+ * //                     auto: {},
+ * //                     guided: { // AgentToolVariableGuidedHandler
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                     predefined: { // AgentToolVariablePredefinedHandler
+ * //                       value: "STRING_VALUE", // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
+ * //               startMessage: "STRING_VALUE",
+ * //               pipeline: { // AgentToolPipeline
+ * //                 type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
+ * //                 instructions: "STRING_VALUE",
+ * //               },
+ * //               approval: { // AgentToolApproval
+ * //                 prompt: "STRING_VALUE",
+ * //               },
+ * //               annotations: [ // AgentToolAnnotationsList
+ * //                 { // AgentToolAnnotation Union: only one key present
+ * //                   tag: { // AgentToolTagAnnotation
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: { // AgentToolCommentAnnotation
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
+ * //             },
+ * //             kb: { // AgentKnowledgeBase
+ * //               knowledgeBaseId: "STRING_VALUE",
+ * //               instructions: "STRING_VALUE",
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
+ * //             },
+ * //             sandbox: { // AgentSandboxCapability Union: only one key present
+ * //               vercel: { // AgentVercelSandboxOptions
+ * //                 vcpus: Number("int"),
+ * //                 network: "allow-all" || "deny-all" || "allowlist",
+ * //                 allowedDomains: [ // DomainNameList
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //               snapshot: { // AgentSnapshotSandboxOptions
+ * //                 snapshotId: "STRING_VALUE", // required
+ * //                 network: "allow-all" || "deny-all" || "allowlist",
+ * //                 allowedDomains: [
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //                 vcpus: Number("int"),
+ * //               },
+ * //             },
+ * //             webSearch: { // AgentWebSearchCapability
+ * //               contextSize: "low" || "medium" || "high",
+ * //               allowedDomains: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //               userLocation: { // WebSearchUserLocation
+ * //                 country: "STRING_VALUE",
+ * //                 region: "STRING_VALUE",
+ * //                 city: "STRING_VALUE",
+ * //                 timezone: "STRING_VALUE",
+ * //               },
+ * //             },
+ * //             webFetch: { // AgentWebFetchCapability
+ * //               allowedDomains: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //             },
+ * //             agent: { // AgentCallCapability
+ * //               agentId: "STRING_VALUE", // required
+ * //               agentVersion: "STRING_VALUE",
+ * //               agentDeployment: "STRING_VALUE",
+ * //               access: {
+ * //                 visibility: "explicit" || "organization",
+ * //                 grants: [
+ * //                   {//  Union: only one key present
+ * //                     userId: "STRING_VALUE",
+ * //                     groupId: "STRING_VALUE",
+ * //                   },
+ * //                 ],
+ * //               },
+ * //               variables: [
+ * //                 {
+ * //                   name: "STRING_VALUE", // required
+ * //                   handler: {//  Union: only one key present
+ * //                     auto: {},
+ * //                     guided: {
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                     predefined: {
+ * //                       value: "STRING_VALUE", // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
+ * //             },
+ * //             handover: { // AgentHandoverCapability
+ * //               name: "STRING_VALUE",
+ * //               description: "STRING_VALUE",
+ * //               variant: "agent" || "service",
+ * //               agent: "STRING_VALUE",
+ * //               agentVersion: "STRING_VALUE",
+ * //               agentDeployment: "STRING_VALUE",
+ * //               service: "STRING_VALUE",
+ * //               silent: true || false,
+ * //               pipeline: { // AgentHandoverPipeline
+ * //                 type: "handover" || "reply_and_handover" || "reply_instructed_and_handover",
+ * //                 instructions: "STRING_VALUE",
+ * //               },
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
+ * //             },
+ * //             delegation: { // AgentDelegationCapability
+ * //               name: "STRING_VALUE",
+ * //               description: "STRING_VALUE",
+ * //               id: "STRING_VALUE", // required
+ * //               agentVersion: "STRING_VALUE",
+ * //               agentDeployment: "STRING_VALUE",
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
+ * //             },
+ * //             transfer: { // AgentTransferCapability
+ * //               name: "STRING_VALUE",
+ * //               description: "STRING_VALUE",
+ * //               variant: "predefined" || "dynamic" || "directory",
+ * //               context: "STRING_VALUE",
+ * //               extension: "STRING_VALUE",
+ * //               pipeline: { // AgentTransferPipeline
+ * //                 type: "transfer" || "reply_and_transfer" || "reply_instructed_and_transfer",
+ * //                 instructions: "STRING_VALUE",
+ * //               },
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
+ * //             },
+ * //             suggestions: { // AgentSuggestionsCapability
+ * //               name: "STRING_VALUE",
+ * //               annotations: "<AgentToolAnnotationsList>",
+ * //             },
+ * //             hangup: { // AgentHangupCapability
+ * //               name: "STRING_VALUE",
+ * //               description: "STRING_VALUE",
+ * //               pipeline: { // AgentHangupPipeline
+ * //                 type: "hangup" || "reply_and_hangup" || "reply_instructed_and_hangup",
+ * //                 instructions: "STRING_VALUE",
+ * //               },
+ * //               annotations: "<AgentToolAnnotationsList>",
+ * //             },
+ * //             wait: { // AgentWaitCapability
+ * //               name: "STRING_VALUE",
+ * //               description: "STRING_VALUE",
+ * //               message: "STRING_VALUE",
+ * //               annotations: "<AgentToolAnnotationsList>",
+ * //             },
+ * //           },
+ * //         ],
+ * //         variables: [ // AgentVariablesList
+ * //           { // AgentVariable
+ * //             name: "STRING_VALUE", // required
+ * //             type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
+ * //             optional: true || false, // required
+ * //             description: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //       webhook: { // AgentWebhookEngine
+ * //         url: "STRING_VALUE", // required
+ * //         secret: "STRING_VALUE", // required
+ * //         timeout: Number("int"),
+ * //       },
+ * //       sqs: { // AgentSqsEngine
+ * //         url: "STRING_VALUE", // required
+ * //         key: "STRING_VALUE", // required
+ * //         secret: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     settings: { // AgentSettings
+ * //       pbxGroupId: "STRING_VALUE",
+ * //     },
+ * //     access: "<AgentAccess>",
+ * //     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",
+ * //     },
+ * //     id: "STRING_VALUE", // required
+ * //     status: "draft" || "active", // required
+ * //     revision: Number("int"), // required
+ * //     latestVersion: "STRING_VALUE",
+ * //     draftBaseVersion: "STRING_VALUE",
+ * //     deployments: [ // AgentDeploymentsList
+ * //       { // AgentDeployment
+ * //         createdAt: "STRING_VALUE", // required
+ * //         createdBy: {
+ * //           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 RestoreAgentVersionToDraftCommandInput - {@link RestoreAgentVersionToDraftCommandInput}
+ * @returns {@link RestoreAgentVersionToDraftCommandOutput}
+ * @see {@link RestoreAgentVersionToDraftCommandInput} for command's `input` shape.
+ * @see {@link RestoreAgentVersionToDraftCommandOutput} 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 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 RestoreAgentVersionToDraftCommand extends RestoreAgentVersionToDraftCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RestoreAgentVersionToDraftInput;
+            output: RestoreAgentVersionToDraftOutput;
+        };
+        sdk: {
+            input: RestoreAgentVersionToDraftCommandInput;
+            output: RestoreAgentVersionToDraftCommandOutput;
+        };
+    };
+}