zuora-sdk-js 3.6.0 → 3.7.0

package/src/zuora_api/model/CancelSubscriptionRequest.js

@@ -16,13 +16,13 @@ import ApiClient from '../ApiClient';
 /**
  * The CancelSubscriptionRequest model module.
  * @module model/CancelSubscriptionRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CancelSubscriptionRequest {
     /**
      * Constructs a new <code>CancelSubscriptionRequest</code>.
      * @alias module:model/CancelSubscriptionRequest
-     * @param cancellation_policy {String} Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required. 
+     * @param cancellation_policy {String} Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required.
      */
     constructor(cancellation_policy) { 
         
@@ -145,49 +145,49 @@ class CancelSubscriptionRequest {
 CancelSubscriptionRequest.RequiredProperties = ["cancellationPolicy"];
 
 /**
- * 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. 
+ * 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.
  * @member {Array.<String>} applicationOrder
  */
 CancelSubscriptionRequest.prototype['applicationOrder'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Boolean} applyCredit
  */
 CancelSubscriptionRequest.prototype['applyCredit'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Boolean} applyCreditBalance
  */
 CancelSubscriptionRequest.prototype['applyCreditBalance'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} bookingDate
  */
 CancelSubscriptionRequest.prototype['bookingDate'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} cancellationEffectiveDate
  */
 CancelSubscriptionRequest.prototype['cancellationEffectiveDate'] = undefined;
 
 /**
- * Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required. 
+ * Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required.
  * @member {String} cancellationPolicy
  */
 CancelSubscriptionRequest.prototype['cancellationPolicy'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Boolean} collect
  */
 CancelSubscriptionRequest.prototype['collect'] = undefined;
 
 /**
- * The date when the customer notifies you that they want to cancel their subscription. 
+ * The date when the customer notifies you that they want to cancel their subscription.
  * @member {String} contractEffectiveDate
  */
 CancelSubscriptionRequest.prototype['contractEffectiveDate'] = undefined;
@@ -199,7 +199,7 @@ CancelSubscriptionRequest.prototype['contractEffectiveDate'] = undefined;
 CancelSubscriptionRequest.prototype['creditMemoReasonCode'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} documentDate
  */
 CancelSubscriptionRequest.prototype['documentDate'] = undefined;
@@ -211,7 +211,7 @@ CancelSubscriptionRequest.prototype['documentDate'] = undefined;
 CancelSubscriptionRequest.prototype['invoice'] = undefined;
 
 /**
- * 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`. 
+ * 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`.
  * @member {Boolean} invoiceCollect
  */
 CancelSubscriptionRequest.prototype['invoiceCollect'] = undefined;
@@ -223,19 +223,19 @@ CancelSubscriptionRequest.prototype['invoiceCollect'] = undefined;
 CancelSubscriptionRequest.prototype['invoiceTargetDate'] = undefined;
 
 /**
- * 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.  
+ * 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. 
  * @member {String} orderDate
  */
 CancelSubscriptionRequest.prototype['orderDate'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Boolean} runBilling
  */
 CancelSubscriptionRequest.prototype['runBilling'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} targetDate
  */
 CancelSubscriptionRequest.prototype['targetDate'] = undefined;

package/src/zuora_api/model/CancelSubscriptionResponse.js

@@ -18,7 +18,7 @@ import OrderStatus from './OrderStatus';
 /**
  * The CancelSubscriptionResponse model module.
  * @module model/CancelSubscriptionResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CancelSubscriptionResponse {
     /**
@@ -169,7 +169,7 @@ class CancelSubscriptionResponse {
 CancelSubscriptionResponse.prototype['cancelledDate'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} creditMemoId
  */
 CancelSubscriptionResponse.prototype['creditMemoId'] = undefined;
@@ -205,13 +205,13 @@ CancelSubscriptionResponse.prototype['subscriptionId'] = undefined;
 CancelSubscriptionResponse.prototype['success'] = undefined;
 
 /**
- * Change in the subscription monthly recurring revenue as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants. 
+ * Change in the subscription monthly recurring revenue as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants.
  * @member {Number} totalDeltaMrr
  */
 CancelSubscriptionResponse.prototype['totalDeltaMrr'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Number} totalDeltaTcv
  */
 CancelSubscriptionResponse.prototype['totalDeltaTcv'] = undefined;

package/src/zuora_api/model/CatalogGroup.js

@@ -18,7 +18,7 @@ import CatalogGroupType from './CatalogGroupType';
 /**
  * The CatalogGroup model module.
  * @module model/CatalogGroup
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CatalogGroup {
     /**

package/src/zuora_api/model/CatalogGroupProductRatePlan.js

@@ -17,7 +17,7 @@ import CatalogGroupStatus from './CatalogGroupStatus';
 /**
  * The CatalogGroupProductRatePlan model module.
  * @module model/CatalogGroupProductRatePlan
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CatalogGroupProductRatePlan {
     /**

package/src/zuora_api/model/ChangeLogField.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The ChangeLogField model module.
  * @module model/ChangeLogField
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChangeLogField {
     /**

package/src/zuora_api/model/ChangePlanRatePlanOverride.js

@@ -18,7 +18,7 @@ import RatePlanFeatureOverride from './RatePlanFeatureOverride';
 /**
  * The ChangePlanRatePlanOverride model module.
  * @module model/ChangePlanRatePlanOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChangePlanRatePlanOverride {
     /**

package/src/zuora_api/model/ChangeSubscriptionRatePlan.js

@@ -18,7 +18,7 @@ import RatePlanObjectCustomFields from './RatePlanObjectCustomFields';
 /**
  * The ChangeSubscriptionRatePlan model module.
  * @module model/ChangeSubscriptionRatePlan
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChangeSubscriptionRatePlan {
     /**

package/src/zuora_api/model/ChargeMetrics.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The ChargeMetrics model module.
  * @module model/ChargeMetrics
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeMetrics {
     /**
@@ -143,7 +143,7 @@ ChargeMetrics.prototype['dtcv'] = undefined;
 ChargeMetrics.prototype['mrr'] = undefined;
 
 /**
- * The charge number of the subscription. Only available for update subscription. 
+ * The charge number of the subscription. Only available for update subscription.
  * @member {String} number
  */
 ChargeMetrics.prototype['number'] = undefined;

package/src/zuora_api/model/ChargeModelConfiguration.js

@@ -17,7 +17,7 @@ import ChargeModelConfigurationItem from './ChargeModelConfigurationItem';
 /**
  * The ChargeModelConfiguration model module.
  * @module model/ChargeModelConfiguration
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeModelConfiguration {
     /**

package/src/zuora_api/model/ChargeModelConfigurationForSubscription.js

@@ -16,12 +16,12 @@ import ApiClient from '../ApiClient';
 /**
  * The ChargeModelConfigurationForSubscription model module.
  * @module model/ChargeModelConfigurationForSubscription
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeModelConfigurationForSubscription {
     /**
      * Constructs a new <code>ChargeModelConfigurationForSubscription</code>.
-     * Container for charge model configuration data.  **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. These 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. 
+     * Container for charge model configuration data.   **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. These 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.
      * @alias module:model/ChargeModelConfigurationForSubscription
      */
     constructor() { 
@@ -99,19 +99,19 @@ class ChargeModelConfigurationForSubscription {
 
 
 /**
- * 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. 
+ * 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.
  * @member {String} customFieldPerUnitRate
  */
 ChargeModelConfigurationForSubscription.prototype['customFieldPerUnitRate'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} customFieldTotalAmount
  */
 ChargeModelConfigurationForSubscription.prototype['customFieldTotalAmount'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} formula
  */
 ChargeModelConfigurationForSubscription.prototype['formula'] = undefined;

package/src/zuora_api/model/ChargeModelConfigurationItem.js

@@ -16,14 +16,14 @@ import ApiClient from '../ApiClient';
 /**
  * The ChargeModelConfigurationItem model module.
  * @module model/ChargeModelConfigurationItem
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeModelConfigurationItem {
     /**
      * Constructs a new <code>ChargeModelConfigurationItem</code>.
      * @alias module:model/ChargeModelConfigurationItem
-     * @param 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.) 
-     * @param 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. 
+     * @param 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.)
+     * @param 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.
      */
     constructor(key, value) { 
         
@@ -101,13 +101,13 @@ class ChargeModelConfigurationItem {
 ChargeModelConfigurationItem.RequiredProperties = ["Key", "Value"];
 
 /**
- * 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.) 
+ * 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.)
  * @member {String} Key
  */
 ChargeModelConfigurationItem.prototype['Key'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} Value
  */
 ChargeModelConfigurationItem.prototype['Value'] = undefined;

package/src/zuora_api/model/ChargeModelDataOverride.js

@@ -18,12 +18,12 @@ import ChargeTier from './ChargeTier';
 /**
  * The ChargeModelDataOverride model module.
  * @module model/ChargeModelDataOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeModelDataOverride {
     /**
      * Constructs a new <code>ChargeModelDataOverride</code>.
-     * Container for charge model configuration data.  **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated 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. 
+     * Container for charge model configuration data.   **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated 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.
      * @alias module:model/ChargeModelDataOverride
      */
     constructor() { 
@@ -108,13 +108,13 @@ class ChargeModelDataOverride {
 ChargeModelDataOverride.prototype['chargeModelConfiguration'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Number} quantity
  */
 ChargeModelDataOverride.prototype['quantity'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Array.<module:model/ChargeTier>} tiers
  */
 ChargeModelDataOverride.prototype['tiers'] = undefined;

package/src/zuora_api/model/ChargeOverride.js

@@ -33,7 +33,7 @@ import ValidityPeriodType from './ValidityPeriodType';
 /**
  * The ChargeOverride model module.
  * @module model/ChargeOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeOverride {
     /**
@@ -539,13 +539,13 @@ ChargeOverride.prototype['taxMode'] = undefined;
 ChargeOverride.prototype['taxable'] = undefined;
 
 /**
- * This field is used to dictate the type of revenue recognition timing. 
+ * This field is used to dictate the type of revenue recognition timing.
  * @member {String} revenueRecognitionTiming
  */
 ChargeOverride.prototype['revenueRecognitionTiming'] = undefined;
 
 /**
- * This field is used to dictate the type of revenue amortization method. 
+ * This field is used to dictate the type of revenue amortization method.
  * @member {String} revenueAmortizationMethod
  */
 ChargeOverride.prototype['revenueAmortizationMethod'] = undefined;

package/src/zuora_api/model/ChargeOverrideBilling.js

@@ -21,7 +21,7 @@ import WeeklyBillCycleDay from './WeeklyBillCycleDay';
 /**
  * The ChargeOverrideBilling model module.
  * @module model/ChargeOverrideBilling
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeOverrideBilling {
     /**

package/src/zuora_api/model/ChargeOverridePricing.js

@@ -33,7 +33,7 @@ import UsageVolumePricingOverride from './UsageVolumePricingOverride';
 /**
  * The ChargeOverridePricing model module.
  * @module model/ChargeOverridePricing
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeOverridePricing {
     /**

package/src/zuora_api/model/ChargeTier.js

@@ -17,7 +17,7 @@ import PriceFormat from './PriceFormat';
 /**
  * The ChargeTier model module.
  * @module model/ChargeTier
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeTier {
     /**

package/src/zuora_api/model/ChargeUpdate.js

@@ -19,7 +19,7 @@ import TriggerParams from './TriggerParams';
 /**
  * The ChargeUpdate model module.
  * @module model/ChargeUpdate
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChargeUpdate {
     /**

package/src/zuora_api/model/ChildrenSettingValueRequest.js

@@ -17,7 +17,7 @@ import ChildrenSettingValueRequestMethod from './ChildrenSettingValueRequestMeth
 /**
  * The ChildrenSettingValueRequest model module.
  * @module model/ChildrenSettingValueRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class ChildrenSettingValueRequest {
     /**

package/src/zuora_api/model/CollectDebitMemoRequest.js

@@ -17,7 +17,7 @@ import CollectDebitMemoRequestPayment from './CollectDebitMemoRequestPayment';
 /**
  * The CollectDebitMemoRequest model module.
  * @module model/CollectDebitMemoRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CollectDebitMemoRequest {
     /**
@@ -98,13 +98,13 @@ class CollectDebitMemoRequest {
 
 
 /**
- * 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. 
+ * 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.
  * @member {Array.<String>} applicationOrder
  */
 CollectDebitMemoRequest.prototype['applicationOrder'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {Boolean} applyCredit
  * @default false
  */

package/src/zuora_api/model/CollectDebitMemoRequestPayment.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CollectDebitMemoRequestPayment model module.
  * @module model/CollectDebitMemoRequestPayment
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CollectDebitMemoRequestPayment {
     /**
@@ -92,13 +92,13 @@ class CollectDebitMemoRequestPayment {
 
 
 /**
- * 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. 
+ * 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.
  * @member {String} gatewayId
  */
 CollectDebitMemoRequestPayment.prototype['gatewayId'] = undefined;
 
 /**
- * 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. 
+ * 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.
  * @member {String} paymentMethodId
  */
 CollectDebitMemoRequestPayment.prototype['paymentMethodId'] = undefined;

package/src/zuora_api/model/CollectDebitMemoResponse.js

@@ -20,7 +20,7 @@ import CollectDebitMemoResponseProcessedPayment from './CollectDebitMemoResponse
 /**
  * The CollectDebitMemoResponse model module.
  * @module model/CollectDebitMemoResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CollectDebitMemoResponse {
     /**
@@ -124,13 +124,13 @@ class CollectDebitMemoResponse {
 
 
 /**
- * The information about which credit memo applied to the specific debit memo. 
+ * The information about which credit memo applied to the specific debit memo.
  * @member {Array.<module:model/CollectDebitMemoResponseAppliedCreditMemos>} appliedCreditMemos
  */
 CollectDebitMemoResponse.prototype['appliedCreditMemos'] = undefined;
 
 /**
- * The information about which payment applied to the specific debit memo. 
+ * The information about which payment applied to the specific debit memo.
  * @member {Array.<module:model/CollectDebitMemoResponseAppliedPayments>} appliedPayments
  */
 CollectDebitMemoResponse.prototype['appliedPayments'] = undefined;

package/src/zuora_api/model/CollectDebitMemoResponseAppliedCreditMemos.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CollectDebitMemoResponseAppliedCreditMemos model module.
  * @module model/CollectDebitMemoResponseAppliedCreditMemos
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CollectDebitMemoResponseAppliedCreditMemos {
     /**
@@ -115,7 +115,7 @@ CollectDebitMemoResponseAppliedCreditMemos.prototype['id'] = undefined;
 CollectDebitMemoResponseAppliedCreditMemos.prototype['number'] = undefined;
 
 /**
- * The unapplied amount of the credit memo after applied to the debit memo. 
+ * The unapplied amount of the credit memo after applied to the debit memo.
  * @member {Number} unappliedAmount
  */
 CollectDebitMemoResponseAppliedCreditMemos.prototype['unappliedAmount'] = undefined;

package/src/zuora_api/model/CollectDebitMemoResponseAppliedPayments.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CollectDebitMemoResponseAppliedPayments model module.
  * @module model/CollectDebitMemoResponseAppliedPayments
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CollectDebitMemoResponseAppliedPayments {
     /**

package/src/zuora_api/model/CollectDebitMemoResponseDebitMemo.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CollectDebitMemoResponseDebitMemo model module.
  * @module model/CollectDebitMemoResponseDebitMemo
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CollectDebitMemoResponseDebitMemo {
     /**

package/src/zuora_api/model/CollectDebitMemoResponseProcessedPayment.js

@@ -17,7 +17,7 @@ import CollectDebitMemoResponseProcessedPaymentStatus from './CollectDebitMemoRe
 /**
  * The CollectDebitMemoResponseProcessedPayment model module.
  * @module model/CollectDebitMemoResponseProcessedPayment
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CollectDebitMemoResponseProcessedPayment {
     /**

package/src/zuora_api/model/CommonErrorResponse.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CommonErrorResponse model module.
  * @module model/CommonErrorResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CommonErrorResponse {
     /**

package/src/zuora_api/model/CommonResponse.js

@@ -17,7 +17,7 @@ import FailedReason from './FailedReason';
 /**
  * The CommonResponse model module.
  * @module model/CommonResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CommonResponse {
     /**
@@ -131,8 +131,9 @@ CommonResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-CommonResponse.prototype['success'] = undefined;
+CommonResponse.prototype['success'] = true;
 
 
 

package/src/zuora_api/model/CompareAndDeployProductCatalogTemplateRequest.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CompareAndDeployProductCatalogTemplateRequest model module.
  * @module model/CompareAndDeployProductCatalogTemplateRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CompareAndDeployProductCatalogTemplateRequest {
     /**