feat(specs): add fields for metadata in composition injectedItems (generated)

algolia/api-clients-automation#5241

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

Author: algolia-bot

algoliasearch/composition/models/__init__.py

@@ -29,6 +29,7 @@
 from .highlight_result import HighlightResult
 from .highlight_result_option import HighlightResultOption
 from .hit import Hit
+from .hit_metadata import HitMetadata
 from .hit_ranking_info import HitRankingInfo
 from .inside_bounding_box import InsideBoundingBox
 from .match_level import MatchLevel
@@ -84,6 +85,7 @@
     "HighlightResult",
     "HighlightResultOption",
     "Hit",
+    "HitMetadata",
     "HitRankingInfo",
     "InsideBoundingBox",
     "MatchLevel",

algoliasearch/composition/models/hit.py

@@ -19,6 +19,7 @@
 
 
 from algoliasearch.composition.models.highlight_result import HighlightResult
+from algoliasearch.composition.models.hit_metadata import HitMetadata
 from algoliasearch.composition.models.hit_ranking_info import HitRankingInfo
 from algoliasearch.composition.models.snippet_result import SnippetResult
 
@@ -28,6 +29,7 @@
     "snippet_result": "_snippetResult",
     "ranking_info": "_rankingInfo",
     "distinct_seq_id": "_distinctSeqID",
+    "extra": "_extra",
 }
 
 
@@ -48,6 +50,7 @@ class Hit(BaseModel):
     """ Snippets that show the context around a matching search query. """
     ranking_info: Optional[HitRankingInfo] = None
     distinct_seq_id: Optional[int] = None
+    extra: Optional[HitMetadata] = None
 
     model_config = ConfigDict(
         strict=False,
@@ -105,5 +108,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             if obj.get("_rankingInfo") is not None
             else None
         )
+        obj["_extra"] = (
+            HitMetadata.from_dict(obj["_extra"])
+            if obj.get("_extra") is not None
+            else None
+        )
 
         return cls.model_validate(obj)

algoliasearch/composition/models/hit_metadata.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 = {
+    "injected_item_key": "_injectedItemKey",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class HitMetadata(BaseModel):
+    """
+    An object that contains the extra key-value pairs provided in the injectedItem definition.
+    """
+
+    injected_item_key: Optional[str] = None
+    """ The key of the injectedItem that inserted this metadata. """
+
+    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 HitMetadata 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 HitMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)