feat(specs): add with transformation helpers (generated)

algolia/api-clients-automation#4931

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

Author: algolia-bot

algoliasearch/ingestion/models/watch_response.py

@@ -44,11 +44,11 @@ class WatchResponse(BaseModel):
     event_id: Optional[str] = None
     """ Universally unique identifier (UUID) of an event. """
     data: Optional[List[object]] = None
-    """ when used with discovering or validating sources, the sampled data of your source is returned. """
+    """ This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.  """
     events: Optional[List[Event]] = None
-    """ in case of error, observability events will be added to the response, if any. """
+    """ in case of error, observability events will be added to the response. """
     message: Optional[str] = None
-    """ a message describing the outcome of a validate run. """
+    """ a message describing the outcome of the operation that has been ran (push, discover or validate) run. """
     created_at: Optional[str] = None
     """ Date of creation in RFC 3339 format. """
 

algoliasearch/search/models/__init__.py

@@ -62,6 +62,9 @@
 from .edit import Edit
 from .edit_type import EditType
 from .error_base import ErrorBase
+from .event import Event
+from .event_status import EventStatus
+from .event_type import EventType
 from .exact_on_single_word_query import ExactOnSingleWordQuery
 from .exhaustive import Exhaustive
 from .facet_filters import FacetFilters
@@ -230,6 +233,9 @@
     "Edit",
     "EditType",
     "ErrorBase",
+    "Event",
+    "EventStatus",
+    "EventType",
     "ExactOnSingleWordQuery",
     "Exhaustive",
     "FacetFilters",

algoliasearch/search/models/event.py

@@ -0,0 +1,94 @@
+# 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, Union
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+from algoliasearch.search.models.event_status import EventStatus
+from algoliasearch.search.models.event_type import EventType
+
+_ALIASES = {
+    "event_id": "eventID",
+    "run_id": "runID",
+    "status": "status",
+    "type": "type",
+    "batch_size": "batchSize",
+    "data": "data",
+    "published_at": "publishedAt",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class Event(BaseModel):
+    """
+    An event describe a step of the task execution flow..
+    """
+
+    event_id: str
+    """ Universally unique identifier (UUID) of an event. """
+    run_id: str
+    """ Universally unique identifier (UUID) of a task run. """
+    status: Union[EventStatus, None]
+    type: EventType
+    batch_size: int
+    """ The extracted record batch size. """
+    data: Optional[Dict[str, object]] = None
+    published_at: str
+    """ Date of publish RFC 3339 format. """
+
+    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 Event 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 Event from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["status"] = obj.get("status")
+        obj["type"] = obj.get("type")
+
+        return cls.model_validate(obj)

algoliasearch/search/models/event_status.py

@@ -0,0 +1,42 @@
+# 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 EventStatus(str, Enum):
+    """
+    EventStatus
+    """
+
+    """
+    allowed enum values
+    """
+    CREATED = "created"
+
+    STARTED = "started"
+
+    RETRIED = "retried"
+
+    FAILED = "failed"
+
+    SUCCEEDED = "succeeded"
+
+    CRITICAL = "critical"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EventStatus from a JSON string"""
+        return cls(loads(json_str))

algoliasearch/search/models/event_type.py

@@ -0,0 +1,38 @@
+# 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 EventType(str, Enum):
+    """
+    EventType
+    """
+
+    """
+    allowed enum values
+    """
+    FETCH = "fetch"
+
+    RECORD = "record"
+
+    LOG = "log"
+
+    TRANSFORM = "transform"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EventType from a JSON string"""
+        return cls(loads(json_str))

algoliasearch/search/models/watch_response.py

@@ -0,0 +1,96 @@
+# 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.search.models.event import Event
+
+_ALIASES = {
+    "run_id": "runID",
+    "event_id": "eventID",
+    "data": "data",
+    "events": "events",
+    "message": "message",
+    "created_at": "createdAt",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class WatchResponse(BaseModel):
+    """
+    WatchResponse
+    """
+
+    run_id: str
+    """ Universally unique identifier (UUID) of a task run. """
+    event_id: Optional[str] = None
+    """ Universally unique identifier (UUID) of an event. """
+    data: Optional[List[object]] = None
+    """ This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.  """
+    events: Optional[List[Event]] = None
+    """ in case of error, observability events will be added to the response. """
+    message: Optional[str] = None
+    """ a message describing the outcome of the operation that has been ran (push, discover or validate) run. """
+    created_at: Optional[str] = None
+    """ Date of creation in RFC 3339 format. """
+
+    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 WatchResponse 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 WatchResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["events"] = (
+            [Event.from_dict(_item) for _item in obj["events"]]
+            if obj.get("events") is not None
+            else None
+        )
+
+        return cls.model_validate(obj)