zuora-sdk-js 3.6.0 → 3.7.0

package/src/zuora_api/model/PreviewPaymentSchedule.js

@@ -17,7 +17,7 @@ import PaymentSchedulePaymentOptionFields from './PaymentSchedulePaymentOptionFi
 /**
  * The PreviewPaymentSchedule model module.
  * @module model/PreviewPaymentSchedule
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewPaymentSchedule {
     /**
@@ -141,31 +141,31 @@ class PreviewPaymentSchedule {
 PreviewPaymentSchedule.prototype['amount'] = undefined;
 
 /**
- * Indicates the updated currency of the pending payment schedule items. 
+ * Indicates the updated currency of the pending payment schedule items.
  * @member {String} currency
  */
 PreviewPaymentSchedule.prototype['currency'] = undefined;
 
 /**
- * Indicates the updated number of payment schedule items that are created by the payment schedule. 
+ * Indicates the updated number of payment schedule items that are created by the payment schedule.
  * @member {Number} occurrences
  */
 PreviewPaymentSchedule.prototype['occurrences'] = undefined;
 
 /**
- * Indicates the updated payment gateway ID of the pending payment schedule items. 
+ * Indicates the updated payment gateway ID of the pending payment schedule items.
  * @member {String} paymentGatewayId
  */
 PreviewPaymentSchedule.prototype['paymentGatewayId'] = undefined;
 
 /**
- * Indicates the updated payment method ID of the pending payment schedule items. 
+ * Indicates the updated payment method ID of the pending payment schedule items.
  * @member {String} paymentMethodId
  */
 PreviewPaymentSchedule.prototype['paymentMethodId'] = undefined;
 
 /**
- * Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  Here is an example: ``` \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ] ```  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later. 
+ * Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.   Here is an example:  ```  \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ]  ```   `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.   To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later.
  * @member {Array.<module:model/PaymentSchedulePaymentOptionFields>} paymentOption
  */
 PreviewPaymentSchedule.prototype['paymentOption'] = undefined;
@@ -177,13 +177,13 @@ PreviewPaymentSchedule.prototype['paymentOption'] = undefined;
 PreviewPaymentSchedule.prototype['period'] = undefined;
 
 /**
- * Indicates the updated collection date for the next pending payment schedule item. 
+ * Indicates the updated collection date for the next pending payment schedule item.
  * @member {String} periodStartDate
  */
 PreviewPaymentSchedule.prototype['periodStartDate'] = undefined;
 
 /**
- * Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.    If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs. 
+ * Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.    If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.
  * @member {Number} runHour
  */
 PreviewPaymentSchedule.prototype['runHour'] = undefined;

package/src/zuora_api/model/PreviewResultOrderMetricsInner.js

@@ -17,7 +17,7 @@ import PreviewResultOrderMetricsInnerOrderActionsInner from './PreviewResultOrde
 /**
  * The PreviewResultOrderMetricsInner model module.
  * @module model/PreviewResultOrderMetricsInner
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewResultOrderMetricsInner {
     /**

package/src/zuora_api/model/PreviewResultOrderMetricsInnerOrderActionsInner.js

@@ -18,7 +18,7 @@ import OrderMetric from './OrderMetric';
 /**
  * The PreviewResultOrderMetricsInnerOrderActionsInner model module.
  * @module model/PreviewResultOrderMetricsInnerOrderActionsInner
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewResultOrderMetricsInnerOrderActionsInner {
     /**
@@ -119,13 +119,13 @@ class PreviewResultOrderMetricsInnerOrderActionsInner {
 
 
 /**
- * The `orderItems` nested field is only available to existing Orders customers who already have access to the field.  **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics. * The Order ELP and Order Item objects  * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects  Existing Orders customers who have these metrics will continue to be supported. 
+ * The `orderItems` nested field is only available to existing Orders customers who already have access to the field.   **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.  * The Order ELP and Order Item objects   * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects   Existing Orders customers who have these metrics will continue to be supported.
  * @member {Array.<module:model/OrderItem>} orderItems
  */
 PreviewResultOrderMetricsInnerOrderActionsInner.prototype['orderItems'] = undefined;
 
 /**
- * The container for order metrics.  **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics. * The Order ELP and Order Item objects  * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects  Existing Orders customers who have these metrics will continue to be supported. 
+ * The container for order metrics.   **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.  * The Order ELP and Order Item objects   * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects   Existing Orders customers who have these metrics will continue to be supported.
  * @member {Array.<module:model/OrderMetric>} orderMetrics
  */
 PreviewResultOrderMetricsInnerOrderActionsInner.prototype['orderMetrics'] = undefined;

package/src/zuora_api/model/PreviewStartDate.js

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

package/src/zuora_api/model/PreviewSubscriptionAccountInfo.js

@@ -20,16 +20,16 @@ import PreviewSubscriptionBillToContact from './PreviewSubscriptionBillToContact
 /**
  * The PreviewSubscriptionAccountInfo model module.
  * @module model/PreviewSubscriptionAccountInfo
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewSubscriptionAccountInfo {
     /**
      * Constructs a new <code>PreviewSubscriptionAccountInfo</code>.
-     * A container for providing a customer account information if you do not have an existing customer account. This customer account information is only used for subscription preview.  You must specify the account information either in this field or in the &#x60;accountKey&#x60; field with the following conditions:  * If you already have a customer account, specify the account number or ID in the accountKey field. * If you do not have a customer account, provide account information in this field. 
+     * A container for providing a customer account information if you do not have an existing customer account. This customer account information is only used for subscription preview.   You must specify the account information either in this field or in the &#x60;accountKey&#x60; field with the following conditions:   * If you already have a customer account, specify the account number or ID in the accountKey field.  * If you do not have a customer account, provide account information in this field.
      * @alias module:model/PreviewSubscriptionAccountInfo
      * @extends Object
      * @implements module:model/AccountObjectNSFields
-     * @param bill_cycle_day {Number} The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set. 
+     * @param bill_cycle_day {Number} The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set.
      * @param bill_to_contact {module:model/PreviewSubscriptionBillToContact} 
      * @param currency {String} A currency as defined in Billing Settings. 
      */
@@ -232,7 +232,7 @@ PreviewSubscriptionAccountInfo.prototype['SyncDate__NS'] = undefined;
 PreviewSubscriptionAccountInfo.prototype['SynctoNetSuite__NS'] = undefined;
 
 /**
- * The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set. 
+ * The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set.
  * @member {Number} billCycleDay
  */
 PreviewSubscriptionAccountInfo.prototype['billCycleDay'] = undefined;

package/src/zuora_api/model/PreviewSubscriptionBillToContact.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The PreviewSubscriptionBillToContact model module.
  * @module model/PreviewSubscriptionBillToContact
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewSubscriptionBillToContact {
     /**
@@ -120,37 +120,37 @@ class PreviewSubscriptionBillToContact {
 
 
 /**
- * The city of the bill-to address. The value should be 40 characters or less. 
+ * The city of the bill-to address. The value should be 40 characters or less.
  * @member {String} city
  */
 PreviewSubscriptionBillToContact.prototype['city'] = undefined;
 
 /**
- * The country of the bill-to address. The value must be a valid country name or abbreviation.  **Note:** You must specify this field if you are using Zuora Tax for this account. 
+ * The country of the bill-to address. The value must be a valid country name or abbreviation.   **Note:** You must specify this field if you are using Zuora Tax for this account.
  * @member {String} country
  */
 PreviewSubscriptionBillToContact.prototype['country'] = undefined;
 
 /**
- * The county of the bill-to address. The value should be 32 characters or less. 
+ * The county of the bill-to address. The value should be 32 characters or less.
  * @member {String} county
  */
 PreviewSubscriptionBillToContact.prototype['county'] = undefined;
 
 /**
- * The state of the bill-to address. The value must be a valid state or province name or 2-character abbreviation.  **Note:** You must specify this field if you are using Zuora Tax for this account and the country is `USA` or `Canada`. 
+ * The state of the bill-to address. The value must be a valid state or province name or 2-character abbreviation.   **Note:** You must specify this field if you are using Zuora Tax for this account and the country is `USA` or `Canada`.
  * @member {String} state
  */
 PreviewSubscriptionBillToContact.prototype['state'] = undefined;
 
 /**
- * If using Zuora Tax, a region string as optionally defined in your tax rules. 
+ * If using Zuora Tax, a region string as optionally defined in your tax rules.
  * @member {String} taxRegion
  */
 PreviewSubscriptionBillToContact.prototype['taxRegion'] = undefined;
 
 /**
- * The zip code of the bill-to address. The value should be 20 characters or less. 
+ * The zip code of the bill-to address. The value should be 20 characters or less.
  * @member {String} zipCode
  */
 PreviewSubscriptionBillToContact.prototype['zipCode'] = undefined;

package/src/zuora_api/model/PreviewSubscriptionInvoice.js

@@ -17,7 +17,7 @@ import PreviewSubscriptionInvoiceItem from './PreviewSubscriptionInvoiceItem';
 /**
  * The PreviewSubscriptionInvoice model module.
  * @module model/PreviewSubscriptionInvoice
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewSubscriptionInvoice {
     /**
@@ -126,7 +126,7 @@ PreviewSubscriptionInvoice.prototype['amountWithoutTax'] = undefined;
 PreviewSubscriptionInvoice.prototype['invoiceItems'] = undefined;
 
 /**
- * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {String} targetDate
  */
 PreviewSubscriptionInvoice.prototype['targetDate'] = undefined;

package/src/zuora_api/model/PreviewSubscriptionInvoiceItem.js

@@ -17,7 +17,7 @@ import SubscriptionTaxationItem from './SubscriptionTaxationItem';
 /**
  * The PreviewSubscriptionInvoiceItem model module.
  * @module model/PreviewSubscriptionInvoiceItem
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewSubscriptionInvoiceItem {
     /**
@@ -141,7 +141,7 @@ class PreviewSubscriptionInvoiceItem {
 
 
 /**
- * The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive. 
+ * The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive.
  * @member {Number} chargeAmount
  */
 PreviewSubscriptionInvoiceItem.prototype['chargeAmount'] = undefined;
@@ -177,13 +177,13 @@ PreviewSubscriptionInvoiceItem.prototype['productRatePlanChargeId'] = undefined;
 PreviewSubscriptionInvoiceItem.prototype['quantity'] = undefined;
 
 /**
- * End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd. 
+ * End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd.
  * @member {String} serviceEndDate
  */
 PreviewSubscriptionInvoiceItem.prototype['serviceEndDate'] = undefined;
 
 /**
- * Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge. 
+ * Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge.
  * @member {String} serviceStartDate
  */
 PreviewSubscriptionInvoiceItem.prototype['serviceStartDate'] = undefined;
@@ -195,7 +195,7 @@ PreviewSubscriptionInvoiceItem.prototype['serviceStartDate'] = undefined;
 PreviewSubscriptionInvoiceItem.prototype['taxAmount'] = undefined;
 
 /**
- * List of taxation items. **Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later. 
+ * List of taxation items.  **Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later. 
  * @member {Array.<module:model/SubscriptionTaxationItem>} taxationItems
  */
 PreviewSubscriptionInvoiceItem.prototype['taxationItems'] = undefined;

package/src/zuora_api/model/PreviewSubscriptionRequest.js

@@ -18,7 +18,7 @@ import PreviewSubscriptionAccountInfo from './PreviewSubscriptionAccountInfo';
 /**
  * The PreviewSubscriptionRequest model module.
  * @module model/PreviewSubscriptionRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewSubscriptionRequest {
     /**
@@ -187,7 +187,7 @@ class PreviewSubscriptionRequest {
 PreviewSubscriptionRequest.RequiredProperties = ["contractEffectiveDate", "subscribeToRatePlans", "termType"];
 
 /**
- *  Customer account number or ID.  You must specify the account information either in this field or in the `previewAccountInfo` field with the following conditions:           * If you already have a customer account, specify the account number or ID in this field. * If you do not have a customer account, provide account information in the `previewAccountInfo` field. 
+ *  Customer account number or ID.   You must specify the account information either in this field or in the `previewAccountInfo` field with the following conditions:           * If you already have a customer account, specify the account number or ID in this field.  * If you do not have a customer account, provide account information in the `previewAccountInfo` field.
  * @member {String} accountKey
  */
 PreviewSubscriptionRequest.prototype['accountKey'] = undefined;
@@ -199,31 +199,31 @@ PreviewSubscriptionRequest.prototype['accountKey'] = undefined;
 PreviewSubscriptionRequest.prototype['contractEffectiveDate'] = undefined;
 
 /**
- * The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.  Default value is dependent on the value of other fields. See **Notes** section for more details. 
+ * The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.   Default value is dependent on the value of other fields. See **Notes** section for more details.
  * @member {String} customerAcceptanceDate
  */
 PreviewSubscriptionRequest.prototype['customerAcceptanceDate'] = undefined;
 
 /**
- * The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. 
+ * The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.
  * @member {String} documentDate
  */
 PreviewSubscriptionRequest.prototype['documentDate'] = undefined;
 
 /**
- * Specifies whether to include draft invoice items in subscription previews. Values are:  * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * Specifies whether to include draft invoice items in subscription previews.  Values are:   * `true` (default). Includes draft invoice items in the preview result.  * `false`. Excludes draft invoice items in the preview result.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {Boolean} includeExistingDraftDocItems
  */
 PreviewSubscriptionRequest.prototype['includeExistingDraftDocItems'] = undefined;
 
 /**
- * Specifies whether to include draft invoice items in previews. Values are:  * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * Specifies whether to include draft invoice items in previews.  Values are:   * `true` (default). Includes draft invoice items in the preview result.  * `false`. Excludes draft invoice items in the preview result.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {Boolean} includeExistingDraftInvoiceItems
  */
 PreviewSubscriptionRequest.prototype['includeExistingDraftInvoiceItems'] = undefined;
 
 /**
- * Duration of the first term of the subscription, in whole months. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored.     
+ * Duration of the first term of the subscription, in whole months. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored.    
  * @member {Number} initialTerm
  */
 PreviewSubscriptionRequest.prototype['initialTerm'] = undefined;
@@ -235,13 +235,13 @@ PreviewSubscriptionRequest.prototype['initialTerm'] = undefined;
 PreviewSubscriptionRequest.prototype['initialTermPeriodType'] = undefined;
 
 /**
- * Invoice owner account number or ID.  **Note:** This 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/). 
+ * Invoice owner account number or ID.   **Note:** This 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/).
  * @member {String} invoiceOwnerAccountKey
  */
 PreviewSubscriptionRequest.prototype['invoiceOwnerAccountKey'] = undefined;
 
 /**
- * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {String} invoiceTargetDate
  */
 PreviewSubscriptionRequest.prototype['invoiceTargetDate'] = undefined;
@@ -258,13 +258,13 @@ PreviewSubscriptionRequest.prototype['notes'] = undefined;
 PreviewSubscriptionRequest.prototype['previewAccountInfo'] = undefined;
 
 /**
- * The type of preview you will receive.   This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.   * If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:     * 186.0   * 187.0   * 188.0   * 189.0   * 196.0   * 206.0      The following values are supported in the **previewType** field:    * InvoiceItem   * ChargeMetrics   * InvoiceItemChargeMetrics      The default value is InvoiceItem.  * If you specify the REST API minor version to 207.0 or later in the request header, the following values are supported in the **previewType** field:    - LegalDoc   - ChargeMetrics   - LegalDocChargeMetrics    The default value is LegalDoc.  See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * The type of preview you will receive.    This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.    * If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:     * 186.0   * 187.0   * 188.0   * 189.0   * 196.0   * 206.0      The following values are supported in the **previewType** field:    * InvoiceItem   * ChargeMetrics   * InvoiceItemChargeMetrics      The default value is InvoiceItem.  * If you specify the REST API minor version to 207.0 or later in the request header, the following values are supported in the **previewType** field:    - LegalDoc   - ChargeMetrics   - LegalDocChargeMetrics    The default value is LegalDoc.  See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {String} previewType
  */
 PreviewSubscriptionRequest.prototype['previewType'] = undefined;
 
 /**
- * The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.  Default value is dependent on the value of other fields. See **Notes** section for more details. 
+ * The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.   Default value is dependent on the value of other fields. See **Notes** section for more details.
  * @member {String} serviceActivationDate
  */
 PreviewSubscriptionRequest.prototype['serviceActivationDate'] = undefined;
@@ -276,13 +276,13 @@ PreviewSubscriptionRequest.prototype['serviceActivationDate'] = undefined;
 PreviewSubscriptionRequest.prototype['subscribeToRatePlans'] = undefined;
 
 /**
- * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {String} targetDate
  */
 PreviewSubscriptionRequest.prototype['targetDate'] = undefined;
 
 /**
- * The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. 
+ * The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.
  * @member {String} termStartDate
  */
 PreviewSubscriptionRequest.prototype['termStartDate'] = undefined;

package/src/zuora_api/model/PreviewSubscriptionResponse.js

@@ -20,7 +20,7 @@ import SubscriptionCreditMemo from './SubscriptionCreditMemo';
 /**
  * The PreviewSubscriptionResponse model module.
  * @module model/PreviewSubscriptionResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PreviewSubscriptionResponse {
     /**
@@ -176,7 +176,7 @@ PreviewSubscriptionResponse.prototype['contractedMrr'] = undefined;
 PreviewSubscriptionResponse.prototype['creditMemo'] = undefined;
 
 /**
- * The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. 
+ * The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.
  * @member {String} documentDate
  */
 PreviewSubscriptionResponse.prototype['documentDate'] = undefined;
@@ -193,7 +193,7 @@ PreviewSubscriptionResponse.prototype['invoice'] = undefined;
 PreviewSubscriptionResponse.prototype['invoiceItems'] = undefined;
 
 /**
- * Date through which charges are calculated on the invoice, as yyyy-mm-dd.  **Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * Date through which charges are calculated on the invoice, as yyyy-mm-dd.   **Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {String} invoiceTargetDate
  */
 PreviewSubscriptionResponse.prototype['invoiceTargetDate'] = undefined;
@@ -205,7 +205,7 @@ PreviewSubscriptionResponse.prototype['invoiceTargetDate'] = undefined;
 PreviewSubscriptionResponse.prototype['success'] = undefined;
 
 /**
- * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. 
+ * Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.
  * @member {String} targetDate
  */
 PreviewSubscriptionResponse.prototype['targetDate'] = undefined;

package/src/zuora_api/model/PreviewThroughDate.js

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

package/src/zuora_api/model/PriceChangeParams.js

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

package/src/zuora_api/model/PricingUpdate.js

@@ -29,7 +29,7 @@ import UsageVolumePricingUpdate from './UsageVolumePricingUpdate';
 /**
  * The PricingUpdate model module.
  * @module model/PricingUpdate
- * @version 3.6.0
+ * @version 3.7.0
  */
 class PricingUpdate {
     /**
@@ -181,7 +181,7 @@ class PricingUpdate {
 
 
 /**
- * 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
  */
 PricingUpdate.prototype['chargeModelData'] = undefined;
@@ -193,67 +193,67 @@ PricingUpdate.prototype['chargeModelData'] = undefined;
 PricingUpdate.prototype['discount'] = undefined;
 
 /**
- * Pricing information about a recurring charge that uses the \"delivery\" charge model. 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>. 
+ * Pricing information about a recurring charge that uses the \"delivery\" charge model. 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} recurringDelivery
  */
 PricingUpdate.prototype['recurringDelivery'] = 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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.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
  */
 PricingUpdate.prototype['usageVolume'] = undefined;