Customer (Square 30.0.1.20230608 API)

java.lang.Object
- com.squareup.square.models.Customer

```
public class Customer
extends Object
```
This is a model class for Customer type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Customer.Builder
Class to build instances of Customer.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Customer.Builder` Class to build instances of `Customer`.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Customer(String id, String createdAt, String updatedAt, List<Card> cards, String givenName, String familyName, String nickname, String companyName, String emailAddress, Address address, String phoneNumber, String birthday, String referenceId, String note, CustomerPreferences preferences, String creationSource, List<String> groupIds, List<String> segmentIds, Long version, CustomerTaxIds taxIds)` Initialization constructor.
`protected`	Customer(String id, String createdAt, String updatedAt, io.apimatic.core.types.OptionalNullable<List<Card>> cards, io.apimatic.core.types.OptionalNullable<String> givenName, io.apimatic.core.types.OptionalNullable<String> familyName, io.apimatic.core.types.OptionalNullable<String> nickname, io.apimatic.core.types.OptionalNullable<String> companyName, io.apimatic.core.types.OptionalNullable<String> emailAddress, Address address, io.apimatic.core.types.OptionalNullable<String> phoneNumber, io.apimatic.core.types.OptionalNullable<String> birthday, io.apimatic.core.types.OptionalNullable<String> referenceId, io.apimatic.core.types.OptionalNullable<String> note, CustomerPreferences preferences, String creationSource, io.apimatic.core.types.OptionalNullable<List<String>> groupIds, io.apimatic.core.types.OptionalNullable<List<String>> segmentIds, Long version, CustomerTaxIds taxIds) Internal initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Address`	`getAddress()` Getter for Address.
`String`	`getBirthday()` Getter for Birthday.
`List<Card>`	`getCards()` Getter for Cards.
`String`	`getCompanyName()` Getter for CompanyName.
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getCreationSource()` Getter for CreationSource.
`String`	`getEmailAddress()` Getter for EmailAddress.
`String`	`getFamilyName()` Getter for FamilyName.
`String`	`getGivenName()` Getter for GivenName.
`List<String>`	`getGroupIds()` Getter for GroupIds.
`String`	`getId()` Getter for Id.
`String`	`getNickname()` Getter for Nickname.
`String`	`getNote()` Getter for Note.
`String`	`getPhoneNumber()` Getter for PhoneNumber.
`CustomerPreferences`	`getPreferences()` Getter for Preferences.
`String`	`getReferenceId()` Getter for ReferenceId.
`List<String>`	`getSegmentIds()` Getter for SegmentIds.
`CustomerTaxIds`	`getTaxIds()` Getter for TaxIds.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`Long`	`getVersion()` Getter for Version.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetBirthday()` Internal Getter for Birthday.
`protected io.apimatic.core.types.OptionalNullable<List<Card>>`	`internalGetCards()` Internal Getter for Cards.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCompanyName()` Internal Getter for CompanyName.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetEmailAddress()` Internal Getter for EmailAddress.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetFamilyName()` Internal Getter for FamilyName.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetGivenName()` Internal Getter for GivenName.
`protected io.apimatic.core.types.OptionalNullable<List<String>>`	`internalGetGroupIds()` Internal Getter for GroupIds.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetNickname()` Internal Getter for Nickname.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetNote()` Internal Getter for Note.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPhoneNumber()` Internal Getter for PhoneNumber.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetReferenceId()` Internal Getter for ReferenceId.
`protected io.apimatic.core.types.OptionalNullable<List<String>>`	`internalGetSegmentIds()` Internal Getter for SegmentIds.
`Customer.Builder`	`toBuilder()` Builds a new `Customer.Builder` object.
`String`	`toString()` Converts this Customer into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Customer
```
public Customer(String id,
                String createdAt,
                String updatedAt,
                List<Card> cards,
                String givenName,
                String familyName,
                String nickname,
                String companyName,
                String emailAddress,
                Address address,
                String phoneNumber,
                String birthday,
                String referenceId,
                String note,
                CustomerPreferences preferences,
                String creationSource,
                List<String> groupIds,
                List<String> segmentIds,
                Long version,
                CustomerTaxIds taxIds)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    createdAt - String value for createdAt.
    
    updatedAt - String value for updatedAt.
    
    cards - List of Card value for cards.
    
    givenName - String value for givenName.
    
    familyName - String value for familyName.
    
    nickname - String value for nickname.
    
    companyName - String value for companyName.
    
    emailAddress - String value for emailAddress.
    
    address - Address value for address.
    
    phoneNumber - String value for phoneNumber.
    
    birthday - String value for birthday.
    
    referenceId - String value for referenceId.
    
    note - String value for note.
    
    preferences - CustomerPreferences value for preferences.
    
    creationSource - String value for creationSource.
    
    groupIds - List of String value for groupIds.
    
    segmentIds - List of String value for segmentIds.
    
    version - Long value for version.
    
    taxIds - CustomerTaxIds value for taxIds.
  - Customer
```
protected Customer(String id,
                   String createdAt,
                   String updatedAt,
                   io.apimatic.core.types.OptionalNullable<List<Card>> cards,
                   io.apimatic.core.types.OptionalNullable<String> givenName,
                   io.apimatic.core.types.OptionalNullable<String> familyName,
                   io.apimatic.core.types.OptionalNullable<String> nickname,
                   io.apimatic.core.types.OptionalNullable<String> companyName,
                   io.apimatic.core.types.OptionalNullable<String> emailAddress,
                   Address address,
                   io.apimatic.core.types.OptionalNullable<String> phoneNumber,
                   io.apimatic.core.types.OptionalNullable<String> birthday,
                   io.apimatic.core.types.OptionalNullable<String> referenceId,
                   io.apimatic.core.types.OptionalNullable<String> note,
                   CustomerPreferences preferences,
                   String creationSource,
                   io.apimatic.core.types.OptionalNullable<List<String>> groupIds,
                   io.apimatic.core.types.OptionalNullable<List<String>> segmentIds,
                   Long version,
                   CustomerTaxIds taxIds)
```
    Internal initialization constructor.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. A unique Square-assigned ID for the customer profile. If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers) or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint.
    
    Returns:
    
    Returns the String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The timestamp when the customer profile was created, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. The timestamp when the customer profile was last updated, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - internalGetCards
```
protected io.apimatic.core.types.OptionalNullable<List<Card>> internalGetCards()
```
    Internal Getter for Cards. Payment details of the credit, debit, and gift cards stored on file for the customer profile. DEPRECATED at version 2021-06-16. Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit and debit cards on file) or [ListGiftCards](api-endpoint:GiftCards-ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter. For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).
    
    Returns:
    
    Returns the Internal List of Card
  - getCards
```
public List<Card> getCards()
```
    Getter for Cards. Payment details of the credit, debit, and gift cards stored on file for the customer profile. DEPRECATED at version 2021-06-16. Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit and debit cards on file) or [ListGiftCards](api-endpoint:GiftCards-ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter. For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).
    
    Returns:
    
    Returns the List of Card
  - internalGetGivenName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetGivenName()
```
    Internal Getter for GivenName. The given name (that is, the first name) associated with the customer profile.
    
    Returns:
    
    Returns the Internal String
  - getGivenName
```
public String getGivenName()
```
    Getter for GivenName. The given name (that is, the first name) associated with the customer profile.
    
    Returns:
    
    Returns the String
  - internalGetFamilyName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetFamilyName()
```
    Internal Getter for FamilyName. The family name (that is, the last name) associated with the customer profile.
    
    Returns:
    
    Returns the Internal String
  - getFamilyName
```
public String getFamilyName()
```
    Getter for FamilyName. The family name (that is, the last name) associated with the customer profile.
    
    Returns:
    
    Returns the String
  - internalGetNickname
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetNickname()
```
    Internal Getter for Nickname. A nickname for the customer profile.
    
    Returns:
    
    Returns the Internal String
  - getNickname
```
public String getNickname()
```
    Getter for Nickname. A nickname for the customer profile.
    
    Returns:
    
    Returns the String
  - internalGetCompanyName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCompanyName()
```
    Internal Getter for CompanyName. A business name associated with the customer profile.
    
    Returns:
    
    Returns the Internal String
  - getCompanyName
```
public String getCompanyName()
```
    Getter for CompanyName. A business name associated with the customer profile.
    
    Returns:
    
    Returns the String
  - internalGetEmailAddress
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetEmailAddress()
```
    Internal Getter for EmailAddress. The email address associated with the customer profile.
    
    Returns:
    
    Returns the Internal String
  - getEmailAddress
```
public String getEmailAddress()
```
    Getter for EmailAddress. The email address associated with the customer profile.
    
    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
  - internalGetPhoneNumber
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPhoneNumber()
```
    Internal Getter for PhoneNumber. The phone number associated with the customer profile.
    
    Returns:
    
    Returns the Internal String
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Getter for PhoneNumber. The phone number associated with the customer profile.
    
    Returns:
    
    Returns the String
  - internalGetBirthday
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBirthday()
```
    Internal Getter for Birthday. The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21` represents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year).
    
    Returns:
    
    Returns the Internal String
  - getBirthday
```
public String getBirthday()
```
    Getter for Birthday. The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21` represents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year).
    
    Returns:
    
    Returns the String
  - internalGetReferenceId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetReferenceId()
```
    Internal Getter for ReferenceId. An optional second ID used to associate the customer profile with an entity in another system.
    
    Returns:
    
    Returns the Internal String
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. An optional second ID used to associate the customer profile with an entity in another system.
    
    Returns:
    
    Returns the String
  - internalGetNote
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetNote()
```
    Internal Getter for Note. A custom note associated with the customer profile.
    
    Returns:
    
    Returns the Internal String
  - getNote
```
public String getNote()
```
    Getter for Note. A custom note associated with the customer profile.
    
    Returns:
    
    Returns the String
  - getPreferences
```
public CustomerPreferences getPreferences()
```
    Getter for Preferences. Represents communication preferences for the customer profile.
    
    Returns:
    
    Returns the CustomerPreferences
  - getCreationSource
```
public String getCreationSource()
```
    Getter for CreationSource. Indicates the method used to create the customer profile.
    
    Returns:
    
    Returns the String
  - internalGetGroupIds
```
protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetGroupIds()
```
    Internal Getter for GroupIds. The IDs of [customer groups](entity:CustomerGroup) the customer belongs to.
    
    Returns:
    
    Returns the Internal List of String
  - getGroupIds
```
public List<String> getGroupIds()
```
    Getter for GroupIds. The IDs of [customer groups](entity:CustomerGroup) the customer belongs to.
    
    Returns:
    
    Returns the List of String
  - internalGetSegmentIds
```
protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetSegmentIds()
```
    Internal Getter for SegmentIds. The IDs of [customer segments](entity:CustomerSegment) the customer belongs to.
    
    Returns:
    
    Returns the Internal List of String
  - getSegmentIds
```
public List<String> getSegmentIds()
```
    Getter for SegmentIds. The IDs of [customer segments](entity:CustomerSegment) the customer belongs to.
    
    Returns:
    
    Returns the List of String
  - getVersion
```
public Long getVersion()
```
    Getter for Version. The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership and cards on file.
    
    Returns:
    
    Returns the Long
  - getTaxIds
```
public CustomerTaxIds getTaxIds()
```
    Getter for TaxIds. Represents the tax ID associated with a [customer profile]($m/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).
    
    Returns:
    
    Returns the CustomerTaxIds
  - 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 Customer into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Customer.Builder toBuilder()
```
    Builds a new Customer.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Customer.Builder object

Class Customer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Customer

Customer

Method Detail

getId

getCreatedAt

getUpdatedAt

internalGetCards

getCards

internalGetGivenName

getGivenName

internalGetFamilyName

getFamilyName

internalGetNickname

getNickname

internalGetCompanyName

getCompanyName

internalGetEmailAddress

getEmailAddress

getAddress

internalGetPhoneNumber

getPhoneNumber

internalGetBirthday

getBirthday

internalGetReferenceId

getReferenceId

internalGetNote

getNote

getPreferences

getCreationSource

internalGetGroupIds

getGroupIds

internalGetSegmentIds

getSegmentIds

getVersion

getTaxIds

hashCode

equals

toString

toBuilder