"""The module that defines the ``UserAccessPass`` 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 .. import parsers
from ..utils import to_dict
from .base_purchase import BasePurchase
from .tenant_access_plan import TenantAccessPlan
[docs]@dataclass
class UserAccessPass(BasePurchase):
"""A user's purchased access plan."""
#: This was a purchase of an access pass.
scope: t.Literal["access-plan"]
#: The plan that was purchased.
purchased_item: TenantAccessPlan
raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
data_parser: t.ClassVar = rqa.Lazy(
lambda: BasePurchase.data_parser.parser.combine(
rqa.FixedMapping(
rqa.RequiredArgument(
"scope",
rqa.StringEnum("access-plan"),
doc="This was a purchase of an access pass.",
),
rqa.RequiredArgument(
"purchased_item",
parsers.ParserFor.make(TenantAccessPlan),
doc="The plan that was purchased.",
),
)
).use_readable_describe(True)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"scope": to_dict(self.scope),
"purchased_item": to_dict(self.purchased_item),
"id": to_dict(self.id),
"state": to_dict(self.state),
"success_at": to_dict(self.success_at),
"updated_at": to_dict(self.updated_at),
"short_id": to_dict(self.short_id),
}
return res
@classmethod
def from_dict(
cls: t.Type[UserAccessPass], d: t.Dict[str, t.Any]
) -> UserAccessPass:
parsed = cls.data_parser.try_parse(d)
res = cls(
scope=parsed.scope,
purchased_item=parsed.purchased_item,
id=parsed.id,
state=parsed.state,
success_at=parsed.success_at,
updated_at=parsed.updated_at,
short_id=parsed.short_id,
)
res.raw_data = d
return res
import os
if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
import datetime
from .transaction_state import TransactionState