Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@giosg/types

Package Overview
Dependencies
Maintainers
6
Versions
99
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@giosg/types - npm Package Compare versions

Comparing version 1.2.15 to 1.2.17

lib/actions.d.ts.map
lib/assets.d.ts.map
lib/chat.d.ts.map
lib/common.d.ts.map
lib/conditions.d.ts.map
lib/customer.d.ts.map
lib/customership.d.ts.map
lib/experiments.d.ts.map
lib/goals.d.ts.map
lib/index.d.ts.map
lib/oath.d.ts.map
lib/partnerships.d.ts.map
lib/permissions.d.ts.map
lib/public.d.ts.map
lib/rooms.d.ts.map
lib/rules.d.ts.map
lib/types.d.ts.map
lib/userclients.d.ts.map
lib/visitor.d.ts.map

3

CHANGELOG.md

@@ -7,2 +7,5 @@ # Changelog

## 1.2.17
- ChatMessage and DecryptedChatMessage interfaces are divided into DataMessages and StatusMessages
## 1.2.11

@@ -9,0 +12,0 @@

155

lib/actions.d.ts
import { UserUid } from "./types";
export declare const ActionTypes: {
/** value: autosuggest message as a string, settings: ActionShowAutosuggestSettings*/
readonly SEND_AUTOSUGGEST: 1;
/** value: array of room unique identifiers, settings: none */
readonly JOIN_ROOMS: 2;
/** value: none, settings: none */
readonly NO_CHATBUTTON: 5;
/** value: none, settings: none */
readonly NO_AUTOSUGGEST: 6;
/** value: JavaScript expression as a string, settings:none */
readonly RUN_JAVASCRIPT: 7;
/** value: none, settings: none */
readonly ENABLE_CHATBUTTON: 8;
/** value: CSS selector as a string, settings: none */
readonly SHOW_ELEMENTS: 9;
/** value: CSS selector as a string, settings: none */
readonly HIDE_ELEMENTS: 10;
/** value: URL as a string, settings: none */
readonly REDIRECT: 11;
/** value: lead form unique identifier, settings: none */
readonly LOAD_LEAD_FORM: 13;
/** value: button text as a string, settings: none */
readonly CHANGE_CB_TEXT: 14;
/** value: room unique identifier, settings: none */
readonly CHANGE_CB_TARGET: 15;
/** value: language as a RFC 3066 code, settings: none */
readonly CHANGE_LANGUAGE: 16;
/** value: lead form unique identifier, settings: none */
readonly SHOW_LEAD_FORM: 17;
/** value: lead form processor unique identifier, settings: none */
readonly SET_LEAD_FORM_PROCESSOR: 18;
/** value: button unique identifier, settings: none */
readonly SHOW_BUTTON: 19;
/** value: unique identifier of the parent room of the window, settings: none */
readonly SHOW_CHAT_DIALOG: 20;
/** value: priority as an integer [1 - 10], settings: none */
readonly SET_VISITOR_PRIORITY: 21;
/** value: none , settings: none */
readonly DISABLE_CAPACITY_CHECK: 22;
/** value: CSS code as a string, settings: none */
readonly INJECT_CSS: 23;
/** value: unique identifier of the element asset, settings: none */
readonly LOAD_INTERACTION_DESIGNER_ELEMENT: 24;
/** value: message as a string, settings: ActionSendChatMessageSettings */
readonly SEND_SYSTEM_MESSAGE: 25;
/** value: unique identifier of the element asset, settings: none */
readonly LOAD_INTERACTION: 26;
/** value: autosuggest message as a string, settings: ActionShowAutosuggestSettings*/
readonly SEND_AUTOSUGGEST: 1;
/** value: array of room unique identifiers, settings: none */
readonly JOIN_ROOMS: 2;
/** value: none, settings: none */
readonly NO_CHATBUTTON: 5;
/** value: none, settings: none */
readonly NO_AUTOSUGGEST: 6;
/** value: JavaScript expression as a string, settings:none */
readonly RUN_JAVASCRIPT: 7;
/** value: none, settings: none */
readonly ENABLE_CHATBUTTON: 8;
/** value: CSS selector as a string, settings: none */
readonly SHOW_ELEMENTS: 9;
/** value: CSS selector as a string, settings: none */
readonly HIDE_ELEMENTS: 10;
/** value: URL as a string, settings: none */
readonly REDIRECT: 11;
/** value: lead form unique identifier, settings: none */
readonly LOAD_LEAD_FORM: 13;
/** value: button text as a string, settings: none */
readonly CHANGE_CB_TEXT: 14;
/** value: room unique identifier, settings: none */
readonly CHANGE_CB_TARGET: 15;
/** value: language as a RFC 3066 code, settings: none */
readonly CHANGE_LANGUAGE: 16;
/** value: lead form unique identifier, settings: none */
readonly SHOW_LEAD_FORM: 17;
/** value: lead form processor unique identifier, settings: none */
readonly SET_LEAD_FORM_PROCESSOR: 18;
/** value: button unique identifier, settings: none */
readonly SHOW_BUTTON: 19;
/** value: unique identifier of the parent room of the window, settings: none */
readonly SHOW_CHAT_DIALOG: 20;
/** value: priority as an integer [1 - 10], settings: none */
readonly SET_VISITOR_PRIORITY: 21;
/** value: none , settings: none */
readonly DISABLE_CAPACITY_CHECK: 22;
/** value: CSS code as a string, settings: none */
readonly INJECT_CSS: 23;
/** value: unique identifier of the element asset, settings: none */
readonly LOAD_INTERACTION_DESIGNER_ELEMENT: 24;
/** value: message as a string, settings: ActionSendChatMessageSettings */
readonly SEND_SYSTEM_MESSAGE: 25;
/** value: interactionUuid, settings: none */
readonly LOAD_INTERACTION: 26;
/** value: asset unique identifier, settings: ActionSendInteractionToChatSettings */
readonly SEND_INTERACTION_TO_CHAT: 27;
};
export declare type ActionType = (typeof ActionTypes)[keyof typeof ActionTypes];
export declare type ActionTypeString = keyof typeof ActionTypes;
export declare const ACTION_TYPES: (
| "SEND_AUTOSUGGEST"
| "JOIN_ROOMS"
| "NO_CHATBUTTON"
| "NO_AUTOSUGGEST"
| "RUN_JAVASCRIPT"
| "ENABLE_CHATBUTTON"
| "SHOW_ELEMENTS"
| "HIDE_ELEMENTS"
| "REDIRECT"
| "LOAD_LEAD_FORM"
| "CHANGE_CB_TEXT"
| "CHANGE_CB_TARGET"
| "CHANGE_LANGUAGE"
| "SHOW_LEAD_FORM"
| "SET_LEAD_FORM_PROCESSOR"
| "SHOW_BUTTON"
| "SHOW_CHAT_DIALOG"
| "SET_VISITOR_PRIORITY"
| "DISABLE_CAPACITY_CHECK"
| "INJECT_CSS"
| "LOAD_INTERACTION_DESIGNER_ELEMENT"
| "SEND_SYSTEM_MESSAGE"
| "LOAD_INTERACTION")[];
export declare const ACTION_TYPES: ("SEND_AUTOSUGGEST" | "JOIN_ROOMS" | "NO_CHATBUTTON" | "NO_AUTOSUGGEST" | "RUN_JAVASCRIPT" | "ENABLE_CHATBUTTON" | "SHOW_ELEMENTS" | "HIDE_ELEMENTS" | "REDIRECT" | "LOAD_LEAD_FORM" | "CHANGE_CB_TEXT" | "CHANGE_CB_TARGET" | "CHANGE_LANGUAGE" | "SHOW_LEAD_FORM" | "SET_LEAD_FORM_PROCESSOR" | "SHOW_BUTTON" | "SHOW_CHAT_DIALOG" | "SET_VISITOR_PRIORITY" | "DISABLE_CAPACITY_CHECK" | "INJECT_CSS" | "LOAD_INTERACTION_DESIGNER_ELEMENT" | "SEND_SYSTEM_MESSAGE" | "LOAD_INTERACTION" | "SEND_INTERACTION_TO_CHAT")[];
export interface ActionShowAutosuggestSettings {
/** Unique identifier of the user from whom the message shall be sent */
autosuggest_user_id: UserUid;
/** Delay before the chat window will be closed in seconds */
close_delay: number;
/** Unique identifier of the user from whom the message shall be sent */
autosuggest_user_id: UserUid;
/** Delay before the chat window will be closed in seconds */
close_delay: number;
}
export interface ActionSendChatMessageSettings {
/** Name of the sender */
sender_public_name: string;
/** Name of the sender */
sender_public_name: string;
}
export declare type ActionSettingsType =
| ActionShowAutosuggestSettings
| ActionSendChatMessageSettings
| {};
export declare const ACTION_STYLES: readonly [
"primary",
"secondary",
"info",
"success",
"warning",
"danger",
"link",
"brand_primary",
"brand_secondary",
];
export interface ActionSendInteractionToChatSettings {
/** Name of the sender */
sender_public_name: string;
/** Optional message to send alongside of the interaction */
message?: string;
}
export declare type ActionSettingsType = ActionShowAutosuggestSettings | ActionSendChatMessageSettings | ActionSendInteractionToChatSettings | {};
export declare const ACTION_STYLES: readonly ["primary", "secondary", "info", "success", "warning", "danger", "link", "brand_primary", "brand_secondary"];
export declare type ActionStyle = typeof ACTION_STYLES[number];
//# sourceMappingURL=actions.d.ts.map

112

lib/actions.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ActionTypes = {
/** value: autosuggest message as a string, settings: ActionShowAutosuggestSettings*/
SEND_AUTOSUGGEST: 1,
/** value: array of room unique identifiers, settings: none */
JOIN_ROOMS: 2,
/** value: none, settings: none */
NO_CHATBUTTON: 5,
/** value: none, settings: none */
NO_AUTOSUGGEST: 6,
/** value: JavaScript expression as a string, settings:none */
RUN_JAVASCRIPT: 7,
/** value: none, settings: none */
ENABLE_CHATBUTTON: 8,
/** value: CSS selector as a string, settings: none */
SHOW_ELEMENTS: 9,
/** value: CSS selector as a string, settings: none */
HIDE_ELEMENTS: 10,
/** value: URL as a string, settings: none */
REDIRECT: 11,
/** value: lead form unique identifier, settings: none */
LOAD_LEAD_FORM: 13,
/** value: button text as a string, settings: none */
CHANGE_CB_TEXT: 14,
/** value: room unique identifier, settings: none */
CHANGE_CB_TARGET: 15,
/** value: language as a RFC 3066 code, settings: none */
CHANGE_LANGUAGE: 16,
/** value: lead form unique identifier, settings: none */
SHOW_LEAD_FORM: 17,
/** value: lead form processor unique identifier, settings: none */
SET_LEAD_FORM_PROCESSOR: 18,
/** value: button unique identifier, settings: none */
SHOW_BUTTON: 19,
/** value: unique identifier of the parent room of the window, settings: none */
SHOW_CHAT_DIALOG: 20,
/** value: priority as an integer [1 - 10], settings: none */
SET_VISITOR_PRIORITY: 21,
/** value: none , settings: none */
DISABLE_CAPACITY_CHECK: 22,
/** value: CSS code as a string, settings: none */
INJECT_CSS: 23,
/** value: unique identifier of the element asset, settings: none */
LOAD_INTERACTION_DESIGNER_ELEMENT: 24,
/** value: message as a string, settings: ActionSendChatMessageSettings */
SEND_SYSTEM_MESSAGE: 25,
/** value: unique identifier of the element asset, settings: none */
LOAD_INTERACTION: 26
/** value: autosuggest message as a string, settings: ActionShowAutosuggestSettings*/
SEND_AUTOSUGGEST: 1,
/** value: array of room unique identifiers, settings: none */
JOIN_ROOMS: 2,
/** value: none, settings: none */
NO_CHATBUTTON: 5,
/** value: none, settings: none */
NO_AUTOSUGGEST: 6,
/** value: JavaScript expression as a string, settings:none */
RUN_JAVASCRIPT: 7,
/** value: none, settings: none */
ENABLE_CHATBUTTON: 8,
/** value: CSS selector as a string, settings: none */
SHOW_ELEMENTS: 9,
/** value: CSS selector as a string, settings: none */
HIDE_ELEMENTS: 10,
/** value: URL as a string, settings: none */
REDIRECT: 11,
/** value: lead form unique identifier, settings: none */
LOAD_LEAD_FORM: 13,
/** value: button text as a string, settings: none */
CHANGE_CB_TEXT: 14,
/** value: room unique identifier, settings: none */
CHANGE_CB_TARGET: 15,
/** value: language as a RFC 3066 code, settings: none */
CHANGE_LANGUAGE: 16,
/** value: lead form unique identifier, settings: none */
SHOW_LEAD_FORM: 17,
/** value: lead form processor unique identifier, settings: none */
SET_LEAD_FORM_PROCESSOR: 18,
/** value: button unique identifier, settings: none */
SHOW_BUTTON: 19,
/** value: unique identifier of the parent room of the window, settings: none */
SHOW_CHAT_DIALOG: 20,
/** value: priority as an integer [1 - 10], settings: none */
SET_VISITOR_PRIORITY: 21,
/** value: none , settings: none */
DISABLE_CAPACITY_CHECK: 22,
/** value: CSS code as a string, settings: none */
INJECT_CSS: 23,
/** value: unique identifier of the element asset, settings: none */
LOAD_INTERACTION_DESIGNER_ELEMENT: 24,
/** value: message as a string, settings: ActionSendChatMessageSettings */
SEND_SYSTEM_MESSAGE: 25,
/** value: interactionUuid, settings: none */
LOAD_INTERACTION: 26,
/** value: asset unique identifier, settings: ActionSendInteractionToChatSettings */
SEND_INTERACTION_TO_CHAT: 27,
};
exports.ACTION_TYPES = Object.keys(exports.ActionTypes);
exports.ACTION_STYLES = [
"primary",
"secondary",
"info",
"success",
"warning",
"danger",
"link",
"brand_primary",
"brand_secondary"
"primary",
"secondary",
"info",
"success",
"warning",
"danger",
"link",
"brand_primary",
"brand_secondary",
];

253

lib/assets.d.ts
import { NestedUser } from "./customer";
import { AssetUid, OrganizationUid, UserUid, AssetType } from "./types";
export interface Asset {
/** Unique identifier of the asset */
id: AssetUid;
/** The original file name of the uploaded file */
file_name: string;
/** Content type of the uploaded file */
content_type: string | null;
/** Kind of file the asset is */
kind: AssetType | null;
/** Name of the asset */
name: string;
/** Description of the asset */
description: string | null;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Unique identifier of the organization that owns the asset */
organization_id: OrganizationUid;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** Date when the asset was created */
created_at: string;
/** Date when the asset was changed for the last time */
updated_at: string;
/** Unique identifier of the user who created the asset */
created_by_user_id: UserUid;
/** Unique identifier of the user who changed the asset for the last time */
updated_by_user_id: UserUid;
/** User who created the asset */
created_by_user: NestedUser;
/** User who changed the asset for the last time */
updated_by_user: NestedUser;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
/** Unique identifier of the asset */
id: AssetUid;
/** The original file name of the uploaded file */
file_name: string;
/** Content type of the uploaded file */
content_type: string | null;
/** Kind of file the asset is */
kind: AssetType | null;
/** Name of the asset */
name: string;
/** Description of the asset */
description: string | null;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Unique identifier of the organization that owns the asset */
organization_id: OrganizationUid;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** Date when the asset was created */
created_at: string;
/** Date when the asset was changed for the last time */
updated_at: string;
/** Unique identifier of the user who created the asset */
created_by_user_id: UserUid;
/** Unique identifier of the user who changed the asset for the last time */
updated_by_user_id: UserUid;
/** User who created the asset */
created_by_user: NestedUser;
/** User who changed the asset for the last time */
updated_by_user: NestedUser;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
}
export interface AssetPayload {
/** Name for the newly created asset. If omitted, defaults to the file name. Otherwise, it must be a non-empty string value */
name?: string;
/** Description of the asset */
description?: string | null;
/** Character encoding for a text file */
charset?: string | null;
/** The asset file to be uploaded. File name is required */
upload: File;
/** Name for the newly created asset. If omitted, defaults to the file name. Otherwise, it must be a non-empty string value */
name?: string;
/** Description of the asset */
description?: string | null;
/** Character encoding for a text file */
charset?: string | null;
/** The asset file to be uploaded. File name is required */
upload: File;
}

@@ -55,90 +55,91 @@ /**

export interface AssetUpdate {
/** Unique identifier of the asset */
id: AssetUid;
/** The original file name of the uploaded file */
file_name: string;
/** Content type of the uploaded file */
content_type: string | null;
/** Kind of file the asset is */
kind: AssetType | null;
/** Name of the asset */
name: string;
/** Description of the asset */
description: string | null;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Unique identifier of the organization that owns the asset */
organization_id: OrganizationUid;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** Date when the asset was created */
created_at: string;
/** Date when the asset was changed for the last time */
updated_at: string;
/** Unique identifier of the user who created the asset */
created_by_user_id: UserUid;
/** Unique identifier of the user who changed the asset for the last time */
updated_by_user_id: UserUid;
/** User who created the asset */
created_by_user: NestedUser;
/** User who changed the asset for the last time */
updated_by_user: NestedUser;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
/** The asset file to be uploaded. File name is required */
upload?: File;
/** Unique identifier of the asset */
id: AssetUid;
/** The original file name of the uploaded file */
file_name: string;
/** Content type of the uploaded file */
content_type: string | null;
/** Kind of file the asset is */
kind: AssetType | null;
/** Name of the asset */
name: string;
/** Description of the asset */
description: string | null;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Unique identifier of the organization that owns the asset */
organization_id: OrganizationUid;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** Date when the asset was created */
created_at: string;
/** Date when the asset was changed for the last time */
updated_at: string;
/** Unique identifier of the user who created the asset */
created_by_user_id: UserUid;
/** Unique identifier of the user who changed the asset for the last time */
updated_by_user_id: UserUid;
/** User who created the asset */
created_by_user: NestedUser;
/** User who changed the asset for the last time */
updated_by_user: NestedUser;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
/** The asset file to be uploaded. File name is required */
upload?: File;
}
export interface AssetUpdatePayload {
/** Name of the asset */
name?: string;
/** Description of the asset */
description?: string | null;
/** Character encoding for a text file */
charset?: string | null;
/** The asset file to be uploaded. File name is required */
upload?: File;
/** Name of the asset */
name?: string;
/** Description of the asset */
description?: string | null;
/** Character encoding for a text file */
charset?: string | null;
/** The asset file to be uploaded. File name is required */
upload?: File;
}
export interface NestedAsset {
/** Unique identifier of the asset*/
id: AssetUid;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Name of the asset */
name: string;
/** Description of the asset */
description: string | null;
/** Kind of file the asset is */
kind: AssetType | null;
/** Content type of the uploaded file */
content_type: string | null;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
/** Unique identifier of the asset*/
id: AssetUid;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Name of the asset */
name: string;
/** Description of the asset */
description: string | null;
/** Kind of file the asset is */
kind: AssetType | null;
/** Content type of the uploaded file */
content_type: string | null;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
}
export interface PublicNestedAsset {
/** Unique identifier of the asset */
id: AssetUid;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Kind of file the asset is */
kind: AssetType | null;
/** Content type of the uploaded file */
content_type: string | null;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
/** Unique identifier of the asset */
id: AssetUid;
/** The full URL for original, uploaded file. Use this URL to link to your asset */
url: string;
/** Kind of file the asset is */
kind: AssetType | null;
/** Content type of the uploaded file */
content_type: string | null;
/** Size of the uploaded file in bytes */
size: number;
/** Character encoding for a text file */
charset: string | null;
/** The width of an image in pixels. Available for images only. It is null for other types of assets */
width: number | null;
/** The height of an image in pixels. Available for images only. It is null for other types of assets */
height: number | null;
}
//# sourceMappingURL=assets.d.ts.map

0

lib/assets.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

1519

lib/chat.d.ts
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,
} from "./types";
import { UserUid, VisitorCid, RoomUid, ChatUid, UserLegacyId, OrganizationUid, ChatInvitationUid, TeamUid, ChatMessageUid, RuleUid, ChatReplySuggestionUid, ChatMessageAttachmentActionUid, ChatMessageAttachmentUid, RoomLegacyId, InteractionUid, ChatMessageType, ChatStatusMessageType, ChatDataMessageType } 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;
/** User who accepted the invitation */
accepted_by_user: NestedUser;
/** 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;
/** 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;
/** User who accepted the invitation */
accepted_by_user: NestedUser;
/** 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;
/** Defines whether the chat invitation has been accepted */
is_accepted: boolean;
}
export interface 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;
/** 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;
/** User who accepted the invitation */
accepted_by_user: NestedUser;
/** 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;
/** 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;
/** User who accepted the invitation */
accepted_by_user: NestedUser;
/** 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;
/** Defines whether the chat invitation has been expired. Chat invitation will expire if it’s not accepted before chat ends */
is_expired: boolean;
}
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;
/** User who accepted the invitation */
accepted_by_user: NestedUser;
/** 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;
/** 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;
/** User who accepted the invitation */
accepted_by_user: NestedUser;
/** 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;
/** 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;
/** Language of the message as a RFC 3066 code */
language_code: LanguageCode;
/** The conversation starter message */
message: string;
}

@@ -188,654 +171,700 @@ /**

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;
/** 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;
/** 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;
/**
* 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;
}
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/visitor is present at the chat */
member_type: "user";
/** Unique identifier of the user/visitor being present at the chat */
member_id: UserUid;
}
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;
/** 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";
/**
* 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";
}
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 | 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";
/** 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;
/** 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 | 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";
/** 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;
/** 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;
/** 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;
/** 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 ChatMessage = ChatMessageUser | ChatMessageVisitor | ChatMessageRule;
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";
/**
* 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;
/** 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;
/** 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 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: "operator" | "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;
/** 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;
/** 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: "operator" | "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;
/** 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;
/** 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;
/** 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;
/** Name of the tag */
name: string;
}
interface DecryptedChatMessageCommon {
/** 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 | 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";
/** 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;
/** 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";
/** 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;
/** 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;
/** 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;
/** 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 DecryptedChatMessage =
| DecryptedChatMessageUser
| DecryptedChatMessageVisitor
| DecryptedChatMessageRule;
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";
/**
* 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;
/** 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;
/** 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;
};
/** 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;
};
/** 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;
};
/** 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;
};
/** 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;
/** 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;
/**
* 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";
/** 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";
/** 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 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";
/** 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;
/** 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;
/** Name of the tag */
name: string;
}
export {};
//# sourceMappingURL=chat.d.ts.map

0

lib/chat.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

629

lib/common.d.ts

@@ -1,628 +0,7 @@

export declare const TIMEZONES: readonly [
"EET",
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
];
export declare const TIMEZONES: readonly ["EET", "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kathmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Riyadh", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GMT", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "US/Alaska", "US/Arizona", "US/Central", "US/Eastern", "US/Hawaii", "US/Mountain", "US/Pacific", "UTC"];
export declare type Timezone = typeof TIMEZONES[number];
export declare const CURRENCIES: readonly [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GQE",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZM",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEB",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XDR",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMK",
"ZWR",
"DOGE",
];
export declare const CURRENCIES: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR", "DOGE"];
export declare type Currency = typeof CURRENCIES[number];
export declare const LANGUAGE_CODES: readonly [
"cs",
"de",
"en",
"es",
"et",
"fi",
"fr",
"ga",
"he",
"it",
"ja",
"ko",
"lv",
"lt",
"nb",
"nl",
"pl",
"ru",
"sv",
"zh-cn",
"zh-tw",
"th",
];
export declare const LANGUAGE_CODES: readonly ["cs", "de", "en", "es", "et", "fi", "fr", "ga", "he", "it", "ja", "ko", "lv", "lt", "nb", "nl", "pl", "ru", "sv", "zh-cn", "zh-tw", "th"];
export declare type LanguageCode = typeof LANGUAGE_CODES[number];
//# sourceMappingURL=common.d.ts.map

1238

lib/common.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.TIMEZONES = [
"EET",
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC"
"EET",
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
];
exports.CURRENCIES = [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GQE",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZM",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEB",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XDR",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMK",
"ZWR",
"DOGE"
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GQE",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZM",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEB",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XDR",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMK",
"ZWR",
"DOGE",
];
exports.LANGUAGE_CODES = [
"cs",
"de",
"en",
"es",
"et",
"fi",
"fr",
"ga",
"he",
"it",
"ja",
"ko",
"lv",
"lt",
"nb",
"nl",
"pl",
"ru",
"sv",
"zh-cn",
"zh-tw",
"th"
"cs",
"de",
"en",
"es",
"et",
"fi",
"fr",
"ga",
"he",
"it",
"ja",
"ko",
"lv",
"lt",
"nb",
"nl",
"pl",
"ru",
"sv",
"zh-cn",
"zh-tw",
"th",
];

229

lib/conditions.d.ts
export declare const ConditionTypes: {
/** value: city name as a string, settings: none */
readonly VISITOR_CITY: 1;
/** value: CSS selector as a string, settings: none */
readonly CSS_SELECTOR: 2;
/** value: JavaScript regular expression as a string, settings: none */
readonly PREVIOUS_PAGE_URL_REGEXP: 3;
/** value: JavaScript regular expression as a string, settings: none */
readonly REFERRER_URL_REGEXP: 4;
/** value: JavaScript regular expression as a string, settings: none */
readonly PAGE_URL_REGEXP: 5;
/** value: country name as a string, settings: none */
readonly VISITOR_COUNTRY: 6;
/** value: visit count as an integer number, settings: none */
readonly VISIT_COUNT_MORE_THAN: 7;
/** value: cart value as a float number with two decimals, settings: none */
readonly CART_SIZE_MORE_THAN: 8;
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
/** value: product name as a string, settings: none */
readonly PRODUCT_NAMES_IN_CART: 10;
/** value: pipeline step as an integer number, settings: none */
readonly PIPELINE_STEP: 11;
/** value: JavaScript expression as a string, settings: none */
readonly JS_FUNCTION_RETURNS_TRUE: 12;
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
/** value: number of purchases as an integer number, settings: none */
readonly PURCHASE_COUNT_MORE_THAN: 14;
/** value: JavaScript regular expression as a string, settings: none */
readonly VISITOR_IP_ADDR: 15;
/** value: part of the URL as a string, settings: none */
readonly PAGE_URL_SIMPLE: 16;
/** value: either "online" (meaning any agent is online) or "offline" (all agents are offline), settings: none */
readonly OPERATOR_PRESENCE: 17;
/** value: number of seconds as an integer number, settings: none */
readonly AFTER_TIMEOUT: 18;
/** value: CSS selector as a string, settings: none */
readonly CLICK_ELEMENT: 19;
/** value: unique identifier of the custom button object, settings: none */
readonly CLICK_BUTTON: 20;
/** value: "desktop" | "mobile" | "tablet" | "mobile,tablet", settings: none */
readonly DEVICE_TYPE: 21;
/** value: none, settings: ConditionWeeklyScheduleSettings */
readonly WEEKLY_SCHEDULE: 22;
/** value: priority value as an integer [1 - 10], settings: none */
readonly VISITOR_PRIORITY_MORE_THAN: 23;
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
/** value: none, settings: none */
readonly VISITOR_TARGETED: 25;
/** value: none, settings: none */
readonly VISITOR_CART_LOCKED: 26;
/** value: none, settings: none */
readonly VISITOR_SENT_LEAD: 27;
/** value: part of the URL as a string, settings: none */
readonly PREVIOUS_PAGE_URL_SIMPLE: 28;
/** value: part of the URL as a string, settings: none */
readonly REFERRER_URL_SIMPLE: 29;
/** value: number of seconds as an integer number, settings: none */
readonly VISITOR_HAS_WAITED_FOR: 30;
/** value: none, settings: ConditionHasChattedSettings */
readonly HAS_CHATTED: 31;
/** value: list of tag unique identifiers, settings: none */
readonly CHAT_HAS_AT_LEAST_ONE_OF_TAGS: 32;
/** value: experiment group as a string, settings: none */
readonly VISITOR_BELONGS_TO_AN_TARGET_EXPERIMENT_GROUP: 33;
/** value: number of seconds as an integer number, settings: none */
readonly VISITOR_HAS_WAITED_FOR_THE_FIRST_ANSWER: 34;
/** value: experiment group unique identifiers, settings: none */
readonly VISITOR_BELONGS_TO_AN_USER_EXPERIMENT_GROUP: 35;
/** value: ai prediction (target) conversion probability, settings: none */
readonly TARGET_PREDICTION_CONVERSION_PROBABILITY: 36;
/** value: city name as a string, settings: none */
readonly VISITOR_CITY: 1;
/** value: CSS selector as a string, settings: none */
readonly CSS_SELECTOR: 2;
/** value: JavaScript regular expression as a string, settings: none */
readonly PREVIOUS_PAGE_URL_REGEXP: 3;
/** value: JavaScript regular expression as a string, settings: none */
readonly REFERRER_URL_REGEXP: 4;
/** value: JavaScript regular expression as a string, settings: none */
readonly PAGE_URL_REGEXP: 5;
/** value: country name as a string, settings: none */
readonly VISITOR_COUNTRY: 6;
/** value: visit count as an integer number, settings: none */
readonly VISIT_COUNT_MORE_THAN: 7;
/** value: cart value as a float number with two decimals, settings: none */
readonly CART_SIZE_MORE_THAN: 8;
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
/** value: product name as a string, settings: none */
readonly PRODUCT_NAMES_IN_CART: 10;
/** value: pipeline step as an integer number, settings: none */
readonly PIPELINE_STEP: 11;
/** value: JavaScript expression as a string, settings: none */
readonly JS_FUNCTION_RETURNS_TRUE: 12;
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
/** value: number of purchases as an integer number, settings: none */
readonly PURCHASE_COUNT_MORE_THAN: 14;
/** value: JavaScript regular expression as a string, settings: none */
readonly VISITOR_IP_ADDR: 15;
/** value: part of the URL as a string, settings: none */
readonly PAGE_URL_SIMPLE: 16;
/** value: either "online" (meaning any agent is online) or "offline" (all agents are offline), settings: none */
readonly OPERATOR_PRESENCE: 17;
/** value: number of seconds as an integer number, settings: none */
readonly AFTER_TIMEOUT: 18;
/** value: CSS selector as a string, settings: none */
readonly CLICK_ELEMENT: 19;
/** value: unique identifier of the custom button object, settings: none */
readonly CLICK_BUTTON: 20;
/** value: "desktop" | "mobile" | "tablet" | "mobile,tablet", settings: none */
readonly DEVICE_TYPE: 21;
/** value: none, settings: ConditionWeeklyScheduleSettings */
readonly WEEKLY_SCHEDULE: 22;
/** value: priority value as an integer [1 - 10], settings: none */
readonly VISITOR_PRIORITY_MORE_THAN: 23;
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
/** value: none, settings: none */
readonly VISITOR_TARGETED: 25;
/** value: none, settings: none */
readonly VISITOR_CART_LOCKED: 26;
/** value: none, settings: none */
readonly VISITOR_SENT_LEAD: 27;
/** value: part of the URL as a string, settings: none */
readonly PREVIOUS_PAGE_URL_SIMPLE: 28;
/** value: part of the URL as a string, settings: none */
readonly REFERRER_URL_SIMPLE: 29;
/** value: number of seconds as an integer number, settings: none */
readonly VISITOR_HAS_WAITED_FOR: 30;
/** value: none, settings: ConditionHasChattedSettings */
readonly HAS_CHATTED: 31;
/** value: list of tag unique identifiers, settings: none */
readonly CHAT_HAS_AT_LEAST_ONE_OF_TAGS: 32;
/** value: experiment group as a string, settings: none */
readonly VISITOR_BELONGS_TO_AN_TARGET_EXPERIMENT_GROUP: 33;
/** value: number of seconds as an integer number, settings: none */
readonly VISITOR_HAS_WAITED_FOR_THE_FIRST_ANSWER: 34;
/** value: experiment group unique identifiers, settings: none */
readonly VISITOR_BELONGS_TO_AN_USER_EXPERIMENT_GROUP: 35;
/** value: ai prediction (target) conversion probability, settings: none */
readonly TARGET_PREDICTION_CONVERSION_PROBABILITY: 36;
};
export declare type ConditionType = (typeof ConditionTypes)[keyof typeof ConditionTypes];
export declare type ConditionTypeString = keyof typeof ConditionTypes;
export declare const CONDITION_TYPES: (
| "VISITOR_CITY"
| "CSS_SELECTOR"
| "PREVIOUS_PAGE_URL_REGEXP"
| "REFERRER_URL_REGEXP"
| "PAGE_URL_REGEXP"
| "VISITOR_COUNTRY"
| "VISIT_COUNT_MORE_THAN"
| "CART_SIZE_MORE_THAN"
| "PRODUCT_NAMES_IN_CART"
| "PIPELINE_STEP"
| "JS_FUNCTION_RETURNS_TRUE"
| "PURCHASE_COUNT_MORE_THAN"
| "VISITOR_IP_ADDR"
| "PAGE_URL_SIMPLE"
| "OPERATOR_PRESENCE"
| "AFTER_TIMEOUT"
| "CLICK_ELEMENT"
| "CLICK_BUTTON"
| "DEVICE_TYPE"
| "WEEKLY_SCHEDULE"
| "VISITOR_PRIORITY_MORE_THAN"
| "VISITOR_TARGETED"
| "VISITOR_CART_LOCKED"
| "VISITOR_SENT_LEAD"
| "PREVIOUS_PAGE_URL_SIMPLE"
| "REFERRER_URL_SIMPLE"
| "VISITOR_HAS_WAITED_FOR"
| "HAS_CHATTED"
| "CHAT_HAS_AT_LEAST_ONE_OF_TAGS"
| "VISITOR_BELONGS_TO_AN_TARGET_EXPERIMENT_GROUP"
| "VISITOR_HAS_WAITED_FOR_THE_FIRST_ANSWER"
| "VISITOR_BELONGS_TO_AN_USER_EXPERIMENT_GROUP"
| "TARGET_PREDICTION_CONVERSION_PROBABILITY")[];
export declare const CONDITION_TYPES: ("VISITOR_CITY" | "CSS_SELECTOR" | "PREVIOUS_PAGE_URL_REGEXP" | "REFERRER_URL_REGEXP" | "PAGE_URL_REGEXP" | "VISITOR_COUNTRY" | "VISIT_COUNT_MORE_THAN" | "CART_SIZE_MORE_THAN" | "PRODUCT_NAMES_IN_CART" | "PIPELINE_STEP" | "JS_FUNCTION_RETURNS_TRUE" | "PURCHASE_COUNT_MORE_THAN" | "VISITOR_IP_ADDR" | "PAGE_URL_SIMPLE" | "OPERATOR_PRESENCE" | "AFTER_TIMEOUT" | "CLICK_ELEMENT" | "CLICK_BUTTON" | "DEVICE_TYPE" | "WEEKLY_SCHEDULE" | "VISITOR_PRIORITY_MORE_THAN" | "VISITOR_TARGETED" | "VISITOR_CART_LOCKED" | "VISITOR_SENT_LEAD" | "PREVIOUS_PAGE_URL_SIMPLE" | "REFERRER_URL_SIMPLE" | "VISITOR_HAS_WAITED_FOR" | "HAS_CHATTED" | "CHAT_HAS_AT_LEAST_ONE_OF_TAGS" | "VISITOR_BELONGS_TO_AN_TARGET_EXPERIMENT_GROUP" | "VISITOR_HAS_WAITED_FOR_THE_FIRST_ANSWER" | "VISITOR_BELONGS_TO_AN_USER_EXPERIMENT_GROUP" | "TARGET_PREDICTION_CONVERSION_PROBABILITY")[];
export interface ConditionWeeklyScheduleSettings {
timezone: string;
intervals: {
/** 1 - monday, 7 - sunday */
start_day: number;
start_minute: "00";
end_minute: "00";
start_hour: "00";
end_hour: "00";
end_minutes: number;
/** 1 - monday, 7 - sunday */
end_day: number;
end_hours: number;
start_hours: number;
start_minutes: number;
}[];
timezone: string;
intervals: {
/** 1 - monday, 7 - sunday */
start_day: number;
start_minute: "00";
end_minute: "00";
start_hour: "00";
end_hour: "00";
end_minutes: number;
/** 1 - monday, 7 - sunday */
end_day: number;
end_hours: number;
start_hours: number;
start_minutes: number;
}[];
}
export interface ConditionHasChattedSettings {
isOnlyForRealChats: boolean;
isOnlyForRealChats: boolean;
}
export declare type ConditionSettingsType =
| ConditionWeeklyScheduleSettings
| ConditionHasChattedSettings
| {};
export declare type ConditionSettingsType = ConditionWeeklyScheduleSettings | ConditionHasChattedSettings | {};
//# sourceMappingURL=conditions.d.ts.map

162

lib/conditions.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConditionTypes = {
/** value: city name as a string, settings: none */
VISITOR_CITY: 1,
/** value: CSS selector as a string, settings: none */
CSS_SELECTOR: 2,
/** value: JavaScript regular expression as a string, settings: none */
PREVIOUS_PAGE_URL_REGEXP: 3,
/** value: JavaScript regular expression as a string, settings: none */
REFERRER_URL_REGEXP: 4,
/** value: JavaScript regular expression as a string, settings: none */
PAGE_URL_REGEXP: 5,
/** value: country name as a string, settings: none */
VISITOR_COUNTRY: 6,
/** value: visit count as an integer number, settings: none */
VISIT_COUNT_MORE_THAN: 7,
/** value: cart value as a float number with two decimals, settings: none */
CART_SIZE_MORE_THAN: 8,
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
// CART_SIZE_LESS_THAN: 9,
/** value: product name as a string, settings: none */
PRODUCT_NAMES_IN_CART: 10,
/** value: pipeline step as an integer number, settings: none */
PIPELINE_STEP: 11,
/** value: JavaScript expression as a string, settings: none */
JS_FUNCTION_RETURNS_TRUE: 12,
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
// VISIT_COUNT_LESS_THAN: 13,
/** value: number of purchases as an integer number, settings: none */
PURCHASE_COUNT_MORE_THAN: 14,
/** value: JavaScript regular expression as a string, settings: none */
VISITOR_IP_ADDR: 15,
/** value: part of the URL as a string, settings: none */
PAGE_URL_SIMPLE: 16,
/** value: either "online" (meaning any agent is online) or "offline" (all agents are offline), settings: none */
OPERATOR_PRESENCE: 17,
/** value: number of seconds as an integer number, settings: none */
AFTER_TIMEOUT: 18,
/** value: CSS selector as a string, settings: none */
CLICK_ELEMENT: 19,
/** value: unique identifier of the custom button object, settings: none */
CLICK_BUTTON: 20,
/** value: "desktop" | "mobile" | "tablet" | "mobile,tablet", settings: none */
DEVICE_TYPE: 21,
/** value: none, settings: ConditionWeeklyScheduleSettings */
WEEKLY_SCHEDULE: 22,
/** value: priority value as an integer [1 - 10], settings: none */
VISITOR_PRIORITY_MORE_THAN: 23,
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
// VISITOR_PRIORITY_LESS_THAN: 24,
/** value: none, settings: none */
VISITOR_TARGETED: 25,
/** value: none, settings: none */
VISITOR_CART_LOCKED: 26,
/** value: none, settings: none */
VISITOR_SENT_LEAD: 27,
/** value: part of the URL as a string, settings: none */
PREVIOUS_PAGE_URL_SIMPLE: 28,
/** value: part of the URL as a string, settings: none */
REFERRER_URL_SIMPLE: 29,
/** value: number of seconds as an integer number, settings: none */
VISITOR_HAS_WAITED_FOR: 30,
/** value: none, settings: ConditionHasChattedSettings */
HAS_CHATTED: 31,
/** value: list of tag unique identifiers, settings: none */
CHAT_HAS_AT_LEAST_ONE_OF_TAGS: 32,
/** value: experiment group as a string, settings: none */
VISITOR_BELONGS_TO_AN_TARGET_EXPERIMENT_GROUP: 33,
/** value: number of seconds as an integer number, settings: none */
VISITOR_HAS_WAITED_FOR_THE_FIRST_ANSWER: 34,
/** value: experiment group unique identifiers, settings: none */
VISITOR_BELONGS_TO_AN_USER_EXPERIMENT_GROUP: 35,
/** value: ai prediction (target) conversion probability, settings: none */
TARGET_PREDICTION_CONVERSION_PROBABILITY: 36
/** value: city name as a string, settings: none */
VISITOR_CITY: 1,
/** value: CSS selector as a string, settings: none */
CSS_SELECTOR: 2,
/** value: JavaScript regular expression as a string, settings: none */
PREVIOUS_PAGE_URL_REGEXP: 3,
/** value: JavaScript regular expression as a string, settings: none */
REFERRER_URL_REGEXP: 4,
/** value: JavaScript regular expression as a string, settings: none */
PAGE_URL_REGEXP: 5,
/** value: country name as a string, settings: none */
VISITOR_COUNTRY: 6,
/** value: visit count as an integer number, settings: none */
VISIT_COUNT_MORE_THAN: 7,
/** value: cart value as a float number with two decimals, settings: none */
CART_SIZE_MORE_THAN: 8,
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
// CART_SIZE_LESS_THAN: 9,
/** value: product name as a string, settings: none */
PRODUCT_NAMES_IN_CART: 10,
/** value: pipeline step as an integer number, settings: none */
PIPELINE_STEP: 11,
/** value: JavaScript expression as a string, settings: none */
JS_FUNCTION_RETURNS_TRUE: 12,
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
// VISIT_COUNT_LESS_THAN: 13,
/** value: number of purchases as an integer number, settings: none */
PURCHASE_COUNT_MORE_THAN: 14,
/** value: JavaScript regular expression as a string, settings: none */
VISITOR_IP_ADDR: 15,
/** value: part of the URL as a string, settings: none */
PAGE_URL_SIMPLE: 16,
/** value: either "online" (meaning any agent is online) or "offline" (all agents are offline), settings: none */
OPERATOR_PRESENCE: 17,
/** value: number of seconds as an integer number, settings: none */
AFTER_TIMEOUT: 18,
/** value: CSS selector as a string, settings: none */
CLICK_ELEMENT: 19,
/** value: unique identifier of the custom button object, settings: none */
CLICK_BUTTON: 20,
/** value: "desktop" | "mobile" | "tablet" | "mobile,tablet", settings: none */
DEVICE_TYPE: 21,
/** value: none, settings: ConditionWeeklyScheduleSettings */
WEEKLY_SCHEDULE: 22,
/** value: priority value as an integer [1 - 10], settings: none */
VISITOR_PRIORITY_MORE_THAN: 23,
/**
* NOTE: no data, might be deprecated
* TODO: Confirm status, remove or add description
*/
// VISITOR_PRIORITY_LESS_THAN: 24,
/** value: none, settings: none */
VISITOR_TARGETED: 25,
/** value: none, settings: none */
VISITOR_CART_LOCKED: 26,
/** value: none, settings: none */
VISITOR_SENT_LEAD: 27,
/** value: part of the URL as a string, settings: none */
PREVIOUS_PAGE_URL_SIMPLE: 28,
/** value: part of the URL as a string, settings: none */
REFERRER_URL_SIMPLE: 29,
/** value: number of seconds as an integer number, settings: none */
VISITOR_HAS_WAITED_FOR: 30,
/** value: none, settings: ConditionHasChattedSettings */
HAS_CHATTED: 31,
/** value: list of tag unique identifiers, settings: none */
CHAT_HAS_AT_LEAST_ONE_OF_TAGS: 32,
/** value: experiment group as a string, settings: none */
VISITOR_BELONGS_TO_AN_TARGET_EXPERIMENT_GROUP: 33,
/** value: number of seconds as an integer number, settings: none */
VISITOR_HAS_WAITED_FOR_THE_FIRST_ANSWER: 34,
/** value: experiment group unique identifiers, settings: none */
VISITOR_BELONGS_TO_AN_USER_EXPERIMENT_GROUP: 35,
/** value: ai prediction (target) conversion probability, settings: none */
TARGET_PREDICTION_CONVERSION_PROBABILITY: 36,
};
exports.CONDITION_TYPES = Object.keys(exports.ConditionTypes);

892

lib/customer.d.ts

@@ -1,17 +0,6 @@

import {
AvatarUid,
OrganizationUid,
UserUid,
BusinessUid,
OrganizationLegacyId,
OrganizationSettingsUid,
UserLegacyId,
TokenUid,
FeatureName,
ChatUserLegacyId,
} from "./types";
import { AvatarUid, OrganizationUid, UserUid, BusinessUid, OrganizationLegacyId, OrganizationSettingsUid, UserLegacyId, TokenUid, FeatureName, ChatUserLegacyId } from "./types";
import { Timezone, Currency } from "./common";
export interface Feature {
/** Name and unique identifier of the feature */
id: FeatureName;
/** Name and unique identifier of the feature */
id: FeatureName;
}

@@ -22,10 +11,10 @@ /**

export interface FeaturePayload {
/** Name and unique identifier of the feature */
id: FeatureName;
/** Name and unique identifier of the feature */
id: FeatureName;
}
export interface Login {
/** Customer email address */
email: string;
/** Customer password */
password: string;
/** Customer email address */
email: string;
/** Customer password */
password: string;
}

@@ -36,36 +25,36 @@ /**

export interface LoginPayload {
/** Customer email address */
email: string;
/** Customer password */
password: string;
/** Customer email address */
email: string;
/** Customer password */
password: string;
}
export interface NestedAvatar {
/** Unique identifier of the avatar */
id: AvatarUid;
/** Link to the avatar */
url: string;
/** Unique identifier of the avatar */
id: AvatarUid;
/** Link to the avatar */
url: string;
}
export interface NestedOrganization {
/** Unique identifier of the organization */
id: OrganizationUid;
/** Name of the organization */
name: string;
/** Unique identifier of the organization */
id: OrganizationUid;
/** Name of the organization */
name: string;
}
export interface NestedUser {
/** Unique identifier of the user */
id: UserUid;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Full name of the user */
full_name: string;
/** Unique identifier of the organization the user belongs to */
organization_id: OrganizationUid;
/** Unique identifier of the users avatar */
avatar_id: AvatarUid | null;
/** Avatar of the user */
avatar: NestedAvatar | null;
/** Defines whether the user is bot or a real person */
is_bot: boolean;
/** Unique identifier of the user */
id: UserUid;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Full name of the user */
full_name: string;
/** Unique identifier of the organization the user belongs to */
organization_id: OrganizationUid;
/** Unique identifier of the users avatar */
avatar_id: AvatarUid | null;
/** Avatar of the user */
avatar: NestedAvatar | null;
/** Defines whether the user is bot or a real person */
is_bot: boolean;
}

@@ -76,223 +65,223 @@ /**

export interface OrganizationCreate {
/** Name of the organization that shall be created */
name: string;
/** Domain name of the organization that shall be created */
domain_name: string;
/** Name of the organization that shall be created */
name: string;
/** Domain name of the organization that shall be created */
domain_name: string;
}
export interface OrganizationCreatePayload {
/** Name of the organization that shall be created */
name: string;
/** Domain name of the organization that shall be created */
domain_name?: string;
/** Name of the organization that shall be created */
name: string;
/** Domain name of the organization that shall be created */
domain_name?: string;
}
export interface Organization {
/** Unique identifier of the organization */
id: OrganizationUid;
/** Name of the organization */
name: string;
/** Contact email address of the organization */
email: string | null;
/** Contact phone number of the organization */
phone: string | null;
/** Contact street address of the organization */
street: string | null;
/** Contact address postal code of the organization */
postal_code: string | null;
/** Contact address city of the organization */
city: string | null;
/** Country as a two-letter, lowercase ISO 3166-1 code, of the organization */
country: string | null;
/** Unique business identifier of the organization */
business_id: BusinessUid | null;
/** The script tag for the organization */
script_tag: string;
/** Date when the organization account was created */
created_at: string;
/** Date when details of the organization were changed for the last time */
updated_at: string;
/** Indicates whether there is any user from the organization online. See user clients for more information */
is_online: boolean;
/** Indicates whether there is any user from the organization currently present. See user clients for more information */
is_present: boolean;
/** Old unique identifier of the organization. Deprecated, use id whenever possible instead */
legacy_id: OrganizationLegacyId;
/** Number of rules the organization can create */
max_rules_count: number | null;
/** Unique identifier of the organization */
id: OrganizationUid;
/** Name of the organization */
name: string;
/** Contact email address of the organization */
email: string | null;
/** Contact phone number of the organization */
phone: string | null;
/** Contact street address of the organization */
street: string | null;
/** Contact address postal code of the organization */
postal_code: string | null;
/** Contact address city of the organization */
city: string | null;
/** Country as a two-letter, lowercase ISO 3166-1 code, of the organization */
country: string | null;
/** Unique business identifier of the organization */
business_id: BusinessUid | null;
/** The script tag for the organization */
script_tag: string;
/** Date when the organization account was created */
created_at: string;
/** Date when details of the organization were changed for the last time */
updated_at: string;
/** Indicates whether there is any user from the organization online. See user clients for more information */
is_online: boolean;
/** Indicates whether there is any user from the organization currently present. See user clients for more information */
is_present: boolean;
/** Old unique identifier of the organization. Deprecated, use id whenever possible instead */
legacy_id: OrganizationLegacyId;
/** Number of rules the organization can create */
max_rules_count: number | null;
}
export interface OrganizationPayload {
/** Name of the organization */
name: string;
/** Contact email address of the organization */
email?: string | null;
/** Contact phone number of the organization */
phone?: string;
/** Contact street address of the organization */
street?: string;
/** Contact address postal code of the organization */
postal_code?: string;
/** Country as a two-letter, lowercase ISO 3166-1 code, of the organization */
city?: string;
/** Country as a two-letter, lowercase ISO 3166-1 code, of the organization */
country?: string;
/** Business ID of the organization */
business_id?: BusinessUid;
/** Name of the organization */
name: string;
/** Contact email address of the organization */
email?: string | null;
/** Contact phone number of the organization */
phone?: string;
/** Contact street address of the organization */
street?: string;
/** Contact address postal code of the organization */
postal_code?: string;
/** Country as a two-letter, lowercase ISO 3166-1 code, of the organization */
city?: string;
/** Country as a two-letter, lowercase ISO 3166-1 code, of the organization */
country?: string;
/** Business ID of the organization */
business_id?: BusinessUid;
}
export interface OrganizationSettings {
/** Unique identifier of the organization settings */
id: OrganizationSettingsUid;
/** Unique identifier of the organization the settings belong to*/
organization_id: OrganizationUid;
/** Organization the settings belong to*/
organization: NestedOrganization;
/** Defines default language of interface for the organization in ISO 639-1 code*/
default_ui_language: string;
/** Defines whether private chat history is enabled */
is_private_chat_history_enabled: boolean;
/** Defines whether strict password policy is enabled */
is_strict_password_policy_enabled: boolean;
/** Defines whether automatic chat links are enabled */
is_automatic_chat_links_enabled: boolean;
/** Defines whether variable signing is required */
is_variable_signing_required: boolean;
/** Defines whether login credentials preservation is enabled */
is_login_credentials_preservation_enabled: boolean;
/** Defines the duration of login credentials preservation */
login_credentials_preservation_duration: number;
/** Date when settings of the organization were created. Available only for settings of your own organization */
created_at: string;
/** Date when settings of the organization were changed for the last time. Available only for settings of your own organization */
updated_at: string;
/** Defines a timezone of the organization */
timezone: Timezone;
/** Defines a currency of the organization */
master_currency: Currency;
/** Defines a currency symbol of the organization */
master_currency_symbol: string;
/** Defines in how many days passwords will expire. By default passwords would not expire */
password_expiration_days: number | null;
/** Unique identifier of the organization settings */
id: OrganizationSettingsUid;
/** Unique identifier of the organization the settings belong to*/
organization_id: OrganizationUid;
/** Organization the settings belong to*/
organization: NestedOrganization;
/** Defines default language of interface for the organization in ISO 639-1 code*/
default_ui_language: string;
/** Defines whether private chat history is enabled */
is_private_chat_history_enabled: boolean;
/** Defines whether strict password policy is enabled */
is_strict_password_policy_enabled: boolean;
/** Defines whether automatic chat links are enabled */
is_automatic_chat_links_enabled: boolean;
/** Defines whether variable signing is required */
is_variable_signing_required: boolean;
/** Defines whether login credentials preservation is enabled */
is_login_credentials_preservation_enabled: boolean;
/** Defines the duration of login credentials preservation */
login_credentials_preservation_duration: number;
/** Date when settings of the organization were created. Available only for settings of your own organization */
created_at: string;
/** Date when settings of the organization were changed for the last time. Available only for settings of your own organization */
updated_at: string;
/** Defines a timezone of the organization */
timezone: Timezone;
/** Defines a currency of the organization */
master_currency: Currency;
/** Defines a currency symbol of the organization */
master_currency_symbol: string;
/** Defines in how many days passwords will expire. By default passwords would not expire */
password_expiration_days: number | null;
}
export interface OrganizationSettingsPayload {
/** Defines default language of interface for the organization in ISO 639-1 code*/
default_ui_language: string;
/** Defines whether private chat history is enabled */
is_private_chat_history_enabled: boolean;
/** Defines whether strict password policy is enabled */
is_strict_password_policy_enabled: boolean;
/** Defines whether automatic chat links are enabled */
is_automatic_chat_links_enabled: boolean;
/** Defines whether variable signing is required */
is_variable_signing_required: boolean;
/** Defines whether login credentials preservation is enabled */
is_login_credentials_preservation_enabled: boolean;
/** Defines the duration of login credentials preservation */
login_credentials_preservation_duration?: number;
/** Defines a timezone of the organization */
timezone: Timezone;
/**Defines a currency of the organization */
master_currency?: Currency;
/** Defines in how many days passwords will expire. By default passwords would not expire */
password_expiration_days?: number | null;
/** Defines default language of interface for the organization in ISO 639-1 code*/
default_ui_language: string;
/** Defines whether private chat history is enabled */
is_private_chat_history_enabled: boolean;
/** Defines whether strict password policy is enabled */
is_strict_password_policy_enabled: boolean;
/** Defines whether automatic chat links are enabled */
is_automatic_chat_links_enabled: boolean;
/** Defines whether variable signing is required */
is_variable_signing_required: boolean;
/** Defines whether login credentials preservation is enabled */
is_login_credentials_preservation_enabled: boolean;
/** Defines the duration of login credentials preservation */
login_credentials_preservation_duration?: number;
/** Defines a timezone of the organization */
timezone: Timezone;
/**Defines a currency of the organization */
master_currency?: Currency;
/** Defines in how many days passwords will expire. By default passwords would not expire */
password_expiration_days?: number | null;
}
export interface RoomUser {
/** Unique identifier of the user */
id: UserUid;
/** Email address of the user */
email: string | null;
/** Id of the organization the user belongs to */
organization_id: OrganizationUid;
/** Organization the user belongs to */
organization: NestedOrganization;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Full name of the user */
full_name: string;
/** Indicates whether the user is a manager */
is_manager: boolean | null;
/** Indicates whether the user is a giosg.com staff member */
is_staff: boolean;
/** Display name of the user, used in chat. May be null but not a blank string */
alias: string | null;
/** Gender of the user */
gender: "male" | "female" | null;
/** A birth date of the user in format YYYY-MM-DD */
birthday: string | null;
/** Phone number of the user */
phone: string | null;
/** Title of the user. May be null but not a blank string */
title: string | null;
/** Date when the user was created */
created_at: string;
/** Date when the user was changed for the last time */
updated_at: string;
/** Date when the user was deleted */
deleted_at: string | null;
/** Defines whether the user wants to serve online as an operator. This determines if the "is_online" can be true */
is_online_enabled: boolean;
/**
* Defines whether the user is currently in online status as an operator, based on the most recent information
* about the user. This can only be true if "is_online_enabled" is true and the user is considered signed in.
* Otherwise this is false
*/
is_online: boolean;
/** Unique identifier of the users avatar */
avatar_id: AvatarUid | null;
/** Avatar of the user */
avatar: NestedAvatar | null;
/** Defines whether the user is currently present, based on the most recent information about the user*/
is_present: boolean;
/** Number of chats the user has, based on the most recent information about the user */
current_chat_count: number;
/**
* Defines whether the user exists no more. If true, the resource exists only for historical purposes
* and cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the user is bot or a real person */
is_bot: boolean;
/** Defines whether the user was created by single sign-on app */
is_created_by_sso: boolean;
/** Old unique identifier of the user in the chat. Deprecated, use id whenever possible instead */
legacy_id: ChatUserLegacyId;
/** Old unique identifier of the user. Deprecated, use id whenever possible instead */
legacy_integer_id: UserLegacyId;
/** Old unique identifier of the organization. Deprecated, use id whenever possible instead */
organization_legacy_id: OrganizationLegacyId;
/** Unique identifier of the user */
id: UserUid;
/** Email address of the user */
email: string | null;
/** Id of the organization the user belongs to */
organization_id: OrganizationUid;
/** Organization the user belongs to */
organization: NestedOrganization;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Full name of the user */
full_name: string;
/** Indicates whether the user is a manager */
is_manager: boolean | null;
/** Indicates whether the user is a giosg.com staff member */
is_staff: boolean;
/** Display name of the user, used in chat. May be null but not a blank string */
alias: string | null;
/** Gender of the user */
gender: "male" | "female" | null;
/** A birth date of the user in format YYYY-MM-DD */
birthday: string | null;
/** Phone number of the user */
phone: string | null;
/** Title of the user. May be null but not a blank string */
title: string | null;
/** Date when the user was created */
created_at: string;
/** Date when the user was changed for the last time */
updated_at: string;
/** Date when the user was deleted */
deleted_at: string | null;
/** Defines whether the user wants to serve online as an operator. This determines if the "is_online" can be true */
is_online_enabled: boolean;
/**
* Defines whether the user is currently in online status as an operator, based on the most recent information
* about the user. This can only be true if "is_online_enabled" is true and the user is considered signed in.
* Otherwise this is false
*/
is_online: boolean;
/** Unique identifier of the users avatar */
avatar_id: AvatarUid | null;
/** Avatar of the user */
avatar: NestedAvatar | null;
/** Defines whether the user is currently present, based on the most recent information about the user*/
is_present: boolean;
/** Number of chats the user has, based on the most recent information about the user */
current_chat_count: number;
/**
* Defines whether the user exists no more. If true, the resource exists only for historical purposes
* and cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the user is bot or a real person */
is_bot: boolean;
/** Defines whether the user was created by single sign-on app */
is_created_by_sso: boolean;
/** Old unique identifier of the user in the chat. Deprecated, use id whenever possible instead */
legacy_id: ChatUserLegacyId;
/** Old unique identifier of the user. Deprecated, use id whenever possible instead */
legacy_integer_id: UserLegacyId;
/** Old unique identifier of the organization. Deprecated, use id whenever possible instead */
organization_legacy_id: OrganizationLegacyId;
}
export interface TargetPermissionToken {
service_url: string;
permission_token: string;
/** Number of seconds before the token will expire */
expires_in: number;
/** Date when the token will expire */
expires_at: string;
service_url: string;
permission_token: string;
/** Number of seconds before the token will expire */
expires_in: number;
/** Date when the token will expire */
expires_at: string;
}
export interface UserApiTokenCreate {
/** Unique identifier of the token */
id: TokenUid;
/** Date when the token was created */
created_at: string;
/** Date when the token was deleted */
deleted_at: string | null;
/** Token string */
key: string;
/** Unique identifier of the organization the authenticated user belongs to */
organization_id: OrganizationUid;
/** Defines whether the token was auto generated */
is_auto_generated: boolean;
/** Unique identifier of the authenticated user */
user_id: UserUid;
/** Description of the token */
description: string;
/** Browser of the authenticated user */
browser: string;
/** Operating system of the authenticated user */
operating_system: string;
/** Type of a device of the authenticated user */
device_type: "tablet" | "mobile" | "desktop";
/** IP address of the authenticated user */
ip_address: string;
/** Country code of the authenticated user */
country_code: string | null;
/** Unique identifier of the token */
id: TokenUid;
/** Date when the token was created */
created_at: string;
/** Date when the token was deleted */
deleted_at: string | null;
/** Token string */
key: string;
/** Unique identifier of the organization the authenticated user belongs to */
organization_id: OrganizationUid;
/** Defines whether the token was auto generated */
is_auto_generated: boolean;
/** Unique identifier of the authenticated user */
user_id: UserUid;
/** Description of the token */
description: string;
/** Browser of the authenticated user */
browser: string;
/** Operating system of the authenticated user */
operating_system: string;
/** Type of a device of the authenticated user */
device_type: "tablet" | "mobile" | "desktop";
/** IP address of the authenticated user */
ip_address: string;
/** Country code of the authenticated user */
country_code: string | null;
}

@@ -303,52 +292,52 @@ /**

export interface UserApiTokenCreatePayload {
/** Description of the token */
description: string;
/** Description of the token */
description: string;
}
export interface UserApiTokenPayload {
/** Unique identifier of the token */
id: TokenUid;
/** Date when the token was created */
created_at: string;
/** Date when the token was deleted */
deleted_at: string | null;
/** Unique identifier of the organization the authenticated user belongs to */
organization_id: OrganizationUid;
/** Defines whether the token was auto generated */
is_auto_generated: boolean;
/** Unique identifier of the authenticated user */
user_id: UserUid;
/** Description of the token */
description: string;
/** Browser of the authenticated user */
browser: string;
/** Operating system of the authenticated user */
operating_system: string;
/** Type of a device of the authenticated user */
device_type: "tablet" | "mobile" | "desktop";
/** IP address of the authenticated user */
ip_address: string;
/** Country code of the authenticated user */
country_code: string | null;
/** Unique identifier of the token */
id: TokenUid;
/** Date when the token was created */
created_at: string;
/** Date when the token was deleted */
deleted_at: string | null;
/** Unique identifier of the organization the authenticated user belongs to */
organization_id: OrganizationUid;
/** Defines whether the token was auto generated */
is_auto_generated: boolean;
/** Unique identifier of the authenticated user */
user_id: UserUid;
/** Description of the token */
description: string;
/** Browser of the authenticated user */
browser: string;
/** Operating system of the authenticated user */
operating_system: string;
/** Type of a device of the authenticated user */
device_type: "tablet" | "mobile" | "desktop";
/** IP address of the authenticated user */
ip_address: string;
/** Country code of the authenticated user */
country_code: string | null;
}
export interface UserAvatar {
/** Unique identifier of the avatar */
id: AvatarUid;
/** Link to the avatar */
url: string;
/** Date when the avatar was created */
created_at: string;
/** Date when the avatar was changed for the last time */
updated_at: string;
/** Unique identifier of the avatar */
id: AvatarUid;
/** Link to the avatar */
url: string;
/** Date when the avatar was created */
created_at: string;
/** Date when the avatar was changed for the last time */
updated_at: string;
}
export interface UserAvatarPayload {
/** Binary file of the Avatar */
url: File;
/** Binary file of the Avatar */
url: File;
}
export interface UserPasswordUpdate {
/** Current password of the user */
old_password: string;
/** New password of the user */
new_password: string;
/** Conformation of the new password of the user */
confirm_password: string;
/** Current password of the user */
old_password: string;
/** New password of the user */
new_password: string;
/** Conformation of the new password of the user */
confirm_password: string;
}

@@ -359,168 +348,169 @@ /**

export interface UserPasswordUpdatePayload {
/** Current password of the user */
old_password: string;
/** New password of the user */
new_password: string;
/** Conformation of the new password of the user */
confirm_password: string;
/** Current password of the user */
old_password: string;
/** New password of the user */
new_password: string;
/** Conformation of the new password of the user */
confirm_password: string;
}
export interface UserPreferences {
/** An estimate about the maximum number of people the user is willing to chat with simultaneously */
chat_capacity: number;
/** Identifier for the sound that shall be played on a desktop when a new message received */
desktop_message_sound: string | null;
/** Identifier for the sound that shall be played on a desktop when a new visitor becomes present */
desktop_visitor_added_sound: string | null;
/**
* Defines volume of notification sounds played on a desktop. The value can be between zero and hundred [0 - 100],
* meaning zero is silent while hundred is the maximum
*/
desktop_volume: number;
/** Defines whether the new message sound should continue until the user will interact with the interface */
is_desktop_message_sound_continuous: boolean;
/** Defines whether notifications are enabled on a desktop */
is_desktop_notification_enabled: boolean;
/** Defines whether the new visitor sound should continue until the user will interact with the interface */
is_desktop_visitor_added_sound_continuous: boolean;
/** Defines whether the sound shall be disabled while the user is offline. */
is_muted_offline: boolean;
/** Defines whether the spellchecking when composing messages is enabled */
is_spellcheck_enabled: boolean;
/** Defined whether statistic emails shall be sent to the user. */
is_statistics_email_enabled: boolean;
/** Defines whether the swim line is shown in the console */
is_swimlane_visible: boolean;
/** Defines a language for the interface for the user in ISO 639-1 code */
ui_language_code: string;
/** Unique identifier of the user */
user_id: UserUid;
/** An estimate about the maximum number of people the user is willing to chat with simultaneously */
chat_capacity: number;
/** Identifier for the sound that shall be played on a desktop when a new message received */
desktop_message_sound: string | null;
/** Identifier for the sound that shall be played on a desktop when a new visitor becomes present */
desktop_visitor_added_sound: string | null;
/**
* Defines volume of notification sounds played on a desktop. The value can be between zero and hundred [0 - 100],
* meaning zero is silent while hundred is the maximum
*/
desktop_volume: number;
/** Defines whether the new message sound should continue until the user will interact with the interface */
is_desktop_message_sound_continuous: boolean;
/** Defines whether notifications are enabled on a desktop */
is_desktop_notification_enabled: boolean;
/** Defines whether the new visitor sound should continue until the user will interact with the interface */
is_desktop_visitor_added_sound_continuous: boolean;
/** Defines whether the sound shall be disabled while the user is offline. */
is_muted_offline: boolean;
/** Defines whether the spellchecking when composing messages is enabled */
is_spellcheck_enabled: boolean;
/** Defined whether statistic emails shall be sent to the user. */
is_statistics_email_enabled: boolean;
/** Defines whether the swim line is shown in the console */
is_swimlane_visible: boolean;
/** Defines a language for the interface for the user in ISO 639-1 code */
ui_language_code: string;
/** Unique identifier of the user */
user_id: UserUid;
}
export interface UserPreferencesPayload {
/** An estimate about the maximum number of people the user is willing to chat with simultaneously */
chat_capacity: number;
/** Identifier for the sound that shall be played on a desktop when a new message received */
desktop_message_sound: string | null;
/** Identifier for the sound that shall be played on a desktop when a new visitor becomes present */
desktop_visitor_added_sound: string | null;
/**
* Defines volume of notification sounds played on a desktop. The value can be between zero and hundred [0 - 100],
* meaning zero is silent while hundred is the maximum
*/
desktop_volume: number;
/** Defines whether the new message sound should continue until the user will interact with the interface */
is_desktop_message_sound_continuous: boolean;
/** Defines whether notifications are enabled on a desktop */
is_desktop_notification_enabled: boolean;
/** Defines whether the new visitor sound should continue until the user will interact with the interface */
is_desktop_visitor_added_sound_continuous: boolean;
/** Defines whether the sound shall be disabled while the user is offline. */
is_muted_offline: boolean;
/** Defines whether the spellchecking when composing messages is enabled */
is_spellcheck_enabled: boolean;
/** Defined whether statistic emails shall be sent to the user. */
is_statistics_email_enabled: boolean;
/** Defines whether the swim line is shown in the console */
is_swimlane_visible?: boolean;
/** Defines a language for the interface for the user in ISO 639-1 code */
ui_language_code: string;
/** An estimate about the maximum number of people the user is willing to chat with simultaneously */
chat_capacity: number;
/** Identifier for the sound that shall be played on a desktop when a new message received */
desktop_message_sound: string | null;
/** Identifier for the sound that shall be played on a desktop when a new visitor becomes present */
desktop_visitor_added_sound: string | null;
/**
* Defines volume of notification sounds played on a desktop. The value can be between zero and hundred [0 - 100],
* meaning zero is silent while hundred is the maximum
*/
desktop_volume: number;
/** Defines whether the new message sound should continue until the user will interact with the interface */
is_desktop_message_sound_continuous: boolean;
/** Defines whether notifications are enabled on a desktop */
is_desktop_notification_enabled: boolean;
/** Defines whether the new visitor sound should continue until the user will interact with the interface */
is_desktop_visitor_added_sound_continuous: boolean;
/** Defines whether the sound shall be disabled while the user is offline. */
is_muted_offline: boolean;
/** Defines whether the spellchecking when composing messages is enabled */
is_spellcheck_enabled: boolean;
/** Defined whether statistic emails shall be sent to the user. */
is_statistics_email_enabled: boolean;
/** Defines whether the swim line is shown in the console */
is_swimlane_visible?: boolean;
/** Defines a language for the interface for the user in ISO 639-1 code */
ui_language_code: string;
}
export interface User {
/** Unique identifier of the user */
id: UserUid;
/** Email address of the user */
email: string | null;
/** Unique identifier of the organization the user belongs to */
organization_id: OrganizationUid;
/** Organization the user belongs to */
organization: NestedOrganization;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Full name of the user */
full_name: string;
/** Indicates whether the user is a manager */
is_manager: boolean | null;
/** Indicates whether the user is a giosg.com staff member */
is_staff: boolean;
/** Display name of the user, used in chat. May be null but not a blank string */
alias: string | null;
/** Gender of the user */
gender: "male" | "female" | null;
/** A birth date of the user in format YYYY-MM-DD */
birthday: string | null;
/** Phone number of the user */
phone: string | null;
/** Title of the user. May be null but not a blank string */
title: string | null;
/** Date when the user was created */
created_at: string;
/** Date when the user was changed for the last time */
updated_at: string;
/** Date when the user was deleted */
deleted_at: string | null;
/** Defines whether the user wants to serve online as an operator. This determines if the "is_online" can be true */
is_online_enabled: boolean;
/**
* Defines whether the user is currently in online status as an operator, based on the most recent information
* about the user. This can only be true if "is_online_enabled" is true and the user is considered signed in.
* Otherwise this is false. See user clients for more information
*/
is_online: boolean;
/** Unique identifier of the users avatar */
avatar_id: AvatarUid | null;
/** Avatar of the user */
avatar: NestedAvatar | null;
/**
* Defines whether the user is currently present, based on the most recent information about the user.
* See user clients for more information
*/
is_present: boolean;
/** Number of chats the user has, based on the most recent information about the user */
current_chat_count: number;
/**
* Defines whether the user exists no more. If true, the resource exists only for historical purposes
* and cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the user is bot or a real person */
is_bot: boolean;
/** Defines whether the user was created by single sign-on app */
is_created_by_sso: boolean;
/** Old unique identifier of the user in the chat. Deprecated, use id whenever possible instead */
legacy_id: ChatUserLegacyId;
/** Old unique identifier of the user. Deprecated, use id whenever possible instead */
legacy_integer_id: UserLegacyId;
/** Old unique identifier of the organization. Deprecated, use id whenever possible instead */
organization_legacy_id: OrganizationLegacyId;
/** Unique identifier of the user */
id: UserUid;
/** Email address of the user */
email: string | null;
/** Unique identifier of the organization the user belongs to */
organization_id: OrganizationUid;
/** Organization the user belongs to */
organization: NestedOrganization;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Full name of the user */
full_name: string;
/** Indicates whether the user is a manager */
is_manager: boolean | null;
/** Indicates whether the user is a giosg.com staff member */
is_staff: boolean;
/** Display name of the user, used in chat. May be null but not a blank string */
alias: string | null;
/** Gender of the user */
gender: "male" | "female" | null;
/** A birth date of the user in format YYYY-MM-DD */
birthday: string | null;
/** Phone number of the user */
phone: string | null;
/** Title of the user. May be null but not a blank string */
title: string | null;
/** Date when the user was created */
created_at: string;
/** Date when the user was changed for the last time */
updated_at: string;
/** Date when the user was deleted */
deleted_at: string | null;
/** Defines whether the user wants to serve online as an operator. This determines if the "is_online" can be true */
is_online_enabled: boolean;
/**
* Defines whether the user is currently in online status as an operator, based on the most recent information
* about the user. This can only be true if "is_online_enabled" is true and the user is considered signed in.
* Otherwise this is false. See user clients for more information
*/
is_online: boolean;
/** Unique identifier of the users avatar */
avatar_id: AvatarUid | null;
/** Avatar of the user */
avatar: NestedAvatar | null;
/**
* Defines whether the user is currently present, based on the most recent information about the user.
* See user clients for more information
*/
is_present: boolean;
/** Number of chats the user has, based on the most recent information about the user */
current_chat_count: number;
/**
* Defines whether the user exists no more. If true, the resource exists only for historical purposes
* and cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the user is bot or a real person */
is_bot: boolean;
/** Defines whether the user was created by single sign-on app */
is_created_by_sso: boolean;
/** Old unique identifier of the user in the chat. Deprecated, use id whenever possible instead */
legacy_id: ChatUserLegacyId;
/** Old unique identifier of the user. Deprecated, use id whenever possible instead */
legacy_integer_id: UserLegacyId;
/** Old unique identifier of the organization. Deprecated, use id whenever possible instead */
organization_legacy_id: OrganizationLegacyId;
}
export interface UserPayload {
/** Email address of the user */
email: string | null;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Indicates whether the user is a manager */
is_manager?: boolean;
/** Display name of the user, used in chat. May be null but not a blank string */
alias?: string | null;
/** Gender of the user */
gender?: "male" | "female" | null;
/** A birth date of the user in format YYYY-MM-DD */
birthday?: string | null;
/** Phone number of the user */
phone?: string | null;
/** Title of the user. May be null but not a blank string */
title?: string | null;
/** Defines whether the user wants to serve online as an operator. This determines if the "is_online" can be true */
is_online_enabled: boolean;
/** Email address of the user */
email: string | null;
/** Name of the user */
first_name: string;
/** Surname of the user */
last_name: string;
/** Indicates whether the user is a manager */
is_manager?: boolean;
/** Display name of the user, used in chat. May be null but not a blank string */
alias?: string | null;
/** Gender of the user */
gender?: "male" | "female" | null;
/** A birth date of the user in format YYYY-MM-DD */
birthday?: string | null;
/** Phone number of the user */
phone?: string | null;
/** Title of the user. May be null but not a blank string */
title?: string | null;
/** Defines whether the user wants to serve online as an operator. This determines if the "is_online" can be true */
is_online_enabled: boolean;
}
export interface Quota {
/** Total free space for new assets, in bytes */
free_space: number;
/** Sum of all your organization asset sizes, in bytes */
usage: number;
/** The maximum allowed sum of your organization asset sizes, in bytes */
limit: number;
/** Total free space for new assets, in bytes */
free_space: number;
/** Sum of all your organization asset sizes, in bytes */
usage: number;
/** The maximum allowed sum of your organization asset sizes, in bytes */
limit: number;
}
//# sourceMappingURL=customer.d.ts.map

0

lib/customer.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

133

lib/customership.d.ts
import { NestedOrganization } from "./customer";
import { OrganizationUid } from "./types";
export interface Customership {
/** Unique identifier of the organization */
organization_id: OrganizationUid;
/** Organization object */
organization: NestedOrganization;
/** Defines whether the organization has a trial subscription */
is_trial: boolean;
/** Number of users the organization can have */
max_users_count: number;
/** Number of users can the organization have chatting */
max_online_users_count: number | null;
/** Number of created rules the organization can have */
max_rules_count: number | null;
/** Number of scheduled reports organization can have */
max_scheduled_email_reports_count: number;
/** Date when the organization’s customership was changed for the last time */
updated_at: string;
/** Unique identifier of the organization */
organization_id: OrganizationUid;
/** Organization object */
organization: NestedOrganization;
/** Defines whether the organization has a trial subscription */
is_trial: boolean;
/** Number of users the organization can have */
max_users_count: number;
/** Number of users can the organization have chatting */
max_online_users_count: number | null;
/** Number of created rules the organization can have */
max_rules_count: number | null;
/** Number of scheduled reports organization can have */
max_scheduled_email_reports_count: number;
/** Date when the organization’s customership was changed for the last time */
updated_at: string;
}
export interface StaffCustomership {
/** Unique identifier of the organization */
organization_id: OrganizationUid;
/** Organization object */
organization: NestedOrganization;
/** Date when the account of the organization expires */
expires_on: string;
/** Defines whether the organization has a trial subscription */
is_trial: boolean;
/** Number of users the organization can have */
max_users_count: number;
/** Number of chatting users the organization can have */
max_online_users_count: number | null;
/** Number of created rules the organization can have */
max_rules_count: number | null;
/** Number of scheduled reports the organization can have */
max_scheduled_email_reports_count: number;
/** Date when the invoice was sent to the customer for the last time */
latest_invoice_sent_on: string | null;
/** Number of months set as an invoicing interval of the organization */
invoicing_interval: number | null;
/** Defines whether the organization is excluded from the invoicing */
is_excluded_from_invoicing: boolean;
/** Defines whether an automated invoicing was created for the organization */
is_invoiced_automatically: boolean;
/** Notes about the organization for the internal use */
invoicing_notes: string;
/** Date when the organization’s customership was changed for the last time */
updated_at: string;
/** Unique identifier of the organization */
organization_id: OrganizationUid;
/** Organization object */
organization: NestedOrganization;
/** Date when the account of the organization expires */
expires_on: string;
/** Defines whether the organization has a trial subscription */
is_trial: boolean;
/** Number of users the organization can have */
max_users_count: number;
/** Number of chatting users the organization can have */
max_online_users_count: number | null;
/** Number of created rules the organization can have */
max_rules_count: number | null;
/** Number of scheduled reports the organization can have */
max_scheduled_email_reports_count: number;
/** Date when the invoice was sent to the customer for the last time */
latest_invoice_sent_on: string | null;
/** Number of months set as an invoicing interval of the organization */
invoicing_interval: number | null;
/** Defines whether the organization is excluded from the invoicing */
is_excluded_from_invoicing: boolean;
/** Defines whether an automated invoicing was created for the organization */
is_invoiced_automatically: boolean;
/** Notes about the organization for the internal use */
invoicing_notes: string;
/** Date when the organization’s customership was changed for the last time */
updated_at: string;
}
export interface StaffCustomershipPayload {
/** Date when the account of the organization expires */
expires_on: string;
/** Defines whether the organization has a trial subscription */
is_trial: boolean;
/** Number of users the organization can have */
max_users_count: number;
/** Number of chatting users the organization can have */
max_online_users_count: number | null;
/** Number of created rules the organization can have */
max_rules_count: number | null;
/** Number of scheduled reports the organization can have */
max_scheduled_email_reports_count: number;
/** Date when the invoice was sent to the customer for the last time */
latest_invoice_sent_on: string | null;
/** Number of months set as an invoicing interval of the organization */
invoicing_interval: number | null;
/** Defines whether the organization is excluded from the invoicing */
is_excluded_from_invoicing: boolean;
/** Defines whether an automated invoicing was created for the organization */
is_invoiced_automatically: boolean;
/** Notes about the organization for the internal use */
invoicing_notes?: string;
/** Date when the account of the organization expires */
expires_on: string;
/** Defines whether the organization has a trial subscription */
is_trial: boolean;
/** Number of users the organization can have */
max_users_count: number;
/** Number of chatting users the organization can have */
max_online_users_count: number | null;
/** Number of created rules the organization can have */
max_rules_count: number | null;
/** Number of scheduled reports the organization can have */
max_scheduled_email_reports_count: number;
/** Date when the invoice was sent to the customer for the last time */
latest_invoice_sent_on: string | null;
/** Number of months set as an invoicing interval of the organization */
invoicing_interval: number | null;
/** Defines whether the organization is excluded from the invoicing */
is_excluded_from_invoicing: boolean;
/** Defines whether an automated invoicing was created for the organization */
is_invoiced_automatically: boolean;
/** Notes about the organization for the internal use */
invoicing_notes?: string;
}
//# sourceMappingURL=customership.d.ts.map

0

lib/customership.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

238

lib/experiments.d.ts

@@ -1,88 +0,168 @@

import { ExperimentRule } from "./rules";
import { ExperimentRule, ExperimentRulePayload } from "./rules";
import { NestedGoal } from "./goals";
import { NestedOrganization } from "./customer";
import { NestedUser } from "./customer";
import {
ExperimentUid,
GoalUid,
UserUid,
OrganizationUid,
ExperimentGroupUid,
ExperimentGroupType,
} from "./types";
import { NestedOrganization, NestedUser } from "./customer";
import { ExperimentUid, GoalUid, UserUid, OrganizationUid, ExperimentGroupUid, ExperimentGroupType, RuleUid, RoomUid } from "./types";
import { Room } from "./rooms";
export interface Experiment {
/** Unique identifier of the experiment */
id: ExperimentUid;
/** Date when the experiment was created */
created_at: string;
/** User who created the experiment */
created_by_user: NestedUser;
/** Unique identifier of the user who created the experiment */
created_by_user_id: UserUid;
/** End time of the experiment */
ends_at: string | null;
/** Unique identifier of the goal of this experiment */
goal_id: GoalUid;
/** Goal of this experiment */
goal: NestedGoal;
/** Defines when to reset group’s visitors */
group_reset_interval: "1d" | "1w" | "full";
/** List of the experiment’s groups */
groups: NestedExperimentGroup[];
/** Name of the experiment */
name: string;
/** Unique identifier of the organization that owns the experiment */
organization_id: OrganizationUid;
/** Organization that owns the experiment */
organization: NestedOrganization;
/** Start time of the experiment */
starts_at: string;
/** Date when the experiment was changed for the last time */
updated_at: string;
/** User who changed the experiment for the last time */
updated_by_user: NestedUser;
/** Unique identifier of the user who changed the experiment for the last time */
updated_by_user_id: UserUid;
/** Unique identifier of the experiment */
id: ExperimentUid;
/** Date when the experiment was created */
created_at: string;
/** User who created the experiment */
created_by_user: NestedUser;
/** Unique identifier of the user who created the experiment */
created_by_user_id: UserUid;
/** End time of the experiment */
ends_at: string | null;
/** Unique identifier of the goal of this experiment */
goal_id: GoalUid;
/** Goal of this experiment */
goal: NestedGoal;
/** Whether the experiment is a draft or published. Once published, the experiment cannot be changed back to draft */
is_draft: boolean;
/** List of room IDs where the experiment treatments can be triggered. If the list is empty, treatment can be triggered in any of the organization’s rooms */
room_ids: RoomUid[];
/** List of rooms where the experiment treatments can be triggered. If the list is empty, treatment can be triggered in any of the organization’s rooms */
rooms: Room[];
/** Defines when to reset group’s visitors */
group_reset_interval: "1d" | "1w" | "full";
/** List of the experiment’s groups */
groups: NestedExperimentGroup[];
/** Name of the experiment */
name: string;
/** Unique identifier of the organization that owns the experiment */
organization_id: OrganizationUid;
/** Organization that owns the experiment */
organization: NestedOrganization;
/** Start time of the experiment */
starts_at: string;
/** Date when the experiment was changed for the last time */
updated_at: string;
/** User who changed the experiment for the last time */
updated_by_user: NestedUser;
/** Unique identifier of the user who changed the experiment for the last time */
updated_by_user_id: UserUid;
}
export interface ExperimentPayload {
/** End time of the experiment */
ends_at?: string | null;
/** Unique identifier of the goal of this experiment */
goal_id: GoalUid;
/** Defines when to reset group’s visitors */
group_reset_interval?: "1d" | "1w" | "full";
/** List of the experiment’s groups */
groups: NestedExperimentGroupPayload[];
/** Name of the experiment */
name: string;
/** Start time of the experiment */
starts_at: string;
/** End time of the experiment */
ends_at?: string | null;
/** Unique identifier of the goal of this experiment */
goal_id?: GoalUid;
/** Defines when to reset group’s visitors */
group_reset_interval?: "1d" | "1w" | "full";
/** List of the experiment’s groups */
groups?: NestedExperimentGroupPayload[];
/** Name of the experiment */
name?: string;
/** Start time of the experiment */
starts_at?: string;
/** Whether the experiment is a draft or published. Once published, the experiment cannot be changed back to draft */
is_draft: boolean;
/** List of room IDs where the experiment treatments can be triggered. If the list is empty, treatment can be triggered in any of the organization’s rooms */
room_ids?: RoomUid[];
}
export interface NestedExperimentGroup {
/** Unique identifier of the experiment group */
id: ExperimentGroupUid;
/** Date when the experiment group was created */
created_at: string;
/** Type of the experiment group */
group_type: ExperimentGroupType;
/** Name of the experiment group */
name: string;
/** The index of this group in the order of groups within the experiment */
order: number;
/** The percentage this group has within the experiments group distribution. Percentages of groups within a experiment must add up to 100 */
percentage: number;
/** Rule that is ran for visitors in this group */
treatment: ExperimentRule | null;
/** Date when the experiment group was changed for the last time */
updated_at: string;
/** Unique identifier of the experiment group */
id: ExperimentGroupUid;
/** Date when the experiment group was created */
created_at: string;
/** Type of the experiment group */
group_type: ExperimentGroupType;
/** Name of the experiment group */
name: string;
/** The index of this group in the order of groups within the experiment */
order: number;
/** The percentage this group has within the experiments group distribution. Percentages of groups within a experiment must add up to 100 */
percentage: number;
/** Rule that is ran for visitors in this group */
treatment: ExperimentRule | null;
/** Date when the experiment group was changed for the last time */
updated_at: string;
}
export interface NestedExperimentGroupPayload {
/** Type of the experiment group */
group_type?: ExperimentGroupType;
/** Name of the experiment group */
name: string;
/** The percentage this group has within the experiments group distribution. Percentages of groups within a experiment must add up to 100 */
percentage: number;
/** Rule that is ran for visitors in this group */
treatment?: ExperimentRule;
/** Type of the experiment group */
group_type?: ExperimentGroupType;
/** Name of the experiment group */
name: string;
/** The percentage this group has within the experiments group distribution. Percentages of groups within a experiment must add up to 100 */
percentage: number;
/** Rule that is ran for visitors in this group */
treatment?: ExperimentRulePayload;
}
/** Experiment API v3 interfaces */
export interface ExperimentResult {
/** The first date of the interval */
start_date: string;
/** The last date of the interval (inclusive) */
end_date: string;
/** The IDs of the experiment group, rule and goal which others are compared against when computing statistical significance. If not provided, these test statistics will not be calculated. */
control_group_goal_rule_id: ExperimentGroupGoalRuleUid;
/** The ID of the experiment. */
experiment_id: ExperimentUid;
/** The ID of the organization this experiment belongs to. */
organization_id: OrganizationUid;
/** The weekly results */
by_week: ExperimentResultGroupsByWeek[];
/** Sums of weekly counts for the whole time range. */
totals: ExperimentResultGroupTotals[];
}
export interface ExperimentResultPayload {
start_date: string;
end_date: string;
control_group_goal_rule_id: ExperimentGroupGoalRuleUid;
group_goal_rule_ids: ExperimentGroupGoalRuleUid[];
}
export interface ExperimentResultResponse extends Omit<ExperimentResult, "by_week" | "totals"> {
by_week: ExperimentResponseGroupsByWeek[];
totals: ExperimentResponseGroupTotals[];
}
export interface ExperimentGroupGoalRuleUid {
group_id: ExperimentGroupUid;
goal_id: GoalUid;
rule_id: RuleUid;
}
export interface ExperimentResultGroupTotals {
/** ID of the experiment group */
group_id: ExperimentGroupUid;
/** ID of the goal for this group */
goal_id: GoalUid;
/** ID of the rule for this group */
rule_id: RuleUid;
/** The total count of unique visitors that were treated with the configured treatment (if a treatment is configured for the experiment) */
unique_visitors_with_treatment_count: number;
/** The total count of unique visitors that achieved the configured goal after being treated */
unique_visitors_with_goal_after_treatment_count: number;
/** The total conversion rate calculated by unique_visitors_with_goal_after_treatment_count/unique_visitors_with_treatment_count */
conversion: number;
/** The test statistics on whether the group has statistically significant difference in conversion rate compared to control group. null for control group */
statistical_significance: number | null;
}
export interface ExperimentResultGroupsByWeek {
/** ID of the experiment group */
group_id: ExperimentGroupUid;
/** ID of the goal for this group */
goal_id: GoalUid;
/** ID of the rule for this group */
rule_id: RuleUid;
/** The starting moment of the week this data point describes */
start_time: string;
/** The ending moment of the week this data point describes */
end_time: string;
/** The weekly count of unique visitors that were treated with the configured treatment (if a treatment is configured for the experiment) */
unique_visitors_with_treatment_count: number;
/** The weekly count of unique visitors that achieved the configured goal after being treated */
unique_visitors_with_goal_after_treatment_count: number;
/** The weekly conversion rate calculated by unique_visitors_with_goal_after_treatment_count/unique_visitors_with_treatment_count */
conversion: number;
/** The test statistics on whether the group has statistically significant difference in conversion rate compared to control group. null for control group */
statistical_significance: number | null;
}
export interface ExperimentResponseGroupTotals extends Omit<ExperimentResultGroupTotals, "conversion" | "statistical_significance"> {
conversion: string;
statistical_significance: string | null;
}
export interface ExperimentResponseGroupsByWeek extends Omit<ExperimentResultGroupsByWeek, "conversion" | "statistical_significance"> {
conversion: string;
statistical_significance: string | null;
}
//# sourceMappingURL=experiments.d.ts.map

0

lib/experiments.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

207

lib/goals.d.ts

@@ -8,119 +8,120 @@ import { NestedOrganization, NestedUser } from "./customer";

export interface GoalMatch {
/** Unique identifier of the visitor. This must be submitted beforehand using Visitor Identifier API */
custom_visitor_identity: VisitorUid;
/** Timestamp of the goal. It is used to link the goal with the visitor’s session */
goal_matched_at: string;
/**
* Value of the goal event. If not given then the default value for the goal is used.
* If there is no default value, the value is left empty
*/
goal_value: number;
/** An array of room unique identifiers where the goal matched */
rooms: RoomUid[];
/** Unique identifier of the visitor. This must be submitted beforehand using Visitor Identifier API */
custom_visitor_identity: VisitorUid;
/** Timestamp of the goal. It is used to link the goal with the visitor’s session */
goal_matched_at: string;
/**
* Value of the goal event. If not given then the default value for the goal is used.
* If there is no default value, the value is left empty
*/
goal_value: number;
/** An array of room unique identifiers where the goal matched */
rooms: RoomUid[];
}
export interface GoalMatchPayload {
/** Unique identifier of the visitor. This must be submitted beforehand using Visitor Identifier API */
custom_visitor_identity: VisitorUid;
/** Timestamp of the goal. It is used to link the goal with the visitor’s session */
goal_matched_at: string;
/**
* Value of the goal event. If not given then the default value for the goal is used.
* If there is no default value, the value is left empty
*/
goal_value?: number;
/** An array of room unique identifiers where the goal matched */
rooms: RoomUid[];
/** Unique identifier of the visitor. This must be submitted beforehand using Visitor Identifier API */
custom_visitor_identity: VisitorUid;
/** Timestamp of the goal. It is used to link the goal with the visitor’s session */
goal_matched_at: string;
/**
* Value of the goal event. If not given then the default value for the goal is used.
* If there is no default value, the value is left empty
*/
goal_value?: number;
/** An array of room unique identifiers where the goal matched */
rooms: RoomUid[];
}
export interface Goal {
/**Unique identifier of the goal */
id: GoalUid;
/** Date when the goal was created */
created_at: string;
/** Unique identifier of the user who created the goal */
created_by_user_id: UserUid;
/** User who created the goal */
created_by_user: NestedUser;
/** Date when the goal was changed for the last time */
updated_at: string;
/** Unique identifier of the user who changed the goal for the last time */
updated_by_user_id: UserUid;
/** User who changed the goal for the last time */
updated_by_user: NestedUser;
/** Organization that owns the goal */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the goal */
organization_id: OrganizationUid;
/** Name of the goal */
name: string;
/** List of [rule condition][] that are used for matching the goal */
conditions: NestedGoalCondition[];
/** Defines whether the goal can match in any room */
is_any_room_allowed: boolean;
/**
* "If "is_any_room_allowed" is false then the goal can match only in the allowed rooms.
* Allowed rooms only allows rooms that the organization owns
*/
allowed_rooms: RoomUid[];
/** Default value of the goal */
default_value: number | null;
/**Unique identifier of the goal */
id: GoalUid;
/** Date when the goal was created */
created_at: string;
/** Unique identifier of the user who created the goal */
created_by_user_id: UserUid;
/** User who created the goal */
created_by_user: NestedUser;
/** Date when the goal was changed for the last time */
updated_at: string;
/** Unique identifier of the user who changed the goal for the last time */
updated_by_user_id: UserUid;
/** User who changed the goal for the last time */
updated_by_user: NestedUser;
/** Organization that owns the goal */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the goal */
organization_id: OrganizationUid;
/** Name of the goal */
name: string;
/** List of [rule condition][] that are used for matching the goal */
conditions: NestedGoalCondition[];
/** Defines whether the goal can match in any room */
is_any_room_allowed: boolean;
/**
* "If "is_any_room_allowed" is false then the goal can match only in the allowed rooms.
* Allowed rooms only allows rooms that the organization owns
*/
allowed_rooms: RoomUid[];
/** Default value of the goal */
default_value: number | null;
}
export interface GoalPayload {
/** Name of the goal */
name: string;
/** List of [rule condition][] that are used for matching the goal */
conditions: NestedGoalConditionPayload[];
/** Defines whether the goal can match in any room */
is_any_room_allowed: boolean;
/**
* If "is_any_room_allowed" is false then the goal can match only in the allowed rooms.
* Allowed rooms only allows rooms that the organization owns
*/
allowed_rooms: RoomUid[];
/** Default value of the goal */
default_value?: number | null;
/** Name of the goal */
name: string;
/** List of [rule condition][] that are used for matching the goal */
conditions: NestedGoalConditionPayload[];
/** Defines whether the goal can match in any room */
is_any_room_allowed: boolean;
/**
* If "is_any_room_allowed" is false then the goal can match only in the allowed rooms.
* Allowed rooms only allows rooms that the organization owns
*/
allowed_rooms: RoomUid[];
/** Default value of the goal */
default_value?: number | null;
}
export interface GoalUpdatePayload {
/** Name of the goal */
name: string;
/** List of [rule condition][] that are used for matching the goal */
conditions?: NestedGoalConditionPayload[];
/** Defines whether the goal can match in any room */
is_any_room_allowed?: boolean;
/**
* If "is_any_room_allowed" is false then the goal can match only in the allowed rooms.
* Allowed rooms only allows rooms that the organization owns
*/
allowed_rooms?: RoomUid[];
/** Default value of the goal */
default_value?: number | null;
/** Name of the goal */
name: string;
/** List of [rule condition][] that are used for matching the goal */
conditions?: NestedGoalConditionPayload[];
/** Defines whether the goal can match in any room */
is_any_room_allowed?: boolean;
/**
* If "is_any_room_allowed" is false then the goal can match only in the allowed rooms.
* Allowed rooms only allows rooms that the organization owns
*/
allowed_rooms?: RoomUid[];
/** Default value of the goal */
default_value?: number | null;
}
export interface NestedGoalCondition {
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value: string;
/** Defines whether the default or opposite match type shall be used */
negate: boolean;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value: string;
/** Defines whether the default or opposite match type shall be used */
negate: boolean;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
}
export interface NestedGoalConditionPayload {
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value?: string;
/** Defines whether the default or opposite match type shall be used */
negate?: boolean;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value?: string;
/** Defines whether the default or opposite match type shall be used */
negate?: boolean;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
}
export interface NestedGoal {
/**Unique identifier of the goal */
id: GoalUid;
/** Name of the goal */
name: string;
/** Organization that owns the goal */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the goal */
organization_id: OrganizationUid;
/**Unique identifier of the goal */
id: GoalUid;
/** Name of the goal */
name: string;
/** Organization that owns the goal */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the goal */
organization_id: OrganizationUid;
}
//# sourceMappingURL=goals.d.ts.map

0

lib/goals.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

257

lib/index.d.ts

@@ -1,246 +0,19 @@

export {
ActionTypes,
ActionType,
ActionTypeString,
ACTION_TYPES,
ActionShowAutosuggestSettings,
ActionSendChatMessageSettings,
ActionSettingsType,
ACTION_STYLES,
ActionStyle,
} from "./actions";
export {
Asset,
AssetPayload,
AssetUpdate,
AssetUpdatePayload,
NestedAsset,
PublicNestedAsset,
} from "./assets";
export {
ChatInvitationAccept,
ChatInvitationAcceptPayload,
ChatInvitationCreate,
ChatInvitationExpire,
ChatInvitationExpirePayload,
ChatInvitation,
ChatConversationStarter,
ChatConversationStarterPayload,
ChatConversationStarterUpdate,
ChatConversationStarterUpdatePayload,
ChatMembership,
ChatMembershipPayload,
ChatMessage,
ChatMessagePayload,
ChatReplySuggestion,
ChatReplySuggestionPayload,
Chat,
ChatPayload,
ChatSessionTag,
ChatSessionTagPayload,
DecryptedChatMessage,
DecryptedChatMessagePayload,
NestedChatMessageAttachmentAction,
NestedChatMessageAttachmentActionPayload,
NestedChatMessageAttachment,
NestedChatMessageAttachmentPayload,
NestedChatMessageResponseAttachment,
NestedChatMessageResponseAttachmentPayload,
NestedChatReplySuggestion,
OrganizationChatMembership,
OrganizationChatMembershipPayload,
RoomChatTag,
RoomChatTagPayload,
} from "./chat";
export { ActionTypes, ActionType, ActionTypeString, ACTION_TYPES, ActionShowAutosuggestSettings, ActionSendChatMessageSettings, ActionSendInteractionToChatSettings, ActionSettingsType, ACTION_STYLES, ActionStyle, } from "./actions";
export { Asset, AssetPayload, AssetUpdate, AssetUpdatePayload, NestedAsset, PublicNestedAsset, } from "./assets";
export { ChatInvitationAccept, ChatInvitationAcceptPayload, ChatInvitationCreate, ChatInvitationExpire, ChatInvitationExpirePayload, ChatInvitation, ChatConversationStarter, ChatConversationStarterPayload, ChatConversationStarterUpdate, ChatConversationStarterUpdatePayload, ChatMembership, ChatMembershipPayload, ChatStatusMessage, ChatDataMessage, ChatMessage, ChatMessagePayload, ChatReplySuggestion, ChatReplySuggestionPayload, Chat, ChatPayload, ChatSessionTag, ChatSessionTagPayload, DecryptedChatDataMessage, DecryptedChatStatusMessage, DecryptedChatMessage, DecryptedChatMessagePayload, NestedChatMessageAttachmentAction, NestedChatMessageAttachmentActionPayload, NestedChatMessageAttachment, NestedChatMessageAttachmentPayload, NestedChatMessageResponseAttachment, NestedChatMessageResponseAttachmentPayload, NestedChatReplySuggestion, OrganizationChatMembership, OrganizationChatMembershipPayload, RoomChatTag, RoomChatTagPayload, } from "./chat";
export { TIMEZONES, Timezone, CURRENCIES, Currency, LANGUAGE_CODES, LanguageCode } from "./common";
export {
ConditionTypes,
ConditionType,
ConditionTypeString,
CONDITION_TYPES,
ConditionWeeklyScheduleSettings,
ConditionHasChattedSettings,
ConditionSettingsType,
} from "./conditions";
export {
Feature,
FeaturePayload,
Login,
LoginPayload,
NestedAvatar,
NestedOrganization,
NestedUser,
OrganizationCreate,
OrganizationCreatePayload,
Organization,
OrganizationPayload,
OrganizationSettings,
OrganizationSettingsPayload,
RoomUser,
TargetPermissionToken,
UserApiTokenCreate,
UserApiTokenCreatePayload,
UserApiTokenPayload,
UserAvatar,
UserAvatarPayload,
UserPasswordUpdate,
UserPasswordUpdatePayload,
UserPreferences,
UserPreferencesPayload,
User,
UserPayload,
Quota,
} from "./customer";
export { ConditionTypes, ConditionType, ConditionTypeString, CONDITION_TYPES, ConditionWeeklyScheduleSettings, ConditionHasChattedSettings, ConditionSettingsType, } from "./conditions";
export { Feature, FeaturePayload, Login, LoginPayload, NestedAvatar, NestedOrganization, NestedUser, OrganizationCreate, OrganizationCreatePayload, Organization, OrganizationPayload, OrganizationSettings, OrganizationSettingsPayload, RoomUser, TargetPermissionToken, UserApiTokenCreate, UserApiTokenCreatePayload, UserApiTokenPayload, UserAvatar, UserAvatarPayload, UserPasswordUpdate, UserPasswordUpdatePayload, UserPreferences, UserPreferencesPayload, User, UserPayload, Quota, } from "./customer";
export { Customership, StaffCustomership, StaffCustomershipPayload } from "./customership";
export {
Experiment,
ExperimentPayload,
NestedExperimentGroup,
NestedExperimentGroupPayload,
} from "./experiments";
export {
GoalMatch,
GoalMatchPayload,
Goal,
GoalPayload,
GoalUpdatePayload,
NestedGoalCondition,
NestedGoalConditionPayload,
NestedGoal,
} from "./goals";
export {
OAUTH_BASE_URL,
OAUTH_SCOPE_OPTIONS,
OauthScopeOptions,
OAUTH_RESPONSE_TYPES,
OauthResponseType,
OAUTH_PROMPT_OPTIONS,
OauthPromptOption,
OAUTH_ERROR_TYPES,
OauthErrorType,
OAuthRequestParams,
OAuthResponseSuccess,
OAuthResponseError,
OAuthResponse,
} from "./oath";
export {
PartnerOrganization,
PartnerOrganizationUser,
Partnership,
PartnershipPayload,
} from "./partnerships";
export { Experiment, ExperimentPayload, NestedExperimentGroup, NestedExperimentGroupPayload, ExperimentResult, ExperimentResultPayload, ExperimentResultResponse, ExperimentGroupGoalRuleUid, ExperimentResultGroupTotals, ExperimentResultGroupsByWeek, ExperimentResponseGroupTotals, ExperimentResponseGroupsByWeek, } from "./experiments";
export { GoalMatch, GoalMatchPayload, Goal, GoalPayload, GoalUpdatePayload, NestedGoalCondition, NestedGoalConditionPayload, NestedGoal, } from "./goals";
export { OAUTH_BASE_URL, OAUTH_SCOPE_OPTIONS, OauthScopeOptions, OAUTH_RESPONSE_TYPES, OauthResponseType, OAUTH_PROMPT_OPTIONS, OauthPromptOption, OAUTH_ERROR_TYPES, OauthErrorType, OAuthRequestParams, OAuthResponseSuccessToken, OAuthResponseSuccessIdToken, OAuthResponseSuccess, OAuthResponseError, OAuthResponse, } from "./oath";
export { PartnerOrganization, PartnerOrganizationUser, Partnership, PartnershipPayload, } from "./partnerships";
export { UserPermission, UserPermissionPayload } from "./permissions";
export {
AutosuggestPermissionOptions,
AutoSuggestPermissionOption,
AutosuggestPermissionOptionString,
AUTOSUGGEST_PERMISSION_OPTIONS,
PublicAutosuggestPermission,
PublicAutosuggestPermissionPayload,
PublicAutosuggest,
PublicAutosuggestPayload,
PublicChatMessage,
PublicChatMessagePayload,
PublicChat,
PublicChatPayload,
PublicCustomVisitorId,
PublicCustomVisitorIdPayload,
PublicLogin,
PublicLoginPayload,
PublicRoom,
PublicRoomVisitorCreatePayload,
PublicRoomVisitor,
PublicRoomVisitorUpdate,
PublicRoomVisitorUpdatePayload,
PublicUser,
PublicVisitorChatTag,
} from "./public";
export {
NestedRoom,
OrganizationRoomSettings,
OrganizationRoomSettingsPayload,
RoomAllowedDomainLink,
RoomAllowedDomainLinkPayload,
RoomCreate,
RoomCreatePayload,
Room,
RoomPayload,
} from "./rooms";
export {
ExperimentRuleCondition,
ExperimentRuleConditionPayload,
ExperimentRule,
ExperimentRulePayload,
RuleAction,
RuleActionPayload,
RuleCondition,
RuleConditionPayload,
Rule,
RulePayload,
RuleUpdatePayload,
} from "./rules";
export {
ApplicationUid,
AssetUid,
AvatarUid,
BrandUid,
BusinessUid,
ChatInvitationUid,
ChatMessageAttachmentUid,
ChatMessageAttachmentActionUid,
ChatMessageUid,
ChatReplySuggestionUid,
ChatSessionUid,
ChatUid,
ExperimentGroupUid,
ExperimentUid,
FeatureName,
GoalUid,
InteractionUid,
OrganizationUid,
OrganizationSettingsUid,
QuotaUid,
RoomSettingsUid,
RoomUid,
RouterUid,
RuleActionUid,
RuleConditionUid,
RuleUid,
TeamUid,
TokenUid,
UserUid,
VisitorUid,
UserClientUid,
BlackListUid,
GiosgSessionId,
PackedVisitorCid,
VisitorGlobalSessionId,
VisitorGlobalId,
VisitorSessionId,
VisitorSecretId,
VisitorCid,
UserLegacyId,
ChatLegacyId,
ChatUserLegacyId,
OrganizationLegacyId,
RoomLegacyId,
RuleLegacyId,
VisitorLegacyId,
RoomLegacyToken,
ASSET_TYPES,
AssetType,
EXPERIMENT_GROUP_TYPES,
ExperimentGroupType,
CHAT_MESSAGE_TYPES,
ChatMessageType,
USER_PERMISSION_SCOPES,
UserPermissionScope,
} from "./types";
export { AutosuggestPermissionOptions, AutoSuggestPermissionOption, AutosuggestPermissionOptionString, AUTOSUGGEST_PERMISSION_OPTIONS, PublicAutosuggestPermission, PublicAutosuggestPermissionPayload, PublicAutosuggest, PublicAutosuggestPayload, PublicChatMessage, PublicChatMessagePayload, PublicChat, PublicChatPayload, PublicCustomVisitorId, PublicCustomVisitorIdPayload, PublicLogin, PublicLoginPayload, PublicRoom, PublicRoomVisitorCreatePayload, PublicRoomVisitor, PublicRoomVisitorUpdate, PublicRoomVisitorUpdatePayload, PublicUser, PublicVisitorChatTag, } from "./public";
export { NestedRoom, OrganizationRoomSettings, OrganizationRoomSettingsPayload, RoomAllowedDomainLink, RoomAllowedDomainLinkPayload, RoomCreate, RoomCreatePayload, Room, RoomPayload, } from "./rooms";
export { ExperimentRuleCondition, ExperimentRuleConditionPayload, ExperimentRule, ExperimentRulePayload, RuleAction, RuleActionPayload, RuleCondition, RuleConditionPayload, Rule, RulePayload, RuleUpdatePayload, } from "./rules";
export { ApplicationUid, AssetUid, AvatarUid, BrandUid, BusinessUid, ChatInvitationUid, ChatMessageAttachmentUid, ChatMessageAttachmentActionUid, ChatMessageUid, ChatReplySuggestionUid, ChatSessionUid, ChatUid, ExperimentGroupUid, ExperimentUid, FeatureName, GoalUid, InteractionUid, OrganizationUid, OrganizationSettingsUid, QuotaUid, RoomSettingsUid, RoomUid, RouterUid, RuleActionUid, RuleConditionUid, RuleUid, TagUid, TeamUid, TokenUid, UserUid, VisitorUid, UserClientUid, BlackListUid, GiosgSessionId, PackedVisitorCid, VisitorGlobalSessionId, VisitorGlobalId, VisitorSessionId, VisitorSecretId, VisitorCid, UserLegacyId, ChatLegacyId, ChatUserLegacyId, OrganizationLegacyId, RoomLegacyId, RuleLegacyId, VisitorLegacyId, RoomLegacyToken, ASSET_TYPES, AssetType, EXPERIMENT_GROUP_TYPES, ExperimentGroupType, CHAT_STATUS_MESSAGE_TYPES, ChatStatusMessageType, CHAT_DATA_MESSAGE_TYPES, ChatDataMessageType, ChatMessageType, USER_PERMISSION_SCOPES, UserPermissionScope, } from "./types";
export { UserClient, UserClientPayload } from "./userclients";
export {
BlackList,
BlackListPayload,
CartLockedResponse,
RoomVisitorPageView,
RoomVisitor,
} from "./visitor";
export { BlackList, BlackListPayload, CartLockedResponse, RoomVisitorPageView, RoomVisitor, } from "./visitor";
//# sourceMappingURL=index.d.ts.map

6

lib/index.js

@@ -22,8 +22,8 @@ "use strict";

exports.AutosuggestPermissionOptions = public_1.AutosuggestPermissionOptions;
exports.AUTOSUGGEST_PERMISSION_OPTIONS =
public_1.AUTOSUGGEST_PERMISSION_OPTIONS;
exports.AUTOSUGGEST_PERMISSION_OPTIONS = public_1.AUTOSUGGEST_PERMISSION_OPTIONS;
var types_1 = require("./types");
exports.ASSET_TYPES = types_1.ASSET_TYPES;
exports.EXPERIMENT_GROUP_TYPES = types_1.EXPERIMENT_GROUP_TYPES;
exports.CHAT_MESSAGE_TYPES = types_1.CHAT_MESSAGE_TYPES;
exports.CHAT_STATUS_MESSAGE_TYPES = types_1.CHAT_STATUS_MESSAGE_TYPES;
exports.CHAT_DATA_MESSAGE_TYPES = types_1.CHAT_DATA_MESSAGE_TYPES;
exports.USER_PERMISSION_SCOPES = types_1.USER_PERMISSION_SCOPES;

109

lib/oath.d.ts
import { ApplicationUid } from "./types";
export declare const OAUTH_BASE_URL = "https://service.giosg.com/identity/authorize";
export declare const OAUTH_SCOPE_OPTIONS: readonly [
"openid",
"openid profile",
"openid email",
"openid profile email",
];
export declare const OAUTH_SCOPE_OPTIONS: readonly ["openid", "openid profile", "openid email", "openid profile email"];
export declare type OauthScopeOptions = typeof OAUTH_SCOPE_OPTIONS[number];

@@ -14,54 +9,64 @@ export declare const OAUTH_RESPONSE_TYPES: readonly ["id_token", "id_token token"];

export declare type OauthPromptOption = typeof OAUTH_PROMPT_OPTIONS[number];
export declare const OAUTH_ERROR_TYPES: readonly [
"invalid_request",
"invalid_client",
"invalid_scope",
"interaction_required",
"login_required",
];
export declare const OAUTH_ERROR_TYPES: readonly ["invalid_request", "invalid_client", "invalid_scope", "interaction_required", "login_required"];
export declare type OauthErrorType = typeof OAUTH_ERROR_TYPES[number];
export interface OAuthRequestParams {
/** A "list" of "scope" strings separated by single whitespace characters. The selected scopes affect the information included to the ID token */
scope: OauthScopeOptions;
/** With Implicit Flow this needs to be id_token token for receiving both ID and access tokens, or id_token for just the ID token */
response_type: OauthResponseType;
/** Unique identifier of the Giosg App as registered to Giosg. The app will act as a OAuth "client" */
client_id: ApplicationUid;
/** Redirection URI to which the response will be sent. This must exactly match one of the URIs that you have allowed for the Giosg App. The https scheme is required */
redirect_uri: string;
/**
* The value that will be included unmodified as the nonce claim in the ID token.
* The value should be used to associate a client session with an ID Token, and to mitigate replay attacks
*/
nonce: string;
/**
* Opaque value used to maintain state between the request and the callback.
* It will be sent back as-is in the authentication response. Recommended to prevent Cross-Site Request Forgery (CSRF, XSRF)
*/
state?: string;
/** Defines whether to show authentication UI to the user. "none" is default */
prompt?: OauthPromptOption;
/** A "list" of "scope" strings separated by single whitespace characters. The selected scopes affect the information included to the ID token */
scope: OauthScopeOptions;
/** With Implicit Flow this needs to be id_token token for receiving both ID and access tokens, or id_token for just the ID token */
response_type: OauthResponseType;
/** Unique identifier of the Giosg App as registered to Giosg. The app will act as a OAuth "client" */
client_id: ApplicationUid;
/** Redirection URI to which the response will be sent. This must exactly match one of the URIs that you have allowed for the Giosg App. The https scheme is required */
redirect_uri: string;
/**
* The value that will be included unmodified as the nonce claim in the ID token.
* The value should be used to associate a client session with an ID Token, and to mitigate replay attacks
*/
nonce: string;
/**
* Opaque value used to maintain state between the request and the callback.
* It will be sent back as-is in the authentication response. Recommended to prevent Cross-Site Request Forgery (CSRF, XSRF)
*/
state?: string;
/** Defines whether to show authentication UI to the user. "none" is default */
prompt?: OauthPromptOption;
}
export interface OAuthResponseSuccess {
/** Type of the token. Is always "bearer" */
token_type: "bearer";
/** Access token that the app can use with APIs. It is returned only if "response_type" request parameter was "id_token token" */
access_token: string | null;
/** The ID token as a JSON Web Token that the app can decode and get verified user information */
id_token: string;
/** The request state parameter unmodified. Your app must verify that the value matches the one sent with the request in order to prevent CSRF attacks */
state: string;
/** Number of seconds before the access token will expire */
expires_in: string;
/** The base URL for a WebSocket connection that client can use to subsribe real-time changes */
socket_url: string;
export interface OAuthResponseSuccessToken {
/** Type of the token. Is always "bearer" */
token_type: "bearer";
/** Access token that the app can use with APIs. It is returned only if "response_type" request parameter was "id_token token" */
access_token: string;
/** The ID token as a JSON Web Token that the app can decode and get verified user information */
id_token: string;
/** The request state parameter unmodified. Your app must verify that the value matches the one sent with the request in order to prevent CSRF attacks */
state: string;
/** Number of seconds before the access token will expire */
expires_in: string;
/** The base URL for a WebSocket connection that client can use to subsribe real-time changes */
socket_url: string;
}
export interface OAuthResponseSuccessIdToken {
/** Type of the token. Is always "bearer" */
token_type: "bearer";
/** Access token that the app can use with APIs. It is returned only if "response_type" request parameter was "id_token token" */
access_token: null;
/** The ID token as a JSON Web Token that the app can decode and get verified user information */
id_token: string;
/** The request state parameter unmodified. Your app must verify that the value matches the one sent with the request in order to prevent CSRF attacks */
state: string;
/** Number of seconds before the access token will expire */
expires_in: string;
/** The base URL for a WebSocket connection that client can use to subsribe real-time changes */
socket_url: string;
}
export declare type OAuthResponseSuccess = OAuthResponseSuccessToken | OAuthResponseSuccessIdToken;
export interface OAuthResponseError {
/** The error code as a string */
error: OauthErrorType;
/** Text description of the error */
error_description: string;
/** The value of the state parameter included in the Authentication Request */
state: string;
/** The error code as a string */
error: OauthErrorType;
/** Text description of the error */
error_description: string;
/** The value of the state parameter included in the Authentication Request */
state: string;
}
export declare type OAuthResponse = OAuthResponseSuccess | OAuthResponseError;
//# sourceMappingURL=oath.d.ts.map

28

lib/oath.js

@@ -5,21 +5,21 @@ "use strict";

exports.OAUTH_SCOPE_OPTIONS = [
"openid",
"openid profile",
"openid email",
"openid profile email"
"openid",
"openid profile",
"openid email",
"openid profile email",
];
exports.OAUTH_RESPONSE_TYPES = [
/**
* @deprecated
*/
"id_token",
"id_token token"
/**
* @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"
"invalid_request",
"invalid_client",
"invalid_scope",
"interaction_required",
"login_required",
];

85

lib/partnerships.d.ts

@@ -5,50 +5,51 @@ import { NestedAvatar } from "./customer";

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;
/** 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;
/** 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;
/** 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;
/** Unique identifier of the partner organization */
partner_organization_id: OrganizationUid;
}
//# sourceMappingURL=partnerships.d.ts.map

0

lib/partnerships.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

37

lib/permissions.d.ts

@@ -5,22 +5,23 @@ import { NestedOrganization } from "./customer";

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;
/** 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;
/** Defines resource that is accessible by the user */
scope: UserPermissionScope;
}
//# sourceMappingURL=permissions.d.ts.map

0

lib/permissions.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

667

lib/public.d.ts

@@ -5,33 +5,11 @@ import { NestedAvatar } from "./customer";

import { NestedChatMessageResponseAttachment } from "./chat";
import {
OrganizationUid,
RoomUid,
VisitorUid,
UserUid,
UserLegacyId,
ChatLegacyId,
ChatMessageUid,
ChatUid,
RuleUid,
VisitorLegacyId,
RuleLegacyId,
RoomLegacyId,
ChatMessageAttachmentUid,
ChatMessageAttachmentActionUid,
ChatSessionUid,
VisitorSessionId,
VisitorGlobalId,
VisitorGlobalSessionId,
VisitorSecretId,
ChatMessageType,
VisitorCid,
} from "./types";
import { OrganizationUid, RoomUid, VisitorUid, UserUid, UserLegacyId, ChatLegacyId, ChatMessageUid, ChatUid, RuleUid, VisitorLegacyId, RuleLegacyId, RoomLegacyId, ChatMessageAttachmentUid, ChatMessageAttachmentActionUid, ChatSessionUid, VisitorSessionId, VisitorGlobalId, VisitorGlobalSessionId, VisitorSecretId, ChatMessageType, VisitorCid } 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;
/** 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;
};

@@ -42,287 +20,281 @@ export declare type AutoSuggestPermissionOption = (typeof AutosuggestPermissionOptions)[keyof typeof AutosuggestPermissionOptions];

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;
/** 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;
/** 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;
/** 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;
/** 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";
/** 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;
/** 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";
/** 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;
/** 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;
/** 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;
/** 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;
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;
/** 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;
/** 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;
/** 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;
/** 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 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;
/** 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[];
/** 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: VisitorSessionId;
/** TODO: add documentation */
visitor_global_id: VisitorGlobalId;
/** TODO: add documentation */
visitor_global_session_id: VisitorGlobalSessionId;
/** 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: VisitorSessionId;
/** TODO: add documentation */
visitor_global_id: VisitorGlobalId;
/** TODO: add documentation */
visitor_global_session_id: VisitorGlobalSessionId;
}
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: VisitorSessionId;
/** TODO: add documentation */
visitor_global_id: VisitorGlobalId;
/** TODO: add documentation */
visitor_global_session_id: VisitorGlobalSessionId;
/** 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: VisitorSessionId;
/** TODO: add documentation */
visitor_global_id: VisitorGlobalId;
/** TODO: add documentation */
visitor_global_session_id: VisitorGlobalSessionId;
}

@@ -333,82 +305,83 @@ /**

export interface PublicLogin {
/** TODO: add documentation */
visitor_secret_id: VisitorSecretId | null;
/** TODO: add documentation */
visitor_global_id: VisitorGlobalId | null;
/** TODO: add documentation */
visitor_secret_id: VisitorSecretId | null;
/** TODO: add documentation */
visitor_global_id: VisitorGlobalId | null;
}
export interface PublicLoginPayload {
/** TODO: add documentation */
visitor_secret_id?: VisitorSecretId | null;
/** TODO: add documentation */
visitor_global_id?: VisitorGlobalId | null;
/** TODO: add documentation */
visitor_secret_id?: VisitorSecretId | null;
/** TODO: add documentation */
visitor_global_id?: VisitorGlobalId | 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 ID of the chat’s room. Deprecated use "id" instead */
legacy_id: RoomLegacyId;
/** TODO: add documentation */
brand: any;
/** 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 ID of the chat’s room. Deprecated use "id" instead */
legacy_id: RoomLegacyId;
/** TODO: add documentation */
brand: any;
}
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;
/** 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;
/** 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;
/** 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;
/** 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;
/** 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;
/** 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

16

lib/public.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
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
/** 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
);
exports.AUTOSUGGEST_PERMISSION_OPTIONS = Object.keys(exports.AutosuggestPermissionOptions);

371

lib/rooms.d.ts
import { NestedOrganization, NestedUser } from "./customer";
import {
RoomUid,
RoomSettingsUid,
OrganizationUid,
RouterUid,
BrandUid,
UserUid,
RoomLegacyToken,
} from "./types";
import { RoomUid, RoomSettingsUid, OrganizationUid, RouterUid, BrandUid, UserUid, RoomLegacyToken } from "./types";
import { LanguageCode } from "./common";
export interface NestedRoom {
/** 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;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain: string;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
/** 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;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain: string;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
}
export interface OrganizationRoomSettings {
/** Unique identifier of the organization room settings */
id: RoomSettingsUid;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
/** Unique identifier of the room to which the settings apply */
room_id: RoomUid;
/** Room to which the settings apply */
room: NestedRoom;
/** Unique identifier of the router that is used to route chats in the room */
router_id: RouterUid | null;
/** Unique identifier of the brand that is used in the room. If null then the default theme is used */
brand_id: BrandUid | null;
/** Defines whether pending visitor messages should be hidden in giosg console */
is_pending_chat_messages_hidden: boolean;
/**
* Defines whether the chat shall open in the same browser tab using the newer client. By default
* a legacy mobile chat client is used and the chat opens into a new browser tab
*/
is_mobile_chat_in_same_tab: boolean;
/** Defines whether Google Analytics tracking is enabled */
is_analytics_tracking_enabled: boolean;
/** Type of the Google Analytics object. This is required if "is_analytics_tracking_enabled" is true */
analytics_object_type: "gaq" | "datalayer" | "ga-send" | "custom" | null;
/** This is required if "analytics_object_type" is "custom" */
analytics_custom_object: string | null;
/** Defines whether AJAX tracking is enabled */
is_ajax_tracking_enabled: boolean;
/** Defines whether the room only accepts signed visitor variables and chat widget URLs */
is_signature_required: boolean;
/** Date when the room settings were created */
created_at: string;
/** Date when the room settings were changed for the last time */
updated_at: string;
/** Unique identifier of the organization room settings */
id: RoomSettingsUid;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
/** Unique identifier of the room to which the settings apply */
room_id: RoomUid;
/** Room to which the settings apply */
room: NestedRoom;
/** Unique identifier of the router that is used to route chats in the room */
router_id: RouterUid | null;
/** Unique identifier of the brand that is used in the room. If null then the default theme is used */
brand_id: BrandUid | null;
/** Defines whether pending visitor messages should be hidden in giosg console */
is_pending_chat_messages_hidden: boolean;
/**
* Defines whether the chat shall open in the same browser tab using the newer client. By default
* a legacy mobile chat client is used and the chat opens into a new browser tab
*/
is_mobile_chat_in_same_tab: boolean;
/** Defines whether Google Analytics tracking is enabled */
is_analytics_tracking_enabled: boolean;
/** Type of the Google Analytics object. This is required if "is_analytics_tracking_enabled" is true */
analytics_object_type: "gaq" | "datalayer" | "ga-send" | "custom" | null;
/** This is required if "analytics_object_type" is "custom" */
analytics_custom_object: string | null;
/** Defines whether AJAX tracking is enabled */
is_ajax_tracking_enabled: boolean;
/** Defines whether the room only accepts signed visitor variables and chat widget URLs */
is_signature_required: boolean;
/** Date when the room settings were created */
created_at: string;
/** Date when the room settings were changed for the last time */
updated_at: string;
}
export interface OrganizationRoomSettingsPayload {
/** Unique identifier of the router that is used to route chats in the room */
router_id?: RouterUid | null;
/** Unique identifier of the brand that is used in the room. If null then the default theme is used */
brand_id?: BrandUid | null;
/** Defines whether pending visitor messages should be hidden in giosg console */
is_pending_chat_messages_hidden: boolean;
/**
* Defines whether the chat shall open in the same browser tab using the newer client. By default
* a legacy mobile chat client is used and the chat opens into a new browser tab
*/
is_mobile_chat_in_same_tab: boolean;
/** Defines whether Google Analytics tracking is enabled */
is_analytics_tracking_enabled: boolean;
/** Type of the Google Analytics object. This is required if "is_analytics_tracking_enabled" is true */
analytics_object_type?: "gaq" | "datalayer" | "ga-send" | "custom";
/** This is required if analytics_object_type is custom */
analytics_custom_object?: string;
/** Defines whether AJAX tracking is enabled */
is_ajax_tracking_enabled: boolean;
/** Defines whether the room only accepts signed visitor variables and chat widget URLs */
is_signature_required?: boolean;
/** Unique identifier of the router that is used to route chats in the room */
router_id?: RouterUid | null;
/** Unique identifier of the brand that is used in the room. If null then the default theme is used */
brand_id?: BrandUid | null;
/** Defines whether pending visitor messages should be hidden in giosg console */
is_pending_chat_messages_hidden: boolean;
/**
* Defines whether the chat shall open in the same browser tab using the newer client. By default
* a legacy mobile chat client is used and the chat opens into a new browser tab
*/
is_mobile_chat_in_same_tab: boolean;
/** Defines whether Google Analytics tracking is enabled */
is_analytics_tracking_enabled: boolean;
/** Type of the Google Analytics object. This is required if "is_analytics_tracking_enabled" is true */
analytics_object_type?: "gaq" | "datalayer" | "ga-send" | "custom";
/** This is required if analytics_object_type is custom */
analytics_custom_object?: string;
/** Defines whether AJAX tracking is enabled */
is_ajax_tracking_enabled: boolean;
/** Defines whether the room only accepts signed visitor variables and chat widget URLs */
is_signature_required?: boolean;
}
export interface RoomAllowedDomainLink {
/** Unique identifier of the organization who owns the domain link */
organization_id: OrganizationUid;
/** Organization who owns the domain link */
organization: NestedOrganization;
/** Unique identifier of the room which has access to the domain link */
room_id: RoomUid;
/** Room which has access to the domain link */
room: NestedRoom;
/** Unique identifier of the domain room */
domain_room_id: RoomUid;
/** Domain room */
domain_room: NestedRoom;
/** Date when the domain link was created */
created_at: string;
/** Date when the domain link was changed for the last time */
updated_at: string;
/** Unique identifier of the organization who owns the domain link */
organization_id: OrganizationUid;
/** Organization who owns the domain link */
organization: NestedOrganization;
/** Unique identifier of the room which has access to the domain link */
room_id: RoomUid;
/** Room which has access to the domain link */
room: NestedRoom;
/** Unique identifier of the domain room */
domain_room_id: RoomUid;
/** Domain room */
domain_room: NestedRoom;
/** Date when the domain link was created */
created_at: string;
/** Date when the domain link was changed for the last time */
updated_at: string;
}
export interface RoomAllowedDomainLinkPayload {
/** Unique identifier of the domain room */
domain_room_id: RoomUid;
/** Unique identifier of the domain room */
domain_room_id: RoomUid;
}

@@ -110,104 +102,105 @@ /**

export interface RoomCreate {
/** Unique identifier of the room */
id: RoomUid;
/** Name of the room */
name: string;
/** Display name of the room. It may be equal to the name attribute, unless the room is shared */
display_name: string;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain: string | null;
/** Legacy signed unique identifier of the room. Deprecated, use an id attribute instead */
token: RoomLegacyToken;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code: LanguageCode;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
/** Unique identifier of the user who changed the room for the last time, or null if unknown */
updated_by_user_id: UserUid;
/** User who changed the room for the last time, or null if unknown */
updated_by_user: NestedUser;
/** Date when the room was created */
created_at: string;
/** Date when the room was changed for the last time*/
updated_at: string;
/**
* 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;
/**
* Defines whether the room exists no more. The resource exists only for historical purposes and
* cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the room is shared to your organization */
is_shared: boolean;
/** Defines whether the room has service hours enabled */
is_service_hours_enabled: boolean;
/**
* Defines whether the room is currently open, i.e. currently in service hours if the room has service
* hours enabled. By default always true
*/
is_open: boolean;
/** Unique identifier of the room */
id: RoomUid;
/** Name of the room */
name: string;
/** Display name of the room. It may be equal to the name attribute, unless the room is shared */
display_name: string;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain: string | null;
/** Legacy signed unique identifier of the room. Deprecated, use an id attribute instead */
token: RoomLegacyToken;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code: LanguageCode;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
/** Unique identifier of the user who changed the room for the last time, or null if unknown */
updated_by_user_id: UserUid;
/** User who changed the room for the last time, or null if unknown */
updated_by_user: NestedUser;
/** Date when the room was created */
created_at: string;
/** Date when the room was changed for the last time*/
updated_at: string;
/**
* 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;
/**
* Defines whether the room exists no more. The resource exists only for historical purposes and
* cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the room is shared to your organization */
is_shared: boolean;
/** Defines whether the room has service hours enabled */
is_service_hours_enabled: boolean;
/**
* Defines whether the room is currently open, i.e. currently in service hours if the room has service
* hours enabled. By default always true
*/
is_open: boolean;
}
export interface RoomCreatePayload {
/** Name of the room */
name: string;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain?: string | null;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code?: LanguageCode;
/** Name of the room */
name: string;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain?: string | null;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code?: LanguageCode;
}
export interface Room {
/** Unique identifier of the room */
id: RoomUid;
/** Name of the room */
name: string;
/** Display name of the room. It may be equal to the name attribute, unless the room is shared */
display_name: string;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain: string | null;
/** Legacy signed unique identifier of the room. Deprecated, use an id attribute instead */
token: RoomLegacyToken;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code: LanguageCode;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
/** Unique identifier of the user who changed the room for the last time, or null if unknown*/
updated_by_user_id: UserUid;
/** User who changed the room for the last time, or null if unknown */
updated_by_user: NestedUser;
/** Date when the room was created */
created_at: string;
/** Date when the room was changed for the last time */
updated_at: string;
/**
* 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;
/**
* Defines whether the room exists no more. The resource exists only for historical purposes and
* cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the room is shared to your organization */
is_shared: boolean;
/** Defines whether the room has service hours enabled */
is_service_hours_enabled: boolean;
/**
* Defines whether the room is currently open, i.e. currently in service hours if the room has service
* hours enabled. By default always true
*/
is_open: boolean;
/** Unique identifier of the room */
id: RoomUid;
/** Name of the room */
name: string;
/** Display name of the room. It may be equal to the name attribute, unless the room is shared */
display_name: string;
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
domain: string | null;
/** Legacy signed unique identifier of the room. Deprecated, use an id attribute instead */
token: RoomLegacyToken;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code: LanguageCode;
/** Unique identifier of the organization that owns the room */
organization_id: OrganizationUid;
/** Organization that owns the room */
organization: NestedOrganization;
/** Unique identifier of the user who changed the room for the last time, or null if unknown*/
updated_by_user_id: UserUid;
/** User who changed the room for the last time, or null if unknown */
updated_by_user: NestedUser;
/** Date when the room was created */
created_at: string;
/** Date when the room was changed for the last time */
updated_at: string;
/**
* 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;
/**
* Defines whether the room exists no more. The resource exists only for historical purposes and
* cannot be used in any other context
*/
is_deleted: boolean;
/** Defines whether the room is shared to your organization */
is_shared: boolean;
/** Defines whether the room has service hours enabled */
is_service_hours_enabled: boolean;
/**
* Defines whether the room is currently open, i.e. currently in service hours if the room has service
* hours enabled. By default always true
*/
is_open: boolean;
}
export interface RoomPayload {
/** Name of the room */
name: string;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code?: LanguageCode;
/** Name of the room */
name: string;
/** Language of the room as a RFC 3066 code. Defaults to en */
language_code?: LanguageCode;
}
//# sourceMappingURL=rooms.d.ts.map

0

lib/rooms.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

407

lib/rules.d.ts
import { NestedGoal } from "./goals";
import { NestedOrganization, NestedUser } from "./customer";
import { NestedRoom } from "./rooms";
import {
RuleUid,
OrganizationUid,
RoomUid,
GoalUid,
UserUid,
RuleConditionUid,
RuleActionUid,
} from "./types";
import { RuleUid, OrganizationUid, RoomUid, GoalUid, UserUid, RuleConditionUid, RuleActionUid } from "./types";
import { ConditionType, ConditionSettingsType } from "./conditions";
import { ActionType, ActionSettingsType } from "./actions";
export interface ExperimentRuleCondition {
/** Unique identifier of the rule condition */
id: RuleConditionUid;
/** Together with other conditions’ indices, defines the order in which the conditions are matched in the rule. Set automatically from the order of the conditions array */
index: number;
/** Defines whether the default or opposite match type shall be used */
is_opposite: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value: string | null;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
/** Unique identifier of the rule condition */
id: RuleConditionUid;
/** Together with other conditions’ indices, defines the order in which the conditions are matched in the rule. Set automatically from the order of the conditions array */
index: number;
/** Defines whether the default or opposite match type shall be used */
is_opposite: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value: string | null;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
}
export interface ExperimentRuleConditionPayload {
/** Defines whether the default or opposite match type shall be used */
is_opposite?: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value?: string | null;
/** Other condition settings. Required with some condition types */
settings?: ConditionSettingsType;
/** Defines whether the default or opposite match type shall be used */
is_opposite?: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value?: string | null;
/** Other condition settings. Required with some condition types */
settings?: ConditionSettingsType;
}
export interface ExperimentRule {
/** Unique identifier of the rule */
id: RuleUid;
/** Name of the rule */
name: string;
/** Organization that owns the rule */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the rule */
organization_id: OrganizationUid;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions: ExperimentRuleCondition[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleAction[];
/** A list of rooms where the rule can be triggered. Can only be set if "is_global" is false */
rooms: NestedRoom[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids: RoomUid[];
/** The goal set for the rule */
goal: NestedGoal;
/** Unique identifier of the goal set for the rule */
goal_id: GoalUid;
/** Type of the rule */
type: "experiment";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per: "session" | "page" | "visitor" | null;
/** Defines whether the rule was created automatically instead of being created from the Rule management UI */
is_auto_generated: boolean;
/** Defines whether the rule is protected and cannot be deleted */
is_protected: boolean;
/** Defines whether the rule is currently enabled */
is_enabled: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global: boolean;
/** Date when the rule was created */
created_at: string;
/** Date when the rule was changed for the last time */
updated_at: string;
/** User who created the rule*/
created_by_user: NestedUser;
/** Unique identifier of the user who created the rule */
created_by_user_id: UserUid;
/** User who changed the rule for the last time */
updated_by_user: NestedUser;
/** Unique identifier of the user who changed the rule for the last time */
updated_by_user_id: UserUid;
/** Unique identifier of the rule */
id: RuleUid;
/** Name of the rule */
name: string;
/** Organization that owns the rule */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the rule */
organization_id: OrganizationUid;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions: ExperimentRuleCondition[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleAction[];
/** A list of rooms where the rule can be triggered. Can only be set if "is_global" is false */
rooms: NestedRoom[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids: RoomUid[];
/** The goal set for the rule */
goal: NestedGoal;
/** Unique identifier of the goal set for the rule */
goal_id: GoalUid;
/** Type of the rule */
type: "experiment";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per: "session" | "page" | "visitor" | null;
/** Defines whether the rule was created automatically instead of being created from the Rule management UI */
is_auto_generated: boolean;
/** Defines whether the rule is protected and cannot be deleted */
is_protected: boolean;
/** Defines whether the rule is currently enabled */
is_enabled: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global: boolean;
/** Date when the rule was created */
created_at: string;
/** Date when the rule was changed for the last time */
updated_at: string;
/** User who created the rule*/
created_by_user: NestedUser;
/** Unique identifier of the user who created the rule */
created_by_user_id: UserUid;
/** User who changed the rule for the last time */
updated_by_user: NestedUser;
/** Unique identifier of the user who changed the rule for the last time */
updated_by_user_id: UserUid;
}
export interface ExperimentRulePayload {
/** Name of the rule */
name: string;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions?: ExperimentRuleCondition[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleAction[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids?: RoomUid[];
/** Unique identifier of the goal set for the rule */
goal_id?: GoalUid;
/** Type of the rule */
type?: "experiment";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per?: "session" | "page" | "visitor" | null;
/** Defines whether the rule is currently enabled */
is_enabled?: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global?: boolean;
/** Name of the rule */
name: string;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions?: ExperimentRuleConditionPayload[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleActionPayload[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids?: RoomUid[];
/** Unique identifier of the goal set for the rule */
goal_id?: GoalUid;
/** Type of the rule */
type?: "experiment";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per?: "session" | "page" | "visitor" | null;
/** Defines whether the rule is currently enabled */
is_enabled?: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global?: boolean;
}
export interface RuleAction {
/** Unique identifier of the rule action */
id: RuleActionUid;
/** Together with other actions’ indices, defines the order in which the actions are executed in the rule. Set automatically from the order of the conditions array */
index: number;
/** Type of the action */
type: ActionType;
/** The value related to the type. Required with most types */
value: string | null;
/** Other action settings. Required with some action types */
settings: ActionSettingsType;
/** Unique identifier of the rule action */
id: RuleActionUid;
/** Together with other actions’ indices, defines the order in which the actions are executed in the rule. Set automatically from the order of the conditions array */
index: number;
/** Type of the action */
type: ActionType;
/** The value related to the type. Required with most types */
value: string | null;
/** Other action settings. Required with some action types */
settings: ActionSettingsType;
}
export interface RuleActionPayload {
/** Type of the action */
type: ActionType;
/** The value related to the type. Required with most types */
value?: string | null;
/** Other action settings. Required with some action types */
settings?: ActionSettingsType;
/** Type of the action */
type: ActionType;
/** The value related to the type. Required with most types */
value?: string | null;
/** Other action settings. Required with some action types */
settings?: ActionSettingsType;
}
export interface RuleCondition {
/** Unique identifier of the rule */
id: RuleConditionUid;
/** Together with other conditions’ indices, defines the order in which the conditions are matched in the rule. Set automatically from the order of the conditions array */
index: number;
/** Defines whether the default or opposite match type shall be used */
is_opposite: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value: string | null;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
/** Unique identifier of the rule */
id: RuleConditionUid;
/** Together with other conditions’ indices, defines the order in which the conditions are matched in the rule. Set automatically from the order of the conditions array */
index: number;
/** Defines whether the default or opposite match type shall be used */
is_opposite: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value: string | null;
/** Other condition settings. Required with some condition types */
settings: ConditionSettingsType;
}
export interface RuleConditionPayload {
/** Defines whether the default or opposite match type shall be used */
is_opposite?: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value?: string | null;
/** Other condition settings. Required with some condition types */
settings?: ConditionSettingsType;
/** Defines whether the default or opposite match type shall be used */
is_opposite?: boolean;
/** Type of the condition */
type: ConditionType;
/** The value related to the type. Required with most types */
value?: string | null;
/** Other condition settings. Required with some condition types */
settings?: ConditionSettingsType;
}
export interface Rule {
/** Unique identifier of the rule */
id: RuleUid;
/** Name of the rule */
name: string;
/** Organization that owns the rule */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the rule */
organization_id: OrganizationUid;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions: RuleCondition[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleAction[];
/** A list of rooms where the rule can be triggered. Can only be set if "is_global" is false */
rooms: NestedRoom[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids: RoomUid[];
/** The goal set for the rule */
goal: NestedGoal;
/** Unique identifier of the goal set for the rule */
goal_id: GoalUid;
/** Type of the rule */
type: "normal" | "target";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per: "session" | "page" | "visitor" | null;
/** Defines whether the rule was created automatically instead of being created from the rule management UI */
is_auto_generated: boolean;
/** Defines whether the rule is protected and cannot be deleted */
is_protected: boolean;
/** Defines whether the rule is currently enabled */
is_enabled: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global: boolean;
/** Date when the rule was created */
created_at: string;
/** Date when the rule was changed for the last time */
updated_at: string;
/** User who created the rule*/
created_by_user: NestedUser;
/** Unique identifier of the user who created the rule*/
created_by_user_id: UserUid;
/** User who changed the rule for the last time*/
updated_by_user: NestedUser;
/** Unique identifier of the user who changed the rule for the last time*/
updated_by_user_id: UserUid;
/** Unique identifier of the rule */
id: RuleUid;
/** Name of the rule */
name: string;
/** Organization that owns the rule */
organization: NestedOrganization;
/** Unique identifier of the organization that owns the rule */
organization_id: OrganizationUid;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions: RuleCondition[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleAction[];
/** A list of rooms where the rule can be triggered. Can only be set if "is_global" is false */
rooms: NestedRoom[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids: RoomUid[];
/** The goal set for the rule */
goal: NestedGoal;
/** Unique identifier of the goal set for the rule */
goal_id: GoalUid;
/** Type of the rule */
type: "normal" | "target" | "experiment";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per: "session" | "page" | "visitor" | null;
/** Defines whether the rule was created automatically instead of being created from the rule management UI */
is_auto_generated: boolean;
/** Defines whether the rule is protected and cannot be deleted */
is_protected: boolean;
/** Defines whether the rule is currently enabled */
is_enabled: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global: boolean;
/** Date when the rule was created */
created_at: string;
/** Date when the rule was changed for the last time */
updated_at: string;
/** User who created the rule*/
created_by_user: NestedUser;
/** Unique identifier of the user who created the rule*/
created_by_user_id: UserUid;
/** User who changed the rule for the last time*/
updated_by_user: NestedUser;
/** Unique identifier of the user who changed the rule for the last time*/
updated_by_user_id: UserUid;
}
export interface RulePayload {
/** Name of the rule */
name: string;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions?: RuleConditionPayload[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleActionPayload[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids?: RoomUid[];
/** Unique identifier of the goal set for the rule */
goal_id?: GoalUid;
/** Type of the rule */
type?: "normal" | "target";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per?: "session" | "page" | "visitor" | null;
/** Defines whether the rule is currently enabled */
is_enabled?: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global?: boolean;
/** Name of the rule */
name: string;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions?: RuleConditionPayload[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions: RuleActionPayload[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids?: RoomUid[];
/** Unique identifier of the goal set for the rule */
goal_id?: GoalUid;
/** Type of the rule */
type?: "normal" | "target";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per?: "session" | "page" | "visitor" | null;
/** Defines whether the rule is currently enabled */
is_enabled?: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global?: boolean;
}
export interface RuleUpdatePayload {
/** Name of the rule */
name?: string;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions?: RuleConditionPayload[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions?: RuleActionPayload[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids?: RoomUid[];
/** Unique identifier of the goal set for the rule */
goal_id?: GoalUid;
/** Type of the rule */
type?: "normal" | "target";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per?: "session" | "page" | "visitor" | null;
/** Defines whether the rule is currently enabled */
is_enabled?: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global?: boolean;
/** Name of the rule */
name?: string;
/** Ordered list of conditions of the rule. The list order defines the matching order */
conditions?: RuleConditionPayload[];
/** Ordered list of actions of the rule. The list order defines the execution order */
actions?: RuleActionPayload[];
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
room_ids?: RoomUid[];
/** Unique identifier of the goal set for the rule */
goal_id?: GoalUid;
/** Type of the rule */
type?: "normal" | "target";
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
match_once_per?: "session" | "page" | "visitor" | null;
/** Defines whether the rule is currently enabled */
is_enabled?: boolean;
/** Defines whether the rule can be triggered in all of the organization’s rooms */
is_global?: boolean;
}
//# sourceMappingURL=rules.d.ts.map

0

lib/rules.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

125

lib/types.d.ts
export declare type ApplicationUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type AssetUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type AvatarUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type BrandUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type BusinessUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatInvitationUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatMessageAttachmentUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatMessageAttachmentActionUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatMessageUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatReplySuggestionUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatSessionUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ExperimentGroupUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ExperimentUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type FeatureName = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type GoalUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type InteractionUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type OrganizationUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type OrganizationSettingsUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type QuotaUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RoomSettingsUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RoomUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RouterUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RuleActionUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RuleConditionUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RuleUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type TagUid = string & {
readonly __nominal: unique symbol;
};
export declare type TeamUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type TokenUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type UserUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};

@@ -94,78 +97,66 @@ /**

export declare type VisitorUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type UserClientUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type BlackListUid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type GiosgSessionId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type PackedVisitorCid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type VisitorGlobalSessionId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type VisitorGlobalId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type VisitorSessionId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type VisitorSecretId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type VisitorCid = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type UserLegacyId = number & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatLegacyId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type ChatUserLegacyId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type OrganizationLegacyId = number & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RoomLegacyId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RuleLegacyId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type VisitorLegacyId = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare type RoomLegacyToken = string & {
readonly __nominal: unique symbol;
readonly __nominal: unique symbol;
};
export declare const ASSET_TYPES: readonly ["image", "css", "javascript", "font"];
export declare type AssetType = typeof ASSET_TYPES[number];
export declare const EXPERIMENT_GROUP_TYPES: readonly [
"target_algorithm",
"target_algorithm_beta1",
"target_algorithm_beta2",
"target_algorithm_beta3",
"target_random",
"control",
"user_defined",
];
export declare const EXPERIMENT_GROUP_TYPES: readonly ["target_algorithm", "target_algorithm_beta1", "target_algorithm_beta2", "target_algorithm_beta3", "target_random", "control", "user_defined"];
export declare type ExperimentGroupType = typeof EXPERIMENT_GROUP_TYPES[number];
export declare const CHAT_MESSAGE_TYPES: readonly [
"msg",
"autosuggest",
"join",
"leave",
"shoppingcart_locked",
"action",
"system",
];
export declare type ChatMessageType = typeof CHAT_MESSAGE_TYPES[number];
export declare const USER_PERMISSION_SCOPES: string[];
export declare const CHAT_STATUS_MESSAGE_TYPES: readonly ["join", "leave", "shoppingcart_locked", "action"];
export declare type ChatStatusMessageType = typeof CHAT_STATUS_MESSAGE_TYPES[number];
export declare const CHAT_DATA_MESSAGE_TYPES: readonly ["msg", "autosuggest", "system"];
export declare type ChatDataMessageType = typeof CHAT_DATA_MESSAGE_TYPES[number];
export declare type ChatMessageType = ChatStatusMessageType | ChatDataMessageType;
export declare const USER_PERMISSION_SCOPES: readonly ["settings", "reports", "users"];
export declare type UserPermissionScope = typeof USER_PERMISSION_SCOPES[number];
//# sourceMappingURL=types.d.ts.map

28

lib/types.js

@@ -6,19 +6,17 @@ "use strict";

exports.EXPERIMENT_GROUP_TYPES = [
"target_algorithm",
"target_algorithm_beta1",
"target_algorithm_beta2",
"target_algorithm_beta3",
"target_random",
"control",
"user_defined"
"target_algorithm",
"target_algorithm_beta1",
"target_algorithm_beta2",
"target_algorithm_beta3",
"target_random",
"control",
"user_defined",
];
exports.CHAT_MESSAGE_TYPES = [
"msg",
"autosuggest",
"join",
"leave",
"shoppingcart_locked",
"action",
"system"
exports.CHAT_STATUS_MESSAGE_TYPES = [
"join",
"leave",
"shoppingcart_locked",
"action",
];
exports.CHAT_DATA_MESSAGE_TYPES = ["msg", "autosuggest", "system"];
exports.USER_PERMISSION_SCOPES = ["settings", "reports", "users"];

85

lib/userclients.d.ts

@@ -30,46 +30,47 @@ import { UserClientUid } from "./types";

export interface UserClient {
/** An unique identifier for the client, generated by the system. */
id: UserClientUid;
/** The number of seconds the system should keep this client present.
* Only the latest provided value applies for the client. */
presence_expires_in: number;
/**
* When the client will expire (or has expired), calculated
* from presence_expires_in. If this is in the past, then
* the client is not considered present.
*
* The presence_expires_in defines how often you need to
* refresh the client’s presence status. Longer timeout allows you
* to make less refresh requests. On the other hand, with longer
* timeouts it takes longer to notice that your client has been closed,
* shut down, or disconnected from the network. We recommend shorter
* timeouts for browsers (e.g. 60 seconds) and longer timeouts for mobile apps.
*/
presence_expires_at: string;
/**
* Probably equals to `presence_expires_in > 0`
*/
is_present: boolean | null;
/** Whether or not this user client is about to expire soon.
* This becomes false when creating/refreshing a user client,
* and will later change to true. This can be used to implement
* “server-side pinging”, see below. */
is_about_to_expire: boolean;
/** This attribute is deprecated and will be dropped soon. */
gcm_token: string | null;
/** @deprecated This attribute is deprecated and will be dropped soon. */
subscribed_channels: string[];
/** When the user client resource was created. */
created_at: string;
/** When the user client resource was updated last time. */
updated_at: string;
/** An unique identifier for the client, generated by the system. */
id: UserClientUid;
/** The number of seconds the system should keep this client present.
* Only the latest provided value applies for the client. */
presence_expires_in: number;
/**
* When the client will expire (or has expired), calculated
* from presence_expires_in. If this is in the past, then
* the client is not considered present.
*
* The presence_expires_in defines how often you need to
* refresh the client’s presence status. Longer timeout allows you
* to make less refresh requests. On the other hand, with longer
* timeouts it takes longer to notice that your client has been closed,
* shut down, or disconnected from the network. We recommend shorter
* timeouts for browsers (e.g. 60 seconds) and longer timeouts for mobile apps.
*/
presence_expires_at: string;
/**
* Probably equals to `presence_expires_in > 0`
*/
is_present: boolean | null;
/** Whether or not this user client is about to expire soon.
* This becomes false when creating/refreshing a user client,
* and will later change to true. This can be used to implement
* “server-side pinging”, see below. */
is_about_to_expire: boolean;
/** This attribute is deprecated and will be dropped soon. */
gcm_token: string | null;
/** @deprecated This attribute is deprecated and will be dropped soon. */
subscribed_channels: string[];
/** When the user client resource was created. */
created_at: string;
/** When the user client resource was updated last time. */
updated_at: string;
}
export interface UserClientPayload {
/** The number of seconds the system should keep this client present.
* Only the latest provided value applies for the client. */
presence_expires_in: number;
/** This attribute is deprecated and will be dropped soon. */
gcm_token?: string;
/** @deprecated This attribute is deprecated and will be dropped soon. */
subscribed_channels?: string[];
/** The number of seconds the system should keep this client present.
* Only the latest provided value applies for the client. */
presence_expires_in: number;
/** This attribute is deprecated and will be dropped soon. */
gcm_token?: string;
/** @deprecated This attribute is deprecated and will be dropped soon. */
subscribed_channels?: string[];
}
//# sourceMappingURL=userclients.d.ts.map

0

lib/userclients.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

333

lib/visitor.d.ts

@@ -9,32 +9,32 @@ import { NestedUser } from "./customer";

export interface BlackList {
/** ID of the ban object. */
id: BlackListUid;
/** ID of the visitor. */
visitor_id: VisitorCid;
/** ID of the chat’s room. */
room_id: RoomUid;
/** ID of the blocker. */
created_by_user_id: UserUid;
/** The user info of the blocker as an object. */
created_by_user: NestedUser;
/** When the ban was created. */
created_at: string;
/** When the ban ends at. */
ends_at: string;
/** Duration of the ban. This must be a positive integer which represents ban duration in seconds. */
duration: number;
/** Reason why the visitor was added to the blacklist. */
reason: string | null;
/** IP address of the visitor */
ip_address: string;
/** Is visitor’s IP address banned. */
is_ip_address_banned: boolean;
/** ID of the ban object. */
id: BlackListUid;
/** ID of the visitor. */
visitor_id: VisitorCid;
/** ID of the chat’s room. */
room_id: RoomUid;
/** ID of the blocker. */
created_by_user_id: UserUid;
/** The user info of the blocker as an object. */
created_by_user: NestedUser;
/** When the ban was created. */
created_at: string;
/** When the ban ends at. */
ends_at: string;
/** Duration of the ban. This must be a positive integer which represents ban duration in seconds. */
duration: number;
/** Reason why the visitor was added to the blacklist. */
reason: string | null;
/** IP address of the visitor */
ip_address: string;
/** Is visitor’s IP address banned. */
is_ip_address_banned: boolean;
}
export interface BlackListPayload {
/** Duration of the ban. This must be a positive integer which represents ban duration in seconds. */
duration: number;
/** Reason why the visitor was added to the blacklist. */
reason?: string;
/** Is visitor’s IP address banned. */
is_ip_address_banned?: boolean;
/** Duration of the ban. This must be a positive integer which represents ban duration in seconds. */
duration: number;
/** Reason why the visitor was added to the blacklist. */
reason?: string;
/** Is visitor’s IP address banned. */
is_ip_address_banned?: boolean;
}

@@ -45,6 +45,6 @@ /**

export interface CartLockedResponse {
cart_id: string;
total_value: string;
total_subscription_value: string;
currency: string;
cart_id: string;
total_value: string;
total_subscription_value: string;
currency: string;
}

@@ -55,23 +55,23 @@ /**

export interface RoomVisitorPageView {
/** When the visitor visited the page. */
created_at: string;
/**
* Unique identifier for the visitor.
* This is the same for the same visitor regardless of the room from which the visitor was requested. */
visitor_id: VisitorCid;
/** ID of the room from which this room visitor page view resource was requested. */
room_id: RoomUid;
/**
* @todo: What type of session it is?
*
* In which session the visitor visited the page.
*/
session_id: GiosgSessionId;
/** Title of the web page at which the visitor visited.
*/
page_title: string;
/** URL of the web page at which the visitor visited. */
page_url: string;
/** Canonical URL of the web page at which the visitor visited. */
canonical_page_url: string;
/** When the visitor visited the page. */
created_at: string;
/**
* Unique identifier for the visitor.
* This is the same for the same visitor regardless of the room from which the visitor was requested. */
visitor_id: VisitorCid;
/** ID of the room from which this room visitor page view resource was requested. */
room_id: RoomUid;
/**
* @todo: What type of session it is?
*
* In which session the visitor visited the page.
*/
session_id: GiosgSessionId;
/** Title of the web page at which the visitor visited.
*/
page_title: string;
/** URL of the web page at which the visitor visited. */
page_url: string;
/** Canonical URL of the web page at which the visitor visited. */
canonical_page_url: string;
}

@@ -86,115 +86,116 @@ /**

export interface RoomVisitor {
/** Unique identifier for the visitor. This is the same for the same visitor regardless of the room from which the visitor was requested. */
id: VisitorCid;
/** ID of the room from which this room visitor resource was requested */
room_id: RoomUid;
/** Whether or not the visitor is currently present in the room */
is_present: boolean;
/**
* @todo: What type of session it is?
*
* Identifier for the latest session for the visitor in this room */
session_id: GiosgSessionId;
/** The latest priority of the visitor as set explicitly with rules. It may be null if the visitor has not been prioritized with rules. */
explicit_priority: number | null;
/** The latest priority automatically calculated for the visitor. */
implicit_priority: number;
/** During how many distinct sessions the visitor has been active on this room. */
visit_count: number;
/** Either desktop, mobile or tablet */
device_type: "desktop" | "mobile" | "tablet";
/** The width resolution of the visitor’s screen in pixels */
device_screen_width: number;
/** The height resolution of the visitor’s screen in pixels */
device_screen_height: number;
/** Name of the browser which the visitor is currently using, without any version number. */
browser_name: string;
/** Version of the browser which the visitor is currently using. */
browser_version: string;
/** The preferred languages of the visitor as sent by the browser as the Accept-Language HTTP header.
* E.g. fi-FI,fi;q=0.8,en-US;q=0.6,en;q=0.4.
* In most cases it is more convenient to use preferred_language_code instead. */
browser_language: string;
/** The ISO code of the most preferred language of the visitor, e.g. fi or en-US */
preferred_language_code: LanguageCode;
/** Name of the operating system which the visitor is using, without any version number. */
os_name: string;
/** Version of the operating system which the visitor is using */
os_version: string;
/** User-Agent header of the visitor browser */
user_agent: string;
/** IP address of the visitor (IPv4) */
ip_address: string;
/** An organization name resolved from the IP address */
ip_organization: string;
/** The best guess about the name of the city where the visitor is currently located. This is usually resolved from their IP address. */
geo_city: string;
/** The best guess about the country where the visitor is currently located.
* This is usually resolved from their IP address. This is a upper-case, two-letter ISO 3166-1 country code */
geo_country_code: string;
/** The country as in country_code, but represented as the name of the country. */
geo_country: string;
/** The full URL from which the visitor entered the room during this session */
referrer_url: string;
/** Hostname from which the visitor entered the room during this session */
referrer_url_hostname: string;
/** Either internal, search, email, social, or website */
referrer_medium: "internal" | "search" | "email" | "social" | "website";
/** The name of the referrer source */
referrer_source: string;
/** The full URL from which the visitor originally entered the room */
original_referrer_url: string;
/** Hostname from which the visitor originally entered the room */
original_referrer_url_hostname: string;
/** Either internal, search, email, social, or website */
original_referrer_medium: "internal" | "search" | "email" | "social" | "website";
/** The name of the original referrer source */
original_referrer_source: string;
/** URL of the web page at which the visitor is currently, at this room. */
page_url: string;
/** Title of the web page at which the visitor is currently, at this room. */
page_title: string;
/** Canonical URL of the web page at which the visitor is currently, at this room. Same than page_url if no canonical URL is available. */
canonical_page_url: string;
/** When the latest session of the visitor has started at this particular room. */
session_started_at: string;
/**
* When the information of the room visitor was updated last time.
* In practice, this means when we have heard about the visitor last time at this particular room. */
updated_at: string;
/**
* An estimated duration of the visitor’s session at the moment,
* in seconds, possibly with fractions. This is equivalent to the
* difference between session_started_at and updated_at.
*/
session_duration: number;
/**
* The currency of the visitor’s shopping cart in the room,
* if the visitor has any, otherwise null. Currency is a upper-case ISO 4217 currency code, e.g. EUR.
*/
shopping_cart_currency: Currency;
/** The total value of the visitor’s shopping cart in the room,
* if the visitor has any. Value null means the shopping cart is not defined.
* The value is presented as a decimal string, e.g. 59.00 in the currency defined by shopping_cart_currency. */
shopping_cart_total_value: string | null;
/** The total monthly subscription value of the visitor’s shopping cart in the room,
* if the visitor has any. Value null means the shopping cart is not defined.
* The value is presented as a decimal string, e.g. 59.00 in the currency
* defined by shopping_cart_currency and per month. */
shopping_cart_total_subscription_value: string | null;
/**
* When the visitor checked out their shopping cart in this room.
* It is null if the cart is not yet checked out or the cart is not defined.
*/
shopping_cart_locked_at: string | null;
/** When the visitor was autosuggested in this room. It is null if the visitor was not autosuggested or the autosuggest happened over 5 minutes ago. */
session_autosuggested_at: string | null;
/** @deprecated */
pipeline_step_index: number;
/** @deprecated */
pipeline_step_name: string;
/** @deprecated */
pipeline_step_count: number;
/** @deprecated */
legacy_id: string;
/** Unique identifier for the visitor. This is the same for the same visitor regardless of the room from which the visitor was requested. */
id: VisitorCid;
/** ID of the room from which this room visitor resource was requested */
room_id: RoomUid;
/** Whether or not the visitor is currently present in the room */
is_present: boolean;
/**
* @todo: What type of session it is?
*
* Identifier for the latest session for the visitor in this room */
session_id: GiosgSessionId;
/** The latest priority of the visitor as set explicitly with rules. It may be null if the visitor has not been prioritized with rules. */
explicit_priority: number | null;
/** The latest priority automatically calculated for the visitor. */
implicit_priority: number;
/** During how many distinct sessions the visitor has been active on this room. */
visit_count: number;
/** Either desktop, mobile or tablet */
device_type: "desktop" | "mobile" | "tablet";
/** The width resolution of the visitor’s screen in pixels */
device_screen_width: number;
/** The height resolution of the visitor’s screen in pixels */
device_screen_height: number;
/** Name of the browser which the visitor is currently using, without any version number. */
browser_name: string;
/** Version of the browser which the visitor is currently using. */
browser_version: string;
/** The preferred languages of the visitor as sent by the browser as the Accept-Language HTTP header.
* E.g. fi-FI,fi;q=0.8,en-US;q=0.6,en;q=0.4.
* In most cases it is more convenient to use preferred_language_code instead. */
browser_language: string;
/** The ISO code of the most preferred language of the visitor, e.g. fi or en-US */
preferred_language_code: LanguageCode;
/** Name of the operating system which the visitor is using, without any version number. */
os_name: string;
/** Version of the operating system which the visitor is using */
os_version: string;
/** User-Agent header of the visitor browser */
user_agent: string;
/** IP address of the visitor (IPv4) */
ip_address: string;
/** An organization name resolved from the IP address */
ip_organization: string;
/** The best guess about the name of the city where the visitor is currently located. This is usually resolved from their IP address. */
geo_city: string;
/** The best guess about the country where the visitor is currently located.
* This is usually resolved from their IP address. This is a upper-case, two-letter ISO 3166-1 country code */
geo_country_code: string;
/** The country as in country_code, but represented as the name of the country. */
geo_country: string;
/** The full URL from which the visitor entered the room during this session */
referrer_url: string;
/** Hostname from which the visitor entered the room during this session */
referrer_url_hostname: string;
/** Either internal, search, email, social, or website */
referrer_medium: "internal" | "search" | "email" | "social" | "website";
/** The name of the referrer source */
referrer_source: string;
/** The full URL from which the visitor originally entered the room */
original_referrer_url: string;
/** Hostname from which the visitor originally entered the room */
original_referrer_url_hostname: string;
/** Either internal, search, email, social, or website */
original_referrer_medium: "internal" | "search" | "email" | "social" | "website";
/** The name of the original referrer source */
original_referrer_source: string;
/** URL of the web page at which the visitor is currently, at this room. */
page_url: string;
/** Title of the web page at which the visitor is currently, at this room. */
page_title: string;
/** Canonical URL of the web page at which the visitor is currently, at this room. Same than page_url if no canonical URL is available. */
canonical_page_url: string;
/** When the latest session of the visitor has started at this particular room. */
session_started_at: string;
/**
* When the information of the room visitor was updated last time.
* In practice, this means when we have heard about the visitor last time at this particular room. */
updated_at: string;
/**
* An estimated duration of the visitor’s session at the moment,
* in seconds, possibly with fractions. This is equivalent to the
* difference between session_started_at and updated_at.
*/
session_duration: number;
/**
* The currency of the visitor’s shopping cart in the room,
* if the visitor has any, otherwise null. Currency is a upper-case ISO 4217 currency code, e.g. EUR.
*/
shopping_cart_currency: Currency;
/** The total value of the visitor’s shopping cart in the room,
* if the visitor has any. Value null means the shopping cart is not defined.
* The value is presented as a decimal string, e.g. 59.00 in the currency defined by shopping_cart_currency. */
shopping_cart_total_value: string | null;
/** The total monthly subscription value of the visitor’s shopping cart in the room,
* if the visitor has any. Value null means the shopping cart is not defined.
* The value is presented as a decimal string, e.g. 59.00 in the currency
* defined by shopping_cart_currency and per month. */
shopping_cart_total_subscription_value: string | null;
/**
* When the visitor checked out their shopping cart in this room.
* It is null if the cart is not yet checked out or the cart is not defined.
*/
shopping_cart_locked_at: string | null;
/** When the visitor was autosuggested in this room. It is null if the visitor was not autosuggested or the autosuggest happened over 5 minutes ago. */
session_autosuggested_at: string | null;
/** @deprecated */
pipeline_step_index: number;
/** @deprecated */
pipeline_step_name: string;
/** @deprecated */
pipeline_step_count: number;
/** @deprecated */
legacy_id: string;
}
//# sourceMappingURL=visitor.d.ts.map

0

lib/visitor.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });

11

package.json
{
"name": "@giosg/types",
"version": "1.2.15",
"version": "1.2.17",
"description": "TypeScript interfaces for GiosgAPI",

@@ -8,3 +8,3 @@ "main": "lib/index.js",

"test": "echo \"Error: no test specified\" && exit 1",
"build": "tsc"
"prepare": "tsc"
},

@@ -14,9 +14,10 @@ "files": [

],
"author": "RazgrizX",
"author": "Giosg",
"license": "MIT",
"devDependencies": {
"@types/node": "^12.7.1",
"prettier": "^1.18.2",
"typescript": "^3.5.3"
},
"peerDependencies": {
"typescript": "^3.5.3"
}
}

0

README.md

@@ -0,0 +0,0 @@ # giosg types

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc