nk20/apps/activity/api/serializers.py

# Copyright (C) 2018-2024 by BDE ENS Paris-Saclay
# SPDX-License-Identifier: GPL-3.0-or-later

from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
from rest_framework.validators import UniqueTogetherValidator

from ..models import Activity, ActivityType, Entry, Guest, GuestTransaction, Opener


class ActivityTypeSerializer(serializers.ModelSerializer):
    """
    REST API Serializer for Activity types.
    The djangorestframework plugin will analyse the model `ActivityType` and parse all fields in the API.
    """

    class Meta:
        model = ActivityType
        fields = '__all__'


class ActivitySerializer(serializers.ModelSerializer):
    """
    REST API Serializer for Activities.
    The djangorestframework plugin will analyse the model `Activity` and parse all fields in the API.
    """

    class Meta:
        model = Activity
        fields = '__all__'


class GuestSerializer(serializers.ModelSerializer):
    """
    REST API Serializer for Guests.
    The djangorestframework plugin will analyse the model `Guest` and parse all fields in the API.
    """

    class Meta:
        model = Guest
        fields = '__all__'


class EntrySerializer(serializers.ModelSerializer):
    """
    REST API Serializer for Entries.
    The djangorestframework plugin will analyse the model `Entry` and parse all fields in the API.
    """

    class Meta:
        model = Entry
        fields = '__all__'


class GuestTransactionSerializer(serializers.ModelSerializer):
    """
    REST API Serializer for Special transactions.
    The djangorestframework plugin will analyse the model `GuestTransaction` and parse all fields in the API.
    """

    class Meta:
        model = GuestTransaction
        fields = '__all__'


class OpenerSerializer(serializers.ModelSerializer):
    """
    REST API Serializer for Openers.
    The djangorestframework plugin will analyse the model `Opener` and parse all fields in the API.
    """

    class Meta:
        model = Opener
        fields = '__all__'
        validators = [UniqueTogetherValidator(
            queryset=Opener.objects.all(), fields=("opener", "activity"),
            message=_("This opener already exists"))]