zuora-sdk-js 3.6.0 → 3.7.0

package/dist/zuora_api/model/CreatePaymentSessionRequest.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreatePaymentSessionRequest model module.
  * @module model/CreatePaymentSessionRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreatePaymentSessionRequest = /*#__PURE__*/function () {
   /**
@@ -157,7 +157,7 @@ var CreatePaymentSessionRequest = /*#__PURE__*/function () {
   }]);
 }();
 /**
- * The ID of the customer account in Zuora that is associated with this payment method. 
+ * The ID of the customer account in Zuora that is associated with this payment method.
  * @member {String} accountId
  */
 CreatePaymentSessionRequest.prototype['accountId'] = undefined;
@@ -169,13 +169,13 @@ CreatePaymentSessionRequest.prototype['accountId'] = undefined;
 CreatePaymentSessionRequest.prototype['amount'] = undefined;
 
 /**
- * The authorization amount for the payment method. Specify a value greater than 0.  This field is required if `processPayment` is false. 
+ * The authorization amount for the payment method. Specify a value greater than 0.   This field is required if `processPayment` is false.
  * @member {Number} authAmount
  */
 CreatePaymentSessionRequest.prototype['authAmount'] = undefined;
 
 /**
- * The currency of the payment in the format of the three-character ISO currency code. 
+ * The currency of the payment in the format of the three-character ISO currency code.
  * @member {String} currency
  */
 CreatePaymentSessionRequest.prototype['currency'] = undefined;
@@ -186,20 +186,20 @@ CreatePaymentSessionRequest.prototype['currency'] = undefined;
 CreatePaymentSessionRequest.prototype['gatewayOptions'] = undefined;
 
 /**
- * The ID of the payment gateway instance configured in Zuora that will process the payment, such as `e884322ab8c711edab030242ac120004`. 
+ * The ID of the payment gateway instance configured in Zuora that will process the payment, such as `e884322ab8c711edab030242ac120004`.
  * @member {String} paymentGateway
  */
 CreatePaymentSessionRequest.prototype['paymentGateway'] = undefined;
 
 /**
- * Indicate whether a payment should be processed after creating the payment method.  If this field is set to `true`, you must specify the `amount` field.  If this field is set to `false`, you must specify the `authAmount` field. The payment method will be verified through the payment gateway instance specified in the `paymentGateway` field. 
+ * Indicate whether a payment should be processed after creating the payment method.   If this field is set to `true`, you must specify the `amount` field.   If this field is set to `false`, you must specify the `authAmount` field. The payment method will be verified through the payment gateway instance specified in the `paymentGateway` field.
  * @member {Boolean} processPayment
  * @default true
  */
 CreatePaymentSessionRequest.prototype['processPayment'] = true;
 
 /**
- * true indicates that the payment method will be stored in Zuora and will be used in subsequent recurring payments. false indicates that the payment method will not be stored in Zuora. End-customers need to be brought back on-session to authenticate the payment. 
+ * true indicates that the payment method will be stored in Zuora and will be used in subsequent recurring payments. false indicates that the payment method will not be stored in Zuora. End-customers need to be brought back on-session to authenticate the payment.
  * @member {Boolean} storePaymentMethod
  * @default true
  */

package/dist/zuora_api/model/CreatePaymentSessionResponse.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreatePaymentSessionResponse model module.
  * @module model/CreatePaymentSessionResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreatePaymentSessionResponse = /*#__PURE__*/function () {
   /**
@@ -94,7 +94,7 @@ var CreatePaymentSessionResponse = /*#__PURE__*/function () {
   }]);
 }();
 /**
- * The token for the payment session data. Send the token back to your client side for identifying your website to Zuora.  For more information, see [Set up Apple Pay through the JavaScript SDK approach](https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for_gateway_integrations_other_than_Adyen_Integration_v2.0). 
+ * The token for the payment session data. Send the token back to your client side for identifying your website to Zuora.   For more information, see [Set up Apple Pay through the JavaScript SDK approach](https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for_gateway_integrations_other_than_Adyen_Integration_v2.0).
  * @member {String} token
  */
 CreatePaymentSessionResponse.prototype['token'] = undefined;

package/dist/zuora_api/model/CreateProductRatePlanChargeRequest.js

@@ -66,14 +66,14 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateProductRatePlanChargeRequest model module.
  * @module model/CreateProductRatePlanChargeRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateProductRatePlanChargeRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreateProductRatePlanChargeRequest</code>.
    * @alias module:model/CreateProductRatePlanChargeRequest
    * @implements module:model/ProductRatePlanChargeObjectNSFields
-   * @param product_rate_plan_id {String} The ID of the product rate plan associated with this product rate plan charge. 
+   * @param product_rate_plan_id {String} The ID of the product rate plan associated with this product rate plan charge.
    * @param bill_cycle_type {module:model/BillCycleType} 
    * @param billing_period {module:model/BillingPeriodProductRatePlanChargeRest} 
    * @param charge_model {module:model/ChargeModelProductRatePlanChargeRest} 
@@ -81,7 +81,7 @@ var CreateProductRatePlanChargeRequest = /*#__PURE__*/function () {
    * @param name {String} The name of the product rate plan charge. 
    * @param product_rate_plan_charge_tier_data {module:model/ProductRatePlanChargeTierData} 
    * @param trigger_event {module:model/TriggerEventProductRatePlanChargeRest} 
-   * @param use_discount_specific_accounting_code {Boolean} Determines whether to define a new accounting code for the new discount charge.  **Character limit**: 5  **Values**: `True`, `False` 
+   * @param use_discount_specific_accounting_code {Boolean} Determines whether to define a new accounting code for the new discount charge.   **Character limit**: 5   **Values**: `True`, `False`
    */
   function CreateProductRatePlanChargeRequest(product_rate_plan_id, bill_cycle_type, billing_period, charge_model, charge_type, name, product_rate_plan_charge_tier_data, trigger_event, use_discount_specific_accounting_code) {
     _classCallCheck(this, CreateProductRatePlanChargeRequest);
@@ -622,13 +622,13 @@ CreateProductRatePlanChargeRequest.prototype['Subsidiary__NS'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['SyncDate__NS'] = undefined;
 
 /**
- * The ID of the product rate plan associated with this product rate plan charge. 
+ * The ID of the product rate plan associated with this product rate plan charge.
  * @member {String} ProductRatePlanId
  */
 CreateProductRatePlanChargeRequest.prototype['ProductRatePlanId'] = undefined;
 
 /**
- * The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. 
+ * The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.
  * @member {String} AccountingCode
  */
 CreateProductRatePlanChargeRequest.prototype['AccountingCode'] = undefined;
@@ -639,7 +639,7 @@ CreateProductRatePlanChargeRequest.prototype['AccountingCode'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['ApplyDiscountTo'] = undefined;
 
 /**
- * Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.  **Character limit**: 2  **Values**: a valid BCD integer, 1 - 31 
+ * Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.   **Character limit**: 2   **Values**: a valid BCD integer, 1 - 31
  * @member {Number} BillCycleDay
  */
 CreateProductRatePlanChargeRequest.prototype['BillCycleDay'] = undefined;
@@ -695,13 +695,13 @@ CreateProductRatePlanChargeRequest.prototype['CommitmentType'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['CreditOption'] = undefined;
 
 /**
- * The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model.   **Character limit**: 16  **Values**: a valid quantity value.   **Note:** When the `ChargeModel` field is set to `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`. 
+ * The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model.    **Character limit**: 16   **Values**: a valid quantity value.    **Note:** When the `ChargeModel` field is set to `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`.
  * @member {Number} DefaultQuantity
  */
 CreateProductRatePlanChargeRequest.prototype['DefaultQuantity'] = undefined;
 
 /**
- * The name of the deferred revenue account for this charge.  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/).  
+ * The name of the deferred revenue account for this charge.   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} DeferredRevenueAccount
  */
 CreateProductRatePlanChargeRequest.prototype['DeferredRevenueAccount'] = undefined;
@@ -723,13 +723,13 @@ CreateProductRatePlanChargeRequest.prototype['Description'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['DiscountLevel'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). See [Fields related to Prepaid with Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown) for more information. 
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). See [Fields related to Prepaid with Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown) for more information.
  * @member {Number} DrawdownRate
  */
 CreateProductRatePlanChargeRequest.prototype['DrawdownRate'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).  
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). 
  * @member {String} DrawdownUom
  */
 CreateProductRatePlanChargeRequest.prototype['DrawdownUom'] = undefined;
@@ -740,27 +740,27 @@ CreateProductRatePlanChargeRequest.prototype['DrawdownUom'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['EndDateCondition'] = undefined;
 
 /**
- * The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.  **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  
+ * The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled. 
  * @member {Boolean} ExcludeItemBillingFromRevenueAccounting
  * @default false
  */
 CreateProductRatePlanChargeRequest.prototype['ExcludeItemBillingFromRevenueAccounting'] = false;
 
 /**
- * The flag to exclude the related rate plan charges and order line items from revenue accounting.  **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  
+ * The flag to exclude the related rate plan charges and order line items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled. 
  * @member {Boolean} ExcludeItemBookingFromRevenueAccounting
  * @default false
  */
 CreateProductRatePlanChargeRequest.prototype['ExcludeItemBookingFromRevenueAccounting'] = false;
 
 /**
- * This field is used to dictate the type of revenue recognition timing. 
+ * This field is used to dictate the type of revenue recognition timing.
  * @member {String} RevenueRecognitionTiming
  */
 CreateProductRatePlanChargeRequest.prototype['RevenueRecognitionTiming'] = undefined;
 
 /**
- * This field is used to dictate the type of revenue amortization method. 
+ * This field is used to dictate the type of revenue amortization method.
  * @member {String} RevenueAmortizationMethod
  */
 CreateProductRatePlanChargeRequest.prototype['RevenueAmortizationMethod'] = undefined;
@@ -772,19 +772,19 @@ CreateProductRatePlanChargeRequest.prototype['RevenueAmortizationMethod'] = unde
 CreateProductRatePlanChargeRequest.prototype['IncludedUnits'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`. 
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`.
  * @member {Boolean} IsPrepaid
  */
 CreateProductRatePlanChargeRequest.prototype['IsPrepaid'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  The value is either \"True\" or \"False\". It determines whether the rollover fields are needed. 
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   The value is either \"True\" or \"False\". It determines whether the rollover fields are needed.
  * @member {Boolean} IsRollover
  */
 CreateProductRatePlanChargeRequest.prototype['IsRollover'] = undefined;
 
 /**
- * **Note**: This field is only applicable to the Discount - Percentage charge model.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.  This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:   - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.   - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.  For more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models). 
+ * **Note**: This field is only applicable to the Discount - Percentage charge model.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.   This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:   - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.   - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.  For more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
  * @member {Boolean} IsStackedDiscount
  */
 CreateProductRatePlanChargeRequest.prototype['IsStackedDiscount'] = undefined;
@@ -801,13 +801,13 @@ CreateProductRatePlanChargeRequest.prototype['LegacyRevenueReporting'] = undefin
 CreateProductRatePlanChargeRequest.prototype['ListPriceBase'] = undefined;
 
 /**
- * Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.  **Character limit**: 16  **Values**: a positive decimal value 
+ * Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.   **Character limit**: 16   **Values**: a positive decimal value
  * @member {Number} MinQuantity
  */
 CreateProductRatePlanChargeRequest.prototype['MinQuantity'] = undefined;
 
 /**
- * Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.  **Character limit**: 16  **Values**: a positive decimal value 
+ * Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.   **Character limit**: 16   **Values**: a positive decimal value
  * @member {Number} MaxQuantity
  */
 CreateProductRatePlanChargeRequest.prototype['MaxQuantity'] = undefined;
@@ -819,7 +819,7 @@ CreateProductRatePlanChargeRequest.prototype['MaxQuantity'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['Name'] = undefined;
 
 /**
- * Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number. 
+ * Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.
  * @member {Number} NumberOfPeriod
  */
 CreateProductRatePlanChargeRequest.prototype['NumberOfPeriod'] = undefined;
@@ -840,19 +840,19 @@ CreateProductRatePlanChargeRequest.prototype['OverageUnusedUnitsCreditOption'] =
 CreateProductRatePlanChargeRequest.prototype['PrepaidOperationType'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   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. 
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    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.
  * @member {Number} PrepaidQuantity
  */
 CreateProductRatePlanChargeRequest.prototype['PrepaidQuantity'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). 
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
  * @member {Number} PrepaidTotalQuantity
  */
 CreateProductRatePlanChargeRequest.prototype['PrepaidTotalQuantity'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  Unit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). 
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   Unit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
  * @member {String} PrepaidUom
  */
 CreateProductRatePlanChargeRequest.prototype['PrepaidUom'] = undefined;
@@ -868,13 +868,13 @@ CreateProductRatePlanChargeRequest.prototype['PriceChangeOption'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['PriceIncreaseOption'] = undefined;
 
 /**
- * Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.  **Character limit**: 16  **Values**: a decimal value between -100 and 100 
+ * Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.   **Character limit**: 16   **Values**: a decimal value between -100 and 100
  * @member {Number} PriceIncreasePercentage
  */
 CreateProductRatePlanChargeRequest.prototype['PriceIncreasePercentage'] = undefined;
 
 /**
- * The natural key of the product rate plan charge.  **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. 
+ * The natural key of the product rate plan charge.   **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.
  * @member {String} ProductRatePlanChargeNumber
  */
 CreateProductRatePlanChargeRequest.prototype['ProductRatePlanChargeNumber'] = undefined;
@@ -896,7 +896,7 @@ CreateProductRatePlanChargeRequest.prototype['RatingGroup'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['RecognizedRevenueAccount'] = undefined;
 
 /**
- * Associates this product rate plan charge with a specific revenue recognition code. 
+ * Associates this product rate plan charge with a specific revenue recognition code.
  * @member {String} RevRecCode
  */
 CreateProductRatePlanChargeRequest.prototype['RevRecCode'] = undefined;
@@ -917,7 +917,7 @@ CreateProductRatePlanChargeRequest.prototype['RevenueRecognitionRuleName'] = und
 CreateProductRatePlanChargeRequest.prototype['RolloverApply'] = 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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  This field defines the number of rollover periods, it is restricted to 3. 
+ * **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   This field defines the number of rollover periods, it is restricted to 3.
  * @member {Number} RolloverPeriods
  */
 CreateProductRatePlanChargeRequest.prototype['RolloverPeriods'] = undefined;
@@ -928,19 +928,19 @@ CreateProductRatePlanChargeRequest.prototype['RolloverPeriods'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['SmoothingModel'] = undefined;
 
 /**
- * Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`. The valid value is a positive integer. 
+ * Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`.  The valid value is a positive integer.
  * @member {Number} SpecificBillingPeriod
  */
 CreateProductRatePlanChargeRequest.prototype['SpecificBillingPeriod'] = undefined;
 
 /**
- * The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.  **Notes**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.   - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`. 
+ * The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.   **Notes**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.   - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
  * @member {Number} SpecificListPriceBase
  */
 CreateProductRatePlanChargeRequest.prototype['SpecificListPriceBase'] = undefined;
 
 /**
- * Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.  **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`. 
+ * Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.   **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.
  * @member {String} TaxCode
  */
 CreateProductRatePlanChargeRequest.prototype['TaxCode'] = undefined;
@@ -951,7 +951,7 @@ CreateProductRatePlanChargeRequest.prototype['TaxCode'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['TaxMode'] = undefined;
 
 /**
- * Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.  **Character limit**: 5  **Values**: `True`, `False`  **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`. 
+ * Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.   **Character limit**: 5   **Values**: `True`, `False`   **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.
  * @member {Boolean} Taxable
  */
 CreateProductRatePlanChargeRequest.prototype['Taxable'] = undefined;
@@ -962,13 +962,13 @@ CreateProductRatePlanChargeRequest.prototype['Taxable'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['TriggerEvent'] = undefined;
 
 /**
- * Specifies a configured unit to measure usage.   **Note**: You must specify this field when creating the following charge models:   - Per Unit Pricing   - Volume Pricing   - Overage Pricing   - Tiered Pricing   - Tiered with Overage Pricing 
+ * Specifies a configured unit to measure usage.    **Note**: You must specify this field when creating the following charge models:   - Per Unit Pricing   - Volume Pricing   - Overage Pricing   - Tiered Pricing   - Tiered with Overage Pricing
  * @member {String} UOM
  */
 CreateProductRatePlanChargeRequest.prototype['UOM'] = undefined;
 
 /**
- * Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.  **Character limit**: 5  **Values**: a whole number between 0 and 65535, exclusive  **Notes**:   - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`.    - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. 
+ * Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.   **Character limit**: 5   **Values**: a whole number between 0 and 65535, exclusive   **Notes**:   - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`.    - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.
  * @member {Number} UpToPeriods
  */
 CreateProductRatePlanChargeRequest.prototype['UpToPeriods'] = undefined;
@@ -984,13 +984,13 @@ CreateProductRatePlanChargeRequest.prototype['UpToPeriodsType'] = undefined;
 CreateProductRatePlanChargeRequest.prototype['UsageRecordRatingOption'] = undefined;
 
 /**
- * Determines whether to define a new accounting code for the new discount charge.  **Character limit**: 5  **Values**: `True`, `False` 
+ * Determines whether to define a new accounting code for the new discount charge.   **Character limit**: 5   **Values**: `True`, `False`
  * @member {Boolean} UseDiscountSpecificAccountingCode
  */
 CreateProductRatePlanChargeRequest.prototype['UseDiscountSpecificAccountingCode'] = undefined;
 
 /**
- * Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal.   **Character limit**: 5  **Values**: `true`, `false` 
+ * Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal.    **Character limit**: 5   **Values**: `true`, `false`
  * @member {Boolean} UseTenantDefaultForPriceChange
  */
 CreateProductRatePlanChargeRequest.prototype['UseTenantDefaultForPriceChange'] = undefined;

package/dist/zuora_api/model/CreateProductRatePlanRequest.js

@@ -33,14 +33,14 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateProductRatePlanRequest model module.
  * @module model/CreateProductRatePlanRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateProductRatePlanRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreateProductRatePlanRequest</code>.
    * @alias module:model/CreateProductRatePlanRequest
    * @implements module:model/ProductRatePlanObjectNSFields
-   * @param name {String} The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product. 
+   * @param name {String} The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.
    * @param product_id {String} The ID of the product that contains the product rate plan. 
    */
   function CreateProductRatePlanRequest(name, product_id) {
@@ -330,13 +330,13 @@ CreateProductRatePlanRequest.prototype['Subsidiary__NS'] = undefined;
 CreateProductRatePlanRequest.prototype['SyncDate__NS'] = undefined;
 
 /**
- * The natural key of the product rate plan.  **Possible values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. 
+ * The natural key of the product rate plan.   **Possible values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.
  * @member {String} ProductRatePlanNumber
  */
 CreateProductRatePlanRequest.prototype['ProductRatePlanNumber'] = undefined;
 
 /**
- * The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product. 
+ * The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.
  * @member {String} Name
  */
 CreateProductRatePlanRequest.prototype['Name'] = undefined;
@@ -348,7 +348,7 @@ CreateProductRatePlanRequest.prototype['Name'] = undefined;
 CreateProductRatePlanRequest.prototype['ProductId'] = undefined;
 
 /**
- * A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.  When creating a product rate plan, you can use this field to specify default currency and at most four other active currencies. 
+ * A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.   When creating a product rate plan, you can use this field to specify default currency and at most four other active currencies.
  * @member {Array.<String>} ActiveCurrencies
  */
 CreateProductRatePlanRequest.prototype['ActiveCurrencies'] = undefined;
@@ -360,13 +360,13 @@ CreateProductRatePlanRequest.prototype['ActiveCurrencies'] = undefined;
 CreateProductRatePlanRequest.prototype['Description'] = undefined;
 
 /**
- * The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format. 
+ * The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format.
  * @member {String} EffectiveStartDate
  */
 CreateProductRatePlanRequest.prototype['EffectiveStartDate'] = undefined;
 
 /**
- * The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format. 
+ * The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format.
  * @member {String} EffectiveEndDate
  */
 CreateProductRatePlanRequest.prototype['EffectiveEndDate'] = undefined;
@@ -384,7 +384,7 @@ CreateProductRatePlanRequest.prototype['ExternalRatePlanIds'] = undefined;
 CreateProductRatePlanRequest.prototype['ExternalIdSourceSystem'] = undefined;
 
 /**
- * The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.  A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually.  **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.   - This field 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 [Zuora Global Support](http://support.zuora.com/). 
+ * The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.   A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.   - This field 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 [Zuora Global Support](http://support.zuora.com/).
  * @member {Number} Grade
  */
 CreateProductRatePlanRequest.prototype['Grade'] = undefined;

package/dist/zuora_api/model/CreateProductRequest.js

@@ -32,16 +32,16 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The CreateProductRequest model module.
  * @module model/CreateProductRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 var CreateProductRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreateProductRequest</code>.
    * @alias module:model/CreateProductRequest
    * @implements module:model/ProductObjectNSFields
-   * @param name {String} The name of the product. This information is displayed in the product catalog pages in the web-based UI. 
-   * @param effective_start_date {String} The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format. 
-   * @param effective_end_date {String} The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format. 
+   * @param name {String} The name of the product. This information is displayed in the product catalog pages in the web-based UI.
+   * @param effective_start_date {String} The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format.
+   * @param effective_end_date {String} The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format.
    */
   function CreateProductRequest(name, effective_start_date, effective_end_date) {
     _classCallCheck(this, CreateProductRequest);
@@ -217,13 +217,13 @@ CreateProductRequest.prototype['SyncDate__NS'] = undefined;
 CreateProductRequest.prototype['SKU'] = undefined;
 
 /**
- * The name of the product. This information is displayed in the product catalog pages in the web-based UI. 
+ * The name of the product. This information is displayed in the product catalog pages in the web-based UI.
  * @member {String} Name
  */
 CreateProductRequest.prototype['Name'] = undefined;
 
 /**
- * The natural key of the product.  **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. 
+ * The natural key of the product.   **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.
  * @member {String} ProductNumber
  */
 CreateProductRequest.prototype['ProductNumber'] = undefined;
@@ -240,19 +240,19 @@ CreateProductRequest.prototype['Category'] = undefined;
 CreateProductRequest.prototype['Description'] = undefined;
 
 /**
- * The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format. 
+ * The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format.
  * @member {String} EffectiveStartDate
  */
 CreateProductRequest.prototype['EffectiveStartDate'] = undefined;
 
 /**
- * The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format. 
+ * The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format.
  * @member {String} EffectiveEndDate
  */
 CreateProductRequest.prototype['EffectiveEndDate'] = undefined;
 
 /**
- * Controls whether to allow your users to add or remove features while creating or amending a subscription.  **Values**: true, false (default) 
+ * Controls whether to allow your users to add or remove features while creating or amending a subscription.   **Values**: true, false (default)
  * @member {Boolean} AllowFeatureChanges
  */
 CreateProductRequest.prototype['AllowFeatureChanges'] = undefined;