pay.collections.payment
=======================

.. py:module:: pay.collections.payment


Classes
-------

.. autoapisummary::

   pay.collections.payment.PaymentCollection


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

.. py:class:: PaymentCollection(session: sqlalchemy.orm.Session, source: str = '*', page: int = 0, start: datetime.datetime | None = None, end: datetime.datetime | None = None)

   Bases: :py:obj:`onegov.core.collection.GenericCollection`\ [\ :py:obj:`onegov.pay.models.Payment`\ ], :py:obj:`onegov.core.collection.Pagination`\ [\ :py:obj:`onegov.pay.models.Payment`\ ]


   Manages the payment records.

   To render a list of payments you might want to also consider the
   :class:`onegov.pay.collection.payable.Paybale` collection, which renders
   payments by loading the linked records first.



   .. py:attribute:: page
      :type:  int


   .. py:attribute:: source
      :value: '*'



   .. py:attribute:: start
      :value: None



   .. py:attribute:: end
      :value: None



   .. py:property:: model_class
      :type: type[onegov.pay.models.Payment]



   .. py:method:: add(*, source: str | None = None, amount: decimal.Decimal | None = None, currency: str = 'CHF', remote_id: str | None = None, state: onegov.pay.types.PaymentState = 'open', **kwargs: Any) -> onegov.pay.models.Payment


   .. py:method:: __eq__(other: object) -> bool

      Returns True if the current and the other Pagination instance
      are equal. Used to find the current page in a list of pages.




   .. py:method:: subset() -> sqlalchemy.orm.Query[onegov.pay.models.Payment]

      Returns an SQLAlchemy query containing all records that should
      be considered for pagination.




   .. py:property:: page_index
      :type: int


      Returns the current page index (starting at 0). 



   .. py:method:: page_by_index(index: int) -> Self

      Returns the page at the given index. A page here means an instance
      of the class inheriting from the ``Pagination`` base class.




   .. py:method:: payment_links_for(items: collections.abc.Iterable[onegov.pay.models.Payment]) -> dict[uuid.UUID, list[onegov.pay.types.AnyPayableBase]]

      A more efficient way of loading all links of the given batch
      (compared to loading payment.links one by one).




   .. py:method:: payment_links_by_subset(subset: collections.abc.Iterable[onegov.pay.models.Payment] | None = None) -> dict[uuid.UUID, list[onegov.pay.types.AnyPayableBase]]


   .. py:method:: payment_links_by_batch(batch: collections.abc.Collection[onegov.pay.models.Payment] | None = None) -> dict[uuid.UUID, list[onegov.pay.types.AnyPayableBase]] | None