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

algoliasearch/composition/client.py

@@ -1406,6 +1406,80 @@ async def search_for_facet_values(
         )
         return resp.deserialize(SearchForFacetValuesResponse, resp.raw_data)
 
+    async def update_sorting_strategy_composition_with_http_info(
+        self,
+        composition_id: Annotated[
+            StrictStr, Field(description="Unique Composition ObjectID.")
+        ],
+        request_body: Dict[str, StrictStr],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> ApiResponse[str]:
+        """
+        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 composition_id: Unique Composition ObjectID. (required)
+        :type composition_id: str
+        :param request_body: (required)
+        :type request_body: Dict[str, str]
+        :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+        :return: Returns the raw algoliasearch 'APIResponse' object.
+        """
+
+        if composition_id is None:
+            raise ValueError(
+                "Parameter `composition_id` is required when calling `update_sorting_strategy_composition`."
+            )
+
+        if request_body is None:
+            raise ValueError(
+                "Parameter `request_body` is required when calling `update_sorting_strategy_composition`."
+            )
+
+        _data = {}
+        if request_body is not None:
+            _data = request_body
+
+        return await self._transporter.request(
+            verb=Verb.POST,
+            path="/1/compositions/{compositionID}/sortingStrategy".replace(
+                "{compositionID}", quote(str(composition_id), safe="")
+            ),
+            request_options=self._request_options.merge(
+                data=dumps(body_serializer(_data)),
+                user_request_options=request_options,
+            ),
+            use_read_transporter=False,
+        )
+
+    async def update_sorting_strategy_composition(
+        self,
+        composition_id: Annotated[
+            StrictStr, Field(description="Unique Composition ObjectID.")
+        ],
+        request_body: Dict[str, StrictStr],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> TaskIDResponse:
+        """
+        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 composition_id: Unique Composition ObjectID. (required)
+        :type composition_id: str
+        :param request_body: (required)
+        :type request_body: Dict[str, str]
+        :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+        :return: Returns the deserialized response in a 'TaskIDResponse' result object.
+        """
+        resp = await self.update_sorting_strategy_composition_with_http_info(
+            composition_id, request_body, request_options
+        )
+        return resp.deserialize(TaskIDResponse, resp.raw_data)
+
 
 class CompositionClientSync:
     """The Algolia 'CompositionClientSync' class.
@@ -2747,3 +2821,77 @@ def search_for_facet_values(
             composition_id, facet_name, search_for_facet_values_request, request_options
         )
         return resp.deserialize(SearchForFacetValuesResponse, resp.raw_data)
+
+    def update_sorting_strategy_composition_with_http_info(
+        self,
+        composition_id: Annotated[
+            StrictStr, Field(description="Unique Composition ObjectID.")
+        ],
+        request_body: Dict[str, StrictStr],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> ApiResponse[str]:
+        """
+        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 composition_id: Unique Composition ObjectID. (required)
+        :type composition_id: str
+        :param request_body: (required)
+        :type request_body: Dict[str, str]
+        :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+        :return: Returns the raw algoliasearch 'APIResponse' object.
+        """
+
+        if composition_id is None:
+            raise ValueError(
+                "Parameter `composition_id` is required when calling `update_sorting_strategy_composition`."
+            )
+
+        if request_body is None:
+            raise ValueError(
+                "Parameter `request_body` is required when calling `update_sorting_strategy_composition`."
+            )
+
+        _data = {}
+        if request_body is not None:
+            _data = request_body
+
+        return self._transporter.request(
+            verb=Verb.POST,
+            path="/1/compositions/{compositionID}/sortingStrategy".replace(
+                "{compositionID}", quote(str(composition_id), safe="")
+            ),
+            request_options=self._request_options.merge(
+                data=dumps(body_serializer(_data)),
+                user_request_options=request_options,
+            ),
+            use_read_transporter=False,
+        )
+
+    def update_sorting_strategy_composition(
+        self,
+        composition_id: Annotated[
+            StrictStr, Field(description="Unique Composition ObjectID.")
+        ],
+        request_body: Dict[str, StrictStr],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> TaskIDResponse:
+        """
+        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 composition_id: Unique Composition ObjectID. (required)
+        :type composition_id: str
+        :param request_body: (required)
+        :type request_body: Dict[str, str]
+        :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+        :return: Returns the deserialized response in a 'TaskIDResponse' result object.
+        """
+        resp = self.update_sorting_strategy_composition_with_http_info(
+            composition_id, request_body, request_options
+        )
+        return resp.deserialize(TaskIDResponse, resp.raw_data)

algoliasearch/composition/models/composition.py

@@ -25,6 +25,7 @@
     "name": "name",
     "description": "description",
     "behavior": "behavior",
+    "sorting_strategy": "sortingStrategy",
 }
 
 
@@ -44,6 +45,8 @@ class Composition(BaseModel):
     description: Optional[str] = None
     """ Composition description. """
     behavior: CompositionBehavior
+    sorting_strategy: Optional[Dict[str, str]] = None
+    """ 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.  """
 
     model_config = ConfigDict(
         strict=False,

algoliasearch/composition/models/params.py

@@ -53,9 +53,10 @@
     "optional_filters": "optionalFilters",
     "page": "page",
     "query": "query",
-    "relevancy_strictness": "relevancyStrictness",
     "query_languages": "queryLanguages",
+    "relevancy_strictness": "relevancyStrictness",
     "rule_contexts": "ruleContexts",
+    "sort_by": "sortBy",
     "user_token": "userToken",
 }
 
@@ -113,12 +114,14 @@ class Params(BaseModel):
     """ Page of search results to retrieve. """
     query: Optional[str] = None
     """ Search query. """
-    relevancy_strictness: Optional[int] = None
-    """ 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.  """
     query_languages: Optional[List[SupportedLanguage]] = None
     """ 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_strictness: Optional[int] = None
+    """ 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.  """
     rule_contexts: Optional[List[str]] = None
     """ 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.  """
+    sort_by: Optional[str] = None
+    """ 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.  """
     user_token: Optional[str] = None
     """ 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).  """