@algolia/client-search 5.0.0-alpha.91 → 5.0.0-alpha.98

package/dist/client-search.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 = '5.0.0-alpha.91';
+const apiClientVersion = '5.0.0-alpha.98';
 function getDefaultHosts(appId) {
     return [
         {
@@ -229,21 +229,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,
@@ -517,24 +521,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,
@@ -544,20 +544,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,
@@ -567,19 +571,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) {
@@ -597,14 +601,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * This method allow you to send requests to the Algolia REST API.
          *
          * @summary Send requests to the Algolia REST API.
-         * @param del - The del object.
-         * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param del.parameters - Query parameters to apply to the current query.
+         * @param customDelete - The customDelete object.
+         * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customDelete.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        del({ path, parameters }, requestOptions) {
+        customDelete({ path, parameters }, requestOptions) {
             if (!path) {
-                throw new Error('Parameter `path` is required when calling `del`.');
+                throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
             const requestPath = '/1{path}'.replace('{path}', path);
             const headers = {};
@@ -617,6 +621,82 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param customGet - The customGet object.
+         * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customGet.parameters - Query parameters to apply to the current query.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customGet({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customGet`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param customPost - The customPost object.
+         * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPost.parameters - Query parameters to apply to the current query.
+         * @param customPost.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPost({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPost`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param customPut - The customPut object.
+         * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPut.parameters - Query parameters to apply to the current query.
+         * @param customPut.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPut({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPut`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Delete an existing API key. The request must be authenticated with the admin API key.
          *
@@ -809,30 +889,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             };
             return transporter.request(request, requestOptions);
         },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param get - The get object.
-         * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param get.parameters - Query parameters to apply to the current query.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        get({ path, parameters }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `get`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
         /**
          * Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
          *
@@ -1368,58 +1424,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             };
             return transporter.request(request, requestOptions);
         },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param post - The post object.
-         * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param post.parameters - Query parameters to apply to the current query.
-         * @param post.body - Parameters to send with the custom request.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        post({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `post`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'POST',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: body ? body : {},
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param put - The put object.
-         * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param put.parameters - Query parameters to apply to the current query.
-         * @param put.body - Parameters to send with the custom request.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        put({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `put`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'PUT',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: body ? body : {},
-            };
-            return transporter.request(request, requestOptions);
-        },
         /**
          * Remove a userID and its associated data from the multi-clusters.
          *
@@ -1852,28 +1856,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,