@algolia/client-search 5.35.0 → 5.37.0

package/dist/builds/node.js

@@ -20,7 +20,7 @@ import {
   getAlgoliaAgent,
   shuffle
 } from "@algolia/client-common";
-var apiClientVersion = "5.35.0";
+var apiClientVersion = "5.37.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -440,7 +440,7 @@ function createSearchClient({
     },
     /**
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
-     * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
+     * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
      * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * @param replaceAllObjects - The `replaceAllObjects` object.
@@ -1378,15 +1378,19 @@ function createSearchClient({
      *  - settings
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
+     * @param getSettings.getVersion - When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getSettings({ indexName }, requestOptions) {
+    getSettings({ indexName, getVersion }, requestOptions) {
       if (!indexName) {
         throw new Error("Parameter `indexName` is required when calling `getSettings`.");
       }
       const requestPath = "/1/indexes/{indexName}/settings".replace("{indexName}", encodeURIComponent(indexName));
       const headers = {};
       const queryParameters = {};
+      if (getVersion !== void 0) {
+        queryParameters["getVersion"] = getVersion.toString();
+      }
       const request = {
         method: "GET",
         path: requestPath,
@@ -2395,7 +2399,7 @@ function searchClient(appId, apiKey, options) {
     },
     /**
      * Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
-     * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
+     * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
      * @summary Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
      * @param accountCopyIndex - The `accountCopyIndex` object.