fix(cts): add waitForTask helpers tests [skip-bc] (generated)

algolia/api-clients-automation#3618

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: algolia-bot

client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt

@@ -86,25 +86,46 @@ public suspend fun SearchClient.waitForApiKey(
  * @param maxRetries maximum number of retry attempts.
  * @param requestOptions additional request configuration.
  */
-public suspend fun SearchClient.waitTask(
+public suspend fun SearchClient.waitForTask(
   indexName: String,
   taskID: Long,
   maxRetries: Int = 50,
   timeout: Duration = Duration.INFINITE,
   initialDelay: Duration = 200.milliseconds,
   maxDelay: Duration = 5.seconds,
   requestOptions: RequestOptions? = null,
-): TaskStatus {
+): GetTaskResponse {
   return retryUntil(
     timeout = timeout,
     maxRetries = maxRetries,
     initialDelay = initialDelay,
     maxDelay = maxDelay,
-    retry = { getTask(indexName, taskID, requestOptions).status },
-    until = { it == TaskStatus.Published },
+    retry = { getTask(indexName, taskID, requestOptions) },
+    until = { it.status == TaskStatus.Published },
   )
 }
 
+@Deprecated("Please use waitForTask instead", ReplaceWith("waitForTask(indexName, taskID, maxRetries, timeout, initialDelay, maxDelay, requestOptions)"))
+public suspend fun SearchClient.waitTask(
+  indexName: String,
+  taskID: Long,
+  maxRetries: Int = 50,
+  timeout: Duration = Duration.INFINITE,
+  initialDelay: Duration = 200.milliseconds,
+  maxDelay: Duration = 5.seconds,
+  requestOptions: RequestOptions? = null,
+): TaskStatus {
+  return waitForTask(
+    indexName = indexName,
+    taskID = taskID,
+    maxRetries = maxRetries,
+    timeout = timeout,
+    initialDelay = initialDelay,
+    maxDelay = maxDelay,
+    requestOptions = requestOptions,
+  ).status
+}
+
 /**
  * Wait for an application-level [taskID] to complete before executing the next line of code.
  *
@@ -115,24 +136,43 @@ public suspend fun SearchClient.waitTask(
  * @param maxRetries maximum number of retry attempts.
  * @param requestOptions additional request configuration.
  */
-public suspend fun SearchClient.waitAppTask(
+public suspend fun SearchClient.waitForAppTask(
   taskID: Long,
   maxRetries: Int = 50,
   timeout: Duration = Duration.INFINITE,
   initialDelay: Duration = 200.milliseconds,
   maxDelay: Duration = 5.seconds,
   requestOptions: RequestOptions? = null,
-): TaskStatus {
+): GetTaskResponse {
   return retryUntil(
     timeout = timeout,
     maxRetries = maxRetries,
     initialDelay = initialDelay,
     maxDelay = maxDelay,
-    retry = { getAppTask(taskID, requestOptions).status },
-    until = { it == TaskStatus.Published },
+    retry = { getAppTask(taskID, requestOptions) },
+    until = { it.status == TaskStatus.Published },
   )
 }
 
+@Deprecated("Please use waitForAppTask instead", ReplaceWith("waitForAppTask(taskID, maxRetries, timeout, initialDelay, maxDelay, requestOptions)"))
+public suspend fun SearchClient.waitAppTask(
+  taskID: Long,
+  maxRetries: Int = 50,
+  timeout: Duration = Duration.INFINITE,
+  initialDelay: Duration = 200.milliseconds,
+  maxDelay: Duration = 5.seconds,
+  requestOptions: RequestOptions? = null,
+): TaskStatus {
+  return waitForAppTask(
+    taskID = taskID,
+    maxRetries = maxRetries,
+    timeout = timeout,
+    initialDelay = initialDelay,
+    maxDelay = maxDelay,
+    requestOptions = requestOptions,
+  ).status
+}
+
 /**
  * Wait on an API key update operation.
  *
@@ -312,7 +352,7 @@ public suspend fun SearchClient.chunkedBatch(
     tasks.add(batch)
   }
   if (waitForTask) {
-    tasks.forEach { waitTask(indexName, it.taskID) }
+    tasks.forEach { waitForTask(indexName, it.taskID) }
   }
   return tasks
 }
@@ -431,7 +471,7 @@ public suspend fun SearchClient.replaceAllObjects(
     requestOptions = requestOptions,
   )
 
-  waitTask(indexName = tmpIndexName, taskID = copy.taskID)
+  waitForTask(indexName = tmpIndexName, taskID = copy.taskID)
 
   copy = operationIndex(
     indexName = indexName,
@@ -442,14 +482,14 @@ public suspend fun SearchClient.replaceAllObjects(
     ),
     requestOptions = requestOptions,
   )
-  waitTask(indexName = tmpIndexName, taskID = copy.taskID)
+  waitForTask(indexName = tmpIndexName, taskID = copy.taskID)
 
   val move = operationIndex(
     indexName = tmpIndexName,
     operationIndexParams = OperationIndexParams(operation = OperationType.Move, destination = indexName),
     requestOptions = requestOptions,
   )
-  waitTask(indexName = tmpIndexName, taskID = move.taskID)
+  waitForTask(indexName = tmpIndexName, taskID = move.taskID)
 
   return ReplaceAllObjectsResponse(copy, batchResponses, move)
 }