Skip to main content

@wildix/xbees-conversations-client

xbees-conversations-client package

Classes

Class

Description

AddChannelMemberCommand

Adds a single member to an existing channel. This operation will either add an existing user or invite a new user to the channel. This operation is idempotent, meaning that if the member already exists, the operation will still return a successful response.

AddChannelMembersCommand

Adds members to an existing channel. This operation is idempotent, meaning that if a member already exists in the channel, the operation will still return a successful response.

ChannelAlreadyExistException

ChannelNotFoundException

Conversations

ConversationsClient

ConversationsServiceException

Base exception class for all service exceptions from Conversations service.

CreateGroupChannelCommand

Creates a new group channel with specified members and members to invite.

CreateInboxTagCommand

Creates a new tag that can be used to group channels. Each user can have up to 15 tags. If the limit is reached, a TagsLimitReachedException will be thrown.

CreateKiteChannelCommand

Creates a new kite channel with specified widget or email.

DeleteChannelCommand

Deletes an existing channel. This operation is idempotent, meaning that if the channel does not exist, the operation will still return a successful response.

DeleteChannelMemberCommand

Deletes a specific member from a channel. This operation is idempotent, meaning that if the member does not exist, the operation will still return a successful response.

DeleteInboxTagCommand

Deletes an existing tag. This operation is idempotent.

DeleteMessageCommand

Deletes an existing message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.

DeleteMessageReactionCommand

Deletes a reaction from a specific message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.

DescribeEventCommand

FileNotFoundException

ForbiddenException

GetActionTriggerResultCommand

Get result of the triggered action.

GetChannelCommand

Retrieves details of a specific channel by its unique identifier.

GetChannelMemberCommand

Retrieves details of a specific member in a channel. This includes the member's role and user information.

GetDirectChannelIdCommand

Gets the channel ID of an existing or non-existing direct channel between the specified user and another member.

GetFilePresignedDownloadUrlCommand

Retrieves a presigned URL for downloading a specific file from a message in a specified channel.

GetInboxStateCommand

Retrieves the user's inbox state to track pinned, tagged, and unread markers.

GetMessageCommand

Retrieves a specific message from a specified channel.

GetOrCreateDirectChannelCommand

Gets or creates a direct channel between the specified user and another member.

GetUploadedFileInfoCommand

Retrieves information about an uploaded file in a specified channel.

HideChannelCommand

Allows a user to hide an existing channel. This operation requires the channel to be accessible to the user.

InviteCommand

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.

JoinChannelCommand

Allows a user to join an existing channel. This operation requires the channel to be accessible to the user. The user can join a channel if it is public or if they have the necessary permissions.

LeaveChannelCommand

Allows a user to leave an existing channel. This operation requires the channel to be accessible to the user.

ListChannelMembersCommand

Retrieves a list of members for a specific channel. Supports pagination through limit and offset parameters.

ListChannelsCommand

Lists all channels associated with a user. Allows pagination using limit and offset parameters. Sorted by last message in the channel.

ListInboxTaggedChannelsCommand

Returns a list of channels associated with the specified tag.

ListInboxTagsCommand

Returns a list of tags associated with the user.

ListMessageReactionsCommand

Retrieves a list of reactions for a specific message in a specified channel. Supports pagination through limit and offset parameters.

ListMessagesCommand

Retrieves a list of messages from a specified channel. Supports pagination through limit and offset parameters.

ListPinnedMessagesCommand

Retrieves a list of pinned messages from a specified channel. Supports pagination through limit and offset parameters.

MarkReadCommand

Marks all messages in the specified channel as read by the user. This operation requires the channel to be accessible to the user.

MarkUnreadChannelsLimitReachedException

MarkUnreadCommand

Marks the channel with unread indicator. A user can have up to 100 channels marked as unread. If a user tries to tag more than 100 channels, the system will remove the oldest channel unread marked if the force flag is specified; otherwise, a MarkUnreadChannelsLimitReachedException will be thrown. The system will automatically remove the unread mark from the channel if the user reads the messages using the MarkRead operation. This operation is idempotent, meaning that if the channel is already marked as unread, no error will be thrown.

MemberAlreadyExistException

MemberNotFoundException

MessageActionNotFoundException

MessageNotFoundException

PartialUpdateChannelCommand

Partially updates the details of an existing channel. This operation allows for updating specific channel properties without altering the entire resource.

PartialUpdateMessageCommand

Partially updates an existing message in a specified channel. This operation requires the channel and message to be accessible to the user.

PinChannelCommand

Marks the channel with a pin flag. A user can have up to 10 pinned channels. If a user tries to pin more than 10 channels, the system will remove the oldest channel if the force flag is specified; otherwise, a PinnedChannelsLimitReachedException will be thrown. The system will automatically remove the channel from pinned list if the user leaves the channel or if the channel is removed. This operation is idempotent, meaning that if the channel is already pinned, no error will be thrown.

PinMessageCommand

Pins specified message in the message. This operation is idempotent, meaning that if the message is already pinned, no error will be thrown.

PinnedChannelsLimitReachedException

RateLimitExceededException

ScheduleExternalFlagAdjustmentJobCommand

Schedules a job to fix the "external" flag for channels in which the user participates.

SendActionTriggerResultCommand

Send result of the triggered action.

SendGiphyCommand

Sends a Giphy message to a specified channel. This operation requires the channel to be accessible to the user.

SendMessageCommand

Sends a message to a specified channel. This operation requires the channel to be accessible to the user.

SendMessageReactionCommand

Sends a reaction to a specific message in a specified channel. This operation requires the channel to be accessible to the user.

SendTypingStartCommand

Sends a typing start event to a specified channel. This operation requires the channel to be accessible to the user.

SendTypingStopCommand

Sends a typing stop event to a specified channel. This operation requires the channel to be accessible to the user.

ShowChannelCommand

Allows a user to show an existing hidden channel. This operation requires the channel to be accessible to the user.

TagChannelCommand

Marks the channel with specified tag. A user can have up to 100 channels tagged for a single tag. If a user tries to tag more than 100 channels, the system will remove the oldest channel tagged if the force flag is specified; otherwise, a TaggedChannelsLimitReachedException will be thrown. The system will automatically remove the channel from the specified tag if the user leaves the channel or if the channel is removed. This operation is idempotent, meaning that if the channel is already tagged, no error will be thrown.

TaggedChannelsLimitReachedException

TagNotFoundException

TagsLimitReachedException

TargetNotEligibleException

TargetNotFoundException

TriggerMessageActionCommand

Sends a trigger for specific action for specified message. This operation requires the message to be accessible to the user.

TriggerNotFoundException

UnpinChannelCommand

Removes pin flag from the the channel.

UnpinMessageCommand

Unpins the message that was previously pinned. This operation is idempotent, meaning that if the message is not pinned, no error will be thrown.

UntagChannelCommand

Removes specified tag from the the channel.

UpdateChannelCommand

Updates the details of an existing channel. This operation can modify channel properties such as name, description, and members.

UpdateInboxTagCommand

Updates an existing tag. This operation is idempotent.

UpdateMessageCommand

Updates an existing message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.

UploadFileCommand

Create a presigned URL for file upload in the channel.

ValidationException

Interfaces

Interface

Description

ActionTriggerResult

AddChannelMemberCommandInput

The input for AddChannelMemberCommand.

AddChannelMemberCommandOutput

The output of AddChannelMemberCommand.

AddChannelMemberInput

AddChannelMemberOutput

AddChannelMembersCommandInput

The input for AddChannelMembersCommand.

AddChannelMembersCommandOutput

The output of AddChannelMembersCommand.

AddChannelMembersInput

AddChannelMembersOutput

ButtonActionHandler

ButtonElement

ButtonLinkHandler

ButtonReplyHandler

Channel

ChannelContext

ChannelContextEvent

ChannelContextEventAttendee

ChannelMember

ClientDefaults

Conversations

ConversationsClientConfig

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

ConversationsClientResolvedConfig

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

CreateGroupChannelCommandInput

The input for CreateGroupChannelCommand.

CreateGroupChannelCommandOutput

The output of CreateGroupChannelCommand.

CreateGroupChannelInput

CreateGroupChannelOutput

CreateInboxTagCommandInput

The input for CreateInboxTagCommand.

CreateInboxTagCommandOutput

The output of CreateInboxTagCommand.

CreateInboxTagInput

CreateInboxTagOutput

CreateKiteChannelCommandInput

The input for CreateKiteChannelCommand.

CreateKiteChannelCommandOutput

The output of CreateKiteChannelCommand.

CreateKiteChannelInput

CreateKiteChannelOutput

DeleteChannelCommandInput

The input for DeleteChannelCommand.

DeleteChannelCommandOutput

The output of DeleteChannelCommand.

DeleteChannelInput

DeleteChannelMemberCommandInput

The input for DeleteChannelMemberCommand.

DeleteChannelMemberCommandOutput

The output of DeleteChannelMemberCommand.

DeleteChannelMemberInput

DeleteChannelMemberOutput

DeleteChannelOutput

DeleteInboxTagCommandInput

The input for DeleteInboxTagCommand.

DeleteInboxTagCommandOutput

The output of DeleteInboxTagCommand.

DeleteInboxTagInput

DeleteInboxTagOutput

DeleteMessageCommandInput

The input for DeleteMessageCommand.

DeleteMessageCommandOutput

The output of DeleteMessageCommand.

DeleteMessageInput

DeleteMessageOutput

DeleteMessageReactionCommandInput

The input for DeleteMessageReactionCommand.

DeleteMessageReactionCommandOutput

The output of DeleteMessageReactionCommand.

DeleteMessageReactionInput

DeleteMessageReactionOutput

DescribeEventCommandInput

The input for DescribeEventCommand.

DescribeEventCommandOutput

The output of DescribeEventCommand.

DescribeEventInput

DescribeEventOutput

GetActionTriggerResultCommandInput

The input for GetActionTriggerResultCommand.

GetActionTriggerResultCommandOutput

The output of GetActionTriggerResultCommand.

GetActionTriggerResultInput

GetActionTriggerResultOutput

GetChannelCommandInput

The input for GetChannelCommand.

GetChannelCommandOutput

The output of GetChannelCommand.

GetChannelInput

GetChannelMemberCommandInput

The input for GetChannelMemberCommand.

GetChannelMemberCommandOutput

The output of GetChannelMemberCommand.

GetChannelMemberInput

GetChannelMemberOutput

GetChannelOutput

GetDirectChannelIdCommandInput

The input for GetDirectChannelIdCommand.

GetDirectChannelIdCommandOutput

The output of GetDirectChannelIdCommand.

GetDirectChannelIdInput

GetDirectChannelIdOutput

GetFilePresignedDownloadUrlCommandInput

The input for GetFilePresignedDownloadUrlCommand.

GetFilePresignedDownloadUrlCommandOutput

The output of GetFilePresignedDownloadUrlCommand.

GetFilePresignedDownloadUrlInput

GetFilePresignedDownloadUrlOutput

GetInboxStateCommandInput

The input for GetInboxStateCommand.

GetInboxStateCommandOutput

The output of GetInboxStateCommand.

GetInboxStateInput

GetInboxStateOutput

GetMessageCommandInput

The input for GetMessageCommand.

GetMessageCommandOutput

The output of GetMessageCommand.

GetMessageInput

GetMessageOutput

GetOrCreateDirectChannelCommandInput

The input for GetOrCreateDirectChannelCommand.

GetOrCreateDirectChannelCommandOutput

The output of GetOrCreateDirectChannelCommand.

GetOrCreateDirectChannelInput

GetOrCreateDirectChannelOutput

GetUploadedFileInfoCommandInput

The input for GetUploadedFileInfoCommand.

GetUploadedFileInfoCommandOutput

The output of GetUploadedFileInfoCommand.

GetUploadedFileInfoInput

GetUploadedFileInfoOutput

HideChannelCommandInput

The input for HideChannelCommand.

HideChannelCommandOutput

The output of HideChannelCommand.

HideChannelInput

HideChannelOutput

InboxChannelsState

InboxPinnedChannel

InboxTag

InboxTaggedChannel

InboxUnreadChannel

InitialMessage

InviteCommandInput

The input for InviteCommand.

InviteCommandOutput

The output of InviteCommand.

InviteInput

InviteOutput

JoinChannelCommandInput

The input for JoinChannelCommand.

JoinChannelCommandOutput

The output of JoinChannelCommand.

JoinChannelInput

JoinChannelOutput

LeaveChannelCommandInput

The input for LeaveChannelCommand.

LeaveChannelCommandOutput

The output of LeaveChannelCommand.

LeaveChannelInput

LeaveChannelOutput

ListChannelMembersCommandInput

The input for ListChannelMembersCommand.

ListChannelMembersCommandOutput

The output of ListChannelMembersCommand.

ListChannelMembersInput

ListChannelMembersOutput

ListChannelsCommandInput

The input for ListChannelsCommand.

ListChannelsCommandOutput

The output of ListChannelsCommand.

ListChannelsInput

ListChannelsOutput

ListInboxTaggedChannelsCommandInput

The input for ListInboxTaggedChannelsCommand.

ListInboxTaggedChannelsCommandOutput

The output of ListInboxTaggedChannelsCommand.

ListInboxTaggedChannelsInput

ListInboxTaggedChannelsOutput

ListInboxTagsCommandInput

The input for ListInboxTagsCommand.

ListInboxTagsCommandOutput

The output of ListInboxTagsCommand.

ListInboxTagsInput

ListInboxTagsOutput

ListMessageReactionsCommandInput

The input for ListMessageReactionsCommand.

ListMessageReactionsCommandOutput

The output of ListMessageReactionsCommand.

ListMessageReactionsInput

ListMessageReactionsOutput

ListMessagesCommandInput

The input for ListMessagesCommand.

ListMessagesCommandOutput

The output of ListMessagesCommand.

ListMessagesInput

ListMessagesOutput

ListPinnedMessagesCommandInput

The input for ListPinnedMessagesCommand.

ListPinnedMessagesCommandOutput

The output of ListPinnedMessagesCommand.

ListPinnedMessagesInput

ListPinnedMessagesOutput

MarkReadCommandInput

The input for MarkReadCommand.

MarkReadCommandOutput

The output of MarkReadCommand.

MarkReadInput

MarkReadOutput

MarkUnreadCommandInput

The input for MarkUnreadCommand.

MarkUnreadCommandOutput

The output of MarkUnreadCommand.

MarkUnreadInput

MarkUnreadOutput

Message

MessageAttachment

MessageForward

MessageGiphy

MessageQuote

PartialUpdateChannelCommandInput

The input for PartialUpdateChannelCommand.

PartialUpdateChannelCommandOutput

The output of PartialUpdateChannelCommand.

PartialUpdateChannelInput

PartialUpdateChannelOutput

PartialUpdateChannelSetOptions

PartialUpdateMessageCommandInput

The input for PartialUpdateMessageCommand.

PartialUpdateMessageCommandOutput

The output of PartialUpdateMessageCommand.

PartialUpdateMessageInput

PartialUpdateMessageOutput

PartialUpdateMessageSetInput

PinChannelCommandInput

The input for PinChannelCommand.

PinChannelCommandOutput

The output of PinChannelCommand.

PinChannelInput

PinChannelOutput

PinMessageCommandInput

The input for PinMessageCommand.

PinMessageCommandOutput

The output of PinMessageCommand.

PinMessageInput

PinMessageOutput

Reaction

RuntimeExtension

ScheduleExternalFlagAdjustmentJobCommandInput

The input for ScheduleExternalFlagAdjustmentJobCommand.

ScheduleExternalFlagAdjustmentJobCommandOutput

The output of ScheduleExternalFlagAdjustmentJobCommand.

ScheduleExternalFlagAdjustmentJobInput

ScheduleExternalFlagAdjustmentJobOutput

SendActionTriggerResultCommandInput

The input for SendActionTriggerResultCommand.

SendActionTriggerResultCommandOutput

The output of SendActionTriggerResultCommand.

SendActionTriggerResultInput

SendActionTriggerResultOutput

SendGiphyCommandInput

The input for SendGiphyCommand.

SendGiphyCommandOutput

The output of SendGiphyCommand.

SendGiphyInput

SendGiphyOutput

SendMessageCommandInput

The input for SendMessageCommand.

SendMessageCommandOutput

The output of SendMessageCommand.

SendMessageInput

SendMessageOutput

SendMessageReactionCommandInput

The input for SendMessageReactionCommand.

SendMessageReactionCommandOutput

The output of SendMessageReactionCommand.

SendMessageReactionInput

SendMessageReactionOutput

SendTypingStartCommandInput

The input for SendTypingStartCommand.

SendTypingStartCommandOutput

The output of SendTypingStartCommand.

SendTypingStartInput

SendTypingStartOutput

SendTypingStopCommandInput

The input for SendTypingStopCommand.

SendTypingStopCommandOutput

The output of SendTypingStopCommand.

SendTypingStopInput

SendTypingStopOutput

ShowChannelCommandInput

The input for ShowChannelCommand.

ShowChannelCommandOutput

The output of ShowChannelCommand.

ShowChannelInput

ShowChannelOutput

TagChannelCommandInput

The input for TagChannelCommand.

TagChannelCommandOutput

The output of TagChannelCommand.

TagChannelInput

TagChannelOutput

TriggerMessageActionCommandInput

The input for TriggerMessageActionCommand.

TriggerMessageActionCommandOutput

The output of TriggerMessageActionCommand.

TriggerMessageActionInput

TriggerMessageActionOutput

UnpinChannelCommandInput

The input for UnpinChannelCommand.

UnpinChannelCommandOutput

The output of UnpinChannelCommand.

UnpinChannelInput

UnpinChannelOutput

UnpinMessageCommandInput

The input for UnpinMessageCommand.

UnpinMessageCommandOutput

The output of UnpinMessageCommand.

UnpinMessageInput

UnpinMessageOutput

UntagChannelCommandInput

The input for UntagChannelCommand.

UntagChannelCommandOutput

The output of UntagChannelCommand.

UntagChannelInput

UntagChannelOutput

UpdateChannelCommandInput

The input for UpdateChannelCommand.

UpdateChannelCommandOutput

The output of UpdateChannelCommand.

UpdateChannelInput

UpdateChannelOutput

UpdateInboxTagCommandInput

The input for UpdateInboxTagCommand.

UpdateInboxTagCommandOutput

The output of UpdateInboxTagCommand.

UpdateInboxTagInput

UpdateInboxTagOutput

UpdateMessageCommandInput

The input for UpdateMessageCommand.

UpdateMessageCommandOutput

The output of UpdateMessageCommand.

UpdateMessageInput

UpdateMessageOutput

UploadFileCommandInput

The input for UploadFileCommand.

UploadFileCommandOutput

The output of UploadFileCommand.

UploadFileInput

UploadFileOptions

UploadFileOutput

User

UserToInvite

WebhookChatActionTriggeredEvent

WebhookChatActionTriggeredEventData

WebhookChatChannelCreatedEvent

WebhookChatChannelCreatedOrUpdatedEventData

WebhookChatChannelUpdatedEvent

WebhookChatMemberAddedEvent

WebhookChatMemberAddedOrRemovedEventData

WebhookChatMemberRemovedEvent

WebhookChatMessageDeletedEvent

WebhookChatMessageNewEvent

WebhookChatMessageNewEventData

WebhookChatMessageUpdatedEvent

WebhookChatMessageUpdatedOrDeletedEventData

WebhookChatReactionDeletedEvent

WebhookChatReactionNewEvent

WebhookChatReactionNewOrDeletedEventData

WelcomeMessage

Namespaces

Namespace

Description

ActionElement

ButtonHandler

Element

Variables

Variable

Description

ActionTriggerStatus

ButtonVariant

ChannelAccess

ChannelContextEventAttendeeStatus

ChannelContextSource

ChannelMemberRole

ChannelType

ChannelWhatsAppStatus

ConversationFileCategory

GroupChannelUnsetOptions

MessageSmsStatus

MessageType

MessageUnsetFields

MessageWhatsAppStatus

ReactionType

TargetNotEligibleReason

WebhookEventType

Type Aliases

Type Alias

Description

ActionElement

ActionTriggerStatus

ButtonHandler

ButtonVariant

ChannelAccess

ChannelContextEventAttendeeStatus

ChannelContextSource

ChannelMemberRole

ChannelType

ChannelWhatsAppStatus

ConversationFileCategory

ConversationsClientConfigType

ConversationsClientResolvedConfigType

Element

GroupChannelUnsetOptions

MessageSmsStatus

MessageType

MessageUnsetFields

MessageWhatsAppStatus

ReactionType

ServiceInputTypes

ServiceOutputTypes

TargetNotEligibleReason

WebhookEventType