com.squareup.square.models

Class Shift

java.lang.Object

com.squareup.square.models.Shift

public class Shift
extends Object

This is a model class for Shift type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Shift(String locationId, String startAt, String id, io.apimatic.core.types.OptionalNullable<String> employeeId, io.apimatic.core.types.OptionalNullable<String> timezone, io.apimatic.core.types.OptionalNullable<String> endAt, ShiftWage wage, io.apimatic.core.types.OptionalNullable<List<Break>> breaks, String status, Integer version, String createdAt, String updatedAt, io.apimatic.core.types.OptionalNullable<String> teamMemberId, Money declaredCashTipMoney) Initialization constructor.
	Shift(String locationId, String startAt, String id, String employeeId, String timezone, String endAt, ShiftWage wage, List<Break> breaks, String status, Integer version, String createdAt, String updatedAt, String teamMemberId, Money declaredCashTipMoney) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<Break>	getBreaks() Getter for Breaks.
String	getCreatedAt() Getter for CreatedAt.
Money	getDeclaredCashTipMoney() Getter for DeclaredCashTipMoney.
String	getEmployeeId() Getter for EmployeeId.
String	getEndAt() Getter for EndAt.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getStartAt() Getter for StartAt.
String	getStatus() Getter for Status.
String	getTeamMemberId() Getter for TeamMemberId.
String	getTimezone() Getter for Timezone.
String	getUpdatedAt() Getter for UpdatedAt.
Integer	getVersion() Getter for Version.
ShiftWage	getWage() Getter for Wage.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<Break>>	internalGetBreaks() Internal Getter for Breaks.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetEmployeeId() Internal Getter for EmployeeId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetEndAt() Internal Getter for EndAt.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetTeamMemberId() Internal Getter for TeamMemberId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetTimezone() Internal Getter for Timezone.
Shift.Builder	toBuilder() Builds a new Shift.Builder object.
String	toString() Converts this Shift into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Shift

public Shift(String locationId,
             String startAt,
             String id,
             String employeeId,
             String timezone,
             String endAt,
             ShiftWage wage,
             List<Break> breaks,
             String status,
             Integer version,
             String createdAt,
             String updatedAt,
             String teamMemberId,
             Money declaredCashTipMoney)

Initialization constructor.

Parameters:

locationId - String value for locationId.

startAt - String value for startAt.

id - String value for id.

employeeId - String value for employeeId.

timezone - String value for timezone.

endAt - String value for endAt.

wage - ShiftWage value for wage.

breaks - List of Break value for breaks.

status - String value for status.

version - Integer value for version.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

teamMemberId - String value for teamMemberId.

declaredCashTipMoney - Money value for declaredCashTipMoney.

Shift

protected Shift(String locationId,
                String startAt,
                String id,
                io.apimatic.core.types.OptionalNullable<String> employeeId,
                io.apimatic.core.types.OptionalNullable<String> timezone,
                io.apimatic.core.types.OptionalNullable<String> endAt,
                ShiftWage wage,
                io.apimatic.core.types.OptionalNullable<List<Break>> breaks,
                String status,
                Integer version,
                String createdAt,
                String updatedAt,
                io.apimatic.core.types.OptionalNullable<String> teamMemberId,
                Money declaredCashTipMoney)

Initialization constructor.

Parameters:

locationId - String value for locationId.

startAt - String value for startAt.

id - String value for id.

employeeId - String value for employeeId.

timezone - String value for timezone.

endAt - String value for endAt.

wage - ShiftWage value for wage.

breaks - List of Break value for breaks.

status - String value for status.

version - Integer value for version.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

teamMemberId - String value for teamMemberId.

declaredCashTipMoney - Money value for declaredCashTipMoney.

Method Detail

getId

public String getId()

Getter for Id. The UUID for this object.

Returns:

Returns the String

internalGetEmployeeId

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

Internal Getter for EmployeeId. The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead.

Returns:

Returns the Internal String

getEmployeeId

public String getEmployeeId()

Getter for EmployeeId. The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the location this shift occurred at. The location should be based on where the employee clocked in.

Returns:

Returns the String

internalGetTimezone

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

Internal Getter for Timezone. The read-only convenience value that is calculated from the location based on the `location_id`. Format: the IANA timezone database identifier for the location timezone.

Returns:

Returns the Internal String

getTimezone

public String getTimezone()

Getter for Timezone. The read-only convenience value that is calculated from the location based on the `location_id`. Format: the IANA timezone database identifier for the location timezone.

Returns:

Returns the String

getStartAt

public String getStartAt()

Getter for StartAt. RFC 3339; shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated.

Returns:

Returns the String

internalGetEndAt

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

Internal Getter for EndAt. RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Returns:

Returns the Internal String

getEndAt

public String getEndAt()

Getter for EndAt. RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Returns:

Returns the String

getWage

public ShiftWage getWage()

Getter for Wage. The hourly wage rate used to compensate an employee for this shift.

Returns:

Returns the ShiftWage

internalGetBreaks

protected io.apimatic.core.types.OptionalNullable<List<Break>> internalGetBreaks()

Internal Getter for Breaks. A list of all the paid or unpaid breaks that were taken during this shift.

Returns:

Returns the Internal List of Break

getBreaks

public List<Break> getBreaks()

Getter for Breaks. A list of all the paid or unpaid breaks that were taken during this shift.

Returns:

Returns the List of Break

getStatus

public String getStatus()

Getter for Status. Enumerates the possible status of a `Shift`.

Returns:

Returns the String

getVersion

public Integer getVersion()

Getter for Version. Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write; potentially overwriting data from another write.

Returns:

Returns the Integer

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. A read-only timestamp in RFC 3339 format; presented in UTC.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. A read-only timestamp in RFC 3339 format; presented in UTC.

Returns:

Returns the String

internalGetTeamMemberId

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

Internal Getter for TeamMemberId. The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26".

Returns:

Returns the Internal String

getTeamMemberId

public String getTeamMemberId()

Getter for TeamMemberId. The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26".

Returns:

Returns the String

getDeclaredCashTipMoney

public Money getDeclaredCashTipMoney()

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

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Shift.Builder toBuilder()

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

Returns:

a new Shift.Builder object