@giosg/types 6.10.0 → 7.0.1

package/lib/cjs/oath.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAUTH_ERROR_TYPES = exports.OAUTH_PROMPT_OPTIONS = exports.OAUTH_RESPONSE_TYPES = exports.OAUTH_SCOPE_OPTIONS = exports.OAUTH_BASE_URL = void 0;
+exports.OAUTH_BASE_URL = "https://service.giosg.com/identity/authorize";
+exports.OAUTH_SCOPE_OPTIONS = [
+    "openid",
+    "openid profile",
+    "openid email",
+    "openid profile email",
+];
+exports.OAUTH_RESPONSE_TYPES = [
+    /**
+     * @deprecated
+     */
+    "id_token",
+    "id_token token",
+];
+exports.OAUTH_PROMPT_OPTIONS = ["none", "login"];
+exports.OAUTH_ERROR_TYPES = [
+    "invalid_request",
+    "invalid_client",
+    "invalid_scope",
+    "interaction_required",
+    "login_required",
+];

package/lib/cjs/partnerships.d.ts

@@ -0,0 +1,54 @@
+import { NestedAvatar } from "./customer";
+import { NestedOrganization } from "./customer";
+import { OrganizationUid, UserUid, AvatarUid } from "./types";
+export interface PartnerOrganization {
+    /** Unique identifier of the partner organization */
+    id: OrganizationUid;
+    /** Name of the partner organization */
+    name: string;
+    /** Date when the partner organization was created */
+    created_at: string;
+    /** Defines whether the partner organization is currently present */
+    is_present: boolean;
+    /** Defines whether the partner organization is currently online */
+    is_online: boolean;
+}
+export interface PartnerOrganizationUser {
+    /** Unique identifier of the user */
+    id: UserUid;
+    /** Full name of the user */
+    full_name: string;
+    /** Email address of the user */
+    email: string;
+    /** Number of chats the user has, based on the most recent information about the user */
+    current_chat_count: number;
+    /** Unique identifier of the users avatar */
+    avatar_id: AvatarUid | null;
+    /** Avatar of the user */
+    avatar: NestedAvatar | null;
+    /** Date when the user was created */
+    created_at: string;
+    /** Defines whether the user is currently present, based on the most recent information about the user*/
+    is_present: boolean;
+    /** Defines whether the user is currently online */
+    is_online: boolean;
+}
+export interface Partnership {
+    /** Partner organization */
+    partner_organization: NestedOrganization;
+    /** Unique identifier of the partner organization */
+    partner_organization_id: OrganizationUid;
+    /** Unique identifier of the organization */
+    organization_id: OrganizationUid;
+    /** Organization that owns the partnership */
+    organization: NestedOrganization;
+    /** Name that is shown to your organization members for this partner. May be null, in which case the original name is shown */
+    display_name: string | null;
+    /** Date when the partnership was created */
+    created_at: string;
+}
+export interface PartnershipPayload {
+    /** Unique identifier of the partner organization */
+    partner_organization_id: OrganizationUid;
+}
+//# sourceMappingURL=partnerships.d.ts.map

package/lib/cjs/partnerships.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partnerships.d.ts","sourceRoot":"","sources":["../../src/partnerships.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9D,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,EAAE,EAAE,eAAe,CAAC;IAEpB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IAEb,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IAEnB,oEAAoE;IACpE,UAAU,EAAE,OAAO,CAAC;IAEpB,mEAAmE;IACnE,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;IAElB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IAEd,wFAAwF;IACxF,kBAAkB,EAAE,MAAM,CAAC;IAE3B,4CAA4C;IAC5C,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAE5B,yBAAyB;IACzB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAE5B,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,wGAAwG;IACxG,UAAU,EAAE,OAAO,CAAC;IAEpB,mDAAmD;IACnD,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,2BAA2B;IAC3B,oBAAoB,EAAE,kBAAkB,CAAC;IAEzC,oDAAoD;IACpD,uBAAuB,EAAE,eAAe,CAAC;IAEzC,4CAA4C;IAC5C,eAAe,EAAE,eAAe,CAAC;IAEjC,6CAA6C;IAC7C,YAAY,EAAE,kBAAkB,CAAC;IAEjC,8HAA8H;IAC9H,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,oDAAoD;IACpD,uBAAuB,EAAE,eAAe,CAAC;CAC1C"}

package/lib/cjs/partnerships.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/permissions.d.ts

@@ -0,0 +1,26 @@
+import { NestedOrganization } from "./customer";
+import { NestedUser } from "./customer";
+import { OrganizationUid, UserUid, UserPermissionScope } from "./types";
+export interface UserPermission {
+    /** Organization to which user belongs to */
+    organization: NestedOrganization;
+    /** Unique identifier of the organization to which user belongs to */
+    organization_id: OrganizationUid;
+    /** User to whom the permission was given */
+    user: NestedUser;
+    /** Unique identifier of the user to whom the permission was given */
+    user_id: UserUid;
+    /** Defines resource that is accessible by the user */
+    scope: UserPermissionScope;
+    /** Date when the user permission was created */
+    created_at: string;
+    /** Unique identifier of the user which created the user permission */
+    created_by_user_id: UserUid;
+    /** User which created the user permission */
+    created_by_user: NestedUser;
+}
+export interface UserPermissionPayload {
+    /** Defines resource that is accessible by the user */
+    scope: UserPermissionScope;
+}
+//# sourceMappingURL=permissions.d.ts.map

package/lib/cjs/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../src/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAExE,MAAM,WAAW,cAAc;IAC7B,4CAA4C;IAC5C,YAAY,EAAE,kBAAkB,CAAC;IAEjC,qEAAqE;IACrE,eAAe,EAAE,eAAe,CAAC;IAEjC,4CAA4C;IAC5C,IAAI,EAAE,UAAU,CAAC;IAEjB,qEAAqE;IACrE,OAAO,EAAE,OAAO,CAAC;IAEjB,sDAAsD;IACtD,KAAK,EAAE,mBAAmB,CAAC;IAE3B,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IAEnB,sEAAsE;IACtE,kBAAkB,EAAE,OAAO,CAAC;IAE5B,6CAA6C;IAC7C,eAAe,EAAE,UAAU,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,sDAAsD;IACtD,KAAK,EAAE,mBAAmB,CAAC;CAC5B"}

package/lib/cjs/permissions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/public.d.ts

@@ -0,0 +1,418 @@
+import { NestedAvatar } from "./customer";
+import { NestedChatMessageAttachmentAction } from "./chat";
+import { NestedChatMessageAttachment } from "./chat";
+import { NestedChatMessageResponseAttachment } from "./chat";
+import { Brand } from "./brands";
+import { OrganizationUid, RoomUid, VisitorUid, UserUid, UserLegacyId, ChatLegacyId, ChatMessageUid, ChatUid, RuleUid, VisitorLegacyId, RuleLegacyId, RoomLegacyId, ChatMessageAttachmentUid, ChatMessageAttachmentActionUid, ChatSessionUid, VisitorSessionCid, VisitorGid, VisitorSessionGid, VisitorSecretId, ChatMessageType, VisitorCid, RoomLegacyToken } from "./types";
+import { LanguageCode } from "./common";
+export declare const AutosuggestPermissionOptions: {
+    /** Not allowed to autosuggest because of capacity being reached or some other reason */
+    readonly NOT_AVAILABLE: 0;
+    /** User has disabled autosuggest */
+    readonly DISABLED: 1;
+    /** Autosuggest is allowed */
+    readonly ENABLED: 2;
+};
+export declare type AutoSuggestPermissionOption = typeof AutosuggestPermissionOptions[keyof typeof AutosuggestPermissionOptions];
+export declare type AutosuggestPermissionOptionString = keyof typeof AutosuggestPermissionOptions;
+export declare const AUTOSUGGEST_PERMISSION_OPTIONS: ("NOT_AVAILABLE" | "DISABLED" | "ENABLED")[];
+export interface PublicAutosuggestPermission {
+    /** TODO: add documentation */
+    organization_id: OrganizationUid;
+    /** TODO: add documentation */
+    room_id: RoomUid;
+    /** TODO: add documentation */
+    visitor_id: VisitorUid;
+    /** TODO: add documentation */
+    is_autosuggest_capacity_check_enabled: boolean;
+    /** TODO: add documentation */
+    autosuggesting_user_id: UserUid;
+    /** TODO: add documentation */
+    autosuggesting_user: PublicUser;
+    /** TODO: add documentation */
+    permission: AutoSuggestPermissionOption;
+}
+export interface PublicAutosuggestPermissionPayload {
+    /** TODO: add documentation */
+    is_autosuggest_capacity_check_enabled: boolean;
+}
+export interface PublicAutosuggest {
+    /** TODO: add documentation */
+    organization_id: OrganizationUid;
+    /** TODO: add documentation */
+    room_id: RoomUid;
+    /** Unique identifier of the visitor to whom the autosuggest message has been sent */
+    visitor_id: VisitorUid;
+    /** Unique identifier of the user from whom the autosuggest message has been sent */
+    autosuggested_by_user_id: UserUid;
+    /** User from whom the autosuggest message has been sent */
+    autosuggested_by_user: PublicUser;
+    /** Text of autosuggest message */
+    autosuggest_message: string;
+    /** TODO: add documentation */
+    autosuggest_url: string;
+    /** TODO: add documentation */
+    autosuggest_url_title: string;
+    /** Legacy unique identifier of the  chat to where the autosuggest message has been sent */
+    legacy_chat_id: ChatLegacyId;
+}
+export interface PublicAutosuggestPayload {
+    /** Unique identifier of the user from whom the autosuggest message has been sent */
+    autosuggested_by_user_id: UserUid;
+    /** Text of autosuggest message */
+    autosuggest_message?: string;
+    /** TODO: add documentation */
+    autosuggest_url?: string;
+    /** TODO: add documentation */
+    autosuggest_url_title?: string;
+}
+interface PublicChatMessageCommon {
+    /** 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;
+    /** 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;
+    /**
+     * 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;
+    /**
+     * @deprecated
+     */
+    /** Legacy ID of the sender. Deprecated use "sender_id" instead */
+    legacy_sender_id: UserLegacyId | VisitorLegacyId | RuleLegacyId;
+    /**
+     * @deprecated
+     */
+    /** Legacy ID of the chat’s room. Deprecated use "room_id" instead */
+    legacy_room_id: RoomLegacyId;
+    /**
+     * @deprecated
+     */
+    /** Legacy ID of the chat. Deprecated use "chat_id" instead */
+    legacy_chat_id: ChatLegacyId;
+}
+interface PublicChatMessageUser extends PublicChatMessageCommon {
+    /** 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 PublicChatMessageVisitor extends PublicChatMessageCommon {
+    /** 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 PublicChatMessageRule extends PublicChatMessageCommon {
+    /** 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;
+}
+export declare type PublicChatMessage = PublicChatMessageUser | PublicChatMessageVisitor | PublicChatMessageRule;
+interface PublicChatMessagePayloadCommon {
+    /** Defines the type of the message. "msg" by default */
+    type: ChatMessageType;
+    /** Display name of the sender as the visitor would see it */
+    sender_public_name?: string;
+    /**
+     * 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 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;
+    /** Unique identifier of the chosen attachment action this was a response to */
+    response_to_action_id?: ChatMessageAttachmentActionUid | 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 PublicChatMessagePayloadUser extends PublicChatMessagePayloadCommon {
+    /** 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 PublicChatMessagePayloadVisitor extends PublicChatMessagePayloadCommon {
+    /** 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 PublicChatMessagePayloadRule extends PublicChatMessagePayloadCommon {
+    /** 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;
+}
+export declare type PublicChatMessagePayload = PublicChatMessagePayloadUser | PublicChatMessagePayloadVisitor | PublicChatMessagePayloadRule;
+export interface PublicChat {
+    /** Unique identifier of the chat */
+    id: ChatUid;
+    /**
+     * Defines the chat type. 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: "visitor" | "external";
+    /** 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;
+    /** 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;
+    /** 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 started with an automatic autosuggestion message */
+    is_autosuggested: boolean;
+    /** Defines whether the response is required by the chat. It is set to true each time a visitor sends a message */
+    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;
+    /** Defines whether the messages of the chat are stored encrypted */
+    is_encrypted: boolean;
+    /**
+     * @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;
+    /** List of users participating in the chat  */
+    user_member_ids: UserUid[];
+    /**
+     * @deprecated
+     */
+    /** Legacy ID of the chat. Deprecated use "id" instead */
+    legacy_id: ChatLegacyId;
+}
+export interface PublicChatPayload {
+    /** Defines whether the chat has ended. Once ended the chat is locked and messages and members can't be altered */
+    is_ended?: boolean;
+    /**
+     * Defines the chat type. 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?: "visitor" | "external";
+    /** List of users participating in the chat */
+    user_member_ids?: UserUid[];
+}
+export interface PublicCustomVisitorId {
+    /** TODO: add documentation */
+    organization_id: OrganizationUid;
+    /** TODO: add documentation */
+    custom_visitor_identity: string;
+    /** Unique identifier of the visitor */
+    visitor_id: VisitorUid;
+    /** TODO: add documentation */
+    visitor_session_id: VisitorSessionCid;
+    /** TODO: add documentation */
+    visitor_global_id: VisitorGid;
+    /** TODO: add documentation */
+    visitor_global_session_id: VisitorSessionGid;
+}
+export interface PublicCustomVisitorIdPayload {
+    /** TODO: add documentation */
+    organization_id: OrganizationUid;
+    /** TODO: add documentation */
+    custom_visitor_identity: string;
+    /** Unique identifier of the visitor */
+    visitor_id: VisitorUid;
+    /** TODO: add documentation */
+    visitor_session_id: VisitorSessionCid;
+    /** TODO: add documentation */
+    visitor_global_id: VisitorGid;
+    /** TODO: add documentation */
+    visitor_global_session_id: VisitorSessionGid;
+}
+/**
+ * @deprecated
+ */
+export interface PublicLogin {
+    /** TODO: add documentation */
+    visitor_secret_id: VisitorSecretId | null;
+    /** TODO: add documentation */
+    visitor_global_id: VisitorGid | null;
+}
+export interface PublicLoginPayload {
+    /** TODO: add documentation */
+    visitor_secret_id?: VisitorSecretId | null;
+    /** TODO: add documentation */
+    visitor_global_id?: VisitorGid | null;
+}
+export interface PublicRoom {
+    /** Unique identifier of the room */
+    id: RoomUid;
+    /** Display name of the room. It may be equal to the name attribute, unless the room is shared */
+    display_name: string;
+    /** Title of the chat dialog */
+    chat_dialog_title: string | null;
+    /** Language of the room as a RFC 3066 code. Defaults to en */
+    language_code: LanguageCode;
+    /**
+     * Defines whether the room is currently online, i.e. there is at least one online user and the organization
+     * is allowed to be online at the room
+     */
+    is_online: boolean;
+    /** Legacy signed unique identifier of the room. Deprecated, use an id attribute instead */
+    legacy_id: RoomLegacyToken;
+    /** The dialog and button brand */
+    brand: Brand;
+    /** How much usually visitors waits for initial answer, in seconds. Null if unknown */
+    estimated_waiting_time: number | null;
+    /** The brand for the dialog */
+    dialog_brand_id: string | null;
+}
+export interface GiosgBrand<T> {
+    id: string;
+    data: T;
+    organization_id: string;
+    created_at: string;
+    updated_at: string;
+    updated_by: string;
+}
+export interface BaseBrandParameter<T> {
+    section: string;
+    name: string;
+    field: keyof T;
+    type: "image" | "color" | "enum";
+    advanced: boolean;
+}
+export interface ColorBrandParameter<T> extends BaseBrandParameter<T> {
+    type: "color";
+}
+export interface ImageBrandParameter<T> extends BaseBrandParameter<T> {
+    type: "image";
+}
+export interface EnumBrandParameter<T> extends BaseBrandParameter<T> {
+    type: "enum";
+    options: Array<{
+        label: string;
+        value: string;
+    }>;
+}
+export declare type BrandParameter<T> = ColorBrandParameter<T> | ImageBrandParameter<T> | EnumBrandParameter<T>;
+export interface PublicRoomVisitorCreatePayload {
+    /** Unique identifier of the visitor */
+    id: VisitorCid;
+    /** The number of seconds the system should
+     * keep this visitor present. Only the latest
+     * provided value applies for the visitor. */
+    presence_expires_in?: number;
+}
+export interface PublicRoomVisitor {
+    /** Unique identifier for the visitor.
+     * This is the same for the same visitor regardless
+     * of the room from which the visitor was requested. */
+    id: VisitorUid;
+    /** ID of the room from which this room visitor resource was requested */
+    room_id: RoomUid;
+    /** The number of seconds the system should keep this visitor present. */
+    presence_expires_in: number;
+}
+export interface PublicRoomVisitorUpdate {
+    /** Unique identifier of the visitor */
+    id: VisitorUid;
+    /** TODO: add documentation */
+    room_id: RoomUid;
+    /** TODO: add documentation */
+    presence_expires_in: number;
+}
+export interface PublicRoomVisitorUpdatePayload {
+    /** TODO: add documentation */
+    presence_expires_in: number;
+}
+export interface PublicUser {
+    /** Unique identifier of the user */
+    id: UserUid;
+    /** TODO: alias? or alias | full name? */
+    public_name: string;
+    /** Avatar of the user */
+    avatar: NestedAvatar;
+    /** Old unique identifier of the user. Deprecated, use id whenever possible instead */
+    legacy_id: UserLegacyId;
+}
+export interface PublicVisitorChatTag {
+    /** Date when the chat was tagged with this tag */
+    created_at: string;
+    /** Sha1 hash of the tag. This is the only information that the visitor and goals generated have about the tag */
+    hashed_name: string;
+    /** Unique identifier of the chat session ( TODO: more?) */
+    chat_session_id: ChatSessionUid;
+    /** Unique identifier of the room to which this tag belongs to */
+    room_id: RoomUid;
+}
+export {};
+//# sourceMappingURL=public.d.ts.map

package/lib/cjs/public.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,iCAAiC,EAAE,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,QAAQ,CAAC;AACrD,OAAO,EAAE,mCAAmC,EAAE,MAAM,QAAQ,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EACL,eAAe,EACf,OAAO,EACP,UAAU,EACV,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,OAAO,EACP,OAAO,EACP,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,wBAAwB,EACxB,8BAA8B,EAC9B,cAAc,EACd,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,UAAU,EACV,eAAe,EAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,eAAO,MAAM,4BAA4B;IACvC,wFAAwF;;IAGxF,oCAAoC;;IAGpC,6BAA6B;;CAErB,CAAC;AACX,oBAAY,2BAA2B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AACzH,oBAAY,iCAAiC,GAAG,MAAM,OAAO,4BAA4B,CAAC;AAC1F,eAAO,MAAM,8BAA8B,8CAEH,CAAC;AAEzC,MAAM,WAAW,2BAA2B;IAC1C,8BAA8B;IAC9B,eAAe,EAAE,eAAe,CAAC;IAEjC,8BAA8B;IAC9B,OAAO,EAAE,OAAO,CAAC;IAEjB,8BAA8B;IAC9B,UAAU,EAAE,UAAU,CAAC;IAEvB,8BAA8B;IAC9B,qCAAqC,EAAE,OAAO,CAAC;IAE/C,8BAA8B;IAC9B,sBAAsB,EAAE,OAAO,CAAC;IAEhC,8BAA8B;IAC9B,mBAAmB,EAAE,UAAU,CAAC;IAEhC,8BAA8B;IAC9B,UAAU,EAAE,2BAA2B,CAAC;CACzC;AAED,MAAM,WAAW,kCAAkC;IACjD,8BAA8B;IAC9B,qCAAqC,EAAE,OAAO,CAAC;CAChD;AAED,MAAM,WAAW,iBAAiB;IAChC,8BAA8B;IAC9B,eAAe,EAAE,eAAe,CAAC;IAEjC,8BAA8B;IAC9B,OAAO,EAAE,OAAO,CAAC;IAEjB,qFAAqF;IACrF,UAAU,EAAE,UAAU,CAAC;IAEvB,oFAAoF;IACpF,wBAAwB,EAAE,OAAO,CAAC;IAElC,2DAA2D;IAC3D,qBAAqB,EAAE,UAAU,CAAC;IAElC,kCAAkC;IAClC,mBAAmB,EAAE,MAAM,CAAC;IAE5B,8BAA8B;IAC9B,eAAe,EAAE,MAAM,CAAC;IAExB,8BAA8B;IAC9B,qBAAqB,EAAE,MAAM,CAAC;IAE9B,2FAA2F;IAC3F,cAAc,EAAE,YAAY,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC,oFAAoF;IACpF,wBAAwB,EAAE,OAAO,CAAC;IAElC,kCAAkC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,8BAA8B;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,8BAA8B;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,UAAU,uBAAuB;IAC/B,uCAAuC;IACvC,EAAE,EAAE,cAAc,CAAC;IAEnB,wDAAwD;IACxD,IAAI,EAAE,eAAe,CAAC;IAEtB,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAC;IAEjB,+DAA+D;IAC/D,OAAO,EAAE,OAAO,CAAC;IAEjB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,6DAA6D;IAC7D,kBAAkB,EAAE,MAAM,CAAC;IAE3B,iCAAiC;IACjC,aAAa,EAAE,YAAY,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,WAAW,EAAE,2BAA2B,EAAE,GAAG,IAAI,CAAC;IAElD,mDAAmD;IACnD,mBAAmB,EAAE,SAAS,GAAG,aAAa,GAAG,UAAU,GAAG,IAAI,CAAC;IAEnE,sEAAsE;IACtE,sBAAsB,EAAE,cAAc,GAAG,IAAI,CAAC;IAE9C,wEAAwE;IACxE,yBAAyB,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE3D,+CAA+C;IAC/C,sBAAsB,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAEnE,+EAA+E;IAC/E,qBAAqB,EAAE,8BAA8B,GAAG,IAAI,CAAC;IAE7D,sDAAsD;IACtD,kBAAkB,EAAE,iCAAiC,GAAG,IAAI,CAAC;IAE7D,2GAA2G;IAC3G,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kEAAkE;IAClE,gBAAgB,EAAE,YAAY,GAAG,eAAe,GAAG,YAAY,CAAC;IAEhE;;OAEG;IACH,qEAAqE;IACrE,cAAc,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,8DAA8D;IAC9D,cAAc,EAAE,YAAY,CAAC;CAC9B;AACD,UAAU,qBAAsB,SAAQ,uBAAuB;IAC7D,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IAEpB,sEAAsE;IACtE,SAAS,EAAE,OAAO,CAAC;CACpB;AACD,UAAU,wBAAyB,SAAQ,uBAAuB;IAChE,wDAAwD;IACxD,WAAW,EAAE,SAAS,CAAC;IAEvB,sEAAsE;IACtE,SAAS,EAAE,UAAU,CAAC;CACvB;AACD,UAAU,qBAAsB,SAAQ,uBAAuB;IAC7D,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IAEpB,sEAAsE;IACtE,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,oBAAY,iBAAiB,GACzB,qBAAqB,GACrB,wBAAwB,GACxB,qBAAqB,CAAC;AAE1B,UAAU,8BAA8B;IACtC,wDAAwD;IACxD,IAAI,EAAE,eAAe,CAAC;IAEtB,6DAA6D;IAC7D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,sEAAsE;IACtE,sBAAsB,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/C,wEAAwE;IACxE,yBAAyB,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE5D,+EAA+E;IAC/E,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,IAAI,CAAC;IAE9D,2GAA2G;IAC3G,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,UAAU,4BAA6B,SAAQ,8BAA8B;IAC3E,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AACD,UAAU,+BAAgC,SAAQ,8BAA8B;IAC9E,wDAAwD;IACxD,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB,sEAAsE;IACtE,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB;AACD,UAAU,4BAA6B,SAAQ,8BAA8B;IAC3E,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AACD,oBAAY,wBAAwB,GAChC,4BAA4B,GAC5B,+BAA+B,GAC/B,4BAA4B,CAAC;AAEjC,MAAM,WAAW,UAAU;IACzB,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ;;;;OAIG;IACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAElC,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IAEnB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,wCAAwC;IACxC,kBAAkB,EAAE,MAAM,CAAC;IAE3B,+DAA+D;IAC/D,OAAO,EAAE,OAAO,CAAC;IAEjB,2FAA2F;IAC3F,oBAAoB,EAAE,eAAe,CAAC;IAEtC,mDAAmD;IACnD,aAAa,EAAE,MAAM,CAAC;IAEtB,uDAAuD;IACvD,kBAAkB,EAAE,MAAM,CAAC;IAE3B,sDAAsD;IACtD,qBAAqB,EAAE,MAAM,CAAC;IAE9B,4FAA4F;IAC5F,yBAAyB,EAAE,MAAM,CAAC;IAElC,sEAAsE;IACtE,8BAA8B,EAAE,MAAM,CAAC;IAEvC,yEAAyE;IACzE,iCAAiC,EAAE,MAAM,CAAC;IAE1C,kFAAkF;IAClF,YAAY,EAAE,MAAM,CAAC;IAErB,4DAA4D;IAC5D,iBAAiB,EAAE,MAAM,CAAC;IAE1B,2CAA2C;IAC3C,oBAAoB,EAAE,MAAM,CAAC;IAE7B,gFAAgF;IAChF,gBAAgB,EAAE,OAAO,CAAC;IAE1B,kHAAkH;IAClH,UAAU,EAAE,OAAO,CAAC;IAEpB,kHAAkH;IAClH,QAAQ,EAAE,OAAO,CAAC;IAElB,oEAAoE;IACpE,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qEAAqE;IACrE,cAAc,EAAE,YAAY,CAAC;IAE7B,wFAAwF;IACxF,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,+CAA+C;IAC/C,eAAe,EAAE,OAAO,EAAE,CAAC;IAE3B;;OAEG;IACH,yDAAyD;IACzD,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,kHAAkH;IAClH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;IAEnC,8CAA8C;IAC9C,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,8BAA8B;IAC9B,eAAe,EAAE,eAAe,CAAC;IAEjC,8BAA8B;IAC9B,uBAAuB,EAAE,MAAM,CAAC;IAEhC,uCAAuC;IACvC,UAAU,EAAE,UAAU,CAAC;IAEvB,8BAA8B;IAC9B,kBAAkB,EAAE,iBAAiB,CAAC;IAEtC,8BAA8B;IAC9B,iBAAiB,EAAE,UAAU,CAAC;IAE9B,8BAA8B;IAC9B,yBAAyB,EAAE,iBAAiB,CAAC;CAC9C;AAED,MAAM,WAAW,4BAA4B;IAC3C,8BAA8B;IAC9B,eAAe,EAAE,eAAe,CAAC;IAEjC,8BAA8B;IAC9B,uBAAuB,EAAE,MAAM,CAAC;IAEhC,uCAAuC;IACvC,UAAU,EAAE,UAAU,CAAC;IAEvB,8BAA8B;IAC9B,kBAAkB,EAAE,iBAAiB,CAAC;IAEtC,8BAA8B;IAC9B,iBAAiB,EAAE,UAAU,CAAC;IAE9B,8BAA8B;IAC9B,yBAAyB,EAAE,iBAAiB,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,8BAA8B;IAC9B,iBAAiB,EAAE,eAAe,GAAG,IAAI,CAAC;IAE1C,8BAA8B;IAC9B,iBAAiB,EAAE,UAAU,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,8BAA8B;IAE9B,iBAAiB,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC3C,8BAA8B;IAC9B,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,UAAU;IACzB,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ,iGAAiG;IACjG,YAAY,EAAE,MAAM,CAAC;IAErB,+BAA+B;IAC/B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,8DAA8D;IAC9D,aAAa,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB,2FAA2F;IAC3F,SAAS,EAAE,eAAe,CAAC;IAE3B,kCAAkC;IAClC,KAAK,EAAE,KAAK,CAAC;IAEb,sFAAsF;IACtF,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,+BAA+B;IAC/B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;IACR,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IAEnC,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC,CAAC;IAEf,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;IAEjC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,CAAE,SAAQ,kBAAkB,CAAC,CAAC,CAAC;IACnE,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,CAAE,SAAQ,kBAAkB,CAAC,CAAC,CAAC;IACnE,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,kBAAkB,CAAC,CAAC,CAAC;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClD;AAED,oBAAY,cAAc,CAAC,CAAC,IACxB,mBAAmB,CAAC,CAAC,CAAC,GACtB,mBAAmB,CAAC,CAAC,CAAC,GACtB,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE1B,MAAM,WAAW,8BAA8B;IAC7C,uCAAuC;IACvC,EAAE,EAAE,UAAU,CAAC;IAEf;;iDAE6C;IAC7C,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB;IAChC;;2DAEuD;IACvD,EAAE,EAAE,UAAU,CAAC;IAEf,yEAAyE;IACzE,OAAO,EAAE,OAAO,CAAC;IAEjB,yEAAyE;IACzE,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC,uCAAuC;IACvC,EAAE,EAAE,UAAU,CAAC;IAEf,8BAA8B;IAC9B,OAAO,EAAE,OAAO,CAAC;IAEjB,8BAA8B;IAC9B,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,8BAA8B;IAC7C,8BAA8B;IAC9B,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IAEpB,yBAAyB;IACzB,MAAM,EAAE,YAAY,CAAC;IAErB,sFAAsF;IACtF,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;IAEnB,iHAAiH;IACjH,WAAW,EAAE,MAAM,CAAC;IAEpB,2DAA2D;IAC3D,eAAe,EAAE,cAAc,CAAC;IAEhC,iEAAiE;IACjE,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/lib/cjs/public.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AUTOSUGGEST_PERMISSION_OPTIONS = exports.AutosuggestPermissionOptions = void 0;
+exports.AutosuggestPermissionOptions = {
+    /** Not allowed to autosuggest because of capacity being reached or some other reason */
+    NOT_AVAILABLE: 0,
+    /** User has disabled autosuggest */
+    DISABLED: 1,
+    /** Autosuggest is allowed */
+    ENABLED: 2,
+};
+exports.AUTOSUGGEST_PERMISSION_OPTIONS = Object.keys(exports.AutosuggestPermissionOptions);