feriennet.models.group_invite
=============================

.. py:module:: feriennet.models.group_invite


Classes
-------

.. autoapisummary::

   feriennet.models.group_invite.GroupInvite


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

.. py:class:: GroupInvite(session: sqlalchemy.orm.Session, group_code: str, username: str | None)

   .. py:attribute:: session


   .. py:attribute:: group_code


   .. py:attribute:: username


   .. py:method:: create(session: sqlalchemy.orm.Session, username: str | None) -> Self
      :classmethod:


      Creates a new group invite with a code that is not yet used. 



   .. py:method:: for_username(username: str | None) -> Self


   .. py:property:: user
      :type: onegov.user.User | None



   .. py:property:: exists
      :type: bool


      Returns True if the group_code associated with this invite exists.

              



   .. py:method:: bookings() -> sqlalchemy.orm.Query[onegov.activity.models.Booking]

      Returns a query of the bookings associated with this invite. 



   .. py:property:: occasion
      :type: onegov.activity.models.Occasion


      Looks up the occasion linked to this group invite.

      Technically it would be possible that a group code points to multiple
      occasions, but that would be an error. If that happens, an exception
      will be thrown.




   .. py:property:: attendees
      :type: tuple[tuple[onegov.activity.models.Attendee, onegov.activity.models.Booking], Ellipsis]


      Returns the attendees linked to this invite. 



   .. py:method:: prospects(username: str) -> collections.abc.Iterator[tuple[onegov.activity.models.Attendee, onegov.activity.models.Booking | None]]

      Returns the attendees associated with the given users that are
      not yet part of the group.

      The result is a list of tuples with the first element being the
      attendee and the second element being the booking for the linked
      occasion, if such a booking already exists (otherwise None).