zuora-sdk-js 3.6.0 → 3.7.0

package/src/zuora_api/model/CreateOrderTermsAndConditions.js

@@ -19,7 +19,7 @@ import RenewalTerm from './RenewalTerm';
 /**
  * The CreateOrderTermsAndConditions model module.
  * @module model/CreateOrderTermsAndConditions
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreateOrderTermsAndConditions {
     /**
@@ -220,7 +220,7 @@ class CreateOrderTermsAndConditions {
 CreateOrderTermsAndConditions.prototype['autoRenew'] = undefined;
 
 /**
- * The ID of the bill-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
+ * The ID of the bill-to contact associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
  * @member {String} billToContactId
  */
 CreateOrderTermsAndConditions.prototype['billToContactId'] = undefined;
@@ -267,7 +267,7 @@ CreateOrderTermsAndConditions.prototype['clearingExistingSoldToContact'] = false
 CreateOrderTermsAndConditions.prototype['invoiceSeparately'] = undefined;
 
 /**
- * The ID of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
+ * The ID of the invoice template associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
  * @member {String} invoiceTemplateId
  */
 CreateOrderTermsAndConditions.prototype['invoiceTemplateId'] = undefined;
@@ -284,7 +284,7 @@ CreateOrderTermsAndConditions.prototype['lastTerm'] = undefined;
 CreateOrderTermsAndConditions.prototype['termIncreaseToNewContractLine'] = undefined;
 
 /**
- * The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
+ * The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
  * @member {String} paymentTerm
  */
 CreateOrderTermsAndConditions.prototype['paymentTerm'] = undefined;
@@ -342,7 +342,7 @@ CreateOrderTermsAndConditions.prototype['clearingScheduledResumeDate'] = undefin
 CreateOrderTermsAndConditions.prototype['sequenceSetId'] = undefined;
 
 /**
- * The ID of the sold-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
+ * The ID of the sold-to contact associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. 
  * @member {String} soldToContactId
  */
 CreateOrderTermsAndConditions.prototype['soldToContactId'] = undefined;
@@ -354,7 +354,7 @@ CreateOrderTermsAndConditions.prototype['soldToContactId'] = undefined;
 CreateOrderTermsAndConditions.prototype['shipToContactId'] = undefined;
 
 /**
- * Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. 
+ * Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field.
  * @member {Boolean} clearingExistingShipToContact
  */
 CreateOrderTermsAndConditions.prototype['clearingExistingShipToContact'] = undefined;
@@ -366,7 +366,7 @@ CreateOrderTermsAndConditions.prototype['clearingExistingShipToContact'] = undef
 CreateOrderTermsAndConditions.prototype['communicationProfileId'] = undefined;
 
 /**
- * Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field. 
+ * Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field.
  * @member {Boolean} clearingExistingCommunicationProfile
  */
 CreateOrderTermsAndConditions.prototype['clearingExistingCommunicationProfile'] = undefined;
@@ -378,7 +378,7 @@ CreateOrderTermsAndConditions.prototype['clearingExistingCommunicationProfile']
 CreateOrderTermsAndConditions.prototype['invoiceGroupNumber'] = undefined;
 
 /**
- * Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field. **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled. 
+ * Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.
  * @member {Boolean} clearingExistingInvoiceGroupNumber
  * @default false
  */

package/src/zuora_api/model/CreateOrderUpdateProduct.js

@@ -19,12 +19,12 @@ import CreateOrderRatePlanUpdate from './CreateOrderRatePlanUpdate';
 /**
  * The CreateOrderUpdateProduct model module.
  * @module model/CreateOrderUpdateProduct
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreateOrderUpdateProduct {
     /**
      * Constructs a new <code>CreateOrderUpdateProduct</code>.
-     * A rate plan can be updated in a subscription through one order action.   - For a rate plan, the following fields are available:       - &#x60;chargeUpdates&#x60;       - &#x60;clearingExistingFeatures&#x60;       - &#x60;customFields&#x60;       - &#x60;externalCatalogPlanId&#x60;         - &#x60;ratePlanId&#x60;       - &#x60;productRatePlanNumber&#x60;       - &#x60;subscriptionRatePlanNumber&#x60;       - &#x60;uniqueToken&#x60;       - &#x60;specificUpdateDate&#x60;       - &#x60;subscriptionProductFeatures&#x60;       - &#x60;uniqueToken&#x60; 
+     * A rate plan can be updated in a subscription through one order action.   - For a rate plan, the following fields are available:       - &#x60;chargeUpdates&#x60;       - &#x60;clearingExistingFeatures&#x60;       - &#x60;customFields&#x60;       - &#x60;externalCatalogPlanId&#x60;         - &#x60;ratePlanId&#x60;       - &#x60;productRatePlanNumber&#x60;       - &#x60;subscriptionRatePlanNumber&#x60;       - &#x60;uniqueToken&#x60;       - &#x60;specificUpdateDate&#x60;       - &#x60;subscriptionProductFeatures&#x60;       - &#x60;uniqueToken&#x60;
      * @alias module:model/CreateOrderUpdateProduct
      * @implements module:model/CreateOrderRatePlanUpdate
      */
@@ -156,7 +156,7 @@ class CreateOrderUpdateProduct {
 
 
 /**
- * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. 
+ * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.
  * @member {Array.<module:model/CreateOrderChargeUpdate>} chargeUpdates
  */
 CreateOrderUpdateProduct.prototype['chargeUpdates'] = undefined;
@@ -168,13 +168,13 @@ CreateOrderUpdateProduct.prototype['chargeUpdates'] = undefined;
 CreateOrderUpdateProduct.prototype['clearingExistingFeatures'] = undefined;
 
 /**
- * Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed. 
+ * Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.
  * @member {Object.<String, Object>} customFields
  */
 CreateOrderUpdateProduct.prototype['customFields'] = undefined;
 
 /**
- * An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.  **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. 
+ * An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
  * @member {String} externalCatalogPlanId
  */
 CreateOrderUpdateProduct.prototype['externalCatalogPlanId'] = undefined;
@@ -186,19 +186,19 @@ CreateOrderUpdateProduct.prototype['externalCatalogPlanId'] = undefined;
 CreateOrderUpdateProduct.prototype['productRatePlanNumber'] = undefined;
 
 /**
- * The id of the rate plan to be updated. It can be the latest version or any history version id. 
+ * The id of the rate plan to be updated. It can be the latest version or any history version id.
  * @member {String} ratePlanId
  */
 CreateOrderUpdateProduct.prototype['ratePlanId'] = undefined;
 
 /**
- * The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.  See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature. 
+ * The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.   See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
  * @member {String} specificUpdateDate
  */
 CreateOrderUpdateProduct.prototype['specificUpdateDate'] = undefined;
 
 /**
- * List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. 
+ * List of features associated with the rate plan.  The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
  * @member {Array.<module:model/CreateOrderRatePlanFeatureOverride>} subscriptionProductFeatures
  */
 CreateOrderUpdateProduct.prototype['subscriptionProductFeatures'] = undefined;
@@ -210,7 +210,7 @@ CreateOrderUpdateProduct.prototype['subscriptionProductFeatures'] = undefined;
 CreateOrderUpdateProduct.prototype['subscriptionRatePlanNumber'] = undefined;
 
 /**
- * A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions. 
+ * A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.
  * @member {String} uniqueToken
  */
 CreateOrderUpdateProduct.prototype['uniqueToken'] = undefined;
@@ -224,7 +224,7 @@ CreateOrderUpdateProduct.prototype['isAddingSubsetCharges'] = undefined;
 
 // Implement CreateOrderRatePlanUpdate interface:
 /**
- * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. 
+ * Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.
  * @member {Array.<module:model/CreateOrderChargeUpdate>} chargeUpdates
  */
 CreateOrderRatePlanUpdate.prototype['chargeUpdates'] = undefined;
@@ -234,12 +234,12 @@ CreateOrderRatePlanUpdate.prototype['chargeUpdates'] = undefined;
  */
 CreateOrderRatePlanUpdate.prototype['clearingExistingFeatures'] = undefined;
 /**
- * Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed. 
+ * Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.
  * @member {Object.<String, Object>} customFields
  */
 CreateOrderRatePlanUpdate.prototype['customFields'] = undefined;
 /**
- * An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.  **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. 
+ * An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
  * @member {String} externalCatalogPlanId
  */
 CreateOrderRatePlanUpdate.prototype['externalCatalogPlanId'] = undefined;
@@ -249,17 +249,17 @@ CreateOrderRatePlanUpdate.prototype['externalCatalogPlanId'] = undefined;
  */
 CreateOrderRatePlanUpdate.prototype['productRatePlanNumber'] = undefined;
 /**
- * The id of the rate plan to be updated. It can be the latest version or any history version id. 
+ * The id of the rate plan to be updated. It can be the latest version or any history version id.
  * @member {String} ratePlanId
  */
 CreateOrderRatePlanUpdate.prototype['ratePlanId'] = undefined;
 /**
- * The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.  See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature. 
+ * The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.   See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
  * @member {String} specificUpdateDate
  */
 CreateOrderRatePlanUpdate.prototype['specificUpdateDate'] = undefined;
 /**
- * List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. 
+ * List of features associated with the rate plan.  The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
  * @member {Array.<module:model/CreateOrderRatePlanFeatureOverride>} subscriptionProductFeatures
  */
 CreateOrderRatePlanUpdate.prototype['subscriptionProductFeatures'] = undefined;
@@ -269,7 +269,7 @@ CreateOrderRatePlanUpdate.prototype['subscriptionProductFeatures'] = undefined;
  */
 CreateOrderRatePlanUpdate.prototype['subscriptionRatePlanNumber'] = undefined;
 /**
- * A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions. 
+ * A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.
  * @member {String} uniqueToken
  */
 CreateOrderRatePlanUpdate.prototype['uniqueToken'] = undefined;

package/src/zuora_api/model/CreatePaymentDebitMemoApplication.js

@@ -17,7 +17,7 @@ import CreatePaymentDebitMemoApplicationItem from './CreatePaymentDebitMemoAppli
 /**
  * The CreatePaymentDebitMemoApplication model module.
  * @module model/CreatePaymentDebitMemoApplication
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentDebitMemoApplication {
     /**
@@ -133,7 +133,7 @@ CreatePaymentDebitMemoApplication.prototype['debitMemoId'] = undefined;
 CreatePaymentDebitMemoApplication.prototype['debitMemoNumber'] = undefined;
 
 /**
- * Container for debit memo items. The maximum number of items is 1,000.  **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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. 
+ * Container for debit memo items. The maximum number of items is 1,000.   **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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 {Array.<module:model/CreatePaymentDebitMemoApplicationItem>} items
  */
 CreatePaymentDebitMemoApplication.prototype['items'] = undefined;

package/src/zuora_api/model/CreatePaymentDebitMemoApplicationItem.js

@@ -16,13 +16,13 @@ import ApiClient from '../ApiClient';
 /**
  * The CreatePaymentDebitMemoApplicationItem model module.
  * @module model/CreatePaymentDebitMemoApplicationItem
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentDebitMemoApplicationItem {
     /**
      * Constructs a new <code>CreatePaymentDebitMemoApplicationItem</code>.
      * @alias module:model/CreatePaymentDebitMemoApplicationItem
-     * @param amount {Number} The amount of the payment associated with the specific debit memo or taxation item. 
+     * @param amount {Number} The amount of the payment associated with the specific debit memo or taxation item.
      */
     constructor(amount) { 
         
@@ -102,7 +102,7 @@ class CreatePaymentDebitMemoApplicationItem {
 CreatePaymentDebitMemoApplicationItem.RequiredProperties = ["amount"];
 
 /**
- * The amount of the payment associated with the specific debit memo or taxation item. 
+ * The amount of the payment associated with the specific debit memo or taxation item.
  * @member {Number} amount
  */
 CreatePaymentDebitMemoApplicationItem.prototype['amount'] = undefined;

package/src/zuora_api/model/CreatePaymentInvoiceApplication.js

@@ -17,13 +17,13 @@ import CreatePaymentInvoiceApplicationItem from './CreatePaymentInvoiceApplicati
 /**
  * The CreatePaymentInvoiceApplication model module.
  * @module model/CreatePaymentInvoiceApplication
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentInvoiceApplication {
     /**
      * Constructs a new <code>CreatePaymentInvoiceApplication</code>.
      * @alias module:model/CreatePaymentInvoiceApplication
-     * @param amount {Number} The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice. 
+     * @param amount {Number} The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice.
      */
     constructor(amount) { 
         
@@ -116,13 +116,13 @@ class CreatePaymentInvoiceApplication {
 CreatePaymentInvoiceApplication.RequiredProperties = ["amount"];
 
 /**
- * The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice. 
+ * The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice.
  * @member {Number} amount
  */
 CreatePaymentInvoiceApplication.prototype['amount'] = undefined;
 
 /**
- * The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`. 
+ * The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`.
  * @member {String} invoiceId
  */
 CreatePaymentInvoiceApplication.prototype['invoiceId'] = undefined;
@@ -133,7 +133,7 @@ CreatePaymentInvoiceApplication.prototype['invoiceId'] = undefined;
 CreatePaymentInvoiceApplication.prototype['invoiceNumber'] = undefined;
 
 /**
- * Container for invoice items. The maximum number of items is 1,000.  **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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. 
+ * Container for invoice items. The maximum number of items is 1,000.   **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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 {Array.<module:model/CreatePaymentInvoiceApplicationItem>} items
  */
 CreatePaymentInvoiceApplication.prototype['items'] = undefined;

package/src/zuora_api/model/CreatePaymentInvoiceApplicationItem.js

@@ -16,13 +16,13 @@ import ApiClient from '../ApiClient';
 /**
  * The CreatePaymentInvoiceApplicationItem model module.
  * @module model/CreatePaymentInvoiceApplicationItem
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentInvoiceApplicationItem {
     /**
      * Constructs a new <code>CreatePaymentInvoiceApplicationItem</code>.
      * @alias module:model/CreatePaymentInvoiceApplicationItem
-     * @param amount {Number} The amount of the payment associated with the specific invoice or taxation item. 
+     * @param amount {Number} The amount of the payment associated with the specific invoice or taxation item.
      */
     constructor(amount) { 
         
@@ -102,7 +102,7 @@ class CreatePaymentInvoiceApplicationItem {
 CreatePaymentInvoiceApplicationItem.RequiredProperties = ["amount"];
 
 /**
- * The amount of the payment associated with the specific invoice or taxation item. 
+ * The amount of the payment associated with the specific invoice or taxation item.
  * @member {Number} amount
  */
 CreatePaymentInvoiceApplicationItem.prototype['amount'] = undefined;

package/src/zuora_api/model/CreatePaymentMethodACH.js

@@ -17,7 +17,7 @@ import PaymentMethodACHBankAccountType from './PaymentMethodACHBankAccountType';
 /**
  * The CreatePaymentMethodACH model module.
  * @module model/CreatePaymentMethodACH
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentMethodACH {
     /**
@@ -193,7 +193,7 @@ CreatePaymentMethodACH.prototype['bankABACode'] = undefined;
 CreatePaymentMethodACH.prototype['bankAccountName'] = undefined;
 
 /**
- * The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. However, for creating tokenized ACH payment methods on  Stripe v2, this field is optional if the `tokens` and `bankAccountMaskNumber` fields are specified. 
+ * The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. However, for creating tokenized ACH payment methods on Stripe v2, this field is optional if the `tokens` and `bankAccountMaskNumber` fields are specified. 
  * @member {String} bankAccountNumber
  */
 CreatePaymentMethodACH.prototype['bankAccountNumber'] = undefined;

package/src/zuora_api/model/CreatePaymentMethodApplePayAdyen.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CreatePaymentMethodApplePayAdyen model module.
  * @module model/CreatePaymentMethodApplePayAdyen
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentMethodApplePayAdyen {
     /**
@@ -84,7 +84,7 @@ class CreatePaymentMethodApplePayAdyen {
 
 
 /**
- * This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay). 
+ * This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay).
  * @member {String} applePaymentData
  */
 CreatePaymentMethodApplePayAdyen.prototype['applePaymentData'] = undefined;

package/src/zuora_api/model/CreatePaymentMethodBankTransfer.js

@@ -17,7 +17,7 @@ import CreatePaymentMethodBankTransferAccountHolderInfo from './CreatePaymentMet
 /**
  * The CreatePaymentMethodBankTransfer model module.
  * @module model/CreatePaymentMethodBankTransfer
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentMethodBankTransfer {
     /**
@@ -141,7 +141,7 @@ class CreatePaymentMethodBankTransfer {
 
 
 /**
- * The International Bank Account Number. This field is required if the `type` field is set to `SEPA`. 
+ * The International Bank Account Number. This field is required if the `type` field is set to `SEPA`.
  * @member {String} IBAN
  */
 CreatePaymentMethodBankTransfer.prototype['IBAN'] = undefined;
@@ -152,25 +152,25 @@ CreatePaymentMethodBankTransfer.prototype['IBAN'] = undefined;
 CreatePaymentMethodBankTransfer.prototype['accountHolderInfo'] = undefined;
 
 /**
- * The number of the customer's bank account. This field is required for the following bank transfer payment methods:   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The number of the customer's bank account. This field is required for the following bank transfer payment methods:   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} accountNumber
  */
 CreatePaymentMethodBankTransfer.prototype['accountNumber'] = undefined;
 
 /**
- * The masked account number of the payment method. 
+ * The masked account number of the payment method.
  * @member {String} accountMaskNumber
  */
 CreatePaymentMethodBankTransfer.prototype['accountMaskNumber'] = undefined;
 
 /**
- * The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:   - Direct Debit UK (`Bacs`)   - Denmark Direct Debit (`Betalingsservice`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} bankCode
  */
 CreatePaymentMethodBankTransfer.prototype['bankCode'] = undefined;
 
 /**
- * The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:   - Sweden Direct Debit (`Autogiro`)   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`) 
+ * The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:   - Sweden Direct Debit (`Autogiro`)   - Direct Entry AU (`Becs`)   - Direct Debit NZ (`Becsnz`)   - Canadian Pre-Authorized Debit (`PAD`)
  * @member {String} branchCode
  */
 CreatePaymentMethodBankTransfer.prototype['branchCode'] = undefined;
@@ -182,13 +182,13 @@ CreatePaymentMethodBankTransfer.prototype['branchCode'] = undefined;
 CreatePaymentMethodBankTransfer.prototype['businessIdentificationCode'] = undefined;
 
 /**
- * The currency used for payment method authorization.  If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used. 
+ * The currency used for payment method authorization.   If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
  * @member {String} currencyCode
  */
 CreatePaymentMethodBankTransfer.prototype['currencyCode'] = undefined;
 
 /**
- * The identity number of the customer. This field is required for the following bank transfer payment methods:   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`) 
+ * The identity number of the customer. This field is required for the following bank transfer payment methods:   - Denmark Direct Debit (`Betalingsservice`)   - Sweden Direct Debit (`Autogiro`)
  * @member {String} identityNumber
  */
 CreatePaymentMethodBankTransfer.prototype['identityNumber'] = undefined;

package/src/zuora_api/model/CreatePaymentMethodBankTransferAccountHolderInfo.js

@@ -16,12 +16,12 @@ import ApiClient from '../ApiClient';
 /**
  * The CreatePaymentMethodBankTransferAccountHolderInfo model module.
  * @module model/CreatePaymentMethodBankTransferAccountHolderInfo
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentMethodBankTransferAccountHolderInfo {
     /**
      * Constructs a new <code>CreatePaymentMethodBankTransferAccountHolderInfo</code>.
-     * This container field is required for the following bank transfer payment methods. The nested &#x60;accountHolderName&#x60; field is required.   - Direct Debit NZ (&#x60;Becsnz&#x60;)   - Single Euro Payments Area (&#x60;SEPA&#x60;)   - Direct Debit UK (&#x60;Bacs&#x60;)   - Denmark Direct Debit (&#x60;Betalingsservice&#x60;)   - Sweden Direct Debit (&#x60;Autogiro&#x60;)   - Canadian Pre-Authorized Debit (&#x60;PAD&#x60;) 
+     * This container field is required for the following bank transfer payment methods. The nested &#x60;accountHolderName&#x60; field is required.   - Direct Debit NZ (&#x60;Becsnz&#x60;)   - Single Euro Payments Area (&#x60;SEPA&#x60;)   - Direct Debit UK (&#x60;Bacs&#x60;)   - Denmark Direct Debit (&#x60;Betalingsservice&#x60;)   - Sweden Direct Debit (&#x60;Autogiro&#x60;)   - Canadian Pre-Authorized Debit (&#x60;PAD&#x60;)
      * @alias module:model/CreatePaymentMethodBankTransferAccountHolderInfo
      */
     constructor() { 
@@ -161,7 +161,7 @@ class CreatePaymentMethodBankTransferAccountHolderInfo {
 CreatePaymentMethodBankTransferAccountHolderInfo.prototype['accountHolderName'] = undefined;
 
 /**
- * The first line of the address for the account holder.  This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). 
+ * The first line of the address for the account holder.   This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
  * @member {String} addressLine1
  */
 CreatePaymentMethodBankTransferAccountHolderInfo.prototype['addressLine1'] = undefined;
@@ -173,13 +173,13 @@ CreatePaymentMethodBankTransferAccountHolderInfo.prototype['addressLine1'] = und
 CreatePaymentMethodBankTransferAccountHolderInfo.prototype['addressLine2'] = undefined;
 
 /**
- * The city where the account holder stays.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. 
+ * The city where the account holder stays.   It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
  * @member {String} city
  */
 CreatePaymentMethodBankTransferAccountHolderInfo.prototype['city'] = undefined;
 
 /**
- * The country where the account holder stays.  This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). 
+ * The country where the account holder stays.   This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
  * @member {String} country
  */
 CreatePaymentMethodBankTransferAccountHolderInfo.prototype['country'] = undefined;

package/src/zuora_api/model/CreatePaymentMethodCCReferenceTransaction.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CreatePaymentMethodCCReferenceTransaction model module.
  * @module model/CreatePaymentMethodCCReferenceTransaction
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentMethodCCReferenceTransaction {
     /**
@@ -98,19 +98,19 @@ class CreatePaymentMethodCCReferenceTransaction {
 
 
 /**
- * The masked credit card number, such as: ``` *********1112 ```  This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.  Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked. 
+ * The masked credit card number, such as:  ```  *********1112  ```   This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.   Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked.
  * @member {String} creditCardMaskNumber
  */
 CreatePaymentMethodCCReferenceTransaction.prototype['creditCardMaskNumber'] = undefined;
 
 /**
- * A gateway unique identifier that replaces sensitive payment method data.   `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method. 
+ * A gateway unique identifier that replaces sensitive payment method data.    `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method.
  * @member {String} secondTokenId
  */
 CreatePaymentMethodCCReferenceTransaction.prototype['secondTokenId'] = undefined;
 
 /**
- * A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.  When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.  The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.  **Note:** When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field. 
+ * A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.   When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.   The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.   **Note:** When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field.
  * @member {String} tokenId
  */
 CreatePaymentMethodCCReferenceTransaction.prototype['tokenId'] = undefined;

package/src/zuora_api/model/CreatePaymentMethodCardholderInfo.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CreatePaymentMethodCardholderInfo model module.
  * @module model/CreatePaymentMethodCardholderInfo
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentMethodCardholderInfo {
     /**
@@ -153,19 +153,19 @@ CreatePaymentMethodCardholderInfo.prototype['addressLine1'] = undefined;
 CreatePaymentMethodCardholderInfo.prototype['addressLine2'] = undefined;
 
 /**
- * The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less. 
+ * The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less.
  * @member {String} cardHolderName
  */
 CreatePaymentMethodCardholderInfo.prototype['cardHolderName'] = undefined;
 
 /**
- * City, 40 characters or less. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. 
+ * City, 40 characters or less.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
  * @member {String} city
  */
 CreatePaymentMethodCardholderInfo.prototype['city'] = undefined;
 
 /**
- * Country, must be a valid country name or abbreviation. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. 
+ * Country, must be a valid country name or abbreviation.  It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
  * @member {String} country
  */
 CreatePaymentMethodCardholderInfo.prototype['country'] = undefined;

package/src/zuora_api/model/CreatePaymentMethodCommon.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The CreatePaymentMethodCommon model module.
  * @module model/CreatePaymentMethodCommon
- * @version 3.6.0
+ * @version 3.7.0
  */
 class CreatePaymentMethodCommon {
     /**
@@ -107,19 +107,19 @@ class CreatePaymentMethodCommon {
 CreatePaymentMethodCommon.prototype['accountKey'] = undefined;
 
 /**
- * Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.  If you do not set this field, Zuora will use one of the following payment gateways instead:  * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. 
+ * Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.   If you do not set this field, Zuora will use one of the following payment gateways instead:   * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.  * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.
  * @member {String} authGateway
  */
 CreatePaymentMethodCommon.prototype['authGateway'] = undefined;
 
 /**
- * The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.   If the IP address length is beyond 45 characters, a validation error occurs.  For validating SEPA payment methods on Stripe v2, this field is required. 
+ * The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.    If the IP address length is beyond 45 characters, a validation error occurs.   For validating SEPA payment methods on Stripe v2, this field is required.
  * @member {String} ipAddress
  */
 CreatePaymentMethodCommon.prototype['ipAddress'] = undefined;
 
 /**
- * Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. 
+ * Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set.
  * @member {Boolean} makeDefault
  * @default false
  */