com.squareup.square.models

Class LoyaltyProgram

java.lang.Object

com.squareup.square.models.LoyaltyProgram

public class LoyaltyProgram
extends Object

This is a model class for LoyaltyProgram type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	LoyaltyProgram(String id, String status, List<LoyaltyProgramRewardTier> rewardTiers, LoyaltyProgramExpirationPolicy expirationPolicy, LoyaltyProgramTerminology terminology, List<String> locationIds, String createdAt, String updatedAt, List<LoyaltyProgramAccrualRule> accrualRules) Initialization constructor.
protected	LoyaltyProgram(String id, String status, io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramRewardTier>> rewardTiers, LoyaltyProgramExpirationPolicy expirationPolicy, LoyaltyProgramTerminology terminology, io.apimatic.core.types.OptionalNullable<List<String>> locationIds, String createdAt, String updatedAt, io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramAccrualRule>> accrualRules) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<LoyaltyProgramAccrualRule>	getAccrualRules() Getter for AccrualRules.
String	getCreatedAt() Getter for CreatedAt.
LoyaltyProgramExpirationPolicy	getExpirationPolicy() Getter for ExpirationPolicy.
String	getId() Getter for Id.
List<String>	getLocationIds() Getter for LocationIds.
List<LoyaltyProgramRewardTier>	getRewardTiers() Getter for RewardTiers.
String	getStatus() Getter for Status.
LoyaltyProgramTerminology	getTerminology() Getter for Terminology.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramAccrualRule>>	internalGetAccrualRules() Internal Getter for AccrualRules.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetLocationIds() Internal Getter for LocationIds.
protected io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramRewardTier>>	internalGetRewardTiers() Internal Getter for RewardTiers.
LoyaltyProgram.Builder	toBuilder() Builds a new LoyaltyProgram.Builder object.
String	toString() Converts this LoyaltyProgram into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyProgram

public LoyaltyProgram(String id,
                      String status,
                      List<LoyaltyProgramRewardTier> rewardTiers,
                      LoyaltyProgramExpirationPolicy expirationPolicy,
                      LoyaltyProgramTerminology terminology,
                      List<String> locationIds,
                      String createdAt,
                      String updatedAt,
                      List<LoyaltyProgramAccrualRule> accrualRules)

Initialization constructor.

Parameters:

id - String value for id.

status - String value for status.

rewardTiers - List of LoyaltyProgramRewardTier value for rewardTiers.

expirationPolicy - LoyaltyProgramExpirationPolicy value for expirationPolicy.

terminology - LoyaltyProgramTerminology value for terminology.

locationIds - List of String value for locationIds.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

accrualRules - List of LoyaltyProgramAccrualRule value for accrualRules.

LoyaltyProgram

protected LoyaltyProgram(String id,
                         String status,
                         io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramRewardTier>> rewardTiers,
                         LoyaltyProgramExpirationPolicy expirationPolicy,
                         LoyaltyProgramTerminology terminology,
                         io.apimatic.core.types.OptionalNullable<List<String>> locationIds,
                         String createdAt,
                         String updatedAt,
                         io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramAccrualRule>> accrualRules)

Initialization constructor.

Parameters:

id - String value for id.

status - String value for status.

rewardTiers - List of LoyaltyProgramRewardTier value for rewardTiers.

expirationPolicy - LoyaltyProgramExpirationPolicy value for expirationPolicy.

terminology - LoyaltyProgramTerminology value for terminology.

locationIds - List of String value for locationIds.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

accrualRules - List of LoyaltyProgramAccrualRule value for accrualRules.

Method Detail

getId

public String getId()

Getter for Id. The Square-assigned ID of the loyalty program. Updates to the loyalty program do not modify the identifier.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. Indicates whether the program is currently active.

Returns:

Returns the String

internalGetRewardTiers

protected io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramRewardTier>> internalGetRewardTiers()

Internal Getter for RewardTiers. The list of rewards for buyers, sorted by ascending points.

Returns:

Returns the Internal List of LoyaltyProgramRewardTier

getRewardTiers

public List<LoyaltyProgramRewardTier> getRewardTiers()

Getter for RewardTiers. The list of rewards for buyers, sorted by ascending points.

Returns:

Returns the List of LoyaltyProgramRewardTier

getExpirationPolicy

public LoyaltyProgramExpirationPolicy getExpirationPolicy()

Getter for ExpirationPolicy. Describes when the loyalty program expires.

Returns:

Returns the LoyaltyProgramExpirationPolicy

getTerminology

public LoyaltyProgramTerminology getTerminology()

Getter for Terminology. Represents the naming used for loyalty points.

Returns:

Returns the LoyaltyProgramTerminology

internalGetLocationIds

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

Internal Getter for LocationIds. The [locations](entity:Location) at which the program is active.

Returns:

Returns the Internal List of String

getLocationIds

public List<String> getLocationIds()

Getter for LocationIds. The [locations](entity:Location) at which the program is active.

Returns:

Returns the List of String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp when the program 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

internalGetAccrualRules

protected io.apimatic.core.types.OptionalNullable<List<LoyaltyProgramAccrualRule>> internalGetAccrualRules()

Internal Getter for AccrualRules. Defines how buyers can earn loyalty points from the base loyalty program. To check for associated [loyalty promotions](entity:LoyaltyPromotion) that enable buyers to earn extra points, call [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions).

Returns:

Returns the Internal List of LoyaltyProgramAccrualRule

getAccrualRules

public List<LoyaltyProgramAccrualRule> getAccrualRules()

Getter for AccrualRules. Defines how buyers can earn loyalty points from the base loyalty program. To check for associated [loyalty promotions](entity:LoyaltyPromotion) that enable buyers to earn extra points, call [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions).

Returns:

Returns the List of LoyaltyProgramAccrualRule

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyProgram.Builder toBuilder()

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

Returns:

a new LoyaltyProgram.Builder object