@wildix/xbees-conversations-client 1.1.0 → 1.1.1

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

@@ -110,6 +110,134 @@ export declare const ChannelType: {
  * @public
  */
 export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
+/**
+ * @public
+ */
+export interface ButtonActionHandler {
+    /**
+     * A unique ID of the action within the message.
+     * @public
+     */
+    id: string;
+}
+/**
+ * @public
+ */
+export interface ButtonLinkHandler {
+    url: string;
+}
+/**
+ * @public
+ */
+export interface ButtonReplyHandler {
+    text?: string;
+}
+/**
+ * @public
+ */
+export type ButtonHandler = ButtonHandler.ActionMember | ButtonHandler.LinkMember | ButtonHandler.ReplyMember | ButtonHandler.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ButtonHandler {
+    interface LinkMember {
+        link: ButtonLinkHandler;
+        reply?: never;
+        action?: never;
+        $unknown?: never;
+    }
+    interface ReplyMember {
+        link?: never;
+        reply: ButtonReplyHandler;
+        action?: never;
+        $unknown?: never;
+    }
+    interface ActionMember {
+        link?: never;
+        reply?: never;
+        action: ButtonActionHandler;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        link?: never;
+        reply?: never;
+        action?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        link: (value: ButtonLinkHandler) => T;
+        reply: (value: ButtonReplyHandler) => T;
+        action: (value: ButtonActionHandler) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ButtonHandler, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ButtonVariant: {
+    readonly CONTAINED: "contained";
+    readonly OUTLINED: "outlined";
+};
+/**
+ * @public
+ */
+export type ButtonVariant = typeof ButtonVariant[keyof typeof ButtonVariant];
+/**
+ * @public
+ */
+export interface ButtonElement {
+    text: string;
+    variant?: ButtonVariant;
+    disabled?: boolean;
+    handler?: ButtonHandler;
+}
+/**
+ * @public
+ */
+export type ActionElement = ActionElement.ButtonMember | ActionElement.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ActionElement {
+    interface ButtonMember {
+        button: ButtonElement;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        button?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        button: (value: ButtonElement) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ActionElement, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface ActionTriggerResult {
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ActionTriggerStatus: {
+    readonly COMPLETED: "completed";
+    readonly PENDING: "pending";
+};
+/**
+ * @public
+ */
+export type ActionTriggerStatus = typeof ActionTriggerStatus[keyof typeof ActionTriggerStatus];
 /**
  * @public
  */
@@ -651,89 +779,6 @@ export interface DeleteMessageReactionOutput {
  */
 export interface DescribeEventInput {
 }
-/**
- * @public
- */
-export interface WebhookChatChannelCreatedOrUpdatedEventData {
-    channel: Channel;
-    members: (ChannelMember)[];
-    users: (User)[];
-}
-/**
- * @public
- * @enum
- */
-export declare const WebhookEventType: {
-    readonly CHANNEL_CREATED: "chat:channel:created";
-    readonly CHANNEL_UPDATED: "chat:channel:updated";
-    readonly MEMBER_ADDED: "chat:member:added";
-    readonly MEMBER_REMOVED: "chat:member:removed";
-    readonly MESSAGE_DELETED: "chat:message:deleted";
-    readonly MESSAGE_NEW: "chat:message:new";
-    readonly MESSAGE_UPDATED: "chat:message:updated";
-    readonly REACTION_DELETED: "chat:reaction:deleted";
-    readonly REACTION_NEW: "chat:reaction:new";
-};
-/**
- * @public
- */
-export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
-/**
- * @public
- */
-export interface WebhookChatChannelCreatedEvent {
-    id: string;
-    company: string;
-    type: WebhookEventType;
-    time: number;
-    integrationId?: string;
-    botId?: string;
-    data: WebhookChatChannelCreatedOrUpdatedEventData;
-}
-/**
- * @public
- */
-export interface WebhookChatChannelUpdatedEvent {
-    id: string;
-    company: string;
-    type: WebhookEventType;
-    time: number;
-    integrationId?: string;
-    botId?: string;
-    data: WebhookChatChannelCreatedOrUpdatedEventData;
-}
-/**
- * @public
- */
-export interface WebhookChatMemberAddedOrRemovedEventData {
-    channel: Channel;
-    member: ChannelMember;
-    user: User;
-}
-/**
- * @public
- */
-export interface WebhookChatMemberAddedEvent {
-    id: string;
-    company: string;
-    type: WebhookEventType;
-    time: number;
-    integrationId?: string;
-    botId?: string;
-    data: WebhookChatMemberAddedOrRemovedEventData;
-}
-/**
- * @public
- */
-export interface WebhookChatMemberRemovedEvent {
-    id: string;
-    company: string;
-    type: WebhookEventType;
-    time: number;
-    integrationId?: string;
-    botId?: string;
-    data: WebhookChatMemberAddedOrRemovedEventData;
-}
 /**
  * @public
  */
@@ -751,6 +796,31 @@ export interface MessageAttachment {
     height?: number;
     thumbnail?: string;
 }
+/**
+ * @public
+ */
+export type Element = Element.ActionsMember | Element.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace Element {
+    interface ActionsMember {
+        actions: (ActionElement)[];
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        actions?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        actions: (value: (ActionElement)[]) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: Element, visitor: Visitor<T>) => T;
+}
 /**
  * @public
  */
@@ -841,6 +911,7 @@ export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof Me
  */
 export interface Message {
     text?: string;
+    elements?: (Element)[];
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
@@ -862,6 +933,112 @@ export interface Message {
     createdAt: string;
     updatedAt?: string;
 }
+/**
+ * @public
+ */
+export interface WebhookChatActionTriggeredEventData {
+    channel: Channel;
+    message: Message;
+    user: User;
+    actionId: string;
+    triggerId: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const WebhookEventType: {
+    readonly ACTION_TRIGGERED: "chat:action:triggered";
+    readonly CHANNEL_CREATED: "chat:channel:created";
+    readonly CHANNEL_UPDATED: "chat:channel:updated";
+    readonly MEMBER_ADDED: "chat:member:added";
+    readonly MEMBER_REMOVED: "chat:member:removed";
+    readonly MESSAGE_DELETED: "chat:message:deleted";
+    readonly MESSAGE_NEW: "chat:message:new";
+    readonly MESSAGE_UPDATED: "chat:message:updated";
+    readonly REACTION_DELETED: "chat:reaction:deleted";
+    readonly REACTION_NEW: "chat:reaction:new";
+};
+/**
+ * @public
+ */
+export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
+/**
+ * @public
+ */
+export interface WebhookChatActionTriggeredEvent {
+    id: string;
+    company: string;
+    type: WebhookEventType;
+    time: number;
+    integrationId?: string;
+    botId?: string;
+    data: WebhookChatActionTriggeredEventData;
+}
+/**
+ * @public
+ */
+export interface WebhookChatChannelCreatedOrUpdatedEventData {
+    channel: Channel;
+    members: (ChannelMember)[];
+    users: (User)[];
+}
+/**
+ * @public
+ */
+export interface WebhookChatChannelCreatedEvent {
+    id: string;
+    company: string;
+    type: WebhookEventType;
+    time: number;
+    integrationId?: string;
+    botId?: string;
+    data: WebhookChatChannelCreatedOrUpdatedEventData;
+}
+/**
+ * @public
+ */
+export interface WebhookChatChannelUpdatedEvent {
+    id: string;
+    company: string;
+    type: WebhookEventType;
+    time: number;
+    integrationId?: string;
+    botId?: string;
+    data: WebhookChatChannelCreatedOrUpdatedEventData;
+}
+/**
+ * @public
+ */
+export interface WebhookChatMemberAddedOrRemovedEventData {
+    channel: Channel;
+    member: ChannelMember;
+    user: User;
+}
+/**
+ * @public
+ */
+export interface WebhookChatMemberAddedEvent {
+    id: string;
+    company: string;
+    type: WebhookEventType;
+    time: number;
+    integrationId?: string;
+    botId?: string;
+    data: WebhookChatMemberAddedOrRemovedEventData;
+}
+/**
+ * @public
+ */
+export interface WebhookChatMemberRemovedEvent {
+    id: string;
+    company: string;
+    type: WebhookEventType;
+    time: number;
+    integrationId?: string;
+    botId?: string;
+    data: WebhookChatMemberAddedOrRemovedEventData;
+}
 /**
  * @public
  */
@@ -959,6 +1136,40 @@ export interface DescribeEventOutput {
     WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent;
     WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent;
     WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent;
+    WebhookChatActionTriggeredEvent?: WebhookChatActionTriggeredEvent;
+}
+/**
+ * @public
+ */
+export interface GetActionTriggerResultInput {
+    /**
+     * The unique identifier of the action trigger inside the message.
+     * @public
+     */
+    triggerId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface GetActionTriggerResultOutput {
+    status: ActionTriggerStatus;
+    result?: ActionTriggerResult;
+}
+/**
+ * @public
+ */
+export declare class TriggerNotFoundException extends __BaseException {
+    readonly name: "TriggerNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TriggerNotFoundException, __BaseException>);
 }
 /**
  * @public
@@ -1194,7 +1405,7 @@ export interface GetUploadedFileInfoInput {
  * @public
  */
 export interface GetUploadedFileInfoOutput {
-    file?: MessageAttachment;
+    file: MessageAttachment;
 }
 /**
  * @public
@@ -1465,6 +1676,36 @@ export interface ListMessagesOutput {
      */
     messages: (Message)[];
 }
+/**
+ * @public
+ */
+export interface ListPinnedMessagesInput {
+    /**
+     * The unique identifier of the channel from which to list messages.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The maximum number of pinned messages to return. The value must be between 1 and 100.
+     * @public
+     */
+    limit?: number;
+    /**
+     * The offset from which to start listing pinned messages. The value must be between 0 and 1000.
+     * @public
+     */
+    offset?: number;
+}
+/**
+ * @public
+ */
+export interface ListPinnedMessagesOutput {
+    /**
+     * A list of pinned messages in the channel.
+     * @public
+     */
+    messages: (Message)[];
+}
 /**
  * @public
  */
@@ -1618,9 +1859,15 @@ export interface PartialUpdateChannelOutput {
  */
 export interface PartialUpdateMessageSetInput {
     text?: string;
+    elements?: (Element)[];
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
+    /**
+     * A list of user IDs mentioned in the message.
+     * @public
+     */
+    mentions?: (string)[];
 }
 /**
  * @public
@@ -1628,7 +1875,9 @@ export interface PartialUpdateMessageSetInput {
  */
 export declare const MessageUnsetFields: {
     readonly ATTACHMENTS: "attachments";
+    readonly ELEMENTS: "elements";
     readonly FORWARD: "forward";
+    readonly MENTIONS: "mentions";
     readonly QUOTE: "quote";
     readonly TEXT: "text";
 };
@@ -1665,6 +1914,11 @@ export interface PartialUpdateMessageInput {
      * @public
      */
     unset?: (MessageUnsetFields)[];
+    /**
+     * Set to true to suppress the updated indicator. Defaults to false.
+     * @public
+     */
+    silent?: boolean;
 }
 /**
  * @public
@@ -1708,6 +1962,42 @@ export declare class PinnedChannelsLimitReachedException extends __BaseException
      */
     constructor(opts: __ExceptionOptionType<PinnedChannelsLimitReachedException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface PinMessageInput {
+    channelId: string;
+    /**
+     * The unique identifier of the message which should be pinned.
+     * @public
+     */
+    messageId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * The duration in seconds after which the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresAt` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresAt` will result in a validation error.
+     * @public
+     */
+    expiresAfter?: number;
+    /**
+     * The specific date and time (in ISO 8601 format) when the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresAt` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresAt` will result in a validation error.
+     * @public
+     */
+    expiresAt?: string;
+    /**
+     * Set to true to suppress system messages generated by this operation. Defaults to false.
+     * @public
+     */
+    silent?: boolean;
+}
+/**
+ * @public
+ */
+export interface PinMessageOutput {
+}
 /**
  * @public
  */
@@ -1734,6 +2024,23 @@ export interface ScheduleExternalFlagAdjustmentJobInput {
  */
 export interface ScheduleExternalFlagAdjustmentJobOutput {
 }
+/**
+ * @public
+ */
+export interface SendActionTriggerResultInput {
+    /**
+     * The unique identifier of the action trigger inside the message.
+     * @public
+     */
+    triggerId: string;
+    status: ActionTriggerStatus;
+    result: ActionTriggerResult;
+}
+/**
+ * @public
+ */
+export interface SendActionTriggerResultOutput {
+}
 /**
  * @public
  */
@@ -1770,6 +2077,7 @@ export interface SendGiphyOutput {
  */
 export interface SendMessageInput {
     text?: string;
+    elements?: (Element)[];
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
@@ -1931,6 +2239,48 @@ export declare class TaggedChannelsLimitReachedException extends __BaseException
      */
     constructor(opts: __ExceptionOptionType<TaggedChannelsLimitReachedException, __BaseException>);
 }
+/**
+ * @public
+ */
+export declare class MessageActionNotFoundException extends __BaseException {
+    readonly name: "MessageActionNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MessageActionNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface TriggerMessageActionInput {
+    /**
+     * The unique identifier of the channel to which the message is sent.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The unique identifier of the message which hold an action.
+     * @public
+     */
+    messageId: string;
+    /**
+     * The unique identifier of the action inside the message.
+     * @public
+     */
+    actionId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface TriggerMessageActionOutput {
+    triggerId: string;
+}
 /**
  * @public
  */
@@ -1951,6 +2301,32 @@ export interface UnpinChannelInput {
  */
 export interface UnpinChannelOutput {
 }
+/**
+ * @public
+ */
+export interface UnpinMessageInput {
+    channelId: string;
+    /**
+     * The unique identifier of the message which should be unpinned.
+     * @public
+     */
+    messageId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string;
+    /**
+     * Set to true to suppress system messages generated by this operation. Defaults to false.
+     * @public
+     */
+    silent?: boolean;
+}
+/**
+ * @public
+ */
+export interface UnpinMessageOutput {
+}
 /**
  * @public
  */
@@ -2063,6 +2439,7 @@ export interface UpdateInboxTagOutput {
  */
 export interface UpdateMessageInput {
     text?: string;
+    elements?: (Element)[];
     attachments?: (MessageAttachment)[];
     quote?: MessageQuote;
     forward?: MessageForward;
@@ -2086,6 +2463,11 @@ export interface UpdateMessageInput {
      * @public
      */
     mentions?: (string)[];
+    /**
+     * Set to true to suppress the updated indicator. Defaults to false.
+     * @public
+     */
+    silent?: boolean;
 }
 /**
  * @public