woosmap-sdk/com.woosmap.sdk.api.localities

Package-level declarations

Contains models data classes for Localities API.

Types

data class AddressComponentsInner(val longName: StringOrStringArray? = null, val shortName: StringOrStringArray? = null, val types: List<String>? = null)

The address component object

CcFormat

enum CcFormat : Enum<CcFormat>

enum for parameter ccFormat

Data

enum Data : Enum<Data>

enum for parameter Data

Extended

enum Extended : Enum<Extended>

enum for parameter extended

Fields

enum Fields : Enum<Fields>

enum for parameter fields

LocalitiesAddressGeometry

data class LocalitiesAddressGeometry(val locationType: LocalitiesAddressGeometry.LocationType? = null, val location: LatLng? = null, val viewport: LatLngBounds? = null)

The location of the result, in latitude and longitude. Accuracy is also provided.

LocalitiesAddressSummary

typealias LocalitiesAddressSummary = LocalitiesDetailsResponseResultAddressesListInner

LocalitiesAutocompleteCollectionResponse

data class LocalitiesAutocompleteCollectionResponse(val localities: List<LocalitiesAutocompleteResponse>? = null)

Localities Collection Response containing Localities

LocalitiesAutocompleteMatchedFields

data class LocalitiesAutocompleteMatchedFields(val description: List<MatchedSubstring>? = null, val name: List<MatchedSubstring>? = null, val admin0: List<MatchedSubstring>? = null, val admin1: List<MatchedSubstring>? = null, val admin2: List<MatchedSubstring>? = null, val postalTown: List<MatchedSubstring>? = null)

Contains a set of substrings for each field (description, name, admin_0, admin_1, admin_2, postal_town) that match elements in the input. It can be used to highlight those substrings. Each substring is identified by an offset and a length.`

LocalitiesAutocompleteResponse

data class LocalitiesAutocompleteResponse(val publicId: String, val type: LocalitiesTypes, val description: String, val matchedSubstrings: LocalitiesAutocompleteMatchedFields, val hasAddresses: Boolean)

Attributes describing a locality. Not all attributes will be available for all locality types.

LocalitiesDetailsResponse

data class LocalitiesDetailsResponse(val result: LocalitiesDetailsResponseResult)

LocalitiesDetailsResponseResult

data class LocalitiesDetailsResponseResult(val formattedAddress: String, val types: List<LocalitiesTypes>, val publicId: String, val geometry: LocalitiesDetailsResponseResultGeometry, val addressComponents: List<AddressComponentsInner>, val status: LocalitiesStatus? = null, val name: String? = null, val addresses: LocalitiesDetailsResponseResultAddresses? = null)

The Root Node for Localities Details

LocalitiesDetailsResponseResultAddresses

data class LocalitiesDetailsResponseResultAddresses(val list: List<LocalitiesDetailsResponseResultAddressesListInner>? = null)

UK Only. List of addresses attached to this Postal Code.

LocalitiesDetailsResponseResultAddressesListInner

data class LocalitiesDetailsResponseResultAddressesListInner(val description: String, val publicId: String)

LocalitiesDetailsResponseResultGeometry

data class LocalitiesDetailsResponseResultGeometry(val location: LatLng, val viewport: LatLngBounds? = null)

The location of the PostalCode, in latitude and longitude, eventually associated with a Viewport.

LocalitiesGeocodeCollectionResponse

data class LocalitiesGeocodeCollectionResponse(val results: List<LocalitiesGeocodeResponse>? = null)

Localities Geocode Collection Response. Contains one or more detailed Localities or Addresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)

LocalitiesGeocodeResponse

data class LocalitiesGeocodeResponse(val formattedAddress: String? = null, val types: List<LocalitiesGeocodeTypes>? = null, val geometry: LocalitiesAddressGeometry? = null, val status: LocalitiesStatus? = null, val addressComponents: List<AddressComponentsInner>? = null, val subBuildings: List<LocalitiesAddressSummary>? = null)

Attributes describing a locality. Not all attributes will be available for all locality types.

LocalitiesGeocodeTypes

enum LocalitiesGeocodeTypes : Enum<LocalitiesGeocodeTypes>

Contains the type of the geocoded suggestion.

LocalitiesStatus

enum LocalitiesStatus : Enum<LocalitiesStatus>

This optional field is only available for UK addresses referenced as not yey built by Royal Mail. Only one value yet.

LocalitiesTypes

enum LocalitiesTypes : Enum<LocalitiesTypes>

Contains the type of the localities suggestion.