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

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


class GiftCardActivityUpdatedEvent(UncheckedBaseModel):
    """
    Published when a [gift card activity](entity:GiftCardActivity) is updated.
    Subscribe to this event to be notified about the following changes:
    - An update to the `REDEEM` activity for a gift card redemption made from a Square product (such as Square Point of Sale).
    These redemptions are initially assigned a `PENDING` state, but then change to a `COMPLETED` or `CANCELED` state.
    - An update to the `IMPORT` activity for an imported gift card when the balance is later adjusted by Square.
    """

    merchant_id: typing.Optional[str] = pydantic.Field(default=None)
    """
    The ID of the Square seller associated with the event.
    """

    type: typing.Optional[str] = pydantic.Field(default=None)
    """
    The type of event. For this event, the value is `gift_card.activity.updated`.
    """

    event_id: typing.Optional[str] = pydantic.Field(default=None)
    """
    The unique ID of the event, which is used for 
    [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
    """

    created_at: typing.Optional[str] = pydantic.Field(default=None)
    """
    The timestamp of when the event was created, in RFC 3339 format.
    """

    data: typing.Optional[GiftCardActivityUpdatedEventData] = pydantic.Field(default=None)
    """
    The data associated with the event.
    """

    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
