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

hyperstack/__init__.py

@@ -14,11 +14,12 @@
 """  # noqa: E501
 
 
-__version__ = "v1.45.2-alpha"
+__version__ = "v1.46.1-alpha"
 
 # import apis into sdk package
 from .api.calculate_api import CalculateApi
 from .api.customer_contract_api import CustomerContractApi
+from .api.fip_exclusions_api import FIPExclusionsApi
 from .api.pricebook_api import PricebookApi
 from .api.snapshots_api import SnapshotsApi
 from .api.alive_api import AliveApi

hyperstack/api/__init__.py

@@ -3,6 +3,7 @@
 # import apis into api package
 from .calculate_api import CalculateApi
 from .customer_contract_api import CustomerContractApi
+from .fip_exclusions_api import FIPExclusionsApi
 from .pricebook_api import PricebookApi
 from .snapshots_api import SnapshotsApi
 from .alive_api import AliveApi

hyperstack/api/alive_api.py

@@ -275,7 +275,7 @@ class AliveApi:
 
 
     @validate_call
-    def get_doc(
+    def get_alive_doc(
         self,
         _request_timeout: Union[
             None,
@@ -290,7 +290,7 @@ class AliveApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> None:
-        """get_doc
+        """get_alive_doc
 
 
         :param _request_timeout: timeout setting for this request. If one
@@ -315,7 +315,7 @@ class AliveApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_doc_serialize(
+        _param = self._get_alive_doc_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -337,7 +337,7 @@ class AliveApi:
 
 
     @validate_call
-    def get_doc_with_http_info(
+    def get_alive_doc_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -352,7 +352,7 @@ class AliveApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[None]:
-        """get_doc
+        """get_alive_doc
 
 
         :param _request_timeout: timeout setting for this request. If one
@@ -377,7 +377,7 @@ class AliveApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_doc_serialize(
+        _param = self._get_alive_doc_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -399,7 +399,7 @@ class AliveApi:
 
 
     @validate_call
-    def get_doc_without_preload_content(
+    def get_alive_doc_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -414,7 +414,7 @@ class AliveApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """get_doc
+        """get_alive_doc
 
 
         :param _request_timeout: timeout setting for this request. If one
@@ -439,7 +439,7 @@ class AliveApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_doc_serialize(
+        _param = self._get_alive_doc_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -456,7 +456,7 @@ class AliveApi:
         return response_data.response
 
 
-    def _get_doc_serialize(
+    def _get_alive_doc_serialize(
         self,
         _request_auth,
         _content_type,

hyperstack/api/api_key_api.py

@@ -602,7 +602,7 @@ class ApiKeyApi:
 
 
     @validate_call
-    def retrieve_api_key(
+    def get_api_key(
         self,
         _request_timeout: Union[
             None,
@@ -643,7 +643,7 @@ class ApiKeyApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_api_key_serialize(
+        _param = self._get_api_key_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -668,7 +668,7 @@ class ApiKeyApi:
 
 
     @validate_call
-    def retrieve_api_key_with_http_info(
+    def get_api_key_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -709,7 +709,7 @@ class ApiKeyApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_api_key_serialize(
+        _param = self._get_api_key_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -734,7 +734,7 @@ class ApiKeyApi:
 
 
     @validate_call
-    def retrieve_api_key_without_preload_content(
+    def get_api_key_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -775,7 +775,7 @@ class ApiKeyApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_api_key_serialize(
+        _param = self._get_api_key_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -795,7 +795,7 @@ class ApiKeyApi:
         return response_data.response
 
 
-    def _retrieve_api_key_serialize(
+    def _get_api_key_serialize(
         self,
         _request_auth,
         _content_type,

hyperstack/api/auth_api.py

@@ -570,7 +570,7 @@ class AuthApi:
 
 
     @validate_call
-    def get_user_mfa_status(
+    def get_authenticated_user(
         self,
         _request_timeout: Union[
             None,
@@ -584,10 +584,10 @@ class AuthApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> MFAStatusResponse:
-        """Get MFA status for authenticated user
+    ) -> AuthUserInfoResponseModel:
+        """Retrieve Authenticated User Details
 
-        Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
+        Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -611,7 +611,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_user_mfa_status_serialize(
+        _param = self._get_authenticated_user_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -619,10 +619,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "MFAStatusResponse",
+            '200': "AuthUserInfoResponseModel",
+            '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
-            '500': "ErrorResponseModel",
+            '500': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -636,7 +636,7 @@ class AuthApi:
 
 
     @validate_call
-    def get_user_mfa_status_with_http_info(
+    def get_authenticated_user_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -650,10 +650,10 @@ class AuthApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[MFAStatusResponse]:
-        """Get MFA status for authenticated user
+    ) -> ApiResponse[AuthUserInfoResponseModel]:
+        """Retrieve Authenticated User Details
 
-        Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
+        Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -677,7 +677,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_user_mfa_status_serialize(
+        _param = self._get_authenticated_user_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -685,10 +685,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "MFAStatusResponse",
+            '200': "AuthUserInfoResponseModel",
+            '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
-            '500': "ErrorResponseModel",
+            '500': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -702,7 +702,7 @@ class AuthApi:
 
 
     @validate_call
-    def get_user_mfa_status_without_preload_content(
+    def get_authenticated_user_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -717,9 +717,9 @@ class AuthApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get MFA status for authenticated user
+        """Retrieve Authenticated User Details
 
-        Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
+        Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -743,7 +743,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_user_mfa_status_serialize(
+        _param = self._get_authenticated_user_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -751,10 +751,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "MFAStatusResponse",
+            '200': "AuthUserInfoResponseModel",
+            '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
-            '500': "ErrorResponseModel",
+            '500': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -763,7 +763,7 @@ class AuthApi:
         return response_data.response
 
 
-    def _get_user_mfa_status_serialize(
+    def _get_authenticated_user_serialize(
         self,
         _request_auth,
         _content_type,
@@ -808,7 +808,7 @@ class AuthApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/auth/me/mfa',
+            resource_path='/auth/me',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -825,7 +825,7 @@ class AuthApi:
 
 
     @validate_call
-    def get_user_organizations(
+    def get_user_mfa_status(
         self,
         _request_timeout: Union[
             None,
@@ -839,10 +839,10 @@ class AuthApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> UserOrganizationsResponse:
-        """Get User Organizations
+    ) -> MFAStatusResponse:
+        """Get MFA status for authenticated user
 
-        Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
+        Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -866,7 +866,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_user_organizations_serialize(
+        _param = self._get_user_mfa_status_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -874,11 +874,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "UserOrganizationsResponse",
-            '400': "ErrorResponseModel",
+            '200': "MFAStatusResponse",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
-            '500': None,
+            '500': "ErrorResponseModel",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -892,7 +891,7 @@ class AuthApi:
 
 
     @validate_call
-    def get_user_organizations_with_http_info(
+    def get_user_mfa_status_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -906,10 +905,10 @@ class AuthApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[UserOrganizationsResponse]:
-        """Get User Organizations
+    ) -> ApiResponse[MFAStatusResponse]:
+        """Get MFA status for authenticated user
 
-        Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
+        Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -933,7 +932,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_user_organizations_serialize(
+        _param = self._get_user_mfa_status_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -941,11 +940,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "UserOrganizationsResponse",
-            '400': "ErrorResponseModel",
+            '200': "MFAStatusResponse",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
-            '500': None,
+            '500': "ErrorResponseModel",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -959,7 +957,7 @@ class AuthApi:
 
 
     @validate_call
-    def get_user_organizations_without_preload_content(
+    def get_user_mfa_status_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -974,9 +972,9 @@ class AuthApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get User Organizations
+        """Get MFA status for authenticated user
 
-        Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
+        Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1000,7 +998,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_user_organizations_serialize(
+        _param = self._get_user_mfa_status_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1008,11 +1006,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "UserOrganizationsResponse",
-            '400': "ErrorResponseModel",
+            '200': "MFAStatusResponse",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
-            '500': None,
+            '500': "ErrorResponseModel",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1021,7 +1018,7 @@ class AuthApi:
         return response_data.response
 
 
-    def _get_user_organizations_serialize(
+    def _get_user_mfa_status_serialize(
         self,
         _request_auth,
         _content_type,
@@ -1066,7 +1063,7 @@ class AuthApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/auth/me/organizations',
+            resource_path='/auth/me/mfa',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -1083,7 +1080,7 @@ class AuthApi:
 
 
     @validate_call
-    def retrieve_authenticated_user_details(
+    def get_user_organizations(
         self,
         _request_timeout: Union[
             None,
@@ -1097,10 +1094,10 @@ class AuthApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> AuthUserInfoResponseModel:
-        """Retrieve Authenticated User Details
+    ) -> UserOrganizationsResponse:
+        """Get User Organizations
 
-        Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
+        Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1124,7 +1121,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_authenticated_user_details_serialize(
+        _param = self._get_user_organizations_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1132,9 +1129,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AuthUserInfoResponseModel",
+            '200': "UserOrganizationsResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1149,7 +1147,7 @@ class AuthApi:
 
 
     @validate_call
-    def retrieve_authenticated_user_details_with_http_info(
+    def get_user_organizations_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -1163,10 +1161,10 @@ class AuthApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[AuthUserInfoResponseModel]:
-        """Retrieve Authenticated User Details
+    ) -> ApiResponse[UserOrganizationsResponse]:
+        """Get User Organizations
 
-        Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
+        Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1190,7 +1188,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_authenticated_user_details_serialize(
+        _param = self._get_user_organizations_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1198,9 +1196,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AuthUserInfoResponseModel",
+            '200': "UserOrganizationsResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1215,7 +1214,7 @@ class AuthApi:
 
 
     @validate_call
-    def retrieve_authenticated_user_details_without_preload_content(
+    def get_user_organizations_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -1230,9 +1229,9 @@ class AuthApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Retrieve Authenticated User Details
+        """Get User Organizations
 
-        Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
+        Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1256,7 +1255,7 @@ class AuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_authenticated_user_details_serialize(
+        _param = self._get_user_organizations_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1264,9 +1263,10 @@ class AuthApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AuthUserInfoResponseModel",
+            '200': "UserOrganizationsResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1276,7 +1276,7 @@ class AuthApi:
         return response_data.response
 
 
-    def _retrieve_authenticated_user_details_serialize(
+    def _get_user_organizations_serialize(
         self,
         _request_auth,
         _content_type,
@@ -1321,7 +1321,7 @@ class AuthApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/auth/me',
+            resource_path='/auth/me/organizations',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,