hyperstack 1.25.0a0__py3-none-any.whl → 1.41.2a0__py3-none-any.whl

hyperstack/api/alive_api.py

@@ -53,6 +53,7 @@ class AliveApi:
     ) -> None:
         """GET: Alive
 
+        Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](None/docs/api-reference/billing-resources/alive/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -115,6 +116,7 @@ class AliveApi:
     ) -> ApiResponse[None]:
         """GET: Alive
 
+        Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](None/docs/api-reference/billing-resources/alive/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -177,6 +179,7 @@ class AliveApi:
     ) -> RESTResponseType:
         """GET: Alive
 
+        Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](None/docs/api-reference/billing-resources/alive/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -250,6 +253,7 @@ class AliveApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -268,3 +272,239 @@ class AliveApi:
         )
 
 
+
+
+    @validate_call
+    def get_doc(
+        self,
+        _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,
+    ) -> None:
+        """get_doc
+
+
+        :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._get_doc_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': 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 get_doc_with_http_info(
+        self,
+        _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[None]:
+        """get_doc
+
+
+        :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._get_doc_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': 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 get_doc_without_preload_content(
+        self,
+        _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:
+        """get_doc
+
+
+        :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._get_doc_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_doc_serialize(
+        self,
+        _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
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'apiKey'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/billing/alive/doc',
+            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
+        )
+
+

hyperstack/api/api_key_api.py

@@ -292,8 +292,7 @@ class ApiKeyApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -333,7 +332,7 @@ class ApiKeyApi:
     ) -> GenerateUpdateApiKeyResponseModel:
         """Generate API Key
 
-        Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/generate-api-key).
+        Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/api-key/generate-api-key).
 
         :param payload: (required)
         :type payload: GenerateUpdateApiKeyPayload
@@ -405,7 +404,7 @@ class ApiKeyApi:
     ) -> ApiResponse[GenerateUpdateApiKeyResponseModel]:
         """Generate API Key
 
-        Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/generate-api-key).
+        Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/api-key/generate-api-key).
 
         :param payload: (required)
         :type payload: GenerateUpdateApiKeyPayload
@@ -477,7 +476,7 @@ class ApiKeyApi:
     ) -> RESTResponseType:
         """Generate API Key
 
-        Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/generate-api-key).
+        Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/api-key/generate-api-key).
 
         :param payload: (required)
         :type payload: GenerateUpdateApiKeyPayload
@@ -582,7 +581,6 @@ class ApiKeyApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'accessToken'
         ]
 
         return self.api_client.param_serialize(
@@ -604,7 +602,7 @@ class ApiKeyApi:
 
 
     @validate_call
-    def retrieve_api_keys(
+    def retrieve_api_key(
         self,
         _request_timeout: Union[
             None,
@@ -621,7 +619,7 @@ class ApiKeyApi:
     ) -> GetApiKeysResponseModel:
         """Retrieve API Keys
 
-        Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/retrieve-api-key).
+        Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/api-key/retrieve-api-key).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -645,7 +643,7 @@ class ApiKeyApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_api_keys_serialize(
+        _param = self._retrieve_api_key_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -670,7 +668,7 @@ class ApiKeyApi:
 
 
     @validate_call
-    def retrieve_api_keys_with_http_info(
+    def retrieve_api_key_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -687,7 +685,7 @@ class ApiKeyApi:
     ) -> ApiResponse[GetApiKeysResponseModel]:
         """Retrieve API Keys
 
-        Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/retrieve-api-key).
+        Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/api-key/retrieve-api-key).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -711,7 +709,7 @@ class ApiKeyApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_api_keys_serialize(
+        _param = self._retrieve_api_key_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -736,7 +734,7 @@ class ApiKeyApi:
 
 
     @validate_call
-    def retrieve_api_keys_without_preload_content(
+    def retrieve_api_key_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -753,7 +751,7 @@ class ApiKeyApi:
     ) -> RESTResponseType:
         """Retrieve API Keys
 
-        Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/retrieve-api-key).
+        Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/api-key/retrieve-api-key).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -777,7 +775,7 @@ class ApiKeyApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_api_keys_serialize(
+        _param = self._retrieve_api_key_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -797,7 +795,7 @@ class ApiKeyApi:
         return response_data.response
 
 
-    def _retrieve_api_keys_serialize(
+    def _retrieve_api_key_serialize(
         self,
         _request_auth,
         _content_type,
@@ -837,8 +835,7 @@ class ApiKeyApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -1139,8 +1136,7 @@ class ApiKeyApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(

hyperstack/api/assigning_member_role_api.py

@@ -40,7 +40,7 @@ class AssigningMemberRoleApi:
 
 
     @validate_call
-    def assign_rbac_role(
+    def assign_rbac_role_to_user(
         self,
         user_id: StrictInt,
         payload: AssignRbacRolePayload,
@@ -59,7 +59,7 @@ class AssigningMemberRoleApi:
     ) -> RbacRoleDetailResponseModel:
         """Assign RBAC Role
 
-        Assigns a specific RBAC role to a user within your organization, granting them access to the resource actions permitted by the role. Provide the user ID in the path and the role ID in the request body. For additional information, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/rbac/manage-member-roles/assign-rbac-role).
+        Assigns a specific RBAC role to a user within your organization, granting them access to the resource actions permitted by the role. Provide the user ID in the path and the role ID in the request body. For additional information, [click here](https://docs...cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/assign-rbac-role).
 
         :param user_id: (required)
         :type user_id: int
@@ -87,7 +87,7 @@ class AssigningMemberRoleApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._assign_rbac_role_serialize(
+        _param = self._assign_rbac_role_to_user_serialize(
             user_id=user_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -115,7 +115,7 @@ class AssigningMemberRoleApi:
 
 
     @validate_call
-    def assign_rbac_role_with_http_info(
+    def assign_rbac_role_to_user_with_http_info(
         self,
         user_id: StrictInt,
         payload: AssignRbacRolePayload,
@@ -134,7 +134,7 @@ class AssigningMemberRoleApi:
     ) -> ApiResponse[RbacRoleDetailResponseModel]:
         """Assign RBAC Role
 
-        Assigns a specific RBAC role to a user within your organization, granting them access to the resource actions permitted by the role. Provide the user ID in the path and the role ID in the request body. For additional information, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/rbac/manage-member-roles/assign-rbac-role).
+        Assigns a specific RBAC role to a user within your organization, granting them access to the resource actions permitted by the role. Provide the user ID in the path and the role ID in the request body. For additional information, [click here](https://docs...cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/assign-rbac-role).
 
         :param user_id: (required)
         :type user_id: int
@@ -162,7 +162,7 @@ class AssigningMemberRoleApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._assign_rbac_role_serialize(
+        _param = self._assign_rbac_role_to_user_serialize(
             user_id=user_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -190,7 +190,7 @@ class AssigningMemberRoleApi:
 
 
     @validate_call
-    def assign_rbac_role_without_preload_content(
+    def assign_rbac_role_to_user_without_preload_content(
         self,
         user_id: StrictInt,
         payload: AssignRbacRolePayload,
@@ -209,7 +209,7 @@ class AssigningMemberRoleApi:
     ) -> RESTResponseType:
         """Assign RBAC Role
 
-        Assigns a specific RBAC role to a user within your organization, granting them access to the resource actions permitted by the role. Provide the user ID in the path and the role ID in the request body. For additional information, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/rbac/manage-member-roles/assign-rbac-role).
+        Assigns a specific RBAC role to a user within your organization, granting them access to the resource actions permitted by the role. Provide the user ID in the path and the role ID in the request body. For additional information, [click here](https://docs...cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/assign-rbac-role).
 
         :param user_id: (required)
         :type user_id: int
@@ -237,7 +237,7 @@ class AssigningMemberRoleApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._assign_rbac_role_serialize(
+        _param = self._assign_rbac_role_to_user_serialize(
             user_id=user_id,
             payload=payload,
             _request_auth=_request_auth,
@@ -260,7 +260,7 @@ class AssigningMemberRoleApi:
         return response_data.response
 
 
-    def _assign_rbac_role_serialize(
+    def _assign_rbac_role_to_user_serialize(
         self,
         user_id,
         payload,
@@ -319,8 +319,7 @@ class AssigningMemberRoleApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -360,7 +359,7 @@ class AssigningMemberRoleApi:
     ) -> CommonResponseModel:
         """Remove RBAC Role From User
 
-        Removes an RBAC role from a user within your organization, revoking the resource permissions they had access to. Provide the user ID in the path. For additional information, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/rbac/manage-member-roles/revoke-rbac-role).
+        Removes an RBAC role from a user within your organization, revoking the resource permissions they had access to. Provide the user ID in the path. For additional information, [click here](https://docs...cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/revoke-rbac-role).
 
         :param user_id: (required)
         :type user_id: int
@@ -431,7 +430,7 @@ class AssigningMemberRoleApi:
     ) -> ApiResponse[CommonResponseModel]:
         """Remove RBAC Role From User
 
-        Removes an RBAC role from a user within your organization, revoking the resource permissions they had access to. Provide the user ID in the path. For additional information, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/rbac/manage-member-roles/revoke-rbac-role).
+        Removes an RBAC role from a user within your organization, revoking the resource permissions they had access to. Provide the user ID in the path. For additional information, [click here](https://docs...cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/revoke-rbac-role).
 
         :param user_id: (required)
         :type user_id: int
@@ -502,7 +501,7 @@ class AssigningMemberRoleApi:
     ) -> RESTResponseType:
         """Remove RBAC Role From User
 
-        Removes an RBAC role from a user within your organization, revoking the resource permissions they had access to. Provide the user ID in the path. For additional information, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/rbac/manage-member-roles/revoke-rbac-role).
+        Removes an RBAC role from a user within your organization, revoking the resource permissions they had access to. Provide the user ID in the path. For additional information, [click here](https://docs...cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/revoke-rbac-role).
 
         :param user_id: (required)
         :type user_id: int
@@ -593,8 +592,7 @@ class AssigningMemberRoleApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(