@algolia/client-search 5.35.0 → 5.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -30,7 +30,7 @@ var import_client_common2 = require("@algolia/client-common");
30
30
 
31
31
  // src/searchClient.ts
32
32
  var import_client_common = require("@algolia/client-common");
33
- var apiClientVersion = "5.35.0";
33
+ var apiClientVersion = "5.37.0";
34
34
  function getDefaultHosts(appId) {
35
35
  return [
36
36
  {
@@ -450,7 +450,7 @@ function createSearchClient({
450
450
  },
451
451
  /**
452
452
  * 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.
453
- * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
453
+ * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
454
454
  *
455
455
  * @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.
456
456
  * @param replaceAllObjects - The `replaceAllObjects` object.
@@ -1388,15 +1388,19 @@ function createSearchClient({
1388
1388
  * - settings
1389
1389
  * @param getSettings - The getSettings object.
1390
1390
  * @param getSettings.indexName - Name of the index on which to perform the operation.
1391
+ * @param getSettings.getVersion - When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
1391
1392
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1392
1393
  */
1393
- getSettings({ indexName }, requestOptions) {
1394
+ getSettings({ indexName, getVersion }, requestOptions) {
1394
1395
  if (!indexName) {
1395
1396
  throw new Error("Parameter `indexName` is required when calling `getSettings`.");
1396
1397
  }
1397
1398
  const requestPath = "/1/indexes/{indexName}/settings".replace("{indexName}", encodeURIComponent(indexName));
1398
1399
  const headers = {};
1399
1400
  const queryParameters = {};
1401
+ if (getVersion !== void 0) {
1402
+ queryParameters["getVersion"] = getVersion.toString();
1403
+ }
1400
1404
  const request = {
1401
1405
  method: "GET",
1402
1406
  path: requestPath,
@@ -2405,7 +2409,7 @@ function searchClient(appId, apiKey, options) {
2405
2409
  },
2406
2410
  /**
2407
2411
  * Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
2408
- * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
2412
+ * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
2409
2413
  *
2410
2414
  * @summary Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
2411
2415
  * @param accountCopyIndex - The `accountCopyIndex` object.