com.squareup.square.models

Class LoyaltyProgramRewardTier

java.lang.Object

com.squareup.square.models.LoyaltyProgramRewardTier

public class LoyaltyProgramRewardTier
extends Object

This is a model class for LoyaltyProgramRewardTier type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LoyaltyProgramRewardTier(int points, CatalogObjectReference pricingRuleReference, String id, String name, LoyaltyProgramRewardDefinition definition, String createdAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCreatedAt() Getter for CreatedAt.
LoyaltyProgramRewardDefinition	getDefinition() Getter for Definition.
String	getId() Getter for Id.
String	getName() Getter for Name.
int	getPoints() Getter for Points.
CatalogObjectReference	getPricingRuleReference() Getter for PricingRuleReference.
int	hashCode()
LoyaltyProgramRewardTier.Builder	toBuilder() Builds a new LoyaltyProgramRewardTier.Builder object.
String	toString() Converts this LoyaltyProgramRewardTier into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyProgramRewardTier

public LoyaltyProgramRewardTier(int points,
                                CatalogObjectReference pricingRuleReference,
                                String id,
                                String name,
                                LoyaltyProgramRewardDefinition definition,
                                String createdAt)

Initialization constructor.

Parameters:

points - int value for points.

pricingRuleReference - CatalogObjectReference value for pricingRuleReference.

id - String value for id.

name - String value for name.

definition - LoyaltyProgramRewardDefinition value for definition.

createdAt - String value for createdAt.

Method Detail

getId

public String getId()

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

Returns:

Returns the String

getPoints

public int getPoints()

Getter for Points. The points exchanged for the reward tier.

Returns:

Returns the int

getName

public String getName()

Getter for Name. The name of the reward tier.

Returns:

Returns the String

getDefinition

public LoyaltyProgramRewardDefinition getDefinition()

Getter for Definition. Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details are now defined using a catalog pricing rule and other catalog objects. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).

Returns:

Returns the LoyaltyProgramRewardDefinition

getCreatedAt

public String getCreatedAt()

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

Returns:

Returns the String

getPricingRuleReference

public CatalogObjectReference getPricingRuleReference()

Getter for PricingRuleReference. A reference to a Catalog object at a specific version. In general this is used as an entry point into a graph of catalog objects, where the objects exist at a specific version.

Returns:

Returns the CatalogObjectReference

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyProgramRewardTier.Builder toBuilder()

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

Returns:

a new LoyaltyProgramRewardTier.Builder object