Duffel.AirlineCredits (Duffel v0.1.0)

Copy Markdown View Source

Manage airline credits issued to customer users, e.g. from cancellations.

See the Duffel documentation.

Summary

Functions

Creates an airline credit.

Retrieves a single airline credit by ID.

Lists one page of airline credits.

Lazily streams all airline credits across pages.

Functions

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

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

Creates an airline credit.

get(client, id)

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

Retrieves a single airline credit by ID.

list(client, params \\ [])

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

Lists one page of airline credits.

Parameters

  • :user_id - filter by customer user
  • :limit / :after / :before - pagination (see Duffel.Page)

stream(client, params \\ [])

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

Lazily streams all airline credits across pages.

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