Package model

Class Dispute

java.lang.Object

model.Dispute

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class Dispute
extends Object

A `Dispute` objected created for a chargeback or customer disputes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dispute.CustomTypeAdapterFactory
static class	Dispute.ReasonEnum	The system-defined reason for the `Dispute`.
static class	Dispute.StateEnum	The current state of the `Dispute`.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ACTION
static String	SERIALIZED_NAME_AMOUNT
static String	SERIALIZED_NAME_APPLICATION
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_CURRENCY
static String	SERIALIZED_NAME_DISPUTE_DETAILS
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_IDENTITY
static String	SERIALIZED_NAME_LINKS
static String	SERIALIZED_NAME_MESSAGE
static String	SERIALIZED_NAME_OCCURRED_AT
static String	SERIALIZED_NAME_REASON
static String	SERIALIZED_NAME_RESPOND_BY
static String	SERIALIZED_NAME_STATE
static String	SERIALIZED_NAME_TAGS
static String	SERIALIZED_NAME_TRANSFER
static String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
Dispute()

Method Summary

Modifier and Type	Method	Description
Dispute	action(String action)
Dispute	amount(Long amount)
Dispute	application(String application)
Dispute	createdAt(OffsetDateTime createdAt)
Dispute	currency(Currency currency)
Dispute	disputeDetails(Map<String,Object> disputeDetails)
boolean	equals(Object o)
static Dispute	fromJson(String jsonString)	Create an instance of Dispute given an JSON string
String	getAction()	The next `action` required to move forward with the `Dispute`.
Long	getAmount()	The total amount of the `Dispute` (in cents).
String	getApplication()	The ID of the `Application` resource the `Dispute` was created under.
OffsetDateTime	getCreatedAt()	Timestamp of when the object was created.
Currency	getCurrency()	Get currency
Map<String,Object>	getDisputeDetails()	Details about the `Dispute` recieved by the `Processor`.
String	getId()	The ID of the `Dispute` resource.
String	getIdentity()	The ID of the resource.
DisputeLinks	getLinks()	Get links
String	getMessage()	Message field that provides additional details.
OffsetDateTime	getOccurredAt()	Point in time when dispute occurred.
Dispute.ReasonEnum	getReason()	The system-defined reason for the `Dispute`.
OffsetDateTime	getRespondBy()	Point in time when dispute has to be resolved and the `Merchant` needs to respond by.
Dispute.StateEnum	getState()	The current state of the `Dispute`.
Map<String,String>	getTags()	Key value pair for annotating custom meta data (e.g.
String	getTransfer()	ID of the `Transfer` resource.
OffsetDateTime	getUpdatedAt()	Timestamp of when the object was last updated.
int	hashCode()
Dispute	id(String id)
Dispute	identity(String identity)
Dispute	links(DisputeLinks links)
Dispute	message(String message)
Dispute	occurredAt(OffsetDateTime occurredAt)
Dispute	putDisputeDetailsItem(String key, Object disputeDetailsItem)
Dispute	putTagsItem(String key, String tagsItem)
Dispute	reason(Dispute.ReasonEnum reason)
Dispute	respondBy(OffsetDateTime respondBy)
void	setAction(String action)
void	setAmount(Long amount)
void	setApplication(String application)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCurrency(Currency currency)
void	setDisputeDetails(Map<String,Object> disputeDetails)
void	setId(String id)
void	setIdentity(String identity)
void	setLinks(DisputeLinks links)
void	setMessage(String message)
void	setOccurredAt(OffsetDateTime occurredAt)
void	setReason(Dispute.ReasonEnum reason)
void	setRespondBy(OffsetDateTime respondBy)
void	setState(Dispute.StateEnum state)
void	setTags(Map<String,String> tags)
void	setTransfer(String transfer)
void	setUpdatedAt(OffsetDateTime updatedAt)
Dispute	state(Dispute.StateEnum state)
Dispute	tags(Map<String,String> tags)
String	toJson()	Convert an instance of Dispute to an JSON string
String	toString()
Dispute	transfer(String transfer)
Dispute	updatedAt(OffsetDateTime updatedAt)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_ACTION

public static final String SERIALIZED_NAME_ACTION

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_APPLICATION

public static final String SERIALIZED_NAME_APPLICATION

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final String SERIALIZED_NAME_CURRENCY

See Also:

Constant Field Values

SERIALIZED_NAME_DISPUTE_DETAILS

public static final String SERIALIZED_NAME_DISPUTE_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_IDENTITY

public static final String SERIALIZED_NAME_IDENTITY

See Also:

Constant Field Values

SERIALIZED_NAME_MESSAGE

public static final String SERIALIZED_NAME_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_OCCURRED_AT

public static final String SERIALIZED_NAME_OCCURRED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_REASON

public static final String SERIALIZED_NAME_REASON

See Also:

Constant Field Values

SERIALIZED_NAME_RESPOND_BY

public static final String SERIALIZED_NAME_RESPOND_BY

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFER

public static final String SERIALIZED_NAME_TRANSFER

See Also:

Constant Field Values

SERIALIZED_NAME_LINKS

public static final String SERIALIZED_NAME_LINKS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

Dispute

public Dispute()

Method Detail

id

public Dispute id(String id)

getId

@Nullable
public String getId()

The ID of the `Dispute` resource.

Returns:

id

setId

public void setId(String id)

createdAt

public Dispute createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp of when the object was created.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public Dispute updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp of when the object was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

action

public Dispute action(String action)

getAction

@Nullable
public String getAction()

The next `action` required to move forward with the `Dispute`.

Returns:

action

setAction

public void setAction(String action)

amount

public Dispute amount(Long amount)

getAmount

@Nullable
public Long getAmount()

The total amount of the `Dispute` (in cents).

Returns:

amount

setAmount

public void setAmount(Long amount)

application

public Dispute application(String application)

getApplication

@Nullable
public String getApplication()

The ID of the `Application` resource the `Dispute` was created under.

Returns:

application

setApplication

public void setApplication(String application)

currency

public Dispute currency(Currency currency)

getCurrency

@Nullable
public Currency getCurrency()

Get currency

Returns:

currency

setCurrency

public void setCurrency(Currency currency)

disputeDetails

public Dispute disputeDetails(Map<String,Object> disputeDetails)

putDisputeDetailsItem

public Dispute putDisputeDetailsItem(String key,
                                     Object disputeDetailsItem)

getDisputeDetails

@Nullable
public Map<String,Object> getDisputeDetails()

Details about the `Dispute` recieved by the `Processor`. May be any type of data.

Returns:

disputeDetails

setDisputeDetails

public void setDisputeDetails(Map<String,Object> disputeDetails)

identity

public Dispute identity(String identity)

getIdentity

@Nullable
public String getIdentity()

The ID of the resource.

Returns:

identity

setIdentity

public void setIdentity(String identity)

message

public Dispute message(String message)

getMessage

@Nullable
public String getMessage()

Message field that provides additional details. This field is typically **null**.

Returns:

message

setMessage

public void setMessage(String message)

occurredAt

public Dispute occurredAt(OffsetDateTime occurredAt)

getOccurredAt

@Nullable
public OffsetDateTime getOccurredAt()

Point in time when dispute occurred.

Returns:

occurredAt

setOccurredAt

public void setOccurredAt(OffsetDateTime occurredAt)

reason

public Dispute reason(Dispute.ReasonEnum reason)

getReason

@Nullable
public Dispute.ReasonEnum getReason()

The system-defined reason for the `Dispute`. Available values include:<ul><li>**INQUIRY**<li>**QUALITY**<li>**FRAUD**

Returns:

reason

setReason

public void setReason(Dispute.ReasonEnum reason)

respondBy

public Dispute respondBy(OffsetDateTime respondBy)

getRespondBy

@Nullable
public OffsetDateTime getRespondBy()

Point in time when dispute has to be resolved and the `Merchant` needs to respond by.

Returns:

respondBy

setRespondBy

public void setRespondBy(OffsetDateTime respondBy)

state

public Dispute state(Dispute.StateEnum state)

getState

@Nullable
public Dispute.StateEnum getState()

The current state of the `Dispute`.

Returns:

state

setState

public void setState(Dispute.StateEnum state)

tags

public Dispute tags(Map<String,String> tags)

putTagsItem

public Dispute putTagsItem(String key,
                           String tagsItem)

getTags

@Nullable
public Map<String,String> getTags()

Key value pair for annotating custom meta data (e.g. order numbers).

Returns:

tags

setTags

public void setTags(Map<String,String> tags)

transfer

public Dispute transfer(String transfer)

getTransfer

@Nullable
public String getTransfer()

ID of the `Transfer` resource.

Returns:

transfer

setTransfer

public void setTransfer(String transfer)

links

public Dispute links(DisputeLinks links)

getLinks

@Nullable
public DisputeLinks getLinks()

Get links

Returns:

links

setLinks

public void setLinks(DisputeLinks links)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to Dispute

fromJson

public static Dispute fromJson(String jsonString)
                        throws IOException

Create an instance of Dispute given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Dispute

Throws:

IOException - if the JSON string is invalid with respect to Dispute

toJson

public String toJson()

Convert an instance of Dispute to an JSON string

Returns:

JSON string