@wix/bex-utils 2.5.0 → 2.7.0

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