@wix/bex-utils 2.5.0 → 2.7.0

package/@wix/bi-logger-cairo-os/dist/types/v2/index.d.ts

@@ -1,2032 +0,0 @@
-import { LogObject, cairoAllFiltersClearedParams, cairoApiRequestDataLoadEndParams, cairoApplyButtonClickedParams, cairoAssignTagsToEntitiesParams, cairoCancelExportModalCtaClickedParams, cairoChangesBeforeApplyParams, cairoComponentSortedParams, cairoCtaClickedParams, cairoCustomizeColumnsInSidePanelParams, cairoDataExAddCustomFieldParams, cairoDataExCustomFieldAdvancesSettingsParams, cairoDataExCustomFieldEndProcessParams, cairoDataExtensionUnsuccessfulUpdateInServerParams, cairoDiscardChangesBeforeApplyParams, cairoDragActionUnsuccessfulUpdateInServerParams, cairoDragItemEndDropParams, cairoDragItemParams, cairoErrorInLoadingAComponentParams, cairoExportCtaClickedParams, cairoExportFailedModalCtaClickedParams, cairoExportModalCtaClickedParams, cairoExportProcessEndParams, cairoExportProcessStartParams, cairoFileDownloadToastDismissedParams, cairoFileDownloadToastDisplayedParams, cairoFileDownloadToastDownloadButtonClickedParams, cairoFilterToggledParams, cairoFiltersPanelUsedParams, cairoItemSelectionToggledParams, cairoItemToggledInExportModalParams, cairoLearnMoreParams, cairoManageViewActionSelectedParams, cairoManageViewClickedParams, cairoModalCtaClickedParams, cairoNestedTableCollapseAndExpandParams, cairoPageBackOrBreadcrumbClickedParams, cairoPageCtaClickedParams, cairoPageDiscardChangesBeforeSaveParams, cairoReloadErrorStateParams, cairoReorderingSortColumnsParams, cairoSearchForTagsParams, cairoSearchResultsParams, cairoSearchViewInViewsParams, cairoSectionCtaClickedParams, cairoSortPanelUsedParams, cairoSortUnsuccessfulUpdateInServerParams, cairoTabSelectedParams, cairoTableTopNotificationDismissedParams, cairoTableTopNotificationDisplayedParams, cairoTagsAddDeleteTagParams, cairoTagsAssignTagParams, cairoTagsModalEndProcessParams, cairoTagsModalStartLoadParams, cairoTagsUnsuccessfulUpdateInServerParams, cairoTagsWidgetClickOnCtaParams, cairoTagsWidgetLoadedParams, cairoTpaSCtaClickedParams, cairoTryAgainClickedParams, cairoUndoClickedParams, cairoUserAttemptsToCancelTheExportParams, cairoViewDeletedParams, cairoViewSavedParams, cairoViewSelectedParams, cairoViewsUnsuccessfulUpdateInServerParams, componentDismissedParams, loadEndParams, loadMoreParams, loadStartParams, newItemCreationEndParams, newItemCreationStartParams, pickerEndLoadParams, pickerModalUsabilityParams, pickerPickModalCtaButtonClickOrImmediateCtaParams, pickerPickerOpenButtonParams, pickerStartLoadParams, pikachuCategoriesDropdownButtonClickedParams, pikachuItemCategorySelectedParams } from '../types';
-/**
- * A function to create a log object for the 'componentDismissed' event (evid: 113)
- *
- * Event description: Sent when a component is dismissed. Relevant components: Picker Modal.
- *
- * @param {componentDismissedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Modal / Picker Dropdown
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} origin - X button/Cancel button
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<componentDismissedParams>} LogObject<componentDismissedParams>
- */
-export declare function componentDismissed(params: componentDismissedParams): LogObject<componentDismissedParams>;
-/**
- * A function to create a log object for the 'loadMore' event (evid: 112)
- *
- * Event description: Sent when a Cairo component is done loading more items (after scrolling). Relevant components: Picker Standalone, Picker Modal, Table, Cards.
- *
- * @param {loadMoreParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {string} currentSortOrder - Which column is currently used to sort the list: {"columnName": "asc"/"desc"}. Relevant for Table and Cards.
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - Optional domain name from FQDN (crm, stores, etc.)
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {boolean} isTPA
- * @property {number} loadedItems - How many new items were loaded in this action
- * @property {number} loadingTime - Component loading time in ms
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<loadMoreParams>} LogObject<loadMoreParams>
- */
-export declare function loadMore(params: loadMoreParams): LogObject<loadMoreParams>;
-/**
- * A function to create a log object for the 'cairoDragItemEndDrop' event (evid: 139)
- *
- * Event description: Sent when a user finish to drag an item
- *
- * @param {cairoDragItemEndDropParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards. For now, it can only be a "category filter" that is displayed in this event. (relate to ticket 525+521).
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {GUID} dragAndDropID - A "couple" identifier , match between drag action and its drop action
- * @property {number} duration - duration in ms from starting to drag the item untill the action has ended
- * @property {string} endType - (happy flow+ ticket 529) how did the "drag action" end? Will get one of the following:
- *  "drop succeeded" = the item has been dropped inside the collection
- * "drop back" = the item has been dropped to it's original index (itemIndexBefore=itenIndexAfter)
- *  "drop outside" = the item has been dropped outside the collection (itemIndexBefore=itenIndexAfter)
- *  "clicked ESC" = the user clicked on the ESC button and the action was cancelled. "drag disabled" = the user tried to drag an item when the this feature is disabled. If the action was cancelled due to external-to-Cairo logic- event 144:140 will be sent instead.
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isFromHandle - Is the item dragged from the handle area?
- * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
- * @property {boolean} isTPA
- * @property {string} itemId - ID of the item that the user tries to drag
- * @property {number} itemIndexAfter - Out of the list of results, what is the new index of the dragged item (after dragging). ** filteredListSize = X --> (1 <= itemIndexAfter <= X) **when endType <> drop succeeded --> itemIndexAfter = itemIndexBefore
- * @property {number} itemIndexBefore - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
- * @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} searchQuery - What did the user search? isFromSearch = FALSE --> searchQuery = null (relate to ticket 521).
- * @return {LogObject<cairoDragItemEndDropParams>} LogObject<cairoDragItemEndDropParams>
- */
-export declare function cairoDragItemEndDrop(params: cairoDragItemEndDropParams): LogObject<cairoDragItemEndDropParams>;
-/**
- * A function to create a log object for the 'pickerPickerOpenButton' event (evid: 105)
- *
- * Event description: Picker button actions (not within the modal)
- *
- * @param {pickerPickerOpenButtonParams} params - The parameters for this event
- * @property {string} action - Any picker button option (render/hover/click)
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
- * @property {string} componentType
- * @property {GUID} csid
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are to presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist (full list)
- * @property {number} maxItems - Max items to select in picker
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
- * @property {string} type - standalone/modal
- * @return {LogObject<pickerPickerOpenButtonParams>} LogObject<pickerPickerOpenButtonParams>
- */
-export declare function pickerPickerOpenButton(params: pickerPickerOpenButtonParams): LogObject<pickerPickerOpenButtonParams>;
-/**
- * A function to create a log object for the 'cairoDiscardChangesBeforeApply' event (evid: 161)
- *
- * Event description: Sent when a user chose to discard his changes in a Cairo component. Relevant components: Table, with apply behavior in the filters panel, or with custom fields option.
- *
- * @param {cairoDiscardChangesBeforeApplyParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards / Picker
- * @property {GUID} csid - Cairo session ID
- * @property {string} currentStatus - (Optional, relevant for Filters)  Json field: The state of feature, if the user would have clicked on the apply button. [{"fieldName": "FIELD_NAME1", "field_value": "VALUE1"}] (for filters -all the filters will appear in this list, filters that not active will get NULL in the filters' value)
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} feature - Filters / Drag and Drop
- * @property {boolean} isTPA
- * @property {number} numActiveFields - (Optional, relevant for Filters) How many fields are active after the apply button is clicked? (fields that their value is not NULL)
- * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
- * @property {number} numOptionalFields - (Optional, relevant for Filters) If there is an optional fields list (like for filters)- how many options are there?
- * @property {string} origin - Feature's Side Panel / Table Toolbar
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoDiscardChangesBeforeApplyParams>} LogObject<cairoDiscardChangesBeforeApplyParams>
- */
-export declare function cairoDiscardChangesBeforeApply(params: cairoDiscardChangesBeforeApplyParams): LogObject<cairoDiscardChangesBeforeApplyParams>;
-/**
- * A function to create a log object for the 'cairoItemSelectionToggled' event (evid: 114)
- *
- * Event description: Sent when a user select/deselects an item(s) in a list
- *
- * @param {cairoItemSelectionToggledParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} clickType - The click purpose : "Selection" / "Deselection"
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/ Picker Dropdown /Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {number} currentLevel - What is the hierarchy level (or step) of the selected item? (out of numLevels)
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} currentStep - What is the step (or hierarchy level) of the selected item?
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isFromSearch - Is the item selected from a list of search results
- * @property {boolean} isSelectAll - Did the user click the "Select All" check box (will get "true" regardless the label attached to the check box: "Select All" or "Deselect All").
- * @property {boolean} isTPA
- * @property {string} itemId - ID of item that is checked/unchecked (isSelectAll = TRUE --> itemId = "All")
- * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item.
- * ** isSelectAll = TRUE --> itemIndex = 0
- * @property {string} location - Location: Table List Header (for using the checkbox) /
- * Table Bulk Toolbar (for using the CTA)(new from Dec 2022)
- * @property {number} maxItems - (Optional) Max number of items that can be selected. null if there's no limit.
- * @property {number} numItemsAfter - How many items have been selected after user clicks items.
- * @property {number} numItemsBefore - How many items have been selected before user clicks items
- * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} searchQuery - What did the user search?
- * @property {number} timeFromAction - The time from user selection until he gets feedback and sees his item(s) checked as selected, in ms (new from Dec 2022)
- * @return {LogObject<cairoItemSelectionToggledParams>} LogObject<cairoItemSelectionToggledParams>
- */
-export declare function cairoItemSelectionToggled(params: cairoItemSelectionToggledParams): LogObject<cairoItemSelectionToggledParams>;
-/**
- * A function to create a log object for the 'pickerEndLoad' event (evid: 102)
- *
- * Event description: Cairo picker finished loading
- *
- * @param {pickerEndLoadParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
- * @property {string} componentType
- * @property {GUID} csid
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are to presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist (full list)
- * @property {number} loadingTime - ms
- * @property {number} maxItems - Max items to select in picker
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
- * @property {string} type - standalone/modal
- * @return {LogObject<pickerEndLoadParams>} LogObject<pickerEndLoadParams>
- */
-export declare function pickerEndLoad(params: pickerEndLoadParams): LogObject<pickerEndLoadParams>;
-/**
- * A function to create a log object for the 'cairoNestedTableCollapseAndExpand' event (evid: 165)
- *
- * Event description: Sent when a user clicks on a category item in a nested table, to collapse or expand it  (to hide or unhide the items under this category)
- *
- * @param {cairoNestedTableCollapseAndExpandParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} clickType - The click purpose : "Collapse" / "Expand"
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/ Picker Dropdown /Table/Cards
- * @property {number} countItems - The value the user see as the count of this item. If  "Is select all"= true, then Null
- * @property {GUID} csid - Cairo session id
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {number} currentLevel - What is the hierarchy level (or step) of the clicked item? (out of numLevels). If  "Is select all"= true, then Null
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {boolean} isFromSearch - Is the item selected from a list of search results
- * @property {boolean} isSelectAll - True if the user chose to collapse / expand all categories simultaneously
- * @property {boolean} isTPA
- * @property {string} itemId - ID of the clicked item .If  "Is select all"= true, then Null
- * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item .If  "Is select all"= true,  then Null
- * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} searchQuery - What did the user search?
- * @return {LogObject<cairoNestedTableCollapseAndExpandParams>} LogObject<cairoNestedTableCollapseAndExpandParams>
- */
-export declare function cairoNestedTableCollapseAndExpand(params: cairoNestedTableCollapseAndExpandParams): LogObject<cairoNestedTableCollapseAndExpandParams>;
-/**
- * A function to create a log object for the 'loadEnd' event (evid: 111)
- *
- * Event description: Sent when a Cairo component is done loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
- *
- * @param {loadEndParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentStatus - for CustomFieldsWidget component: expanded /collapsed. for table-grid switch components: table layout / grid layout. for nested table :All items collapsed / expanded. Null otherwise
- * @property {string} componentType - Picker Standalone/Picker Modal/ Picker Dropdown/ Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isInternalPage - Is under bo.wix.com (new from 03/2023)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist (full list, unfiltered). Relevant for Picker.
- * @property {number} loadingTime - Component loading time in ms
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {Url} url - The page's url (new from 03/2023)
- * @return {LogObject<loadEndParams>} LogObject<loadEndParams>
- */
-export declare function loadEnd(params: loadEndParams): LogObject<loadEndParams>;
-/**
- * A function to create a log object for the 'cairoTagsAddDeleteTag' event (evid: 168)
- *
- * Event description: Send when a user add or delete a tag from his component. Relevant for Verticals who allow use tags in their tables.
- *
- * @param {cairoTagsAddDeleteTagParams} params - The parameters for this event
- * @property {string} actionName - Add / Delete / Rename
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
- * @property {boolean} isTPA
- * @property {number} numTags - How many tags are in the modal after this action?
- * @property {string} origin - Where did the user make the action from? Tags Modal /
- * @property {string} previousName - (Relevant only for action name=Rename) The tag's name, before the change
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @property {string} tagName - The name of the removed/added tag, or the new tag's name - incase of rename tag
- * @return {LogObject<cairoTagsAddDeleteTagParams>} LogObject<cairoTagsAddDeleteTagParams>
- */
-export declare function cairoTagsAddDeleteTag(params: cairoTagsAddDeleteTagParams): LogObject<cairoTagsAddDeleteTagParams>;
-/**
- * A function to create a log object for the 'cairoExportProcessStart' event (evid: 128)
- *
- * Event description: Sent when the export process begins
- *
- * @param {cairoExportProcessStartParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {boolean} isTPA
- * @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
- * @property {number} try - Which try is this; if try > 1, this is a retry
- * @return {LogObject<cairoExportProcessStartParams>} LogObject<cairoExportProcessStartParams>
- */
-export declare function cairoExportProcessStart(params: cairoExportProcessStartParams): LogObject<cairoExportProcessStartParams>;
-/**
- * A function to create a log object for the 'cairoExportFailedModalCtaClicked' event (evid: 135)
- *
- * Event description: Sent when the user clicks a CTA in the "Export Failed" modal
- *
- * @param {cairoExportFailedModalCtaClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} ctaName - Which CTA did the user click in the Export Failed modal: "Cancel"/"X Button" (export is cancelled) OR "Try Again" (export process restarts) OR "learn more" (user is led to contact support)
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {boolean} isTPA
- * @property {number} numItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {number} numItemsExported - How many items were exported before the export failed.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} selectedExportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
- * @property {number} try - Which try is this; if try > 1, this is a retry
- * @return {LogObject<cairoExportFailedModalCtaClickedParams>} LogObject<cairoExportFailedModalCtaClickedParams>
- */
-export declare function cairoExportFailedModalCtaClicked(params: cairoExportFailedModalCtaClickedParams): LogObject<cairoExportFailedModalCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoSearchViewInViews' event (evid: 151)
- *
- * Event description: Sent when the search results are displayed, after a user searches for a view in a Cairo views list. Relevant components: Table, Cards.
- *
- * @param {cairoSearchViewInViewsParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} endType - How did the search action end? "View selected"- the user chose one of the search results, "Search dismissed"- the user cancel the search by any other action. When the "end Type" is "view selected" but "search term" is null= then the user typed and searched, deleted his term and then manually selected a view from his views (not from search results).
- * @property {boolean} isTPA
- * @property {number} numCategoriesInResults - Out of searchResultsCnt - how many results are  from type of "categories"?
- * @property {number} numViews - The distinct views IDs the users has when he searches a view
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {number} searchResultsCnt - How many results appeared for the search query. numSearchReults = 0 --> user saw empty state. This count includes "views" and "categories" results.
- * @property {string} searchTerm - What did the user search? "" if removed search term.
- * @return {LogObject<cairoSearchViewInViewsParams>} LogObject<cairoSearchViewInViewsParams>
- */
-export declare function cairoSearchViewInViews(params: cairoSearchViewInViewsParams): LogObject<cairoSearchViewInViewsParams>;
-/**
- * A function to create a log object for the 'pickerStartLoad' event (evid: 101)
- *
- * Event description: Cairo picker starts loading
- *
- * @param {pickerStartLoadParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
- * @property {string} componentType
- * @property {GUID} csid
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are to presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist (full list)
- * @property {number} maxItems - Max items to select in picker
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
- * @property {string} type - standalone/modal
- * @return {LogObject<pickerStartLoadParams>} LogObject<pickerStartLoadParams>
- */
-export declare function pickerStartLoad(params: pickerStartLoadParams): LogObject<pickerStartLoadParams>;
-/**
- * A function to create a log object for the 'loadStart' event (evid: 110)
- *
- * Event description: Sent when a Cairo component starts loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
- *
- * @param {loadStartParams} params - The parameters for this event
- * @property {string} additionalFeaturesAvailability - Json field :({featureName: boolean}) (new from 06/2023), for features that don't suppose to impact performance
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Picker Dropdown Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
- * @property {boolean} isTPA
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {Url} url - The page's url (new from 03/2023)
- * @return {LogObject<loadStartParams>} LogObject<loadStartParams>
- */
-export declare function loadStart(params: loadStartParams): LogObject<loadStartParams>;
-/**
- * A function to create a log object for the 'pikachuItemCategorySelected' event (evid: 109)
- *
- * Event description: Sent when user selects a category from the Pikachu category menu (e.g. Coupons/Services/Products)
- *
- * @param {pikachuItemCategorySelectedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType
- * @property {GUID} csid
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} itemCategory - Which type of item would we like to pick: 'Collection'/'Product'/'Service'/'Coupon'/'Standalone form'/'Invoice'/'Price quote'
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<pikachuItemCategorySelectedParams>} LogObject<pikachuItemCategorySelectedParams>
- */
-export declare function pikachuItemCategorySelected(params: pikachuItemCategorySelectedParams): LogObject<pikachuItemCategorySelectedParams>;
-/**
- * A function to create a log object for the 'cairoExportCtaClicked' event (evid: 125)
- *
- * Event description: Sent when a user clicks the "Export" CTA in a Cairo component
- *
- * @param {cairoExportCtaClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} availableExportTypes - A list of all of the available export types, along with the number of items that would be exported using each of the options. E.g. {"All Items": 100, "Filtered Items": 80, "Selected Items": 10}
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} defaultExportType - What type of export is automatically selected when the user clicks the export CTA: "All Items"/"Filtered Items"/"Selected Items"
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
- * @property {boolean} isTPA
- * @property {number} numSelectedItems - How many items does the user wish to export
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoExportCtaClickedParams>} LogObject<cairoExportCtaClickedParams>
- */
-export declare function cairoExportCtaClicked(params: cairoExportCtaClickedParams): LogObject<cairoExportCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoCancelExportModalCtaClicked' event (evid: 130)
- *
- * Event description: Sent when the user clicks any of the CTAs in the "Cancel the export?" modal
- *
- * @param {cairoCancelExportModalCtaClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} ctaName - Which CTA did the user click in the Cancel Export modal: "Cancel Export"/"Go Back"/"X Button" (modalType = "Export") OR "Cancel"/"Leave" (modalType = "Browser")
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} duration - How much time (in ms) did it take since the export process began
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {boolean} isTPA
- * @property {string} modalType - Did the user try to close the tab ("Browser") or cancel the export ("Export")
- * @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
- * @property {number} try - Which try is this; if try > 1, this is a retry
- * @return {LogObject<cairoCancelExportModalCtaClickedParams>} LogObject<cairoCancelExportModalCtaClickedParams>
- */
-export declare function cairoCancelExportModalCtaClicked(params: cairoCancelExportModalCtaClickedParams): LogObject<cairoCancelExportModalCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoPageDiscardChangesBeforeSave' event (evid: 174)
- *
- * Event description: Sent when a user chose to discard his changes in a Cairo's page. (by clicking on cancel / navigate to another page / click on the back button / click on the breadcrumb button)
- *
- * @param {cairoPageDiscardChangesBeforeSaveParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards / Picker
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {boolean} isTPA
- * @property {number} numOfActions - Number of changed fields that their changes can be lost
- * @property {number} numOfFields - How many fields are there that can be change in this page?
- * @property {string} origin - Cancel CTA / Breadcrumbs / Back button / Navigation
- * @property {string} pageType - Entity /
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoPageDiscardChangesBeforeSaveParams>} LogObject<cairoPageDiscardChangesBeforeSaveParams>
- */
-export declare function cairoPageDiscardChangesBeforeSave(params: cairoPageDiscardChangesBeforeSaveParams): LogObject<cairoPageDiscardChangesBeforeSaveParams>;
-/**
- * A function to create a log object for the 'cairoFileDownloadToastDownloadButtonClicked' event (evid: 134)
- *
- * Event description: Sent when the user clicks the "Download Manually" button in the toast that is displayed after the export process is complete
- *
- * @param {cairoFileDownloadToastDownloadButtonClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} duration - How much time (in ms) was the notification displayed before the button was clicked
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} isTPA
- * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoFileDownloadToastDownloadButtonClickedParams>} LogObject<cairoFileDownloadToastDownloadButtonClickedParams>
- */
-export declare function cairoFileDownloadToastDownloadButtonClicked(params: cairoFileDownloadToastDownloadButtonClickedParams): LogObject<cairoFileDownloadToastDownloadButtonClickedParams>;
-/**
- * A function to create a log object for the 'cairoCustomizeColumnsInSidePanel' event (evid: 177)
- *
- * Event description: Sent when a user is making his first change in visible columns- add / remove / reorder them- for every time he opened the side panel. Relevant components: Table, Cards.
- *
- * @param {cairoCustomizeColumnsInSidePanelParams} params - The parameters for this event
- * @property {string} actionName - Visibility / Reorder
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid - cairo session id
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view, "false" if it's a user view and "null" if the action wasn't made over any view (new field from 01/2023)
- * @property {boolean} isTPA
- * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
- * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
- * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
- * @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
- * @return {LogObject<cairoCustomizeColumnsInSidePanelParams>} LogObject<cairoCustomizeColumnsInSidePanelParams>
- */
-export declare function cairoCustomizeColumnsInSidePanel(params: cairoCustomizeColumnsInSidePanelParams): LogObject<cairoCustomizeColumnsInSidePanelParams>;
-/**
- * A function to create a log object for the 'cairoTabSelected' event (evid: 121)
- *
- * Event description: Sent when a user selects a tab in a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoTabSelectedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are currently presented to user, after new tab selection
- * @property {boolean} hasAllTab - TRUE if "All" tab is displayed for this component; FALSE otherwise
- * @property {boolean} isTPA
- * @property {string} newTabId - Name of the newly selected tab
- * @property {number} newTabIndex - Index of the newly selected tab. 1 <= newTabIndex <= numTabs.
- * @property {number} numTabs - How many tabs are dispalyed to the user
- * @property {string} prevTabId - (Optional) Name of the previous tab that the user had selected. null if no tab was selected.
- * @property {number} prevTabIndex - (Optional) Index of the previous tab that the user had selected. 1 <= prevTabIndex <= numTabs; null if no tab was selected.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoTabSelectedParams>} LogObject<cairoTabSelectedParams>
- */
-export declare function cairoTabSelected(params: cairoTabSelectedParams): LogObject<cairoTabSelectedParams>;
-/**
- * A function to create a log object for the 'cairoViewsUnsuccessfulUpdateInServer' event (evid: 145)
- *
- * Event description: Sent when a user made an action on a view, but his changes weren't update in the server from different reasons
- *
- * @param {cairoViewsUnsuccessfulUpdateInServerParams} params - The parameters for this event
- * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards. For now, it can only be a "category filter" that is displayed in this event. (relate to ticket 525+521).
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} errorType - What is the type of the error? "Update failed" = updates has failed in the server, "Window closed" = the user clicked the X button to close the window before the server finished the update, "Left page"= the user try navigate to another page before the server finished the update
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
- * @property {string} filtersApplied - A list of filters that were displayed to user when he made the failed action: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {boolean} isFromSearch - Was the failed action made on a search results?
- * @property {boolean} isTPA
- * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} searchQuery - (not relevant for now) What did the user search? isFromSearch = FALSE --> searchQuery = null .
- * @property {number} timeFromEndAction - duration in ms from the end of the failed action until the error indication
- * @property {string} viewId - Which view was the failed action made on. Relevant for Table and Cards.
- * @return {LogObject<cairoViewsUnsuccessfulUpdateInServerParams>} LogObject<cairoViewsUnsuccessfulUpdateInServerParams>
- */
-export declare function cairoViewsUnsuccessfulUpdateInServer(params: cairoViewsUnsuccessfulUpdateInServerParams): LogObject<cairoViewsUnsuccessfulUpdateInServerParams>;
-/**
- * A function to create a log object for the 'cairoModalCtaClicked' event (evid: 162)
- *
- * Event description: Sent when a user clicks on a CTA in an an opened modal
- *
- * @param {cairoModalCtaClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid - Cairo session id
- * @property {string} ctaName - The CTA name the user chose to do in the modal (for example: save, cancel, archive etc.). English only, not localized
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {boolean} isTPA
- * @property {string} localizedCtaName - The CTA name, localized
- * @property {string} modalName - The modal's title (Archive custom field, etc.)
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoModalCtaClickedParams>} LogObject<cairoModalCtaClickedParams>
- */
-export declare function cairoModalCtaClicked(params: cairoModalCtaClickedParams): LogObject<cairoModalCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoAllFiltersCleared' event (evid: 118)
- *
- * Event description: Sent when a user clears all of the filters used in a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoAllFiltersClearedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} filterNames - Comma separated list of filter names that have been cleared
- * @property {number} filteredListSize - How many items were presented to user, before all of the filters were cleared
- * @property {boolean} isTPA
- * @property {number} numFiltersCleared - How many filters have been cleared
- * @property {string} origin - "sidebar"/"toolbar"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoAllFiltersClearedParams>} LogObject<cairoAllFiltersClearedParams>
- */
-export declare function cairoAllFiltersCleared(params: cairoAllFiltersClearedParams): LogObject<cairoAllFiltersClearedParams>;
-/**
- * A function to create a log object for the 'cairoCtaClicked' event (evid: 115)
- *
- * Event description: Sent when a user clicks a CTA ('save', 'add', 'delete', 'continue', etc.) in a Cairo component. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
- *
- * @param {cairoCtaClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid - cairo sessionId
- * @property {number} ctaIndex - 1 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the specific location
- * @property {string} ctaName - "Continue"/"Delete"/"Save"/"Accept"/"Edit"... (in English, not localized)
- * @property {number} currentLevel - What is the hierarchy level (or step) of the selected item? (out of numLevels)
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
- * @property {boolean} isTPA
- * @property {string} itemId - ID of the item that the user clicked on its CTA
- * @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
- * @property {string} localizedCtaName - The CTA name, localized
- * @property {string} location - CTA location: multi bulk action toolbar, bulk action toolbar, action cell, Customize columns action cell
- * @property {number} maxItems - (Optional) Max number of items that can be selected. null if there's no limit.
- * @property {number} moreActionsIndex - (Optional) If the CTA is part of a "more actions" dropdown, its index in the dropdown; otherwise, null
- * @property {number} numCtas - How many CTAs are available in the current location
- * @property {number} numItems - How many items have been selected
- * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {number} timeFromAction - The time from user CTA click until he gets feedback , in ms (new from Dec 2022)
- * @return {LogObject<cairoCtaClickedParams>} LogObject<cairoCtaClickedParams>
- */
-export declare function cairoCtaClicked(params: cairoCtaClickedParams): LogObject<cairoCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoChangesBeforeApply' event (evid: 160)
- *
- * Event description: Sent when a user changes his choices before he clicks on the apply button in a Cairo component. Relevant components: Table, with apply behavior in the filters panel, or with custom fields option.
- *
- * @param {cairoChangesBeforeApplyParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards / Picker (from 12/2022)
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} feature - Filters / Add Custom Field / Edit Custom Field
- * @property {string} fieldName - The field that the user chose to change (not necessary to save) (Null if the user clicked on "clear")
- * @property {string} fieldValue - The chosen value of the field (Null if the user clicked on "clear")
- * @property {boolean} isClearButton - True if the user clicked on the clear button, False otherwise .
- * @property {boolean} isTPA
- * @property {number} numActiveFields - (relevant only when click on "clear") How many fields were active when the user clicked on the clear button? (fields that their value were not NULL)
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoChangesBeforeApplyParams>} LogObject<cairoChangesBeforeApplyParams>
- */
-export declare function cairoChangesBeforeApply(params: cairoChangesBeforeApplyParams): LogObject<cairoChangesBeforeApplyParams>;
-/**
- * A function to create a log object for the 'cairoTagsWidgetClickOnCta' event (evid: 172)
- *
- * Event description: Send when a user click on the widget's ctas (not including assigning tag). Relevant for Verticals who allow use tags in their tables.
- *
- * @param {cairoTagsWidgetClickOnCtaParams} params - The parameters for this event
- * @property {string} actionName - Assign tags / Create tags / Manage tags
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} itemId - The entity ID
- * @property {number} numTags - How many tags are existing? will get 0 if the user didn't create any tag and an empty state will be opened
- * @property {number} numTagsAssigned - How many tags are already assigned to that item?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @return {LogObject<cairoTagsWidgetClickOnCtaParams>} LogObject<cairoTagsWidgetClickOnCtaParams>
- */
-export declare function cairoTagsWidgetClickOnCta(params: cairoTagsWidgetClickOnCtaParams): LogObject<cairoTagsWidgetClickOnCtaParams>;
-/**
- * A function to create a log object for the 'cairoDataExtensionUnsuccessfulUpdateInServer' event (evid: 163)
- *
- * Event description: Sent when a user tried to save a custom field but his changes weren't update in the server from different reasons
- *
- * @param {cairoDataExtensionUnsuccessfulUpdateInServerParams} params - The parameters for this event
- * @property {string} actionName - The action the user tried to do: Add/ Edit etc. (in English, not localized)
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid - Cairo session id
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} errorType - What is the type of the error? Technical issue	/ Network error / 10k Limitation
- * @property {string} fieldName - The name the user typed
- * @property {string} fieldType - What type is the added field? Long text / Date / Number etc.
- * @property {boolean} isTPA
- * @property {string} key - The key value
- * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
- * @property {string} permissions - Json field: {"Installed apps": "Value", "Site visitors": "Value"}. The value can be: Null (the user didn't chose anything), Read, Write, Read and Write.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoDataExtensionUnsuccessfulUpdateInServerParams>} LogObject<cairoDataExtensionUnsuccessfulUpdateInServerParams>
- */
-export declare function cairoDataExtensionUnsuccessfulUpdateInServer(params: cairoDataExtensionUnsuccessfulUpdateInServerParams): LogObject<cairoDataExtensionUnsuccessfulUpdateInServerParams>;
-/**
- * A function to create a log object for the 'cairoErrorInLoadingAComponent' event (evid: 164)
- *
- * Event description: Sent when a an error in Cairo component loading process happen . Relevant components: Picker Standalone, Picker Modal, Table, Cards.
- *
- * @param {cairoErrorInLoadingAComponentParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Picker Dropdown Table/Cards
- * @property {GUID} csid - Cairo session id
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} errorType - Error type (if known): LoadCustomFieldsWidgetLazyContentFailed /
- * InitCustomFieldsDataExtensionFailed /
- * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
- * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
- * @property {boolean} isTPA
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {Url} url - The page's url
- * @return {LogObject<cairoErrorInLoadingAComponentParams>} LogObject<cairoErrorInLoadingAComponentParams>
- */
-export declare function cairoErrorInLoadingAComponent(params: cairoErrorInLoadingAComponentParams): LogObject<cairoErrorInLoadingAComponentParams>;
-/**
- * A function to create a log object for the 'cairoReloadErrorState' event (evid: 176)
- *
- * Event description: Sent when a an error in Cairo component loading process happened and the user reload the state
- *
- * @param {cairoReloadErrorStateParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Picker Dropdown Table/Cards
- * @property {GUID} csid - Cairo session id
- * @property {string} cta - cta
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} errorType - Error type (if known): LoadCustomFieldsWidgetLazyContentFailed /
- * InitCustomFieldsDataExtensionFailed /
- * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
- * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
- * @property {boolean} isTPA
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {Url} url - The page's url
- * @return {LogObject<cairoReloadErrorStateParams>} LogObject<cairoReloadErrorStateParams>
- */
-export declare function cairoReloadErrorState(params: cairoReloadErrorStateParams): LogObject<cairoReloadErrorStateParams>;
-/**
- * A function to create a log object for the 'newItemCreationEnd' event (evid: 107)
- *
- * Event description: Sent when the "create new" process ends (and the result is shown to the user)
- *
- * @param {newItemCreationEndParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - filters
- * @property {string} currentSortOrder - sort order
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
- * @property {boolean} isTPA
- * @property {string} itemId - resultType= "success" --> itemId = ID of newly created item; resultType = "dismissed" --> itemId = null
- * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
- * @property {number} maxItems - Max number of items that can be selected
- * @property {number} numColumns - columns
- * @property {number} numFiltersActive - filters
- * @property {number} numSelectedItems - How many items have been selected before trying to create a new one. 0 <= numItems < maxItems
- * @property {number} numSortedColumns - sort
- * @property {string} origin - "Add New" click source: "Main CTA" / "Card CTA"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} resultType - "success"/"dismissed"
- * @property {string} type - standalone/modal
- * @property {string} visibleColumnsOrder - visible columns order
- * @return {LogObject<newItemCreationEndParams>} LogObject<newItemCreationEndParams>
- */
-export declare function newItemCreationEnd(params: newItemCreationEndParams): LogObject<newItemCreationEndParams>;
-/**
- * A function to create a log object for the 'cairoTagsWidgetLoaded' event (evid: 171)
- *
- * Event description: Send when a Tags' widget is loaded. Relevant for Verticals who allow use tags in their tables.
- *
- * @param {cairoTagsWidgetLoadedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} itemId - The entity ID (that the widget was loaded in its page)
- * @property {number} numTags - How many tags are existing? will get 0 if the user didn't create any tag and an empty state will be opened
- * @property {number} numTagsAssigned - How many tags are assigned to that entity when the widget is loaded?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @return {LogObject<cairoTagsWidgetLoadedParams>} LogObject<cairoTagsWidgetLoadedParams>
- */
-export declare function cairoTagsWidgetLoaded(params: cairoTagsWidgetLoadedParams): LogObject<cairoTagsWidgetLoadedParams>;
-/**
- * A function to create a log object for the 'cairoTableTopNotificationDismissed' event (evid: 137)
- *
- * Event description: Sent when the notification at the top of the table is dismissed, either manually or automatically
- *
- * @param {cairoTableTopNotificationDismissedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} dismissMode - Did the user click the X button ("manual") or was the notification automatically dismissed ("automatic")
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
- * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
- * @property {boolean} isTPA
- * @property {string} notificationText - What is displayed to the user, localized
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoTableTopNotificationDismissedParams>} LogObject<cairoTableTopNotificationDismissedParams>
- */
-export declare function cairoTableTopNotificationDismissed(params: cairoTableTopNotificationDismissedParams): LogObject<cairoTableTopNotificationDismissedParams>;
-/**
- * A function to create a log object for the 'cairoSectionCtaClicked' event (evid: 153)
- *
- * Event description: Send when a user click on a section CTA (show more / show less etc.)
- *
- * @param {cairoSectionCtaClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Section name (Folders)
- * @property {GUID} csid
- * @property {string} ctaId - CTA ID
- * @property {string} ctaName - cta key (show more / show less etc.)
- * @property {string} ctaType - Main / Secondary / More actions
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} localizedCtaName - The CTA name, localized
- * @property {string} loaction - CTA location: Section Toolbar, Collection Toolbar
- * @property {string} location - CTA location: Section Toolbar, Collection Toolbar
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} sectionType - For example: Folders, Table/Grid switch etc.
- * @return {LogObject<cairoSectionCtaClickedParams>} LogObject<cairoSectionCtaClickedParams>
- */
-export declare function cairoSectionCtaClicked(params: cairoSectionCtaClickedParams): LogObject<cairoSectionCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoFileDownloadToastDisplayed' event (evid: 132)
- *
- * Event description: Sent when the export ends successfully and the user is prompted that the file is being downloaded
- *
- * @param {cairoFileDownloadToastDisplayedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} isTPA
- * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {number} try - Which try is this; if try > 1, this is a retry
- * @return {LogObject<cairoFileDownloadToastDisplayedParams>} LogObject<cairoFileDownloadToastDisplayedParams>
- */
-export declare function cairoFileDownloadToastDisplayed(params: cairoFileDownloadToastDisplayedParams): LogObject<cairoFileDownloadToastDisplayedParams>;
-/**
- * A function to create a log object for the 'cairoSearchResults' event (evid: 116)
- *
- * Event description: Sent when the search results are displayed, after a user searches for something in a Cairo component. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
- *
- * @param {cairoSearchResultsParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {number} loadingTime - How much time (in ms) did it take to load the results for searchQuery
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {number} searchResultsCnt - How many results appeared for the search query. numSearchReults = 0 --> user saw empty state.
- * @property {string} searchTerm - What did the user search? "" if removed search term.
- * @return {LogObject<cairoSearchResultsParams>} LogObject<cairoSearchResultsParams>
- */
-export declare function cairoSearchResults(params: cairoSearchResultsParams): LogObject<cairoSearchResultsParams>;
-/**
- * A function to create a log object for the 'cairoTagsModalEndProcess' event (evid: 167)
- *
- * Event description: Send when a user click on button that will close "Tags Modal". Relevant for Verticals who allow use tags in their tables.
- *
- * @param {cairoTagsModalEndProcessParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} endType - Close without changes
- * @property {boolean} isTPA
- * @property {number} numTags - How many tags are in the modal?
- * @property {string} origin - Where did the user open Manage Tags modal from?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @return {LogObject<cairoTagsModalEndProcessParams>} LogObject<cairoTagsModalEndProcessParams>
- */
-export declare function cairoTagsModalEndProcess(params: cairoTagsModalEndProcessParams): LogObject<cairoTagsModalEndProcessParams>;
-/**
- * A function to create a log object for the 'cairoManageViewClicked' event (evid: 142)
- *
- * Event description: Sent when a user clicks on "Manage View" in a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoManageViewClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
- * @property {boolean} isTPA
- * @property {number} numFiltersInView - How many filters comprise the saved view
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoManageViewClickedParams>} LogObject<cairoManageViewClickedParams>
- */
-export declare function cairoManageViewClicked(params: cairoManageViewClickedParams): LogObject<cairoManageViewClickedParams>;
-/**
- * A function to create a log object for the 'cairoTagsModalStartLoad' event (evid: 166)
- *
- * Event description: Send when a user click on a "Tags Modal". Relevant for Verticals who allow use tags in their tables.
- *
- * @param {cairoTagsModalStartLoadParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {number} numTags - How many tags are to be presented?
- * @property {string} origin - Where did the user open Manage Tags modal from?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @return {LogObject<cairoTagsModalStartLoadParams>} LogObject<cairoTagsModalStartLoadParams>
- */
-export declare function cairoTagsModalStartLoad(params: cairoTagsModalStartLoadParams): LogObject<cairoTagsModalStartLoadParams>;
-/**
- * A function to create a log object for the 'cairoSortUnsuccessfulUpdateInServer' event (evid: 148)
- *
- * Event description: Sent when a user made a sort action but his changes weren't update in the server from different reasons
- *
- * @param {cairoSortUnsuccessfulUpdateInServerParams} params - The parameters for this event
- * @property {string} actionName - The action the user tried to do on the sorting column: "Add new sort"/"Change sort column"/"Change sort type"/"Remove sort" / "Reorder sort columns".(in English, not localized)
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards. For now, it can only be a "category filter" that is displayed in this event. (relate to ticket 525+521).
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} errorType - What is the type of the error? "Update failed" = updates has failed in the server, "Window closed" = the user clicked the X button to close the window before the server finished the update, "Left page"= the user try navigate to another page before the server finished the update
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
- * @property {string} filtersApplied - A list of filters that were displayed to user when he made the failed action: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {boolean} isFromSearch - Was the failed action made on a search results?
- * @property {boolean} isTPA
- * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
- * @property {string} origin - The location thefailed sort action was made from :"SidePanel"/"ColumnHeader"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} searchQuery - (not relevant for now) What did the user search? isFromSearch = FALSE --> searchQuery = null .
- * @property {string} sortOrderApplied - Which columns were used to sort the list when the user made the failed action: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} sortingColumn - The sorted column that the user attempted to update (but failed).
- * @property {string} tabShown
- * @property {number} timeFromEndAction - duration in ms from the end of the failed action until the error indication
- * @property {string} viewShown
- * @property {string} visibleColumnsOrder - Which columns are currently comprise the saved view- by the order the user defined
- * @return {LogObject<cairoSortUnsuccessfulUpdateInServerParams>} LogObject<cairoSortUnsuccessfulUpdateInServerParams>
- */
-export declare function cairoSortUnsuccessfulUpdateInServer(params: cairoSortUnsuccessfulUpdateInServerParams): LogObject<cairoSortUnsuccessfulUpdateInServerParams>;
-/**
- * A function to create a log object for the 'cairoItemToggledInExportModal' event (evid: 126)
- *
- * Event description: Sent when user changes selection in the Cairo export modal
- *
- * @param {cairoItemToggledInExportModalParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} availableExportTypes - A list of all of the available export types, along with the number of items that would be exported using each of the options. E.g. {"All Items": 100, "Filtered Items": 80, "Selected Items": 10}
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
- * @property {boolean} isTPA
- * @property {string} newSelectedExportType - What type of export did the user switch to: "All Items"/"Filtered Items"/"Selected Items"
- * @property {string} prevSelectedExportType - What type of export did the user have selected before swiching to newSelectedExportType: "All Items"/"Filtered Items"/"Selected Items"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoItemToggledInExportModalParams>} LogObject<cairoItemToggledInExportModalParams>
- */
-export declare function cairoItemToggledInExportModal(params: cairoItemToggledInExportModalParams): LogObject<cairoItemToggledInExportModalParams>;
-/**
- * A function to create a log object for the 'cairoDragActionUnsuccessfulUpdateInServer' event (evid: 140)
- *
- * Event description: Sent when a user finish to drag items but those changes weren't update in the server from different reasons
- *
- * @param {cairoDragActionUnsuccessfulUpdateInServerParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards. For now, it can only be a "category filter" that is displayed in this event. (relate to ticket 525+521).
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {GUID} dragAndDropID - A "couple" identifier , match between drag action and its drop action- will get the identifier of the failed action
- * @property {string} errorType - What is the type of the error? "Update failed" = updates has failed in the server, "Window closed" = the user clicked the X button to close the window before the server finished the update, "Left page"= the user try navigate to another page before the server finished the update, "External logic" = the action was cancelled due to a vertical logic
- * @property {number} filteredListSize - How many items are to be presented (filtered)?
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
- * @property {string} filtersApplied - A list of filters that were displayed to user when he made the failed action: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {boolean} isTPA
- * @property {string} itemId - ID of the item that the user tries to drag
- * @property {number} itemIndexAfter - Out of the list of results, what is the new index of the clicked item (after dragging, the new index). ** filteredListSize = X --> (1 <= itemIndexAfter <= X) **when endType <> drop succeeded --> itemIndexAfter = itemIndexBefore
- * @property {number} itemIndexBefore - Out of the list of results, what was the index of the clicked item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
- * @property {number} numItemsBefore - How many items have been selected before user clicks item and starts the drag action?
- * @property {number} numItemsBeforeFailed - How many items have been selected when user made the failed action?
- * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} searchQuery - (not relevant for now) What did the user search? isFromSearch = FALSE --> searchQuery = null .
- * @property {string} sortOrderApplied - Which columns were used to sort the list when the user made the failed action: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} tabShown - Which tab was displayed to the user when he made the failed action. Relevant for Table and Cards.
- * @property {number} timeFromEndDrag - duration in ms from the end of the drag action until the error indication
- * @property {string} viewShown - Which view was displayed to the user when he made the failed action. Relevant for Table and Cards.
- * @property {boolean} wasFromHandle - Was the failed action made from the handle area?
- * @return {LogObject<cairoDragActionUnsuccessfulUpdateInServerParams>} LogObject<cairoDragActionUnsuccessfulUpdateInServerParams>
- */
-export declare function cairoDragActionUnsuccessfulUpdateInServer(params: cairoDragActionUnsuccessfulUpdateInServerParams): LogObject<cairoDragActionUnsuccessfulUpdateInServerParams>;
-/**
- * A function to create a log object for the 'cairoSearchForTags' event (evid: 170)
- *
- * Event description: Sent when the search results are displayed, after a user searches for a tag. Relevant for tables that enabled using tags.
- *
- * @param {cairoSearchForTagsParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid - Cairo session id
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} endType - How did the search action end? "Tag selected"- the user chose one of the search results, "Search dismissed"- the user cancel the search by any other action, "Add new tag"- when the searched tag doesn't exist and the user choose to add it as new
- * @property {boolean} isTPA
- * @property {string} location - Where did the user search for the tag? Manage tags modal /
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {number} searchResultsCnt - How many results appeared for the search query. numSearchReults = 0 --> user saw the option to add this tag as new
- * @property {string} searchTerm - What did the user search? "" if removed search term.
- * @return {LogObject<cairoSearchForTagsParams>} LogObject<cairoSearchForTagsParams>
- */
-export declare function cairoSearchForTags(params: cairoSearchForTagsParams): LogObject<cairoSearchForTagsParams>;
-/**
- * A function to create a log object for the 'cairoManageViewActionSelected' event (evid: 143)
- *
- * Event description: Sent when a user selects one of the actions in "manage view" menu.
- *
- * @param {cairoManageViewActionSelectedParams} params - The parameters for this event
- * @property {number} actionIndex - 1 <= actionIndex <= numActions -- the number of the action out of all actions in the menu
- * @property {string} actionName - "view-save-new"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {number} numActions - How many actions are existing in the current menu (including disabled actions)?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoManageViewActionSelectedParams>} LogObject<cairoManageViewActionSelectedParams>
- */
-export declare function cairoManageViewActionSelected(params: cairoManageViewActionSelectedParams): LogObject<cairoManageViewActionSelectedParams>;
-/**
- * A function to create a log object for the 'cairoLearnMore' event (evid: 158)
- *
- * Event description: Send when a user click on "Learn More" from Cairo component.
- *
- * @param {cairoLearnMoreParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Section name (Folders)
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} origin - Where did the user click on "Learn more" from?  Add Custom Field Modal/ Edit Custom Field Modal / Table Toolbar
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoLearnMoreParams>} LogObject<cairoLearnMoreParams>
- */
-export declare function cairoLearnMore(params: cairoLearnMoreParams): LogObject<cairoLearnMoreParams>;
-/**
- * A function to create a log object for the 'cairoAssignTagsToEntities' event (evid: 175)
- *
- * Event description: Assign Tags to entities
- *
- * @param {cairoAssignTagsToEntitiesParams} params - The parameters for this event
- * @property {string} actionName - Assign / Remove
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} assignedTags - array of tags that were assigned (empty array if none)
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
- * @property {boolean} isTPA
- * @property {string} itemIds - array of items ids that were selected
- * @property {number} numItems - How many items have been selected?
- * @property {string} origin - Where did the user make the action from?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @property {string} unAssignedTags - array of tags that were unassigned (empty array if none)
- * @return {LogObject<cairoAssignTagsToEntitiesParams>} LogObject<cairoAssignTagsToEntitiesParams>
- */
-export declare function cairoAssignTagsToEntities(params: cairoAssignTagsToEntitiesParams): LogObject<cairoAssignTagsToEntitiesParams>;
-/**
- * A function to create a log object for the 'cairoPageCtaClicked' event (evid: 150)
- *
- * Event description: Sent when a user clicks a Page CTA ('add', 'more actions' etc.).
- *
- * @param {cairoPageCtaClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Page
- * @property {GUID} csid
- * @property {string} ctaName - "Add New"/"More Actions"... (in English only, not localized). For section= vertical / Cairo - it will be defined as unique title. For section=TPA: it will be the component_id of the TPA. To get the TPA app_id - use the table mysql.app_service.components- join on table.component_id= event.ctaName
- * @property {string} ctaType - Main / Secondary / More Actions Dropdown / More Actions Option
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {boolean} isValid - (Relevant only for Save CTA) True=if all fields are validated, False= if there are validation errors
- * @property {string} location - CTA location: TBD
- * @property {number} moreActionsIndex - (Relevant only for 'More Action Option' CTA) 0 <= moreActionsIndex <= numCtas -- the number of the CTA out of all CTAs in the more action dropdown
- * @property {number} numCtas - (Relevant only for 'More Action Option' CTA) How many CTAs are available in the more action dropdown?
- * @property {string} pageType - Collection / Entity
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} section - Relevant only for "cta type"="more actions option". Will get one of the values: Vertical / Cairo / TPA
- * @return {LogObject<cairoPageCtaClickedParams>} LogObject<cairoPageCtaClickedParams>
- */
-export declare function cairoPageCtaClicked(params: cairoPageCtaClickedParams): LogObject<cairoPageCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoTableTopNotificationDisplayed' event (evid: 136)
- *
- * Event description: Sent when a notification is displayed, showing a message that appears between the table header and the table rows
- *
- * @param {cairoTableTopNotificationDisplayedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
- * @property {boolean} isTPA
- * @property {string} notificationText - What is displayed to the user, localized
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoTableTopNotificationDisplayedParams>} LogObject<cairoTableTopNotificationDisplayedParams>
- */
-export declare function cairoTableTopNotificationDisplayed(params: cairoTableTopNotificationDisplayedParams): LogObject<cairoTableTopNotificationDisplayedParams>;
-/**
- * A function to create a log object for the 'cairoTryAgainClicked' event (evid: 141)
- *
- * Event description: Sent when a user clicks on a "try again" CTA he gets in an error notification
- *
- * @param {cairoTryAgainClickedParams} params - The parameters for this event
- * @property {string} actionName - the action name that failed and triggered the notification (for example: drag, column reorder etc.)
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {number} filteredListSize - How many items were presented when the user made the failed action (filtered)
- * @property {boolean} isFromSearch - Did the user made the failed action on a list of search results
- * @property {boolean} isTPA
- * @property {string} loaction - Toast / Custom fields widget / View only widget / Component error state
- * @property {number} numOfWaitingUpdates - (optional) number of updates in the sequence that follow the failed action
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoTryAgainClickedParams>} LogObject<cairoTryAgainClickedParams>
- */
-export declare function cairoTryAgainClicked(params: cairoTryAgainClickedParams): LogObject<cairoTryAgainClickedParams>;
-/**
- * A function to create a log object for the 'cairoFiltersPanelUsed' event (evid: 119)
- *
- * Event description: (This event was changed in 01/2023 from filter panel used to more generic - any feature panel). Sent when a feature sidebar/menu in a Cairo component is opened or closed. Relevant features: Filters, Sort, Views, Costume Columns. Relevant components: Table, Cards.
- *
- * @param {cairoFiltersPanelUsedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"} (new field from 01/2023)
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} feature - Filter / Sort / Costume Columns / Manage Views / Manage custom fields (new field from 01/2023)/Tags
- * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
- * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view, "false" if it's a user view and "null" if the action wasn't made over any view (new field from 01/2023)
- * @property {boolean} isTPA
- * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
- * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
- * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
- * @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
- * @property {string} origin - From where did the user open/close the panel: Create View, Filter Button, X Button, Sort CTA, Costume Columns CTA, Manage Views, Entity page custom fields, Assign Tags
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {number} timeFromAction - The time from user click on open/close filter panel until he gets feedback and sees the panel opened/closed, in ms (new from Dec 2022, relevant only for filter)
- * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
- * @return {LogObject<cairoFiltersPanelUsedParams>} LogObject<cairoFiltersPanelUsedParams>
- */
-export declare function cairoFiltersPanelUsed(params: cairoFiltersPanelUsedParams): LogObject<cairoFiltersPanelUsedParams>;
-/**
- * A function to create a log object for the 'cairoDragItem' event (evid: 138)
- *
- * Event description: Sent when a user clicks on an item and tries to drag it, in order to sort the items manually
- *
- * @param {cairoDragItemParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards. For now, it can only be a "category filter" that is displayed in this event. (relate to ticket 525+521).
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {GUID} dragAndDropID - A "couple" identifier , match between drag action and its drop action
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isFromHandle - Is the item dragged from the handle area?
- * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
- * @property {boolean} isTPA
- * @property {string} itemId - ID of the item that the user tries to drag.
- * @property {number} itemIndex - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndex <= X)
- * @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} searchQuery - What did the user search? isFromSearch = FALSE --> searchQuery = null. (relate to ticket 521).
- * @return {LogObject<cairoDragItemParams>} LogObject<cairoDragItemParams>
- */
-export declare function cairoDragItem(params: cairoDragItemParams): LogObject<cairoDragItemParams>;
-/**
- * A function to create a log object for the 'cairoFileDownloadToastDismissed' event (evid: 133)
- *
- * Event description: Sent when the toast that tells the user that the export is done and the file is being downloaded is dismissed (by user or automatically).
- *
- * @param {cairoFileDownloadToastDismissedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} dismissMode - Did the user click the X button ("manual") or was the notification automatically dismissed ("automatic")
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} isTPA
- * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoFileDownloadToastDismissedParams>} LogObject<cairoFileDownloadToastDismissedParams>
- */
-export declare function cairoFileDownloadToastDismissed(params: cairoFileDownloadToastDismissedParams): LogObject<cairoFileDownloadToastDismissedParams>;
-/**
- * A function to create a log object for the 'cairoUserAttemptsToCancelTheExport' event (evid: 129)
- *
- * Event description: Sent when the user tries to cancel the export process AFTER it has begun
- *
- * @param {cairoUserAttemptsToCancelTheExportParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} duration - How much time (in ms) did it take since the export process began
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {boolean} isTPA
- * @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
- * @property {string} origin - How did the user try to cancel the export process: "Tab Closed"/"Cancel Buton"/"X Button"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
- * @property {number} try - Which try is this; if try > 1, this is a retry
- * @return {LogObject<cairoUserAttemptsToCancelTheExportParams>} LogObject<cairoUserAttemptsToCancelTheExportParams>
- */
-export declare function cairoUserAttemptsToCancelTheExport(params: cairoUserAttemptsToCancelTheExportParams): LogObject<cairoUserAttemptsToCancelTheExportParams>;
-/**
- * A function to create a log object for the 'pickerPickModalCtaButtonClickOrImmediateCta' event (evid: 104)
- *
- * Event description: Actual pick inside the Cairo picker (CTA button or immediate CTA)
- *
- * @param {pickerPickModalCtaButtonClickOrImmediateCtaParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
- * @property {string} componentType
- * @property {GUID} csid
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are to presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isImmediate - Is it an immediate CTA
- * @property {boolean} isTPA
- * @property {number} itemsCnt - Number of total items picked
- * @property {number} listSize - How many items exist (full list)
- * @property {number} maxItems - Max items to select in picker
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
- * @property {string} type - standalone/modal
- * @return {LogObject<pickerPickModalCtaButtonClickOrImmediateCtaParams>} LogObject<pickerPickModalCtaButtonClickOrImmediateCtaParams>
- */
-export declare function pickerPickModalCtaButtonClickOrImmediateCta(params: pickerPickModalCtaButtonClickOrImmediateCtaParams): LogObject<pickerPickModalCtaButtonClickOrImmediateCtaParams>;
-/**
- * A function to create a log object for the 'newItemCreationStart' event (evid: 106)
- *
- * Event description: Sent when the user clicks the "create new" button
- *
- * @param {newItemCreationStartParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - current filters
- * @property {string} currentSortOrder - sorts
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
- * @property {number} maxItems - Max number of items that can be selected
- * @property {number} numColumns - columns
- * @property {number} numFiltersActive - filters
- * @property {number} numSelectedItems - How many items have been selected before trying to create a new one. 0 <= numSelectedItems < maxItems
- * @property {number} numSortedColumns - sort
- * @property {string} origin - "Add New" click source: "Main CTA" / "Card CTA"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} type - standalone/modal
- * @property {string} visibleColumnsOrder - visible columns order
- * @return {LogObject<newItemCreationStartParams>} LogObject<newItemCreationStartParams>
- */
-export declare function newItemCreationStart(params: newItemCreationStartParams): LogObject<newItemCreationStartParams>;
-/**
- * A function to create a log object for the 'cairoViewSelected' event (evid: 123)
- *
- * Event description: Sent when a user selects a view in a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoViewSelectedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - The current state of filters, after the new view selection
- * @property {string} currentView - The selected view ID (match to "new view name", new field from 12/2022)
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
- * @property {boolean} isDefault - Is the selected view defined as default view?
- * @property {boolean} isFromSearchView - True if the view was selected from "search view in views dropdown" results (new from 01/2023)
- * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
- * @property {boolean} isTPA
- * @property {string} newViewName - Name of the newly selected view
- * @property {number} numFiltersActive - How many filters are active after view selection
- * @property {string} prevFilters - (Optional) The prevoius state of filters, before the new view selection
- * @property {string} prevViewName - (Optional) Name of the previous view that the user was using. null if no view was selected.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoViewSelectedParams>} LogObject<cairoViewSelectedParams>
- */
-export declare function cairoViewSelected(params: cairoViewSelectedParams): LogObject<cairoViewSelectedParams>;
-/**
- * A function to create a log object for the 'cairoDataExAddCustomField' event (evid: 155)
- *
- * Event description: Send when a user click on a "Add Custom Field". Relevant for Verticals who allow data extensions
- *
- * @param {cairoDataExAddCustomFieldParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {number} numColumns - How many columns are shown?
- * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page / Manage custom fields /  Custom fields widget / External (the origin is external to Cairo)
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource
- * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined
- * @return {LogObject<cairoDataExAddCustomFieldParams>} LogObject<cairoDataExAddCustomFieldParams>
- */
-export declare function cairoDataExAddCustomField(params: cairoDataExAddCustomFieldParams): LogObject<cairoDataExAddCustomFieldParams>;
-/**
- * A function to create a log object for the 'cairoFilterToggled' event (evid: 117)
- *
- * Event description: Sent when a user triggers/removes a filter from a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoFilterToggledParams} params - The parameters for this event
- * @property {string} actionType - "add"/"remove" -- Did we add or remove filterName from the list of filters
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards / Picker (from 12/2022)
- * @property {GUID} csid - Cairo session ID
- * @property {string} currentFilters - The current state of filters, following the filter trigger
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} filterName - Which column filter do we want to toggle now, e.g. Beginner / Amateur
- * @property {string} filterValue - JSON containing filterName's new value
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist (full list, unfiltered)
- * @property {number} numFiltersActive - How many filters are active after filterName is toggled. actionType = "add" --> numFiltersActive >= 1; actionType = "remove" --> numFiltersActive < numColumns
- * @property {string} origin - "Panel"/"SubToolbar"/"Toolbar"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoFilterToggledParams>} LogObject<cairoFilterToggledParams>
- */
-export declare function cairoFilterToggled(params: cairoFilterToggledParams): LogObject<cairoFilterToggledParams>;
-/**
- * A function to create a log object for the 'cairoDataExCustomFieldAdvancesSettings' event (evid: 157)
- *
- * Event description: Send when a user click on "Advanced Settings" in the  "Add Custom Field" modal. Relevant for Verticals who allowed data extensions
- *
- * @param {cairoDataExCustomFieldAdvancesSettingsParams} params - The parameters for this event
- * @property {string} actionName - Open / Close the advanced settings
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} origin - Where did the user click on "Advanced Settings" from?  Add Custom Field Modal / Edit Custom Field Modal
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoDataExCustomFieldAdvancesSettingsParams>} LogObject<cairoDataExCustomFieldAdvancesSettingsParams>
- */
-export declare function cairoDataExCustomFieldAdvancesSettings(params: cairoDataExCustomFieldAdvancesSettingsParams): LogObject<cairoDataExCustomFieldAdvancesSettingsParams>;
-/**
- * A function to create a log object for the 'cairoViewSaved' event (evid: 122)
- *
- * Event description: Sent when a user creates/saves a view in a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoViewSavedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} changedAttributes - Which attributes have changed from the last view version? If it's a new view - all the attributes that define the view will be noted. The attributes can be: Filters, Columns Order, Columns Visibility, Sorting, Search (new field from 11/2022)
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} viewFilters - The filters that comprise the view that was just saved
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"} (new field from 11/2022)
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isDefault - Is the saved view defined as default view?
- * @property {boolean} isPredefined - (Relevant only for "save as new view" action, will get null in other cases). Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view. (new field from 11/2022)
- * @property {boolean} isTPA
- * @property {string} newViewName - Name of the newly created/saved/renamed view
- * @property {number} numColumnsInView - How many columns comprise the saved view (new field from 11/2022)
- * @property {number} numFiltersInView - How many filters comprise the saved view
- * @property {string} origin - From where was the view created: Panel, SubToolbar, Toolbar
- * @property {string} prevName - View's previous name. In case of 'save as new view' will get null, in case of 'save changes': prev name=new view name, in case of 'rename' will get the previous version of the view's name (new field from 11/2022)
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} saveType - The save type the user chose from the 'manage view' menu: "save as new view"/ "save changes" / "rename" (new field from 11/2022)
- * @property {string} searchQuery - What did the user search? If there wasn't any search --> searchQuery = null. (new field from 11/2022)
- * @property {string} viewId - The "new view name" unique identifier (new field from 11/2022)
- * @property {string} visibleColumnsOrder - Which columns are currently comprise the saved view- by the order the user defined (new field from 11/2022)
- * @return {LogObject<cairoViewSavedParams>} LogObject<cairoViewSavedParams>
- */
-export declare function cairoViewSaved(params: cairoViewSavedParams): LogObject<cairoViewSavedParams>;
-/**
- * A function to create a log object for the 'cairoViewDeleted' event (evid: 124)
- *
- * Event description: Sent when a user deletes a view in a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoViewDeletedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isDefault - Was the deleted view defined as default view?
- * @property {boolean} isTPA
- * @property {number} numFiltersInView - How many filters comprised the deleted view
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} viewFilters - The filters that comprised the view that was just deleted
- * @property {string} viewId - The "view name" (deleted view) unique identifier (new field from 11/2022)
- * @property {string} viewName - Name of the deleted view
- * @property {boolean} wasSelected - TRUE if viewName was the selected view before deletion; FALSE otherwise
- * @return {LogObject<cairoViewDeletedParams>} LogObject<cairoViewDeletedParams>
- */
-export declare function cairoViewDeleted(params: cairoViewDeletedParams): LogObject<cairoViewDeletedParams>;
-/**
- * A function to create a log object for the 'cairoDataExCustomFieldEndProcess' event (evid: 156)
- *
- * Event description: Send when a user click on cancel / add field in the  "Add Custom Field" modal. Relevant for Verticals who allowed data extensions
- *
- * @param {cairoDataExCustomFieldEndProcessParams} params - The parameters for this event
- * @property {string} actionName - Add/ Edit
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} changedFields - (Relevant when action type is edit) Name / Permission / Name and Permission / No changes
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Section name (Folders)
- * @property {GUID} csid - Cairo session ID
- * @property {string} currentDropdownOptions - Only for fieldType= dropdown,  the options list by its order
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} endType - What did the user chose in the modal? Add field / Cancel
- * @property {string} fieldName - (Relevant when a field was added/edited) The name the user typed
- * @property {string} fieldType - (Relevant when a field was added) What type is the added field?  Long text / Date / Number etc.
- * @property {boolean} isTPA
- * @property {string} key - The key value
- * @property {number} numAdded - (Relevant when a field was added/edited) How many added fields are there in the component (including the current added field)
- * @property {number} numDropdownOptions - Only for fieldType= dropdown, how many options were saved?
- * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
- * @property {string} permissions - Json field:  {"Installed apps": "Value", "Site visitors": "Value"}. The value can be: Null (the user didn't chose anything), Read, Write, Read and Write.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoDataExCustomFieldEndProcessParams>} LogObject<cairoDataExCustomFieldEndProcessParams>
- */
-export declare function cairoDataExCustomFieldEndProcess(params: cairoDataExCustomFieldEndProcessParams): LogObject<cairoDataExCustomFieldEndProcessParams>;
-/**
- * A function to create a log object for the 'cairoComponentSorted' event (evid: 120)
- *
- * Event description: Sent when a user sorts a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoComponentSortedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
- * @property {boolean} isAddNewSort - Indication for adding new sort. Will get "true" for cases the event was sent for adding new sort (and "false" for changing the sorted column, sorted order or remove sort) (new from 12/2022)
- * @property {boolean} isTPA
- * @property {number} itemIndex - The item index inside the sort panel. First row will get 0. In case of simple sort (only 1 column  sorts the table) from the column header - the index will be 0. In case a sorting column was removed from sorting- will get (-1)
- * @property {number} listSize - How many items exist (full list, unfiltered)
- * @property {string} newSortOrder - Which columns are currently used to sort the list, by the order the user defined: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards. (new field from 11/2022)
- * @property {string} newSortedColumn - By which column are we adding sorting now
- * @property {string} newSortingOrder - "asc"/"desc"/"removed" (was "null" until 12/2022, then changed to "removed")
- * @property {number} numSortingColumns - The number of columns that sorting the component after the current action
- * @property {string} origin - The location the sort action was made from :"SidePanel"/"ColumnHeader" (new field from 11/2022)
- * @property {number} prevNumSortingColumns - The number of columns that were sorting the component before the current action
- * @property {string} prevSortOrder - Which columns were used to sort the list (before the current addition), by the order the user defined: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards. (new field from 11/2022)
- * @property {string} prevSortedColumn - The column the user used to sort the component with in the previous sort action. If list wasn't sorted, this should be null
- * @property {string} prevSortingOrder - The last order the user used to sort the list by "prev sorting column" : "asc"/"desc"/null (if wasn't sorted)
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoComponentSortedParams>} LogObject<cairoComponentSortedParams>
- */
-export declare function cairoComponentSorted(params: cairoComponentSortedParams): LogObject<cairoComponentSortedParams>;
-/**
- * A function to create a log object for the 'cairoReorderingSortColumns' event (evid: 147)
- *
- * Event description: Sent when a user changes the order of the columns that sort a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoReorderingSortColumnsParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {number} columnIndexAfter - Out of the list of sorting columns, what is the index of the sorting column (after reordering). ** numSortingColumns = X --> (1 <= columnIndexAfter <= X)
- * @property {number} columnIndexBefore - Out of the list of sorting columns, what was the index of the sorting column (before reordering). ** numSortingColumns = X --> (1 <= columnIndexBefore <= X)
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist (full list, unfiltered)
- * @property {string} newSortOrder - Which columns are currently used to sort the list, by the new order the user defined: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
- * @property {number} numSortingColumns - How many columns are been used for sorting the component?
- * @property {string} prevSortOrder - Which columns are currently used to sort the list, by the previus order the user defined (before the reordering action) : [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} sortingColumn - The sorting column that the user changes its place in the sort hierarchy
- * @property {number} timeFromAction - Time (in ms) that has passed since the user added this specific row in the sort panel. Will give data up to 10 sec from adding the row (if it's over these 10 sec- will get null). When sent for clicking on "add new sort" / for clicking for the first time on a column's header- will get '0'.
- * @return {LogObject<cairoReorderingSortColumnsParams>} LogObject<cairoReorderingSortColumnsParams>
- */
-export declare function cairoReorderingSortColumns(params: cairoReorderingSortColumnsParams): LogObject<cairoReorderingSortColumnsParams>;
-/**
- * A function to create a log object for the 'cairoExportProcessEnd' event (evid: 131)
- *
- * Event description: Sent when the export process ends, either successfully or not (failed/stopped by user)
- *
- * @param {cairoExportProcessEndParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {number} duration - How much time (in ms) did it take since the export process began
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {string} fileName - (Optional) Name of the file to be exported
- * @property {boolean} isTPA
- * @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {number} numItemsExported - How many items were exported before the export ended, either successfully or not.
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} result - Was the export successful or did it fail/stopped by user: "success"/'fail"/"stopped by user"
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
- * @property {number} try - Which try is this; if try > 1, this is a retry
- * @return {LogObject<cairoExportProcessEndParams>} LogObject<cairoExportProcessEndParams>
- */
-export declare function cairoExportProcessEnd(params: cairoExportProcessEndParams): LogObject<cairoExportProcessEndParams>;
-/**
- * A function to create a log object for the 'cairoApplyButtonClicked' event (evid: 159)
- *
- * Event description: Sent when a user clicks on apply button in a Cairo component. Relevant components: Table, Cards.
- *
- * @param {cairoApplyButtonClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId
- * @property {string} cairoVersion - Cairo version
- * @property {string} changedLevels - In which levels of hierarchy the user changed the order? (numbers with commas between them, 1=the highest parent level )
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards / Picker (from 12/2022)
- * @property {GUID} csid - Cairo session ID
- * @property {string} currentStatus - (Optional, relevant for Filters) Json field: The current state of feature, following the apply button. [{"fieldName": "FIELD_NAME1", "field_value": "VALUE1"}] (for filters -all the filters will appear in this list, filters that not active will get NULL in the filters' value)
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {string} feature - Filters / Drag and Drop
- * @property {number} filteredListSize - How many items are currently presented to user, after filters toggled (filtered)
- * @property {boolean} isTPA
- * @property {number} listSize - How many items exist (full list, unfiltered)
- * @property {number} numActiveFields - (Optional, relevant for Filters) How many fields are active after the apply button is clicked? (fields that their value is not NULL)
- * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
- * @property {number} numOptionalFields - (Optional, relevant for Filters)  If there is an optional fields list (like for filters)- how many options are there?
- * @property {string} origin - Feature's Side Panel / Table Toolbar
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoApplyButtonClickedParams>} LogObject<cairoApplyButtonClickedParams>
- */
-export declare function cairoApplyButtonClicked(params: cairoApplyButtonClickedParams): LogObject<cairoApplyButtonClickedParams>;
-/**
- * A function to create a log object for the 'cairoExportModalCtaClicked' event (evid: 127)
- *
- * Event description: Sent when the user clicks any CTA in the export modal
- *
- * @param {cairoExportModalCtaClickedParams} params - The parameters for this event
- * @property {string} action - Does the user want to proceed with the export or dismiss the modal
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} availableExportTypes - A list of all of the available export types, along with the number of items that would be exported using each of the options
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table
- * @property {GUID} csid
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
- * @property {boolean} isTPA
- * @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
- * @property {string} origin - From where did the user close the modal: "Export Button"/"Cancel Button"/"X Button"
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
- * @return {LogObject<cairoExportModalCtaClickedParams>} LogObject<cairoExportModalCtaClickedParams>
- */
-export declare function cairoExportModalCtaClicked(params: cairoExportModalCtaClickedParams): LogObject<cairoExportModalCtaClickedParams>;
-/**
- * A function to create a log object for the 'cairoUndoClicked' event (evid: 144)
- *
- * Event description: Sent when a user clicks on a "undo" CTA he gets in a toast confirming an action was made
- *
- * @param {cairoUndoClickedParams} params - The parameters for this event
- * @property {string} actionName - The action's name the user wants to undo and triggered the toast (for example: view- save changes, view- rename, view- delete etc.)
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - cairo version
- * @property {string} changedAttributes - Which attributes have changed from the saved status to the current
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the action he wants to undo?
- * @property {boolean} isTPA
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} sortOrderApplied - Which columns were used to sort the list when the user made the action he wants to undo: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} viewId - The view that the undo action was made on
- * @property {string} viewName - The view name that the undo action was made on (in case of rename view- this will give the original view name)
- * @property {string} viewNameApplied - In case of action name=rename view - the new name the user gave to the view and now he undo it
- * @return {LogObject<cairoUndoClickedParams>} LogObject<cairoUndoClickedParams>
- */
-export declare function cairoUndoClicked(params: cairoUndoClickedParams): LogObject<cairoUndoClickedParams>;
-/**
- * A function to create a log object for the 'cairoPageBackOrBreadcrumbClicked' event (evid: 152)
- *
- * Event description: Sent when a user clicks a Back button or on the higher hierarchy in the breadcrumbs
- *
- * @param {cairoPageBackOrBreadcrumbClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} buttonName - 'Back' (for back button clicked) / The category's name the users clicked on.
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Page
- * @property {GUID} csid
- * @property {string} destination_page_type - Higher hierarchy (can be relevant both for back button and breadcrumb clicked )/ Last page in BM (relevant only for back button clicked)
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} pageType - Collection Page
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} section - Relevant only for "cta type"="more actions option". For now, will get one of the values: Vertical / Cairo
- * @return {LogObject<cairoPageBackOrBreadcrumbClickedParams>} LogObject<cairoPageBackOrBreadcrumbClickedParams>
- */
-export declare function cairoPageBackOrBreadcrumbClicked(params: cairoPageBackOrBreadcrumbClickedParams): LogObject<cairoPageBackOrBreadcrumbClickedParams>;
-/**
- * A function to create a log object for the 'cairoTpaSCtaClicked' event (evid: 154)
- *
- * Event description: Send when a user click on a TPA's CTA from a Cairo component
- *
- * @param {cairoTpaSCtaClickedParams} params - The parameters for this event
- * @property {GUID} appId - App ID (for now- please look at tpaComponentId field description to get this data)
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component's name, if there are two components of the same type per artifact
- * @property {string} componentType - Table, Grid, Page etc.
- * @property {GUID} csid
- * @property {number} ctaIndex - 0 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the page dropdown menu/ Toolbar
- * @property {string} ctaName - TPA's component_id. To get the TPA app_id - use the table mysql.app_service.components- join on table.component_id= event.ctaName
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} location - Page More Action Dropdown / Component Bulk action Toolbar
- * @property {number} numCtas - How many CTAs are available in the page dropdown menu / toolbar?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} tpaComponentId - TPA's component_id from dev center. To get the TPA app_id - use the table mysql.app_service.components- join on table.component_id= event.tpa_component_id
- * @return {LogObject<cairoTpaSCtaClickedParams>} LogObject<cairoTpaSCtaClickedParams>
- */
-export declare function cairoTpaSCtaClicked(params: cairoTpaSCtaClickedParams): LogObject<cairoTpaSCtaClickedParams>;
-/**
- * A function to create a log object for the 'pikachuCategoriesDropdownButtonClicked' event (evid: 108)
- *
- * Event description: Sent when user clicks the general "+"/"Add Items" button that opens Pikachu
- *
- * @param {pikachuCategoriesDropdownButtonClickedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType
- * @property {GUID} csid
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isTPA
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<pikachuCategoriesDropdownButtonClickedParams>} LogObject<pikachuCategoriesDropdownButtonClickedParams>
- */
-export declare function pikachuCategoriesDropdownButtonClicked(params: pikachuCategoriesDropdownButtonClickedParams): LogObject<pikachuCategoriesDropdownButtonClickedParams>;
-/**
- * A function to create a log object for the 'cairoTagsUnsuccessfulUpdateInServer' event (evid: 169)
- *
- * Event description: Send when a user tried to add/delete/rename/assign/remove assigned tag, but his changes weren't update in the server from different reasons. Relevant for Verticals who allow use tags in their tables.
- *
- * @param {cairoTagsUnsuccessfulUpdateInServerParams} params - The parameters for this event
- * @property {string} actionName - Add / Delete / Rename / Assign / Remove assign / Add and assign / Load tags widget
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {string} errorType - What is the type of the error? Technical issue / Network error
- * @property {boolean} isTPA
- * @property {number} numTags - How many tags are in the modal after this action?
- * @property {string} origin - Where did the user make the action from? Tags Modal / Entity page
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @property {string} tagName - The name of the removed/added/assigned tag
- * @return {LogObject<cairoTagsUnsuccessfulUpdateInServerParams>} LogObject<cairoTagsUnsuccessfulUpdateInServerParams>
- */
-export declare function cairoTagsUnsuccessfulUpdateInServer(params: cairoTagsUnsuccessfulUpdateInServerParams): LogObject<cairoTagsUnsuccessfulUpdateInServerParams>;
-/**
- * A function to create a log object for the 'pickerModalUsability' event (evid: 103)
- *
- * Event description: Any usability action performed inside the picker
- *
- * @param {pickerModalUsabilityParams} params - The parameters for this event
- * @property {string} action - Use cases: search/search results/checkbox/continue/dismiss/load more
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
- * @property {string} componentType
- * @property {GUID} csid
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
- * @property {number} filteredListSize - How many items are to presented (filtered)
- * @property {boolean} isTPA
- * @property {string} itemId - (Optional) ID of item checked
- * @property {number} itemsCnt - (Optional) Number of total items checked
- * @property {number} itemsLoadedCnt - (Optional) Number of additional items loaded
- * @property {number} listSize - How many items exist (full list)
- * @property {number} loadingTime - (Optional) Loading time for use cases such as search results or  load more
- * @property {number} maxItems - Max items to select in picker
- * @property {string} pickSource - The instance that lead to this (Inbox)
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
- * @property {number} searchResultsCnt - (Optional) Number of search results
- * @property {string} searchTerm - (Optional) Search term used
- * @property {string} type - standalone/modal
- * @return {LogObject<pickerModalUsabilityParams>} LogObject<pickerModalUsabilityParams>
- */
-export declare function pickerModalUsability(params: pickerModalUsabilityParams): LogObject<pickerModalUsabilityParams>;
-/**
- * A function to create a log object for the 'cairoSortPanelUsed' event (evid: 146)
- *
- * Event description: Sent when the sort sidebar in a Cairo component is opened or closed. Relevant components: Table, Cards.
- *
- * @param {cairoSortPanelUsedParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Table/Cards
- * @property {GUID} csid
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
- * @property {boolean} isTPA
- * @property {number} numSortedColumns - How many columns actively sort the data?
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @return {LogObject<cairoSortPanelUsedParams>} LogObject<cairoSortPanelUsedParams>
- */
-export declare function cairoSortPanelUsed(params: cairoSortPanelUsedParams): LogObject<cairoSortPanelUsedParams>;
-/**
- * A function to create a log object for the 'cairoTagsAssignTag' event (evid: 173)
- *
- * Event description: Send when a user assign or remove a tag from an item. Relevant for Verticals who allow use tags in their tables.
- *
- * @param {cairoTagsAssignTagParams} params - The parameters for this event
- * @property {string} actionName - Assign / Remove
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Component type
- * @property {GUID} csid - Cairo session ID
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
- * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
- * @property {boolean} isTPA
- * @property {string} itemId - (Relevant if numItems=1) The Item which the tag was assigned to / removed from
- * @property {number} numItems - How many items have been selected?
- * @property {number} numTags - How many tags are existing? will get 0 if the user didn't create any tag and an empty state will be opened
- * @property {number} numTagsAssigned - (Relevant if numItems=1) How many tags are assigned to that item after this action?
- * @property {string} origin - Where did the user make the action from? Entity page /
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - resource
- * @property {string} tagName - The name of the assigned/ removed tag
- * @return {LogObject<cairoTagsAssignTagParams>} LogObject<cairoTagsAssignTagParams>
- */
-export declare function cairoTagsAssignTag(params: cairoTagsAssignTagParams): LogObject<cairoTagsAssignTagParams>;
-/**
- * A function to create a log object for the 'cairoApiRequestDataLoadEnd' event (evid: 149)
- *
- * Event description: Sent when a Cairo's page can't be saved due to an error.
- *
- * @param {cairoApiRequestDataLoadEndParams} params - The parameters for this event
- * @property {string} appId
- * @property {string} artifactId - Artifact that owns the component
- * @property {string} cairoVersion - Cairo version
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
- * @property {GUID} csid
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
- * @property {number} duration - Duration in ms, from clicking on the save button until getting the error indication
- * @property {string} errorType - Technical issue / Logic error / Network error / External error
- * @property {number} filteredListSize - How many items are to be presented (filtered)
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
- * @property {boolean} isTPA
- * @property {string} pageType - Entity / Collection
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
- * @property {string} route - the page's route
- * @return {LogObject<cairoApiRequestDataLoadEndParams>} LogObject<cairoApiRequestDataLoadEndParams>
- */
-export declare function cairoApiRequestDataLoadEnd(params: cairoApiRequestDataLoadEndParams): LogObject<cairoApiRequestDataLoadEndParams>;