com.stripe.model.Dispute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stripe-java Show documentation
Stripe Java Bindings
There is a newer version: 28.2.0
package com.stripe.model;

import com.stripe.exception.APIConnectionException;
import com.stripe.exception.APIException;
import com.stripe.exception.AuthenticationException;
import com.stripe.exception.CardException;
import com.stripe.exception.InvalidRequestException;
import com.stripe.net.APIResource;
import com.stripe.net.RequestOptions;

import java.util.List;
import java.util.Map;

public class Dispute extends APIResource implements HasId {
	String id;
	String object;
	Long amount;
	List balanceTransactions;
	String charge;
	Long created;
	String currency;
	EvidenceSubObject evidenceSubObject; // `evidence`
	EvidenceDetails evidenceDetails;
	Boolean isChargeRefundable;
	Boolean livemode;
	Map metadata;
	String reason;
	String status;
	String networkReasonCode; // Not part of the public API.

	/** 8/2014: Legacy (now use balanceTransactions) -- https://stripe.com/docs/upgrades#2014-08-20 */
	@Deprecated
	String balanceTransaction;
	/** 12/2014: Legacy (now use evidenceSubObject) -- https://stripe.com/docs/upgrades */
	@Deprecated
	String evidence;
	/** 12/2014: Legacy (now use evidenceDetails.dueBy) -- https://stripe.com/docs/upgrades */
	@Deprecated
	Long evidenceDueBy;

	public String getId() {
		return id;
	}

	public void setId(String id) {
		this.id = id;
	}

	public String getObject() {
		return object;
	}

	public void setObject(String object) {
		this.object = object;
	}

	public Long getAmount() {
		return amount;
	}

	public void setAmount(Long amount) {
		this.amount = amount;
	}

	public List getBalanceTransactions() {
		return balanceTransactions;
	}

	public void setBalanceTransactions(List balanceTransactions) {
		this.balanceTransactions = balanceTransactions;
	}

	public String getCharge() {
		return charge;
	}

	public void setCharge(String charge) {
		this.charge = charge;
	}

	public Long getCreated() {
		return created;
	}

	public void setCreated(Long created) {
		this.created = created;
	}

	public String getCurrency() {
		return currency;
	}

	public void setCurrency(String currency) {
		this.currency = currency;
	}

	public EvidenceSubObject getEvidenceSubObject() {
		return evidenceSubObject;
	}

	public void setEvidenceSubObject(EvidenceSubObject evidence) {
		this.evidenceSubObject = evidence;
	}

	public EvidenceDetails getEvidenceDetails() {
		return evidenceDetails;
	}

	public void setEvidenceDetails(EvidenceDetails evidenceDetails) {
		this.evidenceDetails = evidenceDetails;
	}

	public boolean getIsChargeRefundable() {
		return isChargeRefundable;
	}

	public void setIsChargeRefundable(Boolean isChargeRefundable) {
		this.isChargeRefundable = isChargeRefundable;
	}

	public Boolean getLivemode() {
		return livemode;
	}

	public void setLivemode(Boolean livemode) {
		this.livemode = livemode;
	}

	public Map getMetadata() {
		return metadata;
	}
	public void setMetadata(Map metadata) {
		this.metadata = metadata;
	}

	public String getReason() {
		return reason;
	}
	public void setReason(String reason) {
		this.reason = reason;
	}

	public String getStatus() {
		return status;
	}

	public void setStatus(String status) {
		this.status = status;
	}

	public String getNetworkReasonCode() {
		return networkReasonCode;
	}

	/**
	 * This method is not part of the public API and for internal use only.
	 */
	public void setNetworkReasonCode(String networkReasonCode) {
		this.networkReasonCode = networkReasonCode;
	}

	/**
	 * @deprecated
	 * Use `balance_transactions` field
	 */
	@Deprecated
	public String getBalanceTransaction() {
		return balanceTransaction;
	}

	/**
	 * @deprecated
	 * Use `balance_transactions` field
	 */
	@Deprecated
	public void setBalanceTransaction(String balanceTransaction) {
		this.balanceTransaction = balanceTransaction;
	}

	/**
	 * @deprecated
	 * Use evidenceSubObject (https://stripe.com/docs/upgrades#2014-12-08)
	 */
	@Deprecated
	public String getEvidence() {
		return evidence;
	}

	/**
	 * @deprecated
	 * Use evidenceSubObject (https://stripe.com/docs/upgrades#2014-12-08)
	 */
	@Deprecated
	public void setEvidence(String evidence) {
		this.evidence = evidence;
	}

	/**
	 * @deprecated
	 * Use evidenceDetails.dueBy (https://stripe.com/docs/upgrades#2014-12-08)
	 */
	@Deprecated
	public Long getEvidenceDueBy() {
		return evidenceDueBy;
	}

	/**
	 * @deprecated
	 * Use evidenceDetails.dueBy (https://stripe.com/docs/upgrades#2014-12-08)
	 */
	@Deprecated
	public void setEvidenceDueBy(Long evidenceDueBy) {
		this.evidenceDueBy = evidenceDueBy;
	}

	public static Dispute retrieve(String id) throws AuthenticationException,
			InvalidRequestException, APIConnectionException, CardException,
			APIException {
		return retrieve(id, (RequestOptions) null);
	}

	public static Dispute retrieve(String id, RequestOptions options) throws AuthenticationException,
			InvalidRequestException, APIConnectionException, CardException,
			APIException {
		return request(RequestMethod.GET, instanceURL(Dispute.class, id), null, Dispute.class, options);
	}

	public static DisputeCollection list(Map params) throws AuthenticationException,
			InvalidRequestException, APIConnectionException, CardException,
			APIException {
		return list(params, (RequestOptions) null);
	}

	public static DisputeCollection list(Map params, RequestOptions options) throws AuthenticationException,
			InvalidRequestException, APIConnectionException, CardException,
			APIException {
		return requestCollection(classURL(Dispute.class), params, DisputeCollection.class, options);
	}

	@Deprecated
	public static DisputeCollection all(Map params) throws AuthenticationException,
			InvalidRequestException, APIConnectionException, CardException,
			APIException {
		return list(params, (RequestOptions) null);
	}

	@Deprecated
	public static DisputeCollection all(Map params, RequestOptions options) throws AuthenticationException,
			InvalidRequestException, APIConnectionException, CardException,
			APIException {
		return list(params, options);
	}

	public Dispute update(Map params)
			throws AuthenticationException, InvalidRequestException,
			APIConnectionException, CardException, APIException {
		return update(params, (RequestOptions) null);
	}

	public Dispute update(Map params, RequestOptions options)
			throws AuthenticationException, InvalidRequestException,
			APIConnectionException, CardException, APIException {
		return request(RequestMethod.POST, instanceURL(Dispute.class, this.getId()),
				params, Dispute.class, options);
	}

	public Dispute close()
			throws AuthenticationException, InvalidRequestException,
			APIConnectionException, CardException, APIException {
		return close((RequestOptions) null);
	}

	public Dispute close(RequestOptions options)
			throws AuthenticationException, InvalidRequestException,
			APIConnectionException, CardException, APIException {
		return request(RequestMethod.POST, String.format("%s/close", instanceURL(Dispute.class, this.getId())),
				null, Dispute.class, options);
	}
}