com.squareup.square.models

Class CreateLoyaltyRewardRequest

java.lang.Object

com.squareup.square.models.CreateLoyaltyRewardRequest

public class CreateLoyaltyRewardRequest
extends Object

This is a model class for CreateLoyaltyRewardRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateLoyaltyRewardRequest(LoyaltyReward reward, String idempotencyKey) Initialization constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateLoyaltyRewardRequest

public CreateLoyaltyRewardRequest(LoyaltyReward reward,
                                  String idempotencyKey)

Initialization constructor.

Parameters:

reward - LoyaltyReward value for reward.

idempotencyKey - String value for idempotencyKey.

Method Detail

getReward

public LoyaltyReward getReward()

Getter for Reward. Represents a contract to redeem loyalty points for a [reward tier]($m/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).

Returns:

Returns the LoyaltyReward

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique string that identifies this `CreateLoyaltyReward` request. Keys can be any valid string, but must be unique for every request.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateLoyaltyRewardRequest.Builder toBuilder()

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

Returns:

a new CreateLoyaltyRewardRequest.Builder object