fix(specs): add x-acl to insights endpoints (#4822) (generated) [skip ci]

Co-authored-by: Kai Welke <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-csharp/algoliasearch/Clients/InsightsClient.cs

@@ -175,6 +175,9 @@ object CustomPut(
   /// <summary>
   /// Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
   /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - deleteObject
   /// <param name="userToken">User token for which to delete all associated events.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -191,6 +194,9 @@ Task DeleteUserTokenAsync(
   /// <summary>
   /// Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.  (Synchronous version)
   /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - deleteObject
   /// <param name="userToken">User token for which to delete all associated events.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -207,6 +213,9 @@ void DeleteUserToken(
   /// <summary>
   /// 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&nbsp;MB.
   /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - search
   /// <param name="insightsEvents"></param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -223,6 +232,9 @@ Task<EventsResponse> PushEventsAsync(
   /// <summary>
   /// 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&nbsp;MB.  (Synchronous version)
   /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - search
   /// <param name="insightsEvents"></param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>

clients/algoliasearch-client-dart/packages/client_insights/lib/src/api/insights_client.dart

@@ -187,6 +187,9 @@ final class InsightsClient implements ApiClient {
 
   /// Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
   ///
+  /// Required API Key ACLs:
+  ///   - deleteObject
+  ///
   /// Parameters:
   /// * [userToken] User token for which to delete all associated events.
   /// * [requestOptions] additional request configuration.
@@ -211,6 +214,9 @@ final class InsightsClient implements ApiClient {
 
   /// 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.
   ///
+  /// Required API Key ACLs:
+  ///   - search
+  ///
   /// Parameters:
   /// * [insightsEvents]
   /// * [requestOptions] additional request configuration.

clients/algoliasearch-client-go/algolia/insights/api_insights.go

@@ -231,6 +231,9 @@ export function createInsightsClient({
 
     /**
      * Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
+     *
+     * Required API Key ACLs:
+     *  - deleteObject
      * @param deleteUserToken - The deleteUserToken object.
      * @param deleteUserToken.userToken - User token for which to delete all associated events.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -256,6 +259,9 @@ export function createInsightsClient({
 
     /**
      * 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.
+     *
+     * Required API Key ACLs:
+     *  - search
      * @param insightsEvents - The insightsEvents object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts

@@ -119,6 +119,9 @@ public class InsightsClient(
 
   /**
    * Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
+   *
+   * Required API Key ACLs:
+   *   - deleteObject
    * @param userToken User token for which to delete all associated events.
    * @param requestOptions additional request configuration.
    */
@@ -136,6 +139,9 @@ public class InsightsClient(
 
   /**
    * 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.
+   *
+   * Required API Key ACLs:
+   *   - search
    * @param insightsEvents
    * @param requestOptions additional request configuration.
    */

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/InsightsClient.kt

@@ -270,6 +270,9 @@ public function customPut($path, $parameters = null, $body = null, $requestOptio
     /**
      * Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
      *
+     * Required API Key ACLs:
+     *  - deleteObject
+     *
      * @param string $userToken      User token for which to delete all associated events. (required)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      */
@@ -302,6 +305,9 @@ public function deleteUserToken($userToken, $requestOptions = [])
     /**
      * 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.
      *
+     * Required API Key ACLs:
+     *  - search
+     *
      * @param array|InsightsEvents $insightsEvents insightsEvents (required)
      *                                             - $insightsEvents['events'] => (array) Click and conversion events.  **All** events must be valid, otherwise the API returns an error. (required)
      *

clients/algoliasearch-client-php/lib/Api/InsightsClient.php

@@ -472,6 +472,8 @@ async def delete_user_token_with_http_info(
         """
         Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
 
+        Required API Key ACLs:
+          - deleteObject
 
         :param user_token: User token for which to delete all associated events. (required)
         :type user_token: str
@@ -511,6 +513,8 @@ async def delete_user_token(
         """
         Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
 
+        Required API Key ACLs:
+          - deleteObject
 
         :param user_token: User token for which to delete all associated events. (required)
         :type user_token: str
@@ -527,6 +531,8 @@ async def push_events_with_http_info(
         """
         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.
 
+        Required API Key ACLs:
+          - search
 
         :param insights_events: (required)
         :type insights_events: InsightsEvents
@@ -561,6 +567,8 @@ async def push_events(
         """
         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.
 
+        Required API Key ACLs:
+          - search
 
         :param insights_events: (required)
         :type insights_events: InsightsEvents
@@ -1005,6 +1013,8 @@ def delete_user_token_with_http_info(
         """
         Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
 
+        Required API Key ACLs:
+          - deleteObject
 
         :param user_token: User token for which to delete all associated events. (required)
         :type user_token: str
@@ -1044,6 +1054,8 @@ def delete_user_token(
         """
         Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
 
+        Required API Key ACLs:
+          - deleteObject
 
         :param user_token: User token for which to delete all associated events. (required)
         :type user_token: str
@@ -1060,6 +1072,8 @@ def push_events_with_http_info(
         """
         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.
 
+        Required API Key ACLs:
+          - search
 
         :param insights_events: (required)
         :type insights_events: InsightsEvents
@@ -1094,6 +1108,8 @@ def push_events(
         """
         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.
 
+        Required API Key ACLs:
+          - search
 
         :param insights_events: (required)
         :type insights_events: InsightsEvents

clients/algoliasearch-client-python/algoliasearch/insights/client.py

@@ -246,7 +246,9 @@ def custom_put(path, parameters = nil, body = nil, request_options = {})
     end
 
     # Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
-
+    #
+    # Required API Key ACLs:
+    #   - deleteObject
     # @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
@@ -276,7 +278,9 @@ def delete_user_token_with_http_info(user_token, request_options = {})
     end
 
     # Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
-
+    #
+    # Required API Key ACLs:
+    #   - deleteObject
     # @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]
@@ -286,7 +290,9 @@ def delete_user_token(user_token, request_options = {})
     end
 
     # 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.
-
+    #
+    # Required API Key ACLs:
+    #   - search
     # @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)
     # @return [Http::Response] the response
@@ -316,7 +322,9 @@ def push_events_with_http_info(insights_events, request_options = {})
     end
 
     # 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.
-
+    #
+    # Required API Key ACLs:
+    #   - search
     # @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)
     # @return [EventsResponse]

clients/algoliasearch-client-ruby/lib/algolia/api/insights_client.rb

@@ -189,6 +189,9 @@ class InsightsClient(
     * asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile`
     * in the Personalization API.
     *
+    * Required API Key ACLs:
+    *   - deleteObject
+    *
     * @param userToken
     *   User token for which to delete all associated events.
     */
@@ -207,6 +210,9 @@ class InsightsClient(
 
   /** 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.
+    *
+    * Required API Key ACLs:
+    *   - search
     */
   def pushEvents(insightsEvents: InsightsEvents, requestOptions: Option[RequestOptions] = None)(implicit
       ec: ExecutionContext

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/InsightsClient.scala

@@ -314,7 +314,8 @@ open class InsightsClient {
     /// Deletes all events related to the specified user token from events metrics and analytics. The deletion is
     /// asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user
     /// profile` in the Personalization API.
-    ///
+    /// Required API Key ACLs:
+    ///  - deleteObject
     ///
     /// - parameter userToken: (path) User token for which to delete all associated events.
     /// - returns: RequestBuilder<Void>
@@ -376,7 +377,8 @@ open class InsightsClient {
 
     // 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&nbsp;MB.
-    //
+    // Required API Key ACLs:
+    //  - search
     //
     // - parameter insightsEvents: (body)
     // - returns: RequestBuilder<EventsResponse>