@wildix/wilma-agents-client 1.0.1

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

@@ -0,0 +1,386 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetAgentInput, GetAgentOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetAgentCommand}.
+ */
+export interface GetAgentCommandInput extends GetAgentInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetAgentCommand}.
+ */
+export interface GetAgentCommandOutput extends GetAgentOutput, __MetadataBearer {
+}
+declare const GetAgentCommand_base: {
+    new (input: GetAgentCommandInput): import("@smithy/core/client").CommandImpl<GetAgentCommandInput, GetAgentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetAgentCommandInput): import("@smithy/core/client").CommandImpl<GetAgentCommandInput, GetAgentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * Retrieves an agent, including its draft definition and version/rollout state.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaAgentsClient, GetAgentCommand } from "@wildix/wilma-agents-client"; // ES Modules import
+ * // const { WilmaAgentsClient, GetAgentCommand } = 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 = { // GetAgentInput
+ *   company: "STRING_VALUE",
+ *   agentId: "STRING_VALUE", // required
+ * };
+ * const command = new GetAgentCommand(input);
+ * const response = await client.send(command);
+ * // { // GetAgentOutput
+ * //   agent: { // Agent
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     category: "STRING_VALUE",
+ * //     picture: "STRING_VALUE",
+ * //     engine: { // AgentEngine Union: only one key present
+ * //       llm: { // AgentLlmEngine
+ * //         instructions: "STRING_VALUE", // required
+ * //         model: "STRING_VALUE",
+ * //         skills: [ // AgentSkillsList
+ * //           "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
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
+ * //             },
+ * //             function: { // AgentFunctionTool
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               parameters: "DOCUMENT_VALUE",
+ * //               integration: { // FunctionIntegration Union: only one key present
+ * //                 webhook: { // FunctionWebhookIntegration
+ * //                   url: "STRING_VALUE", // required
+ * //                   method: "get" || "post" || "put" || "delete" || "patch",
+ * //                   async: true || false,
+ * //                   authorization: { // WebhookAuthorization Union: only one key present
+ * //                     bearer: { // WebhookAuthorizationBearer
+ * //                       token: "STRING_VALUE", // required
+ * //                     },
+ * //                     basic: { // WebhookAuthorizationBasic
+ * //                       username: "STRING_VALUE", // required
+ * //                       password: "STRING_VALUE", // required
+ * //                     },
+ * //                     oauth: { // WebhookAuthorizationOAuth
+ * //                       clientId: "STRING_VALUE", // required
+ * //                       clientSecret: "STRING_VALUE", // required
+ * //                       endpointUrl: "STRING_VALUE", // required
+ * //                       scope: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                   headers: [ // WebhookHeadersList
+ * //                     { // WebhookHeader
+ * //                       name: "STRING_VALUE", // required
+ * //                       value: "STRING_VALUE", // required
+ * //                     },
+ * //                   ],
+ * //                   timeout: Number("int"),
+ * //                   parameters: "DOCUMENT_VALUE",
+ * //                 },
+ * //               },
+ * //             },
+ * //             kb: { // AgentKnowledgeBase
+ * //               knowledgeBaseId: "STRING_VALUE",
+ * //               instructions: "STRING_VALUE",
+ * //             },
+ * //             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
+ * //               variables: [
+ * //                 {
+ * //                   name: "STRING_VALUE", // required
+ * //                   handler: {//  Union: only one key present
+ * //                     auto: {},
+ * //                     guided: {
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                     predefined: {
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
+ * //             },
+ * //             mcp: { // AgentMcpServerCapability
+ * //               url: "STRING_VALUE", // required
+ * //               authorization: {//  Union: only one key present
+ * //                 bearer: {
+ * //                   token: "STRING_VALUE", // required
+ * //                 },
+ * //                 basic: {
+ * //                   username: "STRING_VALUE", // required
+ * //                   password: "STRING_VALUE", // required
+ * //                 },
+ * //                 oauth: {
+ * //                   clientId: "STRING_VALUE", // required
+ * //                   clientSecret: "STRING_VALUE", // required
+ * //                   endpointUrl: "STRING_VALUE", // required
+ * //                   scope: "STRING_VALUE",
+ * //                 },
+ * //               },
+ * //               allowedTools: [ // FunctionNameList
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //             },
+ * //             handover: { // AgentHandoverCapability
+ * //               instructions: "STRING_VALUE",
+ * //               message: "STRING_VALUE",
+ * //             },
+ * //             delegation: { // AgentDelegationCapability
+ * //               agents: [ // AgentIdList
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //               instructions: "STRING_VALUE",
+ * //             },
+ * //             transfer: { // AgentTransferCapability
+ * //               targets: [ // VoiceTransferTargetsList // required
+ * //                 { // VoiceTransferTarget
+ * //                   name: "STRING_VALUE", // required
+ * //                   description: "STRING_VALUE",
+ * //                   context: "STRING_VALUE", // required
+ * //                   extension: "STRING_VALUE", // required
+ * //                 },
+ * //               ],
+ * //               instructions: "STRING_VALUE",
+ * //             },
+ * //             suggestions: {},
+ * //           },
+ * //         ],
+ * //         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
+ * //       },
+ * //     },
+ * //     channels: { // AgentChannels
+ * //       assistant: { // AssistantChannelSettings
+ * //         enabled: true || false, // required
+ * //         default: true || false,
+ * //       },
+ * //       chat: { // ChatChannelSettings
+ * //         enabled: true || false, // required
+ * //         discoverable: true || false,
+ * //         pbxGroupId: "STRING_VALUE",
+ * //         welcomeMessage: "STRING_VALUE",
+ * //       },
+ * //       voice: { // VoiceChannelSettings
+ * //         enabled: true || false, // required
+ * //         language: "STRING_VALUE", // required
+ * //         synthesis: { // VoiceSynthesisSettings
+ * //           provider: "elevenlabs" || "google", // required
+ * //           voiceId: "STRING_VALUE", // required
+ * //           speed: Number("float"),
+ * //         },
+ * //         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: {
+ * //               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",
+ * //         },
+ * //       },
+ * //       api: { // ApiChannelSettings
+ * //         enabled: true || false, // required
+ * //       },
+ * //     },
+ * //     guardrails: [ // GuardrailIdList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     access: { // AgentAccess
+ * //       visibility: "explicit" || "organization",
+ * //       grants: [ // AgentGrantList
+ * //         { // AgentGrant
+ * //           permission: "view" || "edit" || "use", // required
+ * //           principal: { // AgentGrantPrincipal Union: only one key present
+ * //             userId: "STRING_VALUE",
+ * //             groupId: "STRING_VALUE",
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //     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" || "archived", // required
+ * //     revision: Number("int"), // required
+ * //     latestVersion: Number("int"),
+ * //     aliases: [ // AgentAliasesList
+ * //       { // AgentAlias
+ * //         name: "STRING_VALUE", // required
+ * //         agentId: "STRING_VALUE", // required
+ * //         description: "STRING_VALUE",
+ * //         routing: [ // AgentAliasRoutesList // required
+ * //           { // AgentAliasRoute
+ * //             version: Number("int"), // required
+ * //             weight: Number("int"), // required
+ * //           },
+ * //         ],
+ * //         updatedAt: "STRING_VALUE", // required
+ * //         updatedBy: {
+ * //           type: "user" || "api_key" || "service", // required
+ * //           id: "STRING_VALUE", // required
+ * //           name: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetAgentCommandInput - {@link GetAgentCommandInput}
+ * @returns {@link GetAgentCommandOutput}
+ * @see {@link GetAgentCommandInput} for command's `input` shape.
+ * @see {@link GetAgentCommandOutput} for command's `response` shape.
+ * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
+ *
+ * @throws {@link AgentNotFoundException} (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 GetAgentCommand extends GetAgentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetAgentInput;
+            output: GetAgentOutput;
+        };
+        sdk: {
+            input: GetAgentCommandInput;
+            output: GetAgentCommandOutput;
+        };
+    };
+}