Skip to content

CandidateAddress

Source code in docs_src/capo_chime_sdk_voice/types/candidate_address.py
class CandidateAddress(TypedDict, closed=True):
    street_info: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The street information of the candidate address.</p>"""
    street_number: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The numeric portion of the candidate address.</p>"""
    city: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The city of the candidate address.</p>"""
    state: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The state of the candidate address.</p>"""
    postal_code: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The postal code of the candidate address.</p>"""
    postal_code_plus4: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The zip + 4 or postal code +4 of the candidate address.</p>"""
    country: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The country of the candidate address.</p>"""

city instance-attribute

city: NotRequired[SensitiveNonEmptyString]

The city of the candidate address.

country instance-attribute

country: NotRequired[SensitiveNonEmptyString]

The country of the candidate address.

postal_code instance-attribute

postal_code: NotRequired[SensitiveNonEmptyString]

The postal code of the candidate address.

postal_code_plus4 instance-attribute

postal_code_plus4: NotRequired[SensitiveNonEmptyString]

The zip + 4 or postal code +4 of the candidate address.

state instance-attribute

state: NotRequired[SensitiveNonEmptyString]

The state of the candidate address.

street_info instance-attribute

street_info: NotRequired[SensitiveNonEmptyString]

The street information of the candidate address.

street_number instance-attribute

street_number: NotRequired[SensitiveNonEmptyString]

The numeric portion of the candidate address.