Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AddressModel

Identifies a geographic address

Hierarchy

  • Meta<any>
    • AddressModel

Index

Properties

alpha2Code?: string
bbox?: Bbox

Bounding box of extracted value

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

country?: string
display?: boolean
district?: string
errors?: ErrorModel[]

could be validation errors

formattedAddress?: string
input?: string

The input value which was initially supplied for the property

isEU?: boolean
lastChangedBy?: String

Encoded user (username, userId, etc.)

deprecated
latitude?: number
locality?: string
longitude?: number
modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

modifiedBy?: { displayName?: string; id?: string }

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string
options?: any[]
plusCode?: string
postalCode?: string
province?: string
provinceCode?: string
reason?: any
required?: boolean
reviewNeeded?: boolean
searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

source?: String
streetName?: string
streetNumber?: string
sublocality?: string
treatyMemberships?: string[]
userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

value?: any

The current value of the property

Generated using TypeDoc