wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/v2/models/direction_constraint.py

@@ -0,0 +1,107 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class DirectionConstraint(BaseModel):
+    """
+    A direction constraint is defined by a vector in world frame and a vector in the TCP frame. The direction constraint is satisfied when the vectors are aligned with each other, which the planner attempts to achieve.  Example: If the world vector is [0, 0, 1] and the TCP vector is [0, 0, -1], the planner will try to keep the TCP facing downward during the motion. The constraint vectors must be normalized.
+    """  # noqa: E501
+
+    world: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)] = Field(
+        description="The direction constraint vector in world frame."
+    )
+    tcp: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)] = Field(
+        description="The direction constraint vector in the TCP frame."
+    )
+    tolerance: Union[StrictFloat, StrictInt] = Field(
+        description="The tolerance in degrees for the direction constraint. The planner will try to satisfy the constraint within this tolerance. Start and target orientations must also satisfy it within this tolerance. "
+    )
+    constraint_name: StrictStr
+    __properties: ClassVar[List[str]] = ["world", "tcp", "tolerance", "constraint_name"]
+
+    @field_validator("constraint_name")
+    def constraint_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["DirectionConstraint"]):
+            raise ValueError("must be one of enum values ('DirectionConstraint')")
+        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 DirectionConstraint 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 DirectionConstraint from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "world": obj.get("world"),
+                "tcp": obj.get("tcp"),
+                "tolerance": obj.get("tolerance"),
+                "constraint_name": obj.get("constraint_name"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/error.py

@@ -0,0 +1,84 @@
+# 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
+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 Error(BaseModel):
+    """
+    Error
+    """  # noqa: E501
+
+    code: Optional[StrictStr] = None
+    message: StrictStr
+    __properties: ClassVar[List[str]] = ["code", "message"]
+
+    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 Error 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 Error from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"code": obj.get("code"), "message": obj.get("message")})
+        return _obj

wandelbots_api_client/v2/models/error_direction_constraint_not_met.py

@@ -0,0 +1,93 @@
+# 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, StrictStr, field_validator
+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 ErrorDirectionConstraintNotMet(BaseModel):
+    """
+    A reference joint position (start or target) violates the direction constraint.
+    """  # noqa: E501
+
+    joint_position: Optional[List[Union[StrictFloat, StrictInt]]] = Field(
+        default=None, description="The joint position violating the direction constraint. "
+    )
+    error_feedback_name: StrictStr
+    __properties: ClassVar[List[str]] = ["joint_position", "error_feedback_name"]
+
+    @field_validator("error_feedback_name")
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ErrorDirectionConstraintNotMet"]):
+            raise ValueError("must be one of enum values ('ErrorDirectionConstraintNotMet')")
+        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 ErrorDirectionConstraintNotMet 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 ErrorDirectionConstraintNotMet 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"), "error_feedback_name": obj.get("error_feedback_name")})
+        return _obj

wandelbots_api_client/v2/models/error_direction_constraint_not_normalized.py

@@ -0,0 +1,96 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ErrorDirectionConstraintNotNormalized(BaseModel):
+    """
+    The provided direction constraint is not normalized.
+    """  # noqa: E501
+
+    direction_constraint: Optional[Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)]] = Field(
+        default=None, description="The direction constraint that is not normalized. "
+    )
+    error_feedback_name: StrictStr
+    __properties: ClassVar[List[str]] = ["direction_constraint", "error_feedback_name"]
+
+    @field_validator("error_feedback_name")
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ErrorDirectionConstraintNotNormalized"]):
+            raise ValueError("must be one of enum values ('ErrorDirectionConstraintNotNormalized')")
+        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 ErrorDirectionConstraintNotNormalized 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 ErrorDirectionConstraintNotNormalized from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"direction_constraint": obj.get("direction_constraint"), "error_feedback_name": obj.get("error_feedback_name")}
+        )
+        return _obj

wandelbots_api_client/v2/models/error_invalid_joint_count.py

@@ -0,0 +1,98 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ErrorInvalidJointCount(BaseModel):
+    """
+    The provided joint data does not match the expected number of joints for this motion group.
+    """  # noqa: E501
+
+    expected_joint_count: StrictInt = Field(description="The expected number of joints for this motion group. ")
+    provided_joint_count: StrictInt = Field(description="The number of provided joints. ")
+    error_feedback_name: StrictStr
+    __properties: ClassVar[List[str]] = ["expected_joint_count", "provided_joint_count", "error_feedback_name"]
+
+    @field_validator("error_feedback_name")
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ErrorInvalidJointCount"]):
+            raise ValueError("must be one of enum values ('ErrorInvalidJointCount')")
+        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 ErrorInvalidJointCount 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 ErrorInvalidJointCount from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "expected_joint_count": obj.get("expected_joint_count"),
+                "provided_joint_count": obj.get("provided_joint_count"),
+                "error_feedback_name": obj.get("error_feedback_name"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/error_joint_limit_exceeded.py

@@ -0,0 +1,103 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ErrorJointLimitExceeded(BaseModel):
+    """
+    A reference joint position (start or target) exceeds the configured joint limits.
+    """  # noqa: E501
+
+    joint_index: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = Field(
+        default=None, description="Index of the joint exceeding its limits (0-based). "
+    )
+    joint_position: Optional[List[Union[StrictFloat, StrictInt]]] = Field(
+        default=None, description="The joint position violating the limits. "
+    )
+    error_feedback_name: StrictStr
+    __properties: ClassVar[List[str]] = ["joint_index", "joint_position", "error_feedback_name"]
+
+    @field_validator("error_feedback_name")
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ErrorJointLimitExceeded"]):
+            raise ValueError("must be one of enum values ('ErrorJointLimitExceeded')")
+        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 ErrorJointLimitExceeded 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 ErrorJointLimitExceeded from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "joint_index": obj.get("joint_index"),
+                "joint_position": obj.get("joint_position"),
+                "error_feedback_name": obj.get("error_feedback_name"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/error_joint_position_collision.py

@@ -0,0 +1,106 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wandelbots_api_client.v2.models.collision import Collision
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ErrorJointPositionCollision(BaseModel):
+    """
+    A reference joint position, e.g., start or target joint position, results in collisions that prevent processing.
+    """  # noqa: E501
+
+    collisions: Optional[List[Collision]] = None
+    joint_position: Optional[List[Union[StrictFloat, StrictInt]]] = Field(default=None, description="The joint position that collides. ")
+    error_feedback_name: StrictStr
+    __properties: ClassVar[List[str]] = ["collisions", "joint_position", "error_feedback_name"]
+
+    @field_validator("error_feedback_name")
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ErrorJointPositionCollision"]):
+            raise ValueError("must be one of enum values ('ErrorJointPositionCollision')")
+        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 ErrorJointPositionCollision 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 collisions (list)
+        _items = []
+        if self.collisions:
+            for _item_collisions in self.collisions:
+                if _item_collisions:
+                    _items.append(_item_collisions.to_dict())
+            _dict["collisions"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ErrorJointPositionCollision from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "collisions": [Collision.from_dict(_item) for _item in obj["collisions"]] if obj.get("collisions") is not None else None,
+                "joint_position": obj.get("joint_position"),
+                "error_feedback_name": obj.get("error_feedback_name"),
+            }
+        )
+        return _obj