fix(specs): delete user token processing time (#3525) (generated) [skip ci]

algolia-bot · kai687 · algolia-bot · commit 2798e35ee125 · 2024-08-14T12:24:47.000Z
Co-authored-by: Kai Welke &lt;kai.welke@algolia.com&gt;
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/InsightsClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/InsightsClient.cs
@@ -130,7 +130,7 @@ public interface IInsightsClient
   object CustomPut(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// 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). 
+  /// 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](/specs/personalization#tag/profiles/operation/deleteUserProfile). 
   /// </summary>
   /// <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>
@@ -142,7 +142,7 @@ public interface IInsightsClient
   Task DeleteUserTokenAsync(string userToken, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// 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).  (Synchronous version)
+  /// 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).  (Synchronous version)
   /// </summary>
   /// <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>
@@ -412,7 +412,7 @@ public object CustomPut(string path, Dictionary<string, object> parameters = def
 
 
   /// <summary>
-  /// 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). 
+  /// 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](/specs/personalization#tag/profiles/operation/deleteUserProfile). 
   /// </summary>
   /// <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>
@@ -436,7 +436,7 @@ public async Task DeleteUserTokenAsync(string userToken, RequestOptions options
 
 
   /// <summary>
-  /// 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).  (Synchronous version)
+  /// 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).  (Synchronous version)
   /// </summary>
   /// <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>
diff --git a/clients/algoliasearch-client-dart/packages/client_insights/lib/src/api/insights_client.dart b/clients/algoliasearch-client-dart/packages/client_insights/lib/src/api/insights_client.dart
@@ -185,7 +185,7 @@ final class InsightsClient implements ApiClient {
     );
   }
 
-  /// 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).
+  /// 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
   ///
   /// Parameters:
   /// * [userToken] User token for which to delete all associated events.
diff --git a/clients/algoliasearch-client-go/algolia/insights/api_insights.go b/clients/algoliasearch-client-go/algolia/insights/api_insights.go
diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java
@@ -477,8 +477,9 @@ public CompletableFuture<Object> customPutAsync(@Nonnull String path) throws Alg
   }
 
   /**
-   * Deletes all events related to the specified user token from events metrics and analytics. To
-   * delete a personalization user profile, see [Delete a user
+   * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
    * @param userToken User token for which to delete all associated events. (required)
@@ -492,8 +493,9 @@ public void deleteUserToken(@Nonnull String userToken, RequestOptions requestOpt
   }
 
   /**
-   * Deletes all events related to the specified user token from events metrics and analytics. To
-   * delete a personalization user profile, see [Delete a user
+   * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
    * @param userToken User token for which to delete all associated events. (required)
@@ -505,7 +507,8 @@ public void deleteUserToken(@Nonnull String userToken) throws AlgoliaRuntimeExce
 
   /**
    * (asynchronously) Deletes all events related to the specified user token from events metrics and
-   * analytics. To delete a personalization user profile, see [Delete a user
+   * analytics. The deletion is asynchronous, and processed within 48 hours. To delete a
+   * personalization user profile, see [Delete a user
    * profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
    * @param userToken User token for which to delete all associated events. (required)
@@ -523,7 +526,8 @@ public CompletableFuture<Void> deleteUserTokenAsync(@Nonnull String userToken, R
 
   /**
    * (asynchronously) Deletes all events related to the specified user token from events metrics and
-   * analytics. To delete a personalization user profile, see [Delete a user
+   * analytics. The deletion is asynchronous, and processed within 48 hours. To delete a
+   * personalization user profile, see [Delete a user
    * profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
    * @param userToken User token for which to delete all associated events. (required)
diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts b/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts
@@ -234,7 +234,7 @@ export function createInsightsClient({
     },
 
     /**
-     * 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).
+     * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
      *
      * @param deleteUserToken - The deleteUserToken object.
      * @param deleteUserToken.userToken - User token for which to delete all associated events.
diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/InsightsClient.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/InsightsClient.kt
@@ -117,7 +117,7 @@ public class InsightsClient(
   }
 
   /**
-   * 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).
+   * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    * @param userToken User token for which to delete all associated events.
    * @param requestOptions additional request configuration.
    */
diff --git a/clients/algoliasearch-client-php/lib/Api/InsightsClient.php b/clients/algoliasearch-client-php/lib/Api/InsightsClient.php
@@ -257,7 +257,7 @@ public function customPut($path, $parameters = null, $body = null, $requestOptio
     }
 
     /**
-     * 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).
+     * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
      *
      * @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
diff --git a/clients/algoliasearch-client-python/algoliasearch/insights/client.py b/clients/algoliasearch-client-python/algoliasearch/insights/client.py
@@ -452,7 +452,7 @@ async def delete_user_token_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
-        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).
+        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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
 
 
         :param user_token: User token for which to delete all associated events. (required)
@@ -491,7 +491,7 @@ async def delete_user_token(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> None:
         """
-        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).
+        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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
 
 
         :param user_token: User token for which to delete all associated events. (required)
diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/insights_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/insights_client.rb
@@ -215,7 +215,7 @@ def custom_put(path, parameters = nil, body = nil, request_options = {})
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # 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).
+    # 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
 
     # @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)
@@ -267,7 +267,7 @@ def delete_user_token_with_http_info(user_token, request_options = {})
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # 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).
+    # 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
 
     # @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)
diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/InsightsClient.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/InsightsClient.scala
@@ -165,8 +165,8 @@ class InsightsClient(
     execute[T](request, requestOptions)
   }
 
-  /** Deletes all events related to the specified user token from events metrics and analytics. To delete a
-    * personalization user profile, see [Delete a user
+  /** 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
     *
     * @param userToken
diff --git a/clients/algoliasearch-client-swift/Sources/Insights/InsightsClient.swift b/clients/algoliasearch-client-swift/Sources/Insights/InsightsClient.swift
@@ -294,8 +294,8 @@ open class InsightsClient {
         try await self.deleteUserTokenWithHTTPInfo(userToken: userToken, requestOptions: requestOptions)
     }
 
-    /// Deletes all events related to the specified user token from events metrics and analytics. To delete a
-    /// personalization user profile, see [Delete a user
+    /// 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
     ///
     ///
diff --git a/specs/bundled/insights.doc.yml b/specs/bundled/insights.doc.yml
@@ -1834,6 +1834,8 @@ paths:
         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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
       parameters:
diff --git a/specs/bundled/insights.yml b/specs/bundled/insights.yml
@@ -681,6 +681,8 @@ paths:
         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](/specs/personalization#tag/profiles/operation/deleteUserProfile).
       parameters:

Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ final class InsightsClient implements ApiClient {`
`185`	`185`	`);`
`186`	`186`	`}`
`187`	`187`
`188`		`- /// 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).`
	`188`	`+ /// 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).`
`189`	`189`	`///`
`190`	`190`	`/// Parameters:`
`191`	`191`	`/// * [userToken] User token for which to delete all associated events.`
Original file line number	Diff line number	Diff line change
`@@ -234,7 +234,7 @@ export function createInsightsClient({`
`234`	`234`	`},`
`235`	`235`
`236`	`236`	`/**`
`237`		`- * 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).`
	`237`	`+ * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).`
`238`	`238`	`*`
`239`	`239`	`* @param deleteUserToken - The deleteUserToken object.`
`240`	`240`	`* @param deleteUserToken.userToken - User token for which to delete all associated events.`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public class InsightsClient(`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`/**`
`120`		`- * 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).`
	`120`	`+ * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).`
`121`	`121`	`* @param userToken User token for which to delete all associated events.`
`122`	`122`	`* @param requestOptions additional request configuration.`
`123`	`123`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ public function customPut($path, $parameters = null, $body = null, $requestOptio`
`257`	`257`	`}`
`258`	`258`
`259`	`259`	`/**`
`260`		`- * 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).`
	`260`	`+ * 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](/specs/personalization#tag/profiles/operation/deleteUserProfile).`
`261`	`261`	`*`
`262`	`262`	`* @param string $userToken User token for which to delete all associated events. (required)`
`263`	`263`	`* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions`
Original file line number	Diff line number	Diff line change
`@@ -165,8 +165,8 @@ class InsightsClient(`
`165`	`165`	`execute[T](request, requestOptions)`
`166`	`166`	`}`
`167`	`167`
`168`		`- /** Deletes all events related to the specified user token from events metrics and analytics. To delete a`
`169`		`- * personalization user profile, see [Delete a user`
	`168`	`+ /** Deletes all events related to the specified user token from events metrics and analytics. The deletion is`
	`169`	`+ * asynchronous, and processed within 48 hours. To delete a personalization user profile, see [Delete a user`
`170`	`170`	`* profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).`
`171`	`171`	`*`
`172`	`172`	`* @param userToken`