RubyGems - algolia - Versions diffs - 3.5.2 → 3.5.3 - Mend

algolia 3.5.2 → 3.5.3

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 (6) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +4 -0
data/Gemfile.lock +1 -1
data/lib/algolia/api/analytics_client.rb +32 -32
data/lib/algolia/version.rb +1 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84a0ee67eb820ef65c0a92aa71b5dc4d0c70c7522496f0dc5a9e0a1cccc0bb0b
-  data.tar.gz: 609c3231f74e5a113affbed7cb4377c35ddea0d6dbcf45f9634dcfdab4151733
+  metadata.gz: 579d49fc4b1ff43b579a660ee660f29ede78c357d8be8c6e114815f3c2fbba0d
+  data.tar.gz: 9b7cde4698aea7d6def55213e7f36ff32d8db3c57451c3abe3478ec3ab17a463
 SHA512:
-  metadata.gz: d7a02c43e9dbddc8f1e8cad80e5437977ba777c36d2f4e6ae91861ee75e212615a9c408fd4f1a5e549394e6421f515207de2feb092ca390111a6d1186f016a06
-  data.tar.gz: f4b505358a57ec09aa27a65140f9da14d1e043bf43ae9f3dd5e28e324fdcc5a1fb724efe5757648853f93becc44a273cfed19c25be8d08b731a4abbb7ad1a5d8
+  metadata.gz: c438ef675f78aac07488a8e2ddd20dab0f0528d3bc3f7a9a95206a9ae2e66ad17935c42f29a4b431747fbf6071343090248535aecc3c3f998f83c3c92d77f8f9
+  data.tar.gz: c975b0cfe14004c921688ebe712750a5c8fe4806d7b26df2e82b54082ec411ab555ece86451414c88a67c5ad761ec63c92a28da776b745d97c15e13f20b4b1c4

data/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,7 @@
+## [3.5.3](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.2...3.5.3)
+- [fe2c8440e](https://github.com/algolia/api-clients-automation/commit/fe2c8440e) docs(analytics): constrain pagination only to limit query parameter ([#4012](https://github.com/algolia/api-clients-automation/pull/4012)) by [@febeck](https://github.com/febeck/)
 ## [3.5.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.1...3.5.2)
 - [cd98290fa](https://github.com/algolia/api-clients-automation/commit/cd98290fa) fix(specs): Typo tolernace on words ([#3968](https://github.com/algolia/api-clients-automation/pull/3968)) by [@gazconroy](https://github.com/gazconroy/)

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.5.2)
+    algolia (3.5.3)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/api/analytics_client.rb CHANGED Viewed

@@ -808,8 +808,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -859,8 +859,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetSearchesNoClicksResponse]
@@ -895,8 +895,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -946,8 +946,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetSearchesNoResultsResponse]
@@ -1027,8 +1027,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -1078,8 +1078,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetTopCountriesResponse]
@@ -1107,8 +1107,8 @@ module Algolia
     # @param search [String] Search query.
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -1161,8 +1161,8 @@ module Algolia
     # @param search [String] Search query.
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetTopFilterAttributesResponse]
@@ -1201,8 +1201,8 @@ module Algolia
     # @param search [String] Search query.
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -1261,8 +1261,8 @@ module Algolia
     # @param search [String] Search query.
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetTopFilterForAttributeResponse]
@@ -1302,8 +1302,8 @@ module Algolia
     # @param search [String] Search query.
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -1356,8 +1356,8 @@ module Algolia
     # @param search [String] Search query.
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetTopFiltersNoResultsResponse]
@@ -1397,8 +1397,8 @@ module Algolia
     # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.  (default to false)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -1457,8 +1457,8 @@ module Algolia
     # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.  (default to false)
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetTopHitsResponse]
@@ -1500,8 +1500,8 @@ module Algolia
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param order_by [OrderBy] Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.  (default to 'searchCount')
     # @param direction [Direction] Sorting direction of the results: ascending or descending.  (default to 'asc')
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -1563,8 +1563,8 @@ module Algolia
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param order_by [OrderBy] Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.  (default to 'searchCount')
     # @param direction [Direction] Sorting direction of the results: ascending or descending.  (default to 'asc')
-    # @param limit [Integer] Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.  (default to 10)
-    # @param offset [Integer] Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.  (default to 0)
+    # @param limit [Integer] Number of items to return.  (default to 10)
+    # @param offset [Integer] Position of the first item to return.  (default to 0)
     # @param tags [String] 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/).
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetTopSearchesResponse]

data/lib/algolia/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 module Algolia
-  VERSION = "3.5.2".freeze
+  VERSION = "3.5.3".freeze
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 3.5.3
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday