zuora-sdk-js 3.6.0 → 3.7.0

package/dist/zuora_api/model/SubscriptionRatePlan.js

@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SubscriptionRatePlan model module.
  * @module model/SubscriptionRatePlan
- * @version 3.6.0
+ * @version 3.7.0
  */
 var SubscriptionRatePlan = /*#__PURE__*/function () {
   /**
@@ -247,7 +247,7 @@ SubscriptionRatePlan.prototype['subscriptionRatePlanNumber'] = undefined;
 SubscriptionRatePlan.prototype['isFromExternalCatalog'] = undefined;
 
 /**
- * The last amendment on the rate plan.    **Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.   Possible Values:   * `Add`   * `Update`   * `Remove` 
+ * The last amendment on the rate plan.     **Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.    Possible Values:   * `Add`   * `Update`   * `Remove`
  * @member {module:model/SubscriptionRatePlan.LastChangeTypeEnum} lastChangeType
  */
 SubscriptionRatePlan.prototype['lastChangeType'] = undefined;
@@ -285,13 +285,13 @@ SubscriptionRatePlan.prototype['productRatePlanNumber'] = undefined;
 SubscriptionRatePlan.prototype['ratePlanName'] = undefined;
 
 /**
- * Container for one or more features.   Only available when the following settings are enabled:  * The Entitlements feature in your tenant.  * The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings
+ * Container for one or more features.    Only available when the following settings are enabled:   * The Entitlements feature in your tenant.   * The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings
  * @member {Array.<module:model/SubscriptionProductFeature>} subscriptionProductFeatures
  */
 SubscriptionRatePlan.prototype['subscriptionProductFeatures'] = 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
  */
 SubscriptionRatePlan.prototype['externallyManagedPlanId'] = undefined;
@@ -341,7 +341,7 @@ _GetSubscriptionRatePlan["default"].prototype['subscriptionRatePlanNumber'] = un
  */
 _GetSubscriptionRatePlan["default"].prototype['isFromExternalCatalog'] = undefined;
 /**
- * The last amendment on the rate plan.    **Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.   Possible Values:   * `Add`   * `Update`   * `Remove` 
+ * The last amendment on the rate plan.     **Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.    Possible Values:   * `Add`   * `Update`   * `Remove`
  * @member {module:model/GetSubscriptionRatePlan.LastChangeTypeEnum} lastChangeType
  */
 _GetSubscriptionRatePlan["default"].prototype['lastChangeType'] = undefined;
@@ -372,12 +372,12 @@ _GetSubscriptionRatePlan["default"].prototype['productRatePlanNumber'] = undefin
  */
 _GetSubscriptionRatePlan["default"].prototype['ratePlanName'] = undefined;
 /**
- * Container for one or more features.   Only available when the following settings are enabled:  * The Entitlements feature in your tenant.  * The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings
+ * Container for one or more features.    Only available when the following settings are enabled:   * The Entitlements feature in your tenant.   * The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings
  * @member {Array.<module:model/SubscriptionProductFeature>} subscriptionProductFeatures
  */
 _GetSubscriptionRatePlan["default"].prototype['subscriptionProductFeatures'] = 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
  */
 _GetSubscriptionRatePlan["default"].prototype['externallyManagedPlanId'] = undefined;

package/dist/zuora_api/model/SubscriptionStatusHistory.js

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

package/dist/zuora_api/model/SubscriptionTaxationItem.js

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

package/dist/zuora_api/model/SuspendSubscriptionRequest.js

@@ -29,13 +29,13 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SuspendSubscriptionRequest model module.
  * @module model/SuspendSubscriptionRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 var SuspendSubscriptionRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>SuspendSubscriptionRequest</code>.
    * @alias module:model/SuspendSubscriptionRequest
-   * @param suspend_policy {String} Suspend methods. Specify a way to suspend a subscription.   Value:  * `Today`: The subscription suspension takes effect on today's date. * `EndOfLastInvoicePeriod`: The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension.  * `SpecificDate`: The subscription suspension takes effect on a specific date. You must define the specific date in the `suspendSpecificDate` field. * `FixedPeriodsFromToday`: The subscription suspension takes effect after a specified period based on today's date. You must specify the `suspendPeriods` and `suspendPeriodsType` fields to define the period. 
+   * @param suspend_policy {String} Suspend methods. Specify a way to suspend a subscription.    Value:   * `Today`: The subscription suspension takes effect on today's date.  * `EndOfLastInvoicePeriod`: The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension.   * `SpecificDate`: The subscription suspension takes effect on a specific date. You must define the specific date in the `suspendSpecificDate` field.  * `FixedPeriodsFromToday`: The subscription suspension takes effect after a specified period based on today's date. You must specify the `suspendPeriods` and `suspendPeriodsType` fields to define the period.
    */
   function SuspendSubscriptionRequest(suspend_policy) {
     _classCallCheck(this, SuspendSubscriptionRequest);
@@ -214,37 +214,37 @@ var SuspendSubscriptionRequest = /*#__PURE__*/function () {
 SuspendSubscriptionRequest.RequiredProperties = ["suspendPolicy"];
 
 /**
- * The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. 
+ * The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.
  * @member {Array.<String>} applicationOrder
  */
 SuspendSubscriptionRequest.prototype['applicationOrder'] = undefined;
 
 /**
- * If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.   **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. 
+ * If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.    **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
  * @member {Boolean} applyCredit
  */
 SuspendSubscriptionRequest.prototype['applyCredit'] = undefined;
 
 /**
- * Whether to automatically apply a credit balance to an invoice.  If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.   To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.  Prerequisite: `invoice` must be `true`.   **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled. 
+ * Whether to automatically apply a credit balance to an invoice.   If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.    To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.   Prerequisite: `invoice` must be `true`.    **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled.
  * @member {Boolean} applyCreditBalance
  */
 SuspendSubscriptionRequest.prototype['applyCreditBalance'] = undefined;
 
 /**
- * The booking date that you want to set for the amendment contract when you suspend the subscription. If `resume` is `true`, which means you also choose to resume the subscription at some point, then this field is also the booking date for the Resume amendment contract.  This field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call.  
+ * The booking date that you want to set for the amendment contract when you suspend the subscription. If `resume` is `true`, which means you also choose to resume the subscription at some point, then this field is also the booking date for the Resume amendment contract.   This field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call. 
  * @member {String} bookingDate
  */
 SuspendSubscriptionRequest.prototype['bookingDate'] = undefined;
 
 /**
- * Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.  If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.  Prerequisite: The `invoice` or `runBilling` field must be `true`.   **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later. 
+ * Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.   Prerequisite: The `invoice` or `runBilling` field must be `true`.    **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later.
  * @member {Boolean} collect
  */
 SuspendSubscriptionRequest.prototype['collect'] = undefined;
 
 /**
- * The date when the customer notifies you that they want to amend their subscription. 
+ * The date when the customer notifies you that they want to amend their subscription.
  * @member {String} contractEffectiveDate
  */
 SuspendSubscriptionRequest.prototype['contractEffectiveDate'] = undefined;
@@ -256,13 +256,13 @@ SuspendSubscriptionRequest.prototype['contractEffectiveDate'] = undefined;
 SuspendSubscriptionRequest.prototype['creditMemoReasonCode'] = undefined;
 
 /**
- * The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. 
+ * The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.
  * @member {String} documentDate
  */
 SuspendSubscriptionRequest.prototype['documentDate'] = undefined;
 
 /**
- * Whether to extend the subscription term by the length of time the suspension is in effect. Values: `true`, `false`. 
+ * Whether to extend the subscription term by the length of time the suspension is in effect. Values: `true`, `false`.
  * @member {Boolean} extendsTerm
  */
 SuspendSubscriptionRequest.prototype['extendsTerm'] = undefined;
@@ -274,7 +274,7 @@ SuspendSubscriptionRequest.prototype['extendsTerm'] = undefined;
 SuspendSubscriptionRequest.prototype['invoice'] = undefined;
 
 /**
- * **Note:** This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility.   **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. 
+ * **Note:** This field has been replaced by the `invoice` field  and the `collect` field. `invoiceCollect` is available only for backward  compatibility.    **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.
  * @member {Boolean} invoiceCollect
  */
 SuspendSubscriptionRequest.prototype['invoiceCollect'] = undefined;
@@ -286,73 +286,73 @@ SuspendSubscriptionRequest.prototype['invoiceCollect'] = undefined;
 SuspendSubscriptionRequest.prototype['invoiceTargetDate'] = undefined;
 
 /**
- * The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers. 
+ * The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.  This field must be in the `yyyy-mm-dd` format.  This field is required for Orders customers only, not applicable to Orders Harmonization customers.
  * @member {String} orderDate
  */
 SuspendSubscriptionRequest.prototype['orderDate'] = undefined;
 
 /**
- * Whether to set when to resume a subscription when creating a suspend amendment. Values: `true`, `false`. 
+ * Whether to set when to resume a subscription when creating a suspend amendment. Values: `true`, `false`.
  * @member {Boolean} resume
  */
 SuspendSubscriptionRequest.prototype['resume'] = undefined;
 
 /**
- * The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period.  **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. 
+ * The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period.   **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.
  * @member {String} resumePeriods
  */
 SuspendSubscriptionRequest.prototype['resumePeriods'] = undefined;
 
 /**
- * The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the resumePeriods field to specify the period.  Values: `Day`, `Week`, `Month`, `Year`  **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. 
+ * The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the resumePeriods field to specify the period.   Values: `Day`, `Week`, `Month`, `Year`   **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.
  * @member {String} resumePeriodsType
  */
 SuspendSubscriptionRequest.prototype['resumePeriodsType'] = undefined;
 
 /**
- * Resume methods. Specify a way to resume a subscription. Values:  * `Today`: The subscription resumption takes effect on today's date.  * `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.  * `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field.  * `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period. * `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription. 
+ * Resume methods. Specify a way to resume a subscription. Values:   * `Today`: The subscription resumption takes effect on today's date.   * `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.   * `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field.   * `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.  * `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription.
  * @member {String} resumePolicy
  */
 SuspendSubscriptionRequest.prototype['resumePolicy'] = undefined;
 
 /**
- * A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd.  **Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`.  The value should not be earlier than the subscription suspension date. 
+ * A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd.   **Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`.   The value should not be earlier than the subscription suspension date.
  * @member {String} resumeSpecificDate
  */
 SuspendSubscriptionRequest.prototype['resumeSpecificDate'] = undefined;
 
 /**
- * Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).     The billing documents generated in this operation is only for this subscription, not for the entire customer account.   Possible values:  - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.   - `false`: No invoice is created.   **Note:** This field is in Zuora REST API version control. Supported minor versions are `211.0` or later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header. 
+ * Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).      The billing documents generated  in this operation is only for this subscription, not for the entire  customer account.    Possible values:   - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.    - `false`: No invoice is created.    **Note:** This field is in Zuora REST API version control. Supported  minor versions are `211.0` or later. To use this field in the method,  you must set the `zuora-version` parameter to the minor version number  in the request header.
  * @member {Boolean} runBilling
  */
 SuspendSubscriptionRequest.prototype['runBilling'] = undefined;
 
 /**
- * The length of the period used to specify when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the `suspendPeriodsType` field to specify the period.  **Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday. 
+ * The length of the period used to specify when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the `suspendPeriodsType` field to specify the period.   **Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday.
  * @member {String} suspendPeriods
  */
 SuspendSubscriptionRequest.prototype['suspendPeriods'] = undefined;
 
 /**
- * The period type used to define when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the suspendPeriods field to specify the period.  Type: string (enum)  Values: `Day`, `Week`, `Month`, `Year`  **Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday. 
+ * The period type used to define when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the suspendPeriods field to specify the period.   Type: string (enum)   Values: `Day`, `Week`, `Month`, `Year`   **Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday.
  * @member {String} suspendPeriodsType
  */
 SuspendSubscriptionRequest.prototype['suspendPeriodsType'] = undefined;
 
 /**
- * Suspend methods. Specify a way to suspend a subscription.   Value:  * `Today`: The subscription suspension takes effect on today's date. * `EndOfLastInvoicePeriod`: The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension.  * `SpecificDate`: The subscription suspension takes effect on a specific date. You must define the specific date in the `suspendSpecificDate` field. * `FixedPeriodsFromToday`: The subscription suspension takes effect after a specified period based on today's date. You must specify the `suspendPeriods` and `suspendPeriodsType` fields to define the period. 
+ * Suspend methods. Specify a way to suspend a subscription.    Value:   * `Today`: The subscription suspension takes effect on today's date.  * `EndOfLastInvoicePeriod`: The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension.   * `SpecificDate`: The subscription suspension takes effect on a specific date. You must define the specific date in the `suspendSpecificDate` field.  * `FixedPeriodsFromToday`: The subscription suspension takes effect after a specified period based on today's date. You must specify the `suspendPeriods` and `suspendPeriodsType` fields to define the period.
  * @member {String} suspendPolicy
  */
 SuspendSubscriptionRequest.prototype['suspendPolicy'] = undefined;
 
 /**
- * A specific date when the subscription suspension takes effect, in the format yyyy-mm-dd.  **Note:** This field is only applicable only when the suspendPolicy field is set to SpecificDate.  The value should not be earlier than the subscription contract effective date, later than the subscription term end date, or within a period for which the customer has been invoiced. 
+ * A specific date when the subscription suspension takes effect, in the format yyyy-mm-dd.   **Note:** This field is only applicable only when the suspendPolicy field is set to SpecificDate.   The value should not be earlier than the subscription contract effective date, later than the subscription term end date, or within a period for which the customer has been invoiced.
  * @member {String} suspendSpecificDate
  */
 SuspendSubscriptionRequest.prototype['suspendSpecificDate'] = undefined;
 
 /**
- * Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.   **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.   This field is in Zuora REST API version control. Supported minor versions are `211.0` and later. To use this field in the method, you must set the  `zuora-version` parameter to the minor version number in the request header. 
+ * Date through which to calculate charges if an invoice or a credit memo is generated, as  yyyy-mm-dd. Default is current date.    **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.    This field is in Zuora REST API version control. Supported minor  versions are `211.0` and later. To use this field in the method, you  must set the  `zuora-version` parameter to the minor version number in  the request header.
  * @member {String} targetDate
  */
 SuspendSubscriptionRequest.prototype['targetDate'] = undefined;

package/dist/zuora_api/model/SuspendSubscriptionResponse.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SuspendSubscriptionResponse model module.
  * @module model/SuspendSubscriptionResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 var SuspendSubscriptionResponse = /*#__PURE__*/function () {
   /**
@@ -190,7 +190,7 @@ var SuspendSubscriptionResponse = /*#__PURE__*/function () {
   }]);
 }();
 /**
- * The credit memo ID, if a credit memo is generated during the subscription process.  **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have  [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. 
+ * The credit memo ID, if a credit memo is generated during the subscription process.   **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have  [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
  * @member {String} creditMemoId
  */
 SuspendSubscriptionResponse.prototype['creditMemoId'] = undefined;
@@ -214,7 +214,7 @@ SuspendSubscriptionResponse.prototype['paidAmount'] = undefined;
 SuspendSubscriptionResponse.prototype['paymentId'] = undefined;
 
 /**
- * The date when subscription resumption takes effect, in the format yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend Tenants. 
+ * The date when subscription resumption takes effect, in the format yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend Tenants.
  * @member {String} resumeDate
  */
 SuspendSubscriptionResponse.prototype['resumeDate'] = undefined;
@@ -232,7 +232,7 @@ SuspendSubscriptionResponse.prototype['subscriptionId'] = undefined;
 SuspendSubscriptionResponse.prototype['success'] = undefined;
 
 /**
- * The date when subscription suspension takes effect, in the format yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend Tenants. 
+ * The date when subscription suspension takes effect, in the format yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend Tenants.
  * @member {String} suspendDate
  */
 SuspendSubscriptionResponse.prototype['suspendDate'] = undefined;
@@ -244,7 +244,7 @@ SuspendSubscriptionResponse.prototype['suspendDate'] = undefined;
 SuspendSubscriptionResponse.prototype['termEndDate'] = undefined;
 
 /**
- * Change in the total contracted value of the subscription as a result of the update. It is available for Orders Harmonization and Subscribe/Amend Tenants. 
+ * Change in the total contracted value of the subscription as a result of the update. It is available for Orders Harmonization and Subscribe/Amend Tenants.
  * @member {Number} totalDeltaTcv
  */
 SuspendSubscriptionResponse.prototype['totalDeltaTcv'] = undefined;

package/dist/zuora_api/model/SystemHealthErrorResponse.js

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

package/dist/zuora_api/model/Task.js

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

package/dist/zuora_api/model/TasksResponse.js

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

package/dist/zuora_api/model/TasksResponsePagination.js

@@ -26,12 +26,12 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The TasksResponsePagination model module.
  * @module model/TasksResponsePagination
- * @version 3.6.0
+ * @version 3.7.0
  */
 var TasksResponsePagination = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>TasksResponsePagination</code>.
-   * An object containing pagination information for the list of tasks returned by the API. 
+   * An object containing pagination information for the list of tasks returned by the API.
    * @alias module:model/TasksResponsePagination
    */
   function TasksResponsePagination() {
@@ -113,7 +113,7 @@ TasksResponsePagination.prototype['next_page'] = undefined;
 TasksResponsePagination.prototype['page'] = undefined;
 
 /**
- * An integer denoting the number of tasks in this response. The maximum value is 100. 
+ * An integer denoting the number of tasks in this response. The maximum value is 100.
  * @member {Number} page_length
  */
 TasksResponsePagination.prototype['page_length'] = undefined;

package/dist/zuora_api/model/TaxInfo.js

@@ -27,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The TaxInfo model module.
  * @module model/TaxInfo
- * @version 3.6.0
+ * @version 3.7.0
  */
 var TaxInfo = /*#__PURE__*/function () {
   /**
@@ -153,7 +153,7 @@ var TaxInfo = /*#__PURE__*/function () {
 TaxInfo.prototype['companyCode'] = undefined;
 
 /**
- * A unique entity use code to apply exemptions in Avalara AvaTax.  This account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details. 
+ * A unique entity use code to apply exemptions in Avalara AvaTax.   This account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details.
  * @member {String} exemptEntityUseCode
  */
 TaxInfo.prototype['exemptEntityUseCode'] = undefined;

package/dist/zuora_api/model/TaxItemsFinanceInformation.js

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

package/dist/zuora_api/model/TaxationItem.js

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

package/dist/zuora_api/model/TaxationItemFinanceInformation.js

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

package/dist/zuora_api/model/TaxationItemsData.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The TaxationItemsData model module.
  * @module model/TaxationItemsData
- * @version 3.6.0
+ * @version 3.7.0
  */
 var TaxationItemsData = /*#__PURE__*/function () {
   /**
@@ -128,7 +128,7 @@ var TaxationItemsData = /*#__PURE__*/function () {
 TaxationItemsData.prototype['data'] = undefined;
 
 /**
- * URL to retrieve the next page of the response if it exists; otherwise absent. 
+ * URL to retrieve the next page of the response if it exists; otherwise absent.
  * @member {String} nextPage
  */
 TaxationItemsData.prototype['nextPage'] = undefined;

package/dist/zuora_api/model/TaxationItemsDataResponse.js

@@ -33,7 +33,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The TaxationItemsDataResponse model module.
  * @module model/TaxationItemsDataResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 var TaxationItemsDataResponse = /*#__PURE__*/function () {
   /**
@@ -191,8 +191,9 @@ TaxationItemsDataResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-TaxationItemsDataResponse.prototype['success'] = undefined;
+TaxationItemsDataResponse.prototype['success'] = true;
 
 /**
  * Container for the taxation items of the invoice item. 
@@ -201,7 +202,7 @@ TaxationItemsDataResponse.prototype['success'] = undefined;
 TaxationItemsDataResponse.prototype['data'] = undefined;
 
 /**
- * URL to retrieve the next page of the response if it exists; otherwise absent. 
+ * URL to retrieve the next page of the response if it exists; otherwise absent.
  * @member {String} nextPage
  */
 TaxationItemsDataResponse.prototype['nextPage'] = undefined;
@@ -224,8 +225,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 TaxationItemsData interface:
 /**
  * Container for the taxation items of the invoice item. 
@@ -233,7 +235,7 @@ _CommonResponse["default"].prototype['success'] = undefined;
  */
 _TaxationItemsData["default"].prototype['data'] = undefined;
 /**
- * URL to retrieve the next page of the response if it exists; otherwise absent. 
+ * URL to retrieve the next page of the response if it exists; otherwise absent.
  * @member {String} nextPage
  */
 _TaxationItemsData["default"].prototype['nextPage'] = undefined;

package/dist/zuora_api/model/TermInfo.js

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

package/dist/zuora_api/model/Tier.js

@@ -29,13 +29,13 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The Tier model module.
  * @module model/Tier
- * @version 3.6.0
+ * @version 3.7.0
  */
 var Tier = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>Tier</code>.
    * @alias module:model/Tier
-   * @param price {Number} Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing. 
+   * @param price {Number} Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.
    * @param tier {Number} Unique number that identifies the tier that the price applies to. 
    */
   function Tier(price, tier) {
@@ -137,7 +137,7 @@ Tier.RequiredProperties = ["price", "tier"];
 Tier.prototype['endingUnit'] = undefined;
 
 /**
- * Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing. 
+ * Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.
  * @member {Number} price
  */
 Tier.prototype['price'] = undefined;

package/dist/zuora_api/model/TimeSlicedElpNetMetrics.js

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

package/dist/zuora_api/model/TimeSlicedMetrics.js

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

package/dist/zuora_api/model/TimeSlicedNetMetrics.js

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

package/dist/zuora_api/model/TimeSlicedTcbNetMetrics.js

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

package/dist/zuora_api/model/TokenResponse.js

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

package/dist/zuora_api/model/TransferContactRequest.js

@@ -29,13 +29,13 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The TransferContactRequest model module.
  * @module model/TransferContactRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 var TransferContactRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>TransferContactRequest</code>.
    * @alias module:model/TransferContactRequest
-   * @param destination_account_key {String} The ID or number of the destination account. 
+   * @param destination_account_key {String} The ID or number of the destination account.
    */
   function TransferContactRequest(destination_account_key) {
     _classCallCheck(this, TransferContactRequest);
@@ -117,7 +117,7 @@ var TransferContactRequest = /*#__PURE__*/function () {
 TransferContactRequest.RequiredProperties = ["destinationAccountKey"];
 
 /**
- * The ID or number of the destination account. 
+ * The ID or number of the destination account.
  * @member {String} destinationAccountKey
  */
 TransferContactRequest.prototype['destinationAccountKey'] = undefined;

package/dist/zuora_api/model/TransferPayment.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The TransferPayment model module.
  * @module model/TransferPayment
- * @version 3.6.0
+ * @version 3.7.0
  */
 var TransferPayment = /*#__PURE__*/function () {
   /**
@@ -94,7 +94,7 @@ var TransferPayment = /*#__PURE__*/function () {
   }]);
 }();
 /**
- * The ID of the customer account that the payment is transferred to. Unassign a payment by setting this field to an empty string. This will automatically transfer the payment to a null account. 
+ * The ID of the customer account that the payment is transferred to.  Unassign a payment by setting this field to an empty string. This will automatically transfer the payment to a null account.
  * @member {String} accountId
  */
 TransferPayment.prototype['accountId'] = undefined;