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

hyperstack/api/firewalls_api.py

@@ -46,7 +46,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def add_firewall_rule_to_an_existing_firewall(
+    def add_rule_to_firewall(
         self,
         firewall_id: StrictInt,
         payload: CreateFirewallRulePayload,
@@ -93,7 +93,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._add_firewall_rule_to_an_existing_firewall_serialize(
+        _param = self._add_rule_to_firewall_serialize(
             firewall_id=firewall_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -121,7 +121,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def add_firewall_rule_to_an_existing_firewall_with_http_info(
+    def add_rule_to_firewall_with_http_info(
         self,
         firewall_id: StrictInt,
         payload: CreateFirewallRulePayload,
@@ -168,7 +168,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._add_firewall_rule_to_an_existing_firewall_serialize(
+        _param = self._add_rule_to_firewall_serialize(
             firewall_id=firewall_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -196,7 +196,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def add_firewall_rule_to_an_existing_firewall_without_preload_content(
+    def add_rule_to_firewall_without_preload_content(
         self,
         firewall_id: StrictInt,
         payload: CreateFirewallRulePayload,
@@ -243,7 +243,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._add_firewall_rule_to_an_existing_firewall_serialize(
+        _param = self._add_rule_to_firewall_serialize(
             firewall_id=firewall_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -266,7 +266,7 @@ class FirewallsApi:
         return response_data.response
 
 
-    def _add_firewall_rule_to_an_existing_firewall_serialize(
+    def _add_rule_to_firewall_serialize(
         self,
         firewall_id,
         payload,
@@ -347,7 +347,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def create_a_new_firewall(
+    def create_firewall(
         self,
         payload: CreateFirewallPayload,
         _request_timeout: Union[
@@ -391,7 +391,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._create_a_new_firewall_serialize(
+        _param = self._create_firewall_serialize(
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -420,7 +420,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def create_a_new_firewall_with_http_info(
+    def create_firewall_with_http_info(
         self,
         payload: CreateFirewallPayload,
         _request_timeout: Union[
@@ -464,7 +464,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._create_a_new_firewall_serialize(
+        _param = self._create_firewall_serialize(
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -493,7 +493,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def create_a_new_firewall_without_preload_content(
+    def create_firewall_without_preload_content(
         self,
         payload: CreateFirewallPayload,
         _request_timeout: Union[
@@ -537,7 +537,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._create_a_new_firewall_serialize(
+        _param = self._create_firewall_serialize(
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -561,7 +561,7 @@ class FirewallsApi:
         return response_data.response
 
 
-    def _create_a_new_firewall_serialize(
+    def _create_firewall_serialize(
         self,
         payload,
         _request_auth,
@@ -918,7 +918,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def delete_firewall_rules_from_firewall(
+    def delete_rule_from_firewall(
         self,
         firewall_id: StrictInt,
         firewall_rule_id: StrictInt,
@@ -965,7 +965,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._delete_firewall_rules_from_firewall_serialize(
+        _param = self._delete_rule_from_firewall_serialize(
             firewall_id=firewall_id,
             firewall_rule_id=firewall_rule_id,
             _request_auth=_request_auth,
@@ -995,7 +995,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def delete_firewall_rules_from_firewall_with_http_info(
+    def delete_rule_from_firewall_with_http_info(
         self,
         firewall_id: StrictInt,
         firewall_rule_id: StrictInt,
@@ -1042,7 +1042,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._delete_firewall_rules_from_firewall_serialize(
+        _param = self._delete_rule_from_firewall_serialize(
             firewall_id=firewall_id,
             firewall_rule_id=firewall_rule_id,
             _request_auth=_request_auth,
@@ -1072,7 +1072,7 @@ class FirewallsApi:
 
 
     @validate_call
-    def delete_firewall_rules_from_firewall_without_preload_content(
+    def delete_rule_from_firewall_without_preload_content(
         self,
         firewall_id: StrictInt,
         firewall_rule_id: StrictInt,
@@ -1119,7 +1119,7 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._delete_firewall_rules_from_firewall_serialize(
+        _param = self._delete_rule_from_firewall_serialize(
             firewall_id=firewall_id,
             firewall_rule_id=firewall_rule_id,
             _request_auth=_request_auth,
@@ -1144,7 +1144,7 @@ class FirewallsApi:
         return response_data.response
 
 
-    def _delete_firewall_rules_from_firewall_serialize(
+    def _delete_rule_from_firewall_serialize(
         self,
         firewall_id,
         firewall_rule_id,
@@ -1212,12 +1212,9 @@ class FirewallsApi:
 
 
     @validate_call
-    def list_existing_firewalls(
+    def get_firewall(
         self,
-        page: Optional[StrictInt] = None,
-        page_size: Optional[StrictInt] = None,
-        search: Optional[StrictStr] = None,
-        environment: Annotated[Optional[StrictStr], Field(description="Filter Environment ID or Name")] = None,
+        id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1230,19 +1227,13 @@ class FirewallsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> FirewallsListResponse:
-        """List firewalls
+    ) -> FirewallDetailResponse:
+        """Retrieve firewall details
 
-        Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Infrahub, [**click here**](https://docs...cloud/docs/network-security/security-groups).
+        Retrieves the details of an existing firewall, including the security rules it contains and information about the virtual machines to which it is attached.
 
-        :param page:
-        :type page: int
-        :param page_size:
-        :type page_size: int
-        :param search:
-        :type search: str
-        :param environment: Filter Environment ID or Name
-        :type environment: str
+        :param id: (required)
+        :type 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
@@ -1265,11 +1256,8 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_existing_firewalls_serialize(
-            page=page,
-            page_size=page_size,
-            search=search,
-            environment=environment,
+        _param = self._get_firewall_serialize(
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1277,10 +1265,11 @@ class FirewallsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FirewallsListResponse",
+            '200': "FirewallDetailResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1295,12 +1284,9 @@ class FirewallsApi:
 
 
     @validate_call
-    def list_existing_firewalls_with_http_info(
+    def get_firewall_with_http_info(
         self,
-        page: Optional[StrictInt] = None,
-        page_size: Optional[StrictInt] = None,
-        search: Optional[StrictStr] = None,
-        environment: Annotated[Optional[StrictStr], Field(description="Filter Environment ID or Name")] = None,
+        id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1313,19 +1299,13 @@ class FirewallsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[FirewallsListResponse]:
-        """List firewalls
+    ) -> ApiResponse[FirewallDetailResponse]:
+        """Retrieve firewall details
 
-        Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Infrahub, [**click here**](https://docs...cloud/docs/network-security/security-groups).
+        Retrieves the details of an existing firewall, including the security rules it contains and information about the virtual machines to which it is attached.
 
-        :param page:
-        :type page: int
-        :param page_size:
-        :type page_size: int
-        :param search:
-        :type search: str
-        :param environment: Filter Environment ID or Name
-        :type environment: str
+        :param id: (required)
+        :type 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
@@ -1348,11 +1328,8 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_existing_firewalls_serialize(
-            page=page,
-            page_size=page_size,
-            search=search,
-            environment=environment,
+        _param = self._get_firewall_serialize(
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1360,10 +1337,11 @@ class FirewallsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FirewallsListResponse",
+            '200': "FirewallDetailResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1378,12 +1356,9 @@ class FirewallsApi:
 
 
     @validate_call
-    def list_existing_firewalls_without_preload_content(
+    def get_firewall_without_preload_content(
         self,
-        page: Optional[StrictInt] = None,
-        page_size: Optional[StrictInt] = None,
-        search: Optional[StrictStr] = None,
-        environment: Annotated[Optional[StrictStr], Field(description="Filter Environment ID or Name")] = None,
+        id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1397,18 +1372,12 @@ class FirewallsApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """List firewalls
+        """Retrieve firewall details
 
-        Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Infrahub, [**click here**](https://docs...cloud/docs/network-security/security-groups).
+        Retrieves the details of an existing firewall, including the security rules it contains and information about the virtual machines to which it is attached.
 
-        :param page:
-        :type page: int
-        :param page_size:
-        :type page_size: int
-        :param search:
-        :type search: str
-        :param environment: Filter Environment ID or Name
-        :type environment: str
+        :param id: (required)
+        :type 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
@@ -1431,11 +1400,8 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_existing_firewalls_serialize(
-            page=page,
-            page_size=page_size,
-            search=search,
-            environment=environment,
+        _param = self._get_firewall_serialize(
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1443,10 +1409,11 @@ class FirewallsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FirewallsListResponse",
+            '200': "FirewallDetailResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1456,12 +1423,9 @@ class FirewallsApi:
         return response_data.response
 
 
-    def _list_existing_firewalls_serialize(
+    def _get_firewall_serialize(
         self,
-        page,
-        page_size,
-        search,
-        environment,
+        id,
         _request_auth,
         _content_type,
         _headers,
@@ -1483,23 +1447,9 @@ class FirewallsApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
+        if id is not None:
+            _path_params['id'] = id
         # process the query parameters
-        if page is not None:
-            
-            _query_params.append(('page', page))
-            
-        if page_size is not None:
-            
-            _query_params.append(('pageSize', page_size))
-            
-        if search is not None:
-            
-            _query_params.append(('search', search))
-            
-        if environment is not None:
-            
-            _query_params.append(('environment', environment))
-            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1521,7 +1471,7 @@ class FirewallsApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/core/firewalls',
+            resource_path='/core/firewalls/{id}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -1538,9 +1488,12 @@ class FirewallsApi:
 
 
     @validate_call
-    def retrieve_the_details_of_an_existing_firewall(
+    def list_existing_firewalls(
         self,
-        id: StrictInt,
+        page: Optional[StrictInt] = None,
+        page_size: Optional[StrictInt] = None,
+        search: Optional[StrictStr] = None,
+        environment: Annotated[Optional[StrictStr], Field(description="Filter Environment ID or Name")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1553,13 +1506,19 @@ class FirewallsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> FirewallDetailResponse:
-        """Retrieve firewall details
+    ) -> FirewallsListResponse:
+        """List firewalls
 
-        Retrieves the details of an existing firewall, including the security rules it contains and information about the virtual machines to which it is attached.
+        Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Infrahub, [**click here**](https://docs...cloud/docs/network-security/security-groups).
 
-        :param id: (required)
-        :type id: int
+        :param page:
+        :type page: int
+        :param page_size:
+        :type page_size: int
+        :param search:
+        :type search: str
+        :param environment: Filter Environment ID or Name
+        :type environment: 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
@@ -1582,8 +1541,11 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_the_details_of_an_existing_firewall_serialize(
-            id=id,
+        _param = self._list_existing_firewalls_serialize(
+            page=page,
+            page_size=page_size,
+            search=search,
+            environment=environment,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1591,11 +1553,10 @@ class FirewallsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FirewallDetailResponse",
+            '200': "FirewallsListResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1610,9 +1571,12 @@ class FirewallsApi:
 
 
     @validate_call
-    def retrieve_the_details_of_an_existing_firewall_with_http_info(
+    def list_existing_firewalls_with_http_info(
         self,
-        id: StrictInt,
+        page: Optional[StrictInt] = None,
+        page_size: Optional[StrictInt] = None,
+        search: Optional[StrictStr] = None,
+        environment: Annotated[Optional[StrictStr], Field(description="Filter Environment ID or Name")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1625,13 +1589,19 @@ class FirewallsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[FirewallDetailResponse]:
-        """Retrieve firewall details
+    ) -> ApiResponse[FirewallsListResponse]:
+        """List firewalls
 
-        Retrieves the details of an existing firewall, including the security rules it contains and information about the virtual machines to which it is attached.
+        Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Infrahub, [**click here**](https://docs...cloud/docs/network-security/security-groups).
 
-        :param id: (required)
-        :type id: int
+        :param page:
+        :type page: int
+        :param page_size:
+        :type page_size: int
+        :param search:
+        :type search: str
+        :param environment: Filter Environment ID or Name
+        :type environment: 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
@@ -1654,8 +1624,11 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_the_details_of_an_existing_firewall_serialize(
-            id=id,
+        _param = self._list_existing_firewalls_serialize(
+            page=page,
+            page_size=page_size,
+            search=search,
+            environment=environment,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1663,11 +1636,10 @@ class FirewallsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FirewallDetailResponse",
+            '200': "FirewallsListResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1682,9 +1654,12 @@ class FirewallsApi:
 
 
     @validate_call
-    def retrieve_the_details_of_an_existing_firewall_without_preload_content(
+    def list_existing_firewalls_without_preload_content(
         self,
-        id: StrictInt,
+        page: Optional[StrictInt] = None,
+        page_size: Optional[StrictInt] = None,
+        search: Optional[StrictStr] = None,
+        environment: Annotated[Optional[StrictStr], Field(description="Filter Environment ID or Name")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1698,12 +1673,18 @@ class FirewallsApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Retrieve firewall details
+        """List firewalls
 
-        Retrieves the details of an existing firewall, including the security rules it contains and information about the virtual machines to which it is attached.
+        Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Infrahub, [**click here**](https://docs...cloud/docs/network-security/security-groups).
 
-        :param id: (required)
-        :type id: int
+        :param page:
+        :type page: int
+        :param page_size:
+        :type page_size: int
+        :param search:
+        :type search: str
+        :param environment: Filter Environment ID or Name
+        :type environment: 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
@@ -1726,8 +1707,11 @@ class FirewallsApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_the_details_of_an_existing_firewall_serialize(
-            id=id,
+        _param = self._list_existing_firewalls_serialize(
+            page=page,
+            page_size=page_size,
+            search=search,
+            environment=environment,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1735,11 +1719,10 @@ class FirewallsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FirewallDetailResponse",
+            '200': "FirewallsListResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1749,9 +1732,12 @@ class FirewallsApi:
         return response_data.response
 
 
-    def _retrieve_the_details_of_an_existing_firewall_serialize(
+    def _list_existing_firewalls_serialize(
         self,
-        id,
+        page,
+        page_size,
+        search,
+        environment,
         _request_auth,
         _content_type,
         _headers,
@@ -1773,9 +1759,23 @@ class FirewallsApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if id is not None:
-            _path_params['id'] = id
         # process the query parameters
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if page_size is not None:
+            
+            _query_params.append(('pageSize', page_size))
+            
+        if search is not None:
+            
+            _query_params.append(('search', search))
+            
+        if environment is not None:
+            
+            _query_params.append(('environment', environment))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1797,7 +1797,7 @@ class FirewallsApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/core/firewalls/{id}',
+            resource_path='/core/firewalls',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,