mangopay4-nodejs-sdk 1.64.0

package/lib/models/Transfer.js

@@ -0,0 +1,13 @@
+var _ = require('underscore');
+var Transaction = require('./Transaction');
+
+var Transfer = Transaction.extend({
+    defaults: _.extend({}, Transaction.prototype.defaults, {
+        DebitedWalletId: null,
+        CreditedWalletId: null,
+        ScaContext: null,
+        PendingUserAction: null
+    })
+});
+
+module.exports = Transfer;

package/lib/models/Ubo.js

@@ -0,0 +1,19 @@
+var EntityBase = require('./EntityBase');
+var Address = require('./Address');
+var Birthplace = require('./Birthplace');
+
+/**
+ * UBO entity
+ */
+var Ubo = EntityBase.extend({
+    defaults: {
+        FirstName: String,
+        LastName: String,
+        Address: Address,
+        Nationality: String,
+        Birthday: null,
+        Birthplace: Birthplace
+    }
+});
+
+module.exports = Ubo;

package/lib/models/UboDeclaration.js

@@ -0,0 +1,42 @@
+var EntityBase = require('./EntityBase');
+
+/**
+ * UBO declaration entity.
+ */
+var UboDeclaration = EntityBase.extend({
+    defaults: {
+        /**
+         * cannot be modified by clients
+         */
+        ProcessedDate: null,
+        /**
+         * Declaration status (one of UboDeclarationStatus)
+         */
+        Status: null,
+        /**
+         * Array of reasons why the declaration was refused
+         * Values as declared in UboDeclarationRefusedReasonType.
+         */
+        Reason: null,
+        /**
+         * Explanation of why the declaration was refused.
+         */
+        Message: null,
+        /**
+         * Table of ubos (declared in Ubo)
+         */
+        Ubos: []
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function () {
+        var properties = EntityBase.prototype.getReadOnlyProperties();
+        properties.push('ProcessedDate', 'Status', 'Reason', 'Message');
+        return properties;
+    },
+});
+
+module.exports = UboDeclaration;

package/lib/models/UboDeclarationRefusedReasonType.js

@@ -0,0 +1,23 @@
+/**
+ * Enumeration of reasons why a UBO declaration could be refused.
+ */
+module.exports = {
+    /**
+     * When at least one natural user is missing on the declaration
+     */
+    MissingUbo: 'MISSING_UBO',
+
+    DeclarationDontMatchUboInfo: 'DECLARATION_DO_NOT_MATCH_UBO_INFORMATION',
+
+    WrongUboInformation: 'WRONG_UBO_INFORMATION',
+
+    UboIdentityNeeded: 'UBO_IDENTITY_NEEDED',
+
+    ShareholdersDeclarationNeeded: 'SHAREHOLDERS_DECLARATION_NEEDED',
+
+    OrganizationChartNeeded: 'ORGANIZATION_CHART_NEEDED',
+
+    DocumentsNeeded: 'DOCUMENTS_NEEDED',
+
+    SpecificCase: 'SPECIFIC_CASE'
+};

package/lib/models/UboDeclarationStatus.js

@@ -0,0 +1,26 @@
+/**
+ * UBO declaration possible status enumeration.
+ */
+module.exports = {
+    /**
+     * When the UBO declaration was created
+     */
+    Created: 'CREATED',
+    /**
+     * When validation has been requested for the UBO declaration
+     */
+    ValidationAsked: 'VALIDATION_ASKED',
+    /**
+     * When the UBO declaration was validated
+     */
+    Validated: 'VALIDATED',
+    /**
+     * When the UBO declaration was refused
+     */
+    Refused: 'REFUSED',
+
+    /**
+     * When the UBO declaration was incomplete
+     */
+    Incomplete: 'INCOMPLETE',
+};

package/lib/models/UboRefusedReasonType.js

@@ -0,0 +1,14 @@
+/**
+ * Enumerated possible reasons why declaration of a user as UBO could be refused.
+ */
+module.exports = {
+    /**
+     * When user should not be declared as UBO
+     */
+    InvalidDeclaredUbo: 'INVALID_DECLARED_UBO',
+    /**
+     * When user declared as UBO was created with wrong
+     * details (i.e. date of birth, country of residence)
+     */
+    InvalidUboDetails: 'INVALID_UBO_DETAILS'
+};

package/lib/models/User.js

@@ -0,0 +1,66 @@
+var _ = require('underscore');
+var EntityBase = require('./EntityBase');
+
+var User = EntityBase.extend({
+    defaults: {
+        /**
+         * Type of user
+         */
+        PersonType: null,
+
+        /**
+         * Email address
+         */
+        Email: null,
+
+        /**
+         * KYC Level (LIGHT or REGULAR)
+         */
+        KYCLevel: null,
+
+        /**
+         * Whether or not the user has accepted the MANGOPAY Terms and Conditions.
+         */
+        TermsAndConditionsAccepted: null,
+
+        TermsAndConditionsAcceptedDate: null,
+
+        /**
+         * Category of the user. May take one of the following values:
+         * PAYER - Users who only use MANGOPAY to give money to other users
+         * OWNER - Users who use MANGOPAY to receive funds. Please note that a user needs to be KYC validated to perform payouts
+         */
+        UserCategory: null,
+
+        UserStatus: null
+    },
+
+    /**
+     * Sets the person type to the model
+     * @param {String} personType
+     */
+    setPersonType: function(personType) {
+        this.PersonType = personType;
+    },
+
+    setUserCategory: function(userCategory) {
+        this.UserCategory = userCategory;
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function() {
+        var properties = EntityBase.prototype.getReadOnlyProperties();
+        properties.push('PersonType', 'KYCLevel');
+        return properties;
+    },
+
+    parse: function() {
+        var parsedValues = EntityBase.prototype.parse.call(this, arguments);
+        return _.omit(parsedValues, 'CreationDate');
+    }
+});
+
+module.exports = User;

package/lib/models/UserCategory.js

@@ -0,0 +1,5 @@
+module.exports = {
+    Payer: 'PAYER',
+    Owner: 'OWNER',
+    Platform: 'PLATFORM'
+};

package/lib/models/UserConsent.js

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

package/lib/models/UserDataFormatValidation.js

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

package/lib/models/UserEnrollmentResult.js

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

package/lib/models/UserLegal.js

@@ -0,0 +1,65 @@
+/**
+ * WORK IN PROGRESS
+ */
+var _ = require('underscore');
+
+var PersonType = require('./PersonType');
+
+var User = require('./User');
+var Address = require('./Address');
+
+var UserLegal = User.extend({
+    defaults: _.extend({}, User.prototype.defaults, {
+        Name: null,
+        /**
+         * Type for legal user. Possible: ‘BUSINESS’, ’ORGANIZATION’, 'SOLETRADER'
+         */
+        LegalPersonType: null,
+        HeadquartersAddress: null,
+        LegalRepresentativeFirstName: null,
+        LegalRepresentativeLastName: null,
+        LegalRepresentativeAddress: null,
+        LegalRepresentativeEmail: null,
+        LegalRepresentativeBirthday: null,
+        LegalRepresentativeNationality: null,
+        LegalRepresentativeCountryOfResidence: null,
+        CompanyNumber: null,
+        ProofOfIdentity: null,
+        Statute: null,
+        ProofOfRegistration: null,
+        ShareholderDeclaration: null
+    }),
+
+    /**
+     * Construct
+     */
+    initialize: function() {
+        User.prototype.initialize.apply(this, arguments);
+        this.setPersonType(PersonType.Legal);
+    },
+
+    /**
+     * 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, {
+            HeadquartersAddress: Address,
+            LegalRepresentativeAddress: Address
+        });
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function() {
+        var properties = User.prototype.getReadOnlyProperties();
+        properties.push('Statute', 'ProofOfRegistration', 'ShareholderDeclaration');
+        return properties;
+    }
+});
+
+module.exports = UserLegal;

package/lib/models/UserLegalOwner.js

@@ -0,0 +1,66 @@
+var _ = require('underscore');
+
+var PersonType = require('./PersonType');
+
+var User = require('./User');
+var Address = require('./Address');
+var UserCategory = require("./UserCategory");
+
+var UserLegalOwner = User.extend({
+    defaults: _.extend({}, User.prototype.defaults, {
+        Name: null,
+        /**
+         * Type for legal user. Possible: ‘BUSINESS’, ’ORGANIZATION’, 'SOLETRADER', 'PARTNERSHIP
+         */
+        LegalPersonType: null,
+        HeadquartersAddress: null,
+        LegalRepresentativeFirstName: null,
+        LegalRepresentativeLastName: null,
+        LegalRepresentativeAddress: null,
+        LegalRepresentativeEmail: null,
+        LegalRepresentativeBirthday: null,
+        LegalRepresentativeNationality: null,
+        LegalRepresentativeCountryOfResidence: null,
+        CompanyNumber: null,
+        ProofOfIdentity: null,
+        Statute: null,
+        ProofOfRegistration: null,
+        ShareholderDeclaration: null,
+        UserCategory: null,
+        TermsAndConditionsAccepted: null
+    }),
+
+    /**
+     * Construct
+     */
+    initialize: function() {
+        User.prototype.initialize.apply(this, arguments);
+        this.setPersonType(PersonType.Legal);
+        this.setUserCategory(UserCategory.Owner);
+    },
+
+    /**
+     * 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, {
+            HeadquartersAddress: Address,
+            LegalRepresentativeAddress: Address
+        });
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function() {
+        var properties = User.prototype.getReadOnlyProperties();
+        properties.push('Statute', 'ProofOfRegistration', 'ShareholderDeclaration');
+        return properties;
+    }
+});
+
+module.exports = UserLegalOwner;

package/lib/models/UserLegalPayer.js

@@ -0,0 +1,66 @@
+var _ = require('underscore');
+
+var PersonType = require('./PersonType');
+
+var User = require('./User');
+var Address = require('./Address');
+var UserCategory = require("./UserCategory");
+
+var UserLegalPayer = User.extend({
+    defaults: _.extend({}, User.prototype.defaults, {
+        Name: null,
+        /**
+         * Type for legal user. Possible: ‘BUSINESS’, ’ORGANIZATION’, 'SOLETRADER'
+         */
+        LegalPersonType: null,
+        HeadquartersAddress: null,
+        LegalRepresentativeFirstName: null,
+        LegalRepresentativeLastName: null,
+        LegalRepresentativeAddress: null,
+        LegalRepresentativeEmail: null,
+        LegalRepresentativeBirthday: null,
+        LegalRepresentativeNationality: null,
+        LegalRepresentativeCountryOfResidence: null,
+        CompanyNumber: null,
+        ProofOfIdentity: null,
+        Statute: null,
+        ProofOfRegistration: null,
+        ShareholderDeclaration: null,
+        UserCategory: null,
+        TermsAndConditionsAccepted: null
+    }),
+
+    /**
+     * Construct
+     */
+    initialize: function() {
+        User.prototype.initialize.apply(this, arguments);
+        this.setPersonType(PersonType.Legal);
+        this.setUserCategory(UserCategory.Payer);
+    },
+
+    /**
+     * 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, {
+            HeadquartersAddress: Address,
+            LegalRepresentativeAddress: Address
+        });
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function() {
+        var properties = User.prototype.getReadOnlyProperties();
+        properties.push('Statute', 'ProofOfRegistration', 'ShareholderDeclaration');
+        return properties;
+    }
+});
+
+module.exports = UserLegalPayer;

package/lib/models/UserLegalSca.js

@@ -0,0 +1,57 @@
+var _ = require('underscore');
+
+var PersonType = require('./PersonType');
+
+var User = require('./User');
+var Address = require('./Address');
+var PendingUserAction = require('./PendingUserAction');
+var LegalRepresentative = require('./LegalRepresentative');
+
+var UserLegalSca = User.extend({
+    defaults: _.extend({}, User.prototype.defaults, {
+        Name: null,
+        LegalPersonType: null,
+        LegalRepresentative: null,
+        ProofOfRegistration: null,
+        ShareholderDeclaration: null,
+        Statute: null,
+        CompanyNumber: null,
+        PendingUserAction: null,
+        HeadquartersAddress: null,
+        LegalRepresentativeAddress: null,
+        ScaContext: null
+    }),
+
+    initialize: function() {
+        User.prototype.initialize.apply(this, arguments);
+        this.setPersonType(PersonType.Legal);
+    },
+
+    /**
+     * Get object with key as object type and value the object class
+     * @return {Object} Mapping of sub-objects
+     */
+    getSubObjects: function() {
+        var subObjects = User.prototype.getSubObjects();
+
+        return _.extend({}, subObjects, {
+            Address: Address,
+            HeadquarterAddress: Address,
+            LegalRepresentativeAddress: Address,
+            PendingUserAction: PendingUserAction,
+            LegalRepresentative: LegalRepresentative
+        });
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array}
+     */
+    getReadOnlyProperties: function() {
+        var properties = User.prototype.getReadOnlyProperties();
+        properties.push('Statute', 'ProofOfRegistration', 'ShareholderDeclaration');
+        return properties;
+    }
+});
+
+module.exports = UserLegalSca;

package/lib/models/UserNatural.js

@@ -0,0 +1,51 @@
+var _ = require('underscore');
+
+var PersonType = require('./PersonType');
+
+var User = require('./User');
+var Address = require('./Address');
+
+var UserNatural = User.extend({
+    defaults: _.extend({}, User.prototype.defaults, {
+        FirstName: null,
+        LastName: null,
+        Address: null,
+        Birthday: null,
+        Nationality: null,
+        CountryOfResidence: null,
+        Occupation: null,
+        IncomeRange: null,
+        ProofOfIdentity: null,
+        ProofOfAddress: null,
+        Capacity: null
+    }),
+
+    initialize: function() {
+        User.prototype.initialize.apply(this, arguments);
+        this.setPersonType(PersonType.Natural);
+    },
+
+    /**
+     * Get object with key as object type and value the object class
+     * @return {Object} Mapping of sub-objects
+     */
+    getSubObjects: function() {
+        var subObjects = User.prototype.getSubObjects();
+
+        return _.extend({}, subObjects, {
+            Address: Address
+        });
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array}
+     */
+    getReadOnlyProperties: function() {
+        var properties = User.prototype.getReadOnlyProperties();
+        properties.push('PersonType', 'ProofOfIdentity', 'ProofOfAddress');
+        return properties;
+    }
+});
+
+module.exports = UserNatural;

package/lib/models/UserNaturalCapacity.js

@@ -0,0 +1,13 @@
+/**
+ * Capacity values of a natural user within MangoPay.
+ */
+module.exports = {
+    /**
+     * Real customer
+     */
+    Normal: 'NORMAL',
+    /**
+     * User used only for declaration purpose
+     */
+    Declarative: 'DECLARATIVE'
+};

package/lib/models/UserNaturalOwner.js

@@ -0,0 +1,55 @@
+var _ = require('underscore');
+
+var PersonType = require('./PersonType');
+
+var User = require('./User');
+var Address = require('./Address');
+var UserCategory = require("./UserCategory");
+
+var UserNaturalOwner = User.extend({
+    defaults: _.extend({}, User.prototype.defaults, {
+        FirstName: null,
+        LastName: null,
+        Address: null,
+        Birthday: null,
+        Nationality: null,
+        CountryOfResidence: null,
+        Occupation: null,
+        IncomeRange: null,
+        ProofOfIdentity: null,
+        ProofOfAddress: null,
+        Capacity: null,
+        UserCategory: null,
+        TermsAndConditionsAccepted: null
+    }),
+
+    initialize: function() {
+        User.prototype.initialize.apply(this, arguments);
+        this.setPersonType(PersonType.Natural);
+        this.setUserCategory(UserCategory.Owner);
+    },
+
+    /**
+     * Get object with key as object type and value the object class
+     * @return {Object} Mapping of sub-objects
+     */
+    getSubObjects: function() {
+        var subObjects = User.prototype.getSubObjects();
+
+        return _.extend({}, subObjects, {
+            Address: Address
+        });
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array}
+     */
+    getReadOnlyProperties: function() {
+        var properties = User.prototype.getReadOnlyProperties();
+        properties.push('PersonType', 'ProofOfIdentity', 'ProofOfAddress');
+        return properties;
+    }
+});
+
+module.exports = UserNaturalOwner;

package/lib/models/UserNaturalPayer.js

@@ -0,0 +1,55 @@
+var _ = require('underscore');
+
+var PersonType = require('./PersonType');
+
+var User = require('./User');
+var Address = require('./Address');
+var UserCategory = require("./UserCategory");
+
+var UserNaturalPayer = User.extend({
+    defaults: _.extend({}, User.prototype.defaults, {
+        FirstName: null,
+        LastName: null,
+        Address: null,
+        Birthday: null,
+        Nationality: null,
+        CountryOfResidence: null,
+        Occupation: null,
+        IncomeRange: null,
+        ProofOfIdentity: null,
+        ProofOfAddress: null,
+        Capacity: null,
+        UserCategory: null,
+        TermsAndConditionsAccepted: null
+    }),
+
+    initialize: function() {
+        User.prototype.initialize.apply(this, arguments);
+        this.setPersonType(PersonType.Natural);
+        this.setUserCategory(UserCategory.Payer);
+    },
+
+    /**
+     * Get object with key as object type and value the object class
+     * @return {Object} Mapping of sub-objects
+     */
+    getSubObjects: function() {
+        var subObjects = User.prototype.getSubObjects();
+
+        return _.extend({}, subObjects, {
+            Address: Address
+        });
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array}
+     */
+    getReadOnlyProperties: function() {
+        var properties = User.prototype.getReadOnlyProperties();
+        properties.push('PersonType', 'ProofOfIdentity', 'ProofOfAddress');
+        return properties;
+    }
+});
+
+module.exports = UserNaturalPayer;