com.squareup.square.models

Class CreateLoyaltyPromotionRequest

java.lang.Object

com.squareup.square.models.CreateLoyaltyPromotionRequest

public class CreateLoyaltyPromotionRequest
extends Object

This is a model class for CreateLoyaltyPromotionRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateLoyaltyPromotionRequest(LoyaltyPromotion loyaltyPromotion, String idempotencyKey) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIdempotencyKey() Getter for IdempotencyKey.
LoyaltyPromotion	getLoyaltyPromotion() Getter for LoyaltyPromotion.
int	hashCode()
CreateLoyaltyPromotionRequest.Builder	toBuilder() Builds a new CreateLoyaltyPromotionRequest.Builder object.
String	toString() Converts this CreateLoyaltyPromotionRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateLoyaltyPromotionRequest

public CreateLoyaltyPromotionRequest(LoyaltyPromotion loyaltyPromotion,
                                     String idempotencyKey)

Initialization constructor.

Parameters:

loyaltyPromotion - LoyaltyPromotion value for loyaltyPromotion.

idempotencyKey - String value for idempotencyKey.

Method Detail

getLoyaltyPromotion

public LoyaltyPromotion getLoyaltyPromotion()

Getter for LoyaltyPromotion. Represents a promotion for a [loyalty program]($m/LoyaltyProgram). Loyalty promotions enable buyers to earn extra points on top of those earned from the base program. A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.

Returns:

Returns the LoyaltyPromotion

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique identifier for this request, which is used to ensure idempotency. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateLoyaltyPromotionRequest.Builder toBuilder()

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

Returns:

a new CreateLoyaltyPromotionRequest.Builder object