ClassAddress

Address API object

Hierarchy (view full)

ContactMultipleComponent
- Address

Index

Constructors

Properties

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

Constructors

constructor

new Address(country?, country_code?, state?, city?, street?, zip?, type?): 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:189

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