com.squareup.square.legacy.models.Refund Maven / Gradle / Ivy
package com.squareup.square.legacy.models;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.apimatic.core.types.OptionalNullable;
import java.util.List;
import java.util.Objects;
/**
* This is a model class for Refund type.
*/
public class Refund {
private final String id;
private final String locationId;
private final OptionalNullable transactionId;
private final OptionalNullable tenderId;
private final String createdAt;
private final String reason;
private final Money amountMoney;
private final String status;
private final Money processingFeeMoney;
private final OptionalNullable> additionalRecipients;
/**
* Initialization constructor.
* @param id String value for id.
* @param locationId String value for locationId.
* @param tenderId String value for tenderId.
* @param reason String value for reason.
* @param amountMoney Money value for amountMoney.
* @param status String value for status.
* @param transactionId String value for transactionId.
* @param createdAt String value for createdAt.
* @param processingFeeMoney Money value for processingFeeMoney.
* @param additionalRecipients List of AdditionalRecipient value for additionalRecipients.
*/
@JsonCreator
public Refund(
@JsonProperty("id") String id,
@JsonProperty("location_id") String locationId,
@JsonProperty("tender_id") String tenderId,
@JsonProperty("reason") String reason,
@JsonProperty("amount_money") Money amountMoney,
@JsonProperty("status") String status,
@JsonProperty("transaction_id") String transactionId,
@JsonProperty("created_at") String createdAt,
@JsonProperty("processing_fee_money") Money processingFeeMoney,
@JsonProperty("additional_recipients") List additionalRecipients) {
this.id = id;
this.locationId = locationId;
this.transactionId = OptionalNullable.of(transactionId);
this.tenderId = OptionalNullable.of(tenderId);
this.createdAt = createdAt;
this.reason = reason;
this.amountMoney = amountMoney;
this.status = status;
this.processingFeeMoney = processingFeeMoney;
this.additionalRecipients = OptionalNullable.of(additionalRecipients);
}
/**
* Initialization constructor.
* @param id String value for id.
* @param locationId String value for locationId.
* @param tenderId String value for tenderId.
* @param reason String value for reason.
* @param amountMoney Money value for amountMoney.
* @param status String value for status.
* @param transactionId String value for transactionId.
* @param createdAt String value for createdAt.
* @param processingFeeMoney Money value for processingFeeMoney.
* @param additionalRecipients List of AdditionalRecipient value for additionalRecipients.
*/
protected Refund(
String id,
String locationId,
OptionalNullable tenderId,
String reason,
Money amountMoney,
String status,
OptionalNullable transactionId,
String createdAt,
Money processingFeeMoney,
OptionalNullable> additionalRecipients) {
this.id = id;
this.locationId = locationId;
this.transactionId = transactionId;
this.tenderId = tenderId;
this.createdAt = createdAt;
this.reason = reason;
this.amountMoney = amountMoney;
this.status = status;
this.processingFeeMoney = processingFeeMoney;
this.additionalRecipients = additionalRecipients;
}
/**
* Getter for Id.
* The refund's unique ID.
* @return Returns the String
*/
@JsonGetter("id")
public String getId() {
return id;
}
/**
* Getter for LocationId.
* The ID of the refund's associated location.
* @return Returns the String
*/
@JsonGetter("location_id")
public String getLocationId() {
return locationId;
}
/**
* Internal Getter for TransactionId.
* The ID of the transaction that the refunded tender is part of.
* @return Returns the Internal String
*/
@JsonGetter("transaction_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetTransactionId() {
return this.transactionId;
}
/**
* Getter for TransactionId.
* The ID of the transaction that the refunded tender is part of.
* @return Returns the String
*/
@JsonIgnore
public String getTransactionId() {
return OptionalNullable.getFrom(transactionId);
}
/**
* Internal Getter for TenderId.
* The ID of the refunded tender.
* @return Returns the Internal String
*/
@JsonGetter("tender_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetTenderId() {
return this.tenderId;
}
/**
* Getter for TenderId.
* The ID of the refunded tender.
* @return Returns the String
*/
@JsonIgnore
public String getTenderId() {
return OptionalNullable.getFrom(tenderId);
}
/**
* Getter for CreatedAt.
* The timestamp for when the refund was created, in RFC 3339 format.
* @return Returns the String
*/
@JsonGetter("created_at")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getCreatedAt() {
return createdAt;
}
/**
* Getter for Reason.
* The reason for the refund being issued.
* @return Returns the String
*/
@JsonGetter("reason")
public String getReason() {
return reason;
}
/**
* Getter for AmountMoney.
* Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not
* explicitly define whether they are signed or unsigned are considered unsigned and can only
* hold positive amounts. For signed fields, the sign of the value indicates the purpose of the
* money transfer. See [Working with Monetary
* Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for
* more information.
* @return Returns the Money
*/
@JsonGetter("amount_money")
public Money getAmountMoney() {
return amountMoney;
}
/**
* Getter for Status.
* Indicates a refund's current status.
* @return Returns the String
*/
@JsonGetter("status")
public String getStatus() {
return status;
}
/**
* Getter for ProcessingFeeMoney.
* Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not
* explicitly define whether they are signed or unsigned are considered unsigned and can only
* hold positive amounts. For signed fields, the sign of the value indicates the purpose of the
* money transfer. See [Working with Monetary
* Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for
* more information.
* @return Returns the Money
*/
@JsonGetter("processing_fee_money")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Money getProcessingFeeMoney() {
return processingFeeMoney;
}
/**
* Internal Getter for AdditionalRecipients.
* Additional recipients (other than the merchant) receiving a portion of this refund. For
* example, fees assessed on a refund of a purchase by a third party integration.
* @return Returns the Internal List of AdditionalRecipient
*/
@JsonGetter("additional_recipients")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable> internalGetAdditionalRecipients() {
return this.additionalRecipients;
}
/**
* Getter for AdditionalRecipients.
* Additional recipients (other than the merchant) receiving a portion of this refund. For
* example, fees assessed on a refund of a purchase by a third party integration.
* @return Returns the List of AdditionalRecipient
*/
@JsonIgnore
public List getAdditionalRecipients() {
return OptionalNullable.getFrom(additionalRecipients);
}
@Override
public int hashCode() {
return Objects.hash(
id,
locationId,
transactionId,
tenderId,
createdAt,
reason,
amountMoney,
status,
processingFeeMoney,
additionalRecipients);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof Refund)) {
return false;
}
Refund other = (Refund) obj;
return Objects.equals(id, other.id)
&& Objects.equals(locationId, other.locationId)
&& Objects.equals(transactionId, other.transactionId)
&& Objects.equals(tenderId, other.tenderId)
&& Objects.equals(createdAt, other.createdAt)
&& Objects.equals(reason, other.reason)
&& Objects.equals(amountMoney, other.amountMoney)
&& Objects.equals(status, other.status)
&& Objects.equals(processingFeeMoney, other.processingFeeMoney)
&& Objects.equals(additionalRecipients, other.additionalRecipients);
}
/**
* Converts this Refund into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "Refund [" + "id=" + id + ", locationId=" + locationId + ", tenderId=" + tenderId
+ ", reason=" + reason + ", amountMoney=" + amountMoney + ", status=" + status
+ ", transactionId=" + transactionId + ", createdAt=" + createdAt
+ ", processingFeeMoney=" + processingFeeMoney + ", additionalRecipients="
+ additionalRecipients + "]";
}
/**
* Builds a new {@link Refund.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link Refund.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder(id, locationId, reason, amountMoney, status)
.createdAt(getCreatedAt())
.processingFeeMoney(getProcessingFeeMoney());
builder.transactionId = internalGetTransactionId();
builder.tenderId = internalGetTenderId();
builder.additionalRecipients = internalGetAdditionalRecipients();
return builder;
}
/**
* Class to build instances of {@link Refund}.
*/
public static class Builder {
private String id;
private String locationId;
private OptionalNullable tenderId;
private String reason;
private Money amountMoney;
private String status;
private OptionalNullable transactionId;
private String createdAt;
private Money processingFeeMoney;
private OptionalNullable> additionalRecipients;
/**
* Initialization constructor.
* @param id String value for id.
* @param locationId String value for locationId.
* @param reason String value for reason.
* @param amountMoney Money value for amountMoney.
* @param status String value for status.
*/
public Builder(String id, String locationId, String reason, Money amountMoney, String status) {
this.id = id;
this.locationId = locationId;
this.reason = reason;
this.amountMoney = amountMoney;
this.status = status;
}
/**
* Setter for id.
* @param id String value for id.
* @return Builder
*/
public Builder id(String id) {
this.id = id;
return this;
}
/**
* Setter for locationId.
* @param locationId String value for locationId.
* @return Builder
*/
public Builder locationId(String locationId) {
this.locationId = locationId;
return this;
}
/**
* Setter for tenderId.
* @param tenderId String value for tenderId.
* @return Builder
*/
public Builder tenderId(String tenderId) {
this.tenderId = OptionalNullable.of(tenderId);
return this;
}
/**
* UnSetter for tenderId.
* @return Builder
*/
public Builder unsetTenderId() {
tenderId = null;
return this;
}
/**
* Setter for reason.
* @param reason String value for reason.
* @return Builder
*/
public Builder reason(String reason) {
this.reason = reason;
return this;
}
/**
* Setter for amountMoney.
* @param amountMoney Money value for amountMoney.
* @return Builder
*/
public Builder amountMoney(Money amountMoney) {
this.amountMoney = amountMoney;
return this;
}
/**
* Setter for status.
* @param status String value for status.
* @return Builder
*/
public Builder status(String status) {
this.status = status;
return this;
}
/**
* Setter for transactionId.
* @param transactionId String value for transactionId.
* @return Builder
*/
public Builder transactionId(String transactionId) {
this.transactionId = OptionalNullable.of(transactionId);
return this;
}
/**
* UnSetter for transactionId.
* @return Builder
*/
public Builder unsetTransactionId() {
transactionId = null;
return this;
}
/**
* Setter for createdAt.
* @param createdAt String value for createdAt.
* @return Builder
*/
public Builder createdAt(String createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* Setter for processingFeeMoney.
* @param processingFeeMoney Money value for processingFeeMoney.
* @return Builder
*/
public Builder processingFeeMoney(Money processingFeeMoney) {
this.processingFeeMoney = processingFeeMoney;
return this;
}
/**
* Setter for additionalRecipients.
* @param additionalRecipients List of AdditionalRecipient value for additionalRecipients.
* @return Builder
*/
public Builder additionalRecipients(List additionalRecipients) {
this.additionalRecipients = OptionalNullable.of(additionalRecipients);
return this;
}
/**
* UnSetter for additionalRecipients.
* @return Builder
*/
public Builder unsetAdditionalRecipients() {
additionalRecipients = null;
return this;
}
/**
* Builds a new {@link Refund} object using the set fields.
* @return {@link Refund}
*/
public Refund build() {
return new Refund(
id,
locationId,
tenderId,
reason,
amountMoney,
status,
transactionId,
createdAt,
processingFeeMoney,
additionalRecipients);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy