GeocodeResultItem ¶

class GeocodeResultItem(TypedDict, closed=True):
    place_id: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The <code>PlaceId</code> of the place result.</p>"""
    place_type: "capo_geo_places.types.place_type.PlaceType"
    """<p>A <code>PlaceType</code> is a category that the result place must belong to.</p>"""
    title: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The localized display name of this result item based on request parameter <code>language</code>. </p>"""
    address: NotRequired["capo_geo_places.types.address.Address"]
    """<p>The place's address.</p>"""
    address_number_corrected: NotRequired[
        "capo_geo_places.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>Boolean indicating if the address provided has been corrected.</p>"""
    postal_code_details: NotRequired[
        "capo_geo_places.types.postal_code_details_list.PostalCodeDetailsList"
    ]
    """<p>Contains details about the postal code of the place/result. </p>"""
    position: NotRequired["capo_geo_places.types.position.Position"]
    """<p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>"""
    distance: "capo_geo_places.types.distance_meters.DistanceMeters"
    """<p>The distance in meters from the QueryPosition.</p>"""
    map_view: NotRequired["capo_geo_places.types.bounding_box.BoundingBox"]
    """<p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]</code> </p>"""
    categories: NotRequired["capo_geo_places.types.category_list.CategoryList"]
    """<p>Categories of results that results must belong to.</p>"""
    food_types: NotRequired["capo_geo_places.types.food_type_list.FoodTypeList"]
    """<p>List of food types offered by this result.</p>"""
    access_points: NotRequired[
        "capo_geo_places.types.access_point_list.AccessPointList"
    ]
    """<p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>"""
    time_zone: NotRequired["capo_geo_places.types.time_zone.TimeZone"]
    """<p>The time zone in which the place is located.</p>"""
    political_view: NotRequired["capo_geo_places.types.country_code3.CountryCode3"]
    """<p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.</p>"""
    match_scores: NotRequired[
        "capo_geo_places.types.match_score_details.MatchScoreDetails"
    ]
    """<p>Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.</p>"""
    parsed_query: NotRequired[
        "capo_geo_places.types.geocode_parsed_query.GeocodeParsedQuery"
    ]
    """<p>Free-form text query.</p>"""
    intersections: NotRequired[
        "capo_geo_places.types.intersection_list.IntersectionList"
    ]
    """<p>All Intersections that are near the provided address.</p>"""
    main_address: NotRequired["capo_geo_places.types.related_place.RelatedPlace"]
    """<p>The main address corresponding to a place of type Secondary Address.</p>"""
    secondary_addresses: NotRequired[
        "capo_geo_places.types.related_place_list.RelatedPlaceList"
    ]
    """<p>All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.</p> <note> <p>Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.</p> </note>"""
    translations: NotRequired[
        "capo_geo_places.types.translation_details.TranslationDetails"
    ]
    """<p>All name translations and alternative names for the requested address fields in all available languages.</p>"""
    estimated_point_address: NotRequired[
        "capo_geo_places.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>If <code>true</code>, indicates that the coordinates of the position and access points of the point address are estimated.</p>"""