com.squareup.square.models

Class CalculateLoyaltyPointsRequest

java.lang.Object

com.squareup.square.models.CalculateLoyaltyPointsRequest

public class CalculateLoyaltyPointsRequest
extends Object

This is a model class for CalculateLoyaltyPointsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CalculateLoyaltyPointsRequest(io.apimatic.core.types.OptionalNullable<String> orderId, Money transactionAmountMoney, io.apimatic.core.types.OptionalNullable<String> loyaltyAccountId) Internal initialization constructor.
	CalculateLoyaltyPointsRequest(String orderId, Money transactionAmountMoney, String loyaltyAccountId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLoyaltyAccountId() Getter for LoyaltyAccountId.
String	getOrderId() Getter for OrderId.
Money	getTransactionAmountMoney() Getter for TransactionAmountMoney.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetLoyaltyAccountId() Internal Getter for LoyaltyAccountId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetOrderId() Internal Getter for OrderId.
CalculateLoyaltyPointsRequest.Builder	toBuilder() Builds a new CalculateLoyaltyPointsRequest.Builder object.
String	toString() Converts this CalculateLoyaltyPointsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalculateLoyaltyPointsRequest

public CalculateLoyaltyPointsRequest(String orderId,
                                     Money transactionAmountMoney,
                                     String loyaltyAccountId)

Initialization constructor.

Parameters:

orderId - String value for orderId.

transactionAmountMoney - Money value for transactionAmountMoney.

loyaltyAccountId - String value for loyaltyAccountId.

CalculateLoyaltyPointsRequest

protected CalculateLoyaltyPointsRequest(io.apimatic.core.types.OptionalNullable<String> orderId,
                                        Money transactionAmountMoney,
                                        io.apimatic.core.types.OptionalNullable<String> loyaltyAccountId)

Internal initialization constructor.

Method Detail

internalGetOrderId

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

Internal Getter for OrderId. The [order](entity:Order) ID for which to calculate the points. Specify this field if your application uses the Orders API to process orders. Otherwise, specify the `transaction_amount_money`.

Returns:

Returns the Internal String

getOrderId

public String getOrderId()

Getter for OrderId. The [order](entity:Order) ID for which to calculate the points. Specify this field if your application uses the Orders API to process orders. Otherwise, specify the `transaction_amount_money`.

Returns:

Returns the String

getTransactionAmountMoney

public Money getTransactionAmountMoney()

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

internalGetLoyaltyAccountId

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

Internal Getter for LoyaltyAccountId. The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field if your application uses the Orders API to process orders. If specified, the `promotion_points` field in the response shows the number of points the buyer would earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's `trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. If not specified, the `promotion_points` field shows the number of points the purchase qualifies for regardless of the trigger limit.

Returns:

Returns the Internal String

getLoyaltyAccountId

public String getLoyaltyAccountId()

Getter for LoyaltyAccountId. The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field if your application uses the Orders API to process orders. If specified, the `promotion_points` field in the response shows the number of points the buyer would earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's `trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. If not specified, the `promotion_points` field shows the number of points the purchase qualifies for regardless of the trigger limit.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CalculateLoyaltyPointsRequest.Builder toBuilder()

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

Returns:

a new CalculateLoyaltyPointsRequest.Builder object