wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/models/command.py

@@ -0,0 +1,140 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.models.circle import Circle
+from wandelbots_api_client.models.command_settings import CommandSettings
+from wandelbots_api_client.models.cubic_spline import CubicSpline
+from wandelbots_api_client.models.joints import Joints
+from wandelbots_api_client.models.pose import Pose
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Command(BaseModel):
+    """
+    A command is a single motion command (line, circle, joint_ptp, cartesian_ptp, cubic_spline) with corresponding settings (limits, blending). The motion commands are a flattened union/oneof type. Only set one of the motion commands per command. A motion command always starts at the end of the previous motion command. Subsequently, a plan request must have start joint configuration to plan a well defined motion.
+    """  # noqa: E501
+
+    settings: Optional[CommandSettings] = Field(
+        default=None,
+        description="Command settings for a single motion command. Allow blending between two motion commands or override limits on a motion command level.",
+    )
+    line: Optional[Pose] = Field(
+        default=None,
+        description="A line is representing a straight line from start position to provided target position. The orientation is calculated via a quaternion [slerp](https://en.wikipedia.org/wiki/Slerp) from start orienation to provided target orientation.",
+    )
+    circle: Optional[Circle] = Field(
+        default=None,
+        description="A circular constructs a circle in translative space from start position, provided via position, and provided target position. The orientation is calculated via a [bezier spline](https://en.wikipedia.org/wiki/B%C3%A9zier_curve) from start orienation to provided target orientation. The via point defines the control point for the bezier spline. Therefore, the control point will not be hit directly.",
+    )
+    joint_ptp: Optional[Joints] = Field(
+        default=None, description="A joint point-to-point is representing a line in joint space. All joints will be moved synchronously."
+    )
+    cartesian_ptp: Optional[Pose] = Field(
+        default=None,
+        description="A cartesian point-to-point is representing a joint point-to-point motion from start point to provided target pose. This is a joint point-to-point as well, but the target is given in cartesian space. The target joint configuration will be calculated to be in the same kinematic configuration as the start point is. If that is not possible, planning will fail.",
+    )
+    cubic_spline: Optional[CubicSpline] = Field(
+        default=None,
+        description="A [cubic spline](https://de.wikipedia.org/wiki/Spline-Interpolation) is representing a cartesian cubic spline in translative and orientational space from start point to provided target pose via control points.",
+    )
+    __properties: ClassVar[List[str]] = ["settings", "line", "circle", "joint_ptp", "cartesian_ptp", "cubic_spline"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Command 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 settings
+        if self.settings:
+            _dict["settings"] = self.settings.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of line
+        if self.line:
+            _dict["line"] = self.line.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of circle
+        if self.circle:
+            _dict["circle"] = self.circle.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of joint_ptp
+        if self.joint_ptp:
+            _dict["joint_ptp"] = self.joint_ptp.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of cartesian_ptp
+        if self.cartesian_ptp:
+            _dict["cartesian_ptp"] = self.cartesian_ptp.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of cubic_spline
+        if self.cubic_spline:
+            _dict["cubic_spline"] = self.cubic_spline.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Command from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "settings": CommandSettings.from_dict(obj["settings"]) if obj.get("settings") is not None else None,
+                "line": Pose.from_dict(obj["line"]) if obj.get("line") is not None else None,
+                "circle": Circle.from_dict(obj["circle"]) if obj.get("circle") is not None else None,
+                "joint_ptp": Joints.from_dict(obj["joint_ptp"]) if obj.get("joint_ptp") is not None else None,
+                "cartesian_ptp": Pose.from_dict(obj["cartesian_ptp"]) if obj.get("cartesian_ptp") is not None else None,
+                "cubic_spline": CubicSpline.from_dict(obj["cubic_spline"]) if obj.get("cubic_spline") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/command_settings.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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.models.limits_override import LimitsOverride
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class CommandSettings(BaseModel):
+    """
+    Settings which can be used to modify the behavior in a command-wise manner.
+    """  # noqa: E501
+
+    auto_blending: Optional[StrictInt] = Field(
+        default=None,
+        description="Auto-blending is used to keep a constant velocity when blending between two motion commands. It changes the TCP path around the target point of a motion command. The value represents the percentage of the original velocity.  What is blending? Blending alters the geometry of the TCP path at the target point of a motion command to ensure that the velocity does not drop to zero between two motion commands.",
+    )
+    position_blending: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None,
+        description="If auto-blending blends too much of the resulting trajectory, position-blending could be used between two motion commands. Specifies the maximum radius in [mm] around the motion command's target point where the geometry of the TCP path is allowed to be changed to blend the current motion command into the next one.",
+    )
+    limits_override: Optional[LimitsOverride] = None
+    __properties: ClassVar[List[str]] = ["auto_blending", "position_blending", "limits_override"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CommandSettings 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 limits_override
+        if self.limits_override:
+            _dict["limits_override"] = self.limits_override.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CommandSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "auto_blending": obj.get("auto_blending"),
+                "position_blending": obj.get("position_blending"),
+                "limits_override": LimitsOverride.from_dict(obj["limits_override"]) if obj.get("limits_override") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/comparator.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0
+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 Comparator(str, Enum):
+    """
+    Comparator for the comparison of two values. The comparator is used to compare two values and return a boolean result. The default comparator is unknown.
+    """
+
+    """
+    allowed enum values
+    """
+    COMPARATOR_UNKNOWN = "COMPARATOR_UNKNOWN"
+    COMPARATOR_EQUALS = "COMPARATOR_EQUALS"
+    COMPARATOR_NOT_EQUALS = "COMPARATOR_NOT_EQUALS"
+    COMPARATOR_GREATER = "COMPARATOR_GREATER"
+    COMPARATOR_GREATER_EQUAL = "COMPARATOR_GREATER_EQUAL"
+    COMPARATOR_LESS = "COMPARATOR_LESS"
+    COMPARATOR_LESS_EQUAL = "COMPARATOR_LESS_EQUAL"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Comparator from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/models/compound.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Compound(BaseModel):
+    """
+    Describes a collision shape compounded from multiple collision objects. All objects are described in the compounds reference frame.
+    """  # noqa: E501
+
+    child_geometries: List[Geometry] = Field(description="A list of geometries sharing the same reference frame.")
+    __properties: ClassVar[List[str]] = ["child_geometries"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Compound 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 child_geometries (list)
+        _items = []
+        if self.child_geometries:
+            for _item in self.child_geometries:
+                # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                #     to not drop empty elements in lists
+                if _item is not None:
+                    _items.append(_item.to_dict())
+                # <<< End modification
+            _dict["child_geometries"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Compound from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "child_geometries": [
+                    # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                    #     to allow dicts in lists
+                    Geometry.from_dict(_item) if hasattr(Geometry, "from_dict") else _item
+                    # <<< End modification
+                    for _item in obj["child_geometries"]
+                ]
+                if obj.get("child_geometries") is not None
+                else None
+            }
+        )
+        return _obj
+
+
+from wandelbots_api_client.models.geometry import Geometry
+
+# TODO: Rewrite to not use raise_errors
+Compound.model_rebuild(raise_errors=False)

wandelbots_api_client/models/container_environment_inner.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ContainerEnvironmentInner(BaseModel):
+    """
+    ContainerEnvironmentInner
+    """  # noqa: E501
+
+    name: StrictStr
+    value: StrictStr
+    __properties: ClassVar[List[str]] = ["name", "value"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ContainerEnvironmentInner 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 ContainerEnvironmentInner 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"), "value": obj.get("value")})
+        return _obj

wandelbots_api_client/models/container_image.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from wandelbots_api_client.models.container_image_secrets_inner import ContainerImageSecretsInner
+from wandelbots_api_client.models.image_credentials import ImageCredentials
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ContainerImage(BaseModel):
+    """
+    A user provided, custom container image and the required credentials to pull it from a registry.
+    """  # noqa: E501
+
+    image: Annotated[str, Field(min_length=1, strict=True)] = Field(
+        description="The location of a container image in the form of `<registry>/<image>:<tag>`."
+    )
+    credentials: Optional[ImageCredentials] = None
+    secrets: Optional[List[ContainerImageSecretsInner]] = Field(
+        default=None, description="Known secrets for authentication with the container registry."
+    )
+    __properties: ClassVar[List[str]] = ["image", "credentials", "secrets"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ContainerImage 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 credentials
+        if self.credentials:
+            _dict["credentials"] = self.credentials.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in secrets (list)
+        _items = []
+        if self.secrets:
+            for _item in self.secrets:
+                # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                #     to not drop empty elements in lists
+                if _item is not None:
+                    _items.append(_item.to_dict())
+                # <<< End modification
+            _dict["secrets"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ContainerImage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "image": obj.get("image"),
+                "credentials": ImageCredentials.from_dict(obj["credentials"]) if obj.get("credentials") is not None else None,
+                "secrets": [
+                    # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                    #     to allow dicts in lists
+                    ContainerImageSecretsInner.from_dict(_item) if hasattr(ContainerImageSecretsInner, "from_dict") else _item
+                    # <<< End modification
+                    for _item in obj["secrets"]
+                ]
+                if obj.get("secrets") is not None
+                else None,
+            }
+        )
+        return _obj