@algolia/client-analytics 5.0.0-alpha.106 → 5.0.0-alpha.108

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 (14) hide show
  1. package/dist/client-analytics.cjs +66 -66
  2. package/dist/client-analytics.esm.browser.js +66 -66
  3. package/dist/client-analytics.esm.node.js +66 -66
  4. package/dist/client-analytics.umd.js +2 -2
  5. package/dist/model/clientMethodProps.d.ts +65 -65
  6. package/dist/model/searchNoResultEvent.d.ts +1 -1
  7. package/dist/model/topSearch.d.ts +1 -1
  8. package/dist/model/topSearchWithAnalytics.d.ts +1 -1
  9. package/dist/src/analyticsClient.d.ts +66 -66
  10. package/model/clientMethodProps.ts +65 -65
  11. package/model/searchNoResultEvent.ts +1 -1
  12. package/model/topSearch.ts +1 -1
  13. package/model/topSearchWithAnalytics.ts +1 -1
  14. package/package.json +7 -7
package/dist/model/clientMethodProps.d.ts CHANGED
@@ -65,15 +65,15 @@ export type CustomPutProps = {
65
65
  */
66
66
  export type GetAverageClickPositionProps = {
67
67
  /**
68
- * Index name to target.
68
+ * Index name.
69
69
  */
70
70
  index: string;
71
71
  /**
72
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
72
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
73
73
  */
74
74
  startDate?: string;
75
75
  /**
76
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
76
+ * End date (`YYYY-MM-DD`) of the period to analyze.
77
77
  */
78
78
  endDate?: string;
79
79
  /**
@@ -86,15 +86,15 @@ export type GetAverageClickPositionProps = {
86
86
  */
87
87
  export type GetClickPositionsProps = {
88
88
  /**
89
- * Index name to target.
89
+ * Index name.
90
90
  */
91
91
  index: string;
92
92
  /**
93
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
93
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
94
94
  */
95
95
  startDate?: string;
96
96
  /**
97
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
97
+ * End date (`YYYY-MM-DD`) of the period to analyze.
98
98
  */
99
99
  endDate?: string;
100
100
  /**
@@ -107,15 +107,15 @@ export type GetClickPositionsProps = {
107
107
  */
108
108
  export type GetClickThroughRateProps = {
109
109
  /**
110
- * Index name to target.
110
+ * Index name.
111
111
  */
112
112
  index: string;
113
113
  /**
114
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
114
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
115
115
  */
116
116
  startDate?: string;
117
117
  /**
118
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
118
+ * End date (`YYYY-MM-DD`) of the period to analyze.
119
119
  */
120
120
  endDate?: string;
121
121
  /**
@@ -128,15 +128,15 @@ export type GetClickThroughRateProps = {
128
128
  */
129
129
  export type GetConversationRateProps = {
130
130
  /**
131
- * Index name to target.
131
+ * Index name.
132
132
  */
133
133
  index: string;
134
134
  /**
135
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
135
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
136
136
  */
137
137
  startDate?: string;
138
138
  /**
139
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
139
+ * End date (`YYYY-MM-DD`) of the period to analyze.
140
140
  */
141
141
  endDate?: string;
142
142
  /**
@@ -149,15 +149,15 @@ export type GetConversationRateProps = {
149
149
  */
150
150
  export type GetNoClickRateProps = {
151
151
  /**
152
- * Index name to target.
152
+ * Index name.
153
153
  */
154
154
  index: string;
155
155
  /**
156
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
156
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
157
157
  */
158
158
  startDate?: string;
159
159
  /**
160
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
160
+ * End date (`YYYY-MM-DD`) of the period to analyze.
161
161
  */
162
162
  endDate?: string;
163
163
  /**
@@ -170,15 +170,15 @@ export type GetNoClickRateProps = {
170
170
  */
171
171
  export type GetNoResultsRateProps = {
172
172
  /**
173
- * Index name to target.
173
+ * Index name.
174
174
  */
175
175
  index: string;
176
176
  /**
177
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
177
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
178
178
  */
179
179
  startDate?: string;
180
180
  /**
181
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
181
+ * End date (`YYYY-MM-DD`) of the period to analyze.
182
182
  */
183
183
  endDate?: string;
184
184
  /**
@@ -191,15 +191,15 @@ export type GetNoResultsRateProps = {
191
191
  */
192
192
  export type GetSearchesCountProps = {
193
193
  /**
194
- * Index name to target.
194
+ * Index name.
195
195
  */
196
196
  index: string;
197
197
  /**
198
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
198
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
199
199
  */
200
200
  startDate?: string;
201
201
  /**
202
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
202
+ * End date (`YYYY-MM-DD`) of the period to analyze.
203
203
  */
204
204
  endDate?: string;
205
205
  /**
@@ -212,23 +212,23 @@ export type GetSearchesCountProps = {
212
212
  */
213
213
  export type GetSearchesNoClicksProps = {
214
214
  /**
215
- * Index name to target.
215
+ * Index name.
216
216
  */
217
217
  index: string;
218
218
  /**
219
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
219
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
220
220
  */
221
221
  startDate?: string;
222
222
  /**
223
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
223
+ * End date (`YYYY-MM-DD`) of the period to analyze.
224
224
  */
225
225
  endDate?: string;
226
226
  /**
227
- * Number of records to return (page size).
227
+ * Number of items to return.
228
228
  */
229
229
  limit?: number;
230
230
  /**
231
- * Position of the starting record. Used for paging. 0 is the first record.
231
+ * Position of the first item to return.
232
232
  */
233
233
  offset?: number;
234
234
  /**
@@ -241,23 +241,23 @@ export type GetSearchesNoClicksProps = {
241
241
  */
242
242
  export type GetSearchesNoResultsProps = {
243
243
  /**
244
- * Index name to target.
244
+ * Index name.
245
245
  */
246
246
  index: string;
247
247
  /**
248
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
248
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
249
249
  */
250
250
  startDate?: string;
251
251
  /**
252
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
252
+ * End date (`YYYY-MM-DD`) of the period to analyze.
253
253
  */
254
254
  endDate?: string;
255
255
  /**
256
- * Number of records to return (page size).
256
+ * Number of items to return.
257
257
  */
258
258
  limit?: number;
259
259
  /**
260
- * Position of the starting record. Used for paging. 0 is the first record.
260
+ * Position of the first item to return.
261
261
  */
262
262
  offset?: number;
263
263
  /**
@@ -270,7 +270,7 @@ export type GetSearchesNoResultsProps = {
270
270
  */
271
271
  export type GetStatusProps = {
272
272
  /**
273
- * Index name to target.
273
+ * Index name.
274
274
  */
275
275
  index: string;
276
276
  };
@@ -279,23 +279,23 @@ export type GetStatusProps = {
279
279
  */
280
280
  export type GetTopCountriesProps = {
281
281
  /**
282
- * Index name to target.
282
+ * Index name.
283
283
  */
284
284
  index: string;
285
285
  /**
286
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
286
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
287
287
  */
288
288
  startDate?: string;
289
289
  /**
290
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
290
+ * End date (`YYYY-MM-DD`) of the period to analyze.
291
291
  */
292
292
  endDate?: string;
293
293
  /**
294
- * Number of records to return (page size).
294
+ * Number of items to return.
295
295
  */
296
296
  limit?: number;
297
297
  /**
298
- * Position of the starting record. Used for paging. 0 is the first record.
298
+ * Position of the first item to return.
299
299
  */
300
300
  offset?: number;
301
301
  /**
@@ -308,7 +308,7 @@ export type GetTopCountriesProps = {
308
308
  */
309
309
  export type GetTopFilterAttributesProps = {
310
310
  /**
311
- * Index name to target.
311
+ * Index name.
312
312
  */
313
313
  index: string;
314
314
  /**
@@ -316,19 +316,19 @@ export type GetTopFilterAttributesProps = {
316
316
  */
317
317
  search?: string;
318
318
  /**
319
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
319
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
320
320
  */
321
321
  startDate?: string;
322
322
  /**
323
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
323
+ * End date (`YYYY-MM-DD`) of the period to analyze.
324
324
  */
325
325
  endDate?: string;
326
326
  /**
327
- * Number of records to return (page size).
327
+ * Number of items to return.
328
328
  */
329
329
  limit?: number;
330
330
  /**
331
- * Position of the starting record. Used for paging. 0 is the first record.
331
+ * Position of the first item to return.
332
332
  */
333
333
  offset?: number;
334
334
  /**
@@ -345,7 +345,7 @@ export type GetTopFilterForAttributeProps = {
345
345
  */
346
346
  attribute: string;
347
347
  /**
348
- * Index name to target.
348
+ * Index name.
349
349
  */
350
350
  index: string;
351
351
  /**
@@ -353,19 +353,19 @@ export type GetTopFilterForAttributeProps = {
353
353
  */
354
354
  search?: string;
355
355
  /**
356
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
356
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
357
357
  */
358
358
  startDate?: string;
359
359
  /**
360
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
360
+ * End date (`YYYY-MM-DD`) of the period to analyze.
361
361
  */
362
362
  endDate?: string;
363
363
  /**
364
- * Number of records to return (page size).
364
+ * Number of items to return.
365
365
  */
366
366
  limit?: number;
367
367
  /**
368
- * Position of the starting record. Used for paging. 0 is the first record.
368
+ * Position of the first item to return.
369
369
  */
370
370
  offset?: number;
371
371
  /**
@@ -378,7 +378,7 @@ export type GetTopFilterForAttributeProps = {
378
378
  */
379
379
  export type GetTopFiltersNoResultsProps = {
380
380
  /**
381
- * Index name to target.
381
+ * Index name.
382
382
  */
383
383
  index: string;
384
384
  /**
@@ -386,19 +386,19 @@ export type GetTopFiltersNoResultsProps = {
386
386
  */
387
387
  search?: string;
388
388
  /**
389
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
389
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
390
390
  */
391
391
  startDate?: string;
392
392
  /**
393
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
393
+ * End date (`YYYY-MM-DD`) of the period to analyze.
394
394
  */
395
395
  endDate?: string;
396
396
  /**
397
- * Number of records to return (page size).
397
+ * Number of items to return.
398
398
  */
399
399
  limit?: number;
400
400
  /**
401
- * Position of the starting record. Used for paging. 0 is the first record.
401
+ * Position of the first item to return.
402
402
  */
403
403
  offset?: number;
404
404
  /**
@@ -411,7 +411,7 @@ export type GetTopFiltersNoResultsProps = {
411
411
  */
412
412
  export type GetTopHitsProps = {
413
413
  /**
414
- * Index name to target.
414
+ * Index name.
415
415
  */
416
416
  index: string;
417
417
  /**
@@ -423,19 +423,19 @@ export type GetTopHitsProps = {
423
423
  */
424
424
  clickAnalytics?: boolean;
425
425
  /**
426
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
426
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
427
427
  */
428
428
  startDate?: string;
429
429
  /**
430
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
430
+ * End date (`YYYY-MM-DD`) of the period to analyze.
431
431
  */
432
432
  endDate?: string;
433
433
  /**
434
- * Number of records to return (page size).
434
+ * Number of items to return.
435
435
  */
436
436
  limit?: number;
437
437
  /**
438
- * Position of the starting record. Used for paging. 0 is the first record.
438
+ * Position of the first item to return.
439
439
  */
440
440
  offset?: number;
441
441
  /**
@@ -448,7 +448,7 @@ export type GetTopHitsProps = {
448
448
  */
449
449
  export type GetTopSearchesProps = {
450
450
  /**
451
- * Index name to target.
451
+ * Index name.
452
452
  */
453
453
  index: string;
454
454
  /**
@@ -456,11 +456,11 @@ export type GetTopSearchesProps = {
456
456
  */
457
457
  clickAnalytics?: boolean;
458
458
  /**
459
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
459
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
460
460
  */
461
461
  startDate?: string;
462
462
  /**
463
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
463
+ * End date (`YYYY-MM-DD`) of the period to analyze.
464
464
  */
465
465
  endDate?: string;
466
466
  /**
@@ -472,11 +472,11 @@ export type GetTopSearchesProps = {
472
472
  */
473
473
  direction?: Direction;
474
474
  /**
475
- * Number of records to return (page size).
475
+ * Number of items to return.
476
476
  */
477
477
  limit?: number;
478
478
  /**
479
- * Position of the starting record. Used for paging. 0 is the first record.
479
+ * Position of the first item to return.
480
480
  */
481
481
  offset?: number;
482
482
  /**
@@ -489,15 +489,15 @@ export type GetTopSearchesProps = {
489
489
  */
490
490
  export type GetUsersCountProps = {
491
491
  /**
492
- * Index name to target.
492
+ * Index name.
493
493
  */
494
494
  index: string;
495
495
  /**
496
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
496
+ * Start date (`YYYY-MM-DD`) of the period to analyze.
497
497
  */
498
498
  startDate?: string;
499
499
  /**
500
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
500
+ * End date (`YYYY-MM-DD`) of the period to analyze.
501
501
  */
502
502
  endDate?: string;
503
503
  /**
package/dist/model/searchNoResultEvent.d.ts CHANGED
@@ -8,7 +8,7 @@ export type SearchNoResultEvent = {
8
8
  */
9
9
  count: number;
10
10
  /**
11
- * Number of hits the search query matched.
11
+ * Number of results (hits).
12
12
  */
13
13
  nbHits: number;
14
14
  };
package/dist/model/topSearch.d.ts CHANGED
@@ -8,7 +8,7 @@ export type TopSearch = {
8
8
  */
9
9
  count: number;
10
10
  /**
11
- * Number of hits the search query matched.
11
+ * Number of results (hits).
12
12
  */
13
13
  nbHits: number;
14
14
  };
package/dist/model/topSearchWithAnalytics.d.ts CHANGED
@@ -32,7 +32,7 @@ export type TopSearchWithAnalytics = {
32
32
  */
33
33
  conversionCount: number;
34
34
  /**
35
- * Number of hits the search query matched.
35
+ * Number of results (hits).
36
36
  */
37
37
  nbHits: number;
38
38
  };