Duffel.Stays.NegotiatedRates (Duffel v0.1.0)

Copy Markdown View Source

Manage negotiated (private) accommodation rates.

See the Duffel documentation.

Summary

Functions

Creates a negotiated rate.

Deletes a negotiated rate.

Retrieves a single negotiated rate by ID.

Lists one page of negotiated rates.

Lazily streams all negotiated rates across pages.

Updates a negotiated rate.

Functions

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

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

Creates a negotiated rate.

delete(client, id)

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

Deletes a negotiated rate.

get(client, id)

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

Retrieves a single negotiated rate by ID.

list(client, params \\ [])

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

Lists one page of negotiated rates.

Parameters

  • :limit / :after / :before - pagination (see Duffel.Page)

stream(client, params \\ [])

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

Lazily streams all negotiated rates across pages.

Raises Duffel.Error if a page request fails.

update(client, id, params)

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

Updates a negotiated rate.