@algolia/client-search 5.0.0-alpha.4 → 5.0.0-alpha.40

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

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAY5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CA8Bd"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAY5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CA8Bd"}

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

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CAwBd"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CAwBd"}

package/dist/client-search.cjs.js

@@ -6,7 +6,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion = '5.0.0-alpha.4';
+const apiClientVersion = '5.0.0-alpha.40';
 function getDefaultHosts(appId) {
     return [
         {
@@ -169,19 +169,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Helper method that iterates on the `browse` method.
          * @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.browseParams - The `browse` parameters.
+         * @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.
          */
-        browseObjects({ indexName, browseRequest, ...browseObjectsOptions }, requestOptions) {
+        browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
             return clientCommon.createIterablePromise({
                 func: (previousResponse) => {
                     return this.browse({
                         indexName,
-                        browseRequest: {
+                        browseParams: {
                             cursor: previousResponse ? previousResponse.cursor : undefined,
-                            ...browseRequest,
+                            ...browseParams,
                         },
                     }, requestOptions);
                 },
@@ -196,7 +196,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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.
          */
@@ -227,7 +227,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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.
          */
@@ -383,6 +383,9 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!batchWriteParams) {
                 throw new Error('Parameter `batchWriteParams` is required when calling `batch`.');
             }
+            if (!batchWriteParams.requests) {
+                throw new Error('Parameter `batchWriteParams.requests` is required when calling `batch`.');
+            }
             const requestPath = '/1/indexes/{indexName}/batch'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
@@ -469,10 +472,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Retrieve all index content.
          * @param browse - The browse object.
          * @param browse.indexName - The index in which to perform the request.
-         * @param browse.browseRequest - The browseRequest object.
+         * @param browse.browseParams - The browseParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        browse({ indexName, browseRequest }, requestOptions) {
+        browse({ indexName, browseParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `browse`.');
             }
@@ -484,7 +487,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: browseRequest ? browseRequest : {},
+                data: browseParams ? browseParams : {},
             };
             return transporter.request(request, requestOptions);
         },
@@ -618,15 +621,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Delete all records matching the query.
          * @param deleteBy - The deleteBy object.
          * @param deleteBy.indexName - The index in which to perform the request.
-         * @param deleteBy.searchParams - The searchParams object.
+         * @param deleteBy.deleteByParams - The deleteByParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        deleteBy({ indexName, searchParams }, requestOptions) {
+        deleteBy({ indexName, deleteByParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `deleteBy`.');
             }
-            if (!searchParams) {
-                throw new Error('Parameter `searchParams` is required when calling `deleteBy`.');
+            if (!deleteByParams) {
+                throw new Error('Parameter `deleteByParams` is required when calling `deleteBy`.');
             }
             const requestPath = '/1/indexes/{indexName}/deleteByQuery'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
@@ -636,7 +639,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: searchParams,
+                data: deleteByParams,
             };
             return transporter.request(request, requestOptions);
         },
@@ -875,7 +878,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param getLogs.type - Type of log entries to retrieve. When omitted, all log entries are retrieved.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getLogs({ offset, length, indexName, type }, requestOptions) {
+        getLogs({ offset, length, indexName, type } = {}, requestOptions = undefined) {
             const requestPath = '/1/logs';
             const headers = {};
             const queryParameters = {};
@@ -1137,7 +1140,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param hasPendingMappings.getClusters - If the clusters pending mapping state should be on the response.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        hasPendingMappings({ getClusters }, requestOptions) {
+        hasPendingMappings({ getClusters } = {}, requestOptions = undefined) {
             const requestPath = '/1/clusters/mapping/pending';
             const headers = {};
             const queryParameters = {};
@@ -1196,7 +1199,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param listIndices.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        listIndices({ page }, requestOptions) {
+        listIndices({ page } = {}, requestOptions = undefined) {
             const requestPath = '/1/indexes';
             const headers = {};
             const queryParameters = {};
@@ -1220,7 +1223,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param listUserIds.hitsPerPage - Maximum number of objects to retrieve.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        listUserIds({ page, hitsPerPage }, requestOptions) {
+        listUserIds({ page, hitsPerPage } = {}, requestOptions = undefined) {
             const requestPath = '/1/clusters/mapping';
             const headers = {};
             const queryParameters = {};
@@ -1305,19 +1308,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param partialUpdateObject - The partialUpdateObject object.
          * @param partialUpdateObject.indexName - The index in which to perform the request.
          * @param partialUpdateObject.objectID - Unique identifier of an object.
-         * @param partialUpdateObject.attributeToUpdate - List of attributes to update.
+         * @param partialUpdateObject.attributesToUpdate - Map of attribute(s) to update.
          * @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        partialUpdateObject({ indexName, objectID, attributeToUpdate, createIfNotExists, }, requestOptions) {
+        partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `partialUpdateObject`.');
             }
             if (!objectID) {
                 throw new Error('Parameter `objectID` is required when calling `partialUpdateObject`.');
             }
-            if (!attributeToUpdate) {
-                throw new Error('Parameter `attributeToUpdate` is required when calling `partialUpdateObject`.');
+            if (!attributesToUpdate) {
+                throw new Error('Parameter `attributesToUpdate` is required when calling `partialUpdateObject`.');
             }
             const requestPath = '/1/indexes/{indexName}/{objectID}/partial'
                 .replace('{indexName}', encodeURIComponent(indexName))
@@ -1332,7 +1335,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: attributeToUpdate,
+                data: attributesToUpdate,
             };
             return transporter.request(request, requestOptions);
         },
@@ -1533,17 +1536,17 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Save a batch of rules.
          * @param saveRules - The saveRules object.
          * @param saveRules.indexName - The index in which to perform the request.
-         * @param saveRules.rule - The rule object.
+         * @param saveRules.rules - The rules object.
          * @param saveRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
          * @param saveRules.clearExistingRules - When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        saveRules({ indexName, rule, forwardToReplicas, clearExistingRules, }, requestOptions) {
+        saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `saveRules`.');
             }
-            if (!rule) {
-                throw new Error('Parameter `rule` is required when calling `saveRules`.');
+            if (!rules) {
+                throw new Error('Parameter `rules` is required when calling `saveRules`.');
             }
             const requestPath = '/1/indexes/{indexName}/rules/batch'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
@@ -1559,7 +1562,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: rule,
+                data: rules,
             };
             return transporter.request(request, requestOptions);
         },