Adapt DirectDebitPaying Model - update docs

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
+
+
+
+* * *
+
+
+
+
+
+
+
+
+
+

docs/README.md

@@ -23,16 +23,16 @@
 |[Mandates.cancel](Mandates.md) | Cancel a mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
 |[Disputes.closeDispute](Disputes.md) | Close dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Disputes.contestDispute](Disputes.md) | Contest dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
-|[PayOuts.create](PayOuts.md) | Create new pay-out | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
-|[CardRegistrations.create](CardRegistrations.md) | Create new card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
-|[CardPreAuthorizations.create](CardPreAuthorizations.md) | Create new pre-authorization | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
+|[PayIns.create](PayIns.md) | Create new pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
 |[Mandates.create](Mandates.md) | Create a new Mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
+|[Reports.create](Reports.md) | Create a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
 |[Wallets.create](Wallets.md) | Create new wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
 |[Users.create](Users.md) | Create a new user | [../lib/services/Users.js](../lib/services/Users.js) |
-|[PayIns.create](PayIns.md) | Create new pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
-|[Transfers.create](Transfers.md) | Create new transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
+|[PayOuts.create](PayOuts.md) | Create new pay-out | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
+|[CardRegistrations.create](CardRegistrations.md) | Create new card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
 |[Hooks.create](Hooks.md) | Create new hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
-|[Reports.create](Reports.md) | Create a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
+|[Transfers.create](Transfers.md) | Create new transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
+|[CardPreAuthorizations.create](CardPreAuthorizations.md) | Create new pre-authorization | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
 |[Users.createBankAccount](Users.md) | Create bank account for user | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Disputes.createDisputeDocument](Disputes.md) | Creates document for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Disputes.createDisputeDocumentPage](Disputes.md) | Creates document's page for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
@@ -44,33 +44,38 @@
 |[Transfers.createRefund](Transfers.md) | Create refund for transfer object | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
 |[Disputes.createSettlementTransfer](Disputes.md) | Creates settlement transfer | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Users.deactivateBankAccount](Users.md) | Deactivate a bank account | [../lib/services/Users.js](../lib/services/Users.js) |
-|[Mandates.get](Mandates.md) | Get mandate by ID | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
 |[Cards.get](Cards.md) | Get card | [../lib/services/Cards.js](../lib/services/Cards.js) |
-|[Refunds.get](Refunds.md) | Get events | [../lib/services/Refunds.js](../lib/services/Refunds.js) |
+|[Transfers.get](Transfers.md) | Get transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
+|[Mandates.get](Mandates.md) | Get mandate by ID | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
+|[Reports.get](Reports.md) | Get a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
 |[Responses.get](Responses.md) | Get response from previous call | [../lib/services/Responses.js](../lib/services/Responses.js) |
 |[PayOuts.get](PayOuts.md) | Get payout | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
-|[CardRegistrations.get](CardRegistrations.md) | Get registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
-|[Disputes.get](Disputes.md) | Get dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Users.get](Users.md) | Get natural or legal user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
-|[PayIns.get](PayIns.md) | Get pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
-|[CardPreAuthorizations.get](CardPreAuthorizations.md) | Get pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
-|[KycDocuments.get](KycDocuments.md) | Get KycDocument | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
+|[Refunds.get](Refunds.md) | Get events | [../lib/services/Refunds.js](../lib/services/Refunds.js) |
+|[Disputes.get](Disputes.md) | Get dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
+|[CardRegistrations.get](CardRegistrations.md) | Get registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
 |[Wallets.get](Wallets.md) | Get pay-in | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
+|[KycDocuments.get](KycDocuments.md) | Get KycDocument | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
+|[Clients.get](Clients.md) | Get client by ID | [../lib/services/Clients.js](../lib/services/Clients.js) |
+|[CardPreAuthorizations.get](CardPreAuthorizations.md) | Get pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
+|[PayIns.get](PayIns.md) | Get pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
 |[DisputeDocuments.get](DisputeDocuments.md) | Gets dispute's document | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
-|[Reports.get](Reports.md) | Get a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
 |[Hooks.get](Hooks.md) | Get hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
-|[Transfers.get](Transfers.md) | Get transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
-|[Hooks.getAll](Hooks.md) | Get all hooks | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
+|[Disputes.getAll](Disputes.md) | Get all disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
+|[Users.getAll](Users.md) | Get all users | [../lib/services/Users.js](../lib/services/Users.js) |
+|[Mandates.getAll](Mandates.md) | Get all mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
+|[KycDocuments.getAll](KycDocuments.md) | Get all KycDocuments | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
 |[Events.getAll](Events.md) | Get events | [../lib/services/Events.js](../lib/services/Events.js) |
+|[Hooks.getAll](Hooks.md) | Get all hooks | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
 |[DisputeDocuments.getAll](DisputeDocuments.md) | Gets dispute's documents for client | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
-|[Mandates.getAll](Mandates.md) | Get all mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
-|[Users.getAll](Users.md) | Get all users | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Reports.getAll](Reports.md) | Get all reports | [../lib/services/Reports.js](../lib/services/Reports.js) |
-|[KycDocuments.getAll](KycDocuments.md) | Get all KycDocuments | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
-|[Disputes.getAll](Disputes.md) | Get all disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Users.getBankAccount](Users.md) | Get all bank accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Users.getBankAccounts](Users.md) | Get all bank accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Users.getCards](Users.md) | Get all cards for user | [../lib/services/Users.js](../lib/services/Users.js) |
+|[Clients.getClientWallet](Clients.md) | Get a client wallet | [../lib/services/Clients.js](../lib/services/Clients.js) |
+|[Clients.getClientWalletTransactions](Clients.md) | Get a client wallet's transactions | [../lib/services/Clients.js](../lib/services/Clients.js) |
+|[Clients.getClientWallets](Clients.md) | Get all client wallets | [../lib/services/Clients.js](../lib/services/Clients.js) |
+|[Clients.getClientWalletsByFundsType](Clients.md) | Get client wallets by the type of funds | [../lib/services/Clients.js](../lib/services/Clients.js) |
 |[Disputes.getDisputesForUser](Disputes.md) | Gets user's disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Disputes.getDisputesForWallet](Disputes.md) | Gets dispute's documents for wallet | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Disputes.getDocumentsForDispute](Disputes.md) | Gets documents for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
@@ -82,17 +87,20 @@
 |[Users.getNatural](Users.md) | Get natural user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Disputes.getRepudiation](Disputes.md) | Gets repudiation | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Disputes.getSettlementTransfer](Disputes.md) | Gets settlement transfer | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
-|[Wallets.getTransactions](Wallets.md) | Get transactions for the wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
 |[Disputes.getTransactions](Disputes.md) | Gets dispute's transactions | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
+|[Wallets.getTransactions](Wallets.md) | Get transactions for the wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
 |[Users.getTransactions](Users.md) | Get all transactions for user | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Users.getWallets](Users.md) | Get all wallets accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Disputes.resubmitDispute](Disputes.md) | This method is used to resubmit a Dispute if it is reopened requiring more docs | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
-|[Disputes.update](Disputes.md) | Update dispute's tag | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
-|[CardPreAuthorizations.update](CardPreAuthorizations.md) | Update pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
-|[Cards.update](Cards.md) | Update card | [../lib/services/Cards.js](../lib/services/Cards.js) |
+|[CardRegistrations.update](CardRegistrations.md) | Update card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
+|[Clients.update](Clients.md) | Update client | [../lib/services/Clients.js](../lib/services/Clients.js) |
 |[Users.update](Users.md) | Save user | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Hooks.update](Hooks.md) | Save hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
 |[Wallets.update](Wallets.md) | Update wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
-|[CardRegistrations.update](CardRegistrations.md) | Update card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
+|[CardPreAuthorizations.update](CardPreAuthorizations.md) | Update pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
+|[Cards.update](Cards.md) | Update card | [../lib/services/Cards.js](../lib/services/Cards.js) |
+|[Disputes.update](Disputes.md) | Update dispute's tag | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Disputes.updateDisputeDocument](Disputes.md) | Update dispute document | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Users.updateKycDocument](Users.md) | Save KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
+|[Clients.uploadLogo](Clients.md) | Upload client logo | [../lib/services/Clients.js](../lib/services/Clients.js) |
+|[Clients.uploadLogoFromFile](Clients.md) | Upload client logo from file | [../lib/services/Clients.js](../lib/services/Clients.js) |