com.squareup.square.models

Class GiftCardActivityActivate

java.lang.Object

com.squareup.square.models.GiftCardActivityActivate

public class GiftCardActivityActivate
extends Object

This is a model class for GiftCardActivityActivate type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GiftCardActivityActivate(Money amountMoney, io.apimatic.core.types.OptionalNullable<String> orderId, io.apimatic.core.types.OptionalNullable<String> lineItemUid, io.apimatic.core.types.OptionalNullable<String> referenceId, io.apimatic.core.types.OptionalNullable<List<String>> buyerPaymentInstrumentIds) Initialization constructor.
	GiftCardActivityActivate(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()
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetBuyerPaymentInstrumentIds() Internal Getter for BuyerPaymentInstrumentIds.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetLineItemUid() Internal Getter for LineItemUid.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetOrderId() Internal Getter for OrderId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReferenceId() Internal Getter for ReferenceId.
GiftCardActivityActivate.Builder	toBuilder() Builds a new GiftCardActivityActivate.Builder object.
String	toString() Converts this GiftCardActivityActivate into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

GiftCardActivityActivate

public GiftCardActivityActivate(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.

GiftCardActivityActivate

protected GiftCardActivityActivate(Money amountMoney,
                                   io.apimatic.core.types.OptionalNullable<String> orderId,
                                   io.apimatic.core.types.OptionalNullable<String> lineItemUid,
                                   io.apimatic.core.types.OptionalNullable<String> referenceId,
                                   io.apimatic.core.types.OptionalNullable<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

internalGetOrderId

protected io.apimatic.core.types.OptionalNullable<String> internalGetOrderId()

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 [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.

Returns:

Returns the Internal String

getOrderId

public String getOrderId()

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 [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.

Returns:

Returns the String

internalGetLineItemUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetLineItemUid()

Internal Getter for LineItemUid. The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase. Applications that use the Square Orders API to process orders must specify the line item UID in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.

Returns:

Returns the Internal String

getLineItemUid

public String getLineItemUid()

Getter for LineItemUid. The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase. Applications that use the Square Orders API to process orders must specify the line item UID in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.

Returns:

Returns the String

internalGetReferenceId

protected io.apimatic.core.types.OptionalNullable<String> internalGetReferenceId()

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.

Returns:

Returns the Internal String

getReferenceId

public String getReferenceId()

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.

Returns:

Returns the String

internalGetBuyerPaymentInstrumentIds

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetBuyerPaymentInstrumentIds()

Internal Getter for BuyerPaymentInstrumentIds. The payment instrument IDs used to process the gift card purchase, 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.

Returns:

Returns the Internal List of String

getBuyerPaymentInstrumentIds

public List<String> getBuyerPaymentInstrumentIds()

Getter for BuyerPaymentInstrumentIds. The payment instrument IDs used to process the gift card purchase, 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.

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 GiftCardActivityActivate into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public GiftCardActivityActivate.Builder toBuilder()

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

Returns:

a new GiftCardActivityActivate.Builder object