@wildix/xbees-users-client 1.0.32 → 1.0.34

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

@@ -44,6 +44,55 @@ declare const GetBotCallbackCommand_base: {
  * // { // GetBotCallbackOutput
  * //   callback: { // BotCallback
  * //     endpoint: { // BotEndpoint Union: only one key present
+ * //       llm: { // BotLlmEndpoint
+ * //         prompt: "STRING_VALUE", // required
+ * //         embeddedTools: [ // BotEmbeddedToolsList
+ * //           { // BotEmbeddedTool
+ * //             type: "HANDOVER" || "DELEGATE", // required
+ * //             name: "STRING_VALUE", // required
+ * //             parameters: "DOCUMENT_VALUE",
+ * //           },
+ * //         ],
+ * //         tools: [ // BotToolsList
+ * //           { // BotTool
+ * //             type: "function", // required
+ * //             function: { // BotFunctionDefinition
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               parameters: "DOCUMENT_VALUE",
+ * //               integration: { // BotFunctionIntegration Union: only one key present
+ * //                 webhook: { // BotFunctionIntegrationWebhook
+ * //                   url: "STRING_VALUE", // required
+ * //                   method: "get" || "post" || "put" || "delete" || "patch",
+ * //                   async: true || false,
+ * //                   authorization: { // BotFunctionIntegrationWebhookAuthorization Union: only one key present
+ * //                     bearer: { // BotFunctionIntegrationWebhookAuthorizationBearer
+ * //                       token: "STRING_VALUE", // required
+ * //                     },
+ * //                     basic: { // BotFunctionIntegrationWebhookAuthorizationBasic
+ * //                       username: "STRING_VALUE", // required
+ * //                       password: "STRING_VALUE", // required
+ * //                     },
+ * //                     oauth: { // BotFunctionIntegrationWebhookAuthorizationOAuth
+ * //                       clientId: "STRING_VALUE", // required
+ * //                       clientSecret: "STRING_VALUE", // required
+ * //                       endpointUrl: "STRING_VALUE", // required
+ * //                       scope: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                   headers: [ // BotFunctionIntegrationWebhookHeadersList
+ * //                     { // BotFunctionIntegrationWebhookHeader
+ * //                       key: "STRING_VALUE", // required
+ * //                       value: "STRING_VALUE", // required
+ * //                     },
+ * //                   ],
+ * //                   parameters: "DOCUMENT_VALUE",
+ * //                 },
+ * //               },
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required
  * //         agent: "STRING_VALUE", // required

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

@@ -40,6 +40,55 @@ declare const UpdateBotCallbackCommand_base: {
  *   botId: "STRING_VALUE", // required
  *   callback: { // BotCallback
  *     endpoint: { // BotEndpoint Union: only one key present
+ *       llm: { // BotLlmEndpoint
+ *         prompt: "STRING_VALUE", // required
+ *         embeddedTools: [ // BotEmbeddedToolsList
+ *           { // BotEmbeddedTool
+ *             type: "HANDOVER" || "DELEGATE", // required
+ *             name: "STRING_VALUE", // required
+ *             parameters: "DOCUMENT_VALUE",
+ *           },
+ *         ],
+ *         tools: [ // BotToolsList
+ *           { // BotTool
+ *             type: "function", // required
+ *             function: { // BotFunctionDefinition
+ *               name: "STRING_VALUE", // required
+ *               description: "STRING_VALUE",
+ *               parameters: "DOCUMENT_VALUE",
+ *               integration: { // BotFunctionIntegration Union: only one key present
+ *                 webhook: { // BotFunctionIntegrationWebhook
+ *                   url: "STRING_VALUE", // required
+ *                   method: "get" || "post" || "put" || "delete" || "patch",
+ *                   async: true || false,
+ *                   authorization: { // BotFunctionIntegrationWebhookAuthorization Union: only one key present
+ *                     bearer: { // BotFunctionIntegrationWebhookAuthorizationBearer
+ *                       token: "STRING_VALUE", // required
+ *                     },
+ *                     basic: { // BotFunctionIntegrationWebhookAuthorizationBasic
+ *                       username: "STRING_VALUE", // required
+ *                       password: "STRING_VALUE", // required
+ *                     },
+ *                     oauth: { // BotFunctionIntegrationWebhookAuthorizationOAuth
+ *                       clientId: "STRING_VALUE", // required
+ *                       clientSecret: "STRING_VALUE", // required
+ *                       endpointUrl: "STRING_VALUE", // required
+ *                       scope: "STRING_VALUE",
+ *                     },
+ *                   },
+ *                   headers: [ // BotFunctionIntegrationWebhookHeadersList
+ *                     { // BotFunctionIntegrationWebhookHeader
+ *                       key: "STRING_VALUE", // required
+ *                       value: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                   parameters: "DOCUMENT_VALUE",
+ *                 },
+ *               },
+ *             },
+ *           },
+ *         ],
+ *       },
  *       dialogflowCx: { // BotDialogflowCxEndpoint
  *         credentials: "DOCUMENT_VALUE", // required
  *         agent: "STRING_VALUE", // required
@@ -67,6 +116,55 @@ declare const UpdateBotCallbackCommand_base: {
  * // { // UpdateBotCallbackOutput
  * //   callback: { // BotCallback
  * //     endpoint: { // BotEndpoint Union: only one key present
+ * //       llm: { // BotLlmEndpoint
+ * //         prompt: "STRING_VALUE", // required
+ * //         embeddedTools: [ // BotEmbeddedToolsList
+ * //           { // BotEmbeddedTool
+ * //             type: "HANDOVER" || "DELEGATE", // required
+ * //             name: "STRING_VALUE", // required
+ * //             parameters: "DOCUMENT_VALUE",
+ * //           },
+ * //         ],
+ * //         tools: [ // BotToolsList
+ * //           { // BotTool
+ * //             type: "function", // required
+ * //             function: { // BotFunctionDefinition
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               parameters: "DOCUMENT_VALUE",
+ * //               integration: { // BotFunctionIntegration Union: only one key present
+ * //                 webhook: { // BotFunctionIntegrationWebhook
+ * //                   url: "STRING_VALUE", // required
+ * //                   method: "get" || "post" || "put" || "delete" || "patch",
+ * //                   async: true || false,
+ * //                   authorization: { // BotFunctionIntegrationWebhookAuthorization Union: only one key present
+ * //                     bearer: { // BotFunctionIntegrationWebhookAuthorizationBearer
+ * //                       token: "STRING_VALUE", // required
+ * //                     },
+ * //                     basic: { // BotFunctionIntegrationWebhookAuthorizationBasic
+ * //                       username: "STRING_VALUE", // required
+ * //                       password: "STRING_VALUE", // required
+ * //                     },
+ * //                     oauth: { // BotFunctionIntegrationWebhookAuthorizationOAuth
+ * //                       clientId: "STRING_VALUE", // required
+ * //                       clientSecret: "STRING_VALUE", // required
+ * //                       endpointUrl: "STRING_VALUE", // required
+ * //                       scope: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                   headers: [ // BotFunctionIntegrationWebhookHeadersList
+ * //                     { // BotFunctionIntegrationWebhookHeader
+ * //                       key: "STRING_VALUE", // required
+ * //                       value: "STRING_VALUE", // required
+ * //                     },
+ * //                   ],
+ * //                   parameters: "DOCUMENT_VALUE",
+ * //                 },
+ * //               },
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required
  * //         agent: "STRING_VALUE", // required

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

@@ -1,5 +1,4 @@
 export * from "./BatchGetUsersCommand";
-export * from "./BatchGetUsersEmailNotificationsSettingsCommand";
 export * from "./BatchGetUsersPbxLinkDataCommand";
 export * from "./BatchGetUsersPbxLinkDataV1Command";
 export * from "./ChangeUserEmailCommand";
@@ -11,21 +10,16 @@ export * from "./DeleteBotApiKeyCommand";
 export * from "./GetBotCommand";
 export * from "./GetBotCallbackCommand";
 export * from "./GetUserCommand";
-export * from "./GetUserEmailNotificationsSettingsCommand";
 export * from "./GetUserPbxLinkDataCommand";
 export * from "./GetUserPbxLinkSuggestionCommand";
 export * from "./GetUserPbxLinkSuggestionV1Command";
 export * from "./ListBotApiKeysCommand";
 export * from "./ListBotsCommand";
-export * from "./PartialUpdateUserEmailNotificationsSettingsCommand";
 export * from "./QueryColleaguesCommand";
 export * from "./QueryUserCommand";
 export * from "./QueryUsersCommand";
-export * from "./ToggleTranscriptionEmailNotificationsSubscriptionCommand";
-export * from "./ToggleUnreadEmailNotificationsSubscriptionCommand";
 export * from "./UpdateBotCommand";
 export * from "./UpdateBotCallbackCommand";
-export * from "./UpdateUserEmailNotificationsSettingsCommand";
 export * from "./UploadPictureCommand";
 export * from "./UploadPictureV1Command";
 export * from "./VerifyBotSecretKeyCommand";

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

@@ -214,37 +214,6 @@ export interface BatchGetUsersOutput {
      */
     users: (User)[];
 }
-/**
- * @public
- */
-export interface BatchGetUsersEmailNotificationsSettingsInput {
-    /**
-     * List of the unique identifier of the user
-     * @public
-     */
-    usersIds: (string)[];
-}
-/**
- * @public
- */
-export interface UserEmailNotificationsSettings {
-    /**
-     * A flag that indicates whether the system should send email notifications about unread messages.
-     * @public
-     */
-    unread: boolean;
-    /**
-     * A flag that indicates whether the system should send email notifications about AI transcription.
-     * @public
-     */
-    transcription: boolean;
-}
-/**
- * @public
- */
-export interface BatchGetUsersEmailNotificationsSettingsOutput {
-    notifications: Record<string, UserEmailNotificationsSettings>;
-}
 /**
  * @public
  */
@@ -551,15 +520,226 @@ export declare class BotApiKeyNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<BotApiKeyNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const BotEmbeddedToolType: {
+    readonly DELEGATE: "DELEGATE";
+    readonly TRANSFER: "HANDOVER";
+};
+/**
+ * @public
+ */
+export type BotEmbeddedToolType = typeof BotEmbeddedToolType[keyof typeof BotEmbeddedToolType];
+/**
+ * @public
+ */
+export interface BotEmbeddedTool {
+    type: BotEmbeddedToolType;
+    name: string;
+    /**
+     * The parameters the functions accepts.
+     * @public
+     */
+    parameters?: __DocumentType;
+}
+/**
+ * @public
+ */
+export interface BotFunctionIntegrationWebhookAuthorizationBasic {
+    username: string;
+    password: string;
+}
+/**
+ * @public
+ */
+export interface BotFunctionIntegrationWebhookAuthorizationBearer {
+    token: string;
+}
+/**
+ * @public
+ */
+export interface BotFunctionIntegrationWebhookAuthorizationOAuth {
+    clientId: string;
+    clientSecret: string;
+    endpointUrl: string;
+    scope?: string;
+}
+/**
+ * @public
+ */
+export type BotFunctionIntegrationWebhookAuthorization = BotFunctionIntegrationWebhookAuthorization.BasicMember | BotFunctionIntegrationWebhookAuthorization.BearerMember | BotFunctionIntegrationWebhookAuthorization.OauthMember | BotFunctionIntegrationWebhookAuthorization.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace BotFunctionIntegrationWebhookAuthorization {
+    interface BearerMember {
+        bearer: BotFunctionIntegrationWebhookAuthorizationBearer;
+        basic?: never;
+        oauth?: never;
+        $unknown?: never;
+    }
+    interface BasicMember {
+        bearer?: never;
+        basic: BotFunctionIntegrationWebhookAuthorizationBasic;
+        oauth?: never;
+        $unknown?: never;
+    }
+    interface OauthMember {
+        bearer?: never;
+        basic?: never;
+        oauth: BotFunctionIntegrationWebhookAuthorizationOAuth;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        bearer?: never;
+        basic?: never;
+        oauth?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        bearer: (value: BotFunctionIntegrationWebhookAuthorizationBearer) => T;
+        basic: (value: BotFunctionIntegrationWebhookAuthorizationBasic) => T;
+        oauth: (value: BotFunctionIntegrationWebhookAuthorizationOAuth) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: BotFunctionIntegrationWebhookAuthorization, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface BotFunctionIntegrationWebhookHeader {
+    key: string;
+    value: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const BotFunctionIntegrationMethod: {
+    readonly DELETE: "delete";
+    readonly GET: "get";
+    readonly PATCH: "patch";
+    readonly POST: "post";
+    readonly PUT: "put";
+};
+/**
+ * @public
+ */
+export type BotFunctionIntegrationMethod = typeof BotFunctionIntegrationMethod[keyof typeof BotFunctionIntegrationMethod];
+/**
+ * @public
+ */
+export interface BotFunctionIntegrationWebhook {
+    url: string;
+    method?: BotFunctionIntegrationMethod;
+    async?: boolean;
+    authorization?: BotFunctionIntegrationWebhookAuthorization;
+    headers?: (BotFunctionIntegrationWebhookHeader)[];
+    parameters?: __DocumentType;
+}
+/**
+ * @public
+ */
+export type BotFunctionIntegration = BotFunctionIntegration.WebhookMember | BotFunctionIntegration.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace BotFunctionIntegration {
+    interface WebhookMember {
+        webhook: BotFunctionIntegrationWebhook;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        webhook?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        webhook: (value: BotFunctionIntegrationWebhook) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: BotFunctionIntegration, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface BotFunctionDefinition {
+    /**
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+     * @public
+     */
+    name: string;
+    /**
+     * A description of what the function does, used by the model to choose when and how to call the function.
+     * @public
+     */
+    description?: string;
+    /**
+     * The parameters the functions accepts, described as a JSON Schema object.
+     * @public
+     */
+    parameters?: __DocumentType;
+    integration?: BotFunctionIntegration;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const BotToolType: {
+    readonly FUNCTION: "function";
+};
+/**
+ * @public
+ */
+export type BotToolType = typeof BotToolType[keyof typeof BotToolType];
+/**
+ * @public
+ */
+export interface BotTool {
+    type: BotToolType;
+    function?: BotFunctionDefinition;
+}
+/**
+ * @public
+ */
+export interface BotLlmEndpoint {
+    prompt: string;
+    /**
+     * Embedded functions to use within voice session.
+     * @public
+     */
+    embeddedTools?: (BotEmbeddedTool)[];
+    /**
+     * Custom tools to be used within voice session.
+     * @public
+     */
+    tools?: (BotTool)[];
+}
 /**
  * @public
  */
-export type BotEndpoint = BotEndpoint.DialogflowCxMember | BotEndpoint.OpenAiAssistantMember | BotEndpoint.SqsMember | BotEndpoint.WebhookMember | BotEndpoint.$UnknownMember;
+export type BotEndpoint = BotEndpoint.DialogflowCxMember | BotEndpoint.LlmMember | BotEndpoint.OpenAiAssistantMember | BotEndpoint.SqsMember | BotEndpoint.WebhookMember | BotEndpoint.$UnknownMember;
 /**
  * @public
  */
 export declare namespace BotEndpoint {
+    interface LlmMember {
+        llm: BotLlmEndpoint;
+        dialogflowCx?: never;
+        openAiAssistant?: never;
+        webhook?: never;
+        sqs?: never;
+        $unknown?: never;
+    }
     interface DialogflowCxMember {
+        llm?: never;
         dialogflowCx: BotDialogflowCxEndpoint;
         openAiAssistant?: never;
         webhook?: never;
@@ -567,6 +747,7 @@ export declare namespace BotEndpoint {
         $unknown?: never;
     }
     interface OpenAiAssistantMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant: BotOpenAiAssistantEndpoint;
         webhook?: never;
@@ -574,6 +755,7 @@ export declare namespace BotEndpoint {
         $unknown?: never;
     }
     interface WebhookMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant?: never;
         webhook: BotWebhookEndpoint;
@@ -581,6 +763,7 @@ export declare namespace BotEndpoint {
         $unknown?: never;
     }
     interface SqsMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant?: never;
         webhook?: never;
@@ -591,6 +774,7 @@ export declare namespace BotEndpoint {
      * @public
      */
     interface $UnknownMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant?: never;
         webhook?: never;
@@ -598,6 +782,7 @@ export declare namespace BotEndpoint {
         $unknown: [string, any];
     }
     interface Visitor<T> {
+        llm: (value: BotLlmEndpoint) => T;
         dialogflowCx: (value: BotDialogflowCxEndpoint) => T;
         openAiAssistant: (value: BotOpenAiAssistantEndpoint) => T;
         webhook: (value: BotWebhookEndpoint) => T;
@@ -824,22 +1009,6 @@ export interface GetUserInput {
 export interface GetUserOutput {
     user: User;
 }
-/**
- * @public
- */
-export interface GetUserEmailNotificationsSettingsInput {
-    /**
-     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
-     * @public
-     */
-    userId: string;
-}
-/**
- * @public
- */
-export interface GetUserEmailNotificationsSettingsOutput {
-    notifications: UserEmailNotificationsSettings;
-}
 /**
  * @public
  */
@@ -936,32 +1105,6 @@ export interface ListBotsInput {
 export interface ListBotsOutput {
     bots: (Bot)[];
 }
-/**
- * @public
- */
-export interface PartialUpdateUserEmailNotificationsSettingsInput {
-    /**
-     * A flag that indicates whether the system should send email notifications about unread messages.
-     * @public
-     */
-    unread?: boolean;
-    /**
-     * A flag that indicates whether the system should send email notifications about AI transcription.
-     * @public
-     */
-    transcription?: boolean;
-    /**
-     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
-     * @public
-     */
-    userId: string;
-}
-/**
- * @public
- */
-export interface PartialUpdateUserEmailNotificationsSettingsOutput {
-    notifications: UserEmailNotificationsSettings;
-}
 /**
  * @public
  */
@@ -1127,38 +1270,6 @@ export interface QueryUsersOutput {
      */
     users: (User)[];
 }
-/**
- * @public
- */
-export interface ToggleTranscriptionEmailNotificationsSubscriptionInput {
-    unsubscribeToken: string;
-    /**
-     * A flag that indicates whether the system should send email notifications about AI transcription.
-     * @public
-     */
-    subscribe: boolean;
-}
-/**
- * @public
- */
-export interface ToggleTranscriptionEmailNotificationsSubscriptionOutput {
-}
-/**
- * @public
- */
-export interface ToggleUnreadEmailNotificationsSubscriptionInput {
-    unsubscribeToken: string;
-    /**
-     * A flag that indicates whether the system should send email notifications about unread messages.
-     * @public
-     */
-    subscribe: boolean;
-}
-/**
- * @public
- */
-export interface ToggleUnreadEmailNotificationsSubscriptionOutput {
-}
 /**
  * @public
  */
@@ -1189,32 +1300,6 @@ export interface UpdateBotCallbackInput {
 export interface UpdateBotCallbackOutput {
     callback: BotCallback;
 }
-/**
- * @public
- */
-export interface UpdateUserEmailNotificationsSettingsInput {
-    /**
-     * A flag that indicates whether the system should send email notifications about unread messages.
-     * @public
-     */
-    unread?: boolean;
-    /**
-     * A flag that indicates whether the system should send email notifications about AI transcription.
-     * @public
-     */
-    transcription?: boolean;
-    /**
-     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
-     * @public
-     */
-    userId: string;
-}
-/**
- * @public
- */
-export interface UpdateUserEmailNotificationsSettingsOutput {
-    notifications: UserEmailNotificationsSettings;
-}
 /**
  * @public
  */