@wildix/xbees-conversations-client 1.0.46 → 1.0.48

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

@@ -68,9 +68,13 @@ export interface UserToInvite {
  * @public
  */
 export interface AddChannelMemberInput {
+    /**
+     * The unique identifier of the channel to which the member is to be added.
+     * @public
+     */
     channelId: string;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
@@ -79,7 +83,15 @@ export interface AddChannelMemberInput {
      * @public
      */
     silent?: boolean;
+    /**
+     * A User ID of the member to be added to the channel.
+     * @public
+     */
     memberId?: string;
+    /**
+     * A user to invite to the channel, identified by email address or phone number if the member does not already exist.
+     * @public
+     */
     memberToInvite?: UserToInvite;
 }
 /**
@@ -107,12 +119,12 @@ export interface ChannelMember {
  */
 export interface AddChannelMemberOutput {
     /**
-     * Member added to the channel
+     * Details of the member added to the channel.
      * @public
      */
     member: ChannelMember;
     /**
-     * Users added to the channel
+     * Details of the user added to the channel.
      * @public
      */
     user: User;
@@ -143,18 +155,30 @@ export declare class MemberAlreadyExistException extends __BaseException {
  * @public
  */
 export interface AddChannelMembersInput {
+    /**
+     * The unique identifier of the channel to which members are to be added.
+     * @public
+     */
     channelId: string;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
     /**
-     * True to not send a system message that members added from the conversartion. Default - false.
+     * Set to true to suppress system messages that members were added to the conversation. Default is false.
      * @public
      */
     silent?: boolean;
+    /**
+     * A list of user IDs to be added as members of the channel.
+     * @public
+     */
     members?: (string)[];
+    /**
+     * A list of users to invite to the channel, identified by their email addresses or phone numbers.
+     * @public
+     */
     membersToInvite?: (UserToInvite)[];
 }
 /**
@@ -162,12 +186,12 @@ export interface AddChannelMembersInput {
  */
 export interface AddChannelMembersOutput {
     /**
-     * The list of members added to the channel
+     * The list of members added to the channel.
      * @public
      */
     members: (ChannelMember)[];
     /**
-     * The list of users added to the channel
+     * The list of users added to the channel.
      * @public
      */
     users: (User)[];
@@ -236,6 +260,17 @@ export interface ChannelContext {
     target?: string;
     events?: (ChannelContextEvent)[];
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelWhatsAppStatus: {
+    readonly CHANNEL_CLOSED: "24h_channel_closed";
+};
+/**
+ * @public
+ */
+export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof ChannelWhatsAppStatus];
 /**
  * @public
  */
@@ -268,6 +303,8 @@ export interface Channel {
     telephony?: boolean;
     sms?: boolean;
     mms?: boolean;
+    whatsapp?: boolean;
+    whatsappStatus?: ChannelWhatsAppStatus;
     broadcast?: boolean;
     external?: boolean;
     channelId: string;
@@ -304,23 +341,55 @@ export type ConversationFileCategory = typeof ConversationFileCategory[keyof typ
  * @public
  */
 export interface CreateGroupChannelInput {
+    /**
+     * The subject of the channel.
+     * @public
+     */
     subject?: string;
+    /**
+     * The description of the channel.
+     * @public
+     */
     description?: string;
     /**
-     * Picture URL
+     * The URL of the channel's picture.
      * @public
      */
     picture?: string;
     /**
-     * Picture dominant color represented by a hex value.
+     * The dominant color of the channel's picture, represented by a hex value.
      * @public
      */
     pictureColor?: string;
+    /**
+     * The access level of the channel.
+     * @public
+     */
     access?: ChannelAccess;
+    /**
+     * Indicates if the channel is broadcast-only. Default is false.
+     * @public
+     */
     broadcast?: boolean;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
+    /**
+     * The unique identifier for the new group channel. If not provided, the system will generate one.
+     * @public
+     */
     channelId?: string;
+    /**
+     * A list of user IDs to be added as members of the group channel.
+     * @public
+     */
     members?: (string)[];
+    /**
+     * A list of users to invite to the group channel, identified by their email addresses or phone numbers.
+     * @public
+     */
     membersToInvite?: (UserToInvite)[];
 }
 /**
@@ -333,6 +402,10 @@ export interface CreateGroupChannelOutput {
  * @public
  */
 export interface DeleteChannelInput {
+    /**
+     * The unique identifier of the channel to be deleted.
+     * @public
+     */
     channelId: string;
 }
 /**
@@ -344,15 +417,23 @@ export interface DeleteChannelOutput {
  * @public
  */
 export interface DeleteChannelMemberInput {
+    /**
+     * The unique identifier of the channel from which the member is to be deleted.
+     * @public
+     */
     channelId: string;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
+    /**
+     * The unique identifier of the member to be deleted.
+     * @public
+     */
     memberId: string;
     /**
-     * True to not send a system message that member was removed from the conversartion. Default - false.
+     * Set to true to suppress system messages that the member was removed from the conversation. Default is false.
      * @public
      */
     silent?: boolean;
@@ -377,10 +458,18 @@ export declare class MemberNotFoundException extends __BaseException {
  * @public
  */
 export interface DeleteMessageInput {
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the message to delete.
+     * @public
+     */
     messageId: string;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
@@ -424,19 +513,23 @@ export type ReactionType = typeof ReactionType[keyof typeof ReactionType];
  * @public
  */
 export interface DeleteMessageReactionInput {
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
     channelId: string;
     /**
-     * ID of the message to react to.
+     * The unique identifier of the message to delete the reaction from.
      * @public
      */
     messageId: string;
     /**
-     * Type of the reaction.
+     * The type of the reaction to delete.
      * @public
      */
     reactionType: ReactionType;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
@@ -614,11 +707,26 @@ export type MessageSmsStatus = typeof MessageSmsStatus[keyof typeof MessageSmsSt
  */
 export declare const MessageType: {
     readonly REGULAR: "regular";
+    readonly SYSTEM: "system";
 };
 /**
  * @public
  */
 export type MessageType = typeof MessageType[keyof typeof MessageType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageWhatsAppStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof MessageWhatsAppStatus];
 /**
  * @public
  */
@@ -633,6 +741,8 @@ export interface Message {
     event?: string;
     sms?: boolean;
     smsStatus?: MessageSmsStatus;
+    whatsapp?: boolean;
+    whatsappStatus?: MessageWhatsAppStatus;
     messageId: string;
     channelId: string;
     user: User;
@@ -745,6 +855,10 @@ export interface DescribeEventOutput {
  * @public
  */
 export interface GetChannelInput {
+    /**
+     * The unique identifier of the channel.
+     * @public
+     */
     channelId: string;
 }
 /**
@@ -757,22 +871,50 @@ export interface GetChannelOutput {
  * @public
  */
 export interface GetChannelMemberInput {
+    /**
+     * The unique identifier of the channel.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user.
+     * @public
+     */
     memberId: string;
 }
 /**
  * @public
  */
 export interface GetChannelMemberOutput {
+    /**
+     * Details of the channel member.
+     * @public
+     */
     member: ChannelMember;
+    /**
+     * Details of the user.
+     * @public
+     */
     user: User;
 }
 /**
  * @public
  */
 export interface GetDirectChannelIdInput {
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
+    /**
+     * A User ID of the member to connect with the direct channel.
+     * @public
+     */
     memberId?: string;
+    /**
+     * A user to invite to the direct channel, identified by email addresse or phone number.
+     * @public
+     */
     memberToInvite?: UserToInvite;
 }
 /**
@@ -797,18 +939,22 @@ export declare class FileNotFoundException extends __BaseException {
  */
 export interface GetFilePresignedDownloadUrlInput {
     /**
-     * Channel Id.
+     * The unique identifier of the channel containing the message.
      * @public
      */
     channelId: string;
     /**
-     * Message Id.
+     * The unique identifier of the message containing the file.
      * @public
      */
     messageId: string;
+    /**
+     * The unique identifier of the file to download.
+     * @public
+     */
     fileId: string;
     /**
-     * File category. Channel files or conference recordings. Default: channels.
+     * The category of the file, either channel files or conference recordings.
      * @public
      */
     category?: ConversationFileCategory;
@@ -818,7 +964,7 @@ export interface GetFilePresignedDownloadUrlInput {
  */
 export interface GetFilePresignedDownloadUrlOutput {
     /**
-     * Presigned URL for download file.
+     * The presigned URL for downloading the file.
      * @public
      */
     presignedDownloadUrl: string;
@@ -827,7 +973,15 @@ export interface GetFilePresignedDownloadUrlOutput {
  * @public
  */
 export interface GetMessageInput {
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the message to retrieve.
+     * @public
+     */
     messageId: string;
 }
 /**
@@ -840,8 +994,20 @@ export interface GetMessageOutput {
  * @public
  */
 export interface GetOrCreateDirectChannelInput {
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
+    /**
+     * A User ID of the member to connect with the direct channel.
+     * @public
+     */
     memberId?: string;
+    /**
+     * A user to invite to the direct channel, identified by email addresse or phone number.
+     * @public
+     */
     memberToInvite?: UserToInvite;
 }
 /**
@@ -855,17 +1021,17 @@ export interface GetOrCreateDirectChannelOutput {
  */
 export interface GetUploadedFileInfoInput {
     /**
-     * Channel Id.
+     * The unique identifier of the channel containing the file.
      * @public
      */
     channelId: string;
     /**
-     * File Id. Support cds file's ID.
+     * The unique identifier of the file.
      * @public
      */
     fileId: string;
     /**
-     * File category. Channel files or conference recordings. Default: channels.
+     * The category of the file, either channel files or conference recordings. Default: channels.
      * @public
      */
     category?: ConversationFileCategory;
@@ -880,7 +1046,15 @@ export interface GetUploadedFileInfoOutput {
  * @public
  */
 export interface HideChannelInput {
+    /**
+     * The unique identifier of the channel to hide.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
 }
 /**
@@ -892,20 +1066,40 @@ export interface HideChannelOutput {
  * @public
  */
 export interface InviteInput {
+    /**
+     * A list of users to invite. The list must contain between 1 and 20 users.
+     * @public
+     */
     invitees: (UserToInvite)[];
 }
 /**
  * @public
  */
 export interface InviteOutput {
+    /**
+     * A list of users who were successfully invited.
+     * @public
+     */
     users: (User)[];
 }
 /**
  * @public
  */
 export interface JoinChannelInput {
+    /**
+     * The unique identifier of the channel to join.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
+    /**
+     * Set to true to suppress system messages that the user joined the channel. Default is false.
+     * @public
+     */
     silent?: boolean;
 }
 /**
@@ -918,8 +1112,20 @@ export interface JoinChannelOutput {
  * @public
  */
 export interface LeaveChannelInput {
+    /**
+     * The unique identifier of the channel to leave.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
+    /**
+     * Set to true to suppress system messages that the user left the channel. Default is false.
+     * @public
+     */
     silent?: boolean;
 }
 /**
@@ -931,8 +1137,20 @@ export interface LeaveChannelOutput {
  * @public
  */
 export interface ListChannelMembersInput {
+    /**
+     * The unique identifier of the channel whose members are to be listed.
+     * @public
+     */
     channelId: string;
+    /**
+     * The maximum number of members to return. The value must be between 1 and 100.
+     * @public
+     */
     limit?: number;
+    /**
+     * The offset from which to start listing members. The value must be between 0 and 1000.
+     * @public
+     */
     offset?: number;
 }
 /**
@@ -940,7 +1158,7 @@ export interface ListChannelMembersInput {
  */
 export interface ListChannelMembersOutput {
     /**
-     * The list of members matching the query
+     * The list of members matching the query.
      * @public
      */
     members: (ChannelMember)[];
@@ -954,50 +1172,110 @@ export interface ListChannelMembersOutput {
  * @public
  */
 export interface ListChannelsInput {
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
+    /**
+     * The maximum number of channels to return. The value must be between 1 and 50.
+     * @public
+     */
     limit?: number;
+    /**
+     * The offset from which to start listing channels. The value must be between 0 and 1000.
+     * @public
+     */
     offset?: number;
 }
 /**
  * @public
  */
 export interface ListChannelsOutput {
+    /**
+     * A list of channels associated with the user.
+     * @public
+     */
     channels: (Channel)[];
 }
 /**
  * @public
  */
 export interface ListMessageReactionsInput {
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the message whose reactions are to be listed.
+     * @public
+     */
     messageId: string;
+    /**
+     * The maximum number of reactions to return. The value must be between 1 and 300.
+     * @public
+     */
     limit?: number;
+    /**
+     * The offset from which to start listing reactions. The value must be between 0 and 1000.
+     * @public
+     */
     offset?: number;
 }
 /**
  * @public
  */
 export interface ListMessageReactionsOutput {
+    /**
+     * A list of reactions to the specified message.
+     * @public
+     */
     reactions: (Reaction)[];
 }
 /**
  * @public
  */
 export interface ListMessagesInput {
+    /**
+     * The unique identifier of the channel from which to list messages.
+     * @public
+     */
     channelId: string;
+    /**
+     * The maximum number of messages to return. The value must be between 1 and 100.
+     * @public
+     */
     limit?: number;
+    /**
+     * The offset from which to start listing messages. The value must be between 0 and 1000.
+     * @public
+     */
     offset?: number;
 }
 /**
  * @public
  */
 export interface ListMessagesOutput {
+    /**
+     * A list of messages from the specified channel.
+     * @public
+     */
     messages: (Message)[];
 }
 /**
  * @public
  */
 export interface MarkReadInput {
+    /**
+     * The unique identifier of the channel whose messages are to be marked as read.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
 }
 /**
@@ -1009,19 +1287,35 @@ export interface MarkReadOutput {
  * @public
  */
 export interface PartialUpdateChannelSetOptions {
+    /**
+     * The subject of the channel.
+     * @public
+     */
     subject?: string;
+    /**
+     * The description of the channel.
+     * @public
+     */
     description?: string;
     /**
-     * Picture URL
+     * The URL of the channel's picture.
      * @public
      */
     picture?: string;
     /**
-     * Picture dominant color represented by a hex value.
+     * The dominant color of the channel's picture, represented by a hex value.
      * @public
      */
     pictureColor?: string;
+    /**
+     * The access level of the channel.
+     * @public
+     */
     access?: ChannelAccess;
+    /**
+     * Indicates if the channel is broadcast-only. Default is false.
+     * @public
+     */
     broadcast?: boolean;
 }
 /**
@@ -1044,14 +1338,30 @@ export type GroupChannelUnsetOptions = typeof GroupChannelUnsetOptions[keyof typ
  * @public
  */
 export interface PartialUpdateChannelInput {
+    /**
+     * The unique identifier of the channel to be updated.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
     /**
-     * True to not send a system message about updates. Default - false.
+     * Set to true to suppress system messages about the updates. Default is false.
      * @public
      */
     silent?: boolean;
+    /**
+     * Options to set specific fields in the channel.
+     * @public
+     */
     set?: PartialUpdateChannelSetOptions;
+    /**
+     * Options to unset specific fields in the channel.
+     * @public
+     */
     unset?: (GroupChannelUnsetOptions)[];
 }
 /**
@@ -1087,9 +1397,25 @@ export type MessageUnsetFields = typeof MessageUnsetFields[keyof typeof MessageU
  * @public
  */
 export interface PartialUpdateMessageInput {
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the message to update.
+     * @public
+     */
     messageId: string;
+    /**
+     * Fields to set during the partial update.
+     * @public
+     */
     set?: PartialUpdateMessageSetInput;
+    /**
+     * Fields to unset during the partial update.
+     * @public
+     */
     unset?: (MessageUnsetFields)[];
 }
 /**
@@ -1114,7 +1440,7 @@ export declare class ConversationsServiceException extends __BaseException {
  */
 export interface ScheduleExternalFlagAdjustmentJobInput {
     /**
-     * User ID at x-bees.
+     * The unique identifier of the user.
      * @public
      */
     userId: string;
@@ -1128,17 +1454,25 @@ export interface ScheduleExternalFlagAdjustmentJobOutput {
  * @public
  */
 export interface SendGiphyInput {
+    /**
+     * The unique identifier of the channel to which the Giphy message is sent.
+     * @public
+     */
     channelId: string;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
     /**
-     * Message ID if empty ID will be auto-generated.
+     * The unique identifier of the message. If not provided, an ID will be auto-generated.
      * @public
      */
     messageId?: string;
+    /**
+     * Details of the Giphy message to be sent.
+     * @public
+     */
     giphy: MessageGiphy;
 }
 /**
@@ -1155,17 +1489,25 @@ export interface SendMessageInput {
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
+    /**
+     * The unique identifier of the channel to which the message is sent.
+     * @public
+     */
     channelId: string;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
     /**
-     * Message ID if empty ID will be auto-generated.
+     * The unique identifier of the message. If not provided, an ID will be auto-generated.
      * @public
      */
     messageId?: string;
+    /**
+     * A list of user IDs mentioned in the message.
+     * @public
+     */
     mentions?: (string)[];
 }
 /**
@@ -1178,15 +1520,23 @@ export interface SendMessageOutput {
  * @public
  */
 export interface SendMessageReactionInput {
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the message to which the reaction is sent.
+     * @public
+     */
     messageId: string;
     /**
-     * Type of the reaction. User could have only 1 reaction of each type per message.
+     * The type of the reaction. A user can have only one reaction of each type per message.
      * @public
      */
     reactionType: ReactionType;
     /**
-     * User ID for server side calls
+     * The unique identifier of the user when a service token is used.
      * @public
      */
     userId?: string;
@@ -1200,7 +1550,15 @@ export interface SendMessageReactionOutput {
  * @public
  */
 export interface SendTypingStartInput {
+    /**
+     * The unique identifier of the channel to which the typing start event is sent.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
 }
 /**
@@ -1212,7 +1570,15 @@ export interface SendTypingStartOutput {
  * @public
  */
 export interface SendTypingStopInput {
+    /**
+     * The unique identifier of the channel to which the typing stop event is sent.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
 }
 /**
@@ -1224,7 +1590,15 @@ export interface SendTypingStopOutput {
  * @public
  */
 export interface ShowChannelInput {
+    /**
+     * The unique identifier of the channel to show.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
 }
 /**
@@ -1236,24 +1610,48 @@ export interface ShowChannelOutput {
  * @public
  */
 export interface UpdateChannelInput {
+    /**
+     * The subject of the channel.
+     * @public
+     */
     subject?: string;
+    /**
+     * The description of the channel.
+     * @public
+     */
     description?: string;
     /**
-     * Picture URL
+     * The URL of the channel's picture.
      * @public
      */
     picture?: string;
     /**
-     * Picture dominant color represented by a hex value.
+     * The dominant color of the channel's picture, represented by a hex value.
      * @public
      */
     pictureColor?: string;
+    /**
+     * The access level of the channel.
+     * @public
+     */
     access?: ChannelAccess;
+    /**
+     * Indicates if the channel is broadcast-only. Default is false.
+     * @public
+     */
     broadcast?: boolean;
+    /**
+     * The unique identifier of the channel to be updated.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
     userId?: string;
     /**
-     * True to not send a system message about updates. Default - false.
+     * Set to true to suppress system messages about the updates. Default is false.
      * @public
      */
     silent?: boolean;
@@ -1272,8 +1670,20 @@ export interface UpdateMessageInput {
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
     channelId: string;
+    /**
+     * The unique identifier of the message to update.
+     * @public
+     */
     messageId: string;
+    /**
+     * A list of user IDs mentioned in the message.
+     * @public
+     */
     mentions?: (string)[];
 }
 /**
@@ -1307,17 +1717,17 @@ export interface UploadFileOptions {
  */
 export interface UploadFileInput {
     /**
-     * Channel Id.
+     * The unique identifier of the channel.
      * @public
      */
     channelId: string;
     /**
-     * File name, unreadable characters will be replaced with underscores.
+     * The name of the file. Unreadable characters will be replaced with underscores.
      * @public
      */
     name: string;
     /**
-     * Additional options.
+     * Additional options for the file upload.
      * @public
      */
     options?: UploadFileOptions;
@@ -1327,12 +1737,12 @@ export interface UploadFileInput {
  */
 export interface UploadFileOutput {
     /**
-     * File Id. Format ownerId_uuid.
+     * The unique identifier of the file.
      * @public
      */
     fileId: string;
     /**
-     * Presigned URL for upload file.
+     * The presigned URL for uploading the file.
      * @public
      */
     presignedUploadUrl: string;