Module Values.AddressSource

The place address.

Sourcetype nonrec t = {
  1. label : AddressLabelString.t option;
    (*

    Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.

    *)
  2. country : Country.t option;
    (*

    The country component of the address.

    *)
  3. region : Region.t option;
    (*

    The region or state results should be present in. Example: North Rhine-Westphalia.

    *)
  4. subRegion : SubRegion.t option;
    (*

    The sub-region or county for which results should be present in.

    *)
  5. locality : AddressLocalityString.t option;
    (*

    The city or locality of the address. Example: Vancouver.

    *)
  6. district : AddressDistrictString.t option;
    (*

    The district or division of a locality associated with this address.

    *)
  7. subDistrict : AddressSubDistrictString.t option;
    (*

    A subdivision of a district. Example: Minden-Lübbecke.

    *)
  8. postalCode : AddressPostalCodeString.t option;
    (*

    An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.

    *)
  9. block : AddressBlockString.t option;
    (*

    Name of the block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Example: Sunny Mansion 203 block: 2 Chome

    *)
  10. subBlock : AddressSubBlockString.t option;
    (*

    Name of sub-block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Example: Sunny Mansion 203 sub-block: 4

    *)
  11. intersection : IntersectionStreetList.t option;
    (*

    Name of the streets in the intersection. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Example: ["Friedrichstraße","Unter den Linden"]

    *)
  12. street : AddressStreetString.t option;
    (*

    The name of the street results should be present in.

    *)
  13. streetComponents : StreetComponentsList.t option;
    (*

    Components of the street. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Example: Yonge from "Yonge street".

    *)
  14. addressNumber : AddressAddressNumberString.t option;
    (*

    The number that identifies an address within a street.

    *)
  15. building : AddressBuildingString.t option;
    (*

    The name of the building at the address. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  16. secondaryAddressComponents : SecondaryAddressComponentList.t option;
    (*

    Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Coverage for Address.SecondaryAddressComponents is available in the following countries: AUS, CAN, NZL, USA, PRI

    *)
}
Sourceval make : ?label:??? -> ?country:??? -> ?region:??? -> ?subRegion:??? -> ?locality:??? -> ?district:??? -> ?subDistrict:??? -> ?postalCode:??? -> ?block:??? -> ?subBlock:??? -> ?intersection:??? -> ?street:??? -> ?streetComponents:??? -> ?addressNumber:??? -> ?building:??? -> ?secondaryAddressComponents:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `String of IntersectionStreet.t | `Structure of (string * [> `Enum of string | `String of StreetComponentsBaseNameString.t ]) list ] list | `String of AddressLabelString.t | `Structure of (string * [> `String of CountryCode2.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t