Duffel.Airports (Duffel v0.1.0)

Copy Markdown View Source

Look up airport reference data.

See the Duffel documentation.

Summary

Functions

Retrieves a single airport by ID.

Lists one page of airports.

Lazily streams all airports across pages.

Functions

get(client, id)

@spec get(Duffel.Client.t(), String.t()) :: {:ok, map()} | {:error, Duffel.Error.t()}

Retrieves a single airport by ID.

list(client, params \\ [])

@spec list(Duffel.Client.t(), keyword() | map()) ::
  {:ok, Duffel.Page.t()} | {:error, Duffel.Error.t()}

Lists one page of airports.

Parameters

  • :iata_country_code - filter by ISO 3166-1 alpha-2 country code
  • :iata_code - filter by IATA airport code
  • :limit / :after / :before - pagination (see Duffel.Page)

stream(client, params \\ [])

@spec stream(Duffel.Client.t(), keyword() | map()) :: Enumerable.t()

Lazily streams all airports across pages.

Takes the same parameters as list/2. Raises Duffel.Error if a page request fails.