zuora-sdk-js 3.7.0 → 3.8.0

package/src/zuora_api/model/CreateACHPaymentMethod.js

@@ -0,0 +1,587 @@
+/**
+ * Zuora API Reference
+ * REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
+ *
+ * The version of the OpenAPI document: 2024-05-20
+ * Contact: docs@zuora.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+import CreateBasePaymentMethod from './CreateBasePaymentMethod';
+import GatewayOptions from './GatewayOptions';
+import PaymentMethodACHBankAccountType from './PaymentMethodACHBankAccountType';
+import PaymentMethodMandateInfoMandateStatus from './PaymentMethodMandateInfoMandateStatus';
+import PaymentMethodRequestMandateInfo from './PaymentMethodRequestMandateInfo';
+import PaymentMethodRequestProcessingOptions from './PaymentMethodRequestProcessingOptions';
+import PaymentMethodRequestTokens from './PaymentMethodRequestTokens';
+
+/**
+ * The CreateACHPaymentMethod model module.
+ * @module model/CreateACHPaymentMethod
+ * @version 3.8.0
+ */
+class CreateACHPaymentMethod {
+    /**
+     * Constructs a new <code>CreateACHPaymentMethod</code>.
+     * @alias module:model/CreateACHPaymentMethod
+     * @implements module:model/CreateBasePaymentMethod
+     * @param type {String} Type of the payment method. Possible values include:    * `CreditCard` - Credit card payment method.   * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.   * `ACH` - ACH payment method.   * `SEPA` - Single Euro Payments Area.   * `Betalingsservice` - Direct Debit DK.   * `Autogiro` - Direct Debit SE.   * `Bacs` - Direct Debit UK.   * `Becs` - Direct Entry AU.   * `Becsnz` - Direct Debit NZ.   * `PAD` - Pre-Authorized Debit.   * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.   * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.   * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.   * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.   * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. 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) for details.   * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.   * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.   * You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.    Note that Zuora is continuously adding new payment method types. 
+     * @param bank_aba_code {String} The nine-digit routing number or ABA number used by banks. 
+     * @param bank_account_name {String} The name of the account holder, which can be either a person or a company.   For ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap's `firstName` and `lastName` fields. 
+     * @param bank_account_type {module:model/PaymentMethodACHBankAccountType} 
+     * @param bank_name {String} The name of the bank where the ACH payment account is held.   When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value. 
+     */
+    constructor(type, bank_aba_code, bank_account_name, bank_account_type, bank_name) { 
+        CreateBasePaymentMethod.initialize(this, type);
+        CreateACHPaymentMethod.initialize(this, type, bank_aba_code, bank_account_name, bank_account_type, bank_name);
+    }
+
+    /**
+     * Initializes the fields of this object.
+     * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+     * Only for internal use.
+     */
+    static initialize(obj, type, bank_aba_code, bank_account_name, bank_account_type, bank_name) { 
+        obj['type'] = type;
+        obj['bankABACode'] = bank_aba_code;
+        obj['bankAccountName'] = bank_account_name;
+        obj['bankAccountType'] = bank_account_type;
+        obj['bankName'] = bank_name;
+    }
+
+
+    /**
+     * Create a <code>CreateACHPaymentMethod</code> from a plain JavaScript object.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {module:model/CreateACHPaymentMethod} The populated <code>CreateACHPaymentMethod</code> instance.
+     */
+    static fromObject(data) { 
+        return CreateACHPaymentMethod.constructFromObject(data, null);
+    }
+
+    /**
+     * Constructs a <code>CreateACHPaymentMethod</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/CreateACHPaymentMethod} obj Optional instance to populate.
+     * @return {module:model/CreateACHPaymentMethod} The populated <code>CreateACHPaymentMethod</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new CreateACHPaymentMethod();
+            CreateBasePaymentMethod.constructFromObject(data, obj);
+
+            if (data.hasOwnProperty('accountKey')) {
+                obj['accountKey'] = ApiClient.convertToType(data['accountKey'], 'String');
+            }
+            if (data.hasOwnProperty('paymentMethodNumber')) {
+                obj['paymentMethodNumber'] = ApiClient.convertToType(data['paymentMethodNumber'], 'String');
+            }
+            if (data.hasOwnProperty('paymentGatewayNumber')) {
+                obj['paymentGatewayNumber'] = ApiClient.convertToType(data['paymentGatewayNumber'], 'String');
+            }
+            if (data.hasOwnProperty('screeningAmount')) {
+                obj['screeningAmount'] = ApiClient.convertToType(data['screeningAmount'], 'Number');
+            }
+            if (data.hasOwnProperty('authGateway')) {
+                obj['authGateway'] = ApiClient.convertToType(data['authGateway'], 'String');
+            }
+            if (data.hasOwnProperty('gatewayOptions')) {
+                obj['gatewayOptions'] = GatewayOptions.constructFromObject(data['gatewayOptions']);
+            }
+            if (data.hasOwnProperty('ipAddress')) {
+                obj['ipAddress'] = ApiClient.convertToType(data['ipAddress'], 'String');
+            }
+            if (data.hasOwnProperty('makeDefault')) {
+                obj['makeDefault'] = ApiClient.convertToType(data['makeDefault'], 'Boolean');
+            }
+            if (data.hasOwnProperty('processingOptions')) {
+                obj['processingOptions'] = PaymentMethodRequestProcessingOptions.constructFromObject(data['processingOptions']);
+            }
+            if (data.hasOwnProperty('skipValidation')) {
+                obj['skipValidation'] = ApiClient.convertToType(data['skipValidation'], 'Boolean');
+            }
+            if (data.hasOwnProperty('type')) {
+                obj['type'] = ApiClient.convertToType(data['type'], 'String');
+            }
+            if (data.hasOwnProperty('currencyCode')) {
+                obj['currencyCode'] = ApiClient.convertToType(data['currencyCode'], 'String');
+            }
+            if (data.hasOwnProperty('tokenize')) {
+                obj['tokenize'] = ApiClient.convertToType(data['tokenize'], 'Boolean');
+            }
+            if (data.hasOwnProperty('tokens')) {
+                obj['tokens'] = PaymentMethodRequestTokens.constructFromObject(data['tokens']);
+            }
+            if (data.hasOwnProperty('mandateInfo')) {
+                obj['mandateInfo'] = PaymentMethodRequestMandateInfo.constructFromObject(data['mandateInfo']);
+            }
+            if (data.hasOwnProperty('mandateId')) {
+                obj['mandateId'] = ApiClient.convertToType(data['mandateId'], 'String');
+            }
+            if (data.hasOwnProperty('mandateReceivedStatus')) {
+                obj['mandateReceivedStatus'] = PaymentMethodMandateInfoMandateStatus.constructFromObject(data['mandateReceivedStatus']);
+            }
+            if (data.hasOwnProperty('existingMandateStatus')) {
+                obj['existingMandateStatus'] = PaymentMethodMandateInfoMandateStatus.constructFromObject(data['existingMandateStatus']);
+            }
+            if (data.hasOwnProperty('mandateCreationDate')) {
+                obj['mandateCreationDate'] = ApiClient.convertToType(data['mandateCreationDate'], 'String');
+            }
+            if (data.hasOwnProperty('mandateUpdateDate')) {
+                obj['mandateUpdateDate'] = ApiClient.convertToType(data['mandateUpdateDate'], 'String');
+            }
+            if (data.hasOwnProperty('addressLine1')) {
+                obj['addressLine1'] = ApiClient.convertToType(data['addressLine1'], 'String');
+            }
+            if (data.hasOwnProperty('addressLine2')) {
+                obj['addressLine2'] = ApiClient.convertToType(data['addressLine2'], 'String');
+            }
+            if (data.hasOwnProperty('email')) {
+                obj['email'] = ApiClient.convertToType(data['email'], 'String');
+            }
+            if (data.hasOwnProperty('bankABACode')) {
+                obj['bankABACode'] = ApiClient.convertToType(data['bankABACode'], 'String');
+            }
+            if (data.hasOwnProperty('bankAccountName')) {
+                obj['bankAccountName'] = ApiClient.convertToType(data['bankAccountName'], 'String');
+            }
+            if (data.hasOwnProperty('bankAccountNumber')) {
+                obj['bankAccountNumber'] = ApiClient.convertToType(data['bankAccountNumber'], 'String');
+            }
+            if (data.hasOwnProperty('bankAccountMaskNumber')) {
+                obj['bankAccountMaskNumber'] = ApiClient.convertToType(data['bankAccountMaskNumber'], 'String');
+            }
+            if (data.hasOwnProperty('bankAccountType')) {
+                obj['bankAccountType'] = PaymentMethodACHBankAccountType.constructFromObject(data['bankAccountType']);
+            }
+            if (data.hasOwnProperty('bankName')) {
+                obj['bankName'] = ApiClient.convertToType(data['bankName'], 'String');
+            }
+            if (data.hasOwnProperty('city')) {
+                obj['city'] = ApiClient.convertToType(data['city'], 'String');
+            }
+            if (data.hasOwnProperty('country')) {
+                obj['country'] = ApiClient.convertToType(data['country'], 'String');
+            }
+            if (data.hasOwnProperty('phone')) {
+                obj['phone'] = ApiClient.convertToType(data['phone'], 'String');
+            }
+            if (data.hasOwnProperty('state')) {
+                obj['state'] = ApiClient.convertToType(data['state'], 'String');
+            }
+            if (data.hasOwnProperty('zipCode')) {
+                obj['zipCode'] = ApiClient.convertToType(data['zipCode'], 'String');
+            }
+        }
+        return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>CreateACHPaymentMethod</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateACHPaymentMethod</code>.
+     */
+    static validateJSON(data) {
+        // check to make sure all required properties are present in the JSON string
+        for (const property of CreateACHPaymentMethod.RequiredProperties) {
+            if (!data.hasOwnProperty(property)) {
+                throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+            }
+        }
+        // ensure the json data is a string
+        if (data['accountKey'] && !(typeof data['accountKey'] === 'string' || data['accountKey'] instanceof String)) {
+            throw new Error("Expected the field `accountKey` to be a primitive type in the JSON string but got " + data['accountKey']);
+        }
+        // ensure the json data is a string
+        if (data['paymentMethodNumber'] && !(typeof data['paymentMethodNumber'] === 'string' || data['paymentMethodNumber'] instanceof String)) {
+            throw new Error("Expected the field `paymentMethodNumber` to be a primitive type in the JSON string but got " + data['paymentMethodNumber']);
+        }
+        // ensure the json data is a string
+        if (data['paymentGatewayNumber'] && !(typeof data['paymentGatewayNumber'] === 'string' || data['paymentGatewayNumber'] instanceof String)) {
+            throw new Error("Expected the field `paymentGatewayNumber` to be a primitive type in the JSON string but got " + data['paymentGatewayNumber']);
+        }
+        // ensure the json data is a string
+        if (data['authGateway'] && !(typeof data['authGateway'] === 'string' || data['authGateway'] instanceof String)) {
+            throw new Error("Expected the field `authGateway` to be a primitive type in the JSON string but got " + data['authGateway']);
+        }
+        // validate the optional field `gatewayOptions`
+        if (data['gatewayOptions']) { // data not null
+          GatewayOptions.validateJSON(data['gatewayOptions']);
+        }
+        // ensure the json data is a string
+        if (data['ipAddress'] && !(typeof data['ipAddress'] === 'string' || data['ipAddress'] instanceof String)) {
+            throw new Error("Expected the field `ipAddress` to be a primitive type in the JSON string but got " + data['ipAddress']);
+        }
+        // validate the optional field `processingOptions`
+        if (data['processingOptions']) { // data not null
+          PaymentMethodRequestProcessingOptions.validateJSON(data['processingOptions']);
+        }
+        // ensure the json data is a string
+        if (data['type'] && !(typeof data['type'] === 'string' || data['type'] instanceof String)) {
+            throw new Error("Expected the field `type` to be a primitive type in the JSON string but got " + data['type']);
+        }
+        // ensure the json data is a string
+        if (data['currencyCode'] && !(typeof data['currencyCode'] === 'string' || data['currencyCode'] instanceof String)) {
+            throw new Error("Expected the field `currencyCode` to be a primitive type in the JSON string but got " + data['currencyCode']);
+        }
+        // validate the optional field `tokens`
+        if (data['tokens']) { // data not null
+          PaymentMethodRequestTokens.validateJSON(data['tokens']);
+        }
+        // validate the optional field `mandateInfo`
+        if (data['mandateInfo']) { // data not null
+          PaymentMethodRequestMandateInfo.validateJSON(data['mandateInfo']);
+        }
+        // ensure the json data is a string
+        if (data['mandateId'] && !(typeof data['mandateId'] === 'string' || data['mandateId'] instanceof String)) {
+            throw new Error("Expected the field `mandateId` to be a primitive type in the JSON string but got " + data['mandateId']);
+        }
+        // ensure the json data is a string
+        if (data['addressLine1'] && !(typeof data['addressLine1'] === 'string' || data['addressLine1'] instanceof String)) {
+            throw new Error("Expected the field `addressLine1` to be a primitive type in the JSON string but got " + data['addressLine1']);
+        }
+        // ensure the json data is a string
+        if (data['addressLine2'] && !(typeof data['addressLine2'] === 'string' || data['addressLine2'] instanceof String)) {
+            throw new Error("Expected the field `addressLine2` to be a primitive type in the JSON string but got " + data['addressLine2']);
+        }
+        // ensure the json data is a string
+        if (data['email'] && !(typeof data['email'] === 'string' || data['email'] instanceof String)) {
+            throw new Error("Expected the field `email` to be a primitive type in the JSON string but got " + data['email']);
+        }
+        // ensure the json data is a string
+        if (data['bankABACode'] && !(typeof data['bankABACode'] === 'string' || data['bankABACode'] instanceof String)) {
+            throw new Error("Expected the field `bankABACode` to be a primitive type in the JSON string but got " + data['bankABACode']);
+        }
+        // ensure the json data is a string
+        if (data['bankAccountName'] && !(typeof data['bankAccountName'] === 'string' || data['bankAccountName'] instanceof String)) {
+            throw new Error("Expected the field `bankAccountName` to be a primitive type in the JSON string but got " + data['bankAccountName']);
+        }
+        // ensure the json data is a string
+        if (data['bankAccountNumber'] && !(typeof data['bankAccountNumber'] === 'string' || data['bankAccountNumber'] instanceof String)) {
+            throw new Error("Expected the field `bankAccountNumber` to be a primitive type in the JSON string but got " + data['bankAccountNumber']);
+        }
+        // ensure the json data is a string
+        if (data['bankAccountMaskNumber'] && !(typeof data['bankAccountMaskNumber'] === 'string' || data['bankAccountMaskNumber'] instanceof String)) {
+            throw new Error("Expected the field `bankAccountMaskNumber` to be a primitive type in the JSON string but got " + data['bankAccountMaskNumber']);
+        }
+        // ensure the json data is a string
+        if (data['bankAccountType'] && !(typeof data['bankAccountType'] === 'string' || data['bankAccountType'] instanceof String)) {
+            throw new Error("Expected the field `bankAccountType` to be a primitive type in the JSON string but got " + data['bankAccountType']);
+        }
+        // ensure the json data is a string
+        if (data['bankName'] && !(typeof data['bankName'] === 'string' || data['bankName'] instanceof String)) {
+            throw new Error("Expected the field `bankName` to be a primitive type in the JSON string but got " + data['bankName']);
+        }
+        // ensure the json data is a string
+        if (data['city'] && !(typeof data['city'] === 'string' || data['city'] instanceof String)) {
+            throw new Error("Expected the field `city` to be a primitive type in the JSON string but got " + data['city']);
+        }
+        // ensure the json data is a string
+        if (data['country'] && !(typeof data['country'] === 'string' || data['country'] instanceof String)) {
+            throw new Error("Expected the field `country` to be a primitive type in the JSON string but got " + data['country']);
+        }
+        // ensure the json data is a string
+        if (data['phone'] && !(typeof data['phone'] === 'string' || data['phone'] instanceof String)) {
+            throw new Error("Expected the field `phone` to be a primitive type in the JSON string but got " + data['phone']);
+        }
+        // ensure the json data is a string
+        if (data['state'] && !(typeof data['state'] === 'string' || data['state'] instanceof String)) {
+            throw new Error("Expected the field `state` to be a primitive type in the JSON string but got " + data['state']);
+        }
+        // ensure the json data is a string
+        if (data['zipCode'] && !(typeof data['zipCode'] === 'string' || data['zipCode'] instanceof String)) {
+            throw new Error("Expected the field `zipCode` to be a primitive type in the JSON string but got " + data['zipCode']);
+        }
+
+        return true;
+    }
+
+
+}
+
+CreateACHPaymentMethod.RequiredProperties = ["type", "bankABACode", "bankAccountName", "bankAccountType", "bankName"];
+
+/**
+ * Internal ID of the customer account that will own the payment method. To create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted. 
+ * @member {String} accountKey
+ */
+CreateACHPaymentMethod.prototype['accountKey'] = undefined;
+
+/**
+ * To avoid the repetitive creation of identical payment methods, you can associate a unique identifier with the payment method.  You can specify a string within the allowed limits, or if none is provided, the system will automatically generate one for the payment method. 
+ * @member {String} paymentMethodNumber
+ */
+CreateACHPaymentMethod.prototype['paymentMethodNumber'] = undefined;
+
+/**
+ * The natural key for the payment gateway.
+ * @member {String} paymentGatewayNumber
+ */
+CreateACHPaymentMethod.prototype['paymentGatewayNumber'] = undefined;
+
+/**
+ * For [Chase Paymentech Orbital Gateway](https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Chase_Orbital_Payment_Gateway) integrations,  if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions.  Two-decimal amount is supported.  If the `screeningAmount` field is not specified, the authorization amount is used for fraud screening. 
+ * @member {Number} screeningAmount
+ */
+CreateACHPaymentMethod.prototype['screeningAmount'] = 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. 
+ * @member {String} authGateway
+ */
+CreateACHPaymentMethod.prototype['authGateway'] = undefined;
+
+/**
+ * @member {module:model/GatewayOptions} gatewayOptions
+ */
+CreateACHPaymentMethod.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. 
+ * @member {String} ipAddress
+ */
+CreateACHPaymentMethod.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.  When you set this field to `true`, make sure the payment method is supported by the default payment gateway. 
+ * @member {Boolean} makeDefault
+ * @default false
+ */
+CreateACHPaymentMethod.prototype['makeDefault'] = false;
+
+/**
+ * @member {module:model/PaymentMethodRequestProcessingOptions} processingOptions
+ */
+CreateACHPaymentMethod.prototype['processingOptions'] = undefined;
+
+/**
+ * Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation. 
+ * @member {Boolean} skipValidation
+ * @default false
+ */
+CreateACHPaymentMethod.prototype['skipValidation'] = false;
+
+/**
+ * Type of the payment method. Possible values include:    * `CreditCard` - Credit card payment method.   * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.   * `ACH` - ACH payment method.   * `SEPA` - Single Euro Payments Area.   * `Betalingsservice` - Direct Debit DK.   * `Autogiro` - Direct Debit SE.   * `Bacs` - Direct Debit UK.   * `Becs` - Direct Entry AU.   * `Becsnz` - Direct Debit NZ.   * `PAD` - Pre-Authorized Debit.   * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.   * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.   * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.   * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.   * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. 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) for details.   * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.   * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.   * You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.    Note that Zuora is continuously adding new payment method types. 
+ * @member {String} type
+ */
+CreateACHPaymentMethod.prototype['type'] = undefined;
+
+/**
+ * The currency code of the payment method.
+ * @member {String} currencyCode
+ */
+CreateACHPaymentMethod.prototype['currencyCode'] = undefined;
+
+/**
+ * Specifies whether to tokenize the payment method.
+ * @member {Boolean} tokenize
+ * @default false
+ */
+CreateACHPaymentMethod.prototype['tokenize'] = false;
+
+/**
+ * @member {module:model/PaymentMethodRequestTokens} tokens
+ */
+CreateACHPaymentMethod.prototype['tokens'] = undefined;
+
+/**
+ * @member {module:model/PaymentMethodRequestMandateInfo} mandateInfo
+ */
+CreateACHPaymentMethod.prototype['mandateInfo'] = undefined;
+
+/**
+ * The mandate ID.   When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field.
+ * @member {String} mandateId
+ */
+CreateACHPaymentMethod.prototype['mandateId'] = undefined;
+
+/**
+ * @member {module:model/PaymentMethodMandateInfoMandateStatus} mandateReceivedStatus
+ */
+CreateACHPaymentMethod.prototype['mandateReceivedStatus'] = undefined;
+
+/**
+ * @member {module:model/PaymentMethodMandateInfoMandateStatus} existingMandateStatus
+ */
+CreateACHPaymentMethod.prototype['existingMandateStatus'] = undefined;
+
+/**
+ * The date on which the mandate was created. 
+ * @member {String} mandateCreationDate
+ */
+CreateACHPaymentMethod.prototype['mandateCreationDate'] = undefined;
+
+/**
+ * The date on which the mandate was updated. 
+ * @member {String} mandateUpdateDate
+ */
+CreateACHPaymentMethod.prototype['mandateUpdateDate'] = undefined;
+
+/**
+ * First address line, 255 characters or less. 
+ * @member {String} addressLine1
+ */
+CreateACHPaymentMethod.prototype['addressLine1'] = undefined;
+
+/**
+ * Second address line, 255 characters or less. 
+ * @member {String} addressLine2
+ */
+CreateACHPaymentMethod.prototype['addressLine2'] = undefined;
+
+/**
+ * Card holder's email address, 80 characters or less. 
+ * @member {String} email
+ */
+CreateACHPaymentMethod.prototype['email'] = undefined;
+
+/**
+ * The nine-digit routing number or ABA number used by banks. 
+ * @member {String} bankABACode
+ */
+CreateACHPaymentMethod.prototype['bankABACode'] = undefined;
+
+/**
+ * The name of the account holder, which can be either a person or a company.   For ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap's `firstName` and `lastName` fields. 
+ * @member {String} bankAccountName
+ */
+CreateACHPaymentMethod.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. 
+ * @member {String} bankAccountNumber
+ */
+CreateACHPaymentMethod.prototype['bankAccountNumber'] = undefined;
+
+/**
+ * The masked bank account number associated with the ACH payment. This field is only required if the ACH payment method is created using tokens. 
+ * @member {String} bankAccountMaskNumber
+ */
+CreateACHPaymentMethod.prototype['bankAccountMaskNumber'] = undefined;
+
+/**
+ * @member {module:model/PaymentMethodACHBankAccountType} bankAccountType
+ */
+CreateACHPaymentMethod.prototype['bankAccountType'] = undefined;
+
+/**
+ * The name of the bank where the ACH payment account is held.   When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value. 
+ * @member {String} bankName
+ */
+CreateACHPaymentMethod.prototype['bankName'] = 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. 
+ * @member {String} city
+ */
+CreateACHPaymentMethod.prototype['city'] = undefined;
+
+/**
+ * Country, must be a valid country name or abbreviation.  See [Country Names and Their ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes) for the list of supported country names and abbreviations.  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
+ */
+CreateACHPaymentMethod.prototype['country'] = undefined;
+
+/**
+ * Phone number, 40 characters or less. 
+ * @member {String} phone
+ */
+CreateACHPaymentMethod.prototype['phone'] = undefined;
+
+/**
+ * State, must be a valid state name or 2-character abbreviation.  See [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations. 
+ * @member {String} state
+ */
+CreateACHPaymentMethod.prototype['state'] = undefined;
+
+/**
+ * Zip code, 20 characters or less. 
+ * @member {String} zipCode
+ */
+CreateACHPaymentMethod.prototype['zipCode'] = undefined;
+
+
+// Implement CreateBasePaymentMethod interface:
+/**
+ * Internal ID of the customer account that will own the payment method. To create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted. 
+ * @member {String} accountKey
+ */
+CreateBasePaymentMethod.prototype['accountKey'] = undefined;
+/**
+ * To avoid the repetitive creation of identical payment methods, you can associate a unique identifier with the payment method.  You can specify a string within the allowed limits, or if none is provided, the system will automatically generate one for the payment method. 
+ * @member {String} paymentMethodNumber
+ */
+CreateBasePaymentMethod.prototype['paymentMethodNumber'] = undefined;
+/**
+ * The natural key for the payment gateway.
+ * @member {String} paymentGatewayNumber
+ */
+CreateBasePaymentMethod.prototype['paymentGatewayNumber'] = undefined;
+/**
+ * For [Chase Paymentech Orbital Gateway](https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Chase_Orbital_Payment_Gateway) integrations,  if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions.  Two-decimal amount is supported.  If the `screeningAmount` field is not specified, the authorization amount is used for fraud screening. 
+ * @member {Number} screeningAmount
+ */
+CreateBasePaymentMethod.prototype['screeningAmount'] = 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. 
+ * @member {String} authGateway
+ */
+CreateBasePaymentMethod.prototype['authGateway'] = undefined;
+/**
+ * @member {module:model/GatewayOptions} gatewayOptions
+ */
+CreateBasePaymentMethod.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. 
+ * @member {String} ipAddress
+ */
+CreateBasePaymentMethod.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.  When you set this field to `true`, make sure the payment method is supported by the default payment gateway. 
+ * @member {Boolean} makeDefault
+ * @default false
+ */
+CreateBasePaymentMethod.prototype['makeDefault'] = false;
+/**
+ * @member {module:model/PaymentMethodRequestProcessingOptions} processingOptions
+ */
+CreateBasePaymentMethod.prototype['processingOptions'] = undefined;
+/**
+ * Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation. 
+ * @member {Boolean} skipValidation
+ * @default false
+ */
+CreateBasePaymentMethod.prototype['skipValidation'] = false;
+/**
+ * Type of the payment method. Possible values include:    * `CreditCard` - Credit card payment method.   * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.   * `ACH` - ACH payment method.   * `SEPA` - Single Euro Payments Area.   * `Betalingsservice` - Direct Debit DK.   * `Autogiro` - Direct Debit SE.   * `Bacs` - Direct Debit UK.   * `Becs` - Direct Entry AU.   * `Becsnz` - Direct Debit NZ.   * `PAD` - Pre-Authorized Debit.   * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.   * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.   * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.   * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.   * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. 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) for details.   * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.   * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.   * You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.    Note that Zuora is continuously adding new payment method types. 
+ * @member {String} type
+ */
+CreateBasePaymentMethod.prototype['type'] = undefined;
+/**
+ * The currency code of the payment method.
+ * @member {String} currencyCode
+ */
+CreateBasePaymentMethod.prototype['currencyCode'] = undefined;
+/**
+ * Specifies whether to tokenize the payment method.
+ * @member {Boolean} tokenize
+ * @default false
+ */
+CreateBasePaymentMethod.prototype['tokenize'] = false;
+/**
+ * @member {module:model/PaymentMethodRequestTokens} tokens
+ */
+CreateBasePaymentMethod.prototype['tokens'] = undefined;
+
+
+
+
+export default CreateACHPaymentMethod;
+

package/src/zuora_api/model/CreateAccountContact.js

@@ -18,7 +18,7 @@ import UpdateAccountContact from './UpdateAccountContact';
 /**
  * The CreateAccountContact model module.
  * @module model/CreateAccountContact
- * @version 3.7.0
+ * @version 3.8.0
  */
 class CreateAccountContact {
     /**

package/src/zuora_api/model/CreateAccountCreditCard.js

@@ -18,7 +18,7 @@ import PaymentMethodObjectCustomFields from './PaymentMethodObjectCustomFields';
 /**
  * The CreateAccountCreditCard model module.
  * @module model/CreateAccountCreditCard
- * @version 3.7.0
+ * @version 3.8.0
  */
 class CreateAccountCreditCard {
     /**

package/src/zuora_api/model/CreateAccountCreditCardHolderInfo.js

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