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

packages/composition/model/clientMethodProps.ts

@@ -224,6 +224,17 @@ export type SearchForFacetValuesProps = {
   searchForFacetValuesRequest?: SearchForFacetValuesRequest | undefined;
 };
 
+/**
+ * Properties for the `updateSortingStrategyComposition` method.
+ */
+export type UpdateSortingStrategyCompositionProps = {
+  /**
+   * Unique Composition ObjectID.
+   */
+  compositionID: string;
+  requestBody: { [key: string]: string };
+};
+
 export type WaitForCompositionTaskOptions = {
   /**
    * The maximum number of retries. 50 by default.

packages/composition/model/composition.ts

@@ -19,4 +19,9 @@ export type Composition = {
   description?: string | undefined;
 
   behavior: CompositionBehavior;
+
+  /**
+   * 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.
+   */
+  sortingStrategy?: { [key: string]: string } | undefined;
 };

packages/composition/model/params.ts

@@ -118,20 +118,25 @@ export type Params = {
   query?: string | undefined;
 
   /**
-   * 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.
+   * 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).
    */
-  relevancyStrictness?: number | undefined;
+  queryLanguages?: Array<SupportedLanguage> | undefined;
 
   /**
-   * 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).
+   * 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.
    */
-  queryLanguages?: Array<SupportedLanguage> | undefined;
+  relevancyStrictness?: number | undefined;
 
   /**
    * 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.
    */
   ruleContexts?: Array<string> | undefined;
 
+  /**
+   * 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.
+   */
+  sortBy?: string | undefined;
+
   /**
    * 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).
    */

packages/composition/src/compositionClient.ts

@@ -43,6 +43,7 @@ import type {
   SearchCompositionRulesProps,
   SearchForFacetValuesProps,
   SearchProps,
+  UpdateSortingStrategyCompositionProps,
   WaitForCompositionTaskOptions,
 } from '../model/clientMethodProps';
 
@@ -822,5 +823,45 @@ export function createCompositionClient({
 
       return transporter.request(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 updateSortingStrategyComposition - The updateSortingStrategyComposition object.
+     * @param updateSortingStrategyComposition.compositionID - Unique Composition ObjectID.
+     * @param updateSortingStrategyComposition.requestBody - The requestBody object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    updateSortingStrategyComposition(
+      { compositionID, requestBody }: UpdateSortingStrategyCompositionProps,
+      requestOptions?: RequestOptions,
+    ): Promise<TaskIDResponse> {
+      if (!compositionID) {
+        throw new Error('Parameter `compositionID` is required when calling `updateSortingStrategyComposition`.');
+      }
+
+      if (!requestBody) {
+        throw new Error('Parameter `requestBody` is required when calling `updateSortingStrategyComposition`.');
+      }
+
+      const requestPath = '/1/compositions/{compositionID}/sortingStrategy'.replace(
+        '{compositionID}',
+        encodeURIComponent(compositionID),
+      );
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: requestBody,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
   };
 }