@wix/bex-utils 2.40.0 → 2.42.0

package/@wix/bi-logger-os-data/dist/esm/v2/index.js

@@ -300,6 +300,7 @@ export function pikachuItemCategorySelected(params) {
  * @property {string} hostingPlatformContextId - the id of the context entity that the user view or edit (app/account/site)
  *
  * @property {string} theme - relevant to custom field - inline / card
+ * @property {string} consumerId - consumer Id - relevant for artifact_id = item selection module
  * @property {boolean} routerUsage - returns true if Wix Patterns router is being used, else false
  *
  * @property {boolean} isCurrentViewCustomMade -  will be True if the current view is custom-made; otherwise, it will be False
@@ -342,6 +343,7 @@ export function loadStart(params) {
  * @property {string} hostingPlatformContextId - the id of the context entity that the user view or edit (app/account/site)
  *
  * @property {string} theme - relevant to custom field - inline / card
+ * @property {string} consumerId - consumer Id - relevant for artifact_id = item selection module
  * @property {boolean} routerUsage - returns true if Wix Patterns router is being used, else false
  * @property {boolean} isCurrentViewCustomMade - will be True if the current view is custom-made; otherwise, it will be False
  *
@@ -2111,6 +2113,7 @@ export function cairoSearchForTags(params) {
  * @property {string} itemId - The entity ID (that the widget was loaded in its page)
  * @property {string} appId - app_id
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} theme - Card/ Inline
  * @return {LogObject<cairoTagsWidgetLoadedParams>} LogObject<cairoTagsWidgetLoadedParams>
  */
 export function cairoTagsWidgetLoaded(params) {
@@ -2136,6 +2139,7 @@ export function cairoTagsWidgetLoaded(params) {
  * @property {string} itemId - The entity ID
  * @property {string} appId - app_id
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} theme - Card/ Inline
  * @return {LogObject<cairoTagsWidgetClickOnCtaParams>} LogObject<cairoTagsWidgetClickOnCtaParams>
  */
 export function cairoTagsWidgetClickOnCta(params) {
@@ -2165,6 +2169,7 @@ export function cairoTagsWidgetClickOnCta(params) {
  * @property {string} appId - app_id
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} theme - Card/ Inline
  * @return {LogObject<cairoTagsAssignTagParams>} LogObject<cairoTagsAssignTagParams>
  */
 export function cairoTagsAssignTag(params) {
@@ -2471,6 +2476,7 @@ export function httpClientErrorMappingSrc176Evid100(params) {
  *
  * @param {getResolvedErrorSrc176Evid101Params} params - The parameters for this event
  * @property {string} session_id - the key for connecting the error event
+ * @property {boolean} isEn - True if the user sees the message in english
  * @property {string} mapped_error_not_available - mapped_error_not_available
  * @property {string} translated_message - the translated message of the error
  * @property {string} action_text - the action of the text
@@ -2488,6 +2494,7 @@ export function getResolvedErrorSrc176Evid101(params) {
  *
  * @param {showErrorSrc176Evid102Params} params - The parameters for this event
  * @property {string} session_id - the key for connecting the error event
+ * @property {boolean} isEn - True if the user sees the message in english
  * @property {string} displayed_message - displayed_message to the user
  * @property {string} displayed_action - displayed_action to the user
  * @property {string} action_was_provided - action_was_provided
@@ -2995,6 +3002,7 @@ export function dashboardDeleteAndRestoreSiteOpenPopup(params) {
  * @property {number} score - accuracy of the page type
  * @property {Url} url - url
  * @property {string} previewUrl - preview
+ * @property {boolean} isPatternsPage - yes if it is on Patterns
  * @return {LogObject<pageClassifierSrc5Evid10000Params>} LogObject<pageClassifierSrc5Evid10000Params>
  */
 export function pageClassifierSrc5Evid10000(params) {
@@ -9111,7 +9119,9 @@ export function teamManagementInvitePeoplePageLoad(params) {
 /**
  * A function to create a log object for the 'teamManagementInvitePeopleSendInvite' event (evid: 1411)
  *
- * Event description: User clicks on 'send invite' in the add people window
+ * Event description: User clicks on 'send invite' in the add people window.
+ *
+ *
  *
  * @param {teamManagementInvitePeopleSendInviteParams} params - The parameters for this event
  * @property {string} context - account/site
@@ -9128,6 +9138,9 @@ export function teamManagementInvitePeoplePageLoad(params) {
  * @property {number} num_folders - the distinct number of folders in the invite (null if all)
  * @property {number} contributors_quota - How many contributors can be added to the site based on the premium package quota
  *
+ * @property {string} invite_role_names - the names of the rols assigned in the invite.
+ * @property {string} Invite_predefined_role_ids - all the roles which are predefined in an array (passed as string) in the invite (“123, 456”)
+ * @property {string} invite_custom_role_ids - all the roles which are custom in an array (passed as string) in the invite ("123", "456").
  * @property {number} contributors_count - How many contributors are actually active on the site
  * @property {string} app_id - app_id (context = app)
  * @property {boolean} Has_ai_assistant - Does the user has AI assistant on this page
@@ -9244,8 +9257,6 @@ export function teamManagementManageRolesRolePageLoad(params) {
  * @property {string} role_id - role_id of the role that the user is duplicating
  * @property {string} role_type - custom/predefined
  * @property {string} origin - where the user clicked from - roles list/role page
- * @property {string} platform - platform
- * @property {GUID} msid - msid
  * @return {LogObject<teamManagementManageRolesDuplicateAndEditRoleParams>} LogObject<teamManagementManageRolesDuplicateAndEditRoleParams>
  */
 export function teamManagementManageRolesDuplicateAndEditRole(params) {
@@ -9259,8 +9270,8 @@ export function teamManagementManageRolesDuplicateAndEditRole(params) {
  * @param {teamManagementManageRolesEditCustomRoleParams} params - The parameters for this event
  * @property {string} context - account/site
  * @property {string} role_id - the role_id
- * @property {string} platform - platform
  * @property {GUID} msid - msid
+ * @property {string} origin - where the user clicked from - roles list/role page
  * @return {LogObject<teamManagementManageRolesEditCustomRoleParams>} LogObject<teamManagementManageRolesEditCustomRoleParams>
  */
 export function teamManagementManageRolesEditCustomRole(params) {
@@ -13724,6 +13735,24 @@ export function searchToDeleteSrc5Evid1847(params) {
 export function teamManagementResendInviteClick(params) {
     return { evid: 185, src: 5, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'leavingWithoutSavingModalOpenedSrc5Evid1858' event (evid: 1858)
+ *
+ * Event description: Leaving without saving -  modal opened
+ *
+ * @param {leavingWithoutSavingModalOpenedSrc5Evid1858Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @property {string} hosting_platform_context_id - context id: when the context is site - msid, when the context is app_id (like in devCenter f.e) - appDefId. In account manager is null
+ * @property {string} internal_route - in case of internal page- in this field we will get the additional part of the route
+ * @property {string} displayMode - main / overlay
+ * @return {LogObject<leavingWithoutSavingModalOpenedSrc5Evid1858Params>} LogObject<leavingWithoutSavingModalOpenedSrc5Evid1858Params>
+ */
+export function leavingWithoutSavingModalOpenedSrc5Evid1858(params) {
+    return { evid: 1858, src: 5, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'dashboardContributorsClickOnMangeRolesAndPermissions' event (evid: 187)
  *
@@ -13739,6 +13768,111 @@ export function teamManagementResendInviteClick(params) {
 export function dashboardContributorsClickOnMangeRolesAndPermissions(params) {
     return { evid: 187, src: 5, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'rolesAndPermissionsManageRolesEditRoleSrc5Evid1871' event (evid: 1871)
+ *
+ * Event description: User clicks on 'edit role' (and not edit & duplicate) from the role actions menu (considered as creating a new role). The user can click on a custom role or a pre-defined role.
+ *
+ * @param {rolesAndPermissionsManageRolesEditRoleSrc5Evid1871Params} params - The parameters for this event
+ * @property {string} context - account/site
+ * @property {string} role_id - role_id of the role that the user is duplicating
+ * @property {string} role_type - custom/predefined
+ * @property {string} origin - where the user clicked from - roles list/role page
+ * @property {string} platform - platform
+ * @property {string} role_name - role_name of the role that the user is duplicating
+ * @property {boolean} Has_ai_assistant - Is He had AI assistant? (True/False)
+ * @return {LogObject<rolesAndPermissionsManageRolesEditRoleSrc5Evid1871Params>} LogObject<rolesAndPermissionsManageRolesEditRoleSrc5Evid1871Params>
+ */
+export function rolesAndPermissionsManageRolesEditRoleSrc5Evid1871(params) {
+    return { evid: 1871, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874' event (evid: 1874)
+ *
+ * Event description: User clicks on 'send invites' in the invite Teammates window (user level only).
+ *
+ * About:
+ * Invite_predefined_role_ids - example:  “123456, 789123, 1 | 345678, 0 | 547891, 145254, 134543, 0”
+ * Invite_custom_role_ids - example:  “123456, 789123, 1 | 345678, 0 | 547891, 145254, 134543, 0”
+ *
+ * Will be passed as string for both, we will use | to different between each role in the same invite using ‘|’.  For this group - 123456, 789123, 1 - the first 2 elements are the role_ids (custom / predefined depend on val).
+ * If last value of the rule (in this list) is 1 - it means this is a ‘All sites and users’ type of invite.  If 0 this means we are not  ‘All sites and users’ for this role.
+ *
+ * @param {rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874Params} params - The parameters for this event
+ * @property {string} context - account
+ * @property {number} number_of_invalid_emails - number of invalid emails (only errors for not typing correctly - exclude errors for existing emails)
+ * @property {string} invite_custom_role_ids - the role_ids that the user sends to the invitees which are custom alongside binary indicator for the 'All sites and folders' (True for usage in this).
+ * @property {string} assignment_type - all/specific
+ * @property {number} number_of_existing_emails - emails that already exist in the team
+ * @property {string} origin - where the modal was clicked from
+ * @property {GUID} invite_id - the invite_id
+ * @property {string} platform - platform
+ * @property {number} number_of_valid_emails - number of valid emails
+ * @property {string} invite_predefined_role_ids - the role_ids that the user sends to the invitees which are predefined alongside binary indicator for the 'All sites and folders' (True for usage in this).
+ * @property {string} app_id - app_id (context = app)
+ * @property {boolean} Has_ai_assistant - Does the user has AI assistant on this page
+ *
+ * @return {LogObject<rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874Params>} LogObject<rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874Params>
+ */
+export function rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874(params) {
+    return { evid: 1874, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'restoreSiteModalOpenedSrc5Evid1875' event (evid: 1875)
+ *
+ * Event description: Restore site -  modal opened
+ *
+ * @param {restoreSiteModalOpenedSrc5Evid1875Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @property {string} hosting_platform_context_id - context id: when the context is site - msid, when the context is app_id (like in devCenter f.e) - appDefId. In account manager is null
+ * @property {string} internal_route - in case of internal page- in this field we will get the additional part of the route
+ * @property {string} origin - The origin from which the modal was opened
+ * @return {LogObject<restoreSiteModalOpenedSrc5Evid1875Params>} LogObject<restoreSiteModalOpenedSrc5Evid1875Params>
+ */
+export function restoreSiteModalOpenedSrc5Evid1875(params) {
+    return { evid: 1875, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'restoreSiteModalCtaClickedSrc5Evid1876' event (evid: 1876)
+ *
+ * Event description: Restore site – Modal CTA clicked
+ *
+ * @param {restoreSiteModalCtaClickedSrc5Evid1876Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @property {string} hosting_platform_context_id - context id: when the context is site - msid, when the context is app_id (like in devCenter f.e) - appDefId. In account manager is null
+ * @property {string} internal_route - in case of internal page- in this field we will get the additional part of the route
+ * @property {string} cta - Keep in trash / Restore site
+ * @property {string} origin - The origin from which the modal was opened
+ * @return {LogObject<restoreSiteModalCtaClickedSrc5Evid1876Params>} LogObject<restoreSiteModalCtaClickedSrc5Evid1876Params>
+ */
+export function restoreSiteModalCtaClickedSrc5Evid1876(params) {
+    return { evid: 1876, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'leavingWithoutSavingModalCtaClickedSrc5Evid1878' event (evid: 1878)
+ *
+ * Event description: Leaving without saving – Modal CTA clicked
+ *
+ * @param {leavingWithoutSavingModalCtaClickedSrc5Evid1878Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @property {string} hosting_platform_context_id - context id: when the context is site - msid, when the context is app_id (like in devCenter f.e) - appDefId. In account manager is null
+ * @property {string} internal_route - in case of internal page- in this field we will get the additional part of the route
+ * @property {string} cta - Exit (click on x), Leave, Keep editing (in english)
+ * @property {string} displayMode - main / overlay
+ * @return {LogObject<leavingWithoutSavingModalCtaClickedSrc5Evid1878Params>} LogObject<leavingWithoutSavingModalCtaClickedSrc5Evid1878Params>
+ */
+export function leavingWithoutSavingModalCtaClickedSrc5Evid1878(params) {
+    return { evid: 1878, src: 5, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'ascendHoverOnUpgradeAscend' event (evid: 188)
  *