com.squareup.square.models

Class AdjustLoyaltyPointsRequest

java.lang.Object

com.squareup.square.models.AdjustLoyaltyPointsRequest

public class AdjustLoyaltyPointsRequest
extends Object

This is a model class for AdjustLoyaltyPointsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	AdjustLoyaltyPointsRequest(String idempotencyKey, LoyaltyEventAdjustPoints adjustPoints, Boolean allowNegativeBalance) Initialization constructor.
protected	AdjustLoyaltyPointsRequest(String idempotencyKey, LoyaltyEventAdjustPoints adjustPoints, io.apimatic.core.types.OptionalNullable<Boolean> allowNegativeBalance) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LoyaltyEventAdjustPoints	getAdjustPoints() Getter for AdjustPoints.
Boolean	getAllowNegativeBalance() Getter for AllowNegativeBalance.
String	getIdempotencyKey() Getter for IdempotencyKey.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAllowNegativeBalance() Internal Getter for AllowNegativeBalance.
AdjustLoyaltyPointsRequest.Builder	toBuilder() Builds a new AdjustLoyaltyPointsRequest.Builder object.
String	toString() Converts this AdjustLoyaltyPointsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdjustLoyaltyPointsRequest

public AdjustLoyaltyPointsRequest(String idempotencyKey,
                                  LoyaltyEventAdjustPoints adjustPoints,
                                  Boolean allowNegativeBalance)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

adjustPoints - LoyaltyEventAdjustPoints value for adjustPoints.

allowNegativeBalance - Boolean value for allowNegativeBalance.

AdjustLoyaltyPointsRequest

protected AdjustLoyaltyPointsRequest(String idempotencyKey,
                                     LoyaltyEventAdjustPoints adjustPoints,
                                     io.apimatic.core.types.OptionalNullable<Boolean> allowNegativeBalance)

Internal initialization constructor.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

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

Returns:

Returns the String

getAdjustPoints

public LoyaltyEventAdjustPoints getAdjustPoints()

Getter for AdjustPoints. Provides metadata when the event `type` is `ADJUST_POINTS`.

Returns:

Returns the LoyaltyEventAdjustPoints

internalGetAllowNegativeBalance

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAllowNegativeBalance()

Internal Getter for AllowNegativeBalance. Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting the specified number of points would result in a negative balance. The default value is `false`.

Returns:

Returns the Internal Boolean

getAllowNegativeBalance

public Boolean getAllowNegativeBalance()

Getter for AllowNegativeBalance. Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting the specified number of points would result in a negative balance. The default value is `false`.

Returns:

Returns the Boolean

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public AdjustLoyaltyPointsRequest.Builder toBuilder()

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

Returns:

a new AdjustLoyaltyPointsRequest.Builder object