wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/v2/models/initialize_jogging_response.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, 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 InitializeJoggingResponse(BaseModel):
+    """
+    Acknowledgment to an InitializeJoggingRequest.
+    """  # noqa: E501
+
+    message: Optional[StrictStr] = Field(default=None, description="Error message in case of invalid InitializeJoggingRequest.")
+    kind: StrictStr
+    __properties: ClassVar[List[str]] = ["message", "kind"]
+
+    @field_validator("kind")
+    def kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["INITIALIZE_RECEIVED"]):
+            raise ValueError("must be one of enum values ('INITIALIZE_RECEIVED')")
+        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 InitializeJoggingResponse 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 InitializeJoggingResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"message": obj.get("message"), "kind": obj.get("kind")})
+        return _obj

wandelbots_api_client/v2/models/initialize_movement_request.py

@@ -0,0 +1,112 @@
+# 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.initialize_movement_request_trajectory import InitializeMovementRequestTrajectory
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class InitializeMovementRequest(BaseModel):
+    """
+    Sets up connection by locking a trajectory for execution. The robot controller mode is set to control mode. ATTENTION: This request has to be sent before any StartMovementRequest is sent.            If initializing the movement was successful, no further movements can be initialized. To execute another trajectory, another connection has to be established.
+    """  # noqa: E501
+
+    message_type: StrictStr = Field(description="Type specifier for server, set automatically. ")
+    trajectory: InitializeMovementRequestTrajectory
+    initial_location: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None,
+        description="Location on trajectory where the execution will start. Defaults to 0.0, start of the trajectory. ATTENTION: The robot has to be at the position of the initial location when initializing the movement.            If not, an error is returned. ",
+    )
+    response_coordinate_system: Optional[StrictStr] = Field(
+        default=None,
+        description="Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used. ",
+    )
+    __properties: ClassVar[List[str]] = ["message_type", "trajectory", "initial_location", "response_coordinate_system"]
+
+    @field_validator("message_type")
+    def message_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["InitializeMovementRequest"]):
+            raise ValueError("must be one of enum values ('InitializeMovementRequest')")
+        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 InitializeMovementRequest 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 trajectory
+        if self.trajectory:
+            _dict["trajectory"] = self.trajectory.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of InitializeMovementRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "message_type": obj.get("message_type"),
+                "trajectory": InitializeMovementRequestTrajectory.from_dict(obj["trajectory"])
+                if obj.get("trajectory") is not None
+                else None,
+                "initial_location": obj.get("initial_location"),
+                "response_coordinate_system": obj.get("response_coordinate_system"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/initialize_movement_request_trajectory.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.trajectory_data import TrajectoryData
+from wandelbots_api_client.v2.models.trajectory_id import TrajectoryId
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+INITIALIZEMOVEMENTREQUESTTRAJECTORY_ONE_OF_SCHEMAS = ["TrajectoryData", "TrajectoryId"]
+
+
+class InitializeMovementRequestTrajectory(BaseModel):
+    """
+    The trajectory which should be executed and locked to the connection.
+    """
+
+    # data type: TrajectoryId
+    oneof_schema_1_validator: Optional[TrajectoryId] = None
+    # data type: TrajectoryData
+    oneof_schema_2_validator: Optional[TrajectoryData] = None
+    actual_instance: Optional[Union[TrajectoryData, TrajectoryId]] = None
+    one_of_schemas: Set[str] = {"TrajectoryData", "TrajectoryId"}
+
+    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 = InitializeMovementRequestTrajectory.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: TrajectoryId
+        if not isinstance(v, TrajectoryId):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TrajectoryId`")
+        else:
+            match += 1
+        # validate data type: TrajectoryData
+        if not isinstance(v, TrajectoryData):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TrajectoryData`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in InitializeMovementRequestTrajectory with oneOf schemas: TrajectoryData, TrajectoryId. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in InitializeMovementRequestTrajectory with oneOf schemas: TrajectoryData, TrajectoryId. 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("message_type")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `message_type` in the input.")
+
+        # check if data type is `TrajectoryData`
+        if _data_type == "TrajectoryData":
+            instance.actual_instance = TrajectoryData.from_json(json_str)
+            return instance
+
+        # check if data type is `TrajectoryId`
+        if _data_type == "TrajectoryId":
+            instance.actual_instance = TrajectoryId.from_json(json_str)
+            return instance
+
+        # deserialize data into TrajectoryId
+        try:
+            instance.actual_instance = TrajectoryId.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into TrajectoryData
+        try:
+            instance.actual_instance = TrajectoryData.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 InitializeMovementRequestTrajectory with oneOf schemas: TrajectoryData, TrajectoryId. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into InitializeMovementRequestTrajectory with oneOf schemas: TrajectoryData, TrajectoryId. 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], TrajectoryData, TrajectoryId]]:
+        """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/initialize_movement_response.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.v2.models.add_trajectory_error import AddTrajectoryError
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class InitializeMovementResponse(BaseModel):
+    """
+    Response for InitializeMovementRequest message.
+    """  # noqa: E501
+
+    message: Optional[StrictStr] = Field(default=None, description="Error message in case of invalid InitializeMovementRequest.")
+    add_trajectory_error: Optional[AddTrajectoryError] = Field(
+        default=None,
+        description="Error can occur if joint trajectory was added by InitializeMovementRequest and the trajectory is invalid. ",
+    )
+    kind: StrictStr
+    __properties: ClassVar[List[str]] = ["message", "add_trajectory_error", "kind"]
+
+    @field_validator("kind")
+    def kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["INITIALIZE_RECEIVED"]):
+            raise ValueError("must be one of enum values ('INITIALIZE_RECEIVED')")
+        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 InitializeMovementResponse 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 add_trajectory_error
+        if self.add_trajectory_error:
+            _dict["add_trajectory_error"] = self.add_trajectory_error.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of InitializeMovementResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "message": obj.get("message"),
+                "add_trajectory_error": AddTrajectoryError.from_dict(obj["add_trajectory_error"])
+                if obj.get("add_trajectory_error") is not None
+                else None,
+                "kind": obj.get("kind"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/integer_value.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, 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 IntegerValue(BaseModel):
+    """
+    Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
+    """  # noqa: E501
+
+    value: StrictStr
+    value_type: StrictStr
+    __properties: ClassVar[List[str]] = ["value", "value_type"]
+
+    @field_validator("value_type")
+    def value_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["integer"]):
+            raise ValueError("must be one of enum values ('integer')")
+        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 IntegerValue 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 IntegerValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"value": obj.get("value"), "value_type": obj.get("value_type")})
+        return _obj

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