activity.models.volunteer
=========================

.. py:module:: activity.models.volunteer


Attributes
----------

.. autoapisummary::

   activity.models.volunteer.VolunteerState


Classes
-------

.. autoapisummary::

   activity.models.volunteer.Volunteer


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

.. py:type:: VolunteerState
   :canonical: Literal['open', 'contacted', 'confirmed']


.. py:class:: Volunteer

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   Describes a volunteer that has signed up to fulfill an
   occasion need.



   .. py:attribute:: __tablename__
      :value: 'volunteers'



   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: state
      :type:  sqlalchemy.Column[VolunteerState]


   .. py:attribute:: need_id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: need
      :type:  sqlalchemy.orm.relationship[onegov.activity.models.OccasionNeed]


   .. py:attribute:: token
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: first_name
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: last_name
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: address
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: zip_code
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: place
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: organisation
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: birth_date
      :type:  sqlalchemy.Column[datetime.date]


   .. py:attribute:: email
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: phone
      :type:  sqlalchemy.Column[str]