wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/models/add_trajectory_response.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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.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 AddTrajectoryResponse(BaseModel):
+    """
+    The response signals if the trajectory is valid or faulty, resulting in an executable, partially executable or non-executable state. - valid trajectory: response contains only the unique identifier for the trajectory - trajectory has error on path: response contains the unique identifier for the trajectory and information about the failure. It is executable up to the point of failure. - trajectory has error at start or invalid data: response contains only information about the failure.  To execute the trajectory, use the unique identifier for calling [executeTrajectory](#/operations/executeTrajectory). If you want to validate your trajectory before execution, execute it with a virtual motion group and check the state in the response stream of [executeTrajectory](#/operations/executeTrajectory).
+    """  # noqa: E501
+
+    trajectory: Optional[StrictStr] = Field(
+        default=None,
+        description="The unique identifier of the trajectory. Use this identifier to execute the trajectory with the [executeTrajectory](#/operations/executeTrajectory) endpoint. ",
+    )
+    error: Optional[AddTrajectoryError] = Field(
+        default=None,
+        description="Always check this field first. If this field is present, the trajectory has an error and is only partially or not executable. ",
+    )
+    __properties: ClassVar[List[str]] = ["trajectory", "error"]
+
+    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 AddTrajectoryResponse 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 error
+        if self.error:
+            _dict["error"] = self.error.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AddTrajectoryResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "trajectory": obj.get("trajectory"),
+                "error": AddTrajectoryError.from_dict(obj["error"]) if obj.get("error") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/add_virtual_controller_motion_group_request.py

@@ -0,0 +1,147 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+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.motion_group_from_json import MotionGroupFromJson
+from wandelbots_api_client.v2.models.motion_group_from_type import MotionGroupFromType
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+ADDVIRTUALCONTROLLERMOTIONGROUPREQUEST_ONE_OF_SCHEMAS = ["MotionGroupFromJson", "MotionGroupFromType"]
+
+
+class AddVirtualControllerMotionGroupRequest(BaseModel):
+    """
+    Request body wrapper for `addVirtualControllerMotionGroup`. Allow callers to either reference a predefined motion group model or upload a full JSON configuration that the backend extracts into a motion group description.
+    """
+
+    # data type: MotionGroupFromType
+    oneof_schema_1_validator: Optional[MotionGroupFromType] = None
+    # data type: MotionGroupFromJson
+    oneof_schema_2_validator: Optional[MotionGroupFromJson] = None
+    actual_instance: Optional[Union[MotionGroupFromJson, MotionGroupFromType]] = None
+    one_of_schemas: Set[str] = {"MotionGroupFromJson", "MotionGroupFromType"}
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    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 = AddVirtualControllerMotionGroupRequest.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: MotionGroupFromType
+        if not isinstance(v, MotionGroupFromType):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `MotionGroupFromType`")
+        else:
+            match += 1
+        # validate data type: MotionGroupFromJson
+        if not isinstance(v, MotionGroupFromJson):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `MotionGroupFromJson`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in AddVirtualControllerMotionGroupRequest with oneOf schemas: MotionGroupFromJson, MotionGroupFromType. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in AddVirtualControllerMotionGroupRequest with oneOf schemas: MotionGroupFromJson, MotionGroupFromType. 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
+
+        # deserialize data into MotionGroupFromType
+        try:
+            instance.actual_instance = MotionGroupFromType.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into MotionGroupFromJson
+        try:
+            instance.actual_instance = MotionGroupFromJson.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 AddVirtualControllerMotionGroupRequest with oneOf schemas: MotionGroupFromJson, MotionGroupFromType. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into AddVirtualControllerMotionGroupRequest with oneOf schemas: MotionGroupFromJson, MotionGroupFromType. 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], MotionGroupFromJson, MotionGroupFromType]]:
+        """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/api_version.py

@@ -0,0 +1,83 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ApiVersion(BaseModel):
+    """
+    ApiVersion
+    """  # noqa: E501
+
+    version: StrictStr = Field(description="The version of the API.")
+    __properties: ClassVar[List[str]] = ["version"]
+
+    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 ApiVersion 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 ApiVersion from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"version": obj.get("version")})
+        return _obj

wandelbots_api_client/v2/models/app.py

@@ -0,0 +1,156 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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_extensions import Annotated
+from wandelbots_api_client.v2.models.container_environment_inner import ContainerEnvironmentInner
+from wandelbots_api_client.v2.models.container_image import ContainerImage
+from wandelbots_api_client.v2.models.container_resources import ContainerResources
+from wandelbots_api_client.v2.models.container_storage import ContainerStorage
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class App(BaseModel):
+    """
+    An App is defined by a webserver, packed inside a container, serving a web-application.
+    """  # noqa: E501
+
+    name: Annotated[str, Field(min_length=1, strict=True)] = Field(
+        description="The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g., when updating the application.  It also defines where the application is reachable (/$cell/$name).  It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names). "
+    )
+    app_icon: Annotated[str, Field(min_length=1, strict=True)] = Field(
+        description="The path of the icon for the App (/$cell/$name/$app_icon)."
+    )
+    container_image: ContainerImage
+    port: Optional[StrictInt] = Field(default=8080, description="The port the containerized webserver is listening on.")
+    environment: Optional[List[ContainerEnvironmentInner]] = Field(
+        default=None,
+        description="A list of environment variables with name and their value. These can be used to configure the containerized application, and turn features on or off. ",
+    )
+    storage: Optional[ContainerStorage] = None
+    resources: Optional[ContainerResources] = None
+    health_path: Optional[StrictStr] = Field(
+        default=None,
+        description="Defines the URL path suffix used to check the application's health status. The complete health check URL is constructed as `/$cell/$name/$health_path`. When the application is working as expected, the endpoint returns an HTTP 200 status code.  If not specified, the system will default to using the application icon path suffix (the value of `app_icon`) as the health check endpoint, resulting in `/$cell/$name/$app_icon`.  If the health check fails (no response or non-200 status code), the system will automatically restart the application container to restore service. ",
+    )
+    diagnosis_path: Optional[StrictStr] = Field(
+        default=None,
+        description="Defines the URL path suffix used to provide an endpoint for diagnosis data collection. The complete diagnosis check URL is constructed as `/$cell/$name/$diagnosis_path`.  The endpoint is called when a diagnosis package is requested via the diagnosis API. The endpoint needs to return the data within a zip file `application/zip` response. ",
+    )
+    __properties: ClassVar[List[str]] = [
+        "name",
+        "app_icon",
+        "container_image",
+        "port",
+        "environment",
+        "storage",
+        "resources",
+        "health_path",
+        "diagnosis_path",
+    ]
+
+    @field_validator("name")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z][a-z0-9-]{0,61}[a-z0-9]$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z][a-z0-9-]{0,61}[a-z0-9]$/")
+        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 App 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 container_image
+        if self.container_image:
+            _dict["container_image"] = self.container_image.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in environment (list)
+        _items = []
+        if self.environment:
+            for _item_environment in self.environment:
+                if _item_environment:
+                    _items.append(_item_environment.to_dict())
+            _dict["environment"] = _items
+        # override the default output from pydantic by calling `to_dict()` of storage
+        if self.storage:
+            _dict["storage"] = self.storage.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of resources
+        if self.resources:
+            _dict["resources"] = self.resources.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of App 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"),
+                "app_icon": obj.get("app_icon"),
+                "container_image": ContainerImage.from_dict(obj["container_image"]) if obj.get("container_image") is not None else None,
+                "port": obj.get("port") if obj.get("port") is not None else 8080,
+                "environment": [ContainerEnvironmentInner.from_dict(_item) for _item in obj["environment"]]
+                if obj.get("environment") is not None
+                else None,
+                "storage": ContainerStorage.from_dict(obj["storage"]) if obj.get("storage") is not None else None,
+                "resources": ContainerResources.from_dict(obj["resources"]) if obj.get("resources") is not None else None,
+                "health_path": obj.get("health_path"),
+                "diagnosis_path": obj.get("diagnosis_path"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/behavior.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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 Behavior(str, Enum):
+    """
+    ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that, the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](#/operations/externalJointsStream).
+    """
+
+    """
+    allowed enum values
+    """
+    BEHAVIOR_AUTOMATIC = "BEHAVIOR_AUTOMATIC"
+    BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME = "BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME"
+    BEHAVIOR_EXTERNAL_SOURCE = "BEHAVIOR_EXTERNAL_SOURCE"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Behavior from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/blending_auto.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.3.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BlendingAuto(BaseModel):
+    """
+    BlendingAuto
+    """  # noqa: E501
+
+    min_velocity_in_percent: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(
+        default=None,
+        description="Auto-blending is used to keep a constant velocity when blending between two motion commands. To use auto-blending, the TCP velocity limit must be set. It changes the TCP path around the target point of the motion command. The value represents the percentage of the original velocity. Auto-blending is always performed in cartesian space. ",
+    )
+    blending_name: StrictStr
+    __properties: ClassVar[List[str]] = ["min_velocity_in_percent", "blending_name"]
+
+    @field_validator("blending_name")
+    def blending_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["BlendingAuto"]):
+            raise ValueError("must be one of enum values ('BlendingAuto')")
+        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 BlendingAuto 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 BlendingAuto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"min_velocity_in_percent": obj.get("min_velocity_in_percent"), "blending_name": obj.get("blending_name")}
+        )
+        return _obj