com.squareup.square.models

Class LoyaltyProgramAccrualRuleSpendData

java.lang.Object

com.squareup.square.models.LoyaltyProgramAccrualRuleSpendData

public class LoyaltyProgramAccrualRuleSpendData
extends Object

This is a model class for LoyaltyProgramAccrualRuleSpendData type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LoyaltyProgramAccrualRuleSpendData(Money amountMoney, String taxMode, List<String> excludedCategoryIds, List<String> excludedItemVariationIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
List<String>	getExcludedCategoryIds() Getter for ExcludedCategoryIds.
List<String>	getExcludedItemVariationIds() Getter for ExcludedItemVariationIds.
String	getTaxMode() Getter for TaxMode.
int	hashCode()
LoyaltyProgramAccrualRuleSpendData.Builder	toBuilder() Builds a new LoyaltyProgramAccrualRuleSpendData.Builder object.
String	toString() Converts this LoyaltyProgramAccrualRuleSpendData into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyProgramAccrualRuleSpendData

public LoyaltyProgramAccrualRuleSpendData(Money amountMoney,
                                          String taxMode,
                                          List<String> excludedCategoryIds,
                                          List<String> excludedItemVariationIds)

Initialization constructor.

Parameters:

amountMoney - Money value for amountMoney.

taxMode - String value for taxMode.

excludedCategoryIds - List of String value for excludedCategoryIds.

excludedItemVariationIds - List of String value for excludedItemVariationIds.

Method Detail

getAmountMoney

public Money getAmountMoney()

Getter for AmountMoney. 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

getExcludedCategoryIds

public List<String> getExcludedCategoryIds()

Getter for ExcludedCategoryIds. The IDs of any `CATEGORY` catalog objects that are excluded from points accrual. You can use the [BatchRetrieveCatalogObjects]($e/Catalog/BatchRetrieveCatalogObjects) endpoint to retrieve information about the excluded categories.

Returns:

Returns the List of String

getExcludedItemVariationIds

public List<String> getExcludedItemVariationIds()

Getter for ExcludedItemVariationIds. The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual. You can use the [BatchRetrieveCatalogObjects]($e/Catalog/BatchRetrieveCatalogObjects) endpoint to retrieve information about the excluded item variations.

Returns:

Returns the List of String

getTaxMode

public String getTaxMode()

Getter for TaxMode. Indicates how taxes should be treated when calculating the purchase amount used for loyalty points accrual. This setting applies only to `SPEND` accrual rules or `VISIT` accrual rules that have a minimum spend requirement.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyProgramAccrualRuleSpendData.Builder toBuilder()

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

Returns:

a new LoyaltyProgramAccrualRuleSpendData.Builder object