mangopay4-nodejs-sdk 1.64.0

package/lib/services/Cards.js

@@ -0,0 +1,168 @@
+/**
+ * @module Cards
+ * @desc [MangoPay Cards API Reference](https://docs.mangopay.com/endpoints/v2.01/cards)
+ */
+
+var _ = require('underscore');
+var Service = require('../service');
+var Card = require('../models/Card');
+var Transaction = require('../models/Transaction');
+var CardPreAuthorization = require('../models/CardPreAuthorization');
+var CardValidation = require('../models/CardValidation');
+
+
+var Cards = Service.extend({
+    /**
+     * Get card
+     * @param {number}  cardId  Card identifier
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}        Request promise
+     */
+    get: function(cardId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: cardId
+            },
+            dataClass: Card
+        });
+
+        return this._api.method('card_get', callback, options);
+    },
+
+    /**
+     * Gets a list of cards having the same fingerprint.
+     * The fingerprint is a hash uniquely generated per 16-digit card number.
+     *
+     * @param fingerprint The fingerprint hash
+     * @return List of Cards corresponding to provided fingerprint
+     */
+    getByFingerprint: function(fingerprint, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                fingerprint: fingerprint
+            },
+            dataClass: Card
+        });
+        return this._api.method('cards_get_by_fingerprint', callback, options);
+    },
+
+    /**
+     * Update card
+     * @param {Object}      card        Card object of properties hash
+     * @param {function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    update: function(card, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: card,
+            path: {
+                id: card.Id
+            },
+            dataClass: Card
+        });
+
+        return this._api.method('card_save', callback, options);
+    },
+
+    /**
+     * Get list of Transactions of a Card
+     * @param {number}      cardId      Card identifier
+     * @param {function}    callback    Callback function
+     * @param {object}      options     Request options
+     * @return {object}                 Request promise
+     */
+    getTransactions: function(cardId, callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            path: {
+                cardId: cardId
+            },
+            dataClass: Transaction
+        });
+
+        return this._api.method('transactions_get_for_card', callback, options);
+
+    },
+
+    /**
+     * Gets list of PreAuthorizations of a Card.
+     * @param {number}      cardId      Card identifier
+     * @param {function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    getPreAuthorizations: function(cardId, callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: cardId
+            },
+            dataClass: CardPreAuthorization
+        });
+
+        return this._api.method('card_get_preauthorizations', callback, options);
+    },
+
+    /**
+     * Validate a card
+     * @param cardId The ID of the card
+     * @param cardValidation The create card validation dto
+     * @param callback
+     * @param options
+     * @returns {*|Promise}
+     */
+    validate: function(cardId, cardValidation, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: cardId
+            },
+            data: cardValidation,
+            dataClass: CardValidation
+        });
+
+        return this._api.method('card_validate', callback, options);
+    },
+
+    /**
+     * Get Card Validation
+     * @param cardId The ID of the card
+     * @param cardValidationId The ID of the CardValidation
+     * @param callback
+     * @param options
+     * @returns {*|Promise}
+     */
+    getCardValidation: function(cardId, cardValidationId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                cardId: cardId,
+                cardValidationId: cardValidationId
+            },
+            dataClass: CardValidation
+        });
+
+        return this._api.method('get_card_validation', callback, options);
+    },
+
+    /**
+     * Get a list of Transactions for a fingerprint
+     * @param fingerprint
+     * @param callback
+     * @param options
+     */
+    getTransactionsForFingerprint: function(fingerprint, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                fingerprint: fingerprint
+            }
+        });
+
+        return this._api.method('transactions_get_by_fingerprint', callback, options);
+
+    },
+});
+
+module.exports = Cards;

package/lib/services/Clients.js

@@ -0,0 +1,196 @@
+/**
+ * @module Clients
+ * @desc [MangoPay Users API Reference](https://docs.mangopay.com/endpoints/v2.01/clients)
+ */
+var _ = require('underscore');
+var fs = require('fs');
+var Service = require('../service');
+
+var Client = require('../models/Client');
+var Transaction = require('../models/Transaction');
+var ClientWallet = require('../models/ClientWallet');
+var BankAccount = require('../models/BankAccount');
+var PayOut = require('../models/PayOut');
+var PayIn = require('../models/PayIn');
+
+var Clients = Service.extend({
+    /**
+     * Get client by ID
+     * @param {string}  clientId  Client identifier
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}        Request promise
+     */
+    get: function(callback, options) {
+        options = this._api._getOptions(callback, options, {
+            dataClass: Client
+        });
+
+        return this._api.method('clients_get', callback, options);
+    },
+
+    /**
+     * Update client
+     * @param client            Client to be updated
+     * @param callback          Callback function
+     * @param options           Request options
+     * @returns {*}             Promise of the request
+     */
+    update: function(client,callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: client,
+            dataClass: Client
+        });
+
+        return this._api.method('clients_update', callback, options);
+    },
+
+    /**
+     * Upload client logo
+     * @param {string}  logo                    Logo
+     * @param {Function} callback               Callback function
+     * @param {Object} options                  Request options
+     * @return {Object}                         Promise of the request
+     */
+    uploadLogo: function(logo, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: {File: logo}
+        });
+
+        return this._api.method('clients_upload_logo', callback, options);
+    },
+
+    /**
+     * Upload client logo from file
+     * @param {string}  file                    File path
+     * @param {Function} callback               Callback function
+     * @param {Object} options                  Request options
+     * @return {Object}                         Promise of the request
+     */
+    uploadLogoFromFile: function(file, callback, options) {
+        if (!file) {
+            this._api.errorHandler('File path cannot be empty');
+            return;
+        }
+
+        try {
+            fs.statSync(file);
+        } catch (e) {
+            this._api.errorHandler('File does not exist');
+            return;
+        }
+
+        var logo = Buffer.from(fs.readFileSync(file)).toString('base64');
+
+
+        if (!logo) this._api.errorHandler('Content of the file cannot be empty');
+        return this.uploadLogo(logo, callback, options);
+    },
+
+    /**
+     * Get all client wallets
+     * @param {Function} callback               Callback function
+     * @param {Object} options                  Request options
+     * @return {Object}                         Promise of the request
+     */
+    getClientWallets: function(callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            dataClass: ClientWallet
+        });
+
+        return this._api.method("client_wallets_all", callback, options);
+    },
+
+    /**
+     * Get a client wallet
+     * @param fundsType                         Wallet's funds type
+     * @param currency                          Currency of the wallet
+     * @param {Function} callback               Callback function
+     * @param {Object} options                  Request options
+     * @return {Object}                         Promise of the request
+     */
+    getClientWallet: function(fundsType, currency, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                fundsType: fundsType,
+                currency: currency
+            },
+            dataClass: ClientWallet
+        });
+
+        return this._api.method("client_wallets_get", callback, options);
+    },
+
+    /**
+     * Get client wallets by the type of funds
+     * @param fundsType                         Wallets funds type
+     * @param {Function} callback               Callback function
+     * @param {Object} options                  Request options
+     * @return {Object}                         Promise of the request
+     */
+    getClientWalletsByFundsType: function(fundsType, callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            path: {
+                fundsType: fundsType
+            },
+            dataClass: ClientWallet
+        });
+
+        return this._api.method("client_wallets_by_fundsType", callback, options);
+    },
+
+    /**
+     * Get a client wallet's transactions
+     * @param fundsType                         Wallet's funds type
+     * @param currency                          Currency of the wallet
+     * @param {Function} callback               Callback function
+     * @param {Object} options                  Request options
+     * @return {Object}                         Promise of the request
+     */
+    getClientWalletTransactions:  function(fundsType, currency, callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            path: {
+                fundsType: fundsType,
+                currency: currency
+            },
+            dataClass: Transaction
+        });
+
+        return this._api.method("client_wallets_transactions", callback, options);
+    },
+
+    createBankAccountIBAN: function(bankAccountIBAN, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: bankAccountIBAN,
+            dataClass: BankAccount
+        });
+
+        return this._api.method('client_create_bankaccount_iban', callback, options);
+    },
+
+    createPayOut: function(payOut, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: payOut,
+            dataClass: PayOut
+        });
+
+        return this._api.method('client_create_payout', callback, options);
+    },
+
+    createBankWireDirectPayIn: function(payIn, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: payIn,
+            dataClass: PayIn
+        });
+
+        return this._api.method('client_create_bankwire_direct', callback, options);
+    }
+});
+
+module.exports = Clients;

package/lib/services/Conversions.js

@@ -0,0 +1,155 @@
+var _ = require('underscore');
+var Service = require('../service');
+var ConversionRate = require('../models/ConversionRate');
+var Conversion = require('../models/Conversion');
+var Quote = require('../models/Quote');
+
+var Conversions = Service.extend({
+    /**
+     * This endpoint allows the platform to get a real time
+     * indicative market rate of a specific currency pair.
+     * The rate returned is given in real time.
+     * @param debitedCurrency The sell currency – the currency of the wallet to be debited
+     * @param creditedCurrency The buy currency – the currency of the wallet to be credited
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    getConversionRate: function (debitedCurrency, creditedCurrency, callback, options) {
+        options = this._api._getOptions(callback, options,
+            {
+                path: {
+                    debitedCurrency: debitedCurrency,
+                    creditedCurrency: creditedCurrency
+                },
+                dataClass: ConversionRate
+            });
+
+        return this._api.method("get_conversion_rate", callback, options);
+    },
+
+    /**
+     * This endpoint allows the platform to move funds
+     * between two wallets of different currencies instantaneously.
+     * @param instantConversion Body object
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    createInstantConversion: function (instantConversion, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: instantConversion,
+            dataClass: Conversion
+        });
+
+        return this._api.method('create_instant_conversion', callback, options);
+    },
+
+    /**
+     * This call triggers a conversion, at the rate guaranteed by its quote, of the debited funds to the credited wallet.
+     * Each quoted conversion requires a dedicated Quote object, linked in the QuoteId.
+     * Fees can’t be taken on a quoted conversion.
+     * @param quotedConversion Body object
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    createQuotedConversion: function (quotedConversion, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: quotedConversion,
+            dataClass: Conversion
+        });
+
+        return this._api.method('create_quoted_conversion', callback, options);
+    },
+
+    /**
+     * This call triggers a conversion at the rate defined in its quote.
+     * The debited funds (buy currency), credited funds (sell currency) and currencies are defined in the quote.
+     * The Client Wallets to debit and credit are defined in the conversion.
+     * @param conversion Body object
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    createClientWalletsQuotedConversion: function (conversion, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: conversion,
+            dataClass: Conversion
+        });
+
+        return this._api.method('create_client_wallets_quoted_conversion', callback, options);
+    },
+
+    /**
+     * This call triggers an immediate conversion at the market rate, of the debited funds to the credited wallet at the market rate.
+     * A quote is not required for an instant conversion.
+     * @param conversion Body object
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    createClientWalletsInstantConversion: function (conversion, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: conversion,
+            dataClass: Conversion
+        });
+
+        return this._api.method('create_client_wallets_instant_conversion', callback, options);
+    },
+
+    /**
+     * This endpoint allows the platform to get the
+     * details of a conversion which has been carried out.
+     * @param id Id of the conversion
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    getConversion: function (id, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: id
+            },
+            dataClass: Conversion
+        });
+
+        return this._api.method('get_conversion', callback, options);
+    },
+
+    /**
+     * This call guarantees a conversion rate to let you Create a Quoted Conversion
+     * @param quote Body object
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    createQuote: function (quote, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: quote,
+            dataClass: Quote
+        });
+
+        return this._api.method('create_quote', callback, options);
+    },
+
+    /**
+     * View a Quote
+     * @param id Id of the conversion
+     * @param callback Callback function
+     * @param options Request options
+     * @returns {Object} Request promise
+     */
+    getQuote: function (id, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: id
+            },
+            dataClass: Quote
+        });
+
+        return this._api.method('get_quote', callback, options);
+    },
+});
+
+module.exports = Conversions;

package/lib/services/Deposits.js

@@ -0,0 +1,109 @@
+var Service = require('../service');
+var Deposit = require('../models/Deposit');
+
+var Deposits = Service.extend({
+    /**
+     * Create a Deposit
+     */
+    create: function(deposit, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: deposit,
+            dataClass: Deposit
+        });
+
+        return this._api.method('deposits_create', callback, options);
+    },
+
+    /**
+     * Get a Deposit
+     */
+    get: function(depositId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                depositId: depositId
+            },
+            dataClass: Deposit
+        });
+
+        return this._api.method('deposits_get', callback, options);
+    },
+
+    /**
+     * Cancel a Deposit
+     */
+    cancel: function(depositId, callback, options) {
+        const dto = {
+            PaymentStatus: 'CANCELED'
+        };
+
+        options = this._api._getOptions(callback, options, {
+            path: {
+                depositId: depositId
+            },
+            data: dto,
+            dataClass: Deposit
+        });
+
+        return this._api.method('deposits_update', callback, options);
+    },
+
+    /**
+     * Get all deposits for a card
+     */
+    getAllForCard: function(cardId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                cardId: cardId
+            }
+        });
+
+        return this._api.method('deposits_get_all_for_card', callback, options);
+    },
+
+    /**
+     * Get all deposits for a user
+     */
+    getAllForUser: function(userId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                userId: userId
+            }
+        });
+
+        return this._api.method('deposits_get_all_for_user', callback, options);
+    },
+
+    /**
+     * Update a Deposit (set PaymentStatus to CANCELED or NO_SHOW_REQUESTED)
+     */
+    update: function(depositUpdate, callback, options) {
+        if (!depositUpdate.Id) {
+            this._api.errorHandler('Cannot update deposit, the Id is missing');
+        }
+
+        options = this._api._getOptions(callback, options, {
+            path: {
+                depositId: depositUpdate.Id
+            },
+            data: depositUpdate,
+            dataClass: Deposit
+        });
+
+        return this._api.method('deposits_update', callback, options);
+    },
+
+    /**
+     * Get all transactions for a deposit
+     */
+    getTransactions: function(depositId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                depositId: depositId
+            }
+        });
+
+        return this._api.method('deposits_get_transactions', callback, options);
+    },
+});
+
+module.exports = Deposits;

package/lib/services/DisputeDocuments.js

@@ -0,0 +1,65 @@
+/**
+ * @module DisputeDocuments
+ * @desc [MangoPay Dispute Documents API Reference](https://docs.mangopay.com/endpoints/v2.01/dispute-documents)
+ */
+
+var _ = require('underscore');
+var Service = require('../service');
+var DisputeDocument = require('../models/DisputeDocument');
+
+var DisputeDocuments = Service.extend({
+    /**
+     * Gets dispute's document
+     * @param {number}  documentId      Document identifier
+     * @param {Function} callback       Callback function
+     * @param {Object} options          Request options
+     * @return {Object}                 Request promise
+     */
+    get: function (documentId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: documentId
+            },
+            dataClass: DisputeDocument
+        });
+
+        return this._api.method('disputes_document_get', callback, options);
+    },
+
+    /**
+     * Gets dispute's documents for client
+     * @param {Function} callback       Callback function
+     * @param {Object} options          Request options
+     * @return {Object}                 Request promise
+     */
+    getAll: function (callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            dataClass: DisputeDocument
+        });
+
+        return this._api.method('disputes_document_all', callback, options);
+    },
+
+    /**
+     * Creates temporary URLs where each page of a dispute document can be viewed.
+     *
+     * @param {string} documentId       Document identifier
+     * @param {Function} callback       Callback function
+     * @param {Object} options          Request options
+     * @return {Object}                 Request promise
+     */
+    createDisputeDocumentConsult: function (documentId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: documentId
+            },
+            dataClass: DisputeDocument
+        });
+
+        return this._api.method('disputes_document_create_consult', callback, options);
+    }
+});
+
+module.exports = DisputeDocuments;