com.squareup.square.models

Class LoyaltyEvent

java.lang.Object

com.squareup.square.models.LoyaltyEvent

public class LoyaltyEvent
extends Object

This is a model class for LoyaltyEvent type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description

LoyaltyEvent(String id, String type, String createdAt, String loyaltyAccountId, String source, LoyaltyEventAccumulatePoints accumulatePoints, LoyaltyEventCreateReward createReward, LoyaltyEventRedeemReward redeemReward, LoyaltyEventDeleteReward deleteReward, LoyaltyEventAdjustPoints adjustPoints, String locationId, LoyaltyEventExpirePoints expirePoints, LoyaltyEventOther otherEvent) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LoyaltyEventAccumulatePoints	getAccumulatePoints() Getter for AccumulatePoints.
LoyaltyEventAdjustPoints	getAdjustPoints() Getter for AdjustPoints.
String	getCreatedAt() Getter for CreatedAt.
LoyaltyEventCreateReward	getCreateReward() Getter for CreateReward.
LoyaltyEventDeleteReward	getDeleteReward() Getter for DeleteReward.
LoyaltyEventExpirePoints	getExpirePoints() Getter for ExpirePoints.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getLoyaltyAccountId() Getter for LoyaltyAccountId.
LoyaltyEventOther	getOtherEvent() Getter for OtherEvent.
LoyaltyEventRedeemReward	getRedeemReward() Getter for RedeemReward.
String	getSource() Getter for Source.
String	getType() Getter for Type.
int	hashCode()
LoyaltyEvent.Builder	toBuilder() Builds a new LoyaltyEvent.Builder object.
String	toString() Converts this LoyaltyEvent into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyEvent

public LoyaltyEvent(String id,
                    String type,
                    String createdAt,
                    String loyaltyAccountId,
                    String source,
                    LoyaltyEventAccumulatePoints accumulatePoints,
                    LoyaltyEventCreateReward createReward,
                    LoyaltyEventRedeemReward redeemReward,
                    LoyaltyEventDeleteReward deleteReward,
                    LoyaltyEventAdjustPoints adjustPoints,
                    String locationId,
                    LoyaltyEventExpirePoints expirePoints,
                    LoyaltyEventOther otherEvent)

Initialization constructor.

Parameters:

id - String value for id.

type - String value for type.

createdAt - String value for createdAt.

loyaltyAccountId - String value for loyaltyAccountId.

source - String value for source.

accumulatePoints - LoyaltyEventAccumulatePoints value for accumulatePoints.

createReward - LoyaltyEventCreateReward value for createReward.

redeemReward - LoyaltyEventRedeemReward value for redeemReward.

deleteReward - LoyaltyEventDeleteReward value for deleteReward.

adjustPoints - LoyaltyEventAdjustPoints value for adjustPoints.

locationId - String value for locationId.

expirePoints - LoyaltyEventExpirePoints value for expirePoints.

otherEvent - LoyaltyEventOther value for otherEvent.

Method Detail

getId

public String getId()

Getter for Id. The Square-assigned ID of the loyalty event.

Returns:

Returns the String

getType

public String getType()

Getter for Type. The type of the loyalty event.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp when the event was created, in RFC 3339 format.

Returns:

Returns the String

getAccumulatePoints

public LoyaltyEventAccumulatePoints getAccumulatePoints()

Getter for AccumulatePoints. Provides metadata when the event `type` is `ACCUMULATE_POINTS`.

Returns:

Returns the LoyaltyEventAccumulatePoints

getCreateReward

public LoyaltyEventCreateReward getCreateReward()

Getter for CreateReward. Provides metadata when the event `type` is `CREATE_REWARD`.

Returns:

Returns the LoyaltyEventCreateReward

getRedeemReward

public LoyaltyEventRedeemReward getRedeemReward()

Getter for RedeemReward. Provides metadata when the event `type` is `REDEEM_REWARD`.

Returns:

Returns the LoyaltyEventRedeemReward

getDeleteReward

public LoyaltyEventDeleteReward getDeleteReward()

Getter for DeleteReward. Provides metadata when the event `type` is `DELETE_REWARD`.

Returns:

Returns the LoyaltyEventDeleteReward

getAdjustPoints

public LoyaltyEventAdjustPoints getAdjustPoints()

Getter for AdjustPoints. Provides metadata when the event `type` is `ADJUST_POINTS`.

Returns:

Returns the LoyaltyEventAdjustPoints

getLoyaltyAccountId

public String getLoyaltyAccountId()

Getter for LoyaltyAccountId. The ID of the [loyalty account]($m/LoyaltyAccount) in which the event occurred.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the [location]($m/Location) where the event occurred.

Returns:

Returns the String

getSource

public String getSource()

Getter for Source. Defines whether the event was generated by the Square Point of Sale.

Returns:

Returns the String

getExpirePoints

public LoyaltyEventExpirePoints getExpirePoints()

Getter for ExpirePoints. Provides metadata when the event `type` is `EXPIRE_POINTS`.

Returns:

Returns the LoyaltyEventExpirePoints

getOtherEvent

public LoyaltyEventOther getOtherEvent()

Getter for OtherEvent. Provides metadata when the event `type` is `OTHER`.

Returns:

Returns the LoyaltyEventOther

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyEvent.Builder toBuilder()

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

Returns:

a new LoyaltyEvent.Builder object