# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from __future__ import annotations

from typing_extensions import Literal, TypedDict

__all__ = ["V2ListHeroViewsParams"]


class V2ListHeroViewsParams(TypedDict, total=False):
    id: str
    """
    Comma-separated ids for the requested resources. If \\__type is HeroShowView, this
    is a list of id for Shows. If \\__type is HeroShowGroupView, this is a list of id
    for ShowGroups.
    """

    _type: Literal["HeroShowView", "HeroShowGroupView"]

    exclude: Literal["WEB_ONLY", "MOBILE_ONLY"]
    """
    Allows us to exclude heroes that should only be displayed on web or mobile.
    WARNING: The cachestroker does not warm these query params. If you need to use
    these params we should update the cachestroker.
    """

    fieldset: Literal["HeroEssentials", "HeroSuperEssentials"]
    """
    A way to limit the response to only the fields needed for rendering the heroes
    themselves, and not other show/show group fields. If HeroEssentials: the
    endpoint will return ShowHeroEssentials and ShowGroupHeroEssentials objects
    inside the show or showGroup fields within each HeroView. If
    HeroSuperEssentials: include a summary of showtime data instead of the list of
    actual showtime maps for HeroShowView. Include a summary of whether a showGroup
    has rush or lottery active.
    """

    filter: Literal["CITY_LANDING_TOP"]
    """
    Generic options for filtering TodayTix API resources. Note that these filter
    types are intended to provide consistency at the conceptual / product level, but
    may vary in implementation between resources.
    """

    limit: int
    """Max number of results to be returned, if specified."""

    location: int
    """location Id"""
