algolia 3.0.0.alpha.6 → 3.0.0.alpha.7

data/lib/algolia/api/query_suggestions_client.rb

@@ -33,8 +33,10 @@ module Algolia
       new(config)
     end
 
-    # Create a configuration.
     # Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param query_suggestions_configuration_with_index [QuerySuggestionsConfigurationWithIndex]  (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
@@ -63,8 +65,10 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Create a configuration.
     # Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param query_suggestions_configuration_with_index [QuerySuggestionsConfigurationWithIndex]  (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 [BaseResponse]
@@ -73,8 +77,8 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
     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)
@@ -105,8 +109,8 @@ 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)
@@ -116,8 +120,8 @@ module Algolia
       @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)
@@ -148,8 +152,8 @@ 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)
@@ -159,8 +163,8 @@ module Algolia
       @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.
@@ -192,8 +196,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.
@@ -204,8 +208,8 @@ module Algolia
       @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.
@@ -237,8 +241,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.
@@ -249,8 +253,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Delete a configuration.
     # Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Query Suggestions index name. (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
@@ -260,7 +266,7 @@ module Algolia
         raise ArgumentError, "Parameter `index_name` is required when calling `delete_config`."
       end
 
-      path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
+      path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -279,8 +285,10 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Delete a configuration.
     # Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Query Suggestions index name. (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 [BaseResponse]
@@ -289,8 +297,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
     end
 
-    # List configurations.
     # List all Query Suggestions configurations of your Algolia application.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @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
     def get_all_configs_with_http_info(request_options = {})
@@ -313,8 +323,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List configurations.
     # List all Query Suggestions configurations of your Algolia application.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @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 [Array<QuerySuggestionsConfigurationResponse>]
     def get_all_configs(request_options = {})
@@ -322,8 +334,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::QuerySuggestionsConfigurationResponse>')
     end
 
-    # Get a configuration.
     # Get a single Query Suggestions configuration.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Query Suggestions index name. (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
@@ -333,7 +347,7 @@ module Algolia
         raise ArgumentError, "Parameter `index_name` is required when calling `get_config`."
       end
 
-      path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
+      path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -352,8 +366,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get a configuration.
     # Get a single Query Suggestions configuration.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Query Suggestions index name. (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 [QuerySuggestionsConfigurationResponse]
@@ -362,8 +378,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::QuerySuggestionsConfigurationResponse')
     end
 
-    # Get configuration status.
     # Report the status of a Query Suggestions index.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Query Suggestions index name. (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
@@ -373,7 +391,7 @@ module Algolia
         raise ArgumentError, "Parameter `index_name` is required when calling `get_config_status`."
       end
 
-      path = '/1/configs/{indexName}/status'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
+      path = '/1/configs/{indexName}/status'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -392,8 +410,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get configuration status.
     # Report the status of a Query Suggestions index.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Query Suggestions index name. (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 [GetConfigStatus200Response]
@@ -402,8 +422,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetConfigStatus200Response')
     end
 
-    # Get logs.
     # Get the logs for a single Query Suggestions index.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Query Suggestions index name. (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
@@ -413,7 +435,7 @@ module Algolia
         raise ArgumentError, "Parameter `index_name` is required when calling `get_log_file`."
       end
 
-      path = '/1/logs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
+      path = '/1/logs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -432,8 +454,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get logs.
     # Get the logs for a single Query Suggestions index.
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Query Suggestions index name. (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 [GetLogFile200Response]
@@ -442,8 +466,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetLogFile200Response')
     end
 
-    # Update a configuration.
     # Update a QuerySuggestions configuration.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Query Suggestions index name. (required)
     # @param query_suggestions_configuration [QuerySuggestionsConfiguration]  (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)
@@ -458,7 +484,7 @@ module Algolia
         raise ArgumentError, "Parameter `query_suggestions_configuration` is required when calling `update_config`."
       end
 
-      path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
+      path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -477,8 +503,10 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # Update a configuration.
     # Update a QuerySuggestions configuration.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Query Suggestions index name. (required)
     # @param query_suggestions_configuration [QuerySuggestionsConfiguration]  (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)

data/lib/algolia/api/recommend_client.rb

@@ -29,8 +29,8 @@ module Algolia
       new(config)
     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)
@@ -61,8 +61,8 @@ 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)
@@ -72,8 +72,8 @@ module Algolia
       @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)
@@ -104,8 +104,8 @@ 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)
@@ -115,8 +115,8 @@ module Algolia
       @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.
@@ -148,8 +148,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.
@@ -160,8 +160,8 @@ module Algolia
       @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 +193,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.
@@ -205,8 +205,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Delete a Recommend rule.
     # Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record (object) identifier. (required)
@@ -226,8 +228,8 @@ module Algolia
         raise ArgumentError, "Parameter `object_id` is required when calling `delete_recommend_rule`."
       end
 
-      path = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', @api_client.encode_uri(model.to_s)).sub(
-        '{' + 'objectID' + '}', @api_client.encode_uri(object_id.to_s)
+      path = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', Transport.encode_uri(model.to_s)).sub(
+        '{' + 'objectID' + '}', Transport.encode_uri(object_id.to_s)
       )
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -247,8 +249,10 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Delete a Recommend rule.
     # Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record (object) identifier. (required)
@@ -259,8 +263,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::DeletedAtResponse')
     end
 
-    # Get a Recommend rule.
     # Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record (object) identifier. (required)
@@ -280,8 +286,8 @@ module Algolia
         raise ArgumentError, "Parameter `object_id` is required when calling `get_recommend_rule`."
       end
 
-      path = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', @api_client.encode_uri(model.to_s)).sub(
-        '{' + 'objectID' + '}', @api_client.encode_uri(object_id.to_s)
+      path = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', Transport.encode_uri(model.to_s)).sub(
+        '{' + 'objectID' + '}', Transport.encode_uri(object_id.to_s)
       )
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -301,8 +307,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get a Recommend rule.
     # Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record (object) identifier. (required)
@@ -313,8 +321,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::RuleResponse')
     end
 
-    # Get a Recommend task&#39;s status.
     # Some operations, such as deleting a Recommend rule, will respond with a &#x60;taskID&#x60; value. Use this value here to check the status of that task.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param task_id [Integer] Unique identifier of a task. Numeric value (up to 64bits). (required)
@@ -334,8 +344,8 @@ module Algolia
         raise ArgumentError, "Parameter `task_id` is required when calling `get_recommend_status`."
       end
 
-      path = '/1/indexes/{indexName}/{model}/task/{taskID}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', @api_client.encode_uri(model.to_s)).sub(
-        '{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s)
+      path = '/1/indexes/{indexName}/{model}/task/{taskID}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', Transport.encode_uri(model.to_s)).sub(
+        '{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s)
       )
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -355,8 +365,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get a Recommend task's status.
     # Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param task_id [Integer] Unique identifier of a task. Numeric value (up to 64bits). (required)
@@ -367,8 +379,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendTaskResponse')
     end
 
-    # Get recommendations and trending items.
     # Returns results from either recommendation or trending models:    - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models   - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
+    #
+    # Required API Key ACLs:
+    #   - search
     # @param get_recommendations_params [GetRecommendationsParams]  (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
@@ -397,8 +411,10 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Get recommendations and trending items.
     # Returns results from either recommendation or trending models:    - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models   - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
+    #
+    # Required API Key ACLs:
+    #   - search
     # @param get_recommendations_params [GetRecommendationsParams]  (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 [GetRecommendationsResponse]
@@ -407,8 +423,10 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendationsResponse')
     end
 
-    # List Recommend rules.
     # List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param search_recommend_rules_params [SearchRecommendRulesParams]
@@ -424,8 +442,8 @@ module Algolia
         raise ArgumentError, "Parameter `model` is required when calling `search_recommend_rules`."
       end
 
-      path = '/1/indexes/{indexName}/{model}/recommend/rules/search'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}',
-                                                                                                                                               @api_client.encode_uri(model.to_s))
+      path = '/1/indexes/{indexName}/{model}/recommend/rules/search'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s)).sub('{' + 'model' + '}',
+                                                                                                                                             Transport.encode_uri(model.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -444,8 +462,10 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # List Recommend rules.
     # List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    #
+    # Required API Key ACLs:
+    #   - settings
     # @param index_name [String] Index on which to perform the request. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param search_recommend_rules_params [SearchRecommendRulesParams]