Skip to content

Address

Source code in docs_src/capo_outposts/types/address.py
class Address(TypedDict, closed=True):
    contact_name: "capo_outposts.types.contact_name.ContactName"
    """<p>The name of the contact.</p>"""
    contact_phone_number: "capo_outposts.types.contact_phone_number.ContactPhoneNumber"
    """<p>The phone number of the contact, including the country code (for example, <code>+12065550100</code>).</p>"""
    address_line1: "capo_outposts.types.address_line1.AddressLine1"
    """<p>The first line of the address.</p>"""
    address_line2: NotRequired["capo_outposts.types.address_line2.AddressLine2"]
    """<p>The second line of the address.</p>"""
    address_line3: NotRequired["capo_outposts.types.address_line3.AddressLine3"]
    """<p>The third line of the address.</p>"""
    city: "capo_outposts.types.city.City"
    """<p>The city for the address.</p>"""
    state_or_region: "capo_outposts.types.state_or_region.StateOrRegion"
    """<p>The state for the address.</p>"""
    district_or_county: NotRequired[
        "capo_outposts.types.district_or_county.DistrictOrCounty"
    ]
    """<p>The district or county for the address.</p>"""
    postal_code: "capo_outposts.types.postal_code.PostalCode"
    """<p>The postal code for the address.</p>"""
    country_code: "capo_outposts.types.country_code.CountryCode"
    """<p>The ISO-3166 two-letter country code for the address.</p>"""
    municipality: NotRequired["capo_outposts.types.municipality.Municipality"]
    """<p>The municipality for the address.</p>"""

address_line1 instance-attribute

address_line1: AddressLine1

The first line of the address.

address_line2 instance-attribute

address_line2: NotRequired[AddressLine2]

The second line of the address.

address_line3 instance-attribute

address_line3: NotRequired[AddressLine3]

The third line of the address.

city instance-attribute

city: City

The city for the address.

contact_name instance-attribute

contact_name: ContactName

The name of the contact.

contact_phone_number instance-attribute

contact_phone_number: ContactPhoneNumber

The phone number of the contact, including the country code (for example, +12065550100).

country_code instance-attribute

country_code: CountryCode

The ISO-3166 two-letter country code for the address.

district_or_county instance-attribute

district_or_county: NotRequired[DistrictOrCounty]

The district or county for the address.

municipality instance-attribute

municipality: NotRequired[Municipality]

The municipality for the address.

postal_code instance-attribute

postal_code: PostalCode

The postal code for the address.

state_or_region instance-attribute

state_or_region: StateOrRegion

The state for the address.