@wildix/xbees-users-client 1.3.0 → 1.3.2

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkspaceNotFoundException = exports.UserQueryPredicateNotMetException = exports.UserQuery = exports.IdentityNotFoundException = exports.IdentityAlreadyLinkedException = exports.WorkspaceType = exports.PublicAccessIsRestrictedException = exports.UserNotFoundException = exports.UserCompanyNotValidException = exports.CannotUnbindDefaultWorkspaceException = exports.CannotRemovePrimaryIdentityException = exports.BotSecretKeyNotValidException = exports.BotNotFoundException = exports.BotEndpoint = exports.BotLlmToolType = exports.BotLlmFunctionIntegration = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmFunctionIntegrationWebhookAuthorization = exports.BotLlmEmbeddedToolType = exports.BotCapability = exports.BotToolVariableHandler = exports.BotCapabilityToolPipelineType = exports.BotApiKeyNotFoundException = exports.BotIntegrationType = exports.BotAccess = exports.AppType = exports.AnonymousEntryContext = exports.AccountNotFoundException = exports.WidgetNotFoundException = exports.ChannelNotFoundException = exports.PbxColleaguesSearchStrategy = exports.PbxColleaguesQueryField = exports.GetPbxColleaguesDir = exports.PbxColleagueRole = exports.PbxLicenseType = exports.ValidationException = exports.ForbiddenException = void 0;
+exports.WorkspaceNotFoundException = exports.UserQueryPredicateNotMetException = exports.UserQuery = exports.IdentityNotFoundException = exports.IdentityAlreadyLinkedException = exports.WorkspaceType = exports.PublicAccessIsRestrictedException = exports.UserNotFoundException = exports.UserCompanyNotValidException = exports.CannotUnbindDefaultWorkspaceException = exports.CannotRemovePrimaryIdentityException = exports.BotSecretKeyNotValidException = exports.BotNotFoundException = exports.BotEndpoint = exports.BotLlmToolType = exports.BotLlmFunctionIntegration = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmFunctionIntegrationWebhookAuthorization = exports.BotLlmEmbeddedToolType = exports.BotCapability = exports.BotToolVariableHandler = exports.BotCapabilityToolPipelineType = exports.BotToolAnnotation = exports.BotApiKeyNotFoundException = exports.BotIntegrationType = exports.BotAccess = exports.AppType = exports.AnonymousEntryContext = exports.AccountNotFoundException = exports.WidgetNotFoundException = exports.ChannelNotFoundException = 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";
@@ -147,6 +147,20 @@ class BotApiKeyNotFoundException extends UsersServiceException_1.UsersServiceExc
     }
 }
 exports.BotApiKeyNotFoundException = BotApiKeyNotFoundException;
+var BotToolAnnotation;
+(function (BotToolAnnotation) {
+    BotToolAnnotation.visit = (value, visitor) => {
+        if (value.tag !== undefined)
+            return visitor.tag(value.tag);
+        if (value.comment !== undefined)
+            return visitor.comment(value.comment);
+        if (value.variables !== undefined)
+            return visitor.variables(value.variables);
+        if (value.result !== undefined)
+            return visitor.result(value.result);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(BotToolAnnotation || (exports.BotToolAnnotation = BotToolAnnotation = {}));
 exports.BotCapabilityToolPipelineType = {
     ASYNC_REQUEST: "async_request",
     ASYNC_REQUEST_GUIDED: "async_request_guided",

package/dist-cjs/protocols/Aws_restJson1.js

@@ -1077,6 +1077,7 @@ const de_InviteCommand = async (output, context) => {
     });
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
+        'skippedInvitees': smithy_client_1._json,
         'users': smithy_client_1._json,
     });
     Object.assign(contents, doc);
@@ -1733,6 +1734,7 @@ const se_BotEndpoint = (input, context) => {
 };
 const se_BotLlmEmbeddedTool = (input, context) => {
     return (0, smithy_client_1.take)(input, {
+        'annotations': smithy_client_1._json,
         'name': [],
         'parameters': _ => se_Document(_, context),
         'type': [],
@@ -1780,6 +1782,7 @@ const se_BotLlmFunctionIntegrationWebhook = (input, context) => {
 };
 const se_BotLlmTool = (input, context) => {
     return (0, smithy_client_1.take)(input, {
+        'annotations': smithy_client_1._json,
         'function': _ => se_BotLlmFunctionDefinition(_, context),
         'type': [],
     });
@@ -1835,6 +1838,7 @@ const de_BotEndpoint = (output, context) => {
 };
 const de_BotLlmEmbeddedTool = (output, context) => {
     return (0, smithy_client_1.take)(output, {
+        'annotations': smithy_client_1._json,
         'name': smithy_client_1.expectString,
         'parameters': (_) => de_Document(_, context),
         'type': smithy_client_1.expectString,
@@ -1885,6 +1889,7 @@ const de_BotLlmFunctionIntegrationWebhook = (output, context) => {
 };
 const de_BotLlmTool = (output, context) => {
     return (0, smithy_client_1.take)(output, {
+        'annotations': smithy_client_1._json,
         'function': (_) => de_BotLlmFunctionDefinition(_, context),
         'type': smithy_client_1.expectString,
     });

package/dist-es/models/models_0.js

@@ -138,6 +138,20 @@ export class BotApiKeyNotFoundException extends __BaseException {
         Object.setPrototypeOf(this, BotApiKeyNotFoundException.prototype);
     }
 }
+export var BotToolAnnotation;
+(function (BotToolAnnotation) {
+    BotToolAnnotation.visit = (value, visitor) => {
+        if (value.tag !== undefined)
+            return visitor.tag(value.tag);
+        if (value.comment !== undefined)
+            return visitor.comment(value.comment);
+        if (value.variables !== undefined)
+            return visitor.variables(value.variables);
+        if (value.result !== undefined)
+            return visitor.result(value.result);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(BotToolAnnotation || (BotToolAnnotation = {}));
 export const BotCapabilityToolPipelineType = {
     ASYNC_REQUEST: "async_request",
     ASYNC_REQUEST_GUIDED: "async_request_guided",

package/dist-es/protocols/Aws_restJson1.js

@@ -1007,6 +1007,7 @@ export const de_InviteCommand = async (output, context) => {
     });
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
+        'skippedInvitees': _json,
         'users': _json,
     });
     Object.assign(contents, doc);
@@ -1639,6 +1640,7 @@ const se_BotEndpoint = (input, context) => {
 };
 const se_BotLlmEmbeddedTool = (input, context) => {
     return take(input, {
+        'annotations': _json,
         'name': [],
         'parameters': _ => se_Document(_, context),
         'type': [],
@@ -1686,6 +1688,7 @@ const se_BotLlmFunctionIntegrationWebhook = (input, context) => {
 };
 const se_BotLlmTool = (input, context) => {
     return take(input, {
+        'annotations': _json,
         'function': _ => se_BotLlmFunctionDefinition(_, context),
         'type': [],
     });
@@ -1741,6 +1744,7 @@ const de_BotEndpoint = (output, context) => {
 };
 const de_BotLlmEmbeddedTool = (output, context) => {
     return take(output, {
+        'annotations': _json,
         'name': __expectString,
         'parameters': (_) => de_Document(_, context),
         'type': __expectString,
@@ -1791,6 +1795,7 @@ const de_BotLlmFunctionIntegrationWebhook = (output, context) => {
 };
 const de_BotLlmTool = (output, context) => {
     return take(output, {
+        'annotations': _json,
         'function': (_) => de_BotLlmFunctionDefinition(_, context),
         'type': __expectString,
     });

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

@@ -55,6 +55,22 @@ declare const CreateBotCommand_base: {
  *             type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
  *             name: "STRING_VALUE", // required
  *             parameters: "DOCUMENT_VALUE",
+ *             annotations: [ // BotToolAnnotationsList
+ *               { // BotToolAnnotation Union: only one key present
+ *                 tag: { // BotToolTagAnnotation
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 comment: { // BotToolCommentAnnotation
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 variables: {},
+ *                 result: {},
+ *               },
+ *             ],
  *           },
  *         ],
  *         tools: [ // BotLlmToolsList
@@ -95,6 +111,22 @@ declare const CreateBotCommand_base: {
  *                 },
  *               },
  *             },
+ *             annotations: [
+ *               {//  Union: only one key present
+ *                 tag: {
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 comment: {
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 variables: {},
+ *                 result: {},
+ *               },
+ *             ],
  *           },
  *         ],
  *         capabilities: [ // BotCapabilitiesList
@@ -119,10 +151,42 @@ declare const CreateBotCommand_base: {
  *                 type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  *                 instructions: "STRING_VALUE",
  *               },
+ *               annotations: [
+ *                 {//  Union: only one key present
+ *                   tag: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   comment: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   variables: {},
+ *                   result: {},
+ *                 },
+ *               ],
  *             },
  *             kb: { // BotKnowledgeBase
  *               knowledgeBaseId: "STRING_VALUE",
  *               instructions: "STRING_VALUE",
+ *               annotations: [
+ *                 {//  Union: only one key present
+ *                   tag: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   comment: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   variables: {},
+ *                   result: {},
+ *                 },
+ *               ],
  *             },
  *           },
  *         ],

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

@@ -54,6 +54,22 @@ declare const GetBotCallbackCommand_base: {
  * //             type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
  * //             name: "STRING_VALUE", // required
  * //             parameters: "DOCUMENT_VALUE",
+ * //             annotations: [ // BotToolAnnotationsList
+ * //               { // BotToolAnnotation Union: only one key present
+ * //                 tag: { // BotToolTagAnnotation
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 comment: { // BotToolCommentAnnotation
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 variables: {},
+ * //                 result: {},
+ * //               },
+ * //             ],
  * //           },
  * //         ],
  * //         tools: [ // BotLlmToolsList
@@ -94,6 +110,22 @@ declare const GetBotCallbackCommand_base: {
  * //                 },
  * //               },
  * //             },
+ * //             annotations: [
+ * //               {//  Union: only one key present
+ * //                 tag: {
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 comment: {
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 variables: {},
+ * //                 result: {},
+ * //               },
+ * //             ],
  * //           },
  * //         ],
  * //         capabilities: [ // BotCapabilitiesList
@@ -118,10 +150,42 @@ declare const GetBotCallbackCommand_base: {
  * //                 type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  * //                 instructions: "STRING_VALUE",
  * //               },
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
  * //             },
  * //             kb: { // BotKnowledgeBase
  * //               knowledgeBaseId: "STRING_VALUE",
  * //               instructions: "STRING_VALUE",
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
  * //             },
  * //           },
  * //         ],

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

@@ -28,6 +28,8 @@ declare const InviteCommand_base: {
 };
 /**
  * Invite a list of users to x-bees. This operation creates an account for specified emails or phone numbers. Use this method to create users who can be added to conversations later.
+ * If an invitee resolves to an account that is currently deactivated in GetStream, the operation does not fail; instead, that invitee is reported in `skippedInvitees` and is not included in `users`.
+ *
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -69,6 +71,13 @@ declare const InviteCommand_base: {
  * //       updatedAt: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   skippedInvitees: [ // SkippedMembersList // required
+ * //     { // SkippedMember
+ * //       id: "STRING_VALUE",
+ * //       email: "STRING_VALUE",
+ * //       phone: "STRING_VALUE",
+ * //     },
+ * //   ],
  * // };
  *
  * ```

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

@@ -50,6 +50,22 @@ declare const UpdateBotCallbackCommand_base: {
  *             type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
  *             name: "STRING_VALUE", // required
  *             parameters: "DOCUMENT_VALUE",
+ *             annotations: [ // BotToolAnnotationsList
+ *               { // BotToolAnnotation Union: only one key present
+ *                 tag: { // BotToolTagAnnotation
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 comment: { // BotToolCommentAnnotation
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 variables: {},
+ *                 result: {},
+ *               },
+ *             ],
  *           },
  *         ],
  *         tools: [ // BotLlmToolsList
@@ -90,6 +106,22 @@ declare const UpdateBotCallbackCommand_base: {
  *                 },
  *               },
  *             },
+ *             annotations: [
+ *               {//  Union: only one key present
+ *                 tag: {
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 comment: {
+ *                   value: "STRING_VALUE",
+ *                   applyOnSuccess: true || false,
+ *                   applyOnFailure: true || false,
+ *                 },
+ *                 variables: {},
+ *                 result: {},
+ *               },
+ *             ],
  *           },
  *         ],
  *         capabilities: [ // BotCapabilitiesList
@@ -114,10 +146,42 @@ declare const UpdateBotCallbackCommand_base: {
  *                 type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  *                 instructions: "STRING_VALUE",
  *               },
+ *               annotations: [
+ *                 {//  Union: only one key present
+ *                   tag: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   comment: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   variables: {},
+ *                   result: {},
+ *                 },
+ *               ],
  *             },
  *             kb: { // BotKnowledgeBase
  *               knowledgeBaseId: "STRING_VALUE",
  *               instructions: "STRING_VALUE",
+ *               annotations: [
+ *                 {//  Union: only one key present
+ *                   tag: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   comment: {
+ *                     value: "STRING_VALUE",
+ *                     applyOnSuccess: true || false,
+ *                     applyOnFailure: true || false,
+ *                   },
+ *                   variables: {},
+ *                   result: {},
+ *                 },
+ *               ],
  *             },
  *           },
  *         ],
@@ -160,6 +224,22 @@ declare const UpdateBotCallbackCommand_base: {
  * //             type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
  * //             name: "STRING_VALUE", // required
  * //             parameters: "DOCUMENT_VALUE",
+ * //             annotations: [ // BotToolAnnotationsList
+ * //               { // BotToolAnnotation Union: only one key present
+ * //                 tag: { // BotToolTagAnnotation
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 comment: { // BotToolCommentAnnotation
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 variables: {},
+ * //                 result: {},
+ * //               },
+ * //             ],
  * //           },
  * //         ],
  * //         tools: [ // BotLlmToolsList
@@ -200,6 +280,22 @@ declare const UpdateBotCallbackCommand_base: {
  * //                 },
  * //               },
  * //             },
+ * //             annotations: [
+ * //               {//  Union: only one key present
+ * //                 tag: {
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 comment: {
+ * //                   value: "STRING_VALUE",
+ * //                   applyOnSuccess: true || false,
+ * //                   applyOnFailure: true || false,
+ * //                 },
+ * //                 variables: {},
+ * //                 result: {},
+ * //               },
+ * //             ],
  * //           },
  * //         ],
  * //         capabilities: [ // BotCapabilitiesList
@@ -224,10 +320,42 @@ declare const UpdateBotCallbackCommand_base: {
  * //                 type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  * //                 instructions: "STRING_VALUE",
  * //               },
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
  * //             },
  * //             kb: { // BotKnowledgeBase
  * //               knowledgeBaseId: "STRING_VALUE",
  * //               instructions: "STRING_VALUE",
+ * //               annotations: [
+ * //                 {//  Union: only one key present
+ * //                   tag: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   comment: {
+ * //                     value: "STRING_VALUE",
+ * //                     applyOnSuccess: true || false,
+ * //                     applyOnFailure: true || false,
+ * //                   },
+ * //                   variables: {},
+ * //                   result: {},
+ * //                 },
+ * //               ],
  * //             },
  * //           },
  * //         ],

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

@@ -227,6 +227,26 @@ export interface UserToInvite {
      */
     colleague?: boolean | undefined;
 }
+/**
+ * @public
+ */
+export interface SkippedMember {
+    /**
+     * The unique identifier of the skipped user if it is known.
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * The email address of the skipped user if it is known.
+     * @public
+     */
+    email?: string | undefined;
+    /**
+     * The phone number of the skipped user if it is known.
+     * @public
+     */
+    phone?: string | undefined;
+}
 /**
  * @public
  */
@@ -731,6 +751,132 @@ export declare class BotApiKeyNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<BotApiKeyNotFoundException, __BaseException>);
 }
+/**
+ * Comment annotation emitted after a tool completes.
+ * @public
+ */
+export interface BotToolCommentAnnotation {
+    /**
+     * Static handlebars expression resolved against bot variables and helpers.
+     * @public
+     */
+    value?: string | undefined;
+    /**
+     * Apply when the tool succeeds.
+     * @public
+     */
+    applyOnSuccess?: boolean | undefined;
+    /**
+     * Apply when the tool fails.
+     * @public
+     */
+    applyOnFailure?: boolean | undefined;
+}
+/**
+ * Result annotation emitted after a tool completes.
+ * @public
+ */
+export interface BotToolResultAnnotation {
+}
+/**
+ * Tag annotation emitted after a tool completes.
+ * @public
+ */
+export interface BotToolTagAnnotation {
+    /**
+     * Static handlebars expression resolved against bot variables and helpers.
+     * @public
+     */
+    value?: string | undefined;
+    /**
+     * Apply when the tool succeeds.
+     * @public
+     */
+    applyOnSuccess?: boolean | undefined;
+    /**
+     * Apply when the tool fails.
+     * @public
+     */
+    applyOnFailure?: boolean | undefined;
+}
+/**
+ * Variables annotation emitted after a tool completes.
+ * @public
+ */
+export interface BotToolVariablesAnnotation {
+}
+/**
+ * Configuration for annotations emitted after a tool completes. Tag and comment annotations can provide a handlebars value, while variables and result annotations opt into logging runtime data.
+ * @public
+ */
+export type BotToolAnnotation = BotToolAnnotation.CommentMember | BotToolAnnotation.ResultMember | BotToolAnnotation.TagMember | BotToolAnnotation.VariablesMember | BotToolAnnotation.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace BotToolAnnotation {
+    /**
+     * Tag annotation emitted after a tool completes.
+     * @public
+     */
+    interface TagMember {
+        tag: BotToolTagAnnotation;
+        comment?: never;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Comment annotation emitted after a tool completes.
+     * @public
+     */
+    interface CommentMember {
+        tag?: never;
+        comment: BotToolCommentAnnotation;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Variables annotation emitted after a tool completes.
+     * @public
+     */
+    interface VariablesMember {
+        tag?: never;
+        comment?: never;
+        variables: BotToolVariablesAnnotation;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Result annotation emitted after a tool completes.
+     * @public
+     */
+    interface ResultMember {
+        tag?: never;
+        comment?: never;
+        variables?: never;
+        result: BotToolResultAnnotation;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        tag?: never;
+        comment?: never;
+        variables?: never;
+        result?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        tag: (value: BotToolTagAnnotation) => T;
+        comment: (value: BotToolCommentAnnotation) => T;
+        variables: (value: BotToolVariablesAnnotation) => T;
+        result: (value: BotToolResultAnnotation) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: BotToolAnnotation, visitor: Visitor<T>) => T;
+}
 /**
  * @public
  */
@@ -741,6 +887,7 @@ export interface BotKnowledgeBase {
      * @public
      */
     instructions?: string | undefined;
+    annotations?: (BotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -853,6 +1000,7 @@ export interface BotCapabilityTool {
     id: string;
     variables?: (BotToolVariable)[] | undefined;
     pipeline?: BotCapabilityToolPipeline | undefined;
+    annotations?: (BotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -911,6 +1059,7 @@ export interface BotLlmEmbeddedTool {
      * @public
      */
     parameters?: __DocumentType | undefined;
+    annotations?: (BotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -1078,6 +1227,7 @@ export type BotLlmToolType = typeof BotLlmToolType[keyof typeof BotLlmToolType];
 export interface BotLlmTool {
     type: BotLlmToolType;
     function?: BotLlmFunctionDefinition | undefined;
+    annotations?: (BotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -1727,6 +1877,11 @@ export interface InviteOutput {
      * @public
      */
     users: (User)[];
+    /**
+     * A list of invitees that were skipped during the operation, for example because the resolved account is deactivated in GetStream. Each entry carries the email or phone supplied in the request, and the user id when it was already known.
+     * @public
+     */
+    skippedInvitees: (SkippedMember)[];
 }
 /**
  * @public

package/package.json

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