# This file was auto-generated by Fern from our API Definition.

from ..core.unchecked_base_model import UncheckedBaseModel
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
import typing


class LoyaltyEventExpirePoints(UncheckedBaseModel):
    """
    Provides metadata when the event `type` is `EXPIRE_POINTS`.
    """

    loyalty_program_id: str = pydantic.Field()
    """
    The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
    """

    points: int = pydantic.Field()
    """
    The number of points expired.
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
