<!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.31.1"> <meta name="project" content="Plausible v0.0.1"> <title>Plausible.Auth.User — Plausible v0.0.1</title> <link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" /> <script src="dist/handlebars.runtime-NWIB6V2M.js"></script> <script src="dist/handlebars.templates-43PMFBC7.js"></script> <script src="dist/sidebar_items-B50757C9.js"></script> <script src="docs_config.js"></script> <script async src="dist/html-L4O5OK2K.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 id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar"> <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i> </button> <div class="background-layer"></div> <nav id="sidebar" class="sidebar"> <div class="sidebar-header"> <div class="sidebar-projectInfo"> <a href="readme.html" class="sidebar-projectImage"> <img src="assets/logo.png" alt="Plausible" /> </a> <div> <a href="readme.html" class="sidebar-projectName" translate="no"> Plausible </a> <div class="sidebar-projectVersion" translate="no"> v0.0.1 </div> </div> </div> <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> </ul> </div> <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> <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> <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> <main class="content"> <output role="status" id="toast"></output> <div class="content-outer"> <div id="content" class="content-inner"> <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> <div class="autocomplete"> </div> <button class="icon-settings display-settings"> <i class="ri-settings-3-line"></i> <span class="sr-only">Settings</span> </button> </div> </div> <h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L13" 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.Auth.User</span> <small class="app-vsn" translate="no">(Plausible v0.0.1)</small> </h1> <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> <span class="text">Summary</span> </h1> <div class="summary-types summary"> <h2> <a href="#types">Types</a> </h2> <div class="summary-row"> <div class="summary-signature"> <a href="#t:t/0" translate="no">t()</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="#cancel_email_changeset/1" translate="no">cancel_email_changeset(user)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#changeset/2" translate="no">changeset(user, attrs \\ %{})</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#email_changeset/2" translate="no">email_changeset(user, attrs \\ %{})</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#end_trial/1" translate="no">end_trial(user)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#hash_password/1" translate="no">hash_password(changeset)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#new/1" translate="no">new(attrs \\ %{})</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#password_strength/1" translate="no">password_strength(changeset)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#profile_img_url/1" translate="no">profile_img_url(user)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#remove_trial_expiry/1" translate="no">remove_trial_expiry(user)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#set_password/2" translate="no">set_password(user, password)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#settings_changeset/2" translate="no">settings_changeset(user, attrs \\ %{})</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#start_trial/1" translate="no">start_trial(user)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#subscription_accept_traffic_until_offset_days/0" translate="no">subscription_accept_traffic_until_offset_days()</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#trial_accept_traffic_until_offset_days/0" translate="no">trial_accept_traffic_until_offset_days()</a> </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> </a> <span class="text">Types</span> </h1> <div class="types-list"> <section class="detail" id="t:t/0"> <div class="detail-header"> <a href="#t:t/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">t()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L18" 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> t() :: %Plausible.Auth.User{ __meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), accept_traffic_until: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), allow_next_upgrade_override: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), api_keys: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), email: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), email_verified: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), enterprise_plan: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), google_auth: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), grace_period: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), inserted_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), last_seen: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), name: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), password: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), password_confirmation: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), password_hash: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), previous_email: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), site_memberships: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), sites: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), subscription: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), theme: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), totp_enabled: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), totp_last_used_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), totp_secret: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), totp_token: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), trial_expiry_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), updated_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>() }</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> </a> <span class="text">Functions</span> </h1> <div class="functions-list"> <section class="detail" id="cancel_email_changeset/1"> <div class="detail-header"> <a href="#cancel_email_changeset/1" 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">cancel_email_changeset(user)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L92" 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"> </section> </section> <section class="detail" id="changeset/2"> <span id="changeset/1"></span> <div class="detail-header"> <a href="#changeset/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">changeset(user, attrs \\ %{})</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L106" 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"> </section> </section> <section class="detail" id="email_changeset/2"> <span id="email_changeset/1"></span> <div class="detail-header"> <a href="#email_changeset/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">email_changeset(user, attrs \\ %{})</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L81" 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"> </section> </section> <section class="detail" id="end_trial/1"> <div class="detail-header"> <a href="#end_trial/1" 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">end_trial(user)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L166" 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"> </section> </section> <section class="detail" id="hash_password/1"> <div class="detail-header"> <a href="#hash_password/1" 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">hash_password(changeset)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L146" 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"> </section> </section> <section class="detail" id="new/1"> <span id="new/0"></span> <div class="detail-header"> <a href="#new/1" 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">new(attrs \\ %{})</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L60" 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"> </section> </section> <section class="detail" id="password_strength/1"> <div class="detail-header"> <a href="#password_strength/1" 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">password_strength(changeset)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L170" 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"> </section> </section> <section class="detail" id="profile_img_url/1"> <div class="detail-header"> <a href="#profile_img_url/1" 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">profile_img_url(user)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L200" 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"> </section> </section> <section class="detail" id="remove_trial_expiry/1"> <div class="detail-header"> <a href="#remove_trial_expiry/1" 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">remove_trial_expiry(user)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L153" 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"> </section> </section> <section class="detail" id="set_password/2"> <div class="detail-header"> <a href="#set_password/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">set_password(user, password)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L136" 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"> </section> </section> <section class="detail" id="settings_changeset/2"> <span id="settings_changeset/1"></span> <div class="detail-header"> <a href="#settings_changeset/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">settings_changeset(user, attrs \\ %{})</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L74" 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"> </section> </section> <section class="detail" id="start_trial/1"> <div class="detail-header"> <a href="#start_trial/1" 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">start_trial(user)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L157" 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"> </section> </section> <section class="detail" id="subscription_accept_traffic_until_offset_days/0"> <div class="detail-header"> <a href="#subscription_accept_traffic_until_offset_days/0" 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">subscription_accept_traffic_until_offset_days()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L213" 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"> </section> </section> <section class="detail" id="trial_accept_traffic_until_offset_days/0"> <div class="detail-header"> <a href="#trial_accept_traffic_until_offset_days/0" 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">trial_accept_traffic_until_offset_days()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/user.ex#L211" 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"> </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.31.1) for the <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a> </p> </footer> </div> </div> </main> </div> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script>mermaid.initialize({startOnLoad: true})</script> </body> </html>