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

hyperstack/api/invite_api.py

@@ -40,6 +40,279 @@ class InviteApi:
         self.api_client = api_client
 
 
+    @validate_call
+    def accept_invite(
+        self,
+        id: StrictInt,
+        _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,
+    ) -> CommonResponseModel:
+        """Accept Invite
+
+        Accept an invitation for a user to join your organization.
+
+        :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
+                                 (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._accept_invite_serialize(
+            id=id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CommonResponseModel",
+            '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 accept_invite_with_http_info(
+        self,
+        id: StrictInt,
+        _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[CommonResponseModel]:
+        """Accept Invite
+
+        Accept an invitation for a user to join your organization.
+
+        :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
+                                 (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._accept_invite_serialize(
+            id=id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CommonResponseModel",
+            '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 accept_invite_without_preload_content(
+        self,
+        id: StrictInt,
+        _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:
+        """Accept Invite
+
+        Accept an invitation for a user to join your organization.
+
+        :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
+                                 (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._accept_invite_serialize(
+            id=id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CommonResponseModel",
+            '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 _accept_invite_serialize(
+        self,
+        id,
+        _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 id is not None:
+            _path_params['id'] = id
+        # 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='/auth/invites/{id}/accept',
+            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 delete_invite(
         self,
@@ -57,9 +330,9 @@ class InviteApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> CommonResponseModel:
-        """Delete Invite
+        """Accept Invite
 
-        Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/delete-invite).
+        Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, [click here](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/delete-invite).
 
         :param id: (required)
         :type id: int
@@ -128,9 +401,9 @@ class InviteApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[CommonResponseModel]:
-        """Delete Invite
+        """Accept Invite
 
-        Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/delete-invite).
+        Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, [click here](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/delete-invite).
 
         :param id: (required)
         :type id: int
@@ -199,9 +472,9 @@ class InviteApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Delete Invite
+        """Accept Invite
 
-        Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/delete-invite).
+        Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, [click here](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/delete-invite).
 
         :param id: (required)
         :type id: int
@@ -292,8 +565,7 @@ class InviteApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -333,7 +605,7 @@ class InviteApi:
     ) -> InviteUserResponseModel:
         """Invite User to Organization
 
-        Invites a user to join your organization. For additional information on inviting users to the organization, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/invite-member).
+        Invites a user to join your organization. For additional information on inviting users to the organization, [click here](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/invite-member).
 
         :param payload: (required)
         :type payload: InviteUserPayload
@@ -404,7 +676,7 @@ class InviteApi:
     ) -> ApiResponse[InviteUserResponseModel]:
         """Invite User to Organization
 
-        Invites a user to join your organization. For additional information on inviting users to the organization, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/invite-member).
+        Invites a user to join your organization. For additional information on inviting users to the organization, [click here](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/invite-member).
 
         :param payload: (required)
         :type payload: InviteUserPayload
@@ -475,7 +747,7 @@ class InviteApi:
     ) -> RESTResponseType:
         """Invite User to Organization
 
-        Invites a user to join your organization. For additional information on inviting users to the organization, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/invite-member).
+        Invites a user to join your organization. For additional information on inviting users to the organization, [click here](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/invite-member).
 
         :param payload: (required)
         :type payload: InviteUserPayload
@@ -579,8 +851,7 @@ class InviteApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -619,7 +890,7 @@ class InviteApi:
     ) -> GetInvitesResponseModel:
         """List Invites
 
-        Retrieve a list of email invitations from your organization. For additional information on listing invited users, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/list-invites).
+        Retrieve a list of email invitations from your organization. For additional information on listing invited users, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/list-invites).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -685,7 +956,7 @@ class InviteApi:
     ) -> ApiResponse[GetInvitesResponseModel]:
         """List Invites
 
-        Retrieve a list of email invitations from your organization. For additional information on listing invited users, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/list-invites).
+        Retrieve a list of email invitations from your organization. For additional information on listing invited users, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/list-invites).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -751,7 +1022,7 @@ class InviteApi:
     ) -> RESTResponseType:
         """List Invites
 
-        Retrieve a list of email invitations from your organization. For additional information on listing invited users, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/organization/invites/list-invites).
+        Retrieve a list of email invitations from your organization. For additional information on listing invited users, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/organization/invites/list-invites).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -835,8 +1106,7 @@ class InviteApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(

hyperstack/api/keypair_api.py

@@ -24,7 +24,7 @@ from ..models.import_keypair_response import ImportKeypairResponse
 from ..models.keypairs import Keypairs
 from ..models.response_model import ResponseModel
 from ..models.update_keypair_name import UpdateKeypairName
-from ..models.update_keypairnameresponse import UpdateKeypairnameresponse
+from ..models.update_keypair_name_response import UpdateKeypairNameResponse
 
 from ..api_client import ApiClient, RequestSerialized
 from ..api_response import ApiResponse
@@ -63,7 +63,7 @@ class KeypairApi:
     ) -> ResponseModel:
         """Delete key pair
 
-        Permanently deletes a specified key pair. Include the key pair ID in the request path to remove the designated key pair.
+        Permanently deletes a specified key pair. Provide the key pair ID in the path to remove the designated key pair.
 
         :param id: (required)
         :type id: int
@@ -134,7 +134,7 @@ class KeypairApi:
     ) -> ApiResponse[ResponseModel]:
         """Delete key pair
 
-        Permanently deletes a specified key pair. Include the key pair ID in the request path to remove the designated key pair.
+        Permanently deletes a specified key pair. Provide the key pair ID in the path to remove the designated key pair.
 
         :param id: (required)
         :type id: int
@@ -205,7 +205,7 @@ class KeypairApi:
     ) -> RESTResponseType:
         """Delete key pair
 
-        Permanently deletes a specified key pair. Include the key pair ID in the request path to remove the designated key pair.
+        Permanently deletes a specified key pair. Provide the key pair ID in the path to remove the designated key pair.
 
         :param id: (required)
         :type id: int
@@ -296,8 +296,7 @@ class KeypairApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -337,7 +336,7 @@ class KeypairApi:
     ) -> ImportKeypairResponse:
         """Import key pair
 
-        Imports a new key pair for secure shell (SSH) access to your resources. To import a new key pair, include the key name, environment name, and public key in the request body. For additional information on importing SSH key pairs, [**click here**](https://infrahub-doc.nexgencloud.com/docs/getting-started/create-keypair#importing-an-ssh-key).
+        Imports a new key pair for secure shell (SSH) access to your resources. Provide the key name, environment name, and public key in the request body. For more details on importing SSH key pairs, [**click here**](https://docs...cloud/docs/api-reference/core-resources/keypairs/import-keypair).
 
         :param payload: (required)
         :type payload: ImportKeypairPayload
@@ -409,7 +408,7 @@ class KeypairApi:
     ) -> ApiResponse[ImportKeypairResponse]:
         """Import key pair
 
-        Imports a new key pair for secure shell (SSH) access to your resources. To import a new key pair, include the key name, environment name, and public key in the request body. For additional information on importing SSH key pairs, [**click here**](https://infrahub-doc.nexgencloud.com/docs/getting-started/create-keypair#importing-an-ssh-key).
+        Imports a new key pair for secure shell (SSH) access to your resources. Provide the key name, environment name, and public key in the request body. For more details on importing SSH key pairs, [**click here**](https://docs...cloud/docs/api-reference/core-resources/keypairs/import-keypair).
 
         :param payload: (required)
         :type payload: ImportKeypairPayload
@@ -481,7 +480,7 @@ class KeypairApi:
     ) -> RESTResponseType:
         """Import key pair
 
-        Imports a new key pair for secure shell (SSH) access to your resources. To import a new key pair, include the key name, environment name, and public key in the request body. For additional information on importing SSH key pairs, [**click here**](https://infrahub-doc.nexgencloud.com/docs/getting-started/create-keypair#importing-an-ssh-key).
+        Imports a new key pair for secure shell (SSH) access to your resources. Provide the key name, environment name, and public key in the request body. For more details on importing SSH key pairs, [**click here**](https://docs...cloud/docs/api-reference/core-resources/keypairs/import-keypair).
 
         :param payload: (required)
         :type payload: ImportKeypairPayload
@@ -586,8 +585,7 @@ class KeypairApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -629,7 +627,7 @@ class KeypairApi:
     ) -> Keypairs:
         """List key pairs
 
-        Retrieves a list of your existing SSH key pairs, providing details for each. For additional information on SSH key pairs, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/keypairs-available-features).
+        Retrieves a list of your existing SSH key pairs, providing details for each. For more information on SSH key pairs, [**click here**](https://docs...cloud/docs/api-reference/core-resources/keypairs/).
 
         :param page: Page Number
         :type page: str
@@ -707,7 +705,7 @@ class KeypairApi:
     ) -> ApiResponse[Keypairs]:
         """List key pairs
 
-        Retrieves a list of your existing SSH key pairs, providing details for each. For additional information on SSH key pairs, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/keypairs-available-features).
+        Retrieves a list of your existing SSH key pairs, providing details for each. For more information on SSH key pairs, [**click here**](https://docs...cloud/docs/api-reference/core-resources/keypairs/).
 
         :param page: Page Number
         :type page: str
@@ -785,7 +783,7 @@ class KeypairApi:
     ) -> RESTResponseType:
         """List key pairs
 
-        Retrieves a list of your existing SSH key pairs, providing details for each. For additional information on SSH key pairs, [**click here**](https://infrahub-doc.nexgencloud.com/docs/features/keypairs-available-features).
+        Retrieves a list of your existing SSH key pairs, providing details for each. For more information on SSH key pairs, [**click here**](https://docs...cloud/docs/api-reference/core-resources/keypairs/).
 
         :param page: Page Number
         :type page: str
@@ -893,8 +891,7 @@ class KeypairApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -932,10 +929,10 @@ class KeypairApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> UpdateKeypairnameresponse:
+    ) -> UpdateKeypairNameResponse:
         """Update key pair name
 
-        Updates the name of a specified key pair. Include the key pair ID in the request path and the new `name` of the key pair in the request body.
+        Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body.
 
         :param id: (required)
         :type id: int
@@ -973,7 +970,7 @@ class KeypairApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "UpdateKeypairnameresponse",
+            '200': "UpdateKeypairNameResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -1007,10 +1004,10 @@ class KeypairApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[UpdateKeypairnameresponse]:
+    ) -> ApiResponse[UpdateKeypairNameResponse]:
         """Update key pair name
 
-        Updates the name of a specified key pair. Include the key pair ID in the request path and the new `name` of the key pair in the request body.
+        Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body.
 
         :param id: (required)
         :type id: int
@@ -1048,7 +1045,7 @@ class KeypairApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "UpdateKeypairnameresponse",
+            '200': "UpdateKeypairNameResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -1085,7 +1082,7 @@ class KeypairApi:
     ) -> RESTResponseType:
         """Update key pair name
 
-        Updates the name of a specified key pair. Include the key pair ID in the request path and the new `name` of the key pair in the request body.
+        Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body.
 
         :param id: (required)
         :type id: int
@@ -1123,7 +1120,7 @@ class KeypairApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "UpdateKeypairnameresponse",
+            '200': "UpdateKeypairNameResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '404': "ErrorResponseModel",
@@ -1195,8 +1192,7 @@ class KeypairApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(