query_suggestions_client.rb in algolia-3.0.0.alpha.16

- old
+ new

@@ -31,11 +31,11 @@
 
     def self.create_with_config(config)
       new(config)
     end
 
-    # Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+    # Creates 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)
@@ -63,11 +63,11 @@
       )
 
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+    # Creates 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)
@@ -251,11 +251,11 @@
     def custom_put(path, parameters = nil, body = nil, request_options = {})
       response = custom_put_with_http_info(path, parameters, body, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # 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.
+    # Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.
     #
     # 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)
@@ -283,11 +283,11 @@
       )
 
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # 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.
+    # Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.
     #
     # 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)
@@ -295,11 +295,11 @@
     def delete_config(index_name, request_options = {})
       response = delete_config_with_http_info(index_name, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
     end
 
-    # List all Query Suggestions configurations of your Algolia application.
+    # Retrieves 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
@@ -321,22 +321,22 @@
       )
 
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List all Query Suggestions configurations of your Algolia application.
+    # Retrieves 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 = {})
       response = get_all_configs_with_http_info(request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::QuerySuggestionsConfigurationResponse>')
     end
 
-    # Get a single Query Suggestions configuration.
+    # Retrieves a single Query Suggestions configuration by its index name.
     #
     # 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)
@@ -364,11 +364,11 @@
       )
 
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get a single Query Suggestions configuration.
+    # Retrieves a single Query Suggestions configuration by its index name.
     #
     # 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)
@@ -376,11 +376,11 @@
     def get_config(index_name, request_options = {})
       response = get_config_with_http_info(index_name, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::QuerySuggestionsConfigurationResponse')
     end
 
-    # Report the status of a Query Suggestions index.
+    # Reports 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)
@@ -408,11 +408,11 @@
       )
 
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Report the status of a Query Suggestions index.
+    # Reports 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)
@@ -420,11 +420,11 @@
     def get_config_status(index_name, request_options = {})
       response = get_config_status_with_http_info(index_name, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetConfigStatus200Response')
     end
 
-    # Get the logs for a single Query Suggestions index.
+    # Retrieves 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)
@@ -452,11 +452,11 @@
       )
 
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get the logs for a single Query Suggestions index.
+    # Retrieves 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)
@@ -464,11 +464,11 @@
     def get_log_file(index_name, request_options = {})
       response = get_log_file_with_http_info(index_name, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetLogFile200Response')
     end
 
-    # Update a QuerySuggestions configuration.
+    # Updates a QuerySuggestions configuration.
     #
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Query Suggestions index name. (required)
     # @param query_suggestions_configuration [QuerySuggestionsConfiguration]  (required)
@@ -501,10 +501,10 @@
       )
 
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # Update a QuerySuggestions configuration.
+    # Updates a QuerySuggestions configuration.
     #
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Query Suggestions index name. (required)
     # @param query_suggestions_configuration [QuerySuggestionsConfiguration]  (required)