com.squareup.square.models

Class Booking

java.lang.Object

com.squareup.square.models.Booking

public class Booking
extends Object

This is a model class for Booking type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Booking(String id, Integer version, String status, String createdAt, String updatedAt, io.apimatic.core.types.OptionalNullable<String> startAt, io.apimatic.core.types.OptionalNullable<String> locationId, io.apimatic.core.types.OptionalNullable<String> customerId, io.apimatic.core.types.OptionalNullable<String> customerNote, io.apimatic.core.types.OptionalNullable<String> sellerNote, io.apimatic.core.types.OptionalNullable<List<AppointmentSegment>> appointmentSegments, Integer transitionTimeMinutes, Boolean allDay, String locationType, BookingCreatorDetails creatorDetails, String source) Internal initialization constructor.
	Booking(String id, Integer version, String status, String createdAt, String updatedAt, String startAt, String locationId, String customerId, String customerNote, String sellerNote, List<AppointmentSegment> appointmentSegments, Integer transitionTimeMinutes, Boolean allDay, String locationType, BookingCreatorDetails creatorDetails, String source) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllDay() Getter for AllDay.
List<AppointmentSegment>	getAppointmentSegments() Getter for AppointmentSegments.
String	getCreatedAt() Getter for CreatedAt.
BookingCreatorDetails	getCreatorDetails() Getter for CreatorDetails.
String	getCustomerId() Getter for CustomerId.
String	getCustomerNote() Getter for CustomerNote.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getLocationType() Getter for LocationType.
String	getSellerNote() Getter for SellerNote.
String	getSource() Getter for Source.
String	getStartAt() Getter for StartAt.
String	getStatus() Getter for Status.
Integer	getTransitionTimeMinutes() Getter for TransitionTimeMinutes.
String	getUpdatedAt() Getter for UpdatedAt.
Integer	getVersion() Getter for Version.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<AppointmentSegment>>	internalGetAppointmentSegments() Internal Getter for AppointmentSegments.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCustomerId() Internal Getter for CustomerId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCustomerNote() Internal Getter for CustomerNote.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetLocationId() Internal Getter for LocationId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSellerNote() Internal Getter for SellerNote.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetStartAt() Internal Getter for StartAt.
Booking.Builder	toBuilder() Builds a new Booking.Builder object.
String	toString() Converts this Booking into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Booking

public Booking(String id,
               Integer version,
               String status,
               String createdAt,
               String updatedAt,
               String startAt,
               String locationId,
               String customerId,
               String customerNote,
               String sellerNote,
               List<AppointmentSegment> appointmentSegments,
               Integer transitionTimeMinutes,
               Boolean allDay,
               String locationType,
               BookingCreatorDetails creatorDetails,
               String source)

Initialization constructor.

Parameters:

id - String value for id.

version - Integer value for version.

status - String value for status.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

startAt - String value for startAt.

locationId - String value for locationId.

customerId - String value for customerId.

customerNote - String value for customerNote.

sellerNote - String value for sellerNote.

appointmentSegments - List of AppointmentSegment value for appointmentSegments.

transitionTimeMinutes - Integer value for transitionTimeMinutes.

allDay - Boolean value for allDay.

locationType - String value for locationType.

creatorDetails - BookingCreatorDetails value for creatorDetails.

source - String value for source.

Booking

protected Booking(String id,
                  Integer version,
                  String status,
                  String createdAt,
                  String updatedAt,
                  io.apimatic.core.types.OptionalNullable<String> startAt,
                  io.apimatic.core.types.OptionalNullable<String> locationId,
                  io.apimatic.core.types.OptionalNullable<String> customerId,
                  io.apimatic.core.types.OptionalNullable<String> customerNote,
                  io.apimatic.core.types.OptionalNullable<String> sellerNote,
                  io.apimatic.core.types.OptionalNullable<List<AppointmentSegment>> appointmentSegments,
                  Integer transitionTimeMinutes,
                  Boolean allDay,
                  String locationType,
                  BookingCreatorDetails creatorDetails,
                  String source)

Internal initialization constructor.

Method Detail

getId

public String getId()

Getter for Id. A unique ID of this object representing a booking.

Returns:

Returns the String

getVersion

public Integer getVersion()

Getter for Version. The revision number for the booking used for optimistic concurrency.

Returns:

Returns the Integer

getStatus

public String getStatus()

Getter for Status. Supported booking statuses.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The RFC 3339 timestamp specifying the creation time of this booking.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The RFC 3339 timestamp specifying the most recent update time of this booking.

Returns:

Returns the String

internalGetStartAt

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

Internal Getter for StartAt. The RFC 3339 timestamp specifying the starting time of this booking.

Returns:

Returns the Internal String

getStartAt

public String getStartAt()

Getter for StartAt. The RFC 3339 timestamp specifying the starting time of this booking.

Returns:

Returns the String

internalGetLocationId

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

Internal Getter for LocationId. The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.

Returns:

Returns the Internal String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.

Returns:

Returns the String

internalGetCustomerId

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

Internal Getter for CustomerId. The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service.

Returns:

Returns the Internal String

getCustomerId

public String getCustomerId()

Getter for CustomerId. The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service.

Returns:

Returns the String

internalGetCustomerNote

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

Internal Getter for CustomerNote. The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance.

Returns:

Returns the Internal String

getCustomerNote

public String getCustomerNote()

Getter for CustomerNote. The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance.

Returns:

Returns the String

internalGetSellerNote

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

Internal Getter for SellerNote. The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance. This field should not be visible to customers.

Returns:

Returns the Internal String

getSellerNote

public String getSellerNote()

Getter for SellerNote. The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance. This field should not be visible to customers.

Returns:

Returns the String

internalGetAppointmentSegments

protected io.apimatic.core.types.OptionalNullable<List<AppointmentSegment>> internalGetAppointmentSegments()

Internal Getter for AppointmentSegments. A list of appointment segments for this booking.

Returns:

Returns the Internal List of AppointmentSegment

getAppointmentSegments

public List<AppointmentSegment> getAppointmentSegments()

Getter for AppointmentSegments. A list of appointment segments for this booking.

Returns:

Returns the List of AppointmentSegment

getTransitionTimeMinutes

public Integer getTransitionTimeMinutes()

Getter for TransitionTimeMinutes. Additional time at the end of a booking. Applications should not make this field visible to customers of a seller.

Returns:

Returns the Integer

getAllDay

public Boolean getAllDay()

Getter for AllDay. Whether the booking is of a full business day.

Returns:

Returns the Boolean

getLocationType

public String getLocationType()

Getter for LocationType. Supported types of location where service is provided.

Returns:

Returns the String

getCreatorDetails

public BookingCreatorDetails getCreatorDetails()

Getter for CreatorDetails. Information about a booking creator.

Returns:

Returns the BookingCreatorDetails

getSource

public String getSource()

Getter for Source. Supported sources a booking was created from.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Booking.Builder toBuilder()

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

Returns:

a new Booking.Builder object