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

algolia/api-clients-automation#5686

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Ben Kalmus <ben.kalmus@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>

Author: 3 people

algoliasearch/Clients/CompositionClient.cs

@@ -727,6 +727,48 @@ SearchForFacetValuesResponse SearchForFacetValues(
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
+
+  /// <summary>
+  /// 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.
+  /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - editSettings
+  /// <param name="compositionID">Unique Composition ObjectID.</param>
+  /// <param name="requestBody"></param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>Task of TaskIDResponse</returns>
+  Task<TaskIDResponse> UpdateSortingStrategyCompositionAsync(
+    string compositionID,
+    Dictionary<string, string> requestBody,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  );
+
+  /// <summary>
+  /// 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.  (Synchronous version)
+  /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - editSettings
+  /// <param name="compositionID">Unique Composition ObjectID.</param>
+  /// <param name="requestBody"></param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>TaskIDResponse</returns>
+  TaskIDResponse UpdateSortingStrategyComposition(
+    string compositionID,
+    Dictionary<string, string> requestBody,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  );
 }
 
 /// <summary>
@@ -1498,4 +1540,51 @@ public SearchForFacetValuesResponse SearchForFacetValues(
         cancellationToken
       )
     );
+
+  /// <inheritdoc />
+  public async Task<TaskIDResponse> UpdateSortingStrategyCompositionAsync(
+    string compositionID,
+    Dictionary<string, string> requestBody,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  )
+  {
+    if (compositionID == null)
+      throw new ArgumentException(
+        "Parameter `compositionID` is required when calling `UpdateSortingStrategyComposition`."
+      );
+
+    if (requestBody == null)
+      throw new ArgumentException(
+        "Parameter `requestBody` is required when calling `UpdateSortingStrategyComposition`."
+      );
+
+    var requestOptions = new InternalRequestOptions(options);
+
+    requestOptions.PathParameters.Add(
+      "compositionID",
+      QueryStringHelper.ParameterToString(compositionID)
+    );
+
+    requestOptions.Data = requestBody;
+    return await _transport
+      .ExecuteRequestAsync<TaskIDResponse>(
+        new HttpMethod("POST"),
+        "/1/compositions/{compositionID}/sortingStrategy",
+        requestOptions,
+        cancellationToken
+      )
+      .ConfigureAwait(false);
+  }
+
+  /// <inheritdoc />
+  public TaskIDResponse UpdateSortingStrategyComposition(
+    string compositionID,
+    Dictionary<string, string> requestBody,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  ) =>
+    AsyncHelper.RunSync(() =>
+      UpdateSortingStrategyCompositionAsync(compositionID, requestBody, options, cancellationToken)
+    );
 }

algoliasearch/Models/Composition/Composition.cs

@@ -62,6 +62,13 @@ public Composition(string objectID, string name, CompositionBehavior behavior)
   [JsonPropertyName("behavior")]
   public CompositionBehavior Behavior { get; set; }
 
+  /// <summary>
+  /// 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.
+  /// </summary>
+  /// <value>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. </value>
+  [JsonPropertyName("sortingStrategy")]
+  public Dictionary<string, string> SortingStrategy { get; set; }
+
   /// <summary>
   /// Returns the string presentation of the object
   /// </summary>
@@ -74,6 +81,7 @@ public override string ToString()
     sb.Append("  Name: ").Append(Name).Append("\n");
     sb.Append("  Description: ").Append(Description).Append("\n");
     sb.Append("  Behavior: ").Append(Behavior).Append("\n");
+    sb.Append("  SortingStrategy: ").Append(SortingStrategy).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
   }
@@ -105,7 +113,13 @@ public override bool Equals(object obj)
         Description == input.Description
         || (Description != null && Description.Equals(input.Description))
       )
-      && (Behavior == input.Behavior || (Behavior != null && Behavior.Equals(input.Behavior)));
+      && (Behavior == input.Behavior || (Behavior != null && Behavior.Equals(input.Behavior)))
+      && (
+        SortingStrategy == input.SortingStrategy
+        || SortingStrategy != null
+          && input.SortingStrategy != null
+          && SortingStrategy.SequenceEqual(input.SortingStrategy)
+      );
   }
 
   /// <summary>
@@ -133,6 +147,10 @@ public override int GetHashCode()
       {
         hashCode = (hashCode * 59) + Behavior.GetHashCode();
       }
+      if (SortingStrategy != null)
+      {
+        hashCode = (hashCode * 59) + SortingStrategy.GetHashCode();
+      }
       return hashCode;
     }
   }

algoliasearch/Models/Composition/Params.cs

@@ -190,27 +190,34 @@ public Params() { }
   [JsonPropertyName("query")]
   public string Query { get; set; }
 
-  /// <summary>
-  /// 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.
-  /// </summary>
-  /// <value>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. </value>
-  [JsonPropertyName("relevancyStrictness")]
-  public int? RelevancyStrictness { get; set; }
-
   /// <summary>
   /// 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` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), 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).
   /// </summary>
   /// <value>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` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), 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). </value>
   [JsonPropertyName("queryLanguages")]
   public List<SupportedLanguage> QueryLanguages { get; set; }
 
+  /// <summary>
+  /// 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.
+  /// </summary>
+  /// <value>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. </value>
+  [JsonPropertyName("relevancyStrictness")]
+  public int? RelevancyStrictness { get; set; }
+
   /// <summary>
   /// 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.
   /// </summary>
   /// <value>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. </value>
   [JsonPropertyName("ruleContexts")]
   public List<string> RuleContexts { get; set; }
 
+  /// <summary>
+  /// 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.
+  /// </summary>
+  /// <value>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. </value>
+  [JsonPropertyName("sortBy")]
+  public string SortBy { get; set; }
+
   /// <summary>
   /// 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).
   /// </summary>
@@ -251,9 +258,10 @@ public override string ToString()
     sb.Append("  OptionalFilters: ").Append(OptionalFilters).Append("\n");
     sb.Append("  Page: ").Append(Page).Append("\n");
     sb.Append("  Query: ").Append(Query).Append("\n");
-    sb.Append("  RelevancyStrictness: ").Append(RelevancyStrictness).Append("\n");
     sb.Append("  QueryLanguages: ").Append(QueryLanguages).Append("\n");
+    sb.Append("  RelevancyStrictness: ").Append(RelevancyStrictness).Append("\n");
     sb.Append("  RuleContexts: ").Append(RuleContexts).Append("\n");
+    sb.Append("  SortBy: ").Append(SortBy).Append("\n");
     sb.Append("  UserToken: ").Append(UserToken).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
@@ -358,22 +366,23 @@ public override bool Equals(object obj)
       )
       && (Page == input.Page || Page.Equals(input.Page))
       && (Query == input.Query || (Query != null && Query.Equals(input.Query)))
-      && (
-        RelevancyStrictness == input.RelevancyStrictness
-        || RelevancyStrictness.Equals(input.RelevancyStrictness)
-      )
       && (
         QueryLanguages == input.QueryLanguages
         || QueryLanguages != null
           && input.QueryLanguages != null
           && QueryLanguages.SequenceEqual(input.QueryLanguages)
       )
+      && (
+        RelevancyStrictness == input.RelevancyStrictness
+        || RelevancyStrictness.Equals(input.RelevancyStrictness)
+      )
       && (
         RuleContexts == input.RuleContexts
         || RuleContexts != null
           && input.RuleContexts != null
           && RuleContexts.SequenceEqual(input.RuleContexts)
       )
+      && (SortBy == input.SortBy || (SortBy != null && SortBy.Equals(input.SortBy)))
       && (UserToken == input.UserToken || (UserToken != null && UserToken.Equals(input.UserToken)));
   }
 
@@ -453,15 +462,19 @@ public override int GetHashCode()
       {
         hashCode = (hashCode * 59) + Query.GetHashCode();
       }
-      hashCode = (hashCode * 59) + RelevancyStrictness.GetHashCode();
       if (QueryLanguages != null)
       {
         hashCode = (hashCode * 59) + QueryLanguages.GetHashCode();
       }
+      hashCode = (hashCode * 59) + RelevancyStrictness.GetHashCode();
       if (RuleContexts != null)
       {
         hashCode = (hashCode * 59) + RuleContexts.GetHashCode();
       }
+      if (SortBy != null)
+      {
+        hashCode = (hashCode * 59) + SortBy.GetHashCode();
+      }
       if (UserToken != null)
       {
         hashCode = (hashCode * 59) + UserToken.GetHashCode();