algolia 3.0.0.alpha.12 → 3.0.0.alpha.13

data/lib/algolia/api/ingestion_client.rb

@@ -1340,8 +1340,8 @@ module Algolia
     # @param page [Integer] The page number to fetch, starting at 1.
     # @param action [Array<ActionType>] The action of the tasks to retrieve.
     # @param enabled [Boolean] Whether the task is enabled or not.
-    # @param source_id [Array<String>] The sourceIDs of the tasks to retrive.
-    # @param destination_id [Array<String>] The destinationIDs of the tasks to retrive.
+    # @param source_id [Array<String>] The sourceIDs of the tasks to retrieve.
+    # @param destination_id [Array<String>] The destinationIDs of the tasks to retrieve.
     # @param trigger_type [Array<TriggerType>] The trigger type of the task.
     # @param sort [TaskSortKeys] The key by which the list should be sorted.
     # @param order [OrderKeys] The order of the returned list.
@@ -1387,8 +1387,8 @@ module Algolia
     # @param page [Integer] The page number to fetch, starting at 1.
     # @param action [Array<ActionType>] The action of the tasks to retrieve.
     # @param enabled [Boolean] Whether the task is enabled or not.
-    # @param source_id [Array<String>] The sourceIDs of the tasks to retrive.
-    # @param destination_id [Array<String>] The destinationIDs of the tasks to retrive.
+    # @param source_id [Array<String>] The sourceIDs of the tasks to retrieve.
+    # @param destination_id [Array<String>] The destinationIDs of the tasks to retrieve.
     # @param trigger_type [Array<TriggerType>] The trigger type of the task.
     # @param sort [TaskSortKeys] The key by which the list should be sorted.
     # @param order [OrderKeys] The order of the returned list.

data/lib/algolia/api/insights_client.rb

@@ -209,9 +209,9 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Delete all events related to a certain user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](https://www.algolia.com/doc/rest-api/personalization/#delete-a-user-profile).
+    # Deletes all events related to the specified user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
 
-    # @param user_token [String] The user token for which to delete all associated events. (required)
+    # @param user_token [String] User token for which to delete all associated events. (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
     def delete_user_token_with_http_info(user_token, request_options = {})
@@ -227,7 +227,7 @@ module Algolia
         raise ArgumentError, 'invalid value for "user_token" when calling InsightsClient.delete_user_token, the character length must be great than or equal to 1.'
       end
 
-      pattern = %r{[a-zA-Z0-9_=/+]{1,129}}
+      pattern = %r{[a-zA-Z0-9_=/+-]{1,129}}
       if @api_client.config.client_side_validation && user_token !~ pattern
         raise ArgumentError, "invalid value for 'user_token' when calling InsightsClient.delete_user_token, must conform to the pattern #{pattern}."
       end
@@ -251,9 +251,9 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Delete all events related to a certain user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](https://www.algolia.com/doc/rest-api/personalization/#delete-a-user-profile).
+    # Deletes all events related to the specified user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
 
-    # @param user_token [String] The user token for which to delete all associated events. (required)
+    # @param user_token [String] User token for which to delete all associated events. (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 [nil]
     def delete_user_token(user_token, request_options = {})
@@ -261,7 +261,7 @@ module Algolia
       nil
     end
 
-    # Send a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
+    # Sends a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
 
     # @param insights_events [InsightsEvents]  (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)
@@ -291,7 +291,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Send a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
+    # Sends a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
 
     # @param insights_events [InsightsEvents]  (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

@@ -209,9 +209,9 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (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)
+    # @param object_id [String] Unique record identifier. (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
     def delete_recommend_rule_with_http_info(index_name, model, object_id, request_options = {})
@@ -253,9 +253,9 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (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)
+    # @param object_id [String] Unique record identifier. (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 [DeletedAtResponse]
     def delete_recommend_rule(index_name, model, object_id, request_options = {})
@@ -267,9 +267,9 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - settings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (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)
+    # @param object_id [String] Unique record identifier. (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
     def get_recommend_rule_with_http_info(index_name, model, object_id, request_options = {})
@@ -311,9 +311,9 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - settings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (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)
+    # @param object_id [String] Unique record identifier. (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 [RuleResponse]
     def get_recommend_rule(index_name, model, object_id, request_options = {})
@@ -325,7 +325,7 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (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)
     # @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)
@@ -369,7 +369,7 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (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)
     # @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)
@@ -427,7 +427,7 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - settings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param search_recommend_rules_params [SearchRecommendRulesParams]
     # @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)
@@ -466,7 +466,7 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - settings
-    # @param index_name [String] Index on which to perform the request. (required)
+    # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param search_recommend_rules_params [SearchRecommendRulesParams]
     # @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)