@giosg/types - npm Package Compare versions

Comparing version 1.3.2 to 2.0.0

CHANGELOG.md

@@ -7,2 +7,13 @@ # Changelog
 
+## 2.0.0
+
+- Added new interfaces `GiosgAppInstance`, `GiosgApp`, `GiosgAppPayload`, `InstalledGiosgApp`, `NestedGiosgApp`, `Brand`, `BrandPayload`, `PublicBrand`, `CannedAnswerIncrement`,`CannedAnswer`, `CannedAnswerPayload`, `ChatAssignment`, `LeadFormData`, `LeadFormDataPayload` `AppShare`, `AppSharePayload`, `ShoppingCartProduct`, `ShoppingCart`, `EndpointMethod` `Endpoint`, `Language`, `NestedTargetRule`, `NestedTargetConfig`, `TargetConfig`, `TargetExperiment`, `TargetedAction`, `TargetedActionPayload`, `VisitorPredictionList`, `VisitorPrediction`, `VisitorPredictionPayload`, `VisitorSessionPrediction`, `VisitorSessionPredictionPayload`, `RoomVisitorVariable`, `RoomVisitorVariablePayload`, `NestedWebhookChannelSubscription`, `NestedWebhookChannelSubscriptionPayload`, `WebhookRequestLogEntry`, `Webhook`, `WebhookPayload`
+
+### Breaking changes:
+
+- Renamed `VisitorSessionId` to `VisitorSessionCid`.
+- Renamed `VisitorGlobalSessionId` to `VisitorSessionGid`.
+- Renamed `VisitorGlobalId` to `VisitorGid`.
+- Removed `GiosgSessionId`, it was duplicate of `VisitorGlobalSessionId`.
+
 ## 1.3.2
@@ -9,0 +20,0 @@

lib/actions.d.ts

@@ -0,0 +0,0 @@ import { UserUid } from "./types";

lib/actions.js

@@ -0,0 +0,0 @@ "use strict";

lib/assets.d.ts

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

lib/assets.js

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

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, ChatStatusMessageType, ChatDataMessageType } from "./types";
+import { UserUid, VisitorCid, RoomUid, ChatUid, UserLegacyId, OrganizationUid, ChatInvitationUid, TeamUid, ChatMessageUid, RuleUid, ChatReplySuggestionUid, ChatMessageAttachmentActionUid, ChatMessageAttachmentUid, RoomLegacyId, InteractionUid, ChatMessageType, ChatStatusMessageType, ChatDataMessageType, ChatSessionUid, ChatAssignmentUid } from "./types";
 import { LanguageCode } from "./common";
@@ -1024,3 +1024,3 @@ import { ActionStyle } from "./actions";
     /**
-     * Contains visitorCid if chat type is "visitor"
+     * Contains VisitorCid if chat type is "visitor"
      */
@@ -1033,3 +1033,25 @@ visitor_id: VisitorCid | null;
 }
+/** TODO: Add jsdocs and check nullability of fields */
+export interface ChatAssignment {
+    id: ChatAssignmentUid;
+    is_accepted: boolean;
+    is_expired: boolean;
+    invited_by_user_id: UserUid;
+    invited_by_user: NestedUser;
+    chat_id: ChatSessionUid;
+    room_id: RoomUid;
+    invited_user_id: UserUid | null;
+    invited_team_id: TeamUid | null;
+    invited_organization_id: OrganizationUid | null;
+    invitee_name: string;
+    accepted_by_user_id: UserUid | null;
+    accepted_by_user: NestedUser | null;
+    user_member_count: number;
+    visitor_member_count: number;
+    created_at: string;
+    updated_at: string;
+    accepted_at: string | null;
+    expired_at: string | null;
+}
 export {};
 //# sourceMappingURL=chat.d.ts.map

lib/chat.js

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

lib/common.d.ts

@@ -0,0 +0,0 @@ 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"];

lib/common.js

@@ -0,0 +0,0 @@ "use strict";

lib/conditions.d.ts

@@ -18,6 +18,4 @@ export declare const ConditionTypes: {
     readonly CART_SIZE_MORE_THAN: 8;
-    /**
-     * NOTE: no data, might be deprecated
-     * TODO: Confirm status, remove or add description
-     */
+    /** value: cart value as a float number with two decimals, settings: none */
+    readonly CART_SIZE_LESS_THAN: 9;
     /** value: product name as a string, settings: none */
@@ -29,6 +27,4 @@ readonly PRODUCT_NAMES_IN_CART: 10;
     readonly JS_FUNCTION_RETURNS_TRUE: 12;
-    /**
-     * NOTE: no data, might be deprecated
-     * TODO: Confirm status, remove or add description
-     */
+    /** value: visit count as an integer number, settings: none */
+    readonly VISIT_COUNT_LESS_THAN: 13;
     /** value: number of purchases as an integer number, settings: none */
@@ -54,6 +50,4 @@ readonly PURCHASE_COUNT_MORE_THAN: 14;
     readonly VISITOR_PRIORITY_MORE_THAN: 23;
-    /**
-     * NOTE: no data, might be deprecated
-     * TODO: Confirm status, remove or add description
-     */
+    /** value: priority value as an integer [1 - 10], settings: none */
+    readonly VISITOR_PRIORITY_LESS_THAN: 24;
     /** value: none, settings: none */
@@ -86,3 +80,3 @@ readonly VISITOR_TARGETED: 25;
 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" | "CART_SIZE_LESS_THAN" | "PRODUCT_NAMES_IN_CART" | "PIPELINE_STEP" | "JS_FUNCTION_RETURNS_TRUE" | "VISIT_COUNT_LESS_THAN" | "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_PRIORITY_LESS_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 {
@@ -89,0 +83,0 @@ timezone: string;

lib/conditions.js

@@ -20,7 +20,4 @@ "use strict";
     CART_SIZE_MORE_THAN: 8,
-    /**
-     * NOTE: no data, might be deprecated
-     * TODO: Confirm status, remove or add description
-     */
-    // CART_SIZE_LESS_THAN: 9,
+    /** value: cart value as a float number with two decimals, settings: none */
+    CART_SIZE_LESS_THAN: 9,
     /** value: product name as a string, settings: none */
@@ -32,7 +29,4 @@ PRODUCT_NAMES_IN_CART: 10,
     JS_FUNCTION_RETURNS_TRUE: 12,
-    /**
-     * NOTE: no data, might be deprecated
-     * TODO: Confirm status, remove or add description
-     */
-    // VISIT_COUNT_LESS_THAN: 13,
+    /** value: visit count as an integer number, settings: none */
+    VISIT_COUNT_LESS_THAN: 13,
     /** value: number of purchases as an integer number, settings: none */
@@ -58,7 +52,4 @@ PURCHASE_COUNT_MORE_THAN: 14,
     VISITOR_PRIORITY_MORE_THAN: 23,
-    /**
-     * NOTE: no data, might be deprecated
-     * TODO: Confirm status, remove or add description
-     */
-    // VISITOR_PRIORITY_LESS_THAN: 24,
+    /** value: priority value as an integer [1 - 10], settings: none */
+    VISITOR_PRIORITY_LESS_THAN: 24,
     /** value: none, settings: none */
@@ -65,0 +56,0 @@ VISITOR_TARGETED: 25,

lib/customer.d.ts

@@ -0,0 +0,0 @@ import { AvatarUid, OrganizationUid, UserUid, BusinessUid, OrganizationLegacyId, OrganizationSettingsUid, UserLegacyId, TokenUid, FeatureName, ChatUserLegacyId } from "./types";

lib/customer.js

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

lib/customership.d.ts

@@ -0,0 +0,0 @@ import { NestedOrganization } from "./customer";

lib/customership.js

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

lib/experiments.d.ts

@@ -0,0 +0,0 @@ import { ExperimentRule, ExperimentRulePayload } from "./rules";

lib/experiments.js

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

lib/goals.d.ts

@@ -0,0 +0,0 @@ import { NestedOrganization, NestedUser } from "./customer";

lib/goals.js

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

lib/index.d.ts

 export { ActionTypes, ActionType, ActionTypeString, ACTION_TYPES, ActionShowAutosuggestSettings, ActionSendChatMessageSettings, ActionSendInteractionToChatSettings, ActionSettingsType, ACTION_STYLES, ActionStyle, } from "./actions";
+export { GiosgAppInstance, GiosgAppTriggerCondition, GiosgApp, GiosgAppPayload, InstalledGiosgApp, NestedGiosgApp, } from "./apps";
 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, ChatType, Chat, ChatPayload, ChatSessionTag, ChatSessionTagPayload, DecryptedChatDataMessage, DecryptedChatStatusMessage, DecryptedChatMessage, DecryptedChatMessagePayload, NestedChatMessageAttachmentAction, NestedChatMessageAttachmentActionPayload, NestedChatMessageAttachment, NestedChatMessageAttachmentPayload, NestedChatMessageResponseAttachment, NestedChatMessageResponseAttachmentPayload, NestedChatReplySuggestion, OrganizationChatMembership, OrganizationChatMembershipPayload, RoomChatTag, RoomChatTagPayload, NestedChatMessage, BarChat, } from "./chat";
+export { Brand, BrandPayload, PublicBrand } from "./brands";
+export { CannedAnswerIncrement, CannedAnswer, CannedAnswerPayload } from "./canned_answers";
+export { ChatInvitationAccept, ChatInvitationAcceptPayload, ChatInvitationCreate, ChatInvitationExpire, ChatInvitationExpirePayload, ChatInvitation, ChatConversationStarter, ChatConversationStarterPayload, ChatConversationStarterUpdate, ChatConversationStarterUpdatePayload, ChatMembership, ChatMembershipPayload, ChatStatusMessage, ChatDataMessage, ChatMessage, ChatMessagePayload, ChatReplySuggestion, ChatReplySuggestionPayload, ChatType, Chat, ChatPayload, ChatSessionTag, ChatSessionTagPayload, DecryptedChatDataMessage, DecryptedChatStatusMessage, DecryptedChatMessage, DecryptedChatMessagePayload, NestedChatMessageAttachmentAction, NestedChatMessageAttachmentActionPayload, NestedChatMessageAttachment, NestedChatMessageAttachmentPayload, NestedChatMessageResponseAttachment, NestedChatMessageResponseAttachmentPayload, NestedChatReplySuggestion, OrganizationChatMembership, OrganizationChatMembershipPayload, RoomChatTag, RoomChatTagPayload, NestedChatMessage, BarChat, ChatAssignment, } from "./chat";
 export { TIMEZONES, Timezone, CURRENCIES, Currency, LANGUAGE_CODES, LanguageCode } from "./common";
@@ -10,2 +13,3 @@ export { ConditionTypes, ConditionType, ConditionTypeString, CONDITION_TYPES, ConditionWeeklyScheduleSettings, ConditionHasChattedSettings, ConditionSettingsType, } from "./conditions";
 export { GoalMatch, GoalMatchPayload, Goal, GoalPayload, GoalUpdatePayload, NestedGoalCondition, NestedGoalConditionPayload, NestedGoal, } from "./goals";
+export { LeadFormData, LeadFormDataPayload } from "./leadforms";
 export { LinkPreviewResponse, LinkPreviewResponseSuccess, LinkPreviewResponseError, } from "./linkpreview";
@@ -19,9 +23,13 @@ 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 { ExperimentRuleCondition, ExperimentRuleConditionPayload, ExperimentRule, ExperimentRulePayload, RuleAction, RuleActionPayload, RuleCondition, RuleConditionPayload, Rule, RulePayload, RuleUpdatePayload, } from "./rules";
-export { RoomSharePayload, OutgoingRoomShare, IncomingRoomShare } from "./sharing";
+export { AppShare, AppSharePayload, RoomSharePayload, OutgoingRoomShare, IncomingRoomShare, } from "./sharing";
+export { ShoppingCartProduct, ShoppingCart } from "./shoppingcarts";
+export { EndpointMethod, Endpoint, Language } from "./system";
+export { NestedTargetRule, TargetAlgorithmVersion, NestedTargetConfig, TargetConfig, TargetExperiment, TargetedAction, TargetedActionPayload, VisitorPredictionList, VisitorPrediction, VisitorPredictionPayload, VisitorSessionPrediction, VisitorSessionPredictionPayload, } from "./target";
 export { Team, NestedTeam, TeamPayload, TeamMembership, TeamMembershipPayload } from "./teams";
-export { ApplicationUid, AssetUid, AvatarUid, BrandUid, BusinessUid, ChatInvitationUid, ChatMessageAttachmentUid, ChatMessageAttachmentActionUid, ChatMessageUid, ChatReplySuggestionUid, ChatSessionUid, ChatUid, ExperimentGroupUid, ExperimentUid, FeatureName, GoalUid, InteractionUid, OrganizationUid, OrganizationSettingsUid, QuotaUid, RoomSettingsUid, RoomShareUid, RoomUid, RouterUid, RouterStepUid, RuleActionUid, RuleConditionUid, RuleUid, TagUid, TeamUid, TokenUid, UserUid, UploadUid, 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 { ApplicationUid, AppShareUid, AssetUid, AvatarUid, BrandUid, BusinessUid, CannedAnswerUid, ChatAssignmentUid, ChatInvitationUid, ChatMessageAttachmentUid, ChatMessageAttachmentActionUid, ChatMessageUid, ChatReplySuggestionUid, ChatSessionUid, ChatUid, ExperimentGroupUid, ExperimentUid, FeatureName, GiosgAppUid, GiosgAppInstanceUid, GoalUid, InteractionUid, LeadFormDataUid, LeadFormDefinitionUid, OrganizationUid, OrganizationSettingsUid, QuotaUid, RoomSettingsUid, RoomShareUid, RoomUid, RouterUid, RouterStepUid, RuleActionUid, RuleConditionUid, RuleUid, ShoppingCartUid, ShoppingCartProductUid, TagUid, TargetConfigUid, TeamUid, TokenUid, UserUid, UploadUid, VisitorPredictionUid, VisitorSessionPredictionUid, WebhookUid, VisitorUid, UserClientUid, BlackListUid, PackedVisitorCid, VisitorSecretId, VisitorSessionCid, VisitorSessionGid, VisitorCid, VisitorGid, 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 { Upload, UploadPayload } from "./uploads";
 export { UserClient, UserClientPayload } from "./userclients";
-export { ChatVisitorVariable, ChatVisitorVariablePayload } from "./variables";
+export { ChatVisitorVariable, ChatVisitorVariablePayload, RoomVisitorVariable, RoomVisitorVariablePayload, } from "./variables";
 export { BlackList, BlackListPayload, CartLockedResponse, RoomVisitorPageView, RoomVisitor, } from "./visitor";
+export { NestedWebhookChannelSubscription, NestedWebhookChannelSubscriptionPayload, WebhookRequestLogEntry, Webhook, WebhookPayload, } from "./webhooks";
 //# sourceMappingURL=index.d.ts.map

lib/index.js

@@ -0,0 +0,0 @@ "use strict";

lib/linkpreview.d.ts

 export declare type LinkPreviewResponse = LinkPreviewResponseSuccess | LinkPreviewResponseError;
+/** TODO: Add jsdocs and check nullability of fields */
 export interface LinkPreviewResponseSuccess {
@@ -10,2 +11,3 @@ title: string;
 }
+/** TODO: Add jsdocs and check nullability of fields */
 export interface LinkPreviewResponseError {
@@ -12,0 +14,0 @@ status: "failure";

lib/linkpreview.js

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

lib/oath.d.ts

@@ -0,0 +0,0 @@ import { ApplicationUid } from "./types";

lib/oath.js

@@ -0,0 +0,0 @@ "use strict";

lib/partnerships.d.ts

@@ -0,0 +0,0 @@ import { NestedAvatar } from "./customer";

lib/partnerships.js

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

lib/permissions.d.ts

@@ -0,0 +0,0 @@ import { NestedOrganization } from "./customer";

lib/permissions.js

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

lib/public.d.ts

@@ -5,3 +5,3 @@ 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, VisitorSessionCid, VisitorGid, VisitorSessionGid, VisitorSecretId, ChatMessageType, VisitorCid } from "./types";
 import { LanguageCode } from "./common";
@@ -280,7 +280,7 @@ export declare const AutosuggestPermissionOptions: {
     /** TODO: add documentation */
-    visitor_session_id: VisitorSessionId;
+    visitor_session_id: VisitorSessionCid;
     /** TODO: add documentation */
-    visitor_global_id: VisitorGlobalId;
+    visitor_global_id: VisitorGid;
     /** TODO: add documentation */
-    visitor_global_session_id: VisitorGlobalSessionId;
+    visitor_global_session_id: VisitorSessionGid;
 }
@@ -295,7 +295,7 @@ export interface PublicCustomVisitorIdPayload {
     /** TODO: add documentation */
-    visitor_session_id: VisitorSessionId;
+    visitor_session_id: VisitorSessionCid;
     /** TODO: add documentation */
-    visitor_global_id: VisitorGlobalId;
+    visitor_global_id: VisitorGid;
     /** TODO: add documentation */
-    visitor_global_session_id: VisitorGlobalSessionId;
+    visitor_global_session_id: VisitorSessionGid;
 }
@@ -309,3 +309,3 @@ /**
     /** TODO: add documentation */
-    visitor_global_id: VisitorGlobalId | null;
+    visitor_global_id: VisitorGid | null;
 }
@@ -316,3 +316,3 @@ export interface PublicLoginPayload {
     /** TODO: add documentation */
-    visitor_global_id?: VisitorGlobalId | null;
+    visitor_global_id?: VisitorGid | null;
 }
@@ -319,0 +319,0 @@ export interface PublicRoom {

lib/public.js

@@ -0,0 +0,0 @@ "use strict";

lib/rooms.d.ts

@@ -0,0 +0,0 @@ import { NestedOrganization, NestedUser } from "./customer";

lib/rooms.js

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

lib/routers.d.ts

@@ -0,0 +0,0 @@ import { UserUid, OrganizationUid, TeamUid, RouterUid, RouterStepUid } from "./types";

lib/routers.js

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

lib/rules.d.ts

@@ -0,0 +0,0 @@ import { NestedGoal } from "./goals";

lib/rules.js

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

lib/sharing.d.ts

@@ -1,5 +0,25 @@
-import { RoomShareUid, OrganizationUid, RoomUid, UserUid, RouterUid } from "./types";
+import { NestedGiosgApp } from "./apps";
 import { NestedOrganization, NestedUser } from "./customer";
 import { NestedRoom } from "./rooms";
+import { OrganizationUid, AppShareUid, RoomShareUid, RoomUid, UserUid, RouterUid } from "./types";
 import { Router } from "./routers";
+/** TODO: Add jsdocs and check nullability of fields */
+export interface AppShare {
+    id: AppShareUid;
+    organization_id: OrganizationUid;
+    organization: NestedOrganization;
+    app_id: string;
+    app: NestedGiosgApp;
+    app_organization_id: OrganizationUid;
+    app_organization: NestedOrganization;
+    created_at: string;
+    updated_at: string;
+    created_by_user_id: string;
+    created_by_user: NestedUser;
+    updated_by_user_id: string;
+    updated_by_user: NestedUser;
+}
+export interface AppSharePayload {
+    organization_id: OrganizationUid;
+}
 interface RoomShare {
@@ -6,0 +26,0 @@ /** Unique identifier for the share resource. */

lib/sharing.js

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

lib/teams.d.ts

@@ -40,2 +40,3 @@ import { TeamUid, OrganizationUid, UserUid } from "./types";
 }
+/** TODO: Add jsdocs and check nullability of fields */
 export interface NestedTeam {
@@ -51,2 +52,3 @@ id: TeamUid;
 }
+/** TODO: Add jsdocs and check nullability of fields */
 export interface TeamMembership {
@@ -53,0 +55,0 @@ team_id: TeamUid;

lib/teams.js

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

lib/types.d.ts

 export declare type ApplicationUid = string & {
     readonly __nominal: "aabaa60d-c2f6-4f77-b168-3d7b491be66c";
 };
+export declare type AppShareUid = string & {
+    readonly __nominal: "5ad51c28-4369-41ae-ac49-3ce77df5bf69";
+};
 export declare type AssetUid = string & {
@@ -16,2 +19,8 @@ readonly __nominal: "9f828b12-ea0c-4d03-a94d-6ea7d48f77fa";
 };
+export declare type CannedAnswerUid = String & {
+    readonly __nominal: "9eee0847-2dba-401e-8699-2003939ca867";
+};
+export declare type ChatAssignmentUid = string & {
+    readonly __nominal: "9d5bc251-0d68-44ad-8034-b9a065092cc3";
+};
 export declare type ChatInvitationUid = string & {
@@ -47,2 +56,8 @@ readonly __nominal: "9d5bc25e-0d68-44ad-8034-b9a065092cc3";
 };
+export declare type GiosgAppUid = string & {
+    readonly __nominal: "f478f510-8157-47a5-afb1-095ab8d08f2e";
+};
+export declare type GiosgAppInstanceUid = string & {
+    readonly __nominal: "f478f511-8157-47a5-afb1-095ab8d08f2e";
+};
 export declare type GoalUid = string & {
@@ -54,2 +69,8 @@ readonly __nominal: "f478f5a9-8157-47a5-afb1-095ab8d08f2e";
 };
+export declare type LeadFormDataUid = string & {
+    readonly __nominal: "5bccc5da-6ec9-475e-960f-e326cbc2d306";
+};
+export declare type LeadFormDefinitionUid = string & {
+    readonly __nominal: "5bccc5db-6ec9-475e-960f-e326cbc2d306";
+};
 export declare type OrganizationUid = string & {
@@ -88,5 +109,14 @@ readonly __nominal: "5bccc5dc-6ec9-475e-960f-e326cbc2d306";
 };
+export declare type ShoppingCartUid = string & {
+    readonly __nominal: "1d183681-1aa4-4a23-9125-26df74aed75c";
+};
+export declare type ShoppingCartProductUid = string & {
+    readonly __nominal: "2d183681-1aa4-4a23-9125-26df74aed75c";
+};
 export declare type TagUid = string & {
     readonly __nominal: "174b467a-4eb8-4a2e-8000-16f632a71278";
 };
+export declare type TargetConfigUid = string & {
+    readonly __nominal: "174b467b-4eb8-4a2e-8000-16f632a71278";
+};
 export declare type TeamUid = string & {
@@ -104,2 +134,11 @@ readonly __nominal: "4ee00c46-7dea-4aee-9055-72fac2cdb009";
 };
+export declare type VisitorPredictionUid = string & {
+    readonly __nominal: "a94cdd69-4493-42aa-9cfd-558501b9f39a";
+};
+export declare type VisitorSessionPredictionUid = string & {
+    readonly __nominal: "a94cdd70-4493-42aa-9cfd-558501b9f39a";
+};
+export declare type WebhookUid = string & {
+    readonly __nominal: "a94cdd10-4493-42aa-9cfd-558501b9f39a";
+};
 /**
@@ -109,3 +148,3 @@ * @deprecated
  *  This type is a TODO for all visitorId-related things.
- *  It should be replaced with one of VisitorCid or PackedVisitorCid or VisitorGlobalId */
+ *  It should be replaced with one of VisitorCid or PackedVisitorCid or VisitorGid */
 export declare type VisitorUid = string & {
@@ -120,23 +159,28 @@ readonly __nominal: "9a7132fb-30c1-4353-a5cc-30159cd45ba1";
 };
-export declare type GiosgSessionId = string & {
-    readonly __nominal: "dadb4f32-990d-44f4-ae5b-5e43a5e60833";
-};
+/** VisitorId packed into a signed giosg id format. Used at least in operator console. */
 export declare type PackedVisitorCid = string & {
     readonly __nominal: "28f6b7d6-6678-41d7-baa8-3ef0b24bf5ad";
 };
-export declare type VisitorGlobalSessionId = string & {
-    readonly __nominal: "cfbe5d40-8d3c-4c29-9cd1-6a6db3ddebb8";
+/** Unique identifier which is used to generate VisitorCid and VisitorGid.
+ *  Only used inside visitor side iframes and is passed to server.
+ */
+export declare type VisitorSecretId = string & {
+    readonly __nominal: "cc86fcd6-c232-4a05-977e-3e9d3b4b6b1d";
 };
-export declare type VisitorGlobalId = string & {
-    readonly __nominal: "6b3fc6d0-9230-4411-a717-0a033bc1a437";
-};
-export declare type VisitorSessionId = string & {
+/** Unique identifier for a visitor session in the scope of an organization. Cid stands for "Company ID". */
+export declare type VisitorSessionCid = string & {
     readonly __nominal: "8ff88fe4-99d0-423e-807f-b778fa520b7e";
 };
-export declare type VisitorSecretId = string & {
-    readonly __nominal: "cc86fcd6-c232-4a05-977e-3e9d3b4b6b1d";
+/** Globally unique identifier for a visitor session. Gid stands for "Global ID". */
+export declare type VisitorSessionGid = string & {
+    readonly __nominal: "cfbe5d40-8d3c-4c29-9cd1-6a6db3ddebb8";
 };
+/** Unique identifier for a visitor in the scope of an organization. Cid stands for "Company ID". */
 export declare type VisitorCid = string & {
     readonly __nominal: "3a96b436-5af8-4c45-8438-c76369900bee";
 };
+/** Globally unique identifier for a visitor. Gid stands for "Global ID". */
+export declare type VisitorGid = string & {
+    readonly __nominal: "6b3fc6d0-9230-4411-a717-0a033bc1a437";
+};
 export declare type UserLegacyId = number & {
@@ -143,0 +187,0 @@ readonly __nominal: "85110dc1-c699-43ca-82fa-ad194ad35ea5";

lib/types.js

@@ -0,0 +0,0 @@ "use strict";

lib/uploads.d.ts

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

lib/uploads.js

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

lib/userclients.d.ts

@@ -0,0 +0,0 @@ import { UserClientUid } from "./types";

lib/userclients.js

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

lib/variables.d.ts

@@ -1,2 +0,2 @@
-import { VisitorCid, RoomUid, VisitorSessionId, ChatUid, OrganizationUid } from "./types";
+import { VisitorCid, RoomUid, VisitorSessionCid, ChatUid, OrganizationUid } from "./types";
 export interface ChatVisitorVariable {
@@ -16,3 +16,3 @@ /** Not mentioned in developers.giosg.com */
     /** Identifier for the session on which the variable was saved for the visitor. */
-    session_id: VisitorSessionId | null;
+    session_id: VisitorSessionCid | null;
     created_at: string;
@@ -29,2 +29,3 @@ updated_at: string;
 }
+/** TODO: Add jsdocs and check nullability of fields */
 export interface ChatVisitorVariablePayload {
@@ -38,5 +39,29 @@ chat_id: ChatUid;
     value: string;
-    session_id?: VisitorSessionId | null;
+    session_id?: VisitorSessionCid | null;
     organization_id?: OrganizationUid | null;
 }
+/** TODO: Add jsdocs and check nullability of fields */
+export interface RoomVisitorVariable {
+    visitor_id: VisitorCid;
+    room_id: RoomUid;
+    key: string;
+    value: string;
+    session_id: VisitorSessionCid | null;
+    organization_id: OrganizationUid | null;
+    created_at: string;
+    updated_at: string;
+    is_signed: boolean;
+    is_encrypted: boolean;
+    encrypted_value: string | null;
+    encrypted_symmetric_key: string | null;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface RoomVisitorVariablePayload {
+    visitor_id: VisitorCid;
+    room_id: RoomUid;
+    key: string;
+    value: string;
+    session_id?: VisitorSessionCid | null;
+    organization_id?: OrganizationUid | null;
+}
 //# sourceMappingURL=variables.d.ts.map

lib/variables.js

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

lib/visitor.d.ts

 import { NestedUser } from "./customer";
-import { BlackListUid, VisitorCid, RoomUid, UserUid, GiosgSessionId } from "./types";
+import { BlackListUid, VisitorCid, RoomUid, UserUid, VisitorSessionCid } from "./types";
 import { LanguageCode, Currency } from "./common";
@@ -40,5 +40,3 @@ /**
 }
-/**
- * TODO
- */
+/** TODO: Add jsdocs and check nullability of fields */
 export interface CartLockedResponse {
@@ -67,3 +65,3 @@ cart_id: string;
      */
-    session_id: GiosgSessionId;
+    session_id: VisitorSessionCid;
     /** Title of the web page at which the visitor visited.
@@ -95,3 +93,3 @@ */
      *  Identifier for the latest session for the visitor in this room */
-    session_id: GiosgSessionId;
+    session_id: VisitorSessionCid;
     /** The latest priority of the visitor as set explicitly with rules. It may be null if the visitor has not been prioritized with rules. */
@@ -98,0 +96,0 @@ explicit_priority: number | null;

lib/visitor.js

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

package.json

 {
     "name": "@giosg/types",
-    "version": "1.3.2",
+    "version": "2.0.0",
     "description": "TypeScript interfaces for GiosgAPI",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

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

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

341293

increased by10.13%

Number of package files

102

increased by30.77%

Lines of code

5435

increased by10.81%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes