Skip to content

EndpointLocation

Source code in docs_src/capo_pinpoint/types/endpoint_location.py
class EndpointLocation(TypedDict, closed=True):
    city: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the city where the endpoint is located.</p>"""
    country: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.</p>"""
    latitude: NotRequired["capo_pinpoint.types.__double.__double"]
    """<p>The latitude coordinate of the endpoint location, rounded to one decimal place.</p>"""
    longitude: NotRequired["capo_pinpoint.types.__double.__double"]
    """<p>The longitude coordinate of the endpoint location, rounded to one decimal place.</p>"""
    postal_code: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The postal or ZIP code for the area where the endpoint is located.</p>"""
    region: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.</p>"""

city instance-attribute

city: NotRequired[__string]

The name of the city where the endpoint is located.

country instance-attribute

country: NotRequired[__string]

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

latitude instance-attribute

latitude: NotRequired[__double]

The latitude coordinate of the endpoint location, rounded to one decimal place.

longitude instance-attribute

longitude: NotRequired[__double]

The longitude coordinate of the endpoint location, rounded to one decimal place.

postal_code instance-attribute

postal_code: NotRequired[__string]

The postal or ZIP code for the area where the endpoint is located.

region instance-attribute

region: NotRequired[__string]

The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.