com.squareup.square.models

Class Fulfillment

java.lang.Object

com.squareup.square.models.Fulfillment

public class Fulfillment
extends Object

This is a model class for Fulfillment type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Fulfillment(io.apimatic.core.types.OptionalNullable<String> uid, String type, String state, String lineItemApplication, List<FulfillmentFulfillmentEntry> entries, io.apimatic.core.types.OptionalNullable<Map<String,String>> metadata, FulfillmentPickupDetails pickupDetails, FulfillmentShipmentDetails shipmentDetails, FulfillmentDeliveryDetails deliveryDetails, Integer version) Initialization constructor.
	Fulfillment(String uid, String type, String state, String lineItemApplication, List<FulfillmentFulfillmentEntry> entries, Map<String,String> metadata, FulfillmentPickupDetails pickupDetails, FulfillmentShipmentDetails shipmentDetails, FulfillmentDeliveryDetails deliveryDetails, Integer version) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
FulfillmentDeliveryDetails	getDeliveryDetails() Getter for DeliveryDetails.
List<FulfillmentFulfillmentEntry>	getEntries() Getter for Entries.
String	getLineItemApplication() Getter for LineItemApplication.
Map<String,String>	getMetadata() Getter for Metadata.
FulfillmentPickupDetails	getPickupDetails() Getter for PickupDetails.
FulfillmentShipmentDetails	getShipmentDetails() Getter for ShipmentDetails.
String	getState() Getter for State.
String	getType() Getter for Type.
String	getUid() Getter for Uid.
Integer	getVersion() Getter for Version.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Map<String,String>>	internalGetMetadata() Internal Getter for Metadata.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUid() Internal Getter for Uid.
Fulfillment.Builder	toBuilder() Builds a new Fulfillment.Builder object.
String	toString() Converts this Fulfillment into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Fulfillment

public Fulfillment(String uid,
                   String type,
                   String state,
                   String lineItemApplication,
                   List<FulfillmentFulfillmentEntry> entries,
                   Map<String,String> metadata,
                   FulfillmentPickupDetails pickupDetails,
                   FulfillmentShipmentDetails shipmentDetails,
                   FulfillmentDeliveryDetails deliveryDetails,
                   Integer version)

Initialization constructor.

Parameters:

uid - String value for uid.

type - String value for type.

state - String value for state.

lineItemApplication - String value for lineItemApplication.

entries - List of FulfillmentFulfillmentEntry value for entries.

metadata - Map of String, value for metadata.

pickupDetails - FulfillmentPickupDetails value for pickupDetails.

shipmentDetails - FulfillmentShipmentDetails value for shipmentDetails.

deliveryDetails - FulfillmentDeliveryDetails value for deliveryDetails.

version - Integer value for version.

Fulfillment

protected Fulfillment(io.apimatic.core.types.OptionalNullable<String> uid,
                      String type,
                      String state,
                      String lineItemApplication,
                      List<FulfillmentFulfillmentEntry> entries,
                      io.apimatic.core.types.OptionalNullable<Map<String,String>> metadata,
                      FulfillmentPickupDetails pickupDetails,
                      FulfillmentShipmentDetails shipmentDetails,
                      FulfillmentDeliveryDetails deliveryDetails,
                      Integer version)

Initialization constructor.

Parameters:

uid - String value for uid.

type - String value for type.

state - String value for state.

lineItemApplication - String value for lineItemApplication.

entries - List of FulfillmentFulfillmentEntry value for entries.

metadata - Map of String, value for metadata.

pickupDetails - FulfillmentPickupDetails value for pickupDetails.

shipmentDetails - FulfillmentShipmentDetails value for shipmentDetails.

deliveryDetails - FulfillmentDeliveryDetails value for deliveryDetails.

version - Integer value for version.

Method Detail

internalGetUid

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

Internal Getter for Uid. A unique ID that identifies the fulfillment only within this order.

Returns:

Returns the Internal String

getUid

public String getUid()

Getter for Uid. A unique ID that identifies the fulfillment only within this order.

Returns:

Returns the String

getType

public String getType()

Getter for Type. The type of fulfillment.

Returns:

Returns the String

getState

public String getState()

Getter for State. The current state of this fulfillment.

Returns:

Returns the String

getLineItemApplication

public String getLineItemApplication()

Getter for LineItemApplication. The `line_item_application` describes what order line items this fulfillment applies to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.

Returns:

Returns the String

getEntries

public List<FulfillmentFulfillmentEntry> getEntries()

Getter for Entries. A list of entries pertaining to the fulfillment of an order. Each entry must reference a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to fulfill. Multiple entries can reference the same line item `uid`, as long as the total quantity among all fulfillment entries referencing a single line item does not exceed the quantity of the order's line item itself. An order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`, `CANCELED`, or `FAILED`. Fulfillments can be created and completed independently before order completion.

Returns:

Returns the List of FulfillmentFulfillmentEntry

internalGetMetadata

protected io.apimatic.core.types.OptionalNullable<Map<String,String>> internalGetMetadata()

Internal Getter for Metadata. Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).

Returns:

Returns the Internal Map of String, String

getMetadata

public Map<String,String> getMetadata()

Getter for Metadata. Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).

Returns:

Returns the Map of String, String

getPickupDetails

public FulfillmentPickupDetails getPickupDetails()

Getter for PickupDetails. Contains details necessary to fulfill a pickup order.

Returns:

Returns the FulfillmentPickupDetails

getShipmentDetails

public FulfillmentShipmentDetails getShipmentDetails()

Getter for ShipmentDetails. Contains the details necessary to fulfill a shipment order.

Returns:

Returns the FulfillmentShipmentDetails

getDeliveryDetails

public FulfillmentDeliveryDetails getDeliveryDetails()

Getter for DeliveryDetails. Describes delivery details of an order fulfillment.

Returns:

Returns the FulfillmentDeliveryDetails

getVersion

public Integer getVersion()

Getter for Version. The version number attributed to the fulfillment and incremented every time there is a fulfillment-related update. The fulfillment version is an internal field only for use between Orders and the Fulfillment service.

Returns:

Returns the Integer

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Fulfillment.Builder toBuilder()

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

Returns:

a new Fulfillment.Builder object