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

hyperstack/api/payment_api.py

@@ -40,8 +40,9 @@ class PaymentApi:
 
 
     @validate_call
-    def get_details(
+    def get_payment_receipt(
         self,
+        payment_id: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -54,11 +55,13 @@ class PaymentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> PaymentDetailsResponse:
-        """GET: View payment details
+    ) -> None:
+        """Retrieve Payment Receipt
 
-        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/).
+        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
@@ -81,7 +84,8 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_details_serialize(
+        _param = self._get_payment_receipt_serialize(
+            payment_id=payment_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -89,7 +93,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "PaymentDetailsResponse",
+            '200': None,
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -108,8 +112,9 @@ class PaymentApi:
 
 
     @validate_call
-    def get_details_with_http_info(
+    def get_payment_receipt_with_http_info(
         self,
+        payment_id: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -122,11 +127,13 @@ class PaymentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[PaymentDetailsResponse]:
-        """GET: View payment details
+    ) -> ApiResponse[None]:
+        """Retrieve Payment Receipt
 
-        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/).
+        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
@@ -149,7 +156,8 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_details_serialize(
+        _param = self._get_payment_receipt_serialize(
+            payment_id=payment_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -157,7 +165,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "PaymentDetailsResponse",
+            '200': None,
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -176,8 +184,9 @@ class PaymentApi:
 
 
     @validate_call
-    def get_details_without_preload_content(
+    def get_payment_receipt_without_preload_content(
         self,
+        payment_id: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -191,10 +200,12 @@ class PaymentApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """GET: View payment details
+        """Retrieve Payment Receipt
 
-        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/).
+        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
@@ -217,7 +228,8 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_details_serialize(
+        _param = self._get_payment_receipt_serialize(
+            payment_id=payment_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -225,7 +237,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "PaymentDetailsResponse",
+            '200': None,
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -239,8 +251,9 @@ class PaymentApi:
         return response_data.response
 
 
-    def _get_details_serialize(
+    def _get_payment_receipt_serialize(
         self,
+        payment_id,
         _request_auth,
         _content_type,
         _headers,
@@ -262,6 +275,8 @@ class PaymentApi:
         _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
@@ -284,7 +299,7 @@ class PaymentApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/billing/payment/payment-details',
+            resource_path='/billing/payment/receipt/{payment_id}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -301,9 +316,9 @@ class PaymentApi:
 
 
     @validate_call
-    def get_payment_receipt2(
+    def initiate_payment(
         self,
-        payment_id: StrictStr,
+        payload: PaymentInitiatePayload,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -316,13 +331,13 @@ class PaymentApi:
         _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
+    ) -> PaymentInitiateResponse:
+        """POST: Initiate payment
 
-        Retrieve the payment receipt from Stripe for a specific 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 payment_id: (required)
-        :type payment_id: str
+        :param payload: (required)
+        :type payload: PaymentInitiatePayload
         :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
@@ -345,8 +360,8 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_payment_receipt2_serialize(
-            payment_id=payment_id,
+        _param = self._initiate_payment_serialize(
+            payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -354,7 +369,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "PaymentInitiateResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -373,9 +388,9 @@ class PaymentApi:
 
 
     @validate_call
-    def get_payment_receipt2_with_http_info(
+    def initiate_payment_with_http_info(
         self,
-        payment_id: StrictStr,
+        payload: PaymentInitiatePayload,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -388,13 +403,13 @@ class PaymentApi:
         _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
+    ) -> ApiResponse[PaymentInitiateResponse]:
+        """POST: Initiate payment
 
-        Retrieve the payment receipt from Stripe for a specific 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 payment_id: (required)
-        :type payment_id: str
+        :param payload: (required)
+        :type payload: PaymentInitiatePayload
         :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
@@ -417,8 +432,8 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_payment_receipt2_serialize(
-            payment_id=payment_id,
+        _param = self._initiate_payment_serialize(
+            payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -426,7 +441,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "PaymentInitiateResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -445,9 +460,9 @@ class PaymentApi:
 
 
     @validate_call
-    def get_payment_receipt2_without_preload_content(
+    def initiate_payment_without_preload_content(
         self,
-        payment_id: StrictStr,
+        payload: PaymentInitiatePayload,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -461,12 +476,12 @@ class PaymentApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Retrieve Payment Receipt
+        """POST: Initiate payment
 
-        Retrieve the payment receipt from Stripe for a specific 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 payment_id: (required)
-        :type payment_id: str
+        :param payload: (required)
+        :type payload: PaymentInitiatePayload
         :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
@@ -489,8 +504,8 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get_payment_receipt2_serialize(
-            payment_id=payment_id,
+        _param = self._initiate_payment_serialize(
+            payload=payload,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -498,7 +513,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "PaymentInitiateResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -512,9 +527,9 @@ class PaymentApi:
         return response_data.response
 
 
-    def _get_payment_receipt2_serialize(
+    def _initiate_payment_serialize(
         self,
-        payment_id,
+        payload,
         _request_auth,
         _content_type,
         _headers,
@@ -536,12 +551,12 @@ class PaymentApi:
         _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
+        if payload is not None:
+            _body_params = payload
 
 
         # set the HTTP header `Accept`
@@ -552,6 +567,19 @@ class PaymentApi:
                 ]
             )
 
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
 
         # authentication setting
         _auth_settings: List[str] = [
@@ -559,8 +587,8 @@ class PaymentApi:
         ]
 
         return self.api_client.param_serialize(
-            method='GET',
-            resource_path='/billing/payment/receipt/{payment_id}',
+            method='POST',
+            resource_path='/billing/payment/payment-initiate',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -577,9 +605,8 @@ class PaymentApi:
 
 
     @validate_call
-    def post_payment(
+    def list_payment_details(
         self,
-        payload: PaymentInitiatePayload,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -592,13 +619,11 @@ class PaymentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> PaymentInitiateResponse:
-        """POST: Initiate payment
+    ) -> PaymentDetailsResponse:
+        """GET: View payment details
 
-        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).
+        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 payload: (required)
-        :type payload: PaymentInitiatePayload
         :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
@@ -621,8 +646,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._post_payment_serialize(
-            payload=payload,
+        _param = self._list_payment_details_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -630,7 +654,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "PaymentInitiateResponse",
+            '200': "PaymentDetailsResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -649,9 +673,8 @@ class PaymentApi:
 
 
     @validate_call
-    def post_payment_with_http_info(
+    def list_payment_details_with_http_info(
         self,
-        payload: PaymentInitiatePayload,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -664,13 +687,11 @@ class PaymentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[PaymentInitiateResponse]:
-        """POST: Initiate payment
+    ) -> ApiResponse[PaymentDetailsResponse]:
+        """GET: View payment details
 
-        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).
+        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 payload: (required)
-        :type payload: PaymentInitiatePayload
         :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
@@ -693,8 +714,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._post_payment_serialize(
-            payload=payload,
+        _param = self._list_payment_details_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -702,7 +722,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "PaymentInitiateResponse",
+            '200': "PaymentDetailsResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -721,9 +741,8 @@ class PaymentApi:
 
 
     @validate_call
-    def post_payment_without_preload_content(
+    def list_payment_details_without_preload_content(
         self,
-        payload: PaymentInitiatePayload,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -737,12 +756,10 @@ class PaymentApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """POST: Initiate payment
+        """GET: View payment details
 
-        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).
+        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 payload: (required)
-        :type payload: PaymentInitiatePayload
         :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
@@ -765,8 +782,7 @@ class PaymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._post_payment_serialize(
-            payload=payload,
+        _param = self._list_payment_details_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -774,7 +790,7 @@ class PaymentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "PaymentInitiateResponse",
+            '200': "PaymentDetailsResponse",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
             '403': "ErrorResponseModel",
@@ -788,9 +804,8 @@ class PaymentApi:
         return response_data.response
 
 
-    def _post_payment_serialize(
+    def _list_payment_details_serialize(
         self,
-        payload,
         _request_auth,
         _content_type,
         _headers,
@@ -816,8 +831,6 @@ class PaymentApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if payload is not None:
-            _body_params = payload
 
 
         # set the HTTP header `Accept`
@@ -828,19 +841,6 @@ class PaymentApi:
                 ]
             )
 
-        # set the HTTP header `Content-Type`
-        if _content_type:
-            _header_params['Content-Type'] = _content_type
-        else:
-            _default_content_type = (
-                self.api_client.select_header_content_type(
-                    [
-                        'application/json'
-                    ]
-                )
-            )
-            if _default_content_type is not None:
-                _header_params['Content-Type'] = _default_content_type
 
         # authentication setting
         _auth_settings: List[str] = [
@@ -848,8 +848,8 @@ class PaymentApi:
         ]
 
         return self.api_client.param_serialize(
-            method='POST',
-            resource_path='/billing/payment/payment-initiate',
+            method='GET',
+            resource_path='/billing/payment/payment-details',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,