parseur.schemas.paserfield

Classes

FieldFormat	Enumeration of the data formats a parser field can have.
TableFieldReadSchema	A table field as summarised in a mailbox's table_set (id + name).
ParserFieldBaseSchema	Properties shared by the read and write representations of a parser field.
ParserFieldReadSchema	Read schema for a parser field returned by the API.
ParserFieldWriteSchema	Write schema for a parser field.

Module Contents

class parseur.schemas.paserfield.FieldFormat

Bases: str, enum.Enum

Enumeration of the data formats a parser field can have.

Used as the format of a field when creating or updating a mailbox’s fields (parser_object_set).

TEXT = 'TEXT'

ONELINE = 'ONELINE'

DATE = 'DATE'

TIME = 'TIME'

DATETIME = 'DATETIME'

NUMBER = 'NUMBER'

NAME = 'NAME'

ADDRESS = 'ADDRESS'

TABLE = 'TABLE'

LINK = 'LINK'

class parseur.schemas.paserfield.TableFieldReadSchema

Bases: parseur.schemas.BaseSchema

A table field as summarised in a mailbox’s table_set (id + name).

id

name

class parseur.schemas.paserfield.ParserFieldBaseSchema

Bases: parseur.schemas.BaseSchema

Properties shared by the read and write representations of a parser field.

Both serializing API responses and validating create/update request bodies rely on these common fields, so they are declared once here.

name

format

query

choice_set

class parseur.schemas.paserfield.ParserFieldReadSchema

Bases: ParserFieldBaseSchema

Read schema for a parser field returned by the API.

id

type

is_required

used_by_ai

csv_download

json_download

xls_download

parser_object_set

class parseur.schemas.paserfield.ParserFieldWriteSchema

Bases: ParserFieldBaseSchema

Write schema for a parser field.

Used to validate and serialize each entry of a mailbox’s parser_object_set. Unknown fields are rejected so read-only properties (type, csv_download, …) and typos never reach the API silently. Pass id to update an existing field; omit it to create a new one.

class Meta

unknown

ordered = True

id

is_required

used_by_ai

_destroy

parser_object_set