feat(specs): add sortBy query param and sortingStrategy (generated)

algolia/api-clients-automation#5686

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Ben Kalmus <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>

Author: 3 people

src/main/scala/algoliasearch/api/CompositionClient.scala

@@ -522,4 +522,37 @@ class CompositionClient(
     execute[SearchForFacetValuesResponse](request, requestOptions)
   }
 
+  /** Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to create a new sorting
+    * strategy mapping or replace the currently configured one. The provided sorting indices MUST be associated indices
+    * or replicas of the main targeted index. WARNING: This endpoint cannot validate if the sort index is related to the
+    * composition's main index. Validation will fail at runtime if the index you updated is not related! The update is
+    * applied to the specified composition within the current Algolia application and returns a taskID that can be used
+    * to track the operation’s completion.
+    *
+    * Required API Key ACLs:
+    *   - editSettings
+    *
+    * @param compositionID
+    *   Unique Composition ObjectID.
+    */
+  def updateSortingStrategyComposition(
+      compositionID: String,
+      requestBody: Map[String, String],
+      requestOptions: Option[RequestOptions] = None
+  )(implicit ec: ExecutionContext): Future[TaskIDResponse] = Future {
+    requireNotNull(
+      compositionID,
+      "Parameter `compositionID` is required when calling `updateSortingStrategyComposition`."
+    )
+    requireNotNull(requestBody, "Parameter `requestBody` is required when calling `updateSortingStrategyComposition`.")
+
+    val request = HttpRequest
+      .builder()
+      .withMethod("POST")
+      .withPath(s"/1/compositions/${escape(compositionID)}/sortingStrategy")
+      .withBody(requestBody)
+      .build()
+    execute[TaskIDResponse](request, requestOptions)
+  }
+
 }

src/main/scala/algoliasearch/composition/Composition.scala

@@ -36,10 +36,18 @@ package algoliasearch.composition
   *   Composition name.
   * @param description
   *   Composition description.
+  * @param sortingStrategy
+  *   A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. The sorting indices
+  *   MUST be related to the associated main targeted index in the composition. Each key is the label your frontend
+  *   sends at runtime (for example, \"Price (asc)\"), and each value is the name of the index that should be queried
+  *   when that label is selected. When a request includes a \"sortBy\" parameter, the platform looks up the
+  *   corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced with the
+  *   sorting strategy index it is mapped to. Up to 20 sorting strategies can be defined.
   */
 case class Composition(
     objectID: String,
     name: String,
     description: Option[String] = scala.None,
-    behavior: CompositionBehavior
+    behavior: CompositionBehavior,
+    sortingStrategy: Option[Map[String, String]] = scala.None
 ) extends BatchCompositionActionTrait

src/main/scala/algoliasearch/composition/Params.scala

@@ -102,11 +102,6 @@ import algoliasearch.composition.SupportedLanguage._
   *   Page of search results to retrieve.
   * @param query
   *   Search query.
-  * @param relevancyStrictness
-  *   Relevancy threshold below which less relevant results aren't included in the results You can only set
-  *   `relevancyStrictness` on [virtual replica
-  *   indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
-  *   Use this setting to strike a balance between the relevance and number of returned results.
   * @param queryLanguages
   *   Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection
   *   dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals`
@@ -118,10 +113,22 @@ import algoliasearch.composition.SupportedLanguage._
   *   or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to
   *   unexpected search results. For more information, see [Language-specific
   *   configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
+  * @param relevancyStrictness
+  *   Relevancy threshold below which less relevant results aren't included in the results You can only set
+  *   `relevancyStrictness` on [virtual replica
+  *   indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
+  *   Use this setting to strike a balance between the relevance and number of returned results.
   * @param ruleContexts
   *   Assigns a rule context to the run query [Rule
   *   contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context)
   *   are strings that you can use to trigger matching rules.
+  * @param sortBy
+  *   Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the
+  *   \"sortingStrategy\" mapping. For example, \"Price (asc)\", see Upsert Composition. At runtime, this label is used
+  *   to look up the corresponding index or replica configured in \"sortingStrategy\", and the query is executed using
+  *   that index instead of main's. In addition to \"sortingStrategy\", this parameter is also used to apply a matching
+  *   Composition Rule that contains a condition defined to trigger on \"sortBy\", see Composition Rules. If no value is
+  *   provided or an invalid value, no sorting strategy is applied.
   * @param userToken
   *   Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For
   *   more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
@@ -152,8 +159,9 @@ case class Params(
     optionalFilters: Option[OptionalFilters] = scala.None,
     page: Option[Int] = scala.None,
     query: Option[String] = scala.None,
-    relevancyStrictness: Option[Int] = scala.None,
     queryLanguages: Option[Seq[SupportedLanguage]] = scala.None,
+    relevancyStrictness: Option[Int] = scala.None,
     ruleContexts: Option[Seq[String]] = scala.None,
+    sortBy: Option[String] = scala.None,
     userToken: Option[String] = scala.None
 )