@giosg/types 6.5.0 → 7.0.1

package/lib/mjs/chat.d.ts

@@ -0,0 +1,1071 @@
+import { NestedAvatar } from "./customer";
+import { NestedUser } from "./customer";
+import { UserUid, VisitorCid, RoomUid, ChatUid, UserLegacyId, OrganizationUid, ChatInvitationUid, TeamUid, ChatMessageUid, RuleUid, ChatReplySuggestionUid, ChatMessageAttachmentActionUid, ChatMessageAttachmentUid, RoomLegacyId, InteractionUid, ChatMessageType, ChatStatusMessageType, ChatDataMessageType, ChatSessionUid, ChatAssignmentUid } from "./types";
+import { LanguageCode } from "./common";
+import { ActionStyle } from "./actions";
+export interface ChatInvitationAccept {
+    /** Unique identifier of the invitation */
+    id: ChatInvitationUid;
+    /** Defines whether the chat invitation has been accepted */
+    is_accepted: boolean;
+    /** Defines whether the chat invitation has been expired. Chat invitation will expire if it’s not accepted before chat ends */
+    is_expired: boolean;
+    /** Unique identifier of the user who made an invitation */
+    invited_by_user_id: UserUid;
+    /** User who made an invitation */
+    invited_by_user: NestedUser;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Unique identifier of the room in which the chat occurred */
+    room_id: RoomUid;
+    /** Unique identifier of the user who was invited */
+    invited_user_id?: UserUid;
+    /** Unique identifier of the team which was invited */
+    invited_team_id?: TeamUid;
+    /** Unique identifier of the organization which was invited */
+    invited_organization_id?: OrganizationUid;
+    /**
+     * Name of the invitee. This is either full name of the user, name of the team, or name of the organization
+     * depending on which party was invited
+     */
+    invitee_name: string;
+    /** Unique of the user who accepted the invitation */
+    accepted_by_user_id: UserUid | null;
+    /** User who accepted the invitation */
+    accepted_by_user: NestedUser | null;
+    /** Number of user members of the chat */
+    user_member_count: number;
+    /** Number of visitor members of the chat */
+    visitor_member_count: number;
+    /** Date when the chat invitation was sent */
+    created_at: string;
+    /** Date when the chat invitation was changed for the last time */
+    updated_at: string;
+    /** Date when the chat invitation was accepted */
+    accepted_at: string | null;
+    /** Date when the chat invitation was expired */
+    expired_at: string | null;
+}
+export interface ChatInvitationAcceptPayload {
+    /** Defines whether the chat invitation has been accepted */
+    is_accepted: boolean;
+}
+export declare type ChatInvitationCreate = {
+    /** Unique identifier of the user who was invited */
+    invited_user_id: UserUid;
+} | {
+    /** Unique identifier of the team which was invited */
+    invited_team_id: TeamUid;
+} | {
+    /** Unique identifier of the organization which was invited */
+    invited_organization_id: OrganizationUid;
+};
+export interface ChatInvitationExpire {
+    /** Unique identifier of the invitation */
+    id: ChatInvitationUid;
+    /** Defines whether the chat invitation has been accepted */
+    is_accepted: boolean;
+    /** Defines whether the chat invitation has been expired. Chat invitation will expire if it’s not accepted before chat ends */
+    is_expired: boolean;
+    /** Unique identifier of the user who made an invitation */
+    invited_by_user_id: UserUid;
+    /** User who made an invitation */
+    invited_by_user: NestedUser;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Unique identifier of the room in which the chat occurred */
+    room_id: RoomUid;
+    /** Unique identifier of the user who was invited */
+    invited_user_id?: UserUid;
+    /** Unique identifier of the team which was invited */
+    invited_team_id?: TeamUid;
+    /** Unique identifier of the organization which was invited */
+    invited_organization_id?: OrganizationUid;
+    /**
+     * Name of the invitee. This is either full name of the user, name of the team, or name of the organization
+     * depending on which party was invited
+     */
+    invitee_name: string;
+    /** Unique of the user who accepted the invitation */
+    accepted_by_user_id: UserUid | null;
+    /** User who accepted the invitation */
+    accepted_by_user: NestedUser | null;
+    /** Number of user members of the chat */
+    user_member_count: number;
+    /** Number of visitor members of the chat */
+    visitor_member_count: number;
+    /** Date when the chat invitation was sent */
+    created_at: string;
+    /** Date when the chat invitation was changed for the last time */
+    updated_at: string;
+    /** Date when the chat invitation was accepted */
+    accepted_at: string | null;
+    /** Date when the chat invitation was expired */
+    expired_at: string | null;
+}
+export interface ChatInvitationExpirePayload {
+    /** Defines whether the chat invitation has been expired. Chat invitation will expire if it’s not accepted before chat ends */
+    is_expired: boolean;
+}
+/**
+ * Only one of the invited_user_id, invited_team_id or invited_organization_id can be defined per chat invitation object.
+ * Other two attributes should be either null or omitted
+ */
+export interface ChatInvitation {
+    /** Unique identifier of the invitation */
+    id: ChatInvitationUid;
+    /** Defines whether the chat invitation has been accepted */
+    is_accepted: boolean;
+    /** Defines whether the chat invitation has been expired. Chat invitation will expire if it’s not accepted before chat ends */
+    is_expired: boolean;
+    /** Unique identifier of the user who made an invitation */
+    invited_by_user_id: UserUid;
+    /** User who made an invitation */
+    invited_by_user: NestedUser;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Unique identifier of the room in which the chat occurred */
+    room_id: RoomUid;
+    /** Unique identifier of the user who was invited */
+    invited_user_id?: UserUid;
+    /** Unique identifier of the team which was invited */
+    invited_team_id?: TeamUid;
+    /** Unique identifier of the organization which was invited */
+    invited_organization_id?: OrganizationUid;
+    /**
+     * Name of the invitee. This is either full name of the user, name of the team, or name of the organization
+     * depending on which party was invited
+     */
+    invitee_name: string;
+    /** Unique of the user who accepted the invitation */
+    accepted_by_user_id: UserUid | null;
+    /** User who accepted the invitation */
+    accepted_by_user: NestedUser | null;
+    /** Number of user members of the chat */
+    user_member_count: number;
+    /** Number of visitor members of the chat */
+    visitor_member_count: number;
+    /** Date when the chat invitation was sent */
+    created_at: string;
+    /** Date when the chat invitation was changed for the last time */
+    updated_at: string;
+    /** Date when the chat invitation was accepted */
+    accepted_at: string | null;
+    /** Date when the chat invitation was expired */
+    expired_at: string | null;
+}
+export interface ChatConversationStarter {
+    /** Language of the message as a RFC 3066 code */
+    language_code: LanguageCode;
+    /** The conversation starter message */
+    message: string;
+    /** Date when the chat conversation starter was created */
+    created_at: string;
+    /** Date when the conversation starter was changed for the last time */
+    updated_at: string;
+}
+export interface ChatConversationStarterPayload {
+    /** Language of the message as a RFC 3066 code */
+    language_code: LanguageCode;
+    /** The conversation starter message */
+    message: string;
+}
+/**
+ * @deprecated
+ */
+export interface ChatConversationStarterUpdate {
+    /** Language of the message as a RFC 3066 code */
+    language_code: LanguageCode;
+    /** The conversation starter message */
+    message: string;
+    /** Date when the chat conversation starter was created */
+    created_at: string;
+    /** Date when the conversation starter was changed for the last time */
+    updated_at: string;
+}
+export interface ChatConversationStarterUpdatePayload {
+    /** The conversation starter message */
+    message: string;
+}
+interface ChatMembershipCommon {
+    /**
+     * The name of the user/visitor as it would be displayed for the operator.
+     * For users this is the actual name. For visitors this is any custom name, or null
+     */
+    member_name: string | null;
+    /**
+     * The name of the user/visitor as it would be displayed for the visitor.
+     * This is user’s alias if they have one, otherwise it is their real name.
+     * For visitors, this is any custom username or null
+     */
+    member_public_name: string | null;
+    /** Avatar image of the user/visitor */
+    member_avatar: NestedAvatar | null;
+    /** Unique identifier of the room where the chat takes place */
+    room_id: RoomUid;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Date when the user/visitor was added as a chat member */
+    created_at: string;
+    /** Date when the chat membership was changed for the last time */
+    updated_at: string;
+    /**
+     * Defines whether the user/visitor has the chat “open”. In practice this reflects the state of the chat window.
+     * When the user/visitor closes the chat window, it is supposed that he is no more participating the chat
+     */
+    is_participating: boolean;
+    /** Defines whether the user/visitor is currently present */
+    is_present: boolean;
+    /** Defines whether the user/visitor is typing. "typed" status is changed to "idle" after 60 seconds */
+    composing_status: "idle" | "typing" | "typed";
+    /** Number of messages the user/visitor has sent to the chat */
+    message_count: number;
+    /** Unique identifier of the room’s organization where the chat takes place */
+    room_organization_id: OrganizationUid;
+    /** Unique identifier of the member’s organization */
+    member_organization_id: OrganizationUid;
+    /** Legacy Unique identifier of the user/visitor being present at the chat. Deprecated, use member_i whenever possible instead */
+    legacy_member_id: UserLegacyId;
+    /** Date until user read messages. Messages after this date are unread */
+    last_seen_at: string | null;
+    /** Unread message count */
+    unread_message_count: number;
+}
+export interface ChatMembershipUser extends ChatMembershipCommon {
+    /** Defines whether the user/visitor is present at the chat */
+    member_type: "user";
+    /** Unique identifier of the user/visitor being present at the chat */
+    member_id: UserUid;
+    /** Defines whether the user is bot user or not */
+    is_bot: boolean;
+    /** Defines wheter the user to whom the membership is related to is deleted */
+    is_user_deleted: boolean;
+}
+export interface ChatMembershipVisitor extends ChatMembershipCommon {
+    /** Defines whether the user/visitor is present at the chat */
+    member_type: "visitor";
+    /** Unique identifier of the user/visitor being present at the chat */
+    member_id: VisitorCid;
+}
+export declare type ChatMembership = ChatMembershipUser | ChatMembershipVisitor;
+export interface ChatMembershipPayload {
+    /**
+     * Defines whether the user/visitor has the chat “open”. In practice this reflects the state of the chat window.
+     * When the user/visitor closes the chat window, it is supposed that he is no more participating the chat
+     */
+    is_participating: boolean;
+    /** Defines whether the user/visitor is typing. "typed" status is changed to "idle" after 60 seconds */
+    composing_status: "idle" | "typing" | "typed";
+    last_seen_at?: string;
+}
+interface ChatMessageCommon {
+    /** Unique identifier of the message */
+    id: ChatMessageUid;
+    /** Defines the type of the message. "msg" by default */
+    type: ChatMessageType;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Unique identifier of the room in which the chat occurred */
+    room_id: RoomUid;
+    /** Date when the message was sent */
+    created_at: string;
+    /** Display name of the sender as the visitor would see it */
+    sender_public_name: string;
+    /** Display name of the sender as an operator would see it */
+    sender_name: string;
+    /** Avatar image of the sender */
+    sender_avatar: NestedAvatar | null;
+    /**
+     * Content text of the message. The maximum length is 2000 characters.
+     * This will always be the decrypted if the decryption key is still being stored at the server
+     */
+    message: string | null;
+    /**
+     * Whether or not the message is stored encrypted. When true, the encrypted_message attribute contains
+     * the encrypted ciphertext of the message
+     */
+    is_encrypted: boolean;
+    /**
+     * The encrypted ciphertext of the message, if encryption is used for the chat.
+     * This attribute is only present if "is_encrypted" is true
+     */
+    encrypted_message?: string | undefined;
+    /**
+     * Date when the message’s sensitive data was purged. This means that the message and
+     * visitor’s "sender_name" and "sender_public_name" are set as null. It is null if the data was not purged
+     */
+    sensitive_data_purged_at: string | null;
+    /** Unique identifier of the chat reply suggestion that was selected as a basis for the message */
+    selected_reply_suggestion_id: ChatReplySuggestionUid | null;
+    /** Chat reply suggestion that was selected as a basis for the message */
+    selected_reply_suggestion: NestedChatReplySuggestion | null;
+    /**
+     * List of the chat message attachments for the chat message.
+     * No more than one if "attachment_template" is set to "interaction"
+     */
+    attachments: NestedChatMessageAttachment[] | null;
+    /** Type of the chat message attachment template */
+    attachment_template: "generic" | "interaction" | "external" | null;
+    /** Unique identifier of the message this message was a response to */
+    response_to_message_id: ChatMessageUid | null;
+    /** Unique identifier of the chosen attachment this was a response to */
+    response_to_attachment_id: ChatMessageAttachmentUid | null;
+    /** Chosen attachment this was a response to */
+    response_to_attachment: NestedChatMessageResponseAttachment | null;
+    /** Unique identifier of the chosen attachment action this was a response to */
+    response_to_action_id: ChatMessageAttachmentActionUid | null;
+    /** Chosen attachment action this was a response to */
+    response_to_action: NestedChatMessageAttachmentAction | null;
+    /** Response text of the attachment response. This field is required for interaction attachment response */
+    response_text: string | null;
+    /**
+     * Chosen attachment value of the response. If the chosen attachment was an action,
+     * then this is the value of the action. Otherwise this may be the attachment’s "title_link_url",
+     * "image_url", "image_link_url" or a link provided in text field
+     */
+    response_value: string | null;
+}
+interface ChatMessageUser extends ChatMessageCommon {
+    /** Defines the type of the sender. "user" by default */
+    sender_type: "user";
+    /** Unique identifier of the sender. Could be user, visitor or rule */
+    sender_id: UserUid;
+}
+interface ChatMessageVisitor extends ChatMessageCommon {
+    /** Defines the type of the sender. "user" by default */
+    sender_type: "visitor";
+    /** Unique identifier of the sender. Could be user, visitor or rule */
+    sender_id: VisitorCid;
+}
+interface ChatMessageRule extends ChatMessageCommon {
+    /** Defines the type of the sender. "user" by default */
+    sender_type: "rule";
+    /** Unique identifier of the sender. Could be user, visitor or rule */
+    sender_id: RuleUid;
+}
+interface ChatStatusMessageUser extends ChatMessageUser {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatStatusMessageType;
+}
+interface ChatStatusMessageVisitor extends ChatMessageVisitor {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatStatusMessageType;
+}
+interface ChatStatusMessageRule extends ChatMessageRule {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatStatusMessageType;
+}
+interface ChatDataMessageUser extends ChatMessageUser {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatDataMessageType;
+}
+interface ChatDataMessageVisitor extends ChatMessageVisitor {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatDataMessageType;
+}
+interface ChatDataMessageRule extends ChatMessageRule {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatDataMessageType;
+}
+export declare type ChatStatusMessage = ChatStatusMessageUser | ChatStatusMessageVisitor | ChatStatusMessageRule;
+export declare type ChatDataMessage = ChatDataMessageUser | ChatDataMessageVisitor | ChatDataMessageRule;
+export declare type ChatMessage = ChatStatusMessage | ChatDataMessage;
+export interface ChatMessagePayload {
+    /**
+     * Content text of the message. The maximum length is 2000 characters.
+     * This will always be the decrypted if the decryption key is still being stored at the server
+     */
+    message: string | null;
+    /** Unique identifier of the chat reply suggestion that was selected as a basis for the message */
+    selected_reply_suggestion_id?: ChatReplySuggestionUid | null;
+    /**
+     * List of the chat message attachments for the chat message.
+     * No more than one if "attachment_template" is set to "interaction"
+     */
+    attachments?: NestedChatMessageAttachmentPayload[] | null;
+    /** Type of the chat message attachment template */
+    attachment_template?: "generic" | "interaction" | "external";
+}
+export interface ChatReplySuggestion {
+    /** Unique identifier of the reply suggestion */
+    id: ChatReplySuggestionUid;
+    /** Unique identifier of the user who created the reply suggestion */
+    created_by_user_id: UserUid;
+    /** User who created the reply suggestion */
+    created_by_user: NestedUser;
+    /** User who changed the reply suggestion for the last time */
+    updated_by_user_id: UserUid;
+    /** Unique identifier of the user who changed the reply suggestion for the last time */
+    updated_by_user: NestedUser;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Unique identifier of the chat message which the reply suggestion is tied to */
+    message_id: ChatMessageUid;
+    /** Unique identifier of the room where the chat takes place */
+    room_id: RoomUid;
+    /** Unique identifier of the user’s organization */
+    organization_id: OrganizationUid;
+    /** Date when the reply suggestion was created */
+    created_at: string;
+    /** Date when the reply suggestion was changed for the last time */
+    updated_at: string;
+    /** Message of the reply suggestion */
+    suggestion: string;
+    /** Defines appropriateness level of the reply suggestion for the message. The value range is [0 - 1] or null */
+    relevancy_score: number | null;
+}
+export interface ChatReplySuggestionPayload {
+    /** Message of the reply suggestion */
+    suggestion: string;
+    /** Defines appropriateness level of the reply suggestion for the message. The value range is [0 - 1] or null */
+    relevancy_score?: number | null;
+}
+export declare type ChatType = "operator" | "visitor" | "external" | "group" | "task";
+export interface Chat {
+    /** Unique identifier of the chat */
+    id: ChatUid;
+    /**
+     * Defines the chat type.  Chats with type operator are chat sessions between only users.
+     * Chats with type visitor are chat sessions that has a visitor membership. Chats with type external are chat
+     * sessions that are from external source (e.g. some integration). These chat’s do not close automatically
+     */
+    chat_type: ChatType;
+    /** Date when the chat was created */
+    created_at: string;
+    /** Date when the chat was changed for the last time */
+    updated_at: string;
+    /** Date when the chat conversation ended */
+    ended_at: string | null;
+    /** Date when the chat became waiting */
+    waiting_started_at: string;
+    /** Unique identifier of the room in which the chat occurred */
+    room_id: RoomUid;
+    /** Unique identifier of the organization which owns the room in which the chat occurred */
+    room_organization_id: OrganizationUid;
+    /** Name of the room in which the chat occurred */
+    room_name: string;
+    /** Number of tags associated with the chat */
+    tag_count: number;
+    /** Number of messages in the chat at the moment */
+    message_count: number;
+    /** Number of messages sent by operators in the chat */
+    user_message_count: number;
+    /** Number of messages sent by visitors in the chat */
+    visitor_message_count: number;
+    /** Defines whether there are any messages in chat */
+    has_messages: boolean;
+    /** Defines whether there are any user messages in chat */
+    has_user_messages: boolean;
+    /** Defines whether there are any visitor messages in chat */
+    has_visitor_messages: boolean;
+    /** Number of people (visitors and users) currently participating and present at the chat */
+    present_participant_count: number;
+    /** Number of users currently participating and present at the chat */
+    present_user_participant_count: number;
+    /** Number of visitors currently participating and present at the chat */
+    present_visitor_participant_count: number;
+    /** Number of people (visitors and users) attended or sent messages to the chat */
+    member_count: number;
+    /** Number of users sent at least one message to the chat */
+    user_member_count: number;
+    /** Number of visitors attended the chat */
+    visitor_member_count: number;
+    /** Defines whether the chat is marked as private for its operators */
+    is_private: boolean;
+    /** Defines whether the chat is an actual conversation */
+    is_real_conversation: boolean;
+    /** Defines whether the chat started with an automatic autosuggestion message */
+    is_autosuggested: boolean;
+    /** Defines whether the chats is new and was started by a visitor and response by a user is required */
+    is_waiting: boolean;
+    /** Defines whether the chat is waiting and the chat has no present user members */
+    is_pending: boolean;
+    /** Defines whether the chat has ended. Once ended the chat is locked and messages and members can't be altered */
+    is_ended: boolean;
+    /** Defines whether the messages of the chat are stored encrypted */
+    is_encrypted: boolean;
+    /**
+     * Encrypted symmetric key (AES) with which all the chat messages in the chat are encrypted.
+     * This attribute is available only if "is_encrypted" is true
+     */
+    encrypted_symmetric_key: string | null;
+    /** Full URL of the page that the visitor was on when they received an autosuggest */
+    autosuggest_url: string | null;
+    /** Title of the page that the visitor was on when they received an autosuggest */
+    autosuggest_url_title: string | null;
+    /** Full URL of the page that the visitor was on when they sent their first message to te chat */
+    first_visitor_message_url: string | null;
+    /** Title of the page that the visitor was on when they sent their first message */
+    first_visitor_message_url_title: string | null;
+    /**
+     * @deprecated
+     */
+    /** Legacy Giosg signed encoded unique string for the chat. Deprecated*/
+    token: string;
+    /**
+     * @deprecated
+     */
+    /** Legacy conversation state of the chat. Deprecated */
+    legacy_conversation_state: string;
+    /**
+     * @deprecated
+     */
+    /** Legacy ID of the chat’s room. Deprecated use "room_id" instead */
+    legacy_room_id: RoomLegacyId;
+    /** Number of seconds the visitor had to wait for an answer to the first sent message */
+    visitor_wait_time: number | null;
+    /** Duration of the chat in seconds. This value is null until the chat has ended */
+    duration: number | null;
+    /**
+     * Number of seconds of the chat duration was considered to be active time. This is calculated so
+     * that after each message chat is assumed to be active for 60 seconds and idle after that if no new messages
+     * are received. This value is null until the chat has ended
+     */
+    active_duration: number | null;
+}
+export interface ChatPayload {
+    /** Defines whether the chats is new and was started by a visitor and response by a user is required */
+    is_waiting?: boolean;
+    /** Defines whether the chat has ended. Once ended the chat is locked and messages and members can't be altered */
+    is_ended?: boolean;
+}
+export interface ChatSessionTag {
+    /** Name of the tag */
+    name: string;
+    /** Sha1 hash of the tag. This is the only information that the visitor and goals generated have about the tag */
+    hashed_name: string;
+    /** Date when the chat was tagged with this tag */
+    created_at: string;
+}
+export interface ChatSessionTagPayload {
+    /** Name of the tag */
+    name: string;
+}
+interface DecryptedChatMessageCommon {
+    /** Unique identifier of the message */
+    id: ChatMessageUid;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Unique identifier of the room in which the chat occurred */
+    room_id: RoomUid;
+    /** Date when the message was sent */
+    created_at: string;
+    /** Display name of the sender as the visitor would see it */
+    sender_public_name: string;
+    /** Display name of the sender as an operator would see it */
+    sender_name: string;
+    /** Avatar image of the sender */
+    sender_avatar: NestedAvatar | null;
+    /**
+     * Content text of the message. The maximum length is 2000 characters.
+     * This will always be the decrypted if the decryption key is still being stored at the server
+     */
+    message: string | null;
+    /**
+     * Whether or not the message is stored encrypted. When true, the "encrypted_message" attribute contains
+     * the encrypted ciphertext of the message
+     */
+    is_encrypted: boolean;
+    /**
+     * The encrypted ciphertext of the message, if encryption is used for the chat.
+     * This attribute is only present if "is_encrypted" is true
+     */
+    encrypted_message?: string | null;
+    /**
+     * Date when the message’s sensitive data was purged. This means that the message and
+     * visitor’s "sender_name" and "sender_public_name" are set as null. It is null if the data was not purged
+     */
+    sensitive_data_purged_at: string | null;
+    /** Unique identifier of the chat reply suggestion that was selected as a basis for the message */
+    selected_reply_suggestion_id: ChatReplySuggestionUid | null;
+    /** Chat reply suggestion that was selected as a basis for the message */
+    selected_reply_suggestion: NestedChatReplySuggestion | null;
+    /**
+     * List of the chat message attachments for the chat message.
+     * No more than one if "attachment_template" is set to "interaction"
+     */
+    attachments: NestedChatMessageAttachment[] | null;
+    /** Type of the chat message attachment template */
+    attachment_template: "generic" | "interaction" | "external" | null;
+    /** Unique identifier of the message this message was a response to */
+    response_to_message_id: ChatMessageUid | null;
+    /** Unique identifier of the chosen attachment this was a response to */
+    response_to_attachment_id: ChatMessageAttachmentUid | null;
+    /** Chosen attachment this was a response to */
+    response_to_attachment: NestedChatMessageResponseAttachment | null;
+    /** Unique identifier of the chosen attachment action this was a response to */
+    response_to_action_id: ChatMessageAttachmentActionUid | null;
+    /** Chosen attachment action this was a response to */
+    response_to_action: NestedChatMessageAttachmentAction | null;
+    /** Response text of the attachment response. This field is required for interaction attachment response */
+    response_text: string | null;
+    /**
+     * Chosen attachment value of the response. If the chosen attachment was an action,
+     * then this is the value of the action. Otherwise this may be the attachment’s "title_link_url",
+     * "image_url", "image_link_url" or a link provided in text field
+     */
+    response_value: string | null;
+}
+interface DecryptedChatMessageUser extends DecryptedChatMessageCommon {
+    /** Defines the type of the sender. "user" by default */
+    sender_type: "user";
+    /** Unique identifier of the sender. Could be user, visitor or rule */
+    sender_id: UserUid;
+}
+interface DecryptedChatMessageVisitor extends DecryptedChatMessageCommon {
+    /** Defines the type of the sender. "user" by default */
+    sender_type: "visitor";
+    /** Unique identifier of the sender. Could be user, visitor or rule */
+    sender_id: VisitorCid;
+}
+interface DecryptedChatMessageRule extends DecryptedChatMessageCommon {
+    /** Defines the type of the sender. "user" by default */
+    sender_type: "rule";
+    /** Unique identifier of the sender. Could be user, visitor or rule */
+    sender_id: RuleUid;
+}
+interface DecryptedChatStatusMessageUser extends DecryptedChatMessageUser {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatStatusMessageType;
+}
+interface DecryptedChatStatusMessageVisitor extends DecryptedChatMessageVisitor {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatStatusMessageType;
+}
+interface DecryptedChatStatusMessageRule extends DecryptedChatMessageRule {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatStatusMessageType;
+}
+interface DecryptedChatDataMessageUser extends DecryptedChatMessageUser {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatDataMessageType;
+}
+interface DecryptedChatDataMessageVisitor extends DecryptedChatMessageVisitor {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatDataMessageType;
+}
+interface DecryptedChatDataMessageRule extends DecryptedChatMessageRule {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatDataMessageType;
+}
+export declare type DecryptedChatDataMessage = DecryptedChatDataMessageUser | DecryptedChatDataMessageVisitor | DecryptedChatDataMessageRule;
+export declare type DecryptedChatStatusMessage = DecryptedChatStatusMessageUser | DecryptedChatStatusMessageVisitor | DecryptedChatStatusMessageRule;
+export declare type DecryptedChatMessage = DecryptedChatDataMessage | DecryptedChatStatusMessage;
+export interface DecryptedChatMessagePayload {
+    /**
+     * Content text of the message. The maximum length is 2000 characters.
+     * This will always be the decrypted if the decryption key is still being stored at the server
+     */
+    message: string | null;
+    /** Unique identifier of the chat reply suggestion that was selected as a basis for the message */
+    selected_reply_suggestion_id?: ChatReplySuggestionUid | null;
+    /**
+     * List of the chat message attachments for the chat message.
+     * No more than one if "attachment_template" is set to "interaction"
+     */
+    attachments?: NestedChatMessageAttachment[] | null;
+    /** Type of the chat message attachment template */
+    attachment_template?: "generic" | "interaction" | "external";
+}
+export interface NestedChatMessageAttachmentAction {
+    /** Unique identifier of the action */
+    id: ChatMessageAttachmentActionUid;
+    /** Text of the action. This text will be shown inside the button when rendered to the user interface */
+    text: string;
+    /** Type of this action */
+    type: "button" | "link_button";
+    /** Target URL of the link_button */
+    link_target?: "_blank" | "_parent";
+    /** Value for this action. For link_button should be an url or anchor */
+    value: string;
+    /** Style of the action. This defines color of the button. If omitted, defaults to secondary */
+    style: ActionStyle;
+    /** Defines whether the actions are disabled after selection */
+    is_disabled_on_selection: boolean;
+    /** Defines whether the actions are disabled after visitor sends a new message to chat conversation */
+    is_disabled_on_visitor_message: boolean;
+}
+export interface NestedChatMessageAttachmentActionPayload {
+    /** Text of the action. This text will be shown inside the button when rendered to the user interface */
+    text: string;
+    /** Type of this action */
+    type: "button" | "link_button";
+    /** Target URL of the link_button */
+    link_target?: "_blank" | "_parent";
+    /** Value for this action. For link_button should be an url or anchor */
+    value: string;
+    /** Style of the action. This defines color of the button. If omitted, defaults to secondary */
+    style?: ActionStyle;
+    /** Defines whether the actions are disabled after selection */
+    is_disabled_on_selection: boolean;
+    /** Defines whether the actions are disabled after visitor sends a new message to chat conversation */
+    is_disabled_on_visitor_message: boolean;
+}
+export interface NestedChatMessageAttachment {
+    /** Unique identifier of the attachment */
+    id: ChatMessageAttachmentUid;
+    /** Title of the attachment */
+    title: string;
+    /** URL of the title. If provided, then title will show as clickable link which will open in the given URL */
+    title_link_url: string | null;
+    /** Text part of the attachment. This may serve as description. This can also be a Markdown */
+    text: string;
+    /** URL of the image */
+    image_url: string | null;
+    /** URL of the image link. If provided, then the image will be shown as clickable image which will open in the given URL */
+    image_link_url: string | null;
+    /** Defines whether the link is opened in a new tab or redirects current tab to a new URL */
+    link_target: "_blank" | "_parent";
+    /** List of possible actions for this attachment */
+    actions: NestedChatMessageAttachmentAction[];
+    /** URL of an external page to attach. If provided, then the page will be sent to chat conversation in an iframe*/
+    attachment_url: string | null;
+    /** Unique identifier of interaction to attach. If provided, then the interaction will be attached to chat conversation */
+    interaction_id: InteractionUid | null;
+    /** Free form JSON to be used as parameters for interaction attachment  */
+    parameters: {
+        [key: string]: any;
+    };
+}
+export interface NestedChatMessageAttachmentPayload {
+    /** Title of the attachment */
+    title?: string;
+    /** URL of the title. If provided, then title will show as clickable link which will open in the given URL */
+    title_link_url?: string | null;
+    /** Text part of the attachment. This may serve as description. This can also be a Markdown */
+    text?: string;
+    /** URL of the image */
+    image_url?: string | null;
+    /** URL of the image link. If provided, then the image will be shown as clickable image which will open in the given URL */
+    image_link_url?: string | null;
+    /** Defines whether the link is opened in a new tab or redirects current tab to a new URL */
+    link_target?: "_blank" | "_parent";
+    /** List of possible actions for this attachment  */
+    actions?: NestedChatMessageAttachmentAction[];
+    /** URL of an external page to attach. If provided, then the page will be sent to chat conversation in an iframe*/
+    attachment_url?: string | null;
+    /** Unique identifier of interaction to attach. If provided, then the interaction will be attached to chat conversation */
+    interaction_id?: InteractionUid | null;
+    /** Free form JSON to be used as parameters for interaction attachment  */
+    parameters?: {
+        [key: string]: any;
+    };
+}
+export interface NestedChatMessageResponseAttachment {
+    /** Unique identifier of the attachment */
+    id: ChatMessageAttachmentUid;
+    /** Title of the attachment */
+    title: string;
+    /** URL of the title. If provided, then title will show as clickable link which will open in the given URL */
+    title_link_url: string | null;
+    /** Text part of the attachment. This may serve as description. This can also be a Markdown */
+    text: string;
+    /** URL of the image */
+    image_url: string | null;
+    /** URL of the image link. If provided, then the image will be shown as clickable image which will open in the given URL */
+    image_link_url: string | null;
+    /** Defines whether the link is opened in a new tab or redirects current tab to a new URL */
+    link_target: "_blank" | "_parent";
+    /** Unique identifier of interaction to attach. If provided, then the interaction will be attached to chat conversation */
+    interaction_id: InteractionUid | null;
+    /** Free form JSON to be used as parameters for interaction attachment  */
+    parameters: {
+        [key: string]: any;
+    };
+}
+export interface NestedChatMessageResponseAttachmentPayload {
+    /** Title of the attachment */
+    title?: string;
+    /** URL of the title. If provided, then title will show as clickable link which will open in the given URL */
+    title_link_url?: string | null;
+    /** Text part of the attachment. This may serve as description. This can also be a Markdown */
+    text?: string;
+    /** URL of the image */
+    image_url?: string | null;
+    /** URL of the image link. If provided, then the image will be shown as clickable image which will open in the given URL */
+    image_link_url?: string | null;
+    /** Defines whether the link is opened in a new tab or redirects current tab to a new URL */
+    link_target?: "_blank" | "_parent";
+    /** Unique identifier of interaction to attach. If provided, then the interaction will be attached to chat conversation */
+    interaction_id?: InteractionUid | null;
+    /** Free form JSON to be used as parameters for interaction attachment  */
+    parameters?: {
+        [key: string]: any;
+    };
+}
+export interface NestedChatReplySuggestion {
+    /** Unique identifier of the reply suggestion */
+    id: ChatReplySuggestionUid;
+    /** Message of the reply suggestion */
+    suggestion: string;
+    /** Defines appropriateness level of the reply suggestion for the message. The value range is [0 - 1] or null */
+    relevancy_score: number | null;
+    /** Unique identifier of the chat message which the reply suggestion is tied to */
+    message_id: ChatMessageUid;
+}
+interface OrganizationChatMembershipCommon {
+    /**
+     * The name of the user/visitor as it would be displayed for the operator.
+     * For users this is the actual name. For visitors this is any custom name, or null
+     */
+    member_name: string | null;
+    /**
+     * The name of the user/visitor as it would be displayed for the visitor.
+     * This is user’s alias if they have one, otherwise it is their real name.
+     * For visitors, this is any custom username or null
+     */
+    member_public_name: string | null;
+    /** Avatar image of the user/visitor */
+    member_avatar: NestedAvatar | null;
+    /** Unique identifier of the room where the chat takes place */
+    room_id: RoomUid;
+    /** Unique identifier of the chat */
+    chat_id: ChatUid;
+    /** Date when the user/visitor was added as a chat member */
+    created_at: string;
+    /** Date when the chat membership was changed for the last time */
+    updated_at: string;
+    /**
+     * Defines whether the user/visitor has the chat “open”. In practice this reflects the state of the chat window.
+     * When the user/visitor closes the chat window, it is supposed that he is no more participating the chat
+     */
+    is_participating: boolean;
+    /** Defines whether the user/visitor is currently present */
+    is_present: boolean;
+    /** Defines whether the user/visitor is typing. "typed" status is changed to "idle" after 60 seconds */
+    composing_status: "idle" | "typing" | "typed";
+    /** Number of messages the user/visitor has sent to the chat */
+    message_count: number;
+    /** Unique identifier of the room’s organization where the chat takes place */
+    room_organization_id: OrganizationUid;
+    /** Unique identifier of the member’s organization */
+    member_organization_id: OrganizationUid;
+    /** @deprecated Legacy Unique identifier of the user/visitor being present at the chat. Deprecated, use "member_id" whenever possible instead */
+    legacy_member_id: UserLegacyId;
+}
+interface OrganizationChatMembershipUser extends OrganizationChatMembershipCommon {
+    /** Unique identifier of the user/visitor being present at the chat */
+    member_id: UserUid;
+    /** Defines whether the user/visitor is present at the chat */
+    member_type: "user";
+}
+interface OrganizationChatMembershipVisitor extends OrganizationChatMembershipCommon {
+    /** Unique identifier of the user/visitor being present at the chat */
+    member_id: VisitorCid;
+    /** Defines whether the user/visitor is present at the chat */
+    member_type: "visitor";
+}
+export declare type OrganizationChatMembership = OrganizationChatMembershipUser | OrganizationChatMembershipVisitor;
+export interface OrganizationChatMembershipPayload {
+    /** Unique identifier of the user/visitor being present at the chat */
+    member_id: UserUid | VisitorCid;
+    /**
+     * Defines whether the user/visitor has the chat “open”. In practice this reflects the state of the chat window.
+     * When the user/visitor closes the chat window, it is supposed that he is no more participating the chat
+     */
+    is_participating: boolean;
+    /** Defines whether the user/visitor is typing. "typed" status is changed to "idle" after 60 seconds */
+    composing_status: "idle" | "typing" | "typed";
+}
+export interface RoomChatTag {
+    /** Name of the tag */
+    name: string;
+    /** Sha1 hash of the tag. This is the only information that the visitor and goals generated have about the tag */
+    hashed_name: string;
+    /** Date when the chat was tagged with this tag */
+    created_at: string;
+    /** Unique identifier of the room to which this tag belongs to */
+    room_id: RoomUid;
+}
+export interface RoomChatTagPayload {
+    /** Name of the tag */
+    name: string;
+}
+/**
+ * Beta version
+ * Very limited subset of ChatMessage
+ * */
+export interface NestedChatMessage {
+    /** Unique identifier of the message */
+    id: ChatMessageUid;
+    /** Defines the type of the message. "msg" by default */
+    type: ChatMessageType;
+    /** Date when the message was sent */
+    created_at: string;
+    /** TODO: Connect this type to sender_type */
+    sender_id: UserUid | RuleUid | VisitorCid;
+    /** Defines the type of the sender_id */
+    sender_type: "user" | "rule" | "visitor";
+    /** Display name of the sender as an operator would see it */
+    sender_name: string;
+    /** Display name of the sender as the visitor would see it */
+    sender_public_name: string;
+    /** Avatar image of the sender */
+    sender_avatar: NestedAvatar | null;
+    /**
+     * Content text of the message. The maximum length is 2000 characters.
+     * This will always be the decrypted if the decryption key is still being stored at the server
+     */
+    message: string | null;
+    /**
+     * Whether or not the message is stored encrypted. When true, the encrypted_message attribute contains
+     * the encrypted ciphertext of the message
+     */
+    is_encrypted: boolean;
+    /**
+     * The encrypted ciphertext of the message, if encryption is used for the chat.
+     * This attribute is only present if "is_encrypted" is true
+     */
+    encrypted_message?: string | null;
+    /**
+     * Date when the message’s sensitive data was purged. This means that the message and
+     * visitor’s "sender_name" and "sender_public_name" are set as null. It is null if the data was not purged
+     */
+    sensitive_data_purged_at: string | null;
+    /** Type of the chat message attachment template */
+    attachment_template: "generic" | "interaction" | "external" | null;
+}
+/**
+ * Beta version
+ * Mostly consists of Chat interface with some additional field
+ * It intentionally does not extends Chat interface because we might want to remove
+ *  some fields from this interface
+ */
+export interface BarChat {
+    /** Unique identifier of the chat */
+    id: ChatUid;
+    /**
+     * Defines the chat type.  Chats with type operator are chat sessions between only users.
+     * Chats with type visitor are chat sessions that has a visitor membership. Chats with type external are chat
+     * sessions that are from external source (e.g. some integration). These chat’s do not close automatically
+     */
+    chat_type: ChatType;
+    /** Date when the chat was created */
+    created_at: string;
+    /** Date when the chat was changed for the last time */
+    updated_at: string;
+    /** Date when the chat conversation ended */
+    ended_at: string | null;
+    /** Date when the chat became waiting */
+    waiting_started_at: string;
+    /** Unique identifier of the room in which the chat occurred */
+    room_id: RoomUid;
+    /** Unique identifier of the organization which owns the room in which the chat occurred */
+    room_organization_id: OrganizationUid;
+    /** Name of the room in which the chat occurred */
+    room_name: string;
+    /** Number of tags associated with the chat */
+    tag_count: number;
+    /** Number of messages in the chat at the moment */
+    message_count: number;
+    /** Number of messages sent by operators in the chat */
+    user_message_count: number;
+    /** Number of messages sent by visitors in the chat */
+    visitor_message_count: number;
+    /** Defines whether there are any messages in chat */
+    has_messages: boolean;
+    /** Defines whether there are any user messages in chat */
+    has_user_messages: boolean;
+    /** Defines whether there are any visitor messages in chat */
+    has_visitor_messages: boolean;
+    /** Number of people (visitors and users) currently participating and present at the chat */
+    present_participant_count: number;
+    /** Number of users currently participating and present at the chat */
+    present_user_participant_count: number;
+    /** Number of visitors currently participating and present at the chat */
+    present_visitor_participant_count: number;
+    /** Number of people (visitors and users) attended or sent messages to the chat */
+    member_count: number;
+    /** Number of users sent at least one message to the chat */
+    user_member_count: number;
+    /** Number of visitors attended the chat */
+    visitor_member_count: number;
+    /** Defines whether the chat is marked as private for its operators */
+    is_private: boolean;
+    /** Defines whether the chat is an actual conversation */
+    is_real_conversation: boolean;
+    /** Defines whether the chat started with an automatic autosuggestion message */
+    is_autosuggested: boolean;
+    /** Defines whether the chats is new and was started by a visitor and response by a user is required */
+    is_waiting: boolean;
+    /** Defines whether the chat is waiting and the chat has no present user members */
+    is_pending: boolean;
+    /** Defines whether the chat has ended. Once ended the chat is locked and messages and members can't be altered */
+    is_ended: boolean;
+    /** Defines whether the messages of the chat are stored encrypted */
+    is_encrypted: boolean;
+    /** True if the message contents are available and False if they are encrypted and the encryption key is not available anymore */
+    is_available: boolean;
+    /** True if chat session was removed by manual request or by data retention policy */
+    is_removed: boolean;
+    /**
+     * Encrypted symmetric key (AES) with which all the chat messages in the chat are encrypted.
+     * This attribute is available only if "is_encrypted" is true
+     */
+    encrypted_symmetric_key: string | null;
+    /** Full URL of the page that the visitor was on when they received an autosuggest */
+    autosuggest_url: string | null;
+    /** Title of the page that the visitor was on when they received an autosuggest */
+    autosuggest_url_title: string | null;
+    /** Full URL of the page that the visitor was on when they sent their first message to te chat */
+    first_visitor_message_url: string | null;
+    /** Title of the page that the visitor was on when they sent their first message */
+    first_visitor_message_url_title: string | null;
+    /** Number of seconds the visitor had to wait for an answer to the first sent message */
+    visitor_wait_time: number | null;
+    /** Duration of the chat in seconds. This value is null until the chat has ended */
+    duration: number | null;
+    /**
+     * Number of seconds of the chat duration was considered to be active time. This is calculated so
+     * that after each message chat is assumed to be active for 60 seconds and idle after that if no new messages
+     * are received. This value is null until the chat has ended
+     */
+    active_duration: number | null;
+    /** Chat session latest message if exists */
+    chat_session_latest_message: ChatMessage | null;
+    /**
+     * Chat name
+     * Can be visitor name or chat conversation name.
+     *
+     * Visitor name is set by visitor variables.
+     * Further information is here https://developers.giosg.com/javascript_api.html#submit-visitor-variables
+     */
+    name: string | null;
+    /**
+     * Containts URL of visitor avatar.
+     *
+     * Visitor avatar url is set by visitor variables.
+     * Further information is here https://developers.giosg.com/javascript_api.html#submit-visitor-variables
+     */
+    visitor_avatar: string | null;
+    /**
+     * Contains VisitorCid if chat type is "visitor"
+     */
+    visitor_id: VisitorCid | null;
+    /** Team ID if this chat is team chat channel type, null otherwise */
+    team_id: TeamUid | null;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface ChatAssignment {
+    id: ChatAssignmentUid;
+    is_accepted: boolean;
+    is_expired: boolean;
+    invited_by_user_id: UserUid;
+    invited_by_user: NestedUser;
+    chat_id: ChatSessionUid;
+    room_id: RoomUid;
+    invited_user_id: UserUid | null;
+    invited_team_id: TeamUid | null;
+    invited_organization_id: OrganizationUid | null;
+    invitee_name: string;
+    accepted_by_user_id: UserUid | null;
+    accepted_by_user: NestedUser | null;
+    user_member_count: number;
+    visitor_member_count: number;
+    created_at: string;
+    updated_at: string;
+    accepted_at: string | null;
+    expired_at: string | null;
+}
+export {};
+//# sourceMappingURL=chat.d.ts.map