algolia 3.0.0.alpha.5 → 3.0.0.alpha.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 967cf7b65e49c051c330af87355ad196db3c02ae9b2f7484fb2de373a3898778
-  data.tar.gz: 07a58cca43fcf74604a25a2188000bf5df557483564aeb6c5d35d0f1b07e7365
+  metadata.gz: f178243d901a09bdc7e4c0e3b47e2c2c7f0ca3d20db76e7b310f16f6e1b9f3d0
+  data.tar.gz: c1d301f0c071472df043614b2d7cce87aa809694c0fba5c790abec1e17483fa1
 SHA512:
-  metadata.gz: b7efe62c28c64dd1d2d4efef50015e12b0880d547841c7011a311f373f1e9dd00a3624c99d495353d22935a764d2bfe8f2c68e8f5aa56ba8e98dfb52d747b661
-  data.tar.gz: 20ac8eb5d08ee24bb143ce81b08f875c5abec190e44eb5abfa52d812a03b671b6b5d4a41df4c74556fb1fc601001c5e52b8030093877bbc3d19e53b3a53df783
+  metadata.gz: 51da927c52fb523660c1b45718517cfc805d235fec4f4da35294f93d5cb93dc9a56ec9750bd9086fa23d4a54c9bcd7c6ad0afa672634577b4edca45784220e75
+  data.tar.gz: 8cd4e5732f6721eadfeb595b7928b21f152734fa8cfcdedc0a53bfb938f887bd7b99173759c72c1c95e08215e6218ff618fd6fe32d402af41ab6338de3d33e92

data/.openapi-generator/VERSION

@@ -1 +1 @@
-7.2.0
+7.3.0

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [3.0.0.alpha.7](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.6...3.0.0.alpha.7)
+
+- [28b34ffb6](https://github.com/algolia/api-clients-automation/commit/28b34ffb6) feat(ruby): add browse helpers ([#2669](https://github.com/algolia/api-clients-automation/pull/2669)) by [@millotp](https://github.com/millotp/)
+
+## [3.0.0.alpha.6](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.5...3.0.0.alpha.6)
+
+- [379fbc501](https://github.com/algolia/api-clients-automation/commit/379fbc501) fix(specs): correct `searchSynonyms` parameters ([#2595](https://github.com/algolia/api-clients-automation/pull/2595)) by [@morganleroi](https://github.com/morganleroi/)
+- [982fd3ca4](https://github.com/algolia/api-clients-automation/commit/982fd3ca4) feat(specs): import `crawler` and `usage` specs from new world repo ([#2598](https://github.com/algolia/api-clients-automation/pull/2598)) by [@shortcuts](https://github.com/shortcuts/)
+- [9532a0136](https://github.com/algolia/api-clients-automation/commit/9532a0136) feat(specs): AB testing tracked user count ([#2596](https://github.com/algolia/api-clients-automation/pull/2596)) by [@cdhawke](https://github.com/cdhawke/)
+- [02302dc36](https://github.com/algolia/api-clients-automation/commit/02302dc36) feat(ruby): add wait helpers ([#2577](https://github.com/algolia/api-clients-automation/pull/2577)) by [@millotp](https://github.com/millotp/)
+- [2481e3ac8](https://github.com/algolia/api-clients-automation/commit/2481e3ac8) fix(clients): support the rest of the languages ([#2571](https://github.com/algolia/api-clients-automation/pull/2571)) by [@millotp](https://github.com/millotp/)
+- [99ce6dbae](https://github.com/algolia/api-clients-automation/commit/99ce6dbae) fix(clients): monitoring for JavaScript and Python ([#2568](https://github.com/algolia/api-clients-automation/pull/2568)) by [@shortcuts](https://github.com/shortcuts/)
+- [bb822f79a](https://github.com/algolia/api-clients-automation/commit/bb822f79a) fix(ruby): make the snippets pretty ([#2562](https://github.com/algolia/api-clients-automation/pull/2562)) by [@millotp](https://github.com/millotp/)
+- [6c099d46f](https://github.com/algolia/api-clients-automation/commit/6c099d46f) fix(ruby): correct oneOf deserialization ([#2559](https://github.com/algolia/api-clients-automation/pull/2559)) by [@millotp](https://github.com/millotp/)
+- [99e4bdf2c](https://github.com/algolia/api-clients-automation/commit/99e4bdf2c) feat(specs): add acl permissions to operations ([#2555](https://github.com/algolia/api-clients-automation/pull/2555)) by [@kai687](https://github.com/kai687/)
+- [8b0622380](https://github.com/algolia/api-clients-automation/commit/8b0622380) fix(specs): rename clearAllSynonyms to clearSynonyms ([#2553](https://github.com/algolia/api-clients-automation/pull/2553)) by [@kai687](https://github.com/kai687/)
+
 ## [3.0.0.alpha.5](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.4...3.0.0.alpha.5)
 
 - [7c5ba3288](https://github.com/algolia/api-clients-automation/commit/7c5ba3288) feat(specs): update Insights API spec ([#2376](https://github.com/algolia/api-clients-automation/pull/2376)) by [@kai687](https://github.com/kai687/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.alpha.5)
+    algolia (3.0.0.alpha.7)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
       net-http-persistent
@@ -10,34 +10,34 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.2.0)
     connection_pool (2.4.1)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
     faraday-net_http_persistent (2.1.0)
       faraday (~> 2.5)
       net-http-persistent (~> 4.0)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
+    net-http (0.4.1)
+      uri
     net-http-persistent (4.0.2)
       connection_pool (~> 2.2)
     parallel (1.24.0)
-    parser (3.2.2.4)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)
-    regexp_parser (2.8.3)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
-    rubocop (1.59.0)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
@@ -47,8 +47,8 @@ GEM
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     unicode-display_width (2.5.0)
+    uri (0.13.0)
 
 PLATFORMS
   aarch64-linux

data/algolia.gemspec

@@ -1,3 +1,4 @@
+require 'English'
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'algolia/version'
@@ -20,7 +21,7 @@ Gem::Specification.new do |s|
     'rubygems_mfa_required' => 'true'
   }
 
-  s.files         = `git ls-files`.split($/)
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.executables   = []
   s.require_paths = ['lib']
 

data/lib/algolia/api/abtesting_client.rb

@@ -34,8 +34,10 @@ module Algolia
       new(config)
     end
 
-    # Create an A/B test.
     # Creates an A/B test.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param add_ab_tests_request [AddABTestsRequest]  (required)
     # @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
@@ -64,18 +66,20 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Create an A/B test.
     # Creates an A/B test.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param add_ab_tests_request [AddABTestsRequest]  (required)
     # @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 [ABTestResponse]
     def add_ab_tests(add_ab_tests_request, request_options = {})
       response = add_ab_tests_with_http_info(add_ab_tests_request, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
     end
 
-    # Send requests to the Algolia REST API.
     # 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 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)
@@ -106,19 +110,19 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Send requests to the Algolia REST API.
     # 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 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]
     def custom_delete(path, parameters = nil, request_options = {})
       response = custom_delete_with_http_info(path, parameters, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Send requests to the Algolia REST API.
     # 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 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)
@@ -149,19 +153,19 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Send requests to the Algolia REST API.
     # 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 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]
     def custom_get(path, parameters = nil, request_options = {})
       response = custom_get_with_http_info(path, parameters, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Send requests to the Algolia REST API.
     # 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 parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
@@ -193,8 +197,8 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Send requests to the Algolia REST API.
     # 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 parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
@@ -202,11 +206,11 @@ module Algolia
     # @return [Object]
     def custom_post(path, parameters = nil, body = nil, request_options = {})
       response = custom_post_with_http_info(path, parameters, body, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Send requests to the Algolia REST API.
     # 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 parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
@@ -238,8 +242,8 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # Send requests to the Algolia REST API.
     # 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 parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
@@ -247,11 +251,13 @@ module Algolia
     # @return [Object]
     def custom_put(path, parameters = nil, body = nil, request_options = {})
       response = custom_put_with_http_info(path, parameters, body, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Delete an A/B test.
     # Delete an A/B test. To determine the &#x60;id&#x60; for an A/B test, use the [&#x60;listABTests&#x60; operation](#tag/abtest/operation/listABTests).
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param id [Integer] Unique A/B test ID. (required)
     # @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
@@ -261,7 +267,7 @@ module Algolia
         raise ArgumentError, "Parameter `id` is required when calling `delete_ab_test`."
       end
 
-      path = '/2/abtests/{id}'.sub('{' + 'id' + '}', @api_client.encode_uri(id.to_s))
+      path = '/2/abtests/{id}'.sub('{' + 'id' + '}', Transport.encode_uri(id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -280,18 +286,22 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Delete an A/B test.
     # Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param id [Integer] Unique A/B test ID. (required)
     # @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 [ABTestResponse]
     def delete_ab_test(id, request_options = {})
       response = delete_ab_test_with_http_info(id, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
     end
 
-    # Get A/B test details.
     # Get specific details for an A/B test. To determine the &#x60;id&#x60; for an A/B test, use the [&#x60;listABTests&#x60; operation](#tag/abtest/operation/listABTests).
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param id [Integer] Unique A/B test ID. (required)
     # @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
@@ -301,7 +311,7 @@ module Algolia
         raise ArgumentError, "Parameter `id` is required when calling `get_ab_test`."
       end
 
-      path = '/2/abtests/{id}'.sub('{' + 'id' + '}', @api_client.encode_uri(id.to_s))
+      path = '/2/abtests/{id}'.sub('{' + 'id' + '}', Transport.encode_uri(id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -320,18 +330,22 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get A/B test details.
     # Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param id [Integer] Unique A/B test ID. (required)
     # @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 [ABTest]
     def get_ab_test(id, request_options = {})
       response = get_ab_test_with_http_info(id, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTest')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTest')
     end
 
     # List all A/B tests.
-    # List all A/B tests.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param offset [Integer] Position of the starting record. Used for paging. 0 is the first record. (default to 0)
     # @param limit [Integer] Number of records to return (page size). (default to 10)
     # @param index_prefix [String] Only return A/B tests for indices starting with this prefix.
@@ -363,7 +377,9 @@ module Algolia
     end
 
     # List all A/B tests.
-    # List all A/B tests.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param offset [Integer] Position of the starting record. Used for paging. 0 is the first record. (default to 0)
     # @param limit [Integer] Number of records to return (page size). (default to 10)
     # @param index_prefix [String] Only return A/B tests for indices starting with this prefix.
@@ -372,11 +388,13 @@ module Algolia
     # @return [ListABTestsResponse]
     def list_ab_tests(offset = nil, limit = nil, index_prefix = nil, index_suffix = nil, request_options = {})
       response = list_ab_tests_with_http_info(offset, limit, index_prefix, index_suffix, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ListABTestsResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ListABTestsResponse')
     end
 
-    # Stop an A/B test.
     # If stopped, the test is over and can&#39;t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the &#x60;id&#x60; for an A/B test, use the [&#x60;listABTests&#x60; operation](#tag/abtest/operation/listABTests).
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param id [Integer] Unique A/B test ID. (required)
     # @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
@@ -386,7 +404,7 @@ module Algolia
         raise ArgumentError, "Parameter `id` is required when calling `stop_ab_test`."
       end
 
-      path = '/2/abtests/{id}/stop'.sub('{' + 'id' + '}', @api_client.encode_uri(id.to_s))
+      path = '/2/abtests/{id}/stop'.sub('{' + 'id' + '}', Transport.encode_uri(id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -405,14 +423,16 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Stop an A/B test.
     # If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param id [Integer] Unique A/B test ID. (required)
     # @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 [ABTestResponse]
     def stop_ab_test(id, request_options = {})
       response = stop_ab_test_with_http_info(id, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
     end
   end
 end