Source code for codegrade.models.otp_login_response

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

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

from __future__ import annotations

import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa

from ..utils import to_dict




@dataclass
class OTPLoginResponse:
    """Response when an OTP login session is created.

    Use the `id` to confirm the code (`otp_login.confirm`). If that returns
    `{"type": "select"}`, use it to list matching users (`otp_login.list`) and
    select one (`otp_login.select`).
    """

    #: The OTP session identifier, used for `confirm`, `list`, and `select`
    #: calls.
    id: str

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

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "id",
                rqa.SimpleValue.str,
                doc="The OTP session identifier, used for `confirm`, `list`, and `select` calls.",
            ),
        ).use_readable_describe(True)
    )

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

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

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