mangopay4-nodejs-sdk 1.64.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mangopay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,179 @@
+Mangopay Node.js SDK
+=================================================
+MangopaySDK is a Node.js client library to work with [Mangopay REST API](http://docs.mangopay.com/api-references/).
+
+
+Installation
+-------------------------------------------------
+Install the module via npm
+
+    npm install mangopay4-nodejs-sdk --save
+
+Usage inside your app
+
+    var mangopay = require('mangopay4-nodejs-sdk');
+
+    var api = new mangopay({
+        clientId: 'your_client_id',
+        clientApiKey: 'your_client_api_key',
+        // Set the right production API url. If testing, omit the property since it defaults to sandbox URL
+        baseUrl: 'https://api.mangopay.com'
+    });
+
+    api.Users.create(...)
+
+Supported options
+-------------------------------------------------
+| Option    | Default value | Description |
+| --------  | -----------   | ----------- |
+|clientId   |null      | API Client Id|
+|clientApiKey|null| API Client Api Key|
+|baseUrl|"https://api.sandbox.mangopay.com"| API Base URL. The default value points to sandbox. Production is 'https://api.mangopay.com'|
+|debugMode|false| Active debugging|
+|logClass|```function() {console.log(arguments)}```|Log function to be used for debug|
+|connectionTimeout|30000|Set the connection timeout limit (in milliseconds)|
+|responseTimeout|80000|Set the response timeout limit (in milliseconds)|
+|apiVersion|'v2.01'|API Version|
+|errorHandler|```function(options, err) {console.error(options, err)}```|Set a custom error handler
+
+Documentation
+-------------------------------------------------
+[Github Full Node.js SDK Documentation](docs/README.md) is located in ``/docs`` folder.
+You can also access [API References on our website](https://docs.mangopay.com/endpoints/).
+
+License
+-------------------------------------------------
+MangopaySDK is distributed under MIT license, see the [LICENSE file](LICENSE).
+
+Contacts
+-------------------------------------------------
+Report bugs or suggest features using
+[issue tracker on GitHub](https://github.com/Mangopay/mangopay2-nodejs-sdk/issues).
+
+Account creation
+-------------------------------------------------
+You can get yourself a free sandbox account or sign up for a production account by [registering on the Mangopay site](https://www.mangopay.com/start/) (note that validation of your production account involves several steps, so think about doing it in advance of when you actually want to go live).
+
+
+### Creating a user
+
+#### Using a hash of properties:
+```ts
+    mangopay.Users.create({
+        "FirstName": "Victor",
+        "LastName": "Hugo",
+        "Address": "1 rue des Misérables, Paris",
+        "Birthday": 1300186358,
+        "Nationality": "FR",
+        "CountryOfResidence": "FR",
+        "Occupation": "Writer",
+        "IncomeRange": "6",
+        "ProofOfIdentity": null,
+        "ProofOfAddress": null,
+        "PersonType": "NATURAL",
+        "Email": "victor@hugo.com",
+        "Tag": "custom tag",
+    }, function(model) {
+        // User created - using callback
+    }).then(function(model){
+        // User created - using promise
+    });
+```
+
+#### Using Mangopay SDK pre-defined models:
+```ts
+    var myUser = new api.models.UserLegal({
+        Name: 'MangoPay',
+        Email: 'info@mangopay.com',
+        LegalPersonType: 'BUSINESS',
+        LegalRepresentativeFirstName: 'Mango',
+        LegalRepresentativeLastName: 'Pay',
+        LegalRepresentativeEmail: 'mango@mangopay.com',
+        HeadquartersAddress: new api.models.Address({
+            AddressLine1: "4101 Reservoir Rd NW",
+            AddressLine2: "",
+            City: "Washington",
+            Region: "District of Columbia",
+            PostalCode: "20007",
+            Country: "US"
+        }),
+        LegalRepresentativeBirthday: 1300186358,
+        LegalRepresentativeNationality: 'FR',
+        LegalRepresentativeCountryOfResidence: 'FR',
+        CompanyNumber: 123456789,
+        Tag: 'custom tag'
+    });
+
+    api.Users.create(myUser).then(function(){
+        // Output the created user data to console
+        console.log(myUser.Name + ' user created at ' + myUser.CreationDate);
+    });
+```
+
+#### Promise vs Callback
+Mangopay Node.js SDK supports both callback and promise approach.
+Here is how they can be implemented :
+
+```ts
+    api.Service.method(... , function(data, response, err){
+        // Callback method
+    })
+
+    api.Service.method(...).then(function(data) {
+        // Promise function called
+    }, function(error) {
+        //exception
+    })
+```
+
+### Pagination / Filtering
+In order to [paginate or filter](https://docs.mangopay.com/guide/lists-pagination-management) results,
+we can use ``options.parameters`` to specify these options:
+```ts
+    api.Transactions.getAll({
+        parameters: {
+            // Pagination
+            per_page: 2,
+            page: 2,
+
+            // Filters
+            BeforeDate: 1414000367,
+            AfterDate: 1414000367,
+            Nature: REGULAR,
+            Status: FAILED,
+            Type: TRANSFER
+        }
+    }
+```
+
+### Reading server response headers
+For [reading the server response headers](examples/readResponseHeaders.js) we can use ``options.resolveWithFullResponse: true``
+```ts
+    api.Users.getAll(null, {
+      parameters: {
+        per_page: 1
+      },
+      resolveWithFullResponse: true
+    }).then(function(response){
+      // Read pages count
+      console.log(response.headers['x-number-of-pages']);
+
+      // Read response body
+      console.log(response.body);
+    });
+```
+
+Sample usage of Mangopay SDK installed with npm in a Node.js project
+-------------------------------------------------
+Don't forget to check examples folder !
+
+Contributing
+-------------------------------------------------
+    npm start                       // installs dependencies and global mocha for testing and jsdox for documentation
+    npm test                        // runs the mocha tests
+    npm run-script documentation    // update documentation using jsdox, make sure to have it installed globally
+
+Unit Tests
+-------------------------------------------------
+Mocha tests are placed under ``/test/`` folder. To run the tests, make sure you have all dependencies installed.
+Check Contributing section for details.

package/docs/BankAccounts.md

@@ -0,0 +1,35 @@
+# BankAccounts
+
+
+
+
+
+* * *
+
+### BankAccounts.getTransactions(bankAccountId, callback, options) 
+
+Retrieve list of transactions for a bank account
+
+**Parameters**
+
+**bankAccountId**: `number`, Bank Account Id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *
+
+
+
+
+
+
+
+
+
+

package/docs/BankingAliases.md

@@ -0,0 +1,108 @@
+# BankingAliases
+
+
+
+
+
+* * *
+
+### BankingAliases.create(bankingAlias, callback, options) 
+
+Create a banking alias
+
+**Parameters**
+
+**bankingAlias**: `Object`, Banking Alias Data
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### BankingAliases.get(bankingAliasId, callback, options) 
+
+Get a banking alias
+
+**Parameters**
+
+**bankingAliasId**: `number`, Banking Alias Id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### BankingAliases.getAll(callback, options) 
+
+Get all banking aliases
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### BankingAliases.update(bankingAliasId, callback, options) 
+
+Update banking alias
+
+**Parameters**
+
+**bankingAliasId**: `number`, Banking Alias Id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### BankingAliases.deactivate(bankingAliasId, callback, options) 
+
+Deactivate banking alias
+
+**Parameters**
+
+**bankingAliasId**: `number`, Banking Alias Id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### BankingAliases.activate(bankingAliasId, callback, options) 
+
+Activate banking alias
+
+**Parameters**
+
+**bankingAliasId**: `number`, Banking Alias Id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *
+
+
+
+
+
+
+
+
+
+

package/docs/CardPreAuthorizations.md

@@ -0,0 +1,55 @@
+# CardPreAuthorizations
+
+[MangoPay Card Pre-Authorizations API Reference](https://docs.mangopay.com/endpoints/v2.01/preauthorizations)
+
+
+
+* * *
+
+### CardPreAuthorizations.create(cardPreAuthorization, callback, options)
+
+Create new pre-authorization
+
+**Parameters**
+
+**cardPreAuthorization**: `Object`, CardPreAuthorization object or properties hash
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### CardPreAuthorizations.get(cardPreAuthorizationId, callback, options)
+
+Get pre-authorization object
+
+**Parameters**
+
+**cardPreAuthorizationId**: `number`, PreAuthorization identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### CardPreAuthorizations.update(cardPreAuthorization, callback, options)
+
+Update pre-authorization object
+
+**Parameters**
+
+**cardPreAuthorization**: `Object`, CardPreAuthorization object of properties hash
+
+**callback**: `function`, Update pre-authorization object
+
+**options**: `Object`, Update pre-authorization object
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/CardRegistrations.md

@@ -0,0 +1,55 @@
+# CardRegistrations
+
+[MangoPay Card Registration API Reference](https://docs.mangopay.com/endpoints/v2.01/cards)
+
+
+
+* * *
+
+### CardRegistrations.create(cardRegistration, callback, options)
+
+Create new card registration
+
+**Parameters**
+
+**cardRegistration**: `Object`, CardRegistration object or properties hash
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### CardRegistrations.get(cardRegistrationId, callback, options)
+
+Get registration
+
+**Parameters**
+
+**cardRegistrationId**: `number`, Registration identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### CardRegistrations.update(cardRegistration, callback, options)
+
+Update card registration
+
+**Parameters**
+
+**cardRegistration**: `Object`, CardPreAuthorization object of properties hash
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/Cards.md

@@ -0,0 +1,82 @@
+# Cards
+
+[MangoPay Cards API Reference](https://docs.mangopay.com/endpoints/v2.01/cards#e177_the-card-registration-object)
+
+
+
+* * *
+
+### Cards.get(cardId, callback, options)
+
+Get card
+
+**Parameters**
+
+**cardId**: `number`, Card identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Cards.getByFingerprint(fingerprint)
+
+Gets a list of cards having the same fingerprint.
+The fingerprint is a hash uniquely generated per 16-digit card number.
+
+**Parameters**
+
+**fingerprint**: , The fingerprint hash
+
+**Returns**: , List of Cards corresponding to provided fingerprint
+
+
+### Cards.update(card, callback, options)
+
+Update card
+
+**Parameters**
+
+**card**: `Object`, Card object of properties hash
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Cards.getTransactions(cardId, callback, options)
+
+Get list of Transactions of a Card
+
+**Parameters**
+
+**cardId**: `number`, Card identifier
+
+**callback**: `function`, Callback function
+
+**options**: `object`, Request options
+
+**Returns**: `object`, Request promise
+
+
+### Cards.getPreAuthorizations(cardId, callback, options)
+
+Gets list of PreAuthorizations of a Card.
+
+**Parameters**
+
+**cardId**: `number`, Card identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/Clients.md

@@ -0,0 +1,142 @@
+# Clients
+
+[MangoPay Users API Reference](https://docs.mangopay.com/endpoints/v2.01/clients)
+
+
+
+* * *
+
+### Clients.get(clientId, callback, options) 
+
+Get client by ID
+
+**Parameters**
+
+**clientId**: `string`, Client identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Clients.update(client, callback, options) 
+
+Update client
+
+**Parameters**
+
+**client**: , Client to be updated
+
+**callback**: , Callback function
+
+**options**: , Request options
+
+**Returns**: `*`, Promise of the request
+
+
+### Clients.uploadLogo(logo, callback, options) 
+
+Upload client logo
+
+**Parameters**
+
+**logo**: `string`, Logo
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Clients.uploadLogoFromFile(file, callback, options) 
+
+Upload client logo from file
+
+**Parameters**
+
+**file**: `string`, File path
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Clients.getClientWallets(callback, options) 
+
+Get all client wallets
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Clients.getClientWallet(fundsType, currency, callback, options) 
+
+Get a client wallet
+
+**Parameters**
+
+**fundsType**: , Wallet's funds type
+
+**currency**: , Currency of the wallet
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Clients.getClientWalletsByFundsType(fundsType, callback, options) 
+
+Get client wallets by the type of funds
+
+**Parameters**
+
+**fundsType**: , Wallets funds type
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Clients.getClientWalletTransactions(fundsType, currency, callback, options) 
+
+Get a client wallet's transactions
+
+**Parameters**
+
+**fundsType**: , Wallet's funds type
+
+**currency**: , Currency of the wallet
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+
+* * *
+
+
+
+
+
+
+
+
+
+