Models¶

class EventimPublicAttraction(EventimBaseModel):
    """This class is the response model for the public API 'attractions' (v1) endpoint."""

    attraction_id: int
    name: str
    link: str
    url: EventimPublicUrl
    image_url: str | None = None
    rating: EventimPublicRating

class EventimPublicContent(EventimBaseModel):
    """This class is the response model for the public API 'content' (v1) endpoint."""

    content_id: str
    title: str
    description: str
    url: EventimPublicUrl
    type: PUBLIC_CONTENT_TYPE

class EventimPublicLocation(EventimBaseModel):
    """This class is the response model for the public API 'locations' (v1) endpoint."""

    location_id: str
    name: str
    description: str | None = None
    city: str
    link: str
    url: EventimPublicUrl
    image_url: str | None = None
    rating: EventimPublicRating

class EventimPublicProductGroup(EventimBaseModel):
    """This class is the response model for the public API 'productGroups' (v2) endpoint."""

    product_group_id: int
    name: str
    description: str | None = None
    start_date: datetime | None = None
    end_date: datetime | None = None
    product_count: int
    link: str
    url: EventimPublicUrl
    image_url: str | None = None
    currency: str | None = None
    rating: EventimPublicRating | None = None
    categories: list[dict]
    tags: list[str] | None = None
    status: str  # TODO: Literal
    ranking_statistic: dict
    products: list[EventimPublicProductGroupProduct]

class EventimPublicProductGroupProduct(EventimBaseModel):
    """This class is the response sub model for the public API 'productGroups/products' (v2) endpoint."""

    product_id: int
    name: str
    type: PUBLIC_PRODUCTGROUP_PRODUCT_TYPE  # TODO: Literal
    status: str  # TODO: Literal
    link: str
    url: EventimPublicUrl
    type_attributes: dict
    rating: EventimPublicRating | None = None
    tags: list[str] | None = None
    has_recommendation: bool

class EventimPublicRating(EventimBaseModel):
    """This class is the response model for generic Rating objects of the public endpoints."""

    count: int
    average: float

class EventimPublicUrl(EventimBaseModel):
    """This class is the response model for generic URL objects of the public endpoints."""

    path: str
    domain: str

class EventimPrivateCalendarContentEvent(EventimBaseModel):
    """This class is the response model for the private component API 'component' endpoint."""

    id: int
    title: str
    url: str
    start: datetime | Literal[""]
    event_time: str
    price: str
    event_date: str
    tile_first_line: str
    price_available: bool
    ticket_available: bool
    ticket_status_message: str
    product_state: EventimPrivateCalendarContentEventProductState
    event_state: int
    voucher: bool
    promotion_contained: bool
    subscription_package: bool
    subscription_package_data: EventimPrivateCalendarContentEventSubscriptionPackageData | None = None
    venue_name: str
    first: str
    second: str
    third: str
    event_weekday: str
    identical_city: bool
    identical_venue: bool
    marketing_labels: list[EventimPrivateCalendarContentEventMarketingLabel]
    club_icon: EventimPrivateCalendarContentEventClubIcon
    sub_listings: list[EventimPrivateCalendarContentEventSubListing]
    external_offers: bool
    tdl_id: int
    formatted_day: str
    formatted_month_year: str
    formatted_weekday_time: str
    formatted_iso_date: str
    continuous_event_data: EventimPrivateCalendarContentEventContinuousEventData | None = None
    event_favorites_item: str | None = None  # TODO: Check type
    image_path: str | None = None  # TODO: Check type
    link_to_modal_layer: str | None = None  # TODO: Check type
    medal_icon: str | None = None  # TODO: Check type
    gender_icon: str | None = None  # TODO: Check type
    formatted_date_time: str | None = None  # TODO: Check type
    desc1: str | None = None  # TODO: Check type
    desc2: str | None = None  # TODO: Check type
    crossed_out_price: str
    bookable: bool
    availability_indicator: int
    ticket_fee_link: str | None = None
    scarcity_message: str | None = None
    link_event: bool
    link_event_url: str | None = None
    calendar_price_indicator: str | None = None  # TODO: Check type
    ticket_direct: bool
    eventim_pass: bool
    fanticket: bool
    red: bool
    mobile_ticket: bool
    will_call: bool
    resale_cta_visible: bool
    timeslot: bool
    tracking_data: EventimPrivateCalendarContentEventTrackingDate

class EventimPrivateCalendarContentEventClubIcon(EventimBaseModel):
    """This class is the response sub model for the private component API 'component' endpoint for Event Club Icon."""

    icon_visible: bool
    marketing_label: EventimPrivateCalendarContentEventMarketingLabel | None = None
    ticket_type_info_visible: bool
    ticket_type_info: str
    icon_color: str

class EventimPrivateCalendarContentEventContinuousEventData(EventimBaseModel):
    """Response sub model for the private component API 'component' endpoint for Continuous Event Data."""

    start_date: str
    to_date: str

class EventimPrivateCalendarContentEventMarketingLabel(EventimBaseModel):
    """Response sub model for the private component API 'component' endpoint for Event Marketing Label."""

    id: int
    label_name: str
    font_color: str
    background_color: str
    tracking_name: str

class EventimPrivateCalendarContentEventProductState(EventimBaseModel):
    """This class is the response sub model for the private component API 'component' endpoint for Product State."""

    available: bool
    message: str
    red: bool
    available_for_seatmap: bool
    status: Literal[
        "AFTER_OFFSALE",
        "AVAILABLE",
        "BEFORE_ONSALE",
        "CANCELLED",
        "NO_AMOUNT",
        "POSTPONED",
        "SOLD_OUT_FANSALE_AVAILABLE",
        "SOLD_OUT",
        "UNDELIVERABLE",
        "UNKNOWN",
    ]

class EventimPrivateCalendarContentEventSubListing(EventimBaseModel):
    """This class is the response sub model for the private component API 'component' endpoint for Sub-Listing."""

    headline: str
    icon_key: str
    sub_listing_items: list[EventimPrivateCalendarContentEventSubListingSubListingItem]
    formatted_price: str
    tracking_key: str
    priority: int
    available: bool
    status_hidden: bool
    has_price: bool

class EventimPrivateCalendarContentEventSubListingSubListingItem(EventimBaseModel):
    """This class is the response sub model for the private component API 'component' endpoint for Sub-Listing Item."""

    headline: str
    short_description: str
    details_url: str
    formatted_price: str
    price: float
    crossed_out_price: str
    available: bool
    status_hidden: bool
    ticket_fee_link: str | None = None
    has_price: bool

class EventimPrivateCalendarContentEventSubscriptionPackageData(EventimBaseModel):
    """This class is the response sub model for the private component API 'component' endpoint
    for Subscription Package."""

    start_date: str
    to_date: str
    subscription_package_url: str
    event_count: int
    venue_count: int
    product_count: int
    event_message: str
    subscription_package_message: str
    city_message: str
    subscription_package_description_message_key: str
    subscription_package_description_link_text: str
    product_message: str

class EventimPrivateCalendarContentEventTrackingDate(EventimBaseModel):
    """This class is the response sub model for the private component API 'component' endpoint for
    Event Tracking Data."""

    label: str
    id: int
    name: str