feriennet.models.volunteer_cart
===============================

.. py:module:: feriennet.models.volunteer_cart


Classes
-------

.. autoapisummary::

   feriennet.models.volunteer_cart.CardItemRow
   feriennet.models.volunteer_cart.VolunteerCart
   feriennet.models.volunteer_cart.VolunteerCartAction


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

.. py:class:: CardItemRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: need_id
      :type:  uuid.UUID


   .. py:attribute:: need_name
      :type:  str


   .. py:attribute:: start
      :type:  datetime.datetime


   .. py:attribute:: end
      :type:  datetime.datetime


   .. py:attribute:: timezone
      :type:  str


   .. py:attribute:: activity_title
      :type:  str


   .. py:attribute:: occasion_id
      :type:  uuid.UUID


.. py:class:: VolunteerCart(session: sqlalchemy.orm.Session, browser_session: onegov.core.browser_session.BrowserSession)

   Stores items of the volunteer cart view in the browser session.

   Items stored this way may not overlap with existing items. We want
   to prevent volunteers from signing up for conflicting items.



   .. py:attribute:: session


   .. py:attribute:: browser_session


   .. py:method:: from_request(request: onegov.feriennet.request.FeriennetRequest) -> Self
      :classmethod:



   .. py:method:: add(need_id: uuid.UUID) -> None


   .. py:method:: remove(need_id: uuid.UUID) -> None


   .. py:method:: has(need_id: uuid.UUID) -> bool


   .. py:method:: ids() -> collections.abc.Sequence[uuid.UUID]


   .. py:method:: clear() -> None


   .. py:method:: card_items(need_id: uuid.UUID | None = None) -> sqlalchemy.orm.Query[CardItemRow]


   .. py:method:: overlaps(need_id: uuid.UUID) -> bool


   .. py:method:: for_frontend(layout: onegov.feriennet.layout.DefaultLayout, localize: bool = True) -> collections.abc.Iterator[onegov.core.types.RenderData]


.. py:class:: VolunteerCartAction(action: Literal['add', 'remove'], target: uuid.UUID)

   Represents a single action for the VolunteerCart. 


   .. py:attribute:: action


   .. py:attribute:: target


   .. py:method:: execute(request: onegov.feriennet.request.FeriennetRequest, cart: VolunteerCart) -> onegov.core.types.JSON_ro