com.squareup.square.models

Class LoyaltyReward

java.lang.Object

com.squareup.square.models.LoyaltyReward

public class LoyaltyReward
extends Object

This is a model class for LoyaltyReward type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LoyaltyReward(String loyaltyAccountId, String rewardTierId, String id, String status, Integer points, String orderId, String createdAt, String updatedAt, String redeemedAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCreatedAt() Getter for CreatedAt.
String	getId() Getter for Id.
String	getLoyaltyAccountId() Getter for LoyaltyAccountId.
String	getOrderId() Getter for OrderId.
Integer	getPoints() Getter for Points.
String	getRedeemedAt() Getter for RedeemedAt.
String	getRewardTierId() Getter for RewardTierId.
String	getStatus() Getter for Status.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
LoyaltyReward.Builder	toBuilder() Builds a new LoyaltyReward.Builder object.
String	toString() Converts this LoyaltyReward into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyReward

public LoyaltyReward(String loyaltyAccountId,
                     String rewardTierId,
                     String id,
                     String status,
                     Integer points,
                     String orderId,
                     String createdAt,
                     String updatedAt,
                     String redeemedAt)

Initialization constructor.

Parameters:

loyaltyAccountId - String value for loyaltyAccountId.

rewardTierId - String value for rewardTierId.

id - String value for id.

status - String value for status.

points - Integer value for points.

orderId - String value for orderId.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

redeemedAt - String value for redeemedAt.

Method Detail

getId

public String getId()

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

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. The status of the loyalty reward.

Returns:

Returns the String

getLoyaltyAccountId

public String getLoyaltyAccountId()

Getter for LoyaltyAccountId. The Square-assigned ID of the [loyalty account]($m/LoyaltyAccount) to which the reward belongs.

Returns:

Returns the String

getRewardTierId

public String getRewardTierId()

Getter for RewardTierId. The Square-assigned ID of the [reward tier]($m/LoyaltyProgramRewardTier) used to create the reward.

Returns:

Returns the String

getPoints

public Integer getPoints()

Getter for Points. The number of loyalty points used for the reward.

Returns:

Returns the Integer

getOrderId

public String getOrderId()

Getter for OrderId. The Square-assigned ID of the [order]($m/Order) to which the reward is attached.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

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

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The timestamp when the reward was last updated, in RFC 3339 format.

Returns:

Returns the String

getRedeemedAt

public String getRedeemedAt()

Getter for RedeemedAt. The timestamp when the reward was redeemed, in RFC 3339 format.

Returns:

Returns the 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 LoyaltyReward into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyReward.Builder toBuilder()

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

Returns:

a new LoyaltyReward.Builder object