PhoenixKitStaff.Teams (PhoenixKitStaff v0.2.0)

Copy Markdown View Source

CRUD for teams.

Summary

Functions

change(team, attrs \\ %{})

Returns a changeset for the given team.

count()

Total number of teams.

create(attrs)

Inserts a team and broadcasts :team_created.

delete(team)

Deletes a team and broadcasts :team_deleted.

get(uuid, opts \\ [])

Fetches a team by uuid, or nil if not found.

get!(uuid, opts \\ [])

Fetches a team by uuid. Raises if not found.

list(opts \\ [])

Lists teams. Accepts :preload and :department_uuid to filter by department.

update(team, attrs)

Updates a team and broadcasts :team_updated.

Functions

change(team, attrs \\ %{})

@spec change(PhoenixKitStaff.Schemas.Team.t(), map()) ::
  Ecto.Changeset.t(PhoenixKitStaff.Schemas.Team.t())

Returns a changeset for the given team.

count()

@spec count() :: non_neg_integer()

Total number of teams.

create(attrs)

@spec create(map()) ::
  {:ok, PhoenixKitStaff.Schemas.Team.t()}
  | {:error, Ecto.Changeset.t(PhoenixKitStaff.Schemas.Team.t())}

Inserts a team and broadcasts :team_created.

delete(team)

@spec delete(PhoenixKitStaff.Schemas.Team.t()) ::
  {:ok, PhoenixKitStaff.Schemas.Team.t()}
  | {:error, Ecto.Changeset.t(PhoenixKitStaff.Schemas.Team.t())}

Deletes a team and broadcasts :team_deleted.

get(uuid, opts \\ [])

@spec get(
  UUIDv7.t() | String.t(),
  keyword()
) :: PhoenixKitStaff.Schemas.Team.t() | nil

Fetches a team by uuid, or nil if not found.

get!(uuid, opts \\ [])

@spec get!(
  UUIDv7.t() | String.t(),
  keyword()
) :: PhoenixKitStaff.Schemas.Team.t()

Fetches a team by uuid. Raises if not found.

list(opts \\ [])

@spec list(keyword()) :: [PhoenixKitStaff.Schemas.Team.t()]

Lists teams. Accepts :preload and :department_uuid to filter by department.

update(team, attrs)

@spec update(PhoenixKitStaff.Schemas.Team.t(), map()) ::
  {:ok, PhoenixKitStaff.Schemas.Team.t()}
  | {:error, Ecto.Changeset.t(PhoenixKitStaff.Schemas.Team.t())}

Updates a team and broadcasts :team_updated.