Skip to content

TranslationName

Source code in docs_src/capo_geo_places/types/translation_name.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class TranslationName(TypedDict, closed=True):
    value: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The translated or alternative name value.</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 code for the translation name.</p>"""
    type: "capo_geo_places.types.translation_name_type.TranslationNameType"
    """<p>The type of translation name. Valid values are <code>Abbreviation</code>, <code>AreaCode</code>, <code>BaseName</code>, <code>Exonym</code>, <code>Shortened</code>, and <code>Synonym</code>.</p>"""
    primary: NotRequired["capo_geo_places.types.sensitive_boolean.SensitiveBoolean"]
    """<p>If <code>true</code>, indicates this is the primary name variant for the given language.</p>"""
    transliterated: NotRequired[
        "capo_geo_places.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>If <code>true</code>, indicates this name is a transliterated version rather than a native script translation.</p>"""

language instance-attribute 

language: NotRequired[LanguageTag]

A BCP 47 compliant language code for the translation name.

primary instance-attribute 

primary: NotRequired[SensitiveBoolean]

If true, indicates this is the primary name variant for the given language.

transliterated instance-attribute 

transliterated: NotRequired[SensitiveBoolean]

If true, indicates this name is a transliterated version rather than a native script translation.

type instance-attribute 

type: TranslationNameType

The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.

value instance-attribute 

value: SensitiveString

The translated or alternative name value.