com.squareup.square.models

Class TerminalAction

java.lang.Object

com.squareup.square.models.TerminalAction

public class TerminalAction
extends Object

This is a model class for TerminalAction type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TerminalAction(String id, io.apimatic.core.types.OptionalNullable<String> deviceId, io.apimatic.core.types.OptionalNullable<String> deadlineDuration, String status, String cancelReason, String createdAt, String updatedAt, String appId, String type, QrCodeOptions qrCodeOptions, SaveCardOptions saveCardOptions, SignatureOptions signatureOptions, ConfirmationOptions confirmationOptions, ReceiptOptions receiptOptions, DataCollectionOptions dataCollectionOptions, SelectOptions selectOptions, DeviceMetadata deviceMetadata, io.apimatic.core.types.OptionalNullable<Boolean> awaitNextAction, io.apimatic.core.types.OptionalNullable<String> awaitNextActionDuration) Internal initialization constructor.
	TerminalAction(String id, String deviceId, String deadlineDuration, String status, String cancelReason, String createdAt, String updatedAt, String appId, String type, QrCodeOptions qrCodeOptions, SaveCardOptions saveCardOptions, SignatureOptions signatureOptions, ConfirmationOptions confirmationOptions, ReceiptOptions receiptOptions, DataCollectionOptions dataCollectionOptions, SelectOptions selectOptions, DeviceMetadata deviceMetadata, Boolean awaitNextAction, String awaitNextActionDuration) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAppId() Getter for AppId.
Boolean	getAwaitNextAction() Getter for AwaitNextAction.
String	getAwaitNextActionDuration() Getter for AwaitNextActionDuration.
String	getCancelReason() Getter for CancelReason.
ConfirmationOptions	getConfirmationOptions() Getter for ConfirmationOptions.
String	getCreatedAt() Getter for CreatedAt.
DataCollectionOptions	getDataCollectionOptions() Getter for DataCollectionOptions.
String	getDeadlineDuration() Getter for DeadlineDuration.
String	getDeviceId() Getter for DeviceId.
DeviceMetadata	getDeviceMetadata() Getter for DeviceMetadata.
String	getId() Getter for Id.
QrCodeOptions	getQrCodeOptions() Getter for QrCodeOptions.
ReceiptOptions	getReceiptOptions() Getter for ReceiptOptions.
SaveCardOptions	getSaveCardOptions() Getter for SaveCardOptions.
SelectOptions	getSelectOptions() Getter for SelectOptions.
SignatureOptions	getSignatureOptions() Getter for SignatureOptions.
String	getStatus() Getter for Status.
String	getType() Getter for Type.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAwaitNextAction() Internal Getter for AwaitNextAction.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetAwaitNextActionDuration() Internal Getter for AwaitNextActionDuration.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetDeadlineDuration() Internal Getter for DeadlineDuration.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetDeviceId() Internal Getter for DeviceId.
TerminalAction.Builder	toBuilder() Builds a new TerminalAction.Builder object.
String	toString() Converts this TerminalAction into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

TerminalAction

public TerminalAction(String id,
                      String deviceId,
                      String deadlineDuration,
                      String status,
                      String cancelReason,
                      String createdAt,
                      String updatedAt,
                      String appId,
                      String type,
                      QrCodeOptions qrCodeOptions,
                      SaveCardOptions saveCardOptions,
                      SignatureOptions signatureOptions,
                      ConfirmationOptions confirmationOptions,
                      ReceiptOptions receiptOptions,
                      DataCollectionOptions dataCollectionOptions,
                      SelectOptions selectOptions,
                      DeviceMetadata deviceMetadata,
                      Boolean awaitNextAction,
                      String awaitNextActionDuration)

Initialization constructor.

Parameters:

id - String value for id.

deviceId - String value for deviceId.

deadlineDuration - String value for deadlineDuration.

status - String value for status.

cancelReason - String value for cancelReason.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

appId - String value for appId.

type - String value for type.

qrCodeOptions - QrCodeOptions value for qrCodeOptions.

saveCardOptions - SaveCardOptions value for saveCardOptions.

signatureOptions - SignatureOptions value for signatureOptions.

confirmationOptions - ConfirmationOptions value for confirmationOptions.

receiptOptions - ReceiptOptions value for receiptOptions.

dataCollectionOptions - DataCollectionOptions value for dataCollectionOptions.

selectOptions - SelectOptions value for selectOptions.

deviceMetadata - DeviceMetadata value for deviceMetadata.

awaitNextAction - Boolean value for awaitNextAction.

awaitNextActionDuration - String value for awaitNextActionDuration.

TerminalAction

protected TerminalAction(String id,
                         io.apimatic.core.types.OptionalNullable<String> deviceId,
                         io.apimatic.core.types.OptionalNullable<String> deadlineDuration,
                         String status,
                         String cancelReason,
                         String createdAt,
                         String updatedAt,
                         String appId,
                         String type,
                         QrCodeOptions qrCodeOptions,
                         SaveCardOptions saveCardOptions,
                         SignatureOptions signatureOptions,
                         ConfirmationOptions confirmationOptions,
                         ReceiptOptions receiptOptions,
                         DataCollectionOptions dataCollectionOptions,
                         SelectOptions selectOptions,
                         DeviceMetadata deviceMetadata,
                         io.apimatic.core.types.OptionalNullable<Boolean> awaitNextAction,
                         io.apimatic.core.types.OptionalNullable<String> awaitNextActionDuration)

Internal initialization constructor.

Method Detail

getId

public String getId()

Getter for Id. A unique ID for this `TerminalAction`.

Returns:

Returns the String

internalGetDeviceId

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

Internal Getter for DeviceId. The unique Id of the device intended for this `TerminalAction`. The Id can be retrieved from /v2/devices api.

Returns:

Returns the Internal String

getDeviceId

public String getDeviceId()

Getter for DeviceId. The unique Id of the device intended for this `TerminalAction`. The Id can be retrieved from /v2/devices api.

Returns:

Returns the String

internalGetDeadlineDuration

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

Internal Getter for DeadlineDuration. The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT` Default: 5 minutes from creation Maximum: 5 minutes

Returns:

Returns the Internal String

getDeadlineDuration

public String getDeadlineDuration()

Getter for DeadlineDuration. The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT` Default: 5 minutes from creation Maximum: 5 minutes

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. The status of the `TerminalAction`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`

Returns:

Returns the String

getCancelReason

public String getCancelReason()

Getter for CancelReason.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The time when the `TerminalAction` was created as an RFC 3339 timestamp.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The time when the `TerminalAction` was last updated as an RFC 3339 timestamp.

Returns:

Returns the String

getAppId

public String getAppId()

Getter for AppId. The ID of the application that created the action.

Returns:

Returns the String

getType

public String getType()

Getter for Type. Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.

Returns:

Returns the String

getQrCodeOptions

public QrCodeOptions getQrCodeOptions()

Getter for QrCodeOptions. Fields to describe the action that displays QR-Codes.

Returns:

Returns the QrCodeOptions

getSaveCardOptions

public SaveCardOptions getSaveCardOptions()

Getter for SaveCardOptions. Describes save-card action fields.

Returns:

Returns the SaveCardOptions

getSignatureOptions

public SignatureOptions getSignatureOptions()

Getter for SignatureOptions.

Returns:

Returns the SignatureOptions

getConfirmationOptions

public ConfirmationOptions getConfirmationOptions()

Getter for ConfirmationOptions.

Returns:

Returns the ConfirmationOptions

getReceiptOptions

public ReceiptOptions getReceiptOptions()

Getter for ReceiptOptions. Describes receipt action fields.

Returns:

Returns the ReceiptOptions

getDataCollectionOptions

public DataCollectionOptions getDataCollectionOptions()

Getter for DataCollectionOptions.

Returns:

Returns the DataCollectionOptions

getSelectOptions

public SelectOptions getSelectOptions()

Getter for SelectOptions.

Returns:

Returns the SelectOptions

getDeviceMetadata

public DeviceMetadata getDeviceMetadata()

Getter for DeviceMetadata.

Returns:

Returns the DeviceMetadata

internalGetAwaitNextAction

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

Internal Getter for AwaitNextAction. Indicates the action will be linked to another action and requires a waiting dialog to be displayed instead of returning to the idle screen on completion of the action. Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types.

Returns:

Returns the Internal Boolean

getAwaitNextAction

public Boolean getAwaitNextAction()

Getter for AwaitNextAction. Indicates the action will be linked to another action and requires a waiting dialog to be displayed instead of returning to the idle screen on completion of the action. Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types.

Returns:

Returns the Boolean

internalGetAwaitNextActionDuration

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

Internal Getter for AwaitNextActionDuration. The timeout duration of the waiting dialog as an RFC 3339 duration, after which the waiting dialog will no longer be displayed and the Terminal will return to the idle screen. Default: 5 minutes from when the waiting dialog is displayed Maximum: 5 minutes

Returns:

Returns the Internal String

getAwaitNextActionDuration

public String getAwaitNextActionDuration()

Getter for AwaitNextActionDuration. The timeout duration of the waiting dialog as an RFC 3339 duration, after which the waiting dialog will no longer be displayed and the Terminal will return to the idle screen. Default: 5 minutes from when the waiting dialog is displayed Maximum: 5 minutes

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public TerminalAction.Builder toBuilder()

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

Returns:

a new TerminalAction.Builder object