AddressValue Class

An address field value.

New in version 2023-07-31: The unit, city_district, state_district, suburb, house, and level properties.

Inheritance

builtins.object

AddressValue

Constructor

AddressValue(**kwargs: Any)

Methods

from_dict	Converts a dict in the shape of a AddressValue to the model itself.
to_dict	Returns a dict representation of AddressValue.

from_dict

Converts a dict in the shape of a AddressValue to the model itself.

from_dict(data: Dict) -> AddressValue

Parameters

Name	Description
data Required	dict A dictionary in the shape of AddressValue.

Returns

Type	Description
AddressValue	AddressValue

to_dict

Returns a dict representation of AddressValue.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

city

Name of city, town, village, etc.

city: str | None

city_district

Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.

city_district: str | None

country_region

Country/region.

country_region: str | None

house

Building name, such as World Trade Center.

house: str | None

house_number

House or building number.

house_number: str | None

level

Floor number, such as 3F.

level: str | None

po_box

Post office box number.

po_box: str | None

postal_code

Postal code used for mail sorting.

postal_code: str | None

road

Street name.

road: str | None

state

First-level administrative division.

state: str | None

state_district

Second-level administrative division used in certain locales.

state_district: str | None

street_address

Street-level address, excluding city, state, countryRegion, and postalCode.

street_address: str | None

suburb

Unofficial neighborhood name, like Chinatown.

suburb: str | None

unit

Apartment or office number.

unit: str | None