wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/models/program_start_request.py

@@ -0,0 +1,83 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ProgramStartRequest(BaseModel):
+    """
+    The state of a program run.
+    """  # noqa: E501
+
+    arguments: Dict[str, Any] = Field(description="The arguments to pass to the program.")
+    __properties: ClassVar[List[str]] = ["arguments"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ProgramStartRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProgramStartRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"arguments": obj.get("arguments")})
+        return _obj

wandelbots_api_client/v2/models/rectangle.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class Rectangle(BaseModel):
+    """
+    Defines an x/y-plane with finite size. Centred around the z-axis.
+    """  # noqa: E501
+
+    shape_type: StrictStr
+    size_x: Union[StrictFloat, StrictInt] = Field(description="The dimension in x-direction in [mm].")
+    size_y: Union[StrictFloat, StrictInt] = Field(description="The dimension in y-direction in [mm].")
+    __properties: ClassVar[List[str]] = ["shape_type", "size_x", "size_y"]
+
+    @field_validator("shape_type")
+    def shape_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["rectangle"]):
+            raise ValueError("must be one of enum values ('rectangle')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Rectangle from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Rectangle from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"shape_type": obj.get("shape_type"), "size_x": obj.get("size_x"), "size_y": obj.get("size_y")})
+        return _obj

wandelbots_api_client/v2/models/rectangular_capsule.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class RectangularCapsule(BaseModel):
+    """
+    Convex hull around four spheres. Sphere center points in x/y-plane, offset by either combination \"+/- sizeX\" or \"+/- sizeY\".  Alternative description: Rectangle in x/y-plane with a 3D padding.
+    """  # noqa: E501
+
+    shape_type: StrictStr
+    radius: Union[StrictFloat, StrictInt] = Field(description="The radius of the inner spheres in [mm].")
+    sphere_center_distance_x: Union[StrictFloat, StrictInt] = Field(description="The distance of the sphere center in x-direction in [mm].")
+    sphere_center_distance_y: Union[StrictFloat, StrictInt] = Field(description="The distance of the sphere center in y-direction in [mm].")
+    __properties: ClassVar[List[str]] = ["shape_type", "radius", "sphere_center_distance_x", "sphere_center_distance_y"]
+
+    @field_validator("shape_type")
+    def shape_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["rectangular_capsule"]):
+            raise ValueError("must be one of enum values ('rectangular_capsule')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RectangularCapsule from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RectangularCapsule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "shape_type": obj.get("shape_type"),
+                "radius": obj.get("radius"),
+                "sphere_center_distance_x": obj.get("sphere_center_distance_x"),
+                "sphere_center_distance_y": obj.get("sphere_center_distance_y"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/release_channel.py

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ReleaseChannel(str, Enum):
+    """
+    The channel that defines what a new Wandelbots NOVA version is.    * `next` the latest version   * `stable` newest patch of the current version
+    """
+
+    """
+    allowed enum values
+    """
+    STABLE = "stable"
+    NEXT = "next"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ReleaseChannel from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/robot_controller.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.robot_controller_configuration import RobotControllerConfiguration
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class RobotController(BaseModel):
+    """
+    The configuration of a physical or virtual robot controller.
+    """  # noqa: E501
+
+    name: Annotated[str, Field(strict=True)] = Field(
+        description="Unique name of controller within the cell. It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names). "
+    )
+    configuration: RobotControllerConfiguration
+    __properties: ClassVar[List[str]] = ["name", "configuration"]
+
+    @field_validator("name")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z][a-z0-9-]{0,61}[a-z0-9]$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z][a-z0-9-]{0,61}[a-z0-9]$/")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RobotController from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of configuration
+        if self.configuration:
+            _dict["configuration"] = self.configuration.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RobotController from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": obj.get("name"),
+                "configuration": RobotControllerConfiguration.from_dict(obj["configuration"])
+                if obj.get("configuration") is not None
+                else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/robot_controller_configuration.py

@@ -0,0 +1,262 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from wandelbots_api_client.v2.models.abb_controller import AbbController
+from wandelbots_api_client.v2.models.fanuc_controller import FanucController
+from wandelbots_api_client.v2.models.kuka_controller import KukaController
+from wandelbots_api_client.v2.models.universalrobots_controller import UniversalrobotsController
+from wandelbots_api_client.v2.models.virtual_controller import VirtualController
+from wandelbots_api_client.v2.models.yaskawa_controller import YaskawaController
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+ROBOTCONTROLLERCONFIGURATION_ONE_OF_SCHEMAS = [
+    "AbbController",
+    "FanucController",
+    "KukaController",
+    "UniversalrobotsController",
+    "VirtualController",
+    "YaskawaController",
+]
+
+
+class RobotControllerConfiguration(BaseModel):
+    """
+    RobotControllerConfiguration
+    """
+
+    # data type: AbbController
+    oneof_schema_1_validator: Optional[AbbController] = None
+    # data type: FanucController
+    oneof_schema_2_validator: Optional[FanucController] = None
+    # data type: KukaController
+    oneof_schema_3_validator: Optional[KukaController] = None
+    # data type: UniversalrobotsController
+    oneof_schema_4_validator: Optional[UniversalrobotsController] = None
+    # data type: VirtualController
+    oneof_schema_5_validator: Optional[VirtualController] = None
+    # data type: YaskawaController
+    oneof_schema_6_validator: Optional[YaskawaController] = None
+    actual_instance: Optional[
+        Union[AbbController, FanucController, KukaController, UniversalrobotsController, VirtualController, YaskawaController]
+    ] = None
+    one_of_schemas: Set[str] = {
+        "AbbController",
+        "FanucController",
+        "KukaController",
+        "UniversalrobotsController",
+        "VirtualController",
+        "YaskawaController",
+    }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    discriminator_value_class_map: Dict[str, str] = {}
+
+    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])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = RobotControllerConfiguration.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: AbbController
+        if not isinstance(v, AbbController):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `AbbController`")
+        else:
+            match += 1
+        # validate data type: FanucController
+        if not isinstance(v, FanucController):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `FanucController`")
+        else:
+            match += 1
+        # validate data type: KukaController
+        if not isinstance(v, KukaController):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `KukaController`")
+        else:
+            match += 1
+        # validate data type: UniversalrobotsController
+        if not isinstance(v, UniversalrobotsController):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `UniversalrobotsController`")
+        else:
+            match += 1
+        # validate data type: VirtualController
+        if not isinstance(v, VirtualController):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `VirtualController`")
+        else:
+            match += 1
+        # validate data type: YaskawaController
+        if not isinstance(v, YaskawaController):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `YaskawaController`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in RobotControllerConfiguration with oneOf schemas: AbbController, FanucController, KukaController, UniversalrobotsController, VirtualController, YaskawaController. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in RobotControllerConfiguration with oneOf schemas: AbbController, FanucController, KukaController, UniversalrobotsController, VirtualController, YaskawaController. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(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 = []
+        match = 0
+
+        # use oneOf discriminator to lookup the data type
+        _data_type = json.loads(json_str).get("kind")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `kind` in the input.")
+
+        # check if data type is `AbbController`
+        if _data_type == "AbbController":
+            instance.actual_instance = AbbController.from_json(json_str)
+            return instance
+
+        # check if data type is `FanucController`
+        if _data_type == "FanucController":
+            instance.actual_instance = FanucController.from_json(json_str)
+            return instance
+
+        # check if data type is `KukaController`
+        if _data_type == "KukaController":
+            instance.actual_instance = KukaController.from_json(json_str)
+            return instance
+
+        # check if data type is `UniversalrobotsController`
+        if _data_type == "UniversalrobotsController":
+            instance.actual_instance = UniversalrobotsController.from_json(json_str)
+            return instance
+
+        # check if data type is `VirtualController`
+        if _data_type == "VirtualController":
+            instance.actual_instance = VirtualController.from_json(json_str)
+            return instance
+
+        # check if data type is `YaskawaController`
+        if _data_type == "YaskawaController":
+            instance.actual_instance = YaskawaController.from_json(json_str)
+            return instance
+
+        # deserialize data into AbbController
+        try:
+            instance.actual_instance = AbbController.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into FanucController
+        try:
+            instance.actual_instance = FanucController.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into KukaController
+        try:
+            instance.actual_instance = KukaController.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into UniversalrobotsController
+        try:
+            instance.actual_instance = UniversalrobotsController.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into VirtualController
+        try:
+            instance.actual_instance = VirtualController.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into YaskawaController
+        try:
+            instance.actual_instance = YaskawaController.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when deserializing the JSON string into RobotControllerConfiguration with oneOf schemas: AbbController, FanucController, KukaController, UniversalrobotsController, VirtualController, YaskawaController. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into RobotControllerConfiguration with oneOf schemas: AbbController, FanucController, KukaController, UniversalrobotsController, VirtualController, YaskawaController. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    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):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(
+        self,
+    ) -> Optional[
+        Union[
+            Dict[str, Any], AbbController, FanucController, KukaController, UniversalrobotsController, VirtualController, YaskawaController
+        ]
+    ]:
+        """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):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())