Address

class Address

The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The unique ID for an address.

Link copied to clipboard
val city: String?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val name: String?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: Address.Builder.() -> Unit = {}): Address
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String