wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/v2/models/error_max_iterations_exceeded.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0
+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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ErrorMaxIterationsExceeded(BaseModel):
+    """
+    The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions.
+    """  # noqa: E501
+
+    max_iterations: Optional[StrictInt] = Field(default=None, description="The maximum number of iterations that was reached. ")
+    error_feedback_name: StrictStr
+    __properties: ClassVar[List[str]] = ["max_iterations", "error_feedback_name"]
+
+    @field_validator("error_feedback_name")
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ErrorMaxIterationsExceeded"]):
+            raise ValueError("must be one of enum values ('ErrorMaxIterationsExceeded')")
+        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 ErrorMaxIterationsExceeded 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 ErrorMaxIterationsExceeded from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"max_iterations": obj.get("max_iterations"), "error_feedback_name": obj.get("error_feedback_name")})
+        return _obj

wandelbots_api_client/v2/models/error_motion_group_key_mismatch.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0
+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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ErrorMotionGroupKeyMismatch(BaseModel):
+    """
+    ErrorMotionGroupKeyMismatch
+    """  # noqa: E501
+
+    invalid_motion_group_keys: Optional[List[StrictStr]] = Field(
+        default=None, description="Motion group keys that have no matching motion group setup. "
+    )
+    __properties: ClassVar[List[str]] = ["invalid_motion_group_keys"]
+
+    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 ErrorMotionGroupKeyMismatch 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 ErrorMotionGroupKeyMismatch from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"invalid_motion_group_keys": obj.get("invalid_motion_group_keys")})
+        return _obj

wandelbots_api_client/v2/models/error_unsupported_operation.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0
+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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ErrorUnsupportedOperation(BaseModel):
+    """
+    The operation requested is not supported.
+    """  # noqa: E501
+
+    error_feedback_name: StrictStr
+    __properties: ClassVar[List[str]] = ["error_feedback_name"]
+
+    @field_validator("error_feedback_name")
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ErrorUnsupportedOperation"]):
+            raise ValueError("must be one of enum values ('ErrorUnsupportedOperation')")
+        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 ErrorUnsupportedOperation 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 ErrorUnsupportedOperation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"error_feedback_name": obj.get("error_feedback_name")})
+        return _obj

wandelbots_api_client/v2/models/execute.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0
+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 wandelbots_api_client.v2.models.execute_details import ExecuteDetails
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class Execute(BaseModel):
+    """
+    Details about the state of the motion execution. The details are either for a jogging or a trajectory. If NOVA is not controlling this motion group at the moment, this field is omitted.
+    """  # noqa: E501
+
+    joint_position: List[Union[StrictFloat, StrictInt]] = Field(
+        description="Commanded joint position of each joint. This command was sent in the time step the corresponding state was received. The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm]. "
+    )
+    details: Optional[ExecuteDetails] = None
+    __properties: ClassVar[List[str]] = ["joint_position", "details"]
+
+    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 Execute 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 details
+        if self.details:
+            _dict["details"] = self.details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Execute from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "joint_position": obj.get("joint_position"),
+                "details": ExecuteDetails.from_dict(obj["details"]) if obj.get("details") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/execute_details.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
+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.jogging_details import JoggingDetails
+from wandelbots_api_client.v2.models.trajectory_details import TrajectoryDetails
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+EXECUTEDETAILS_ONE_OF_SCHEMAS = ["JoggingDetails", "TrajectoryDetails"]
+
+
+class ExecuteDetails(BaseModel):
+    """
+    ExecuteDetails
+    """
+
+    # data type: JoggingDetails
+    oneof_schema_1_validator: Optional[JoggingDetails] = None
+    # data type: TrajectoryDetails
+    oneof_schema_2_validator: Optional[TrajectoryDetails] = None
+    actual_instance: Optional[Union[JoggingDetails, TrajectoryDetails]] = None
+    one_of_schemas: Set[str] = {"JoggingDetails", "TrajectoryDetails"}
+
+    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 = ExecuteDetails.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: JoggingDetails
+        if not isinstance(v, JoggingDetails):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `JoggingDetails`")
+        else:
+            match += 1
+        # validate data type: TrajectoryDetails
+        if not isinstance(v, TrajectoryDetails):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TrajectoryDetails`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. 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 `JoggingDetails`
+        if _data_type == "JOGGING":
+            instance.actual_instance = JoggingDetails.from_json(json_str)
+            return instance
+
+        # check if data type is `TrajectoryDetails`
+        if _data_type == "TRAJECTORY":
+            instance.actual_instance = TrajectoryDetails.from_json(json_str)
+            return instance
+
+        # deserialize data into JoggingDetails
+        try:
+            instance.actual_instance = JoggingDetails.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into TrajectoryDetails
+        try:
+            instance.actual_instance = TrajectoryDetails.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 ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. 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], JoggingDetails, TrajectoryDetails]]:
+        """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())