feriennet.path
==============

.. py:module:: feriennet.path


Functions
---------

.. autoapisummary::

   feriennet.path.get_vacation_activities
   feriennet.path.get_vacation_activity
   feriennet.path.get_occasion
   feriennet.path.get_periods
   feriennet.path.get_period
   feriennet.path.get_my_bookings
   feriennet.path.get_booking
   feriennet.path.get_attendee
   feriennet.path.get_matches
   feriennet.path.get_billing
   feriennet.path.get_invoice_action
   feriennet.path.get_my_invoices
   feriennet.path.get_my_invoice_item
   feriennet.path.get_occasion_attendee_collection
   feriennet.path.get_notification_template_collection
   feriennet.path.get_notification_template
   feriennet.path.get_calendar
   feriennet.path.get_group_invite
   feriennet.path.get_occasion_need
   feriennet.path.get_volunteer_cart
   feriennet.path.get_volunteer_cart_action
   feriennet.path.get_volunteers
   feriennet.path.get_volunteer


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

.. py:function:: get_vacation_activities(request: onegov.feriennet.request.FeriennetRequest, app: onegov.feriennet.FeriennetApp, pages: tuple[int, int] | None = None, filter: dict[str, list[str]] | None = None) -> onegov.feriennet.collections.VacationActivityCollection

.. py:function:: get_vacation_activity(request: onegov.feriennet.request.FeriennetRequest, name: str) -> onegov.feriennet.models.VacationActivity | None

.. py:function:: get_occasion(request: onegov.feriennet.request.FeriennetRequest, id: uuid.UUID) -> onegov.activity.Occasion | None

.. py:function:: get_periods(request: onegov.feriennet.request.FeriennetRequest) -> onegov.activity.PeriodCollection

.. py:function:: get_period(request: onegov.feriennet.request.FeriennetRequest, id: uuid.UUID) -> onegov.activity.Period | None

.. py:function:: get_my_bookings(request: onegov.feriennet.request.FeriennetRequest, app: onegov.feriennet.FeriennetApp, period_id: uuid.UUID | None = None, username: str | None = None) -> onegov.activity.BookingCollection

.. py:function:: get_booking(request: onegov.feriennet.request.FeriennetRequest, id: uuid.UUID) -> onegov.activity.Booking | None

.. py:function:: get_attendee(request: onegov.feriennet.request.FeriennetRequest, id: uuid.UUID) -> onegov.activity.Attendee | None

.. py:function:: get_matches(request: onegov.feriennet.request.FeriennetRequest, app: onegov.feriennet.FeriennetApp, period_id: uuid.UUID | None, states: list[onegov.feriennet.collections.match.OccasionState] | None = None) -> onegov.feriennet.collections.MatchCollection | None

.. py:function:: get_billing(request: onegov.feriennet.request.FeriennetRequest, app: onegov.feriennet.FeriennetApp, period_id: uuid.UUID, username: str | None = None, expand: bool = False, state: Literal['paid', 'unpaid'] = 'unpaid') -> onegov.feriennet.collections.BillingCollection | None

.. py:function:: get_invoice_action(request: onegov.feriennet.models.InvoiceAction, app: onegov.feriennet.FeriennetApp, id: uuid.UUID, action: Literal['mark-paid', 'mark-unpaid', 'remove-manual'], extend_to: Literal['invoice', 'family'] | None = None) -> onegov.feriennet.models.InvoiceAction | None

.. py:function:: get_my_invoices(request: onegov.feriennet.request.FeriennetRequest, app: onegov.feriennet.FeriennetApp, username: str | None = None, invoice: uuid.UUID | None = None) -> onegov.activity.InvoiceCollection | None

.. py:function:: get_my_invoice_item(request: onegov.feriennet.request.FeriennetRequest, id: uuid.UUID) -> onegov.activity.InvoiceItem | None

.. py:function:: get_occasion_attendee_collection(request: onegov.feriennet.request.FeriennetRequest, app: onegov.feriennet.FeriennetApp, activity_name: str, period_id: uuid.UUID | None = None) -> onegov.feriennet.collections.OccasionAttendeeCollection | None

.. py:function:: get_notification_template_collection(app: onegov.feriennet.FeriennetApp) -> onegov.feriennet.collections.NotificationTemplateCollection

.. py:function:: get_notification_template(app: onegov.feriennet.FeriennetApp, id: uuid.UUID, period_id: uuid.UUID | None) -> onegov.feriennet.models.NotificationTemplate | None

.. py:function:: get_calendar(request: onegov.feriennet.request.FeriennetRequest, name: str, token: str) -> onegov.feriennet.models.Calendar | None

.. py:function:: get_group_invite(request: onegov.feriennet.request.FeriennetRequest, group_code: str, username: str | None = None) -> onegov.feriennet.models.GroupInvite | None

.. py:function:: get_occasion_need(request: onegov.feriennet.request.FeriennetRequest, id: uuid.UUID) -> onegov.activity.OccasionNeed | None

.. py:function:: get_volunteer_cart(request: onegov.feriennet.request.FeriennetRequest) -> onegov.feriennet.models.VolunteerCart

.. py:function:: get_volunteer_cart_action(request: onegov.feriennet.request.FeriennetRequest, action: Literal['add', 'remove'], target: uuid.UUID) -> onegov.feriennet.models.VolunteerCartAction

.. py:function:: get_volunteers(request: onegov.feriennet.request.FeriennetRequest, period_id: uuid.UUID) -> onegov.activity.VolunteerCollection | None

.. py:function:: get_volunteer(request: onegov.feriennet.request.FeriennetRequest, id: uuid.UUID) -> onegov.activity.Volunteer | None