Packages

ex_nominatim

2.1.0
3.0.0 2.1.0 2.0.0 1.1.4 retired 1.1.3 retired 1.1.2 retired 1.1.1 retired 1.1.0 retired 1.0.0 retired

A full-featured client for the OpenStreetMap Nominatim API V1 (public and self-hosted), with extensive request validation, robust error-handling and reporting, rate limiting, optional caching, telemetry instrumentation, retry with exponential backoff, and geohash enrichment.

HexDocs

Current section

Files

Jump to
Readme
9 Versions
1 Dependency
Dependants
Files
Activity
ex_nominatim lib client search_params.ex
Raw

lib/client/search_params.ex 

# SPDX-FileCopyrightText: 2024 Isaak Tsalicoglou <isaak@overbring.com>

# SPDX-License-Identifier: Apache-2.0



defmodule ExNominatim.Client.SearchParams do

  @moduledoc """

  The struct for a request to the `/search` API endpoint.

  """

  @moduledoc since: "1.0.0"



  defstruct [

    :q,

    :amenity,

    :street,

    :city,

    :county,

    :state,

    :country,

    :postalcode,

    :limit,

    :addressdetails,

    :extratags,

    :namedetails,

    :accept_language,

    :countrycodes,

    :layer,

    :featureType,

    :exclude_place_ids,

    :viewbox,

    :bounded,

    :polygon_geojson,

    :polygon_kml,

    :polygon_svg,

    :polygon_text,

    :polygon_threshold,

    :email,

    :dedupe,

    :debug,

    :format,

    valid?: nil,

    errors: []

  ]



  @required []



  @doc """

  Construct a new `%SearchParams{}` struct from the content of the keyword list `opts`, while taking into account that a request to the `/reverse` API endpoint requires either a free-form query with the keyword `:q` assigned a value _or_ a structured query with values defined for at least one of `:amenity`, `:street`, `:city`, `:county`, `:state`, `:country` and `:postalcode`, but not both.

  """



  def new(opts), do: ExNominatim.Client.new(opts, @required, __MODULE__)

end