Duffel.OfferRequests.SearchParams (Duffel v0.1.0)

Copy Markdown View Source

Build the request body for Duffel.OfferRequests.create/3.

new/1 assembles the params map and checks the required fields are present. slice/4 and passenger/1 build the journeys to search and the passengers travelling.

params =
  Duffel.OfferRequests.SearchParams.new(
    slices: [
      Duffel.OfferRequests.SearchParams.slice("LHR", "JFK", "2026-07-01")
    ],
    passengers: [Duffel.OfferRequests.SearchParams.passenger(type: "adult")],
    cabin_class: "economy"
  )

Duffel.OfferRequests.create(client, params)

Using the builder is optional — create/3 still accepts a plain map.

Summary

Functions

new(opts)

Builds an offer request params map.

passenger(opts \\ [])

Builds a passenger. Accepts :type ("adult", "child", "infant_without_seat") or :age, plus optional :given_name, :family_name, :fare_type and :loyalty_programme_accounts. Absent fields are omitted.

slice(origin, destination, departure_date, opts \\ [])

Builds a slice (one leg of the journey) from origin and destination IATA codes and a departure_date (YYYY-MM-DD).

Functions

new(opts)

@spec new(keyword()) :: map()

Builds an offer request params map.

Required: :slices and :passengers. Optional: :cabin_class, :max_connections, :private_fares and :airline_credit_ids. Raises ArgumentError if a required option is missing.

passenger(opts \\ [])

@spec passenger(keyword()) :: map()

Builds a passenger. Accepts :type ("adult", "child", "infant_without_seat") or :age, plus optional :given_name, :family_name, :fare_type and :loyalty_programme_accounts. Absent fields are omitted.

slice(origin, destination, departure_date, opts \\ [])

@spec slice(String.t(), String.t(), String.t(), keyword()) :: map()

Builds a slice (one leg of the journey) from origin and destination IATA codes and a departure_date (YYYY-MM-DD).

Pass :departure_time or :arrival_time as %{from: "09:00", to: "12:00"} to restrict the times of day.