algoliasearch 5.0.0-alpha.97 → 5.0.0-alpha.99

package/dist/algoliasearch/builds/browser.d.ts

@@ -4,7 +4,7 @@ import type { ClientOptions } from '@algolia/client-common';
 import type { Region as PersonalizationRegion, PersonalizationClient } from '@algolia/client-personalization/src/personalizationClient';
 import type { InitClientOptions, InitClientRegion } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.0-alpha.97";
+export declare const apiClientVersion = "5.0.0-alpha.99";
 /**
  * The client type.
  */
@@ -22,7 +22,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("@algolia/client-search/model/getApiKeyResponse").GetApiKeyResponse>;
     browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
-    browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
+    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
     searchForHits<T_1>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
         results: import("@algolia/client-search/model/searchResponse").SearchResponse<T_1>[];
     }>;
@@ -37,9 +37,9 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("@algolia/client-search/model/clientMethodProps").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
     batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     browse<T_2>({ indexName, browseParams }: import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T_2>>;
-    clearAllSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearAllSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     clearObjects({ indexName }: import("@algolia/client-search/model/clientMethodProps").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     clearRules({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
+    clearSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     customDelete({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     customGet({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     customPost({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
@@ -85,7 +85,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("@algolia/client-search/model/clientMethodProps").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse>;
     searchRules({ indexName, searchRulesParams }: import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
     searchSingleIndex<T_5>({ indexName, searchParams }: import("@algolia/client-search/model/clientMethodProps").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchResponse").SearchResponse<T_5>>;
-    searchSynonyms({ indexName, type, page, hitsPerPage, searchSynonymsParams, }: import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
+    searchSynonyms({ indexName, searchSynonymsParams }: import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
     searchUserIds(searchUserIdsParams: import("@algolia/client-search/model/searchUserIdsParams").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchUserIdsResponse").SearchUserIdsResponse>;
     setDictionarySettings(dictionarySettingsParams: import("@algolia/client-search/model/dictionarySettingsParams").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     setSettings({ indexName, indexSettings, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;

package/dist/algoliasearch/builds/node.d.ts

@@ -4,7 +4,7 @@ import type { ClientOptions } from '@algolia/client-common';
 import type { Region as PersonalizationRegion, PersonalizationClient } from '@algolia/client-personalization/src/personalizationClient';
 import type { InitClientOptions, InitClientRegion } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.0-alpha.97";
+export declare const apiClientVersion = "5.0.0-alpha.99";
 /**
  * The client type.
  */
@@ -22,7 +22,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("@algolia/client-search/model/getApiKeyResponse").GetApiKeyResponse>;
     browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
-    browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
+    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
     searchForHits<T_1>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
         results: import("@algolia/client-search/model/searchResponse").SearchResponse<T_1>[];
     }>;
@@ -37,9 +37,9 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("@algolia/client-search/model/clientMethodProps").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
     batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     browse<T_2>({ indexName, browseParams }: import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T_2>>;
-    clearAllSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearAllSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     clearObjects({ indexName }: import("@algolia/client-search/model/clientMethodProps").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     clearRules({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
+    clearSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     customDelete({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     customGet({ path, parameters }: import("@algolia/client-search/model/clientMethodProps").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     customPost({ path, parameters, body }: import("@algolia/client-search/model/clientMethodProps").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
@@ -85,7 +85,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("@algolia/client-search/model/clientMethodProps").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse>;
     searchRules({ indexName, searchRulesParams }: import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
     searchSingleIndex<T_5>({ indexName, searchParams }: import("@algolia/client-search/model/clientMethodProps").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchResponse").SearchResponse<T_5>>;
-    searchSynonyms({ indexName, type, page, hitsPerPage, searchSynonymsParams, }: import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
+    searchSynonyms({ indexName, searchSynonymsParams }: import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
     searchUserIds(searchUserIdsParams: import("@algolia/client-search/model/searchUserIdsParams").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchUserIdsResponse").SearchUserIdsResponse>;
     setDictionarySettings(dictionarySettingsParams: import("@algolia/client-search/model/dictionarySettingsParams").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
     setSettings({ indexName, indexSettings, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;

package/dist/algoliasearch.cjs

@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$4 = '5.0.0-alpha.97';
+const apiClientVersion$4 = '5.0.0-alpha.99';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -303,7 +303,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$3 = '5.0.0-alpha.97';
+const apiClientVersion$3 = '5.0.0-alpha.99';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1200,7 +1200,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$2 = '5.0.0-alpha.97';
+const apiClientVersion$2 = '5.0.0-alpha.99';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1457,7 +1457,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$1 = '5.0.0-alpha.97';
+const apiClientVersion$1 = '5.0.0-alpha.99';
 function getDefaultHosts(appId) {
     return [
         {
@@ -1682,21 +1682,25 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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. 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 browseObjects.searchSynonymsParams - The `searchSynonyms` method parameters.
          * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
          */
-        browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }, requestOptions) {
+        browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }, requestOptions) {
             const params = {
+                page: 0,
+                ...searchSynonymsParams,
                 hitsPerPage: 1000,
-                ...browseSynonymsOptions,
             };
             return clientCommon.createIterablePromise({
                 func: (previousResponse) => {
                     return this.searchSynonyms({
-                        ...params,
                         indexName,
-                        page: previousResponse
-                            ? previousResponse.page + 1
-                            : browseSynonymsOptions.page || 0,
+                        searchSynonymsParams: {
+                            ...params,
+                            page: previousResponse
+                                ? previousResponse.page + 1
+                                : params.page,
+                        },
                     }, requestOptions);
                 },
                 validate: (response) => response.nbHits < params.hitsPerPage,
@@ -1970,24 +1974,20 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete all synonyms in the index.
+         * Delete the records but leave settings and index-specific API keys untouched.
          *
-         * @summary Delete all synonyms.
-         * @param clearAllSynonyms - The clearAllSynonyms object.
-         * @param clearAllSynonyms.indexName - Index on which to perform the request.
-         * @param clearAllSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+         * @summary Delete all records from an index.
+         * @param clearObjects - The clearObjects object.
+         * @param clearObjects.indexName - Index on which to perform the request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        clearAllSynonyms({ indexName, forwardToReplicas }, requestOptions) {
+        clearObjects({ indexName }, requestOptions) {
             if (!indexName) {
-                throw new Error('Parameter `indexName` is required when calling `clearAllSynonyms`.');
+                throw new Error('Parameter `indexName` is required when calling `clearObjects`.');
             }
-            const requestPath = '/1/indexes/{indexName}/synonyms/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const requestPath = '/1/indexes/{indexName}/clear'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
-            if (forwardToReplicas !== undefined) {
-                queryParameters.forwardToReplicas = forwardToReplicas.toString();
-            }
             const request = {
                 method: 'POST',
                 path: requestPath,
@@ -1997,20 +1997,24 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete the records but leave settings and index-specific API keys untouched.
+         * Delete all rules in the index.
          *
-         * @summary Delete all records from an index.
-         * @param clearObjects - The clearObjects object.
-         * @param clearObjects.indexName - Index on which to perform the request.
+         * @summary Delete all rules.
+         * @param clearRules - The clearRules object.
+         * @param clearRules.indexName - Index on which to perform the request.
+         * @param clearRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        clearObjects({ indexName }, requestOptions) {
+        clearRules({ indexName, forwardToReplicas }, requestOptions) {
             if (!indexName) {
-                throw new Error('Parameter `indexName` is required when calling `clearObjects`.');
+                throw new Error('Parameter `indexName` is required when calling `clearRules`.');
             }
-            const requestPath = '/1/indexes/{indexName}/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const requestPath = '/1/indexes/{indexName}/rules/clear'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
             const request = {
                 method: 'POST',
                 path: requestPath,
@@ -2020,19 +2024,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete all rules in the index.
+         * Delete all synonyms in the index.
          *
-         * @summary Delete all rules.
-         * @param clearRules - The clearRules object.
-         * @param clearRules.indexName - Index on which to perform the request.
-         * @param clearRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+         * @summary Delete all synonyms.
+         * @param clearSynonyms - The clearSynonyms object.
+         * @param clearSynonyms.indexName - Index on which to perform the request.
+         * @param clearSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        clearRules({ indexName, forwardToReplicas }, requestOptions) {
+        clearSynonyms({ indexName, forwardToReplicas }, requestOptions) {
             if (!indexName) {
-                throw new Error('Parameter `indexName` is required when calling `clearRules`.');
+                throw new Error('Parameter `indexName` is required when calling `clearSynonyms`.');
             }
-            const requestPath = '/1/indexes/{indexName}/rules/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const requestPath = '/1/indexes/{indexName}/synonyms/clear'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
             if (forwardToReplicas !== undefined) {
@@ -3305,28 +3309,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Search for synonyms.
          * @param searchSynonyms - The searchSynonyms object.
          * @param searchSynonyms.indexName - Index on which to perform the request.
-         * @param searchSynonyms.type - Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms).
-         * @param searchSynonyms.page - Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there\'s no pagination.
-         * @param searchSynonyms.hitsPerPage - Maximum number of hits per page.
          * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        searchSynonyms({ indexName, type, page, hitsPerPage, searchSynonymsParams, }, requestOptions) {
+        searchSynonyms({ indexName, searchSynonymsParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `searchSynonyms`.');
             }
             const requestPath = '/1/indexes/{indexName}/synonyms/search'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
-            if (type !== undefined) {
-                queryParameters.type = type.toString();
-            }
-            if (page !== undefined) {
-                queryParameters.page = page.toString();
-            }
-            if (hitsPerPage !== undefined) {
-                queryParameters.hitsPerPage = hitsPerPage.toString();
-            }
             const request = {
                 method: 'POST',
                 path: requestPath,

package/dist/algoliasearch.esm.browser.js

@@ -685,7 +685,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
 const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$4 = '5.0.0-alpha.97';
+const apiClientVersion$4 = '5.0.0-alpha.99';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -984,7 +984,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$3 = '5.0.0-alpha.97';
+const apiClientVersion$3 = '5.0.0-alpha.99';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1881,7 +1881,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$2 = '5.0.0-alpha.97';
+const apiClientVersion$2 = '5.0.0-alpha.99';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -2138,7 +2138,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$1 = '5.0.0-alpha.97';
+const apiClientVersion$1 = '5.0.0-alpha.99';
 function getDefaultHosts(appId) {
     return [
         {
@@ -2363,21 +2363,25 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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. 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 browseObjects.searchSynonymsParams - The `searchSynonyms` method parameters.
          * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
          */
-        browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }, requestOptions) {
+        browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }, requestOptions) {
             const params = {
+                page: 0,
+                ...searchSynonymsParams,
                 hitsPerPage: 1000,
-                ...browseSynonymsOptions,
             };
             return createIterablePromise({
                 func: (previousResponse) => {
                     return this.searchSynonyms({
-                        ...params,
                         indexName,
-                        page: previousResponse
-                            ? previousResponse.page + 1
-                            : browseSynonymsOptions.page || 0,
+                        searchSynonymsParams: {
+                            ...params,
+                            page: previousResponse
+                                ? previousResponse.page + 1
+                                : params.page,
+                        },
                     }, requestOptions);
                 },
                 validate: (response) => response.nbHits < params.hitsPerPage,
@@ -2651,24 +2655,20 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete all synonyms in the index.
+         * Delete the records but leave settings and index-specific API keys untouched.
          *
-         * @summary Delete all synonyms.
-         * @param clearAllSynonyms - The clearAllSynonyms object.
-         * @param clearAllSynonyms.indexName - Index on which to perform the request.
-         * @param clearAllSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+         * @summary Delete all records from an index.
+         * @param clearObjects - The clearObjects object.
+         * @param clearObjects.indexName - Index on which to perform the request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        clearAllSynonyms({ indexName, forwardToReplicas }, requestOptions) {
+        clearObjects({ indexName }, requestOptions) {
             if (!indexName) {
-                throw new Error('Parameter `indexName` is required when calling `clearAllSynonyms`.');
+                throw new Error('Parameter `indexName` is required when calling `clearObjects`.');
             }
-            const requestPath = '/1/indexes/{indexName}/synonyms/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const requestPath = '/1/indexes/{indexName}/clear'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
-            if (forwardToReplicas !== undefined) {
-                queryParameters.forwardToReplicas = forwardToReplicas.toString();
-            }
             const request = {
                 method: 'POST',
                 path: requestPath,
@@ -2678,20 +2678,24 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete the records but leave settings and index-specific API keys untouched.
+         * Delete all rules in the index.
          *
-         * @summary Delete all records from an index.
-         * @param clearObjects - The clearObjects object.
-         * @param clearObjects.indexName - Index on which to perform the request.
+         * @summary Delete all rules.
+         * @param clearRules - The clearRules object.
+         * @param clearRules.indexName - Index on which to perform the request.
+         * @param clearRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        clearObjects({ indexName }, requestOptions) {
+        clearRules({ indexName, forwardToReplicas }, requestOptions) {
             if (!indexName) {
-                throw new Error('Parameter `indexName` is required when calling `clearObjects`.');
+                throw new Error('Parameter `indexName` is required when calling `clearRules`.');
             }
-            const requestPath = '/1/indexes/{indexName}/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const requestPath = '/1/indexes/{indexName}/rules/clear'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
             const request = {
                 method: 'POST',
                 path: requestPath,
@@ -2701,19 +2705,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete all rules in the index.
+         * Delete all synonyms in the index.
          *
-         * @summary Delete all rules.
-         * @param clearRules - The clearRules object.
-         * @param clearRules.indexName - Index on which to perform the request.
-         * @param clearRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+         * @summary Delete all synonyms.
+         * @param clearSynonyms - The clearSynonyms object.
+         * @param clearSynonyms.indexName - Index on which to perform the request.
+         * @param clearSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        clearRules({ indexName, forwardToReplicas }, requestOptions) {
+        clearSynonyms({ indexName, forwardToReplicas }, requestOptions) {
             if (!indexName) {
-                throw new Error('Parameter `indexName` is required when calling `clearRules`.');
+                throw new Error('Parameter `indexName` is required when calling `clearSynonyms`.');
             }
-            const requestPath = '/1/indexes/{indexName}/rules/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const requestPath = '/1/indexes/{indexName}/synonyms/clear'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
             if (forwardToReplicas !== undefined) {
@@ -3986,28 +3990,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Search for synonyms.
          * @param searchSynonyms - The searchSynonyms object.
          * @param searchSynonyms.indexName - Index on which to perform the request.
-         * @param searchSynonyms.type - Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms).
-         * @param searchSynonyms.page - Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there\'s no pagination.
-         * @param searchSynonyms.hitsPerPage - Maximum number of hits per page.
          * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        searchSynonyms({ indexName, type, page, hitsPerPage, searchSynonymsParams, }, requestOptions) {
+        searchSynonyms({ indexName, searchSynonymsParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `searchSynonyms`.');
             }
             const requestPath = '/1/indexes/{indexName}/synonyms/search'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
-            if (type !== undefined) {
-                queryParameters.type = type.toString();
-            }
-            if (page !== undefined) {
-                queryParameters.page = page.toString();
-            }
-            if (hitsPerPage !== undefined) {
-                queryParameters.hitsPerPage = hitsPerPage.toString();
-            }
             const request = {
                 method: 'POST',
                 path: requestPath,