parseur.schemas.export_config

Classes

ExportType

Type of an export configuration.

ExportConfigReadSchema

Read schema for a mailbox export configuration.

ExportConfigWriteSchema

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

Module Contents

class parseur.schemas.export_config.ExportType[source]

Bases: str, 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.

PARSER = 'PARSER'[source]
PARSER_FIELD = 'PARSER_FIELD'[source]
class parseur.schemas.export_config.ExportConfigReadSchema[source]

Bases: parseur.schemas.BaseSchema

Read schema for a mailbox export configuration.

id[source]
name[source]
type[source]
parser_id[source]
parser_field_id[source]
parser_field_name[source]
items[source]
csv_download[source]
xls_download[source]
class parseur.schemas.export_config.ExportConfigWriteSchema[source]

Bases: 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.

class Meta[source]
unknown[source]
ordered = True[source]
name[source]
type[source]
parser_field_id[source]
items[source]