api.v1.serializers.correspondent_serializers.BaseCorrespondentSerializer module

Module with the BaseCorrespondentSerializer serializer class.

class api.v1.serializers.correspondent_serializers.BaseCorrespondentSerializer.BaseCorrespondentSerializer(*args, **kwargs)

Bases: ModelSerializer

The base serializer for core.models.Correspondent.

Includes all viable fields from the model. Sets all constraints that must be implemented in all serializers. Other serializers for core.models.Correspondent should inherit from this.

class Meta

Bases: object

Metadata class for the base serializer.

Contains constraints that must be implemented by all serializers. Other serializer metaclasses should inherit from this. read_only_fields must not be shortened in subclasses.

model

The model to serialize.

alias of Correspondent

exclude: Final[list[str]] = ['user']

Exclude only the core.models.Correspondent.Correspondent.user field.

read_only_fields: Final[list[str]] = ['email_address', 'email_name', 'list_id', 'list_owner', 'list_subscribe', 'list_unsubscribe', 'list_unsubscribe_post', 'list_post', 'list_help', 'list_archive', 'created', 'updated']

The core.models.Correspondent.Correspondent.email_address, core.models.Correspondent.Correspondent.created and core.models.Correspondent.Correspondent.updated fields are read-only.

_declared_fields = {}