@wix/bex-utils 2.6.0 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/@wix/bi-logger-os-data/dist/cjs/index.js +4279 -0
  2. package/@wix/bi-logger-os-data/dist/cjs/index.js.map +1 -0
  3. package/@wix/bi-logger-os-data/dist/cjs/testkit/client-testkit.js +4288 -0
  4. package/@wix/bi-logger-os-data/dist/cjs/testkit/client-testkit.js.map +1 -0
  5. package/@wix/bi-logger-os-data/dist/cjs/testkit/common.js +56732 -0
  6. package/@wix/bi-logger-os-data/dist/cjs/testkit/common.js.map +1 -0
  7. package/@wix/bi-logger-os-data/dist/cjs/testkit/node-testkit.js +4314 -0
  8. package/@wix/bi-logger-os-data/dist/cjs/testkit/node-testkit.js.map +1 -0
  9. package/@wix/bi-logger-os-data/dist/cjs/v2/index.js +26632 -0
  10. package/@wix/bi-logger-os-data/dist/cjs/v2/index.js.map +1 -0
  11. package/@wix/bi-logger-os-data/dist/esm/index.js +4274 -0
  12. package/@wix/bi-logger-os-data/dist/esm/index.js.map +1 -0
  13. package/@wix/bi-logger-os-data/dist/esm/testkit/client-testkit.js +4279 -0
  14. package/@wix/bi-logger-os-data/dist/esm/testkit/client-testkit.js.map +1 -0
  15. package/@wix/bi-logger-os-data/dist/esm/testkit/common.js +56727 -0
  16. package/@wix/bi-logger-os-data/dist/esm/testkit/common.js.map +1 -0
  17. package/@wix/bi-logger-os-data/dist/esm/testkit/node-testkit.js +4285 -0
  18. package/@wix/bi-logger-os-data/dist/esm/testkit/node-testkit.js.map +1 -0
  19. package/@wix/bi-logger-os-data/dist/esm/v2/index.js +25192 -0
  20. package/@wix/bi-logger-os-data/dist/esm/v2/index.js.map +1 -0
  21. package/@wix/bi-logger-os-data/dist/types/index.d.ts +1426 -0
  22. package/@wix/bi-logger-os-data/dist/types/testkit/client-testkit.d.ts +12457 -0
  23. package/@wix/bi-logger-os-data/dist/types/testkit/node-testkit.d.ts +12458 -0
  24. package/@wix/bi-logger-os-data/dist/types/types.d.ts +12452 -0
  25. package/@wix/bi-logger-os-data/dist/types/v2/index.d.ts +22374 -0
  26. package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/package.json +6 -6
  27. package/@wix/bi-logger-os-data/src/index.ts +5678 -0
  28. package/@wix/bi-logger-os-data/src/testkit/client-testkit.ts +16678 -0
  29. package/@wix/bi-logger-os-data/src/testkit/common.ts +65077 -0
  30. package/@wix/bi-logger-os-data/src/testkit/node-testkit.ts +16688 -0
  31. package/@wix/bi-logger-os-data/src/types.ts +22122 -0
  32. package/@wix/bi-logger-os-data/src/v2/index.ts +26601 -0
  33. package/README.md +1 -1
  34. package/package.json +3 -3
  35. package/@wix/bi-logger-cairo-os/dist/cjs/index.js +0 -297
  36. package/@wix/bi-logger-cairo-os/dist/cjs/index.js.map +0 -1
  37. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/client-testkit.js +0 -603
  38. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/client-testkit.js.map +0 -1
  39. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/common.js +0 -7239
  40. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/common.js.map +0 -1
  41. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/node-testkit.js +0 -647
  42. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/node-testkit.js.map +0 -1
  43. package/@wix/bi-logger-cairo-os/dist/cjs/v2/index.js +0 -2267
  44. package/@wix/bi-logger-cairo-os/dist/cjs/v2/index.js.map +0 -1
  45. package/@wix/bi-logger-cairo-os/dist/esm/index.js +0 -293
  46. package/@wix/bi-logger-cairo-os/dist/esm/index.js.map +0 -1
  47. package/@wix/bi-logger-cairo-os/dist/esm/testkit/client-testkit.js +0 -595
  48. package/@wix/bi-logger-cairo-os/dist/esm/testkit/client-testkit.js.map +0 -1
  49. package/@wix/bi-logger-cairo-os/dist/esm/testkit/common.js +0 -7235
  50. package/@wix/bi-logger-cairo-os/dist/esm/testkit/common.js.map +0 -1
  51. package/@wix/bi-logger-cairo-os/dist/esm/testkit/node-testkit.js +0 -619
  52. package/@wix/bi-logger-cairo-os/dist/esm/testkit/node-testkit.js.map +0 -1
  53. package/@wix/bi-logger-cairo-os/dist/esm/v2/index.js +0 -2186
  54. package/@wix/bi-logger-cairo-os/dist/esm/v2/index.js.map +0 -1
  55. package/@wix/bi-logger-cairo-os/dist/types/index.d.ts +0 -94
  56. package/@wix/bi-logger-cairo-os/dist/types/testkit/client-testkit.d.ts +0 -1510
  57. package/@wix/bi-logger-cairo-os/dist/types/testkit/node-testkit.d.ts +0 -1511
  58. package/@wix/bi-logger-cairo-os/dist/types/types.d.ts +0 -1505
  59. package/@wix/bi-logger-cairo-os/dist/types/v2/index.d.ts +0 -2032
  60. package/@wix/bi-logger-cairo-os/src/index.ts +0 -350
  61. package/@wix/bi-logger-cairo-os/src/testkit/client-testkit.ts +0 -1771
  62. package/@wix/bi-logger-cairo-os/src/testkit/common.ts +0 -7312
  63. package/@wix/bi-logger-cairo-os/src/testkit/node-testkit.ts +0 -1781
  64. package/@wix/bi-logger-cairo-os/src/types.ts +0 -2596
  65. package/@wix/bi-logger-cairo-os/src/v2/index.ts +0 -2263
  66. package/@wix/bi-logger-cairo-os/testkit/package.json +0 -6
  67. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/dist/cjs/types.js +0 -0
  68. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/dist/cjs/types.js.map +0 -0
  69. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/dist/esm/types.js +0 -0
  70. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/dist/esm/types.js.map +0 -0
  71. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/dist/types/testkit/common.d.ts +0 -0
  72. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/src/external-types.d.ts +0 -0
  73. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/testkit/client/package.json +0 -0
  74. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/testkit/node/package.json +0 -0
  75. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/v2/package.json +0 -0
  76. /package/@wix/{bi-logger-cairo-os → bi-logger-os-data}/v2/types.d.ts +0 -0
@@ -1,2267 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.cairoTryAgainClicked = exports.cairoTableTopNotificationDisplayed = exports.cairoPageCtaClicked = exports.cairoAssignTagsToEntities = exports.cairoLearnMore = exports.cairoManageViewActionSelected = exports.cairoSearchForTags = exports.cairoDragActionUnsuccessfulUpdateInServer = exports.cairoItemToggledInExportModal = exports.cairoSortUnsuccessfulUpdateInServer = exports.cairoTagsModalStartLoad = exports.cairoManageViewClicked = exports.cairoTagsModalEndProcess = exports.cairoSearchResults = exports.cairoFileDownloadToastDisplayed = exports.cairoSectionCtaClicked = exports.cairoTableTopNotificationDismissed = exports.cairoTagsWidgetLoaded = exports.newItemCreationEnd = exports.cairoReloadErrorState = exports.cairoErrorInLoadingAComponent = exports.cairoDataExtensionUnsuccessfulUpdateInServer = exports.cairoTagsWidgetClickOnCta = exports.cairoChangesBeforeApply = exports.cairoCtaClicked = exports.cairoAllFiltersCleared = exports.cairoModalCtaClicked = exports.cairoViewsUnsuccessfulUpdateInServer = exports.cairoTabSelected = exports.cairoCustomizeColumnsInSidePanel = exports.cairoFileDownloadToastDownloadButtonClicked = exports.cairoPageDiscardChangesBeforeSave = exports.cairoCancelExportModalCtaClicked = exports.cairoExportCtaClicked = exports.pikachuItemCategorySelected = exports.loadStart = exports.pickerStartLoad = exports.cairoSearchViewInViews = exports.cairoExportFailedModalCtaClicked = exports.cairoExportProcessStart = exports.cairoTagsAddDeleteTag = exports.loadEnd = exports.cairoNestedTableCollapseAndExpand = exports.pickerEndLoad = exports.cairoItemSelectionToggled = exports.cairoDiscardChangesBeforeApply = exports.pickerPickerOpenButton = exports.cairoDragItemEndDrop = exports.loadMore = exports.componentDismissed = void 0;
4
- exports.cairoApiRequestDataLoadEnd = exports.cairoTagsAssignTag = exports.cairoSortPanelUsed = exports.pickerModalUsability = exports.cairoTagsUnsuccessfulUpdateInServer = exports.pikachuCategoriesDropdownButtonClicked = exports.cairoTpaSCtaClicked = exports.cairoPageBackOrBreadcrumbClicked = exports.cairoUndoClicked = exports.cairoExportModalCtaClicked = exports.cairoApplyButtonClicked = exports.cairoExportProcessEnd = exports.cairoReorderingSortColumns = exports.cairoComponentSorted = exports.cairoDataExCustomFieldEndProcess = exports.cairoViewDeleted = exports.cairoViewSaved = exports.cairoDataExCustomFieldAdvancesSettings = exports.cairoFilterToggled = exports.cairoDataExAddCustomField = exports.cairoViewSelected = exports.newItemCreationStart = exports.pickerPickModalCtaButtonClickOrImmediateCta = exports.cairoUserAttemptsToCancelTheExport = exports.cairoFileDownloadToastDismissed = exports.cairoDragItem = exports.cairoFiltersPanelUsed = void 0;
5
- /**
6
- * A function to create a log object for the 'componentDismissed' event (evid: 113)
7
- *
8
- * Event description: Sent when a component is dismissed. Relevant components: Picker Modal.
9
- *
10
- * @param {componentDismissedParams} params - The parameters for this event
11
- * @property {string} appId
12
- * @property {string} artifactId - Artifact that owns the component
13
- * @property {string} cairoVersion
14
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
15
- * @property {string} componentType - Picker Modal / Picker Dropdown
16
- * @property {GUID} csid
17
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
18
- * @property {boolean} isTPA
19
- * @property {string} origin - X button/Cancel button
20
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
21
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
22
- * @return {LogObject<componentDismissedParams>} LogObject<componentDismissedParams>
23
- */
24
- function componentDismissed(params) {
25
- return { evid: 113, src: 144, endpoint: 'cairo-os', params: params };
26
- }
27
- exports.componentDismissed = componentDismissed;
28
- /**
29
- * A function to create a log object for the 'loadMore' event (evid: 112)
30
- *
31
- * Event description: Sent when a Cairo component is done loading more items (after scrolling). Relevant components: Picker Standalone, Picker Modal, Table, Cards.
32
- *
33
- * @param {loadMoreParams} params - The parameters for this event
34
- * @property {string} appId
35
- * @property {string} artifactId - Artifact that owns the component
36
- * @property {string} cairoVersion
37
- * @property {string} componentName - Component name, if there are two components of the same type per artifact
38
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
39
- * @property {GUID} csid
40
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
41
- * @property {string} currentSortOrder - Which column is currently used to sort the list: {"columnName": "asc"/"desc"}. Relevant for Table and Cards.
42
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
43
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
44
- * @property {string} domain - Optional domain name from FQDN (crm, stores, etc.)
45
- * @property {number} filteredListSize - How many items are to be presented (filtered)
46
- * @property {boolean} isTPA
47
- * @property {number} loadedItems - How many new items were loaded in this action
48
- * @property {number} loadingTime - Component loading time in ms
49
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
50
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
51
- * @return {LogObject<loadMoreParams>} LogObject<loadMoreParams>
52
- */
53
- function loadMore(params) {
54
- return { evid: 112, src: 144, endpoint: 'cairo-os', params: params };
55
- }
56
- exports.loadMore = loadMore;
57
- /**
58
- * A function to create a log object for the 'cairoDragItemEndDrop' event (evid: 139)
59
- *
60
- * Event description: Sent when a user finish to drag an item
61
- *
62
- * @param {cairoDragItemEndDropParams} params - The parameters for this event
63
- * @property {string} appId
64
- * @property {string} artifactId - Artifact that owns the component
65
- * @property {string} cairoVersion - cairo version
66
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
67
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
68
- * @property {GUID} csid
69
- * @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).
70
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
71
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
72
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
73
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
74
- * @property {GUID} dragAndDropID - A "couple" identifier , match between drag action and its drop action
75
- * @property {number} duration - duration in ms from starting to drag the item untill the action has ended
76
- * @property {string} endType - (happy flow+ ticket 529) how did the "drag action" end? Will get one of the following:
77
- * "drop succeeded" = the item has been dropped inside the collection
78
- * "drop back" = the item has been dropped to it's original index (itemIndexBefore=itenIndexAfter)
79
- * "drop outside" = the item has been dropped outside the collection (itemIndexBefore=itenIndexAfter)
80
- * "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.
81
- * @property {number} filteredListSize - How many items are to be presented (filtered)
82
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
83
- * @property {boolean} isFromHandle - Is the item dragged from the handle area?
84
- * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
85
- * @property {boolean} isTPA
86
- * @property {string} itemId - ID of the item that the user tries to drag
87
- * @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
88
- * @property {number} itemIndexBefore - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
89
- * @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
90
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
91
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
92
- * @property {string} searchQuery - What did the user search? isFromSearch = FALSE --> searchQuery = null (relate to ticket 521).
93
- * @return {LogObject<cairoDragItemEndDropParams>} LogObject<cairoDragItemEndDropParams>
94
- */
95
- function cairoDragItemEndDrop(params) {
96
- return { evid: 139, src: 144, endpoint: 'cairo-os', params: params };
97
- }
98
- exports.cairoDragItemEndDrop = cairoDragItemEndDrop;
99
- /**
100
- * A function to create a log object for the 'pickerPickerOpenButton' event (evid: 105)
101
- *
102
- * Event description: Picker button actions (not within the modal)
103
- *
104
- * @param {pickerPickerOpenButtonParams} params - The parameters for this event
105
- * @property {string} action - Any picker button option (render/hover/click)
106
- * @property {string} appId
107
- * @property {string} artifactId - Artifact that owns the component
108
- * @property {string} cairoVersion
109
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
110
- * @property {string} componentType
111
- * @property {GUID} csid
112
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
113
- * @property {number} filteredListSize - How many items are to presented (filtered)
114
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
115
- * @property {boolean} isTPA
116
- * @property {number} listSize - How many items exist (full list)
117
- * @property {number} maxItems - Max items to select in picker
118
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
119
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
120
- * @property {string} type - standalone/modal
121
- * @return {LogObject<pickerPickerOpenButtonParams>} LogObject<pickerPickerOpenButtonParams>
122
- */
123
- function pickerPickerOpenButton(params) {
124
- return { evid: 105, src: 144, endpoint: 'cairo-os', params: params };
125
- }
126
- exports.pickerPickerOpenButton = pickerPickerOpenButton;
127
- /**
128
- * A function to create a log object for the 'cairoDiscardChangesBeforeApply' event (evid: 161)
129
- *
130
- * 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.
131
- *
132
- * @param {cairoDiscardChangesBeforeApplyParams} params - The parameters for this event
133
- * @property {string} appId
134
- * @property {string} artifactId - Artifact that owns the component
135
- * @property {string} cairoVersion - Cairo version
136
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
137
- * @property {string} componentType - Table/Cards / Picker
138
- * @property {GUID} csid - Cairo session ID
139
- * @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)
140
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
141
- * @property {string} feature - Filters / Drag and Drop
142
- * @property {boolean} isTPA
143
- * @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)
144
- * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
145
- * @property {number} numOptionalFields - (Optional, relevant for Filters) If there is an optional fields list (like for filters)- how many options are there?
146
- * @property {string} origin - Feature's Side Panel / Table Toolbar
147
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
148
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
149
- * @return {LogObject<cairoDiscardChangesBeforeApplyParams>} LogObject<cairoDiscardChangesBeforeApplyParams>
150
- */
151
- function cairoDiscardChangesBeforeApply(params) {
152
- return { evid: 161, src: 144, endpoint: 'cairo-os', params: params };
153
- }
154
- exports.cairoDiscardChangesBeforeApply = cairoDiscardChangesBeforeApply;
155
- /**
156
- * A function to create a log object for the 'cairoItemSelectionToggled' event (evid: 114)
157
- *
158
- * Event description: Sent when a user select/deselects an item(s) in a list
159
- *
160
- * @param {cairoItemSelectionToggledParams} params - The parameters for this event
161
- * @property {string} appId
162
- * @property {string} artifactId - Artifact that owns the component
163
- * @property {string} cairoVersion
164
- * @property {string} clickType - The click purpose : "Selection" / "Deselection"
165
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
166
- * @property {string} componentType - Picker Standalone/Picker Modal/ Picker Dropdown /Table/Cards
167
- * @property {GUID} csid
168
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
169
- * @property {number} currentLevel - What is the hierarchy level (or step) of the selected item? (out of numLevels)
170
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
171
- * @property {string} currentStep - What is the step (or hierarchy level) of the selected item?
172
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
173
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
174
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
175
- * @property {number} filteredListSize - How many items are to be presented (filtered)
176
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
177
- * @property {boolean} isFromSearch - Is the item selected from a list of search results
178
- * @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").
179
- * @property {boolean} isTPA
180
- * @property {string} itemId - ID of item that is checked/unchecked (isSelectAll = TRUE --> itemId = "All")
181
- * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item.
182
- * ** isSelectAll = TRUE --> itemIndex = 0
183
- * @property {string} location - Location: Table List Header (for using the checkbox) /
184
- * Table Bulk Toolbar (for using the CTA)(new from Dec 2022)
185
- * @property {number} maxItems - (Optional) Max number of items that can be selected. null if there's no limit.
186
- * @property {number} numItemsAfter - How many items have been selected after user clicks items.
187
- * @property {number} numItemsBefore - How many items have been selected before user clicks items
188
- * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
189
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
190
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
191
- * @property {string} searchQuery - What did the user search?
192
- * @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)
193
- * @return {LogObject<cairoItemSelectionToggledParams>} LogObject<cairoItemSelectionToggledParams>
194
- */
195
- function cairoItemSelectionToggled(params) {
196
- return { evid: 114, src: 144, endpoint: 'cairo-os', params: params };
197
- }
198
- exports.cairoItemSelectionToggled = cairoItemSelectionToggled;
199
- /**
200
- * A function to create a log object for the 'pickerEndLoad' event (evid: 102)
201
- *
202
- * Event description: Cairo picker finished loading
203
- *
204
- * @param {pickerEndLoadParams} params - The parameters for this event
205
- * @property {string} appId
206
- * @property {string} artifactId - Artifact that owns the component
207
- * @property {string} cairoVersion
208
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
209
- * @property {string} componentType
210
- * @property {GUID} csid
211
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
212
- * @property {number} filteredListSize - How many items are to presented (filtered)
213
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
214
- * @property {boolean} isTPA
215
- * @property {number} listSize - How many items exist (full list)
216
- * @property {number} loadingTime - ms
217
- * @property {number} maxItems - Max items to select in picker
218
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
219
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
220
- * @property {string} type - standalone/modal
221
- * @return {LogObject<pickerEndLoadParams>} LogObject<pickerEndLoadParams>
222
- */
223
- function pickerEndLoad(params) {
224
- return { evid: 102, src: 144, endpoint: 'cairo-os', params: params };
225
- }
226
- exports.pickerEndLoad = pickerEndLoad;
227
- /**
228
- * A function to create a log object for the 'cairoNestedTableCollapseAndExpand' event (evid: 165)
229
- *
230
- * 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)
231
- *
232
- * @param {cairoNestedTableCollapseAndExpandParams} params - The parameters for this event
233
- * @property {string} appId
234
- * @property {string} artifactId - Artifact that owns the component
235
- * @property {string} cairoVersion - cairo version
236
- * @property {string} clickType - The click purpose : "Collapse" / "Expand"
237
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
238
- * @property {string} componentType - Picker Standalone/Picker Modal/ Picker Dropdown /Table/Cards
239
- * @property {number} countItems - The value the user see as the count of this item. If "Is select all"= true, then Null
240
- * @property {GUID} csid - Cairo session id
241
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
242
- * @property {number} currentLevel - What is the hierarchy level (or step) of the clicked item? (out of numLevels). If "Is select all"= true, then Null
243
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
244
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
245
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
246
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
247
- * @property {number} filteredListSize - How many items are to be presented (filtered)
248
- * @property {boolean} isFromSearch - Is the item selected from a list of search results
249
- * @property {boolean} isSelectAll - True if the user chose to collapse / expand all categories simultaneously
250
- * @property {boolean} isTPA
251
- * @property {string} itemId - ID of the clicked item .If "Is select all"= true, then Null
252
- * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item .If "Is select all"= true, then Null
253
- * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
254
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
255
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
256
- * @property {string} searchQuery - What did the user search?
257
- * @return {LogObject<cairoNestedTableCollapseAndExpandParams>} LogObject<cairoNestedTableCollapseAndExpandParams>
258
- */
259
- function cairoNestedTableCollapseAndExpand(params) {
260
- return { evid: 165, src: 144, endpoint: 'cairo-os', params: params };
261
- }
262
- exports.cairoNestedTableCollapseAndExpand = cairoNestedTableCollapseAndExpand;
263
- /**
264
- * A function to create a log object for the 'loadEnd' event (evid: 111)
265
- *
266
- * Event description: Sent when a Cairo component is done loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
267
- *
268
- * @param {loadEndParams} params - The parameters for this event
269
- * @property {string} appId
270
- * @property {string} artifactId - Artifact that owns the component
271
- * @property {string} cairoVersion
272
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
273
- * @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
274
- * @property {string} componentType - Picker Standalone/Picker Modal/ Picker Dropdown/ Table/Cards
275
- * @property {GUID} csid
276
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
277
- * @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.
278
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
279
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
280
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
281
- * @property {number} filteredListSize - How many items are to be presented (filtered)
282
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
283
- * @property {boolean} isInternalPage - Is under bo.wix.com (new from 03/2023)
284
- * @property {boolean} isTPA
285
- * @property {number} listSize - How many items exist (full list, unfiltered). Relevant for Picker.
286
- * @property {number} loadingTime - Component loading time in ms
287
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
288
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
289
- * @property {Url} url - The page's url (new from 03/2023)
290
- * @return {LogObject<loadEndParams>} LogObject<loadEndParams>
291
- */
292
- function loadEnd(params) {
293
- return { evid: 111, src: 144, endpoint: 'cairo-os', params: params };
294
- }
295
- exports.loadEnd = loadEnd;
296
- /**
297
- * A function to create a log object for the 'cairoTagsAddDeleteTag' event (evid: 168)
298
- *
299
- * Event description: Send when a user add or delete a tag from his component. Relevant for Verticals who allow use tags in their tables.
300
- *
301
- * @param {cairoTagsAddDeleteTagParams} params - The parameters for this event
302
- * @property {string} actionName - Add / Delete / Rename
303
- * @property {string} appId
304
- * @property {string} artifactId - Artifact that owns the component
305
- * @property {string} cairoVersion - Cairo version
306
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
307
- * @property {string} componentType - Component type
308
- * @property {GUID} csid - Cairo session ID
309
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
310
- * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
311
- * @property {boolean} isTPA
312
- * @property {number} numTags - How many tags are in the modal after this action?
313
- * @property {string} origin - Where did the user make the action from? Tags Modal /
314
- * @property {string} previousName - (Relevant only for action name=Rename) The tag's name, before the change
315
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
316
- * @property {string} resource - resource
317
- * @property {string} tagName - The name of the removed/added tag, or the new tag's name - incase of rename tag
318
- * @return {LogObject<cairoTagsAddDeleteTagParams>} LogObject<cairoTagsAddDeleteTagParams>
319
- */
320
- function cairoTagsAddDeleteTag(params) {
321
- return { evid: 168, src: 144, endpoint: 'cairo-os', params: params };
322
- }
323
- exports.cairoTagsAddDeleteTag = cairoTagsAddDeleteTag;
324
- /**
325
- * A function to create a log object for the 'cairoExportProcessStart' event (evid: 128)
326
- *
327
- * Event description: Sent when the export process begins
328
- *
329
- * @param {cairoExportProcessStartParams} params - The parameters for this event
330
- * @property {string} appId
331
- * @property {string} artifactId - Artifact that owns the component
332
- * @property {string} cairoVersion
333
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
334
- * @property {string} componentType - Table
335
- * @property {GUID} csid
336
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
337
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
338
- * @property {boolean} isTPA
339
- * @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.
340
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
341
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
342
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
343
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
344
- * @property {number} try - Which try is this; if try > 1, this is a retry
345
- * @return {LogObject<cairoExportProcessStartParams>} LogObject<cairoExportProcessStartParams>
346
- */
347
- function cairoExportProcessStart(params) {
348
- return { evid: 128, src: 144, endpoint: 'cairo-os', params: params };
349
- }
350
- exports.cairoExportProcessStart = cairoExportProcessStart;
351
- /**
352
- * A function to create a log object for the 'cairoExportFailedModalCtaClicked' event (evid: 135)
353
- *
354
- * Event description: Sent when the user clicks a CTA in the "Export Failed" modal
355
- *
356
- * @param {cairoExportFailedModalCtaClickedParams} params - The parameters for this event
357
- * @property {string} appId
358
- * @property {string} artifactId - Artifact that owns the component
359
- * @property {string} cairoVersion
360
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
361
- * @property {string} componentType - Table
362
- * @property {GUID} csid
363
- * @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)
364
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
365
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
366
- * @property {boolean} isTPA
367
- * @property {number} numItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
368
- * @property {number} numItemsExported - How many items were exported before the export failed.
369
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
370
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
371
- * @property {string} selectedExportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
372
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
373
- * @property {number} try - Which try is this; if try > 1, this is a retry
374
- * @return {LogObject<cairoExportFailedModalCtaClickedParams>} LogObject<cairoExportFailedModalCtaClickedParams>
375
- */
376
- function cairoExportFailedModalCtaClicked(params) {
377
- return { evid: 135, src: 144, endpoint: 'cairo-os', params: params };
378
- }
379
- exports.cairoExportFailedModalCtaClicked = cairoExportFailedModalCtaClicked;
380
- /**
381
- * A function to create a log object for the 'cairoSearchViewInViews' event (evid: 151)
382
- *
383
- * 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.
384
- *
385
- * @param {cairoSearchViewInViewsParams} params - The parameters for this event
386
- * @property {string} appId
387
- * @property {string} artifactId - Artifact that owns the component
388
- * @property {string} cairoVersion - Cairo version
389
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
390
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
391
- * @property {GUID} csid
392
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
393
- * @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).
394
- * @property {boolean} isTPA
395
- * @property {number} numCategoriesInResults - Out of searchResultsCnt - how many results are from type of "categories"?
396
- * @property {number} numViews - The distinct views IDs the users has when he searches a view
397
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
398
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
399
- * @property {number} searchResultsCnt - How many results appeared for the search query. numSearchReults = 0 --> user saw empty state. This count includes "views" and "categories" results.
400
- * @property {string} searchTerm - What did the user search? "" if removed search term.
401
- * @return {LogObject<cairoSearchViewInViewsParams>} LogObject<cairoSearchViewInViewsParams>
402
- */
403
- function cairoSearchViewInViews(params) {
404
- return { evid: 151, src: 144, endpoint: 'cairo-os', params: params };
405
- }
406
- exports.cairoSearchViewInViews = cairoSearchViewInViews;
407
- /**
408
- * A function to create a log object for the 'pickerStartLoad' event (evid: 101)
409
- *
410
- * Event description: Cairo picker starts loading
411
- *
412
- * @param {pickerStartLoadParams} params - The parameters for this event
413
- * @property {string} appId
414
- * @property {string} artifactId - Artifact that owns the component
415
- * @property {string} cairoVersion
416
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
417
- * @property {string} componentType
418
- * @property {GUID} csid
419
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
420
- * @property {number} filteredListSize - How many items are to presented (filtered)
421
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
422
- * @property {boolean} isTPA
423
- * @property {number} listSize - How many items exist (full list)
424
- * @property {number} maxItems - Max items to select in picker
425
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
426
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
427
- * @property {string} type - standalone/modal
428
- * @return {LogObject<pickerStartLoadParams>} LogObject<pickerStartLoadParams>
429
- */
430
- function pickerStartLoad(params) {
431
- return { evid: 101, src: 144, endpoint: 'cairo-os', params: params };
432
- }
433
- exports.pickerStartLoad = pickerStartLoad;
434
- /**
435
- * A function to create a log object for the 'loadStart' event (evid: 110)
436
- *
437
- * Event description: Sent when a Cairo component starts loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
438
- *
439
- * @param {loadStartParams} params - The parameters for this event
440
- * @property {string} additionalFeaturesAvailability - Json field :({featureName: boolean}) (new from 06/2023), for features that don't suppose to impact performance
441
- * @property {string} appId
442
- * @property {string} artifactId - Artifact that owns the component
443
- * @property {string} cairoVersion - cairo version
444
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
445
- * @property {string} componentType - Picker Standalone/Picker Modal/Picker Dropdown Table/Cards
446
- * @property {GUID} csid
447
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
448
- * @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.
449
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
450
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
451
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
452
- * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
453
- * @property {boolean} isTPA
454
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
455
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
456
- * @property {Url} url - The page's url (new from 03/2023)
457
- * @return {LogObject<loadStartParams>} LogObject<loadStartParams>
458
- */
459
- function loadStart(params) {
460
- return { evid: 110, src: 144, endpoint: 'cairo-os', params: params };
461
- }
462
- exports.loadStart = loadStart;
463
- /**
464
- * A function to create a log object for the 'pikachuItemCategorySelected' event (evid: 109)
465
- *
466
- * Event description: Sent when user selects a category from the Pikachu category menu (e.g. Coupons/Services/Products)
467
- *
468
- * @param {pikachuItemCategorySelectedParams} params - The parameters for this event
469
- * @property {string} appId
470
- * @property {string} artifactId - Artifact that owns the component
471
- * @property {string} cairoVersion
472
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
473
- * @property {string} componentType
474
- * @property {GUID} csid
475
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
476
- * @property {boolean} isTPA
477
- * @property {string} itemCategory - Which type of item would we like to pick: 'Collection'/'Product'/'Service'/'Coupon'/'Standalone form'/'Invoice'/'Price quote'
478
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
479
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
480
- * @return {LogObject<pikachuItemCategorySelectedParams>} LogObject<pikachuItemCategorySelectedParams>
481
- */
482
- function pikachuItemCategorySelected(params) {
483
- return { evid: 109, src: 144, endpoint: 'cairo-os', params: params };
484
- }
485
- exports.pikachuItemCategorySelected = pikachuItemCategorySelected;
486
- /**
487
- * A function to create a log object for the 'cairoExportCtaClicked' event (evid: 125)
488
- *
489
- * Event description: Sent when a user clicks the "Export" CTA in a Cairo component
490
- *
491
- * @param {cairoExportCtaClickedParams} params - The parameters for this event
492
- * @property {string} appId
493
- * @property {string} artifactId - Artifact that owns the component
494
- * @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}
495
- * @property {string} cairoVersion
496
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
497
- * @property {string} componentType - Table
498
- * @property {GUID} csid
499
- * @property {string} defaultExportType - What type of export is automatically selected when the user clicks the export CTA: "All Items"/"Filtered Items"/"Selected Items"
500
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
501
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
502
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
503
- * @property {boolean} isTPA
504
- * @property {number} numSelectedItems - How many items does the user wish to export
505
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
506
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
507
- * @return {LogObject<cairoExportCtaClickedParams>} LogObject<cairoExportCtaClickedParams>
508
- */
509
- function cairoExportCtaClicked(params) {
510
- return { evid: 125, src: 144, endpoint: 'cairo-os', params: params };
511
- }
512
- exports.cairoExportCtaClicked = cairoExportCtaClicked;
513
- /**
514
- * A function to create a log object for the 'cairoCancelExportModalCtaClicked' event (evid: 130)
515
- *
516
- * Event description: Sent when the user clicks any of the CTAs in the "Cancel the export?" modal
517
- *
518
- * @param {cairoCancelExportModalCtaClickedParams} params - The parameters for this event
519
- * @property {string} appId
520
- * @property {string} artifactId - Artifact that owns the component
521
- * @property {string} cairoVersion
522
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
523
- * @property {string} componentType - Table
524
- * @property {GUID} csid
525
- * @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")
526
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
527
- * @property {number} duration - How much time (in ms) did it take since the export process began
528
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
529
- * @property {boolean} isTPA
530
- * @property {string} modalType - Did the user try to close the tab ("Browser") or cancel the export ("Export")
531
- * @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.
532
- * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
533
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
534
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
535
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
536
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
537
- * @property {number} try - Which try is this; if try > 1, this is a retry
538
- * @return {LogObject<cairoCancelExportModalCtaClickedParams>} LogObject<cairoCancelExportModalCtaClickedParams>
539
- */
540
- function cairoCancelExportModalCtaClicked(params) {
541
- return { evid: 130, src: 144, endpoint: 'cairo-os', params: params };
542
- }
543
- exports.cairoCancelExportModalCtaClicked = cairoCancelExportModalCtaClicked;
544
- /**
545
- * A function to create a log object for the 'cairoPageDiscardChangesBeforeSave' event (evid: 174)
546
- *
547
- * 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)
548
- *
549
- * @param {cairoPageDiscardChangesBeforeSaveParams} params - The parameters for this event
550
- * @property {string} appId
551
- * @property {string} artifactId - Artifact that owns the component
552
- * @property {string} cairoVersion - Cairo version
553
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
554
- * @property {string} componentType - Table/Cards / Picker
555
- * @property {GUID} csid - Cairo session ID
556
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
557
- * @property {boolean} isTPA
558
- * @property {number} numOfActions - Number of changed fields that their changes can be lost
559
- * @property {number} numOfFields - How many fields are there that can be change in this page?
560
- * @property {string} origin - Cancel CTA / Breadcrumbs / Back button / Navigation
561
- * @property {string} pageType - Entity /
562
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
563
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
564
- * @return {LogObject<cairoPageDiscardChangesBeforeSaveParams>} LogObject<cairoPageDiscardChangesBeforeSaveParams>
565
- */
566
- function cairoPageDiscardChangesBeforeSave(params) {
567
- return { evid: 174, src: 144, endpoint: 'cairo-os', params: params };
568
- }
569
- exports.cairoPageDiscardChangesBeforeSave = cairoPageDiscardChangesBeforeSave;
570
- /**
571
- * A function to create a log object for the 'cairoFileDownloadToastDownloadButtonClicked' event (evid: 134)
572
- *
573
- * Event description: Sent when the user clicks the "Download Manually" button in the toast that is displayed after the export process is complete
574
- *
575
- * @param {cairoFileDownloadToastDownloadButtonClickedParams} params - The parameters for this event
576
- * @property {string} appId
577
- * @property {string} artifactId - Artifact that owns the component
578
- * @property {string} cairoVersion
579
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
580
- * @property {string} componentType - Table
581
- * @property {GUID} csid
582
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
583
- * @property {number} duration - How much time (in ms) was the notification displayed before the button was clicked
584
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
585
- * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
586
- * @property {boolean} isTPA
587
- * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
588
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
589
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
590
- * @return {LogObject<cairoFileDownloadToastDownloadButtonClickedParams>} LogObject<cairoFileDownloadToastDownloadButtonClickedParams>
591
- */
592
- function cairoFileDownloadToastDownloadButtonClicked(params) {
593
- return { evid: 134, src: 144, endpoint: 'cairo-os', params: params };
594
- }
595
- exports.cairoFileDownloadToastDownloadButtonClicked = cairoFileDownloadToastDownloadButtonClicked;
596
- /**
597
- * A function to create a log object for the 'cairoCustomizeColumnsInSidePanel' event (evid: 177)
598
- *
599
- * 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.
600
- *
601
- * @param {cairoCustomizeColumnsInSidePanelParams} params - The parameters for this event
602
- * @property {string} actionName - Visibility / Reorder
603
- * @property {string} appId
604
- * @property {string} artifactId - Artifact that owns the component
605
- * @property {string} cairoVersion - version
606
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
607
- * @property {string} componentType - Table/Cards
608
- * @property {GUID} csid - cairo session id
609
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
610
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
611
- * @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)
612
- * @property {boolean} isTPA
613
- * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
614
- * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
615
- * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
616
- * @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
617
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
618
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
619
- * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
620
- * @return {LogObject<cairoCustomizeColumnsInSidePanelParams>} LogObject<cairoCustomizeColumnsInSidePanelParams>
621
- */
622
- function cairoCustomizeColumnsInSidePanel(params) {
623
- return { evid: 177, src: 144, endpoint: 'cairo-os', params: params };
624
- }
625
- exports.cairoCustomizeColumnsInSidePanel = cairoCustomizeColumnsInSidePanel;
626
- /**
627
- * A function to create a log object for the 'cairoTabSelected' event (evid: 121)
628
- *
629
- * Event description: Sent when a user selects a tab in a Cairo component. Relevant components: Table, Cards.
630
- *
631
- * @param {cairoTabSelectedParams} params - The parameters for this event
632
- * @property {string} appId
633
- * @property {string} artifactId - Artifact that owns the component
634
- * @property {string} cairoVersion
635
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
636
- * @property {string} componentType - Table/Cards
637
- * @property {GUID} csid
638
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
639
- * @property {number} filteredListSize - How many items are currently presented to user, after new tab selection
640
- * @property {boolean} hasAllTab - TRUE if "All" tab is displayed for this component; FALSE otherwise
641
- * @property {boolean} isTPA
642
- * @property {string} newTabId - Name of the newly selected tab
643
- * @property {number} newTabIndex - Index of the newly selected tab. 1 <= newTabIndex <= numTabs.
644
- * @property {number} numTabs - How many tabs are dispalyed to the user
645
- * @property {string} prevTabId - (Optional) Name of the previous tab that the user had selected. null if no tab was selected.
646
- * @property {number} prevTabIndex - (Optional) Index of the previous tab that the user had selected. 1 <= prevTabIndex <= numTabs; null if no tab was selected.
647
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
648
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
649
- * @return {LogObject<cairoTabSelectedParams>} LogObject<cairoTabSelectedParams>
650
- */
651
- function cairoTabSelected(params) {
652
- return { evid: 121, src: 144, endpoint: 'cairo-os', params: params };
653
- }
654
- exports.cairoTabSelected = cairoTabSelected;
655
- /**
656
- * A function to create a log object for the 'cairoViewsUnsuccessfulUpdateInServer' event (evid: 145)
657
- *
658
- * Event description: Sent when a user made an action on a view, but his changes weren't update in the server from different reasons
659
- *
660
- * @param {cairoViewsUnsuccessfulUpdateInServerParams} params - The parameters for this event
661
- * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
662
- * @property {string} appId
663
- * @property {string} artifactId - Artifact that owns the component
664
- * @property {string} cairoVersion - cairo version
665
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
666
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
667
- * @property {GUID} csid
668
- * @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).
669
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
670
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
671
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
672
- * @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
673
- * @property {number} filteredListSize - How many items are to be presented (filtered)
674
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
675
- * @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.
676
- * @property {boolean} isFromSearch - Was the failed action made on a search results?
677
- * @property {boolean} isTPA
678
- * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
679
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
680
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
681
- * @property {string} searchQuery - (not relevant for now) What did the user search? isFromSearch = FALSE --> searchQuery = null .
682
- * @property {number} timeFromEndAction - duration in ms from the end of the failed action until the error indication
683
- * @property {string} viewId - Which view was the failed action made on. Relevant for Table and Cards.
684
- * @return {LogObject<cairoViewsUnsuccessfulUpdateInServerParams>} LogObject<cairoViewsUnsuccessfulUpdateInServerParams>
685
- */
686
- function cairoViewsUnsuccessfulUpdateInServer(params) {
687
- return { evid: 145, src: 144, endpoint: 'cairo-os', params: params };
688
- }
689
- exports.cairoViewsUnsuccessfulUpdateInServer = cairoViewsUnsuccessfulUpdateInServer;
690
- /**
691
- * A function to create a log object for the 'cairoModalCtaClicked' event (evid: 162)
692
- *
693
- * Event description: Sent when a user clicks on a CTA in an an opened modal
694
- *
695
- * @param {cairoModalCtaClickedParams} params - The parameters for this event
696
- * @property {string} appId
697
- * @property {string} artifactId - Artifact that owns the component
698
- * @property {string} cairoVersion - cairo version
699
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
700
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
701
- * @property {GUID} csid - Cairo session id
702
- * @property {string} ctaName - The CTA name the user chose to do in the modal (for example: save, cancel, archive etc.). English only, not localized
703
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
704
- * @property {boolean} isTPA
705
- * @property {string} localizedCtaName - The CTA name, localized
706
- * @property {string} modalName - The modal's title (Archive custom field, etc.)
707
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
708
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
709
- * @return {LogObject<cairoModalCtaClickedParams>} LogObject<cairoModalCtaClickedParams>
710
- */
711
- function cairoModalCtaClicked(params) {
712
- return { evid: 162, src: 144, endpoint: 'cairo-os', params: params };
713
- }
714
- exports.cairoModalCtaClicked = cairoModalCtaClicked;
715
- /**
716
- * A function to create a log object for the 'cairoAllFiltersCleared' event (evid: 118)
717
- *
718
- * Event description: Sent when a user clears all of the filters used in a Cairo component. Relevant components: Table, Cards.
719
- *
720
- * @param {cairoAllFiltersClearedParams} params - The parameters for this event
721
- * @property {string} appId
722
- * @property {string} artifactId - Artifact that owns the component
723
- * @property {string} cairoVersion
724
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
725
- * @property {string} componentType - Table/Cards
726
- * @property {GUID} csid
727
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
728
- * @property {string} filterNames - Comma separated list of filter names that have been cleared
729
- * @property {number} filteredListSize - How many items were presented to user, before all of the filters were cleared
730
- * @property {boolean} isTPA
731
- * @property {number} numFiltersCleared - How many filters have been cleared
732
- * @property {string} origin - "sidebar"/"toolbar"
733
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
734
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
735
- * @return {LogObject<cairoAllFiltersClearedParams>} LogObject<cairoAllFiltersClearedParams>
736
- */
737
- function cairoAllFiltersCleared(params) {
738
- return { evid: 118, src: 144, endpoint: 'cairo-os', params: params };
739
- }
740
- exports.cairoAllFiltersCleared = cairoAllFiltersCleared;
741
- /**
742
- * A function to create a log object for the 'cairoCtaClicked' event (evid: 115)
743
- *
744
- * 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.
745
- *
746
- * @param {cairoCtaClickedParams} params - The parameters for this event
747
- * @property {string} appId
748
- * @property {string} artifactId - Artifact that owns the component
749
- * @property {string} cairoVersion
750
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
751
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
752
- * @property {GUID} csid - cairo sessionId
753
- * @property {number} ctaIndex - 1 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the specific location
754
- * @property {string} ctaName - "Continue"/"Delete"/"Save"/"Accept"/"Edit"... (in English, not localized)
755
- * @property {number} currentLevel - What is the hierarchy level (or step) of the selected item? (out of numLevels)
756
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
757
- * @property {number} filteredListSize - How many items are to be presented (filtered)
758
- * @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
759
- * @property {boolean} isTPA
760
- * @property {string} itemId - ID of the item that the user clicked on its CTA
761
- * @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
762
- * @property {string} localizedCtaName - The CTA name, localized
763
- * @property {string} location - CTA location: multi bulk action toolbar, bulk action toolbar, action cell, Customize columns action cell
764
- * @property {number} maxItems - (Optional) Max number of items that can be selected. null if there's no limit.
765
- * @property {number} moreActionsIndex - (Optional) If the CTA is part of a "more actions" dropdown, its index in the dropdown; otherwise, null
766
- * @property {number} numCtas - How many CTAs are available in the current location
767
- * @property {number} numItems - How many items have been selected
768
- * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
769
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
770
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
771
- * @property {number} timeFromAction - The time from user CTA click until he gets feedback , in ms (new from Dec 2022)
772
- * @return {LogObject<cairoCtaClickedParams>} LogObject<cairoCtaClickedParams>
773
- */
774
- function cairoCtaClicked(params) {
775
- return { evid: 115, src: 144, endpoint: 'cairo-os', params: params };
776
- }
777
- exports.cairoCtaClicked = cairoCtaClicked;
778
- /**
779
- * A function to create a log object for the 'cairoChangesBeforeApply' event (evid: 160)
780
- *
781
- * 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.
782
- *
783
- * @param {cairoChangesBeforeApplyParams} params - The parameters for this event
784
- * @property {string} appId
785
- * @property {string} artifactId - Artifact that owns the component
786
- * @property {string} cairoVersion - Cairo version
787
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
788
- * @property {string} componentType - Table/Cards / Picker (from 12/2022)
789
- * @property {GUID} csid - Cairo session ID
790
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
791
- * @property {string} feature - Filters / Add Custom Field / Edit Custom Field
792
- * @property {string} fieldName - The field that the user chose to change (not necessary to save) (Null if the user clicked on "clear")
793
- * @property {string} fieldValue - The chosen value of the field (Null if the user clicked on "clear")
794
- * @property {boolean} isClearButton - True if the user clicked on the clear button, False otherwise .
795
- * @property {boolean} isTPA
796
- * @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)
797
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
798
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
799
- * @return {LogObject<cairoChangesBeforeApplyParams>} LogObject<cairoChangesBeforeApplyParams>
800
- */
801
- function cairoChangesBeforeApply(params) {
802
- return { evid: 160, src: 144, endpoint: 'cairo-os', params: params };
803
- }
804
- exports.cairoChangesBeforeApply = cairoChangesBeforeApply;
805
- /**
806
- * A function to create a log object for the 'cairoTagsWidgetClickOnCta' event (evid: 172)
807
- *
808
- * 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.
809
- *
810
- * @param {cairoTagsWidgetClickOnCtaParams} params - The parameters for this event
811
- * @property {string} actionName - Assign tags / Create tags / Manage tags
812
- * @property {string} appId
813
- * @property {string} artifactId - Artifact that owns the component
814
- * @property {string} cairoVersion - Cairo version
815
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
816
- * @property {string} componentType - Component type
817
- * @property {GUID} csid - Cairo session ID
818
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
819
- * @property {boolean} isTPA
820
- * @property {string} itemId - The entity ID
821
- * @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
822
- * @property {number} numTagsAssigned - How many tags are already assigned to that item?
823
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
824
- * @property {string} resource - resource
825
- * @return {LogObject<cairoTagsWidgetClickOnCtaParams>} LogObject<cairoTagsWidgetClickOnCtaParams>
826
- */
827
- function cairoTagsWidgetClickOnCta(params) {
828
- return { evid: 172, src: 144, endpoint: 'cairo-os', params: params };
829
- }
830
- exports.cairoTagsWidgetClickOnCta = cairoTagsWidgetClickOnCta;
831
- /**
832
- * A function to create a log object for the 'cairoDataExtensionUnsuccessfulUpdateInServer' event (evid: 163)
833
- *
834
- * Event description: Sent when a user tried to save a custom field but his changes weren't update in the server from different reasons
835
- *
836
- * @param {cairoDataExtensionUnsuccessfulUpdateInServerParams} params - The parameters for this event
837
- * @property {string} actionName - The action the user tried to do: Add/ Edit etc. (in English, not localized)
838
- * @property {string} appId
839
- * @property {string} artifactId - Artifact that owns the component
840
- * @property {string} cairoVersion - cairo version
841
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
842
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
843
- * @property {GUID} csid - Cairo session id
844
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
845
- * @property {string} errorType - What is the type of the error? Technical issue / Network error / 10k Limitation
846
- * @property {string} fieldName - The name the user typed
847
- * @property {string} fieldType - What type is the added field? Long text / Date / Number etc.
848
- * @property {boolean} isTPA
849
- * @property {string} key - The key value
850
- * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
851
- * @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.
852
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
853
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
854
- * @return {LogObject<cairoDataExtensionUnsuccessfulUpdateInServerParams>} LogObject<cairoDataExtensionUnsuccessfulUpdateInServerParams>
855
- */
856
- function cairoDataExtensionUnsuccessfulUpdateInServer(params) {
857
- return { evid: 163, src: 144, endpoint: 'cairo-os', params: params };
858
- }
859
- exports.cairoDataExtensionUnsuccessfulUpdateInServer = cairoDataExtensionUnsuccessfulUpdateInServer;
860
- /**
861
- * A function to create a log object for the 'cairoErrorInLoadingAComponent' event (evid: 164)
862
- *
863
- * Event description: Sent when a an error in Cairo component loading process happen . Relevant components: Picker Standalone, Picker Modal, Table, Cards.
864
- *
865
- * @param {cairoErrorInLoadingAComponentParams} params - The parameters for this event
866
- * @property {string} appId
867
- * @property {string} artifactId - Artifact that owns the component
868
- * @property {string} cairoVersion - cairo version
869
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
870
- * @property {string} componentType - Picker Standalone/Picker Modal/Picker Dropdown Table/Cards
871
- * @property {GUID} csid - Cairo session id
872
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
873
- * @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.
874
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
875
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
876
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
877
- * @property {string} errorType - Error type (if known): LoadCustomFieldsWidgetLazyContentFailed /
878
- * InitCustomFieldsDataExtensionFailed /
879
- * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
880
- * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
881
- * @property {boolean} isTPA
882
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
883
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
884
- * @property {Url} url - The page's url
885
- * @return {LogObject<cairoErrorInLoadingAComponentParams>} LogObject<cairoErrorInLoadingAComponentParams>
886
- */
887
- function cairoErrorInLoadingAComponent(params) {
888
- return { evid: 164, src: 144, endpoint: 'cairo-os', params: params };
889
- }
890
- exports.cairoErrorInLoadingAComponent = cairoErrorInLoadingAComponent;
891
- /**
892
- * A function to create a log object for the 'cairoReloadErrorState' event (evid: 176)
893
- *
894
- * Event description: Sent when a an error in Cairo component loading process happened and the user reload the state
895
- *
896
- * @param {cairoReloadErrorStateParams} params - The parameters for this event
897
- * @property {string} appId
898
- * @property {string} artifactId - Artifact that owns the component
899
- * @property {string} cairoVersion - cairo version
900
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
901
- * @property {string} componentType - Picker Standalone/Picker Modal/Picker Dropdown Table/Cards
902
- * @property {GUID} csid - Cairo session id
903
- * @property {string} cta - cta
904
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
905
- * @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.
906
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
907
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
908
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
909
- * @property {string} errorType - Error type (if known): LoadCustomFieldsWidgetLazyContentFailed /
910
- * InitCustomFieldsDataExtensionFailed /
911
- * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
912
- * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
913
- * @property {boolean} isTPA
914
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
915
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
916
- * @property {Url} url - The page's url
917
- * @return {LogObject<cairoReloadErrorStateParams>} LogObject<cairoReloadErrorStateParams>
918
- */
919
- function cairoReloadErrorState(params) {
920
- return { evid: 176, src: 144, endpoint: 'cairo-os', params: params };
921
- }
922
- exports.cairoReloadErrorState = cairoReloadErrorState;
923
- /**
924
- * A function to create a log object for the 'newItemCreationEnd' event (evid: 107)
925
- *
926
- * Event description: Sent when the "create new" process ends (and the result is shown to the user)
927
- *
928
- * @param {newItemCreationEndParams} params - The parameters for this event
929
- * @property {string} appId
930
- * @property {string} artifactId - Artifact that owns the component
931
- * @property {string} cairoVersion
932
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
933
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
934
- * @property {GUID} csid
935
- * @property {string} currentFilters - filters
936
- * @property {string} currentSortOrder - sort order
937
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
938
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
939
- * @property {boolean} isTPA
940
- * @property {string} itemId - resultType= "success" --> itemId = ID of newly created item; resultType = "dismissed" --> itemId = null
941
- * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
942
- * @property {number} maxItems - Max number of items that can be selected
943
- * @property {number} numColumns - columns
944
- * @property {number} numFiltersActive - filters
945
- * @property {number} numSelectedItems - How many items have been selected before trying to create a new one. 0 <= numItems < maxItems
946
- * @property {number} numSortedColumns - sort
947
- * @property {string} origin - "Add New" click source: "Main CTA" / "Card CTA"
948
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
949
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
950
- * @property {string} resultType - "success"/"dismissed"
951
- * @property {string} type - standalone/modal
952
- * @property {string} visibleColumnsOrder - visible columns order
953
- * @return {LogObject<newItemCreationEndParams>} LogObject<newItemCreationEndParams>
954
- */
955
- function newItemCreationEnd(params) {
956
- return { evid: 107, src: 144, endpoint: 'cairo-os', params: params };
957
- }
958
- exports.newItemCreationEnd = newItemCreationEnd;
959
- /**
960
- * A function to create a log object for the 'cairoTagsWidgetLoaded' event (evid: 171)
961
- *
962
- * Event description: Send when a Tags' widget is loaded. Relevant for Verticals who allow use tags in their tables.
963
- *
964
- * @param {cairoTagsWidgetLoadedParams} params - The parameters for this event
965
- * @property {string} appId
966
- * @property {string} artifactId - Artifact that owns the component
967
- * @property {string} cairoVersion - Cairo version
968
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
969
- * @property {string} componentType - Component type
970
- * @property {GUID} csid - Cairo session ID
971
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
972
- * @property {boolean} isTPA
973
- * @property {string} itemId - The entity ID (that the widget was loaded in its page)
974
- * @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
975
- * @property {number} numTagsAssigned - How many tags are assigned to that entity when the widget is loaded?
976
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
977
- * @property {string} resource - resource
978
- * @return {LogObject<cairoTagsWidgetLoadedParams>} LogObject<cairoTagsWidgetLoadedParams>
979
- */
980
- function cairoTagsWidgetLoaded(params) {
981
- return { evid: 171, src: 144, endpoint: 'cairo-os', params: params };
982
- }
983
- exports.cairoTagsWidgetLoaded = cairoTagsWidgetLoaded;
984
- /**
985
- * A function to create a log object for the 'cairoTableTopNotificationDismissed' event (evid: 137)
986
- *
987
- * Event description: Sent when the notification at the top of the table is dismissed, either manually or automatically
988
- *
989
- * @param {cairoTableTopNotificationDismissedParams} params - The parameters for this event
990
- * @property {string} appId
991
- * @property {string} artifactId - Artifact that owns the component
992
- * @property {string} cairoVersion
993
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
994
- * @property {string} componentType - Table
995
- * @property {GUID} csid
996
- * @property {string} dismissMode - Did the user click the X button ("manual") or was the notification automatically dismissed ("automatic")
997
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
998
- * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
999
- * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
1000
- * @property {boolean} isTPA
1001
- * @property {string} notificationText - What is displayed to the user, localized
1002
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1003
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1004
- * @return {LogObject<cairoTableTopNotificationDismissedParams>} LogObject<cairoTableTopNotificationDismissedParams>
1005
- */
1006
- function cairoTableTopNotificationDismissed(params) {
1007
- return { evid: 137, src: 144, endpoint: 'cairo-os', params: params };
1008
- }
1009
- exports.cairoTableTopNotificationDismissed = cairoTableTopNotificationDismissed;
1010
- /**
1011
- * A function to create a log object for the 'cairoSectionCtaClicked' event (evid: 153)
1012
- *
1013
- * Event description: Send when a user click on a section CTA (show more / show less etc.)
1014
- *
1015
- * @param {cairoSectionCtaClickedParams} params - The parameters for this event
1016
- * @property {string} appId
1017
- * @property {string} artifactId - Artifact that owns the component
1018
- * @property {string} cairoVersion - Cairo version
1019
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1020
- * @property {string} componentType - Section name (Folders)
1021
- * @property {GUID} csid
1022
- * @property {string} ctaId - CTA ID
1023
- * @property {string} ctaName - cta key (show more / show less etc.)
1024
- * @property {string} ctaType - Main / Secondary / More actions
1025
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1026
- * @property {boolean} isTPA
1027
- * @property {string} localizedCtaName - The CTA name, localized
1028
- * @property {string} loaction - CTA location: Section Toolbar, Collection Toolbar
1029
- * @property {string} location - CTA location: Section Toolbar, Collection Toolbar
1030
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1031
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1032
- * @property {string} sectionType - For example: Folders, Table/Grid switch etc.
1033
- * @return {LogObject<cairoSectionCtaClickedParams>} LogObject<cairoSectionCtaClickedParams>
1034
- */
1035
- function cairoSectionCtaClicked(params) {
1036
- return { evid: 153, src: 144, endpoint: 'cairo-os', params: params };
1037
- }
1038
- exports.cairoSectionCtaClicked = cairoSectionCtaClicked;
1039
- /**
1040
- * A function to create a log object for the 'cairoFileDownloadToastDisplayed' event (evid: 132)
1041
- *
1042
- * Event description: Sent when the export ends successfully and the user is prompted that the file is being downloaded
1043
- *
1044
- * @param {cairoFileDownloadToastDisplayedParams} params - The parameters for this event
1045
- * @property {string} appId
1046
- * @property {string} artifactId - Artifact that owns the component
1047
- * @property {string} cairoVersion
1048
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1049
- * @property {string} componentType - Table
1050
- * @property {GUID} csid
1051
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1052
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1053
- * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1054
- * @property {boolean} isTPA
1055
- * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
1056
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1057
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1058
- * @property {number} try - Which try is this; if try > 1, this is a retry
1059
- * @return {LogObject<cairoFileDownloadToastDisplayedParams>} LogObject<cairoFileDownloadToastDisplayedParams>
1060
- */
1061
- function cairoFileDownloadToastDisplayed(params) {
1062
- return { evid: 132, src: 144, endpoint: 'cairo-os', params: params };
1063
- }
1064
- exports.cairoFileDownloadToastDisplayed = cairoFileDownloadToastDisplayed;
1065
- /**
1066
- * A function to create a log object for the 'cairoSearchResults' event (evid: 116)
1067
- *
1068
- * 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.
1069
- *
1070
- * @param {cairoSearchResultsParams} params - The parameters for this event
1071
- * @property {string} appId
1072
- * @property {string} artifactId - Artifact that owns the component
1073
- * @property {string} cairoVersion
1074
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1075
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1076
- * @property {GUID} csid
1077
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1078
- * @property {boolean} isTPA
1079
- * @property {number} loadingTime - How much time (in ms) did it take to load the results for searchQuery
1080
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1081
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1082
- * @property {number} searchResultsCnt - How many results appeared for the search query. numSearchReults = 0 --> user saw empty state.
1083
- * @property {string} searchTerm - What did the user search? "" if removed search term.
1084
- * @return {LogObject<cairoSearchResultsParams>} LogObject<cairoSearchResultsParams>
1085
- */
1086
- function cairoSearchResults(params) {
1087
- return { evid: 116, src: 144, endpoint: 'cairo-os', params: params };
1088
- }
1089
- exports.cairoSearchResults = cairoSearchResults;
1090
- /**
1091
- * A function to create a log object for the 'cairoTagsModalEndProcess' event (evid: 167)
1092
- *
1093
- * Event description: Send when a user click on button that will close "Tags Modal". Relevant for Verticals who allow use tags in their tables.
1094
- *
1095
- * @param {cairoTagsModalEndProcessParams} params - The parameters for this event
1096
- * @property {string} appId
1097
- * @property {string} artifactId - Artifact that owns the component
1098
- * @property {string} cairoVersion - Cairo version
1099
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1100
- * @property {string} componentType - Component type
1101
- * @property {GUID} csid - Cairo session ID
1102
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1103
- * @property {string} endType - Close without changes
1104
- * @property {boolean} isTPA
1105
- * @property {number} numTags - How many tags are in the modal?
1106
- * @property {string} origin - Where did the user open Manage Tags modal from?
1107
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1108
- * @property {string} resource - resource
1109
- * @return {LogObject<cairoTagsModalEndProcessParams>} LogObject<cairoTagsModalEndProcessParams>
1110
- */
1111
- function cairoTagsModalEndProcess(params) {
1112
- return { evid: 167, src: 144, endpoint: 'cairo-os', params: params };
1113
- }
1114
- exports.cairoTagsModalEndProcess = cairoTagsModalEndProcess;
1115
- /**
1116
- * A function to create a log object for the 'cairoManageViewClicked' event (evid: 142)
1117
- *
1118
- * Event description: Sent when a user clicks on "Manage View" in a Cairo component. Relevant components: Table, Cards.
1119
- *
1120
- * @param {cairoManageViewClickedParams} params - The parameters for this event
1121
- * @property {string} appId
1122
- * @property {string} artifactId - Artifact that owns the component
1123
- * @property {string} cairoVersion - Cairo version
1124
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1125
- * @property {string} componentType - Table/Cards
1126
- * @property {GUID} csid
1127
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1128
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1129
- * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1130
- * @property {boolean} isTPA
1131
- * @property {number} numFiltersInView - How many filters comprise the saved view
1132
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1133
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1134
- * @return {LogObject<cairoManageViewClickedParams>} LogObject<cairoManageViewClickedParams>
1135
- */
1136
- function cairoManageViewClicked(params) {
1137
- return { evid: 142, src: 144, endpoint: 'cairo-os', params: params };
1138
- }
1139
- exports.cairoManageViewClicked = cairoManageViewClicked;
1140
- /**
1141
- * A function to create a log object for the 'cairoTagsModalStartLoad' event (evid: 166)
1142
- *
1143
- * Event description: Send when a user click on a "Tags Modal". Relevant for Verticals who allow use tags in their tables.
1144
- *
1145
- * @param {cairoTagsModalStartLoadParams} params - The parameters for this event
1146
- * @property {string} appId
1147
- * @property {string} artifactId - Artifact that owns the component
1148
- * @property {string} cairoVersion - Cairo version
1149
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1150
- * @property {string} componentType - Component type
1151
- * @property {GUID} csid - Cairo session ID
1152
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1153
- * @property {boolean} isTPA
1154
- * @property {number} numTags - How many tags are to be presented?
1155
- * @property {string} origin - Where did the user open Manage Tags modal from?
1156
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1157
- * @property {string} resource - resource
1158
- * @return {LogObject<cairoTagsModalStartLoadParams>} LogObject<cairoTagsModalStartLoadParams>
1159
- */
1160
- function cairoTagsModalStartLoad(params) {
1161
- return { evid: 166, src: 144, endpoint: 'cairo-os', params: params };
1162
- }
1163
- exports.cairoTagsModalStartLoad = cairoTagsModalStartLoad;
1164
- /**
1165
- * A function to create a log object for the 'cairoSortUnsuccessfulUpdateInServer' event (evid: 148)
1166
- *
1167
- * Event description: Sent when a user made a sort action but his changes weren't update in the server from different reasons
1168
- *
1169
- * @param {cairoSortUnsuccessfulUpdateInServerParams} params - The parameters for this event
1170
- * @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)
1171
- * @property {string} appId
1172
- * @property {string} artifactId - Artifact that owns the component
1173
- * @property {string} cairoVersion - cairo version
1174
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1175
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1176
- * @property {GUID} csid
1177
- * @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).
1178
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
1179
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1180
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1181
- * @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
1182
- * @property {number} filteredListSize - How many items are to be presented (filtered)
1183
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1184
- * @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.
1185
- * @property {boolean} isFromSearch - Was the failed action made on a search results?
1186
- * @property {boolean} isTPA
1187
- * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
1188
- * @property {string} origin - The location thefailed sort action was made from :"SidePanel"/"ColumnHeader"
1189
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1190
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1191
- * @property {string} searchQuery - (not relevant for now) What did the user search? isFromSearch = FALSE --> searchQuery = null .
1192
- * @property {string} sortOrderApplied - Which columns were used to sort the list when the user made the failed action: [{"fieldName": "FIELD_NAME", "order": "asc"}
1193
- * @property {string} sortingColumn - The sorted column that the user attempted to update (but failed).
1194
- * @property {string} tabShown
1195
- * @property {number} timeFromEndAction - duration in ms from the end of the failed action until the error indication
1196
- * @property {string} viewShown
1197
- * @property {string} visibleColumnsOrder - Which columns are currently comprise the saved view- by the order the user defined
1198
- * @return {LogObject<cairoSortUnsuccessfulUpdateInServerParams>} LogObject<cairoSortUnsuccessfulUpdateInServerParams>
1199
- */
1200
- function cairoSortUnsuccessfulUpdateInServer(params) {
1201
- return { evid: 148, src: 144, endpoint: 'cairo-os', params: params };
1202
- }
1203
- exports.cairoSortUnsuccessfulUpdateInServer = cairoSortUnsuccessfulUpdateInServer;
1204
- /**
1205
- * A function to create a log object for the 'cairoItemToggledInExportModal' event (evid: 126)
1206
- *
1207
- * Event description: Sent when user changes selection in the Cairo export modal
1208
- *
1209
- * @param {cairoItemToggledInExportModalParams} params - The parameters for this event
1210
- * @property {string} appId
1211
- * @property {string} artifactId - Artifact that owns the component
1212
- * @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}
1213
- * @property {string} cairoVersion
1214
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1215
- * @property {string} componentType - Table
1216
- * @property {GUID} csid
1217
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1218
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1219
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1220
- * @property {boolean} isTPA
1221
- * @property {string} newSelectedExportType - What type of export did the user switch to: "All Items"/"Filtered Items"/"Selected Items"
1222
- * @property {string} prevSelectedExportType - What type of export did the user have selected before swiching to newSelectedExportType: "All Items"/"Filtered Items"/"Selected Items"
1223
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1224
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1225
- * @return {LogObject<cairoItemToggledInExportModalParams>} LogObject<cairoItemToggledInExportModalParams>
1226
- */
1227
- function cairoItemToggledInExportModal(params) {
1228
- return { evid: 126, src: 144, endpoint: 'cairo-os', params: params };
1229
- }
1230
- exports.cairoItemToggledInExportModal = cairoItemToggledInExportModal;
1231
- /**
1232
- * A function to create a log object for the 'cairoDragActionUnsuccessfulUpdateInServer' event (evid: 140)
1233
- *
1234
- * Event description: Sent when a user finish to drag items but those changes weren't update in the server from different reasons
1235
- *
1236
- * @param {cairoDragActionUnsuccessfulUpdateInServerParams} params - The parameters for this event
1237
- * @property {string} appId
1238
- * @property {string} artifactId - Artifact that owns the component
1239
- * @property {string} cairoVersion - cairo version
1240
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1241
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1242
- * @property {GUID} csid
1243
- * @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).
1244
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1245
- * @property {GUID} dragAndDropID - A "couple" identifier , match between drag action and its drop action- will get the identifier of the failed action
1246
- * @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
1247
- * @property {number} filteredListSize - How many items are to be presented (filtered)?
1248
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1249
- * @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.
1250
- * @property {boolean} isTPA
1251
- * @property {string} itemId - ID of the item that the user tries to drag
1252
- * @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
1253
- * @property {number} itemIndexBefore - Out of the list of results, what was the index of the clicked item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
1254
- * @property {number} numItemsBefore - How many items have been selected before user clicks item and starts the drag action?
1255
- * @property {number} numItemsBeforeFailed - How many items have been selected when user made the failed action?
1256
- * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
1257
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1258
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1259
- * @property {string} searchQuery - (not relevant for now) What did the user search? isFromSearch = FALSE --> searchQuery = null .
1260
- * @property {string} sortOrderApplied - Which columns were used to sort the list when the user made the failed action: [{"fieldName": "FIELD_NAME", "order": "asc"}
1261
- * @property {string} tabShown - Which tab was displayed to the user when he made the failed action. Relevant for Table and Cards.
1262
- * @property {number} timeFromEndDrag - duration in ms from the end of the drag action until the error indication
1263
- * @property {string} viewShown - Which view was displayed to the user when he made the failed action. Relevant for Table and Cards.
1264
- * @property {boolean} wasFromHandle - Was the failed action made from the handle area?
1265
- * @return {LogObject<cairoDragActionUnsuccessfulUpdateInServerParams>} LogObject<cairoDragActionUnsuccessfulUpdateInServerParams>
1266
- */
1267
- function cairoDragActionUnsuccessfulUpdateInServer(params) {
1268
- return { evid: 140, src: 144, endpoint: 'cairo-os', params: params };
1269
- }
1270
- exports.cairoDragActionUnsuccessfulUpdateInServer = cairoDragActionUnsuccessfulUpdateInServer;
1271
- /**
1272
- * A function to create a log object for the 'cairoSearchForTags' event (evid: 170)
1273
- *
1274
- * Event description: Sent when the search results are displayed, after a user searches for a tag. Relevant for tables that enabled using tags.
1275
- *
1276
- * @param {cairoSearchForTagsParams} params - The parameters for this event
1277
- * @property {string} appId
1278
- * @property {string} artifactId - Artifact that owns the component
1279
- * @property {string} cairoVersion - Cairo version
1280
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1281
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1282
- * @property {GUID} csid - Cairo session id
1283
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1284
- * @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
1285
- * @property {boolean} isTPA
1286
- * @property {string} location - Where did the user search for the tag? Manage tags modal /
1287
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1288
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1289
- * @property {number} searchResultsCnt - How many results appeared for the search query. numSearchReults = 0 --> user saw the option to add this tag as new
1290
- * @property {string} searchTerm - What did the user search? "" if removed search term.
1291
- * @return {LogObject<cairoSearchForTagsParams>} LogObject<cairoSearchForTagsParams>
1292
- */
1293
- function cairoSearchForTags(params) {
1294
- return { evid: 170, src: 144, endpoint: 'cairo-os', params: params };
1295
- }
1296
- exports.cairoSearchForTags = cairoSearchForTags;
1297
- /**
1298
- * A function to create a log object for the 'cairoManageViewActionSelected' event (evid: 143)
1299
- *
1300
- * Event description: Sent when a user selects one of the actions in "manage view" menu.
1301
- *
1302
- * @param {cairoManageViewActionSelectedParams} params - The parameters for this event
1303
- * @property {number} actionIndex - 1 <= actionIndex <= numActions -- the number of the action out of all actions in the menu
1304
- * @property {string} actionName - "view-save-new"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
1305
- * @property {string} appId
1306
- * @property {string} artifactId - Artifact that owns the component
1307
- * @property {string} cairoVersion - cairo version
1308
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1309
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1310
- * @property {GUID} csid
1311
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1312
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1313
- * @property {boolean} isTPA
1314
- * @property {number} numActions - How many actions are existing in the current menu (including disabled actions)?
1315
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1316
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1317
- * @return {LogObject<cairoManageViewActionSelectedParams>} LogObject<cairoManageViewActionSelectedParams>
1318
- */
1319
- function cairoManageViewActionSelected(params) {
1320
- return { evid: 143, src: 144, endpoint: 'cairo-os', params: params };
1321
- }
1322
- exports.cairoManageViewActionSelected = cairoManageViewActionSelected;
1323
- /**
1324
- * A function to create a log object for the 'cairoLearnMore' event (evid: 158)
1325
- *
1326
- * Event description: Send when a user click on "Learn More" from Cairo component.
1327
- *
1328
- * @param {cairoLearnMoreParams} params - The parameters for this event
1329
- * @property {string} appId
1330
- * @property {string} artifactId - Artifact that owns the component
1331
- * @property {string} cairoVersion - Cairo version
1332
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1333
- * @property {string} componentType - Section name (Folders)
1334
- * @property {GUID} csid - Cairo session ID
1335
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1336
- * @property {boolean} isTPA
1337
- * @property {string} origin - Where did the user click on "Learn more" from? Add Custom Field Modal/ Edit Custom Field Modal / Table Toolbar
1338
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1339
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1340
- * @return {LogObject<cairoLearnMoreParams>} LogObject<cairoLearnMoreParams>
1341
- */
1342
- function cairoLearnMore(params) {
1343
- return { evid: 158, src: 144, endpoint: 'cairo-os', params: params };
1344
- }
1345
- exports.cairoLearnMore = cairoLearnMore;
1346
- /**
1347
- * A function to create a log object for the 'cairoAssignTagsToEntities' event (evid: 175)
1348
- *
1349
- * Event description: Assign Tags to entities
1350
- *
1351
- * @param {cairoAssignTagsToEntitiesParams} params - The parameters for this event
1352
- * @property {string} actionName - Assign / Remove
1353
- * @property {string} appId
1354
- * @property {string} artifactId - Artifact that owns the component
1355
- * @property {string} assignedTags - array of tags that were assigned (empty array if none)
1356
- * @property {string} cairoVersion - Cairo version
1357
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1358
- * @property {string} componentType - Component type
1359
- * @property {GUID} csid - Cairo session ID
1360
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1361
- * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
1362
- * @property {boolean} isTPA
1363
- * @property {string} itemIds - array of items ids that were selected
1364
- * @property {number} numItems - How many items have been selected?
1365
- * @property {string} origin - Where did the user make the action from?
1366
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1367
- * @property {string} resource - resource
1368
- * @property {string} unAssignedTags - array of tags that were unassigned (empty array if none)
1369
- * @return {LogObject<cairoAssignTagsToEntitiesParams>} LogObject<cairoAssignTagsToEntitiesParams>
1370
- */
1371
- function cairoAssignTagsToEntities(params) {
1372
- return { evid: 175, src: 144, endpoint: 'cairo-os', params: params };
1373
- }
1374
- exports.cairoAssignTagsToEntities = cairoAssignTagsToEntities;
1375
- /**
1376
- * A function to create a log object for the 'cairoPageCtaClicked' event (evid: 150)
1377
- *
1378
- * Event description: Sent when a user clicks a Page CTA ('add', 'more actions' etc.).
1379
- *
1380
- * @param {cairoPageCtaClickedParams} params - The parameters for this event
1381
- * @property {string} appId
1382
- * @property {string} artifactId - Artifact that owns the component
1383
- * @property {string} cairoVersion - Cairo version
1384
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1385
- * @property {string} componentType - Page
1386
- * @property {GUID} csid
1387
- * @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
1388
- * @property {string} ctaType - Main / Secondary / More Actions Dropdown / More Actions Option
1389
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1390
- * @property {boolean} isTPA
1391
- * @property {boolean} isValid - (Relevant only for Save CTA) True=if all fields are validated, False= if there are validation errors
1392
- * @property {string} location - CTA location: TBD
1393
- * @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
1394
- * @property {number} numCtas - (Relevant only for 'More Action Option' CTA) How many CTAs are available in the more action dropdown?
1395
- * @property {string} pageType - Collection / Entity
1396
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1397
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1398
- * @property {string} section - Relevant only for "cta type"="more actions option". Will get one of the values: Vertical / Cairo / TPA
1399
- * @return {LogObject<cairoPageCtaClickedParams>} LogObject<cairoPageCtaClickedParams>
1400
- */
1401
- function cairoPageCtaClicked(params) {
1402
- return { evid: 150, src: 144, endpoint: 'cairo-os', params: params };
1403
- }
1404
- exports.cairoPageCtaClicked = cairoPageCtaClicked;
1405
- /**
1406
- * A function to create a log object for the 'cairoTableTopNotificationDisplayed' event (evid: 136)
1407
- *
1408
- * Event description: Sent when a notification is displayed, showing a message that appears between the table header and the table rows
1409
- *
1410
- * @param {cairoTableTopNotificationDisplayedParams} params - The parameters for this event
1411
- * @property {string} appId
1412
- * @property {string} artifactId - Artifact that owns the component
1413
- * @property {string} cairoVersion
1414
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1415
- * @property {string} componentType - Table
1416
- * @property {GUID} csid
1417
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1418
- * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
1419
- * @property {boolean} isTPA
1420
- * @property {string} notificationText - What is displayed to the user, localized
1421
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1422
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1423
- * @return {LogObject<cairoTableTopNotificationDisplayedParams>} LogObject<cairoTableTopNotificationDisplayedParams>
1424
- */
1425
- function cairoTableTopNotificationDisplayed(params) {
1426
- return { evid: 136, src: 144, endpoint: 'cairo-os', params: params };
1427
- }
1428
- exports.cairoTableTopNotificationDisplayed = cairoTableTopNotificationDisplayed;
1429
- /**
1430
- * A function to create a log object for the 'cairoTryAgainClicked' event (evid: 141)
1431
- *
1432
- * Event description: Sent when a user clicks on a "try again" CTA he gets in an error notification
1433
- *
1434
- * @param {cairoTryAgainClickedParams} params - The parameters for this event
1435
- * @property {string} actionName - the action name that failed and triggered the notification (for example: drag, column reorder etc.)
1436
- * @property {string} appId
1437
- * @property {string} artifactId - Artifact that owns the component
1438
- * @property {string} cairoVersion - cairo version
1439
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1440
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1441
- * @property {GUID} csid
1442
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1443
- * @property {number} filteredListSize - How many items were presented when the user made the failed action (filtered)
1444
- * @property {boolean} isFromSearch - Did the user made the failed action on a list of search results
1445
- * @property {boolean} isTPA
1446
- * @property {string} loaction - Toast / Custom fields widget / View only widget / Component error state
1447
- * @property {number} numOfWaitingUpdates - (optional) number of updates in the sequence that follow the failed action
1448
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1449
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1450
- * @return {LogObject<cairoTryAgainClickedParams>} LogObject<cairoTryAgainClickedParams>
1451
- */
1452
- function cairoTryAgainClicked(params) {
1453
- return { evid: 141, src: 144, endpoint: 'cairo-os', params: params };
1454
- }
1455
- exports.cairoTryAgainClicked = cairoTryAgainClicked;
1456
- /**
1457
- * A function to create a log object for the 'cairoFiltersPanelUsed' event (evid: 119)
1458
- *
1459
- * 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.
1460
- *
1461
- * @param {cairoFiltersPanelUsedParams} params - The parameters for this event
1462
- * @property {string} appId
1463
- * @property {string} artifactId - Artifact that owns the component
1464
- * @property {string} cairoVersion
1465
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1466
- * @property {string} componentType - Table/Cards
1467
- * @property {GUID} csid
1468
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"} (new field from 01/2023)
1469
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
1470
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1471
- * @property {string} feature - Filter / Sort / Costume Columns / Manage Views / Manage custom fields (new field from 01/2023)/Tags
1472
- * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
1473
- * @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)
1474
- * @property {boolean} isTPA
1475
- * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
1476
- * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
1477
- * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
1478
- * @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
1479
- * @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
1480
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1481
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1482
- * @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)
1483
- * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
1484
- * @return {LogObject<cairoFiltersPanelUsedParams>} LogObject<cairoFiltersPanelUsedParams>
1485
- */
1486
- function cairoFiltersPanelUsed(params) {
1487
- return { evid: 119, src: 144, endpoint: 'cairo-os', params: params };
1488
- }
1489
- exports.cairoFiltersPanelUsed = cairoFiltersPanelUsed;
1490
- /**
1491
- * A function to create a log object for the 'cairoDragItem' event (evid: 138)
1492
- *
1493
- * Event description: Sent when a user clicks on an item and tries to drag it, in order to sort the items manually
1494
- *
1495
- * @param {cairoDragItemParams} params - The parameters for this event
1496
- * @property {string} appId
1497
- * @property {string} artifactId - Artifact that owns the component
1498
- * @property {string} cairoVersion - cairo version
1499
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1500
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1501
- * @property {GUID} csid
1502
- * @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).
1503
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
1504
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
1505
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1506
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1507
- * @property {GUID} dragAndDropID - A "couple" identifier , match between drag action and its drop action
1508
- * @property {number} filteredListSize - How many items are to be presented (filtered)
1509
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1510
- * @property {boolean} isFromHandle - Is the item dragged from the handle area?
1511
- * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
1512
- * @property {boolean} isTPA
1513
- * @property {string} itemId - ID of the item that the user tries to drag.
1514
- * @property {number} itemIndex - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndex <= X)
1515
- * @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
1516
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1517
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1518
- * @property {string} searchQuery - What did the user search? isFromSearch = FALSE --> searchQuery = null. (relate to ticket 521).
1519
- * @return {LogObject<cairoDragItemParams>} LogObject<cairoDragItemParams>
1520
- */
1521
- function cairoDragItem(params) {
1522
- return { evid: 138, src: 144, endpoint: 'cairo-os', params: params };
1523
- }
1524
- exports.cairoDragItem = cairoDragItem;
1525
- /**
1526
- * A function to create a log object for the 'cairoFileDownloadToastDismissed' event (evid: 133)
1527
- *
1528
- * 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).
1529
- *
1530
- * @param {cairoFileDownloadToastDismissedParams} params - The parameters for this event
1531
- * @property {string} appId
1532
- * @property {string} artifactId - Artifact that owns the component
1533
- * @property {string} cairoVersion
1534
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1535
- * @property {string} componentType - Table
1536
- * @property {GUID} csid
1537
- * @property {string} dismissMode - Did the user click the X button ("manual") or was the notification automatically dismissed ("automatic")
1538
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1539
- * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
1540
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1541
- * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1542
- * @property {boolean} isTPA
1543
- * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
1544
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1545
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1546
- * @return {LogObject<cairoFileDownloadToastDismissedParams>} LogObject<cairoFileDownloadToastDismissedParams>
1547
- */
1548
- function cairoFileDownloadToastDismissed(params) {
1549
- return { evid: 133, src: 144, endpoint: 'cairo-os', params: params };
1550
- }
1551
- exports.cairoFileDownloadToastDismissed = cairoFileDownloadToastDismissed;
1552
- /**
1553
- * A function to create a log object for the 'cairoUserAttemptsToCancelTheExport' event (evid: 129)
1554
- *
1555
- * Event description: Sent when the user tries to cancel the export process AFTER it has begun
1556
- *
1557
- * @param {cairoUserAttemptsToCancelTheExportParams} params - The parameters for this event
1558
- * @property {string} appId
1559
- * @property {string} artifactId - Artifact that owns the component
1560
- * @property {string} cairoVersion
1561
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1562
- * @property {string} componentType - Table
1563
- * @property {GUID} csid
1564
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1565
- * @property {number} duration - How much time (in ms) did it take since the export process began
1566
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1567
- * @property {boolean} isTPA
1568
- * @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.
1569
- * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
1570
- * @property {string} origin - How did the user try to cancel the export process: "Tab Closed"/"Cancel Buton"/"X Button"
1571
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1572
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1573
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
1574
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
1575
- * @property {number} try - Which try is this; if try > 1, this is a retry
1576
- * @return {LogObject<cairoUserAttemptsToCancelTheExportParams>} LogObject<cairoUserAttemptsToCancelTheExportParams>
1577
- */
1578
- function cairoUserAttemptsToCancelTheExport(params) {
1579
- return { evid: 129, src: 144, endpoint: 'cairo-os', params: params };
1580
- }
1581
- exports.cairoUserAttemptsToCancelTheExport = cairoUserAttemptsToCancelTheExport;
1582
- /**
1583
- * A function to create a log object for the 'pickerPickModalCtaButtonClickOrImmediateCta' event (evid: 104)
1584
- *
1585
- * Event description: Actual pick inside the Cairo picker (CTA button or immediate CTA)
1586
- *
1587
- * @param {pickerPickModalCtaButtonClickOrImmediateCtaParams} params - The parameters for this event
1588
- * @property {string} appId
1589
- * @property {string} artifactId - Artifact that owns the component
1590
- * @property {string} cairoVersion
1591
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
1592
- * @property {string} componentType
1593
- * @property {GUID} csid
1594
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
1595
- * @property {number} filteredListSize - How many items are to presented (filtered)
1596
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1597
- * @property {boolean} isImmediate - Is it an immediate CTA
1598
- * @property {boolean} isTPA
1599
- * @property {number} itemsCnt - Number of total items picked
1600
- * @property {number} listSize - How many items exist (full list)
1601
- * @property {number} maxItems - Max items to select in picker
1602
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
1603
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
1604
- * @property {string} type - standalone/modal
1605
- * @return {LogObject<pickerPickModalCtaButtonClickOrImmediateCtaParams>} LogObject<pickerPickModalCtaButtonClickOrImmediateCtaParams>
1606
- */
1607
- function pickerPickModalCtaButtonClickOrImmediateCta(params) {
1608
- return { evid: 104, src: 144, endpoint: 'cairo-os', params: params };
1609
- }
1610
- exports.pickerPickModalCtaButtonClickOrImmediateCta = pickerPickModalCtaButtonClickOrImmediateCta;
1611
- /**
1612
- * A function to create a log object for the 'newItemCreationStart' event (evid: 106)
1613
- *
1614
- * Event description: Sent when the user clicks the "create new" button
1615
- *
1616
- * @param {newItemCreationStartParams} params - The parameters for this event
1617
- * @property {string} appId
1618
- * @property {string} artifactId - Artifact that owns the component
1619
- * @property {string} cairoVersion
1620
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1621
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
1622
- * @property {GUID} csid
1623
- * @property {string} currentFilters - current filters
1624
- * @property {string} currentSortOrder - sorts
1625
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
1626
- * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1627
- * @property {boolean} isTPA
1628
- * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
1629
- * @property {number} maxItems - Max number of items that can be selected
1630
- * @property {number} numColumns - columns
1631
- * @property {number} numFiltersActive - filters
1632
- * @property {number} numSelectedItems - How many items have been selected before trying to create a new one. 0 <= numSelectedItems < maxItems
1633
- * @property {number} numSortedColumns - sort
1634
- * @property {string} origin - "Add New" click source: "Main CTA" / "Card CTA"
1635
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1636
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1637
- * @property {string} type - standalone/modal
1638
- * @property {string} visibleColumnsOrder - visible columns order
1639
- * @return {LogObject<newItemCreationStartParams>} LogObject<newItemCreationStartParams>
1640
- */
1641
- function newItemCreationStart(params) {
1642
- return { evid: 106, src: 144, endpoint: 'cairo-os', params: params };
1643
- }
1644
- exports.newItemCreationStart = newItemCreationStart;
1645
- /**
1646
- * A function to create a log object for the 'cairoViewSelected' event (evid: 123)
1647
- *
1648
- * Event description: Sent when a user selects a view in a Cairo component. Relevant components: Table, Cards.
1649
- *
1650
- * @param {cairoViewSelectedParams} params - The parameters for this event
1651
- * @property {string} appId
1652
- * @property {string} artifactId - Artifact that owns the component
1653
- * @property {string} cairoVersion
1654
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1655
- * @property {string} componentType - Table/Cards
1656
- * @property {GUID} csid
1657
- * @property {string} currentFilters - The current state of filters, after the new view selection
1658
- * @property {string} currentView - The selected view ID (match to "new view name", new field from 12/2022)
1659
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1660
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1661
- * @property {boolean} isDefault - Is the selected view defined as default view?
1662
- * @property {boolean} isFromSearchView - True if the view was selected from "search view in views dropdown" results (new from 01/2023)
1663
- * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1664
- * @property {boolean} isTPA
1665
- * @property {string} newViewName - Name of the newly selected view
1666
- * @property {number} numFiltersActive - How many filters are active after view selection
1667
- * @property {string} prevFilters - (Optional) The prevoius state of filters, before the new view selection
1668
- * @property {string} prevViewName - (Optional) Name of the previous view that the user was using. null if no view was selected.
1669
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1670
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1671
- * @return {LogObject<cairoViewSelectedParams>} LogObject<cairoViewSelectedParams>
1672
- */
1673
- function cairoViewSelected(params) {
1674
- return { evid: 123, src: 144, endpoint: 'cairo-os', params: params };
1675
- }
1676
- exports.cairoViewSelected = cairoViewSelected;
1677
- /**
1678
- * A function to create a log object for the 'cairoDataExAddCustomField' event (evid: 155)
1679
- *
1680
- * Event description: Send when a user click on a "Add Custom Field". Relevant for Verticals who allow data extensions
1681
- *
1682
- * @param {cairoDataExAddCustomFieldParams} params - The parameters for this event
1683
- * @property {string} appId
1684
- * @property {string} artifactId - Artifact that owns the component
1685
- * @property {string} cairoVersion - Cairo version
1686
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1687
- * @property {string} componentType - Component type
1688
- * @property {GUID} csid - Cairo session ID
1689
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1690
- * @property {boolean} isTPA
1691
- * @property {number} numColumns - How many columns are shown?
1692
- * @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)
1693
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1694
- * @property {string} resource
1695
- * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined
1696
- * @return {LogObject<cairoDataExAddCustomFieldParams>} LogObject<cairoDataExAddCustomFieldParams>
1697
- */
1698
- function cairoDataExAddCustomField(params) {
1699
- return { evid: 155, src: 144, endpoint: 'cairo-os', params: params };
1700
- }
1701
- exports.cairoDataExAddCustomField = cairoDataExAddCustomField;
1702
- /**
1703
- * A function to create a log object for the 'cairoFilterToggled' event (evid: 117)
1704
- *
1705
- * Event description: Sent when a user triggers/removes a filter from a Cairo component. Relevant components: Table, Cards.
1706
- *
1707
- * @param {cairoFilterToggledParams} params - The parameters for this event
1708
- * @property {string} actionType - "add"/"remove" -- Did we add or remove filterName from the list of filters
1709
- * @property {string} appId
1710
- * @property {string} artifactId - Artifact that owns the component
1711
- * @property {string} cairoVersion
1712
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1713
- * @property {string} componentType - Table/Cards / Picker (from 12/2022)
1714
- * @property {GUID} csid - Cairo session ID
1715
- * @property {string} currentFilters - The current state of filters, following the filter trigger
1716
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1717
- * @property {string} filterName - Which column filter do we want to toggle now, e.g. Beginner / Amateur
1718
- * @property {string} filterValue - JSON containing filterName's new value
1719
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1720
- * @property {boolean} isTPA
1721
- * @property {number} listSize - How many items exist (full list, unfiltered)
1722
- * @property {number} numFiltersActive - How many filters are active after filterName is toggled. actionType = "add" --> numFiltersActive >= 1; actionType = "remove" --> numFiltersActive < numColumns
1723
- * @property {string} origin - "Panel"/"SubToolbar"/"Toolbar"
1724
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1725
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1726
- * @return {LogObject<cairoFilterToggledParams>} LogObject<cairoFilterToggledParams>
1727
- */
1728
- function cairoFilterToggled(params) {
1729
- return { evid: 117, src: 144, endpoint: 'cairo-os', params: params };
1730
- }
1731
- exports.cairoFilterToggled = cairoFilterToggled;
1732
- /**
1733
- * A function to create a log object for the 'cairoDataExCustomFieldAdvancesSettings' event (evid: 157)
1734
- *
1735
- * Event description: Send when a user click on "Advanced Settings" in the "Add Custom Field" modal. Relevant for Verticals who allowed data extensions
1736
- *
1737
- * @param {cairoDataExCustomFieldAdvancesSettingsParams} params - The parameters for this event
1738
- * @property {string} actionName - Open / Close the advanced settings
1739
- * @property {string} appId
1740
- * @property {string} artifactId - Artifact that owns the component
1741
- * @property {string} cairoVersion - Cairo version
1742
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1743
- * @property {string} componentType - Component type
1744
- * @property {GUID} csid - Cairo session ID
1745
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1746
- * @property {boolean} isTPA
1747
- * @property {string} origin - Where did the user click on "Advanced Settings" from? Add Custom Field Modal / Edit Custom Field Modal
1748
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1749
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1750
- * @return {LogObject<cairoDataExCustomFieldAdvancesSettingsParams>} LogObject<cairoDataExCustomFieldAdvancesSettingsParams>
1751
- */
1752
- function cairoDataExCustomFieldAdvancesSettings(params) {
1753
- return { evid: 157, src: 144, endpoint: 'cairo-os', params: params };
1754
- }
1755
- exports.cairoDataExCustomFieldAdvancesSettings = cairoDataExCustomFieldAdvancesSettings;
1756
- /**
1757
- * A function to create a log object for the 'cairoViewSaved' event (evid: 122)
1758
- *
1759
- * Event description: Sent when a user creates/saves a view in a Cairo component. Relevant components: Table, Cards.
1760
- *
1761
- * @param {cairoViewSavedParams} params - The parameters for this event
1762
- * @property {string} appId
1763
- * @property {string} artifactId - Artifact that owns the component
1764
- * @property {string} cairoVersion - Cairo version
1765
- * @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)
1766
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1767
- * @property {string} componentType - Table/Cards
1768
- * @property {GUID} csid
1769
- * @property {string} viewFilters - The filters that comprise the view that was just saved
1770
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"} (new field from 11/2022)
1771
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1772
- * @property {boolean} isDefault - Is the saved view defined as default view?
1773
- * @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)
1774
- * @property {boolean} isTPA
1775
- * @property {string} newViewName - Name of the newly created/saved/renamed view
1776
- * @property {number} numColumnsInView - How many columns comprise the saved view (new field from 11/2022)
1777
- * @property {number} numFiltersInView - How many filters comprise the saved view
1778
- * @property {string} origin - From where was the view created: Panel, SubToolbar, Toolbar
1779
- * @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)
1780
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1781
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1782
- * @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)
1783
- * @property {string} searchQuery - What did the user search? If there wasn't any search --> searchQuery = null. (new field from 11/2022)
1784
- * @property {string} viewId - The "new view name" unique identifier (new field from 11/2022)
1785
- * @property {string} visibleColumnsOrder - Which columns are currently comprise the saved view- by the order the user defined (new field from 11/2022)
1786
- * @return {LogObject<cairoViewSavedParams>} LogObject<cairoViewSavedParams>
1787
- */
1788
- function cairoViewSaved(params) {
1789
- return { evid: 122, src: 144, endpoint: 'cairo-os', params: params };
1790
- }
1791
- exports.cairoViewSaved = cairoViewSaved;
1792
- /**
1793
- * A function to create a log object for the 'cairoViewDeleted' event (evid: 124)
1794
- *
1795
- * Event description: Sent when a user deletes a view in a Cairo component. Relevant components: Table, Cards.
1796
- *
1797
- * @param {cairoViewDeletedParams} params - The parameters for this event
1798
- * @property {string} appId
1799
- * @property {string} artifactId - Artifact that owns the component
1800
- * @property {string} cairoVersion
1801
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1802
- * @property {string} componentType - Table/Cards
1803
- * @property {GUID} csid
1804
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1805
- * @property {boolean} isDefault - Was the deleted view defined as default view?
1806
- * @property {boolean} isTPA
1807
- * @property {number} numFiltersInView - How many filters comprised the deleted view
1808
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1809
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1810
- * @property {string} viewFilters - The filters that comprised the view that was just deleted
1811
- * @property {string} viewId - The "view name" (deleted view) unique identifier (new field from 11/2022)
1812
- * @property {string} viewName - Name of the deleted view
1813
- * @property {boolean} wasSelected - TRUE if viewName was the selected view before deletion; FALSE otherwise
1814
- * @return {LogObject<cairoViewDeletedParams>} LogObject<cairoViewDeletedParams>
1815
- */
1816
- function cairoViewDeleted(params) {
1817
- return { evid: 124, src: 144, endpoint: 'cairo-os', params: params };
1818
- }
1819
- exports.cairoViewDeleted = cairoViewDeleted;
1820
- /**
1821
- * A function to create a log object for the 'cairoDataExCustomFieldEndProcess' event (evid: 156)
1822
- *
1823
- * Event description: Send when a user click on cancel / add field in the "Add Custom Field" modal. Relevant for Verticals who allowed data extensions
1824
- *
1825
- * @param {cairoDataExCustomFieldEndProcessParams} params - The parameters for this event
1826
- * @property {string} actionName - Add/ Edit
1827
- * @property {string} appId
1828
- * @property {string} artifactId - Artifact that owns the component
1829
- * @property {string} cairoVersion - Cairo version
1830
- * @property {string} changedFields - (Relevant when action type is edit) Name / Permission / Name and Permission / No changes
1831
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1832
- * @property {string} componentType - Section name (Folders)
1833
- * @property {GUID} csid - Cairo session ID
1834
- * @property {string} currentDropdownOptions - Only for fieldType= dropdown, the options list by its order
1835
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1836
- * @property {string} endType - What did the user chose in the modal? Add field / Cancel
1837
- * @property {string} fieldName - (Relevant when a field was added/edited) The name the user typed
1838
- * @property {string} fieldType - (Relevant when a field was added) What type is the added field? Long text / Date / Number etc.
1839
- * @property {boolean} isTPA
1840
- * @property {string} key - The key value
1841
- * @property {number} numAdded - (Relevant when a field was added/edited) How many added fields are there in the component (including the current added field)
1842
- * @property {number} numDropdownOptions - Only for fieldType= dropdown, how many options were saved?
1843
- * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
1844
- * @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.
1845
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1846
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1847
- * @return {LogObject<cairoDataExCustomFieldEndProcessParams>} LogObject<cairoDataExCustomFieldEndProcessParams>
1848
- */
1849
- function cairoDataExCustomFieldEndProcess(params) {
1850
- return { evid: 156, src: 144, endpoint: 'cairo-os', params: params };
1851
- }
1852
- exports.cairoDataExCustomFieldEndProcess = cairoDataExCustomFieldEndProcess;
1853
- /**
1854
- * A function to create a log object for the 'cairoComponentSorted' event (evid: 120)
1855
- *
1856
- * Event description: Sent when a user sorts a Cairo component. Relevant components: Table, Cards.
1857
- *
1858
- * @param {cairoComponentSortedParams} params - The parameters for this event
1859
- * @property {string} appId
1860
- * @property {string} artifactId - Artifact that owns the component
1861
- * @property {string} cairoVersion - Cairo version
1862
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1863
- * @property {string} componentType - Table/Cards
1864
- * @property {GUID} csid
1865
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1866
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1867
- * @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)
1868
- * @property {boolean} isTPA
1869
- * @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)
1870
- * @property {number} listSize - How many items exist (full list, unfiltered)
1871
- * @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)
1872
- * @property {string} newSortedColumn - By which column are we adding sorting now
1873
- * @property {string} newSortingOrder - "asc"/"desc"/"removed" (was "null" until 12/2022, then changed to "removed")
1874
- * @property {number} numSortingColumns - The number of columns that sorting the component after the current action
1875
- * @property {string} origin - The location the sort action was made from :"SidePanel"/"ColumnHeader" (new field from 11/2022)
1876
- * @property {number} prevNumSortingColumns - The number of columns that were sorting the component before the current action
1877
- * @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)
1878
- * @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
1879
- * @property {string} prevSortingOrder - The last order the user used to sort the list by "prev sorting column" : "asc"/"desc"/null (if wasn't sorted)
1880
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1881
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1882
- * @return {LogObject<cairoComponentSortedParams>} LogObject<cairoComponentSortedParams>
1883
- */
1884
- function cairoComponentSorted(params) {
1885
- return { evid: 120, src: 144, endpoint: 'cairo-os', params: params };
1886
- }
1887
- exports.cairoComponentSorted = cairoComponentSorted;
1888
- /**
1889
- * A function to create a log object for the 'cairoReorderingSortColumns' event (evid: 147)
1890
- *
1891
- * Event description: Sent when a user changes the order of the columns that sort a Cairo component. Relevant components: Table, Cards.
1892
- *
1893
- * @param {cairoReorderingSortColumnsParams} params - The parameters for this event
1894
- * @property {string} appId
1895
- * @property {string} artifactId - Artifact that owns the component
1896
- * @property {string} cairoVersion - Cairo version
1897
- * @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)
1898
- * @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)
1899
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1900
- * @property {string} componentType - Table/Cards
1901
- * @property {GUID} csid
1902
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1903
- * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1904
- * @property {boolean} isTPA
1905
- * @property {number} listSize - How many items exist (full list, unfiltered)
1906
- * @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.
1907
- * @property {number} numSortingColumns - How many columns are been used for sorting the component?
1908
- * @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.
1909
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1910
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1911
- * @property {string} sortingColumn - The sorting column that the user changes its place in the sort hierarchy
1912
- * @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'.
1913
- * @return {LogObject<cairoReorderingSortColumnsParams>} LogObject<cairoReorderingSortColumnsParams>
1914
- */
1915
- function cairoReorderingSortColumns(params) {
1916
- return { evid: 147, src: 144, endpoint: 'cairo-os', params: params };
1917
- }
1918
- exports.cairoReorderingSortColumns = cairoReorderingSortColumns;
1919
- /**
1920
- * A function to create a log object for the 'cairoExportProcessEnd' event (evid: 131)
1921
- *
1922
- * Event description: Sent when the export process ends, either successfully or not (failed/stopped by user)
1923
- *
1924
- * @param {cairoExportProcessEndParams} params - The parameters for this event
1925
- * @property {string} appId
1926
- * @property {string} artifactId - Artifact that owns the component
1927
- * @property {string} cairoVersion
1928
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1929
- * @property {string} componentType - Table
1930
- * @property {GUID} csid
1931
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1932
- * @property {number} duration - How much time (in ms) did it take since the export process began
1933
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1934
- * @property {string} fileName - (Optional) Name of the file to be exported
1935
- * @property {boolean} isTPA
1936
- * @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.
1937
- * @property {number} numItemsExported - How many items were exported before the export ended, either successfully or not.
1938
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1939
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1940
- * @property {string} result - Was the export successful or did it fail/stopped by user: "success"/'fail"/"stopped by user"
1941
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
1942
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
1943
- * @property {number} try - Which try is this; if try > 1, this is a retry
1944
- * @return {LogObject<cairoExportProcessEndParams>} LogObject<cairoExportProcessEndParams>
1945
- */
1946
- function cairoExportProcessEnd(params) {
1947
- return { evid: 131, src: 144, endpoint: 'cairo-os', params: params };
1948
- }
1949
- exports.cairoExportProcessEnd = cairoExportProcessEnd;
1950
- /**
1951
- * A function to create a log object for the 'cairoApplyButtonClicked' event (evid: 159)
1952
- *
1953
- * Event description: Sent when a user clicks on apply button in a Cairo component. Relevant components: Table, Cards.
1954
- *
1955
- * @param {cairoApplyButtonClickedParams} params - The parameters for this event
1956
- * @property {string} appId
1957
- * @property {string} artifactId
1958
- * @property {string} cairoVersion - Cairo version
1959
- * @property {string} changedLevels - In which levels of hierarchy the user changed the order? (numbers with commas between them, 1=the highest parent level )
1960
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1961
- * @property {string} componentType - Table/Cards / Picker (from 12/2022)
1962
- * @property {GUID} csid - Cairo session ID
1963
- * @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)
1964
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1965
- * @property {string} feature - Filters / Drag and Drop
1966
- * @property {number} filteredListSize - How many items are currently presented to user, after filters toggled (filtered)
1967
- * @property {boolean} isTPA
1968
- * @property {number} listSize - How many items exist (full list, unfiltered)
1969
- * @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)
1970
- * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
1971
- * @property {number} numOptionalFields - (Optional, relevant for Filters) If there is an optional fields list (like for filters)- how many options are there?
1972
- * @property {string} origin - Feature's Side Panel / Table Toolbar
1973
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1974
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1975
- * @return {LogObject<cairoApplyButtonClickedParams>} LogObject<cairoApplyButtonClickedParams>
1976
- */
1977
- function cairoApplyButtonClicked(params) {
1978
- return { evid: 159, src: 144, endpoint: 'cairo-os', params: params };
1979
- }
1980
- exports.cairoApplyButtonClicked = cairoApplyButtonClicked;
1981
- /**
1982
- * A function to create a log object for the 'cairoExportModalCtaClicked' event (evid: 127)
1983
- *
1984
- * Event description: Sent when the user clicks any CTA in the export modal
1985
- *
1986
- * @param {cairoExportModalCtaClickedParams} params - The parameters for this event
1987
- * @property {string} action - Does the user want to proceed with the export or dismiss the modal
1988
- * @property {string} appId
1989
- * @property {string} artifactId - Artifact that owns the component
1990
- * @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
1991
- * @property {string} cairoVersion
1992
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1993
- * @property {string} componentType - Table
1994
- * @property {GUID} csid
1995
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1996
- * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1997
- * @property {boolean} isTPA
1998
- * @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.
1999
- * @property {string} origin - From where did the user close the modal: "Export Button"/"Cancel Button"/"X Button"
2000
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2001
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
2002
- * @property {string} selectedExportType - What type of export does the user want: "All Items"/"Filtered Items"/"Selected Items"
2003
- * @property {boolean} supportsTotal - Does the vertical using Cairo support total number of items in list
2004
- * @return {LogObject<cairoExportModalCtaClickedParams>} LogObject<cairoExportModalCtaClickedParams>
2005
- */
2006
- function cairoExportModalCtaClicked(params) {
2007
- return { evid: 127, src: 144, endpoint: 'cairo-os', params: params };
2008
- }
2009
- exports.cairoExportModalCtaClicked = cairoExportModalCtaClicked;
2010
- /**
2011
- * A function to create a log object for the 'cairoUndoClicked' event (evid: 144)
2012
- *
2013
- * Event description: Sent when a user clicks on a "undo" CTA he gets in a toast confirming an action was made
2014
- *
2015
- * @param {cairoUndoClickedParams} params - The parameters for this event
2016
- * @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.)
2017
- * @property {string} appId
2018
- * @property {string} artifactId - Artifact that owns the component
2019
- * @property {string} cairoVersion - cairo version
2020
- * @property {string} changedAttributes - Which attributes have changed from the saved status to the current
2021
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
2022
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
2023
- * @property {GUID} csid
2024
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
2025
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
2026
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
2027
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
2028
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
2029
- * @property {number} filteredListSize - How many items are to be presented (filtered)
2030
- * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the action he wants to undo?
2031
- * @property {boolean} isTPA
2032
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2033
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
2034
- * @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"}
2035
- * @property {string} viewId - The view that the undo action was made on
2036
- * @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)
2037
- * @property {string} viewNameApplied - In case of action name=rename view - the new name the user gave to the view and now he undo it
2038
- * @return {LogObject<cairoUndoClickedParams>} LogObject<cairoUndoClickedParams>
2039
- */
2040
- function cairoUndoClicked(params) {
2041
- return { evid: 144, src: 144, endpoint: 'cairo-os', params: params };
2042
- }
2043
- exports.cairoUndoClicked = cairoUndoClicked;
2044
- /**
2045
- * A function to create a log object for the 'cairoPageBackOrBreadcrumbClicked' event (evid: 152)
2046
- *
2047
- * Event description: Sent when a user clicks a Back button or on the higher hierarchy in the breadcrumbs
2048
- *
2049
- * @param {cairoPageBackOrBreadcrumbClickedParams} params - The parameters for this event
2050
- * @property {string} appId
2051
- * @property {string} artifactId - Artifact that owns the component
2052
- * @property {string} buttonName - 'Back' (for back button clicked) / The category's name the users clicked on.
2053
- * @property {string} cairoVersion - Cairo version
2054
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
2055
- * @property {string} componentType - Page
2056
- * @property {GUID} csid
2057
- * @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)
2058
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2059
- * @property {boolean} isTPA
2060
- * @property {string} pageType - Collection Page
2061
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2062
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
2063
- * @property {string} section - Relevant only for "cta type"="more actions option". For now, will get one of the values: Vertical / Cairo
2064
- * @return {LogObject<cairoPageBackOrBreadcrumbClickedParams>} LogObject<cairoPageBackOrBreadcrumbClickedParams>
2065
- */
2066
- function cairoPageBackOrBreadcrumbClicked(params) {
2067
- return { evid: 152, src: 144, endpoint: 'cairo-os', params: params };
2068
- }
2069
- exports.cairoPageBackOrBreadcrumbClicked = cairoPageBackOrBreadcrumbClicked;
2070
- /**
2071
- * A function to create a log object for the 'cairoTpaSCtaClicked' event (evid: 154)
2072
- *
2073
- * Event description: Send when a user click on a TPA's CTA from a Cairo component
2074
- *
2075
- * @param {cairoTpaSCtaClickedParams} params - The parameters for this event
2076
- * @property {GUID} appId - App ID (for now- please look at tpaComponentId field description to get this data)
2077
- * @property {string} artifactId - Artifact that owns the component
2078
- * @property {string} cairoVersion - Cairo version
2079
- * @property {string} componentName - (Optional) Component's name, if there are two components of the same type per artifact
2080
- * @property {string} componentType - Table, Grid, Page etc.
2081
- * @property {GUID} csid
2082
- * @property {number} ctaIndex - 0 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the page dropdown menu/ Toolbar
2083
- * @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
2084
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2085
- * @property {boolean} isTPA
2086
- * @property {string} location - Page More Action Dropdown / Component Bulk action Toolbar
2087
- * @property {number} numCtas - How many CTAs are available in the page dropdown menu / toolbar?
2088
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2089
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
2090
- * @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
2091
- * @return {LogObject<cairoTpaSCtaClickedParams>} LogObject<cairoTpaSCtaClickedParams>
2092
- */
2093
- function cairoTpaSCtaClicked(params) {
2094
- return { evid: 154, src: 144, endpoint: 'cairo-os', params: params };
2095
- }
2096
- exports.cairoTpaSCtaClicked = cairoTpaSCtaClicked;
2097
- /**
2098
- * A function to create a log object for the 'pikachuCategoriesDropdownButtonClicked' event (evid: 108)
2099
- *
2100
- * Event description: Sent when user clicks the general "+"/"Add Items" button that opens Pikachu
2101
- *
2102
- * @param {pikachuCategoriesDropdownButtonClickedParams} params - The parameters for this event
2103
- * @property {string} appId
2104
- * @property {string} artifactId - Artifact that owns the component
2105
- * @property {string} cairoVersion
2106
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
2107
- * @property {string} componentType
2108
- * @property {GUID} csid
2109
- * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
2110
- * @property {boolean} isTPA
2111
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2112
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
2113
- * @return {LogObject<pikachuCategoriesDropdownButtonClickedParams>} LogObject<pikachuCategoriesDropdownButtonClickedParams>
2114
- */
2115
- function pikachuCategoriesDropdownButtonClicked(params) {
2116
- return { evid: 108, src: 144, endpoint: 'cairo-os', params: params };
2117
- }
2118
- exports.pikachuCategoriesDropdownButtonClicked = pikachuCategoriesDropdownButtonClicked;
2119
- /**
2120
- * A function to create a log object for the 'cairoTagsUnsuccessfulUpdateInServer' event (evid: 169)
2121
- *
2122
- * 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.
2123
- *
2124
- * @param {cairoTagsUnsuccessfulUpdateInServerParams} params - The parameters for this event
2125
- * @property {string} actionName - Add / Delete / Rename / Assign / Remove assign / Add and assign / Load tags widget
2126
- * @property {string} appId
2127
- * @property {string} artifactId - Artifact that owns the component
2128
- * @property {string} cairoVersion - Cairo version
2129
- * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
2130
- * @property {string} componentType - Component type
2131
- * @property {GUID} csid - Cairo session ID
2132
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2133
- * @property {string} errorType - What is the type of the error? Technical issue / Network error
2134
- * @property {boolean} isTPA
2135
- * @property {number} numTags - How many tags are in the modal after this action?
2136
- * @property {string} origin - Where did the user make the action from? Tags Modal / Entity page
2137
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2138
- * @property {string} resource - resource
2139
- * @property {string} tagName - The name of the removed/added/assigned tag
2140
- * @return {LogObject<cairoTagsUnsuccessfulUpdateInServerParams>} LogObject<cairoTagsUnsuccessfulUpdateInServerParams>
2141
- */
2142
- function cairoTagsUnsuccessfulUpdateInServer(params) {
2143
- return { evid: 169, src: 144, endpoint: 'cairo-os', params: params };
2144
- }
2145
- exports.cairoTagsUnsuccessfulUpdateInServer = cairoTagsUnsuccessfulUpdateInServer;
2146
- /**
2147
- * A function to create a log object for the 'pickerModalUsability' event (evid: 103)
2148
- *
2149
- * Event description: Any usability action performed inside the picker
2150
- *
2151
- * @param {pickerModalUsabilityParams} params - The parameters for this event
2152
- * @property {string} action - Use cases: search/search results/checkbox/continue/dismiss/load more
2153
- * @property {string} appId
2154
- * @property {string} artifactId - Artifact that owns the component
2155
- * @property {string} cairoVersion
2156
- * @property {string} componentName - Optional in case having 2 pickers under the same artifact
2157
- * @property {string} componentType
2158
- * @property {GUID} csid
2159
- * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
2160
- * @property {number} filteredListSize - How many items are to presented (filtered)
2161
- * @property {boolean} isTPA
2162
- * @property {string} itemId - (Optional) ID of item checked
2163
- * @property {number} itemsCnt - (Optional) Number of total items checked
2164
- * @property {number} itemsLoadedCnt - (Optional) Number of additional items loaded
2165
- * @property {number} listSize - How many items exist (full list)
2166
- * @property {number} loadingTime - (Optional) Loading time for use cases such as search results or load more
2167
- * @property {number} maxItems - Max items to select in picker
2168
- * @property {string} pickSource - The instance that lead to this (Inbox)
2169
- * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
2170
- * @property {string} resource - Singular form of the resource name. E.g. order, contact, etc. from FDQN ("goal" of picker)
2171
- * @property {number} searchResultsCnt - (Optional) Number of search results
2172
- * @property {string} searchTerm - (Optional) Search term used
2173
- * @property {string} type - standalone/modal
2174
- * @return {LogObject<pickerModalUsabilityParams>} LogObject<pickerModalUsabilityParams>
2175
- */
2176
- function pickerModalUsability(params) {
2177
- return { evid: 103, src: 144, endpoint: 'cairo-os', params: params };
2178
- }
2179
- exports.pickerModalUsability = pickerModalUsability;
2180
- /**
2181
- * A function to create a log object for the 'cairoSortPanelUsed' event (evid: 146)
2182
- *
2183
- * Event description: Sent when the sort sidebar in a Cairo component is opened or closed. Relevant components: Table, Cards.
2184
- *
2185
- * @param {cairoSortPanelUsedParams} params - The parameters for this event
2186
- * @property {string} appId
2187
- * @property {string} artifactId
2188
- * @property {string} cairoVersion - Cairo version
2189
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
2190
- * @property {string} componentType - Table/Cards
2191
- * @property {GUID} csid
2192
- * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
2193
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2194
- * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
2195
- * @property {boolean} isTPA
2196
- * @property {number} numSortedColumns - How many columns actively sort the data?
2197
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2198
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
2199
- * @return {LogObject<cairoSortPanelUsedParams>} LogObject<cairoSortPanelUsedParams>
2200
- */
2201
- function cairoSortPanelUsed(params) {
2202
- return { evid: 146, src: 144, endpoint: 'cairo-os', params: params };
2203
- }
2204
- exports.cairoSortPanelUsed = cairoSortPanelUsed;
2205
- /**
2206
- * A function to create a log object for the 'cairoTagsAssignTag' event (evid: 173)
2207
- *
2208
- * Event description: Send when a user assign or remove a tag from an item. Relevant for Verticals who allow use tags in their tables.
2209
- *
2210
- * @param {cairoTagsAssignTagParams} params - The parameters for this event
2211
- * @property {string} actionName - Assign / Remove
2212
- * @property {string} appId
2213
- * @property {string} artifactId - Artifact that owns the component
2214
- * @property {string} cairoVersion - Cairo version
2215
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
2216
- * @property {string} componentType - Component type
2217
- * @property {GUID} csid - Cairo session ID
2218
- * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2219
- * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
2220
- * @property {boolean} isTPA
2221
- * @property {string} itemId - (Relevant if numItems=1) The Item which the tag was assigned to / removed from
2222
- * @property {number} numItems - How many items have been selected?
2223
- * @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
2224
- * @property {number} numTagsAssigned - (Relevant if numItems=1) How many tags are assigned to that item after this action?
2225
- * @property {string} origin - Where did the user make the action from? Entity page /
2226
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2227
- * @property {string} resource - resource
2228
- * @property {string} tagName - The name of the assigned/ removed tag
2229
- * @return {LogObject<cairoTagsAssignTagParams>} LogObject<cairoTagsAssignTagParams>
2230
- */
2231
- function cairoTagsAssignTag(params) {
2232
- return { evid: 173, src: 144, endpoint: 'cairo-os', params: params };
2233
- }
2234
- exports.cairoTagsAssignTag = cairoTagsAssignTag;
2235
- /**
2236
- * A function to create a log object for the 'cairoApiRequestDataLoadEnd' event (evid: 149)
2237
- *
2238
- * Event description: Sent when a Cairo's page can't be saved due to an error.
2239
- *
2240
- * @param {cairoApiRequestDataLoadEndParams} params - The parameters for this event
2241
- * @property {string} appId
2242
- * @property {string} artifactId - Artifact that owns the component
2243
- * @property {string} cairoVersion - Cairo version
2244
- * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
2245
- * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
2246
- * @property {GUID} csid
2247
- * @property {string} currentFilters - A list of filters that are currently displayed to user: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
2248
- * @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.
2249
- * @property {string} currentTab - Which tab is currently displayed to the user. Relevant for Table and Cards.
2250
- * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
2251
- * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
2252
- * @property {number} duration - Duration in ms, from clicking on the save button until getting the error indication
2253
- * @property {string} errorType - Technical issue / Logic error / Network error / External error
2254
- * @property {number} filteredListSize - How many items are to be presented (filtered)
2255
- * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
2256
- * @property {boolean} isTPA
2257
- * @property {string} pageType - Entity / Collection
2258
- * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2259
- * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
2260
- * @property {string} route - the page's route
2261
- * @return {LogObject<cairoApiRequestDataLoadEndParams>} LogObject<cairoApiRequestDataLoadEndParams>
2262
- */
2263
- function cairoApiRequestDataLoadEnd(params) {
2264
- return { evid: 149, src: 144, endpoint: 'cairo-os', params: params };
2265
- }
2266
- exports.cairoApiRequestDataLoadEnd = cairoApiRequestDataLoadEnd;
2267
- //# sourceMappingURL=index.js.map