Skip to main content

@wildix/xbees-users-client

xbees-users-client package

Classes

Class

Description

BatchGetUsersCommand

Retrieves details of multiple users in a single batch operation.

BatchGetUsersEmailNotificationsSettingsCommand

Get multiple user settings by their IDs

BatchGetUsersPbxLinkDataCommand

Retrieves PBX link data for multiple users in a single batch operation.

BatchGetUsersPbxLinkDataV1Command

Retrieves PBX link data for multiple users in a single batch operation. This is a deprecated operation - use BatchGetUsersPbxLinkData instead.

BotApiKeyNotFoundException

BotNotFoundException

BotSecretKeyNotValidException

ChangeUserEmailCommand

Schedules user's email changing.

CreateBotApiKeyCommand

Creates a new API key for a specific bot.

CreateBotCommand

Creates a new bot with the specified configuration and callback settings.

CreateSystemBotCommand

Creates a new system bot with basic configuration for internal use.

DeleteBotApiKeyCommand

Deletes an existing API key for a specific bot.

DeleteBotCommand

Deletes an existing bot and all its associated data.

ForbiddenException

GetAppVersionCommand

Returns the current Google Play Store version of the Android app for the specified appType (X-Bees, X-Hoppers, Collaboration).

GetBotCallbackCommand

Retrieves the callback configuration for a specific bot.

GetBotCommand

Retrieves details of a specific bot by its unique identifier.

GetUserCommand

Retrieves details of a specific user by their unique identifier.

GetUserEmailNotificationsSettingsCommand

Getting user email notifications settings

GetUserPbxLinkDataCommand

Retrieves PBX link data for a specific user.

GetUserPbxLinkSuggestionCommand

Retrieves PBX link suggestion information for a user based on their email address.

GetUserPbxLinkSuggestionV1Command

Retrieves PBX link suggestion information for a user based on their email address. This is a deprecated operation - use GetUserPbxLinkSuggestion instead.

IntelligenceSearchCommand

Search user in the directory using AI. Result is sorted by relevance.

ListBotApiKeysCommand

Retrieves a list of API keys associated with a specific bot.

ListBotsCommand

Retrieves a list of all bots for the specified company.

PartialUpdateUserEmailNotificationsSettingsCommand

Partially update user email notifications settings

QueryColleaguesCommand

Searches for colleagues using various filters and search criteria, with optional auto-invitation for new users.

QueryUserCommand

Searches for a single user using a query with optional predicate validation.

QueryUsersCommand

Searches for multiple users using queries with optional predicate validation.

ToggleTranscriptionEmailNotificationsSubscriptionCommand

Using unsubscribeToken from email you can Toggle transcription email notifications subscription

ToggleUnreadEmailNotificationsSubscriptionCommand

Using unsubscribeToken from email you can Toggle unread messages email notifications subscription

UpdateBotCallbackCommand

Updates the callback configuration for a specific bot.

UpdateBotCommand

Updates the configuration of an existing bot.

UpdateUserEmailNotificationsSettingsCommand

Update user email notifications settings

UploadPictureCommand

Uploads a user profile picture in base64 format and returns the URL where it can be accessed.

UploadPictureV1Command

Uploads a user profile picture in base64 format and returns the URL where it can be accessed. This is a deprecated operation - use UploadPicture instead.

UserCompanyNotValidException

UserNotFoundException

UserQueryPredicateNotMetException

Users

UsersClient

UsersServiceException

Base exception class for all service exceptions from Users service.

ValidationException

VerifyBotSecretKeyCommand

Verifies a bot secret key and returns bot information if valid.

VerifyBotSecretKeyV1Command

Verifies a bot secret key and returns bot information if valid. This is a deprecated operation - use VerifyBotSecretKey instead.

Interfaces

Interface

Description

BatchGetUsersCommandInput

The input for BatchGetUsersCommand.

BatchGetUsersCommandOutput

The output of BatchGetUsersCommand.

BatchGetUsersEmailNotificationsSettingsCommandInput

The input for BatchGetUsersEmailNotificationsSettingsCommand.

BatchGetUsersEmailNotificationsSettingsCommandOutput

The output of BatchGetUsersEmailNotificationsSettingsCommand.

BatchGetUsersEmailNotificationsSettingsInput

BatchGetUsersEmailNotificationsSettingsOutput

BatchGetUsersInput

BatchGetUsersOutput

BatchGetUsersPbxLinkDataCommandInput

The input for BatchGetUsersPbxLinkDataCommand.

BatchGetUsersPbxLinkDataCommandOutput

The output of BatchGetUsersPbxLinkDataCommand.

BatchGetUsersPbxLinkDataInput

BatchGetUsersPbxLinkDataOutput

BatchGetUsersPbxLinkDataV1CommandInput

The input for BatchGetUsersPbxLinkDataV1Command.

BatchGetUsersPbxLinkDataV1CommandOutput

The output of BatchGetUsersPbxLinkDataV1Command.

BatchGetUsersPbxLinkDataV1Input

BatchGetUsersPbxLinkDataV1Output

Bot

BotApiKey

BotCallback

BotCapabilityTool

BotCapabilityToolPipeline

BotDialogflowCxEndpoint

BotKnowledgeBase

BotLlmEmbeddedTool

BotLlmEndpoint

BotLlmFunctionDefinition

BotLlmFunctionIntegrationWebhook

BotLlmFunctionIntegrationWebhookAuthorizationBasic

BotLlmFunctionIntegrationWebhookAuthorizationBearer

BotLlmFunctionIntegrationWebhookAuthorizationOAuth

BotLlmFunctionIntegrationWebhookHeader

BotLlmTool

BotOpenAiAssistantEndpoint

BotSqsEndpoint

BotToolVariable

BotToolVariableAutoHandler

BotToolVariableGuidedHandler

BotToolVariablePredefinedHandler

BotWebhookEndpoint

ChangeUserEmailCommandInput

The input for ChangeUserEmailCommand.

ChangeUserEmailCommandOutput

The output of ChangeUserEmailCommand.

ChangeUserEmailInput

ChangeUserEmailOutput

ClientDefaults

CreateBotApiKeyCommandInput

The input for CreateBotApiKeyCommand.

CreateBotApiKeyCommandOutput

The output of CreateBotApiKeyCommand.

CreateBotApiKeyInput

CreateBotApiKeyOutput

CreateBotCommandInput

The input for CreateBotCommand.

CreateBotCommandOutput

The output of CreateBotCommand.

CreateBotInput

CreateBotOutput

CreateSystemBotCommandInput

The input for CreateSystemBotCommand.

CreateSystemBotCommandOutput

The output of CreateSystemBotCommand.

CreateSystemBotInput

CreateSystemBotOutput

DeleteBotApiKeyCommandInput

The input for DeleteBotApiKeyCommand.

DeleteBotApiKeyCommandOutput

The output of DeleteBotApiKeyCommand.

DeleteBotApiKeyInput

DeleteBotApiKeyOutput

DeleteBotCommandInput

The input for DeleteBotCommand.

DeleteBotCommandOutput

The output of DeleteBotCommand.

DeleteBotInput

DeleteBotOutput

DirectoryItem

GetAppVersionCommandInput

The input for GetAppVersionCommand.

GetAppVersionCommandOutput

The output of GetAppVersionCommand.

GetAppVersionInput

GetAppVersionOutput

GetBotCallbackCommandInput

The input for GetBotCallbackCommand.

GetBotCallbackCommandOutput

The output of GetBotCallbackCommand.

GetBotCallbackInput

GetBotCallbackOutput

GetBotCommandInput

The input for GetBotCommand.

GetBotCommandOutput

The output of GetBotCommand.

GetBotInput

GetBotOutput

GetUserCommandInput

The input for GetUserCommand.

GetUserCommandOutput

The output of GetUserCommand.

GetUserEmailNotificationsSettingsCommandInput

The input for GetUserEmailNotificationsSettingsCommand.

GetUserEmailNotificationsSettingsCommandOutput

The output of GetUserEmailNotificationsSettingsCommand.

GetUserEmailNotificationsSettingsInput

GetUserEmailNotificationsSettingsOutput

GetUserInput

GetUserOutput

GetUserPbxLinkDataCommandInput

The input for GetUserPbxLinkDataCommand.

GetUserPbxLinkDataCommandOutput

The output of GetUserPbxLinkDataCommand.

GetUserPbxLinkDataInput

GetUserPbxLinkDataOutput

GetUserPbxLinkSuggestionCommandInput

The input for GetUserPbxLinkSuggestionCommand.

GetUserPbxLinkSuggestionCommandOutput

The output of GetUserPbxLinkSuggestionCommand.

GetUserPbxLinkSuggestionInput

GetUserPbxLinkSuggestionOutput

GetUserPbxLinkSuggestionV1CommandInput

The input for GetUserPbxLinkSuggestionV1Command.

GetUserPbxLinkSuggestionV1CommandOutput

The output of GetUserPbxLinkSuggestionV1Command.

GetUserPbxLinkSuggestionV1Input

GetUserPbxLinkSuggestionV1Output

IntelligenceSearchCommandInput

The input for IntelligenceSearchCommand.

IntelligenceSearchCommandOutput

The output of IntelligenceSearchCommand.

IntelligenceSearchInput

IntelligenceSearchOutput

ListBotApiKeysCommandInput

The input for ListBotApiKeysCommand.

ListBotApiKeysCommandOutput

The output of ListBotApiKeysCommand.

ListBotApiKeysInput

ListBotApiKeysOutput

ListBotsCommandInput

The input for ListBotsCommand.

ListBotsCommandOutput

The output of ListBotsCommand.

ListBotsInput

ListBotsOutput

NewEmailData

OldEmailData

PartialUpdateUserEmailNotificationsSettingsCommandInput

The input for PartialUpdateUserEmailNotificationsSettingsCommand.

PartialUpdateUserEmailNotificationsSettingsCommandOutput

The output of PartialUpdateUserEmailNotificationsSettingsCommand.

PartialUpdateUserEmailNotificationsSettingsInput

PartialUpdateUserEmailNotificationsSettingsOutput

PbxColleague

QueryColleaguesCommandInput

The input for QueryColleaguesCommand.

QueryColleaguesCommandOutput

The output of QueryColleaguesCommand.

QueryColleaguesInput

QueryColleaguesOutput

QueryColleaguesOutputItem

QueryColleaguesParameters

QueryUserCommandInput

The input for QueryUserCommand.

QueryUserCommandOutput

The output of QueryUserCommand.

QueryUserInput

QueryUserOutput

QueryUsersCommandInput

The input for QueryUsersCommand.

QueryUsersCommandOutput

The output of QueryUsersCommand.

QueryUsersInput

QueryUsersOutput

RuntimeExtension

ToggleTranscriptionEmailNotificationsSubscriptionCommandInput

The input for ToggleTranscriptionEmailNotificationsSubscriptionCommand.

ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput

The output of ToggleTranscriptionEmailNotificationsSubscriptionCommand.

ToggleTranscriptionEmailNotificationsSubscriptionInput

ToggleTranscriptionEmailNotificationsSubscriptionOutput

ToggleUnreadEmailNotificationsSubscriptionCommandInput

The input for ToggleUnreadEmailNotificationsSubscriptionCommand.

ToggleUnreadEmailNotificationsSubscriptionCommandOutput

The output of ToggleUnreadEmailNotificationsSubscriptionCommand.

ToggleUnreadEmailNotificationsSubscriptionInput

ToggleUnreadEmailNotificationsSubscriptionOutput

UpdateBotCallbackCommandInput

The input for UpdateBotCallbackCommand.

UpdateBotCallbackCommandOutput

The output of UpdateBotCallbackCommand.

UpdateBotCallbackInput

UpdateBotCallbackOutput

UpdateBotCommandInput

The input for UpdateBotCommand.

UpdateBotCommandOutput

The output of UpdateBotCommand.

UpdateBotInput

UpdateBotOutput

UpdateUserEmailNotificationsSettingsCommandInput

The input for UpdateUserEmailNotificationsSettingsCommand.

UpdateUserEmailNotificationsSettingsCommandOutput

The output of UpdateUserEmailNotificationsSettingsCommand.

UpdateUserEmailNotificationsSettingsInput

UpdateUserEmailNotificationsSettingsOutput

UploadPictureCommandInput

The input for UploadPictureCommand.

UploadPictureCommandOutput

The output of UploadPictureCommand.

UploadPictureInput

UploadPictureOutput

UploadPictureV1CommandInput

The input for UploadPictureV1Command.

UploadPictureV1CommandOutput

The output of UploadPictureV1Command.

UploadPictureV1Input

UploadPictureV1Output

User

UserEmailNotificationsSettings

UserPbxDialplanSettings

UserPbxInfo

UserPbxLinkData

UserPbxLinkSuggestion

UserPbxPersonalSettings

UserPbxServices

UserPersonalInfo

UserQueryPredicate

Users

UsersClientConfig

The configuration interface of UsersClient class constructor that set the region, credentials and other options.

UsersClientResolvedConfig

The resolved configuration interface of UsersClient class. This is resolved and normalized from the constructor configuration interface.

VerifyBotSecretKeyCommandInput

The input for VerifyBotSecretKeyCommand.

VerifyBotSecretKeyCommandOutput

The output of VerifyBotSecretKeyCommand.

VerifyBotSecretKeyInput

VerifyBotSecretKeyOutput

VerifyBotSecretKeyV1CommandInput

The input for VerifyBotSecretKeyV1Command.

VerifyBotSecretKeyV1CommandOutput

The output of VerifyBotSecretKeyV1Command.

VerifyBotSecretKeyV1Input

VerifyBotSecretKeyV1Output

Namespaces

Namespace

Description

BotCapability

BotEndpoint

BotLlmFunctionIntegration

BotLlmFunctionIntegrationWebhookAuthorization

BotToolVariableHandler

UserQuery

Variables

Variable

Description

AppType

BotAccess

BotCapabilityToolPipelineType

BotIntegrationType

BotLlmEmbeddedToolType

BotLlmFunctionIntegrationMethod

BotLlmToolType

GetPbxColleaguesDir

PbxColleagueRole

PbxColleaguesQueryField

PbxColleaguesSearchStrategy

PbxLicenseType

Type Aliases

Type Alias

Description

AppType

BotAccess

BotCapability

BotCapabilityToolPipelineType

BotEndpoint

BotIntegrationType

BotLlmEmbeddedToolType

BotLlmFunctionIntegration

BotLlmFunctionIntegrationMethod

BotLlmFunctionIntegrationWebhookAuthorization

BotLlmToolType

BotToolVariableHandler

GetPbxColleaguesDir

PbxColleagueRole

PbxColleaguesQueryField

PbxColleaguesSearchStrategy

PbxLicenseType

ServiceInputTypes

ServiceOutputTypes

UserQuery

UsersClientConfigType

UsersClientResolvedConfigType