feat(specs): introduce multifeed composition behavior for beta release (generated)

algolia/api-clients-automation#5828

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Gavin Wade <[email protected]>

Author: algolia-bot

algoliasearch/composition/models/__init__.py

@@ -71,6 +71,7 @@
 from .main_injection_query_parameters import MainInjectionQueryParameters
 from .match_level import MatchLevel
 from .matched_geo_location import MatchedGeoLocation
+from .multifeed import Multifeed
 from .multiple_batch_request import MultipleBatchRequest
 from .multiple_batch_response import MultipleBatchResponse
 from .numeric_filters import NumericFilters
@@ -182,6 +183,7 @@
     "MainInjectionQueryParameters",
     "MatchLevel",
     "MatchedGeoLocation",
+    "Multifeed",
     "MultipleBatchRequest",
     "MultipleBatchResponse",
     "NumericFilters",

algoliasearch/composition/models/composition_behavior.py

@@ -19,9 +19,11 @@
 
 
 from algoliasearch.composition.models.injection import Injection
+from algoliasearch.composition.models.multifeed import Multifeed
 
 _ALIASES = {
     "injection": "injection",
+    "multifeed": "multifeed",
 }
 
 
@@ -31,10 +33,11 @@ def _alias_generator(name: str) -> str:
 
 class CompositionBehavior(BaseModel):
     """
-    CompositionBehavior
+    An object containing either an `injection` or `multifeed` behavior schema, but not both.
     """
 
-    injection: Injection
+    injection: Optional[Injection] = None
+    multifeed: Optional[Multifeed] = None
 
     model_config = ConfigDict(
         strict=False,
@@ -76,5 +79,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             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
+        )
 
         return cls.model_validate(obj)

algoliasearch/composition/models/multifeed.py

@@ -0,0 +1,84 @@
+# 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, List, 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 = {
+    "feeds": "feeds",
+    "feeds_order": "feedsOrder",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class Multifeed(BaseModel):
+    """
+    Multifeed
+    """
+
+    feeds: Dict[str, Injection]
+    """ A key-value store of Feed ID to Feed. Currently, the only supported Feed type is an Injection. """
+    feeds_order: Optional[List[str]] = None
+    """ A list of Feed IDs that specifies the order in which to order the results in the response. The IDs should be a subset of those in the Feeds object, and only those specified will be processed. When this field is not set, all Feeds are processed and returned with a default ordering. """
+
+    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 Multifeed 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 Multifeed from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["feeds"] = (
+            dict((_k, Injection.from_dict(_v)) for _k, _v in obj["feeds"].items())
+            if obj.get("feeds") is not None
+            else None
+        )
+
+        return cls.model_validate(obj)