Address (Square 30.0.1.20230608 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	Address(io.apimatic.core.types.OptionalNullable<String> addressLine1, io.apimatic.core.types.OptionalNullable<String> addressLine2, io.apimatic.core.types.OptionalNullable<String> addressLine3, io.apimatic.core.types.OptionalNullable<String> locality, io.apimatic.core.types.OptionalNullable<String> sublocality, io.apimatic.core.types.OptionalNullable<String> sublocality2, io.apimatic.core.types.OptionalNullable<String> sublocality3, io.apimatic.core.types.OptionalNullable<String> administrativeDistrictLevel1, io.apimatic.core.types.OptionalNullable<String> administrativeDistrictLevel2, io.apimatic.core.types.OptionalNullable<String> administrativeDistrictLevel3, io.apimatic.core.types.OptionalNullable<String> postalCode, String country, io.apimatic.core.types.OptionalNullable<String> firstName, io.apimatic.core.types.OptionalNullable<String> lastName) Internal initialization constructor.
	`Address(String addressLine1, String addressLine2, String addressLine3, String locality, String sublocality, String sublocality2, String sublocality3, String administrativeDistrictLevel1, String administrativeDistrictLevel2, String administrativeDistrictLevel3, String postalCode, String country, String firstName, String lastName)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAddressLine1()` Getter for AddressLine1.
`String`	`getAddressLine2()` Getter for AddressLine2.
`String`	`getAddressLine3()` Getter for AddressLine3.
`String`	`getAdministrativeDistrictLevel1()` Getter for AdministrativeDistrictLevel1.
`String`	`getAdministrativeDistrictLevel2()` Getter for AdministrativeDistrictLevel2.
`String`	`getAdministrativeDistrictLevel3()` Getter for AdministrativeDistrictLevel3.
`String`	`getCountry()` Getter for Country.
`String`	`getFirstName()` Getter for FirstName.
`String`	`getLastName()` Getter for LastName.
`String`	`getLocality()` Getter for Locality.
`String`	`getPostalCode()` Getter for PostalCode.
`String`	`getSublocality()` Getter for Sublocality.
`String`	`getSublocality2()` Getter for Sublocality2.
`String`	`getSublocality3()` Getter for Sublocality3.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetAddressLine1()` Internal Getter for AddressLine1.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetAddressLine2()` Internal Getter for AddressLine2.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetAddressLine3()` Internal Getter for AddressLine3.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetAdministrativeDistrictLevel1()` Internal Getter for AdministrativeDistrictLevel1.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetAdministrativeDistrictLevel2()` Internal Getter for AdministrativeDistrictLevel2.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetAdministrativeDistrictLevel3()` Internal Getter for AdministrativeDistrictLevel3.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetFirstName()` Internal Getter for FirstName.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetLastName()` Internal Getter for LastName.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetLocality()` Internal Getter for Locality.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPostalCode()` Internal Getter for PostalCode.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetSublocality()` Internal Getter for Sublocality.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetSublocality2()` Internal Getter for Sublocality2.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetSublocality3()` Internal Getter for Sublocality3.
`Address.Builder`	`toBuilder()` Builds a new `Address.Builder` object.
`String`	`toString()` Converts this Address into string format.

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

- Constructor Detail
  - Address
```
public Address(String addressLine1,
               String addressLine2,
               String addressLine3,
               String locality,
               String sublocality,
               String sublocality2,
               String sublocality3,
               String administrativeDistrictLevel1,
               String administrativeDistrictLevel2,
               String administrativeDistrictLevel3,
               String postalCode,
               String country,
               String firstName,
               String lastName)
```
    Initialization constructor.
    
    Parameters:
    
    addressLine1 - String value for addressLine1.
    
    addressLine2 - String value for addressLine2.
    
    addressLine3 - String value for addressLine3.
    
    locality - String value for locality.
    
    sublocality - String value for sublocality.
    
    sublocality2 - String value for sublocality2.
    
    sublocality3 - String value for sublocality3.
    
    administrativeDistrictLevel1 - String value for administrativeDistrictLevel1.
    
    administrativeDistrictLevel2 - String value for administrativeDistrictLevel2.
    
    administrativeDistrictLevel3 - String value for administrativeDistrictLevel3.
    
    postalCode - String value for postalCode.
    
    country - String value for country.
    
    firstName - String value for firstName.
    
    lastName - String value for lastName.
  - Address
```
protected Address(io.apimatic.core.types.OptionalNullable<String> addressLine1,
                  io.apimatic.core.types.OptionalNullable<String> addressLine2,
                  io.apimatic.core.types.OptionalNullable<String> addressLine3,
                  io.apimatic.core.types.OptionalNullable<String> locality,
                  io.apimatic.core.types.OptionalNullable<String> sublocality,
                  io.apimatic.core.types.OptionalNullable<String> sublocality2,
                  io.apimatic.core.types.OptionalNullable<String> sublocality3,
                  io.apimatic.core.types.OptionalNullable<String> administrativeDistrictLevel1,
                  io.apimatic.core.types.OptionalNullable<String> administrativeDistrictLevel2,
                  io.apimatic.core.types.OptionalNullable<String> administrativeDistrictLevel3,
                  io.apimatic.core.types.OptionalNullable<String> postalCode,
                  String country,
                  io.apimatic.core.types.OptionalNullable<String> firstName,
                  io.apimatic.core.types.OptionalNullable<String> lastName)
```
    Internal initialization constructor.
- Method Detail
  - internalGetAddressLine1
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetAddressLine1()
```
    Internal Getter for AddressLine1. The first line of the address. Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields).
    
    Returns:
    
    Returns the Internal String
  - getAddressLine1
```
public String getAddressLine1()
```
    Getter for AddressLine1. The first line of the address. Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields).
    
    Returns:
    
    Returns the String
  - internalGetAddressLine2
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetAddressLine2()
```
    Internal Getter for AddressLine2. The second line of the address, if any.
    
    Returns:
    
    Returns the Internal String
  - getAddressLine2
```
public String getAddressLine2()
```
    Getter for AddressLine2. The second line of the address, if any.
    
    Returns:
    
    Returns the String
  - internalGetAddressLine3
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetAddressLine3()
```
    Internal Getter for AddressLine3. The third line of the address, if any.
    
    Returns:
    
    Returns the Internal String
  - getAddressLine3
```
public String getAddressLine3()
```
    Getter for AddressLine3. The third line of the address, if any.
    
    Returns:
    
    Returns the String
  - internalGetLocality
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetLocality()
```
    Internal Getter for Locality. The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the Internal String
  - getLocality
```
public String getLocality()
```
    Getter for Locality. The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the String
  - internalGetSublocality
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetSublocality()
```
    Internal Getter for Sublocality. A civil region within the address's `locality`, if any.
    
    Returns:
    
    Returns the Internal String
  - getSublocality
```
public String getSublocality()
```
    Getter for Sublocality. A civil region within the address's `locality`, if any.
    
    Returns:
    
    Returns the String
  - internalGetSublocality2
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetSublocality2()
```
    Internal Getter for Sublocality2. A civil region within the address's `sublocality`, if any.
    
    Returns:
    
    Returns the Internal String
  - getSublocality2
```
public String getSublocality2()
```
    Getter for Sublocality2. A civil region within the address's `sublocality`, if any.
    
    Returns:
    
    Returns the String
  - internalGetSublocality3
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetSublocality3()
```
    Internal Getter for Sublocality3. A civil region within the address's `sublocality_2`, if any.
    
    Returns:
    
    Returns the Internal String
  - getSublocality3
```
public String getSublocality3()
```
    Getter for Sublocality3. A civil region within the address's `sublocality_2`, if any.
    
    Returns:
    
    Returns the String
  - internalGetAdministrativeDistrictLevel1
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetAdministrativeDistrictLevel1()
```
    Internal Getter for AdministrativeDistrictLevel1. A civil entity within the address's country. In the US, this is the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the Internal String
  - getAdministrativeDistrictLevel1
```
public String getAdministrativeDistrictLevel1()
```
    Getter for AdministrativeDistrictLevel1. A civil entity within the address's country. In the US, this is the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the String
  - internalGetAdministrativeDistrictLevel2
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetAdministrativeDistrictLevel2()
```
    Internal Getter for AdministrativeDistrictLevel2. A civil entity within the address's `administrative_district_level_1`. In the US, this is the county.
    
    Returns:
    
    Returns the Internal String
  - getAdministrativeDistrictLevel2
```
public String getAdministrativeDistrictLevel2()
```
    Getter for AdministrativeDistrictLevel2. A civil entity within the address's `administrative_district_level_1`. In the US, this is the county.
    
    Returns:
    
    Returns the String
  - internalGetAdministrativeDistrictLevel3
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetAdministrativeDistrictLevel3()
```
    Internal Getter for AdministrativeDistrictLevel3. A civil entity within the address's `administrative_district_level_2`, if any.
    
    Returns:
    
    Returns the Internal String
  - getAdministrativeDistrictLevel3
```
public String getAdministrativeDistrictLevel3()
```
    Getter for AdministrativeDistrictLevel3. A civil entity within the address's `administrative_district_level_2`, if any.
    
    Returns:
    
    Returns the String
  - internalGetPostalCode
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPostalCode()
```
    Internal Getter for PostalCode. The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the Internal String
  - getPostalCode
```
public String getPostalCode()
```
    Getter for PostalCode. The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the String
  - getCountry
```
public String getCountry()
```
    Getter for Country. Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).
    
    Returns:
    
    Returns the String
  - internalGetFirstName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetFirstName()
```
    Internal Getter for FirstName. Optional first name when it's representing recipient.
    
    Returns:
    
    Returns the Internal String
  - getFirstName
```
public String getFirstName()
```
    Getter for FirstName. Optional first name when it's representing recipient.
    
    Returns:
    
    Returns the String
  - internalGetLastName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetLastName()
```
    Internal Getter for LastName. Optional last name when it's representing recipient.
    
    Returns:
    
    Returns the Internal String
  - getLastName
```
public String getLastName()
```
    Getter for LastName. Optional last name when it's representing recipient.
    
    Returns:
    
    Returns the String
  - 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 Address into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Address.Builder toBuilder()
```
    Builds a new Address.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Address.Builder object

Class Address

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Address

Address

Method Detail

internalGetAddressLine1

getAddressLine1

internalGetAddressLine2

getAddressLine2

internalGetAddressLine3

getAddressLine3

internalGetLocality

getLocality

internalGetSublocality

getSublocality

internalGetSublocality2

getSublocality2

internalGetSublocality3

getSublocality3

internalGetAdministrativeDistrictLevel1

getAdministrativeDistrictLevel1

internalGetAdministrativeDistrictLevel2

getAdministrativeDistrictLevel2

internalGetAdministrativeDistrictLevel3

getAdministrativeDistrictLevel3

internalGetPostalCode

getPostalCode

getCountry

internalGetFirstName

getFirstName

internalGetLastName

getLastName

hashCode

equals

toString

toBuilder