algolia 3.5.2 → 3.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84a0ee67eb820ef65c0a92aa71b5dc4d0c70c7522496f0dc5a9e0a1cccc0bb0b
-  data.tar.gz: 609c3231f74e5a113affbed7cb4377c35ddea0d6dbcf45f9634dcfdab4151733
+  metadata.gz: 173d97afe834fd78766030a2edbced933c7fd49ccd5c792855ae508abccdcb5d
+  data.tar.gz: 1cc5116b4ad772a662567ccbab55e05ca979bdebf109122cd807fa93fbb1dca9
 SHA512:
-  metadata.gz: d7a02c43e9dbddc8f1e8cad80e5437977ba777c36d2f4e6ae91861ee75e212615a9c408fd4f1a5e549394e6421f515207de2feb092ca390111a6d1186f016a06
-  data.tar.gz: f4b505358a57ec09aa27a65140f9da14d1e043bf43ae9f3dd5e28e324fdcc5a1fb724efe5757648853f93becc44a273cfed19c25be8d08b731a4abbb7ad1a5d8
+  metadata.gz: 333f9740f51c5b162cd5b41743cf73e607913079156912f788ebc4c368240d330b86c21174d013fa234a1617690e2e6bd0e2a5ddae260e492a7e16cd1f8c4f1a
+  data.tar.gz: ff3edd31b6753c14056240c5e4b0fa62dbcd3db9a8ef80ebd26291686c66dfb74daf89eb90fdcf1bee52b2b1ff44fb26ecaaebb4f0ce4e2bdeaea3d03823ce7b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.5.4](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.3...3.5.4)
+
+- [1f36e8f93](https://github.com/algolia/api-clients-automation/commit/1f36e8f93) fix(specs): results in getObjects is required ([#4024](https://github.com/algolia/api-clients-automation/pull/4024)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.5.2)
+    algolia (3.5.4)
       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

@@ -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/models/search/get_objects_response.rb

@@ -62,6 +62,8 @@ module Algolia
           if (value = attributes[:results]).is_a?(Array)
             self.results = value
           end
+        else
+          self.results = nil
         end
       end
 

data/lib/algolia/version.rb

@@ -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.4".freeze
 end

metadata

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