@wildix/wilma-agents-client 1.0.1 → 1.0.2

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

@@ -1,137 +0,0 @@
-import { Command as $Command } from "@smithy/core/client";
-import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListGuardrailsInput, ListGuardrailsOutput } from "../models/models_0";
-import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
-/**
- * @public
- */
-export type { __MetadataBearer };
-export { $Command };
-/**
- * @public
- *
- * The input for {@link ListGuardrailsCommand}.
- */
-export interface ListGuardrailsCommandInput extends ListGuardrailsInput {
-}
-/**
- * @public
- *
- * The output of {@link ListGuardrailsCommand}.
- */
-export interface ListGuardrailsCommandOutput extends ListGuardrailsOutput, __MetadataBearer {
-}
-declare const ListGuardrailsCommand_base: {
-    new (input: ListGuardrailsCommandInput): import("@smithy/core/client").CommandImpl<ListGuardrailsCommandInput, ListGuardrailsCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (...[input]: [] | [ListGuardrailsCommandInput]): import("@smithy/core/client").CommandImpl<ListGuardrailsCommandInput, ListGuardrailsCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): {
-        [x: string]: unknown;
-    };
-};
-/**
- * Lists guardrails for the specified company.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WilmaAgentsClient, ListGuardrailsCommand } from "@wildix/wilma-agents-client"; // ES Modules import
- * // const { WilmaAgentsClient, ListGuardrailsCommand } = 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 = { // ListGuardrailsInput
- *   company: "STRING_VALUE",
- *   limit: Number("int"),
- *   nextToken: "STRING_VALUE",
- * };
- * const command = new ListGuardrailsCommand(input);
- * const response = await client.send(command);
- * // { // ListGuardrailsOutput
- * //   guardrails: [ // GuardrailsList // required
- * //     { // Guardrail
- * //       name: "STRING_VALUE", // required
- * //       description: "STRING_VALUE",
- * //       topicPolicy: { // GuardrailTopicPolicy
- * //         topics: [ // GuardrailTopicsList // required
- * //           { // GuardrailTopic
- * //             name: "STRING_VALUE", // required
- * //             definition: "STRING_VALUE", // required
- * //             examples: [ // GuardrailPhrasesList
- * //               "STRING_VALUE",
- * //             ],
- * //             action: "block" || "detect", // required
- * //           },
- * //         ],
- * //       },
- * //       contentPolicy: { // GuardrailContentPolicy
- * //         filters: [ // GuardrailContentFiltersList // required
- * //           { // GuardrailContentFilter
- * //             category: "hate" || "insults" || "sexual" || "violence" || "misconduct" || "prompt_attack", // required
- * //             inputStrength: "none" || "low" || "medium" || "high",
- * //             outputStrength: "none" || "low" || "medium" || "high",
- * //           },
- * //         ],
- * //       },
- * //       wordPolicy: { // GuardrailWordPolicy
- * //         blockedWords: [
- * //           "STRING_VALUE",
- * //         ],
- * //         profanity: true || false,
- * //       },
- * //       piiPolicy: { // GuardrailPiiPolicy
- * //         entities: [ // GuardrailPiiEntitiesList // required
- * //           { // GuardrailPiiEntity
- * //             entityType: "email" || "phone_number" || "name" || "address" || "credit_card" || "iban" || "national_id" || "password" || "custom", // required
- * //             pattern: "STRING_VALUE",
- * //             action: "block" || "anonymize", // required
- * //           },
- * //         ],
- * //       },
- * //       blockedInputMessage: "STRING_VALUE",
- * //       blockedOutputMessage: "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
- * //     },
- * //   ],
- * //   nextToken: "STRING_VALUE",
- * // };
- *
- * ```
- *
- * @param ListGuardrailsCommandInput - {@link ListGuardrailsCommandInput}
- * @returns {@link ListGuardrailsCommandOutput}
- * @see {@link ListGuardrailsCommandInput} for command's `input` shape.
- * @see {@link ListGuardrailsCommandOutput} for command's `response` shape.
- * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
- *
- * @throws {@link ValidationException} (client fault)
- *
- * @throws {@link WilmaAgentsServiceException}
- * <p>Base exception class for all service exceptions from WilmaAgents service.</p>
- *
- *
- * @public
- */
-export declare class ListGuardrailsCommand extends ListGuardrailsCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: ListGuardrailsInput;
-            output: ListGuardrailsOutput;
-        };
-        sdk: {
-            input: ListGuardrailsCommandInput;
-            output: ListGuardrailsCommandOutput;
-        };
-    };
-}

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

@@ -1,107 +0,0 @@
-import { Command as $Command } from "@smithy/core/client";
-import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { PutAgentAliasInput, PutAgentAliasOutput } from "../models/models_0";
-import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
-/**
- * @public
- */
-export type { __MetadataBearer };
-export { $Command };
-/**
- * @public
- *
- * The input for {@link PutAgentAliasCommand}.
- */
-export interface PutAgentAliasCommandInput extends PutAgentAliasInput {
-}
-/**
- * @public
- *
- * The output of {@link PutAgentAliasCommand}.
- */
-export interface PutAgentAliasCommandOutput extends PutAgentAliasOutput, __MetadataBearer {
-}
-declare const PutAgentAliasCommand_base: {
-    new (input: PutAgentAliasCommandInput): import("@smithy/core/client").CommandImpl<PutAgentAliasCommandInput, PutAgentAliasCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (input: PutAgentAliasCommandInput): import("@smithy/core/client").CommandImpl<PutAgentAliasCommandInput, PutAgentAliasCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): {
-        [x: string]: unknown;
-    };
-};
-/**
- * Creates or updates an alias: a named pointer routing traffic to one or more published versions with weights. Repointing 'production' to an older version is a rollback; two weighted routes make a canary.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WilmaAgentsClient, PutAgentAliasCommand } from "@wildix/wilma-agents-client"; // ES Modules import
- * // const { WilmaAgentsClient, PutAgentAliasCommand } = 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 = { // PutAgentAliasInput
- *   company: "STRING_VALUE",
- *   agentId: "STRING_VALUE", // required
- *   aliasName: "STRING_VALUE", // required
- *   description: "STRING_VALUE",
- *   routing: [ // AgentAliasRoutesList // required
- *     { // AgentAliasRoute
- *       version: Number("int"), // required
- *       weight: Number("int"), // required
- *     },
- *   ],
- * };
- * const command = new PutAgentAliasCommand(input);
- * const response = await client.send(command);
- * // { // PutAgentAliasOutput
- * //   alias: { // 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: { // Actor
- * //       type: "user" || "api_key" || "service", // required
- * //       id: "STRING_VALUE", // required
- * //       name: "STRING_VALUE",
- * //     },
- * //   },
- * // };
- *
- * ```
- *
- * @param PutAgentAliasCommandInput - {@link PutAgentAliasCommandInput}
- * @returns {@link PutAgentAliasCommandOutput}
- * @see {@link PutAgentAliasCommandInput} for command's `input` shape.
- * @see {@link PutAgentAliasCommandOutput} 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 ValidationException} (client fault)
- *
- * @throws {@link WilmaAgentsServiceException}
- * <p>Base exception class for all service exceptions from WilmaAgents service.</p>
- *
- *
- * @public
- */
-export declare class PutAgentAliasCommand extends PutAgentAliasCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: PutAgentAliasInput;
-            output: PutAgentAliasOutput;
-        };
-        sdk: {
-            input: PutAgentAliasCommandInput;
-            output: PutAgentAliasCommandOutput;
-        };
-    };
-}

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

@@ -1,175 +0,0 @@
-import { Command as $Command } from "@smithy/core/client";
-import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { UpdateGuardrailInput, UpdateGuardrailOutput } from "../models/models_0";
-import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
-/**
- * @public
- */
-export type { __MetadataBearer };
-export { $Command };
-/**
- * @public
- *
- * The input for {@link UpdateGuardrailCommand}.
- */
-export interface UpdateGuardrailCommandInput extends UpdateGuardrailInput {
-}
-/**
- * @public
- *
- * The output of {@link UpdateGuardrailCommand}.
- */
-export interface UpdateGuardrailCommandOutput extends UpdateGuardrailOutput, __MetadataBearer {
-}
-declare const UpdateGuardrailCommand_base: {
-    new (input: UpdateGuardrailCommandInput): import("@smithy/core/client").CommandImpl<UpdateGuardrailCommandInput, UpdateGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (input: UpdateGuardrailCommandInput): import("@smithy/core/client").CommandImpl<UpdateGuardrailCommandInput, UpdateGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): {
-        [x: string]: unknown;
-    };
-};
-/**
- * Updates a guardrail. The change applies to every agent referencing it.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WilmaAgentsClient, UpdateGuardrailCommand } from "@wildix/wilma-agents-client"; // ES Modules import
- * // const { WilmaAgentsClient, UpdateGuardrailCommand } = 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 = { // UpdateGuardrailInput
- *   name: "STRING_VALUE", // required
- *   description: "STRING_VALUE",
- *   topicPolicy: { // GuardrailTopicPolicy
- *     topics: [ // GuardrailTopicsList // required
- *       { // GuardrailTopic
- *         name: "STRING_VALUE", // required
- *         definition: "STRING_VALUE", // required
- *         examples: [ // GuardrailPhrasesList
- *           "STRING_VALUE",
- *         ],
- *         action: "block" || "detect", // required
- *       },
- *     ],
- *   },
- *   contentPolicy: { // GuardrailContentPolicy
- *     filters: [ // GuardrailContentFiltersList // required
- *       { // GuardrailContentFilter
- *         category: "hate" || "insults" || "sexual" || "violence" || "misconduct" || "prompt_attack", // required
- *         inputStrength: "none" || "low" || "medium" || "high",
- *         outputStrength: "none" || "low" || "medium" || "high",
- *       },
- *     ],
- *   },
- *   wordPolicy: { // GuardrailWordPolicy
- *     blockedWords: [
- *       "STRING_VALUE",
- *     ],
- *     profanity: true || false,
- *   },
- *   piiPolicy: { // GuardrailPiiPolicy
- *     entities: [ // GuardrailPiiEntitiesList // required
- *       { // GuardrailPiiEntity
- *         entityType: "email" || "phone_number" || "name" || "address" || "credit_card" || "iban" || "national_id" || "password" || "custom", // required
- *         pattern: "STRING_VALUE",
- *         action: "block" || "anonymize", // required
- *       },
- *     ],
- *   },
- *   blockedInputMessage: "STRING_VALUE",
- *   blockedOutputMessage: "STRING_VALUE",
- *   company: "STRING_VALUE",
- *   guardrailId: "STRING_VALUE", // required
- * };
- * const command = new UpdateGuardrailCommand(input);
- * const response = await client.send(command);
- * // { // UpdateGuardrailOutput
- * //   guardrail: { // Guardrail
- * //     name: "STRING_VALUE", // required
- * //     description: "STRING_VALUE",
- * //     topicPolicy: { // GuardrailTopicPolicy
- * //       topics: [ // GuardrailTopicsList // required
- * //         { // GuardrailTopic
- * //           name: "STRING_VALUE", // required
- * //           definition: "STRING_VALUE", // required
- * //           examples: [ // GuardrailPhrasesList
- * //             "STRING_VALUE",
- * //           ],
- * //           action: "block" || "detect", // required
- * //         },
- * //       ],
- * //     },
- * //     contentPolicy: { // GuardrailContentPolicy
- * //       filters: [ // GuardrailContentFiltersList // required
- * //         { // GuardrailContentFilter
- * //           category: "hate" || "insults" || "sexual" || "violence" || "misconduct" || "prompt_attack", // required
- * //           inputStrength: "none" || "low" || "medium" || "high",
- * //           outputStrength: "none" || "low" || "medium" || "high",
- * //         },
- * //       ],
- * //     },
- * //     wordPolicy: { // GuardrailWordPolicy
- * //       blockedWords: [
- * //         "STRING_VALUE",
- * //       ],
- * //       profanity: true || false,
- * //     },
- * //     piiPolicy: { // GuardrailPiiPolicy
- * //       entities: [ // GuardrailPiiEntitiesList // required
- * //         { // GuardrailPiiEntity
- * //           entityType: "email" || "phone_number" || "name" || "address" || "credit_card" || "iban" || "national_id" || "password" || "custom", // required
- * //           pattern: "STRING_VALUE",
- * //           action: "block" || "anonymize", // required
- * //         },
- * //       ],
- * //     },
- * //     blockedInputMessage: "STRING_VALUE",
- * //     blockedOutputMessage: "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
- * //   },
- * // };
- *
- * ```
- *
- * @param UpdateGuardrailCommandInput - {@link UpdateGuardrailCommandInput}
- * @returns {@link UpdateGuardrailCommandOutput}
- * @see {@link UpdateGuardrailCommandInput} for command's `input` shape.
- * @see {@link UpdateGuardrailCommandOutput} for command's `response` shape.
- * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
- *
- * @throws {@link GuardrailNotFoundException} (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 UpdateGuardrailCommand extends UpdateGuardrailCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: UpdateGuardrailInput;
-            output: UpdateGuardrailOutput;
-        };
-        sdk: {
-            input: UpdateGuardrailCommandInput;
-            output: UpdateGuardrailCommandOutput;
-        };
-    };
-}