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

hyperstack/api/environment_api.py

@@ -22,6 +22,7 @@ from typing_extensions import Annotated
 from ..models.create_environment import CreateEnvironment
 from ..models.environment import Environment
 from ..models.environments import Environments
+from ..models.name_available_model import NameAvailableModel
 from ..models.response_model import ResponseModel
 from ..models.update_environment import UpdateEnvironment
 
@@ -62,7 +63,7 @@ class EnvironmentApi:
     ) -> Environment:
         """Create environment
 
-        Creates an environment—a container to organize your resources, including SSH key pairs, virtual machines, and volumes. To create your environment, provide your desired environment name, and [**region**](https://infrahub-doc.nexgencloud.com/docs/features/regions) in the request body.
+        Creates an environment—a container to organize your resources, including SSH key pairs, virtual machines, and volumes. To create your environment, provide your desired environment name, and [**region**](https://docs...cloud/docs/resource-management/regions/) in the request body.
 
         :param payload: (required)
         :type payload: CreateEnvironment
@@ -134,7 +135,7 @@ class EnvironmentApi:
     ) -> ApiResponse[Environment]:
         """Create environment
 
-        Creates an environment—a container to organize your resources, including SSH key pairs, virtual machines, and volumes. To create your environment, provide your desired environment name, and [**region**](https://infrahub-doc.nexgencloud.com/docs/features/regions) in the request body.
+        Creates an environment—a container to organize your resources, including SSH key pairs, virtual machines, and volumes. To create your environment, provide your desired environment name, and [**region**](https://docs...cloud/docs/resource-management/regions/) in the request body.
 
         :param payload: (required)
         :type payload: CreateEnvironment
@@ -206,7 +207,7 @@ class EnvironmentApi:
     ) -> RESTResponseType:
         """Create environment
 
-        Creates an environment—a container to organize your resources, including SSH key pairs, virtual machines, and volumes. To create your environment, provide your desired environment name, and [**region**](https://infrahub-doc.nexgencloud.com/docs/features/regions) in the request body.
+        Creates an environment—a container to organize your resources, including SSH key pairs, virtual machines, and volumes. To create your environment, provide your desired environment name, and [**region**](https://docs...cloud/docs/resource-management/regions/) in the request body.
 
         :param payload: (required)
         :type payload: CreateEnvironment
@@ -311,8 +312,7 @@ class EnvironmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -585,8 +585,7 @@ class EnvironmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -607,6 +606,279 @@ class EnvironmentApi:
 
 
 
+    @validate_call
+    def fetch_environment_name_availability(
+        self,
+        name: StrictStr,
+        _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,
+    ) -> NameAvailableModel:
+        """Fetch environment name availability
+
+        Check if a Environment name is available
+
+        :param name: (required)
+        :type name: 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._fetch_environment_name_availability_serialize(
+            name=name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "NameAvailableModel",
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '404': "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 fetch_environment_name_availability_with_http_info(
+        self,
+        name: StrictStr,
+        _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[NameAvailableModel]:
+        """Fetch environment name availability
+
+        Check if a Environment name is available
+
+        :param name: (required)
+        :type name: 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._fetch_environment_name_availability_serialize(
+            name=name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "NameAvailableModel",
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '404': "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 fetch_environment_name_availability_without_preload_content(
+        self,
+        name: StrictStr,
+        _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:
+        """Fetch environment name availability
+
+        Check if a Environment name is available
+
+        :param name: (required)
+        :type name: 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._fetch_environment_name_availability_serialize(
+            name=name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "NameAvailableModel",
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
+            '500': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _fetch_environment_name_availability_serialize(
+        self,
+        name,
+        _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 name is not None:
+            _path_params['name'] = name
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'apiKey'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/core/environments/name-availability/{name}',
+            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 list_environments(
         self,
@@ -628,7 +900,7 @@ class EnvironmentApi:
     ) -> Environments:
         """List environments
 
-        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://infrahub-doc.nexgencloud.com/docs/features/regions), and the date and time of creation. For more information on environments, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/environments-available-features).
+        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
 
         :param page: Page Number
         :type page: str
@@ -706,7 +978,7 @@ class EnvironmentApi:
     ) -> ApiResponse[Environments]:
         """List environments
 
-        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://infrahub-doc.nexgencloud.com/docs/features/regions), and the date and time of creation. For more information on environments, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/environments-available-features).
+        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
 
         :param page: Page Number
         :type page: str
@@ -784,7 +1056,7 @@ class EnvironmentApi:
     ) -> RESTResponseType:
         """List environments
 
-        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://infrahub-doc.nexgencloud.com/docs/features/regions), and the date and time of creation. For more information on environments, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/environments-available-features).
+        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
 
         :param page: Page Number
         :type page: str
@@ -892,8 +1164,7 @@ class EnvironmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -1166,8 +1437,7 @@ class EnvironmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -1468,8 +1738,7 @@ class EnvironmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(

hyperstack/api/firewall_attachment_api.py

@@ -39,7 +39,7 @@ class FirewallAttachmentApi:
 
 
     @validate_call
-    def attach_firewalls_to_vms(
+    def post_attach_security_groups(
         self,
         firewall_id: StrictInt,
         payload: AttachFirewallWithVM,
@@ -58,6 +58,7 @@ class FirewallAttachmentApi:
     ) -> ResponseModel:
         """Attach Firewalls to VMs
 
+        Attach a firewall to one or more virtual machines by providing the virtual machine IDs in the request body and the firewall ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/firewalls/attach-firewall-to-vms).
 
         :param firewall_id: (required)
         :type firewall_id: int
@@ -85,7 +86,7 @@ class FirewallAttachmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._attach_firewalls_to_vms_serialize(
+        _param = self._post_attach_security_groups_serialize(
             firewall_id=firewall_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -115,7 +116,7 @@ class FirewallAttachmentApi:
 
 
     @validate_call
-    def attach_firewalls_to_vms_with_http_info(
+    def post_attach_security_groups_with_http_info(
         self,
         firewall_id: StrictInt,
         payload: AttachFirewallWithVM,
@@ -134,6 +135,7 @@ class FirewallAttachmentApi:
     ) -> ApiResponse[ResponseModel]:
         """Attach Firewalls to VMs
 
+        Attach a firewall to one or more virtual machines by providing the virtual machine IDs in the request body and the firewall ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/firewalls/attach-firewall-to-vms).
 
         :param firewall_id: (required)
         :type firewall_id: int
@@ -161,7 +163,7 @@ class FirewallAttachmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._attach_firewalls_to_vms_serialize(
+        _param = self._post_attach_security_groups_serialize(
             firewall_id=firewall_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -191,7 +193,7 @@ class FirewallAttachmentApi:
 
 
     @validate_call
-    def attach_firewalls_to_vms_without_preload_content(
+    def post_attach_security_groups_without_preload_content(
         self,
         firewall_id: StrictInt,
         payload: AttachFirewallWithVM,
@@ -210,6 +212,7 @@ class FirewallAttachmentApi:
     ) -> RESTResponseType:
         """Attach Firewalls to VMs
 
+        Attach a firewall to one or more virtual machines by providing the virtual machine IDs in the request body and the firewall ID in the path. For more information, [**click here**](https://docs...cloud/docs/api-reference/core-resources/firewalls/attach-firewall-to-vms).
 
         :param firewall_id: (required)
         :type firewall_id: int
@@ -237,7 +240,7 @@ class FirewallAttachmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._attach_firewalls_to_vms_serialize(
+        _param = self._post_attach_security_groups_serialize(
             firewall_id=firewall_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -262,7 +265,7 @@ class FirewallAttachmentApi:
         return response_data.response
 
 
-    def _attach_firewalls_to_vms_serialize(
+    def _post_attach_security_groups_serialize(
         self,
         firewall_id,
         payload,
@@ -321,8 +324,7 @@ class FirewallAttachmentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(