mangopay4-nodejs-sdk 1.64.0

package/lib/models/PaymentMethodMetadata.js

@@ -0,0 +1,38 @@
+var EntityBase = require('./EntityBase');
+
+var PaymentMethodMetadata = EntityBase.extend({
+    defaults: {
+        /**
+         * The type of metadata. Allowed values: BIN, GOOGLE_PAY
+         */
+        Type: null,
+        /**
+         * The bank identification number (BIN). (Format: 6 or 8 digits)
+         */
+        Bin: null,
+        /**
+         * The tokenized payment data provided by the third-party payment method.
+         */
+        Token: null,
+        /**
+         * In the case of Google Pay, the format of the Token.
+         * PAN_ONLY – The card is registered in the Google account and requires 3DS authentication.
+         * CRYPTOGRAM_3DS – The card is enrolled in the customer’s Google Wallet and authentication is handled by the Android device.
+         */
+        TokenFormat: null,
+        /**
+         * The country where the card was issued. Format: ISO-3166 alpha-2 two-letter country code
+         */
+        IssuerCountryCode: null,
+        /**
+         * The name of the card issuer.
+         */
+        IssuingBank: null,
+        /**
+         * Additional data about the card based on the BIN. In the case of co-branded card products, two objects are returned.
+         */
+        BinData: null
+    }
+});
+
+module.exports = PaymentMethodMetadata;

package/lib/models/PayoutMethods.js

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

package/lib/models/PendingUserAction.js

@@ -0,0 +1,16 @@
+var EntityBase = require('./EntityBase');
+
+var PendingUserAction = EntityBase.extend({
+    defaults: {
+        /**
+         * The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded.
+         * <p>
+         * Caution: Before redirecting the user on this URL, you must add the query parameter ReturnUrl with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not).
+         * <p>
+         * For more details, see <a href="https://docs.mangopay.com/guides/users/sca#how-to-redirect-a-user-for-an-sca-session">How to redirect a user for an SCA session</a>
+         */
+        RedirectUrl: null
+    }
+});
+
+module.exports = PendingUserAction;

package/lib/models/PersonType.js

@@ -0,0 +1,5 @@
+module.exports = {
+    NotSpecified: 'NotSpecified',
+    Natural: 'NATURAL',
+    Legal: 'LEGAL'
+};

package/lib/models/PlatformCategorization.js

@@ -0,0 +1,16 @@
+var EntityBase = require('./EntityBase');
+
+var PlatformCategorization = EntityBase.extend({
+  defaults: {
+    /**
+     * The type of business conducted by the client
+     */
+    BusinessType: null,
+    /**
+     * Sector of business
+     */
+    Sector: null
+  }
+});
+
+module.exports = PlatformCategorization;

package/lib/models/PlatformType.js

@@ -0,0 +1,10 @@
+module.exports = {
+    NotSpecified: 'NotSpecified',
+    MARKETPLACE: 'MARKETPLACE',
+    P2P_PAYMENT: 'P2P_PAYMENT',
+    CROWDFUNDING_DONATION: 'CROWDFUNDING_DONATION',
+    CROWDFUNDING_REWARD: 'CROWDFUNDING_REWARD',
+    CROWDFUNDING_EQUITY: 'CROWDFUNDING_EQUITY',
+    CROWDFUNDING_LOAN: 'CROWDFUNDING_LOAN',
+    OTHER: 'OTHER'
+};

package/lib/models/Quote.js

@@ -0,0 +1,11 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        ExpirationDate: null,
+        Status: null,
+        DebitedFunds: null,
+        CreditedFunds: null,
+        ConversionRateResponse: null
+    }
+});

package/lib/models/Recipient.js

@@ -0,0 +1,20 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        Status: null,
+        DisplayName: null,
+        PayoutMethodType: null,
+        RecipientType: null,
+        Currency: null,
+        Country: null,
+        RecipientScope: null,
+        UserId: null,
+        IndividualRecipient: null,
+        BusinessRecipient: null,
+        LocalBankTransfer: null,
+        InternationalBankTransfer: null,
+        PendingUserAction: null,
+        ScaContext: null
+    }
+});

package/lib/models/RecipientSchema.js

@@ -0,0 +1,17 @@
+var EntityBase = require('./EntityBase');
+
+module.exports = EntityBase.extend({
+    defaults: {
+        DisplayName: null,
+        Currency: null,
+        Country: null,
+        RecipientType: null,
+        PayoutMethodType: null,
+        RecipientScope: null,
+        Tag: null,
+        LocalBankTransfer: null,
+        InternationalBankTransfer: null,
+        IndividualRecipient: null,
+        BusinessRecipient: null,
+    }
+});

package/lib/models/RecurringPayIn.js

@@ -0,0 +1,10 @@
+var _ = require('underscore');
+var PayIn = require('./PayIn');
+
+var RecurringPayIn = PayIn.extend({
+    defaults: _.extend({}, PayIn.prototype.defaults, {
+        RecurringPayinRegistrationId: null
+    }),
+});
+
+module.exports = RecurringPayIn;

package/lib/models/RecurringPayInCIT.js

@@ -0,0 +1,32 @@
+var EntityBase = require('./EntityBase');
+var BrowserInfo = require('./BrowserInfo');
+var Money = require('./Money');
+
+var RecurringPayInCIT = EntityBase.extend({
+    defaults: {
+        /**
+         * Array with owners identities
+         */
+         RecurringPayinRegistrationId: null,
+         BrowserInfo: null,
+         IpAddress: null,
+         SecureModeReturnURL: null,
+         StatementDescriptor: null,
+         DebitedFunds: null,
+         Fees: null
+    },
+
+    /**
+     * Get mapping of model properties and corresponding object types
+     * @returns {Object}
+     */
+    getSubObjects: function() {
+        return {
+            'BrowserInfo': BrowserInfo,
+            'DebitedFunds': Money,
+            'Fees': Money
+        }
+    }
+});
+
+module.exports = RecurringPayInCIT;

package/lib/models/RecurringPayInCurrentState.js

@@ -0,0 +1,24 @@
+var Model = require('./../Model');
+var Money = require('./Money')
+
+var RecurringPayInCurrentState = Model.extend({
+    defaults: {
+        PayinsLinked: null,
+        CumulatedDebitedAmount: null,
+        CumulatedFeesAmount: null,
+        LastPayinId: null
+    },
+    
+    /**
+     * Get mapping of model properties and corresponding object types
+     * @returns {Object}
+     */
+         getSubObjects: function() {
+            return {
+                'CumulatedDebitedAmount': Money,
+                'CumulatedFeesAmount': Money
+            }
+        }
+});
+
+module.exports = RecurringPayInCurrentState;

package/lib/models/RecurringPayInMIT.js

@@ -0,0 +1,27 @@
+var EntityBase = require('./EntityBase');
+var Money = require('./Money');
+
+var RecurringPayInMIT = EntityBase.extend({
+    defaults: {
+        /**
+         * Array with owners identities
+         */
+         RecurringPayinRegistrationId: null,
+         DebitedFunds: null,
+         Fees: null,
+         StatementDescriptor: null
+    },
+
+    /**
+     * Get mapping of model properties and corresponding object types
+     * @returns {Object}
+     */
+    getSubObjects: function() {
+        return {
+            'DebitedFunds': Money,
+            'Fees': Money
+        }
+    }
+});
+
+module.exports = RecurringPayInMIT;

package/lib/models/RecurringPayInPut.js

@@ -0,0 +1,24 @@
+var Model = require('./../Model');
+var Billing = require('./Billing');
+var Shipping = require('./Shipping');
+
+var RecurringPayInPut = Model.extend({
+    defaults: {
+        CardId: null,
+        Billing: null,
+        Shipping: null
+    },
+    
+    /**
+     * Get mapping of model properties and corresponding object types
+     * @returns {Object}
+     */
+    getSubObjects: function() {
+        return {
+            'Billing': Billing,
+            'Shipping': Shipping
+        }
+    }
+});
+
+module.exports = RecurringPayInPut;

package/lib/models/Refund.js

@@ -0,0 +1,26 @@
+var _ = require('underscore');
+var Transaction = require('./Transaction');
+var RefundReasonDetails = require('./RefundReasonDetails');
+
+var Refund = Transaction.extend({
+    defaults: _.extend({}, Transaction.prototype.defaults, {
+        InitialTransactionId: null,
+        /**
+         * Initial transaction Type {PAYIN, PAYOUT, TRANSFER}
+         */
+        InitialTransactionType: null,
+        DebitedWalletId: null,
+        CreditedWalletId: null,
+        RefundReason: null,
+        Reference: null,
+        StatementDescriptor: null 
+    }),
+
+    getSubObjects: function() {
+        return {
+            'RefundReason': RefundReasonDetails
+        };
+    }
+});
+
+module.exports = Refund;

package/lib/models/RefundReasonDetails.js

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

package/lib/models/Report.js

@@ -0,0 +1,54 @@
+var EntityBase = require('./EntityBase');
+var ReportFilter = require('./ReportFilter');
+
+
+var Report = EntityBase.extend({
+    defaults: {
+        /**
+         *The date when the report was executed
+         */
+        ReportDate: null,
+        /**
+         * The URL to download the report
+         */
+        DownloadURL: null,
+        /**
+         * A URL that will be pinged when the report is ready to download (works in a similar way to the hooks)
+         */
+        CallbackURL: null,
+        /**
+         * The format of the report download { CSV }
+         */
+        DownloadFormat: null,
+        /**
+         * Report type {TRANSACTIONS, WALLETS}
+         */
+        ReportType: null,
+        /**
+         * The column to sort against and direction
+         */
+        Sort: null,
+        /**
+         * Whether the report should be limited to the first 10 lines (and therefore quicker to execute)
+         */
+        Preview: null,
+        Filters: null,
+        /**
+         * A list of columns/infos to show in the report
+         */
+        Columns: null,
+        /**
+         * The result code
+         */
+        ResultCode: null,
+        ResultMessage: null
+    },
+
+    getSubObjects: function () {
+        return {
+            'Filters': ReportFilter
+        }
+    }
+});
+
+module.exports = Report;

package/lib/models/ReportFilter.js

@@ -0,0 +1,52 @@
+var Model = require('../Model');
+
+var ReportFilter = Model.extend({
+    defaults: {
+        /**
+         * To return only resources that have CreationDate BEFORE this date
+         */
+        BeforeDate: null,
+        /**
+         * To return only resources that have CreationDate AFTER this date
+         */
+        AfterDate: null,
+        /**
+         * The type of the transaction
+         */
+        Type: null,
+        /**
+         * The status of the transaction
+         */
+        Status: null,
+        /**
+         * The nature of the transaction
+         */
+        Nature: null,
+        /**
+         * The minimum amount of DebitedFunds
+         */
+        MinDebitedFundsAmount: null,
+        /**
+         * The currency for the minimum amount of DebitedFunds
+         */
+        MinDebitedFundsCurrency: null,
+        /**
+         * The maximum amount of DebitedFunds
+         */
+        MaxDebitedFundsAmount: null,
+        /**
+         * The currency for the maximum amount of DebitedFunds
+         */
+        MaxDebitedFundsCurrency: null,
+        /**
+         * The object owner's id
+         */
+        AuthorId: null,
+
+        WalletId: null
+
+    }
+
+});
+
+module.exports = ReportFilter;

package/lib/models/ReportFilterV2.js

@@ -0,0 +1,11 @@
+var Model = require('../Model');
+
+var ReportFilterV2 = Model.extend({
+    defaults: {
+        Currency: null,
+        UserId: null,
+        WalletId: null
+    }
+});
+
+module.exports = ReportFilterV2;

package/lib/models/ReportV2.js

@@ -0,0 +1,28 @@
+var EntityBase = require('./EntityBase');
+var ReportFilterV2 = require('./ReportFilterV2');
+
+
+var ReportV2 = EntityBase.extend({
+    defaults: {
+        ReportDate: null,
+        Status: null,
+        ResultCode: null,
+        ResultMessage: null,
+        DownloadFormat: null,
+        DownloadURL: null,
+        ReportType: null,
+        Sort: null,
+        AfterDate: null,
+        BeforeDate: null,
+        Filters: null,
+        Columns: null
+    },
+
+    getSubObjects: function () {
+        return {
+            'Filters': ReportFilterV2
+        };
+    }
+});
+
+module.exports = ReportV2;

package/lib/models/Repudiation.js

@@ -0,0 +1,51 @@
+var _ = require('underscore');
+var Model = require('../Model');
+var Money = require('./Money');
+
+var Repudiation = Model.extend({
+    defaults: {
+        AuthorId: null,
+        /**
+         * The funds repudiated from the wallet
+         */
+        DebitedFunds: null,
+        /**
+         * The fees taken on the repudiation – will always be 0 at this stage
+         */
+        Fees: null,
+        /**
+         * The amount of credited funds – since there are currently no fees,
+         * this will be equal to the DebitedFunds
+         */
+        CreditedFunds: null,
+        /**
+         * The wallet from where the repudiation was taken
+         */
+        DebitedWalletId: null,
+        /**
+         * The status of the transfer {CREATED, SUCCEEDED, FAILED}
+         */
+        Status: null,
+        ResultCode: null,
+        ResultMessage: null,
+        ExecutionDate: null,
+        /**
+         * The Id of the dispute to which this repudation corresponds.
+         * Note that this value may be null (if it was created before the Dispute
+         * objects started to be used – October 2015)
+         */
+        DisputeId: null,
+        InitialTransactionId: null,
+        InitialTransactionType: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'DebitedFunds': Money,
+            'Fees': Money,
+            'CreditedFunds': Money
+        }
+    }
+});
+
+module.exports = Repudiation;

package/lib/models/SecurityInfo.js

@@ -0,0 +1,12 @@
+var EntityBase = require('./EntityBase');
+
+var SecurityInfo = EntityBase.extend({
+  defaults: {
+    /**
+     * The address
+     */
+    AVSResult: null
+  }
+});
+
+module.exports = SecurityInfo;

package/lib/models/Settlement.js

@@ -0,0 +1,16 @@
+var EntityBase = require('./EntityBase');
+
+var Settlement = EntityBase.extend({
+    defaults: {
+        SettlementId: null,
+        Status: null,
+        SettlementDate: null,
+        ExternalProviderName: null,
+        DeclaredIntentAmount: null,
+        ExternalProcessorFeesAmount: null,
+        ActualSettlementAmount: null,
+        FundsMissingAmount: null
+    }
+});
+
+module.exports = Settlement;

package/lib/models/SettlementTransfer.js

@@ -0,0 +1,37 @@
+var _ = require('underscore');
+var Model = require('../Model');
+var Money = require('./Money');
+
+var SettlementTransfer = Model.extend({
+    defaults: {
+        /**
+         * The Id of the author of the original PayIn that was repudiated
+         */
+        AuthorId: null,
+
+        /**
+         * The funds debited from the debited wallet
+         */
+        DebitedFunds: null,
+
+        /**
+         * The amount you wish to charge for this settlement.
+         * This can be equal to 0, or more than 0 to charge for the settlement
+         * or less than 0 to refund some of the original Fees that were taken
+         * on the original settlement (eg DebitedFunds of 1000 and
+         * Fees of -200 will transfer 800 from the original wallet
+         * to the credit wallet, and transfer 200 from your Fees
+         * wallet to your Credit wallet
+         */
+        Fees: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'DebitedFunds': Money,
+            'Fees': Money
+        }
+    }
+});
+
+module.exports = SettlementTransfer;

package/lib/models/Shipping.js

@@ -0,0 +1,14 @@
+var EntityBase = require('./EntityBase');
+
+var Shipping = EntityBase.extend({
+    defaults: {
+        FirstName: null,
+        LastName: null,
+        /**
+         * The address
+         */
+        Address: null
+    }
+});
+
+module.exports = Shipping;

package/lib/models/ShippingAddress.js

@@ -0,0 +1,25 @@
+var EntityBase = require('./EntityBase');
+var Address = require('./Address');
+
+/**
+ * Models shipping details
+ */
+module.exports = EntityBase.extend({
+    defaults: {
+        /**
+         * Name of the shipping recipient
+         */
+        RecipientName: null,
+
+        /**
+         * The shipping address
+         */
+        Address: null
+    },
+
+    getSubObjects: function () {
+        return {
+            'Address': Address
+        };
+    }
+});

package/lib/models/ShippingPreference.js

@@ -0,0 +1,5 @@
+module.exports = {
+    SetProvidedAddress: 'SET_PROVIDED_ADDRESS',
+    GetFromFile: 'GET_FROM_FILE',
+    NoShipping: 'NO_SHIPPING'
+};

package/lib/models/Transaction.js

@@ -0,0 +1,50 @@
+var EntityBase = require('./EntityBase');
+var Money = require('./Money');
+
+var Wallet = EntityBase.extend({
+    defaults: {
+        /**
+         * Array with owners identities
+         */
+        AuthorId: null,
+        CreditedUserId: null,
+        DebitedFunds: null,
+        CreditedFunds: null,
+        Fees: null,
+        /**
+         * TransactionStatus {CREATED, SUCCEEDED, FAILED}
+         */
+        Status: null,
+        ResultCode: null,
+        ResultMessage: null,
+        ExecutionDate: null,
+        Type: null,
+        Nature: null,
+        DebitedWalletId: null,
+        CreditedWalletId: null
+    },
+
+    /**
+     * Get mapping of model properties and corresponding object types
+     * @returns {Object}
+     */
+    getSubObjects: function() {
+        return {
+            'DebitedFunds': Money,
+            'CreditedFunds': Money,
+            'Fees': Money
+        }
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function() {
+        var properties = EntityBase.prototype.getReadOnlyProperties();
+        properties.push('Status', 'ResultCode', 'ExecutionDate');
+        return properties;
+    }
+});
+
+module.exports = Wallet;