parseur.schemas.export_config
=============================

.. py:module:: parseur.schemas.export_config


Classes
-------

.. autoapisummary::

   parseur.schemas.export_config.ExportType
   parseur.schemas.export_config.ExportConfigReadSchema
   parseur.schemas.export_config.ExportConfigWriteSchema


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

.. py:class:: ExportType

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


   Type of an export configuration.

   - ``PARSER``: export the document-level result (one row per document).
   - ``PARSER_FIELD``: export the rows of a table field.


   .. py:attribute:: PARSER
      :value: 'PARSER'



   .. py:attribute:: PARSER_FIELD
      :value: 'PARSER_FIELD'



.. py:class:: ExportConfigReadSchema

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


   Read schema for a mailbox export configuration.


   .. py:attribute:: id


   .. py:attribute:: name


   .. py:attribute:: type


   .. py:attribute:: parser_id


   .. py:attribute:: parser_field_id


   .. py:attribute:: parser_field_name


   .. py:attribute:: items


   .. py:attribute:: csv_download


   .. py:attribute:: xls_download


.. py:class:: ExportConfigWriteSchema

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


   Validate/serialize the body sent when creating or updating an export config.

   Unknown fields are rejected so read-only properties and typos never reach
   the API silently.


   .. py:class:: Meta

      .. py:attribute:: unknown


      .. py:attribute:: ordered
         :value: True




   .. py:attribute:: name


   .. py:attribute:: type


   .. py:attribute:: parser_field_id


   .. py:attribute:: items