com.squareup.square.models

Class TipSettings

java.lang.Object

com.squareup.square.models.TipSettings

public class TipSettings
extends Object

This is a model class for TipSettings type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	TipSettings(Boolean allowTipping, Boolean separateTipScreen, Boolean customTipField, List<Integer> tipPercentages, Boolean smartTipping) Initialization constructor.
protected	TipSettings(io.apimatic.core.types.OptionalNullable<Boolean> allowTipping, io.apimatic.core.types.OptionalNullable<Boolean> separateTipScreen, io.apimatic.core.types.OptionalNullable<Boolean> customTipField, io.apimatic.core.types.OptionalNullable<List<Integer>> tipPercentages, io.apimatic.core.types.OptionalNullable<Boolean> smartTipping) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowTipping() Getter for AllowTipping.
Boolean	getCustomTipField() Getter for CustomTipField.
Boolean	getSeparateTipScreen() Getter for SeparateTipScreen.
Boolean	getSmartTipping() Getter for SmartTipping.
List<Integer>	getTipPercentages() Getter for TipPercentages.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAllowTipping() Internal Getter for AllowTipping.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetCustomTipField() Internal Getter for CustomTipField.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetSeparateTipScreen() Internal Getter for SeparateTipScreen.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetSmartTipping() Internal Getter for SmartTipping.
protected io.apimatic.core.types.OptionalNullable<List<Integer>>	internalGetTipPercentages() Internal Getter for TipPercentages.
TipSettings.Builder	toBuilder() Builds a new TipSettings.Builder object.
String	toString() Converts this TipSettings into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

TipSettings

public TipSettings(Boolean allowTipping,
                   Boolean separateTipScreen,
                   Boolean customTipField,
                   List<Integer> tipPercentages,
                   Boolean smartTipping)

Initialization constructor.

Parameters:

allowTipping - Boolean value for allowTipping.

separateTipScreen - Boolean value for separateTipScreen.

customTipField - Boolean value for customTipField.

tipPercentages - List of Integer value for tipPercentages.

smartTipping - Boolean value for smartTipping.

TipSettings

protected TipSettings(io.apimatic.core.types.OptionalNullable<Boolean> allowTipping,
                      io.apimatic.core.types.OptionalNullable<Boolean> separateTipScreen,
                      io.apimatic.core.types.OptionalNullable<Boolean> customTipField,
                      io.apimatic.core.types.OptionalNullable<List<Integer>> tipPercentages,
                      io.apimatic.core.types.OptionalNullable<Boolean> smartTipping)

Initialization constructor.

Parameters:

allowTipping - Boolean value for allowTipping.

separateTipScreen - Boolean value for separateTipScreen.

customTipField - Boolean value for customTipField.

tipPercentages - List of Integer value for tipPercentages.

smartTipping - Boolean value for smartTipping.

Method Detail

internalGetAllowTipping

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

Internal Getter for AllowTipping. Indicates whether tipping is enabled for this checkout. Defaults to false.

Returns:

Returns the Internal Boolean

getAllowTipping

public Boolean getAllowTipping()

Getter for AllowTipping. Indicates whether tipping is enabled for this checkout. Defaults to false.

Returns:

Returns the Boolean

internalGetSeparateTipScreen

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

Internal Getter for SeparateTipScreen. Indicates whether tip options should be presented on the screen before presenting the signature screen during card payment. Defaults to false.

Returns:

Returns the Internal Boolean

getSeparateTipScreen

public Boolean getSeparateTipScreen()

Getter for SeparateTipScreen. Indicates whether tip options should be presented on the screen before presenting the signature screen during card payment. Defaults to false.

Returns:

Returns the Boolean

internalGetCustomTipField

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

Internal Getter for CustomTipField. Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false.

Returns:

Returns the Internal Boolean

getCustomTipField

public Boolean getCustomTipField()

Getter for CustomTipField. Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false.

Returns:

Returns the Boolean

internalGetTipPercentages

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

Internal Getter for TipPercentages. A list of tip percentages that should be presented during the checkout flow, specified as up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25.

Returns:

Returns the Internal List of Integer

getTipPercentages

public List<Integer> getTipPercentages()

Getter for TipPercentages. A list of tip percentages that should be presented during the checkout flow, specified as up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25.

Returns:

Returns the List of Integer

internalGetSmartTipping

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

Internal Getter for SmartTipping. Enables the "Smart Tip Amounts" behavior. Exact tipping options depend on the region in which the Square seller is active. For payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00. For payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%. If set to true, the `tip_percentages` settings is ignored. Defaults to false. To learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app).

Returns:

Returns the Internal Boolean

getSmartTipping

public Boolean getSmartTipping()

Getter for SmartTipping. Enables the "Smart Tip Amounts" behavior. Exact tipping options depend on the region in which the Square seller is active. For payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00. For payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%. If set to true, the `tip_percentages` settings is ignored. Defaults to false. To learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app).

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public TipSettings.Builder toBuilder()

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

Returns:

a new TipSettings.Builder object