<!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.Imported.SiteImport — 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-7320A3C1.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/imported/site_import.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.Imported.SiteImport</span> <small class="app-vsn" translate="no">(Plausible v0.0.1)</small> </h1> <section id="moduledoc"> <p>Site import schema.</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> <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="#complete_changeset/2" translate="no">complete_changeset(site_import, params \\ %{})</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#completed/0" translate="no">completed()</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#create_changeset/3" translate="no">create_changeset(site, user, params)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#fail_changeset/1" translate="no">fail_changeset(site_import)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#failed/0" translate="no">failed()</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#importing/0" translate="no">importing()</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#label/1" translate="no">label(arg1)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#pending/0" translate="no">pending()</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#start_changeset/1" translate="no">start_changeset(site_import)</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/imported/site_import.ex#L16" 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.Imported.SiteImport{ __meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), end_date: <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>(), imported_by: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), imported_by_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>(), site: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), site_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), source: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), start_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), status: <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="complete_changeset/2"> <span id="complete_changeset/1"></span> <div class="detail-header"> <a href="#complete_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">complete_changeset(site_import, params \\ %{})</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.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> complete_changeset(<a href="#t:t/0">t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) :: <a href="https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre> </div> </section> </section> <section class="detail" id="completed/0"> <div class="detail-header"> <a href="#completed/0" class="detail-link" title="Link to this macro"> <i class="ri-link-m" aria-hidden="true"></i> <span class="sr-only">Link to this macro</span> </a> <h1 class="signature" translate="no">completed()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.ex#L31" 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> <span class="note">(macro)</span> </div> <section class="docstring"> </section> </section> <section class="detail" id="create_changeset/3"> <div class="detail-header"> <a href="#create_changeset/3" 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_changeset(site, user, params)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.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> create_changeset(<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/typespecs.html#basic-types">map</a>()) :: <a href="https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre> </div> </section> </section> <section class="detail" id="fail_changeset/1"> <div class="detail-header"> <a href="#fail_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">fail_changeset(site_import)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.ex#L65" 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> fail_changeset(<a href="#t:t/0">t</a>()) :: <a href="https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre> </div> </section> </section> <section class="detail" id="failed/0"> <div class="detail-header"> <a href="#failed/0" class="detail-link" title="Link to this macro"> <i class="ri-link-m" aria-hidden="true"></i> <span class="sr-only">Link to this macro</span> </a> <h1 class="signature" translate="no">failed()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.ex#L31" 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> <span class="note">(macro)</span> </div> <section class="docstring"> </section> </section> <section class="detail" id="importing/0"> <div class="detail-header"> <a href="#importing/0" class="detail-link" title="Link to this macro"> <i class="ri-link-m" aria-hidden="true"></i> <span class="sr-only">Link to this macro</span> </a> <h1 class="signature" translate="no">importing()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.ex#L31" 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> <span class="note">(macro)</span> </div> <section class="docstring"> </section> </section> <section class="detail" id="label/1"> <div class="detail-header"> <a href="#label/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">label(arg1)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.ex#L37" 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> label(<a href="#t:t/0">t</a>() | <a href="Plausible.Site.ImportedData.html#t:t/0">Plausible.Site.ImportedData.t</a>()) :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()</pre> </div> </section> </section> <section class="detail" id="pending/0"> <div class="detail-header"> <a href="#pending/0" class="detail-link" title="Link to this macro"> <i class="ri-link-m" aria-hidden="true"></i> <span class="sr-only">Link to this macro</span> </a> <h1 class="signature" translate="no">pending()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.ex#L31" 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> <span class="note">(macro)</span> </div> <section class="docstring"> </section> </section> <section class="detail" id="start_changeset/1"> <div class="detail-header"> <a href="#start_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">start_changeset(site_import)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported/site_import.ex#L51" 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> start_changeset(<a href="#t:t/0">t</a>()) :: <a href="https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre> </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 <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>