@algolia/client-search 5.7.0 → 5.8.0

package/dist/src/searchClient.js

@@ -1,13 +1,13 @@
 // src/searchClient.ts
 import {
+  ApiError,
   createAuth,
+  createIterablePromise,
   createTransporter,
   getAlgoliaAgent,
-  shuffle,
-  ApiError,
-  createIterablePromise
+  shuffle
 } from "@algolia/client-common";
-var apiClientVersion = "5.7.0";
+var apiClientVersion = "5.8.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -505,8 +505,7 @@ function createSearchClient({
      * Creates a new API key with specific permissions and restrictions.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param apiKey - The apiKey object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -533,12 +532,11 @@ function createSearchClient({
      * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index.  To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param addOrUpdateObject - The addOrUpdateObject object.
      * @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
      * @param addOrUpdateObject.objectID - Unique record identifier.
-     * @param addOrUpdateObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
+     * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addOrUpdateObject({ indexName, objectID, body }, requestOptions) {
@@ -567,8 +565,7 @@ function createSearchClient({
      * Adds a source to the list of allowed sources.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param source - Source to add.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -595,8 +592,7 @@ function createSearchClient({
      * Assigns or moves a user ID to a cluster.  The time it takes to move a user is proportional to the amount of data linked to the user ID.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param assignUserId - The assignUserId object.
      * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -629,7 +625,6 @@ function createSearchClient({
     },
     /**
      * Adds, updates, or deletes records in one index with a single API request.  Batching index updates reduces latency and increases data integrity.  - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name.
-     *
      * @param batch - The batch object.
      * @param batch.indexName - Name of the index on which to perform the operation.
      * @param batch.batchWriteParams - The batchWriteParams object.
@@ -661,8 +656,7 @@ function createSearchClient({
      * Assigns multiple user IDs to a cluster.  **You can\'t move users with this operation**.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param batchAssignUserIds - The batchAssignUserIds object.
      * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -700,8 +694,7 @@ function createSearchClient({
      * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param batchDictionaryEntries - The batchDictionaryEntries object.
      * @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
      * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
@@ -735,11 +728,10 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Retrieves records from an index, up to 1,000 per request.  While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices.  - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.  Browse requests automatically apply these settings:  - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`)  If you send these parameters with your browse requests, they\'ll be ignored.
+     * Retrieves records from an index, up to 1,000 per request.  While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices.  - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.  Browse requests automatically apply these settings:  - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`)  If you send these parameters with your browse requests, they\'ll be ignored.
      *
      * Required API Key ACLs:
-     * - browse.
-     *
+     *  - browse
      * @param browse - The browse object.
      * @param browse.indexName - Name of the index on which to perform the operation.
      * @param browse.browseParams - The browseParams object.
@@ -765,8 +757,7 @@ function createSearchClient({
      * Deletes only the records from an index while keeping settings, synonyms, and rules.
      *
      * Required API Key ACLs:
-     * - deleteIndex.
-     *
+     *  - deleteIndex
      * @param clearObjects - The clearObjects object.
      * @param clearObjects.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -790,8 +781,7 @@ function createSearchClient({
      * Deletes all rules from the index.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param clearRules - The clearRules object.
      * @param clearRules.indexName - Name of the index on which to perform the operation.
      * @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
@@ -805,7 +795,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       const request = {
         method: "POST",
@@ -819,8 +809,7 @@ function createSearchClient({
      * Deletes all synonyms from the index.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param clearSynonyms - The clearSynonyms object.
      * @param clearSynonyms.indexName - Name of the index on which to perform the operation.
      * @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
@@ -834,7 +823,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       const request = {
         method: "POST",
@@ -846,7 +835,6 @@ function createSearchClient({
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @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.
@@ -869,7 +857,6 @@ function createSearchClient({
     },
     /**
      * This method allow you to 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.
@@ -892,7 +879,6 @@ function createSearchClient({
     },
     /**
      * This method allow you to 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.
@@ -917,7 +903,6 @@ function createSearchClient({
     },
     /**
      * This method allow you to 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.
@@ -944,8 +929,7 @@ function createSearchClient({
      * Deletes the API key.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param deleteApiKey - The deleteApiKey object.
      * @param deleteApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -969,8 +953,7 @@ function createSearchClient({
      * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](#tag/Records/operation/batch).
      *
      * Required API Key ACLs:
-     * - deleteIndex.
-     *
+     *  - deleteIndex
      * @param deleteBy - The deleteBy object.
      * @param deleteBy.indexName - Name of the index on which to perform the operation.
      * @param deleteBy.deleteByParams - The deleteByParams object.
@@ -999,8 +982,7 @@ function createSearchClient({
      * Deletes an index and all its settings.  - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it.   For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).
      *
      * Required API Key ACLs:
-     * - deleteIndex.
-     *
+     *  - deleteIndex
      * @param deleteIndex - The deleteIndex object.
      * @param deleteIndex.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1024,8 +1006,7 @@ function createSearchClient({
      * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
      *
      * Required API Key ACLs:
-     * - deleteObject.
-     *
+     *  - deleteObject
      * @param deleteObject - The deleteObject object.
      * @param deleteObject.indexName - Name of the index on which to perform the operation.
      * @param deleteObject.objectID - Unique record identifier.
@@ -1053,8 +1034,7 @@ function createSearchClient({
      * Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param deleteRule - The deleteRule object.
      * @param deleteRule.indexName - Name of the index on which to perform the operation.
      * @param deleteRule.objectID - Unique identifier of a rule object.
@@ -1072,7 +1052,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       const request = {
         method: "DELETE",
@@ -1086,8 +1066,7 @@ function createSearchClient({
      * Deletes a source from the list of allowed sources.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param deleteSource - The deleteSource object.
      * @param deleteSource.source - IP address range of the source.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1111,8 +1090,7 @@ function createSearchClient({
      * Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param deleteSynonym - The deleteSynonym object.
      * @param deleteSynonym.indexName - Name of the index on which to perform the operation.
      * @param deleteSynonym.objectID - Unique identifier of a synonym object.
@@ -1130,7 +1108,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       const request = {
         method: "DELETE",
@@ -1142,7 +1120,6 @@ function createSearchClient({
     },
     /**
      * Gets the permissions and restrictions of an 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, with the description replaced by `<redacted>`.
-     *
      * @param getApiKey - The getApiKey object.
      * @param getApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1166,8 +1143,7 @@ function createSearchClient({
      * Checks the status of a given application task.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param getAppTask - The getAppTask object.
      * @param getAppTask.taskID - Unique task identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1191,8 +1167,7 @@ function createSearchClient({
      * Lists supported languages with their supported dictionary types and number of custom entries.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getDictionaryLanguages(requestOptions) {
@@ -1211,8 +1186,7 @@ function createSearchClient({
      * Retrieves the languages for which standard dictionary entries are turned off.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getDictionarySettings(requestOptions) {
@@ -1231,8 +1205,7 @@ function createSearchClient({
      * The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).  - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn\'t appear in the logs itself.
      *
      * Required API Key ACLs:
-     * - logs.
-     *
+     *  - logs
      * @param getLogs - The getLogs object.
      * @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
      * @param getLogs.length - Maximum number of entries to retrieve.
@@ -1245,16 +1218,16 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (offset !== void 0) {
-        queryParameters.offset = offset.toString();
+        queryParameters["offset"] = offset.toString();
       }
       if (length !== void 0) {
-        queryParameters.length = length.toString();
+        queryParameters["length"] = length.toString();
       }
       if (indexName !== void 0) {
-        queryParameters.indexName = indexName.toString();
+        queryParameters["indexName"] = indexName.toString();
       }
       if (type !== void 0) {
-        queryParameters.type = type.toString();
+        queryParameters["type"] = type.toString();
       }
       const request = {
         method: "GET",
@@ -1268,8 +1241,7 @@ function createSearchClient({
      * Retrieves one record by its object ID.  To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param getObject - The getObject object.
      * @param getObject.indexName - Name of the index on which to perform the operation.
      * @param getObject.objectID - Unique record identifier.
@@ -1287,7 +1259,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (attributesToRetrieve !== void 0) {
-        queryParameters.attributesToRetrieve = attributesToRetrieve.toString();
+        queryParameters["attributesToRetrieve"] = attributesToRetrieve.toString();
       }
       const request = {
         method: "GET",
@@ -1301,8 +1273,7 @@ function createSearchClient({
      * Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param getObjectsParams - Request object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -1331,8 +1302,7 @@ function createSearchClient({
      * Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param getRule - The getRule object.
      * @param getRule.indexName - Name of the index on which to perform the operation.
      * @param getRule.objectID - Unique identifier of a rule object.
@@ -1360,8 +1330,7 @@ function createSearchClient({
      * Retrieves an object with non-null index settings.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1385,8 +1354,7 @@ function createSearchClient({
      * Retrieves all allowed IP addresses with access to your application.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getSources(requestOptions) {
@@ -1402,11 +1370,10 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
+     * Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param getSynonym - The getSynonym object.
      * @param getSynonym.indexName - Name of the index on which to perform the operation.
      * @param getSynonym.objectID - Unique identifier of a synonym object.
@@ -1434,8 +1401,7 @@ function createSearchClient({
      * Checks the status of a given task.  Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server.  The indexing tasks\' responses include a task ID that you can use to check the status.
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param getTask - The getTask object.
      * @param getTask.indexName - Name of the index on which to perform the operation.
      * @param getTask.taskID - Unique task identifier.
@@ -1463,8 +1429,7 @@ function createSearchClient({
      * Get the IDs of the 10 users with the highest number of records per cluster.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTopUserIds(requestOptions) {
@@ -1483,8 +1448,7 @@ function createSearchClient({
      * Returns the user ID data stored in the mapping.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param getUserId - The getUserId object.
      * @param getUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1508,8 +1472,7 @@ function createSearchClient({
      * To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param hasPendingMappings - The hasPendingMappings object.
      * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1519,7 +1482,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (getClusters !== void 0) {
-        queryParameters.getClusters = getClusters.toString();
+        queryParameters["getClusters"] = getClusters.toString();
       }
       const request = {
         method: "GET",
@@ -1533,8 +1496,7 @@ function createSearchClient({
      * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listApiKeys(requestOptions) {
@@ -1553,8 +1515,7 @@ function createSearchClient({
      * Lists the available clusters in a multi-cluster setup.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listClusters(requestOptions) {
@@ -1573,8 +1534,7 @@ function createSearchClient({
      * Lists all indices in the current Algolia application.  The request follows any index restrictions of the API key you use to make the request.
      *
      * Required API Key ACLs:
-     * - listIndexes.
-     *
+     *  - listIndexes
      * @param listIndices - The listIndices object.
      * @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
      * @param listIndices.hitsPerPage - Number of hits per page.
@@ -1585,10 +1545,10 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (page !== void 0) {
-        queryParameters.page = page.toString();
+        queryParameters["page"] = page.toString();
       }
       if (hitsPerPage !== void 0) {
-        queryParameters.hitsPerPage = hitsPerPage.toString();
+        queryParameters["hitsPerPage"] = hitsPerPage.toString();
       }
       const request = {
         method: "GET",
@@ -1602,8 +1562,7 @@ function createSearchClient({
      * Lists the userIDs assigned to a multi-cluster application.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param listUserIds - The listUserIds object.
      * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
      * @param listUserIds.hitsPerPage - Number of hits per page.
@@ -1614,10 +1573,10 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (page !== void 0) {
-        queryParameters.page = page.toString();
+        queryParameters["page"] = page.toString();
       }
       if (hitsPerPage !== void 0) {
-        queryParameters.hitsPerPage = hitsPerPage.toString();
+        queryParameters["hitsPerPage"] = hitsPerPage.toString();
       }
       const request = {
         method: "GET",
@@ -1629,7 +1588,6 @@ function createSearchClient({
     },
     /**
      * Adds, updates, or deletes records in multiple indices with a single API request.  - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.
-     *
      * @param batchParams - The batchParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -1653,11 +1611,10 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Copies or moves (renames) an index within the same Algolia application.  - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'ll be created.  **Copy**  - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)  **Move**  - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
+     * Copies or moves (renames) an index within the same Algolia application.  - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'ll be created.  **Copy**  - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)  **Move**  - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param operationIndex - The operationIndex object.
      * @param operationIndex.indexName - Name of the index on which to perform the operation.
      * @param operationIndex.operationIndexParams - The operationIndexParams object.
@@ -1689,11 +1646,10 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Adds new attributes to a record, or update existing ones.  - If a record with the specified object ID doesn\'t exist,   a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes.   If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.  To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don\'t have access to your initial data.  - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn\'t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn\'t exist yet, the engine only creates it if you pass an IncrementSet value that\'s greater than 0.  You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties:  - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
+     * Adds new attributes to a record, or updates existing ones.  - If a record with the specified object ID doesn\'t exist,   a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes.   If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.  To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don\'t have access to your initial data.  - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn\'t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn\'t exist yet, the engine only creates it if you pass an IncrementSet value greater than 0.  You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties:  - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param partialUpdateObject - The partialUpdateObject object.
      * @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
      * @param partialUpdateObject.objectID - Unique record identifier.
@@ -1715,7 +1671,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (createIfNotExists !== void 0) {
-        queryParameters.createIfNotExists = createIfNotExists.toString();
+        queryParameters["createIfNotExists"] = createIfNotExists.toString();
       }
       const request = {
         method: "POST",
@@ -1730,8 +1686,7 @@ function createSearchClient({
      * Deletes a user ID and its associated data from the clusters.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param removeUserId - The removeUserId object.
      * @param removeUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1755,8 +1710,7 @@ function createSearchClient({
      * Replaces the list of allowed sources.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param replaceSources - The replaceSources object.
      * @param replaceSources.source - Allowed sources.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1781,8 +1735,7 @@ function createSearchClient({
      * Restores a deleted API key.  Restoring resets the `validity` attribute to `0`.  Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can\'t be restored.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param restoreApiKey - The restoreApiKey object.
      * @param restoreApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1806,11 +1759,10 @@ function createSearchClient({
      * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param saveObject - The saveObject object.
      * @param saveObject.indexName - Name of the index on which to perform the operation.
-     * @param saveObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
+     * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveObject({ indexName, body }, requestOptions) {
@@ -1836,8 +1788,7 @@ function createSearchClient({
      * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced.  To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveRule - The saveRule object.
      * @param saveRule.indexName - Name of the index on which to perform the operation.
      * @param saveRule.objectID - Unique identifier of a rule object.
@@ -1862,7 +1813,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       const request = {
         method: "PUT",
@@ -1877,8 +1828,7 @@ function createSearchClient({
      * Create or update multiple rules.  If a rule with the specified object ID doesn\'t exist, Algolia creates a new one. Otherwise, existing rules are replaced.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveRules - The saveRules object.
      * @param saveRules.indexName - Name of the index on which to perform the operation.
      * @param saveRules.rules - The rules object.
@@ -1897,10 +1847,10 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       if (clearExistingRules !== void 0) {
-        queryParameters.clearExistingRules = clearExistingRules.toString();
+        queryParameters["clearExistingRules"] = clearExistingRules.toString();
       }
       const request = {
         method: "POST",
@@ -1915,8 +1865,7 @@ function createSearchClient({
      * If a synonym with the specified object ID doesn\'t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveSynonym - The saveSynonym object.
      * @param saveSynonym.indexName - Name of the index on which to perform the operation.
      * @param saveSynonym.objectID - Unique identifier of a synonym object.
@@ -1944,7 +1893,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       const request = {
         method: "PUT",
@@ -1959,8 +1908,7 @@ function createSearchClient({
      * If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveSynonyms - The saveSynonyms object.
      * @param saveSynonyms.indexName - Name of the index on which to perform the operation.
      * @param saveSynonyms.synonymHit - The synonymHit object.
@@ -1979,10 +1927,10 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       if (replaceExistingSynonyms !== void 0) {
-        queryParameters.replaceExistingSynonyms = replaceExistingSynonyms.toString();
+        queryParameters["replaceExistingSynonyms"] = replaceExistingSynonyms.toString();
       }
       const request = {
         method: "POST",
@@ -1994,11 +1942,10 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Sends multiple search request to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -2048,8 +1995,7 @@ function createSearchClient({
      * Searches for standard and custom dictionary entries.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param searchDictionaryEntries - The searchDictionaryEntries object.
      * @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
      * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
@@ -2090,8 +2036,7 @@ function createSearchClient({
      * Searches for values of a specified facet attribute.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param searchForFacetValues - The searchForFacetValues object.
      * @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
      * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
@@ -2123,8 +2068,7 @@ function createSearchClient({
      * Searches for rules in your index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param searchRules - The searchRules object.
      * @param searchRules.indexName - Name of the index on which to perform the operation.
      * @param searchRules.searchRulesParams - The searchRulesParams object.
@@ -2149,11 +2093,10 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Searches a single index and return matching search results (_hits_).  This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
+     * Searches a single index and returns matching search results (_hits_).  This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param searchSingleIndex - The searchSingleIndex object.
      * @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
      * @param searchSingleIndex.searchParams - The searchParams object.
@@ -2181,8 +2124,7 @@ function createSearchClient({
      * Searches for synonyms in your index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param searchSynonyms - The searchSynonyms object.
      * @param searchSynonyms.indexName - Name of the index on which to perform the operation.
      * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
@@ -2213,8 +2155,7 @@ function createSearchClient({
      * Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.  To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param searchUserIdsParams - The searchUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -2243,8 +2184,7 @@ function createSearchClient({
      * Turns standard stop word dictionary entries on or off for a given language.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param dictionarySettingsParams - The dictionarySettingsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -2273,8 +2213,7 @@ function createSearchClient({
      * Update the specified index settings.  Index settings that you don\'t specify are left unchanged. Specify `null` to reset a setting to its default value.  For best performance, update the index settings before you add new records to your index.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param setSettings - The setSettings object.
      * @param setSettings.indexName - Name of the index on which to perform the operation.
      * @param setSettings.indexSettings - The indexSettings object.
@@ -2292,7 +2231,7 @@ function createSearchClient({
       const headers = {};
       const queryParameters = {};
       if (forwardToReplicas !== void 0) {
-        queryParameters.forwardToReplicas = forwardToReplicas.toString();
+        queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
       }
       const request = {
         method: "PUT",
@@ -2307,8 +2246,7 @@ function createSearchClient({
      * Replaces the permissions of an existing API key.  Any unspecified attribute resets that attribute to its default value.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param updateApiKey - The updateApiKey object.
      * @param updateApiKey.key - API key.
      * @param updateApiKey.apiKey - The apiKey object.