zuora-sdk-js 3.6.0 → 3.7.0

package/docs/PaymentMethodResponseBankTransfer.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**IBAN** | **String** | The International Bank Account Number used to create the SEPA payment method. The value is masked.  | [optional] 
+**IBAN** | **String** | The International Bank Account Number used to create the SEPA payment method. The value is masked. | [optional] 
 **account_number** | **String** | The number of the customer's bank account and it is masked.  | [optional] 
-**bank_code** | **String** | The sort code or number that identifies the bank. This is also known as the sort code.           | [optional] 
+**bank_code** | **String** | The sort code or number that identifies the bank. This is also known as the sort code.          | [optional] 
 **bank_transfer_type** | **String** | The type of the Bank Transfer payment method. For example, `SEPA`.  | [optional] 
 **branch_code** | **String** | The branch code of the bank used for Direct Debit.            | [optional] 
 **business_identification_code** | **String** | The BIC code used for SEPA. The value is masked.         | [optional] 

package/docs/PaymentMethodResponseGooglePay.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **google_bin** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 **google_card_number** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
-**google_card_type** | **String** | This field is only available for Google Pay payment methods.  For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.  | [optional] 
+**google_card_type** | **String** | This field is only available for Google Pay payment methods.   For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. | [optional] 
 **google_expiry_date** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 **google_gateway_token** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 

package/docs/PaymentMethodUpdaterInstanceResponse.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **is_active** | **Boolean** | `true` indicates that this PMU instance is active.  | [optional] 
 **is_default** | **Boolean** | `true` indicates that it is the default PMU instance.  | [optional] 
 **is_test** | **String** | `true` indicates that this PMU instance is for testing.  | [optional] 
-**process_associated_gw_only** | **Boolean** | `true` indicates that only the payment methods for customer accounts that meet either of the following conditions are included in the updates:   - The default payment gateway of the customer account is set to an instance of the same type as `updaterGatewayType`.   - The default payment gateway of the customer account is not configured, but the default payment gateway of the tenant is set to an instance of the same type as `updaterGatewayType`.  `false` indicates that information of all payment methods is submitted.  | [optional] 
-**process_autopay_default_pm_only** | **Boolean** | `true` indicates that only the default payment methods for customer accounts with the AutoPay setting enabled are included in the updates.   `false` indicates that data of all payment methods for all customer accounts is submitted, regardless of whether AutoPay is enabled for the customer account or not.  | [optional] 
+**process_associated_gw_only** | **Boolean** | `true` indicates that only the payment methods for customer accounts that meet either of the following conditions are included in the updates:   - The default payment gateway of the customer account is set to an instance of the same type as `updaterGatewayType`.   - The default payment gateway of the customer account is not configured, but the default payment gateway of the tenant is set to an instance of the same type as `updaterGatewayType`.  `false` indicates that information of all payment methods is submitted. | [optional] 
+**process_autopay_default_pm_only** | **Boolean** | `true` indicates that only the default payment methods for customer accounts with the AutoPay setting enabled are included in the updates.    `false` indicates that data of all payment methods for all customer accounts is submitted, regardless of whether AutoPay is enabled for the customer account or not. | [optional] 
 **process_mastercard** | **Boolean** | `true` indicates that Mastercard data processing is supported.  | [optional] 
 **process_visa** | **Boolean** | `true` indicates that Visa data processing is supported.  | [optional] 
 **updater_gateway_type** | **String** | The payment gateway type of the PMU instance.  | [optional] 

package/docs/PaymentMethodsApi.md

@@ -37,8 +37,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentMethodsApi();
-let payment_method_id = "payment_method_id_example"; // String | ID of a payment method. 
-let profile_number = 56; // Number | Number that identifies a stored credential profile within the payment method. 
+let payment_method_id = "payment_method_id_example"; // String | ID of a payment method.
+let profile_number = 56; // Number | Number that identifies a stored credential profile within the payment method.
 let opts = {
   'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -62,8 +62,8 @@ apiInstance.cancelStoredCredentialProfile(payment_method_id, profile_number, opt
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_id** | **String**| ID of a payment method.  | 
- **profile_number** | **Number**| Number that identifies a stored credential profile within the payment method.  | 
+ **payment_method_id** | **String**| ID of a payment method. | 
+ **profile_number** | **Number**| Number that identifies a stored credential profile within the payment method. | 
  **idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.   | [optional] 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
@@ -93,7 +93,7 @@ Name | Type | Description  | Notes
 
 Create a payment method
 
-You can use this operation to create either a payment method associated with a specific customer account, or an orphan payment method that is not associated with any customer account. The orphan payment method must be associated with a customer account within 10 days. Otherwise, it will be deleted.  This operation supports the payment methods listed below.          ### Credit Card The following request body fields are applicable to this payment method: * `cardHolderInfo` (`cardHolderName` required) * `cardNumber` (required) * `cardType` (required) * `expirationMonth` (required) * `expirationYear` (required) * `cardMaskNumber` * `mitConsentAgreementRef` * `mitConsentAgreementSrc` * `mitNetworkTransactionId` * `mitProfileAction` * `mitProfileType` * `mitProfileAgreedOn` * `securityCode` * `checkDuplicated` * `mandateInfo` * `identityNumber`  ### Credit Card (CC) Reference Transaction The following request body fields are applicable to this payment method: * `tokenId` (required) * `secondTokenId` * `creditCardMaskNumber` * `mandateInfo`  ### ACH The following request body fields are applicable to this payment method: * `bankABACode` (required) * `bankAccountName` (required) * `bankAccountNumber` (required) * `bankAccountMaskNumber` * `bankAccountType` (required) * `bankName` (required) * `addressLine1` * `addressLine2` * `phone` * `city` * `country` * `state` * `zipCode` * `mandateInfo`  ### SEPA The following request body fields are applicable to this payment method: * `IBAN` (required) * `accountHolderInfo` (required) * `businessIdentificationCode` * `mandateInfo`  ### Betalingsservice (Direct Debit DK) The following request body fields are applicable to this payment method: * `accountNumber` (required) * `identityNumber` (required) * `bankCode` (required) * `accountHolderInfo` (required) * `mandateInfo`  ### Autogiro (Direct Debit SE) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `identityNumber` (required) * `branchCode` (required) * `accountHolderInfo` (required)  * `mandateInfo`  ### Bacs (Direct Debit UK) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `bankCode` (required) * `accountHolderInfo` (required) * `mandateInfo`  ### Becs (Direct Entry AU) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `branchCode` (required) * `accountHolderInfo` (required) * `mandateInfo`  ### Becsnz (Direct Debit NZ) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `bankCode` (required) * `branchCode` (required) * `accountHolderInfo` (required) * `mandateInfo`  ### PAD (Pre-Authorized Debit) The following request body fields are applicable to this payment method: * `accountNumber` (required) * `bankCode` (required) * `branchCode` (required) * `accountHolderInfo` (required) * `mandateInfo`  ### PayPal Express Checkout The following request body fields are specific to this payment method: * `BAID` (required) * `email` (required)  ### PayPal Native Express Checkout The following request body fields are specific to this payment method: * `BAID` (required) * `email` (optional)  ### PayPal Adaptive The following request body fields are specific to this payment method: * `preapprovalKey` (required) * `email` (required)  ### PayPal Commerce Platform The following request body fields are applicable to the creation of a payment method with the PayPal Commerce Platform gateway integration: * `BAID` (required) * `email` (required)   ### Apple Pay on Adyen Integration v2.0 See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details.  ### Google Pay on Adyen Integration v2.0 See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.  ### Google Pay on Chase Paymentech Orbital Gateway See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.  ### Custom payment methods With the support of Universal Payment Connector (UPC) and Open Payment Method (OPM) services, you can create custom payment methods by using the fields defined in a definition file for this type of custom payment method. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details. 
+You can use this operation to create either a payment method associated with a specific customer account, or an orphan payment method that is not associated with any customer account. The orphan payment method must be associated with a customer account within 10 days. Otherwise, it will be deleted.  This operation supports the payment methods listed below.          ### Credit Card The following request body fields are applicable to this payment method: * `cardHolderInfo` (`cardHolderName` required) * `cardNumber` (required) * `cardType` (required) * `expirationMonth` (required) * `expirationYear` (required) * `cardMaskNumber` * `mitConsentAgreementRef` * `mitConsentAgreementSrc` * `mitNetworkTransactionId` * `mitProfileAction` * `mitProfileType` * `mitProfileAgreedOn` * `securityCode` * `checkDuplicated` * `mandateInfo` * `identityNumber`  ### Credit Card (CC) Reference Transaction The following request body fields are applicable to this payment method: * `tokenId` (required) * `secondTokenId` * `creditCardMaskNumber` * `mandateInfo`  ### ACH The following request body fields are applicable to this payment method: * `bankABACode` (required) * `bankAccountName` (required) * `bankAccountNumber` (required) * `bankAccountMaskNumber` * `bankAccountType` (required) * `bankName` (required) * `addressLine1` * `addressLine2` * `phone` * `city` * `country` * `state` * `zipCode` * `mandateInfo`  ### SEPA The following request body fields are applicable to this payment method: * `IBAN` (required) * `accountHolderInfo` (required) * `businessIdentificationCode` * `mandateInfo`  ### Betalingsservice (Direct Debit DK) The following request body fields are applicable to this payment method: * `accountNumber` (required) * `identityNumber` (required) * `bankCode` (required) * `accountHolderInfo` (required) * `mandateInfo`  ### Autogiro (Direct Debit SE) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `identityNumber` (required) * `branchCode` (required) * `accountHolderInfo` (required)  * `mandateInfo`  ### Bacs (Direct Debit UK) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `bankCode` (required) * `accountHolderInfo` (required) * `mandateInfo` n### Becs (Direct Entry AU) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `branchCode` (required) * `accountHolderInfo` (required) * `mandateInfo`  ### Becsnz (Direct Debit NZ) The following request body fields are applicable to this payment method:         * `accountNumber` (required) * `bankCode` (required) * `branchCode` (required) * `accountHolderInfo` (required) * `mandateInfo` n### PAD (Pre-Authorized Debit) The following request body fields are applicable to this payment method: * `accountNumber` (required) * `bankCode` (required) * `branchCode` (required) * `accountHolderInfo` (required) * `mandateInfo` n### PayPal Express Checkout The following request body fields are specific to this payment method: * `BAID` (required) * `email` (required)  ### PayPal Native Express Checkout The following request body fields are specific to this payment method: * `BAID` (required) * `email` (optional)  ### PayPal Adaptive The following request body fields are specific to this payment method: * `preapprovalKey` (required) * `email` (required)  ### PayPal Commerce Platform The following request body fields are applicable to the creation of a payment method with the PayPal Commerce Platform gateway integration: * `BAID` (required) * `email` (required)   ### Apple Pay on Adyen Integration v2.0 See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details.  ### Google Pay on Adyen Integration v2.0 See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.  ### Google Pay on Chase Paymentech Orbital Gateway See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.  ### Custom payment methods With the support of Universal Payment Connector (UPC) and Open Payment Method (OPM) services, you can create custom payment methods by using the fields defined in a definition file for this type of custom payment method. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details. 
 
 ### Example
 
@@ -237,7 +237,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentMethodsApi();
-let payment_method_id = "payment_method_id_example"; // String | ID of a payment method. 
+let payment_method_id = "payment_method_id_example"; // String | ID of a payment method.
 let request = new ZuoraSdkJs.CreateStoredCredentialProfileRequest(); // CreateStoredCredentialProfileRequest | 
 let opts = {
   'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
@@ -262,7 +262,7 @@ apiInstance.createStoredCredentialProfile(payment_method_id, request, opts).then
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_id** | **String**| ID of a payment method.  | 
+ **payment_method_id** | **String**| ID of a payment method. | 
  **request** | [**CreateStoredCredentialProfileRequest**](CreateStoredCredentialProfileRequest.md)|  | 
  **idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.   | [optional] 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
@@ -435,8 +435,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentMethodsApi();
-let payment_method_id = "payment_method_id_example"; // String | ID of a payment method. 
-let profile_number = 56; // Number | Number that identifies a stored credential profile within the payment method. 
+let payment_method_id = "payment_method_id_example"; // String | ID of a payment method.
+let profile_number = 56; // Number | Number that identifies a stored credential profile within the payment method.
 let opts = {
   'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -460,8 +460,8 @@ apiInstance.expireStoredCredentialProfile(payment_method_id, profile_number, opt
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_id** | **String**| ID of a payment method.  | 
- **profile_number** | **Number**| Number that identifies a stored credential profile within the payment method.  | 
+ **payment_method_id** | **String**| ID of a payment method. | 
+ **profile_number** | **Number**| Number that identifies a stored credential profile within the payment method. | 
  **idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.   | [optional] 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
@@ -567,14 +567,14 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentMethodsApi();
-let payment_method_id = "payment_method_id_example"; // String | ID of a payment method. 
+let payment_method_id = "payment_method_id_example"; // String | ID of a payment method.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
   'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
   'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
   'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
-  'include_all': false, // Boolean | Specifies whether to retrieve all the stored credential profiles within the payment method.  By default, Zuora returns only the stored credential profiles with `Agreed` or `Active` status. If you set this parameter to `true`, Zuora returns all the stored credential profiles. 
+  'include_all': false, // Boolean | Specifies whether to retrieve all the stored credential profiles within the payment method.  By default, Zuora returns only the stored credential profiles with `Agreed` or `Active` status. If you set this parameter to `true`, Zuora returns all the stored credential profiles.
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.  
   'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
 };
@@ -591,13 +591,13 @@ apiInstance.getStoredCredentialProfiles(payment_method_id, opts).then((data) =>
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_id** | **String**| ID of a payment method.  | 
+ **payment_method_id** | **String**| ID of a payment method. | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
  **zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).  | [optional] 
  **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional] 
- **include_all** | **Boolean**| Specifies whether to retrieve all the stored credential profiles within the payment method.  By default, Zuora returns only the stored credential profiles with `Agreed` or `Active` status. If you set this parameter to `true`, Zuora returns all the stored credential profiles.  | [optional] [default to false]
+ **include_all** | **Boolean**| Specifies whether to retrieve all the stored credential profiles within the payment method.  By default, Zuora returns only the stored credential profiles with `Agreed` or `Active` status. If you set this parameter to `true`, Zuora returns all the stored credential profiles. | [optional] [default to false]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
  **zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.  | [optional] 
 
@@ -633,7 +633,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentMethodsApi();
-let payment_method_id = "payment_method_id_example"; // String | The ID of the payment method where you want to scrub the sensitive data. 
+let payment_method_id = "payment_method_id_example"; // String | The ID of the payment method where you want to scrub the sensitive data.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -656,7 +656,7 @@ apiInstance.scrubPaymentMethod(payment_method_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_id** | **String**| The ID of the payment method where you want to scrub the sensitive data.  | 
+ **payment_method_id** | **String**| The ID of the payment method where you want to scrub the sensitive data. | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
@@ -685,7 +685,7 @@ Name | Type | Description  | Notes
 
 Update a payment method
 
-This operation allows you to update an existing payment method.   The following request body fields can be updated for any payment method types except for Credit Card Reference Transaction: * `authGateway` * `gatewayOptions` * `accountHolderInfo` * `ipAddress` * Custom fields  The following request body fields can be updated only for the Credit Card payment method: * `expirationMonth`  * `expirationYear` * `securityCode`  The following request body field can be updated for the Credit Card, Credit Card Reference Transaction, ACH, and Bank Transfer payment methods: * `mandateInfo`  
+This operation allows you to update an existing payment method.  nThe following request body fields can be updated for any payment method types except for Credit Card Reference Transaction: * `authGateway` * `gatewayOptions` * `accountHolderInfo` * `ipAddress` * Custom fields  The following request body fields can be updated only for the Credit Card payment method: * `expirationMonth`  * `expirationYear` * `securityCode`  The following request body field can be updated for the Credit Card, Credit Card Reference Transaction, ACH, and Bank Transfer payment methods: * `mandateInfo`  
 
 ### Example
 
@@ -763,7 +763,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentMethodsApi();
-let payment_method_id = "payment_method_id_example"; // String | The ID of the payment method to be verified. 
+let payment_method_id = "payment_method_id_example"; // String | The ID of the payment method to be verified.
 let body = new ZuoraSdkJs.VerifyPaymentMethodRequest(); // VerifyPaymentMethodRequest | 
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -786,7 +786,7 @@ apiInstance.verifyPaymentMethod(payment_method_id, body, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_id** | **String**| The ID of the payment method to be verified.  | 
+ **payment_method_id** | **String**| The ID of the payment method to be verified. | 
  **body** | [**VerifyPaymentMethodRequest**](VerifyPaymentMethodRequest.md)|  | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 

package/docs/PaymentPart.md

@@ -6,12 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The amount of the payment part.  | [optional] 
 **created_by_id** | **String** | The ID of the Zuora user who created the payment part.  | [optional] 
-**created_date** | **String** | The date and time when the payment part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.  | [optional] 
+**created_date** | **String** | The date and time when the payment part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. | [optional] 
 **debit_memo_id** | **String** | The ID of the debit memo associated with the payment part.  | [optional] 
 **id** | **String** | The ID of the payment part.  | [optional] 
 **invoice_id** | **String** | The ID of the invoice associated with the payment part.  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the payment part.  | [optional] 
-**updated_date** | **String** | The date and time when the payment part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
+**updated_date** | **String** | The date and time when the payment part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. | [optional] 
 **organization_label** | **String** |  | [optional] 
 **billing_document_owner_id** | **String** |  | [optional] 
 

package/docs/PaymentResponse.md

@@ -43,7 +43,7 @@ Name | Type | Description | Notes
 **standalone** | **Boolean** | This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment.  The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.  The value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora.  | [optional] [default to false]
 **status** | [**PaymentStatus**](PaymentStatus.md) |  | [optional] 
 **submitted_on** | **String** | The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **type** | [**PaymentType**](PaymentType.md) |  | [optional] 
 **unapplied_amount** | **Number** | The unapplied amount of the payment.  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the payment.  | [optional] 

package/docs/PaymentRunResponse.md

@@ -32,6 +32,6 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 
 

package/docs/PaymentRunsApi.md

@@ -98,7 +98,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentRunsApi();
-let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. 
+let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -120,7 +120,7 @@ apiInstance.deletePaymentRun(payment_run_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.  | 
+ **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
@@ -160,7 +160,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentRunsApi();
-let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. 
+let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -183,7 +183,7 @@ apiInstance.getPaymentRun(payment_run_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.  | 
+ **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
@@ -224,7 +224,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentRunsApi();
-let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. 
+let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -246,7 +246,7 @@ apiInstance.getPaymentRunData(payment_run_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.  | 
+ **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
@@ -286,7 +286,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentRunsApi();
-let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. 
+let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -308,7 +308,7 @@ apiInstance.getPaymentRunSummary(payment_run_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.  | 
+ **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
@@ -356,12 +356,12 @@ let opts = {
   'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
   'page': 1, // Number | The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. 
   'page_size': 20, // Number | The number of records returned per page in the response. 
-  'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field. 
-  'created_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `createdDate` field. 
-  'status': "status_example", // String | This parameter filters the response based on the `status` field. 
-  'target_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `targetDate` field. 
-  'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field. 
-  'updated_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `updatedDate` field. 
+  'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field.
+  'created_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `createdDate` field.
+  'status': "status_example", // String | This parameter filters the response based on the `status` field.
+  'target_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `targetDate` field.
+  'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field.
+  'updated_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `updatedDate` field.
   'sort': "sort_example", // String | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.  A sortable field uses the following form:   *operator* *field_name*  You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*    *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.    - The `-` operator indicates an ascending order.   - The `+` operator indicates a descending order.  By default, the response data is displayed in descending order by payment run number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - targetDate   - status   - createdDate   - createdById   - updatedDate   - updatedById  Examples:  - /v1/payment-runs?sort=+createdDate  - /v1/payment-runs?status=Processing&sort=-createdById,+targetDate 
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.  
   'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
@@ -386,12 +386,12 @@ Name | Type | Description  | Notes
  **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional] 
  **page** | **Number**| The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.  | [optional] [default to 1]
  **page_size** | **Number**| The number of records returned per page in the response.  | [optional] [default to 20]
- **created_by_id** | **String**| This parameter filters the response based on the `createdById` field.  | [optional] 
- **created_date** | **Date**| This parameter filters the response based on the `createdDate` field.  | [optional] 
- **status** | **String**| This parameter filters the response based on the `status` field.  | [optional] 
- **target_date** | **String**| This parameter filters the response based on the `targetDate` field.  | [optional] 
- **updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field.  | [optional] 
- **updated_date** | **Date**| This parameter filters the response based on the `updatedDate` field.  | [optional] 
+ **created_by_id** | **String**| This parameter filters the response based on the `createdById` field. | [optional] 
+ **created_date** | **Date**| This parameter filters the response based on the `createdDate` field. | [optional] 
+ **status** | **String**| This parameter filters the response based on the `status` field. | [optional] 
+ **target_date** | **String**| This parameter filters the response based on the `targetDate` field. | [optional] 
+ **updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field. | [optional] 
+ **updated_date** | **Date**| This parameter filters the response based on the `updatedDate` field. | [optional] 
  **sort** | **String**| This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.  A sortable field uses the following form:   *operator* *field_name*  You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*    *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.    - The `-` operator indicates an ascending order.   - The `+` operator indicates a descending order.  By default, the response data is displayed in descending order by payment run number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - targetDate   - status   - createdDate   - createdById   - updatedDate   - updatedById  Examples:  - /v1/payment-runs?sort=+createdDate  - /v1/payment-runs?status=Processing&sort=-createdById,+targetDate  | [optional] 
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
  **zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.  | [optional] 
@@ -428,7 +428,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentRunsApi();
-let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. 
+let payment_run_key = "payment_run_key_example"; // String | The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
 let body = new ZuoraSdkJs.UpdatePaymentRunRequest(); // UpdatePaymentRunRequest | 
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -452,7 +452,7 @@ apiInstance.updatePaymentRun(payment_run_key, body, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.  | 
+ **payment_run_key** | **String**| The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566. | 
  **body** | [**UpdatePaymentRunRequest**](UpdatePaymentRunRequest.md)|  | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 

package/docs/PaymentSchedule.md

@@ -17,16 +17,16 @@ Name | Type | Description | Notes
 **is_custom** | **Boolean** | Indicates if the payment schedule is a custom payment schedule.  | [optional] 
 **items** | [**[PaymentScheduleItem]**](PaymentScheduleItem.md) | Container for payment schedule items.  | [optional] 
 **next_payment_date** | **String** | The date the next payment will be processed.  | [optional] 
-**occurrences** | **Number** | The number of payment schedule items that are created by this payment schedule.  | [optional] 
-**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  This field is only available if `zuora-version` is set to `337.0` or later.  | [optional] 
+**occurrences** | **Number** | The number of payment schedule items that are created by this payment schedule. | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.   `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.   This field is only available if `zuora-version` is set to `337.0` or later. | [optional] 
 **payment_schedule_number** | **String** | Number of the payment schedule.  | [optional] 
-**period** | **String** | For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.  Return `null` for custom payment schedules.  | [optional] 
-**prepayment** | **Boolean** | Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.  | [optional] 
+**period** | **String** | For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.   Return `null` for custom payment schedules. | [optional] 
+**prepayment** | **Boolean** | Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. | [optional] 
 **recent_payment_date** | **String** | The date the last payment was processed.  | [optional] 
-**run_hour** | **Number** | [0,1,2,~,22,23]  At which hour in the day in the tenant’s timezone this payment will be collected.  Return `0` for custom payment schedules.  | [optional] 
-**standalone** | **Boolean** | Indicates if the payments that the payment schedule created are standalone payments.  | [optional] 
-**start_date** | **String** | The date when the first payment of this payment schedule is proccessed.  | [optional] 
-**status** | **String** | The status of the payment schedule.  - Active: There is still payment schedule item to process. - Canceled: After a payment schedule is canceled by the user, the schedule is marked as `Canceled`. - Completed: After all payment schedule items are processed, the schedule is marked as `Completed`.  | [optional] 
+**run_hour** | **Number** | [0,1,2,~,22,23]   At which hour in the day in the tenant’s timezone this payment will be collected.   Return `0` for custom payment schedules. | [optional] 
+**standalone** | **Boolean** | Indicates if the payments that the payment schedule created are standalone payments. | [optional] 
+**start_date** | **String** | The date when the first payment of this payment schedule is proccessed. | [optional] 
+**status** | **String** | The status of the payment schedule.   - Active: There is still payment schedule item to process.  - Canceled: After a payment schedule is canceled by the user, the schedule is marked as `Canceled`.  - Completed: After all payment schedule items are processed, the schedule is marked as `Completed`. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **total_amount** | **Number** | The total amount that will be collected by the payment schedule.  | [optional] 
 **total_payments_errored** | **Number** | The number of errored payments.  | [optional] 

package/docs/PaymentScheduleItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account_id** | **String** | ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.  | [optional] 
+**account_id** | **String** | ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`. | [optional] 
 **amount** | **Number** | The total amount of the payment schedule.  | [optional] 
 **balance** | **Number** | The remaining balance of payment schedule item.  | [optional] 
 **billing_document** | [**PaymentScheduleBillingDocument**](PaymentScheduleBillingDocument.md) |  | [optional] 
@@ -15,20 +15,20 @@ Name | Type | Description | Notes
 **created_date** | **String** | The date and time when the payment schedule item was created.  | [optional] 
 **currency** | **String** | The currency of the payment.  | [optional] 
 **description** | **String** | The description of the payment schedule item.  | [optional] 
-**error_message** | **String** | The error message indicating if the error is related to the configuration or the payment collection.  | [optional] 
-**id** | **String** | ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.  | [optional] 
+**error_message** | **String** | The error message indicating if the error is related to the configuration or the payment collection. | [optional] 
+**id** | **String** | ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`. | [optional] 
 **number** | **String** | Number of the payment schedule item.  | [optional] 
 **payment_gateway_id** | **String** | ID of the payment gateway of the payment schedule item.  | [optional] 
 **payment_id** | **String** | ID of the payment that is created by the payment schedule item, or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`.   | [optional] 
 **payment_method_id** | **String** | ID of the payment method of the payment schedule item.  | [optional] 
-**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  This field is only available if `zuora-version` is set to `337.0` or later.  | [optional] 
-**payment_schedule_id** | **String** | ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.  | [optional] 
-**payment_schedule_number** | **String** | Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.  | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.   `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.   This field is only available if `zuora-version` is set to `337.0` or later. | [optional] 
+**payment_schedule_id** | **String** | ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`. | [optional] 
+**payment_schedule_number** | **String** | Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`. | [optional] 
 **psi_payments** | [**[PaymentScheduleLinkedPaymentID]**](PaymentScheduleLinkedPaymentID.md) | Container for payments linked to the payment schedule item.  | [optional] 
-**run_hour** | **Number** | At which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.  | [optional] 
+**run_hour** | **Number** | At which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs. | [optional] 
 **scheduled_date** | **String** | The scheduled date when the payment is processed.  | [optional] 
-**standalone** | **Boolean** | Indicates if the payment created by the payment schedule item is a standalone payment or not.  | [optional] 
-**status** | **String** | ID of the payment method of the payment schedule item.  - `Pending`: Payment schedule item is waiting for processing. - `Processed`: The payment has been collected. - `Error`: Failed to collect the payment. - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.  | [optional] 
+**standalone** | **Boolean** | Indicates if the payment created by the payment schedule item is a standalone payment or not. | [optional] 
+**status** | **String** | ID of the payment method of the payment schedule item.   - `Pending`: Payment schedule item is waiting for processing.  - `Processed`: The payment has been collected.  - `Error`: Failed to collect the payment.  - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`. | [optional] 
 **updated_by_id** | **String** | The ID of the user who updated the payment schedule item.  | [optional] 
 **updated_date** | **String** | The date and time when the payment schedule item was last updated.  | [optional] 
 

package/docs/PaymentScheduleItemResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account_id** | **String** | ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.  | [optional] 
+**account_id** | **String** | ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`. | [optional] 
 **amount** | **Number** | The total amount of the payment schedule.  | [optional] 
 **balance** | **Number** | The remaining balance of payment schedule item.  | [optional] 
 **billing_document** | [**PaymentScheduleBillingDocument**](PaymentScheduleBillingDocument.md) |  | [optional] 
@@ -15,26 +15,26 @@ Name | Type | Description | Notes
 **created_date** | **String** | The date and time when the payment schedule item was created.  | [optional] 
 **currency** | **String** | The currency of the payment.  | [optional] 
 **description** | **String** | The description of the payment schedule item.  | [optional] 
-**error_message** | **String** | The error message indicating if the error is related to the configuration or the payment collection.  | [optional] 
-**id** | **String** | ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.  | [optional] 
+**error_message** | **String** | The error message indicating if the error is related to the configuration or the payment collection. | [optional] 
+**id** | **String** | ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`. | [optional] 
 **number** | **String** | Number of the payment schedule item.  | [optional] 
 **payment_gateway_id** | **String** | ID of the payment gateway of the payment schedule item.  | [optional] 
 **payment_id** | **String** | ID of the payment that is created by the payment schedule item, or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`.   | [optional] 
 **payment_method_id** | **String** | ID of the payment method of the payment schedule item.  | [optional] 
-**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  This field is only available if `zuora-version` is set to `337.0` or later.  | [optional] 
-**payment_schedule_id** | **String** | ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.  | [optional] 
-**payment_schedule_number** | **String** | Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.  | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.   `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.   This field is only available if `zuora-version` is set to `337.0` or later. | [optional] 
+**payment_schedule_id** | **String** | ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`. | [optional] 
+**payment_schedule_number** | **String** | Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`. | [optional] 
 **psi_payments** | [**[PaymentScheduleLinkedPaymentID]**](PaymentScheduleLinkedPaymentID.md) | Container for payments linked to the payment schedule item.  | [optional] 
-**run_hour** | **Number** | At which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.  | [optional] 
+**run_hour** | **Number** | At which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs. | [optional] 
 **scheduled_date** | **String** | The scheduled date when the payment is processed.  | [optional] 
-**standalone** | **Boolean** | Indicates if the payment created by the payment schedule item is a standalone payment or not.  | [optional] 
-**status** | **String** | ID of the payment method of the payment schedule item.  - `Pending`: Payment schedule item is waiting for processing. - `Processed`: The payment has been collected. - `Error`: Failed to collect the payment. - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.  | [optional] 
+**standalone** | **Boolean** | Indicates if the payment created by the payment schedule item is a standalone payment or not. | [optional] 
+**status** | **String** | ID of the payment method of the payment schedule item.   - `Pending`: Payment schedule item is waiting for processing.  - `Processed`: The payment has been collected.  - `Error`: Failed to collect the payment.  - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`. | [optional] 
 **updated_by_id** | **String** | The ID of the user who updated the payment schedule item.  | [optional] 
 **updated_date** | **String** | The date and time when the payment schedule item was last updated.  | [optional] 
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 
 
 

package/docs/PaymentSchedulePaymentOptionFields.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **detail** | [**PaymentSchedulePaymentOptionFieldsDetail**](PaymentSchedulePaymentOptionFieldsDetail.md) |  | [optional] 
-**type** | **String** | The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway.  | [optional] 
+**type** | **String** | The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway. | [optional]