zuora-sdk-js 3.6.0 → 3.7.0

package/dist/zuora_api/model/CreateOrderPricingUpdate.js

@@ -39,7 +39,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderPricingUpdate model module.
  * @module model/CreateOrderPricingUpdate
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderPricingUpdate = /*#__PURE__*/function () {
   /**
@@ -204,7 +204,7 @@ var CreateOrderPricingUpdate = /*#__PURE__*/function () {
   }]);
 }();
 /**
- * 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
  */
 CreateOrderPricingUpdate.prototype['chargeModelData'] = undefined;
@@ -216,67 +216,67 @@ CreateOrderPricingUpdate.prototype['chargeModelData'] = undefined;
 CreateOrderPricingUpdate.prototype['discount'] = undefined;
 
 /**
- * This field is only available if you have the Delivery Pricing charge model enabled.  **Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. 
+ * This field is only available if you have the Delivery Pricing charge model enabled.   **Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.
  * @member {module:model/RecurringDeliveryPricingUpdate} recurringDeliveryBased
  */
 CreateOrderPricingUpdate.prototype['recurringDeliveryBased'] = 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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.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
  */
 CreateOrderPricingUpdate.prototype['usageVolume'] = undefined;

package/dist/zuora_api/model/CreateOrderProductOverride.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderProductOverride model module.
  * @module model/CreateOrderProductOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderProductOverride = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderProductRatePlanOverride.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderProductRatePlanOverride model module.
  * @module model/CreateOrderProductRatePlanOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderProductRatePlanOverride = /*#__PURE__*/function () {
   /**
@@ -196,25 +196,25 @@ CreateOrderProductRatePlanOverride.prototype['chargeOverrides'] = undefined;
 CreateOrderProductRatePlanOverride.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
  */
 CreateOrderProductRatePlanOverride.prototype['customFields'] = undefined;
 
 /**
- * An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.  **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. 
+ * An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.   **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
  * @member {String} externalCatalogPlanId
  */
 CreateOrderProductRatePlanOverride.prototype['externalCatalogPlanId'] = undefined;
 
 /**
- * Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. 
+ * Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
  * @member {String} externallyManagedPlanId
  */
 CreateOrderProductRatePlanOverride.prototype['externallyManagedPlanId'] = 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
  */
 CreateOrderProductRatePlanOverride.prototype['productRatePlanId'] = undefined;
@@ -226,13 +226,13 @@ CreateOrderProductRatePlanOverride.prototype['productRatePlanId'] = undefined;
 CreateOrderProductRatePlanOverride.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
  */
 CreateOrderProductRatePlanOverride.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
  */
 CreateOrderProductRatePlanOverride.prototype['uniqueToken'] = undefined;

package/dist/zuora_api/model/CreateOrderRatePlanFeatureOverride.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderRatePlanFeatureOverride model module.
  * @module model/CreateOrderRatePlanFeatureOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderRatePlanFeatureOverride = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderRatePlanOverride.js

@@ -31,12 +31,12 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderRatePlanOverride model module.
  * @module model/CreateOrderRatePlanOverride
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderRatePlanOverride = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreateOrderRatePlanOverride</code>.
-   * Information about an order action of type &#x60;addProduct&#x60;.   If you want to create a pending order through the \&quot;Add product\&quot; order action, and if the charge&#39;s trigger condition is &#x60;Specific Date&#x60;, you must set a charge number in the &#x60;chargeNumber&#x60; field for the \&quot;Add product\&quot; order action. In this case, if you do not set it, Zuora will not generate the charge number for you.  See more information about pending orders in &lt;a href&#x3D;\&quot;https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/Pending_orders_and_subscriptions\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Pending orders and subscriptions&lt;/a&gt;.  
+   * Information about an order action of type &#x60;addProduct&#x60;.    If you want to create a pending order through the \&quot;Add product\&quot; order action, and if the charge&#39;s trigger condition is &#x60;Specific Date&#x60;, you must set a charge number in the &#x60;chargeNumber&#x60; field for the \&quot;Add product\&quot; order action. In this case, if you do not set it, Zuora will not generate the charge number for you.   See more information about pending orders in &lt;a href&#x3D;\&quot;https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/Pending_orders_and_subscriptions\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Pending orders and subscriptions&lt;/a&gt;. 
    * @alias module:model/CreateOrderRatePlanOverride
    */
   function CreateOrderRatePlanOverride() {
@@ -216,25 +216,25 @@ CreateOrderRatePlanOverride.prototype['chargeOverrides'] = undefined;
 CreateOrderRatePlanOverride.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
  */
 CreateOrderRatePlanOverride.prototype['customFields'] = undefined;
 
 /**
- * An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.  **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. 
+ * An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.   **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
  * @member {String} externalCatalogPlanId
  */
 CreateOrderRatePlanOverride.prototype['externalCatalogPlanId'] = undefined;
 
 /**
- * Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. 
+ * Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
  * @member {String} externallyManagedPlanId
  */
 CreateOrderRatePlanOverride.prototype['externallyManagedPlanId'] = 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
  */
 CreateOrderRatePlanOverride.prototype['productRatePlanId'] = undefined;
@@ -246,13 +246,13 @@ CreateOrderRatePlanOverride.prototype['productRatePlanId'] = undefined;
 CreateOrderRatePlanOverride.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
  */
 CreateOrderRatePlanOverride.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
  */
 CreateOrderRatePlanOverride.prototype['uniqueToken'] = undefined;

package/dist/zuora_api/model/CreateOrderRatePlanUpdate.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderRatePlanUpdate model module.
  * @module model/CreateOrderRatePlanUpdate
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderRatePlanUpdate = /*#__PURE__*/function () {
   /**
@@ -190,7 +190,7 @@ var CreateOrderRatePlanUpdate = /*#__PURE__*/function () {
   }]);
 }();
 /**
- * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. 
+ * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.
  * @member {Array.<module:model/CreateOrderChargeUpdate>} chargeUpdates
  */
 CreateOrderRatePlanUpdate.prototype['chargeUpdates'] = undefined;
@@ -202,13 +202,13 @@ CreateOrderRatePlanUpdate.prototype['chargeUpdates'] = undefined;
 CreateOrderRatePlanUpdate.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
  */
 CreateOrderRatePlanUpdate.prototype['customFields'] = undefined;
 
 /**
- * An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.  **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. 
+ * An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
  * @member {String} externalCatalogPlanId
  */
 CreateOrderRatePlanUpdate.prototype['externalCatalogPlanId'] = undefined;
@@ -220,19 +220,19 @@ CreateOrderRatePlanUpdate.prototype['externalCatalogPlanId'] = undefined;
 CreateOrderRatePlanUpdate.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
  */
 CreateOrderRatePlanUpdate.prototype['ratePlanId'] = undefined;
 
 /**
- * The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.  See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature. 
+ * The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.   See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
  * @member {String} specificUpdateDate
  */
 CreateOrderRatePlanUpdate.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
  */
 CreateOrderRatePlanUpdate.prototype['subscriptionProductFeatures'] = undefined;
@@ -244,7 +244,7 @@ CreateOrderRatePlanUpdate.prototype['subscriptionProductFeatures'] = undefined;
 CreateOrderRatePlanUpdate.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
  */
 CreateOrderRatePlanUpdate.prototype['uniqueToken'] = undefined;

package/dist/zuora_api/model/CreateOrderRequest.js

@@ -37,7 +37,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderRequest model module.
  * @module model/CreateOrderRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderRequest = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResponse.js

@@ -38,7 +38,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponse model module.
  * @module model/CreateOrderResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponse = /*#__PURE__*/function () {
   /**
@@ -379,8 +379,9 @@ CreateOrderResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-CreateOrderResponse.prototype['success'] = undefined;
+CreateOrderResponse.prototype['success'] = true;
 
 /**
  * The account ID for the order. This field is returned instead of the `accountNumber` field if the `returnIds` query parameter is set to `true`.
@@ -510,8 +511,9 @@ _CommonResponse["default"].prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-_CommonResponse["default"].prototype['success'] = undefined;
+_CommonResponse["default"].prototype['success'] = true;
 // Implement CreateOrderResult interface:
 /**
  * The account ID for the order. This field is returned instead of the `accountNumber` field if the `returnIds` query parameter is set to `true`.

package/dist/zuora_api/model/CreateOrderResponseOrderAction.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponseOrderAction model module.
  * @module model/CreateOrderResponseOrderAction
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponseOrderAction = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResponseOrderLineItems.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponseOrderLineItems model module.
  * @module model/CreateOrderResponseOrderLineItems
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponseOrderLineItems = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResponseOrderMetric.js

@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponseOrderMetric model module.
  * @module model/CreateOrderResponseOrderMetric
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponseOrderMetric = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResponseRamps.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponseRamps model module.
  * @module model/CreateOrderResponseRamps
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponseRamps = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResponseRefunds.js

@@ -27,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponseRefunds model module.
  * @module model/CreateOrderResponseRefunds
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponseRefunds = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResponseSubscriptions.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponseSubscriptions model module.
  * @module model/CreateOrderResponseSubscriptions
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponseSubscriptions = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResponseWriteOff.js

@@ -27,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResponseWriteOff model module.
  * @module model/CreateOrderResponseWriteOff
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResponseWriteOff = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResult.js

@@ -35,7 +35,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResult model module.
  * @module model/CreateOrderResult
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResult = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderResume.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderResume model module.
  * @module model/CreateOrderResume
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderResume = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/CreateOrderSubscription.js

@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderSubscription model module.
  * @module model/CreateOrderSubscription
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderSubscription = /*#__PURE__*/function () {
   /**
@@ -90,6 +90,9 @@ var CreateOrderSubscription = /*#__PURE__*/function () {
         if (data.hasOwnProperty('ramp')) {
           obj['ramp'] = _CreateRamp["default"].constructFromObject(data['ramp']);
         }
+        if (data.hasOwnProperty('notes')) {
+          obj['notes'] = _ApiClient["default"].convertToType(data['notes'], 'String');
+        }
         if (data.hasOwnProperty('subscriptionNumber')) {
           obj['subscriptionNumber'] = _ApiClient["default"].convertToType(data['subscriptionNumber'], 'String');
         }
@@ -137,6 +140,10 @@ var CreateOrderSubscription = /*#__PURE__*/function () {
         _CreateRamp["default"].validateJSON(data['ramp']);
       }
       // ensure the json data is a string
+      if (data['notes'] && !(typeof data['notes'] === 'string' || data['notes'] instanceof String)) {
+        throw new Error("Expected the field `notes` to be a primitive type in the JSON string but got " + data['notes']);
+      }
+      // ensure the json data is a string
       if (data['subscriptionNumber'] && !(typeof data['subscriptionNumber'] === 'string' || data['subscriptionNumber'] instanceof String)) {
         throw new Error("Expected the field `subscriptionNumber` to be a primitive type in the JSON string but got " + data['subscriptionNumber']);
       }
@@ -167,7 +174,13 @@ CreateOrderSubscription.prototype['quote'] = undefined;
 CreateOrderSubscription.prototype['ramp'] = undefined;
 
 /**
- * Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription. 
+ * A string of up to 65,535 characters. 
+ * @member {String} notes
+ */
+CreateOrderSubscription.prototype['notes'] = undefined;
+
+/**
+ * Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.
  * @member {String} subscriptionNumber
  */
 CreateOrderSubscription.prototype['subscriptionNumber'] = undefined;

package/dist/zuora_api/model/CreateOrderSubscriptionOwnerAccount.js

@@ -33,14 +33,14 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderSubscriptionOwnerAccount model module.
  * @module model/CreateOrderSubscriptionOwnerAccount
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderSubscriptionOwnerAccount = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreateOrderSubscriptionOwnerAccount</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/CreateOrderSubscriptionOwnerAccount
-   * @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/CreateAccountContact} 
    * @param currency {String} ISO 3-letter currency code (uppercase). For example, USD. 
    * @param name {String} Account name. 
@@ -268,19 +268,19 @@ CreateOrderSubscriptionOwnerAccount.RequiredProperties = ["billCycleDay", "billT
 CreateOrderSubscriptionOwnerAccount.prototype['accountNumber'] = 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
  */
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.prototype['billCycleDay'] = undefined;
@@ -291,7 +291,7 @@ CreateOrderSubscriptionOwnerAccount.prototype['billCycleDay'] = undefined;
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.prototype['communicationProfileId'] = undefined;
@@ -320,25 +320,25 @@ CreateOrderSubscriptionOwnerAccount.prototype['currency'] = undefined;
 CreateOrderSubscriptionOwnerAccount.prototype['customFields'] = 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 the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account. 
+ * 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 the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.
  * @member {String} hpmCreditCardPaymentMethodId
  */
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.prototype['invoiceTemplateId'] = undefined;
@@ -362,7 +362,7 @@ CreateOrderSubscriptionOwnerAccount.prototype['notes'] = undefined;
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.prototype['paymentGateway'] = undefined;
@@ -373,7 +373,7 @@ CreateOrderSubscriptionOwnerAccount.prototype['paymentGateway'] = undefined;
 CreateOrderSubscriptionOwnerAccount.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
  */
 CreateOrderSubscriptionOwnerAccount.prototype['paymentTerm'] = undefined;

package/dist/zuora_api/model/CreateOrderSuspend.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateOrderSuspend model module.
  * @module model/CreateOrderSuspend
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateOrderSuspend = /*#__PURE__*/function () {
   /**