Duffel.Identity.CustomerUserGroups (Duffel v0.1.0)

Copy Markdown View Source

Group customer users to scope what each of your users can see and manage.

See the Duffel documentation.

Summary

Functions

Creates a customer user group.

Deletes a customer user group.

Retrieves a single group by ID.

Lists customer user groups. Not paginated.

Updates a customer user group's name or members.

Functions

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

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

Creates a customer user group.

Examples

Duffel.Identity.CustomerUserGroups.create(client, %{
  name: "Acme Corp",
  user_ids: ["icu_123"]
})

delete(client, id)

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

Deletes a customer user group.

get(client, id)

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

Retrieves a single group by ID.

list(client)

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

Lists customer user groups. Not paginated.

update(client, id, params)

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

Updates a customer user group's name or members.