feat(specs): add compositions deduplication setting (generated)

algolia/api-clients-automation#5418

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Ben Kalmus <[email protected]>
Co-authored-by: Clara Muller <[email protected]>

Author: 3 people

algoliasearch/composition/models/__init__.py

@@ -35,6 +35,8 @@
 from .composition_source_search import CompositionSourceSearch
 from .compositions_search_response import CompositionsSearchResponse
 from .condition import Condition
+from .dedup_positioning import DedupPositioning
+from .deduplication import Deduplication
 from .delete_composition_action import DeleteCompositionAction
 from .delete_composition_rule_action import DeleteCompositionRuleAction
 from .distinct import Distinct
@@ -144,6 +146,8 @@
     "CompositionSourceSearch",
     "CompositionsSearchResponse",
     "Condition",
+    "DedupPositioning",
+    "Deduplication",
     "DeleteCompositionAction",
     "DeleteCompositionRuleAction",
     "Distinct",

algoliasearch/composition/models/dedup_positioning.py

@@ -0,0 +1,34 @@
+# 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 enum import Enum
+from json import loads
+from sys import version_info
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+class DedupPositioning(str, Enum):
+    """
+    Deduplication positioning configures how a duplicate result should be resolved between an injected item and main search results. Current configuration supports: - 'highest': always select the item in the highest position, and remove duplicates that appear lower in the results. - 'highestInjected': duplicate result will be moved to its highest possible injected position, but not higher.    If a duplicate appears higher in main search results, it will be removed to stay it's intended group position (which could be lower than main).
+    """
+
+    """
+    allowed enum values
+    """
+    HIGHEST = "highest"
+
+    HIGHESTINJECTED = "highestInjected"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DedupPositioning from a JSON string"""
+        return cls(loads(json_str))

algoliasearch/composition/models/deduplication.py

@@ -0,0 +1,76 @@
+# 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.dedup_positioning import DedupPositioning
+
+_ALIASES = {
+    "positioning": "positioning",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class Deduplication(BaseModel):
+    """
+    Deduplication configures the methods used to resolve duplicate items between main search results and injected group results.
+    """
+
+    positioning: DedupPositioning
+
+    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 Deduplication 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 Deduplication from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["positioning"] = obj.get("positioning")
+
+        return cls.model_validate(obj)

algoliasearch/composition/models/injection.py

@@ -18,12 +18,14 @@
     from typing_extensions import Self
 
 
+from algoliasearch.composition.models.deduplication import Deduplication
 from algoliasearch.composition.models.injected_item import InjectedItem
 from algoliasearch.composition.models.main import Main
 
 _ALIASES = {
     "main": "main",
     "injected_items": "injectedItems",
+    "deduplication": "deduplication",
 }
 
 
@@ -39,6 +41,7 @@ class Injection(BaseModel):
     main: Main
     injected_items: Optional[List[InjectedItem]] = None
     """ list of injected items of the current Composition. """
+    deduplication: Optional[Deduplication] = None
 
     model_config = ConfigDict(
         strict=False,
@@ -83,5 +86,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             if obj.get("injectedItems") is not None
             else None
         )
+        obj["deduplication"] = (
+            Deduplication.from_dict(obj["deduplication"])
+            if obj.get("deduplication") is not None
+            else None
+        )
 
         return cls.model_validate(obj)