Package com.braintreegateway

Class DisputeGateway

java.lang.Object

com.braintreegateway.DisputeGateway

public class DisputeGateway
extends Object

Provides methods to interact with Dispute objects. This class does not need to be instantiated directly. Instead, use BraintreeGateway.dispute() to get an instance of this class:

 BraintreeGateway gateway = new BraintreeGateway(...);
 gateway.dispute().find(...)
 

For more detailed information on disputes, see https://developer.paypal.com/braintree/docs/reference/response/dispute/java

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration
private Http	http

Constructor Summary

Constructors

Constructor	Description
DisputeGateway(Http http, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
Result<Dispute>	accept(String id)	Accept a @{link Dispute}, given a dispute ID.
Result<DisputeEvidence>	addFileEvidence(String disputeId, FileEvidenceRequest fileEvidenceRequest)	Add File Evidence to a @{link Dispute}, given an ID and a @{link FileEvidenceRequest} File evidence request.
Result<DisputeEvidence>	addFileEvidence(String disputeId, String documentId)	Add File Evidence to a @{link Dispute}, given an ID and a @{link DocumentUpload} ID.
Result<DisputeEvidence>	addTextEvidence(String id, TextEvidenceRequest textEvidenceRequest)	Add Text Evidence to a @{link Dispute}, given an ID and content.
Result<DisputeEvidence>	addTextEvidence(String id, String content)	Add Text Evidence to a @{link Dispute}, given an ID and content.
private Result<DisputeEvidence>	addTextEvidenceRequest(String id, TextEvidenceRequest textEvidenceRequest)
(package private) PaginatedResult<Dispute>	fetchDisputes(DisputeSearchRequest query, int page)
Result<Dispute>	finalize(String id)	Finalize a @{link Dispute}, given an ID.
Dispute	find(String id)	Returns a @{link Dispute}, given an ID.
Result<Dispute>	removeEvidence(String disputeId, String evidenceId)	Remove Evidence from a @{link Dispute}, given an ID and a @{link DisputeEvidence} ID.
PaginatedCollection<Dispute>	search(DisputeSearchRequest query)	Finds all Disputes that match the query.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

private Configuration configuration

http

private Http http

Constructor Detail

DisputeGateway

public DisputeGateway(Http http,
                      Configuration configuration)

Method Detail

accept

public Result<Dispute> accept(String id)

Accept a @{link Dispute}, given a dispute ID.

Parameters:

id - the dispute id to accept.

Returns:

a Result.

Throws:

NotFoundException - if a Dispute with the given ID cannot be found.

addFileEvidence

public Result<DisputeEvidence> addFileEvidence(String disputeId,
                                               String documentId)

Add File Evidence to a @{link Dispute}, given an ID and a @{link DocumentUpload} ID.

Parameters:

disputeId - the dispute id to add text evidence to.

documentId - the document id of a previously uploaded document

Returns:

a Result.

Throws:

NotFoundException - if the Dispute ID or Document ID cannot be found.

addFileEvidence

public Result<DisputeEvidence> addFileEvidence(String disputeId,
                                               FileEvidenceRequest fileEvidenceRequest)

Add File Evidence to a @{link Dispute}, given an ID and a @{link FileEvidenceRequest} File evidence request.

Parameters:

disputeId - the dispute id to add text evidence to.

fileEvidenceRequest - the file evidence request for the dispute.

Returns:

a Result.

Throws:

NotFoundException - if the Dispute ID or Document ID cannot be found.

addTextEvidence

public Result<DisputeEvidence> addTextEvidence(String id,
                                               TextEvidenceRequest textEvidenceRequest)

Add Text Evidence to a @{link Dispute}, given an ID and content.

Parameters:

id - the dispute id to add text evidence to.

textEvidenceRequest - the text evidence request for the dispute.

Returns:

a Result.

Throws:

NotFoundException - if a Dispute with the given ID cannot be found.

IllegalArgumentException - if the content is empty.

addTextEvidence

public Result<DisputeEvidence> addTextEvidence(String id,
                                               String content)

Add Text Evidence to a @{link Dispute}, given an ID and content.

Parameters:

id - the dispute id to add text evidence to.

content - the content of the text evidence for the dispute.

Returns:

a Result.

Throws:

NotFoundException - if a Dispute with the given ID cannot be found.

IllegalArgumentException - if the content is empty.

addTextEvidenceRequest

private Result<DisputeEvidence> addTextEvidenceRequest(String id,
                                                       TextEvidenceRequest textEvidenceRequest)

finalize

public Result<Dispute> finalize(String id)

Finalize a @{link Dispute}, given an ID.

Parameters:

id - the dispute id to finalize.

Returns:

a Result.

Throws:

NotFoundException - if a Dispute with the given ID cannot be found.

find

public Dispute find(String id)

Returns a @{link Dispute}, given an ID.

Parameters:

id - the dispute id to find.

Returns:

a Dispute.

Throws:

NotFoundException - if a Dispute with the given ID cannot be found.

removeEvidence

public Result<Dispute> removeEvidence(String disputeId,
                                      String evidenceId)

Remove Evidence from a @{link Dispute}, given an ID and a @{link DisputeEvidence} ID.

Parameters:

disputeId - the dispute id to remove evidence from.

evidenceId - the evidence id to remove.

Returns:

a Result.

Throws:

NotFoundException - if the Dispute ID or evidence ID cannot be found.

search

public PaginatedCollection<Dispute> search(DisputeSearchRequest query)

Finds all Disputes that match the query.

Parameters:

query - the query for what disputes to find.

Returns:

a PaginatedCollection of Dispute.

fetchDisputes

PaginatedResult<Dispute> fetchDisputes(DisputeSearchRequest query,
                                       int page)