2023-10-02 15:58:47 +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">
|
2024-01-16 10:41:49 +03:00
|
|
|
<meta name="generator" content="ExDoc v0.31.1">
|
2023-10-02 15:58:47 +03:00
|
|
|
<meta name="project" content="Plausible v0.0.1">
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
|
2023-10-02 15:58:47 +03:00
|
|
|
<title>Plausible.Site.Memberships.AcceptInvitation — Plausible v0.0.1</title>
|
2024-01-16 10:41:49 +03:00
|
|
|
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
|
2024-01-11 10:50:44 +03:00
|
|
|
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
|
2024-01-30 12:12:14 +03:00
|
|
|
<script src="dist/sidebar_items-EF0D6B9C.js"></script>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
<script src="docs_config.js"></script>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<script async src="dist/html-L4O5OK2K.js"></script>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</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">
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
|
2023-10-02 15:58:47 +03:00
|
|
|
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
|
|
|
|
|
</button>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="background-layer"></div>
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<nav id="sidebar" class="sidebar">
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
<div class="sidebar-header">
|
2024-01-11 10:50:44 +03:00
|
|
|
<div class="sidebar-projectInfo">
|
2023-10-02 15:58:47 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<a href="readme.html" class="sidebar-projectImage">
|
|
|
|
|
<img src="assets/logo.png" alt="Plausible" />
|
|
|
|
|
</a>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div>
|
|
|
|
|
<a href="readme.html" class="sidebar-projectName" translate="no">
|
2023-10-02 15:58:47 +03:00
|
|
|
Plausible
|
2024-01-11 10:50:44 +03:00
|
|
|
</a>
|
|
|
|
|
<div class="sidebar-projectVersion" translate="no">
|
|
|
|
|
v0.0.1
|
|
|
|
|
</div>
|
2023-10-02 15:58:47 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
|
|
|
|
|
<li>
|
|
|
|
|
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
|
|
|
|
|
Pages
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
|
|
|
|
|
Modules
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
|
|
|
|
|
<span translate="no">Mix</span> Tasks
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</ul>
|
|
|
|
|
</div>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
|
|
|
|
|
<ul id="extras-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
|
|
|
|
|
<ul id="modules-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
|
|
|
|
|
<ul id="tasks-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</nav>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<main class="content">
|
2023-10-02 15:58:47 +03:00
|
|
|
<output role="status" id="toast"></output>
|
|
|
|
|
<div class="content-outer">
|
|
|
|
|
<div id="content" class="content-inner">
|
2024-01-11 10:50:44 +03:00
|
|
|
<div class="top-search">
|
|
|
|
|
<div class="search-settings">
|
|
|
|
|
<form class="search-bar" action="search.html">
|
|
|
|
|
<label class="search-label">
|
|
|
|
|
<span class="sr-only">Search documentation of Plausible</span>
|
|
|
|
|
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
|
|
|
|
|
</label>
|
|
|
|
|
<button type="submit" class="search-button" aria-label="Submit Search">
|
|
|
|
|
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
|
|
|
|
|
</button>
|
|
|
|
|
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
|
|
|
|
|
<i class="ri-close-line ri-lg" title="Cancel search"></i>
|
|
|
|
|
</button>
|
|
|
|
|
</form>
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="autocomplete">
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<button class="icon-settings display-settings">
|
|
|
|
|
<i class="ri-settings-3-line"></i>
|
|
|
|
|
<span class="sr-only">Settings</span>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
2024-01-16 10:41:49 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</div>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
<h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/accept_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.AcceptInvitation</span>
|
|
|
|
|
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
|
|
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="moduledoc">
|
|
|
|
|
<p>Service for accepting invitations, including ownership transfers.</p><p>Accepting invitation accounts for the fact that it's possible
|
|
|
|
|
that accepting user has an existing membership for the site and
|
|
|
|
|
acts permissively to not unnecessarily disrupt the flow while
|
|
|
|
|
also maintaining integrity of site memberships. This also applies
|
|
|
|
|
to cases where users update their email address between issuing
|
|
|
|
|
the invitation and accepting it.</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>
|
|
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Summary</span>
|
2023-10-02 15:58:47 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="summary-functions summary">
|
|
|
|
|
<h2>
|
|
|
|
|
<a href="#functions">Functions</a>
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="#accept_invitation/2" translate="no">accept_invitation(invitation_id, user)</a>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-10-13 19:38:53 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="#transfer_ownership/2" translate="no">transfer_ownership(site, user)</a>
|
2023-10-13 19:38:53 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-10-02 15:58:47 +03:00
|
|
|
</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>
|
|
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Functions</span>
|
2023-10-02 15:58:47 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="functions-list">
|
2023-12-20 17:57:27 +03:00
|
|
|
<section class="detail" id="accept_invitation/2">
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
<div class="detail-header">
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="#accept_invitation/2" class="detail-link" title="Link to this function">
|
2023-10-02 15:58:47 +03:00
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
2023-12-20 17:57:27 +03:00
|
|
|
<h1 class="signature" translate="no">accept_invitation(invitation_id, user)</h1>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/accept_invitation.ex#L60" class="icon-action" rel="help" title="View Source">
|
2023-10-02 15:58:47 +03:00
|
|
|
<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">
|
|
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<pre translate="no"><span class="attribute">@spec</span> accept_invitation(<a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(), <a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>()) ::
|
2023-10-02 15:58:47 +03:00
|
|
|
{:ok, <a href="Plausible.Site.Membership.html#t:t/0">Plausible.Site.Membership.t</a>()}
|
2023-12-20 17:57:27 +03:00
|
|
|
| {:error,
|
|
|
|
|
:invitation_not_found
|
|
|
|
|
| <a href="Plausible.Billing.Quota.html#t:over_limits_error/0">Plausible.Billing.Quota.over_limits_error</a>()
|
2024-01-11 10:50:44 +03:00
|
|
|
| <a href="https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()
|
2023-12-20 17:57:27 +03:00
|
|
|
| :no_plan}</pre>
|
2023-10-13 19:38:53 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2023-12-20 17:57:27 +03:00
|
|
|
<section class="detail" id="transfer_ownership/2">
|
2023-10-13 19:38:53 +03:00
|
|
|
|
|
|
|
|
<div class="detail-header">
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="#transfer_ownership/2" class="detail-link" title="Link to this function">
|
2023-10-13 19:38:53 +03:00
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
2023-12-20 17:57:27 +03:00
|
|
|
<h1 class="signature" translate="no">transfer_ownership(site, user)</h1>
|
2023-10-13 19:38:53 +03:00
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/site/memberships/accept_invitation.ex#L33" class="icon-action" rel="help" title="View Source">
|
2023-10-13 19:38:53 +03:00
|
|
|
<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">
|
|
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<pre translate="no"><span class="attribute">@spec</span> transfer_ownership(<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="Plausible.Billing.Quota.html#t:over_limits_error/0">Plausible.Billing.Quota.over_limits_error</a>()
|
2024-01-11 10:50:44 +03:00
|
|
|
| <a href="https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()
|
2023-12-20 17:57:27 +03:00
|
|
|
| :transfer_to_self
|
|
|
|
|
| :no_plan}</pre>
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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
|
2024-01-16 10:41:49 +03:00
|
|
|
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
|
2023-10-02 15:58:47 +03:00
|
|
|
|
|
|
|
|
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
</main>
|
2023-10-02 15:58:47 +03:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
|
|
|
|
<script>mermaid.initialize({startOnLoad: true})</script>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
