UpdateCustomerRequest (Square 37.0.0.20240118 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	UpdateCustomerRequest(io.apimatic.core.types.OptionalNullable<String> givenName, io.apimatic.core.types.OptionalNullable<String> familyName, io.apimatic.core.types.OptionalNullable<String> companyName, io.apimatic.core.types.OptionalNullable<String> nickname, io.apimatic.core.types.OptionalNullable<String> emailAddress, Address address, io.apimatic.core.types.OptionalNullable<String> phoneNumber, io.apimatic.core.types.OptionalNullable<String> referenceId, io.apimatic.core.types.OptionalNullable<String> note, io.apimatic.core.types.OptionalNullable<String> birthday, Long version, CustomerTaxIds taxIds) Initialization constructor.
	`UpdateCustomerRequest(String givenName, String familyName, String companyName, String nickname, String emailAddress, Address address, String phoneNumber, String referenceId, String note, String birthday, Long version, CustomerTaxIds taxIds)` 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.
`String`	`getCompanyName()` Getter for CompanyName.
`String`	`getEmailAddress()` Getter for EmailAddress.
`String`	`getFamilyName()` Getter for FamilyName.
`String`	`getGivenName()` Getter for GivenName.
`String`	`getNickname()` Getter for Nickname.
`String`	`getNote()` Getter for Note.
`String`	`getPhoneNumber()` Getter for PhoneNumber.
`String`	`getReferenceId()` Getter for ReferenceId.
`CustomerTaxIds`	`getTaxIds()` Getter for TaxIds.
`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<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<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.
`UpdateCustomerRequest.Builder`	`toBuilder()` Builds a new `UpdateCustomerRequest.Builder` object.
`String`	`toString()` Converts this UpdateCustomerRequest into string format.

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

- Constructor Detail
  - UpdateCustomerRequest
```
public UpdateCustomerRequest(String givenName,
                             String familyName,
                             String companyName,
                             String nickname,
                             String emailAddress,
                             Address address,
                             String phoneNumber,
                             String referenceId,
                             String note,
                             String birthday,
                             Long version,
                             CustomerTaxIds taxIds)
```
    Initialization constructor.
    
    Parameters:
    
    givenName - String value for givenName.
    
    familyName - String value for familyName.
    
    companyName - String value for companyName.
    
    nickname - String value for nickname.
    
    emailAddress - String value for emailAddress.
    
    address - Address value for address.
    
    phoneNumber - String value for phoneNumber.
    
    referenceId - String value for referenceId.
    
    note - String value for note.
    
    birthday - String value for birthday.
    
    version - Long value for version.
    
    taxIds - CustomerTaxIds value for taxIds.
  - UpdateCustomerRequest
```
protected UpdateCustomerRequest(io.apimatic.core.types.OptionalNullable<String> givenName,
                                io.apimatic.core.types.OptionalNullable<String> familyName,
                                io.apimatic.core.types.OptionalNullable<String> companyName,
                                io.apimatic.core.types.OptionalNullable<String> nickname,
                                io.apimatic.core.types.OptionalNullable<String> emailAddress,
                                Address address,
                                io.apimatic.core.types.OptionalNullable<String> phoneNumber,
                                io.apimatic.core.types.OptionalNullable<String> referenceId,
                                io.apimatic.core.types.OptionalNullable<String> note,
                                io.apimatic.core.types.OptionalNullable<String> birthday,
                                Long version,
                                CustomerTaxIds taxIds)
```
    Initialization constructor.
    
    Parameters:
    
    givenName - String value for givenName.
    
    familyName - String value for familyName.
    
    companyName - String value for companyName.
    
    nickname - String value for nickname.
    
    emailAddress - String value for emailAddress.
    
    address - Address value for address.
    
    phoneNumber - String value for phoneNumber.
    
    referenceId - String value for referenceId.
    
    note - String value for note.
    
    birthday - String value for birthday.
    
    version - Long value for version.
    
    taxIds - CustomerTaxIds value for taxIds.
- Method Detail
  - 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. The maximum length for this value is 300 characters.
    
    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. The maximum length for this value is 300 characters.
    
    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. The maximum length for this value is 300 characters.
    
    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. The maximum length for this value is 300 characters.
    
    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. The maximum length for this value is 500 characters.
    
    Returns:
    
    Returns the Internal String
  - getCompanyName
```
public String getCompanyName()
```
    Getter for CompanyName. A business name associated with the customer profile. The maximum length for this value is 500 characters.
    
    Returns:
    
    Returns the String
  - internalGetNickname
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetNickname()
```
    Internal Getter for Nickname. A nickname for the customer profile. The maximum length for this value is 100 characters.
    
    Returns:
    
    Returns the Internal String
  - getNickname
```
public String getNickname()
```
    Getter for Nickname. A nickname for the customer profile. The maximum length for this value is 100 characters.
    
    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. The maximum length for this value is 254 characters.
    
    Returns:
    
    Returns the Internal String
  - getEmailAddress
```
public String getEmailAddress()
```
    Getter for EmailAddress. The email address associated with the customer profile. The maximum length for this value is 254 characters.
    
    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. The phone number must be valid and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).
    
    Returns:
    
    Returns the Internal String
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Getter for PhoneNumber. The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).
    
    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. The maximum length for this value is 100 characters.
    
    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. The maximum length for this value is 100 characters.
    
    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
  - internalGetBirthday
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBirthday()
```
    Internal Getter for Birthday. The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.
    
    Returns:
    
    Returns the Internal String
  - getBirthday
```
public String getBirthday()
```
    Getter for Birthday. The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.
    
    Returns:
    
    Returns the String
  - getVersion
```
public Long getVersion()
```
    Getter for Version. The current version of the customer profile. As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile).
    
    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 UpdateCustomerRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public UpdateCustomerRequest.Builder toBuilder()
```
    Builds a new UpdateCustomerRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new UpdateCustomerRequest.Builder object

Class UpdateCustomerRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateCustomerRequest

UpdateCustomerRequest

Method Detail

internalGetGivenName

getGivenName

internalGetFamilyName

getFamilyName

internalGetCompanyName

getCompanyName

internalGetNickname

getNickname

internalGetEmailAddress

getEmailAddress

getAddress

internalGetPhoneNumber

getPhoneNumber

internalGetReferenceId

getReferenceId

internalGetNote

getNote

internalGetBirthday

getBirthday

getVersion

getTaxIds

hashCode

equals

toString

toBuilder