Context for authoring outbound adapter pools and memberships.
Summary
Functions
Adds a channel adapter to a pool.
Creates an adapter pool in an explicit tenant scope.
Deletes an adapter pool unless active outbound enrollments still use it.
Lists adapter pools in an explicit tenant scope.
Lists members for a pool in an explicit tenant scope.
Removes one adapter from a pool without mutating existing enrollment pins.
Updates an adapter pool after verifying the caller's tenant scope.
Types
@type tenant_filters() :: %{tenant_key: binary() | nil}
Functions
@spec add_pool_member(Ecto.Schema.t() | Ecto.UUID.t(), map()) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Adds a channel adapter to a pool.
@spec create_adapter_pool(map()) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Creates an adapter pool in an explicit tenant scope.
@spec delete_adapter_pool(Ecto.Schema.t() | Ecto.UUID.t(), map() | keyword()) :: {:ok, Ecto.Schema.t()} | {:error, map()}
Deletes an adapter pool unless active outbound enrollments still use it.
@spec list_adapter_pools(tenant_filters()) :: [Ecto.Schema.t()]
Lists adapter pools in an explicit tenant scope.
@spec list_pool_members(Ecto.Schema.t() | Ecto.UUID.t() | map()) :: [Ecto.Schema.t()]
Lists members for a pool in an explicit tenant scope.
@spec remove_pool_member(Ecto.Schema.t() | Ecto.UUID.t(), Ecto.UUID.t() | map()) :: {:ok, Ecto.Schema.t()} | {:error, :not_found}
Removes one adapter from a pool without mutating existing enrollment pins.
@spec update_adapter_pool(Ecto.Schema.t() | Ecto.UUID.t(), map()) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Updates an adapter pool after verifying the caller's tenant scope.