wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/models/bus_ios_state_enum.py

@@ -0,0 +1,36 @@
+# 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 BusIOsStateEnum(str, Enum):
+    """
+    Current state of the BUS input/output service.
+    """
+
+    """
+    allowed enum values
+    """
+    BUS_IOS_STATE_UNKNOWN = "BUS_IOS_STATE_UNKNOWN"
+    BUS_IOS_STATE_INITIALIZING = "BUS_IOS_STATE_INITIALIZING"
+    BUS_IOS_STATE_CONNECTED = "BUS_IOS_STATE_CONNECTED"
+    BUS_IOS_STATE_DISCONNECTED = "BUS_IOS_STATE_DISCONNECTED"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BusIOsStateEnum from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/capsule.py

@@ -0,0 +1,94 @@
+# 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 Capsule(BaseModel):
+    """
+    Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
+    """  # noqa: E501
+
+    shape_type: StrictStr
+    radius: Union[StrictFloat, StrictInt] = Field(description="The radius of the cylinder and semi-spheres in [mm].")
+    cylinder_height: Union[StrictFloat, StrictInt] = Field(description="The height of the inner cylinder in [mm].")
+    __properties: ClassVar[List[str]] = ["shape_type", "radius", "cylinder_height"]
+
+    @field_validator("shape_type")
+    def shape_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["capsule"]):
+            raise ValueError("must be one of enum values ('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 Capsule 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 Capsule 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"), "cylinder_height": obj.get("cylinder_height")}
+        )
+        return _obj

wandelbots_api_client/v2/models/cartesian_limits.py

@@ -0,0 +1,108 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class CartesianLimits(BaseModel):
+    """
+    CartesianLimits
+    """  # noqa: E501
+
+    velocity: Optional[Union[StrictFloat, StrictInt]] = None
+    acceleration: Optional[Union[StrictFloat, StrictInt]] = None
+    jerk: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None, description="> **NOTE** > > This limit type is experimental and its behavior may change in future releases. "
+    )
+    orientation_velocity: Optional[Union[StrictFloat, StrictInt]] = None
+    orientation_acceleration: Optional[Union[StrictFloat, StrictInt]] = None
+    orientation_jerk: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None, description="> **NOTE** > > This limit type is experimental and its behavior may change in future releases. "
+    )
+    __properties: ClassVar[List[str]] = [
+        "velocity",
+        "acceleration",
+        "jerk",
+        "orientation_velocity",
+        "orientation_acceleration",
+        "orientation_jerk",
+    ]
+
+    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 CartesianLimits 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 CartesianLimits from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "velocity": obj.get("velocity"),
+                "acceleration": obj.get("acceleration"),
+                "jerk": obj.get("jerk"),
+                "orientation_velocity": obj.get("orientation_velocity"),
+                "orientation_acceleration": obj.get("orientation_acceleration"),
+                "orientation_jerk": obj.get("orientation_jerk"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/cell.py

@@ -0,0 +1,127 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.app import App
+from wandelbots_api_client.v2.models.robot_controller import RobotController
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class Cell(BaseModel):
+    """
+    To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g., robot controllers, also within apps.
+    """  # noqa: E501
+
+    name: Annotated[str, Field(strict=True)] = Field(
+        description="A unique name for the cell used as an identifier for addressing the cell in all API calls. It must be a valid k8s label name as defined by [RFC 1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names). "
+    )
+    version: Optional[StrictStr] = Field(
+        default=None, description="Wandelbots NOVA version of the cell. This version must not exceed the current system version. "
+    )
+    description: Optional[Annotated[str, Field(strict=True, max_length=200)]] = Field(
+        default=None, description="A description of the cell. "
+    )
+    controllers: Optional[List[RobotController]] = None
+    apps: Optional[List[App]] = None
+    __properties: ClassVar[List[str]] = ["name", "version", "description", "controllers", "apps"]
+
+    @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,30}[a-z0-9]$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z][a-z0-9-]{0,30}[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 Cell 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 each item in controllers (list)
+        _items = []
+        if self.controllers:
+            for _item_controllers in self.controllers:
+                if _item_controllers:
+                    _items.append(_item_controllers.to_dict())
+            _dict["controllers"] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in apps (list)
+        _items = []
+        if self.apps:
+            for _item_apps in self.apps:
+                if _item_apps:
+                    _items.append(_item_apps.to_dict())
+            _dict["apps"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Cell 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"),
+                "version": obj.get("version"),
+                "description": obj.get("description"),
+                "controllers": [RobotController.from_dict(_item) for _item in obj["controllers"]]
+                if obj.get("controllers") is not None
+                else None,
+                "apps": [App.from_dict(_item) for _item in obj["apps"]] if obj.get("apps") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/cloud_config_status.py

@@ -0,0 +1,164 @@
+# 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.cloud_config_status_configured import CloudConfigStatusConfigured
+from wandelbots_api_client.v2.models.cloud_config_status_not_configured import CloudConfigStatusNotConfigured
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+CLOUDCONFIGSTATUS_ONE_OF_SCHEMAS = ["CloudConfigStatusConfigured", "CloudConfigStatusNotConfigured"]
+
+
+class CloudConfigStatus(BaseModel):
+    """
+    CloudConfigStatus
+    """
+
+    # data type: CloudConfigStatusConfigured
+    oneof_schema_1_validator: Optional[CloudConfigStatusConfigured] = None
+    # data type: CloudConfigStatusNotConfigured
+    oneof_schema_2_validator: Optional[CloudConfigStatusNotConfigured] = None
+    actual_instance: Optional[Union[CloudConfigStatusConfigured, CloudConfigStatusNotConfigured]] = None
+    one_of_schemas: Set[str] = {"CloudConfigStatusConfigured", "CloudConfigStatusNotConfigured"}
+
+    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 = CloudConfigStatus.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: CloudConfigStatusConfigured
+        if not isinstance(v, CloudConfigStatusConfigured):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CloudConfigStatusConfigured`")
+        else:
+            match += 1
+        # validate data type: CloudConfigStatusNotConfigured
+        if not isinstance(v, CloudConfigStatusNotConfigured):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CloudConfigStatusNotConfigured`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in CloudConfigStatus with oneOf schemas: CloudConfigStatusConfigured, CloudConfigStatusNotConfigured. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in CloudConfigStatus with oneOf schemas: CloudConfigStatusConfigured, CloudConfigStatusNotConfigured. 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("status")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `status` in the input.")
+
+        # check if data type is `CloudConfigStatusConfigured`
+        if _data_type == "configured":
+            instance.actual_instance = CloudConfigStatusConfigured.from_json(json_str)
+            return instance
+
+        # check if data type is `CloudConfigStatusNotConfigured`
+        if _data_type == "not_configured":
+            instance.actual_instance = CloudConfigStatusNotConfigured.from_json(json_str)
+            return instance
+
+        # deserialize data into CloudConfigStatusConfigured
+        try:
+            instance.actual_instance = CloudConfigStatusConfigured.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CloudConfigStatusNotConfigured
+        try:
+            instance.actual_instance = CloudConfigStatusNotConfigured.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 CloudConfigStatus with oneOf schemas: CloudConfigStatusConfigured, CloudConfigStatusNotConfigured. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into CloudConfigStatus with oneOf schemas: CloudConfigStatusConfigured, CloudConfigStatusNotConfigured. 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], CloudConfigStatusConfigured, CloudConfigStatusNotConfigured]]:
+        """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())

wandelbots_api_client/v2/models/cloud_config_status_configured.py

@@ -0,0 +1,97 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from wandelbots_api_client.v2.models.cloud_configuration import CloudConfiguration
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class CloudConfigStatusConfigured(BaseModel):
+    """
+    CloudConfigStatusConfigured
+    """  # noqa: E501
+
+    status: StrictStr
+    config: CloudConfiguration
+    __properties: ClassVar[List[str]] = ["status", "config"]
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["configured"]):
+            raise ValueError("must be one of enum values ('configured')")
+        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 CloudConfigStatusConfigured 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 config
+        if self.config:
+            _dict["config"] = self.config.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CloudConfigStatusConfigured from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"status": obj.get("status"), "config": CloudConfiguration.from_dict(obj["config"]) if obj.get("config") is not None else None}
+        )
+        return _obj