com.squareup.square.models

Class LoyaltyPromotionIncentivePointsMultiplierData

java.lang.Object

com.squareup.square.models.LoyaltyPromotionIncentivePointsMultiplierData

public class LoyaltyPromotionIncentivePointsMultiplierData
extends Object

This is a model class for LoyaltyPromotionIncentivePointsMultiplierData type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	LoyaltyPromotionIncentivePointsMultiplierData(Integer pointsMultiplier, String multiplier) Initialization constructor.
protected	LoyaltyPromotionIncentivePointsMultiplierData(io.apimatic.core.types.OptionalNullable<Integer> pointsMultiplier, io.apimatic.core.types.OptionalNullable<String> multiplier) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMultiplier() Getter for Multiplier.
Integer	getPointsMultiplier() Getter for PointsMultiplier.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetMultiplier() Internal Getter for Multiplier.
protected io.apimatic.core.types.OptionalNullable<Integer>	internalGetPointsMultiplier() Internal Getter for PointsMultiplier.
LoyaltyPromotionIncentivePointsMultiplierData.Builder	toBuilder() Builds a new LoyaltyPromotionIncentivePointsMultiplierData.Builder object.
String	toString() Converts this LoyaltyPromotionIncentivePointsMultiplierData into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyPromotionIncentivePointsMultiplierData

public LoyaltyPromotionIncentivePointsMultiplierData(Integer pointsMultiplier,
                                                     String multiplier)

Initialization constructor.

Parameters:

pointsMultiplier - Integer value for pointsMultiplier.

multiplier - String value for multiplier.

LoyaltyPromotionIncentivePointsMultiplierData

protected LoyaltyPromotionIncentivePointsMultiplierData(io.apimatic.core.types.OptionalNullable<Integer> pointsMultiplier,
                                                        io.apimatic.core.types.OptionalNullable<String> multiplier)

Initialization constructor.

Parameters:

pointsMultiplier - Integer value for pointsMultiplier.

multiplier - String value for multiplier.

Method Detail

internalGetPointsMultiplier

protected io.apimatic.core.types.OptionalNullable<Integer> internalGetPointsMultiplier()

Internal Getter for PointsMultiplier. The multiplier used to calculate the number of points earned each time the promotion is triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier` of 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points). DEPRECATED at version 2023-08-16. Replaced by the `multiplier` field. One of the following is required when specifying a points multiplier: - (Recommended) The `multiplier` field. - This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` with the equivalent value.

Returns:

Returns the Internal Integer

getPointsMultiplier

public Integer getPointsMultiplier()

Getter for PointsMultiplier. The multiplier used to calculate the number of points earned each time the promotion is triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier` of 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points). DEPRECATED at version 2023-08-16. Replaced by the `multiplier` field. One of the following is required when specifying a points multiplier: - (Recommended) The `multiplier` field. - This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` with the equivalent value.

Returns:

Returns the Integer

internalGetMultiplier

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

Internal Getter for Multiplier. The multiplier used to calculate the number of points earned each time the promotion is triggered, specified as a string representation of a decimal. Square supports multipliers up to 10x, with three point precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `multiplier` of "1.5", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points). Fractional points are dropped. One of the following is required when specifying a points multiplier: - (Recommended) This `multiplier` field. - The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` with the equivalent value.

Returns:

Returns the Internal String

getMultiplier

public String getMultiplier()

Getter for Multiplier. The multiplier used to calculate the number of points earned each time the promotion is triggered, specified as a string representation of a decimal. Square supports multipliers up to 10x, with three point precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `multiplier` of "1.5", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points). Fractional points are dropped. One of the following is required when specifying a points multiplier: - (Recommended) This `multiplier` field. - The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` with the equivalent value.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyPromotionIncentivePointsMultiplierData.Builder toBuilder()

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

Returns:

a new LoyaltyPromotionIncentivePointsMultiplierData.Builder object