Skip to content

PostalCodeDetails

Source code in docs_src/capo_geo_places/types/postal_code_details.py
class PostalCodeDetails(TypedDict, closed=True):
    postal_code: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess. </p>"""
    postal_authority: NotRequired[
        "capo_geo_places.types.postal_authority.PostalAuthority"
    ]
    """<p>The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.</p>"""
    postal_code_type: NotRequired[
        "capo_geo_places.types.postal_code_type.PostalCodeType"
    ]
    """<p>The postal code type.</p>"""
    usps_zip: NotRequired["capo_geo_places.types.usps_zip.UspsZip"]
    """<p>The ZIP Classification Code, or in other words what type of postal code is it.</p>"""
    usps_zip_plus4: NotRequired["capo_geo_places.types.usps_zip_plus4.UspsZipPlus4"]
    """<p>The USPS ZIP+4 Record Type Code.</p>"""

postal_authority instance-attribute

postal_authority: NotRequired[PostalAuthority]

The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

postal_code instance-attribute

postal_code: NotRequired[SensitiveString]

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.

postal_code_type instance-attribute

postal_code_type: NotRequired[PostalCodeType]

The postal code type.

usps_zip instance-attribute

usps_zip: NotRequired[UspsZip]

The ZIP Classification Code, or in other words what type of postal code is it.

usps_zip_plus4 instance-attribute

usps_zip_plus4: NotRequired[UspsZipPlus4]

The USPS ZIP+4 Record Type Code.