com.squareup.square.legacy.models.GiftCardActivityRefund 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.Objects;
/**
* This is a model class for GiftCardActivityRefund type.
*/
public class GiftCardActivityRefund {
private final OptionalNullable redeemActivityId;
private final Money amountMoney;
private final OptionalNullable referenceId;
private final String paymentId;
/**
* Initialization constructor.
* @param redeemActivityId String value for redeemActivityId.
* @param amountMoney Money value for amountMoney.
* @param referenceId String value for referenceId.
* @param paymentId String value for paymentId.
*/
@JsonCreator
public GiftCardActivityRefund(
@JsonProperty("redeem_activity_id") String redeemActivityId,
@JsonProperty("amount_money") Money amountMoney,
@JsonProperty("reference_id") String referenceId,
@JsonProperty("payment_id") String paymentId) {
this.redeemActivityId = OptionalNullable.of(redeemActivityId);
this.amountMoney = amountMoney;
this.referenceId = OptionalNullable.of(referenceId);
this.paymentId = paymentId;
}
/**
* Initialization constructor.
* @param redeemActivityId String value for redeemActivityId.
* @param amountMoney Money value for amountMoney.
* @param referenceId String value for referenceId.
* @param paymentId String value for paymentId.
*/
protected GiftCardActivityRefund(
OptionalNullable redeemActivityId,
Money amountMoney,
OptionalNullable referenceId,
String paymentId) {
this.redeemActivityId = redeemActivityId;
this.amountMoney = amountMoney;
this.referenceId = referenceId;
this.paymentId = paymentId;
}
/**
* Internal Getter for RedeemActivityId.
* The ID of the refunded `REDEEM` gift card activity. Square populates this field if the
* `payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request
* represents a gift card redemption. For applications that use a custom payment processing
* system, this field is required when creating a `REFUND` activity. The provided `REDEEM`
* activity ID must be linked to the same gift card.
* @return Returns the Internal String
*/
@JsonGetter("redeem_activity_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetRedeemActivityId() {
return this.redeemActivityId;
}
/**
* Getter for RedeemActivityId.
* The ID of the refunded `REDEEM` gift card activity. Square populates this field if the
* `payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request
* represents a gift card redemption. For applications that use a custom payment processing
* system, this field is required when creating a `REFUND` activity. The provided `REDEEM`
* activity ID must be linked to the same gift card.
* @return Returns the String
*/
@JsonIgnore
public String getRedeemActivityId() {
return OptionalNullable.getFrom(redeemActivityId);
}
/**
* 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")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Money getAmountMoney() {
return amountMoney;
}
/**
* Internal Getter for ReferenceId.
* A client-specified ID that associates the gift card activity with an entity in another
* system.
* @return Returns the Internal String
*/
@JsonGetter("reference_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetReferenceId() {
return this.referenceId;
}
/**
* Getter for ReferenceId.
* A client-specified ID that associates the gift card activity with an entity in another
* system.
* @return Returns the String
*/
@JsonIgnore
public String getReferenceId() {
return OptionalNullable.getFrom(referenceId);
}
/**
* Getter for PaymentId.
* The ID of the refunded payment. Square populates this field if the refund is for a payment
* processed by Square. This field matches the `payment_id` in the corresponding
* [RefundPayment](api-endpoint:Refunds-RefundPayment) request.
* @return Returns the String
*/
@JsonGetter("payment_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getPaymentId() {
return paymentId;
}
@Override
public int hashCode() {
return Objects.hash(redeemActivityId, amountMoney, referenceId, paymentId);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof GiftCardActivityRefund)) {
return false;
}
GiftCardActivityRefund other = (GiftCardActivityRefund) obj;
return Objects.equals(redeemActivityId, other.redeemActivityId)
&& Objects.equals(amountMoney, other.amountMoney)
&& Objects.equals(referenceId, other.referenceId)
&& Objects.equals(paymentId, other.paymentId);
}
/**
* Converts this GiftCardActivityRefund into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "GiftCardActivityRefund [" + "redeemActivityId=" + redeemActivityId
+ ", amountMoney=" + amountMoney + ", referenceId=" + referenceId + ", paymentId="
+ paymentId + "]";
}
/**
* Builds a new {@link GiftCardActivityRefund.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link GiftCardActivityRefund.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder().amountMoney(getAmountMoney()).paymentId(getPaymentId());
builder.redeemActivityId = internalGetRedeemActivityId();
builder.referenceId = internalGetReferenceId();
return builder;
}
/**
* Class to build instances of {@link GiftCardActivityRefund}.
*/
public static class Builder {
private OptionalNullable redeemActivityId;
private Money amountMoney;
private OptionalNullable referenceId;
private String paymentId;
/**
* Setter for redeemActivityId.
* @param redeemActivityId String value for redeemActivityId.
* @return Builder
*/
public Builder redeemActivityId(String redeemActivityId) {
this.redeemActivityId = OptionalNullable.of(redeemActivityId);
return this;
}
/**
* UnSetter for redeemActivityId.
* @return Builder
*/
public Builder unsetRedeemActivityId() {
redeemActivityId = null;
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 referenceId.
* @param referenceId String value for referenceId.
* @return Builder
*/
public Builder referenceId(String referenceId) {
this.referenceId = OptionalNullable.of(referenceId);
return this;
}
/**
* UnSetter for referenceId.
* @return Builder
*/
public Builder unsetReferenceId() {
referenceId = null;
return this;
}
/**
* Setter for paymentId.
* @param paymentId String value for paymentId.
* @return Builder
*/
public Builder paymentId(String paymentId) {
this.paymentId = paymentId;
return this;
}
/**
* Builds a new {@link GiftCardActivityRefund} object using the set fields.
* @return {@link GiftCardActivityRefund}
*/
public GiftCardActivityRefund build() {
return new GiftCardActivityRefund(redeemActivityId, amountMoney, referenceId, paymentId);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy