fix(specs): more accurate composition behavior typing (generated)

algolia/api-clients-automation#5892

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>

Author: algolia-bot

algoliasearch/composition/models/__init__.py

@@ -26,6 +26,8 @@
 from .composition import Composition
 from .composition_behavior import CompositionBehavior
 from .composition_id_ranking_info import CompositionIdRankingInfo
+from .composition_injection_behavior import CompositionInjectionBehavior
+from .composition_multifeed_behavior import CompositionMultifeedBehavior
 from .composition_rule import CompositionRule
 from .composition_rule_consequence import CompositionRuleConsequence
 from .composition_rules_batch_params import CompositionRulesBatchParams
@@ -138,6 +140,8 @@
     "Composition",
     "CompositionBehavior",
     "CompositionIdRankingInfo",
+    "CompositionInjectionBehavior",
+    "CompositionMultifeedBehavior",
     "CompositionRule",
     "CompositionRuleConsequence",
     "CompositionRulesBatchParams",

algoliasearch/composition/models/composition_behavior.py

@@ -6,83 +6,125 @@
 
 from __future__ import annotations
 
-from json import loads
+from json import dumps
 from sys import version_info
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, Set, Union
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, Field, ValidationError, model_serializer
 
 if version_info >= (3, 11):
     from typing import Self
 else:
     from typing_extensions import Self
 
 
-from algoliasearch.composition.models.injection import Injection
-from algoliasearch.composition.models.multifeed import Multifeed
-
-_ALIASES = {
-    "injection": "injection",
-    "multifeed": "multifeed",
-}
-
-
-def _alias_generator(name: str) -> str:
-    return _ALIASES.get(name, name)
+from algoliasearch.composition.models.composition_injection_behavior import (
+    CompositionInjectionBehavior,
+)
+from algoliasearch.composition.models.composition_multifeed_behavior import (
+    CompositionMultifeedBehavior,
+)
 
 
 class CompositionBehavior(BaseModel):
     """
     An object containing either an `injection` or `multifeed` behavior schema, but not both.
     """
 
-    injection: Optional[Injection] = None
-    multifeed: Optional[Multifeed] = None
-
-    model_config = ConfigDict(
-        strict=False,
-        use_enum_values=True,
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-        alias_generator=_alias_generator,
-        extra="allow",
+    oneof_schema_1_validator: Optional[CompositionInjectionBehavior] = Field(
+        default=None
     )
 
-    def to_json(self) -> str:
-        return self.model_dump_json(by_alias=True, exclude_unset=True)
+    oneof_schema_2_validator: Optional[CompositionMultifeedBehavior] = Field(
+        default=None
+    )
+
+    actual_instance: Union[
+        CompositionInjectionBehavior, CompositionMultifeedBehavior, None
+    ] = None
+    one_of_schemas: Set[str] = {
+        "CompositionInjectionBehavior",
+        "CompositionMultifeedBehavior",
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError(
+                    "If a position argument is used, only 1 is allowed to set `actual_instance`"
+                )
+            if kwargs:
+                raise ValueError(
+                    "If a position argument is used, keyword arguments cannot be used."
+                )
+            super().__init__(actual_instance=args[0])  # pyright: ignore
+        else:
+            super().__init__(**kwargs)
+
+    @model_serializer
+    def unwrap_actual_instance(
+        self,
+    ) -> Union[CompositionInjectionBehavior, CompositionMultifeedBehavior, Self, None]:
+        """
+        Unwraps the `actual_instance` when calling the `to_json` method.
+        """
+        return self.actual_instance if hasattr(self, "actual_instance") else self
 
     @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
         """Create an instance of CompositionBehavior 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,
-        )
+        return cls.from_json(dumps(obj))
 
     @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of CompositionBehavior from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        obj["injection"] = (
-            Injection.from_dict(obj["injection"])
-            if obj.get("injection") is not None
-            else None
-        )
-        obj["multifeed"] = (
-            Multifeed.from_dict(obj["multifeed"])
-            if obj.get("multifeed") is not None
-            else None
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+
+        try:
+            instance.actual_instance = CompositionInjectionBehavior.from_json(json_str)
+
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        try:
+            instance.actual_instance = CompositionMultifeedBehavior.from_json(json_str)
+
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        raise ValueError(
+            "No match found when deserializing the JSON string into CompositionBehavior with oneOf schemas: CompositionInjectionBehavior, CompositionMultifeedBehavior. Details: "
+            + ", ".join(error_messages)
         )
 
-        return cls.model_validate(obj)
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(
+            self.actual_instance.to_json  # pyright: ignore
+        ):
+            return self.actual_instance.to_json()  # pyright: ignore
+        else:
+            return dumps(self.actual_instance)
+
+    def to_dict(
+        self,
+    ) -> Optional[
+        Union[
+            Dict[str, Any], CompositionInjectionBehavior, CompositionMultifeedBehavior
+        ]
+    ]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(
+            self.actual_instance.to_dict  # pyright: ignore
+        ):
+            return self.actual_instance.to_dict()  # pyright: ignore
+        else:
+            return self.actual_instance  # pyright: ignore

algoliasearch/composition/models/composition_injection_behavior.py

@@ -0,0 +1,80 @@
+# 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
+
+
+from algoliasearch.composition.models.injection import Injection
+
+_ALIASES = {
+    "injection": "injection",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class CompositionInjectionBehavior(BaseModel):
+    """
+    An object containing an `injection` behavior.
+    """
+
+    injection: Injection
+
+    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 CompositionInjectionBehavior 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 CompositionInjectionBehavior from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["injection"] = (
+            Injection.from_dict(obj["injection"])
+            if obj.get("injection") is not None
+            else None
+        )
+
+        return cls.model_validate(obj)

algoliasearch/composition/models/composition_multifeed_behavior.py

@@ -0,0 +1,80 @@
+# 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
+
+
+from algoliasearch.composition.models.multifeed import Multifeed
+
+_ALIASES = {
+    "multifeed": "multifeed",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class CompositionMultifeedBehavior(BaseModel):
+    """
+    An object containing a `multifeed` behavior.
+    """
+
+    multifeed: Multifeed
+
+    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 CompositionMultifeedBehavior 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 CompositionMultifeedBehavior from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["multifeed"] = (
+            Multifeed.from_dict(obj["multifeed"])
+            if obj.get("multifeed") is not None
+            else None
+        )
+
+        return cls.model_validate(obj)