action neutrinoapi_geocode_address {
  label: "Geocode Address"
  description: "Geocode an address, partial address or just the name of a place"
  provider: neutrinoapi
  method: GET
  path: "/geocode-address"
  encoding: json
  input: {
    type: "object"
    properties: {
      address: {
        type: "string"
      }
      city: {
        type: "string"
      }
      "country-code": {
        type: "string"
      }
      county: {
        type: "string"
      }
      "fuzzy-search": {
        type: "boolean"
      }
      "house-number": {
        type: "string"
      }
      "language-code": {
        type: "string"
      }
      "postal-code": {
        type: "string"
      }
      state: {
        type: "string"
      }
      street: {
        type: "string"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["found", "locations"]
    properties: {
      found: {
        type: "integer"
        format: "int32"
        description: "The number of possible matching locations found"
      }
      locations: {
        type: "array"
        description: "Array of matching location objects"
        items: {
          type: "object"
          required: ["country", "address", "city", "country-code", "country-code3", "latitude", "postal-code", "longitude", "state", "address-components", "currency-code", "location-type", "location-tags", "timezone", "region-code", "postal-address"]
          properties: {
            address: {
              type: "string"
              description: "The complete address using comma-separated values"
            }
            "address-components": {
              type: "object"
              description: "The components which make up the address such as road, city, state, etc"
            }
            city: {
              type: "string"
              description: "The city of the location"
            }
            country: {
              type: "string"
              description: "The country of the location"
            }
            "country-code": {
              type: "string"
              description: "The ISO 2-letter country code of the location"
            }
            "country-code3": {
              type: "string"
              description: "The ISO 3-letter country code of the location"
            }
            "currency-code": {
              type: "string"
              description: "ISO 4217 currency code associated with the country"
            }
            latitude: {
              type: "number"
              format: "double"
              description: "The location latitude"
            }
            "location-tags": {
              type: "array"
              description: "Array of strings containing any location tags associated with the address. Tags are additional pieces of metadata about a specific location, there are thousands of different tags. Some examples of tags: shop, office, cafe, bank, pub"
              items: {
                type: "string"
              }
            }
            "location-type": {
              type: "string"
              description: "The detected location type ordered roughly from most to least precise, possible values are: <br> <ul> <li>address - indicates a precise street address</li> <li>street - accurate to the street level but may not point to the exact location of the house/building number</li> <li>city - accurate to the city level, this includes villages, towns, suburbs, etc</li> <li>postal-code - indicates a postal code area (no house or street information present)</li> <li>railway - location is part of a rail network such as a station or railway track</li> <li>natural - indicates a natural feature, for example a mountain peak or a waterway</li> <li>island - location is an island or archipelago</li> <li>administrative - indicates an administrative boundary such as a country, state or province</li> </ul>"
            }
            longitude: {
              type: "number"
              format: "double"
              description: "The location longitude"
            }
            "postal-address": {
              type: "string"
              description: "The formatted address using local standards suitable for printing on an envelope"
            }
            "postal-code": {
              type: "string"
              description: "The postal code for the location"
            }
            "region-code": {
              type: "string"
              description: "The ISO 3166-2 region code for the location"
            }
            state: {
              type: "string"
              description: "The state of the location"
            }
            timezone: {
              type: "object"
              description: "Map containing timezone details for the location"
            }
          }
        }
      }
    }
  }
}