@algolia/client-search 5.36.0 → 5.37.0

package/dist/worker.d.ts

@@ -1486,7 +1486,7 @@ type Consequence = {
      */
     promote?: Array<Promote> | undefined;
     /**
-     * Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
+     * Determines whether promoted records must also match active filters for the consequence to apply.  This ensures user-applied filters take priority and irrelevant matches aren\'t shown. For example, if you promote a record with `color: red` but the user filters for `color: blue`, the \"red\" record won\'t be shown.  > In the Algolia dashboard, when you use the **Pin an item** consequence, `filterPromotes` appears as the checkbox: **Pinned items must match active filters to be displayed.** For examples, see [Promote results with rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/#promote-results-matching-active-filters).
      */
     filterPromotes?: boolean | undefined;
     /**
@@ -2597,6 +2597,10 @@ type GetSettingsProps = {
      * Name of the index on which to perform the operation.
      */
     indexName: string;
+    /**
+     * When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
+     */
+    getVersion?: number | undefined;
 };
 /**
  * Properties for the `getSynonym` method.
@@ -3051,7 +3055,7 @@ type AccountCopyIndexOptions = {
     batchSize?: number | undefined;
 };
 
-declare const apiClientVersion = "5.36.0";
+declare const apiClientVersion = "5.37.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3559,9 +3563,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *  - 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 }: GetSettingsProps, requestOptions?: RequestOptions): Promise<SettingsResponse>;
+    getSettings({ indexName, getVersion }: GetSettingsProps, requestOptions?: RequestOptions): Promise<SettingsResponse>;
     /**
      * Retrieves all allowed IP addresses with access to your application.
      *

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.36.0",
+  "version": "5.37.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,10 +49,10 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.36.0",
-    "@algolia/requester-browser-xhr": "5.36.0",
-    "@algolia/requester-fetch": "5.36.0",
-    "@algolia/requester-node-http": "5.36.0"
+    "@algolia/client-common": "5.37.0",
+    "@algolia/requester-browser-xhr": "5.37.0",
+    "@algolia/requester-fetch": "5.37.0",
+    "@algolia/requester-node-http": "5.37.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",