Skip to content

Commit 31a33c3

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 cbf51e8 commit 31a33c3

File tree

1 file changed

+64
-32
lines changed

1 file changed

+64
-32
lines changed

‎Sources/Analytics/AnalyticsClient.swift‎

Lines changed: 64 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1078,8 +1078,10 @@ open class AnalyticsClient {
10781078
/// - parameter index: (query) Index name.
10791079
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
10801080
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1081-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1082-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1081+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1082+
/// items can be retrieved. (optional, default to 10)
1083+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1084+
/// first 1000 items can be retrieved. (optional, default to 0)
10831085
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
10841086
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
10851087
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1121,9 +1123,11 @@ open class AnalyticsClient {
11211123
//
11221124
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
11231125
//
1124-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1126+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1127+
// items can be retrieved. (optional, default to 10)
11251128
//
1126-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1129+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1130+
// first 1000 items can be retrieved. (optional, default to 0)
11271131
//
11281132
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
11291133
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1169,8 +1173,10 @@ open class AnalyticsClient {
11691173
/// - parameter index: (query) Index name.
11701174
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
11711175
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1172-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1173-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1176+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1177+
/// items can be retrieved. (optional, default to 10)
1178+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1179+
/// first 1000 items can be retrieved. (optional, default to 0)
11741180
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
11751181
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
11761182
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1212,9 +1218,11 @@ open class AnalyticsClient {
12121218
//
12131219
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
12141220
//
1215-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1221+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1222+
// items can be retrieved. (optional, default to 10)
12161223
//
1217-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1224+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1225+
// first 1000 items can be retrieved. (optional, default to 0)
12181226
//
12191227
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
12201228
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1310,8 +1318,10 @@ open class AnalyticsClient {
13101318
/// - parameter index: (query) Index name.
13111319
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
13121320
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1313-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1314-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1321+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1322+
/// items can be retrieved. (optional, default to 10)
1323+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1324+
/// first 1000 items can be retrieved. (optional, default to 0)
13151325
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
13161326
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
13171327
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1353,9 +1363,11 @@ open class AnalyticsClient {
13531363
//
13541364
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
13551365
//
1356-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1366+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1367+
// items can be retrieved. (optional, default to 10)
13571368
//
1358-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1369+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1370+
// first 1000 items can be retrieved. (optional, default to 0)
13591371
//
13601372
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
13611373
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1402,8 +1414,10 @@ open class AnalyticsClient {
14021414
/// - parameter search: (query) Search query. (optional)
14031415
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
14041416
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1405-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1406-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1417+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1418+
/// items can be retrieved. (optional, default to 10)
1419+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1420+
/// first 1000 items can be retrieved. (optional, default to 0)
14071421
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
14081422
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
14091423
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1450,9 +1464,11 @@ open class AnalyticsClient {
14501464
//
14511465
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
14521466
//
1453-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1467+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1468+
// items can be retrieved. (optional, default to 10)
14541469
//
1455-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1470+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1471+
// first 1000 items can be retrieved. (optional, default to 0)
14561472
//
14571473
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
14581474
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1502,8 +1518,10 @@ open class AnalyticsClient {
15021518
/// - parameter search: (query) Search query. (optional)
15031519
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
15041520
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1505-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1506-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1521+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1522+
/// items can be retrieved. (optional, default to 10)
1523+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1524+
/// first 1000 items can be retrieved. (optional, default to 0)
15071525
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
15081526
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
15091527
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1554,9 +1572,11 @@ open class AnalyticsClient {
15541572
//
15551573
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
15561574
//
1557-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1575+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1576+
// items can be retrieved. (optional, default to 10)
15581577
//
1559-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1578+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1579+
// first 1000 items can be retrieved. (optional, default to 0)
15601580
//
15611581
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
15621582
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1619,8 +1639,10 @@ open class AnalyticsClient {
16191639
/// - parameter search: (query) Search query. (optional)
16201640
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
16211641
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1622-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1623-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1642+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1643+
/// items can be retrieved. (optional, default to 10)
1644+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1645+
/// first 1000 items can be retrieved. (optional, default to 0)
16241646
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
16251647
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
16261648
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1668,9 +1690,11 @@ open class AnalyticsClient {
16681690
//
16691691
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
16701692
//
1671-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1693+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1694+
// items can be retrieved. (optional, default to 10)
16721695
//
1673-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1696+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1697+
// first 1000 items can be retrieved. (optional, default to 0)
16741698
//
16751699
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
16761700
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1723,8 +1747,10 @@ open class AnalyticsClient {
17231747
/// metrics related to click and conversion events are also included in the response. (optional, default to false)
17241748
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
17251749
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1726-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1727-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1750+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1751+
/// items can be retrieved. (optional, default to 10)
1752+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1753+
/// first 1000 items can be retrieved. (optional, default to 0)
17281754
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
17291755
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
17301756
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1780,9 +1806,11 @@ open class AnalyticsClient {
17801806
//
17811807
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
17821808
//
1783-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1809+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1810+
// items can be retrieved. (optional, default to 10)
17841811
//
1785-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1812+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1813+
// first 1000 items can be retrieved. (optional, default to 0)
17861814
//
17871815
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
17881816
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1841,8 +1869,10 @@ open class AnalyticsClient {
18411869
/// - parameter orderBy: (query) Attribute by which to order the response items. If the `clickAnalytics` parameter
18421870
/// is false, only `searchCount` is available. (optional)
18431871
/// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
1844-
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1845-
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1872+
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1873+
/// items can be retrieved. (optional, default to 10)
1874+
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1875+
/// first 1000 items can be retrieved. (optional, default to 0)
18461876
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
18471877
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
18481878
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1903,9 +1933,11 @@ open class AnalyticsClient {
19031933
//
19041934
// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
19051935
//
1906-
// - parameter limit: (query) Number of items to return. (optional, default to 10)
1936+
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1937+
// items can be retrieved. (optional, default to 10)
19071938
//
1908-
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
1939+
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1940+
// first 1000 items can be retrieved. (optional, default to 0)
19091941
//
19101942
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
19111943
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics

0 commit comments

Comments
 (0)