Manage customer users — the travellers and bookers your own users represent within Duffel.
See the Duffel documentation.
Summary
Functions
Creates a customer user.
Retrieves a single customer user by ID.
Lists one page of customer users.
Lazily streams all customer users across pages.
Updates a customer user. Replaces the user with the given attributes.
Functions
@spec create(Duffel.Client.t(), map(), keyword()) :: {:ok, map()} | {:error, Duffel.Error.t()}
Creates a customer user.
Examples
Duffel.Identity.CustomerUsers.create(client, %{
email: "amelia@duffel.com",
given_name: "Amelia",
family_name: "Earhart",
phone_number: "+442080160508"
})
@spec get(Duffel.Client.t(), String.t()) :: {:ok, map()} | {:error, Duffel.Error.t()}
Retrieves a single customer user by ID.
@spec list(Duffel.Client.t(), keyword() | map()) :: {:ok, Duffel.Page.t()} | {:error, Duffel.Error.t()}
Lists one page of customer users.
Parameters
:limit/:after/:before- pagination (seeDuffel.Page)
@spec stream(Duffel.Client.t(), keyword() | map()) :: Enumerable.t()
Lazily streams all customer users across pages.
Raises Duffel.Error if a page request fails.
@spec update(Duffel.Client.t(), String.t(), map()) :: {:ok, map()} | {:error, Duffel.Error.t()}
Updates a customer user. Replaces the user with the given attributes.