Skip to content

StreetComponents

Source code in docs_src/capo_geo_places/types/street_components.py
class StreetComponents(TypedDict, closed=True):
    base_name: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>Base name part of the street name. </p> <p>Example: Younge from the "Younge street".</p>"""
    type: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>Street type part of the street name. </p> <p>Example: <code>"avenue"</code>.</p>"""
    type_placement: NotRequired["capo_geo_places.types.type_placement.TypePlacement"]
    """<p>Defines if the street type is before or after the base name.</p>"""
    type_separator: NotRequired["capo_geo_places.types.type_separator.TypeSeparator"]
    """<p>Defines a separator character such as <code>""</code> or <code>" "</code> between the base name and type.</p>"""
    prefix: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>A prefix is a directional identifier that precedes, but is not included in, the base name of a road. </p> <p>Example: E for East.</p>"""
    suffix: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>A suffix is a directional identifier that follows, but is not included in, the base name of a road. </p> <p>Example W for West.</p>"""
    direction: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>Indicates the official directional identifiers assigned to highways.</p>"""
    language: NotRequired["capo_geo_places.types.language_tag.LanguageTag"]
    """<p>A <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.</p>"""

base_name instance-attribute

base_name: NotRequired[SensitiveString]

Base name part of the street name.

Example: Younge from the "Younge street".

direction instance-attribute

direction: NotRequired[SensitiveString]

Indicates the official directional identifiers assigned to highways.

language instance-attribute

language: NotRequired[LanguageTag]

A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

prefix instance-attribute

prefix: NotRequired[SensitiveString]

A prefix is a directional identifier that precedes, but is not included in, the base name of a road.

Example: E for East.

suffix instance-attribute

suffix: NotRequired[SensitiveString]

A suffix is a directional identifier that follows, but is not included in, the base name of a road.

Example W for West.

type instance-attribute

type: NotRequired[SensitiveString]

Street type part of the street name.

Example: "avenue".

type_placement instance-attribute

type_placement: NotRequired[TypePlacement]

Defines if the street type is before or after the base name.

type_separator instance-attribute

type_separator: NotRequired[TypeSeparator]

Defines a separator character such as "" or " " between the base name and type.