com.squareup.square.models

Class GiftCardActivityLoad

java.lang.Object

com.squareup.square.models.GiftCardActivityLoad

public class GiftCardActivityLoad
extends Object

This is a model class for GiftCardActivityLoad type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GiftCardActivityLoad.Builder Class to build instances of GiftCardActivityLoad.

Constructor Summary

Constructors

Constructor and Description
GiftCardActivityLoad(Money amountMoney, String orderId, String lineItemUid, String referenceId, List<String> buyerPaymentInstrumentIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
List<String>	getBuyerPaymentInstrumentIds() Getter for BuyerPaymentInstrumentIds.
String	getLineItemUid() Getter for LineItemUid.
String	getOrderId() Getter for OrderId.
String	getReferenceId() Getter for ReferenceId.
int	hashCode()
GiftCardActivityLoad.Builder	toBuilder() Builds a new GiftCardActivityLoad.Builder object.
String	toString() Converts this GiftCardActivityLoad into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

GiftCardActivityLoad

public GiftCardActivityLoad(Money amountMoney,
                            String orderId,
                            String lineItemUid,
                            String referenceId,
                            List<String> buyerPaymentInstrumentIds)

Initialization constructor.

Parameters:

amountMoney - Money value for amountMoney.

orderId - String value for orderId.

lineItemUid - String value for lineItemUid.

referenceId - String value for referenceId.

buyerPaymentInstrumentIds - List of String value for buyerPaymentInstrumentIds.

Method Detail

getAmountMoney

public Money getAmountMoney()

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.

Returns:

Returns the Money

getOrderId

public String getOrderId()

Getter for OrderId. The `order_id` of the order associated with the activity. It is populated along with `line_item_uid` and is required if using the Square Orders API.

Returns:

Returns the String

getLineItemUid

public String getLineItemUid()

Getter for LineItemUid. The `line_item_uid` of the gift card’s line item in the order associated with the activity. It is populated along with `order_id` and is required if using the Square Orders API.

Returns:

Returns the String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. A client-specified ID to associate an entity, in another system, with this gift card activity. This can be used to track the order or payment related information when the Square Orders API is not being used.

Returns:

Returns the String

getBuyerPaymentInstrumentIds

public List<String> getBuyerPaymentInstrumentIds()

Getter for BuyerPaymentInstrumentIds. If you are not using the Orders API, this field is required because it is used to identify a buyer to perform compliance checks.

Returns:

Returns the List of String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this GiftCardActivityLoad into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public GiftCardActivityLoad.Builder toBuilder()

Builds a new GiftCardActivityLoad.Builder object. Creates the instance with the state of the current model.

Returns:

a new GiftCardActivityLoad.Builder object