@algolia/client-search 5.52.1 → 5.54.0

package/dist/src/searchClient.js

@@ -5,9 +5,10 @@ import {
   createIterablePromise,
   createTransporter,
   getAlgoliaAgent,
-  shuffle
+  shuffle,
+  validateRequired
 } from "@algolia/client-common";
-var apiClientVersion = "5.52.1";
+var apiClientVersion = "5.54.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -272,7 +273,7 @@ function createSearchClient({
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }, requestOptions) {
       const params = {
         ...searchRulesParams,
-        hitsPerPage: searchRulesParams?.hitsPerPage || 1e3
+        hitsPerPage: (searchRulesParams == null ? void 0 : searchRulesParams.hitsPerPage) || 1e3
       };
       return createIterablePromise({
         func: (previousResponse) => {
@@ -309,7 +310,7 @@ function createSearchClient({
     }, requestOptions) {
       const params = {
         ...searchSynonymsParams,
-        page: searchSynonymsParams?.page || 0,
+        page: (searchSynonymsParams == null ? void 0 : searchSynonymsParams.page) || 0,
         hitsPerPage: 1e3
       };
       return createIterablePromise({
@@ -341,9 +342,17 @@ function createSearchClient({
      * @param chunkedBatch.action - The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
      * @param chunkedBatch.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param chunkedBatch.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    async chunkedBatch({ indexName, objects, action = "addObject", waitForTasks, batchSize = 1e3 }, requestOptions) {
+    async chunkedBatch({
+      indexName,
+      objects,
+      action = "addObject",
+      waitForTasks,
+      batchSize = 1e3,
+      maxRetries = 100
+    }, requestOptions) {
       let requests = [];
       const responses = [];
       const objectEntries = objects.entries();
@@ -356,7 +365,7 @@ function createSearchClient({
       }
       if (waitForTasks) {
         for (const resp of responses) {
-          await this.waitForTask({ indexName, taskID: resp.taskID });
+          await this.waitForTask({ indexName, taskID: resp.taskID, maxRetries });
         }
       }
       return responses;
@@ -370,11 +379,12 @@ function createSearchClient({
      * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
+     * @param saveObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    async saveObjects({ indexName, objects, waitForTasks, batchSize }, requestOptions) {
+    async saveObjects({ indexName, objects, waitForTasks, batchSize, maxRetries }, requestOptions) {
       return await this.chunkedBatch(
-        { indexName, objects, action: "addObject", waitForTasks, batchSize },
+        { indexName, objects, action: "addObject", waitForTasks, batchSize, maxRetries },
         requestOptions
       );
     },
@@ -387,16 +397,18 @@ function createSearchClient({
      * @param deleteObjects.objectIDs - The objectIDs to delete.
      * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param deleteObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
+     * @param deleteObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    async deleteObjects({ indexName, objectIDs, waitForTasks, batchSize }, requestOptions) {
+    async deleteObjects({ indexName, objectIDs, waitForTasks, batchSize, maxRetries }, requestOptions) {
       return await this.chunkedBatch(
         {
           indexName,
           objects: objectIDs.map((objectID) => ({ objectID })),
           action: "deleteObject",
           waitForTasks,
-          batchSize
+          batchSize,
+          maxRetries
         },
         requestOptions
       );
@@ -411,16 +423,18 @@ function createSearchClient({
      * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail.
      * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
+     * @param partialUpdateObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    async partialUpdateObjects({ indexName, objects, createIfNotExists, waitForTasks, batchSize }, requestOptions) {
+    async partialUpdateObjects({ indexName, objects, createIfNotExists, waitForTasks, batchSize, maxRetries }, requestOptions) {
       return await this.chunkedBatch(
         {
           indexName,
           objects,
           action: createIfNotExists ? "partialUpdateObject" : "partialUpdateObjectNoCreate",
           batchSize,
-          waitForTasks
+          waitForTasks,
+          maxRetries
         },
         requestOptions
       );
@@ -435,9 +449,10 @@ function createSearchClient({
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
      * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+     * @param replaceAllObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
-    async replaceAllObjects({ indexName, objects, batchSize, scopes }, requestOptions) {
+    async replaceAllObjects({ indexName, objects, batchSize, scopes, maxRetries = 100 }, requestOptions) {
       const randomSuffix = Math.floor(Math.random() * 1e6) + 1e5;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
       if (scopes === void 0) {
@@ -456,12 +471,13 @@ function createSearchClient({
           requestOptions
         );
         const batchResponses = await this.chunkedBatch(
-          { indexName: tmpIndexName, objects, waitForTasks: true, batchSize },
+          { indexName: tmpIndexName, objects, waitForTasks: true, batchSize, maxRetries },
           requestOptions
         );
         await this.waitForTask({
           indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID
+          taskID: copyOperationResponse.taskID,
+          maxRetries
         });
         copyOperationResponse = await this.operationIndex(
           {
@@ -476,7 +492,8 @@ function createSearchClient({
         );
         await this.waitForTask({
           indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID
+          taskID: copyOperationResponse.taskID,
+          maxRetries
         });
         const moveOperationResponse = await this.operationIndex(
           {
@@ -487,7 +504,8 @@ function createSearchClient({
         );
         await this.waitForTask({
           indexName: tmpIndexName,
-          taskID: moveOperationResponse.taskID
+          taskID: moveOperationResponse.taskID,
+          maxRetries
         });
         return { copyOperationResponse, batchResponses, moveOperationResponse };
       } catch (error) {
@@ -537,12 +555,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addApiKey(apiKey, requestOptions) {
-      if (!apiKey) {
-        throw new Error("Parameter `apiKey` is required when calling `addApiKey`.");
-      }
-      if (!apiKey.acl) {
-        throw new Error("Parameter `apiKey.acl` is required when calling `addApiKey`.");
-      }
+      validateRequired("apiKey", "addApiKey", apiKey);
+      validateRequired("apiKey.acl", "addApiKey", apiKey.acl);
       const requestPath = "/1/keys";
       const headers = {};
       const queryParameters = {};
@@ -567,15 +581,9 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addOrUpdateObject({ indexName, objectID, body }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `addOrUpdateObject`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `addOrUpdateObject`.");
-      }
-      if (!body) {
-        throw new Error("Parameter `body` is required when calling `addOrUpdateObject`.");
-      }
+      validateRequired("indexName", "addOrUpdateObject", indexName);
+      validateRequired("objectID", "addOrUpdateObject", objectID);
+      validateRequired("body", "addOrUpdateObject", body);
       const requestPath = "/1/indexes/{indexName}/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -597,12 +605,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     appendSource(source, requestOptions) {
-      if (!source) {
-        throw new Error("Parameter `source` is required when calling `appendSource`.");
-      }
-      if (!source.source) {
-        throw new Error("Parameter `source.source` is required when calling `appendSource`.");
-      }
+      validateRequired("source", "appendSource", source);
+      validateRequired("source.source", "appendSource", source.source);
       const requestPath = "/1/security/sources/append";
       const headers = {};
       const queryParameters = {};
@@ -628,15 +632,9 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     assignUserId({ xAlgoliaUserID, assignUserIdParams }, requestOptions) {
-      if (!xAlgoliaUserID) {
-        throw new Error("Parameter `xAlgoliaUserID` is required when calling `assignUserId`.");
-      }
-      if (!assignUserIdParams) {
-        throw new Error("Parameter `assignUserIdParams` is required when calling `assignUserId`.");
-      }
-      if (!assignUserIdParams.cluster) {
-        throw new Error("Parameter `assignUserIdParams.cluster` is required when calling `assignUserId`.");
-      }
+      validateRequired("xAlgoliaUserID", "assignUserId", xAlgoliaUserID);
+      validateRequired("assignUserIdParams", "assignUserId", assignUserIdParams);
+      validateRequired("assignUserIdParams.cluster", "assignUserId", assignUserIdParams.cluster);
       const requestPath = "/1/clusters/mapping";
       const headers = {};
       const queryParameters = {};
@@ -663,15 +661,9 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batch({ indexName, batchWriteParams }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `batch`.");
-      }
-      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`.");
-      }
+      validateRequired("indexName", "batch", indexName);
+      validateRequired("batchWriteParams", "batch", batchWriteParams);
+      validateRequired("batchWriteParams.requests", "batch", batchWriteParams.requests);
       const requestPath = "/1/indexes/{indexName}/batch".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -697,18 +689,10 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }, requestOptions) {
-      if (!xAlgoliaUserID) {
-        throw new Error("Parameter `xAlgoliaUserID` is required when calling `batchAssignUserIds`.");
-      }
-      if (!batchAssignUserIdsParams) {
-        throw new Error("Parameter `batchAssignUserIdsParams` is required when calling `batchAssignUserIds`.");
-      }
-      if (!batchAssignUserIdsParams.cluster) {
-        throw new Error("Parameter `batchAssignUserIdsParams.cluster` is required when calling `batchAssignUserIds`.");
-      }
-      if (!batchAssignUserIdsParams.users) {
-        throw new Error("Parameter `batchAssignUserIdsParams.users` is required when calling `batchAssignUserIds`.");
-      }
+      validateRequired("xAlgoliaUserID", "batchAssignUserIds", xAlgoliaUserID);
+      validateRequired("batchAssignUserIdsParams", "batchAssignUserIds", batchAssignUserIdsParams);
+      validateRequired("batchAssignUserIdsParams.cluster", "batchAssignUserIds", batchAssignUserIdsParams.cluster);
+      validateRequired("batchAssignUserIdsParams.users", "batchAssignUserIds", batchAssignUserIdsParams.users);
       const requestPath = "/1/clusters/mapping/batch";
       const headers = {};
       const queryParameters = {};
@@ -735,17 +719,13 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }, requestOptions) {
-      if (!dictionaryName) {
-        throw new Error("Parameter `dictionaryName` is required when calling `batchDictionaryEntries`.");
-      }
-      if (!batchDictionaryEntriesParams) {
-        throw new Error("Parameter `batchDictionaryEntriesParams` is required when calling `batchDictionaryEntries`.");
-      }
-      if (!batchDictionaryEntriesParams.requests) {
-        throw new Error(
-          "Parameter `batchDictionaryEntriesParams.requests` is required when calling `batchDictionaryEntries`."
-        );
-      }
+      validateRequired("dictionaryName", "batchDictionaryEntries", dictionaryName);
+      validateRequired("batchDictionaryEntriesParams", "batchDictionaryEntries", batchDictionaryEntriesParams);
+      validateRequired(
+        "batchDictionaryEntriesParams.requests",
+        "batchDictionaryEntries",
+        batchDictionaryEntriesParams.requests
+      );
       const requestPath = "/1/dictionaries/{dictionaryName}/batch".replace(
         "{dictionaryName}",
         encodeURIComponent(dictionaryName)
@@ -772,9 +752,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     browse({ indexName, browseParams }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `browse`.");
-      }
+      validateRequired("indexName", "browse", indexName);
       const requestPath = "/1/indexes/{indexName}/browse".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -798,9 +776,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     clearObjects({ indexName }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `clearObjects`.");
-      }
+      validateRequired("indexName", "clearObjects", indexName);
       const requestPath = "/1/indexes/{indexName}/clear".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -823,9 +799,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     clearRules({ indexName, forwardToReplicas }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `clearRules`.");
-      }
+      validateRequired("indexName", "clearRules", indexName);
       const requestPath = "/1/indexes/{indexName}/rules/clear".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -851,9 +825,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     clearSynonyms({ indexName, forwardToReplicas }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `clearSynonyms`.");
-      }
+      validateRequired("indexName", "clearSynonyms", indexName);
       const requestPath = "/1/indexes/{indexName}/synonyms/clear".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -876,9 +848,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     customDelete({ path, parameters }, requestOptions) {
-      if (!path) {
-        throw new Error("Parameter `path` is required when calling `customDelete`.");
-      }
+      validateRequired("path", "customDelete", path);
       const requestPath = "/{path}".replace("{path}", path);
       const headers = {};
       const queryParameters = parameters ? parameters : {};
@@ -898,9 +868,7 @@ function createSearchClient({
      * @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`.");
-      }
+      validateRequired("path", "customGet", path);
       const requestPath = "/{path}".replace("{path}", path);
       const headers = {};
       const queryParameters = parameters ? parameters : {};
@@ -921,9 +889,7 @@ function createSearchClient({
      * @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`.");
-      }
+      validateRequired("path", "customPost", path);
       const requestPath = "/{path}".replace("{path}", path);
       const headers = {};
       const queryParameters = parameters ? parameters : {};
@@ -945,9 +911,7 @@ function createSearchClient({
      * @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`.");
-      }
+      validateRequired("path", "customPut", path);
       const requestPath = "/{path}".replace("{path}", path);
       const headers = {};
       const queryParameters = parameters ? parameters : {};
@@ -970,9 +934,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteApiKey({ key }, requestOptions) {
-      if (!key) {
-        throw new Error("Parameter `key` is required when calling `deleteApiKey`.");
-      }
+      validateRequired("key", "deleteApiKey", key);
       const requestPath = "/1/keys/{key}".replace("{key}", encodeURIComponent(key));
       const headers = {};
       const queryParameters = {};
@@ -995,12 +957,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteBy({ indexName, deleteByParams }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `deleteBy`.");
-      }
-      if (!deleteByParams) {
-        throw new Error("Parameter `deleteByParams` is required when calling `deleteBy`.");
-      }
+      validateRequired("indexName", "deleteBy", indexName);
+      validateRequired("deleteByParams", "deleteBy", deleteByParams);
       const requestPath = "/1/indexes/{indexName}/deleteByQuery".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -1023,9 +981,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteIndex({ indexName }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `deleteIndex`.");
-      }
+      validateRequired("indexName", "deleteIndex", indexName);
       const requestPath = "/1/indexes/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -1048,12 +1004,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteObject({ indexName, objectID }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `deleteObject`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `deleteObject`.");
-      }
+      validateRequired("indexName", "deleteObject", indexName);
+      validateRequired("objectID", "deleteObject", objectID);
       const requestPath = "/1/indexes/{indexName}/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1077,12 +1029,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteRule({ indexName, objectID, forwardToReplicas }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `deleteRule`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `deleteRule`.");
-      }
+      validateRequired("indexName", "deleteRule", indexName);
+      validateRequired("objectID", "deleteRule", objectID);
       const requestPath = "/1/indexes/{indexName}/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1107,9 +1055,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteSource({ source }, requestOptions) {
-      if (!source) {
-        throw new Error("Parameter `source` is required when calling `deleteSource`.");
-      }
+      validateRequired("source", "deleteSource", source);
       const requestPath = "/1/security/sources/{source}".replace("{source}", encodeURIComponent(source));
       const headers = {};
       const queryParameters = {};
@@ -1133,12 +1079,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteSynonym({ indexName, objectID, forwardToReplicas }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `deleteSynonym`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `deleteSynonym`.");
-      }
+      validateRequired("indexName", "deleteSynonym", indexName);
+      validateRequired("objectID", "deleteSynonym", objectID);
       const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1163,9 +1105,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getApiKey({ key }, requestOptions) {
-      if (!key) {
-        throw new Error("Parameter `key` is required when calling `getApiKey`.");
-      }
+      validateRequired("key", "getApiKey", key);
       const requestPath = "/1/keys/{key}".replace("{key}", encodeURIComponent(key));
       const headers = {};
       const queryParameters = {};
@@ -1187,9 +1127,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getAppTask({ taskID }, requestOptions) {
-      if (!taskID) {
-        throw new Error("Parameter `taskID` is required when calling `getAppTask`.");
-      }
+      validateRequired("taskID", "getAppTask", taskID);
       const requestPath = "/1/task/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
       const headers = {};
       const queryParameters = {};
@@ -1287,12 +1225,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getObject({ indexName, objectID, attributesToRetrieve }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `getObject`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `getObject`.");
-      }
+      validateRequired("indexName", "getObject", indexName);
+      validateRequired("objectID", "getObject", objectID);
       const requestPath = "/1/indexes/{indexName}/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1316,12 +1250,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getObjects(getObjectsParams, requestOptions) {
-      if (!getObjectsParams) {
-        throw new Error("Parameter `getObjectsParams` is required when calling `getObjects`.");
-      }
-      if (!getObjectsParams.requests) {
-        throw new Error("Parameter `getObjectsParams.requests` is required when calling `getObjects`.");
-      }
+      validateRequired("getObjectsParams", "getObjects", getObjectsParams);
+      validateRequired("getObjectsParams.requests", "getObjects", getObjectsParams.requests);
       const requestPath = "/1/indexes/*/objects";
       const headers = {};
       const queryParameters = {};
@@ -1347,12 +1277,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getRule({ indexName, objectID }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `getRule`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `getRule`.");
-      }
+      validateRequired("indexName", "getRule", indexName);
+      validateRequired("objectID", "getRule", objectID);
       const requestPath = "/1/indexes/{indexName}/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1375,9 +1301,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getSettings({ indexName, getVersion }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `getSettings`.");
-      }
+      validateRequired("indexName", "getSettings", indexName);
       const requestPath = "/1/indexes/{indexName}/settings".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -1422,12 +1346,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getSynonym({ indexName, objectID }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `getSynonym`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `getSynonym`.");
-      }
+      validateRequired("indexName", "getSynonym", indexName);
+      validateRequired("objectID", "getSynonym", objectID);
       const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1450,12 +1370,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTask({ indexName, taskID }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `getTask`.");
-      }
-      if (!taskID) {
-        throw new Error("Parameter `taskID` is required when calling `getTask`.");
-      }
+      validateRequired("indexName", "getTask", indexName);
+      validateRequired("taskID", "getTask", taskID);
       const requestPath = "/1/indexes/{indexName}/task/{taskID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{taskID}", encodeURIComponent(taskID));
       const headers = {};
       const queryParameters = {};
@@ -1500,9 +1416,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getUserId({ userID }, requestOptions) {
-      if (!userID) {
-        throw new Error("Parameter `userID` is required when calling `getUserId`.");
-      }
+      validateRequired("userID", "getUserId", userID);
       const requestPath = "/1/clusters/mapping/{userID}".replace("{userID}", encodeURIComponent(userID));
       const headers = {};
       const queryParameters = {};
@@ -1647,12 +1561,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     multipleBatch(batchParams, requestOptions) {
-      if (!batchParams) {
-        throw new Error("Parameter `batchParams` is required when calling `multipleBatch`.");
-      }
-      if (!batchParams.requests) {
-        throw new Error("Parameter `batchParams.requests` is required when calling `multipleBatch`.");
-      }
+      validateRequired("batchParams", "multipleBatch", batchParams);
+      validateRequired("batchParams.requests", "multipleBatch", batchParams.requests);
       const requestPath = "/1/indexes/*/batch";
       const headers = {};
       const queryParameters = {};
@@ -1676,18 +1586,10 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     operationIndex({ indexName, operationIndexParams }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `operationIndex`.");
-      }
-      if (!operationIndexParams) {
-        throw new Error("Parameter `operationIndexParams` is required when calling `operationIndex`.");
-      }
-      if (!operationIndexParams.operation) {
-        throw new Error("Parameter `operationIndexParams.operation` is required when calling `operationIndex`.");
-      }
-      if (!operationIndexParams.destination) {
-        throw new Error("Parameter `operationIndexParams.destination` is required when calling `operationIndex`.");
-      }
+      validateRequired("indexName", "operationIndex", indexName);
+      validateRequired("operationIndexParams", "operationIndex", operationIndexParams);
+      validateRequired("operationIndexParams.operation", "operationIndex", operationIndexParams.operation);
+      validateRequired("operationIndexParams.destination", "operationIndex", operationIndexParams.destination);
       const requestPath = "/1/indexes/{indexName}/operation".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -1713,15 +1615,9 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter 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 (!attributesToUpdate) {
-        throw new Error("Parameter `attributesToUpdate` is required when calling `partialUpdateObject`.");
-      }
+      validateRequired("indexName", "partialUpdateObject", indexName);
+      validateRequired("objectID", "partialUpdateObject", objectID);
+      validateRequired("attributesToUpdate", "partialUpdateObject", attributesToUpdate);
       const requestPath = "/1/indexes/{indexName}/{objectID}/partial".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1749,9 +1645,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     removeUserId({ userID }, requestOptions) {
-      if (!userID) {
-        throw new Error("Parameter `userID` is required when calling `removeUserId`.");
-      }
+      validateRequired("userID", "removeUserId", userID);
       const requestPath = "/1/clusters/mapping/{userID}".replace("{userID}", encodeURIComponent(userID));
       const headers = {};
       const queryParameters = {};
@@ -1773,9 +1667,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     replaceSources({ source }, requestOptions) {
-      if (!source) {
-        throw new Error("Parameter `source` is required when calling `replaceSources`.");
-      }
+      validateRequired("source", "replaceSources", source);
       const requestPath = "/1/security/sources";
       const headers = {};
       const queryParameters = {};
@@ -1798,9 +1690,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     restoreApiKey({ key }, requestOptions) {
-      if (!key) {
-        throw new Error("Parameter `key` is required when calling `restoreApiKey`.");
-      }
+      validateRequired("key", "restoreApiKey", key);
       const requestPath = "/1/keys/{key}/restore".replace("{key}", encodeURIComponent(key));
       const headers = {};
       const queryParameters = {};
@@ -1823,12 +1713,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveObject({ indexName, body }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `saveObject`.");
-      }
-      if (!body) {
-        throw new Error("Parameter `body` is required when calling `saveObject`.");
-      }
+      validateRequired("indexName", "saveObject", indexName);
+      validateRequired("body", "saveObject", body);
       const requestPath = "/1/indexes/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -1854,21 +1740,11 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveRule({ indexName, objectID, rule, forwardToReplicas }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `saveRule`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `saveRule`.");
-      }
-      if (!rule) {
-        throw new Error("Parameter `rule` is required when calling `saveRule`.");
-      }
-      if (!rule.objectID) {
-        throw new Error("Parameter `rule.objectID` is required when calling `saveRule`.");
-      }
-      if (!rule.consequence) {
-        throw new Error("Parameter `rule.consequence` is required when calling `saveRule`.");
-      }
+      validateRequired("indexName", "saveRule", indexName);
+      validateRequired("objectID", "saveRule", objectID);
+      validateRequired("rule", "saveRule", rule);
+      validateRequired("rule.objectID", "saveRule", rule.objectID);
+      validateRequired("rule.consequence", "saveRule", rule.consequence);
       const requestPath = "/1/indexes/{indexName}/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1897,12 +1773,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `saveRules`.");
-      }
-      if (!rules) {
-        throw new Error("Parameter `rules` is required when calling `saveRules`.");
-      }
+      validateRequired("indexName", "saveRules", indexName);
+      validateRequired("rules", "saveRules", rules);
       const requestPath = "/1/indexes/{indexName}/rules/batch".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -1934,21 +1806,11 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `saveSynonym`.");
-      }
-      if (!objectID) {
-        throw new Error("Parameter `objectID` is required when calling `saveSynonym`.");
-      }
-      if (!synonymHit) {
-        throw new Error("Parameter `synonymHit` is required when calling `saveSynonym`.");
-      }
-      if (!synonymHit.objectID) {
-        throw new Error("Parameter `synonymHit.objectID` is required when calling `saveSynonym`.");
-      }
-      if (!synonymHit.type) {
-        throw new Error("Parameter `synonymHit.type` is required when calling `saveSynonym`.");
-      }
+      validateRequired("indexName", "saveSynonym", indexName);
+      validateRequired("objectID", "saveSynonym", objectID);
+      validateRequired("synonymHit", "saveSynonym", synonymHit);
+      validateRequired("synonymHit.objectID", "saveSynonym", synonymHit.objectID);
+      validateRequired("synonymHit.type", "saveSynonym", synonymHit.type);
       const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
       const headers = {};
       const queryParameters = {};
@@ -1977,12 +1839,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `saveSynonyms`.");
-      }
-      if (!synonymHit) {
-        throw new Error("Parameter `synonymHit` is required when calling `saveSynonyms`.");
-      }
+      validateRequired("indexName", "saveSynonyms", indexName);
+      validateRequired("synonymHit", "saveSynonyms", synonymHit);
       const requestPath = "/1/indexes/{indexName}/synonyms/batch".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -2031,12 +1889,8 @@ function createSearchClient({
         };
         searchMethodParams = newSignatureRequest;
       }
-      if (!searchMethodParams) {
-        throw new Error("Parameter `searchMethodParams` is required when calling `search`.");
-      }
-      if (!searchMethodParams.requests) {
-        throw new Error("Parameter `searchMethodParams.requests` is required when calling `search`.");
-      }
+      validateRequired("searchMethodParams", "search", searchMethodParams);
+      validateRequired("searchMethodParams.requests", "search", searchMethodParams.requests);
       const requestPath = "/1/indexes/*/queries";
       const headers = {};
       const queryParameters = {};
@@ -2062,19 +1916,13 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }, requestOptions) {
-      if (!dictionaryName) {
-        throw new Error("Parameter `dictionaryName` is required when calling `searchDictionaryEntries`.");
-      }
-      if (!searchDictionaryEntriesParams) {
-        throw new Error(
-          "Parameter `searchDictionaryEntriesParams` is required when calling `searchDictionaryEntries`."
-        );
-      }
-      if (!searchDictionaryEntriesParams.query) {
-        throw new Error(
-          "Parameter `searchDictionaryEntriesParams.query` is required when calling `searchDictionaryEntries`."
-        );
-      }
+      validateRequired("dictionaryName", "searchDictionaryEntries", dictionaryName);
+      validateRequired("searchDictionaryEntriesParams", "searchDictionaryEntries", searchDictionaryEntriesParams);
+      validateRequired(
+        "searchDictionaryEntriesParams.query",
+        "searchDictionaryEntries",
+        searchDictionaryEntriesParams.query
+      );
       const requestPath = "/1/dictionaries/{dictionaryName}/search".replace(
         "{dictionaryName}",
         encodeURIComponent(dictionaryName)
@@ -2104,12 +1952,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `searchForFacetValues`.");
-      }
-      if (!facetName) {
-        throw new Error("Parameter `facetName` is required when calling `searchForFacetValues`.");
-      }
+      validateRequired("indexName", "searchForFacetValues", indexName);
+      validateRequired("facetName", "searchForFacetValues", facetName);
       const requestPath = "/1/indexes/{indexName}/facets/{facetName}/query".replace("{indexName}", encodeURIComponent(indexName)).replace("{facetName}", encodeURIComponent(facetName));
       const headers = {};
       const queryParameters = {};
@@ -2135,9 +1979,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchRules({ indexName, searchRulesParams }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `searchRules`.");
-      }
+      validateRequired("indexName", "searchRules", indexName);
       const requestPath = "/1/indexes/{indexName}/rules/search".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -2163,9 +2005,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchSingleIndex({ indexName, searchParams }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `searchSingleIndex`.");
-      }
+      validateRequired("indexName", "searchSingleIndex", indexName);
       const requestPath = "/1/indexes/{indexName}/query".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -2191,9 +2031,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchSynonyms({ indexName, searchSynonymsParams }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `searchSynonyms`.");
-      }
+      validateRequired("indexName", "searchSynonyms", indexName);
       const requestPath = "/1/indexes/{indexName}/synonyms/search".replace(
         "{indexName}",
         encodeURIComponent(indexName)
@@ -2222,12 +2060,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchUserIds(searchUserIdsParams, requestOptions) {
-      if (!searchUserIdsParams) {
-        throw new Error("Parameter `searchUserIdsParams` is required when calling `searchUserIds`.");
-      }
-      if (!searchUserIdsParams.query) {
-        throw new Error("Parameter `searchUserIdsParams.query` is required when calling `searchUserIds`.");
-      }
+      validateRequired("searchUserIdsParams", "searchUserIds", searchUserIdsParams);
+      validateRequired("searchUserIdsParams.query", "searchUserIds", searchUserIdsParams.query);
       const requestPath = "/1/clusters/mapping/search";
       const headers = {};
       const queryParameters = {};
@@ -2251,14 +2085,12 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     setDictionarySettings(dictionarySettingsParams, requestOptions) {
-      if (!dictionarySettingsParams) {
-        throw new Error("Parameter `dictionarySettingsParams` is required when calling `setDictionarySettings`.");
-      }
-      if (!dictionarySettingsParams.disableStandardEntries) {
-        throw new Error(
-          "Parameter `dictionarySettingsParams.disableStandardEntries` is required when calling `setDictionarySettings`."
-        );
-      }
+      validateRequired("dictionarySettingsParams", "setDictionarySettings", dictionarySettingsParams);
+      validateRequired(
+        "dictionarySettingsParams.disableStandardEntries",
+        "setDictionarySettings",
+        dictionarySettingsParams.disableStandardEntries
+      );
       const requestPath = "/1/dictionaries/*/settings";
       const headers = {};
       const queryParameters = {};
@@ -2283,12 +2115,8 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     setSettings({ indexName, indexSettings, forwardToReplicas }, requestOptions) {
-      if (!indexName) {
-        throw new Error("Parameter `indexName` is required when calling `setSettings`.");
-      }
-      if (!indexSettings) {
-        throw new Error("Parameter `indexSettings` is required when calling `setSettings`.");
-      }
+      validateRequired("indexName", "setSettings", indexName);
+      validateRequired("indexSettings", "setSettings", indexSettings);
       const requestPath = "/1/indexes/{indexName}/settings".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
@@ -2315,15 +2143,9 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     updateApiKey({ key, apiKey }, requestOptions) {
-      if (!key) {
-        throw new Error("Parameter `key` is required when calling `updateApiKey`.");
-      }
-      if (!apiKey) {
-        throw new Error("Parameter `apiKey` is required when calling `updateApiKey`.");
-      }
-      if (!apiKey.acl) {
-        throw new Error("Parameter `apiKey.acl` is required when calling `updateApiKey`.");
-      }
+      validateRequired("key", "updateApiKey", key);
+      validateRequired("apiKey", "updateApiKey", apiKey);
+      validateRequired("apiKey.acl", "updateApiKey", apiKey.acl);
       const requestPath = "/1/keys/{key}".replace("{key}", encodeURIComponent(key));
       const headers = {};
       const queryParameters = {};
@@ -2342,7 +2164,4 @@ export {
   apiClientVersion,
   createSearchClient
 };
-//# sourceMappingURL=searchClient.js.mapClientVersion,
-  createSearchClient
-};
 //# sourceMappingURL=searchClient.js.map