zuora-sdk-js 3.6.0 → 3.7.0

package/src/zuora_api/model/PreviewOrderChargeOverride.js

@@ -24,7 +24,7 @@ import ValidityPeriodType from './ValidityPeriodType';
 /**
  * The PreviewOrderChargeOverride model module.
  * @module model/PreviewOrderChargeOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderChargeOverride {
     /**
@@ -372,7 +372,7 @@ PreviewOrderChargeOverride.prototype['uniqueToken'] = undefined;
 PreviewOrderChargeOverride.prototype['validityPeriodType'] = undefined;
 
 /**
- * The taxCode of a charge. This field is available when the field `taxable` is set to true.  
+ * The taxCode of a charge. This field is available when the field `taxable` is set to true. 
  * @member {String} taxCode
  */
 PreviewOrderChargeOverride.prototype['taxCode'] = undefined;

package/src/zuora_api/model/PreviewOrderChargeUpdate.js

@@ -19,7 +19,7 @@ import TriggerParams from './TriggerParams';
 /**
  * The PreviewOrderChargeUpdate model module.
  * @module model/PreviewOrderChargeUpdate
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderChargeUpdate {
     /**
@@ -150,7 +150,7 @@ class PreviewOrderChargeUpdate {
 PreviewOrderChargeUpdate.prototype['billing'] = undefined;
 
 /**
- * The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field. 
+ * The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field.
  * @member {String} chargeNumber
  */
 PreviewOrderChargeUpdate.prototype['chargeNumber'] = undefined;
@@ -190,7 +190,7 @@ PreviewOrderChargeUpdate.prototype['estimatedStartDate'] = undefined;
 PreviewOrderChargeUpdate.prototype['effectiveDate'] = undefined;
 
 /**
- * **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).       
+ * **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.   The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).      
  * @member {Number} prepaidQuantity
  */
 PreviewOrderChargeUpdate.prototype['prepaidQuantity'] = undefined;
@@ -202,7 +202,7 @@ PreviewOrderChargeUpdate.prototype['prepaidQuantity'] = undefined;
 PreviewOrderChargeUpdate.prototype['pricing'] = undefined;
 
 /**
- * A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions. 
+ * A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.
  * @member {String} uniqueToken
  */
 PreviewOrderChargeUpdate.prototype['uniqueToken'] = undefined;

package/src/zuora_api/model/PreviewOrderCreateSubscription.js

@@ -19,7 +19,7 @@ import PreviewOrderSubscriptionOwnerAccount from './PreviewOrderSubscriptionOwne
 /**
  * The PreviewOrderCreateSubscription model module.
  * @module model/PreviewOrderCreateSubscription
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderCreateSubscription {
     /**
@@ -208,7 +208,7 @@ class PreviewOrderCreateSubscription {
 PreviewOrderCreateSubscription.prototype['billToContactId'] = undefined;
 
 /**
- * Specifies whether the subscription appears on a separate invoice when Zuora generates invoices. 
+ * Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.
  * @member {Boolean} invoiceSeparately
  */
 PreviewOrderCreateSubscription.prototype['invoiceSeparately'] = undefined;
@@ -231,7 +231,7 @@ PreviewOrderCreateSubscription.prototype['newSubscriptionOwnerAccount'] = undefi
 PreviewOrderCreateSubscription.prototype['notes'] = undefined;
 
 /**
- * The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
+ * The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.   **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
  * @member {String} paymentTerm
  */
 PreviewOrderCreateSubscription.prototype['paymentTerm'] = undefined;
@@ -267,7 +267,7 @@ PreviewOrderCreateSubscription.prototype['subscribeToRatePlans'] = undefined;
 PreviewOrderCreateSubscription.prototype['subscriptionNumber'] = undefined;
 
 /**
- * Account number of an existing account that will own the subscription. For example, A00000001.  If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field. 
+ * Account number of an existing account that will own the subscription. For example, A00000001.   If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.
  * @member {String} subscriptionOwnerAccountNumber
  */
 PreviewOrderCreateSubscription.prototype['subscriptionOwnerAccountNumber'] = undefined;

package/src/zuora_api/model/PreviewOrderCreateSubscriptionTerms.js

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

package/src/zuora_api/model/PreviewOrderOrderAction.js

@@ -29,7 +29,7 @@ import TriggerDate from './TriggerDate';
 /**
  * The PreviewOrderOrderAction model module.
  * @module model/PreviewOrderOrderAction
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderOrderAction {
     /**

package/src/zuora_api/model/PreviewOrderPricingUpdate.js

@@ -28,7 +28,7 @@ import UsageVolumePricingUpdate from './UsageVolumePricingUpdate';
 /**
  * The PreviewOrderPricingUpdate model module.
  * @module model/PreviewOrderPricingUpdate
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderPricingUpdate {
     /**
@@ -173,7 +173,7 @@ class PreviewOrderPricingUpdate {
 
 
 /**
- * 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.
  * @member {module:model/ChargeModelDataOverride} chargeModelData
  */
 PreviewOrderPricingUpdate.prototype['chargeModelData'] = undefined;
@@ -185,61 +185,61 @@ PreviewOrderPricingUpdate.prototype['chargeModelData'] = undefined;
 PreviewOrderPricingUpdate.prototype['discount'] = undefined;
 
 /**
- * Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. 
+ * Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.
  * @member {module:model/RecurringFlatFeePricingUpdate} recurringFlatFee
  */
 PreviewOrderPricingUpdate.prototype['recurringFlatFee'] = undefined;
 
 /**
- * Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased. 
+ * Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.
  * @member {module:model/RecurringPerUnitPricingUpdate} recurringPerUnit
  */
 PreviewOrderPricingUpdate.prototype['recurringPerUnit'] = undefined;
 
 /**
- * Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. 
+ * Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.
  * @member {module:model/RecurringTieredPricingUpdate} recurringTiered
  */
 PreviewOrderPricingUpdate.prototype['recurringTiered'] = undefined;
 
 /**
- * Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. 
+ * Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.
  * @member {module:model/RecurringVolumePricingUpdate} recurringVolume
  */
 PreviewOrderPricingUpdate.prototype['recurringVolume'] = undefined;
 
 /**
- * Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. 
+ * Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.
  * @member {module:model/UsageFlatFeePricingUpdate} usageFlatFee
  */
 PreviewOrderPricingUpdate.prototype['usageFlatFee'] = undefined;
 
 /**
- * Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed. 
+ * Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.
  * @member {module:model/UsageOveragePricingUpdate} usageOverage
  */
 PreviewOrderPricingUpdate.prototype['usageOverage'] = undefined;
 
 /**
- * Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed. 
+ * Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.
  * @member {module:model/UsagePerUnitPricingUpdate} usagePerUnit
  */
 PreviewOrderPricingUpdate.prototype['usagePerUnit'] = undefined;
 
 /**
- * Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. 
+ * Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.
  * @member {module:model/UsageTieredPricingUpdate} usageTiered
  */
 PreviewOrderPricingUpdate.prototype['usageTiered'] = undefined;
 
 /**
- * Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier. 
+ * Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.
  * @member {module:model/UsageTieredWithOveragePricingUpdate} usageTieredWithOverage
  */
 PreviewOrderPricingUpdate.prototype['usageTieredWithOverage'] = undefined;
 
 /**
- * Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed. 
+ * Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.
  * @member {module:model/UsageVolumePricingUpdate} usageVolume
  */
 PreviewOrderPricingUpdate.prototype['usageVolume'] = undefined;

package/src/zuora_api/model/PreviewOrderRatePlanOverride.js

@@ -18,7 +18,7 @@ import PreviewOrderChargeOverride from './PreviewOrderChargeOverride';
 /**
  * The PreviewOrderRatePlanOverride model module.
  * @module model/PreviewOrderRatePlanOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderRatePlanOverride {
     /**
@@ -152,13 +152,13 @@ PreviewOrderRatePlanOverride.prototype['chargeOverrides'] = undefined;
 PreviewOrderRatePlanOverride.prototype['clearingExistingFeatures'] = undefined;
 
 /**
- * Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed. 
+ * Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed.
  * @member {Object.<String, Object>} customFields
  */
 PreviewOrderRatePlanOverride.prototype['customFields'] = undefined;
 
 /**
- * Internal identifier of the product rate plan that the rate plan is based on. 
+ * Internal identifier of the product rate plan that the rate plan is based on.
  * @member {String} productRatePlanId
  */
 PreviewOrderRatePlanOverride.prototype['productRatePlanId'] = undefined;
@@ -170,13 +170,13 @@ PreviewOrderRatePlanOverride.prototype['productRatePlanId'] = undefined;
 PreviewOrderRatePlanOverride.prototype['productRatePlanNumber'] = undefined;
 
 /**
- * List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. 
+ * List of features associated with the rate plan.  The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
  * @member {Array.<module:model/CreateOrderRatePlanFeatureOverride>} subscriptionProductFeatures
  */
 PreviewOrderRatePlanOverride.prototype['subscriptionProductFeatures'] = undefined;
 
 /**
- * Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.  For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify. 
+ * Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.   For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
  * @member {String} uniqueToken
  */
 PreviewOrderRatePlanOverride.prototype['uniqueToken'] = undefined;

package/src/zuora_api/model/PreviewOrderRatePlanUpdate.js

@@ -18,7 +18,7 @@ import PreviewOrderChargeUpdate from './PreviewOrderChargeUpdate';
 /**
  * The PreviewOrderRatePlanUpdate model module.
  * @module model/PreviewOrderRatePlanUpdate
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderRatePlanUpdate {
     /**
@@ -143,7 +143,7 @@ class PreviewOrderRatePlanUpdate {
 
 
 /**
- * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  When previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update. 
+ * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.   When previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update.
  * @member {Array.<module:model/PreviewOrderChargeUpdate>} chargeUpdates
  */
 PreviewOrderRatePlanUpdate.prototype['chargeUpdates'] = undefined;
@@ -155,7 +155,7 @@ PreviewOrderRatePlanUpdate.prototype['chargeUpdates'] = undefined;
 PreviewOrderRatePlanUpdate.prototype['clearingExistingFeatures'] = undefined;
 
 /**
- * Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed. 
+ * Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed.
  * @member {Object.<String, Object>} customFields
  */
 PreviewOrderRatePlanUpdate.prototype['customFields'] = undefined;
@@ -167,7 +167,7 @@ PreviewOrderRatePlanUpdate.prototype['customFields'] = undefined;
 PreviewOrderRatePlanUpdate.prototype['productRatePlanNumber'] = undefined;
 
 /**
- * The id of the rate plan to be updated. It can be the latest version or any history version id. 
+ * The id of the rate plan to be updated. It can be the latest version or any history version id.
  * @member {String} ratePlanId
  */
 PreviewOrderRatePlanUpdate.prototype['ratePlanId'] = undefined;
@@ -179,7 +179,7 @@ PreviewOrderRatePlanUpdate.prototype['ratePlanId'] = undefined;
 PreviewOrderRatePlanUpdate.prototype['specificUpdateDate'] = undefined;
 
 /**
- * List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. 
+ * List of features associated with the rate plan.  The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
  * @member {Array.<module:model/CreateOrderRatePlanFeatureOverride>} subscriptionProductFeatures
  */
 PreviewOrderRatePlanUpdate.prototype['subscriptionProductFeatures'] = undefined;
@@ -191,7 +191,7 @@ PreviewOrderRatePlanUpdate.prototype['subscriptionProductFeatures'] = undefined;
 PreviewOrderRatePlanUpdate.prototype['subscriptionRatePlanNumber'] = undefined;
 
 /**
- * A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions. 
+ * A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.
  * @member {String} uniqueToken
  */
 PreviewOrderRatePlanUpdate.prototype['uniqueToken'] = undefined;

package/src/zuora_api/model/PreviewOrderRequest.js

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

package/src/zuora_api/model/PreviewOrderResponse.js

@@ -19,7 +19,7 @@ import PreviewOrderResult from './PreviewOrderResult';
 /**
  * The PreviewOrderResponse model module.
  * @module model/PreviewOrderResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderResponse {
     /**
@@ -138,8 +138,9 @@ PreviewOrderResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-PreviewOrderResponse.prototype['success'] = undefined;
+PreviewOrderResponse.prototype['success'] = true;
 
 /**
  * @member {module:model/PreviewOrderResult} previewResult
@@ -165,8 +166,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/PreviewOrderResult.js

@@ -22,7 +22,7 @@ import PreviewResultOrderMetricsInner from './PreviewResultOrderMetricsInner';
 /**
  * The PreviewOrderResult model module.
  * @module model/PreviewOrderResult
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderResult {
     /**
@@ -177,13 +177,13 @@ PreviewOrderResult.prototype['invoices'] = undefined;
 PreviewOrderResult.prototype['orderDeltaMetrics'] = undefined;
 
 /**
- * **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects.   * [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)  * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)  * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)   It is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).   Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported. 
+ * **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects.    * [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)   * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)   * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)    It is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).    Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.
  * @member {Array.<module:model/PreviewResultOrderMetricsInner>} orderMetrics
  */
 PreviewOrderResult.prototype['orderMetrics'] = undefined;
 
 /**
- * **Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature 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 coming October 2020.  The ramp metrics. 
+ * **Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature 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 coming October 2020.   The ramp metrics.
  * @member {Array.<module:model/OrderRampMetrics>} rampMetrics
  */
 PreviewOrderResult.prototype['rampMetrics'] = undefined;

package/src/zuora_api/model/PreviewOrderResultChargeMetrics.js

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

package/src/zuora_api/model/PreviewOrderResultCreditMemos.js

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

package/src/zuora_api/model/PreviewOrderResultDeltaMetrics.js

@@ -20,12 +20,12 @@ import OrderDeltaTcv from './OrderDeltaTcv';
 /**
  * The PreviewOrderResultDeltaMetrics model module.
  * @module model/PreviewOrderResultDeltaMetrics
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderResultDeltaMetrics {
     /**
      * Constructs a new <code>PreviewOrderResultDeltaMetrics</code>.
-     * **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects.  * [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr) * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv) * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)  It is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). 
+     * **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects.   * [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)  * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)  * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)   It is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).
      * @alias module:model/PreviewOrderResultDeltaMetrics
      */
     constructor() { 

package/src/zuora_api/model/PreviewOrderResultInvoices.js

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

package/src/zuora_api/model/PreviewOrderSubscriptionOwnerAccount.js

@@ -20,14 +20,14 @@ import TaxInfo from './TaxInfo';
 /**
  * The PreviewOrderSubscriptionOwnerAccount model module.
  * @module model/PreviewOrderSubscriptionOwnerAccount
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderSubscriptionOwnerAccount {
     /**
      * Constructs a new <code>PreviewOrderSubscriptionOwnerAccount</code>.
-     * Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.  **Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).  If you do not set this field or the &#x60;subscriptionOwnerAccountNumber&#x60; field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the &#x60;subscriptionOwnerAccountNumber&#x60; field. 
+     * Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.   **Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).   If you do not set this field or the &#x60;subscriptionOwnerAccountNumber&#x60; field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the &#x60;subscriptionOwnerAccountNumber&#x60; field.
      * @alias module:model/PreviewOrderSubscriptionOwnerAccount
-     * @param bill_cycle_day {Number} Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\". 
+     * @param bill_cycle_day {Number} Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".
      * @param bill_to_contact {module:model/OrderCreateAccountContact} 
      * @param currency {String} ISO 3-letter currency code (uppercase). For example, USD. 
      * @param name {String} Account name. 
@@ -273,7 +273,7 @@ PreviewOrderSubscriptionOwnerAccount.RequiredProperties = ["billCycleDay", "bill
 PreviewOrderSubscriptionOwnerAccount.prototype['accountNumber'] = undefined;
 
 /**
- * List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses. 
+ * List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.
  * @member {String} additionalEmailAddresses
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['additionalEmailAddresses'] = undefined;
@@ -285,19 +285,19 @@ PreviewOrderSubscriptionOwnerAccount.prototype['additionalEmailAddresses'] = und
 PreviewOrderSubscriptionOwnerAccount.prototype['allowInvoiceEdit'] = undefined;
 
 /**
- * Specifies whether future payments are automatically billed when they are due. 
+ * Specifies whether future payments are automatically billed when they are due.
  * @member {Boolean} autoPay
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['autoPay'] = undefined;
 
 /**
- * Name of the billing batch that the account belongs to. For example, Batch1. 
+ * Name of the billing batch that the account belongs to. For example, Batch1.
  * @member {String} batch
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['batch'] = undefined;
 
 /**
- * Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\". 
+ * Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".
  * @member {Number} billCycleDay
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['billCycleDay'] = undefined;
@@ -308,7 +308,7 @@ PreviewOrderSubscriptionOwnerAccount.prototype['billCycleDay'] = undefined;
 PreviewOrderSubscriptionOwnerAccount.prototype['billToContact'] = undefined;
 
 /**
- * Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts. 
+ * Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.
  * @member {String} communicationProfileId
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['communicationProfileId'] = undefined;
@@ -319,7 +319,7 @@ PreviewOrderSubscriptionOwnerAccount.prototype['communicationProfileId'] = undef
 PreviewOrderSubscriptionOwnerAccount.prototype['creditCard'] = undefined;
 
 /**
- * **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.  The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b. 
+ * **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.   The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
  * @member {String} creditMemoTemplateId
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['creditMemoTemplateId'] = undefined;
@@ -349,31 +349,31 @@ PreviewOrderSubscriptionOwnerAccount.prototype['customFields'] = undefined;
 PreviewOrderSubscriptionOwnerAccount.prototype['customerServiceRepName'] = undefined;
 
 /**
- * **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.  The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2. 
+ * **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.   The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
  * @member {String} debitMemoTemplateId
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['debitMemoTemplateId'] = undefined;
 
 /**
- * The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.  If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field, but not both.  For a specified credit card payment method, it is recommended that [the support for stored credential transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions) for this payment method is already enabled. 
+ * The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.   If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,  but not both.   For a specified credit card payment method, it is recommended that [the support for stored credential transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions) for this payment method is already enabled.
  * @member {String} hpmCreditCardPaymentMethodId
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['hpmCreditCardPaymentMethodId'] = undefined;
 
 /**
- * Specifies whether to turn on the invoice delivery method 'Email' for the new account.  Values are:   * `true` (default). Turn on the invoice delivery method 'Email' for the new account. * `false`. Turn off the invoice delivery method 'Email' for the new account.          
+ * Specifies whether to turn on the invoice delivery method 'Email' for the new account.   Values are:    * `true` (default). Turn on the invoice delivery method 'Email' for the new account.  * `false`. Turn off the invoice delivery method 'Email' for the new account.         
  * @member {Boolean} invoiceDeliveryPrefsEmail
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['invoiceDeliveryPrefsEmail'] = undefined;
 
 /**
- * Specifies whether to turn on the invoice delivery method 'Print' for the new account. Values are:   * `true`. Turn on the invoice delivery method 'Print' for the new account. * `false` (default). Turn off the invoice delivery method 'Print' for the new account. 
+ * Specifies whether to turn on the invoice delivery method 'Print' for the new account.  Values are:    * `true`. Turn on the invoice delivery method 'Print' for the new account.  * `false` (default). Turn off the invoice delivery method 'Print' for the new account.
  * @member {Boolean} invoiceDeliveryPrefsPrint
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['invoiceDeliveryPrefsPrint'] = undefined;
 
 /**
- * Internal identifier of the invoice template that Zuora uses when generating invoices for the account. 
+ * Internal identifier of the invoice template that Zuora uses when generating invoices for the account.
  * @member {String} invoiceTemplateId
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['invoiceTemplateId'] = undefined;
@@ -397,7 +397,7 @@ PreviewOrderSubscriptionOwnerAccount.prototype['notes'] = undefined;
 PreviewOrderSubscriptionOwnerAccount.prototype['parentId'] = undefined;
 
 /**
- * The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway. 
+ * The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.
  * @member {String} paymentGateway
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['paymentGateway'] = undefined;
@@ -408,19 +408,19 @@ PreviewOrderSubscriptionOwnerAccount.prototype['paymentGateway'] = undefined;
 PreviewOrderSubscriptionOwnerAccount.prototype['paymentMethod'] = undefined;
 
 /**
- * Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices. 
+ * Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.
  * @member {String} paymentTerm
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['paymentTerm'] = undefined;
 
 /**
- * The number of the purchase order associated with this account. Purchase order information generally comes from customers. 
+ * The number of the purchase order associated with this account. Purchase order information generally comes from customers.
  * @member {String} purchaseOrderNumber
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['purchaseOrderNumber'] = undefined;
 
 /**
- * The name of the sales representative associated with this account, if applicable. 
+ * The name of the sales representative associated with this account, if applicable.
  * @member {String} salesRep
  */
 PreviewOrderSubscriptionOwnerAccount.prototype['salesRep'] = undefined;

package/src/zuora_api/model/PreviewOrderSubscriptions.js

@@ -19,7 +19,7 @@ import QuoteObjectFields from './QuoteObjectFields';
 /**
  * The PreviewOrderSubscriptions model module.
  * @module model/PreviewOrderSubscriptions
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderSubscriptions {
     /**
@@ -139,7 +139,7 @@ PreviewOrderSubscriptions.prototype['quote'] = undefined;
 PreviewOrderSubscriptions.prototype['ramp'] = undefined;
 
 /**
- * Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription. 
+ * Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.
  * @member {String} subscriptionNumber
  */
 PreviewOrderSubscriptions.prototype['subscriptionNumber'] = undefined;

package/src/zuora_api/model/PreviewOrderSubscriptionsAsync.js

@@ -20,7 +20,7 @@ import QuoteObjectFields from './QuoteObjectFields';
 /**
  * The PreviewOrderSubscriptionsAsync model module.
  * @module model/PreviewOrderSubscriptionsAsync
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewOrderSubscriptionsAsync {
     /**
@@ -144,7 +144,7 @@ PreviewOrderSubscriptionsAsync.prototype['quote'] = undefined;
 PreviewOrderSubscriptionsAsync.prototype['ramp'] = undefined;
 
 /**
- * Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription. 
+ * Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.
  * @member {String} subscriptionNumber
  */
 PreviewOrderSubscriptionsAsync.prototype['subscriptionNumber'] = undefined;
@@ -170,7 +170,7 @@ PreviewOrderSubscriptions.prototype['quote'] = undefined;
  */
 PreviewOrderSubscriptions.prototype['ramp'] = undefined;
 /**
- * Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription. 
+ * Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.
  * @member {String} subscriptionNumber
  */
 PreviewOrderSubscriptions.prototype['subscriptionNumber'] = undefined;