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

data/lib/algolia/api/recommend_client.rb

@@ -14,7 +14,6 @@ module Algolia
 
     def self.create(app_id, api_key, opts = {})
       hosts = []
-
       hosts << Transport::StatefulHost.new("#{app_id}-dsn.algolia.net", accept: CallType::READ)
       hosts << Transport::StatefulHost.new("#{app_id}.algolia.net", accept: CallType::WRITE)
 
@@ -30,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 \&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)
@@ -62,19 +61,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)
@@ -105,19 +104,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.
@@ -149,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.
@@ -158,11 +157,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.
@@ -194,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.
@@ -203,11 +202,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 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)
@@ -227,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?
@@ -248,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)
@@ -257,11 +260,13 @@ module Algolia
     # @return [DeletedAtResponse]
     def delete_recommend_rule(index_name, model, object_id, request_options = {})
       response = delete_recommend_rule_with_http_info(index_name, model, object_id, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Recommend::DeletedAtResponse')
+      @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)
@@ -281,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?
@@ -302,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)
@@ -311,11 +318,13 @@ module Algolia
     # @return [RuleResponse]
     def get_recommend_rule(index_name, model, object_id, request_options = {})
       response = get_recommend_rule_with_http_info(index_name, model, object_id, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Recommend::RuleResponse')
+      @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)
@@ -335,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?
@@ -356,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)
@@ -365,11 +376,13 @@ module Algolia
     # @return [GetRecommendTaskResponse]
     def get_recommend_status(index_name, model, task_id, request_options = {})
       response = get_recommend_status_with_http_info(index_name, model, task_id, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendTaskResponse')
+      @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
@@ -392,24 +405,28 @@ module Algolia
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
-        :use_read_transporter => false
+        :use_read_transporter => true
       )
 
       @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]
     def get_recommendations(get_recommendations_params, request_options = {})
       response = get_recommendations_with_http_info(get_recommendations_params, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendationsResponse')
+      @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]
@@ -425,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 = {}
@@ -439,14 +456,16 @@ module Algolia
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
-        :use_read_transporter => false
+        :use_read_transporter => true
       )
 
       @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]
@@ -454,7 +473,7 @@ module Algolia
     # @return [SearchRecommendRulesResponse]
     def search_recommend_rules(index_name, model, search_recommend_rules_params = nil, request_options = {})
       response = search_recommend_rules_with_http_info(index_name, model, search_recommend_rules_params, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Recommend::SearchRecommendRulesResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::SearchRecommendRulesResponse')
     end
   end
 end