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