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

hyperstack/api/payment_api.py

@@ -16,6 +16,7 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
+from pydantic import StrictStr
 from ..models.payment_details_response import PaymentDetailsResponse
 from ..models.payment_initiate_payload import PaymentInitiatePayload
 from ..models.payment_initiate_response import PaymentInitiateResponse
@@ -39,7 +40,7 @@ class PaymentApi:
 
 
     @validate_call
-    def get_view_payment_details(
+    def get_details(
         self,
         _request_timeout: Union[
             None,
@@ -56,6 +57,7 @@ class PaymentApi:
     ) -> PaymentDetailsResponse:
         """GET: View payment details
 
+        Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](None/docs/api-reference/billing-resources/retrieve-payment-history/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -79,7 +81,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_view_payment_details_serialize(
+        _param = self._get_details_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -106,7 +108,7 @@ class PaymentApi:
 
 
     @validate_call
-    def get_view_payment_details_with_http_info(
+    def get_details_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -123,6 +125,7 @@ class PaymentApi:
     ) -> ApiResponse[PaymentDetailsResponse]:
         """GET: View payment details
 
+        Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](None/docs/api-reference/billing-resources/retrieve-payment-history/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -146,7 +149,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_view_payment_details_serialize(
+        _param = self._get_details_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -173,7 +176,7 @@ class PaymentApi:
 
 
     @validate_call
-    def get_view_payment_details_without_preload_content(
+    def get_details_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -190,6 +193,7 @@ class PaymentApi:
     ) -> RESTResponseType:
         """GET: View payment details
 
+        Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](None/docs/api-reference/billing-resources/retrieve-payment-history/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -213,7 +217,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_view_payment_details_serialize(
+        _param = self._get_details_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -235,7 +239,7 @@ class PaymentApi:
         return response_data.response
 
 
-    def _get_view_payment_details_serialize(
+    def _get_details_serialize(
         self,
         _request_auth,
         _content_type,
@@ -275,8 +279,7 @@ class PaymentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -298,7 +301,283 @@ class PaymentApi:
 
 
     @validate_call
-    def post_initiate_payment(
+    def get_payment_receipt2(
+        self,
+        payment_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> None:
+        """Retrieve Payment Receipt
+
+        Retrieve the payment receipt from Stripe for a specific payment
+
+        :param payment_id: (required)
+        :type payment_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_receipt2_serialize(
+            payment_id=payment_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '403': "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 get_payment_receipt2_with_http_info(
+        self,
+        payment_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[None]:
+        """Retrieve Payment Receipt
+
+        Retrieve the payment receipt from Stripe for a specific payment
+
+        :param payment_id: (required)
+        :type payment_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_receipt2_serialize(
+            payment_id=payment_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '403': "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 get_payment_receipt2_without_preload_content(
+        self,
+        payment_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Retrieve Payment Receipt
+
+        Retrieve the payment receipt from Stripe for a specific payment
+
+        :param payment_id: (required)
+        :type payment_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_receipt2_serialize(
+            payment_id=payment_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+            '400': "ErrorResponseModel",
+            '401': "ErrorResponseModel",
+            '403': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
+            '500': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_payment_receipt2_serialize(
+        self,
+        payment_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 payment_id is not None:
+            _path_params['payment_id'] = payment_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='/billing/payment/receipt/{payment_id}',
+            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 post_payment(
         self,
         payload: PaymentInitiatePayload,
         _request_timeout: Union[
@@ -316,6 +595,7 @@ class PaymentApi:
     ) -> PaymentInitiateResponse:
         """POST: Initiate payment
 
+        Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](None/docs/api-reference/billing-resources/create-payment).
 
         :param payload: (required)
         :type payload: PaymentInitiatePayload
@@ -341,7 +621,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._post_initiate_payment_serialize(
+        _param = self._post_payment_serialize(
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -369,7 +649,7 @@ class PaymentApi:
 
 
     @validate_call
-    def post_initiate_payment_with_http_info(
+    def post_payment_with_http_info(
         self,
         payload: PaymentInitiatePayload,
         _request_timeout: Union[
@@ -387,6 +667,7 @@ class PaymentApi:
     ) -> ApiResponse[PaymentInitiateResponse]:
         """POST: Initiate payment
 
+        Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](None/docs/api-reference/billing-resources/create-payment).
 
         :param payload: (required)
         :type payload: PaymentInitiatePayload
@@ -412,7 +693,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._post_initiate_payment_serialize(
+        _param = self._post_payment_serialize(
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -440,7 +721,7 @@ class PaymentApi:
 
 
     @validate_call
-    def post_initiate_payment_without_preload_content(
+    def post_payment_without_preload_content(
         self,
         payload: PaymentInitiatePayload,
         _request_timeout: Union[
@@ -458,6 +739,7 @@ class PaymentApi:
     ) -> RESTResponseType:
         """POST: Initiate payment
 
+        Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](None/docs/api-reference/billing-resources/create-payment).
 
         :param payload: (required)
         :type payload: PaymentInitiatePayload
@@ -483,7 +765,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._post_initiate_payment_serialize(
+        _param = self._post_payment_serialize(
             payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -506,7 +788,7 @@ class PaymentApi:
         return response_data.response
 
 
-    def _post_initiate_payment_serialize(
+    def _post_payment_serialize(
         self,
         payload,
         _request_auth,
@@ -562,8 +844,7 @@ class PaymentApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(

hyperstack/api/permission_api.py

@@ -54,7 +54,7 @@ class PermissionApi:
     ) -> GetPermissionsResponseModel:
         """List Permissions
 
-        Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/permission/permissions).
+        Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, [click here](https://docs...cloud/docs/api-reference/auth-resources/permission/permissions).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -120,7 +120,7 @@ class PermissionApi:
     ) -> ApiResponse[GetPermissionsResponseModel]:
         """List Permissions
 
-        Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/permission/permissions).
+        Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, [click here](https://docs...cloud/docs/api-reference/auth-resources/permission/permissions).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -186,7 +186,7 @@ class PermissionApi:
     ) -> RESTResponseType:
         """List Permissions
 
-        Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/permission/permissions).
+        Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, [click here](https://docs...cloud/docs/api-reference/auth-resources/permission/permissions).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -270,8 +270,7 @@ class PermissionApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(

hyperstack/api/policy_api.py

@@ -54,7 +54,7 @@ class PolicyApi:
     ) -> GetPoliciesResponseModel:
         """List Policies
 
-        Retrieves a list of policies available for addition to RBAC roles. For additional information on policies, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/policies).
+        Retrieves a list of policies available for addition to RBAC roles. For additional information on policies, [click here](https://docs...cloud/docs/api-reference/auth-resources/policies).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -120,7 +120,7 @@ class PolicyApi:
     ) -> ApiResponse[GetPoliciesResponseModel]:
         """List Policies
 
-        Retrieves a list of policies available for addition to RBAC roles. For additional information on policies, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/policies).
+        Retrieves a list of policies available for addition to RBAC roles. For additional information on policies, [click here](https://docs...cloud/docs/api-reference/auth-resources/policies).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -186,7 +186,7 @@ class PolicyApi:
     ) -> RESTResponseType:
         """List Policies
 
-        Retrieves a list of policies available for addition to RBAC roles. For additional information on policies, [click here](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/policies).
+        Retrieves a list of policies available for addition to RBAC roles. For additional information on policies, [click here](https://docs...cloud/docs/api-reference/auth-resources/policies).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -270,8 +270,7 @@ class PolicyApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(

hyperstack/api/pricebook_api.py

@@ -38,7 +38,7 @@ class PricebookApi:
 
 
     @validate_call
-    def retrive_pricebook(
+    def get_pricebook(
         self,
         _request_timeout: Union[
             None,
@@ -53,8 +53,9 @@ class PricebookApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> List[PricebookModel]:
-        """retrive_pricebook
+        """get_pricebook
 
+        Retrieves the Infrahub Pricebook, detailing hourly running costs for all resources offered by Infrahub. For more information on Pricebook [**click here**](None/docs/api-reference/pricebook-resources/pricebook/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -78,7 +79,7 @@ class PricebookApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrive_pricebook_serialize(
+        _param = self._get_pricebook_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -104,7 +105,7 @@ class PricebookApi:
 
 
     @validate_call
-    def retrive_pricebook_with_http_info(
+    def get_pricebook_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -119,8 +120,9 @@ class PricebookApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[List[PricebookModel]]:
-        """retrive_pricebook
+        """get_pricebook
 
+        Retrieves the Infrahub Pricebook, detailing hourly running costs for all resources offered by Infrahub. For more information on Pricebook [**click here**](None/docs/api-reference/pricebook-resources/pricebook/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -144,7 +146,7 @@ class PricebookApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrive_pricebook_serialize(
+        _param = self._get_pricebook_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -170,7 +172,7 @@ class PricebookApi:
 
 
     @validate_call
-    def retrive_pricebook_without_preload_content(
+    def get_pricebook_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -185,8 +187,9 @@ class PricebookApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """retrive_pricebook
+        """get_pricebook
 
+        Retrieves the Infrahub Pricebook, detailing hourly running costs for all resources offered by Infrahub. For more information on Pricebook [**click here**](None/docs/api-reference/pricebook-resources/pricebook/).
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -210,7 +213,7 @@ class PricebookApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrive_pricebook_serialize(
+        _param = self._get_pricebook_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -231,7 +234,7 @@ class PricebookApi:
         return response_data.response
 
 
-    def _retrive_pricebook_serialize(
+    def _get_pricebook_serialize(
         self,
         _request_auth,
         _content_type,
@@ -271,8 +274,7 @@ class PricebookApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'apiKey', 
-            'accessToken'
+            'apiKey'
         ]
 
         return self.api_client.param_serialize(