com.squareup.square.models

Class LoyaltyProgramRewardDefinition

java.lang.Object

com.squareup.square.models.LoyaltyProgramRewardDefinition

public class LoyaltyProgramRewardDefinition
extends Object

This is a model class for LoyaltyProgramRewardDefinition type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LoyaltyProgramRewardDefinition(String scope, String discountType, String percentageDiscount, List<String> catalogObjectIds, Money fixedDiscountMoney, Money maxDiscountMoney) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getCatalogObjectIds() Getter for CatalogObjectIds.
String	getDiscountType() Getter for DiscountType.
Money	getFixedDiscountMoney() Getter for FixedDiscountMoney.
Money	getMaxDiscountMoney() Getter for MaxDiscountMoney.
String	getPercentageDiscount() Getter for PercentageDiscount.
String	getScope() Getter for Scope.
int	hashCode()
LoyaltyProgramRewardDefinition.Builder	toBuilder() Builds a new LoyaltyProgramRewardDefinition.Builder object.
String	toString() Converts this LoyaltyProgramRewardDefinition into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyProgramRewardDefinition

public LoyaltyProgramRewardDefinition(String scope,
                                      String discountType,
                                      String percentageDiscount,
                                      List<String> catalogObjectIds,
                                      Money fixedDiscountMoney,
                                      Money maxDiscountMoney)

Initialization constructor.

Parameters:

scope - String value for scope.

discountType - String value for discountType.

percentageDiscount - String value for percentageDiscount.

catalogObjectIds - List of String value for catalogObjectIds.

fixedDiscountMoney - Money value for fixedDiscountMoney.

maxDiscountMoney - Money value for maxDiscountMoney.

Method Detail

getScope

public String getScope()

Getter for Scope. Indicates the scope of the reward tier. 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 String

getDiscountType

public String getDiscountType()

Getter for DiscountType. The type of discount the reward tier offers. 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 String

getPercentageDiscount

public String getPercentageDiscount()

Getter for PercentageDiscount. The fixed percentage of the discount. Present if `discount_type` is `FIXED_PERCENTAGE`. For example, a 7.25% off discount will be represented as "7.25". DEPRECATED at version 2020-12-16. You can find this information in the `discount_data.percentage` field of the `DISCOUNT` catalog object referenced by the pricing rule.

Returns:

Returns the String

getCatalogObjectIds

public List<String> getCatalogObjectIds()

Getter for CatalogObjectIds. The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the `type` field. DEPRECATED at version 2020-12-16. You can find this information in the `product_set_data.product_ids_any` field of the `PRODUCT_SET` catalog object referenced by the pricing rule.

Returns:

Returns the List of String

getFixedDiscountMoney

public Money getFixedDiscountMoney()

Getter for FixedDiscountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getMaxDiscountMoney

public Money getMaxDiscountMoney()

Getter for MaxDiscountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyProgramRewardDefinition.Builder toBuilder()

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

Returns:

a new LoyaltyProgramRewardDefinition.Builder object