fix(specs): add missing redirect property to rule consequence schema (generated)

algolia/api-clients-automation#5934

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

Author: algolia-bot

algoliasearch/search/models/__init__.py

@@ -46,6 +46,7 @@
 from .consequence_params import ConsequenceParams
 from .consequence_query import ConsequenceQuery
 from .consequence_query_object import ConsequenceQueryObject
+from .consequence_redirect import ConsequenceRedirect
 from .created_at_response import CreatedAtResponse
 from .delete_api_key_response import DeleteApiKeyResponse
 from .delete_by_params import DeleteByParams
@@ -222,6 +223,7 @@
     "ConsequenceParams",
     "ConsequenceQuery",
     "ConsequenceQueryObject",
+    "ConsequenceRedirect",
     "CreatedAtResponse",
     "DeleteApiKeyResponse",
     "DeleteByParams",

algoliasearch/search/models/consequence.py

@@ -20,13 +20,15 @@
 
 from algoliasearch.search.models.consequence_hide import ConsequenceHide
 from algoliasearch.search.models.consequence_params import ConsequenceParams
+from algoliasearch.search.models.consequence_redirect import ConsequenceRedirect
 from algoliasearch.search.models.promote import Promote
 
 _ALIASES = {
     "params": "params",
     "promote": "promote",
     "filter_promotes": "filterPromotes",
     "hide": "hide",
+    "redirect": "redirect",
     "user_data": "userData",
 }
 
@@ -47,6 +49,7 @@ class Consequence(BaseModel):
     """ 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. """
+    redirect: Optional[ConsequenceRedirect] = None
     user_data: Optional[object] = None
     """ 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.  """
 
@@ -100,5 +103,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             if obj.get("hide") is not None
             else None
         )
+        obj["redirect"] = (
+            ConsequenceRedirect.from_dict(obj["redirect"])
+            if obj.get("redirect") is not None
+            else None
+        )
 
         return cls.model_validate(obj)

algoliasearch/search/models/consequence_redirect.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+"""
+Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+"""
+
+from __future__ import annotations
+
+from json import loads
+from sys import version_info
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+_ALIASES = {
+    "index_name": "indexName",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class ConsequenceRedirect(BaseModel):
+    """
+    Redirect to a virtual replica index.  This consequence is only valid for rules with `scope: redirect`.
+    """
+
+    index_name: str
+    """ Name of the virtual replica index to redirect searches to. """
+
+    model_config = ConfigDict(
+        strict=False,
+        use_enum_values=True,
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        alias_generator=_alias_generator,
+        extra="allow",
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ConsequenceRedirect from a JSON string"""
+        return cls.from_dict(loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias."""
+        return self.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+        )
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConsequenceRedirect from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)