com.squareup.square.legacy.models.GiftCardActivityLoad 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 GiftCardActivityLoad type.
*/
public class GiftCardActivityLoad {
private final Money amountMoney;
private final OptionalNullable orderId;
private final OptionalNullable lineItemUid;
private final OptionalNullable referenceId;
private final OptionalNullable> buyerPaymentInstrumentIds;
/**
* Initialization constructor.
* @param amountMoney Money value for amountMoney.
* @param orderId String value for orderId.
* @param lineItemUid String value for lineItemUid.
* @param referenceId String value for referenceId.
* @param buyerPaymentInstrumentIds List of String value for buyerPaymentInstrumentIds.
*/
@JsonCreator
public GiftCardActivityLoad(
@JsonProperty("amount_money") Money amountMoney,
@JsonProperty("order_id") String orderId,
@JsonProperty("line_item_uid") String lineItemUid,
@JsonProperty("reference_id") String referenceId,
@JsonProperty("buyer_payment_instrument_ids") List buyerPaymentInstrumentIds) {
this.amountMoney = amountMoney;
this.orderId = OptionalNullable.of(orderId);
this.lineItemUid = OptionalNullable.of(lineItemUid);
this.referenceId = OptionalNullable.of(referenceId);
this.buyerPaymentInstrumentIds = OptionalNullable.of(buyerPaymentInstrumentIds);
}
/**
* Initialization constructor.
* @param amountMoney Money value for amountMoney.
* @param orderId String value for orderId.
* @param lineItemUid String value for lineItemUid.
* @param referenceId String value for referenceId.
* @param buyerPaymentInstrumentIds List of String value for buyerPaymentInstrumentIds.
*/
protected GiftCardActivityLoad(
Money amountMoney,
OptionalNullable orderId,
OptionalNullable lineItemUid,
OptionalNullable referenceId,
OptionalNullable> buyerPaymentInstrumentIds) {
this.amountMoney = amountMoney;
this.orderId = orderId;
this.lineItemUid = lineItemUid;
this.referenceId = referenceId;
this.buyerPaymentInstrumentIds = buyerPaymentInstrumentIds;
}
/**
* 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 OrderId.
* The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item. Applications
* that use the Square Orders API to process orders must specify the order ID in the
* [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
* @return Returns the Internal String
*/
@JsonGetter("order_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetOrderId() {
return this.orderId;
}
/**
* Getter for OrderId.
* The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item. Applications
* that use the Square Orders API to process orders must specify the order ID in the
* [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
* @return Returns the String
*/
@JsonIgnore
public String getOrderId() {
return OptionalNullable.getFrom(orderId);
}
/**
* Internal Getter for LineItemUid.
* The UID of the `GIFT_CARD` line item in the order that represents the additional funds for
* the gift card. Applications that use the Square Orders API to process orders must specify the
* line item UID in the
* [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
* @return Returns the Internal String
*/
@JsonGetter("line_item_uid")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetLineItemUid() {
return this.lineItemUid;
}
/**
* Getter for LineItemUid.
* The UID of the `GIFT_CARD` line item in the order that represents the additional funds for
* the gift card. Applications that use the Square Orders API to process orders must specify the
* line item UID in the
* [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
* @return Returns the String
*/
@JsonIgnore
public String getLineItemUid() {
return OptionalNullable.getFrom(lineItemUid);
}
/**
* Internal Getter for ReferenceId.
* A client-specified ID that associates the gift card activity with an entity in another
* system. Applications that use a custom order processing system can use this field to track
* information related to an order or payment.
* @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. Applications that use a custom order processing system can use this field to track
* information related to an order or payment.
* @return Returns the String
*/
@JsonIgnore
public String getReferenceId() {
return OptionalNullable.getFrom(referenceId);
}
/**
* Internal Getter for BuyerPaymentInstrumentIds.
* The payment instrument IDs used to process the order for the additional funds, such as a
* credit card ID or bank account ID. Applications that use a custom order processing system
* must specify payment instrument IDs in the
* [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
* Square uses this information to perform compliance checks. For applications that use the
* Square Orders API to process payments, Square has the necessary instrument IDs to perform
* compliance checks. Each buyer payment instrument ID can contain a maximum of 255 characters.
* @return Returns the Internal List of String
*/
@JsonGetter("buyer_payment_instrument_ids")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable> internalGetBuyerPaymentInstrumentIds() {
return this.buyerPaymentInstrumentIds;
}
/**
* Getter for BuyerPaymentInstrumentIds.
* The payment instrument IDs used to process the order for the additional funds, such as a
* credit card ID or bank account ID. Applications that use a custom order processing system
* must specify payment instrument IDs in the
* [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
* Square uses this information to perform compliance checks. For applications that use the
* Square Orders API to process payments, Square has the necessary instrument IDs to perform
* compliance checks. Each buyer payment instrument ID can contain a maximum of 255 characters.
* @return Returns the List of String
*/
@JsonIgnore
public List getBuyerPaymentInstrumentIds() {
return OptionalNullable.getFrom(buyerPaymentInstrumentIds);
}
@Override
public int hashCode() {
return Objects.hash(amountMoney, orderId, lineItemUid, referenceId, buyerPaymentInstrumentIds);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof GiftCardActivityLoad)) {
return false;
}
GiftCardActivityLoad other = (GiftCardActivityLoad) obj;
return Objects.equals(amountMoney, other.amountMoney)
&& Objects.equals(orderId, other.orderId)
&& Objects.equals(lineItemUid, other.lineItemUid)
&& Objects.equals(referenceId, other.referenceId)
&& Objects.equals(buyerPaymentInstrumentIds, other.buyerPaymentInstrumentIds);
}
/**
* Converts this GiftCardActivityLoad into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "GiftCardActivityLoad [" + "amountMoney=" + amountMoney + ", orderId=" + orderId
+ ", lineItemUid=" + lineItemUid + ", referenceId=" + referenceId
+ ", buyerPaymentInstrumentIds=" + buyerPaymentInstrumentIds + "]";
}
/**
* Builds a new {@link GiftCardActivityLoad.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link GiftCardActivityLoad.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder().amountMoney(getAmountMoney());
builder.orderId = internalGetOrderId();
builder.lineItemUid = internalGetLineItemUid();
builder.referenceId = internalGetReferenceId();
builder.buyerPaymentInstrumentIds = internalGetBuyerPaymentInstrumentIds();
return builder;
}
/**
* Class to build instances of {@link GiftCardActivityLoad}.
*/
public static class Builder {
private Money amountMoney;
private OptionalNullable orderId;
private OptionalNullable lineItemUid;
private OptionalNullable referenceId;
private OptionalNullable> buyerPaymentInstrumentIds;
/**
* Setter for amountMoney.
* @param amountMoney Money value for amountMoney.
* @return Builder
*/
public Builder amountMoney(Money amountMoney) {
this.amountMoney = amountMoney;
return this;
}
/**
* Setter for orderId.
* @param orderId String value for orderId.
* @return Builder
*/
public Builder orderId(String orderId) {
this.orderId = OptionalNullable.of(orderId);
return this;
}
/**
* UnSetter for orderId.
* @return Builder
*/
public Builder unsetOrderId() {
orderId = null;
return this;
}
/**
* Setter for lineItemUid.
* @param lineItemUid String value for lineItemUid.
* @return Builder
*/
public Builder lineItemUid(String lineItemUid) {
this.lineItemUid = OptionalNullable.of(lineItemUid);
return this;
}
/**
* UnSetter for lineItemUid.
* @return Builder
*/
public Builder unsetLineItemUid() {
lineItemUid = null;
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 buyerPaymentInstrumentIds.
* @param buyerPaymentInstrumentIds List of String value for buyerPaymentInstrumentIds.
* @return Builder
*/
public Builder buyerPaymentInstrumentIds(List buyerPaymentInstrumentIds) {
this.buyerPaymentInstrumentIds = OptionalNullable.of(buyerPaymentInstrumentIds);
return this;
}
/**
* UnSetter for buyerPaymentInstrumentIds.
* @return Builder
*/
public Builder unsetBuyerPaymentInstrumentIds() {
buyerPaymentInstrumentIds = null;
return this;
}
/**
* Builds a new {@link GiftCardActivityLoad} object using the set fields.
* @return {@link GiftCardActivityLoad}
*/
public GiftCardActivityLoad build() {
return new GiftCardActivityLoad(amountMoney, orderId, lineItemUid, referenceId, buyerPaymentInstrumentIds);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy