View Source Plausible.Sites (Plausible v0.0.1)

Sites context functions.

Summary

Types

list_opt()

Functions

create(user, params)

create_shared_link(site, name, password \\ nil)

get_by_domain(domain)

get_by_domain!(domain)

get_for_user(user_id, domain, roles \\ [:owner, :admin, :viewer])

get_for_user!(user_id, domain, roles \\ [:owner, :admin, :viewer])

has_admin_access?(user_id, site)

has_goals?(site)

has_stats?(site)

is_member?(user_id, site)

list(user, pagination_params, opts \\ [])

list_with_invitations(user, pagination_params, opts \\ [])

locked?(site)

owned_site_ids(user)

owned_sites_count(user)

owned_sites_domains(user)

role(user_id, site)

set_option(user, site, option, value)

shared_link_url(site, link)

stats_start_date(site)

Returns the date of the first event of the given site, or nil if the site does not have stats yet.

toggle_pin(user, site)

Types

list_opt()

@type list_opt() :: {:filter_by_domain, String.t()}

Functions

create(user, params)

create_shared_link(site, name, password \\ nil)

get_by_domain(domain)

get_by_domain!(domain)

get_for_user(user_id, domain, roles \\ [:owner, :admin, :viewer])

get_for_user!(user_id, domain, roles \\ [:owner, :admin, :viewer])

has_admin_access?(user_id, site)

has_goals?(site)

has_stats?(site)

is_member?(user_id, site)

list(user, pagination_params, opts \\ [])

@spec list(Plausible.Auth.User.t(), map(), [list_opt()]) :: Scrivener.Page.t()

list_with_invitations(user, pagination_params, opts \\ [])

@spec list_with_invitations(Plausible.Auth.User.t(), map(), [list_opt()]) ::
  Scrivener.Page.t()

locked?(site)

owned_site_ids(user)

owned_sites_count(user)

owned_sites_domains(user)

role(user_id, site)

set_option(user, site, option, value)

@spec set_option(Plausible.Auth.User.t(), Plausible.Site.t(), atom(), any()) ::
  Plausible.Site.UserPreference.t()

shared_link_url(site, link)

stats_start_date(site)

@spec stats_start_date(Plausible.Site.t()) :: Date.t() | nil

Returns the date of the first event of the given site, or nil if the site does not have stats yet.

If this is the first time the function is called for the site, it queries Clickhouse and saves the date in the sites table.

toggle_pin(user, site)

@spec toggle_pin(Plausible.Auth.User.t(), Plausible.Site.t()) ::
  {:ok, Plausible.Site.UserPreference.t()} | {:error, :too_many_pins}