mangopay4-nodejs-sdk 1.64.0

package/lib/models/BrowserInfo.js

@@ -0,0 +1,15 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        AcceptHeader: null,
+        JavaEnabled: null,
+        JavascriptEnabled: null,
+        Language: null,
+        ColorDepth: null,
+        ScreenHeight: null,
+        ScreenWidth: null,
+        TimeZoneOffset: null,
+        UserAgent: null
+    }
+});

package/lib/models/Card.js

@@ -0,0 +1,19 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        ExpirationDate: null,
+        Alias: null,
+        CardProvider: null,
+        UserId: null,
+        CardType: null,
+        Product: null,
+        BankCode: null,
+        Country: null,
+        Active: null,
+        Currency: null,
+        Validity: null,
+        Fingerprint: null,
+        CardHolderName: null
+    }
+});

package/lib/models/CardInfo.js

@@ -0,0 +1,32 @@
+var EntityBase = require('./EntityBase');
+
+var CardInfo = EntityBase.extend({
+    defaults: {
+        /**
+         * The 6-digit bank identification number (BIN) of the card issuer.
+         */
+        BIN: null,
+        /**
+         * The name of the card issuer.
+         */
+        IssuingBank: null,
+        /**
+         * TThe country where the card was issued.
+         */
+        IssuerCountryCode: null,
+        /**
+         * The type of card product: DEBIT, CREDIT, CHARGE CARD.
+         */
+        Type: null,
+        /**
+         * The card brand. Examples include: AMERICAN EXPRESS, DISCOVER, JCB, MASTERCARD, VISA, etc.
+         */
+        Brand: null,
+        /**
+         * The subtype of the card product. Examples include: CLASSIC, GOLD, PLATINUM, PREPAID, etc.
+         */
+        SubType: null
+    }
+});
+
+module.exports = CardInfo;

package/lib/models/CardPreAuthorization.js

@@ -0,0 +1,144 @@
+var _ = require('underscore');
+var Model = require('../Model');
+var Money = require('./Money');
+var Billing = require('./Billing');
+var SecurityInfo = require('./SecurityInfo');
+var Shipping = require('./Shipping');
+var BrowserInfo = require('./BrowserInfo');
+
+var CardPreAuthorization = Model.extend({
+    defaults: {
+        AuthorId: null,
+
+        /**
+         * It represents the amount debited on the bank account
+         * of the Author.DebitedFunds = Fees + CreditedFunds
+         * (amount received on wallet)
+         */
+        DebitedFunds: null,
+
+        /**
+         * Status of the PreAuthorization: CREATED, SUCCEEDED, FAILED
+         */
+        Status: null,
+
+        /**
+         * The status of the payment after the PreAuthorization:
+         * WAITING, CANCELED, EXPIRED, VALIDATED
+         */
+        PaymentStatus: null,
+
+        ResultCode: null,
+        ResultMessage: null,
+
+        /**
+         * How the PreAuthorization has been executed.
+         * Only on value for now: CARD
+         */
+        ExecutionType: null,
+
+        /**
+         * An optional value to be specified on the user's bank statement
+         */
+        StatementDescriptor: null,
+
+        /**
+         * The SecureMode correspond to '3D secure' for CB Visa and MasterCard
+         * or 'Amex Safe Key' for American Express.
+         * This field lets you activate it manually.
+         */
+        SecureMode: null,
+
+        /**
+         * The ID of the registered card (Got through CardRegistration object)
+         */
+        CardId: null,
+
+        /**
+         * Boolean. The value is 'true' if the SecureMode was used
+         */
+        SecureModeNeeded: null,
+
+        /**
+         * This is the URL where to redirect users to proceed
+         * to 3D secure validation
+         */
+        SecureModeRedirectURL: null,
+
+        /**
+         * This is the URL where users are automatically redirected
+         * after 3D secure validation (if activated)
+         */
+        SecureModeReturnURL: null,
+        /**
+         * The date when the payment is processed
+         */
+        ExpirationDate: null,
+        /**
+         * The date when the payment was authorized
+         */
+        AuthorizationDate: null,
+        /**
+         * The type of pre-authorization ("CARD" is the only acceptable value at present
+         */
+        PaymentType: null,
+        PayInId: null,
+        Billing: null,
+        SecurityInfo: null,
+        RemainingFunds: null,
+
+        /**
+         * Boolean. The value is 'true' if the MultiCapture was used
+         */
+        MultiCapture: null,
+
+        /**
+         *  Is not Mandatory for 3DSv1 (flag �Use 3DSV2 Scenario� OFF)
+         *  Is mandatory when the flag �Use 3DSV2 Scenario� is active for (FORCE/DEFAULT/FRICTIONLESS both 3)
+         */
+        IpAddress: null,
+
+        /**
+         * Shipping Address
+         */
+        Shipping: null,
+
+        /*
+         * BrowserInfo
+         */
+        BrowserInfo: null,
+
+        /*
+         * Requested3DSVersion
+         */
+        Requested3DSVersion: null,
+
+        /*
+         * Applied3DSVersion
+         */
+        Applied3DSVersion: null,
+        /*
+         * Information about the card
+         */
+        CardInfo: null
+    },
+
+    getSubObjects: function() {
+      return {
+            'DebitedFunds': Money,
+            'Billing': Billing,
+            'SecurityInfo': SecurityInfo,
+            'RemainingFunds': Money,
+            'Shipping': Shipping,
+            'BrowserInfo': BrowserInfo
+        }
+    },
+
+    getReadOnlyProperties: function() {
+        var properties = Model.prototype.getReadOnlyProperties();
+        properties.push('Status', 'ResultCode', 'ResultMessage');
+        return properties;
+    }
+});
+
+module.exports = CardPreAuthorization;

package/lib/models/CardRegistration.js

@@ -0,0 +1,29 @@
+var _ = require('underscore');
+var Model = require('../Model');
+
+var CardRegistration = Model.extend({
+    defaults: {
+        UserId: null,
+        CardType: null,
+        AccessKey: null,
+        PreregistrationData: null,
+        CardRegistrationURL: null,
+        CardId: null,
+        RegistrationData: null,
+        ResultCode: null,
+        ResultMessage: null,
+        Currency: null,
+        Status: null,
+        CardHolderName: null
+    },
+
+    getReadOnlyProperties: function() {
+        var properties = Model.prototype.getReadOnlyProperties();
+        properties.push('AccessKey', 'PreregistrationData', 'CardRegistrationURL', 'CardId', 'ResultCode',
+            'ResultMessage', 'Status');
+
+        return properties;
+    }
+});
+
+module.exports = CardRegistration;

package/lib/models/CardValidation.js

@@ -0,0 +1,19 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        AuthorId: null,
+        Status: null,
+        SecureModeReturnURL: null,
+        SecureModeRedirectURL: null,
+        SecureModeNeeded: null,
+        SecureMode: null,
+        IpAddress: null,
+        BrowserInfo: null,
+        Validity: null,
+        Type: null,
+        Applied3DSVersion: null,
+        ResultCode: null,
+        ResultMessage: null
+    }
+});

package/lib/models/CategorizeUserLegal.js

@@ -0,0 +1,15 @@
+var Model = require('./../Model');
+
+var CategorizeUserLegal = Model.extend({
+    defaults: {
+        Id: null,
+        UserCategory: null,
+        TermsAndConditionsAccepted: null,
+        LegalRepresentative: null,
+        HeadquartersAddress: null,
+        CompanyNumber: null,
+        ScaContext: null
+    }
+});
+
+module.exports = CategorizeUserLegal;

package/lib/models/CategorizeUserNatural.js

@@ -0,0 +1,18 @@
+var Model = require('./../Model');
+
+var CategorizeUserNatural = Model.extend({
+    defaults: {
+        Id: null,
+        UserCategory: null,
+        TermsAndConditionsAccepted: null,
+        Email: null,
+        Birthday: null,
+        Nationality: null,
+        CountryOfResidence: null,
+        PhoneNumber: null,
+        PhoneNumberCountry: null,
+        ScaContext: null
+    }
+});
+
+module.exports = CategorizeUserNatural;

package/lib/models/Check.js

@@ -0,0 +1,13 @@
+var Model = require('../Model');
+
+module.exports = Model.extend({
+    defaults: {
+        CheckId: null,
+        Type: null,
+        CheckStatus: null,
+        CreationDate: null,
+        LastUpdate: null,
+        Data: null,
+        Reasons: null
+    }
+});

package/lib/models/CheckData.js

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

package/lib/models/Client.js

@@ -0,0 +1,62 @@
+var EntityBase = require('./EntityBase');
+
+var Client = EntityBase.extend({
+    defaults: {
+        Name: null,
+        ClientId: null,
+        /**
+         *The primary branding colour to use for your merchant
+         */
+        PrimaryThemeColour: null,
+        /**
+         * The primary branding colour to use for buttons for your merchant
+         */
+        PrimaryButtonColour: null,
+        /**
+         * The URL of the logo of your client
+         */
+        Logo: null,
+        /**
+         * A list of email addresses to use when contacting you for technical issues/communications
+         */
+        TechEmails: null,
+        /**
+         * A list of email addresses to use when contacting you for admin/commercial issues/communications
+         */
+        AdminEmails: null,
+        /**
+         * A list of email addresses to use when contacting you for fraud/compliance issues/communications
+         */
+        FraudEmails: null,
+        /**
+         * A list of email addresses to use when contacting you for billing issues/communications
+         */
+        BillingEmails: null,
+        /**
+         * A description of what your platform does
+         */
+        PlatformDescription: null,
+        /**
+         * Client's business categorization info
+         */
+        PlatformCategorization: null,
+        /**
+         * The URL for your website
+         */
+        PlatformURL: null,
+
+        HeadquartersAddress: null,
+
+        HeadquartersPhoneNumber: null,
+        /**
+         * The tax (or VAT) number for your company
+         */
+        TaxNumber: null,
+        /**
+         * The licensor of the platform’s company account, indicating the Mangopay entity the platform contracted with
+         */
+        Licensor: null
+    }
+});
+
+module.exports = Client;

package/lib/models/ClientWallet.js

@@ -0,0 +1,28 @@
+var EntityBase = require('./EntityBase');
+var Money = require('./Money');
+
+var ClientWallet = EntityBase.extend({
+    defaults : {
+        Balance : null,
+        Currency : null,
+        FundsType : null
+    },
+
+    getSubObjects: function() {
+        return {
+            'Balance': Money
+        }
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function() {
+        var properties = EntityBase.prototype.getReadOnlyProperties();
+        properties.push('Balance');
+        return properties;
+    }
+});
+
+module.exports = ClientWallet;

package/lib/models/Conversion.js

@@ -0,0 +1,19 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        AuthorId: null,
+        DebitedWalletId: null,
+        CreditedWalletId: null,
+        DebitedFunds: null,
+        CreditedFunds: null,
+        Fees: null,
+        ConversionRate: null,
+        Status: null,
+        Type: null,
+        Nature: null,
+        ResultCode: null,
+        ResultMessage: null,
+        ExecutionDate: null
+    }
+});

package/lib/models/ConversionRate.js

@@ -0,0 +1,10 @@
+var Model = require('../Model');
+
+module.exports = Model.extend({
+    defaults: {
+        DebitedCurrency: null,
+        CreditedCurrency: null,
+        ClientRate: null,
+        MarketRate: null
+    }
+});

package/lib/models/CountryAuthorization.js

@@ -0,0 +1,12 @@
+var EntityBase = require('./EntityBase');
+
+var CountryAuthorization = EntityBase.extend({
+    defaults: {
+        CountryCode: null,
+        CountryName: null,
+        Authorization: null,
+        LastUpdate: null
+    }
+});
+
+module.exports = CountryAuthorization;

package/lib/models/DebitedBankAccount.js

@@ -0,0 +1,15 @@
+var Model = require('../Model');
+var Money = require('./Money');
+
+var DebitedBankAccount = Model.extend({
+    defaults: {
+        OwnerName: null,
+        AccountNumber: null,
+        IBAN: null,
+        BIC: null,
+        Type: null,
+        Country: null
+    }
+});
+
+module.exports = DebitedBankAccount;

package/lib/models/DeclaredUbo.js

@@ -0,0 +1,29 @@
+var Model = require('./../Model')
+
+/**
+ * Represents validation status of a user declared as UBO.
+ */
+var DeclaredUbo = Model.extend({
+    defaults: {
+        /**
+         * ID of the declared user
+         */
+        UserId: null,
+        /**
+         * Validation status of this declared UBO
+         * One of DeclaredUboStatus
+         */
+        Status: null,
+        /**
+         * Reason why the UBO is not valid
+         * One of UboRefusedReasonType
+         */
+        RefusedReasonType: null,
+        /**
+         * Message explaining why the UBO is not valid
+         */
+        RefusedReasonMessage: null
+    }
+});
+
+module.exports = DeclaredUbo;

package/lib/models/DeclaredUboStatus.js

@@ -0,0 +1,17 @@
+/**
+ * Enumeration of possible statuses of a declared UBO.
+ */
+module.exports = {
+    /**
+     * When declaration of a UBO was created
+     */
+    Created: 'CREATED',
+    /**
+     * When declaration of a UBO was validated
+     */
+    Validated: 'VALIDATED',
+    /**
+     * When declaration of a UBO was refused
+     */
+    Refused: 'REFUSED'
+};

package/lib/models/Deposit.js

@@ -0,0 +1,29 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        AuthorId: null,
+        DebitedFunds: null,
+        Status: null,
+        PaymentStatus: null,
+        PayinsLinked: null,
+        ResultCode: null,
+        ResultMessage: null,
+        CardId: null,
+        SecureModeReturnURL: null,
+        SecureModeRedirectURL: null,
+        SecureModeNeeded: null,
+        ExpirationDate: null,
+        PaymentType: null,
+        ExecutionType: null,
+        StatementDescriptor: null,
+        Culture: null,
+        IpAddress: null,
+        BrowserInfo: null,
+        Billing: null,
+        Shipping: null,
+        Requested3DSVersion: null,
+        Applied3DSVersion: null,
+        CardInfo: null
+    }
+});

package/lib/models/Dispute.js

@@ -0,0 +1,46 @@
+var _ = require('underscore');
+var Model = require('../Model');
+var Money = require('./Money');
+var DisputeReason = require('./DisputeReason');
+
+var Dispute = Model.extend({
+    defaults: {
+        InitialTransactionId: null,
+        InitialTransactionType: null,
+        DisputeType: null,
+        ContestDeadlineDate: null,
+        ClosedDate: null,
+        DisputeReason: null,
+        DisputedFunds: null,
+        ContestedFunds: null,
+        Status: null,
+
+        /**
+         * Free text used when reopening the dispute
+         */
+        StatusMessage: null,
+
+        /**
+         * The outcome of the dispute – will be null until closed, and then one of WON, LOST or VOID
+         */
+        ResultCode: null,
+        ResultMessage: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'DisputeReason': DisputeReason,
+            'DisputedFunds': Money,
+            'ContestedFunds': Money
+        }
+    },
+
+    getReadOnlyProperties: function() {
+        var properties = Model.prototype.getReadOnlyProperties();
+        properties.push('InitialTransactionId', 'InitialTransactionType', 'DisputeType', 'ContestDeadlineDate',
+            'DisputeReason', 'DisputedFunds', 'Status', 'StatusMessage', 'ResultCode', 'ResultMessage');
+        return properties;
+    }
+});
+
+module.exports = Dispute;

package/lib/models/DisputeDocument.js

@@ -0,0 +1,10 @@
+var Document = require('./Document');
+
+var DisputeDocument = Document.extend({
+    defaults: {
+        DisputeId: null,
+        Type: null
+    }
+});
+
+module.exports = DisputeDocument;

package/lib/models/DisputeDocumentPage.js

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

package/lib/models/DisputeReason.js

@@ -0,0 +1,11 @@
+var _ = require('underscore');
+var Model = require('../Model');
+
+var DisputeReason = Model.extend({
+    defaults: {
+        DisputeReasonType: null,
+        DisputeReasonMessage: null
+    }
+});
+
+module.exports = DisputeReason;

package/lib/models/Document.js

@@ -0,0 +1,12 @@
+var EntityBase = require('./EntityBase');
+
+var Document = EntityBase.extend({
+    defaults: {
+        Status: null,
+        RefusedReasonMessage: null,
+        RefusedReasonType: null,
+        ProcessedDate: null
+    }
+});
+
+module.exports = Document;

package/lib/models/DocumentPageConsult.js

@@ -0,0 +1,17 @@
+var Model = require('../Model');
+
+var DocumentPageConsult = Model.extend({
+    defaults: {
+        /**
+         * URL where this document page can be viewed.
+         */
+        Url: null,
+
+        /**
+         * Time in millis when the page consult will expire.
+         */
+        ExpirationDate: null
+    }
+});
+
+module.exports = DocumentPageConsult;