election_day.path
=================

.. py:module:: election_day.path


Functions
---------

.. autoapisummary::

   election_day.path.get_auth
   election_day.path.get_principal
   election_day.path.get_manage_elections
   election_day.path.get_manage_election_compsites
   election_day.path.get_manage_votes
   election_day.path.get_manage_sms_subscribers
   election_day.path.get_manage_email_subscribers
   election_day.path.get_manage_upload_tokens
   election_day.path.get_manage_data_sources
   election_day.path.get_manage_data_source_items
   election_day.path.get_election
   election_day.path.get_candidate
   election_day.path.get_list
   election_day.path.get_election_compound
   election_day.path.get_superregion
   election_day.path.get_vote
   election_day.path.get_ballot
   election_day.path.get_subscriber
   election_day.path.get_upload_token
   election_day.path.get_data_source
   election_day.path.get_data_source_item
   election_day.path.get_archive_by_year
   election_day.path.get_archive_search
   election_day.path.get_locale
   election_day.path.get_manage_screens
   election_day.path.get_screen


Module Contents
---------------

.. py:function:: get_auth(request: onegov.election_day.request.ElectionDayRequest, to: str = '/') -> onegov.user.Auth

.. py:function:: get_principal(app: onegov.election_day.ElectionDayApp) -> onegov.election_day.models.Principal

.. py:function:: get_manage_elections(app: onegov.election_day.ElectionDayApp, page: int = 0, year: int | None = None) -> onegov.election_day.collections.ElectionCollection

.. py:function:: get_manage_election_compsites(app: onegov.election_day.ElectionDayApp, page: int = 0, year: int | None = None) -> onegov.election_day.collections.ElectionCompoundCollection

.. py:function:: get_manage_votes(app: onegov.election_day.ElectionDayApp, page: int = 0, year: int | None = None) -> onegov.election_day.collections.VoteCollection

.. py:function:: get_manage_sms_subscribers(app: onegov.election_day.ElectionDayApp, page: int = 0, term: str | None = None, active_only: bool | None = None) -> onegov.election_day.collections.SmsSubscriberCollection

.. py:function:: get_manage_email_subscribers(app: onegov.election_day.ElectionDayApp, page: int = 0, term: str | None = None, active_only: bool | None = None) -> onegov.election_day.collections.EmailSubscriberCollection

.. py:function:: get_manage_upload_tokens(app: onegov.election_day.ElectionDayApp) -> onegov.election_day.collections.UploadTokenCollection

.. py:function:: get_manage_data_sources(app: onegov.election_day.ElectionDayApp, page: int = 0) -> onegov.election_day.collections.DataSourceCollection

.. py:function:: get_manage_data_source_items(app: onegov.election_day.ElectionDayApp, id: uuid.UUID, page: int = 0) -> onegov.election_day.collections.DataSourceItemCollection

.. py:function:: get_election(app: onegov.election_day.ElectionDayApp, id: str) -> onegov.election_day.models.Election | None

.. py:function:: get_candidate(app: onegov.election_day.ElectionDayApp, id: uuid.UUID) -> onegov.election_day.models.Candidate | None

.. py:function:: get_list(app: onegov.election_day.ElectionDayApp, id: uuid.UUID) -> onegov.election_day.models.List | None

.. py:function:: get_election_compound(app: onegov.election_day.ElectionDayApp, id: str) -> onegov.election_day.models.ElectionCompound | None

.. py:function:: get_superregion(app: onegov.election_day.ElectionDayApp, election_compound_id: str, domain: str, id: str) -> onegov.election_day.models.ElectionCompoundPart | None

.. py:function:: get_vote(app: onegov.election_day.ElectionDayApp, id: str) -> onegov.election_day.models.Vote | None

.. py:function:: get_ballot(app: onegov.election_day.ElectionDayApp, id: uuid.UUID) -> onegov.election_day.models.Ballot | None

.. py:function:: get_subscriber(app: onegov.election_day.ElectionDayApp, id: uuid.UUID) -> onegov.election_day.models.Subscriber | None

.. py:function:: get_upload_token(app: onegov.election_day.ElectionDayApp, id: uuid.UUID) -> onegov.election_day.models.UploadToken | None

.. py:function:: get_data_source(app: onegov.election_day.ElectionDayApp, id: uuid.UUID) -> onegov.election_day.models.DataSource | None

.. py:function:: get_data_source_item(app: onegov.election_day.ElectionDayApp, id: uuid.UUID) -> onegov.election_day.models.DataSourceItem | None

.. py:function:: get_archive_by_year(app: onegov.election_day.ElectionDayApp, date: str) -> onegov.election_day.collections.ArchivedResultCollection

.. py:function:: get_archive_search(app: onegov.election_day.ElectionDayApp, from_date: datetime.date | None = None, to_date: datetime.date | None = None, answers: list[str] | None = None, item_type: str | None = None, domains: list[str] | None = None, term: str | None = None, page: int = 0) -> onegov.election_day.collections.SearchableArchivedResultCollection | None

.. py:function:: get_locale(request: onegov.election_day.request.ElectionDayRequest, app: onegov.election_day.ElectionDayApp, locale: str) -> onegov.core.i18n.SiteLocale | None

.. py:function:: get_manage_screens(app: onegov.election_day.ElectionDayApp, page: int = 0) -> onegov.election_day.collections.ScreenCollection

.. py:function:: get_screen(app: onegov.election_day.ElectionDayApp, number: int) -> onegov.election_day.models.Screen | None