Duffel.PartialOfferRequests (Duffel v0.1.0)

Copy Markdown View Source

Multi-step flight search: offers are returned per slice independently.

Select one partial offer per slice, then fetch the full fares for the combination with fares/3.

See the Duffel documentation.

Summary

Functions

Creates a partial offer request.

Fetches the full fares for one selected partial offer per slice.

Retrieves a partial offer request.

Functions

create(client, params, opts \\ [])

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

Creates a partial offer request.

Takes the same search parameters as Duffel.OfferRequests.create/3.

Options

  • :params - query string parameters, e.g. params: [supplier_timeout: 10_000]

fares(client, id, selected_partial_offers)

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

Fetches the full fares for one selected partial offer per slice.

Examples

Duffel.PartialOfferRequests.fares(client, "prq_123", ["off_1", "off_2"])

get(client, id, opts \\ [])

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

Retrieves a partial offer request.

Pass :selected_partial_offers (a list of partial offer IDs already selected for previous slices) to get offers for the next slice.

Examples

Duffel.PartialOfferRequests.get(client, "prq_123",
  selected_partial_offers: ["off_1", "off_2"]
)