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

from __future__ import annotations

from typing_extensions import Literal, Required, Annotated, TypedDict

from ..._utils import PropertyInfo

__all__ = ["V2RetrieveFeedParams"]


class V2RetrieveFeedParams(TypedDict, total=False):
    type: Required[Literal["FACEBOOK", "ITERABLE"]]
    """
    The type determines the fields included with each entry in the feed and the
    format in which the data is returned
    """

    include_shows_without_allocations: Annotated[bool, PropertyInfo(alias="includeShowsWithoutAllocations")]
    """
    Whether to include shows without any regular allocations. By default, shows that
    don't have active regular allocations at the time of the query will NOT be
    included.
    """

    location: str
    """
    A single location ID or comma-separated list of IDs. If none are provided, the
    feed will include data for all locations.
    """

    sort_by: Annotated[Literal["MAX_DISCOUNT_PERCENTAGE", "TOP_SELLING_RANK"], PropertyInfo(alias="sortBy")]
    """Field by which to sort the results."""

    sort_order: Annotated[Literal["ASC", "DESC"], PropertyInfo(alias="sortOrder")]
    """Order by which to sort the results, if a sortBy parameter is provided."""
