@wildix/wilma-copilot-client 1.0.2

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

@@ -0,0 +1,335 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateAssetInput, UpdateAssetOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaCopilotClientResolvedConfig } from "../WilmaCopilotClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAssetCommand}.
+ */
+export interface UpdateAssetCommandInput extends UpdateAssetInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAssetCommand}.
+ */
+export interface UpdateAssetCommandOutput extends UpdateAssetOutput, __MetadataBearer {
+}
+declare const UpdateAssetCommand_base: {
+    new (input: UpdateAssetCommandInput): import("@smithy/core/client").CommandImpl<UpdateAssetCommandInput, UpdateAssetCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateAssetCommandInput): import("@smithy/core/client").CommandImpl<UpdateAssetCommandInput, UpdateAssetCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Updates an asset. Published profile versions that captured this asset are unaffected; the change reaches live conversations when a profile referencing it is republished.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaCopilotClient, UpdateAssetCommand } from "@wildix/wilma-copilot-client"; // ES Modules import
+ * // const { WilmaCopilotClient, UpdateAssetCommand } = 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 = { // UpdateAssetInput
+ *   key: "STRING_VALUE",
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   enabled: true || false,
+ *   type: "guidance" || "next_best_action" || "battle_card" || "playbook" || "knowledge",
+ *   title: "STRING_VALUE",
+ *   subtitle: "STRING_VALUE",
+ *   markdown: "STRING_VALUE",
+ *   footer: "STRING_VALUE",
+ *   severity: "neutral" || "success" || "warning" || "danger",
+ *   icon: "info" || "lightbulb" || "shield" || "book_open" || "alert" || "sparkles",
+ *   sticky: true || false,
+ *   content: { // AssetContent Union: only one key present
+ *     card: { // AssetCard
+ *       content: { // CardContent Union: only one key present
+ *         static: { // CardStaticContent
+ *           markdown: "STRING_VALUE",
+ *         },
+ *         agent: { // CardAgentContent
+ *           agentId: "STRING_VALUE", // required
+ *           variables: [ // CopilotVariableBindingsList
+ *             { // CopilotVariableBinding
+ *               name: "STRING_VALUE", // required
+ *               type: "STRING_VALUE",
+ *               optional: true || false,
+ *               variant: "auto" || "guided" || "predefined", // required
+ *               description: "STRING_VALUE",
+ *               value: "STRING_VALUE",
+ *             },
+ *           ],
+ *         },
+ *       },
+ *     },
+ *     playbook: { // AssetPlaybook
+ *       goal: "STRING_VALUE",
+ *       steps: [ // PlaybookStepsList
+ *         { // PlaybookStep
+ *           id: "STRING_VALUE", // required
+ *           title: "STRING_VALUE", // required
+ *           markdown: "STRING_VALUE",
+ *           required: true || false,
+ *           autoComplete: true || false,
+ *           autoCompleteInstructions: "STRING_VALUE",
+ *         },
+ *       ],
+ *       completionCriteria: { // PlaybookCompletionCriteria Union: only one key present
+ *         manual: { // PlaybookManualCompletion
+ *           allowAgentMarkComplete: true || false, // required
+ *         },
+ *         semantic: { // PlaybookSemanticCompletion
+ *           description: "STRING_VALUE", // required
+ *           examples: [ // StringList
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *       },
+ *     },
+ *     smartAction: { // AssetSmartActions
+ *       actions: [ // SmartActionItemsList // required
+ *         { // SmartActionItem
+ *           id: "STRING_VALUE", // required
+ *           label: "STRING_VALUE", // required
+ *           description: "STRING_VALUE",
+ *           action: { // SmartAction Union: only one key present
+ *             openUrl: { // SmartActionOpenUrl
+ *               url: "STRING_VALUE", // required
+ *               openInNewTab: true || false,
+ *             },
+ *             runAgent: { // SmartActionRunAgent
+ *               agentId: "STRING_VALUE", // required
+ *               variables: [
+ *                 {
+ *                   name: "STRING_VALUE", // required
+ *                   type: "STRING_VALUE",
+ *                   optional: true || false,
+ *                   variant: "auto" || "guided" || "predefined", // required
+ *                   description: "STRING_VALUE",
+ *                   value: "STRING_VALUE",
+ *                 },
+ *               ],
+ *               resultMode: "show_card" || "silent", // required
+ *               requireConfirmation: true || false,
+ *             },
+ *             runTool: { // SmartActionRunTool
+ *               toolId: "STRING_VALUE", // required
+ *               variables: [
+ *                 {
+ *                   name: "STRING_VALUE", // required
+ *                   type: "STRING_VALUE",
+ *                   optional: true || false,
+ *                   variant: "auto" || "guided" || "predefined", // required
+ *                   description: "STRING_VALUE",
+ *                   value: "STRING_VALUE",
+ *                 },
+ *               ],
+ *               resultMode: "show_card" || "silent", // required
+ *               requireConfirmation: true || false,
+ *             },
+ *             transfer: { // SmartActionTransfer
+ *               destination: "STRING_VALUE", // required
+ *             },
+ *             handover: { // SmartActionHandover
+ *               handoverVariant: "agent" || "service", // required
+ *               assignee: "STRING_VALUE",
+ *               service: "STRING_VALUE",
+ *             },
+ *           },
+ *         },
+ *       ],
+ *     },
+ *     knowledge: { // AssetKnowledge
+ *       summary: "STRING_VALUE",
+ *       sources: "STRING_VALUE",
+ *     },
+ *   },
+ *   conditions: "DOCUMENT_VALUE",
+ *   company: "STRING_VALUE",
+ *   assetId: "STRING_VALUE", // required
+ *   revision: Number("int"), // required
+ * };
+ * const command = new UpdateAssetCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateAssetOutput
+ * //   asset: { // Asset
+ * //     key: "STRING_VALUE",
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     enabled: true || false,
+ * //     type: "guidance" || "next_best_action" || "battle_card" || "playbook" || "knowledge",
+ * //     title: "STRING_VALUE",
+ * //     subtitle: "STRING_VALUE",
+ * //     markdown: "STRING_VALUE",
+ * //     footer: "STRING_VALUE",
+ * //     severity: "neutral" || "success" || "warning" || "danger",
+ * //     icon: "info" || "lightbulb" || "shield" || "book_open" || "alert" || "sparkles",
+ * //     sticky: true || false,
+ * //     content: { // AssetContent Union: only one key present
+ * //       card: { // AssetCard
+ * //         content: { // CardContent Union: only one key present
+ * //           static: { // CardStaticContent
+ * //             markdown: "STRING_VALUE",
+ * //           },
+ * //           agent: { // CardAgentContent
+ * //             agentId: "STRING_VALUE", // required
+ * //             variables: [ // CopilotVariableBindingsList
+ * //               { // CopilotVariableBinding
+ * //                 name: "STRING_VALUE", // required
+ * //                 type: "STRING_VALUE",
+ * //                 optional: true || false,
+ * //                 variant: "auto" || "guided" || "predefined", // required
+ * //                 description: "STRING_VALUE",
+ * //                 value: "STRING_VALUE",
+ * //               },
+ * //             ],
+ * //           },
+ * //         },
+ * //       },
+ * //       playbook: { // AssetPlaybook
+ * //         goal: "STRING_VALUE",
+ * //         steps: [ // PlaybookStepsList
+ * //           { // PlaybookStep
+ * //             id: "STRING_VALUE", // required
+ * //             title: "STRING_VALUE", // required
+ * //             markdown: "STRING_VALUE",
+ * //             required: true || false,
+ * //             autoComplete: true || false,
+ * //             autoCompleteInstructions: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         completionCriteria: { // PlaybookCompletionCriteria Union: only one key present
+ * //           manual: { // PlaybookManualCompletion
+ * //             allowAgentMarkComplete: true || false, // required
+ * //           },
+ * //           semantic: { // PlaybookSemanticCompletion
+ * //             description: "STRING_VALUE", // required
+ * //             examples: [ // StringList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         },
+ * //       },
+ * //       smartAction: { // AssetSmartActions
+ * //         actions: [ // SmartActionItemsList // required
+ * //           { // SmartActionItem
+ * //             id: "STRING_VALUE", // required
+ * //             label: "STRING_VALUE", // required
+ * //             description: "STRING_VALUE",
+ * //             action: { // SmartAction Union: only one key present
+ * //               openUrl: { // SmartActionOpenUrl
+ * //                 url: "STRING_VALUE", // required
+ * //                 openInNewTab: true || false,
+ * //               },
+ * //               runAgent: { // SmartActionRunAgent
+ * //                 agentId: "STRING_VALUE", // required
+ * //                 variables: [
+ * //                   {
+ * //                     name: "STRING_VALUE", // required
+ * //                     type: "STRING_VALUE",
+ * //                     optional: true || false,
+ * //                     variant: "auto" || "guided" || "predefined", // required
+ * //                     description: "STRING_VALUE",
+ * //                     value: "STRING_VALUE",
+ * //                   },
+ * //                 ],
+ * //                 resultMode: "show_card" || "silent", // required
+ * //                 requireConfirmation: true || false,
+ * //               },
+ * //               runTool: { // SmartActionRunTool
+ * //                 toolId: "STRING_VALUE", // required
+ * //                 variables: [
+ * //                   {
+ * //                     name: "STRING_VALUE", // required
+ * //                     type: "STRING_VALUE",
+ * //                     optional: true || false,
+ * //                     variant: "auto" || "guided" || "predefined", // required
+ * //                     description: "STRING_VALUE",
+ * //                     value: "STRING_VALUE",
+ * //                   },
+ * //                 ],
+ * //                 resultMode: "show_card" || "silent", // required
+ * //                 requireConfirmation: true || false,
+ * //               },
+ * //               transfer: { // SmartActionTransfer
+ * //                 destination: "STRING_VALUE", // required
+ * //               },
+ * //               handover: { // SmartActionHandover
+ * //                 handoverVariant: "agent" || "service", // required
+ * //                 assignee: "STRING_VALUE",
+ * //                 service: "STRING_VALUE",
+ * //               },
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
+ * //       knowledge: { // AssetKnowledge
+ * //         summary: "STRING_VALUE",
+ * //         sources: "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 UpdateAssetCommandInput - {@link UpdateAssetCommandInput}
+ * @returns {@link UpdateAssetCommandOutput}
+ * @see {@link UpdateAssetCommandInput} for command's `input` shape.
+ * @see {@link UpdateAssetCommandOutput} 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 AssetNotFoundException} (client fault)
+ *
+ * @throws {@link AssetNonUniqueNameException} (client fault)
+ *
+ * @throws {@link RevisionConflictException} (client fault)
+ *  The resource was modified concurrently; re-read it and retry with the latest revision.
+ *
+ * @throws {@link WilmaCopilotServiceException}
+ * <p>Base exception class for all service exceptions from WilmaCopilot service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateAssetCommand extends UpdateAssetCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateAssetInput;
+            output: UpdateAssetOutput;
+        };
+        sdk: {
+            input: UpdateAssetCommandInput;
+            output: UpdateAssetCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,183 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateAutomationInput, UpdateAutomationOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaCopilotClientResolvedConfig } from "../WilmaCopilotClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAutomationCommand}.
+ */
+export interface UpdateAutomationCommandInput extends UpdateAutomationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAutomationCommand}.
+ */
+export interface UpdateAutomationCommandOutput extends UpdateAutomationOutput, __MetadataBearer {
+}
+declare const UpdateAutomationCommand_base: {
+    new (input: UpdateAutomationCommandInput): import("@smithy/core/client").CommandImpl<UpdateAutomationCommandInput, UpdateAutomationCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateAutomationCommandInput): import("@smithy/core/client").CommandImpl<UpdateAutomationCommandInput, UpdateAutomationCommandOutput, WilmaCopilotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Updates an automation. Published profile versions that captured this automation are unaffected; the change reaches live conversations when a profile referencing it is republished.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaCopilotClient, UpdateAutomationCommand } from "@wildix/wilma-copilot-client"; // ES Modules import
+ * // const { WilmaCopilotClient, UpdateAutomationCommand } = 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 = { // UpdateAutomationInput
+ *   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",
+ *   automationId: "STRING_VALUE", // required
+ *   revision: Number("int"), // required
+ * };
+ * const command = new UpdateAutomationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateAutomationOutput
+ * //   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 UpdateAutomationCommandInput - {@link UpdateAutomationCommandInput}
+ * @returns {@link UpdateAutomationCommandOutput}
+ * @see {@link UpdateAutomationCommandInput} for command's `input` shape.
+ * @see {@link UpdateAutomationCommandOutput} 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 AutomationNotFoundException} (client fault)
+ *
+ * @throws {@link AutomationNonUniqueNameException} (client fault)
+ *
+ * @throws {@link RevisionConflictException} (client fault)
+ *  The resource was modified concurrently; re-read it and retry with the latest revision.
+ *
+ * @throws {@link WilmaCopilotServiceException}
+ * <p>Base exception class for all service exceptions from WilmaCopilot service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateAutomationCommand extends UpdateAutomationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateAutomationInput;
+            output: UpdateAutomationOutput;
+        };
+        sdk: {
+            input: UpdateAutomationCommandInput;
+            output: UpdateAutomationCommandOutput;
+        };
+    };
+}