zuora-sdk-js 3.6.0 → 3.7.0

package/docs/BusinessRegionsResponse.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]
 **id** | **String** | The unique ID of the e-invoicing business region.  | [optional] 
 **country** | **String** | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes\" target=\"_blank\">ISO Standard Country Codes</a>.  | [optional] 
 **business_name** | **String** | The full official name that the Seller is registered with the relevant legal authority.  | [optional] 
@@ -36,6 +36,7 @@ Name | Type | Description | Notes
 **invoice_enabled** | **Boolean** | It will control that whether the invoice should be supported by the process type or not.  | [optional] 
 **credit_memo_enabled** | **Boolean** | It will control that whether the credit memo should be supported by the process type or not.  | [optional] 
 **debit_memo_enabled** | **Boolean** | It will control that whether the debit memo should be supported by the process type or not.  | [optional] 
+**file_format** | **Object** |  | [optional] 
 
 
 

package/docs/CancelAuthorizationRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **account_id** | **String** | The ID of the customer account. This field is generally required, but is optional if you are using the Ingenico ePayments gateway. | [optional] 
 **account_number** | **String** | The number of the customer account. This field is generally required, but is optional if you are using the Ingenico ePayments gateway. | [optional] 
 **gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
-**gateway_order_id** | **String** | The order ID for the specific gateway.  The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.  | 
+**gateway_order_id** | **String** | The order ID for the specific gateway.   The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field. | 
 **payment_gateway_id** | **String** | The ID of the payment gateway instance. This field is required if you do not specify the `accountId` and `accountNumber` fields. | [optional] 
 **transaction_id** | **String** | The ID of the transaction. | 
 

package/docs/CancelAuthorizationResponse.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**gateway_order_id** | **String** | The order ID for the specific gateway.  The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.  | [optional] 
-**result_code** | **String** | The result code of the request.   0 indicates that the request succeeded, and the following values indicate that the request failed:   - 1: The request is declined.   - 7: The field format is not correct.   - 10: Client connection has timed out.   - 11: Host connection has timed out.   - 12: Processor connection has timed out.   - 13: Gateway server is busy.   - 20: The card type is not supported.   - 21: The merchant account information is invalid.   - 22: A generic error occurred on the processor.   - 40: The card type has not been set up yet.   - 41: The limit for a single transaction is exceeded.   - 42: Address checking failed.   - 43: Card security code checking failed.   - 44: Failed due to the gateway security setting.   - 45: Fraud protection is declined.   - 46: Address checking or card security code checking failed (for Authorize.net gateway only).   - 47: The maximum amount is exceeded (for Authorize.net gateway only).   - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).   - 49: Card security code checking failed (for Authorize.net gateway only).   - 60: User authentication failed.   - 61: The currency code is invalid.   - 62: The transaction ID is invalid.   - 63: The credit card number is invalid.   - 64: The card expiration date is invalid.   - 65: The transaction is duplicated.   - 66: Credit transaction error.   - 67: Void transaction error.   - 90: A valid amount is required.   - 91: The BA code is invalid.   - 92: The account number is invalid.   - 93: The ACH transaction is not accepted by the merchant.   - 94: An error occurred for the ACH transaction.   - 95: The version parameter is invalid.   - 96: The transaction type is invalid.   - 97: The transaction method is invalid.   - 98: The bank account type is invalid.   - 99: The authorization code is invalid.   - 200: General transaction error.   - 500: The transaction is queued for submission.   - 999: Unknown error.   - -1: An error occurred in gateway communication.   - -2: Idempotency is not supported.   - -3: Inquiry call is not supported.  | [optional] 
+**gateway_order_id** | **String** | The order ID for the specific gateway.   The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field. | [optional] 
+**result_code** | **String** | The result code of the request.    0 indicates that the request succeeded, and the following values indicate that the request failed:   - 1: The request is declined.   - 7: The field format is not correct.   - 10: Client connection has timed out.   - 11: Host connection has timed out.   - 12: Processor connection has timed out.   - 13: Gateway server is busy.   - 20: The card type is not supported.   - 21: The merchant account information is invalid.   - 22: A generic error occurred on the processor.   - 40: The card type has not been set up yet.   - 41: The limit for a single transaction is exceeded.   - 42: Address checking failed.   - 43: Card security code checking failed.   - 44: Failed due to the gateway security setting.   - 45: Fraud protection is declined.   - 46: Address checking or card security code checking failed (for Authorize.net gateway only).   - 47: The maximum amount is exceeded (for Authorize.net gateway only).   - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).   - 49: Card security code checking failed (for Authorize.net gateway only).   - 60: User authentication failed.   - 61: The currency code is invalid.   - 62: The transaction ID is invalid.   - 63: The credit card number is invalid.   - 64: The card expiration date is invalid.   - 65: The transaction is duplicated.   - 66: Credit transaction error.   - 67: Void transaction error.   - 90: A valid amount is required.   - 91: The BA code is invalid.   - 92: The account number is invalid.   - 93: The ACH transaction is not accepted by the merchant.   - 94: An error occurred for the ACH transaction.   - 95: The version parameter is invalid.   - 96: The transaction type is invalid.   - 97: The transaction method is invalid.   - 98: The bank account type is invalid.   - 99: The authorization code is invalid.   - 200: General transaction error.   - 500: The transaction is queued for submission.   - 999: Unknown error.   - -1: An error occurred in gateway communication.   - -2: Idempotency is not supported.   - -3: Inquiry call is not supported. | [optional] 
 **result_message** | **String** | The corresponding request ID. | [optional] 
 **success** | **Boolean** | Indicates whether the call succeeded. | [optional] 
 **transaction_id** | **String** | The ID of the transaction. | [optional] 

package/docs/CancelBillRunRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**cancel_once** | **Boolean** | Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run.  | [optional] [default to true]
+**cancel_once** | **Boolean** | Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run. | [optional] [default to true]
 
 

package/docs/CancelBillRunResponse.md

@@ -7,27 +7,27 @@ 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]
 **id** | **String** | The unique ID of the bill run.  | [optional] 
 **name** | **String** | The name of the bill run.  | [optional] 
 **bill_run_number** | **String** | The number of the bill run.  | [optional] 
-**batches** | **[String]** | The batch of accounts for this bill run, this field can not exist with `billRunFilters` together.  **Values:** `AllBatches` or an array of `Batch`*n* where *n* is a number between 1 and 50, for example, `Batch7`.  | [optional] 
-**bill_cycle_day** | **String** | The day of the bill cycle, this field is only valid when `batches` is specified.  **Values:**  - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run  | [optional] 
+**batches** | **[String]** | The batch of accounts for this bill run, this field can not exist with `billRunFilters` together.   **Values:** `AllBatches` or an array of `Batch`*n* where *n* is a number between 1 and 50, for example, `Batch7`. | [optional] 
+**bill_cycle_day** | **String** | The day of the bill cycle, this field is only valid when `batches` is specified.   **Values:**   - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run  - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run | [optional] 
 **bill_run_filters** | [**[BillRunFilter]**](BillRunFilter.md) | The target account or subscriptions for this bill run.  | [optional] 
-**charge_type_to_exclude** | [**[ChargeType]**](ChargeType.md) | The types of the charges to be excluded from the generation of billing documents.  | [optional] 
+**charge_type_to_exclude** | [**[ChargeType]**](ChargeType.md) | The types of the charges to be excluded from the generation of billing documents. | [optional] 
 **auto_email** | **Boolean** | Whether to automatically send emails after Auto-Post is complete.  | [optional] 
-**auto_post** | **Boolean** | Whether to automatically post the bill run after the bill run is created.  | [optional] 
-**auto_renewal** | **Boolean** | Whether to automatically renew auto-renew subscriptions that are up for renewal.  | [optional] 
-**no_email_for_zero_amount_invoice** | **Boolean** | Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete.  | [optional] 
+**auto_post** | **Boolean** | Whether to automatically post the bill run after the bill run is created. | [optional] 
+**auto_renewal** | **Boolean** | Whether to automatically renew auto-renew subscriptions that are up for renewal. | [optional] 
+**no_email_for_zero_amount_invoice** | **Boolean** | Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. | [optional] 
 **schedule** | [**BillRunSchedule**](BillRunSchedule.md) |  | [optional] 
 **scheduled_execution_time** | **String** | The scheduled execution time for a bill run.  | [optional] 
 **status** | [**BillRunStatus**](BillRunStatus.md) |  | [optional] 
 **invoice_date** | **String** | The invoice date for this bill run, only valid for ad-hoc bill runs.  | [optional] 
-**invoice_date_offset** | **Number** | The offset compared to bill run execution date, only valid for scheduled bill runs.  | [optional] 
+**invoice_date_offset** | **Number** | The offset compared to bill run execution date, only valid for scheduled bill runs. | [optional] 
 **invoice_date_month_offset** | **Number** | The month offset of invoice date for this bill run based on run date, only valid for monthly scheduled bill runs. invoiceDateOffset and invoiceDateMonthOffset/invoiceDateDayOfMonth are mutually exclusive. invoiceDateMonthOffset and invoiceDateDayOfMonth coexist.  | [optional] 
 **invoice_date_day_of_month** | **Number** | The day of month of invoice date for this bill run, only valid for monthly scheduled bill runs. The value is between 1 and 31, where 31 = end-of-month. invoiceDateOffset and invoiceDateMonthOffset/invoiceDateDayOfMonth are mutually exclusive. invoiceDateMonthOffset and invoiceDateDayOfMonth coexist.  | [optional] 
 **target_date** | **String** | The target date for this bill run, only valid for ad-hoc bill runs.  | [optional] 
-**target_date_offset** | **Number** | The offset compared to bill run execution date, only valid for scheduled bill runs.  | [optional] 
+**target_date_offset** | **Number** | The offset compared to bill run execution date, only valid for scheduled bill runs. | [optional] 
 **target_date_month_offset** | **Number** | The month offset of target date for this bill run based on run date, only valid for monthly scheduled bill runs. targetDateOffset and targetDateMonthOffset/targetDateDayOfMonth are mutually exclusive. targetDateMonthOffset and targetDateDayOfMonth coexist.  | [optional] 
 **target_date_day_of_month** | **Number** | The day of month of target date for this bill run, only valid for monthly scheduled bill runs. The value is between 1 and 31, where 31 = end-of-month. targetDateOffset and targetDateMonthOffset/targetDateDayOfMonth are mutually exclusive. targetDateMonthOffset and targetDateDayOfMonth coexist.  | [optional] 
 **include_subscriptions** | **Boolean** | Whether to bill subscriptions.  | [optional] 

package/docs/CancelBillingAdjustmentRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**debit_memo_custom_fields** | **{String: Object}** | Container for custom fields of the Debit Memo. The custom fields of the Debit Memo can be defined during Cancel Adjustment  | [optional] 
+**debit_memo_custom_fields** | **{String: Object}** | Container for custom fields of the Debit Memo. The custom fields of the Debit Memo can be defined during Cancel Adjustment | [optional] 
 
 

package/docs/CancelBillingAdjustmentResponse.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]
 **debit_memo_number** | **String** | The Debit Memo generated for the cancelled adjustment.         | [optional] 
 
 

package/docs/CancelOrderResponse.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]
 **account_number** | **String** | The account number for the order. | [optional] 
 **cancel_reason** | **String** | The reason for cancelling the order. | [optional] 
 **order_number** | **String** | The order number of the order created. | [optional] 

package/docs/CancelSubscriptionRequest.md

@@ -4,21 +4,21 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.  | [optional] 
-**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.  **Note:** This field 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.  | [optional] 
-**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.  If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.   To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.  Prerequisite: `invoice` must be `true`.   **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled.  | [optional] 
-**booking_date** | **String** | The booking date that you want to set for the amendment contract when you cancel the subscription. The default value is the current date when you make the API call.  | [optional] 
-**cancellation_effective_date** | **String** | Date the cancellation takes effect, in the format yyyy-mm-dd.  Use only if `cancellationPolicy` is `SpecificDate`. Should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced.  | [optional] 
-**cancellation_policy** | **String** | Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required.  | 
-**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.  If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.  Prerequisite: The `invoice` or `runBilling` field must be `true`.   **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later.  | [optional] 
-**contract_effective_date** | **String** | The date when the customer notifies you that they want to cancel their subscription.  | [optional] 
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. | [optional] 
+**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.   **Note:** This field 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. | [optional] 
+**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.   If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.    To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.   Prerequisite: `invoice` must be `true`.    **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled. | [optional] 
+**booking_date** | **String** | The booking date that you want to set for the amendment contract when you cancel the subscription. The default value is the current date when you make the API call. | [optional] 
+**cancellation_effective_date** | **String** | Date the cancellation takes effect, in the format yyyy-mm-dd.  Use only if `cancellationPolicy` is `SpecificDate`. Should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced. | [optional] 
+**cancellation_policy** | **String** | Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required. | 
+**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.   Prerequisite: The `invoice` or `runBilling` field must be `true`.    **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later. | [optional] 
+**contract_effective_date** | **String** | The date when the customer notifies you that they want to cancel their subscription. | [optional] 
 **credit_memo_reason_code** | **String** | A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. | [optional] 
-**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. | [optional] 
 **invoice** | **Boolean** | **Note:** This field has been replaced by the `runBilling` field. The `invoice` field is only available for backward compatibility.   Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, an invoice is created. If the value is `false`, no action is taken. The default value is `false`.    This field is in Zuora REST API version control. Supported minor versions are `196.0` and `207.0`. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.  | [optional] 
-**invoice_collect** | **Boolean** | This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility.  If this field is set to `true`, an invoice is generated and payment automatically collected.  **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.  | [optional] 
+**invoice_collect** | **Boolean** | This field has been replaced by the `invoice` field and the  `collect` field. `invoiceCollect` is available only for backward compatibility.   If this field is set to `true`, an invoice is generated and payment automatically collected.   **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. | [optional] 
 **invoice_target_date** | **String** | **Note:** This field has been replaced by the `targetDate` field. The `invoiceTargetDate` field is only available for backward compatibility.   Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   This field is in Zuora REST API version control. Supported minor versions are `207.0` and earlier.  | [optional] 
-**order_date** | **String** | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers.   | [optional] 
-**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).     The billing documents generated in this operation is only for this subscription, not for the entire customer account.   Possible values:  - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.   - `false`: No invoice is created.   **Note:** This field is in Zuora REST API version control. Supported minor versions are `211.0` or later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.   **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.   This field is in Zuora REST API version control. Supported minor versions are `211.0` and later. To use this field in the method, you must set the  `zuora-version` parameter to the minor version number in the request header.  | [optional] 
+**order_date** | **String** | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.  This field must be in the `yyyy-mm-dd` format.  This field is required for Orders customers only, not applicable to Orders Harmonization customers.  | [optional] 
+**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).      The billing documents generated  in this operation is only for this subscription, not for the entire  customer account.    Possible values:   - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.    - `false`: No invoice is created.    **Note:** This field is in Zuora REST API version control. Supported  minor versions are `211.0` or later. To use this field in the method,  you must set the `zuora-version` parameter to the minor version number  in the request header. | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as  yyyy-mm-dd. Default is current date.    **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.    This field is in Zuora REST API version control. Supported minor  versions are `211.0` and later. To use this field in the method, you  must set the  `zuora-version` parameter to the minor version number in  the request header. | [optional] 
 
 

package/docs/CancelSubscriptionResponse.md

@@ -5,14 +5,14 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cancelled_date** | **String** | The date that the subscription was canceled. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
-**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.  **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and 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.  | [optional] 
+**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.   **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and 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. | [optional] 
 **invoice_id** | **String** | ID of the invoice, if one is generated.  | [optional] 
 **paid_amount** | **Number** | Amount paid.  | [optional] 
 **payment_id** | **String** | ID of the payment, if a payment is collected.  | [optional] 
 **subscription_id** | **String** | The subscription ID. It is available for Orders Harmonization and Subscribe/Amend Tenants.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
-**total_delta_mrr** | **Number** | Change in the subscription monthly recurring revenue as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
-**total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
+**total_delta_mrr** | **Number** | Change in the subscription monthly recurring revenue as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants. | [optional] 
+**total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants. | [optional] 
 **order_number** | **String** | The order number. It is available for Orders Tenants.  | [optional] 
 **status** | [**OrderStatus**](OrderStatus.md) |  | [optional] 
 **account_number** | **String** | The account number that this order has been created under. This is also the invoice owner of the subscriptions included in this order. It is available for Orders Tenants. | [optional] 

package/docs/CatalogGroupsApi.md

@@ -96,7 +96,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.CatalogGroupsApi();
-let catalog_group_key = "catalog_group_key_example"; // String | The unique number or ID of the catalog group to be deleted. 
+let catalog_group_key = "catalog_group_key_example"; // String | The unique number or ID of the catalog group to be deleted.
 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. 
@@ -119,7 +119,7 @@ apiInstance.deleteCatalogGroup(catalog_group_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **catalog_group_key** | **String**| The unique number or ID of the catalog group to be deleted.  | 
+ **catalog_group_key** | **String**| The unique number or ID of the catalog group to be deleted. | 
  **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.CatalogGroupsApi();
-let catalog_group_key = "catalog_group_key_example"; // String | The unique number or ID of the catalog group to be retrieved. 
+let catalog_group_key = "catalog_group_key_example"; // String | The unique number or ID of the catalog group to be retrieved.
 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.getCatalogGroup(catalog_group_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **catalog_group_key** | **String**| The unique number or ID of the catalog group to be retrieved.  | 
+ **catalog_group_key** | **String**| The unique number or ID of the catalog group to be retrieved. | 
  **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] 

package/docs/ChargeMetrics.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **dmrr** | **Number** | Change in monthly recurring revenue.  | [optional] 
 **dtcv** | **Number** | Change in total contract value.  | [optional] 
 **mrr** | **Number** | Monthly recurring revenue.  | [optional] 
-**number** | **String** | The charge number of the subscription. Only available for update subscription.  | [optional] 
+**number** | **String** | The charge number of the subscription. Only available for update subscription. | [optional] 
 **origin_rate_plan_id** | **String** | The origin rate plan ID. Only available for update subscription.  | [optional] 
 **original_id** | **String** | The original rate plan charge ID. Only available for update subscription.  | [optional] 
 **product_rate_plan_charge_id** | **String** | The product rate plan charge ID.  | [optional] 

package/docs/ChargeModelConfigurationForSubscription.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**custom_field_per_unit_rate** | **String** | The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`.      This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | [optional] 
-**custom_field_total_amount** | **String** | The custom field that carries the total amount to charge for a usage record. For example, `totalAmount__c`.       This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | [optional] 
-**formula** | **String** | The pricing formula to calculate actual rating amount for each usage record.  This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | [optional] 
+**custom_field_per_unit_rate** | **String** | The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`.      This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | [optional] 
+**custom_field_total_amount** | **String** | The custom field that carries the total amount to charge for a usage record. For example, `totalAmount__c`.       This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | [optional] 
+**formula** | **String** | The pricing formula to calculate actual rating amount for each usage record.   This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | [optional] 
 
 

package/docs/ChargeModelConfigurationItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**key** | **String** | The name of the field that is specified for a specific charge model.  Configuration keys supported are as follows:  * `formula` (only available if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.) * `customFieldPerUnitRate` (only available if you have the Pre-Rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.) * `customFieldTotalAmount` (only available if you have the Pre-Rated Pricing model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)  | 
-**value** | **String** | The value of the field that is specified in the `Key` field.  Possible values are follows:  * A valid pricing formula to calculate actual rating amount for each usage record. For example, `usageQuantity()*10`. Use it with Key `formula` when the Multi-Attribute Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. * A name of a usage custom field that carries the per-unit rate for a usage record. For example, `perUnitRate__c`. Use it with Key `customFieldPerUnitRate` when the Pre-Rated Per Unit Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. * A name of a usage custom field that carries the total amount for a usage record. For example, `totalAmount__c`. Use it with Key `customFieldTotalAmount` when the Pre-Rated Pricing model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | 
+**key** | **String** | The name of the field that is specified for a specific charge model.   Configuration keys supported are as follows:   * `formula` (only available if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)  * `customFieldPerUnitRate` (only available if you have the Pre-Rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)  * `customFieldTotalAmount` (only available if you have the Pre-Rated Pricing model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.) | 
+**value** | **String** | The value of the field that is specified in the `Key` field.   Possible values are follows:   * A valid pricing formula to calculate actual rating amount for each usage record. For example, `usageQuantity()*10`. Use it with Key `formula` when the Multi-Attribute Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  * A name of a usage custom field that carries the per-unit rate for a usage record. For example, `perUnitRate__c`. Use it with Key `customFieldPerUnitRate` when the Pre-Rated Per Unit Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  * A name of a usage custom field that carries the total amount for a usage record. For example, `totalAmount__c`. Use it with Key `customFieldTotalAmount` when the Pre-Rated Pricing model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | 
 
 

package/docs/ChargeModelDataOverride.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_model_configuration** | [**ChargeModelConfigurationForSubscription**](ChargeModelConfigurationForSubscription.md) |  | [optional] 
-**quantity** | **Number** | Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the `quantity()` function.  This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model.  | [optional] 
-**tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.  **Note**: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | [optional] 
+**quantity** | **Number** | Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the `quantity()` function.   This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model. | [optional] 
+**tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.   **Note**: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | [optional] 
 
 

package/docs/ChargeOverride.md

@@ -23,8 +23,8 @@ Name | Type | Description | Notes
 **tax_code** | **String** | The taxCode of a charge. This field is available when the field 'taxable' is set to true.  | [optional] 
 **tax_mode** | [**TaxMode**](TaxMode.md) |  | [optional] 
 **taxable** | **Boolean** | The flag to indicate whether the charge is taxable. If this field is set to true, both the fields `taxCode` and `taxMode` are required.  | [optional] 
-**revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing.  | [optional] 
-**revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method.  | [optional] 
+**revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing. | [optional] 
+**revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method. | [optional] 
 **is_charge_level_min_commit** | **Boolean** | The flag to indicate whether the charge is charge level min commit.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 **commitment_type** | [**CommitmentType**](CommitmentType.md) |  | [optional] 
 **prepaid_operation_type** | [**PrepaidOperationType**](PrepaidOperationType.md) |  | [optional] 

package/docs/CollectDebitMemoRequest.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to the debit memo. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply the debit memo.  | [optional] 
-**apply_credit** | **Boolean** | Whether to automatically apply credit memos or unapplied payments, or both to the debit memo. If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the debit memo. If no value is specified or the value is `false`, no action is taken.  | [optional] [default to false]
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to the debit memo. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply the debit memo. | [optional] 
+**apply_credit** | **Boolean** | Whether to automatically apply credit memos or unapplied payments, or both to the debit memo.  If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the debit memo. If no value is specified or the value is `false`, no action is taken. | [optional] [default to false]
 **collect** | **Boolean** | Indicates if the current request needs to collect payment or not.  | [optional] [default to false]
 **payment** | [**CollectDebitMemoRequestPayment**](CollectDebitMemoRequestPayment.md) |  | [optional] 
 

package/docs/CollectDebitMemoRequestPayment.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**gateway_id** | **String** | The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method. If no gateway ID is specified in the request body, the default gateway for the customer account is used automatically, if this default one is not configured, the default gateway of the tenant would be used.  | [optional] 
-**payment_method_id** | **String** | The unique ID of the payment method that the customer used to make the payment. If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.  | [optional] 
+**gateway_id** | **String** | The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method.  If no gateway ID is specified in the request body, the default gateway for the customer account is used automatically, if this default one is not configured, the default gateway of the tenant would be used. | [optional] 
+**payment_method_id** | **String** | The unique ID of the payment method that the customer used to make the payment.  If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs. | [optional] 
 
 

package/docs/CollectDebitMemoResponse.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**applied_credit_memos** | [**[CollectDebitMemoResponseAppliedCreditMemos]**](CollectDebitMemoResponseAppliedCreditMemos.md) | The information about which credit memo applied to the specific debit memo.  | [optional] 
-**applied_payments** | [**[CollectDebitMemoResponseAppliedPayments]**](CollectDebitMemoResponseAppliedPayments.md) | The information about which payment applied to the specific debit memo.  | [optional] 
+**applied_credit_memos** | [**[CollectDebitMemoResponseAppliedCreditMemos]**](CollectDebitMemoResponseAppliedCreditMemos.md) | The information about which credit memo applied to the specific debit memo. | [optional] 
+**applied_payments** | [**[CollectDebitMemoResponseAppliedPayments]**](CollectDebitMemoResponseAppliedPayments.md) | The information about which payment applied to the specific debit memo. | [optional] 
 **debit_memo** | [**CollectDebitMemoResponseDebitMemo**](CollectDebitMemoResponseDebitMemo.md) |  | [optional] 
 **processed_payment** | [**CollectDebitMemoResponseProcessedPayment**](CollectDebitMemoResponseProcessedPayment.md) |  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 

package/docs/CollectDebitMemoResponseAppliedCreditMemos.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **applied_amount** | **Number** | The applied amount of the credit memo to the debit memo.  | [optional] 
 **id** | **String** | The unique ID of the credit memo.  | [optional] 
 **number** | **String** | The unique identification number of the credit memo.  | [optional] 
-**unapplied_amount** | **Number** | The unapplied amount of the credit memo after applied to the debit memo.  | [optional] 
+**unapplied_amount** | **Number** | The unapplied amount of the credit memo after applied to the debit memo. | [optional] 
 
 

package/docs/CommonResponse.md

@@ -7,6 +7,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/Condition.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conditions** | [**[Condition]**](Condition.md) | The conditions will be combined by the relation.  | [optional] 
 **field** | **String** | The field name of a single condition.  | [optional] 
-**operator** | **String** | The operator of a single condition. - eq: equal, field = value - neq: not equal, field != value - gt: greater than, field > value - lt: less than, field < value - gte: greater than or equal, field >= value - lte: less than or equal, field <= value - lk: like, field like value - in: in, field in value, multiple values are separated by comma - nl: null, field is null - nnl: not null, field is not null  | [optional] 
+**operator** | **String** | The operator of a single condition.  - eq: equal, field = value - neq: not equal, field != value - gt: greater than, field > value - lt: less than, field < value - gte: greater than or equal, field >= value - lte: less than or equal, field <= value - lk: like, field like value - in: in, field in value, multiple values are separated by comma - nl: null, field is null - nnl: not null, field is not null | [optional] 
 **relation** | **String** | The relation among the conditions.  | [optional] 
 **value** | **String** | The value of a single condition.  | [optional] 
 

package/docs/Contact.md

@@ -7,12 +7,12 @@ Name | Type | Description | Notes
 **id** | **String** | The ID of the contact.  | [optional] 
 **account_id** | **String** | The ID of the account associated with the contact.  | [optional] 
 **account_number** | **String** | The number of the customer account associated with the contact.  | [optional] 
-**address1** | **String** | The first line of the contact's address, which is often a street address or business name.  | [optional] 
+**address1** | **String** | The first line of the contact's address, which is often a street address or business name. | [optional] 
 **address2** | **String** | The second line of the contact's address.  | [optional] 
 **city** | **String** | The city of the contact's address.  | [optional] 
 **contact_description** | **String** | A description for the contact.  | [optional] 
 **country** | **String** | The country of the contact's address.  | [optional] 
-**county** | **String** | The county. May optionally be used by Zuora Tax to calculate county tax.  | [optional] 
+**county** | **String** | The county. May optionally be used by Zuora Tax to calculate county tax. | [optional] 
 **fax** | **String** | The contact's fax number.  | [optional] 
 **first_name** | **String** | The contact's first name.  | [optional] 
 **home_phone** | **String** | The contact's home phone number.  | [optional] 
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 **personal_email** | **String** | The contact's personal email address.  | [optional] 
 **state** | **String** | The state or province of the contact's address.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
-**tax_region** | **String** | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.  | [optional] 
+**tax_region** | **String** | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. | [optional] 
 **work_email** | **String** | The contact's business email address.  | [optional] 
 **work_phone** | **String** | The contact's business phone number.  | [optional] 
 **zip_code** | **String** | The zip code for the contact's address.  | [optional] 

package/docs/ContactInfo.md

@@ -4,25 +4,25 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**address1** | **String** | First line of the contact's address. This is often a street address or a business name.  | [optional] 
+**address1** | **String** | First line of the contact's address. This is often a street address or a business name. | [optional] 
 **address2** | **String** | Second line of the contact's address.  | [optional] 
 **city** | **String** | City of the contact's address.  | [optional] 
 **contact_description** | **String** | A description for the contact.  | [optional] 
-**country** | **String** | Country; must be a valid country name or abbreviation. If using [Zuora Tax](https://knowledgecenter.zuora.com/Zuora_Billing/Taxes/A_Zuora_Tax), you must specify a country in the bill-to contact to calculate tax.  | [optional] 
+**country** | **String** | Country; must be a valid country name or abbreviation. If using [Zuora Tax](https://knowledgecenter.zuora.com/Zuora_Billing/Taxes/A_Zuora_Tax), you must specify a country in the bill-to contact to calculate tax. | [optional] 
 **county** | **String** | County of the contact's address.  | [optional] 
-**custom_fields** | **{String: Object}** | Custom fields of the Account object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.  | [optional] 
+**custom_fields** | **{String: Object}** | Custom fields of the Account object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information. | [optional] 
 **fax** | **String** | Fax number of the contact.  | [optional] 
 **first_name** | **String** | First name of the contact.  | 
 **home_phone** | **String** | Home phone number of the contact.  | [optional] 
 **last_name** | **String** |  | 
 **mobile_phone** | **String** | Mobile phone number of the contact.  | [optional] 
 **nickname** | **String** | Nickname of the contact.  | [optional] 
-**other_phone** | **String** | Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.  | [optional] 
+**other_phone** | **String** | Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number. | [optional] 
 **other_phone_type** | [**PhoneType**](PhoneType.md) |  | [optional] 
 **personal_email** | **String** | Personal email address of the contact.  | [optional] 
 **postal_code** | **String** | ZIP code or other postal code of the contact's address.  | [optional] 
 **state** | **String** | State or province of the contact's address.  | [optional] 
-**tax_region** | **String** | Region defined in your taxation rules. Only applicable if you use Zuora Tax.  | [optional] 
+**tax_region** | **String** | Region defined in your taxation rules. Only applicable if you use Zuora Tax. | [optional] 
 **work_email** | **String** | Business email address of the contact.  | [optional] 
 **work_phone** | **String** | Business phone number of the contact.  | [optional] 
 

package/docs/ContactResponse.md

@@ -11,12 +11,12 @@ Name | Type | Description | Notes
 **id** | **String** | The ID of the contact.  | [optional] 
 **account_id** | **String** | The ID of the account associated with the contact.  | [optional] 
 **account_number** | **String** | The number of the customer account associated with the contact.  | [optional] 
-**address1** | **String** | The first line of the contact's address, which is often a street address or business name.  | [optional] 
+**address1** | **String** | The first line of the contact's address, which is often a street address or business name. | [optional] 
 **address2** | **String** | The second line of the contact's address.  | [optional] 
 **city** | **String** | The city of the contact's address.  | [optional] 
 **contact_description** | **String** | A description for the contact.  | [optional] 
 **country** | **String** | The country of the contact's address.  | [optional] 
-**county** | **String** | The county. May optionally be used by Zuora Tax to calculate county tax.  | [optional] 
+**county** | **String** | The county. May optionally be used by Zuora Tax to calculate county tax. | [optional] 
 **fax** | **String** | The contact's fax number.  | [optional] 
 **first_name** | **String** | The contact's first name.  | [optional] 
 **home_phone** | **String** | The contact's home phone number.  | [optional] 
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
 **other_phone_type** | [**PhoneType**](PhoneType.md) |  | [optional] 
 **personal_email** | **String** | The contact's personal email address.  | [optional] 
 **state** | **String** | The state or province of the contact's address.  | [optional] 
-**tax_region** | **String** | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.  | [optional] 
+**tax_region** | **String** | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. | [optional] 
 **work_email** | **String** | The contact's business email address.  | [optional] 
 **work_phone** | **String** | The contact's business phone number.  | [optional] 
 **zip_code** | **String** | The zip code for the contact's address.  | [optional] 

package/docs/ContactSnapshot.md

@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**address1** | **String** | The first line for the address of the contact, which is often a street address or business name.  | [optional] 
-**address2** | **String** | The second line for the address of the contact, which is mostly the locality.  | [optional] 
+**address1** | **String** | The first line for the address of the contact, which is often a street address or business name. | [optional] 
+**address2** | **String** | The second line for the address of the contact, which is mostly the locality. | [optional] 
 **city** | **String** | The city for the address of the contact.  | [optional] 
 **contact_id** | **String** | The Zuora ID of the contact who the snapshot belongs to.  | [optional] 
 **country** | **String** | The country for the address of the contact.  | [optional] 
-**county** | **String** | The county for the address of the contact. The field value might optionally be used by Zuora Tax to calculate county tax.  | [optional] 
+**county** | **String** | The county for the address of the contact. The field value might optionally be used by Zuora Tax to calculate county tax. | [optional] 
 **description** | **String** | A description of the contact.  | [optional] 
 **fax** | **String** | The fax number of the contact.  | [optional] 
 **first_name** | **String** | The first name of the contact.  | [optional] 

package/docs/ContactSnapshotResponse.md

@@ -7,13 +7,13 @@ 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] 
-**address1** | **String** | The first line for the address of the contact, which is often a street address or business name.  | [optional] 
-**address2** | **String** | The second line for the address of the contact, which is mostly the locality.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
+**address1** | **String** | The first line for the address of the contact, which is often a street address or business name. | [optional] 
+**address2** | **String** | The second line for the address of the contact, which is mostly the locality. | [optional] 
 **city** | **String** | The city for the address of the contact.  | [optional] 
 **contact_id** | **String** | The Zuora ID of the contact who the snapshot belongs to.  | [optional] 
 **country** | **String** | The country for the address of the contact.  | [optional] 
-**county** | **String** | The county for the address of the contact. The field value might optionally be used by Zuora Tax to calculate county tax.  | [optional] 
+**county** | **String** | The county for the address of the contact. The field value might optionally be used by Zuora Tax to calculate county tax. | [optional] 
 **description** | **String** | A description of the contact.  | [optional] 
 **fax** | **String** | The fax number of the contact.  | [optional] 
 **first_name** | **String** | The first name of the contact.  | [optional] 

package/docs/ContactSnapshotsApi.md

@@ -26,7 +26,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.ContactSnapshotsApi();
-let contact_snapshot_id = "contact_snapshot_id_example"; // String | The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab. 
+let contact_snapshot_id = "contact_snapshot_id_example"; // String | The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab.
 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. 
@@ -51,7 +51,7 @@ apiInstance.getContactSnapshot(contact_snapshot_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **contact_snapshot_id** | **String**| The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab.  | 
+ **contact_snapshot_id** | **String**| The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab. | 
  **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]