parseur.event
=============

.. py:module:: parseur.event


Classes
-------

.. autoapisummary::

   parseur.event.ParseurEvent


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

.. py:class:: ParseurEvent

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Enumeration of supported Parseur webhook event types.

   Use these values when registering webhooks to specify which event to listen for.

   Members:

   - `DOCUMENT_PROCESSED`: Document processed successfully.
   - `DOCUMENT_PROCESSED_FLATTENED`: Document processed as flat data.
   - `DOCUMENT_TEMPLATE_NEEDED`: Document processing failed (template needed).
   - `DOCUMENT_EXPORT_FAILED`: Export of the document failed.
   - `TABLE_PROCESSED`: A table field row was processed.
   - `TABLE_PROCESSED_FLATTENED`: A table field row (flattened) was processed.


   .. py:attribute:: DOCUMENT_PROCESSED
      :value: 'document.processed'



   .. py:attribute:: DOCUMENT_PROCESSED_FLATTENED
      :value: 'document.processed.flattened'



   .. py:attribute:: DOCUMENT_TEMPLATE_NEEDED
      :value: 'document.template_needed'



   .. py:attribute:: DOCUMENT_EXPORT_FAILED
      :value: 'document.export_failed'



   .. py:attribute:: TABLE_PROCESSED
      :value: 'table.processed'



   .. py:attribute:: TABLE_PROCESSED_FLATTENED
      :value: 'table.processed.flattened'



   .. py:method:: is_table_event() -> bool