com.squareup.square.models

Class FulfillmentPickupDetails

java.lang.Object

com.squareup.square.models.FulfillmentPickupDetails

public class FulfillmentPickupDetails
extends Object

This is a model class for FulfillmentPickupDetails type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FulfillmentPickupDetails(FulfillmentRecipient recipient, io.apimatic.core.types.OptionalNullable<String> expiresAt, io.apimatic.core.types.OptionalNullable<String> autoCompleteDuration, String scheduleType, io.apimatic.core.types.OptionalNullable<String> pickupAt, io.apimatic.core.types.OptionalNullable<String> pickupWindowDuration, io.apimatic.core.types.OptionalNullable<String> prepTimeDuration, io.apimatic.core.types.OptionalNullable<String> note, String placedAt, String acceptedAt, String rejectedAt, String readyAt, String expiredAt, String pickedUpAt, String canceledAt, io.apimatic.core.types.OptionalNullable<String> cancelReason, io.apimatic.core.types.OptionalNullable<Boolean> isCurbsidePickup, FulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails) Initialization constructor.
	FulfillmentPickupDetails(FulfillmentRecipient recipient, String expiresAt, String autoCompleteDuration, String scheduleType, String pickupAt, String pickupWindowDuration, String prepTimeDuration, String note, String placedAt, String acceptedAt, String rejectedAt, String readyAt, String expiredAt, String pickedUpAt, String canceledAt, String cancelReason, Boolean isCurbsidePickup, FulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAcceptedAt() Getter for AcceptedAt.
String	getAutoCompleteDuration() Getter for AutoCompleteDuration.
String	getCanceledAt() Getter for CanceledAt.
String	getCancelReason() Getter for CancelReason.
FulfillmentPickupDetailsCurbsidePickupDetails	getCurbsidePickupDetails() Getter for CurbsidePickupDetails.
String	getExpiredAt() Getter for ExpiredAt.
String	getExpiresAt() Getter for ExpiresAt.
Boolean	getIsCurbsidePickup() Getter for IsCurbsidePickup.
String	getNote() Getter for Note.
String	getPickedUpAt() Getter for PickedUpAt.
String	getPickupAt() Getter for PickupAt.
String	getPickupWindowDuration() Getter for PickupWindowDuration.
String	getPlacedAt() Getter for PlacedAt.
String	getPrepTimeDuration() Getter for PrepTimeDuration.
String	getReadyAt() Getter for ReadyAt.
FulfillmentRecipient	getRecipient() Getter for Recipient.
String	getRejectedAt() Getter for RejectedAt.
String	getScheduleType() Getter for ScheduleType.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetAutoCompleteDuration() Internal Getter for AutoCompleteDuration.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCancelReason() Internal Getter for CancelReason.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetExpiresAt() Internal Getter for ExpiresAt.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetIsCurbsidePickup() Internal Getter for IsCurbsidePickup.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetNote() Internal Getter for Note.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPickupAt() Internal Getter for PickupAt.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPickupWindowDuration() Internal Getter for PickupWindowDuration.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPrepTimeDuration() Internal Getter for PrepTimeDuration.
FulfillmentPickupDetails.Builder	toBuilder() Builds a new FulfillmentPickupDetails.Builder object.
String	toString() Converts this FulfillmentPickupDetails into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

FulfillmentPickupDetails

public FulfillmentPickupDetails(FulfillmentRecipient recipient,
                                String expiresAt,
                                String autoCompleteDuration,
                                String scheduleType,
                                String pickupAt,
                                String pickupWindowDuration,
                                String prepTimeDuration,
                                String note,
                                String placedAt,
                                String acceptedAt,
                                String rejectedAt,
                                String readyAt,
                                String expiredAt,
                                String pickedUpAt,
                                String canceledAt,
                                String cancelReason,
                                Boolean isCurbsidePickup,
                                FulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails)

Initialization constructor.

Parameters:

recipient - FulfillmentRecipient value for recipient.

expiresAt - String value for expiresAt.

autoCompleteDuration - String value for autoCompleteDuration.

scheduleType - String value for scheduleType.

pickupAt - String value for pickupAt.

pickupWindowDuration - String value for pickupWindowDuration.

prepTimeDuration - String value for prepTimeDuration.

note - String value for note.

placedAt - String value for placedAt.

acceptedAt - String value for acceptedAt.

rejectedAt - String value for rejectedAt.

readyAt - String value for readyAt.

expiredAt - String value for expiredAt.

pickedUpAt - String value for pickedUpAt.

canceledAt - String value for canceledAt.

cancelReason - String value for cancelReason.

isCurbsidePickup - Boolean value for isCurbsidePickup.

curbsidePickupDetails - FulfillmentPickupDetailsCurbsidePickupDetails value for curbsidePickupDetails.

FulfillmentPickupDetails

protected FulfillmentPickupDetails(FulfillmentRecipient recipient,
                                   io.apimatic.core.types.OptionalNullable<String> expiresAt,
                                   io.apimatic.core.types.OptionalNullable<String> autoCompleteDuration,
                                   String scheduleType,
                                   io.apimatic.core.types.OptionalNullable<String> pickupAt,
                                   io.apimatic.core.types.OptionalNullable<String> pickupWindowDuration,
                                   io.apimatic.core.types.OptionalNullable<String> prepTimeDuration,
                                   io.apimatic.core.types.OptionalNullable<String> note,
                                   String placedAt,
                                   String acceptedAt,
                                   String rejectedAt,
                                   String readyAt,
                                   String expiredAt,
                                   String pickedUpAt,
                                   String canceledAt,
                                   io.apimatic.core.types.OptionalNullable<String> cancelReason,
                                   io.apimatic.core.types.OptionalNullable<Boolean> isCurbsidePickup,
                                   FulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails)

Initialization constructor.

Parameters:

recipient - FulfillmentRecipient value for recipient.

expiresAt - String value for expiresAt.

autoCompleteDuration - String value for autoCompleteDuration.

scheduleType - String value for scheduleType.

pickupAt - String value for pickupAt.

pickupWindowDuration - String value for pickupWindowDuration.

prepTimeDuration - String value for prepTimeDuration.

note - String value for note.

placedAt - String value for placedAt.

acceptedAt - String value for acceptedAt.

rejectedAt - String value for rejectedAt.

readyAt - String value for readyAt.

expiredAt - String value for expiredAt.

pickedUpAt - String value for pickedUpAt.

canceledAt - String value for canceledAt.

cancelReason - String value for cancelReason.

isCurbsidePickup - Boolean value for isCurbsidePickup.

curbsidePickupDetails - FulfillmentPickupDetailsCurbsidePickupDetails value for curbsidePickupDetails.

Method Detail

getRecipient

public FulfillmentRecipient getRecipient()

Getter for Recipient. Information about the fulfillment recipient.

Returns:

Returns the FulfillmentRecipient

internalGetExpiresAt

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

Internal Getter for ExpiresAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment expires if it is not marked in progress. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order are automatically completed.

Returns:

Returns the Internal String

getExpiresAt

public String getExpiresAt()

Getter for ExpiresAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment expires if it is not marked in progress. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order are automatically completed.

Returns:

Returns the String

internalGetAutoCompleteDuration

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

Internal Getter for AutoCompleteDuration. The duration of time after which an in progress pickup fulfillment is automatically moved to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D"). If not set, this pickup fulfillment remains in progress until it is canceled or completed.

Returns:

Returns the Internal String

getAutoCompleteDuration

public String getAutoCompleteDuration()

Getter for AutoCompleteDuration. The duration of time after which an in progress pickup fulfillment is automatically moved to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D"). If not set, this pickup fulfillment remains in progress until it is canceled or completed.

Returns:

Returns the String

getScheduleType

public String getScheduleType()

Getter for ScheduleType. The schedule type of the pickup fulfillment.

Returns:

Returns the String

internalGetPickupAt

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

Internal Getter for PickupAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment.

Returns:

Returns the Internal String

getPickupAt

public String getPickupAt()

Getter for PickupAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment.

Returns:

Returns the String

internalGetPickupWindowDuration

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

Internal Getter for PickupWindowDuration. The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants.

Returns:

Returns the Internal String

getPickupWindowDuration

public String getPickupWindowDuration()

Getter for PickupWindowDuration. The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants.

Returns:

Returns the String

internalGetPrepTimeDuration

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

Internal Getter for PrepTimeDuration. The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, "P1W3D").

Returns:

Returns the Internal String

getPrepTimeDuration

public String getPrepTimeDuration()

Getter for PrepTimeDuration. The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, "P1W3D").

Returns:

Returns the String

internalGetNote

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

Internal Getter for Note. A note to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.

Returns:

Returns the Internal String

getNote

public String getNote()

Getter for Note. A note to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.

Returns:

Returns the String

getPlacedAt

public String getPlacedAt()

Getter for PlacedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Returns:

Returns the String

getAcceptedAt

public String getAcceptedAt()

Getter for AcceptedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Returns:

Returns the String

getRejectedAt

public String getRejectedAt()

Getter for RejectedAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Returns:

Returns the String

getReadyAt

public String getReadyAt()

Getter for ReadyAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Returns:

Returns the String

getExpiredAt

public String getExpiredAt()

Getter for ExpiredAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Returns:

Returns the String

getPickedUpAt

public String getPickedUpAt()

Getter for PickedUpAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Returns:

Returns the String

getCanceledAt

public String getCanceledAt()

Getter for CanceledAt. The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Returns:

Returns the String

internalGetCancelReason

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

Internal Getter for CancelReason. A description of why the pickup was canceled. The maximum length: 100 characters.

Returns:

Returns the Internal String

getCancelReason

public String getCancelReason()

Getter for CancelReason. A description of why the pickup was canceled. The maximum length: 100 characters.

Returns:

Returns the String

internalGetIsCurbsidePickup

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

Internal Getter for IsCurbsidePickup. If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.

Returns:

Returns the Internal Boolean

getIsCurbsidePickup

public Boolean getIsCurbsidePickup()

Getter for IsCurbsidePickup. If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.

Returns:

Returns the Boolean

getCurbsidePickupDetails

public FulfillmentPickupDetailsCurbsidePickupDetails getCurbsidePickupDetails()

Getter for CurbsidePickupDetails. Specific details for curbside pickup.

Returns:

Returns the FulfillmentPickupDetailsCurbsidePickupDetails

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public FulfillmentPickupDetails.Builder toBuilder()

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

Returns:

a new FulfillmentPickupDetails.Builder object