Merge branch 'main' into fix/filterPromotes (generated)

Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

Author: algolia-bot

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Consequence.cs

@@ -35,9 +35,9 @@ public Consequence() { }
   public List<Promote> Promote { get; set; }
 
   /// <summary>
-  /// 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).
   /// </summary>
-  /// <value>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. </value>
+  /// <value>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). </value>
   [JsonPropertyName("filterPromotes")]
   public bool? FilterPromotes { get; set; }
 

clients/algoliasearch-client-dart/packages/client_search/lib/src/model/consequence.dart

@@ -28,7 +28,7 @@ final class Consequence {
   @JsonKey(name: r'promote')
   final Iterable<dynamic>? promote;
 
-  /// 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).
   @JsonKey(name: r'filterPromotes')
   final bool? filterPromotes;
 

clients/algoliasearch-client-go/algolia/search/model_consequence.go

@@ -69,10 +69,13 @@ public Consequence setFilterPromotes(Boolean filterPromotes) {
   }
 
   /**
-   * 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).
    */
   @javax.annotation.Nullable
   public Boolean getFilterPromotes() {

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/Consequence.java

@@ -16,7 +16,7 @@ export 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;
 

clients/algoliasearch-client-javascript/packages/client-search/model/consequence.ts

@@ -9,7 +9,7 @@ import kotlinx.serialization.json.*
  *
  * @param params
  * @param promote Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
- * @param filterPromotes 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.
+ * @param filterPromotes 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).
  * @param hide Records you want to hide from the search results.
  * @param userData A JSON object with custom data that will be appended to the `userData` array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON.
  */
@@ -21,7 +21,7 @@ public data class Consequence(
   /** Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.  */
   @SerialName(value = "promote") val promote: List<Promote>? = null,
 
-  /** 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).  */
   @SerialName(value = "filterPromotes") val filterPromotes: Boolean? = null,
 
   /** Records you want to hide from the search results. */

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/Consequence.kt

@@ -246,7 +246,7 @@ public function getFilterPromotes()
     /**
      * Sets filterPromotes.
      *
-     * @param null|bool $filterPromotes 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.
+     * @param null|bool $filterPromotes 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).
      *
      * @return self
      */

clients/algoliasearch-client-php/lib/Model/Search/Consequence.php

@@ -44,7 +44,7 @@ class Consequence(BaseModel):
     promote: Optional[List[Promote]] = None
     """ Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.  """
     filter_promotes: Optional[bool] = None
-    """ 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).  """
     hide: Optional[List[ConsequenceHide]] = None
     """ Records you want to hide from the search results. """
     user_data: Optional[object] = None

clients/algoliasearch-client-python/algoliasearch/search/models/consequence.py

@@ -14,7 +14,7 @@ class Consequence
       # Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
       attr_accessor :promote
 
-      # 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).
       attr_accessor :filter_promotes
 
       # Records you want to hide from the search results.

clients/algoliasearch-client-ruby/lib/algolia/models/search/consequence.rb

@@ -40,9 +40,12 @@ package algoliasearch.search
   *   Records you want to pin to a specific position in the search results. You can promote up to 300 records, either
   *   individually, or as groups of up to 100 records each.
   * @param filterPromotes
-  *   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).
   * @param hide
   *   Records you want to hide from the search results.
   * @param userData