reservation.models.custom_reservation
=====================================

.. py:module:: reservation.models.custom_reservation


Classes
-------

.. autoapisummary::

   reservation.models.custom_reservation.CustomReservation


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

.. py:class:: CustomReservation

   Bases: :py:obj:`libres.db.models.Reservation`, :py:obj:`onegov.core.orm.ModelBase`, :py:obj:`onegov.pay.Payable`


   Describes a pending or approved reservation.

       


   .. py:attribute:: __mapper_args__


   .. py:property:: resource_obj
      :type: onegov.reservation.models.resource.Resource



   .. py:property:: payable_reference
      :type: str


      A string which identifies this payable in payment lists. Do not
      join any values here as it can lead to an explosion of executed
      queries!

      By default we use the table name plus a hash derived from the
      primary key values of the table. This ensures that we do not
      accidentally leak secrets.

      In practice, this reference should be customised for each payable.




   .. py:method:: price(resource: onegov.reservation.models.resource.Resource | None = None) -> onegov.pay.Price | None

      Returns the price of the reservation.

      Even though one token may point to multiple reservations the price
      is bound to the reservation record.

      The price per token is calculcated by combining all the prices.