Source code for codegrade.models.base_coupon_usage_summary

"""The module that defines the ``BaseCouponUsageSummary`` model.

SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""

from __future__ import annotations

import datetime
import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa

from ..utils import to_dict


@dataclass
class BaseCouponUsageSummary:
    """The base of a coupon usage."""

    #: The ID of the specific coupon usage event.
    id: str
    #: Timestamp when the coupon was successfully redeemed.
    success_at: datetime.datetime

    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)

    data_parser: t.ClassVar = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "id",
                rqa.SimpleValue.str,
                doc="The ID of the specific coupon usage event.",
            ),
            rqa.RequiredArgument(
                "success_at",
                rqa.RichValue.DateTime,
                doc="Timestamp when the coupon was successfully redeemed.",
            ),
        ).use_readable_describe(True)
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "id": to_dict(self.id),
            "success_at": to_dict(self.success_at),
        }
        return res

    @classmethod
    def from_dict(
        cls: t.Type[BaseCouponUsageSummary], d: t.Dict[str, t.Any]
    ) -> BaseCouponUsageSummary:
        parsed = cls.data_parser.try_parse(d)

        res = cls(
            id=parsed.id,
            success_at=parsed.success_at,
        )
        res.raw_data = d
        return res