mangopay4-nodejs-sdk 1.64.0

package/lib/models/EMoney.js

@@ -0,0 +1,30 @@
+var _ = require('underscore');
+
+var Model = require('../Model');
+var Money = require('./Money');
+
+var EMoney = Model.extend({
+    defaults: _.extend({}, Model.prototype.defaults, {
+        /**
+         * Owner object owner's UserId
+         */
+        UserId: null,
+        CreditedEMoney: null,
+        DebitedEMoney: null
+    }),
+
+    /**
+     * Get object with key as object type and value the object class
+     * @return {Object} Sub-objects mapping
+     */
+    getSubObjects: function () {
+        var subObjects = User.prototype.getSubObjects();
+
+        return _.extend({}, subObjects, {
+            CreditedEMoney: Money,
+            DebitedEMoney: Money
+        });
+    }
+});
+
+module.exports = EMoney;

package/lib/models/EntityBase.js

@@ -0,0 +1,70 @@
+var _ = require('underscore');
+var Model = require('../Model');
+
+var EntityBase = Model.extend({
+    defaults: {
+        Id: null,
+        Tag: null,
+        CreationDate: null
+    },
+
+    getReadOnlyProperties: function() {
+        var properties = Model.prototype.getReadOnlyProperties();
+        properties.push('Id', 'CreationDate');
+        return properties;
+    },
+
+    /**
+     * Casting the entity to JSON data that will be passed to the server
+     */
+    toJSON: function() {
+        var self = this;
+
+        /**
+         * Flatten object model structure
+         */
+        _.each(this, function(dataValue){
+            if (dataValue instanceof Model) {
+                _.extendOwn(self, dataValue);
+            }
+        });
+
+        /**
+         * Parse dependents object functionality
+         */
+        var dependsObjects = this.getDependsObjects();
+        if (dependsObjects.length) {
+            _.each(dependsObjects, function(dependsObject){
+                var propertyValue = self.getData(dependsObject.propertyName);
+                _.each(dependsObject.propertyValueMapping, function(modelClass, key) {
+                    if (propertyValue instanceof modelClass) {
+                        self[dependsObject.dependsPropertyName] = key;
+                    }
+                });
+            });
+        }
+
+        // delete self.CreationDate;
+        return self;
+    },
+
+    /**
+     * Parse method is being called to interpret the data received from the server
+     */
+    parse: function() {
+        var self = this;
+        var dependsObjects = this.getDependsObjects();
+        if (dependsObjects.length) {
+            _.each(dependsObjects, function(dependsObject){
+                var dependsPropertyValue = self.getData(dependsObject.dependsPropertyName);
+                var PropertyObjectClass = dependsObject.propertyValueMapping[dependsPropertyValue];
+                if (PropertyObjectClass) {
+                    var updatedDependsObject = new PropertyObjectClass(self.getData(dependsObject.propertyName));
+                    self.setData(dependsObject.propertyName, updatedDependsObject);
+                }
+            });
+        }
+    }
+});
+
+module.exports = EntityBase;

package/lib/models/Hook.js

@@ -0,0 +1,19 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        /**
+         * This is the URL where your receive notification for each EventType
+         */
+        Url: null,
+        /**
+         * Status: ENABLED, DISABLED
+         */
+        Status: null,
+        /**
+         * Validity: VALID, INVALID
+         */
+        Validity: null,
+        EventType: null
+    }
+});

package/lib/models/IdempotencyResponse.js

@@ -0,0 +1,11 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        StatusCode: null,
+        ContentLength: null,
+        ContentType: null,
+        Date: null,
+        Resource: null
+    }
+});

package/lib/models/IdentityVerification.js

@@ -0,0 +1,12 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        HostedUrl: null,
+        Status: null,
+        ReturnUrl: null,
+        LastUpdate: null,
+        UserId: null,
+        Checks: null
+    }
+});

package/lib/models/KycDocument.js

@@ -0,0 +1,11 @@
+var Document = require('./Document');
+
+var KycDocument = Document.extend({
+    defaults: {
+        UserId: null,
+        Flags: null,
+        Tag: null
+    }
+});
+
+module.exports = KycDocument;

package/lib/models/KycDocumentStatus.js

@@ -0,0 +1,7 @@
+module.exports = {
+    Created: 'CREATED',
+    ValidationAsked: 'VALIDATION_ASKED',
+    Validated: 'VALIDATED',
+    Refused: 'REFUSED',
+    OutOfDate: 'OUT_OF_DATE'
+};

package/lib/models/KycDocumentType.js

@@ -0,0 +1,7 @@
+module.exports = {
+    IdentityProof: 'IDENTITY_PROOF',
+    RegistrationProof: 'REGISTRATION_PROOF',
+    ArticlesOfAssociation: 'ARTICLES_OF_ASSOCIATION',
+    ShareholderDeclaration: 'SHAREHOLDER_DECLARATION',
+    AddressProof: 'ADDRESS_PROOF'
+};

package/lib/models/KycPage.js

@@ -0,0 +1,12 @@
+var EntityBase = require('./EntityBase');
+
+var KycPage = EntityBase.extend({
+    defaults: {
+        /**
+         * Image base64
+         */
+        File: null
+    }
+});
+
+module.exports = KycPage;

package/lib/models/LegalPersonType.js

@@ -0,0 +1,7 @@
+module.exports = {
+    NotSpecified: 'NotSpecified',
+    Business: 'BUSINESS',
+    Organization: 'ORGANIZATION',
+    Soletrader: 'SOLETRADER',
+    Partnership: 'PARTNERSHIP'
+};

package/lib/models/LegalRepresentative.js

@@ -0,0 +1,16 @@
+var EntityBase = require('./EntityBase');
+
+var LegalRepresentative = EntityBase.extend({
+    defaults: {
+        FirstName: null,
+        LastName: null,
+        Birthday: null,
+        Nationality: null,
+        CountryOfResidence: null,
+        Email: null,
+        PhoneNumber: null,
+        PhoneNumberCountry: null
+    }
+});
+
+module.exports = LegalRepresentative;

package/lib/models/Mandate.js

@@ -0,0 +1,69 @@
+var _ = require('underscore');
+var Model = require('../Model');
+
+var Mandate = Model.extend({
+    defaults: {
+        /**
+         *  When the item was created
+         */
+        CreationDate: null,
+        /**
+         *  Custom data that you can add to this item
+         */
+        Tag: null,
+        /**
+         *  An ID of a Bank Account
+         */
+        BankAccountId: null,
+        /**
+         *  The object owner's UserId
+         */
+        UserId: null,
+        /**
+         *  The URL to redirect to after payment (whether successful or not)
+         */
+        ReturnURL: null,
+        /**
+         *  The URL to redirect to user to for them to proceed with the payment
+         */
+        RedirectURL: null,
+        /**
+         *  The URL to download the mandate
+         */
+        DocumentURL: null,
+        /**
+         *  The language to use for the mandate confirmation page - needs to be the ISO code of the language
+         */
+        Culture: null,
+        /**
+         *  The type of mandate, but will only be completed once the mandate has been submitted
+         */
+        Scheme: null,
+        /**
+         *  The status of the mandate
+         */
+        Status: null,
+        /**
+         *  The result code
+         */
+        ResultCode: null,
+        /**
+         *  A verbal explanation of the ResultCode
+         */
+        ResultMessage: null,
+        /**
+         *  The execution type for creating the mandate
+         */
+        ExecutionType: 'WEB',
+        /**
+         *  The type of Mandate, defaults to DIRECT_DEBIT
+         */
+        MandateType: 'DIRECT_DEBIT',
+        /**
+         *  The bank reference
+         */
+        BankReference: null
+    }
+});
+
+module.exports = Mandate;

package/lib/models/MandateStatus.js

@@ -0,0 +1,7 @@
+module.exports = {
+    Created: 'CREATED',
+    Submitted: 'SUBMITTED',
+    Active: 'ACTIVE',
+    Failed: 'FAILED',
+    Expired: 'EXPIRED'
+};

package/lib/models/Money.js

@@ -0,0 +1,16 @@
+var EntityBase = require('./EntityBase');
+
+var Money = EntityBase.extend({
+    defaults: {
+        /**
+         * The currency - should be ISO 4217 format
+         */
+        Currency: null,
+        /**
+         * The amount of money in cents, e.g. 12.60€ would be represented as 1260
+         */
+        Amount: null
+    }
+});
+
+module.exports = Money;

package/lib/models/PayByBankSupportedBank.js

@@ -0,0 +1,7 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        SupportedBanks: null
+    }
+});

package/lib/models/PayIn.js

@@ -0,0 +1,36 @@
+var _ = require('underscore');
+var Transaction = require('./Transaction');
+
+var PayIn = Transaction.extend({
+    defaults: _.extend({}, Transaction.prototype.defaults, {
+        CreditedWalletId: null,
+        /**
+         * PaymentType (CARD, BANK_WIRE, DIRECT_DEBIT, PREAUTHORIZED)
+         */
+        PaymentType: null,
+        /**
+         * One of PayInPaymentDetails implementations, depending on PaymentType
+         */
+        PaymentDetails: null,
+        /**
+         * ExecutionType (WEB, DIRECT, EXTERNAL_INSTRUCTION)
+         */
+        ExecutionType: null,
+        /**
+         * One of PayInExecutionDetails implementations, depending on ExecutionType
+         */
+        ExecutionDetails: null,
+        /**
+         * The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
+         */
+        ProfilingAttemptReference: null
+    }),
+
+    getReadOnlyProperties: function() {
+        var properties = Transaction.prototype.getReadOnlyProperties();
+        properties.push('PaymentType', 'ExecutionType');
+        return properties;
+    }
+});
+
+module.exports = PayIn;

package/lib/models/PayInExecutionDetails.js

@@ -0,0 +1,7 @@
+var EntityBase = require('./EntityBase');
+
+var PayInExecutionDetails = EntityBase.extend({
+
+});
+
+module.exports = PayInExecutionDetails;

package/lib/models/PayInExecutionDetailsBankingAlias.js

@@ -0,0 +1,19 @@
+var _ = require('underscore');
+var PayInExecutionDetails = require('./PayInExecutionDetails');
+var DebitedBankAccount = require('./DebitedBankAccount');
+
+var PayInExecutionDetailsBankingAlias = PayInExecutionDetails.extend({
+    defaults: {
+        BankingAliasId: null,
+        WireReference: null,
+        DebitedBankAccount: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'DebitedBankAccount': DebitedBankAccount
+        }
+    }
+});
+
+module.exports = PayInExecutionDetailsBankingAlias;

package/lib/models/PayInExecutionDetailsDirect.js

@@ -0,0 +1,29 @@
+var _ = require('underscore');
+var PayInExecutionDetails = require('./PayInExecutionDetails');
+var Billing = require('./Billing');
+var SecurityInfo = require('./SecurityInfo');
+
+var PayInExecutionDetailsDirect = PayInExecutionDetails.extend({
+    defaults: {
+        /**
+         *  SecureMode { DEFAULT, FORCE, NO_CHOICE }
+         */
+        SecureMode: null,
+        SecureModeReturnURL: null,
+        SecureModeRedirectURL: null,
+        SecureModeNeeded: null,
+        Billing: null,
+        SecurityInfo: null,
+        Requested3DSVersion: null,
+        Applied3DSVersion: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'Billing': Billing,
+            'SecurityInfo': SecurityInfo
+        }
+  }
+});
+
+module.exports = PayInExecutionDetailsDirect;

package/lib/models/PayInExecutionDetailsWeb.js

@@ -0,0 +1,40 @@
+var _ = require('underscore');
+var PayInExecutionDetails = require('./PayInExecutionDetails');
+var PayInTemplateURLOptions = require('./PayInTemplateURLOptions');
+
+var PayInExecutionDetailsWeb = PayInExecutionDetails.extend({
+    defaults: {
+        RedirectURL: null,
+        ReturnURL: null,
+        TemplateURL: null,
+        /**
+         * The URL where you host the iFramed template.
+         * For CB, Visa, MasterCard you need to specify PAYLINE: before your URL
+         * with the iFramed template
+         * ex: PAYLINE: https://www.maysite.com/payline_template/
+         * Used for:
+         *  - direct debit web type pay-in.
+         *
+         */
+        TemplateURLOptions: null,
+        Culture: null,
+        /**
+         * Mode3DSType { DEFAULT, FORCE, NO_CHOICE }
+         */
+        SecureMode: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'TemplateURLOptions': PayInTemplateURLOptions
+        }
+    },
+
+    getReadOnlyProperties: function () {
+        var properties = PayInExecutionDetails.prototype.getReadOnlyProperties();
+        properties.push('RedirectURL', 'Type');
+        return properties;
+    }
+});
+
+module.exports = PayInExecutionDetailsWeb;

package/lib/models/PayInExecutionType.js

@@ -0,0 +1,5 @@
+module.exports = {
+    Direct: 'DIRECT',
+    Web: 'WEB',
+    ExternalInstruction: 'EXTERNAL_INSTRUCTION'
+};

package/lib/models/PayInIntent.js

@@ -0,0 +1,20 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        Amount: null,
+        AvailableAmountToSplit: null,
+        Currency: null,
+        PlatformFeesAmount: null,
+        Status: null,
+        NextActions: null,
+        ExternalData: null,
+        Buyer: null,
+        LineItems: null,
+        Captures: null,
+        Refunds: null,
+        Disputes: null,
+        Splits: null,
+        SettlementId: null
+    }
+});

package/lib/models/PayInIntentSplit.js

@@ -0,0 +1,14 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        LineItemId: null,
+        SellerId: null,
+        WalletId: null,
+        SplitAmount: null,
+        FeesAmount: null,
+        TransferDate: null,
+        Description: null,
+        Status: null
+    }
+});

package/lib/models/PayInIntentSplits.js

@@ -0,0 +1,7 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        Splits: null
+    }
+});

package/lib/models/PayInPaymentDetails.js

@@ -0,0 +1,7 @@
+var EntityBase = require('./EntityBase');
+
+var PayInPaymentDetails = EntityBase.extend({
+
+});
+
+module.exports = PayInPaymentDetails;

package/lib/models/PayInPaymentDetailsApplePay.js

@@ -0,0 +1,19 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsApplePay = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Payment information returned by Apple Pay payment
+         */
+        PaymentData: null,
+
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null
+    }
+});
+
+module.exports = PayInPaymentDetailsApplePay;

package/lib/models/PayInPaymentDetailsBancontact.js

@@ -0,0 +1,13 @@
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsBancontact = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null
+    }
+});
+
+module.exports = PayInPaymentDetailsBancontact;

package/lib/models/PayInPaymentDetailsBankWire.js

@@ -0,0 +1,23 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+var Money = require('./Money');
+var BankAccount = require('./BankAccount');
+
+var PayInPaymentDetailsBankWire = PayInPaymentDetails.extend({
+    defaults: {
+        DeclaredDebitedFunds: null,
+        DeclaredFees: null,
+        BankAccount: null,
+        WireReference: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'DeclaredDebitedFunds': Money,
+            'DeclaredFees': Money,
+            'BankAccount': BankAccount
+        }
+    }
+});
+
+module.exports = PayInPaymentDetailsBankWire;

package/lib/models/PayInPaymentDetailsBankingAlias.js

@@ -0,0 +1,18 @@
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+var DebitedBankAccount = require('./DebitedBankAccount');
+
+var PayInPaymentDetailsBankingAlias = PayInPaymentDetails.extend({
+    defaults: {
+        BankingAliasId: null,
+        WireReference: null,
+        DebitedBankAccount: null
+    },
+
+    getSubObjects: function () {
+        return {
+            'DebitedBankAccount': DebitedBankAccount
+        };
+    }
+});
+
+module.exports = PayInPaymentDetailsBankingAlias;

package/lib/models/PayInPaymentDetailsBizum.js

@@ -0,0 +1,23 @@
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsBizum = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null,
+        /**
+         * Format: International E.164 standard (preceded by plus sign and country code, +34 in Spain); pattern: ^[+][1-9][\d]{4,14}$
+         * The phone number of the end user to which the Bizum push notification is sent to authenticate the transaction.
+         * If the Phone parameter is sent, then RedirectURL is not returned and ReturnURL is ignored.
+         */
+        Phone: null,
+        /**
+         * The URL to which the user is returned after the payment, whether the transaction is successful or not.
+         */
+        ReturnURL: null
+    }
+});
+
+module.exports = PayInPaymentDetailsBizum;

package/lib/models/PayInPaymentDetailsBlik.js

@@ -0,0 +1,17 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsBlik = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null,
+        Code: null,
+        IpAddress: null,
+        BrowserInfo: null
+    }
+});
+
+module.exports = PayInPaymentDetailsBlik;

package/lib/models/PayInPaymentDetailsCard.js

@@ -0,0 +1,10 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsCard = PayInPaymentDetails.extend({
+    defaults: {
+        StatementDescriptor: null
+    }
+});
+
+module.exports = PayInPaymentDetailsCard;

package/lib/models/PayInPaymentDetailsCardDirect.js

@@ -0,0 +1,14 @@
+var _ = require('underscore');
+var PayInPaymentDetailsCard = require('./PayInPaymentDetailsCard');
+
+var PayInPaymentDetailsCardDirect = PayInPaymentDetailsCard.extend({
+    defaults: _.extend({}, PayInPaymentDetailsCard.prototype.defaults, {
+        CardId: null,
+        IpAddress: null,
+        Shipping: null,
+        BrowserInfo: null,
+        CardInfo: null
+    })
+});
+
+module.exports = PayInPaymentDetailsCardDirect;