from __future__ import annotations
from typing import TYPE_CHECKING, Any, List, Optional
from .base import TelegramObject
if TYPE_CHECKING:
from .chat import Chat
from .custom import DateTime
[docs]
class Giveaway(TelegramObject):
"""
This object represents a message about a scheduled giveaway.
Source: https://core.telegram.org/bots/api#giveaway
"""
chats: List[Chat]
"""The list of chats which the user must join to participate in the giveaway"""
winners_selection_date: DateTime
"""Point in time (Unix timestamp) when winners of the giveaway will be selected"""
winner_count: int
"""The number of users which are supposed to be selected as winners of the giveaway"""
only_new_members: Optional[bool] = None
"""*Optional*. :code:`True`, if only users who join the chats after the giveaway started should be eligible to win"""
has_public_winners: Optional[bool] = None
"""*Optional*. :code:`True`, if the list of giveaway winners will be visible to everyone"""
prize_description: Optional[str] = None
"""*Optional*. Description of additional giveaway prize"""
country_codes: Optional[List[str]] = None
"""*Optional*. A list of two-letter `ISO 3166-1 alpha-2 <https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>`_ country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways."""
premium_subscription_month_count: Optional[int] = None
"""*Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
chats: List[Chat],
winners_selection_date: DateTime,
winner_count: int,
only_new_members: Optional[bool] = None,
has_public_winners: Optional[bool] = None,
prize_description: Optional[str] = None,
country_codes: Optional[List[str]] = None,
premium_subscription_month_count: Optional[int] = None,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(
chats=chats,
winners_selection_date=winners_selection_date,
winner_count=winner_count,
only_new_members=only_new_members,
has_public_winners=has_public_winners,
prize_description=prize_description,
country_codes=country_codes,
premium_subscription_month_count=premium_subscription_month_count,
**__pydantic_kwargs,
)