chore: generated code for commit 9753e2d. [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-javascript/packages/client-search/model/clientMethodProps.ts

@@ -10,8 +10,6 @@ import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParam
 import type { BatchWriteParams } from './batchWriteParams';
 import type { BrowseRequest } from './browseRequest';
 import type { DictionaryType } from './dictionaryType';
-import type { GetApiKeyResponse } from './getApiKeyResponse';
-import type { GetTaskResponse } from './getTaskResponse';
 import type { IndexSettings } from './indexSettings';
 import type { LogType } from './logType';
 import type { OperationIndexParams } from './operationIndexParams';
@@ -733,10 +731,7 @@ export type BrowseOptions<T> = Partial<
 > &
   Required<Pick<CreateIterablePromise<T>, 'aggregator'>>;
 
-type WaitForOptions<T> = Omit<
-  CreateIterablePromise<T>,
-  'func' | 'timeout' | 'validate'
-> & {
+type WaitForOptions = Partial<{
   /**
    * The maximum number of retries. 50 by default.
    */
@@ -746,9 +741,9 @@ type WaitForOptions<T> = Omit<
    * The function to decide how long to wait between retries.
    */
   timeout: (retryCount: number) => number;
-};
+}>;
 
-export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
+export type WaitForTaskOptions = WaitForOptions & {
   /**
    * The `indexName` where the operation was performed.
    */
@@ -759,7 +754,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<GetApiKeyResponse> & {
+export type WaitForApiKeyOptions = WaitForOptions & {
   /**
    * The API Key.
    */

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -335,7 +335,7 @@ export function createSearchClient({
      * @param browseObjects - The browseObjects object.
      * @param browseObjects.indexName - The index in which to perform the request.
      * @param browseObjects.browseRequest - The `browse` method parameters.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
+     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
      */
@@ -372,7 +372,7 @@ export function createSearchClient({
      * @param browseObjects - The browseObjects object.
      * @param browseObjects.indexName - The index in which to perform the request.
      * @param browseObjects.searchRulesParams - The `searchRules` method parameters.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
+     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
      */
@@ -415,7 +415,7 @@ export function createSearchClient({
      * @summary Helper method that iterates on the `searchSynonyms` method.
      * @param browseObjects - The browseObjects object.
      * @param browseObjects.indexName - The index in which to perform the request.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
+     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
      */