@wildix/xbees-conversations-client 1.0.47 → 1.0.48

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

@@ -26,8 +26,7 @@ declare const GetMessageCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves a specific message from a specified channel.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -143,6 +142,8 @@ declare const GetMessageCommand_base: {
  * //     event: "STRING_VALUE",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
  * //     messageId: "STRING_VALUE", // required
  * //     channelId: "STRING_VALUE", // required
  * //     user: "<User>", // required
@@ -183,6 +184,7 @@ declare const GetMessageCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class GetMessageCommand extends GetMessageCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const GetOrCreateDirectChannelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Gets or creates a direct channel between the specified user and another member.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -104,6 +103,8 @@ declare const GetOrCreateDirectChannelCommand_base: {
  * //     telephony: true || false,
  * //     sms: true || false,
  * //     mms: true || false,
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "24h_channel_closed",
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     channelId: "STRING_VALUE", // required
@@ -130,6 +131,7 @@ declare const GetOrCreateDirectChannelCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class GetOrCreateDirectChannelCommand extends GetOrCreateDirectChannelCommand_base {
 }

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

@@ -26,7 +26,7 @@ declare const GetUploadedFileInfoCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Get information about uploaded file.
+ * Retrieves information about an uploaded file in a specified channel.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,8 +26,7 @@ declare const HideChannelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Allows a user to hide an existing channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +58,7 @@ declare const HideChannelCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class HideChannelCommand extends HideChannelCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const InviteCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * 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.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -84,6 +83,7 @@ declare const InviteCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class InviteCommand extends InviteCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const JoinChannelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * 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.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -99,6 +98,8 @@ declare const JoinChannelCommand_base: {
  * //     telephony: true || false,
  * //     sms: true || false,
  * //     mms: true || false,
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "24h_channel_closed",
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     channelId: "STRING_VALUE", // required
@@ -127,6 +128,7 @@ declare const JoinChannelCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class JoinChannelCommand extends JoinChannelCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const LeaveChannelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Allows a user to leave an existing channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -60,6 +59,7 @@ declare const LeaveChannelCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class LeaveChannelCommand extends LeaveChannelCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const ListChannelMembersCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves a list of members for a specific channel. Supports pagination through limit and offset parameters.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -88,6 +87,7 @@ declare const ListChannelMembersCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class ListChannelMembersCommand extends ListChannelMembersCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const ListChannelsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Lists all channels associated with a user. Allows pagination using limit and offset parameters. Sorted by last message in the channel.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -100,6 +99,8 @@ declare const ListChannelsCommand_base: {
  * //       telephony: true || false,
  * //       sms: true || false,
  * //       mms: true || false,
+ * //       whatsapp: true || false,
+ * //       whatsappStatus: "24h_channel_closed",
  * //       broadcast: true || false,
  * //       external: true || false,
  * //       channelId: "STRING_VALUE", // required
@@ -127,6 +128,7 @@ declare const ListChannelsCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class ListChannelsCommand extends ListChannelsCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const ListMessageReactionsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves a list of reactions for a specific message in a specified channel. Supports pagination through limit and offset parameters.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -87,6 +86,7 @@ declare const ListMessageReactionsCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class ListMessageReactionsCommand extends ListMessageReactionsCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const ListMessagesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves a list of messages from a specified channel. Supports pagination through limit and offset parameters.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -145,6 +144,8 @@ declare const ListMessagesCommand_base: {
  * //       event: "STRING_VALUE",
  * //       sms: true || false,
  * //       smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //       whatsapp: true || false,
+ * //       whatsappStatus: "trying" || "sent" || "delivered" || "error",
  * //       messageId: "STRING_VALUE", // required
  * //       channelId: "STRING_VALUE", // required
  * //       user: "<User>", // required
@@ -186,6 +187,7 @@ declare const ListMessagesCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class ListMessagesCommand extends ListMessagesCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const MarkReadCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Marks all messages in the specified channel as read by the user. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +58,7 @@ declare const MarkReadCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class MarkReadCommand extends MarkReadCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const PartialUpdateChannelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Partially updates the details of an existing channel. This operation allows for updating specific channel properties without altering the entire resource.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -110,6 +109,8 @@ declare const PartialUpdateChannelCommand_base: {
  * //     telephony: true || false,
  * //     sms: true || false,
  * //     mms: true || false,
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "24h_channel_closed",
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     channelId: "STRING_VALUE", // required
@@ -138,6 +139,7 @@ declare const PartialUpdateChannelCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class PartialUpdateChannelCommand extends PartialUpdateChannelCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const PartialUpdateMessageCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Partially updates an existing message in a specified channel. This operation requires the channel and message to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -237,6 +236,8 @@ declare const PartialUpdateMessageCommand_base: {
  * //     event: "STRING_VALUE",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
  * //     messageId: "STRING_VALUE", // required
  * //     channelId: "STRING_VALUE", // required
  * //     user: "<User>", // required
@@ -279,6 +280,7 @@ declare const PartialUpdateMessageCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class PartialUpdateMessageCommand extends PartialUpdateMessageCommand_base {
 }

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

@@ -26,7 +26,7 @@ declare const ScheduleExternalFlagAdjustmentJobCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Job to fix the "external" flag for channels in which the user participates.
+ * Schedules a job to fix the "external" flag for channels in which the user participates.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,8 +26,7 @@ declare const SendGiphyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Sends a Giphy message to a specified channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -151,6 +150,8 @@ declare const SendGiphyCommand_base: {
  * //     event: "STRING_VALUE",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
  * //     messageId: "STRING_VALUE", // required
  * //     channelId: "STRING_VALUE", // required
  * //     user: "<User>", // required
@@ -191,6 +192,7 @@ declare const SendGiphyCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class SendGiphyCommand extends SendGiphyCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const SendMessageCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Sends a message to a specified channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -236,6 +235,8 @@ declare const SendMessageCommand_base: {
  * //     event: "STRING_VALUE",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
  * //     messageId: "STRING_VALUE", // required
  * //     channelId: "STRING_VALUE", // required
  * //     user: "<User>", // required
@@ -276,6 +277,7 @@ declare const SendMessageCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class SendMessageCommand extends SendMessageCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const SendMessageReactionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Sends a reaction to a specific message in a specified channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -61,6 +60,7 @@ declare const SendMessageReactionCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class SendMessageReactionCommand extends SendMessageReactionCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const SendTypingStartCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Sends a typing start event to a specified channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +58,7 @@ declare const SendTypingStartCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class SendTypingStartCommand extends SendTypingStartCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const SendTypingStopCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Sends a typing stop event to a specified channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +58,7 @@ declare const SendTypingStopCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class SendTypingStopCommand extends SendTypingStopCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const ShowChannelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Allows a user to show an existing hidden channel. This operation requires the channel to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +58,7 @@ declare const ShowChannelCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class ShowChannelCommand extends ShowChannelCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const UpdateChannelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Updates the details of an existing channel. This operation can modify channel properties such as name, description, and members.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -105,6 +104,8 @@ declare const UpdateChannelCommand_base: {
  * //     telephony: true || false,
  * //     sms: true || false,
  * //     mms: true || false,
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "24h_channel_closed",
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     channelId: "STRING_VALUE", // required
@@ -133,6 +134,7 @@ declare const UpdateChannelCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class UpdateChannelCommand extends UpdateChannelCommand_base {
 }

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

@@ -26,8 +26,7 @@ declare const UpdateMessageCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Updates an existing message in a specified channel. This operation is idempotent and requires the channel and message to be accessible to the user.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -235,6 +234,8 @@ declare const UpdateMessageCommand_base: {
  * //     event: "STRING_VALUE",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
  * //     messageId: "STRING_VALUE", // required
  * //     channelId: "STRING_VALUE", // required
  * //     user: "<User>", // required
@@ -277,6 +278,7 @@ declare const UpdateMessageCommand_base: {
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *
+ * @public
  */
 export declare class UpdateMessageCommand extends UpdateMessageCommand_base {
 }

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

@@ -26,7 +26,7 @@ declare const UploadFileCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Create a presigned URL for file in x-bees channel.
+ * Create a presigned URL for file upload in the channel.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -1,6 +1,5 @@
 export * from "./AddChannelMemberCommand";
 export * from "./AddChannelMembersCommand";
-export * from "./AssignChannelCommand";
 export * from "./CreateGroupChannelCommand";
 export * from "./DeleteChannelCommand";
 export * from "./DeleteChannelMemberCommand";