Reports feature

docs/README.md

@@ -23,47 +23,50 @@
 |[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) |
-|[Hooks.create](Hooks.md) | Create new hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
+|[Mandates.create](Mandates.md) | Create a new Mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
 |[PayIns.create](PayIns.md) | Create new pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
-|[CardPreAuthorizations.create](CardPreAuthorizations.md) | Create new pre-authorization | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
+|[Hooks.create](Hooks.md) | Create new hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
+|[Users.create](Users.md) | Create a new user | [../lib/services/Users.js](../lib/services/Users.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) |
-|[CardRegistrations.create](CardRegistrations.md) | Create new card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
 |[Transfers.create](Transfers.md) | Create new transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
-|[Mandates.create](Mandates.md) | Create a new Mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
+|[CardRegistrations.create](CardRegistrations.md) | Create new card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
 |[PayOuts.create](PayOuts.md) | Create new pay-out | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
-|[Users.create](Users.md) | Create a new user | [../lib/services/Users.js](../lib/services/Users.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) |
 |[Disputes.createDisputeDocumentPageFromFile](Disputes.md) | Creates document's page for dispute from file | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
 |[Users.createKycDocument](Users.md) | Create new KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Users.createKycPage](Users.md) | Create page for KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Users.createKycPageFromFile](Users.md) | Create page for KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
-|[PayIns.createRefund](PayIns.md) | Create refund for pay-in object | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
 |[Transfers.createRefund](Transfers.md) | Create refund for transfer object | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
+|[PayIns.createRefund](PayIns.md) | Create refund for pay-in object | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
 |[Disputes.createSettlementTransfer](Disputes.md) | Creates settlement transfer | [../lib/services/Disputes.js](../lib/services/Disputes.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) |
+|[PayOuts.get](PayOuts.md) | Get payout | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
+|[Cards.get](Cards.md) | Get card | [../lib/services/Cards.js](../lib/services/Cards.js) |
 |[Hooks.get](Hooks.md) | Get hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
+|[Users.get](Users.md) | Get natural or legal user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Disputes.get](Disputes.md) | Get dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
-|[Responses.get](Responses.md) | Get response from previous call | [../lib/services/Responses.js](../lib/services/Responses.js) |
 |[Mandates.get](Mandates.md) | Get mandate by ID | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
-|[DisputeDocuments.get](DisputeDocuments.md) | Gets dispute's document | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
-|[Wallets.get](Wallets.md) | Get pay-in | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
-|[PayOuts.get](PayOuts.md) | Get payout | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
-|[Users.get](Users.md) | Get natural or legal user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
-|[Refunds.get](Refunds.md) | Get events | [../lib/services/Refunds.js](../lib/services/Refunds.js) |
 |[CardRegistrations.get](CardRegistrations.md) | Get registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
-|[Transfers.get](Transfers.md) | Get transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
-|[Cards.get](Cards.md) | Get card | [../lib/services/Cards.js](../lib/services/Cards.js) |
+|[PayIns.get](PayIns.md) | Get pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
 |[KycDocuments.get](KycDocuments.md) | Get KycDocument | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
-|[DisputeDocuments.getAll](DisputeDocuments.md) | Gets dispute's documents for client | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
-|[Disputes.getAll](Disputes.md) | Get all disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
+|[CardPreAuthorizations.get](CardPreAuthorizations.md) | Get pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
+|[Transfers.get](Transfers.md) | Get transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
+|[Responses.get](Responses.md) | Get response from previous call | [../lib/services/Responses.js](../lib/services/Responses.js) |
+|[Reports.get](Reports.md) | Get a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
+|[Refunds.get](Refunds.md) | Get events | [../lib/services/Refunds.js](../lib/services/Refunds.js) |
+|[Wallets.get](Wallets.md) | Get pay-in | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
+|[DisputeDocuments.get](DisputeDocuments.md) | Gets dispute's document | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
 |[KycDocuments.getAll](KycDocuments.md) | Get all KycDocuments | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
-|[Users.getAll](Users.md) | Get all users | [../lib/services/Users.js](../lib/services/Users.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) |
 |[Mandates.getAll](Mandates.md) | Get all mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
+|[Hooks.getAll](Hooks.md) | Get all hooks | [../lib/services/Hooks.js](../lib/services/Hooks.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) |
 |[Events.getAll](Events.md) | Get events | [../lib/services/Events.js](../lib/services/Events.js) |
+|[DisputeDocuments.getAll](DisputeDocuments.md) | Gets dispute's documents for client | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.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) |
@@ -79,15 +82,15 @@
 |[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) |
 |[Users.getTransactions](Users.md) | Get all transactions for user | [../lib/services/Users.js](../lib/services/Users.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.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) |
-|[CardRegistrations.update](CardRegistrations.md) | Update card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.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) |
 |[Hooks.update](Hooks.md) | Save hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
+|[Disputes.update](Disputes.md) | Update dispute's tag | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
+|[CardRegistrations.update](CardRegistrations.md) | Update card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
+|[Cards.update](Cards.md) | Update card | [../lib/services/Cards.js](../lib/services/Cards.js) |
 |[Users.update](Users.md) | Save user | [../lib/services/Users.js](../lib/services/Users.js) |
 |[Wallets.update](Wallets.md) | Update wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
 |[Disputes.updateDisputeDocument](Disputes.md) | Update dispute document | [../lib/services/Disputes.js](../lib/services/Disputes.js) |

docs/Reports.md

@@ -0,0 +1,63 @@
+# Reports
+
+[MangoPay Reports API Reference](https://docs.mangopay.com/endpoints/v2.01/reporting)
+
+
+
+* * *
+
+### Reports.create(report, callback, options) 
+
+Create a report
+
+**Parameters**
+
+**report**: `Object`, Report Data
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Reports.get(reportId, callback, options) 
+
+Get a report
+
+**Parameters**
+
+**reportId**: `number`, Report Id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Reports.getAll(callback, options) 
+
+Get all reports
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *
+
+
+
+
+
+
+
+
+
+

lib/services/Reports.js

@@ -7,7 +7,13 @@ var Service = require('../service');
 var Report = require('../models/Report');
 
 var Reports = Service.extend({
-
+    /**
+     * Create a report
+     * @param {Object}      report      Report Data
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
     create: function(report, callback, options) {
         options = this._api._getOptions(callback, options, {
             data: report,
@@ -17,6 +23,13 @@ var Reports = Service.extend({
         return this._api.method('reports_create', callback, options);
     },
 
+    /**
+     * Get a report
+     * @param {number}      reportId    Report Id
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
     get: function(reportId, callback, options) {
         options = this._api._getOptions(callback, options, {
             path: {
@@ -28,6 +41,12 @@ var Reports = Service.extend({
         return this._api.method('reports_get', callback, options);
     },
 
+    /**
+     * Get all reports
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
     getAll: function(callback, options) {
         return this._api.method('reports_all', callback, options);
     }

test/services/Reports.js

@@ -4,7 +4,7 @@ var helpers = require('../helpers');
 describe('Reports', function() {
     var report;
 
-    before(function (done) {
+    before(function(done) {
         report = {
             ReportType: "TRANSACTION"
         };
@@ -13,14 +13,11 @@ describe('Reports', function() {
         });
     });
 
-
-    describe('Create', function () {
-        it('should exist', function () {
-            expect(report.Id).to.exist;
-        });
+    it('should exist after creting it', function () {
+        expect(report.Id).to.exist;
     });
 
-    describe('Get', function () {
+    describe('Getting created report', function () {
         var getReport;
 
         before(function(done){
@@ -35,6 +32,4 @@ describe('Reports', function() {
             expect(report.CreationDate).to.equal(getReport.CreationDate);
         });
     });
-
-
 });