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

from __future__ import annotations

from typing import List, Union
from datetime import datetime
from typing_extensions import Literal, Annotated, TypedDict

from ..._types import SequenceNotStr
from ..._utils import PropertyInfo

__all__ = ["BotTimeseriesParams"]


class BotTimeseriesParams(TypedDict, total=False):
    agg_interval: Annotated[Literal["15m", "1h", "1d", "1w"], PropertyInfo(alias="aggInterval")]
    """Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).

    Refer to
    [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
    """

    asn: SequenceNotStr[str]
    """Filters results by Autonomous System.

    Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list.
    Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes
    results from AS174, but includes results from AS3356.
    """

    bot: SequenceNotStr[str]
    """Filters results by bot name."""

    bot_category: Annotated[
        List[
            Literal[
                "SEARCH_ENGINE_CRAWLER",
                "SEARCH_ENGINE_OPTIMIZATION",
                "MONITORING_AND_ANALYTICS",
                "ADVERTISING_AND_MARKETING",
                "SOCIAL_MEDIA_MARKETING",
                "PAGE_PREVIEW",
                "ACADEMIC_RESEARCH",
                "SECURITY",
                "ACCESSIBILITY",
                "WEBHOOKS",
                "FEED_FETCHER",
                "AI_CRAWLER",
                "AGGREGATOR",
                "AI_ASSISTANT",
                "AI_SEARCH",
                "ARCHIVER",
            ]
        ],
        PropertyInfo(alias="botCategory"),
    ]
    """Filters results by bot category."""

    bot_kind: Annotated[List[Literal["AGENT", "BOT"]], PropertyInfo(alias="botKind")]
    """Filters results by bot kind."""

    bot_operator: Annotated[SequenceNotStr[str], PropertyInfo(alias="botOperator")]
    """Filters results by bot operator."""

    bot_verification_status: Annotated[List[Literal["VERIFIED"]], PropertyInfo(alias="botVerificationStatus")]
    """Filters results by bot verification status (Verified vs. Unverified)."""

    continent: SequenceNotStr[str]
    """Filters results by continent.

    Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude
    continents from results. For example, `-EU,NA` excludes results from EU, but
    includes results from NA.
    """

    date_end: Annotated[SequenceNotStr[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")]
    """End of the date range (inclusive)."""

    date_range: Annotated[SequenceNotStr[str], PropertyInfo(alias="dateRange")]
    """Filters results by date range.

    For example, use `7d` and `7dcontrol` to compare this week with the previous
    week. Use this parameter or set specific start and end dates (`dateStart` and
    `dateEnd` parameters).
    """

    date_start: Annotated[SequenceNotStr[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")]
    """Start of the date range."""

    format: Literal["JSON", "CSV"]
    """Format in which results will be returned."""

    location: SequenceNotStr[str]
    """Filters results by location.

    Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude
    locations from results. For example, `-US,PT` excludes results from the US, but
    includes results from PT.
    """

    name: SequenceNotStr[str]
    """Array of names used to label the series in the response."""
