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

wandelbots_api_client/v2/api/store_object_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
@@ -591,7 +590,7 @@ class StoreObjectApi:
     ) -> bytearray:
         """Get Object
 
-        Get the object.  This request returns the object and any metadata attached to it. 
+        Returns content and metadata of a stored object. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -663,7 +662,7 @@ class StoreObjectApi:
     ) -> ApiResponse[bytearray]:
         """Get Object
 
-        Get the object.  This request returns the object and any metadata attached to it. 
+        Returns content and metadata of a stored object. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -735,7 +734,7 @@ class StoreObjectApi:
     ) -> RESTResponseType:
         """Get Object
 
-        Get the object.  This request returns the object and any metadata attached to it. 
+        Returns content and metadata of a stored object. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -868,7 +867,7 @@ class StoreObjectApi:
     ) -> None:
         """Get Object Metadata
 
-        Get object metadata.  Objects can be large. Therefore this request only returns metadata without fetching the object's content. 
+        Returns metadata. Object content is not returned. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -940,7 +939,7 @@ class StoreObjectApi:
     ) -> ApiResponse[None]:
         """Get Object Metadata
 
-        Get object metadata.  Objects can be large. Therefore this request only returns metadata without fetching the object's content. 
+        Returns metadata. Object content is not returned. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1012,7 +1011,7 @@ class StoreObjectApi:
     ) -> RESTResponseType:
         """Get Object Metadata
 
-        Get object metadata.  Objects can be large. Therefore this request only returns metadata without fetching the object's content. 
+        Returns metadata. Object content is not returned. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1404,7 +1403,7 @@ class StoreObjectApi:
     ) -> None:
         """Store Object
 
-        Store any data as an object.  Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects.  Optional: Specify metadata as a dictionary with names and values. 
+        Store any data as an object.  Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects.  #### Optional Specify metadata as a dictionary with names and values. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1484,7 +1483,7 @@ class StoreObjectApi:
     ) -> ApiResponse[None]:
         """Store Object
 
-        Store any data as an object.  Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects.  Optional: Specify metadata as a dictionary with names and values. 
+        Store any data as an object.  Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects.  #### Optional Specify metadata as a dictionary with names and values. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1564,7 +1563,7 @@ class StoreObjectApi:
     ) -> RESTResponseType:
         """Store Object
 
-        Store any data as an object.  Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects.  Optional: Specify metadata as a dictionary with names and values. 
+        Store any data as an object.  Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects.  #### Optional Specify metadata as a dictionary with names and values. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str

wandelbots_api_client/v2/api/system_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
@@ -26,6 +25,8 @@ from urllib.parse import quote
 from pydantic import Field, StrictBytes, StrictStr
 from typing import Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
+from uuid import UUID
+from wandelbots_api_client.v2.models.configuration_archive_status import ConfigurationArchiveStatus
 from wandelbots_api_client.v2.models.configuration_resource import ConfigurationResource
 from wandelbots_api_client.v2.models.release_channel import ReleaseChannel
 from wandelbots_api_client.v2.models.service_status import ServiceStatus
@@ -50,7 +51,7 @@ class SystemApi:
     @validate_call
     async def backup_configuration(
         self,
-        resources: Annotated[List[StrictStr], Field(description="List of resource identifiers to included in the backup and restore operations.")],
+        resources: Annotated[Optional[List[StrictStr]], Field(description="List of resource identifiers to include in the retrieval.")] = None,
         metadata: Annotated[Optional[Dict[str, StrictStr]], Field(description="Additional metadata to add to the backup")] = None,
         _request_timeout: Union[
             None,
@@ -67,9 +68,9 @@ class SystemApi:
     ) -> bytearray:
         """Retrieve Configuration Backup
 
-        Retrieves a configuration backup based on provided resource identifiers. 
+        Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved. 
 
-        :param resources: List of resource identifiers to included in the backup and restore operations. (required)
+        :param resources: List of resource identifiers to include in the retrieval.
         :type resources: List[str]
         :param metadata: Additional metadata to add to the backup
         :type metadata: Dict[str, str]
@@ -106,7 +107,7 @@ class SystemApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "bytearray",
-            '400': "Error2",
+            '400': "Error",
         }
         response_data = await self.api_client.call_api(
             *_param,
@@ -122,7 +123,7 @@ class SystemApi:
     @validate_call
     async def backup_configuration_with_http_info(
         self,
-        resources: Annotated[List[StrictStr], Field(description="List of resource identifiers to included in the backup and restore operations.")],
+        resources: Annotated[Optional[List[StrictStr]], Field(description="List of resource identifiers to include in the retrieval.")] = None,
         metadata: Annotated[Optional[Dict[str, StrictStr]], Field(description="Additional metadata to add to the backup")] = None,
         _request_timeout: Union[
             None,
@@ -139,9 +140,9 @@ class SystemApi:
     ) -> ApiResponse[bytearray]:
         """Retrieve Configuration Backup
 
-        Retrieves a configuration backup based on provided resource identifiers. 
+        Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved. 
 
-        :param resources: List of resource identifiers to included in the backup and restore operations. (required)
+        :param resources: List of resource identifiers to include in the retrieval.
         :type resources: List[str]
         :param metadata: Additional metadata to add to the backup
         :type metadata: Dict[str, str]
@@ -178,7 +179,7 @@ class SystemApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "bytearray",
-            '400': "Error2",
+            '400': "Error",
         }
         response_data = await self.api_client.call_api(
             *_param,
@@ -194,7 +195,7 @@ class SystemApi:
     @validate_call
     async def backup_configuration_without_preload_content(
         self,
-        resources: Annotated[List[StrictStr], Field(description="List of resource identifiers to included in the backup and restore operations.")],
+        resources: Annotated[Optional[List[StrictStr]], Field(description="List of resource identifiers to include in the retrieval.")] = None,
         metadata: Annotated[Optional[Dict[str, StrictStr]], Field(description="Additional metadata to add to the backup")] = None,
         _request_timeout: Union[
             None,
@@ -211,9 +212,9 @@ class SystemApi:
     ) -> RESTResponseType:
         """Retrieve Configuration Backup
 
-        Retrieves a configuration backup based on provided resource identifiers. 
+        Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved. 
 
-        :param resources: List of resource identifiers to included in the backup and restore operations. (required)
+        :param resources: List of resource identifiers to include in the retrieval.
         :type resources: List[str]
         :param metadata: Additional metadata to add to the backup
         :type metadata: Dict[str, str]
@@ -250,7 +251,7 @@ class SystemApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "bytearray",
-            '400': "Error2",
+            '400': "Error",
         }
         response_data = await self.api_client.call_api(
             *_param,
@@ -592,6 +593,269 @@ class SystemApi:
 
 
 
+    @validate_call
+    async def get_configuration_backup_status(
+        self,
+        operation_id: UUID,
+        _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,
+    ) -> ConfigurationArchiveStatus:
+        """Retrieve Backup Status
+
+        Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
+
+        :param operation_id: (required)
+        :type operation_id: str
+        :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_configuration_backup_status_serialize(
+            operation_id=operation_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ConfigurationArchiveStatus",
+            '404': "Error",
+        }
+        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_configuration_backup_status_with_http_info(
+        self,
+        operation_id: UUID,
+        _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[ConfigurationArchiveStatus]:
+        """Retrieve Backup Status
+
+        Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
+
+        :param operation_id: (required)
+        :type operation_id: str
+        :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_configuration_backup_status_serialize(
+            operation_id=operation_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ConfigurationArchiveStatus",
+            '404': "Error",
+        }
+        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_configuration_backup_status_without_preload_content(
+        self,
+        operation_id: UUID,
+        _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:
+        """Retrieve Backup Status
+
+        Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
+
+        :param operation_id: (required)
+        :type operation_id: str
+        :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_configuration_backup_status_serialize(
+            operation_id=operation_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ConfigurationArchiveStatus",
+            '404': "Error",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_configuration_backup_status_serialize(
+        self,
+        operation_id,
+        _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
+        if operation_id is not None:
+            
+            _query_params.append(('operation_id', operation_id))
+            
+        # 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='/system/configuration/status',
+            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
+        )
+
+
+
     @validate_call
     async def get_diagnose_package(
         self,
@@ -1623,7 +1887,7 @@ class SystemApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': None,
-            '400': "Error2",
+            '400': "Error",
         }
         response_data = await self.api_client.call_api(
             *_param,
@@ -1695,7 +1959,7 @@ class SystemApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': None,
-            '400': "Error2",
+            '400': "Error",
         }
         response_data = await self.api_client.call_api(
             *_param,
@@ -1767,7 +2031,7 @@ class SystemApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': None,
-            '400': "Error2",
+            '400': "Error",
         }
         response_data = await self.api_client.call_api(
             *_param,