com.squareup.square.models

Class CashDrawerShiftSummary

java.lang.Object

com.squareup.square.models.CashDrawerShiftSummary

public class CashDrawerShiftSummary
extends Object

This is a model class for CashDrawerShiftSummary type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CashDrawerShiftSummary(String id, String state, io.apimatic.core.types.OptionalNullable<String> openedAt, io.apimatic.core.types.OptionalNullable<String> endedAt, io.apimatic.core.types.OptionalNullable<String> closedAt, io.apimatic.core.types.OptionalNullable<String> description, Money openedCashMoney, Money expectedCashMoney, Money closedCashMoney, String createdAt, String updatedAt, String locationId) Initialization constructor.
	CashDrawerShiftSummary(String id, String state, String openedAt, String endedAt, String closedAt, String description, Money openedCashMoney, Money expectedCashMoney, Money closedCashMoney, String createdAt, String updatedAt, String locationId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClosedAt() Getter for ClosedAt.
Money	getClosedCashMoney() Getter for ClosedCashMoney.
String	getCreatedAt() Getter for CreatedAt.
String	getDescription() Getter for Description.
String	getEndedAt() Getter for EndedAt.
Money	getExpectedCashMoney() Getter for ExpectedCashMoney.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getOpenedAt() Getter for OpenedAt.
Money	getOpenedCashMoney() Getter for OpenedCashMoney.
String	getState() Getter for State.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetClosedAt() Internal Getter for ClosedAt.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetDescription() Internal Getter for Description.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetEndedAt() Internal Getter for EndedAt.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetOpenedAt() Internal Getter for OpenedAt.
CashDrawerShiftSummary.Builder	toBuilder() Builds a new CashDrawerShiftSummary.Builder object.
String	toString() Converts this CashDrawerShiftSummary into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CashDrawerShiftSummary

public CashDrawerShiftSummary(String id,
                              String state,
                              String openedAt,
                              String endedAt,
                              String closedAt,
                              String description,
                              Money openedCashMoney,
                              Money expectedCashMoney,
                              Money closedCashMoney,
                              String createdAt,
                              String updatedAt,
                              String locationId)

Initialization constructor.

Parameters:

id - String value for id.

state - String value for state.

openedAt - String value for openedAt.

endedAt - String value for endedAt.

closedAt - String value for closedAt.

description - String value for description.

openedCashMoney - Money value for openedCashMoney.

expectedCashMoney - Money value for expectedCashMoney.

closedCashMoney - Money value for closedCashMoney.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

locationId - String value for locationId.

CashDrawerShiftSummary

protected CashDrawerShiftSummary(String id,
                                 String state,
                                 io.apimatic.core.types.OptionalNullable<String> openedAt,
                                 io.apimatic.core.types.OptionalNullable<String> endedAt,
                                 io.apimatic.core.types.OptionalNullable<String> closedAt,
                                 io.apimatic.core.types.OptionalNullable<String> description,
                                 Money openedCashMoney,
                                 Money expectedCashMoney,
                                 Money closedCashMoney,
                                 String createdAt,
                                 String updatedAt,
                                 String locationId)

Initialization constructor.

Parameters:

id - String value for id.

state - String value for state.

openedAt - String value for openedAt.

endedAt - String value for endedAt.

closedAt - String value for closedAt.

description - String value for description.

openedCashMoney - Money value for openedCashMoney.

expectedCashMoney - Money value for expectedCashMoney.

closedCashMoney - Money value for closedCashMoney.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

locationId - String value for locationId.

Method Detail

getId

public String getId()

Getter for Id. The shift unique ID.

Returns:

Returns the String

getState

public String getState()

Getter for State. The current state of a cash drawer shift.

Returns:

Returns the String

internalGetOpenedAt

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

Internal Getter for OpenedAt. The shift start time in ISO 8601 format.

Returns:

Returns the Internal String

getOpenedAt

public String getOpenedAt()

Getter for OpenedAt. The shift start time in ISO 8601 format.

Returns:

Returns the String

internalGetEndedAt

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

Internal Getter for EndedAt. The shift end time in ISO 8601 format.

Returns:

Returns the Internal String

getEndedAt

public String getEndedAt()

Getter for EndedAt. The shift end time in ISO 8601 format.

Returns:

Returns the String

internalGetClosedAt

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

Internal Getter for ClosedAt. The shift close time in ISO 8601 format.

Returns:

Returns the Internal String

getClosedAt

public String getClosedAt()

Getter for ClosedAt. The shift close time in ISO 8601 format.

Returns:

Returns the String

internalGetDescription

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

Internal Getter for Description. An employee free-text description of a cash drawer shift.

Returns:

Returns the Internal String

getDescription

public String getDescription()

Getter for Description. An employee free-text description of a cash drawer shift.

Returns:

Returns the String

getOpenedCashMoney

public Money getOpenedCashMoney()

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

getExpectedCashMoney

public Money getExpectedCashMoney()

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

getClosedCashMoney

public Money getClosedCashMoney()

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

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The shift start time in RFC 3339 format.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The shift updated at time in RFC 3339 format.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the location the cash drawer shift belongs to.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CashDrawerShiftSummary.Builder toBuilder()

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

Returns:

a new CashDrawerShiftSummary.Builder object