mangopay4-nodejs-sdk 1.64.0

package/docs/DisputeDocuments.md

@@ -0,0 +1,53 @@
+# DisputeDocuments
+
+[MangoPay Dispute Documents API Reference](https://docs.mangopay.com/endpoints/v2/dispute-documents#e214_the-dispute-document-object)
+
+
+
+* * *
+
+### DisputeDocuments.get(documentId, callback, options)
+
+Gets dispute's document
+
+**Parameters**
+
+**documentId**: `number`, Document identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### DisputeDocuments.getAll(callback, options)
+
+Gets dispute's documents for client
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### DisputeDocuments.createDisputeDocumentConsult(documentId, callback, options)
+
+Creates temporary URLs where each page of a dispute document can be viewed.
+
+**Parameters**
+
+**documentId**: `string`, Document identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/Disputes.md

@@ -0,0 +1,292 @@
+# Disputes
+
+[MangoPay Disputes API Reference](https://docs.mangopay.com/endpoints/v2.01/disputes#e176_the-dispute-object)
+
+
+
+* * *
+
+### Disputes.get(disputeId, callback, options)
+
+Get dispute
+
+**Parameters**
+
+**disputeId**: `number`, Dispute identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.getAll(callback, options)
+
+Get all disputes
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.update(dispute, callback, options)
+
+Update dispute's tag
+
+**Parameters**
+
+**dispute**: `Object`, Dispute object of properties hash
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.contestDispute(disputeId, contestedFunds, callback, options)
+
+Contest dispute
+
+**Parameters**
+
+**disputeId**: `number`, Dispute id
+
+**contestedFunds**: `Money`, Contested funds
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.resubmitDispute(disputeId, callback, options)
+
+This method is used to resubmit a Dispute if it is reopened requiring more docs
+
+**Parameters**
+
+**disputeId**: `number`, Dispute id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.closeDispute(disputeId, callback, options)
+
+Close dispute
+
+**Parameters**
+
+**disputeId**: `number`, Dispute id
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.getTransactions(disputeId, callback, options)
+
+Gets dispute's transactions
+
+**Parameters**
+
+**disputeId**: `number`, Dispute identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.getDisputesForWallet(walletId, callback, options)
+
+Gets dispute's documents for wallet
+
+**Parameters**
+
+**walletId**: `number`, Wallet identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.getDisputesForUser(userId, callback, options)
+
+Gets user's disputes
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.getRepudiation(repudiationId, callback, options)
+
+Gets repudiation
+
+**Parameters**
+
+**repudiationId**: `number`, Repudiation identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.createSettlementTransfer(settlementTransfer, repudiationId, callback, options)
+
+Creates settlement transfer
+
+**Parameters**
+
+**settlementTransfer**: `Object`, Settlement transfer
+
+**repudiationId**: `number`, Repudiation identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.getSettlementTransfer(settlementTransferId, callback, options)
+
+Gets settlement transfer
+
+**Parameters**
+
+**settlementTransferId**: `number`, Settlement Transfer identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.getDocumentsForDispute(disputeId, callback, options)
+
+Gets documents for dispute
+
+**Parameters**
+
+**disputeId**: `number`, Dispute identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Disputes.updateDisputeDocument(disputeId, disputeDocument, callback, options)
+
+Update dispute document
+
+**Parameters**
+
+**disputeId**: `number`, Dispute identifier
+
+**disputeDocument**: `Object`, Dispute document
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.createDisputeDocument(disputeId, disputeDocument, callback, options)
+
+Creates document for dispute
+
+**Parameters**
+
+**disputeId**: `number`, Dispute Id
+
+**disputeDocument**: `Object`, Dispute document
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.createDisputeDocumentPage(disputeId, disputeDocumentId, disputeDocumentPage, callback, options)
+
+Creates document's page for dispute
+
+**Parameters**
+
+**disputeId**: `number`, Dispute identifier
+
+**disputeDocumentId**: `number`, Dispute document identifier
+
+**disputeDocumentPage**: `Object`, Dispute document page
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.createDisputeDocumentPageFromFile(disputeId, disputeDocumentId, file, callback, options)
+
+Creates document's page for dispute from file
+
+**Parameters**
+
+**disputeId**: `number`, Dispute identifier
+
+**disputeDocumentId**: `number`, Dispute document identifier
+
+**file**: `string`, File path
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Disputes.getPendingSettlement(callback, options)
+
+Retrieve a list of Disputes pending settlement
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `object`, Request options
+
+**Returns**: `object`, Request promise
+
+
+
+* * *

package/docs/Events.md

@@ -0,0 +1,23 @@
+# Events
+
+[MangoPay Events API Reference](https://docs.mangopay.com/endpoints/v2.01/events#e251_the-event-object)
+
+
+
+* * *
+
+### Events.getAll(callback, options)
+
+Get events
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/Hooks.md

@@ -0,0 +1,68 @@
+# Hooks
+
+[MangoPay Hooks API Reference](https://docs.mangopay.com/endpoints/v2.01/hooks#e246_the-hook-object)
+
+
+
+* * *
+
+### Hooks.create(hook, callback, options)
+
+Create new hook
+
+**Parameters**
+
+**hook**: `Object`, Hook object
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Hooks.get(hookId, callback, options)
+
+Get hook
+
+**Parameters**
+
+**hookId**: `number`, Hook identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Hooks.update(hook, callback, options)
+
+Save hook
+
+**Parameters**
+
+**hook**: `Object`, Hook object
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Hooks.getAll(callback, options)
+
+Get all hooks
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/Idempotency.md

@@ -0,0 +1,11 @@
+* * *
+
+
+
+
+
+
+
+
+
+

package/docs/KycDocuments.md

@@ -0,0 +1,52 @@
+# KycDocuments
+
+[MangoPay KYC Documents API Reference](https://docs.mangopay.com/index.php/endpoints/v2.01/kyc-documents)
+
+
+* * *
+
+### KycDocuments.getAll(callback, options)
+
+Get all KycDocuments
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### KycDocuments.get(kycDocumentId, callback, options)
+
+Get KycDocument
+
+**Parameters**
+
+**kycDocumentId**: `number`, KycDocument identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### KycDocuments.createKycDocumentConsult(documentId, callback, options)
+
+Creates temporary URLs where each page of a KYC document can be viewed.
+
+**Parameters**
+
+**documentId**: `string`, Document identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *

package/docs/Mandates.md

@@ -0,0 +1,125 @@
+# Mandates
+
+[MangoPay Mandates API Reference](https://docs.mangopay.com/endpoints/v2.01/mandates)
+
+
+
+* * *
+
+### Mandates.create(mandate, callback, options) 
+
+Create a new Mandate
+
+**Parameters**
+
+**mandate**: `Object`, Mandate object
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Promise of the request
+
+
+### Mandates.getAll(callback, options) 
+
+Get all mandates
+
+**Parameters**
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Mandates.get(mandateId, callback, options) 
+
+Get mandate by ID
+
+**Parameters**
+
+**mandateId**: `number`, Mandate identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Mandates.cancel(mandateId, callback, options) 
+
+Cancel a mandate
+
+**Parameters**
+
+**mandateId**: `number`, Mandate identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Mandates.getMandatesForUser(userId, callback, options) 
+
+Gets user's mandates
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Mandates.getMandatesForBankAccount(userId, bankAccountId, callback, options) 
+
+Gets bank account mandates
+
+**Parameters**
+
+**userId**: `number`, User identifier
+
+**bankAccountId**: `number`, Bank Account identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+### Mandates.getTransactions(mandateId, callback, options) 
+
+Gets Transactions for a Mandate
+
+**Parameters**
+
+**mandateId**: `number`, Mandate identifier
+
+**callback**: `function`, Callback function
+
+**options**: `Object`, Request options
+
+**Returns**: `Object`, Request promise
+
+
+
+* * *
+
+
+
+
+
+
+
+
+
+

package/docs/OptionsHelper.md

@@ -0,0 +1,32 @@
+# Global
+
+
+
+
+
+* * *
+
+### withIdempotency(options, idempotencyKey) 
+
+Adds Idempotency-Key headers to the provided 'options' parameter
+
+**Parameters**
+
+**options**: , Adds Idempotency-Key headers to the provided 'options' parameter
+
+**idempotencyKey**: , Adds Idempotency-Key headers to the provided 'options' parameter
+
+
+
+
+* * *
+
+
+
+
+
+
+
+
+
+