Source code for parseur.event

from enum import Enum



[docs]class ParseurEvent(str, 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.
    """


[docs]    DOCUMENT_PROCESSED = "document.processed"


[docs]    DOCUMENT_PROCESSED_FLATTENED = "document.processed.flattened"


[docs]    DOCUMENT_TEMPLATE_NEEDED = "document.template_needed"


[docs]    DOCUMENT_EXPORT_FAILED = "document.export_failed"


[docs]    TABLE_PROCESSED = "table.processed"


[docs]    TABLE_PROCESSED_FLATTENED = "table.processed.flattened"



[docs]    def is_table_event(self) -> bool:
        return self.value.startswith("table")