@wildix/wilma-copilot-client 1.0.2

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

@@ -0,0 +1,176 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateAutomationInput, CreateAutomationOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaCopilotClientResolvedConfig } from "../WilmaCopilotClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateAutomationCommand}.
+ */
+export interface CreateAutomationCommandInput extends CreateAutomationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateAutomationCommand}.
+ */
+export interface CreateAutomationCommandOutput extends CreateAutomationOutput, __MetadataBearer {
+}
+declare const CreateAutomationCommand_base: {
+    new (input: CreateAutomationCommandInput): import("@smithy/core/client").CommandImpl<CreateAutomationCommandInput, CreateAutomationCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateAutomationCommandInput): import("@smithy/core/client").CommandImpl<CreateAutomationCommandInput, CreateAutomationCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Creates a new reusable automation.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaCopilotClient, CreateAutomationCommand } from "@wildix/wilma-copilot-client"; // ES Modules import
+ * // const { WilmaCopilotClient, CreateAutomationCommand } = require("@wildix/wilma-copilot-client"); // CommonJS import
+ * // import type { WilmaCopilotClientConfig } from "@wildix/wilma-copilot-client";
+ * const config = {}; // type is WilmaCopilotClientConfig
+ * const client = new WilmaCopilotClient(config);
+ * const input = { // CreateAutomationInput
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   handler: { // AutomationHandler Union: only one key present
+ *     agent: { // AgentAutomationHandler
+ *       agentId: "STRING_VALUE", // required
+ *       prompt: "STRING_VALUE",
+ *       outputMode: "card" || "silent",
+ *       parameters: [ // CopilotVariableBindingsList
+ *         { // CopilotVariableBinding
+ *           name: "STRING_VALUE", // required
+ *           type: "STRING_VALUE",
+ *           optional: true || false,
+ *           variant: "auto" || "guided" || "predefined", // required
+ *           description: "STRING_VALUE",
+ *           value: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *     tool: { // ToolAutomationHandler
+ *       toolId: "STRING_VALUE",
+ *       toolName: "STRING_VALUE", // required
+ *       action: "STRING_VALUE",
+ *       payloadTemplate: "STRING_VALUE",
+ *       outputMode: "card" || "silent",
+ *       parameters: [
+ *         {
+ *           name: "STRING_VALUE", // required
+ *           type: "STRING_VALUE",
+ *           optional: true || false,
+ *           variant: "auto" || "guided" || "predefined", // required
+ *           description: "STRING_VALUE",
+ *           value: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *     knowledgeBase: { // KnowledgeBaseAutomationHandler
+ *       knowledgeBaseId: "STRING_VALUE", // required
+ *     },
+ *   },
+ *   conditions: "DOCUMENT_VALUE",
+ *   company: "STRING_VALUE",
+ * };
+ * const command = new CreateAutomationCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateAutomationOutput
+ * //   automation: { // Automation
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     handler: { // AutomationHandler Union: only one key present
+ * //       agent: { // AgentAutomationHandler
+ * //         agentId: "STRING_VALUE", // required
+ * //         prompt: "STRING_VALUE",
+ * //         outputMode: "card" || "silent",
+ * //         parameters: [ // CopilotVariableBindingsList
+ * //           { // CopilotVariableBinding
+ * //             name: "STRING_VALUE", // required
+ * //             type: "STRING_VALUE",
+ * //             optional: true || false,
+ * //             variant: "auto" || "guided" || "predefined", // required
+ * //             description: "STRING_VALUE",
+ * //             value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //       tool: { // ToolAutomationHandler
+ * //         toolId: "STRING_VALUE",
+ * //         toolName: "STRING_VALUE", // required
+ * //         action: "STRING_VALUE",
+ * //         payloadTemplate: "STRING_VALUE",
+ * //         outputMode: "card" || "silent",
+ * //         parameters: [
+ * //           {
+ * //             name: "STRING_VALUE", // required
+ * //             type: "STRING_VALUE",
+ * //             optional: true || false,
+ * //             variant: "auto" || "guided" || "predefined", // required
+ * //             description: "STRING_VALUE",
+ * //             value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //       knowledgeBase: { // KnowledgeBaseAutomationHandler
+ * //         knowledgeBaseId: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     conditions: "DOCUMENT_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
+ * //     revision: Number("int"), // required
+ * //     executionsLast30Days: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateAutomationCommandInput - {@link CreateAutomationCommandInput}
+ * @returns {@link CreateAutomationCommandOutput}
+ * @see {@link CreateAutomationCommandInput} for command's `input` shape.
+ * @see {@link CreateAutomationCommandOutput} for command's `response` shape.
+ * @see {@link WilmaCopilotClientResolvedConfig | config} for WilmaCopilotClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link AutomationNonUniqueNameException} (client fault)
+ *
+ * @throws {@link WilmaCopilotServiceException}
+ * <p>Base exception class for all service exceptions from WilmaCopilot service.</p>
+ *
+ *
+ * @public
+ */
+export declare class CreateAutomationCommand extends CreateAutomationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateAutomationInput;
+            output: CreateAutomationOutput;
+        };
+        sdk: {
+            input: CreateAutomationCommandInput;
+            output: CreateAutomationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,196 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateEvaluationInput, CreateEvaluationOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaCopilotClientResolvedConfig } from "../WilmaCopilotClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateEvaluationCommand}.
+ */
+export interface CreateEvaluationCommandInput extends CreateEvaluationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateEvaluationCommand}.
+ */
+export interface CreateEvaluationCommandOutput extends CreateEvaluationOutput, __MetadataBearer {
+}
+declare const CreateEvaluationCommand_base: {
+    new (input: CreateEvaluationCommandInput): import("@smithy/core/client").CommandImpl<CreateEvaluationCommandInput, CreateEvaluationCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateEvaluationCommandInput): import("@smithy/core/client").CommandImpl<CreateEvaluationCommandInput, CreateEvaluationCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Creates a new reusable evaluation.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaCopilotClient, CreateEvaluationCommand } from "@wildix/wilma-copilot-client"; // ES Modules import
+ * // const { WilmaCopilotClient, CreateEvaluationCommand } = require("@wildix/wilma-copilot-client"); // CommonJS import
+ * // import type { WilmaCopilotClientConfig } from "@wildix/wilma-copilot-client";
+ * const config = {}; // type is WilmaCopilotClientConfig
+ * const client = new WilmaCopilotClient(config);
+ * const input = { // CreateEvaluationInput
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   instructions: "STRING_VALUE", // required
+ *   fields: [ // CopilotFieldsList
+ *     { // CopilotField
+ *       id: "STRING_VALUE", // required
+ *       name: "STRING_VALUE", // required
+ *       description: "STRING_VALUE",
+ *       optional: true || false,
+ *       parameter: { // CopilotFieldParameter Union: only one key present
+ *         text: { // CopilotTextParameter
+ *           examples: [ // StringList
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         multiline: { // CopilotMultilineParameter
+ *           examples: [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         number: { // CopilotNumberParameter
+ *           min: Number("int"),
+ *           max: Number("int"),
+ *         },
+ *         selection: { // CopilotSelectionParameter
+ *           options: [ // required
+ *             "STRING_VALUE",
+ *           ],
+ *           multi: true || false,
+ *           adaptive: true || false,
+ *           adaptiveOptions: [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *       },
+ *     },
+ *   ],
+ *   triggers: { // EvaluationTriggers
+ *     interval: { // EvaluationIntervalTrigger
+ *       enabled: true || false, // required
+ *       intervalSeconds: Number("int"),
+ *     },
+ *     customerEndSpeaking: true || false,
+ *     agentEndSpeaking: true || false,
+ *     immediatelyOncePerSession: true || false,
+ *   },
+ *   window: "new_transcript" || "new_with_prior" || "full_transcript", // required
+ *   model: "STRING_VALUE",
+ *   group: "STRING_VALUE",
+ *   conditions: "DOCUMENT_VALUE",
+ *   company: "STRING_VALUE",
+ * };
+ * const command = new CreateEvaluationCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateEvaluationOutput
+ * //   evaluation: { // Evaluation
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     instructions: "STRING_VALUE", // required
+ * //     fields: [ // CopilotFieldsList
+ * //       { // CopilotField
+ * //         id: "STRING_VALUE", // required
+ * //         name: "STRING_VALUE", // required
+ * //         description: "STRING_VALUE",
+ * //         optional: true || false,
+ * //         parameter: { // CopilotFieldParameter Union: only one key present
+ * //           text: { // CopilotTextParameter
+ * //             examples: [ // StringList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           multiline: { // CopilotMultilineParameter
+ * //             examples: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           number: { // CopilotNumberParameter
+ * //             min: Number("int"),
+ * //             max: Number("int"),
+ * //           },
+ * //           selection: { // CopilotSelectionParameter
+ * //             options: [ // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             multi: true || false,
+ * //             adaptive: true || false,
+ * //             adaptiveOptions: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         },
+ * //       },
+ * //     ],
+ * //     triggers: { // EvaluationTriggers
+ * //       interval: { // EvaluationIntervalTrigger
+ * //         enabled: true || false, // required
+ * //         intervalSeconds: Number("int"),
+ * //       },
+ * //       customerEndSpeaking: true || false,
+ * //       agentEndSpeaking: true || false,
+ * //       immediatelyOncePerSession: true || false,
+ * //     },
+ * //     window: "new_transcript" || "new_with_prior" || "full_transcript", // required
+ * //     model: "STRING_VALUE",
+ * //     group: "STRING_VALUE",
+ * //     conditions: "DOCUMENT_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
+ * //     revision: Number("int"), // required
+ * //     usageLast30Days: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateEvaluationCommandInput - {@link CreateEvaluationCommandInput}
+ * @returns {@link CreateEvaluationCommandOutput}
+ * @see {@link CreateEvaluationCommandInput} for command's `input` shape.
+ * @see {@link CreateEvaluationCommandOutput} for command's `response` shape.
+ * @see {@link WilmaCopilotClientResolvedConfig | config} for WilmaCopilotClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link EvaluationNonUniqueNameException} (client fault)
+ *
+ * @throws {@link WilmaCopilotServiceException}
+ * <p>Base exception class for all service exceptions from WilmaCopilot service.</p>
+ *
+ *
+ * @public
+ */
+export declare class CreateEvaluationCommand extends CreateEvaluationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateEvaluationInput;
+            output: CreateEvaluationOutput;
+        };
+        sdk: {
+            input: CreateEvaluationCommandInput;
+            output: CreateEvaluationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,202 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateIntentInput, CreateIntentOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaCopilotClientResolvedConfig } from "../WilmaCopilotClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateIntentCommand}.
+ */
+export interface CreateIntentCommandInput extends CreateIntentInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateIntentCommand}.
+ */
+export interface CreateIntentCommandOutput extends CreateIntentOutput, __MetadataBearer {
+}
+declare const CreateIntentCommand_base: {
+    new (input: CreateIntentCommandInput): import("@smithy/core/client").CommandImpl<CreateIntentCommandInput, CreateIntentCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateIntentCommandInput): import("@smithy/core/client").CommandImpl<CreateIntentCommandInput, CreateIntentCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Creates a new reusable intent.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaCopilotClient, CreateIntentCommand } from "@wildix/wilma-copilot-client"; // ES Modules import
+ * // const { WilmaCopilotClient, CreateIntentCommand } = require("@wildix/wilma-copilot-client"); // CommonJS import
+ * // import type { WilmaCopilotClientConfig } from "@wildix/wilma-copilot-client";
+ * const config = {}; // type is WilmaCopilotClientConfig
+ * const client = new WilmaCopilotClient(config);
+ * const input = { // CreateIntentInput
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   handlers: { // IntentHandlers
+ *     textMatch: { // IntentTextMatch
+ *       enabled: true || false, // required
+ *       options: [ // IntentTextMatchOptionsList
+ *         { // IntentTextMatchOption
+ *           id: "STRING_VALUE", // required
+ *           value: "STRING_VALUE", // required
+ *           mode: "exact" || "fuzzy" || "regex", // required
+ *         },
+ *       ],
+ *     },
+ *     aiMatch: { // IntentAiMatch
+ *       enabled: true || false, // required
+ *       instructions: "STRING_VALUE",
+ *       fields: [ // CopilotFieldsList
+ *         { // CopilotField
+ *           id: "STRING_VALUE", // required
+ *           name: "STRING_VALUE", // required
+ *           description: "STRING_VALUE",
+ *           optional: true || false,
+ *           parameter: { // CopilotFieldParameter Union: only one key present
+ *             text: { // CopilotTextParameter
+ *               examples: [ // StringList
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *             multiline: { // CopilotMultilineParameter
+ *               examples: [
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *             number: { // CopilotNumberParameter
+ *               min: Number("int"),
+ *               max: Number("int"),
+ *             },
+ *             selection: { // CopilotSelectionParameter
+ *               options: [ // required
+ *                 "STRING_VALUE",
+ *               ],
+ *               multi: true || false,
+ *               adaptive: true || false,
+ *               adaptiveOptions: [
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   },
+ *   conditions: "DOCUMENT_VALUE",
+ *   company: "STRING_VALUE",
+ * };
+ * const command = new CreateIntentCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateIntentOutput
+ * //   intent: { // Intent
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     handlers: { // IntentHandlers
+ * //       textMatch: { // IntentTextMatch
+ * //         enabled: true || false, // required
+ * //         options: [ // IntentTextMatchOptionsList
+ * //           { // IntentTextMatchOption
+ * //             id: "STRING_VALUE", // required
+ * //             value: "STRING_VALUE", // required
+ * //             mode: "exact" || "fuzzy" || "regex", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //       aiMatch: { // IntentAiMatch
+ * //         enabled: true || false, // required
+ * //         instructions: "STRING_VALUE",
+ * //         fields: [ // CopilotFieldsList
+ * //           { // CopilotField
+ * //             id: "STRING_VALUE", // required
+ * //             name: "STRING_VALUE", // required
+ * //             description: "STRING_VALUE",
+ * //             optional: true || false,
+ * //             parameter: { // CopilotFieldParameter Union: only one key present
+ * //               text: { // CopilotTextParameter
+ * //                 examples: [ // StringList
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //               multiline: { // CopilotMultilineParameter
+ * //                 examples: [
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //               number: { // CopilotNumberParameter
+ * //                 min: Number("int"),
+ * //                 max: Number("int"),
+ * //               },
+ * //               selection: { // CopilotSelectionParameter
+ * //                 options: [ // required
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //                 multi: true || false,
+ * //                 adaptive: true || false,
+ * //                 adaptiveOptions: [
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
+ * //     },
+ * //     conditions: "DOCUMENT_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
+ * //     revision: Number("int"), // required
+ * //     usageLast30Days: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateIntentCommandInput - {@link CreateIntentCommandInput}
+ * @returns {@link CreateIntentCommandOutput}
+ * @see {@link CreateIntentCommandInput} for command's `input` shape.
+ * @see {@link CreateIntentCommandOutput} for command's `response` shape.
+ * @see {@link WilmaCopilotClientResolvedConfig | config} for WilmaCopilotClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link IntentNonUniqueNameException} (client fault)
+ *
+ * @throws {@link WilmaCopilotServiceException}
+ * <p>Base exception class for all service exceptions from WilmaCopilot service.</p>
+ *
+ *
+ * @public
+ */
+export declare class CreateIntentCommand extends CreateIntentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateIntentInput;
+            output: CreateIntentOutput;
+        };
+        sdk: {
+            input: CreateIntentCommandInput;
+            output: CreateIntentCommandOutput;
+        };
+    };
+}