Skip to content

Address

Used by
Source code in docs_src/capo_snowball/types/address.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class Address(TypedDict, closed=True):
    address_id: NotRequired["capo_snowball.types.address_id.AddressId"]
    """<p>The unique ID for an address.</p>"""
    name: NotRequired["capo_snowball.types.string.String"]
    """<p>The name of a person to receive a Snow device at an address.</p>"""
    company: NotRequired["capo_snowball.types.string.String"]
    """<p>The name of the company to receive a Snow device at an address.</p>"""
    street1: NotRequired["capo_snowball.types.string.String"]
    """<p>The first line in a street address that a Snow device is to be delivered to.</p>"""
    street2: NotRequired["capo_snowball.types.string.String"]
    """<p>The second line in a street address that a Snow device is to be delivered to.</p>"""
    street3: NotRequired["capo_snowball.types.string.String"]
    """<p>The third line in a street address that a Snow device is to be delivered to.</p>"""
    city: NotRequired["capo_snowball.types.string.String"]
    """<p>The city in an address that a Snow device is to be delivered to.</p>"""
    state_or_province: NotRequired["capo_snowball.types.string.String"]
    """<p>The state or province in an address that a Snow device is to be delivered to.</p>"""
    prefecture_or_district: NotRequired["capo_snowball.types.string.String"]
    """<p>This field is no longer used and the value is ignored.</p>"""
    landmark: NotRequired["capo_snowball.types.string.String"]
    """<p>This field is no longer used and the value is ignored.</p>"""
    country: NotRequired["capo_snowball.types.string.String"]
    """<p>The country in an address that a Snow device is to be delivered to.</p>"""
    postal_code: NotRequired["capo_snowball.types.string.String"]
    """<p>The postal code in an address that a Snow device is to be delivered to.</p>"""
    phone_number: NotRequired["capo_snowball.types.string.String"]
    """<p>The phone number associated with an address that a Snow device is to be delivered to.</p>"""
    is_restricted: "capo_snowball.types.boolean.Boolean"
    """<p>If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.</p>"""
    type: NotRequired["capo_snowball.types.address_type.AddressType"]
    """<p>Differentiates between delivery address and pickup address in the customer account. Provided at job creation.</p>"""

address_id instance-attribute 

address_id: NotRequired[AddressId]

The unique ID for an address.

city instance-attribute 

city: NotRequired[String]

The city in an address that a Snow device is to be delivered to.

company instance-attribute 

company: NotRequired[String]

The name of the company to receive a Snow device at an address.

country instance-attribute 

country: NotRequired[String]

The country in an address that a Snow device is to be delivered to.

is_restricted instance-attribute 

is_restricted: Boolean

If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

landmark instance-attribute 

landmark: NotRequired[String]

This field is no longer used and the value is ignored.

name instance-attribute 

name: NotRequired[String]

The name of a person to receive a Snow device at an address.

phone_number instance-attribute 

phone_number: NotRequired[String]

The phone number associated with an address that a Snow device is to be delivered to.

postal_code instance-attribute 

postal_code: NotRequired[String]

The postal code in an address that a Snow device is to be delivered to.

prefecture_or_district instance-attribute 

prefecture_or_district: NotRequired[String]

This field is no longer used and the value is ignored.

state_or_province instance-attribute 

state_or_province: NotRequired[String]

The state or province in an address that a Snow device is to be delivered to.

street1 instance-attribute 

street1: NotRequired[String]

The first line in a street address that a Snow device is to be delivered to.

street2 instance-attribute 

street2: NotRequired[String]

The second line in a street address that a Snow device is to be delivered to.

street3 instance-attribute 

street3: NotRequired[String]

The third line in a street address that a Snow device is to be delivered to.

type instance-attribute 

type: NotRequired[AddressType]

Differentiates between delivery address and pickup address in the customer account. Provided at job creation.