@wix/bex-utils 2.6.0 → 2.7.0

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