botapi-py 1.4.4__tar.gz → 1.4.6__tar.gz

{botapi_py-1.4.4 → botapi_py-1.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: botapi-py
-Version: 1.4.4
+Version: 1.4.6
 Summary: A simple and flexible Python library to conveniently build fast Telegram bots using the Bot API.
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: pydantic>=2.12.0

{botapi_py-1.4.4 → botapi_py-1.4.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "botapi-py"
-version = "1.4.4"
+version = "1.4.6"
 description = "A simple and flexible Python library to conveniently build fast Telegram bots using the Bot API."
 # readme = "README.md"
 # authors = [

{botapi_py-1.4.4 → botapi_py-1.4.6}/src/botapi/dispatchers/get_updates_handler.py

@@ -22,14 +22,14 @@ class GetUpdatesAsyncDispatcher(BaseAsyncDispatcher):
 	tasks: set[asyncio.Task] # prevent gc from collecting tasks before they finish
 	bot: botapi.methods.Bot
 	reconnect_delay: float
-	allowed_updates: list[str]
+	allowed_updates: list[botapi.enums.UpdateType]
 	offset: int
 	
 	def __init__(
 		self,
 		update_handler: UpdateHandler,
 		bot: botapi.methods.Bot,
-		allowed_updates: list[str], # botapi.enums.UpdateType
+		allowed_updates: list[botapi.enums.UpdateType],
 		reconnect_delay: float = 5,
 		shutdown_wait_timeout: float = 3
 	) -> None:

{botapi_py-1.4.4 → botapi_py-1.4.6}/src/botapi/methods.py

@@ -140,6 +140,7 @@ from .types import (
 	BusinessLocation,
 	BusinessOpeningHoursInterval,
 	BusinessOpeningHours,
+	UserRating,
 	StoryAreaPosition,
 	LocationAddress,
 	StoryAreaType,
@@ -160,12 +161,14 @@ from .types import (
 	MessageReactionUpdated,
 	MessageReactionCountUpdated,
 	ForumTopic,
+	GiftBackground,
 	Gift,
 	Gifts,
 	UniqueGiftModel,
 	UniqueGiftSymbol,
 	UniqueGiftBackdropColors,
 	UniqueGiftBackdrop,
+	UniqueGiftColors,
 	UniqueGift,
 	GiftInfo,
 	UniqueGiftInfo,
@@ -522,6 +525,7 @@ class Bot(core.BaseBot):
 		video_start_timestamp: Optional[int] = None,
 		disable_notification: Optional[bool] = None,
 		protect_content: Optional[bool] = None,
+		message_effect_id: Optional[str] = None,
 		suggested_post_parameters: Optional[SuggestedPostParameters] = None,
 	) -> Message:
 		'''
@@ -541,6 +545,7 @@ class Bot(core.BaseBot):
 			'video_start_timestamp': video_start_timestamp,
 			'disable_notification': disable_notification,
 			'protect_content': protect_content,
+			'message_effect_id': message_effect_id,
 			'suggested_post_parameters': suggested_post_parameters,
 			'message_id': message_id,
 		})
@@ -594,6 +599,7 @@ class Bot(core.BaseBot):
 		disable_notification: Optional[bool] = None,
 		protect_content: Optional[bool] = None,
 		allow_paid_broadcast: Optional[bool] = None,
+		message_effect_id: Optional[str] = None,
 		suggested_post_parameters: Optional[SuggestedPostParameters] = None,
 		reply_parameters: Optional[ReplyParameters] = None,
 		reply_markup: Optional[Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]] = None,
@@ -627,6 +633,7 @@ class Bot(core.BaseBot):
 			'disable_notification': disable_notification,
 			'protect_content': protect_content,
 			'allow_paid_broadcast': allow_paid_broadcast,
+			'message_effect_id': message_effect_id,
 			'suggested_post_parameters': suggested_post_parameters,
 			'reply_parameters': reply_parameters,
 			'reply_markup': reply_markup,
@@ -1418,6 +1425,34 @@ class Bot(core.BaseBot):
 		})
 		return Message.model_validate(response)
 
+	async def send_message_draft(
+		self,
+		chat_id: int,
+		draft_id: int,
+		text: str,
+		message_thread_id: Optional[int] = None,
+		parse_mode: Optional[enums.ParseMode] = enums.ParseMode.HTML,
+		entities: Optional[List[MessageEntity]] = None,
+	) -> bool:
+		'''
+        Use this method to stream a partial message
+        to a user while the message is being
+        generated; supported only for bots with forum topic
+        mode enabled. Returns True on success.
+
+        Reference: https://core.telegram.org/bots/api#sendmessagedraft
+		'''
+
+		response = await self._send_request('sendMessageDraft', {
+			'chat_id': chat_id,
+			'message_thread_id': message_thread_id,
+			'draft_id': draft_id,
+			'text': text,
+			'parse_mode': parse_mode if not entities else None, # FIX,
+			'entities': entities,
+		})
+		return BoolAdapter.validate_python(response)
+
 	async def send_chat_action(
 		self,
 		chat_id: Union[int, str],
@@ -2303,11 +2338,13 @@ class Bot(core.BaseBot):
 	) -> bool:
 		'''
         Use this method to edit name and icon
-        of a topic in a forum supergroup chat.
-        The bot must be an administrator in the
-        chat for this to work and must have
-        the can_manage_topics administrator rights, unless it is the
-        creator of the topic. Returns True on success.
+        of a topic in a forum supergroup chat
+        or a private chat with a user. In
+        the case of a supergroup chat the bot
+        must be an administrator in the chat for
+        this to work and must have the can_manage_topics
+        administrator rights, unless it is the creator of
+        the topic. Returns True on success.
 
         Reference: https://core.telegram.org/bots/api#editforumtopic
 		'''
@@ -2372,10 +2409,11 @@ class Bot(core.BaseBot):
 		'''
         Use this method to delete a forum topic
         along with all its messages in a forum
-        supergroup chat. The bot must be an administrator
-        in the chat for this to work and
-        must have the can_delete_messages administrator rights. Returns True
-        on success.
+        supergroup chat or a private chat with a
+        user. In the case of a supergroup chat
+        the bot must be an administrator in the
+        chat for this to work and must have
+        the can_delete_messages administrator rights. Returns True on success.
 
         Reference: https://core.telegram.org/bots/api#deleteforumtopic
 		'''
@@ -2393,11 +2431,13 @@ class Bot(core.BaseBot):
 	) -> bool:
 		'''
         Use this method to clear the list of
-        pinned messages in a forum topic. The bot
-        must be an administrator in the chat for
-        this to work and must have the can_pin_messages
-        administrator right in the supergroup. Returns True on
-        success.
+        pinned messages in a forum topic in a
+        forum supergroup chat or a private chat with
+        a user. In the case of a supergroup
+        chat the bot must be an administrator in
+        the chat for this to work and must
+        have the can_pin_messages administrator right in the supergroup.
+        Returns True on success.
 
         Reference: https://core.telegram.org/bots/api#unpinallforumtopicmessages
 		'''
@@ -3186,8 +3226,10 @@ class Bot(core.BaseBot):
 		exclude_unsaved: Optional[bool] = None,
 		exclude_saved: Optional[bool] = None,
 		exclude_unlimited: Optional[bool] = None,
-		exclude_limited: Optional[bool] = None,
+		exclude_limited_upgradable: Optional[bool] = None,
+		exclude_limited_non_upgradable: Optional[bool] = None,
 		exclude_unique: Optional[bool] = None,
+		exclude_from_blockchain: Optional[bool] = None,
 		sort_by_price: Optional[bool] = None,
 		offset: Optional[str] = None,
 		limit: Optional[int] = None,
@@ -3205,7 +3247,77 @@ class Bot(core.BaseBot):
 			'exclude_unsaved': exclude_unsaved,
 			'exclude_saved': exclude_saved,
 			'exclude_unlimited': exclude_unlimited,
-			'exclude_limited': exclude_limited,
+			'exclude_limited_upgradable': exclude_limited_upgradable,
+			'exclude_limited_non_upgradable': exclude_limited_non_upgradable,
+			'exclude_unique': exclude_unique,
+			'exclude_from_blockchain': exclude_from_blockchain,
+			'sort_by_price': sort_by_price,
+			'offset': offset,
+			'limit': limit,
+		})
+		return OwnedGifts.model_validate(response)
+
+	async def get_user_gifts(
+		self,
+		user_id: int,
+		exclude_unlimited: Optional[bool] = None,
+		exclude_limited_upgradable: Optional[bool] = None,
+		exclude_limited_non_upgradable: Optional[bool] = None,
+		exclude_from_blockchain: Optional[bool] = None,
+		exclude_unique: Optional[bool] = None,
+		sort_by_price: Optional[bool] = None,
+		offset: Optional[str] = None,
+		limit: Optional[int] = None,
+	) -> OwnedGifts:
+		'''
+        Returns the gifts owned and hosted by a
+        user. Returns OwnedGifts on success.
+
+        Reference: https://core.telegram.org/bots/api#getusergifts
+		'''
+
+		response = await self._send_request('getUserGifts', {
+			'user_id': user_id,
+			'exclude_unlimited': exclude_unlimited,
+			'exclude_limited_upgradable': exclude_limited_upgradable,
+			'exclude_limited_non_upgradable': exclude_limited_non_upgradable,
+			'exclude_from_blockchain': exclude_from_blockchain,
+			'exclude_unique': exclude_unique,
+			'sort_by_price': sort_by_price,
+			'offset': offset,
+			'limit': limit,
+		})
+		return OwnedGifts.model_validate(response)
+
+	async def get_chat_gifts(
+		self,
+		chat_id: Union[int, str],
+		exclude_unsaved: Optional[bool] = None,
+		exclude_saved: Optional[bool] = None,
+		exclude_unlimited: Optional[bool] = None,
+		exclude_limited_upgradable: Optional[bool] = None,
+		exclude_limited_non_upgradable: Optional[bool] = None,
+		exclude_from_blockchain: Optional[bool] = None,
+		exclude_unique: Optional[bool] = None,
+		sort_by_price: Optional[bool] = None,
+		offset: Optional[str] = None,
+		limit: Optional[int] = None,
+	) -> OwnedGifts:
+		'''
+        Returns the gifts owned by a chat. Returns
+        OwnedGifts on success.
+
+        Reference: https://core.telegram.org/bots/api#getchatgifts
+		'''
+
+		response = await self._send_request('getChatGifts', {
+			'chat_id': chat_id,
+			'exclude_unsaved': exclude_unsaved,
+			'exclude_saved': exclude_saved,
+			'exclude_unlimited': exclude_unlimited,
+			'exclude_limited_upgradable': exclude_limited_upgradable,
+			'exclude_limited_non_upgradable': exclude_limited_non_upgradable,
+			'exclude_from_blockchain': exclude_from_blockchain,
 			'exclude_unique': exclude_unique,
 			'sort_by_price': sort_by_price,
 			'offset': offset,
@@ -3313,6 +3425,37 @@ class Bot(core.BaseBot):
 		})
 		return Story.model_validate(response)
 
+	async def repost_story(
+		self,
+		business_connection_id: str,
+		from_chat_id: int,
+		from_story_id: int,
+		active_period: int,
+		post_to_chat_page: Optional[bool] = None,
+		protect_content: Optional[bool] = None,
+	) -> Story:
+		'''
+        Reposts a story on behalf of a business
+        account from another business account. Both business accounts
+        must be managed by the same bot, and
+        the story on the source account must have
+        been posted (or reposted) by the bot. Requires
+        the can_manage_stories business bot right for both business
+        accounts. Returns Story on success.
+
+        Reference: https://core.telegram.org/bots/api#repoststory
+		'''
+
+		response = await self._send_request('repostStory', {
+			'business_connection_id': business_connection_id,
+			'from_chat_id': from_chat_id,
+			'from_story_id': from_story_id,
+			'active_period': active_period,
+			'post_to_chat_page': post_to_chat_page,
+			'protect_content': protect_content,
+		})
+		return Story.model_validate(response)
+
 	async def edit_story(
 		self,
 		business_connection_id: str,

{botapi_py-1.4.4 → botapi_py-1.4.6}/src/botapi/types.py

@@ -95,6 +95,7 @@ class Message(MaybeInaccessibleMessage, frozen=True):
 	chat_shared: Optional[ChatShared] = Field(default=None)
 	gift: Optional[GiftInfo] = Field(default=None)
 	unique_gift: Optional[UniqueGiftInfo] = Field(default=None)
+	gift_upgrade_sent: Optional[GiftInfo] = Field(default=None)
 	connected_website: Optional[str] = Field(default=None)
 	write_access_allowed: Optional[WriteAccessAllowed] = Field(default=None)
 	passport_data: Optional[PassportData] = Field(default=None)
@@ -871,7 +872,9 @@ class OwnedGiftRegular(OwnedGift, frozen=True):
 	can_be_upgraded: Optional[bool] = Field(default=None)
 	was_refunded: Optional[bool] = Field(default=None)
 	convert_star_count: Optional[int] = Field(default=None)
-	prepaid_upgrade_star_count: Optional[int] = Field(default=None) 
+	prepaid_upgrade_star_count: Optional[int] = Field(default=None)
+	is_upgrade_separate: Optional[bool] = Field(default=None)
+	unique_gift_number: Optional[int] = Field(default=None) 
 
 class OwnedGiftUnique(OwnedGift, frozen=True):
 	'''
@@ -2250,7 +2253,8 @@ class User(BaseModel, frozen=True):
 	can_read_all_group_messages: Optional[bool] = Field(default=None)
 	supports_inline_queries: Optional[bool] = Field(default=None)
 	can_connect_to_business: Optional[bool] = Field(default=None)
-	has_main_web_app: Optional[bool] = Field(default=None) 
+	has_main_web_app: Optional[bool] = Field(default=None)
+	has_topics_enabled: Optional[bool] = Field(default=None) 
 
 class Chat(BaseModel, frozen=True):
 	'''
@@ -2321,7 +2325,10 @@ class ChatFullInfo(BaseModel, frozen=True):
 	can_set_sticker_set: Optional[bool] = Field(default=None)
 	custom_emoji_sticker_set_name: Optional[str] = Field(default=None)
 	linked_chat_id: Optional[int] = Field(default=None)
-	location: Optional[ChatLocation] = Field(default=None) 
+	location: Optional[ChatLocation] = Field(default=None)
+	rating: Optional[UserRating] = Field(default=None)
+	unique_gift_colors: Optional[UniqueGiftColors] = Field(default=None)
+	paid_message_star_count: Optional[int] = Field(default=None) 
 
 class MessageId(BaseModel, frozen=True):
 	'''
@@ -2659,6 +2666,7 @@ class ChecklistTask(BaseModel, frozen=True):
 	text: str
 	text_entities: Optional[List[MessageEntity]] = Field(default=None)
 	completed_by_user: Optional[User] = Field(default=None)
+	completed_by_chat: Optional[Chat] = Field(default=None)
 	completion_date: Optional[int] = Field(default=None) 
 
 class Checklist(BaseModel, frozen=True):
@@ -2815,7 +2823,8 @@ class ForumTopicCreated(BaseModel, frozen=True):
 
 	name: str
 	icon_color: int
-	icon_custom_emoji_id: Optional[str] = Field(default=None) 
+	icon_custom_emoji_id: Optional[str] = Field(default=None)
+	is_name_implicit: Optional[bool] = Field(default=None) 
 
 class ForumTopicClosed(BaseModel, frozen=True):
 	'''
@@ -3638,6 +3647,19 @@ class BusinessOpeningHours(BaseModel, frozen=True):
 	time_zone_name: str
 	opening_hours: List[BusinessOpeningHoursInterval] 
 
+class UserRating(BaseModel, frozen=True):
+	'''
+    This object describes the rating of a user
+    based on their Telegram Star spendings.
+
+    Reference: https://core.telegram.org/bots/api#userrating
+	'''
+
+	level: int
+	rating: int
+	current_level_rating: int
+	next_level_rating: Optional[int] = Field(default=None) 
+
 class StoryAreaPosition(BaseModel, frozen=True):
 	'''
     Describes the position of a clickable area within
@@ -3736,7 +3758,19 @@ class ForumTopic(BaseModel, frozen=True):
 	message_thread_id: int
 	name: str
 	icon_color: int
-	icon_custom_emoji_id: Optional[str] = Field(default=None) 
+	icon_custom_emoji_id: Optional[str] = Field(default=None)
+	is_name_implicit: Optional[bool] = Field(default=None) 
+
+class GiftBackground(BaseModel, frozen=True):
+	'''
+    This object describes the background of a gift.
+
+    Reference: https://core.telegram.org/bots/api#giftbackground
+	'''
+
+	center_color: int
+	edge_color: int
+	text_color: int 
 
 class Gift(BaseModel, frozen=True):
 	'''
@@ -3750,8 +3784,14 @@ class Gift(BaseModel, frozen=True):
 	sticker: Sticker
 	star_count: int
 	upgrade_star_count: Optional[int] = Field(default=None)
+	is_premium: Optional[bool] = Field(default=None)
+	has_colors: Optional[bool] = Field(default=None)
 	total_count: Optional[int] = Field(default=None)
 	remaining_count: Optional[int] = Field(default=None)
+	personal_total_count: Optional[int] = Field(default=None)
+	personal_remaining_count: Optional[int] = Field(default=None)
+	background: Optional[GiftBackground] = Field(default=None)
+	unique_gift_variant_count: Optional[int] = Field(default=None)
 	publisher_chat: Optional[Chat] = Field(default=None) 
 
 class Gifts(BaseModel, frozen=True):
@@ -3812,6 +3852,22 @@ class UniqueGiftBackdrop(BaseModel, frozen=True):
 	colors: UniqueGiftBackdropColors
 	rarity_per_mille: int 
 
+class UniqueGiftColors(BaseModel, frozen=True):
+	'''
+    This object contains information about the color scheme
+    for a user's name, message replies and link
+    previews based on a unique gift.
+
+    Reference: https://core.telegram.org/bots/api#uniquegiftcolors
+	'''
+
+	model_custom_emoji_id: str
+	symbol_custom_emoji_id: str
+	light_theme_main_color: int
+	light_theme_other_colors: List[int]
+	dark_theme_main_color: int
+	dark_theme_other_colors: List[int] 
+
 class UniqueGift(BaseModel, frozen=True):
 	'''
     This object describes a unique gift that was
@@ -3820,12 +3876,16 @@ class UniqueGift(BaseModel, frozen=True):
     Reference: https://core.telegram.org/bots/api#uniquegift
 	'''
 
+	gift_id: str
 	base_name: str
 	name: str
 	number: int
 	model: UniqueGiftModel
 	symbol: UniqueGiftSymbol
 	backdrop: UniqueGiftBackdrop
+	is_premium: Optional[bool] = Field(default=None)
+	is_from_blockchain: Optional[bool] = Field(default=None)
+	colors: Optional[UniqueGiftColors] = Field(default=None)
 	publisher_chat: Optional[Chat] = Field(default=None) 
 
 class GiftInfo(BaseModel, frozen=True):
@@ -3840,10 +3900,12 @@ class GiftInfo(BaseModel, frozen=True):
 	owned_gift_id: Optional[str] = Field(default=None)
 	convert_star_count: Optional[int] = Field(default=None)
 	prepaid_upgrade_star_count: Optional[int] = Field(default=None)
+	is_upgrade_separate: Optional[bool] = Field(default=None)
 	can_be_upgraded: Optional[bool] = Field(default=None)
 	text: Optional[str] = Field(default=None)
 	entities: Optional[List[MessageEntity]] = Field(default=None)
-	is_private: Optional[bool] = Field(default=None) 
+	is_private: Optional[bool] = Field(default=None)
+	unique_gift_number: Optional[int] = Field(default=None) 
 
 class UniqueGiftInfo(BaseModel, frozen=True):
 	'''
@@ -3855,7 +3917,8 @@ class UniqueGiftInfo(BaseModel, frozen=True):
 
 	gift: UniqueGift
 	origin: str
-	last_resale_star_count: Optional[int] = Field(default=None)
+	last_resale_currency: Optional[str] = Field(default=None)
+	last_resale_amount: Optional[int] = Field(default=None)
 	owned_gift_id: Optional[str] = Field(default=None)
 	transfer_star_count: Optional[int] = Field(default=None)
 	next_transfer_date: Optional[int] = Field(default=None) 
@@ -3884,7 +3947,8 @@ class AcceptedGiftTypes(BaseModel, frozen=True):
 	unlimited_gifts: bool
 	limited_gifts: bool
 	unique_gifts: bool
-	premium_subscription: bool 
+	premium_subscription: bool
+	gifts_from_channels: bool 
 
 class StarAmount(BaseModel, frozen=True):
 	'''