import type * as Square from "../index"; /** * Represents a postal address in a country. * For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). */ export interface Address { /** * 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). */ addressLine1?: string | null; /** The second line of the address, if any. */ addressLine2?: string | null; /** The third line of the address, if any. */ addressLine3?: string | null; /** 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). */ locality?: string | null; /** A civil region within the address's `locality`, if any. */ sublocality?: string | null; /** A civil region within the address's `sublocality`, if any. */ sublocality2?: string | null; /** A civil region within the address's `sublocality_2`, if any. */ sublocality3?: string | null; /** * 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). */ administrativeDistrictLevel1?: string | null; /** * A civil entity within the address's `administrative_district_level_1`. * In the US, this is the county. */ administrativeDistrictLevel2?: string | null; /** * A civil entity within the address's `administrative_district_level_2`, * if any. */ administrativeDistrictLevel3?: string | null; /** 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). */ postalCode?: string | null; /** * The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`. * See [Country](#type-country) for possible values */ country?: Square.Country; /** Optional first name when it's representing recipient. */ firstName?: string | null; /** Optional last name when it's representing recipient. */ lastName?: string | null; }