mangopay4-nodejs-sdk 1.64.0

package/docs/Users.md

@@ -0,0 +1,322 @@
+# Users
+
+[MangoPay Users API Reference](https://docs.mangopay.com/endpoints/v2.01/users)
+
+
+
+* * *
+
+### Users.create(user)
+
+Create a new user
+
+**Parameters**
+
+**user**: `Object`, Can be a UserNatural, UserLegal or a hash of user properties.
+
+**Returns**: `Object`, Promise of the request
+
+
+### Users.getAll()
+
+Get all users
+
+**Returns**: `Object`, Request promise
+
+
+### Users.get(userId, callback, options)
+
+Get natural or legal user by ID
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getNatural(userId, callback, options)
+
+Get natural user by ID
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Callback function              Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getLegal(userId, callback, options)
+
+Get legal user by ID
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Callback function              Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Users.update(user, callback, options)
+
+Save user
+
+**Parameters**
+
+**user**: `Object`, User object to be saved
+
+**callback**: `function`, Save user
+
+**options**: `Object`, Save user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.createBankAccount(userId, bankAccount, callback, options)
+
+Create bank account for user
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**bankAccount**: `Object`, Bank account object
+
+**callback**: `function`, Create bank account for user
+
+**options**: `Object`, Create bank account for user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.deactivateBankAccount(userId, bankAccountId, callback, options)
+
+Deactivate a bank account
+
+**Parameters**
+
+**userId**: , Deactivate a bank account
+
+**bankAccountId**: , Deactivate a bank account
+
+**callback**: , Deactivate a bank account
+
+**options**: , Deactivate a bank account
+
+**Returns**: `*`
+
+
+### Users.getBankAccounts(userId, callback, options)
+
+Get all bank accounts for user
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Get all bank accounts for user
+
+**options**: `Object`, Get all bank accounts for user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getBankAccount(userId, bankAccountId, callback, options)
+
+Get all bank accounts for user
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**bankAccountId**: `number`, Bank account id
+
+**callback**: `function`, Get all bank accounts for user
+
+**options**: `Object`, Get all bank accounts for user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getWallets(userId, callback, options)
+
+Get all wallets accounts for user
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Get all wallets accounts for user
+
+**options**: `Object`, Get all wallets accounts for user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getTransactions(userId, callback, options)
+
+Get all transactions for user
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Get all transactions for user
+
+**options**: `Object`, Get all transactions for user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getCards(userId, callback, options)
+
+Get all cards for user
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Get all cards for user
+
+**options**: `Object`, Get all cards for user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.createKycDocument(userId, kycDocument, callback, options)
+
+Create new KYC document
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**kycDocument**: `Object`, Create new KYC document
+
+**callback**: `function`, Create new KYC document
+
+**options**: `Object`, Create new KYC document
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getKycDocuments(userId, callback, options)
+
+Get all KYC documents for user
+
+**Parameters**
+
+**userId**: `number`, Get all KYC documents for user
+
+**callback**: `function`, Get all KYC documents for user
+
+**options**: `object`, Get all KYC documents for user
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getKycDocument(userId, kycDocumentId, callback, options)
+
+Get KYC document
+
+**Parameters**
+
+**userId**: `number`, Get KYC document
+
+**kycDocumentId**: `number`, Get KYC document
+
+**callback**: `function`, Get KYC document
+
+**options**: `object`, Get KYC document
+
+**Returns**: `Object`, Request promise
+
+
+### Users.updateKycDocument(userId, kycDocument, callback, options)
+
+Save KYC document
+
+**Parameters**
+
+**userId**: `number`, Save KYC document
+
+**kycDocument**: `Object`, Save KYC document
+
+**callback**: `function`, Save KYC document
+
+**options**: `object`, Save KYC document
+
+**Returns**: `Object`, Request promise
+
+
+### Users.createKycPage(userId, kycDocumentId, kycPage, callback, options)
+
+Create page for KYC document
+
+**Parameters**
+
+**userId**: `number`, Create page for KYC document
+
+**kycDocumentId**: `number`, Create page for KYC document
+
+**kycPage**: `Object`, Create page for KYC document
+
+**callback**: `function`, Create page for KYC document
+
+**options**: `Object`, Create page for KYC document
+
+**Returns**: `Object`, Request promise
+
+
+### Users.createKycPageFromFile(userId, kycDocumentId, file, callback, options)
+
+Create page for KYC document
+
+**Parameters**
+
+**userId**: `number`, Create page for KYC document
+
+**kycDocumentId**: `number`, Create page for KYC document
+
+**file**: `string`, File path
+
+**callback**: `function`, Create page for KYC document
+
+**options**: `Object`, Create page for KYC document
+
+**Returns**: `Object`, Request promise
+
+
+### Users.getEMoney(userId, year, month, callback, options)
+
+Get users's EMoney
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**year**: `year`, The year for which we want to get the emoney
+
+**month**: `month`, The month for which we want to get the emoney. Can be null
+
+**callback**: `function`, Get users's EMoney
+
+**options**: `Object`, Get users's EMoney
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/Wallets.md

@@ -0,0 +1,70 @@
+# Wallets
+
+[MangoPay Wallets API Reference](https://docs.mangopay.com/endpoints/v2.01/wallets)
+
+
+
+* * *
+
+### Wallets.create(wallet, callback, options)
+
+Create new wallet
+
+**Parameters**
+
+**wallet**: `Object`, Wallet object
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Wallets.get(walletId, callback, options)
+
+Get pay-in
+
+**Parameters**
+
+**walletId**: `number`, Wallet identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Wallets.update(wallet, callback, options)
+
+Update wallet
+
+**Parameters**
+
+**wallet**: `Object`, Wallet object
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Wallets.getTransactions(walletId, callback, options)
+
+Get transactions for the wallet
+
+**Parameters**
+
+**walletId**: `number`, Wallet identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/templates/class.mustache

@@ -0,0 +1,11 @@
+{{#name}}
+## Class: {{name}}
+{{/name}}
+{{#description}}{{{description}}}{{/description}}
+
+{{#members}}
+**{{name}}**: {{#typesString}}`{{typesString}}`{{/typesString}} {{#description}}, {{{description}}}{{/description}}
+{{/members}}
+{{#methods}}
+{{> function}}
+{{/methods}}

package/docs/templates/file.mustache

@@ -0,0 +1,53 @@
+{{#modules}}
+{{#name}}
+# {{name}}
+{{/name}}
+
+{{#description}}{{{description}}}{{/description}}
+
+{{#hasRequires}}
+**Requires:**
+
+{{#requires}}
++ {{{req}}}
+{{/requires}}
+{{/hasRequires}}
+
+{{#hasMembers}}
+**Members:**
+
+{{#members}}
++ {{{member}}}
+{{/members}}
+{{/hasMembers}}
+
+{{#examples}}
+**Example:**
+```js
+{{{examples}}}
+```
+
+{{/examples}}
+* * *
+
+{{#functions}}
+{{> function}}
+
+{{/functions}}
+{{#classes}}
+{{> class}}
+
+{{/classes}}
+
+{{/modules}}
+* * *
+
+{{#copyright}}*{{copyright}}*{{/copyright}}
+
+{{#author}}**Author:** {{author}}{{/author}}
+
+{{#license}}**License:** {{license}} {{/license}}
+
+{{#overview}}**Overview:** {{{overview}}}{{/overview}}
+
+{{#version}}**Version:** {{version}}{{/version}}

package/docs/templates/function.mustache

@@ -0,0 +1,33 @@
+### {{#moduleName}}{{moduleName}}.{{/moduleName}}{{#className}}{{className}}.{{/className}}{{name}}({{#paramsString}}{{paramsString}}{{/paramsString}}) {{#version}}{{version}}{{/version}}
+
+{{#description}}
+{{{description}}}
+
+{{/description}}
+{{#deprecated}}
+Deprecated: {{{deprecated}}}
+
+{{/deprecated}}
+{{#hasParams}}
+**Parameters**
+
+{{/hasParams}}
+{{#params}}
+**{{name}}**: {{#typesString}}`{{typesString}}`{{/typesString}}{{#description}}, {{{description}}}{{/description}}
+
+{{/params}}
+{{#fires}}
+**Fires**: {{.}}
+
+{{/fires}}
+{{#returns}}
+**Returns**: {{#typesString}}`{{typesString}}`{{/typesString}}{{#description}}, {{{description}}}{{/description}}
+{{/returns}}
+
+{{#examples}}
+**Example**:
+```js
+{{{examples}}}
+```
+
+{{/examples}}

package/docs/templates/index.mustache

@@ -0,0 +1,26 @@
+# MangoPay Node.js SDK Documentation
+
+## Services
+* [CardPreAuthorizations](CardPreAuthorizations.md)
+* [CardRegistrations](CardRegistrations.md)
+* [Cards](Cards.md)
+* [DisputeDocuments](DisputeDocuments.md)
+* [Disputes](Disputes.md)
+* [Events](Events.md)
+* [Hooks](Hooks.md)
+* [KycDocuments](KycDocuments.md)
+* [PayIns](PayIns.md)
+* [PayOuts](PayOuts.md)
+* [Refunds](Refunds.md)
+* [Responses](Responses.md)
+* [Transfers](Transfers.md)
+* [Users](Users.md)
+* [Wallets](Wallets.md)
+
+## All available functions
+| Function | Description | Source Code |
+| -------- | ----------- | ----------- |
+{{#functions}}
+    {{> function}}
+
+{{/functions}}

package/docs/templates/overview.mustache

@@ -0,0 +1 @@
+|[{{moduleName}}.{{name}}]({{{file}}}) | {{description}} | [{{sourcePath}}]({{{sourcePath}}}) |

package/examples/createUsers.js

@@ -0,0 +1,112 @@
+/**
+ *
+ * Creating users using Mangopay SDK Models and hash of properties
+ *
+ */
+
+
+// In your app you will require('mangopay4-nodejs-sdk')
+var mangopay = require('../index');
+
+// In your app you will define your own set of configurations.
+// Check README.md for the full list
+var api = new mangopay({
+    clientId: 'sdk-unit-tests',
+    clientApiKey: 'cqFfFrWfCcb7UadHNxx2C9Lo6Djw8ZduLi7J9USTmu8bhxxpju'
+});
+
+/**
+ *
+ * Create a new user using Mangopay SDK Model
+ * Promise style handling of the response
+ *
+ */
+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 (myReturnedUser) {
+    // Output the created user data to console
+    console.log(myUser.Name + ' legal user created at ' + myReturnedUser.CreationDate);
+});
+
+/**
+ *
+ * Create a user using a hash of properties. Res
+ * Don't forget to define PersonType
+ * This example uses callback pattern approach
+ *
+ */
+api.Users.create({
+    Name: 'MangoPay',
+    Email: 'info@mangopay.com',
+    LegalPersonType: 'BUSINESS',
+    LegalRepresentativeFirstName: 'Mango',
+    LegalRepresentativeLastName: 'Pay',
+    LegalRepresentativeEmail: 'mango@mangopay.com',
+    PersonType: "LEGAL",
+    HeadquartersAddress: {
+        "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'
+}, function (myOtherUser) {
+    // Output the created user data to console
+    console.log(myOtherUser.Name + ' user created at ' + myOtherUser.CreationDate);
+});
+
+/**
+ *
+ * Create a new natural user with only required values
+ * Promise style handling of the response
+ *
+ */
+api.Users.create({
+    PersonType: "NATURAL",
+    FirstName: "John",
+    LastName: "Smith",
+    Birthday: 1300186358,
+    Nationality: "FR",
+    CountryOfResidence: "GB",
+    Email: "john@smith.eu",
+}).then(function (response) {
+    console.log("Natural user created", response);
+});
+
+/**
+ *
+ * Fail at creating a new natural user, error caught
+ * Promise style handling of the response
+ *
+ */
+api.Users.create({
+    PersonType: "NATURAL",
+}).catch(function (error) {
+    console.log("Natural user creation failed", error);
+});

package/examples/createWallet.js

@@ -0,0 +1,28 @@
+// In your app you will require('mangopay4-nodejs-sdk')
+var mangopay = require('../index');
+
+// In your app you will define your own set of configurations.
+// Check README.md for the full list
+var api = new mangopay({
+    clientId: 'sdk-unit-tests',
+    clientApiKey: 'cqFfFrWfCcb7UadHNxx2C9Lo6Djw8ZduLi7J9USTmu8bhxxpju'
+});
+
+api.Users.create({
+    PersonType: "NATURAL",
+    FirstName: "John",
+    LastName: "Smith",
+    Birthday: 1300186358,
+    Nationality: "FR",
+    CountryOfResidence: "GB",
+    Email: "john@smith.eu",
+}).then(function (user) {
+    api.Wallets.create({
+        Owners: [ user.Id ],
+        Description: "create wallet - demo",
+        Currency: "EUR",
+    })
+        .then(function (res) {
+            console.log("Wallet successfully created ", res)
+        });
+});

package/examples/failedRequest.js

@@ -0,0 +1,20 @@
+/**
+ * Examples of trying to read invalid data.
+ */
+var mangopay = require('../index');
+
+var api = new mangopay({
+    clientId: 'sdk-unit-tests',
+    clientApiKey: 'cqFfFrWfCcb7UadHNxx2C9Lo6Djw8ZduLi7J9USTmu8bhxxpju'
+});
+
+/**
+ * Try to request invalid user
+ */
+var INVALID_UID = '11510910021zx';
+
+api.Users.getNatural(INVALID_UID)
+    .catch(function(data) {
+        // Catch the failure
+        console.error(data.Message);
+    });

package/examples/getBankAccounts.js

@@ -0,0 +1,29 @@
+/**
+ * Examples of reading users data
+ */
+ var mangopay = require('../index');
+
+ var api = new mangopay({
+     clientId: 'sdk-unit-tests',
+     clientApiKey: 'cqFfFrWfCcb7UadHNxx2C9Lo6Djw8ZduLi7J9USTmu8bhxxpju'
+ });
+ 
+ api.Users.getBankAccounts(108379078, {
+     parameters: {
+         per_page: 100,
+         page: 1,
+         active: false
+     }
+ }).then(function(data){
+     console.log("Should be zero: " + data.length);
+ });
+ 
+ api.Users.getBankAccounts(108379078, {
+     parameters: {
+         per_page: 100,
+         page: 1,
+         active: true
+     }
+ }).then(function(data){
+     console.log("Should be more than one: " + data.length);
+ });