Skip to content

Address

Source code in docs_src/capo_identitystore/types/address.py
class Address(TypedDict, closed=True):
    street_address: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The street of the address.</p>"""
    locality: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string of the address locality.</p>"""
    region: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The region of the address.</p>"""
    postal_code: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The postal code of the address.</p>"""
    country: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The country of the address.</p>"""
    formatted: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing a formatted version of the address for display.</p>"""
    type: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string representing the type of address. For example, "Home."</p>"""
    primary: "capo_identitystore.types.boolean_type.BooleanType"
    """<p>A Boolean value representing whether this is the primary address for the associated resource.</p>"""

country instance-attribute

country: NotRequired[SensitiveStringType]

The country of the address.

formatted instance-attribute

formatted: NotRequired[SensitiveStringType]

A string containing a formatted version of the address for display.

locality instance-attribute

locality: NotRequired[SensitiveStringType]

A string of the address locality.

postal_code instance-attribute

postal_code: NotRequired[SensitiveStringType]

The postal code of the address.

primary instance-attribute

primary: BooleanType

A Boolean value representing whether this is the primary address for the associated resource.

region instance-attribute

region: NotRequired[SensitiveStringType]

The region of the address.

street_address instance-attribute

street_address: NotRequired[SensitiveStringType]

The street of the address.

type instance-attribute

type: NotRequired[SensitiveStringType]

A string representing the type of address. For example, "Home."