wandelbots-api-client 25.6.0.dev7__py3-none-any.whl → 25.10.0rc2__py3-none-any.whl

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.1.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, 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
+
+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]]] = None 
+    error_feedback_name: str = "ErrorJointLimitExceeded"
+    __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(
+        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 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/{coordinate_systems.py → error_joint_position_collision.py}

@@ -3,9 +3,9 @@
 """
     Wandelbots NOVA API
 
-    Interact with robots in an easy and intuitive way.  > **Note:** API version 2 is experimental and will experience functional changes. 
+    Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 2.0.0 beta
+    The version of the OpenAPI document: 2.1.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -17,18 +17,27 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict
-from typing import Any, ClassVar, Dict, List
-from wandelbots_api_client.v2.models.coordinate_system import CoordinateSystem
+from pydantic import BaseModel, ConfigDict, 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
 
-class CoordinateSystems(BaseModel):
+class ErrorJointPositionCollision(BaseModel):
     """
-    CoordinateSystems
+    A reference joint position, e.g., start or target joint position, results in collisions that prevent processing. 
     """ # noqa: E501
-    coordinate_systems: List[CoordinateSystem]
-    __properties: ClassVar[List[str]] = ["coordinate_systems"]
+    collisions: Optional[List[Collision]] = None 
+    joint_position: Optional[List[Union[StrictFloat, StrictInt]]] = None 
+    error_feedback_name: str = "ErrorJointPositionCollision"
+    __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(
         populate_by_name=True,
@@ -52,7 +61,7 @@ class CoordinateSystems(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of CoordinateSystems from a JSON string"""
+        """Create an instance of ErrorJointPositionCollision from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -73,21 +82,21 @@ class CoordinateSystems(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in coordinate_systems (list)
+        # override the default output from pydantic by calling `to_dict()` of each item in collisions (list)
         _items = []
-        if self.coordinate_systems:
-            for _item in self.coordinate_systems:
+        if self.collisions:
+            for _item in self.collisions:
                 # >>> 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['coordinate_systems'] = _items
+            _dict['collisions'] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of CoordinateSystems from a dict"""
+        """Create an instance of ErrorJointPositionCollision from a dict"""
         if obj is None:
             return None
 
@@ -95,13 +104,15 @@ class CoordinateSystems(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "coordinate_systems": [
+            "collisions": [
                 # >>> 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
-                CoordinateSystem.from_dict(_item) if hasattr(CoordinateSystem, 'from_dict') else _item
+                Collision.from_dict(_item) if hasattr(Collision, 'from_dict') else _item
                 # <<< End modification
-                for _item in obj["coordinate_systems"]
-            ] if obj.get("coordinate_systems") is not None else None
+                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
 

wandelbots_api_client/v2/models/error_max_iterations_exceeded.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.1.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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ErrorMaxIterationsExceeded(BaseModel):
+    """
+    The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions. 
+    """ # noqa: E501
+    max_iterations: Optional[StrictInt] = Field(default=None, description="The maximum number of iterations that was reached. ") 
+    error_feedback_name: str = "ErrorMaxIterationsExceeded"
+    __properties: ClassVar[List[str]] = ["max_iterations", "error_feedback_name"]
+
+    @field_validator('error_feedback_name')
+    def error_feedback_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['ErrorMaxIterationsExceeded']):
+            raise ValueError("must be one of enum values ('ErrorMaxIterationsExceeded')")
+        return value
+
+    model_config = ConfigDict(
+        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 ErrorMaxIterationsExceeded from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ErrorMaxIterationsExceeded from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "max_iterations": obj.get("max_iterations"),
+            "error_feedback_name": obj.get("error_feedback_name")
+        })
+        return _obj
+
+

wandelbots_api_client/v2/models/execute.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    Wandelbots NOVA API
+
+    Interact with robots in an easy and intuitive way. 
+
+    The version of the OpenAPI document: 2.1.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 wandelbots_api_client.v2.models.execute_details import ExecuteDetails
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Execute(BaseModel):
+    """
+    Details about the state of the motion execution. The details are either for a jogging or a trajectory. If NOVA is not controlling this motion group at the moment, this field is omitted. 
+    """ # noqa: E501
+    joint_position: List[Union[StrictFloat, StrictInt]] = Field(description="Commanded joint position of each joint in [rad]. This command was sent in the time step the corresponding state was received. ") 
+    details: Optional[ExecuteDetails] = None 
+    __properties: ClassVar[List[str]] = ["joint_position", "details"]
+
+    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 Execute from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of details
+        if self.details:
+            _dict['details'] = self.details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Execute from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "joint_position": obj.get("joint_position"),
+            "details": ExecuteDetails.from_dict(obj["details"]) if obj.get("details") is not None else None
+        })
+        return _obj
+
+

wandelbots_api_client/v2/models/{set_io_values_request_inner.py → execute_details.py}

@@ -3,9 +3,9 @@
 """
     Wandelbots NOVA API
 
-    Interact with robots in an easy and intuitive way.  > **Note:** API version 2 is experimental and will experience functional changes. 
+    Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 2.0.0 beta
+    The version of the OpenAPI document: 2.1.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -17,27 +17,24 @@ 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.io_boolean_value import IOBooleanValue
-from wandelbots_api_client.v2.models.io_float_value import IOFloatValue
-from wandelbots_api_client.v2.models.io_integer_value import IOIntegerValue
+from wandelbots_api_client.v2.models.jogging_details import JoggingDetails
+from wandelbots_api_client.v2.models.trajectory_details import TrajectoryDetails
 from pydantic import StrictStr, Field
 from typing import Union, List, Set, Optional, Dict
 from typing_extensions import Literal, Self
 
-SETIOVALUESREQUESTINNER_ONE_OF_SCHEMAS = ["IOBooleanValue", "IOFloatValue", "IOIntegerValue"]
+EXECUTEDETAILS_ONE_OF_SCHEMAS = ["JoggingDetails", "TrajectoryDetails"]
 
-class SetIOValuesRequestInner(BaseModel):
+class ExecuteDetails(BaseModel):
     """
-    SetIOValuesRequestInner
+    ExecuteDetails
     """
-    # data type: IOBooleanValue
-    oneof_schema_1_validator: Optional[IOBooleanValue] = None
-    # data type: IOIntegerValue
-    oneof_schema_2_validator: Optional[IOIntegerValue] = None
-    # data type: IOFloatValue
-    oneof_schema_3_validator: Optional[IOFloatValue] = None
-    actual_instance: Optional[Union[IOBooleanValue, IOFloatValue, IOIntegerValue]] = None
-    one_of_schemas: Set[str] = { "IOBooleanValue", "IOFloatValue", "IOIntegerValue" }
+    # data type: JoggingDetails
+    oneof_schema_1_validator: Optional[JoggingDetails] = None
+    # data type: TrajectoryDetails
+    oneof_schema_2_validator: Optional[TrajectoryDetails] = None
+    actual_instance: Optional[Union[JoggingDetails, TrajectoryDetails]] = None
+    one_of_schemas: Set[str] = { "JoggingDetails", "TrajectoryDetails" }
 
     model_config = ConfigDict(
         validate_assignment=True,
@@ -45,6 +42,9 @@ class SetIOValuesRequestInner(BaseModel):
     )
 
 
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
     def __init__(self, *args, **kwargs) -> None:
         if args:
             if len(args) > 1:
@@ -57,30 +57,25 @@ class SetIOValuesRequestInner(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_oneof(cls, v):
-        instance = SetIOValuesRequestInner.model_construct()
+        instance = ExecuteDetails.model_construct()
         error_messages = []
         match = 0
-        # validate data type: IOBooleanValue
-        if not isinstance(v, IOBooleanValue):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `IOBooleanValue`")
-        else:
-            match += 1
-        # validate data type: IOIntegerValue
-        if not isinstance(v, IOIntegerValue):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `IOIntegerValue`")
+        # validate data type: JoggingDetails
+        if not isinstance(v, JoggingDetails):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `JoggingDetails`")
         else:
             match += 1
-        # validate data type: IOFloatValue
-        if not isinstance(v, IOFloatValue):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `IOFloatValue`")
+        # validate data type: TrajectoryDetails
+        if not isinstance(v, TrajectoryDetails):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TrajectoryDetails`")
         else:
             match += 1
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when setting `actual_instance` in SetIOValuesRequestInner with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when setting `actual_instance` in ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when setting `actual_instance` in SetIOValuesRequestInner with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting `actual_instance` in ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -95,31 +90,40 @@ class SetIOValuesRequestInner(BaseModel):
         error_messages = []
         match = 0
 
-        # deserialize data into IOBooleanValue
-        try:
-            instance.actual_instance = IOBooleanValue.from_json(json_str)
-            match += 1
-        except (ValidationError, ValueError) as e:
-            error_messages.append(str(e))
-        # deserialize data into IOIntegerValue
+        # use oneOf discriminator to lookup the data type
+        _data_type = json.loads(json_str).get("kind")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `kind` in the input.")
+
+        # check if data type is `JoggingDetails`
+        if _data_type == "JOGGING":
+            instance.actual_instance = JoggingDetails.from_json(json_str)
+            return instance
+
+        # check if data type is `TrajectoryDetails`
+        if _data_type == "TRAJECTORY":
+            instance.actual_instance = TrajectoryDetails.from_json(json_str)
+            return instance
+
+        # deserialize data into JoggingDetails
         try:
-            instance.actual_instance = IOIntegerValue.from_json(json_str)
+            instance.actual_instance = JoggingDetails.from_json(json_str)
             match += 1
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
-        # deserialize data into IOFloatValue
+        # deserialize data into TrajectoryDetails
         try:
-            instance.actual_instance = IOFloatValue.from_json(json_str)
+            instance.actual_instance = TrajectoryDetails.from_json(json_str)
             match += 1
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
 
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when deserializing the JSON string into SetIOValuesRequestInner with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when deserializing the JSON string into ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into SetIOValuesRequestInner with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into ExecuteDetails with oneOf schemas: JoggingDetails, TrajectoryDetails. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -133,7 +137,7 @@ class SetIOValuesRequestInner(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], IOBooleanValue, IOFloatValue, IOIntegerValue]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], JoggingDetails, TrajectoryDetails]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None