From 31a33c3defc7e2868e425378d553e10beffc47f7 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 3 Oct 2024 10:02:53 +0000 Subject: [PATCH] fix(specs): update analytics and abtesting max pagination query limit (generated) https://github.com/algolia/api-clients-automation/pull/3696 Co-authored-by: algolia-bot Co-authored-by: Fernando Beck Co-authored-by: Pierre Millot --- Sources/Analytics/AnalyticsClient.swift | 96 ++++++++++++++++--------- 1 file changed, 64 insertions(+), 32 deletions(-) diff --git a/Sources/Analytics/AnalyticsClient.swift b/Sources/Analytics/AnalyticsClient.swift index a86c5fd9..b83240f5 100644 --- a/Sources/Analytics/AnalyticsClient.swift +++ b/Sources/Analytics/AnalyticsClient.swift @@ -1078,8 +1078,10 @@ open class AnalyticsClient { /// - parameter index: (query) Index name. /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1121,9 +1123,11 @@ open class AnalyticsClient { // // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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 @@ -1169,8 +1173,10 @@ open class AnalyticsClient { /// - parameter index: (query) Index name. /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1212,9 +1218,11 @@ open class AnalyticsClient { // // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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 @@ -1310,8 +1318,10 @@ open class AnalyticsClient { /// - parameter index: (query) Index name. /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1353,9 +1363,11 @@ open class AnalyticsClient { // // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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 @@ -1402,8 +1414,10 @@ open class AnalyticsClient { /// - parameter search: (query) Search query. (optional) /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1450,9 +1464,11 @@ open class AnalyticsClient { // // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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 @@ -1502,8 +1518,10 @@ open class AnalyticsClient { /// - parameter search: (query) Search query. (optional) /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1554,9 +1572,11 @@ open class AnalyticsClient { // // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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 @@ -1619,8 +1639,10 @@ open class AnalyticsClient { /// - parameter search: (query) Search query. (optional) /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1668,9 +1690,11 @@ open class AnalyticsClient { // // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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 @@ -1723,8 +1747,10 @@ open class AnalyticsClient { /// metrics related to click and conversion events are also included in the response. (optional, default to false) /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1780,9 +1806,11 @@ open class AnalyticsClient { // // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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 @@ -1841,8 +1869,10 @@ open class AnalyticsClient { /// - parameter orderBy: (query) Attribute by which to order the response items. If the `clickAnalytics` parameter /// is false, only `searchCount` is available. (optional) /// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional) - /// - parameter limit: (query) Number of items to return. (optional, default to 10) - /// - parameter offset: (query) Position of the first item to return. (optional, default to 0) + /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + /// items can be retrieved. (optional, default to 10) + /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + /// first 1000 items can be retrieved. (optional, default to 0) /// - parameter tags: (query) 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/). (optional) @@ -1903,9 +1933,11 @@ open class AnalyticsClient { // // - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional) // - // - parameter limit: (query) Number of items to return. (optional, default to 10) + // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000 + // items can be retrieved. (optional, default to 10) // - // - parameter offset: (query) Position of the first item to return. (optional, default to 0) + // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the + // first 1000 items can be retrieved. (optional, default to 0) // // - parameter tags: (query) 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