wandelbots-api-client 26.3.0.dev26__py3-none-any.whl → 26.3.0.dev28__py3-none-any.whl

wandelbots_api_client/__init__.py

@@ -7,13 +7,13 @@
 
     Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 1.3.0
+    The version of the OpenAPI document: 1.4.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
-__version__ = "26.3.0.dev26"
+__version__ = "26.3.0.dev28"
 
 from . import models
 from . import api

wandelbots_api_client/api/application_api.py

@@ -5,7 +5,7 @@
 
     Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 1.3.0
+    The version of the OpenAPI document: 1.4.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -64,7 +64,7 @@ class ApplicationApi:
     ) -> None:
         """Add Application
 
-        Install a basic, containerized web application to the cell to control robots with a customized frontend.  Prerequisites: A Docker hub account or similar container registry account, with valid credentials.  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](/docs/docs/development/) for more information.  <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed. 
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Install a basic, containerized web application to the cell to control robots with a customized frontend.  Prerequisites: A Docker hub account or similar container registry account, with valid credentials.  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](/docs/docs/development/) for more information.  <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -141,7 +141,7 @@ class ApplicationApi:
     ) -> ApiResponse[None]:
         """Add Application
 
-        Install a basic, containerized web application to the cell to control robots with a customized frontend.  Prerequisites: A Docker hub account or similar container registry account, with valid credentials.  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](/docs/docs/development/) for more information.  <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed. 
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Install a basic, containerized web application to the cell to control robots with a customized frontend.  Prerequisites: A Docker hub account or similar container registry account, with valid credentials.  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](/docs/docs/development/) for more information.  <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -218,7 +218,7 @@ class ApplicationApi:
     ) -> RESTResponseType:
         """Add Application
 
-        Install a basic, containerized web application to the cell to control robots with a customized frontend.  Prerequisites: A Docker hub account or similar container registry account, with valid credentials.  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](/docs/docs/development/) for more information.  <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed. 
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Install a basic, containerized web application to the cell to control robots with a customized frontend.  Prerequisites: A Docker hub account or similar container registry account, with valid credentials.  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](/docs/docs/development/) for more information.  <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -365,7 +365,7 @@ class ApplicationApi:
     ) -> None:
         """Clear Applications
 
-        Delete all GUI applications from the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Delete all GUI applications from the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -438,7 +438,7 @@ class ApplicationApi:
     ) -> ApiResponse[None]:
         """Clear Applications
 
-        Delete all GUI applications from the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Delete all GUI applications from the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -511,7 +511,7 @@ class ApplicationApi:
     ) -> RESTResponseType:
         """Clear Applications
 
-        Delete all GUI applications from the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Delete all GUI applications from the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -646,7 +646,7 @@ class ApplicationApi:
     ) -> None:
         """Delete Application
 
-        Delete a GUI application from the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Delete a GUI application from the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -723,7 +723,7 @@ class ApplicationApi:
     ) -> ApiResponse[None]:
         """Delete Application
 
-        Delete a GUI application from the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Delete a GUI application from the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -800,7 +800,7 @@ class ApplicationApi:
     ) -> RESTResponseType:
         """Delete Application
 
-        Delete a GUI application from the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Delete a GUI application from the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -940,7 +940,7 @@ class ApplicationApi:
     ) -> App:
         """Configuration
 
-        Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the 'Update Configuration' endpoint. 
+        **Required permissions:** `can_access_apps` - View application configurations ___  Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the 'Update Configuration' endpoint. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1012,7 +1012,7 @@ class ApplicationApi:
     ) -> ApiResponse[App]:
         """Configuration
 
-        Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the 'Update Configuration' endpoint. 
+        **Required permissions:** `can_access_apps` - View application configurations ___  Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the 'Update Configuration' endpoint. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1084,7 +1084,7 @@ class ApplicationApi:
     ) -> RESTResponseType:
         """Configuration
 
-        Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the 'Update Configuration' endpoint. 
+        **Required permissions:** `can_access_apps` - View application configurations ___  Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the 'Update Configuration' endpoint. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1214,7 +1214,7 @@ class ApplicationApi:
     ) -> List[str]:
         """List Applications
 
-        List all GUI applications that have been added to a cell. with the 'Add Application' endpoint. If the cell does not contain GUI applications, the list is returned empty. 
+        **Required permissions:** `can_access_apps` - View application configurations ___  List all GUI applications that have been added to a cell. with the 'Add Application' endpoint. If the cell does not contain GUI applications, the list is returned empty. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1281,7 +1281,7 @@ class ApplicationApi:
     ) -> ApiResponse[List[str]]:
         """List Applications
 
-        List all GUI applications that have been added to a cell. with the 'Add Application' endpoint. If the cell does not contain GUI applications, the list is returned empty. 
+        **Required permissions:** `can_access_apps` - View application configurations ___  List all GUI applications that have been added to a cell. with the 'Add Application' endpoint. If the cell does not contain GUI applications, the list is returned empty. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1348,7 +1348,7 @@ class ApplicationApi:
     ) -> RESTResponseType:
         """List Applications
 
-        List all GUI applications that have been added to a cell. with the 'Add Application' endpoint. If the cell does not contain GUI applications, the list is returned empty. 
+        **Required permissions:** `can_access_apps` - View application configurations ___  List all GUI applications that have been added to a cell. with the 'Add Application' endpoint. If the cell does not contain GUI applications, the list is returned empty. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1474,7 +1474,7 @@ class ApplicationApi:
     ) -> None:
         """Update Configuration
 
-        Update the configuration of a GUI application in the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Update the configuration of a GUI application in the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1556,7 +1556,7 @@ class ApplicationApi:
     ) -> ApiResponse[None]:
         """Update Configuration
 
-        Update the configuration of a GUI application in the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Update the configuration of a GUI application in the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1638,7 +1638,7 @@ class ApplicationApi:
     ) -> RESTResponseType:
         """Update Configuration
 
-        Update the configuration of a GUI application in the cell.
+        **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___  Update the configuration of a GUI application in the cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str

wandelbots_api_client/api/cell_api.py

@@ -5,7 +5,7 @@
 
     Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 1.3.0
+    The version of the OpenAPI document: 1.4.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -64,7 +64,7 @@ class CellApi:
     ) -> None:
         """Delete Cell
 
-        Delete an entire cell.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Delete an entire cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -137,7 +137,7 @@ class CellApi:
     ) -> ApiResponse[None]:
         """Delete Cell
 
-        Delete an entire cell.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Delete an entire cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -210,7 +210,7 @@ class CellApi:
     ) -> RESTResponseType:
         """Delete Cell
 
-        Delete an entire cell.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Delete an entire cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -344,7 +344,7 @@ class CellApi:
     ) -> None:
         """Add Cell
 
-        Deploy an entire cell with all its resources.  A cell can be used to deploy a robot controller, one or more robots, as well as custom applications.  Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Deploy an entire cell with all its resources.  A cell can be used to deploy a robot controller, one or more robots, as well as custom applications.  Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
 
         :param cell: (required)
         :type cell: Cell
@@ -418,7 +418,7 @@ class CellApi:
     ) -> ApiResponse[None]:
         """Add Cell
 
-        Deploy an entire cell with all its resources.  A cell can be used to deploy a robot controller, one or more robots, as well as custom applications.  Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Deploy an entire cell with all its resources.  A cell can be used to deploy a robot controller, one or more robots, as well as custom applications.  Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
 
         :param cell: (required)
         :type cell: Cell
@@ -492,7 +492,7 @@ class CellApi:
     ) -> RESTResponseType:
         """Add Cell
 
-        Deploy an entire cell with all its resources.  A cell can be used to deploy a robot controller, one or more robots, as well as custom applications.  Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Deploy an entire cell with all its resources.  A cell can be used to deploy a robot controller, one or more robots, as well as custom applications.  Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
 
         :param cell: (required)
         :type cell: Cell
@@ -639,7 +639,7 @@ class CellApi:
     ) -> Cell:
         """Configuration
 
-        List all cell resources.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman. 
+        **Required permissions:** `can_access_cells` - View cell configurations and resources ___  List all cell resources.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -707,7 +707,7 @@ class CellApi:
     ) -> ApiResponse[Cell]:
         """Configuration
 
-        List all cell resources.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman. 
+        **Required permissions:** `can_access_cells` - View cell configurations and resources ___  List all cell resources.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -775,7 +775,7 @@ class CellApi:
     ) -> RESTResponseType:
         """Configuration
 
-        List all cell resources.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman. 
+        **Required permissions:** `can_access_cells` - View cell configurations and resources ___  List all cell resources.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -899,7 +899,7 @@ class CellApi:
     ) -> List[ServiceStatus]:
         """Service Status
 
-        List the status of all cell resources.
+        **Required permissions:** `can_access_system` - View system status and metadata ___  List the status of all cell resources.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -967,7 +967,7 @@ class CellApi:
     ) -> ApiResponse[List[ServiceStatus]]:
         """Service Status
 
-        List the status of all cell resources.
+        **Required permissions:** `can_access_system` - View system status and metadata ___  List the status of all cell resources.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1035,7 +1035,7 @@ class CellApi:
     ) -> RESTResponseType:
         """Service Status
 
-        List the status of all cell resources.
+        **Required permissions:** `can_access_system` - View system status and metadata ___  List the status of all cell resources.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1158,7 +1158,7 @@ class CellApi:
     ) -> List[str]:
         """List Cells
 
-        List all deployed cell names. If no cells are deployed, an empty list is returned.
+        **Required permissions:** `can_access_cells` - View cell configurations and resources ___  List all deployed cell names. If no cells are deployed, an empty list is returned.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1221,7 +1221,7 @@ class CellApi:
     ) -> ApiResponse[List[str]]:
         """List Cells
 
-        List all deployed cell names. If no cells are deployed, an empty list is returned.
+        **Required permissions:** `can_access_cells` - View cell configurations and resources ___  List all deployed cell names. If no cells are deployed, an empty list is returned.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1284,7 +1284,7 @@ class CellApi:
     ) -> RESTResponseType:
         """List Cells
 
-        List all deployed cell names. If no cells are deployed, an empty list is returned.
+        **Required permissions:** `can_access_cells` - View cell configurations and resources ___  List all deployed cell names. If no cells are deployed, an empty list is returned.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1403,7 +1403,7 @@ class CellApi:
     ) -> None:
         """Update Configuration
 
-        Update the definition of the entire Cell.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Update the definition of the entire Cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1482,7 +1482,7 @@ class CellApi:
     ) -> ApiResponse[None]:
         """Update Configuration
 
-        Update the definition of the entire Cell.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Update the definition of the entire Cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1561,7 +1561,7 @@ class CellApi:
     ) -> RESTResponseType:
         """Update Configuration
 
-        Update the definition of the entire Cell.
+        **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___  Update the definition of the entire Cell.
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str