Class Address

Address API object

Hierarchy (View Summary)

ContactMultipleComponent
- Address

Index

Constructors

Properties

city? country? country_code? state? street? type? zip?

Constructors

constructor

new Address(
    country?: string,
    country_code?: string,
    state?: string,
    city?: string,
    street?: string,
    zip?: string,
    type?: string,
): Address
Builds an address object for a contact. A contact can contain multiple addresses objects.
Parameters
- Optionalcountry: string
  Full country name
- Optionalcountry_code: string
  Two-letter country abbreviation
- Optionalstate: string
  State abbreviation
- Optionalcity: string
  City name
- Optionalstreet: string
  Street number and name
- Optionalzip: string
  ZIP code
- Optionaltype: string
  Address type. Standard Values: HOME, WORK
Returns Address
Overrides ContactMultipleComponent.constructor
- Defined in src/messages/contacts.ts:188

Properties

`Optional` `Readonly`city

city?: string

The city of the address

`Optional` `Readonly`country

country?: string

The country of the address

`Optional` `Readonly`country_code

country_code?: string

The country code of the address

`Optional` `Readonly`state

state?: string

The state of the address

`Optional` `Readonly`street

street?: string

The street of the address

`Optional` `Readonly`type

type?: string

The type of the address

`Optional` `Readonly`zip

zip?: string

The zip code of the address