View Source Plausible.Site.Memberships.CreateInvitation (Plausible v0.0.1)

Service for inviting new or existing users to a sites, including ownershhip transfers.

Summary

Types

Functions

bulk_create_invitation(sites, inviter, invitee_email, role, opts \\ [])

bulk_transfer_ownership_direct(sites, new_owner)

create_invitation(site, inviter, invitee_email, role)

Invites a new team member to the given site. Returns a %Plausible.Auth.Invitation{} struct and sends the invitee an email to accept this invitation.

Types

invite_error()

@type invite_error() ::
  Ecto.Changeset.t()
  | :already_a_member
  | :transfer_to_self
  | :no_plan
  | {:over_limit, non_neg_integer()}
  | :forbidden

Functions

bulk_create_invitation(sites, inviter, invitee_email, role, opts \\ [])

@spec bulk_create_invitation(
  [Plausible.Site.t()],
  Plausible.Auth.User.t(),
  String.t(),
  atom(),
  Keyword.t()
) :: {:ok, [Plausible.Auth.Invitation.t()]} | {:error, invite_error()}

bulk_transfer_ownership_direct(sites, new_owner)

@spec bulk_transfer_ownership_direct([Plausible.Site.t()], Plausible.Auth.User.t()) ::
  {:ok, [Plausible.Site.Membership.t()]}
  | {:error,
     invite_error() | Plausible.Billing.Quota.Limits.over_limits_error()}

create_invitation(site, inviter, invitee_email, role)

@spec create_invitation(
  Plausible.Site.t(),
  Plausible.Auth.User.t(),
  String.t(),
  atom()
) ::
  {:ok, Plausible.Auth.Invitation.t()} | {:error, invite_error()}

Invites a new team member to the given site. Returns a %Plausible.Auth.Invitation{} struct and sends the invitee an email to accept this invitation.

The inviter must have enough permissions to invite the new team member, otherwise this function returns {:error, :forbidden}.

If the new team member role is :owner, this function handles the invitation as an ownership transfer and requires the inviter to be the owner of the site.