hyperstack 1.45.2a0__py3-none-any.whl → 1.46.2a0__py3-none-any.whl

hyperstack/api/virtual_machine_events_api.py

@@ -38,7 +38,7 @@ class VirtualMachineEventsApi:
 
 
     @validate_call
-    def list_virtual_machine_events(
+    def list_vm_events(
         self,
         vm_id: StrictInt,
         _request_timeout: Union[
@@ -82,7 +82,7 @@ class VirtualMachineEventsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_virtual_machine_events_serialize(
+        _param = self._list_vm_events_serialize(
             vm_id=vm_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -109,7 +109,7 @@ class VirtualMachineEventsApi:
 
 
     @validate_call
-    def list_virtual_machine_events_with_http_info(
+    def list_vm_events_with_http_info(
         self,
         vm_id: StrictInt,
         _request_timeout: Union[
@@ -153,7 +153,7 @@ class VirtualMachineEventsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_virtual_machine_events_serialize(
+        _param = self._list_vm_events_serialize(
             vm_id=vm_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -180,7 +180,7 @@ class VirtualMachineEventsApi:
 
 
     @validate_call
-    def list_virtual_machine_events_without_preload_content(
+    def list_vm_events_without_preload_content(
         self,
         vm_id: StrictInt,
         _request_timeout: Union[
@@ -224,7 +224,7 @@ class VirtualMachineEventsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_virtual_machine_events_serialize(
+        _param = self._list_vm_events_serialize(
             vm_id=vm_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -246,7 +246,7 @@ class VirtualMachineEventsApi:
         return response_data.response
 
 
-    def _list_virtual_machine_events_serialize(
+    def _list_vm_events_serialize(
         self,
         vm_id,
         _request_auth,

hyperstack/api/vnc_url_api.py

@@ -39,9 +39,10 @@ class VncUrlApi:
 
 
     @validate_call
-    def get_vnc_url(
+    def get_vncurl(
         self,
         vm_id: StrictInt,
+        job_id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -54,13 +55,15 @@ class VncUrlApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> RequestConsole:
-        """Request Instance Console
+    ) -> VNCURL:
+        """Get VNC Console Link
 
-        Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-console-path).
+        Retrieves the URL to access the VNC console for a specified virtual machine by providing the virtual machine ID and the job ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-vnc-url).
 
         :param vm_id: (required)
         :type vm_id: int
+        :param job_id: (required)
+        :type job_id: int
         :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
@@ -83,8 +86,9 @@ class VncUrlApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_vnc_url_serialize(
+        _param = self._get_vncurl_serialize(
             vm_id=vm_id,
+            job_id=job_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -92,7 +96,7 @@ class VncUrlApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "RequestConsole",
+            '200': "VNCURL",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -110,9 +114,10 @@ class VncUrlApi:
 
 
     @validate_call
-    def get_vnc_url_with_http_info(
+    def get_vncurl_with_http_info(
         self,
         vm_id: StrictInt,
+        job_id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -125,13 +130,15 @@ class VncUrlApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[RequestConsole]:
-        """Request Instance Console
+    ) -> ApiResponse[VNCURL]:
+        """Get VNC Console Link
 
-        Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-console-path).
+        Retrieves the URL to access the VNC console for a specified virtual machine by providing the virtual machine ID and the job ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-vnc-url).
 
         :param vm_id: (required)
         :type vm_id: int
+        :param job_id: (required)
+        :type job_id: int
         :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
@@ -154,8 +161,9 @@ class VncUrlApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_vnc_url_serialize(
+        _param = self._get_vncurl_serialize(
             vm_id=vm_id,
+            job_id=job_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -163,7 +171,7 @@ class VncUrlApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "RequestConsole",
+            '200': "VNCURL",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -181,9 +189,10 @@ class VncUrlApi:
 
 
     @validate_call
-    def get_vnc_url_without_preload_content(
+    def get_vncurl_without_preload_content(
         self,
         vm_id: StrictInt,
+        job_id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -197,12 +206,14 @@ class VncUrlApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Request Instance Console
+        """Get VNC Console Link
 
-        Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-console-path).
+        Retrieves the URL to access the VNC console for a specified virtual machine by providing the virtual machine ID and the job ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-vnc-url).
 
         :param vm_id: (required)
         :type vm_id: int
+        :param job_id: (required)
+        :type job_id: int
         :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
@@ -225,8 +236,9 @@ class VncUrlApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_vnc_url_serialize(
+        _param = self._get_vncurl_serialize(
             vm_id=vm_id,
+            job_id=job_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -234,7 +246,7 @@ class VncUrlApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "RequestConsole",
+            '200': "VNCURL",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -247,9 +259,10 @@ class VncUrlApi:
         return response_data.response
 
 
-    def _get_vnc_url_serialize(
+    def _get_vncurl_serialize(
         self,
         vm_id,
+        job_id,
         _request_auth,
         _content_type,
         _headers,
@@ -273,6 +286,8 @@ class VncUrlApi:
         # process the path parameters
         if vm_id is not None:
             _path_params['vm_id'] = vm_id
+        if job_id is not None:
+            _path_params['job_id'] = job_id
         # process the query parameters
         # process the header parameters
         # process the form parameters
@@ -295,7 +310,7 @@ class VncUrlApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/core/virtual-machines/{vm_id}/request-console',
+            resource_path='/core/virtual-machines/{vm_id}/console/{job_id}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -312,10 +327,9 @@ class VncUrlApi:
 
 
     @validate_call
-    def get_vncurl(
+    def request_vm_console(
         self,
         vm_id: StrictInt,
-        job_id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -328,15 +342,13 @@ class VncUrlApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> VNCURL:
-        """Get VNC Console Link
+    ) -> RequestConsole:
+        """Request Instance Console
 
-        Retrieves the URL to access the VNC console for a specified virtual machine by providing the virtual machine ID and the job ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-vnc-url).
+        Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-console-path).
 
         :param vm_id: (required)
         :type vm_id: int
-        :param job_id: (required)
-        :type job_id: int
         :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
@@ -359,9 +371,8 @@ class VncUrlApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_vncurl_serialize(
+        _param = self._request_vm_console_serialize(
             vm_id=vm_id,
-            job_id=job_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -369,7 +380,7 @@ class VncUrlApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "VNCURL",
+            '200': "RequestConsole",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -387,10 +398,9 @@ class VncUrlApi:
 
 
     @validate_call
-    def get_vncurl_with_http_info(
+    def request_vm_console_with_http_info(
         self,
         vm_id: StrictInt,
-        job_id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -403,15 +413,13 @@ class VncUrlApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[VNCURL]:
-        """Get VNC Console Link
+    ) -> ApiResponse[RequestConsole]:
+        """Request Instance Console
 
-        Retrieves the URL to access the VNC console for a specified virtual machine by providing the virtual machine ID and the job ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-vnc-url).
+        Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-console-path).
 
         :param vm_id: (required)
         :type vm_id: int
-        :param job_id: (required)
-        :type job_id: int
         :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
@@ -434,9 +442,8 @@ class VncUrlApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_vncurl_serialize(
+        _param = self._request_vm_console_serialize(
             vm_id=vm_id,
-            job_id=job_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -444,7 +451,7 @@ class VncUrlApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "VNCURL",
+            '200': "RequestConsole",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -462,10 +469,9 @@ class VncUrlApi:
 
 
     @validate_call
-    def get_vncurl_without_preload_content(
+    def request_vm_console_without_preload_content(
         self,
         vm_id: StrictInt,
-        job_id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -479,14 +485,12 @@ class VncUrlApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get VNC Console Link
+        """Request Instance Console
 
-        Retrieves the URL to access the VNC console for a specified virtual machine by providing the virtual machine ID and the job ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-vnc-url).
+        Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-console-path).
 
         :param vm_id: (required)
         :type vm_id: int
-        :param job_id: (required)
-        :type job_id: int
         :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
@@ -509,9 +513,8 @@ class VncUrlApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_vncurl_serialize(
+        _param = self._request_vm_console_serialize(
             vm_id=vm_id,
-            job_id=job_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -519,7 +522,7 @@ class VncUrlApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "VNCURL",
+            '200': "RequestConsole",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -532,10 +535,9 @@ class VncUrlApi:
         return response_data.response
 
 
-    def _get_vncurl_serialize(
+    def _request_vm_console_serialize(
         self,
         vm_id,
-        job_id,
         _request_auth,
         _content_type,
         _headers,
@@ -559,8 +561,6 @@ class VncUrlApi:
         # process the path parameters
         if vm_id is not None:
             _path_params['vm_id'] = vm_id
-        if job_id is not None:
-            _path_params['job_id'] = job_id
         # process the query parameters
         # process the header parameters
         # process the form parameters
@@ -583,7 +583,7 @@ class VncUrlApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/core/virtual-machines/{vm_id}/console/{job_id}',
+            resource_path='/core/virtual-machines/{vm_id}/request-console',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,