wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/models/pose.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: 1.4.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
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.models.vector3d import Vector3d
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Pose(BaseModel):
+    """
+    Representing a pose in space with its origin in `coordinate_system`. A pose consists of positional coordinates [x, y, z] in millimeters (mm) and orientational coordinates in axis-angle representation [rx, ry, rz] in radian (rad).
+    """  # noqa: E501
+
+    position: Vector3d = Field(description="Position vector, defined in [x, y, z] with floating numbers in millimeters (ms).")
+    orientation: Optional[Vector3d] = Field(
+        default=None,
+        description="Rotation vector, defined in [rx, ry, rz] with floating numbers. The rotation is represented in vector3 using an axis-angle representation: axis.normalized * angle (angle in radians).",
+    )
+    coordinate_system: Optional[StrictStr] = Field(
+        default=None,
+        description="Unique identifier addressing the reference coordinate system of the pose. Default is the world coordinate system.",
+    )
+    __properties: ClassVar[List[str]] = ["position", "orientation", "coordinate_system"]
+
+    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 Pose 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 position
+        if self.position:
+            _dict["position"] = self.position.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of orientation
+        if self.orientation:
+            _dict["orientation"] = self.orientation.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Pose from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "position": Vector3d.from_dict(obj["position"]) if obj.get("position") is not None else None,
+                "orientation": Vector3d.from_dict(obj["orientation"]) if obj.get("orientation") is not None else None,
+                "coordinate_system": obj.get("coordinate_system"),
+            }
+        )
+        return _obj

wandelbots_api_client/models/pose2.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: 1.4.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_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Pose2(BaseModel):
+    """
+    Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
+    """  # noqa: E501
+
+    position: Optional[Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)]] = Field(
+        default=None, description="Describes a position in 3D space. A three-dimensional vector [x, y, z] with double precision. "
+    )
+    orientation: Optional[Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)]] = Field(
+        default=None,
+        description="Defines a rotation in 3D space. A three-dimensional Vector [rx, ry, rz] with double precision. Rotation is applied around the vector. The angle of rotation equals the length of the vector. ",
+    )
+    __properties: ClassVar[List[str]] = ["position", "orientation"]
+
+    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 Pose2 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 Pose2 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"position": obj.get("position"), "orientation": obj.get("orientation")})
+        return _obj

wandelbots_api_client/models/program_metadata.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ProgramMetadata(BaseModel):
+    """
+    The metadata of a program.
+    """  # noqa: E501
+
+    id: StrictStr = Field(description="The unique identifier of the program.")
+    name: StrictStr = Field(description="The name of the program presented to the enduser.")
+    created_date: StrictStr = Field(description="The date when the program was created.")
+    last_updated_date: StrictStr = Field(description="The date when the program was last updated.")
+    is_hidden: StrictBool = Field(description="Whether the program is accessible for the enduser or only for the developer. ")
+    image: Optional[StrictStr] = Field(default=None, description="The path to the image of the program")
+    __properties: ClassVar[List[str]] = ["id", "name", "created_date", "last_updated_date", "is_hidden", "image"]
+
+    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 ProgramMetadata 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 ProgramMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "name": obj.get("name"),
+                "created_date": obj.get("created_date"),
+                "last_updated_date": obj.get("last_updated_date"),
+                "is_hidden": obj.get("is_hidden"),
+                "image": obj.get("image"),
+            }
+        )
+        return _obj

wandelbots_api_client/models/program_run.py

@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wandelbots_api_client.models.execution_result import ExecutionResult
+from wandelbots_api_client.models.program_run_state import ProgramRunState
+from wandelbots_api_client.models.store_value import StoreValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ProgramRun(BaseModel):
+    """
+    ProgramRun
+    """  # noqa: E501
+
+    id: StrictStr
+    state: ProgramRunState
+    logs: Optional[StrictStr] = ""
+    stdout: Optional[StrictStr] = ""
+    store: Optional[Dict[str, StoreValue]] = None
+    error: Optional[StrictStr] = None
+    traceback: Optional[StrictStr] = None
+    start_time: Optional[Union[StrictFloat, StrictInt]] = None
+    end_time: Optional[Union[StrictFloat, StrictInt]] = None
+    execution_results: Optional[List[ExecutionResult]] = None
+    __properties: ClassVar[List[str]] = [
+        "id",
+        "state",
+        "logs",
+        "stdout",
+        "store",
+        "error",
+        "traceback",
+        "start_time",
+        "end_time",
+        "execution_results",
+    ]
+
+    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 ProgramRun 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 value in store (dict)
+        # >>> Modified from openapi template
+        if self.store:
+            _field_dict = {}
+            for _key, _value in self.store.items():
+                if self.store[_key]:
+                    _field_dict[_key] = _value.to_dict()
+            _dict["store"] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each item in execution_results (list)
+        _items = []
+        if self.execution_results:
+            for _item in self.execution_results:
+                # >>> 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["execution_results"] = _items
+        # set to None if error (nullable) is None
+        # and model_fields_set contains the field
+        if self.error is None and "error" in self.model_fields_set:
+            _dict["error"] = None
+
+        # set to None if traceback (nullable) is None
+        # and model_fields_set contains the field
+        if self.traceback is None and "traceback" in self.model_fields_set:
+            _dict["traceback"] = None
+
+        # set to None if start_time (nullable) is None
+        # and model_fields_set contains the field
+        if self.start_time is None and "start_time" in self.model_fields_set:
+            _dict["start_time"] = None
+
+        # set to None if end_time (nullable) is None
+        # and model_fields_set contains the field
+        if self.end_time is None and "end_time" in self.model_fields_set:
+            _dict["end_time"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProgramRun from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "state": obj.get("state"),
+                "logs": obj.get("logs") if obj.get("logs") is not None else "",
+                "stdout": obj.get("stdout") if obj.get("stdout") is not None else "",
+                "store": dict((_k, StoreValue.from_dict(_v)) for _k, _v in obj["store"].items()) if obj.get("store") is not None else None,
+                "error": obj.get("error"),
+                "traceback": obj.get("traceback"),
+                "start_time": obj.get("start_time"),
+                "end_time": obj.get("end_time"),
+                "execution_results": [
+                    # >>> 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
+                    ExecutionResult.from_dict(_item) if hasattr(ExecutionResult, "from_dict") else _item
+                    # <<< End modification
+                    for _item in obj["execution_results"]
+                ]
+                if obj.get("execution_results") is not None
+                else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/program_run_object.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: 1.4.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 datetime import datetime
+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
+
+
+class ProgramRunObject(BaseModel):
+    """
+    ProgramRunObject
+    """  # noqa: E501
+
+    id: StrictStr = Field(description="The identifier of the program run.")
+    program_id: StrictStr = Field(description="The identifier of the program stored in the program library.")
+    status: StrictStr = Field(description="The status of the program run which shows which state the program run is currently is in.")
+    program_output: Optional[StrictStr] = Field(
+        default=None, description="The output of the program run, which provides the output generate while running the program."
+    )
+    created_at: datetime = Field(description="ISO 8601 date-time format when the program run was created.")
+    last_updated_at: datetime = Field(description="ISO 8601 date-time format when the program run was last updated.")
+    __properties: ClassVar[List[str]] = ["id", "program_id", "status", "program_output", "created_at", "last_updated_at"]
+
+    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 ProgramRunObject 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 ProgramRunObject from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "program_id": obj.get("program_id"),
+                "status": obj.get("status"),
+                "program_output": obj.get("program_output"),
+                "created_at": obj.get("created_at"),
+                "last_updated_at": obj.get("last_updated_at"),
+            }
+        )
+        return _obj

wandelbots_api_client/models/program_run_state.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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 ProgramRunState(str, Enum):
+    """
+    ProgramRunState
+    """
+
+    """
+    allowed enum values
+    """
+    NOT_STARTED = "not started"
+    RUNNING = "running"
+    COMPLETED = "completed"
+    FAILED = "failed"
+    STOPPED = "stopped"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ProgramRunState from a JSON string"""
+        return cls(json.loads(json_str))