com.squareup.square.models

Class LoyaltyAccount

java.lang.Object

com.squareup.square.models.LoyaltyAccount

public class LoyaltyAccount
extends Object

This is a model class for LoyaltyAccount type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LoyaltyAccount(String programId, String id, Integer balance, Integer lifetimePoints, String customerId, String enrolledAt, String createdAt, String updatedAt, LoyaltyAccountMapping mapping, List<LoyaltyAccountExpiringPointDeadline> expiringPointDeadlines) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Integer	getBalance() Getter for Balance.
String	getCreatedAt() Getter for CreatedAt.
String	getCustomerId() Getter for CustomerId.
String	getEnrolledAt() Getter for EnrolledAt.
List<LoyaltyAccountExpiringPointDeadline>	getExpiringPointDeadlines() Getter for ExpiringPointDeadlines.
String	getId() Getter for Id.
Integer	getLifetimePoints() Getter for LifetimePoints.
LoyaltyAccountMapping	getMapping() Getter for Mapping.
String	getProgramId() Getter for ProgramId.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
LoyaltyAccount.Builder	toBuilder() Builds a new LoyaltyAccount.Builder object.
String	toString() Converts this LoyaltyAccount into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyAccount

public LoyaltyAccount(String programId,
                      String id,
                      Integer balance,
                      Integer lifetimePoints,
                      String customerId,
                      String enrolledAt,
                      String createdAt,
                      String updatedAt,
                      LoyaltyAccountMapping mapping,
                      List<LoyaltyAccountExpiringPointDeadline> expiringPointDeadlines)

Initialization constructor.

Parameters:

programId - String value for programId.

id - String value for id.

balance - Integer value for balance.

lifetimePoints - Integer value for lifetimePoints.

customerId - String value for customerId.

enrolledAt - String value for enrolledAt.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

mapping - LoyaltyAccountMapping value for mapping.

expiringPointDeadlines - List of LoyaltyAccountExpiringPointDeadline value for expiringPointDeadlines.

Method Detail

getId

public String getId()

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

Returns:

Returns the String

getProgramId

public String getProgramId()

Getter for ProgramId. The Square-assigned ID of the [loyalty program]($m/LoyaltyProgram) to which the account belongs.

Returns:

Returns the String

getBalance

public Integer getBalance()

Getter for Balance. The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field. Your application should be able to handle loyalty accounts that have a negative point balance (`balance` is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange.

Returns:

Returns the Integer

getLifetimePoints

public Integer getLifetimePoints()

Getter for LifetimePoints. The total points accrued during the lifetime of the account.

Returns:

Returns the Integer

getCustomerId

public String getCustomerId()

Getter for CustomerId. The Square-assigned ID of the [customer]($m/Customer) that is associated with the account.

Returns:

Returns the String

getEnrolledAt

public String getEnrolledAt()

Getter for EnrolledAt. The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the **Enrolled On** or **Member Since** date in first-party Square products. If this field is not set in a `CreateLoyaltyAccount` request, Square populates it after the buyer's first action on their account (when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service in Square Point of Sale. This field is typically specified in a `CreateLoyaltyAccount` request when creating a loyalty account for a buyer who already interacted with their account. For example, you would set this field when migrating accounts from an external system. The timestamp in the request can represent a current or previous date and time, but it cannot be set for the future.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

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

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

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

Returns:

Returns the String

getMapping

public LoyaltyAccountMapping getMapping()

Getter for Mapping. Represents the mapping that associates a loyalty account with a buyer. Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see [Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview).

Returns:

Returns the LoyaltyAccountMapping

getExpiringPointDeadlines

public List<LoyaltyAccountExpiringPointDeadline> getExpiringPointDeadlines()

Getter for ExpiringPointDeadlines. The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. The total number of points in this field equals the number of points in the `balance` field.

Returns:

Returns the List of LoyaltyAccountExpiringPointDeadline

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyAccount.Builder toBuilder()

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

Returns:

a new LoyaltyAccount.Builder object