Address
March 27, 2019 ยท View on GitHub
Description
Represents a physical address.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| address_line_1 | getAddressLine1() | setAddressLine1($value) | string | 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). | [optional] |
| address_line_2 | getAddressLine2() | setAddressLine2($value) | string | The second line of the address, if any. | [optional] |
| address_line_3 | getAddressLine3() | setAddressLine3($value) | string | The third line of the address, if any. | [optional] |
| locality | getLocality() | setLocality($value) | string | The city or town of the address. | [optional] |
| sublocality | getSublocality() | setSublocality($value) | string | A civil region within the address's `locality`, if any. | [optional] |
| sublocality_2 | getSublocality2() | setSublocality2($value) | string | A civil region within the address's `sublocality`, if any. | [optional] |
| sublocality_3 | getSublocality3() | setSublocality3($value) | string | A civil region within the address's `sublocality_2`, if any. | [optional] |
| administrative_district_level_1 | getAdministrativeDistrictLevel1() | setAdministrativeDistrictLevel1($value) | string | A civil entity within the address's country. In the US, this is the state. | [optional] |
| administrative_district_level_2 | getAdministrativeDistrictLevel2() | setAdministrativeDistrictLevel2($value) | string | A civil entity within the address's `administrative_district_level_1`. In the US, this is the county. | [optional] |
| administrative_district_level_3 | getAdministrativeDistrictLevel3() | setAdministrativeDistrictLevel3($value) | string | A civil entity within the address's `administrative_district_level_2`, if any. | [optional] |
| postal_code | getPostalCode() | setPostalCode($value) | string | The address's postal code. | [optional] |
| country | getCountry() | setCountry($value) | string | The address's country, in ISO 3166-1-alpha-2 format. See Country for possible values | [optional] |
| first_name | getFirstName() | setFirstName($value) | string | Optional first name when it's representing recipient. | [optional] |
| last_name | getLastName() | setLastName($value) | string | Optional last name when it's representing recipient. | [optional] |
| organization | getOrganization() | setOrganization($value) | string | Optional organization name when it's representing recipient. | [optional] |
Note: All properties are protected and only accessed via getters and setters.