Merge pull request #112 from CyberSource/release-march24

March Release 24

CyberSource/api/billing_agreements_api.py

@@ -47,8 +47,8 @@ def __init__(self, merchant_config, api_client=None):
 
     def billing_agreements_de_registration(self, modify_billing_agreement, id, **kwargs):
         """
-        Standing Instruction Cancellation or Modification
-        Standing Instruction with or without Token
+        Modify a Billing Agreement
+        #### Standing Instruction: Standing Instruction with or without Token.  #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer:   - Requests that you revoke the mandate.   - Closes their account with you. Possible revoke mandate status values -   - Revoked—the revoke mandate request was successfully processed.   - Failed—the revoke mandate request was not accepted.  #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first  #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values:   - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID.   - Pending—a pending mandate means the mandate is not yet signed.   - Failed—the customer did not authenticate.   - Expired—the deadline to create the mandate passed.   - Revoked—the mandate is cancelled.  #### Paypal Billing Agreement:  A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment.  You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes. 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function
         to be invoked when receiving the response.
@@ -61,7 +61,7 @@ def billing_agreements_de_registration(self, modify_billing_agreement, id, **kwa
             for asynchronous request. (optional)
         :param ModifyBillingAgreement modify_billing_agreement: (required)
         :param str id: ID for de-registration or cancellation of Billing Agreement (required)
-        :return: PtsV2CreditsPost201Response1
+        :return: PtsV2ModifyBillingAgreementPost201Response
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -78,8 +78,8 @@ def billing_agreements_de_registration(self, modify_billing_agreement, id, **kwa
 
     def billing_agreements_de_registration_with_http_info(self, modify_billing_agreement, id, **kwargs):
         """
-        Standing Instruction Cancellation or Modification
-        Standing Instruction with or without Token
+        Modify a Billing Agreement
+        #### Standing Instruction: Standing Instruction with or without Token.  #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer:   - Requests that you revoke the mandate.   - Closes their account with you. Possible revoke mandate status values -   - Revoked—the revoke mandate request was successfully processed.   - Failed—the revoke mandate request was not accepted.  #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first  #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values:   - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID.   - Pending—a pending mandate means the mandate is not yet signed.   - Failed—the customer did not authenticate.   - Expired—the deadline to create the mandate passed.   - Revoked—the mandate is cancelled.  #### Paypal Billing Agreement:  A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment.  You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes. 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function
         to be invoked when receiving the response.
@@ -92,7 +92,7 @@ def billing_agreements_de_registration_with_http_info(self, modify_billing_agree
             for asynchronous request. (optional)
         :param ModifyBillingAgreement modify_billing_agreement: (required)
         :param str id: ID for de-registration or cancellation of Billing Agreement (required)
-        :return: PtsV2CreditsPost201Response1
+        :return: PtsV2ModifyBillingAgreementPost201Response
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -160,7 +160,7 @@ def billing_agreements_de_registration_with_http_info(self, modify_billing_agree
                                         body=body_params,
                                         post_params=form_params,
                                         files=local_var_files,
-                                        response_type='PtsV2CreditsPost201Response1',
+                                        response_type='PtsV2ModifyBillingAgreementPost201Response',
                                         auth_settings=auth_settings,
                                         callback=params.get('callback'),
                                         _return_http_data_only=params.get('_return_http_data_only'),
@@ -293,8 +293,8 @@ def billing_agreements_intimation_with_http_info(self, intimate_billing_agreemen
 
     def billing_agreements_registration(self, create_billing_agreement, **kwargs):
         """
-        Standing Instruction completion registration
-        Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed
+        Create a Billing Agreement
+        #### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed  #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values:   - Pending—the create mandate request was successfully processed.   - Failed—the create mandate request was not accepted.  #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when:   - You have existing customers with signed, active mandates   - You manage mandates outside of CyberSource.  When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed. 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function
         to be invoked when receiving the response.
@@ -306,7 +306,7 @@ def billing_agreements_registration(self, create_billing_agreement, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param CreateBillingAgreement create_billing_agreement: (required)
-        :return: PtsV2CreditsPost201Response1
+        :return: PtsV2CreateBillingAgreementPost201Response
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -323,8 +323,8 @@ def billing_agreements_registration(self, create_billing_agreement, **kwargs):
 
     def billing_agreements_registration_with_http_info(self, create_billing_agreement, **kwargs):
         """
-        Standing Instruction completion registration
-        Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed
+        Create a Billing Agreement
+        #### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed  #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values:   - Pending—the create mandate request was successfully processed.   - Failed—the create mandate request was not accepted.  #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when:   - You have existing customers with signed, active mandates   - You manage mandates outside of CyberSource.  When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed. 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function
         to be invoked when receiving the response.
@@ -336,7 +336,7 @@ def billing_agreements_registration_with_http_info(self, create_billing_agreemen
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param CreateBillingAgreement create_billing_agreement: (required)
-        :return: PtsV2CreditsPost201Response1
+        :return: PtsV2CreateBillingAgreementPost201Response
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -396,7 +396,7 @@ def billing_agreements_registration_with_http_info(self, create_billing_agreemen
                                         body=body_params,
                                         post_params=form_params,
                                         files=local_var_files,
-                                        response_type='PtsV2CreditsPost201Response1',
+                                        response_type='PtsV2CreateBillingAgreementPost201Response',
                                         auth_settings=auth_settings,
                                         callback=params.get('callback'),
                                         _return_http_data_only=params.get('_return_http_data_only'),