@wildix/xbees-conversations-client 1.0.56 → 1.0.58

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

@@ -432,160 +432,7 @@ export interface CreateGroupChannelOutput {
 /**
  * @public
  */
-export interface MessageAttachment {
-    id: string;
-    /**
-     * This *is* documentation about the field. Describe here what fsId and how to get it.
-     * @public
-     */
-    fsId: string;
-    mime?: string;
-    name: string;
-    size: number;
-    width?: number;
-    height?: number;
-    thumbnail?: string;
-}
-/**
- * @public
- */
-export interface MessageForward {
-    forwardCompany?: string;
-    forwardDate: string;
-    forwardEmail?: string;
-    forwardName?: string;
-}
-/**
- * @public
- */
-export interface MessageGiphy {
-    id: string;
-    size: string;
-    url: string;
-    height: string;
-    width: string;
-}
-/**
- * @public
- */
-export interface MessagePredefinedReply {
-    /**
-     * Text that will be sent to the user; clicking the text will trigger sending this message.
-     * @public
-     */
-    text: string;
-    /**
-     * Label that will appear on the reply button; if no label is provided, the text will be used.
-     * @public
-     */
-    label?: string;
-}
-/**
- * @public
- */
-export interface MessageQuote {
-    messageId: string;
-    channelId: string;
-    user: User;
-    text?: string;
-    attachments?: (MessageAttachment)[];
-    forward?: MessageForward;
-    mentions?: (User)[];
-    giphy?: MessageGiphy;
-    createdAt: string;
-    updatedAt?: string;
-}
-/**
- * @public
- * @enum
- */
-export declare const MessageSmsStatus: {
-    readonly DELIVERED: "delivered";
-    readonly ERROR: "error";
-    readonly SENT: "sent";
-    readonly TRYING: "trying";
-};
-/**
- * @public
- */
-export type MessageSmsStatus = typeof MessageSmsStatus[keyof typeof MessageSmsStatus];
-/**
- * @public
- * @enum
- */
-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
- */
-export interface InitialMessage {
-    text?: string;
-    attachments?: (MessageAttachment)[];
-    quote?: MessageQuote;
-    forward?: MessageForward;
-    /**
-     * A list of predefined replies will be visible to the user receiving the message. Once the user clicks on a reply, the system will automatically send the specified message to the conversation. You can specify up to 10 replies, which will only be visible if the message is the last one in the conversation.
-     * @public
-     */
-    predefinedReplies?: (MessagePredefinedReply)[];
-    type: MessageType;
-    giphy?: MessageGiphy;
-    silent?: boolean;
-    event?: string;
-    sms?: boolean;
-    smsStatus?: MessageSmsStatus;
-    whatsapp?: boolean;
-    whatsappStatus?: MessageWhatsAppStatus;
-    messageId: string;
-}
-/**
- * @public
- */
-export interface WelcomeMessage {
-    text?: string;
-    attachments?: (MessageAttachment)[];
-    quote?: MessageQuote;
-    forward?: MessageForward;
-    /**
-     * A list of predefined replies will be visible to the user receiving the message. Once the user clicks on a reply, the system will automatically send the specified message to the conversation. You can specify up to 10 replies, which will only be visible if the message is the last one in the conversation.
-     * @public
-     */
-    predefinedReplies?: (MessagePredefinedReply)[];
-    type: MessageType;
-    giphy?: MessageGiphy;
-    silent?: boolean;
-    event?: string;
-    sms?: boolean;
-    smsStatus?: MessageSmsStatus;
-    whatsapp?: boolean;
-    whatsappStatus?: MessageWhatsAppStatus;
-    messageId: string;
-    user: User;
-}
-/**
- * @public
- */
-export interface CreateKiteChannelInput {
+export interface CreateInboxTagInput {
     /**
      * The unique identifier of the user when a service token is used.
      * @public
@@ -595,67 +442,36 @@ export interface CreateKiteChannelInput {
      * The unique identifier for the new group channel. If not provided, the system will generate one.
      * @public
      */
-    channelId?: string;
-    /**
-     * The unique identifier of the Kite widget or email of the agent (example: 36cv69ao or vadim.ruban@wildix.com).
-     * @public
-     */
-    targetId: string;
-    /**
-     * The unique identifier of the route for time-based configuration.
-     * @public
-     */
-    targetRouteId?: string;
-    /**
-     * A list of welcome messages is created during channel creation to preserve the same state as the client has on the interface. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.
-     * @public
-     */
-    welcomeMessages?: (WelcomeMessage)[];
+    tagId?: string;
     /**
-     * A message to be added to the conversation for the user. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.
+     * The name of the tag.
      * @public
      */
-    initialMessage?: InitialMessage;
+    name: string;
 }
 /**
  * @public
  */
-export interface CreateKiteChannelOutput {
-    channel: Channel;
+export interface InboxTag {
+    id: string;
+    name: string;
 }
-/**
- * @public
- * @enum
- */
-export declare const TargetNotEligibleReason: {
-    readonly NO_LICENSE: "no_license";
-};
-/**
- * @public
- */
-export type TargetNotEligibleReason = typeof TargetNotEligibleReason[keyof typeof TargetNotEligibleReason];
 /**
  * @public
  */
-export declare class TargetNotEligibleException extends __BaseException {
-    readonly name: "TargetNotEligibleException";
-    readonly $fault: "client";
-    reason?: TargetNotEligibleReason;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<TargetNotEligibleException, __BaseException>);
+export interface CreateInboxTagOutput {
+    tag: InboxTag;
 }
 /**
  * @public
  */
-export declare class TargetNotFoundException extends __BaseException {
-    readonly name: "TargetNotFoundException";
+export declare class TagsLimitReachedException extends __BaseException {
+    readonly name: "TagsLimitReachedException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<TargetNotFoundException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<TagsLimitReachedException, __BaseException>);
 }
 /**
  * @public
@@ -713,6 +529,26 @@ export declare class MemberNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<MemberNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface DeleteInboxTagInput {
+    /**
+     * The unique identifier of the tag.
+     * @public
+     */
+    tagId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface DeleteInboxTagOutput {
+}
 /**
  * @public
  */
@@ -886,6 +722,42 @@ export interface WebhookChatMemberRemovedEvent {
     botId?: string;
     data: WebhookChatMemberAddedOrRemovedEventData;
 }
+/**
+ * @public
+ */
+export interface MessageAttachment {
+    id: string;
+    /**
+     * This *is* documentation about the field. Describe here what fsId and how to get it.
+     * @public
+     */
+    fsId: string;
+    mime?: string;
+    name: string;
+    size: number;
+    width?: number;
+    height?: number;
+    thumbnail?: string;
+}
+/**
+ * @public
+ */
+export interface MessageForward {
+    forwardCompany?: string;
+    forwardDate: string;
+    forwardEmail?: string;
+    forwardName?: string;
+}
+/**
+ * @public
+ */
+export interface MessageGiphy {
+    id: string;
+    size: string;
+    url: string;
+    height: string;
+    width: string;
+}
 /**
  * @public
  */
@@ -895,6 +767,61 @@ export interface Reaction {
     messageId?: string;
     user?: User;
 }
+/**
+ * @public
+ */
+export interface MessageQuote {
+    messageId: string;
+    channelId: string;
+    user: User;
+    text?: string;
+    attachments?: (MessageAttachment)[];
+    forward?: MessageForward;
+    mentions?: (User)[];
+    giphy?: MessageGiphy;
+    createdAt: string;
+    updatedAt?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageSmsStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageSmsStatus = typeof MessageSmsStatus[keyof typeof MessageSmsStatus];
+/**
+ * @public
+ * @enum
+ */
+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
  */
@@ -903,11 +830,6 @@ export interface Message {
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
-    /**
-     * A list of predefined replies will be visible to the user receiving the message. Once the user clicks on a reply, the system will automatically send the specified message to the conversation. You can specify up to 10 replies, which will only be visible if the message is the last one in the conversation.
-     * @public
-     */
-    predefinedReplies?: (MessagePredefinedReply)[];
     type: MessageType;
     giphy?: MessageGiphy;
     silent?: boolean;
@@ -1142,6 +1064,57 @@ export interface GetFilePresignedDownloadUrlOutput {
      */
     presignedDownloadUrl: string;
 }
+/**
+ * @public
+ */
+export interface GetInboxStateInput {
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface InboxPinnedChannel {
+    channelId: string;
+    pinnedAt: string;
+}
+/**
+ * @public
+ */
+export interface InboxTaggedChannel {
+    channelId: string;
+    tagId: string;
+}
+/**
+ * @public
+ */
+export interface InboxUnreadChannel {
+    channelId: string;
+    /**
+     * A date when unread indicator was set by the user.
+     * @public
+     */
+    unreadAt: string;
+    messageId?: string;
+}
+/**
+ * @public
+ */
+export interface InboxChannelsState {
+    unread: (InboxUnreadChannel)[];
+    pinned: (InboxPinnedChannel)[];
+    tagged: (InboxTaggedChannel)[];
+}
+/**
+ * @public
+ */
+export interface GetInboxStateOutput {
+    channels: InboxChannelsState;
+    tags: (InboxTag)[];
+}
 /**
  * @public
  */
@@ -1351,7 +1324,7 @@ export interface ListChannelsInput {
      */
     userId?: string;
     /**
-     * The maximum number of channels to return. The value must be between 1 and 30.
+     * The maximum number of channels to return. The value must be between 1 and 50.
      * @public
      */
     limit?: number;
@@ -1371,6 +1344,54 @@ export interface ListChannelsOutput {
      */
     channels: (Channel)[];
 }
+/**
+ * @public
+ */
+export interface ListInboxTaggedChannelsInput {
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * The unique identifier of the channel whose members are to be listed.
+     * @public
+     */
+    tagId: string;
+}
+/**
+ * @public
+ */
+export interface ListInboxTaggedChannelsOutput {
+    channels: (InboxTaggedChannel)[];
+}
+/**
+ * @public
+ */
+export declare class TagNotFoundException extends __BaseException {
+    readonly name: "TagNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TagNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface ListInboxTagsInput {
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface ListInboxTagsOutput {
+    tags: (InboxTag)[];
+}
 /**
  * @public
  */
@@ -1456,6 +1477,47 @@ export interface MarkReadInput {
  */
 export interface MarkReadOutput {
 }
+/**
+ * @public
+ */
+export declare class MarkUnreadChannelsLimitReachedException extends __BaseException {
+    readonly name: "MarkUnreadChannelsLimitReachedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MarkUnreadChannelsLimitReachedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface MarkUnreadInput {
+    /**
+     * The unique identifier of the channel whose messages are to be marked as unread.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * A Message ID in the channel from which to calculate the amount of unread messages.
+     * @public
+     */
+    messageId?: string;
+    /**
+     * A flag that indicates whether the system should replace the oldest marked unread channel with a new one if the limit of unread marked channels is reached. If the force option is specified as false and the user already has the maximum limit of unread marked channels, then the system will respond with an error.
+     * @public
+     */
+    force?: boolean;
+}
+/**
+ * @public
+ */
+export interface MarkUnreadOutput {
+}
 /**
  * @public
  */
@@ -1551,11 +1613,6 @@ export interface PartialUpdateMessageSetInput {
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
-    /**
-     * A list of predefined replies will be visible to the user receiving the message. Once the user clicks on a reply, the system will automatically send the specified message to the conversation. You can specify up to 10 replies, which will only be visible if the message is the last one in the conversation.
-     * @public
-     */
-    predefinedReplies?: (MessagePredefinedReply)[];
 }
 /**
  * @public
@@ -1607,6 +1664,42 @@ export interface PartialUpdateMessageInput {
 export interface PartialUpdateMessageOutput {
     message: Message;
 }
+/**
+ * @public
+ */
+export interface PinChannelInput {
+    /**
+     * The unique identifier of the channel which should be pinned.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * A flag that indicates whether the system should replace the oldest pinned channel with a new one if the limit of pinned channels is reached. If the force option is specified as false and the user already has the maximum limit of pinned channels, then the system will respond with an error.
+     * @public
+     */
+    force?: boolean;
+}
+/**
+ * @public
+ */
+export interface PinChannelOutput {
+}
+/**
+ * @public
+ */
+export declare class PinnedChannelsLimitReachedException extends __BaseException {
+    readonly name: "PinnedChannelsLimitReachedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PinnedChannelsLimitReachedException, __BaseException>);
+}
 /**
  * @public
  */
@@ -1672,11 +1765,6 @@ export interface SendMessageInput {
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
-    /**
-     * A list of predefined replies will be visible to the user receiving the message. Once the user clicks on a reply, the system will automatically send the specified message to the conversation. You can specify up to 10 replies, which will only be visible if the message is the last one in the conversation.
-     * @public
-     */
-    predefinedReplies?: (MessagePredefinedReply)[];
     /**
      * The unique identifier of the channel to which the message is sent.
      * @public
@@ -1794,6 +1882,92 @@ export interface ShowChannelInput {
  */
 export interface ShowChannelOutput {
 }
+/**
+ * @public
+ */
+export interface TagChannelInput {
+    /**
+     * The unique identifier of the channel whose messages are to be marked as unread.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * The unique identifier of the tag to add to the channel.
+     * @public
+     */
+    tagId: string;
+    /**
+     * A flag that indicates whether the system should replace the oldest tagged channel with a new one if the limit of tagged channels is reached. If the force option is specified as false and the user already has the maximum limit of tagged channels for the tag, then the system will respond with an error.
+     * @public
+     */
+    force?: boolean;
+}
+/**
+ * @public
+ */
+export interface TagChannelOutput {
+}
+/**
+ * @public
+ */
+export declare class TaggedChannelsLimitReachedException extends __BaseException {
+    readonly name: "TaggedChannelsLimitReachedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TaggedChannelsLimitReachedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface UnpinChannelInput {
+    /**
+     * The unique identifier of the channel which should be unpinned.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface UnpinChannelOutput {
+}
+/**
+ * @public
+ */
+export interface UntagChannelInput {
+    /**
+     * The unique identifier of the channel whose messages are to be marked as unread.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * The unique identifier of the tag to remove from the channel.
+     * @public
+     */
+    tagId: string;
+}
+/**
+ * @public
+ */
+export interface UntagChannelOutput {
+}
 /**
  * @public
  */
@@ -1850,6 +2024,32 @@ export interface UpdateChannelInput {
 export interface UpdateChannelOutput {
     channel: Channel;
 }
+/**
+ * @public
+ */
+export interface UpdateInboxTagInput {
+    /**
+     * The unique identifier of the channel containing the message.
+     * @public
+     */
+    tagId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * The name of the tag.
+     * @public
+     */
+    name: string;
+}
+/**
+ * @public
+ */
+export interface UpdateInboxTagOutput {
+    tag: InboxTag;
+}
 /**
  * @public
  */
@@ -1858,11 +2058,6 @@ export interface UpdateMessageInput {
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
-    /**
-     * A list of predefined replies will be visible to the user receiving the message. Once the user clicks on a reply, the system will automatically send the specified message to the conversation. You can specify up to 10 replies, which will only be visible if the message is the last one in the conversation.
-     * @public
-     */
-    predefinedReplies?: (MessagePredefinedReply)[];
     /**
      * The unique identifier of the channel containing the message.
      * @public