Skip to content

ContactInformation

Source code in docs_src/capo_account/types/contact_information.py
class ContactInformation(TypedDict, closed=True):
    full_name: "capo_account.types.full_name.FullName"
    """<p>The full name of the primary contact address.</p>"""
    address_line1: "capo_account.types.address_line.AddressLine"
    """<p>The first line of the primary contact address.</p>"""
    address_line2: NotRequired["capo_account.types.address_line.AddressLine"]
    """<p>The second line of the primary contact address, if any.</p>"""
    address_line3: NotRequired["capo_account.types.address_line.AddressLine"]
    """<p>The third line of the primary contact address, if any.</p>"""
    city: "capo_account.types.city.City"
    """<p>The city of the primary contact address.</p>"""
    state_or_region: NotRequired["capo_account.types.state_or_region.StateOrRegion"]
    """<p>The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, <code>NJ</code>) or the full state name (for example, <code>New Jersey</code>). This field is required in the following countries: <code>US</code>, <code>CA</code>, <code>GB</code>, <code>DE</code>, <code>JP</code>, <code>IN</code>, and <code>BR</code>.</p>"""
    district_or_county: NotRequired[
        "capo_account.types.district_or_county.DistrictOrCounty"
    ]
    """<p>The district or county of the primary contact address, if any.</p>"""
    postal_code: "capo_account.types.postal_code.PostalCode"
    """<p>The postal code of the primary contact address.</p>"""
    country_code: "capo_account.types.country_code.CountryCode"
    """<p>The ISO-3166 two-letter country code for the primary contact address.</p>"""
    phone_number: "capo_account.types.contact_information_phone_number.ContactInformationPhoneNumber"
    """<p>The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.</p>"""
    company_name: NotRequired["capo_account.types.company_name.CompanyName"]
    """<p>The name of the company associated with the primary contact information, if any.</p>"""
    website_url: NotRequired["capo_account.types.website_url.WebsiteUrl"]
    """<p>The URL of the website associated with the primary contact information, if any.</p>"""

address_line1 instance-attribute

address_line1: AddressLine

The first line of the primary contact address.

address_line2 instance-attribute

address_line2: NotRequired[AddressLine]

The second line of the primary contact address, if any.

address_line3 instance-attribute

address_line3: NotRequired[AddressLine]

The third line of the primary contact address, if any.

city instance-attribute

city: City

The city of the primary contact address.

company_name instance-attribute

company_name: NotRequired[CompanyName]

The name of the company associated with the primary contact information, if any.

country_code instance-attribute

country_code: CountryCode

The ISO-3166 two-letter country code for the primary contact address.

district_or_county instance-attribute

district_or_county: NotRequired[DistrictOrCounty]

The district or county of the primary contact address, if any.

full_name instance-attribute

full_name: FullName

The full name of the primary contact address.

phone_number instance-attribute

The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.

postal_code instance-attribute

postal_code: PostalCode

The postal code of the primary contact address.

state_or_region instance-attribute

state_or_region: NotRequired[StateOrRegion]

The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, NJ) or the full state name (for example, New Jersey). This field is required in the following countries: US, CA, GB, DE, JP, IN, and BR.

website_url instance-attribute

website_url: NotRequired[WebsiteUrl]

The URL of the website associated with the primary contact information, if any.