Travel.Client (travel v0.2.0)

Copy Markdown View Source

HTTP client for the Duffel API built on Req.

Handles authentication, request formatting, response parsing, and error handling.

Request Format

All POST/PATCH requests wrap the payload in a data key as required by the Duffel API:

# You pass: %{check_in_date: "2025-06-01"}
# API receives: %{data: %{check_in_date: "2025-06-01"}}

Response Format

Responses are parsed into {:ok, Travel.Types.DuffelResponse} tuples. Errors are returned as {:error, Travel.Error} tuples.

Summary

Functions

request(config, method, path, body \\ nil, query_params \\ nil)

Makes an HTTP request to the Duffel API.

stream(config, path, query_params \\ nil)

Makes a paginated request that returns a stream of all pages.

Functions

request(config, method, path, body \\ nil, query_params \\ nil)

@spec request(
  Travel.t(),
  atom(),
  String.t(),
  map() | nil,
  map() | nil
) ::
  {:ok, Travel.Types.DuffelResponse.t()} | {:error, Travel.Error.t() | term()}

Makes an HTTP request to the Duffel API.

Parameters

  • config - A Travel configuration struct
  • method - HTTP method (:get, :post, :patch, :delete)
  • path - API path (e.g., "stays/search")
  • body - (optional) Request body, will be wrapped in data key
  • query_params - (optional) Query string parameters

Returns

  • {:ok, %T.DuffelResponse{}} on success
  • {:error, %Travel.Error{}} on API error
  • {:error, reason} on network/HTTP error

Examples

config = Travel.new(access_token: "duffel_test_xxx")

Travel.Client.request(config, :post, "stays/search", %{
  location: %{...},
  check_in_date: "2025-06-01",
  check_out_date: "2025-06-05",
  rooms: 1,
  guests: [%{type: "adult"}]
})

stream(config, path, query_params \\ nil)

@spec stream(Travel.t(), String.t(), map() | nil) :: Enumerable.t()

Makes a paginated request that returns a stream of all pages.

Uses cursor-based pagination. Each page is yielded as it's fetched.

Examples

config = Travel.new(access_token: "duffel_test_xxx")

Travel.Client.stream(config, "stays/bookings")
|> Enum.each(fn response ->
  IO.inspect(response.data)
end)