algolia 3.5.0 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9200f03830a6a4072814ecf540ec1c2ccd1c820a1302dd12a503f263066645d
-  data.tar.gz: 48ec72d14a23b49eef15e99dfdf4c9a1d46d4efc25020f844abe5f672b1e3acf
+  metadata.gz: 84a0ee67eb820ef65c0a92aa71b5dc4d0c70c7522496f0dc5a9e0a1cccc0bb0b
+  data.tar.gz: 609c3231f74e5a113affbed7cb4377c35ddea0d6dbcf45f9634dcfdab4151733
 SHA512:
-  metadata.gz: 91c0f16ed9d08c1ab4b8c8743d72f493441bdc4f1f421c35ba7b7044025fb0ac38cba7928b4660c65abe01b878307ff298431d6ca21536b9a85fd056d1ec7033
-  data.tar.gz: c7118984d0a3e3db25d012ecd6abbe7d4e372360c85df3bff47382476f3a12386f084dbd14424d69ce8e0b6c8f739b218e04972acf7f71d1a02c54db07efa0de
+  metadata.gz: d7a02c43e9dbddc8f1e8cad80e5437977ba777c36d2f4e6ae91861ee75e212615a9c408fd4f1a5e549394e6421f515207de2feb092ca390111a6d1186f016a06
+  data.tar.gz: f4b505358a57ec09aa27a65140f9da14d1e043bf43ae9f3dd5e28e324fdcc5a1fb724efe5757648853f93becc44a273cfed19c25be8d08b731a4abbb7ad1a5d8

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [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/)
+- [5866c2954](https://github.com/algolia/api-clients-automation/commit/5866c2954) fix(specs): Add context to hitsPerPage ([#3969](https://github.com/algolia/api-clients-automation/pull/3969)) by [@gazconroy](https://github.com/gazconroy/)
+- [9e73e971c](https://github.com/algolia/api-clients-automation/commit/9e73e971c) fix(ruby): add helper to add segment to user agent ([#3972](https://github.com/algolia/api-clients-automation/pull/3972)) by [@millotp](https://github.com/millotp/)
+- [162dfafa1](https://github.com/algolia/api-clients-automation/commit/162dfafa1) fix(clients): escape char in comments ([#3973](https://github.com/algolia/api-clients-automation/pull/3973)) by [@millotp](https://github.com/millotp/)
+- [8b879dead](https://github.com/algolia/api-clients-automation/commit/8b879dead) fix(specs): alternativesAsExact is plurals and synonyms ([#3974](https://github.com/algolia/api-clients-automation/pull/3974)) by [@gazconroy](https://github.com/gazconroy/)
+- [1a9b95e85](https://github.com/algolia/api-clients-automation/commit/1a9b95e85) fix(specs): Separators are non-alphanumeric characters ([#3978](https://github.com/algolia/api-clients-automation/pull/3978)) by [@gazconroy](https://github.com/gazconroy/)
+- [519fd9840](https://github.com/algolia/api-clients-automation/commit/519fd9840) fix(specs): multiple clients fixes ([#3971](https://github.com/algolia/api-clients-automation/pull/3971)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.5.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.0...3.5.1)
+
+- [8b343d2ee](https://github.com/algolia/api-clients-automation/commit/8b343d2ee) fix(ruby): only prefix model by client:: ([#3923](https://github.com/algolia/api-clients-automation/pull/3923)) by [@millotp](https://github.com/millotp/)
+- [f516d0243](https://github.com/algolia/api-clients-automation/commit/f516d0243) fix(specs): Typos in API descriptions ([#3932](https://github.com/algolia/api-clients-automation/pull/3932)) by [@gazconroy](https://github.com/gazconroy/)
+- [ee6c043ef](https://github.com/algolia/api-clients-automation/commit/ee6c043ef) fix(clients): remove all client side validation expect null check ([#3936](https://github.com/algolia/api-clients-automation/pull/3936)) by [@millotp](https://github.com/millotp/)
+- [434c99f80](https://github.com/algolia/api-clients-automation/commit/434c99f80) fix(specs): use the read transporter for browse ([#3938](https://github.com/algolia/api-clients-automation/pull/3938)) by [@millotp](https://github.com/millotp/)
+- [45d433d0a](https://github.com/algolia/api-clients-automation/commit/45d433d0a) fix(specs): correct type for banners [skip-bc] ([#3939](https://github.com/algolia/api-clients-automation/pull/3939)) by [@millotp](https://github.com/millotp/)
+
 ## [3.5.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.4.0...3.5.0)
 
 - [ad8e3d224](https://github.com/algolia/api-clients-automation/commit/ad8e3d224) fix(specs): update analytics and abtesting max pagination query limit ([#3696](https://github.com/algolia/api-clients-automation/pull/3696)) by [@febeck](https://github.com/febeck/)

data/Gemfile.lock

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

data/lib/algolia/api/abtesting_client.rb

@@ -45,6 +45,14 @@ module Algolia
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # Creates a new A/B test.
@@ -93,7 +101,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @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
@@ -125,7 +133,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @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 [Object]
@@ -136,7 +144,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @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
@@ -168,7 +176,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @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 [Object]
@@ -179,7 +187,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @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)
@@ -212,7 +220,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @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)
@@ -224,7 +232,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @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)
@@ -257,7 +265,7 @@ module Algolia
 
     # This method allow you to send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
+    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @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)
@@ -372,13 +380,6 @@ module Algolia
       index_suffix = nil,
       request_options = {}
     )
-      if @api_client.config.client_side_validation && !offset.nil? && offset < 0
-        raise(
-          ArgumentError,
-          "invalid value for \"\"offset\"\" when calling AbtestingClient.list_ab_tests, must be greater than or equal to 0."
-        )
-      end
-
       path = "/2/abtests"
       query_params = {}
       query_params[:offset] = offset unless offset.nil?
@@ -461,7 +462,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ScheduleABTestResponse")
     end
 
-    # Stops an A/B test by its ID.  You can&#39;t restart stopped A/B tests.
+    # Stops an A/B test by its ID.  You can't restart stopped A/B tests.
     #
     # Required API Key ACLs:
     #   - editSettings