com.squareup.square.models

Class LoyaltyPromotion

java.lang.Object

com.squareup.square.models.LoyaltyPromotion

public class LoyaltyPromotion
extends Object

This is a model class for LoyaltyPromotion type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	LoyaltyPromotion(String name, LoyaltyPromotionIncentive incentive, LoyaltyPromotionAvailableTimeData availableTime, String id, LoyaltyPromotionTriggerLimit triggerLimit, String status, String createdAt, String canceledAt, String updatedAt, String loyaltyProgramId, Money minimumSpendAmountMoney, List<String> qualifyingItemVariationIds, List<String> qualifyingCategoryIds) Initialization constructor.
protected	LoyaltyPromotion(String name, LoyaltyPromotionIncentive incentive, LoyaltyPromotionAvailableTimeData availableTime, String id, LoyaltyPromotionTriggerLimit triggerLimit, String status, String createdAt, String canceledAt, String updatedAt, String loyaltyProgramId, Money minimumSpendAmountMoney, io.apimatic.core.types.OptionalNullable<List<String>> qualifyingItemVariationIds, io.apimatic.core.types.OptionalNullable<List<String>> qualifyingCategoryIds) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LoyaltyPromotionAvailableTimeData	getAvailableTime() Getter for AvailableTime.
String	getCanceledAt() Getter for CanceledAt.
String	getCreatedAt() Getter for CreatedAt.
String	getId() Getter for Id.
LoyaltyPromotionIncentive	getIncentive() Getter for Incentive.
String	getLoyaltyProgramId() Getter for LoyaltyProgramId.
Money	getMinimumSpendAmountMoney() Getter for MinimumSpendAmountMoney.
String	getName() Getter for Name.
List<String>	getQualifyingCategoryIds() Getter for QualifyingCategoryIds.
List<String>	getQualifyingItemVariationIds() Getter for QualifyingItemVariationIds.
String	getStatus() Getter for Status.
LoyaltyPromotionTriggerLimit	getTriggerLimit() Getter for TriggerLimit.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetQualifyingCategoryIds() Internal Getter for QualifyingCategoryIds.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetQualifyingItemVariationIds() Internal Getter for QualifyingItemVariationIds.
LoyaltyPromotion.Builder	toBuilder() Builds a new LoyaltyPromotion.Builder object.
String	toString() Converts this LoyaltyPromotion into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyPromotion

public LoyaltyPromotion(String name,
                        LoyaltyPromotionIncentive incentive,
                        LoyaltyPromotionAvailableTimeData availableTime,
                        String id,
                        LoyaltyPromotionTriggerLimit triggerLimit,
                        String status,
                        String createdAt,
                        String canceledAt,
                        String updatedAt,
                        String loyaltyProgramId,
                        Money minimumSpendAmountMoney,
                        List<String> qualifyingItemVariationIds,
                        List<String> qualifyingCategoryIds)

Initialization constructor.

Parameters:

name - String value for name.

incentive - LoyaltyPromotionIncentive value for incentive.

availableTime - LoyaltyPromotionAvailableTimeData value for availableTime.

id - String value for id.

triggerLimit - LoyaltyPromotionTriggerLimit value for triggerLimit.

status - String value for status.

createdAt - String value for createdAt.

canceledAt - String value for canceledAt.

updatedAt - String value for updatedAt.

loyaltyProgramId - String value for loyaltyProgramId.

minimumSpendAmountMoney - Money value for minimumSpendAmountMoney.

qualifyingItemVariationIds - List of String value for qualifyingItemVariationIds.

qualifyingCategoryIds - List of String value for qualifyingCategoryIds.

LoyaltyPromotion

protected LoyaltyPromotion(String name,
                           LoyaltyPromotionIncentive incentive,
                           LoyaltyPromotionAvailableTimeData availableTime,
                           String id,
                           LoyaltyPromotionTriggerLimit triggerLimit,
                           String status,
                           String createdAt,
                           String canceledAt,
                           String updatedAt,
                           String loyaltyProgramId,
                           Money minimumSpendAmountMoney,
                           io.apimatic.core.types.OptionalNullable<List<String>> qualifyingItemVariationIds,
                           io.apimatic.core.types.OptionalNullable<List<String>> qualifyingCategoryIds)

Internal initialization constructor.

Method Detail

getId

public String getId()

Getter for Id. The Square-assigned ID of the promotion.

Returns:

Returns the String

getName

public String getName()

Getter for Name. The name of the promotion.

Returns:

Returns the String

getIncentive

public LoyaltyPromotionIncentive getIncentive()

Getter for Incentive. Represents how points for a [loyalty promotion]($m/LoyaltyPromotion) are calculated, either by multiplying the points earned from the base program or by adding a specified number of points to the points earned from the base program.

Returns:

Returns the LoyaltyPromotionIncentive

getAvailableTime

public LoyaltyPromotionAvailableTimeData getAvailableTime()

Getter for AvailableTime. Represents scheduling information that determines when purchases can qualify to earn points from a [loyalty promotion]($m/LoyaltyPromotion).

Returns:

Returns the LoyaltyPromotionAvailableTimeData

getTriggerLimit

public LoyaltyPromotionTriggerLimit getTriggerLimit()

Getter for TriggerLimit. Represents the number of times a buyer can earn points during a [loyalty promotion]($m/LoyaltyPromotion). If this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during the time that the promotion is available. A purchase that is disqualified from earning points because of this limit might qualify for another active promotion.

Returns:

Returns the LoyaltyPromotionTriggerLimit

getStatus

public String getStatus()

Getter for Status. Indicates the status of a [loyalty promotion]($m/LoyaltyPromotion).

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp of when the promotion was created, in RFC 3339 format.

Returns:

Returns the String

getCanceledAt

public String getCanceledAt()

Getter for CanceledAt. The timestamp of when the promotion was canceled, in RFC 3339 format.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

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

Returns:

Returns the String

getLoyaltyProgramId

public String getLoyaltyProgramId()

Getter for LoyaltyProgramId. The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion.

Returns:

Returns the String

getMinimumSpendAmountMoney

public Money getMinimumSpendAmountMoney()

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

internalGetQualifyingItemVariationIds

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

Internal Getter for QualifyingItemVariationIds. The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified, the purchase must include at least one of these items to qualify for the promotion. This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. You can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both.

Returns:

Returns the Internal List of String

getQualifyingItemVariationIds

public List<String> getQualifyingItemVariationIds()

Getter for QualifyingItemVariationIds. The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified, the purchase must include at least one of these items to qualify for the promotion. This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. You can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both.

Returns:

Returns the List of String

internalGetQualifyingCategoryIds

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

Internal Getter for QualifyingCategoryIds. The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified, the purchase must include at least one item from one of these categories to qualify for the promotion. This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. You can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both.

Returns:

Returns the Internal List of String

getQualifyingCategoryIds

public List<String> getQualifyingCategoryIds()

Getter for QualifyingCategoryIds. The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified, the purchase must include at least one item from one of these categories to qualify for the promotion. This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded. You can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both.

Returns:

Returns the List of 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 LoyaltyPromotion into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyPromotion.Builder toBuilder()

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

Returns:

a new LoyaltyPromotion.Builder object