com.mangopay.core.APIs.implementation

Class DisputeApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.DisputeApiImpl

All Implemented Interfaces:

DisputeApi

public class DisputeApiImpl
extends ApiBase
implements DisputeApi

API for disputes.

Field Summary

Fields inherited from class com.mangopay.core.APIs.ApiBase

root

Constructor Summary

Constructors

Constructor and Description
DisputeApiImpl(MangoPayApi root) Instantiates new DisputeApiImpl object.

Method Summary

Modifier and Type	Method and Description
Dispute	closeDispute(java.lang.String disputeId) Closes dispute.
Dispute	contestDispute(Money contestedFunds, java.lang.String disputeId) Contests dispute.
DisputeDocument	createDisputeDocument(DisputeDocument disputeDocument, java.lang.String disputeId) Creates document for dispute.
DisputeDocument	createDisputeDocument(java.lang.String idempotencyKey, DisputeDocument disputeDocument, java.lang.String disputeId) Creates document for dispute.
java.util.List<DocumentPageConsult>	createDisputeDocumentConsult(java.lang.String documentId) Creates temporary URLs where each page of a dispute document can be viewed.
void	createDisputePage(java.lang.String disputeId, java.lang.String documentId, byte[] binaryData) Creates document's page for dispute.
void	createDisputePage(java.lang.String disputeId, java.lang.String documentId, java.lang.String filePath) Creates document's page for dispute.
void	createDisputePage(java.lang.String idempotencyKey, java.lang.String disputeId, java.lang.String documentId, byte[] binaryData) Creates document's page for dispute.
void	createDisputePage(java.lang.String idempotencyKey, java.lang.String disputeId, java.lang.String documentId, java.lang.String filePath) Creates document's page for dispute.
Transfer	createSettlementTransfer(SettlementTransfer settlementTransfer, java.lang.String repudiationId) Creates settlement transfer.
Transfer	createSettlementTransfer(java.lang.String idempotencyKey, SettlementTransfer settlementTransfer, java.lang.String repudiationId) Creates settlement transfer.
Dispute	get(java.lang.String disputeId) Gets dispute.
java.util.List<Dispute>	getAll() Gets all disputes.
java.util.List<Dispute>	getAll(Pagination pagination, FilterDisputes filters, Sorting sorting) Gets all disputes.
java.util.List<Dispute>	getDisputesForUser(java.lang.String userId, Pagination pagination, FilterDisputes filters, Sorting sorting) Gets user's disputes.
java.util.List<Dispute>	getDisputesForWallet(java.lang.String walletId, Pagination pagination, FilterDisputes filters, Sorting sorting) Gets dispute's documents for wallet.
java.util.List<Dispute>	getDisputesWithPendingSettlement() Get disputes that need settling
java.util.List<Dispute>	getDisputesWithPendingSettlement(Pagination pagination, Sorting sorting) Get disputes that need settling
DisputeDocument	getDocument(java.lang.String documentId) Gets dispute's document.
java.util.List<DisputeDocument>	getDocumentsForClient(Pagination pagination, FilterDisputeDocuments filters, Sorting sorting) Gets dispute's documents for client.
java.util.List<DisputeDocument>	getDocumentsForDispute(java.lang.String disputeId, Pagination pagination, FilterDisputeDocuments filters, Sorting sorting) Gets documents for dispute.
Repudiation	getRepudiation(java.lang.String repudiationId) Gets repudiation.
java.util.List<Transaction>	getTransactions(java.lang.String disputeId, Pagination pagination, FilterTransactions filters, Sorting sorting) Gets dispute's transactions.
Dispute	resubmitDispute(java.lang.String disputeId) Resubmits dispute.
DisputeDocument	submitDisputeDocument(DisputeDocument disputeDocument, java.lang.String disputeId) Submits dispute document.
Dispute	updateTag(java.lang.String tag, java.lang.String disputeId) Updates dispute's tag.

Methods inherited from class com.mangopay.core.APIs.ApiBase

createObject, createObject, createObject, getList, getList, getList, getList, getList, getList, getListNoClientId, getObject, getObjectNoClientId, getRequestType, getRequestUrl, getRoot, updateObject, updateObject, updateObject, updateObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisputeApiImpl

public DisputeApiImpl(MangoPayApi root)

Instantiates new DisputeApiImpl object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance.

Method Detail

get

public Dispute get(java.lang.String disputeId)
            throws java.lang.Exception

Description copied from interface: DisputeApi

Gets dispute.

Specified by:

get in interface DisputeApi

Parameters:

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

getAll

public java.util.List<Dispute> getAll(Pagination pagination,
                                      FilterDisputes filters,
                                      Sorting sorting)
                               throws java.lang.Exception

Description copied from interface: DisputeApi

Gets all disputes.

Specified by:

getAll in interface DisputeApi

Parameters:

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of Dispute instances returned from API.

Throws:

java.lang.Exception

getAll

public java.util.List<Dispute> getAll()
                               throws java.lang.Exception

Description copied from interface: DisputeApi

Gets all disputes.

Specified by:

getAll in interface DisputeApi

Returns:

List of Dispute instances returned from API.

Throws:

java.lang.Exception

getTransactions

public java.util.List<Transaction> getTransactions(java.lang.String disputeId,
                                                   Pagination pagination,
                                                   FilterTransactions filters,
                                                   Sorting sorting)
                                            throws java.lang.Exception

Description copied from interface: DisputeApi

Gets dispute's transactions.

Specified by:

getTransactions in interface DisputeApi

Parameters:

disputeId - Dispute identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of Transaction instances returned from API.

Throws:

java.lang.Exception

getDisputesForWallet

public java.util.List<Dispute> getDisputesForWallet(java.lang.String walletId,
                                                    Pagination pagination,
                                                    FilterDisputes filters,
                                                    Sorting sorting)
                                             throws java.lang.Exception

Description copied from interface: DisputeApi

Gets dispute's documents for wallet.

Specified by:

getDisputesForWallet in interface DisputeApi

Parameters:

walletId - Wallet identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of dispute instances returned from API.

Throws:

java.lang.Exception

getDisputesForUser

public java.util.List<Dispute> getDisputesForUser(java.lang.String userId,
                                                  Pagination pagination,
                                                  FilterDisputes filters,
                                                  Sorting sorting)
                                           throws java.lang.Exception

Description copied from interface: DisputeApi

Gets user's disputes.

Specified by:

getDisputesForUser in interface DisputeApi

Parameters:

userId - User identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of Dispute instances returned from API.

Throws:

java.lang.Exception

getDocument

public DisputeDocument getDocument(java.lang.String documentId)
                            throws java.lang.Exception

Description copied from interface: DisputeApi

Gets dispute's document.

Specified by:

getDocument in interface DisputeApi

Parameters:

documentId - Dispute document identifier.

Returns:

Dispute's document instance returned from API.

Throws:

java.lang.Exception

getDocumentsForDispute

public java.util.List<DisputeDocument> getDocumentsForDispute(java.lang.String disputeId,
                                                              Pagination pagination,
                                                              FilterDisputeDocuments filters,
                                                              Sorting sorting)
                                                       throws java.lang.Exception

Description copied from interface: DisputeApi

Gets documents for dispute.

Specified by:

getDocumentsForDispute in interface DisputeApi

Parameters:

disputeId - Dispute identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of DisputeDocument instances returned from API.

Throws:

java.lang.Exception

getDocumentsForClient

public java.util.List<DisputeDocument> getDocumentsForClient(Pagination pagination,
                                                             FilterDisputeDocuments filters,
                                                             Sorting sorting)
                                                      throws java.lang.Exception

Description copied from interface: DisputeApi

Gets dispute's documents for client.

Specified by:

getDocumentsForClient in interface DisputeApi

Parameters:

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of dispute documents returned from API.

Throws:

java.lang.Exception

getRepudiation

public Repudiation getRepudiation(java.lang.String repudiationId)
                           throws java.lang.Exception

Description copied from interface: DisputeApi

Gets repudiation.

Specified by:

getRepudiation in interface DisputeApi

Parameters:

repudiationId - Repudiation identifier.

Returns:

Repudiation instance returned from API.

Throws:

java.lang.Exception

createSettlementTransfer

public Transfer createSettlementTransfer(SettlementTransfer settlementTransfer,
                                         java.lang.String repudiationId)
                                  throws java.lang.Exception

Description copied from interface: DisputeApi

Creates settlement transfer.

Specified by:

createSettlementTransfer in interface DisputeApi

Parameters:

settlementTransfer - Settlement transfer.

repudiationId - Repudiation identifier.

Returns:

Transfer instance returned from API.

Throws:

java.lang.Exception

createSettlementTransfer

public Transfer createSettlementTransfer(java.lang.String idempotencyKey,
                                         SettlementTransfer settlementTransfer,
                                         java.lang.String repudiationId)
                                  throws java.lang.Exception

Description copied from interface: DisputeApi

Creates settlement transfer.

Specified by:

createSettlementTransfer in interface DisputeApi

Parameters:

idempotencyKey - idempotency key for this request.

settlementTransfer - Settlement transfer.

repudiationId - Repudiation identifier.

Returns:

Transfer instance returned from API.

Throws:

java.lang.Exception

getDisputesWithPendingSettlement

public java.util.List<Dispute> getDisputesWithPendingSettlement()
                                                         throws java.lang.Exception

Description copied from interface: DisputeApi

Get disputes that need settling

Specified by:

getDisputesWithPendingSettlement in interface DisputeApi

Returns:

a list of Disputes

Throws:

java.lang.Exception

getDisputesWithPendingSettlement

public java.util.List<Dispute> getDisputesWithPendingSettlement(Pagination pagination,
                                                                Sorting sorting)
                                                         throws java.lang.Exception

Description copied from interface: DisputeApi

Get disputes that need settling

Specified by:

getDisputesWithPendingSettlement in interface DisputeApi

Parameters:

pagination - Pagination object

sorting - Sorting object

Returns:

a list of Disputes

Throws:

java.lang.Exception

updateTag

public Dispute updateTag(java.lang.String tag,
                         java.lang.String disputeId)
                  throws java.lang.Exception

Description copied from interface: DisputeApi

Updates dispute's tag.

Specified by:

updateTag in interface DisputeApi

Parameters:

tag - New tag text.

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

submitDisputeDocument

public DisputeDocument submitDisputeDocument(DisputeDocument disputeDocument,
                                             java.lang.String disputeId)
                                      throws java.lang.Exception

Description copied from interface: DisputeApi

Submits dispute document.

Specified by:

submitDisputeDocument in interface DisputeApi

Parameters:

disputeDocument - Dispute document to be submitted.

disputeId - Dispute identifier.

Returns:

Dispute document instance returned from API.

Throws:

java.lang.Exception

contestDispute

public Dispute contestDispute(Money contestedFunds,
                              java.lang.String disputeId)
                       throws java.lang.Exception

Description copied from interface: DisputeApi

Contests dispute.

Specified by:

contestDispute in interface DisputeApi

Parameters:

contestedFunds - Contested funds.

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

resubmitDispute

public Dispute resubmitDispute(java.lang.String disputeId)
                        throws java.lang.Exception

Description copied from interface: DisputeApi

Resubmits dispute.

Specified by:

resubmitDispute in interface DisputeApi

Parameters:

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

closeDispute

public Dispute closeDispute(java.lang.String disputeId)
                     throws java.lang.Exception

Description copied from interface: DisputeApi

Closes dispute.

Specified by:

closeDispute in interface DisputeApi

Parameters:

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

createDisputeDocument

public DisputeDocument createDisputeDocument(DisputeDocument disputeDocument,
                                             java.lang.String disputeId)
                                      throws java.lang.Exception

Description copied from interface: DisputeApi

Creates document for dispute.

Specified by:

createDisputeDocument in interface DisputeApi

Parameters:

disputeDocument - Dispute document to be created.

disputeId - Dispute identifier.

Returns:

Dispute document returned from API.

Throws:

java.lang.Exception

createDisputeDocument

public DisputeDocument createDisputeDocument(java.lang.String idempotencyKey,
                                             DisputeDocument disputeDocument,
                                             java.lang.String disputeId)
                                      throws java.lang.Exception

Description copied from interface: DisputeApi

Creates document for dispute.

Specified by:

createDisputeDocument in interface DisputeApi

Parameters:

idempotencyKey - idempotency key for this request.

disputeDocument - Dispute document to be created.

disputeId - Dispute identifier.

Returns:

Dispute document returned from API.

Throws:

java.lang.Exception

createDisputePage

public void createDisputePage(java.lang.String disputeId,
                              java.lang.String documentId,
                              byte[] binaryData)
                       throws java.lang.Exception

Description copied from interface: DisputeApi

Creates document's page for dispute.

Specified by:

createDisputePage in interface DisputeApi

Parameters:

disputeId - Dispute identifier.

documentId - Dispute document identifier.

binaryData - The byte array the DisputePage will be created from.

Throws:

java.lang.Exception

createDisputePage

public void createDisputePage(java.lang.String idempotencyKey,
                              java.lang.String disputeId,
                              java.lang.String documentId,
                              byte[] binaryData)
                       throws java.lang.Exception

Description copied from interface: DisputeApi

Creates document's page for dispute.

Specified by:

createDisputePage in interface DisputeApi

Parameters:

idempotencyKey - idempotency key for this request.

disputeId - Dispute identifier.

documentId - Dispute document identifier.

binaryData - The byte array the DisputePage will be created from.

Throws:

java.lang.Exception

createDisputePage

public void createDisputePage(java.lang.String disputeId,
                              java.lang.String documentId,
                              java.lang.String filePath)
                       throws java.io.IOException,
                              java.lang.Exception

Description copied from interface: DisputeApi

Creates document's page for dispute.

Specified by:

createDisputePage in interface DisputeApi

Parameters:

disputeId - Dispute identifier.

documentId - Dispute document identifier.

filePath - Path to the file the DisputePage will be created from.

Throws:

java.io.IOException

java.lang.Exception

createDisputePage

public void createDisputePage(java.lang.String idempotencyKey,
                              java.lang.String disputeId,
                              java.lang.String documentId,
                              java.lang.String filePath)
                       throws java.io.IOException,
                              java.lang.Exception

Description copied from interface: DisputeApi

Creates document's page for dispute.

Specified by:

createDisputePage in interface DisputeApi

Parameters:

idempotencyKey - idempotency key for this request.

disputeId - Dispute identifier.

documentId - Dispute document identifier.

filePath - Path to the file the DisputePage will be created from.

Throws:

java.io.IOException

java.lang.Exception

createDisputeDocumentConsult

public java.util.List<DocumentPageConsult> createDisputeDocumentConsult(java.lang.String documentId)
                                                                 throws java.lang.Exception

Description copied from interface: DisputeApi

Creates temporary URLs where each page of a dispute document can be viewed.

Specified by:

createDisputeDocumentConsult in interface DisputeApi

Parameters:

documentId - Identification of the document whose pages to view

Returns:

List of consults for viewing the dispute document's pages

Throws:

java.lang.Exception