com.squareup.square.models

Class OrderFulfillmentRecipient

java.lang.Object

com.squareup.square.models.OrderFulfillmentRecipient

public class OrderFulfillmentRecipient
extends Object

This is a model class for OrderFulfillmentRecipient type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
OrderFulfillmentRecipient(String customerId, String displayName, String emailAddress, String phoneNumber, Address address) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Address	getAddress() Getter for Address.
String	getCustomerId() Getter for CustomerId.
String	getDisplayName() Getter for DisplayName.
String	getEmailAddress() Getter for EmailAddress.
String	getPhoneNumber() Getter for PhoneNumber.
int	hashCode()
OrderFulfillmentRecipient.Builder	toBuilder() Builds a new OrderFulfillmentRecipient.Builder object.
String	toString() Converts this OrderFulfillmentRecipient into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderFulfillmentRecipient

public OrderFulfillmentRecipient(String customerId,
                                 String displayName,
                                 String emailAddress,
                                 String phoneNumber,
                                 Address address)

Initialization constructor.

Parameters:

customerId - String value for customerId.

displayName - String value for displayName.

emailAddress - String value for emailAddress.

phoneNumber - String value for phoneNumber.

address - Address value for address.

Method Detail

getCustomerId

public String getCustomerId()

Getter for CustomerId. The customer ID of the customer associated with the fulfillment. If `customer_id` is provided, the fulfillment recipient's `display_name`, `email_address`, and `phone_number` are automatically populated from the targeted customer profile. If these fields are set in the request, the request values overrides the information from the customer profile. If the targeted customer profile does not contain the necessary information and these fields are left unset, the request results in an error.

Returns:

Returns the String

getDisplayName

public String getDisplayName()

Getter for DisplayName. The display name of the fulfillment recipient. If provided, the display name overrides the value pulled from the customer profile indicated by `customer_id`.

Returns:

Returns the String

getEmailAddress

public String getEmailAddress()

Getter for EmailAddress. The email address of the fulfillment recipient. If provided, the email address overrides the value pulled from the customer profile indicated by `customer_id`.

Returns:

Returns the String

getPhoneNumber

public String getPhoneNumber()

Getter for PhoneNumber. The phone number of the fulfillment recipient. If provided, the phone number overrides the value pulled from the customer profile indicated by `customer_id`.

Returns:

Returns the String

getAddress

public Address getAddress()

Getter for Address. Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the Address

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public OrderFulfillmentRecipient.Builder toBuilder()

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

Returns:

a new OrderFulfillmentRecipient.Builder object