com.squareup.square.models

Class LoyaltyEventRedeemReward

java.lang.Object

com.squareup.square.models.LoyaltyEventRedeemReward

public class LoyaltyEventRedeemReward
extends Object

This is a model class for LoyaltyEventRedeemReward type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LoyaltyEventRedeemReward(String loyaltyProgramId, String rewardId, String orderId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLoyaltyProgramId() Getter for LoyaltyProgramId.
String	getOrderId() Getter for OrderId.
String	getRewardId() Getter for RewardId.
int	hashCode()
LoyaltyEventRedeemReward.Builder	toBuilder() Builds a new LoyaltyEventRedeemReward.Builder object.
String	toString() Converts this LoyaltyEventRedeemReward into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyEventRedeemReward

public LoyaltyEventRedeemReward(String loyaltyProgramId,
                                String rewardId,
                                String orderId)

Initialization constructor.

Parameters:

loyaltyProgramId - String value for loyaltyProgramId.

rewardId - String value for rewardId.

orderId - String value for orderId.

Method Detail

getLoyaltyProgramId

public String getLoyaltyProgramId()

Getter for LoyaltyProgramId. The ID of the [loyalty program]($m/LoyaltyProgram).

Returns:

Returns the String

getRewardId

public String getRewardId()

Getter for RewardId. The ID of the redeemed [loyalty reward]($m/LoyaltyReward). This field is returned only if the event source is `LOYALTY_API`.

Returns:

Returns the String

getOrderId

public String getOrderId()

Getter for OrderId. The ID of the [order]($m/Order) that redeemed the reward. This field is returned only if the Orders API is used to process orders.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyEventRedeemReward.Builder toBuilder()

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

Returns:

a new LoyaltyEventRedeemReward.Builder object