hyperstack 0.1.23__py3-none-any.whl → 1.41.0a0__py3-none-any.whl

hyperstack/api/volume_attachment_api.py

@@ -21,6 +21,7 @@ from ..models.attach_volumes import AttachVolumes
 from ..models.attach_volumes_payload import AttachVolumesPayload
 from ..models.detach_volumes import DetachVolumes
 from ..models.detach_volumes_payload import DetachVolumesPayload
+from ..models.update_volume_attachment_payload import UpdateVolumeAttachmentPayload
 
 from ..api_client import ApiClient, RequestSerialized
 from ..api_response import ApiResponse
@@ -43,7 +44,7 @@ class VolumeAttachmentApi:
     @validate_call
     def attach_volumes_to_virtual_machine(
         self,
-        virtual_machine_id: StrictInt,
+        vm_id: StrictInt,
         payload: AttachVolumesPayload,
         _request_timeout: Union[
             None,
@@ -60,10 +61,10 @@ class VolumeAttachmentApi:
     ) -> AttachVolumes:
         """Attach volumes to virtual machine
 
-        Attaches one or more volumes to an existing virtual machine, expanding its storage capacity by 2PB per attached volume. Include the virtual machine ID in the path and the volume IDs in the request body to attach the specified volumes to the designated virtual machine. For additional details on volume attachment, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/volumes-available-features#attach-a-volume-to-a-virtual-machine-1).
+        Attaches one or more volumes to an existing virtual machine, expanding its storage capacity by 2PB per attached volume. Include the VM ID in the path and the volume IDs in the request body to attach the specified volumes. For more detailson volume attachment, [**click here**](https://docs...cloud/docs/api-reference/core-resources/volumes/volume-attachment/attach-volumes/).
 
-        :param virtual_machine_id: (required)
-        :type virtual_machine_id: int
+        :param vm_id: (required)
+        :type vm_id: int
         :param payload: (required)
         :type payload: AttachVolumesPayload
         :param _request_timeout: timeout setting for this request. If one
@@ -89,7 +90,7 @@ class VolumeAttachmentApi:
         """ # noqa: E501
 
         _param = self._attach_volumes_to_virtual_machine_serialize(
-            virtual_machine_id=virtual_machine_id,
+            vm_id=vm_id,
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -119,7 +120,7 @@ class VolumeAttachmentApi:
     @validate_call
     def attach_volumes_to_virtual_machine_with_http_info(
         self,
-        virtual_machine_id: StrictInt,
+        vm_id: StrictInt,
         payload: AttachVolumesPayload,
         _request_timeout: Union[
             None,
@@ -136,10 +137,10 @@ class VolumeAttachmentApi:
     ) -> ApiResponse[AttachVolumes]:
         """Attach volumes to virtual machine
 
-        Attaches one or more volumes to an existing virtual machine, expanding its storage capacity by 2PB per attached volume. Include the virtual machine ID in the path and the volume IDs in the request body to attach the specified volumes to the designated virtual machine. For additional details on volume attachment, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/volumes-available-features#attach-a-volume-to-a-virtual-machine-1).
+        Attaches one or more volumes to an existing virtual machine, expanding its storage capacity by 2PB per attached volume. Include the VM ID in the path and the volume IDs in the request body to attach the specified volumes. For more detailson volume attachment, [**click here**](https://docs...cloud/docs/api-reference/core-resources/volumes/volume-attachment/attach-volumes/).
 
-        :param virtual_machine_id: (required)
-        :type virtual_machine_id: int
+        :param vm_id: (required)
+        :type vm_id: int
         :param payload: (required)
         :type payload: AttachVolumesPayload
         :param _request_timeout: timeout setting for this request. If one
@@ -165,7 +166,7 @@ class VolumeAttachmentApi:
         """ # noqa: E501
 
         _param = self._attach_volumes_to_virtual_machine_serialize(
-            virtual_machine_id=virtual_machine_id,
+            vm_id=vm_id,
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -195,7 +196,7 @@ class VolumeAttachmentApi:
     @validate_call
     def attach_volumes_to_virtual_machine_without_preload_content(
         self,
-        virtual_machine_id: StrictInt,
+        vm_id: StrictInt,
         payload: AttachVolumesPayload,
         _request_timeout: Union[
             None,
@@ -212,10 +213,10 @@ class VolumeAttachmentApi:
     ) -> RESTResponseType:
         """Attach volumes to virtual machine
 
-        Attaches one or more volumes to an existing virtual machine, expanding its storage capacity by 2PB per attached volume. Include the virtual machine ID in the path and the volume IDs in the request body to attach the specified volumes to the designated virtual machine. For additional details on volume attachment, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/volumes-available-features#attach-a-volume-to-a-virtual-machine-1).
+        Attaches one or more volumes to an existing virtual machine, expanding its storage capacity by 2PB per attached volume. Include the VM ID in the path and the volume IDs in the request body to attach the specified volumes. For more detailson volume attachment, [**click here**](https://docs...cloud/docs/api-reference/core-resources/volumes/volume-attachment/attach-volumes/).
 
-        :param virtual_machine_id: (required)
-        :type virtual_machine_id: int
+        :param vm_id: (required)
+        :type vm_id: int
         :param payload: (required)
         :type payload: AttachVolumesPayload
         :param _request_timeout: timeout setting for this request. If one
@@ -241,7 +242,7 @@ class VolumeAttachmentApi:
         """ # noqa: E501
 
         _param = self._attach_volumes_to_virtual_machine_serialize(
-            virtual_machine_id=virtual_machine_id,
+            vm_id=vm_id,
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -266,7 +267,7 @@ class VolumeAttachmentApi:
 
     def _attach_volumes_to_virtual_machine_serialize(
         self,
-        virtual_machine_id,
+        vm_id,
         payload,
         _request_auth,
         _content_type,
@@ -289,8 +290,8 @@ class VolumeAttachmentApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if virtual_machine_id is not None:
-            _path_params['virtual_machine_id'] = virtual_machine_id
+        if vm_id is not None:
+            _path_params['vm_id'] = vm_id
         # process the query parameters
         # process the header parameters
         # process the form parameters
@@ -323,13 +324,12 @@ class VolumeAttachmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
             method='POST',
-            resource_path='/core/virtual-machines/{virtual_machine_id}/attach-volumes',
+            resource_path='/core/virtual-machines/{vm_id}/attach-volumes',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -348,7 +348,7 @@ class VolumeAttachmentApi:
     @validate_call
     def detach_volumes_from_virtual_machine(
         self,
-        virtual_machine_id: StrictInt,
+        vm_id: StrictInt,
         payload: DetachVolumesPayload,
         _request_timeout: Union[
             None,
@@ -365,10 +365,10 @@ class VolumeAttachmentApi:
     ) -> DetachVolumes:
         """Detach volumes from virtual machine
 
-        Detaches one or more volumes currently attached to an existing virtual machine. Include the virtual machine ID in the path and the volume IDs in the request body to detach the specified volumes from the designated virtual machine.
+        Detaches one or more volumes attached to an existing virtual machine. Include the VM ID in the path and volume IDs in the request body to detach the specified volumes from the virtual machine.
 
-        :param virtual_machine_id: (required)
-        :type virtual_machine_id: int
+        :param vm_id: (required)
+        :type vm_id: int
         :param payload: (required)
         :type payload: DetachVolumesPayload
         :param _request_timeout: timeout setting for this request. If one
@@ -394,7 +394,7 @@ class VolumeAttachmentApi:
         """ # noqa: E501
 
         _param = self._detach_volumes_from_virtual_machine_serialize(
-            virtual_machine_id=virtual_machine_id,
+            vm_id=vm_id,
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -424,7 +424,7 @@ class VolumeAttachmentApi:
     @validate_call
     def detach_volumes_from_virtual_machine_with_http_info(
         self,
-        virtual_machine_id: StrictInt,
+        vm_id: StrictInt,
         payload: DetachVolumesPayload,
         _request_timeout: Union[
             None,
@@ -441,10 +441,10 @@ class VolumeAttachmentApi:
     ) -> ApiResponse[DetachVolumes]:
         """Detach volumes from virtual machine
 
-        Detaches one or more volumes currently attached to an existing virtual machine. Include the virtual machine ID in the path and the volume IDs in the request body to detach the specified volumes from the designated virtual machine.
+        Detaches one or more volumes attached to an existing virtual machine. Include the VM ID in the path and volume IDs in the request body to detach the specified volumes from the virtual machine.
 
-        :param virtual_machine_id: (required)
-        :type virtual_machine_id: int
+        :param vm_id: (required)
+        :type vm_id: int
         :param payload: (required)
         :type payload: DetachVolumesPayload
         :param _request_timeout: timeout setting for this request. If one
@@ -470,7 +470,7 @@ class VolumeAttachmentApi:
         """ # noqa: E501
 
         _param = self._detach_volumes_from_virtual_machine_serialize(
-            virtual_machine_id=virtual_machine_id,
+            vm_id=vm_id,
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -500,7 +500,7 @@ class VolumeAttachmentApi:
     @validate_call
     def detach_volumes_from_virtual_machine_without_preload_content(
         self,
-        virtual_machine_id: StrictInt,
+        vm_id: StrictInt,
         payload: DetachVolumesPayload,
         _request_timeout: Union[
             None,
@@ -517,10 +517,10 @@ class VolumeAttachmentApi:
     ) -> RESTResponseType:
         """Detach volumes from virtual machine
 
-        Detaches one or more volumes currently attached to an existing virtual machine. Include the virtual machine ID in the path and the volume IDs in the request body to detach the specified volumes from the designated virtual machine.
+        Detaches one or more volumes attached to an existing virtual machine. Include the VM ID in the path and volume IDs in the request body to detach the specified volumes from the virtual machine.
 
-        :param virtual_machine_id: (required)
-        :type virtual_machine_id: int
+        :param vm_id: (required)
+        :type vm_id: int
         :param payload: (required)
         :type payload: DetachVolumesPayload
         :param _request_timeout: timeout setting for this request. If one
@@ -546,7 +546,7 @@ class VolumeAttachmentApi:
         """ # noqa: E501
 
         _param = self._detach_volumes_from_virtual_machine_serialize(
-            virtual_machine_id=virtual_machine_id,
+            vm_id=vm_id,
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -571,7 +571,7 @@ class VolumeAttachmentApi:
 
     def _detach_volumes_from_virtual_machine_serialize(
         self,
-        virtual_machine_id,
+        vm_id,
         payload,
         _request_auth,
         _content_type,
@@ -594,8 +594,8 @@ class VolumeAttachmentApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if virtual_machine_id is not None:
-            _path_params['virtual_machine_id'] = virtual_machine_id
+        if vm_id is not None:
+            _path_params['vm_id'] = vm_id
         # process the query parameters
         # process the header parameters
         # process the form parameters
@@ -628,13 +628,313 @@ class VolumeAttachmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
             method='POST',
-            resource_path='/core/virtual-machines/{virtual_machine_id}/detach-volumes',
+            resource_path='/core/virtual-machines/{vm_id}/detach-volumes',
+            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
+    def update_a_volume_attachment(
+        self,
+        volume_attachment_id: StrictInt,
+        payload: UpdateVolumeAttachmentPayload,
+        _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,
+    ) -> AttachVolumes:
+        """Update a volume attachment
+
+
+        :param volume_attachment_id: (required)
+        :type volume_attachment_id: int
+        :param payload: (required)
+        :type payload: UpdateVolumeAttachmentPayload
+        :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._update_a_volume_attachment_serialize(
+            volume_attachment_id=volume_attachment_id,
+            payload=payload,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AttachVolumes",
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
+            '405': "ErrorResponseModel",
+            '500': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def update_a_volume_attachment_with_http_info(
+        self,
+        volume_attachment_id: StrictInt,
+        payload: UpdateVolumeAttachmentPayload,
+        _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[AttachVolumes]:
+        """Update a volume attachment
+
+
+        :param volume_attachment_id: (required)
+        :type volume_attachment_id: int
+        :param payload: (required)
+        :type payload: UpdateVolumeAttachmentPayload
+        :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._update_a_volume_attachment_serialize(
+            volume_attachment_id=volume_attachment_id,
+            payload=payload,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AttachVolumes",
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
+            '405': "ErrorResponseModel",
+            '500': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def update_a_volume_attachment_without_preload_content(
+        self,
+        volume_attachment_id: StrictInt,
+        payload: UpdateVolumeAttachmentPayload,
+        _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:
+        """Update a volume attachment
+
+
+        :param volume_attachment_id: (required)
+        :type volume_attachment_id: int
+        :param payload: (required)
+        :type payload: UpdateVolumeAttachmentPayload
+        :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._update_a_volume_attachment_serialize(
+            volume_attachment_id=volume_attachment_id,
+            payload=payload,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AttachVolumes",
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
+            '405': "ErrorResponseModel",
+            '500': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _update_a_volume_attachment_serialize(
+        self,
+        volume_attachment_id,
+        payload,
+        _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, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if volume_attachment_id is not None:
+            _path_params['volume_attachment_id'] = volume_attachment_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if payload is not None:
+            _body_params = payload
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'apiKey'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/core/volume-attachments/{volume_attachment_id}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,

hyperstack/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.1.23/python'
+        self.user_agent = 'OpenAPI-Generator/v1.41.0-alpha/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):