parseur.schemas.document
========================

.. py:module:: parseur.schemas.document


Classes
-------

.. autoapisummary::

   parseur.schemas.document.DocumentStatus
   parseur.schemas.document.DocumentSchema
   parseur.schemas.document.DocumentLogSchema
   parseur.schemas.document.AttachmentSchema
   parseur.schemas.document.DocumentUploadSchema


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

.. py:class:: DocumentStatus

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


   Enum for Parseur document processing statuses.


   .. py:attribute:: INCOMING
      :value: 'INCOMING'



   .. py:attribute:: ANALYZING
      :value: 'ANALYZING'



   .. py:attribute:: DELETED
      :value: 'DELETED'



   .. py:attribute:: PROGRESS
      :value: 'PROGRESS'



   .. py:attribute:: PARSEDOK
      :value: 'PARSEDOK'



   .. py:attribute:: PARSEDKO
      :value: 'PARSEDKO'



   .. py:attribute:: QUOTAEXC
      :value: 'QUOTAEXC'



   .. py:attribute:: SKIPPED
      :value: 'SKIPPED'



   .. py:attribute:: SPLIT
      :value: 'SPLIT'



   .. py:attribute:: EXPORTKO
      :value: 'EXPORTKO'



   .. py:attribute:: TRANSKO
      :value: 'TRANSKO'



   .. py:attribute:: INVALID
      :value: 'INVALID'



.. py:class:: DocumentSchema

   Bases: :py:obj:`parseur.schemas.BaseSchema`


   .. py:attribute:: id


   .. py:attribute:: name


   .. py:attribute:: status


   .. py:attribute:: status_source


   .. py:attribute:: received


   .. py:attribute:: processed


   .. py:attribute:: ai_credits_used


   .. py:attribute:: credits_used


   .. py:attribute:: is_ai_ready


   .. py:attribute:: is_ocr_ready


   .. py:attribute:: is_processable


   .. py:attribute:: is_split


   .. py:attribute:: is_splittable


   .. py:attribute:: parser


   .. py:attribute:: template


   .. py:attribute:: attached_to


   .. py:attribute:: prev_id


   .. py:attribute:: next_id


   .. py:attribute:: content


   .. py:attribute:: result


   .. py:attribute:: csv_download_url


   .. py:attribute:: json_download_url


   .. py:attribute:: xls_download_url


   .. py:attribute:: original_document_url


   .. py:attribute:: ocr_ready_url


   .. py:method:: parse_result_json(data, **kwargs)


.. py:class:: DocumentLogSchema

   Bases: :py:obj:`parseur.schemas.BaseSchema`


   .. py:attribute:: id


   .. py:attribute:: code


   .. py:attribute:: created


   .. py:attribute:: document


   .. py:attribute:: document_name


   .. py:attribute:: message


   .. py:attribute:: parser


   .. py:attribute:: parser_name


   .. py:attribute:: payload


   .. py:attribute:: source


   .. py:attribute:: status


   .. py:attribute:: template


   .. py:attribute:: template_name


   .. py:attribute:: initiator


   .. py:attribute:: initiator_name


   .. py:method:: parse_payload_json(data, **kwargs)


.. py:class:: AttachmentSchema

   Bases: :py:obj:`parseur.schemas.BaseSchema`


   .. py:attribute:: DocumentID


   .. py:attribute:: name


.. py:class:: DocumentUploadSchema

   Bases: :py:obj:`parseur.schemas.BaseSchema`


   .. py:attribute:: DocumentID


   .. py:attribute:: attachments


   .. py:attribute:: message