2023-10-25 15:02:51 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "generator" content = "ExDoc v0.30.3" >
< meta name = "project" content = "Plausible v0.0.1" >
< title > Plausible.Site.Memberships.CreateInvitation — Plausible v0.0.1< / title >
< link rel = "stylesheet" href = "dist/html-elixir-P5GXSCHE.css" / >
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
< script src = "dist/handlebars.templates-NBND3S2D.js" > < / script >
2023-11-16 18:41:27 +03:00
< script src = "dist/sidebar_items-F325A691.js" > < / script >
2023-10-25 15:02:51 +03:00
< script src = "docs_config.js" > < / script >
< script async src = "dist/html-CGDDOCMI.js" > < / script >
< / head >
< body data-type = "modules" class = "page-module" >
< script >
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) & &
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
< / script >
< div class = "main" >
< button class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" >
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
< section class = "sidebar" >
< form class = "sidebar-search" action = "search.html" >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-label = "Cancel Search" >
< i class = "ri-close-line ri-lg" aria-hidden = "true" title = "Cancel search" > < / i >
< / button >
< label class = "search-label" >
< p class = "sr-only" > Search< / p >
< input name = "q" type = "text" class = "search-input" placeholder = "Search..." aria-label = "Input your search terms" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< / form >
< div class = "autocomplete" >
< div class = "autocomplete-results" >
< / div >
< / div >
< div class = "sidebar-header" >
< a href = "readme.html" >
< img src = "assets/logo.png" alt = "Plausible" class = "sidebar-projectImage" >
< / a >
< div class = "sidebar-projectDetails" >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
Plausible
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
< / div >
< ul class = "sidebar-listNav" >
< li > < a id = "extras-list-link" href = "#full-list" > Pages< / a > < / li >
< li > < a id = "modules-list-link" href = "#full-list" > Modules< / a > < / li >
< li > < a id = "tasks-list-link" href = "#full-list" > < span translate = "no" > Mix< / span > Tasks< / a > < / li >
< / ul >
< / div >
< div class = "gradient" > < / div >
< ul id = "full-list" > < / ul >
< / section >
< section class = "content" >
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
< h1 >
< button class = "icon-action display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/create_invitation.ex#L1" title = "View Source" class = "icon-action" rel = "help" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< span translate = "no" > Plausible.Site.Memberships.CreateInvitation< / span >
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
< section id = "moduledoc" >
< p > Service for inviting new or existing users to a sites, including ownershhip
transfers.< / p >
< / section >
< section id = "summary" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#summary" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
Summary
< / a >
< / h1 >
< div class = "summary-types summary" >
< h2 >
< a href = "#types" > Types< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:invite_error/0" translate = "no" > invite_error()< / a >
< / div >
< / div >
< / div >
< div class = "summary-functions summary" >
< h2 >
< a href = "#functions" > Functions< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#bulk_create_invitation/5" translate = "no" > bulk_create_invitation(sites, inviter, invitee_email, role, opts \\ [])< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#bulk_transfer_ownership_direct/2" translate = "no" > bulk_transfer_ownership_direct(sites, new_owner)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#create_invitation/4" translate = "no" > create_invitation(site, inviter, invitee_email, role)< / a >
< / div >
< div class = "summary-synopsis" > < p > 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.< / p > < / div >
< / div >
< / div >
< / section >
< section id = "types" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#types" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
Types
< / a >
< / h1 >
< div class = "types-list" >
< section class = "detail" id = "t:invite_error/0" >
< div class = "detail-header" >
< a href = "#t:invite_error/0" class = "detail-link" title = "Link to this type" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this type< / span >
< / a >
< h1 class = "signature" translate = "no" > invite_error()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/create_invitation.ex#L12" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @type< / span > invite_error() ::
< a href = "https://hexdocs.pm/ecto/3.10.3/Ecto.Changeset.html#t:t/0" > Ecto.Changeset.t< / a > ()
| :already_a_member
| :transfer_to_self
| {:over_limit, < a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > non_neg_integer< / a > ()}
| :forbidden
| :upgrade_required< / pre >
< / div >
< / section >
< / section >
< / div >
< / section >
< section id = "functions" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#functions" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
Functions
< / a >
< / h1 >
< div class = "functions-list" >
< section class = "detail" id = "bulk_create_invitation/5" >
< span id = "bulk_create_invitation/4" > < / span >
< div class = "detail-header" >
< a href = "#bulk_create_invitation/5" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > bulk_create_invitation(sites, inviter, invitee_email, role, opts \\ [])< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/create_invitation.ex#L57" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > bulk_create_invitation(
[< a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > ()],
< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (),
< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (),
< a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > atom< / a > (),
< a href = "https://hexdocs.pm/elixir/Keyword.html#t:t/0" > Keyword.t< / a > ()
) :: {:ok, [< a href = "Plausible.Auth.Invitation.html#t:t/0" > Plausible.Auth.Invitation.t< / a > ()]} | {:error, < a href = "#t:invite_error/0" > invite_error< / a > ()}< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "bulk_transfer_ownership_direct/2" >
< div class = "detail-header" >
< a href = "#bulk_transfer_ownership_direct/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > bulk_transfer_ownership_direct(sites, new_owner)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/create_invitation.ex#L41" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > bulk_transfer_ownership_direct([< a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > ()], < a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) ::
{:ok, [< a href = "Plausible.Site.Membership.html#t:t/0" > Plausible.Site.Membership.t< / a > ()]} | {:error, < a href = "#t:invite_error/0" > invite_error< / a > ()}< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "create_invitation/4" >
< div class = "detail-header" >
< a href = "#create_invitation/4" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > create_invitation(site, inviter, invitee_email, role)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/create_invitation.ex#L33" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > create_invitation(
< a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > (),
< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (),
< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (),
< a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > atom< / a > ()
) ::
{:ok, < a href = "Plausible.Auth.Invitation.html#t:t/0" > Plausible.Auth.Invitation.t< / a > ()} | {:error, < a href = "#t:invite_error/0" > invite_error< / a > ()}< / pre >
< / div >
< p > 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.< / p > < p > The inviter must have enough permissions to invite the new team member,
otherwise this function returns < code class = "inline" > {:error, :forbidden}< / code > .< / p > < p > If the new team member role is < code class = "inline" > :owner< / code > , this function handles the invitation
as an ownership transfer and requires the inviter to be the owner of the site.< / p >
< / section >
< / section >
< / div >
< / section >
< footer class = "footer" >
< p >
< span class = "line" >
< button class = "a-main footer-button display-quick-switch" title = "Search HexDocs packages" >
Search HexDocs
< / button >
< a href = "Plausible.epub" title = "ePub version" >
Download ePub version
< / a >
< / span >
< / p >
< p class = "built-using" >
Built using
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.30.3) for the
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
< / section >
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
