@wildix/xbees-users-client 1.0.46 → 1.0.48

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserQueryPredicateNotMetException = exports.UserQuery = exports.UserNotFoundException = exports.UserCompanyNotValidException = exports.BotSecretKeyNotValidException = exports.BotNotFoundException = exports.BotEndpoint = exports.BotLlmToolType = exports.BotLlmFunctionIntegration = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmFunctionIntegrationWebhookAuthorization = exports.BotLlmEmbeddedToolType = exports.BotApiKeyNotFoundException = exports.BotIntegrationType = exports.BotAccess = exports.PbxColleaguesSearchStrategy = exports.PbxColleaguesQueryField = exports.GetPbxColleaguesDir = exports.PbxColleagueRole = exports.PbxLicenseType = exports.ValidationException = exports.ForbiddenException = void 0;
+exports.UserQueryPredicateNotMetException = exports.UserQuery = exports.UserNotFoundException = exports.UserCompanyNotValidException = exports.BotSecretKeyNotValidException = exports.BotNotFoundException = exports.BotEndpoint = exports.BotLlmToolType = exports.BotLlmFunctionIntegration = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmFunctionIntegrationWebhookAuthorization = exports.BotLlmEmbeddedToolType = exports.BotCapability = exports.BotToolVariableHandler = exports.BotApiKeyNotFoundException = exports.BotIntegrationType = exports.BotAccess = exports.PbxColleaguesSearchStrategy = exports.PbxColleaguesQueryField = exports.GetPbxColleaguesDir = exports.PbxColleagueRole = exports.PbxLicenseType = exports.ValidationException = exports.ForbiddenException = void 0;
 const UsersServiceException_1 = require("./UsersServiceException");
 class ForbiddenException extends UsersServiceException_1.UsersServiceException {
     name = "ForbiddenException";
@@ -93,6 +93,28 @@ class BotApiKeyNotFoundException extends UsersServiceException_1.UsersServiceExc
     }
 }
 exports.BotApiKeyNotFoundException = BotApiKeyNotFoundException;
+var BotToolVariableHandler;
+(function (BotToolVariableHandler) {
+    BotToolVariableHandler.visit = (value, visitor) => {
+        if (value.auto !== undefined)
+            return visitor.auto(value.auto);
+        if (value.guided !== undefined)
+            return visitor.guided(value.guided);
+        if (value.predefined !== undefined)
+            return visitor.predefined(value.predefined);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(BotToolVariableHandler || (exports.BotToolVariableHandler = BotToolVariableHandler = {}));
+var BotCapability;
+(function (BotCapability) {
+    BotCapability.visit = (value, visitor) => {
+        if (value.tool !== undefined)
+            return visitor.tool(value.tool);
+        if (value.kb !== undefined)
+            return visitor.kb(value.kb);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(BotCapability || (exports.BotCapability = BotCapability = {}));
 exports.BotLlmEmbeddedToolType = {
     DELEGATE: "DELEGATE",
     HANDOVER: "HANDOVER",

package/dist-cjs/protocols/Aws_restJson1.js

@@ -1236,6 +1236,7 @@ const se_BotLlmEmbeddedToolsList = (input, context) => {
 };
 const se_BotLlmEndpoint = (input, context) => {
     return (0, smithy_client_1.take)(input, {
+        'capabilities': smithy_client_1._json,
         'embeddedTools': _ => se_BotLlmEmbeddedToolsList(_, context),
         'model': [],
         'prompt': [],
@@ -1337,6 +1338,7 @@ const de_BotLlmEmbeddedToolsList = (output, context) => {
 };
 const de_BotLlmEndpoint = (output, context) => {
     return (0, smithy_client_1.take)(output, {
+        'capabilities': smithy_client_1._json,
         'embeddedTools': (_) => de_BotLlmEmbeddedToolsList(_, context),
         'model': smithy_client_1.expectString,
         'prompt': smithy_client_1.expectString,

package/dist-es/models/models_0.js

@@ -87,6 +87,28 @@ export class BotApiKeyNotFoundException extends __BaseException {
         Object.setPrototypeOf(this, BotApiKeyNotFoundException.prototype);
     }
 }
+export var BotToolVariableHandler;
+(function (BotToolVariableHandler) {
+    BotToolVariableHandler.visit = (value, visitor) => {
+        if (value.auto !== undefined)
+            return visitor.auto(value.auto);
+        if (value.guided !== undefined)
+            return visitor.guided(value.guided);
+        if (value.predefined !== undefined)
+            return visitor.predefined(value.predefined);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(BotToolVariableHandler || (BotToolVariableHandler = {}));
+export var BotCapability;
+(function (BotCapability) {
+    BotCapability.visit = (value, visitor) => {
+        if (value.tool !== undefined)
+            return visitor.tool(value.tool);
+        if (value.kb !== undefined)
+            return visitor.kb(value.kb);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(BotCapability || (BotCapability = {}));
 export const BotLlmEmbeddedToolType = {
     DELEGATE: "DELEGATE",
     HANDOVER: "HANDOVER",

package/dist-es/protocols/Aws_restJson1.js

@@ -1166,6 +1166,7 @@ const se_BotLlmEmbeddedToolsList = (input, context) => {
 };
 const se_BotLlmEndpoint = (input, context) => {
     return take(input, {
+        'capabilities': _json,
         'embeddedTools': _ => se_BotLlmEmbeddedToolsList(_, context),
         'model': [],
         'prompt': [],
@@ -1267,6 +1268,7 @@ const de_BotLlmEmbeddedToolsList = (output, context) => {
 };
 const de_BotLlmEndpoint = (output, context) => {
     return take(output, {
+        'capabilities': _json,
         'embeddedTools': (_) => de_BotLlmEmbeddedToolsList(_, context),
         'model': __expectString,
         'prompt': __expectString,

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

@@ -48,6 +48,7 @@ declare const CreateBotApiKeyCommand_base: {
  * //     searchable: true || false,
  * //     access: "EVERYBODY" || "ORGANIZATION",
  * //     id: "STRING_VALUE", // required
+ * //     category: "STRING_VALUE",
  * //     integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
  * //     integrationApiKeysCount: Number("int"), // required
  * //     createdAt: "STRING_VALUE", // required

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

@@ -92,6 +92,31 @@ declare const CreateBotCommand_base: {
  *             },
  *           },
  *         ],
+ *         capabilities: [ // BotCapabilitiesList
+ *           { // BotCapability Union: only one key present
+ *             tool: { // BotCapabilityTool
+ *               id: "STRING_VALUE", // required
+ *               variables: [ // BotToolVariablesList
+ *                 { // BotToolVariable
+ *                   name: "STRING_VALUE", // required
+ *                   handler: { // BotToolVariableHandler Union: only one key present
+ *                     auto: {},
+ *                     guided: { // BotToolVariableGuidedHandler
+ *                       description: "STRING_VALUE", // required
+ *                     },
+ *                     predefined: { // BotToolVariablePredefinedHandler
+ *                       description: "STRING_VALUE", // required
+ *                     },
+ *                   },
+ *                 },
+ *               ],
+ *             },
+ *             kb: { // BotKnowledgeBase
+ *               knowledgeBaseId: "STRING_VALUE",
+ *               instructions: "STRING_VALUE",
+ *             },
+ *           },
+ *         ],
  *       },
  *       dialogflowCx: { // BotDialogflowCxEndpoint
  *         credentials: "DOCUMENT_VALUE", // required
@@ -124,6 +149,7 @@ declare const CreateBotCommand_base: {
  * //     searchable: true || false,
  * //     access: "EVERYBODY" || "ORGANIZATION",
  * //     id: "STRING_VALUE", // required
+ * //     category: "STRING_VALUE",
  * //     integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
  * //     integrationApiKeysCount: Number("int"), // required
  * //     createdAt: "STRING_VALUE", // required

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

@@ -93,6 +93,31 @@ declare const GetBotCallbackCommand_base: {
  * //             },
  * //           },
  * //         ],
+ * //         capabilities: [ // BotCapabilitiesList
+ * //           { // BotCapability Union: only one key present
+ * //             tool: { // BotCapabilityTool
+ * //               id: "STRING_VALUE", // required
+ * //               variables: [ // BotToolVariablesList
+ * //                 { // BotToolVariable
+ * //                   name: "STRING_VALUE", // required
+ * //                   handler: { // BotToolVariableHandler Union: only one key present
+ * //                     auto: {},
+ * //                     guided: { // BotToolVariableGuidedHandler
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                     predefined: { // BotToolVariablePredefinedHandler
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
+ * //             },
+ * //             kb: { // BotKnowledgeBase
+ * //               knowledgeBaseId: "STRING_VALUE",
+ * //               instructions: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //         ],
  * //       },
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required

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

@@ -47,6 +47,7 @@ declare const GetBotCommand_base: {
  * //     searchable: true || false,
  * //     access: "EVERYBODY" || "ORGANIZATION",
  * //     id: "STRING_VALUE", // required
+ * //     category: "STRING_VALUE",
  * //     integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
  * //     integrationApiKeysCount: Number("int"), // required
  * //     createdAt: "STRING_VALUE", // required

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

@@ -47,6 +47,7 @@ declare const ListBotsCommand_base: {
  * //       searchable: true || false,
  * //       access: "EVERYBODY" || "ORGANIZATION",
  * //       id: "STRING_VALUE", // required
+ * //       category: "STRING_VALUE",
  * //       integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
  * //       integrationApiKeysCount: Number("int"), // required
  * //       createdAt: "STRING_VALUE", // required

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

@@ -89,6 +89,31 @@ declare const UpdateBotCallbackCommand_base: {
  *             },
  *           },
  *         ],
+ *         capabilities: [ // BotCapabilitiesList
+ *           { // BotCapability Union: only one key present
+ *             tool: { // BotCapabilityTool
+ *               id: "STRING_VALUE", // required
+ *               variables: [ // BotToolVariablesList
+ *                 { // BotToolVariable
+ *                   name: "STRING_VALUE", // required
+ *                   handler: { // BotToolVariableHandler Union: only one key present
+ *                     auto: {},
+ *                     guided: { // BotToolVariableGuidedHandler
+ *                       description: "STRING_VALUE", // required
+ *                     },
+ *                     predefined: { // BotToolVariablePredefinedHandler
+ *                       description: "STRING_VALUE", // required
+ *                     },
+ *                   },
+ *                 },
+ *               ],
+ *             },
+ *             kb: { // BotKnowledgeBase
+ *               knowledgeBaseId: "STRING_VALUE",
+ *               instructions: "STRING_VALUE",
+ *             },
+ *           },
+ *         ],
  *       },
  *       dialogflowCx: { // BotDialogflowCxEndpoint
  *         credentials: "DOCUMENT_VALUE", // required
@@ -167,6 +192,31 @@ declare const UpdateBotCallbackCommand_base: {
  * //             },
  * //           },
  * //         ],
+ * //         capabilities: [ // BotCapabilitiesList
+ * //           { // BotCapability Union: only one key present
+ * //             tool: { // BotCapabilityTool
+ * //               id: "STRING_VALUE", // required
+ * //               variables: [ // BotToolVariablesList
+ * //                 { // BotToolVariable
+ * //                   name: "STRING_VALUE", // required
+ * //                   handler: { // BotToolVariableHandler Union: only one key present
+ * //                     auto: {},
+ * //                     guided: { // BotToolVariableGuidedHandler
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                     predefined: { // BotToolVariablePredefinedHandler
+ * //                       description: "STRING_VALUE", // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
+ * //             },
+ * //             kb: { // BotKnowledgeBase
+ * //               knowledgeBaseId: "STRING_VALUE",
+ * //               instructions: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //         ],
  * //       },
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required

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

@@ -51,6 +51,7 @@ declare const UpdateBotCommand_base: {
  * //     searchable: true || false,
  * //     access: "EVERYBODY" || "ORGANIZATION",
  * //     id: "STRING_VALUE", // required
+ * //     category: "STRING_VALUE",
  * //     integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
  * //     integrationApiKeysCount: Number("int"), // required
  * //     createdAt: "STRING_VALUE", // required

package/dist-types/models/models_0.d.ts

@@ -570,6 +570,11 @@ export interface Bot {
      */
     access?: BotAccess | undefined;
     id: string;
+    /**
+     * Category of the bot
+     * @public
+     */
+    category?: string | undefined;
     integrationType: BotIntegrationType;
     integrationApiKeysCount: number;
     createdAt: string;
@@ -594,6 +599,132 @@ export declare class BotApiKeyNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<BotApiKeyNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface BotKnowledgeBase {
+    knowledgeBaseId?: string | undefined;
+    /**
+     * Additional instructions for when the bot should use this knowledge base.
+     * @public
+     */
+    instructions?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface BotToolVariableAutoHandler {
+}
+/**
+ * @public
+ */
+export interface BotToolVariableGuidedHandler {
+    description: string;
+}
+/**
+ * @public
+ */
+export interface BotToolVariablePredefinedHandler {
+    description: string;
+}
+/**
+ * @public
+ */
+export type BotToolVariableHandler = BotToolVariableHandler.AutoMember | BotToolVariableHandler.GuidedMember | BotToolVariableHandler.PredefinedMember | BotToolVariableHandler.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace BotToolVariableHandler {
+    interface AutoMember {
+        auto: BotToolVariableAutoHandler;
+        guided?: never;
+        predefined?: never;
+        $unknown?: never;
+    }
+    interface GuidedMember {
+        auto?: never;
+        guided: BotToolVariableGuidedHandler;
+        predefined?: never;
+        $unknown?: never;
+    }
+    interface PredefinedMember {
+        auto?: never;
+        guided?: never;
+        predefined: BotToolVariablePredefinedHandler;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        auto?: never;
+        guided?: never;
+        predefined?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        auto: (value: BotToolVariableAutoHandler) => T;
+        guided: (value: BotToolVariableGuidedHandler) => T;
+        predefined: (value: BotToolVariablePredefinedHandler) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: BotToolVariableHandler, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface BotToolVariable {
+    /**
+     * Name of the tool variable, e.g.: 'myvar'
+     * @public
+     */
+    name: string;
+    handler?: BotToolVariableHandler | undefined;
+}
+/**
+ * @public
+ */
+export interface BotCapabilityTool {
+    /**
+     * Unique identifier of the tool using nanoid format
+     * @public
+     */
+    id: string;
+    variables?: (BotToolVariable)[] | undefined;
+}
+/**
+ * @public
+ */
+export type BotCapability = BotCapability.KbMember | BotCapability.ToolMember | BotCapability.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace BotCapability {
+    interface ToolMember {
+        tool: BotCapabilityTool;
+        kb?: never;
+        $unknown?: never;
+    }
+    interface KbMember {
+        tool?: never;
+        kb: BotKnowledgeBase;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        tool?: never;
+        kb?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        tool: (value: BotCapabilityTool) => T;
+        kb: (value: BotKnowledgeBase) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: BotCapability, visitor: Visitor<T>) => T;
+}
 /**
  * @public
  * @enum
@@ -806,6 +937,7 @@ export interface BotLlmEndpoint {
      * @public
      */
     tools?: (BotLlmTool)[] | undefined;
+    capabilities?: (BotCapability)[] | undefined;
 }
 /**
  * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/xbees-users-client",
     "description": "@wildix/xbees-users-client client",
-    "version": "1.0.46",
+    "version": "1.0.48",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",