wandelbots-api-client 25.8.0.dev77__py3-none-any.whl → 25.11.0.dev12__py3-none-any.whl

wandelbots_api_client/v2/api/trajectory_planning_api.py

@@ -3,15 +3,14 @@
 """
     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.
 """  # noqa: E501
 
-
 from furl import furl
 import json
 import humps
@@ -24,7 +23,6 @@ from typing_extensions import Annotated
 from urllib.parse import quote
 
 from pydantic import Field, StrictStr
-from typing import Optional
 from typing_extensions import Annotated
 from wandelbots_api_client.v2.models.plan_collision_free_request import PlanCollisionFreeRequest
 from wandelbots_api_client.v2.models.plan_collision_free_response import PlanCollisionFreeResponse
@@ -51,7 +49,7 @@ class TrajectoryPlanningApi:
     async def plan_collision_free(
         self,
         cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        plan_collision_free_request: Optional[PlanCollisionFreeRequest] = None,
+        plan_collision_free_request: PlanCollisionFreeRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -71,7 +69,7 @@ class TrajectoryPlanningApi:
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
-        :param plan_collision_free_request:
+        :param plan_collision_free_request: (required)
         :type plan_collision_free_request: PlanCollisionFreeRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -125,7 +123,7 @@ class TrajectoryPlanningApi:
     async def plan_collision_free_with_http_info(
         self,
         cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        plan_collision_free_request: Optional[PlanCollisionFreeRequest] = None,
+        plan_collision_free_request: PlanCollisionFreeRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -145,7 +143,7 @@ class TrajectoryPlanningApi:
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
-        :param plan_collision_free_request:
+        :param plan_collision_free_request: (required)
         :type plan_collision_free_request: PlanCollisionFreeRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -199,7 +197,7 @@ class TrajectoryPlanningApi:
     async def plan_collision_free_without_preload_content(
         self,
         cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        plan_collision_free_request: Optional[PlanCollisionFreeRequest] = None,
+        plan_collision_free_request: PlanCollisionFreeRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -219,7 +217,7 @@ class TrajectoryPlanningApi:
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
-        :param plan_collision_free_request:
+        :param plan_collision_free_request: (required)
         :type plan_collision_free_request: PlanCollisionFreeRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -346,7 +344,7 @@ class TrajectoryPlanningApi:
     async def plan_trajectory(
         self,
         cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        plan_trajectory_request: Optional[PlanTrajectoryRequest] = None,
+        plan_trajectory_request: PlanTrajectoryRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -362,11 +360,11 @@ class TrajectoryPlanningApi:
     ) -> PlanTrajectoryResponse:
         """Plan Trajectory
 
-        Plans a new trajectory for a single motion group.  Describe the trajectory as a sequence of motion commands that the robots TCP should follow.  Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint.  If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion. 
+        Plans a new trajectory for a single motion group.  Describe the trajectory as a sequence of motion commands that the robots TCP should follow.  Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint.  If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs.   <!-- theme: info -->  > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
-        :param plan_trajectory_request:
+        :param plan_trajectory_request: (required)
         :type plan_trajectory_request: PlanTrajectoryRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -420,7 +418,7 @@ class TrajectoryPlanningApi:
     async def plan_trajectory_with_http_info(
         self,
         cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        plan_trajectory_request: Optional[PlanTrajectoryRequest] = None,
+        plan_trajectory_request: PlanTrajectoryRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -436,11 +434,11 @@ class TrajectoryPlanningApi:
     ) -> ApiResponse[PlanTrajectoryResponse]:
         """Plan Trajectory
 
-        Plans a new trajectory for a single motion group.  Describe the trajectory as a sequence of motion commands that the robots TCP should follow.  Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint.  If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion. 
+        Plans a new trajectory for a single motion group.  Describe the trajectory as a sequence of motion commands that the robots TCP should follow.  Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint.  If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs.   <!-- theme: info -->  > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
-        :param plan_trajectory_request:
+        :param plan_trajectory_request: (required)
         :type plan_trajectory_request: PlanTrajectoryRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -494,7 +492,7 @@ class TrajectoryPlanningApi:
     async def plan_trajectory_without_preload_content(
         self,
         cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        plan_trajectory_request: Optional[PlanTrajectoryRequest] = None,
+        plan_trajectory_request: PlanTrajectoryRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -510,11 +508,11 @@ class TrajectoryPlanningApi:
     ) -> RESTResponseType:
         """Plan Trajectory
 
-        Plans a new trajectory for a single motion group.  Describe the trajectory as a sequence of motion commands that the robots TCP should follow.  Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint.  If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion. 
+        Plans a new trajectory for a single motion group.  Describe the trajectory as a sequence of motion commands that the robots TCP should follow.  Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint.  If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs.   <!-- theme: info -->  > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
-        :param plan_trajectory_request:
+        :param plan_trajectory_request: (required)
         :type plan_trajectory_request: PlanTrajectoryRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

wandelbots_api_client/v2/api/version_api.py

@@ -0,0 +1,284 @@
+# 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 furl import furl
+import json
+import humps
+import re
+import warnings
+import websockets
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, AsyncGenerator, Callable, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+from urllib.parse import quote
+
+from wandelbots_api_client.v2.models.api_version import ApiVersion
+
+from wandelbots_api_client.v2.api_client import ApiClient, RequestSerialized
+from wandelbots_api_client.v2.api_response import ApiResponse
+from wandelbots_api_client.v2.rest import RESTResponseType
+
+class VersionApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+    @validate_call
+    async def get_api_version(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiVersion:
+        """API Version
+
+        Retrieves the version of the NOVA API.
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_api_version_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ApiVersion",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def get_api_version_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ApiVersion]:
+        """API Version
+
+        Retrieves the version of the NOVA API.
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_api_version_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ApiVersion",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def get_api_version_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """API Version
+
+        Retrieves the version of the NOVA API.
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_api_version_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ApiVersion",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_api_version_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'BasicAuth', 
+            'BearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/version',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+