Duffel.OrderChangeOffers (Duffel v0.1.0)

Copy Markdown View Source

Retrieve the offers returned by an order change request.

See the Duffel documentation.

Summary

Functions

Retrieves a single order change offer by ID.

Lists one page of order change offers.

Lazily streams all order change offers across pages.

Functions

get(client, id)

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

Retrieves a single order change offer by ID.

list(client, params)

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

Lists one page of order change offers.

Parameters

  • :order_change_request_id - the change request to list offers for (required)
  • :sort - "change_total_amount" or "total_duration", prefix with - for descending
  • :max_connections - maximum number of connections (default 1)
  • :limit / :after / :before - pagination (see Duffel.Page)

stream(client, params)

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

Lazily streams all order change offers across pages.

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