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

data/lib/algolia/api/analytics_client.rb

@@ -34,8 +34,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)
@@ -66,19 +66,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)
@@ -109,19 +109,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.
@@ -153,8 +153,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.
@@ -162,11 +162,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.
@@ -198,8 +198,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.
@@ -207,11 +207,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
 
-    # Get average click position.
     # Return the average click position for the complete time range and for individual days. &gt; **Note**: If all &#x60;positions&#x60; have a &#x60;clickCount&#x60; of &#x60;0&#x60; or &#x60;null&#x60;, it means Algolia didn&#39;t receive any click events for tracked searches. A _tracked_ search is a search request where the &#x60;clickAnalytics&#x60; parameter is &#x60;true&#x60;.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -257,8 +259,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get average click position.
     # Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -267,11 +271,13 @@ module Algolia
     # @return [GetAverageClickPositionResponse]
     def get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_average_click_position_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetAverageClickPositionResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetAverageClickPositionResponse')
     end
 
-    # Get click positions.
     # Show the number of clicks events and their associated position in the search results.  &gt; **Note**: If all &#x60;positions&#x60; have a &#x60;clickCount&#x60; of &#x60;0&#x60; or &#x60;null&#x60;, it means Algolia didn&#39;t receive any click events for tracked searches. A _tracked_ search is a search request where the &#x60;clickAnalytics&#x60; parameter is &#x60;true&#x60;.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -317,8 +323,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get click positions.
     # Show the number of clicks events and their associated position in the search results.  > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -327,11 +335,13 @@ module Algolia
     # @return [GetClickPositionsResponse]
     def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_click_positions_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetClickPositionsResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetClickPositionsResponse')
     end
 
-    # Get click-through rate (CTR).
     # Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -377,8 +387,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get click-through rate (CTR).
     # Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -387,11 +399,13 @@ module Algolia
     # @return [GetClickThroughRateResponse]
     def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_click_through_rate_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetClickThroughRateResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetClickThroughRateResponse')
     end
 
-    # Get conversion rate (CR).
     # Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -437,8 +451,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get conversion rate (CR).
     # Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -447,11 +463,13 @@ module Algolia
     # @return [GetConversationRateResponse]
     def get_conversation_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_conversation_rate_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetConversationRateResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetConversationRateResponse')
     end
 
-    # Get no click rate.
     # Returns the rate at which searches don&#39;t lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -497,8 +515,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get no click rate.
     # Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -507,11 +527,13 @@ module Algolia
     # @return [GetNoClickRateResponse]
     def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_no_click_rate_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetNoClickRateResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetNoClickRateResponse')
     end
 
-    # Get no results rate.
     # Returns the rate at which searches didn&#39;t return any results.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -557,8 +579,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get no results rate.
     # Returns the rate at which searches didn't return any results.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -567,11 +591,13 @@ module Algolia
     # @return [GetNoResultsRateResponse]
     def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_no_results_rate_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetNoResultsRateResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetNoResultsRateResponse')
     end
 
-    # Get number of searches.
     # Returns the number of searches within a time range.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -617,8 +643,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get number of searches.
     # Returns the number of searches within a time range.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -627,11 +655,13 @@ module Algolia
     # @return [GetSearchesCountResponse]
     def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_searches_count_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetSearchesCountResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetSearchesCountResponse')
     end
 
-    # Get top searches with no clicks.
     # Return the most popular of the last 1,000 searches that didn&#39;t lead to any clicks.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -681,8 +711,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top searches with no clicks.
     # Return the most popular of the last 1,000 searches that didn't lead to any clicks.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -693,11 +725,13 @@ module Algolia
     # @return [GetSearchesNoClicksResponse]
     def get_searches_no_clicks(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {})
       response = get_searches_no_clicks_with_http_info(index, start_date, end_date, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetSearchesNoClicksResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetSearchesNoClicksResponse')
     end
 
-    # Get top searches with no results.
     # Returns the most popular of the latest 1,000 searches that didn&#39;t return any results.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -747,8 +781,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top searches with no results.
     # Returns the most popular of the latest 1,000 searches that didn't return any results.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -759,11 +795,13 @@ module Algolia
     # @return [GetSearchesNoResultsResponse]
     def get_searches_no_results(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {})
       response = get_searches_no_results_with_http_info(index, start_date, end_date, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetSearchesNoResultsResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetSearchesNoResultsResponse')
     end
 
-    # Get Analytics API status.
     # Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, &#x60;updatedAt&#x60; will be &#x60;null&#x60;. &gt; **Note**: The Analytics API is updated every 5&amp;nbsp;minutes.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (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
@@ -793,18 +831,22 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get Analytics API status.
     # Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5&nbsp;minutes.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (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 [GetStatusResponse]
     def get_status(index, request_options = {})
       response = get_status_with_http_info(index, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetStatusResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetStatusResponse')
     end
 
-    # Get top countries.
     # Returns top countries. Limited to the 1,000 most frequent ones.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -854,8 +896,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top countries.
     # Returns top countries. Limited to the 1,000 most frequent ones.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -866,11 +910,13 @@ module Algolia
     # @return [GetTopCountriesResponse]
     def get_top_countries(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {})
       response = get_top_countries_with_http_info(index, start_date, end_date, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopCountriesResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopCountriesResponse')
     end
 
-    # Get top filterable attributes.
     # Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -922,8 +968,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top filterable attributes.
     # Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -935,11 +983,13 @@ module Algolia
     # @return [GetTopFilterAttributesResponse]
     def get_top_filter_attributes(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {})
       response = get_top_filter_attributes_with_http_info(index, search, start_date, end_date, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopFilterAttributesResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopFilterAttributesResponse')
     end
 
-    # Get top filter values for an attribute.
     # Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param attribute [String] Attribute name. (required)
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
@@ -970,7 +1020,7 @@ module Algolia
         raise ArgumentError, "invalid value for '\"end_date\"' when calling AnalyticsClient.get_top_filter_for_attribute, must conform to the pattern #{pattern}."
       end
 
-      path = '/2/filters/{attribute}'.sub('{' + 'attribute' + '}', @api_client.encode_uri(attribute.to_s))
+      path = '/2/filters/{attribute}'.sub('{' + 'attribute' + '}', Transport.encode_uri(attribute.to_s))
       query_params = {}
       query_params[:index] = index
       query_params[:search] = search unless search.nil?
@@ -996,8 +1046,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top filter values for an attribute.
     # Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param attribute [String] Attribute name. (required)
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
@@ -1010,11 +1062,13 @@ module Algolia
     # @return [GetTopFilterForAttributeResponse]
     def get_top_filter_for_attribute(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {})
       response = get_top_filter_for_attribute_with_http_info(attribute, index, search, start_date, end_date, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopFilterForAttributeResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopFilterForAttributeResponse')
     end
 
-    # Get top filters for a no result search.
     # Returns top filters for filter-enabled searches that don&#39;t return results. Limited to the 1,000 most recently used filters.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -1066,8 +1120,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top filters for a no result search.
     # Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -1079,11 +1135,13 @@ module Algolia
     # @return [GetTopFiltersNoResultsResponse]
     def get_top_filters_no_results(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {})
       response = get_top_filters_no_results_with_http_info(index, search, start_date, end_date, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopFiltersNoResultsResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopFiltersNoResultsResponse')
     end
 
-    # Get top hits.
     # Return the most popular clicked results in the last 1,000 searches.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
     # @param click_analytics [Boolean] Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (default to false)
@@ -1137,8 +1195,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top hits.
     # Return the most popular clicked results in the last 1,000 searches.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param search [String] User query.
     # @param click_analytics [Boolean] Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (default to false)
@@ -1151,11 +1211,13 @@ module Algolia
     # @return [GetTopHitsResponse]
     def get_top_hits(index, search = nil, click_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {})
       response = get_top_hits_with_http_info(index, search, click_analytics, start_date, end_date, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopHitsResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopHitsResponse')
     end
 
-    # Get top searches.
     # Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param click_analytics [Boolean] Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (default to false)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -1212,8 +1274,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get top searches.
     # Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param click_analytics [Boolean] Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (default to false)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -1228,11 +1292,13 @@ module Algolia
     def get_top_searches(index, click_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil,
                          request_options = {})
       response = get_top_searches_with_http_info(index, click_analytics, start_date, end_date, order_by, direction, limit, offset, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopSearchesResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetTopSearchesResponse')
     end
 
-    # Get user count.
     # Return the count of unique users.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -1278,8 +1344,10 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get user count.
     # Return the count of unique users.
+    #
+    # Required API Key ACLs:
+    #   - analytics
     # @param index [String] Index name to target. (required)
     # @param start_date [String] Start date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
     # @param end_date [String] End date (a string in the format &#x60;YYYY-MM-DD&#x60;) of the period to analyze.
@@ -1288,7 +1356,7 @@ module Algolia
     # @return [GetUsersCountResponse]
     def get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
       response = get_users_count_with_http_info(index, start_date, end_date, tags, request_options)
-      deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetUsersCountResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Analytics::GetUsersCountResponse')
     end
   end
 end