feat(specs): update transformation specs for no-code (generated)

algolia/api-clients-automation#4901

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Mehmet Ali Gok <[email protected]>

Author: algolia-bot

algoliasearch/ingestion/models/transformation.py

@@ -18,10 +18,15 @@
     from typing_extensions import Self
 
 
+from algoliasearch.ingestion.models.transformation_input import TransformationInput
+from algoliasearch.ingestion.models.transformation_type import TransformationType
+
 _ALIASES = {
     "transformation_id": "transformationID",
     "authentication_ids": "authenticationIDs",
     "code": "code",
+    "type": "type",
+    "input": "input",
     "name": "name",
     "description": "description",
     "owner": "owner",
@@ -44,7 +49,9 @@ class Transformation(BaseModel):
     authentication_ids: Optional[List[str]] = None
     """ The authentications associated with the current transformation. """
     code: str
-    """ The source code of the transformation. """
+    """ It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code. """
+    type: Optional[TransformationType] = None
+    input: Optional[TransformationInput] = None
     name: str
     """ The uniquely identified name of your transformation. """
     description: Optional[str] = None
@@ -91,4 +98,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         if not isinstance(obj, dict):
             return cls.model_validate(obj)
 
+        obj["type"] = obj.get("type")
+        obj["input"] = (
+            TransformationInput.from_dict(obj["input"])
+            if obj.get("input") is not None
+            else None
+        )
+
         return cls.model_validate(obj)

algoliasearch/ingestion/models/transformation_code.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 = {
+    "code": "code",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class TransformationCode(BaseModel):
+    """
+    Input for a transformation that contains the source code of the transformation.
+    """
+
+    code: str
+    """ The source code of the transformation. """
+
+    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 TransformationCode 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 TransformationCode from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)

algoliasearch/ingestion/models/transformation_create.py

@@ -18,9 +18,14 @@
     from typing_extensions import Self
 
 
+from algoliasearch.ingestion.models.transformation_input import TransformationInput
+from algoliasearch.ingestion.models.transformation_type import TransformationType
+
 _ALIASES = {
     "code": "code",
     "name": "name",
+    "type": "type",
+    "input": "input",
     "description": "description",
     "authentication_ids": "authenticationIDs",
 }
@@ -35,10 +40,12 @@ class TransformationCreate(BaseModel):
     API request body for creating a transformation.
     """
 
-    code: str
-    """ The source code of the transformation. """
+    code: Optional[str] = None
+    """ It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code. """
     name: str
     """ The uniquely identified name of your transformation. """
+    type: TransformationType
+    input: TransformationInput
     description: Optional[str] = None
     """ A descriptive name for your transformation of what it does. """
     authentication_ids: Optional[List[str]] = None
@@ -79,4 +86,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         if not isinstance(obj, dict):
             return cls.model_validate(obj)
 
+        obj["type"] = obj.get("type")
+        obj["input"] = (
+            TransformationInput.from_dict(obj["input"])
+            if obj.get("input") is not None
+            else None
+        )
+
         return cls.model_validate(obj)

algoliasearch/ingestion/models/transformation_input.py

@@ -0,0 +1,113 @@
+# 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 dumps
+from sys import version_info
+from typing import Any, Dict, Optional, Set, Union
+
+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.ingestion.models.transformation_code import TransformationCode
+from algoliasearch.ingestion.models.transformation_no_code import TransformationNoCode
+
+
+class TransformationInput(BaseModel):
+    """
+    The input for the transformation, which can be either code or a no-code configuration.
+    """
+
+    oneof_schema_1_validator: Optional[TransformationCode] = Field(default=None)
+
+    oneof_schema_2_validator: Optional[TransformationNoCode] = Field(default=None)
+
+    actual_instance: Union[TransformationCode, TransformationNoCode, None] = None
+    one_of_schemas: Set[str] = {"TransformationCode", "TransformationNoCode"}
+
+    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[TransformationCode, TransformationNoCode, 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_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        """Create an instance of TransformationInput from a JSON string"""
+        return cls.from_json(dumps(obj))
+
+    @classmethod
+    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 = TransformationCode.from_json(json_str)
+
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        try:
+            instance.actual_instance = TransformationNoCode.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 TransformationInput with oneOf schemas: TransformationCode, TransformationNoCode. Details: "
+            + ", ".join(error_messages)
+        )
+
+    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], TransformationCode, TransformationNoCode]]:
+        """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/ingestion/models/transformation_no_code.py

@@ -0,0 +1,72 @@
+# 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
+
+
+_ALIASES = {
+    "steps": "steps",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class TransformationNoCode(BaseModel):
+    """
+    Input for a no-code transformation that contains a series of steps.
+    """
+
+    steps: List[object]
+
+    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 TransformationNoCode 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 TransformationNoCode from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)

algoliasearch/ingestion/models/transformation_try.py

@@ -37,7 +37,7 @@ class TransformationTry(BaseModel):
     """
 
     code: str
-    """ The source code of the transformation. """
+    """ It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code. """
     sample_record: object
     """ The record to apply the given code to. """
     authentications: Optional[List[AuthenticationCreate]] = None

algoliasearch/ingestion/models/transformation_type.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 TransformationType(str, Enum):
+    """
+    The type of transformation, which can be either 'code' or 'noCode'.
+    """
+
+    """
+    allowed enum values
+    """
+    CODE = "code"
+
+    NOCODE = "noCode"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TransformationType from a JSON string"""
+        return cls(loads(json_str))