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

wandelbots_api_client/v2/api/application_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
@@ -65,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. 
+        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.  #### Workflow  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information.  #### Predefined environment variables  <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application's root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -142,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. 
+        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.  #### Workflow  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information.  #### Predefined environment variables  <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application's root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -219,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. 
+        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.  #### Workflow  After adding the application to the cell, open the application on the Wandelbots NOVA home screen.  Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information.  #### Predefined environment variables  <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application's root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -944,7 +943,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. 
+        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 [updateApp](updateApp). 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1016,7 +1015,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. 
+        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 [updateApp](updateApp). 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1088,7 +1087,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. 
+        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 [updateApp](updateApp). 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -1219,7 +1218,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. 
+        List all GUI applications that have been added to a cell with [addApp](addApp).  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
@@ -1286,7 +1285,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. 
+        List all GUI applications that have been added to a cell with [addApp](addApp).  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
@@ -1353,7 +1352,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. 
+        List all GUI applications that have been added to a cell with [addApp](addApp).  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