zuora-sdk-js 3.6.0 → 3.7.0

package/docs/PaymentsApi.md

@@ -40,7 +40,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 let body = new ZuoraSdkJs.ApplyPaymentRequest(); // ApplyPaymentRequest | 
 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. 
@@ -64,7 +64,7 @@ apiInstance.applyPayment(payment_key, body, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **body** | [**ApplyPaymentRequest**](ApplyPaymentRequest.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] 
@@ -106,7 +106,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 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. 
@@ -129,7 +129,7 @@ apiInstance.cancelPayment(payment_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **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] 
@@ -158,7 +158,7 @@ Name | Type | Description  | Notes
 
 Create a payment
 
-**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   Creates a payment in the following scenarios:  - A full or partial payment on an invoice or a debit memo - A full or partial payment on several invoices and debit memos - An unapplied payment in the following situations:   - You do not know which customer account the payment belongs to.   - You know which customer account the payment belongs to, but you do not know which invoice the payment is applied to.   - You receive a payment from your customer that exceeds the balance on the invoice.   - You receive a payment from your customer before the invoice has been created.   - You intend to create a payment without any invoices or debit memos. - A standalone payment. If you only need to create and process an electronic payment in Zuora through a Zuora gateway integration but settle the payment outside of Zuora, you can create a standalone payment. For a standalone payment, you can specify a currency different from the payment currency in the customer account settings.     The support for standalone payments is in the Early Adopter phase. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.   If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account.  When you create a payment, the total number of invoice items and debit memo items that the payment will apply to should be less than or equal to 15,000.  For more information, see [Create Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments) and [Create Payments Without Specifying Customer Accounts](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments_Without_Specifying_Customer_Accounts).      
+**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   Creates a payment in the following scenarios:  - A full or partial payment on an invoice or a debit memo - A full or partial payment on several invoices and debit memos - An unapplied payment in the following situations:   - You do not know which customer account the payment belongs to.   - You know which customer account the payment belongs to, but you do not know which invoice the payment is applied to.   - You receive a payment from your customer that exceeds the balance on the invoice.   - You receive a payment from your customer before the invoice has been created.   - You intend to create a payment without any invoices or debit memos. - A standalone payment. If you only need to create and process an electronic payment in Zuora through a Zuora gateway integration but settle the payment outside of Zuora, you can create a standalone payment. For a standalone payment, you can specify a currency different from the payment currency in the customer account settings.     The support for standalone payments is in the Early Adopter phase. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.   If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account. nWhen you create a payment, the total number of invoice items and debit memo items that the payment will apply to should be less than or equal to 15,000. nFor more information, see [Create Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments) and [Create Payments Without Specifying Customer Accounts](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments_Without_Specifying_Customer_Accounts).      
 
 ### Example
 
@@ -236,7 +236,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 let body = new ZuoraSdkJs.CreateRefundRequest(); // CreateRefundRequest | 
 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.  
@@ -261,7 +261,7 @@ apiInstance.createRefundPayment(payment_key, body, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **body** | [**CreateRefundRequest**](CreateRefundRequest.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] 
@@ -304,7 +304,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 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. 
@@ -327,7 +327,7 @@ apiInstance.deletePayment(payment_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **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] 
@@ -368,7 +368,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 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. 
@@ -391,7 +391,7 @@ apiInstance.getPayment(payment_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **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] 
@@ -432,9 +432,9 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let part_id = "part_id_example"; // String | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts). 
-let item_part_id = "item_part_id_example"; // String | The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part items](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentItemParts). 
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let part_id = "part_id_example"; // String | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts).
+let item_part_id = "item_part_id_example"; // String | The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part items](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentItemParts).
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 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. 
@@ -457,9 +457,9 @@ apiInstance.getPaymentItemPart(part_id, item_part_id, payment_key, opts).then((d
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **part_id** | **String**| The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts).  | 
- **item_part_id** | **String**| The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part items](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentItemParts).  | 
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **part_id** | **String**| The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts). | 
+ **item_part_id** | **String**| The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part items](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentItemParts). | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **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] 
@@ -500,8 +500,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let part_id = "part_id_example"; // String | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts). 
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let part_id = "part_id_example"; // String | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts).
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 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. 
@@ -526,8 +526,8 @@ apiInstance.getPaymentItemParts(part_id, payment_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **part_id** | **String**| The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts).  | 
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **part_id** | **String**| The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts). | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **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] 
@@ -570,8 +570,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let part_id = "part_id_example"; // String | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts). 
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let part_id = "part_id_example"; // String | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts).
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 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. 
@@ -594,8 +594,8 @@ apiInstance.getPaymentPart(part_id, payment_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **part_id** | **String**| The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts).  | 
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **part_id** | **String**| The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/Get_PaymentParts). | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **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] 
@@ -636,7 +636,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 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. 
@@ -661,7 +661,7 @@ apiInstance.getPaymentParts(payment_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **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] 
@@ -692,7 +692,7 @@ Name | Type | Description  | Notes
 
 List payments
 
-**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   Retrieves the information about all payments from all your customer accounts.  ### Filtering  You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.  If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.  Examples:  - /v1/payments?status=Processed  - /v1/payments?currency=USD&status=Processed  - /v1/payments?status=Processed&type=External&sort=+number 
+**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   Retrieves the information about all payments from all your customer accounts.  ### Filtering  You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.  If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.  Examples:  - /v1/payments?status=Processed  - /v1/payments?currency=USD&status=Processed n- /v1/payments?status=Processed&type=External&sort=+number 
 
 ### Example
 
@@ -713,21 +713,21 @@ let opts = {
   '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. 
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.  
-  'account_id': "account_id_example", // String | This parameter filters the response based on the `accountId` field. 
-  'amount': 3.4, // Number | This parameter filters the response based on the `amount` field. 
-  'applied_amount': 3.4, // Number | This parameter filters the response based on the `appliedAmount` 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. 
-  'credit_balance_amount': 3.4, // Number | This parameter filters the response based on the `creditBalanceAmount` field. 
-  'currency': "currency_example", // String | This parameter filters the response based on the `currency` field. 
-  'effective_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `effectiveDate` field. 
-  'number': "number_example", // String | This parameter filters the response based on the `number` field. 
-  'refund_amount': 3.4, // Number | This parameter filters the response based on the `refundAmount` field. 
-  'status': "status_example", // String | This parameter filters the response based on the `status` field. 
-  'type': "type_example", // String | This parameter filters the response based on the `type` field. 
-  'unapplied_amount': 3.4, // Number | This parameter filters the response based on the `unappliedAmount` 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. 
+  'account_id': "account_id_example", // String | This parameter filters the response based on the `accountId` field.
+  'amount': 3.4, // Number | This parameter filters the response based on the `amount` field.
+  'applied_amount': 3.4, // Number | This parameter filters the response based on the `appliedAmount` 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.
+  'credit_balance_amount': 3.4, // Number | This parameter filters the response based on the `creditBalanceAmount` field.
+  'currency': "currency_example", // String | This parameter filters the response based on the `currency` field.
+  'effective_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `effectiveDate` field.
+  'number': "number_example", // String | This parameter filters the response based on the `number` field.
+  'refund_amount': 3.4, // Number | This parameter filters the response based on the `refundAmount` field.
+  'status': "status_example", // String | This parameter filters the response based on the `status` field.
+  'type': "type_example", // String | This parameter filters the response based on the `type` field.
+  'unapplied_amount': 3.4, // Number | This parameter filters the response based on the `unappliedAmount` 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 number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - number   - accountId   - amount   - appliedAmount   - unappliedAmount   - refundAmount   - creditBalanceAmount   - effectiveDate   - createdDate   - createdById   - updatedDate   - updatedById    Examples:  - /v1/payments?sort=+number  - /v1/payments?status=Processed&sort=-number,+amount 
   '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. 
 };
@@ -752,21 +752,21 @@ Name | Type | Description  | Notes
  **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]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
- **account_id** | **String**| This parameter filters the response based on the `accountId` field.  | [optional] 
- **amount** | **Number**| This parameter filters the response based on the `amount` field.  | [optional] 
- **applied_amount** | **Number**| This parameter filters the response based on the `appliedAmount` 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] 
- **credit_balance_amount** | **Number**| This parameter filters the response based on the `creditBalanceAmount` field.  | [optional] 
- **currency** | **String**| This parameter filters the response based on the `currency` field.  | [optional] 
- **effective_date** | **Date**| This parameter filters the response based on the `effectiveDate` field.  | [optional] 
- **number** | **String**| This parameter filters the response based on the `number` field.  | [optional] 
- **refund_amount** | **Number**| This parameter filters the response based on the `refundAmount` field.  | [optional] 
- **status** | **String**| This parameter filters the response based on the `status` field.  | [optional] 
- **type** | **String**| This parameter filters the response based on the `type` field.  | [optional] 
- **unapplied_amount** | **Number**| This parameter filters the response based on the `unappliedAmount` 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] 
+ **account_id** | **String**| This parameter filters the response based on the `accountId` field. | [optional] 
+ **amount** | **Number**| This parameter filters the response based on the `amount` field. | [optional] 
+ **applied_amount** | **Number**| This parameter filters the response based on the `appliedAmount` 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] 
+ **credit_balance_amount** | **Number**| This parameter filters the response based on the `creditBalanceAmount` field. | [optional] 
+ **currency** | **String**| This parameter filters the response based on the `currency` field. | [optional] 
+ **effective_date** | **Date**| This parameter filters the response based on the `effectiveDate` field. | [optional] 
+ **number** | **String**| This parameter filters the response based on the `number` field. | [optional] 
+ **refund_amount** | **Number**| This parameter filters the response based on the `refundAmount` field. | [optional] 
+ **status** | **String**| This parameter filters the response based on the `status` field. | [optional] 
+ **type** | **String**| This parameter filters the response based on the `type` field. | [optional] 
+ **unapplied_amount** | **Number**| This parameter filters the response based on the `unappliedAmount` 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 number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - number   - accountId   - amount   - appliedAmount   - unappliedAmount   - refundAmount   - creditBalanceAmount   - effectiveDate   - createdDate   - createdById   - updatedDate   - updatedById    Examples:  - /v1/payments?sort=+number  - /v1/payments?status=Processed&sort=-number,+amount  | [optional] 
  **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] 
 
@@ -802,7 +802,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 let body = new ZuoraSdkJs.CreateRefundwithAutoUnapply(); // CreateRefundwithAutoUnapply | 
 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.  
@@ -827,7 +827,7 @@ apiInstance.refundPaymentwithAutoUnapply(payment_key, body, opts).then((data) =>
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **body** | [**CreateRefundwithAutoUnapply**](CreateRefundwithAutoUnapply.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] 
@@ -936,7 +936,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. 
+let payment_key = "payment_key_example"; // String | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
 let body = new ZuoraSdkJs.UnapplyPaymentRequest(); // UnapplyPaymentRequest | 
 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. 
@@ -960,7 +960,7 @@ apiInstance.unapplyPayment(payment_key, body, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.  | 
+ **payment_key** | **String**| The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. | 
  **body** | [**UnapplyPaymentRequest**](UnapplyPaymentRequest.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] 
@@ -1002,7 +1002,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.PaymentsApi();
-let payment_id = "payment_id_example"; // String | The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`. 
+let payment_id = "payment_id_example"; // String | The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`.
 let body = new ZuoraSdkJs.UpdatePaymentRequest(); // UpdatePaymentRequest | 
 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. 
@@ -1026,7 +1026,7 @@ apiInstance.updatePayment(payment_id, body, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_id** | **String**| The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`.  | 
+ **payment_id** | **String**| The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`. | 
  **body** | [**UpdatePaymentRequest**](UpdatePaymentRequest.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/PostAsyncInvoiceRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**invoice_date** | **String** | The new invoice date when posting the invoice. By default, it will use invoice date of the invoice.  | [optional] 
+**invoice_date** | **String** | The new invoice date when posting the invoice. By default, it will use invoice date of the invoice. | [optional] 
 
 

package/docs/PostAttachmentResponse.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **request_id** | **String** | The request ID of this process.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
-**file_id** | **String** | ID to identify the attached file. Use this file ID with [Get files](https://www.zuora.com/developer/api-references/api/operation/Get_Files) to download the file.  | [optional] 
+**file_id** | **String** | ID to identify the attached file. Use this file ID with [Get files](https://www.zuora.com/developer/api-references/api/operation/Get_Files) to download the file. | [optional] 
 **id** | **String** | Attachment id.  | [optional] 
 
 

package/docs/PostAttachmentsRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **File** | The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls  The maximum file size is 4 MB.  | 
+**file** | **File** | The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls   The maximum file size is 4 MB. | 
 
 

package/docs/PostBillRunRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**invoice_date** | **String** | The date that appears on the invoice being created, in `yyyy-mm-dd` format.   The value cannot fall in a closed accounting period.  | 
+**invoice_date** | **String** | The date that appears on the invoice being created, in `yyyy-mm-dd` format.    The value cannot fall in a closed accounting period. | 
 
 

package/docs/PostCreateOrUpdateEmailTemplateRequest.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**allow_partial_success** | **Boolean** | When set to `false`, the call will fail if one or multiple instances fail to import, and a `200` response is returned if all email templates have been successfully updated. When set to `true`, a success (`200`) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response.  | [optional] 
+**allow_partial_success** | **Boolean** | When set to `false`, the call will fail if one or multiple instances fail to import, and a `200` response is returned if all email templates have been successfully updated.  When set to `true`, a success (`200`) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response. | [optional] 
 **email_templates** | [**[PostCreateOrUpdateEmailTemplateRequestFormat]**](PostCreateOrUpdateEmailTemplateRequestFormat.md) | A container for email templates.  | [optional] 
 
 

package/docs/PostCreditMemoRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**credit_memo_date** | **String** | The new memo date when posting the credit memo. By default, it will use current memo date of the credit memo.  | [optional] 
+**credit_memo_date** | **String** | The new memo date when posting the credit memo. By default, it will use current memo date of the credit memo. | [optional] 
 
 

package/docs/PostCustomObjectDefinitionFieldDefinitionRequest.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**display_name** | **Boolean** | Indicates whether to use this field as the display name of the custom object when being linked to another custom object.  This field applies only to the Text custom field type:  - The `type` field is `string`. - The `enum` field is not specified.  | [optional] 
+**display_name** | **Boolean** | Indicates whether to use this field as the display name of the custom object when being linked to another custom object.   This field applies only to the Text custom field type:   - The `type` field is `string`.  - The `enum` field is not specified. | [optional] 
 **format** | **String** | The data format of the custom field | [optional] 
 **label** | **String** | The UI label of the custom field | 
-**max_length** | **Number** | The maximum length of string that can be stored in the custom field.  This field applies only to the following custom field types:  - Text:   - The `type` field is `string`.   - The `format` field is not specified or is `url`.   - The `enum` field is not specified. - Picklist:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is not specified or is `false`. - Multiselect:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is `true`.  If the custom field is filterable, the value of `maxLength` must be 512 or less.  | [optional] 
+**max_length** | **Number** | The maximum length of string that can be stored in the custom field.   This field applies only to the following custom field types:   - Text:   - The `type` field is `string`.   - The `format` field is not specified or is `url`.   - The `enum` field is not specified. - Picklist:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is not specified or is `false`. - Multiselect:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is `true`.  If the custom field is filterable, the value of `maxLength` must be 512 or less. | [optional] 
 **multiselect** | **Boolean** | Indicates whether this is a multiselect custom field.  This field applies only to the Picklist or Multiselect custom field types:  - The `type` field is `string`. - The `maxLength` field is specified. - The `enum` field is specified.  | [optional] 
 **type** | **String** | The data type of the custom field | 
 

package/docs/PostCustomObjectDefinitionsRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**definitions** | [**{String: PostCustomObjectDefinitionsRequestDefinition}**](PostCustomObjectDefinitionsRequestDefinition.md) | The custom object definitions. This object maps types to custom object definitions.  | [optional] 
+**definitions** | [**{String: PostCustomObjectDefinitionsRequestDefinition}**](PostCustomObjectDefinitionsRequestDefinition.md) | The custom object definitions. This object maps types to custom object definitions. | [optional] 
 
 

package/docs/PostCustomObjectDefinitionsRequestDefinition.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **auditable** | **[String]** | The set of fields which Audit Trail tracks and records changes of. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields. | [optional] 
-**enable_create_record_auditing** | **Boolean** | Indicates whether to audit the creation of custom object records of this custom object definition.  Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>.  | [optional] [default to false]
-**enable_delete_record_auditing** | **Boolean** | Indicates whether to audit the deletion of custom object records of this custom object definition.  Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>.  | [optional] [default to false]
+**enable_create_record_auditing** | **Boolean** | Indicates whether to audit the creation of custom object records of this custom object definition.   Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>. | [optional] [default to false]
+**enable_delete_record_auditing** | **Boolean** | Indicates whether to audit the deletion of custom object records of this custom object definition.   Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>. | [optional] [default to false]
 **filterable** | **[String]** | The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable. | [optional] 
 **label** | **String** | A UI label for the custom object | 
 **object** | **String** | The API name of the custom object | 

package/docs/PostPublicNotificationDefinitionRequest.md

@@ -5,15 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **active** | **Boolean** | The status of the notification definition. The default value is `true`. | [optional] [default to true]
-**associated_account** | **String** | Indicates with which type of account this notification is associated. Depending on your environment, you can use one of the following values: * `Account.Id`: ID of the primary customer account related to the notification. It is also the default value. * `ParentAccount.Id`: this option is available only if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled for your tenant. * `SubscriptionOwnerAccount.Id`: this option is available if the base object of the notification is Order Action.  **Note:** before specifying this field, we recommend that you use [Data Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference) to check the available types of accounts for the current notification.    | [optional] 
+**associated_account** | **String** | Indicates with which type of account this notification is associated. Depending on your environment, you can use one of the following values:  * `Account.Id`: ID of the primary customer account related to the notification. It is also the default value.  * `ParentAccount.Id`: this option is available only if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled for your tenant.  * `SubscriptionOwnerAccount.Id`: this option is available if the base object of the notification is Order Action.   **Note:** before specifying this field, we recommend that you use [Data Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference) to check the available types of accounts for the current notification.   | [optional] 
 **callout** | [**PostPublicNotificationDefinitionRequestCallout**](PostPublicNotificationDefinitionRequestCallout.md) |  | [optional] 
 **callout_active** | **Boolean** | The status of the callout action. The default value is `false`. | [optional] [default to false]
-**communication_profile_id** | **String** | The profile that notification definition belongs to.   You can use the [Query Action](https://www.zuora.com/developer/api-references/api/operation/Action_Postquery) to get the communication profile Id. See the following request sample:  `{     \"queryString\": \"select Id, ProfileName from CommunicationProfile\"  }`  If you do not pass the communicationProfileId, notification service will be automatically added to the 'Default Profile'.  | [optional] 
+**communication_profile_id** | **String** | The profile that notification definition belongs to.    You can use the [Query Action](https://www.zuora.com/developer/api-references/api/operation/Action_Postquery) to get the communication profile Id. See the following request sample:   `{     \"queryString\": \"select Id, ProfileName from CommunicationProfile\"  }`  If you do not pass the communicationProfileId, notification service will be automatically added to the 'Default Profile'. | [optional] 
 **description** | **String** | The description of the notification definition. | [optional] 
 **email_active** | **Boolean** | The status of the email action. The default value is `false`. | [optional] [default to false]
 **email_template_id** | **String** | The ID of the email template. If `emailActive` is `true`, an email template is required. And EventType of the email template MUST be the same as the eventType. | [optional] 
 **event_type_name** | **String** | The name of the event type.   | 
-**event_type_namespace** | **String** | The namespace of the `eventTypeName` field. The `eventTypeName` has the `user.notification` namespace by default.             For example, if you want to create a notification definition on the `OrderActionProcessed` event, you must specify `com.zuora.notification` for this field.  | [optional] 
+**event_type_namespace** | **String** | The namespace of the `eventTypeName` field. The `eventTypeName` has the `user.notification` namespace by default.             For example, if you want to create a notification definition on the `OrderActionProcessed` event, you must specify `com.zuora.notification` for this field. | [optional] 
 **filter_rule** | [**PostPublicNotificationDefinitionRequestFilterRule**](PostPublicNotificationDefinitionRequestFilterRule.md) |  | [optional] 
 **filter_rule_params** | **{String: String}** | The parameter values used to configure the filter rule.  | [optional] 
 **name** | **String** | The name of the notification definition, unique per communication profile. | 

package/docs/PostPublicNotificationDefinitionRequestFilterRule.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to filter an invoice posted notification to only invoices with an amount over 1000, you would define the following condition:  ```Invoice.Amount > 1000```  There are conventions and keywords you need to be aware of. For example:  * `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.  * Unlike Event Triggers, there is no access to variables with the `_old` suffix. Fields with the `_old` suffix are only available on Event Trigger conditions.  | 
+**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/).  The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to filter an invoice posted notification to only invoices with an amount over 1000, you would define the following condition:   ```Invoice.Amount > 1000```   There are conventions and keywords you need to be aware of. For example:   * `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.   * Unlike Event Triggers, there is no access to variables with the `_old` suffix. Fields with the `_old` suffix are only available on Event Trigger conditions. | 
 **description** | **String** | The description of the filter rule. | [optional] 
-**parameters** | [**{String: FilterRuleParameterDefinition}**](FilterRuleParameterDefinition.md) | The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY`  | 
+**parameters** | [**{String: FilterRuleParameterDefinition}**](FilterRuleParameterDefinition.md) | The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY` | 
 
 

package/docs/PostScheduledEventRequest.md

@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **active** | **Boolean** | Indicate whether the scheduled event is active or inactive. | [optional] [default to true]
-**api_field** | **String** | The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$   See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base fields.  | 
-**api_object** | **String** | The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$             See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base objects.  | 
-**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:  ```Invoice.Amount > 1000```  `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.  | [optional] 
+**api_field** | **String** | The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$   See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base fields. | 
+**api_object** | **String** | The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$             See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base objects. | 
+**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true.  The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).  Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:   ```Invoice.Amount > 1000```   `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`. | [optional] 
 **description** | **String** | The description of the scheduled event. | [optional] 
 **display_name** | **String** | The display name of the scheduled event. | 
 **hours** | **Number** | The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant. | 

package/docs/PreviewExistingSubscriptionResponse.md

@@ -7,7 +7,7 @@ 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]
 **invoices** | [**[PreviewExistingSubscriptionResultInvoices]**](PreviewExistingSubscriptionResultInvoices.md) | Container for invoices. | [optional] 
 **credit_memos** | [**[PreviewExistingSubscriptionResultCreditMemos]**](PreviewExistingSubscriptionResultCreditMemos.md) | Container for credit memos. This field is only available if you have the Invoice Settlement feature enabled. | [optional] 
 

package/docs/PreviewOptions.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **preview_thru_type** | [**PreviewOptionsPreviewThruType**](PreviewOptionsPreviewThruType.md) |  | [optional] 
 **preview_types** | **[String]** | One or more types of the preview. It can include:  * ChargeMetrics: charge level metrics will be returned in the response, including: `cmrr`, `tcv`, `tcb`, and `tax`. * BillingDocs: `invoices` and `creditMemos` will be returned in the response. Note `creditMemos` is only available if the Invoice Settlement feature is enabled. * OrderDeltaMetrics: order delta metrics will be returned in the response, including: `orderDeltaMrr`, `orderDeltaTcb` and  `orderDeltaTcv`. * OrderMetrics: order metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv`, and `elp`. **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the OrderDeltaMetrics. It is recommended that all customers use the [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported. * RampMetrics: ramp metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv` metrics for each charge and each ramp interval. * RampDeltaMetrics: ramp metrics changes will be returned in the response, including: `deltaQuantity`, `deltaMrr`, `deltaTcb`, `deltaTcv` metrics for each charge and each ramp interval.  | [optional] 
 **specific_preview_thru_date** | **String** | The end date of the order preview. You can preview the invoice charges through the preview through date. (Invoice preview only)   **Note:** This field is only applicable if the 'previewThruType' field is set to 'SpecificDate'.  | [optional] 
-**charge_type_to_exclude** | [**[ChargeType]**](ChargeType.md) | The charge types to exclude from the forecast run.  | [optional] 
+**charge_type_to_exclude** | [**[ChargeType]**](ChargeType.md) | The charge types to exclude from the forecast run. | [optional]