zuora-sdk-js 3.6.0 → 3.7.0

package/src/zuora_api/model/UpdateOpenPaymentMethodTypeRequest.js

@@ -17,17 +17,17 @@ import OpenPaymentMethodTypeRequestFields from './OpenPaymentMethodTypeRequestFi
 /**
  * The UpdateOpenPaymentMethodTypeRequest model module.
  * @module model/UpdateOpenPaymentMethodTypeRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOpenPaymentMethodTypeRequest {
     /**
      * Constructs a new <code>UpdateOpenPaymentMethodTypeRequest</code>.
      * @alias module:model/UpdateOpenPaymentMethodTypeRequest
      * @param fields {Array.<module:model/OpenPaymentMethodTypeRequestFields>} An array containing field metadata of the custom payment method type.  Notes:   - All the following nested metadata fields must be provided in the request to define a field.    - At least one field must be defined in the fields array for a custom payment method type.    - Up to 20 fields can be defined in the fields array for a custom method type. 
-     * @param internal_name {String} A string to identify the custom payment method type in the API name of the payment method type.  The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.  This field cannot be updated after the creation of the custom payment method type.  This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:  `<internalName>__c_<tenantId>`  For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`. 
-     * @param label {String} The label that is used to refer to this type in the Zuora UI.  This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ”  
-     * @param method_reference_id_field {String} The identification reference of the custom payment method.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.  The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.  This field cannot be updated after the creation of the custom payment method type. 
-     * @param tenant_id {String} Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.  This field cannot be updated after the creation of the custom payment method type. 
+     * @param internal_name {String} A string to identify the custom payment method type in the API name of the payment method type.   The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.   This field cannot be updated after the creation of the custom payment method type.   This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:   `<internalName>__c_<tenantId>`   For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.
+     * @param label {String} The label that is used to refer to this type in the Zuora UI.   This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ” 
+     * @param method_reference_id_field {String} The identification reference of the custom payment method.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.   The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.   This field cannot be updated after the creation of the custom payment method type.
+     * @param tenant_id {String} Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.   This field cannot be updated after the creation of the custom payment method type.
      */
     constructor(fields, internal_name, label, method_reference_id_field, tenant_id) { 
         
@@ -156,7 +156,7 @@ class UpdateOpenPaymentMethodTypeRequest {
 UpdateOpenPaymentMethodTypeRequest.RequiredProperties = ["fields", "internalName", "label", "methodReferenceIdField", "tenantId"];
 
 /**
- * If this custom payment method type is specific to one entity only, specify the entity ID in UUID format when creating the draft payment method type, such as `123e4567-e89b-12d3-a456-426614174000`.  You can only update this field to be empty, indicating that this custom payment method type is available to the global entity and all the sub entities in the tenant. 
+ * If this custom payment method type is specific to one entity only, specify the entity ID in UUID format when creating the draft payment method type, such as `123e4567-e89b-12d3-a456-426614174000`.   You can only update this field to be empty, indicating that this custom payment method type is available to the global entity and all the sub entities in the tenant.
  * @member {String} entityId
  */
 UpdateOpenPaymentMethodTypeRequest.prototype['entityId'] = undefined;
@@ -168,37 +168,37 @@ UpdateOpenPaymentMethodTypeRequest.prototype['entityId'] = undefined;
 UpdateOpenPaymentMethodTypeRequest.prototype['fields'] = undefined;
 
 /**
- * A string to identify the custom payment method type in the API name of the payment method type.  The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.  This field cannot be updated after the creation of the custom payment method type.  This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:  `<internalName>__c_<tenantId>`  For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`. 
+ * A string to identify the custom payment method type in the API name of the payment method type.   The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.   This field cannot be updated after the creation of the custom payment method type.   This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:   `<internalName>__c_<tenantId>`   For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.
  * @member {String} internalName
  */
 UpdateOpenPaymentMethodTypeRequest.prototype['internalName'] = undefined;
 
 /**
- * The label that is used to refer to this type in the Zuora UI.  This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ”  
+ * The label that is used to refer to this type in the Zuora UI.   This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ” 
  * @member {String} label
  */
 UpdateOpenPaymentMethodTypeRequest.prototype['label'] = undefined;
 
 /**
- * The identification reference of the custom payment method.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.  The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.  This field cannot be updated after the creation of the custom payment method type. 
+ * The identification reference of the custom payment method.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.   The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.   This field cannot be updated after the creation of the custom payment method type.
  * @member {String} methodReferenceIdField
  */
 UpdateOpenPaymentMethodTypeRequest.prototype['methodReferenceIdField'] = undefined;
 
 /**
- * The identification reference indicating the subtype of the custom payment method.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.  This field cannot be updated after the creation of the custom payment method type. 
+ * The identification reference indicating the subtype of the custom payment method.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.   This field cannot be updated after the creation of the custom payment method type.
  * @member {String} subTypeField
  */
 UpdateOpenPaymentMethodTypeRequest.prototype['subTypeField'] = undefined;
 
 /**
- * Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.  This field cannot be updated after the creation of the custom payment method type. 
+ * Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.   This field cannot be updated after the creation of the custom payment method type.
  * @member {String} tenantId
  */
 UpdateOpenPaymentMethodTypeRequest.prototype['tenantId'] = undefined;
 
 /**
- * The identification reference of the user or customer account.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.  This field cannot be updated after the creation of the custom payment method type. 
+ * The identification reference of the user or customer account.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.   This field cannot be updated after the creation of the custom payment method type.
  * @member {String} userReferenceIdField
  */
 UpdateOpenPaymentMethodTypeRequest.prototype['userReferenceIdField'] = undefined;

package/src/zuora_api/model/UpdateOrderAction.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The UpdateOrderAction model module.
  * @module model/UpdateOrderAction
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderAction {
     /**
@@ -87,7 +87,7 @@ class UpdateOrderAction {
 
 
 /**
- * The change reason set for an order action when the order action is updated. 
+ * The change reason set for an order action when the order action is updated.
  * @member {String} changeReason
  */
 UpdateOrderAction.prototype['changeReason'] = undefined;

package/src/zuora_api/model/UpdateOrderActionChargeTriggerDate.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The UpdateOrderActionChargeTriggerDate model module.
  * @module model/UpdateOrderActionChargeTriggerDate
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderActionChargeTriggerDate {
     /**

package/src/zuora_api/model/UpdateOrderActionRequest.js

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

package/src/zuora_api/model/UpdateOrderActionTriggerDate.js

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

package/src/zuora_api/model/UpdateOrderActionTriggerDates.js

@@ -18,7 +18,7 @@ import UpdateOrderActionTriggerDate from './UpdateOrderActionTriggerDate';
 /**
  * The UpdateOrderActionTriggerDates model module.
  * @module model/UpdateOrderActionTriggerDates
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderActionTriggerDates {
     /**

package/src/zuora_api/model/UpdateOrderActionTriggerDatesRequest.js

@@ -17,13 +17,13 @@ import UpdateOrderActionTriggerDates from './UpdateOrderActionTriggerDates';
 /**
  * The UpdateOrderActionTriggerDatesRequest model module.
  * @module model/UpdateOrderActionTriggerDatesRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderActionTriggerDatesRequest {
     /**
      * Constructs a new <code>UpdateOrderActionTriggerDatesRequest</code>.
      * @alias module:model/UpdateOrderActionTriggerDatesRequest
-     * @param subscription_number {String} Subscription number of a subscription in the `Pending` order for which you are to update the triggering dates. For example, A-S00000001. 
+     * @param subscription_number {String} Subscription number of a subscription in the `Pending` order for which you are to update the triggering dates. For example, A-S00000001.
      */
     constructor(subscription_number) { 
         
@@ -111,7 +111,7 @@ UpdateOrderActionTriggerDatesRequest.RequiredProperties = ["subscriptionNumber"]
 UpdateOrderActionTriggerDatesRequest.prototype['orderActions'] = undefined;
 
 /**
- * Subscription number of a subscription in the `Pending` order for which you are to update the triggering dates. For example, A-S00000001. 
+ * Subscription number of a subscription in the `Pending` order for which you are to update the triggering dates. For example, A-S00000001.
  * @member {String} subscriptionNumber
  */
 UpdateOrderActionTriggerDatesRequest.prototype['subscriptionNumber'] = undefined;

package/src/zuora_api/model/UpdateOrderCustomFieldsRequest.js

@@ -17,7 +17,7 @@ import UpdateOrderSubscriptionsCustomFields from './UpdateOrderSubscriptionsCust
 /**
  * The UpdateOrderCustomFieldsRequest model module.
  * @module model/UpdateOrderCustomFieldsRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderCustomFieldsRequest {
     /**

package/src/zuora_api/model/UpdateOrderLineItem.js

@@ -21,7 +21,7 @@ import TaxMode from './TaxMode';
 /**
  * The UpdateOrderLineItem model module.
  * @module model/UpdateOrderLineItem
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderLineItem {
     /**

package/src/zuora_api/model/UpdateOrderLineItemRequest.js

@@ -22,7 +22,7 @@ import UpdateOrderLineItem from './UpdateOrderLineItem';
 /**
  * The UpdateOrderLineItemRequest model module.
  * @module model/UpdateOrderLineItemRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderLineItemRequest {
     /**

package/src/zuora_api/model/UpdateOrderRequest.js

@@ -24,7 +24,7 @@ import ProcessingOptions from './ProcessingOptions';
 /**
  * The UpdateOrderRequest model module.
  * @module model/UpdateOrderRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderRequest {
     /**

package/src/zuora_api/model/UpdateOrderSubscriptionsCustomFields.js

@@ -17,7 +17,7 @@ import UpdateOrderSubscriptionsOrderActionsCustomFields from './UpdateOrderSubsc
 /**
  * The UpdateOrderSubscriptionsCustomFields model module.
  * @module model/UpdateOrderSubscriptionsCustomFields
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderSubscriptionsCustomFields {
     /**

package/src/zuora_api/model/UpdateOrderSubscriptionsOrderActionsCustomFields.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The UpdateOrderSubscriptionsOrderActionsCustomFields model module.
  * @module model/UpdateOrderSubscriptionsOrderActionsCustomFields
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderSubscriptionsOrderActionsCustomFields {
     /**
@@ -96,13 +96,13 @@ class UpdateOrderSubscriptionsOrderActionsCustomFields {
 UpdateOrderSubscriptionsOrderActionsCustomFields.prototype['customFields'] = undefined;
 
 /**
- * The Id of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time. 
+ * The Id of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.
  * @member {String} orderActionId
  */
 UpdateOrderSubscriptionsOrderActionsCustomFields.prototype['orderActionId'] = undefined;
 
 /**
- * The sequence number of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time. 
+ * The sequence number of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.
  * @member {Number} sequence
  */
 UpdateOrderSubscriptionsOrderActionsCustomFields.prototype['sequence'] = undefined;

package/src/zuora_api/model/UpdateOrderTriggerDateResponse.js

@@ -17,7 +17,7 @@ import UpdateOrderTriggerDatesSubscriptionsStatus from './UpdateOrderTriggerDate
 /**
  * The UpdateOrderTriggerDateResponse model module.
  * @module model/UpdateOrderTriggerDateResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderTriggerDateResponse {
     /**

package/src/zuora_api/model/UpdateOrderTriggerDatesRequest.js

@@ -17,7 +17,7 @@ import UpdateOrderActionTriggerDatesRequest from './UpdateOrderActionTriggerDate
 /**
  * The UpdateOrderTriggerDatesRequest model module.
  * @module model/UpdateOrderTriggerDatesRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderTriggerDatesRequest {
     /**

package/src/zuora_api/model/UpdateOrderTriggerDatesResponse.js

@@ -19,7 +19,7 @@ import UpdateOrderTriggerDateResponse from './UpdateOrderTriggerDateResponse';
 /**
  * The UpdateOrderTriggerDatesResponse model module.
  * @module model/UpdateOrderTriggerDatesResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdateOrderTriggerDatesResponse {
     /**
@@ -165,8 +165,9 @@ UpdateOrderTriggerDatesResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-UpdateOrderTriggerDatesResponse.prototype['success'] = undefined;
+UpdateOrderTriggerDatesResponse.prototype['success'] = true;
 
 /**
  * The account number for the order.
@@ -211,8 +212,9 @@ CommonResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-CommonResponse.prototype['success'] = undefined;
+CommonResponse.prototype['success'] = true;
 
 
 

package/src/zuora_api/model/UpdatePaymentMethodRequest.js

@@ -22,7 +22,7 @@ import UpdaterPaymentMethodRequestAccountHolderInfo from './UpdaterPaymentMethod
 /**
  * The UpdatePaymentMethodRequest model module.
  * @module model/UpdatePaymentMethodRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdatePaymentMethodRequest {
     /**
@@ -168,7 +168,7 @@ UpdatePaymentMethodRequest.prototype['expirationMonth'] = undefined;
 UpdatePaymentMethodRequest.prototype['expirationYear'] = undefined;
 
 /**
- * Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.   If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.  If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway. 
+ * Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.    If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.   If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.
  * @member {String} securityCode
  */
 UpdatePaymentMethodRequest.prototype['securityCode'] = undefined;
@@ -179,13 +179,13 @@ UpdatePaymentMethodRequest.prototype['securityCode'] = undefined;
 UpdatePaymentMethodRequest.prototype['accountHolderInfo'] = undefined;
 
 /**
- * The ID of the customer account associated with this payment method, such as `2x92c0f859b0480f0159d3a4a6ee5bb6`.  **Note:** You can use this field to associate an orphan payment method with a customer account. If a payment method is already associated with a customer account, you cannot change the associated payment method through this operation. You cannot remove the previous account ID and leave this field empty, either. 
+ * The ID of the customer account associated with this payment method, such as `2x92c0f859b0480f0159d3a4a6ee5bb6`.   **Note:** You can use this field to associate an orphan payment method with a customer account. If a payment method is already associated with a customer account, you cannot change the associated payment method through this operation. You cannot remove the previous account ID and leave this field empty, either.
  * @member {String} accountKey
  */
 UpdatePaymentMethodRequest.prototype['accountKey'] = undefined;
 
 /**
- * Specifies the ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.   This field is not supported in updating Credit Card Reference Transaction payment methods. 
+ * Specifies the ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.    This field is not supported in updating Credit Card Reference Transaction payment methods.
  * @member {String} authGateway
  */
 UpdatePaymentMethodRequest.prototype['authGateway'] = undefined;
@@ -202,7 +202,7 @@ UpdatePaymentMethodRequest.prototype['currencyCode'] = undefined;
 UpdatePaymentMethodRequest.prototype['gatewayOptions'] = 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
  */
 UpdatePaymentMethodRequest.prototype['ipAddress'] = undefined;
@@ -230,7 +230,7 @@ UpdatePaymentMethodRequestCreditCardInfo.prototype['expirationMonth'] = undefine
  */
 UpdatePaymentMethodRequestCreditCardInfo.prototype['expirationYear'] = undefined;
 /**
- * Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.   If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.  If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway. 
+ * Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.    If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.   If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.
  * @member {String} securityCode
  */
 UpdatePaymentMethodRequestCreditCardInfo.prototype['securityCode'] = undefined;

package/src/zuora_api/model/UpdatePaymentMethodRequestCreditCardInfo.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The UpdatePaymentMethodRequestCreditCardInfo model module.
  * @module model/UpdatePaymentMethodRequestCreditCardInfo
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdatePaymentMethodRequestCreditCardInfo {
     /**
@@ -102,7 +102,7 @@ UpdatePaymentMethodRequestCreditCardInfo.prototype['expirationMonth'] = undefine
 UpdatePaymentMethodRequestCreditCardInfo.prototype['expirationYear'] = undefined;
 
 /**
- * Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.   If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.  If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway. 
+ * Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.    If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.   If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.
  * @member {String} securityCode
  */
 UpdatePaymentMethodRequestCreditCardInfo.prototype['securityCode'] = undefined;

package/src/zuora_api/model/UpdatePaymentMethodResponse.js

@@ -18,7 +18,7 @@ import FailedReason from './FailedReason';
 /**
  * The UpdatePaymentMethodResponse model module.
  * @module model/UpdatePaymentMethodResponse
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdatePaymentMethodResponse {
     /**
@@ -137,8 +137,9 @@ UpdatePaymentMethodResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-UpdatePaymentMethodResponse.prototype['success'] = undefined;
+UpdatePaymentMethodResponse.prototype['success'] = true;
 
 /**
  * Internal ID of the payment method that was created.
@@ -165,8 +166,9 @@ CommonResponse.prototype['reasons'] = undefined;
 /**
  * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-CommonResponse.prototype['success'] = undefined;
+CommonResponse.prototype['success'] = true;
 
 
 

package/src/zuora_api/model/UpdatePaymentRequest.js

@@ -17,7 +17,7 @@ import PaymentRequestFinanceInformation from './PaymentRequestFinanceInformation
 /**
  * The UpdatePaymentRequest model module.
  * @module model/UpdatePaymentRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdatePaymentRequest {
     /**
@@ -149,7 +149,7 @@ UpdatePaymentRequest.prototype['comment'] = undefined;
 UpdatePaymentRequest.prototype['financeInformation'] = undefined;
 
 /**
- * This field is mainly used for gateway reconciliation. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Gateway_Reconciliation_Consideration\" target=\"_blank\">Electronic payment processing</a> for details.  You must have the **Edit Payment Gateway Status** <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/User_Roles/e_Payments_Roles\" target=\"_blank\">user permission</a> to update this field. 
+ * This field is mainly used for gateway reconciliation. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Gateway_Reconciliation_Consideration\" target=\"_blank\">Electronic payment processing</a> for details.   You must have the **Edit Payment Gateway Status** <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/User_Roles/e_Payments_Roles\" target=\"_blank\">user permission</a> to update this field.
  * @member {module:model/UpdatePaymentRequest.GatewayStateEnum} gatewayState
  */
 UpdatePaymentRequest.prototype['gatewayState'] = undefined;
@@ -161,7 +161,7 @@ UpdatePaymentRequest.prototype['gatewayState'] = undefined;
 UpdatePaymentRequest.prototype['paymentScheduleKey'] = undefined;
 
 /**
- * The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.  You can only update the reference ID for external payments. 
+ * The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.   You can only update the reference ID for external payments.
  * @member {String} referenceId
  */
 UpdatePaymentRequest.prototype['referenceId'] = undefined;

package/src/zuora_api/model/UpdatePaymentRunRequest.js

@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
 /**
  * The UpdatePaymentRunRequest model module.
  * @module model/UpdatePaymentRunRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdatePaymentRunRequest {
     /**
@@ -143,85 +143,85 @@ class UpdatePaymentRunRequest {
 
 
 /**
- * The ID of the customer account associated with the payment run.  This field conflicts with each of the `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields. If there are such conflicts, an error occurs and an error message is returned. 
+ * The ID of the customer account associated with the payment run.   This field conflicts with each of the `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields. If there are such conflicts, an error occurs and an error message is returned.
  * @member {String} accountId
  */
 UpdatePaymentRunRequest.prototype['accountId'] = undefined;
 
 /**
- * **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.  Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled. 
+ * **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.   Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled.
  * @member {Boolean} applyCreditBalance
  */
 UpdatePaymentRunRequest.prototype['applyCreditBalance'] = undefined;
 
 /**
- * **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.  Whether to automatically apply a posted credit memo to one or more receivables in the payment run. 
+ * **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.   Whether to automatically apply a posted credit memo to one or more receivables in the payment run.
  * @member {Boolean} autoApplyCreditMemo
  */
 UpdatePaymentRunRequest.prototype['autoApplyCreditMemo'] = undefined;
 
 /**
- * **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.  Whether to automatically apply unapplied payments to  one or more receivables in the payment run. 
+ * **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.   Whether to automatically apply unapplied payments to  one or more receivables in the payment run.
  * @member {Boolean} autoApplyUnappliedPayment
  */
 UpdatePaymentRunRequest.prototype['autoApplyUnappliedPayment'] = undefined;
 
 /**
- * The alias name given to a batch. The batch name is a string of 50 characters or less.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  
+ * The alias name given to a batch. The batch name is a string of 50 characters or less.   This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned. 
  * @member {String} batch
  */
 UpdatePaymentRunRequest.prototype['batch'] = undefined;
 
 /**
- * The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned. 
+ * The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM.   This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.
  * @member {String} billCycleDay
  */
 UpdatePaymentRunRequest.prototype['billCycleDay'] = undefined;
 
 /**
- * The ID of a bill run.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned. 
+ * The ID of a bill run.   This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.
  * @member {String} billingRunId
  */
 UpdatePaymentRunRequest.prototype['billingRunId'] = undefined;
 
 /**
- * Whether to process electronic payments during the execution of payment runs.   If the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored. 
+ * Whether to process electronic payments during the execution of payment runs.    If the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored.
  * @member {Boolean} collectPayment
  */
 UpdatePaymentRunRequest.prototype['collectPayment'] = undefined;
 
 /**
- * **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process a single payment for all receivables that are due on an account. 
+ * **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.    Whether to process a single payment for all receivables that are due on an account.
  * @member {Boolean} consolidatedPayment
  */
 UpdatePaymentRunRequest.prototype['consolidatedPayment'] = undefined;
 
 /**
- * A currency defined in the web-based UI administrative settings.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned. 
+ * A currency defined in the web-based UI administrative settings.   This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.
  * @member {String} currency
  */
 UpdatePaymentRunRequest.prototype['currency'] = undefined;
 
 /**
- * The ID of the gateway instance that processes the payment.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned. 
+ * The ID of the gateway instance that processes the payment.   This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.
  * @member {String} paymentGatewayId
  */
 UpdatePaymentRunRequest.prototype['paymentGatewayId'] = undefined;
 
 /**
- * **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process payments even if the default payment method is closed. 
+ * **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.    Whether to process payments even if the default payment method is closed.
  * @member {Boolean} processPaymentWithClosedPM
  */
 UpdatePaymentRunRequest.prototype['processPaymentWithClosedPM'] = undefined;
 
 /**
- * The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00. 
+ * The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00.
  * @member {Date} runDate
  */
 UpdatePaymentRunRequest.prototype['runDate'] = undefined;
 
 /**
- * The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date. 
+ * The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date.
  * @member {String} targetDate
  */
 UpdatePaymentRunRequest.prototype['targetDate'] = undefined;

package/src/zuora_api/model/UpdatePaymentScheduleItemRequest.js

@@ -18,7 +18,7 @@ import PaymentSchedulePaymentOptionFields from './PaymentSchedulePaymentOptionFi
 /**
  * The UpdatePaymentScheduleItemRequest model module.
  * @module model/UpdatePaymentScheduleItemRequest
- * @version 3.6.0
+ * @version 3.7.0
  */
 class UpdatePaymentScheduleItemRequest {
     /**
@@ -196,7 +196,7 @@ UpdatePaymentScheduleItemRequest.prototype['linkPayments'] = undefined;
 UpdatePaymentScheduleItemRequest.prototype['paymentGatewayId'] = undefined;
 
 /**
- * ID of the payment to be linked to the payment schedule item.  **Note**: This feild is version controlled. To enable this field, you must set `zuora-version` to equal or smaller than `336.0`. 
+ * ID of the payment to be linked to the payment schedule item.   **Note**: This feild is version controlled. To enable this field, you must set `zuora-version` to equal or smaller than `336.0`.
  * @member {String} paymentId
  */
 UpdatePaymentScheduleItemRequest.prototype['paymentId'] = undefined;
@@ -208,13 +208,13 @@ UpdatePaymentScheduleItemRequest.prototype['paymentId'] = undefined;
 UpdatePaymentScheduleItemRequest.prototype['paymentMethodId'] = undefined;
 
 /**
- * Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  Here is an example: ``` \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ] ```  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later. 
+ * Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.   Here is an example:  ```  \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ]  ```   `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.   To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later.
  * @member {Array.<module:model/PaymentSchedulePaymentOptionFields>} paymentOption
  */
 UpdatePaymentScheduleItemRequest.prototype['paymentOption'] = undefined;
 
 /**
- * At which hour of the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs. 
+ * At which hour of the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.
  * @member {Number} runHour
  */
 UpdatePaymentScheduleItemRequest.prototype['runHour'] = undefined;