Skip to content

Commit 8805c6d

Browse files
algolia-botfebeckmillotp
committed
fix(specs): update analytics and abtesting max pagination query limit (generated)
algolia/api-clients-automation#3696 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Fernando Beck <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 56eb220 commit 8805c6d

File tree

2 files changed

+47
-45
lines changed

2 files changed

+47
-45
lines changed

‎packages/client-analytics/model/clientMethodProps.ts

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -304,11 +304,11 @@ export type GetSearchesNoClicksProps = {
304304
*/
305305
endDate?: string;
306306
/**
307-
* Number of items to return.
307+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
308308
*/
309309
limit?: number;
310310
/**
311-
* Position of the first item to return.
311+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
312312
*/
313313
offset?: number;
314314
/**
@@ -334,11 +334,11 @@ export type GetSearchesNoResultsProps = {
334334
*/
335335
endDate?: string;
336336
/**
337-
* Number of items to return.
337+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
338338
*/
339339
limit?: number;
340340
/**
341-
* Position of the first item to return.
341+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
342342
*/
343343
offset?: number;
344344
/**
@@ -374,11 +374,11 @@ export type GetTopCountriesProps = {
374374
*/
375375
endDate?: string;
376376
/**
377-
* Number of items to return.
377+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
378378
*/
379379
limit?: number;
380380
/**
381-
* Position of the first item to return.
381+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
382382
*/
383383
offset?: number;
384384
/**
@@ -408,11 +408,11 @@ export type GetTopFilterAttributesProps = {
408408
*/
409409
endDate?: string;
410410
/**
411-
* Number of items to return.
411+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
412412
*/
413413
limit?: number;
414414
/**
415-
* Position of the first item to return.
415+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
416416
*/
417417
offset?: number;
418418
/**
@@ -446,11 +446,11 @@ export type GetTopFilterForAttributeProps = {
446446
*/
447447
endDate?: string;
448448
/**
449-
* Number of items to return.
449+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
450450
*/
451451
limit?: number;
452452
/**
453-
* Position of the first item to return.
453+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
454454
*/
455455
offset?: number;
456456
/**
@@ -480,11 +480,11 @@ export type GetTopFiltersNoResultsProps = {
480480
*/
481481
endDate?: string;
482482
/**
483-
* Number of items to return.
483+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
484484
*/
485485
limit?: number;
486486
/**
487-
* Position of the first item to return.
487+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
488488
*/
489489
offset?: number;
490490
/**
@@ -522,11 +522,11 @@ export type GetTopHitsProps = {
522522
*/
523523
endDate?: string;
524524
/**
525-
* Number of items to return.
525+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
526526
*/
527527
limit?: number;
528528
/**
529-
* Position of the first item to return.
529+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
530530
*/
531531
offset?: number;
532532
/**
@@ -568,11 +568,11 @@ export type GetTopSearchesProps = {
568568
*/
569569
direction?: Direction;
570570
/**
571-
* Number of items to return.
571+
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
572572
*/
573573
limit?: number;
574574
/**
575-
* Position of the first item to return.
575+
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
576576
*/
577577
offset?: number;
578578
/**

‎packages/client-analytics/src/analyticsClient.ts

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,6 @@ export function createAnalyticsClient({
291291
if (index !== undefined) {
292292
queryParameters.index = index.toString();
293293
}
294-
295294
if (startDate !== undefined) {
296295
queryParameters.startDate = startDate.toString();
297296
}
@@ -343,7 +342,6 @@ export function createAnalyticsClient({
343342
if (startDate !== undefined) {
344343
queryParameters.startDate = startDate.toString();
345344
}
346-
347345
if (endDate !== undefined) {
348346
queryParameters.endDate = endDate.toString();
349347
}
@@ -388,13 +386,13 @@ export function createAnalyticsClient({
388386
if (index !== undefined) {
389387
queryParameters.index = index.toString();
390388
}
389+
391390
if (startDate !== undefined) {
392391
queryParameters.startDate = startDate.toString();
393392
}
394393
if (endDate !== undefined) {
395394
queryParameters.endDate = endDate.toString();
396395
}
397-
398396
if (tags !== undefined) {
399397
queryParameters.tags = tags.toString();
400398
}
@@ -433,13 +431,14 @@ export function createAnalyticsClient({
433431
const requestPath = '/2/clicks/clickThroughRate';
434432
const headers: Headers = {};
435433
const queryParameters: QueryParameters = {};
436-
437434
if (index !== undefined) {
438435
queryParameters.index = index.toString();
439436
}
437+
440438
if (startDate !== undefined) {
441439
queryParameters.startDate = startDate.toString();
442440
}
441+
443442
if (endDate !== undefined) {
444443
queryParameters.endDate = endDate.toString();
445444
}
@@ -484,13 +483,13 @@ export function createAnalyticsClient({
484483
if (index !== undefined) {
485484
queryParameters.index = index.toString();
486485
}
487-
488486
if (startDate !== undefined) {
489487
queryParameters.startDate = startDate.toString();
490488
}
491489
if (endDate !== undefined) {
492490
queryParameters.endDate = endDate.toString();
493491
}
492+
494493
if (tags !== undefined) {
495494
queryParameters.tags = tags.toString();
496495
}
@@ -627,7 +626,6 @@ export function createAnalyticsClient({
627626
if (index !== undefined) {
628627
queryParameters.index = index.toString();
629628
}
630-
631629
if (startDate !== undefined) {
632630
queryParameters.startDate = startDate.toString();
633631
}
@@ -675,9 +673,11 @@ export function createAnalyticsClient({
675673
if (index !== undefined) {
676674
queryParameters.index = index.toString();
677675
}
676+
678677
if (startDate !== undefined) {
679678
queryParameters.startDate = startDate.toString();
680679
}
680+
681681
if (endDate !== undefined) {
682682
queryParameters.endDate = endDate.toString();
683683
}
@@ -722,13 +722,13 @@ export function createAnalyticsClient({
722722
if (index !== undefined) {
723723
queryParameters.index = index.toString();
724724
}
725-
726725
if (startDate !== undefined) {
727726
queryParameters.startDate = startDate.toString();
728727
}
729728
if (endDate !== undefined) {
730729
queryParameters.endDate = endDate.toString();
731730
}
731+
732732
if (tags !== undefined) {
733733
queryParameters.tags = tags.toString();
734734
}
@@ -753,8 +753,8 @@ export function createAnalyticsClient({
753753
* @param getSearchesNoClicks.index - Index name.
754754
* @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
755755
* @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
756-
* @param getSearchesNoClicks.limit - Number of items to return.
757-
* @param getSearchesNoClicks.offset - Position of the first item to return.
756+
* @param getSearchesNoClicks.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
757+
* @param getSearchesNoClicks.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
758758
* @param getSearchesNoClicks.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
759759
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
760760
*/
@@ -772,6 +772,7 @@ export function createAnalyticsClient({
772772
if (index !== undefined) {
773773
queryParameters.index = index.toString();
774774
}
775+
775776
if (startDate !== undefined) {
776777
queryParameters.startDate = startDate.toString();
777778
}
@@ -781,10 +782,10 @@ export function createAnalyticsClient({
781782
if (limit !== undefined) {
782783
queryParameters.limit = limit.toString();
783784
}
784-
785785
if (offset !== undefined) {
786786
queryParameters.offset = offset.toString();
787787
}
788+
788789
if (tags !== undefined) {
789790
queryParameters.tags = tags.toString();
790791
}
@@ -809,8 +810,8 @@ export function createAnalyticsClient({
809810
* @param getSearchesNoResults.index - Index name.
810811
* @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
811812
* @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
812-
* @param getSearchesNoResults.limit - Number of items to return.
813-
* @param getSearchesNoResults.offset - Position of the first item to return.
813+
* @param getSearchesNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
814+
* @param getSearchesNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
814815
* @param getSearchesNoResults.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
815816
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
816817
*/
@@ -838,10 +839,10 @@ export function createAnalyticsClient({
838839
if (limit !== undefined) {
839840
queryParameters.limit = limit.toString();
840841
}
841-
842842
if (offset !== undefined) {
843843
queryParameters.offset = offset.toString();
844844
}
845+
845846
if (tags !== undefined) {
846847
queryParameters.tags = tags.toString();
847848
}
@@ -898,8 +899,8 @@ export function createAnalyticsClient({
898899
* @param getTopCountries.index - Index name.
899900
* @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
900901
* @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
901-
* @param getTopCountries.limit - Number of items to return.
902-
* @param getTopCountries.offset - Position of the first item to return.
902+
* @param getTopCountries.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
903+
* @param getTopCountries.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
903904
* @param getTopCountries.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
904905
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
905906
*/
@@ -926,7 +927,6 @@ export function createAnalyticsClient({
926927
if (limit !== undefined) {
927928
queryParameters.limit = limit.toString();
928929
}
929-
930930
if (offset !== undefined) {
931931
queryParameters.offset = offset.toString();
932932
}
@@ -955,8 +955,8 @@ export function createAnalyticsClient({
955955
* @param getTopFilterAttributes.search - Search query.
956956
* @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
957957
* @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
958-
* @param getTopFilterAttributes.limit - Number of items to return.
959-
* @param getTopFilterAttributes.offset - Position of the first item to return.
958+
* @param getTopFilterAttributes.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
959+
* @param getTopFilterAttributes.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
960960
* @param getTopFilterAttributes.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
961961
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
962962
*/
@@ -971,7 +971,6 @@ export function createAnalyticsClient({
971971
const requestPath = '/2/filters';
972972
const headers: Headers = {};
973973
const queryParameters: QueryParameters = {};
974-
975974
if (index !== undefined) {
976975
queryParameters.index = index.toString();
977976
}
@@ -981,13 +980,13 @@ export function createAnalyticsClient({
981980
if (startDate !== undefined) {
982981
queryParameters.startDate = startDate.toString();
983982
}
983+
984984
if (endDate !== undefined) {
985985
queryParameters.endDate = endDate.toString();
986986
}
987987
if (limit !== undefined) {
988988
queryParameters.limit = limit.toString();
989989
}
990-
991990
if (offset !== undefined) {
992991
queryParameters.offset = offset.toString();
993992
}
@@ -1017,8 +1016,8 @@ export function createAnalyticsClient({
10171016
* @param getTopFilterForAttribute.search - Search query.
10181017
* @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
10191018
* @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1020-
* @param getTopFilterForAttribute.limit - Number of items to return.
1021-
* @param getTopFilterForAttribute.offset - Position of the first item to return.
1019+
* @param getTopFilterForAttribute.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1020+
* @param getTopFilterForAttribute.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
10221021
* @param getTopFilterForAttribute.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
10231022
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
10241023
*/
@@ -1040,10 +1039,10 @@ export function createAnalyticsClient({
10401039
if (index !== undefined) {
10411040
queryParameters.index = index.toString();
10421041
}
1042+
10431043
if (search !== undefined) {
10441044
queryParameters.search = search.toString();
10451045
}
1046-
10471046
if (startDate !== undefined) {
10481047
queryParameters.startDate = startDate.toString();
10491048
}
@@ -1053,6 +1052,7 @@ export function createAnalyticsClient({
10531052
if (limit !== undefined) {
10541053
queryParameters.limit = limit.toString();
10551054
}
1055+
10561056
if (offset !== undefined) {
10571057
queryParameters.offset = offset.toString();
10581058
}
@@ -1081,8 +1081,8 @@ export function createAnalyticsClient({
10811081
* @param getTopFiltersNoResults.search - Search query.
10821082
* @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
10831083
* @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1084-
* @param getTopFiltersNoResults.limit - Number of items to return.
1085-
* @param getTopFiltersNoResults.offset - Position of the first item to return.
1084+
* @param getTopFiltersNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1085+
* @param getTopFiltersNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
10861086
* @param getTopFiltersNoResults.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
10871087
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
10881088
*/
@@ -1113,6 +1113,7 @@ export function createAnalyticsClient({
11131113
if (limit !== undefined) {
11141114
queryParameters.limit = limit.toString();
11151115
}
1116+
11161117
if (offset !== undefined) {
11171118
queryParameters.offset = offset.toString();
11181119
}
@@ -1143,8 +1144,8 @@ export function createAnalyticsClient({
11431144
* @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
11441145
* @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
11451146
* @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1146-
* @param getTopHits.limit - Number of items to return.
1147-
* @param getTopHits.offset - Position of the first item to return.
1147+
* @param getTopHits.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1148+
* @param getTopHits.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
11481149
* @param getTopHits.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
11491150
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
11501151
*/
@@ -1213,8 +1214,8 @@ export function createAnalyticsClient({
12131214
* @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
12141215
* @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
12151216
* @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
1216-
* @param getTopSearches.limit - Number of items to return.
1217-
* @param getTopSearches.offset - Position of the first item to return.
1217+
* @param getTopSearches.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1218+
* @param getTopSearches.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
12181219
* @param getTopSearches.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
12191220
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
12201221
*/
@@ -1262,6 +1263,7 @@ export function createAnalyticsClient({
12621263
if (direction !== undefined) {
12631264
queryParameters.direction = direction.toString();
12641265
}
1266+
12651267
if (limit !== undefined) {
12661268
queryParameters.limit = limit.toString();
12671269
}

0 commit comments

Comments
 (0)