AutocompleteAddressHighlights ¶

class AutocompleteAddressHighlights(TypedDict, closed=True):
    label: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.</p>"""
    country: NotRequired["capo_geo_places.types.country_highlights.CountryHighlights"]
    """<p>The alpha-2 or alpha-3 character code for the country that the results will be present in.</p>"""
    region: NotRequired["capo_geo_places.types.region_highlights.RegionHighlights"]
    """<p>The region or state results should be to be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>"""
    sub_region: NotRequired[
        "capo_geo_places.types.sub_region_highlights.SubRegionHighlights"
    ]
    """<p>The sub-region or county for which results should be present in. </p>"""
    locality: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>The city or locality results should be present in. </p> <p>Example: <code>Vancouver</code>.</p>"""
    district: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>The district or division of a city the results should be present in.</p>"""
    sub_district: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>Indicates the starting and ending index of the title in the text query that match the found title. </p>"""
    street: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>The name of the street results should be present in.</p>"""
    block: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>Name of the block. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>"""
    sub_block: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>Name of sub-block. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>"""
    intersection: NotRequired[
        "capo_geo_places.types.intersection_highlights_list.IntersectionHighlightsList"
    ]
    """<p>Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]</p>"""
    postal_code: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess. </p>"""
    address_number: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>The house number or address results should have. </p>"""
    building: NotRequired["capo_geo_places.types.highlight_list.HighlightList"]
    """<p>The name of the building at the address.</p>"""