botapi-py 1.5.7__tar.gz → 1.5.9__tar.gz

{botapi_py-1.5.7 → botapi_py-1.5.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: botapi-py
-Version: 1.5.7
+Version: 1.5.9
 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.5.7 → botapi_py-1.5.9}/pyproject.toml

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

{botapi_py-1.5.7 → botapi_py-1.5.9}/src/botapi/enums.py

@@ -42,6 +42,8 @@ class UpdateType(enum.StrEnum):
 	EDITED_BUSINESS_MESSAGE = 'edited_business_message'
 	DELETED_BUSINESS_MESSAGES = 'deleted_business_messages'
 	PURCHASED_PAID_MEDIA = 'purchased_paid_media'
+	MANAGED_BOT = 'managed_bot'
+	GUEST_MESSAGE = 'guest_message'
 	
 class MediaType(enum.StrEnum):
 	'''
@@ -59,6 +61,7 @@ class MediaType(enum.StrEnum):
 	VOICE = 'voice'
 	STORY = 'story' # does not have `file_id`, only `id`
 	PAID_MEDIA = 'paid_media' # this contains a `photo` attribute that is a list of `PhotoSize` objects
+	LIVE_PHOTO = 'live_photo'
 	
 class ServiceMessage(enum.StrEnum):
 	'''

{botapi_py-1.5.7 → botapi_py-1.5.9}/src/botapi/methods.py

@@ -37,6 +37,7 @@ from .types import (
 	Animation,
 	Audio,
 	Document,
+	LivePhoto,
 	Story,
 	VideoQuality,
 	Video,
@@ -46,11 +47,19 @@ from .types import (
 	PaidMedia,
 	_PaidMedia,
 	PaidMediaAdapter,
-	PaidMediaPreview,
+	PaidMediaLivePhoto,
 	PaidMediaPhoto,
+	PaidMediaPreview,
 	PaidMediaVideo,
 	Contact,
 	Dice,
+	PollMedia,
+	InputPollMedia,
+	_InputPollMedia,
+	InputPollMediaAdapter,
+	InputPollOptionMedia,
+	_InputPollOptionMedia,
+	InputPollOptionMediaAdapter,
 	PollOption,
 	InputPollOption,
 	PollAnswer,
@@ -66,6 +75,10 @@ from .types import (
 	WebAppData,
 	ProximityAlertTriggered,
 	MessageAutoDeleteTimerChanged,
+	ManagedBotCreated,
+	ManagedBotUpdated,
+	PollOptionAdded,
+	PollOptionDeleted,
 	ChatBoostAdded,
 	BackgroundFill,
 	_BackgroundFill,
@@ -119,6 +132,7 @@ from .types import (
 	KeyboardButton,
 	KeyboardButtonRequestUsers,
 	KeyboardButtonRequestChat,
+	KeyboardButtonRequestManagedBot,
 	KeyboardButtonPollType,
 	ReplyKeyboardRemove,
 	InlineKeyboardMarkup,
@@ -188,6 +202,7 @@ from .types import (
 	OwnedGiftRegular,
 	OwnedGiftUnique,
 	OwnedGifts,
+	BotAccessSettings,
 	AcceptedGiftTypes,
 	StarAmount,
 	BotCommand,
@@ -225,19 +240,28 @@ from .types import (
 	BusinessBotRights,
 	BusinessConnection,
 	BusinessMessagesDeleted,
+	SentWebAppMessage,
+	SentGuestMessage,
+	PreparedInlineMessage,
+	PreparedKeyboardButton,
 	ResponseParameters,
 	InputMedia,
 	_InputMedia,
 	InputMediaAdapter,
-	InputMediaPhoto,
-	InputMediaVideo,
 	InputMediaAnimation,
 	InputMediaAudio,
 	InputMediaDocument,
+	InputMediaLivePhoto,
+	InputMediaLocation,
+	InputMediaPhoto,
+	InputMediaSticker,
+	InputMediaVenue,
+	InputMediaVideo,
 	InputFile,
 	InputPaidMedia,
 	_InputPaidMedia,
 	InputPaidMediaAdapter,
+	InputPaidMediaLivePhoto,
 	InputPaidMediaPhoto,
 	InputPaidMediaVideo,
 	InputProfilePhoto,
@@ -288,8 +312,6 @@ from .types import (
 	InputContactMessageContent,
 	InputInvoiceMessageContent,
 	ChosenInlineResult,
-	SentWebAppMessage,
-	PreparedInlineMessage,
 	LabeledPrice,
 	Invoice,
 	ShippingAddress,
@@ -747,6 +769,56 @@ class Methods(core.BaseBot):
 		})
 		return Message.model_validate(response)
 
+	async def send_live_photo(
+		self,
+		chat_id: Union[int, str],
+		live_photo: Union[InputFile, str],
+		photo: Union[InputFile, str],
+		business_connection_id: Optional[str] = None,
+		message_thread_id: Optional[int] = None,
+		direct_messages_topic_id: Optional[int] = None,
+		caption: Optional[str] = None,
+		parse_mode: Optional[Union[str, enums.ParseMode]] = None,
+		caption_entities: Optional[List[MessageEntity]] = None,
+		show_caption_above_media: Optional[bool] = None,
+		has_spoiler: Optional[bool] = None,
+		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,
+	) -> Message:
+		'''
+        Use this method to send live photos. On
+        success, the sent Message is returned.
+
+        Reference: https://core.telegram.org/bots/api#sendlivephoto
+		'''
+
+		response = await self._send_request('sendLivePhoto', {
+			'business_connection_id': business_connection_id,
+			'chat_id': chat_id,
+			'message_thread_id': message_thread_id,
+			'direct_messages_topic_id': direct_messages_topic_id,
+			'live_photo': live_photo,
+			'photo': photo,
+			'caption': caption,
+			'parse_mode': parse_mode,
+			'caption_entities': caption_entities,
+			'show_caption_above_media': show_caption_above_media,
+			'has_spoiler': has_spoiler,
+			'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,
+		})
+		return Message.model_validate(response)
+
 	async def send_audio(
 		self,
 		chat_id: Union[int, str],
@@ -1134,7 +1206,7 @@ class Methods(core.BaseBot):
 	async def send_media_group(
 		self,
 		chat_id: Union[int, str],
-		media: List[Union[InputMediaAudio, InputMediaDocument, InputMediaPhoto, InputMediaVideo]],
+		media: List[Union[InputMediaAudio, InputMediaDocument, InputMediaLivePhoto, InputMediaPhoto, InputMediaVideo]],
 		business_connection_id: Optional[str] = None,
 		message_thread_id: Optional[int] = None,
 		direct_messages_topic_id: Optional[int] = None,
@@ -1146,11 +1218,11 @@ class Methods(core.BaseBot):
 	) -> List[Message]:
 		'''
         Use this method to send a group of
-        photos, videos, documents or audios as an album.
-        Documents and audio files can be only grouped
-        in an album with messages of the same
-        type. On success, an array of Message objects
-        that were sent is returned.
+        photos, live photos, videos, documents or audios as
+        an album. Documents and audio files can be
+        only grouped in an album with messages of
+        the same type. On success, an array of
+        Message objects that were sent is returned.
 
         Reference: https://core.telegram.org/bots/api#sendmediagroup
 		'''
@@ -1325,13 +1397,24 @@ class Methods(core.BaseBot):
 		is_anonymous: Optional[bool] = None,
 		type: Optional[str] = None,
 		allows_multiple_answers: Optional[bool] = None,
-		correct_option_id: Optional[int] = None,
+		allows_revoting: Optional[bool] = None,
+		shuffle_options: Optional[bool] = None,
+		allow_adding_options: Optional[bool] = None,
+		hide_results_until_closes: Optional[bool] = None,
+		members_only: Optional[bool] = None,
+		country_codes: Optional[List[str]] = None,
+		correct_option_ids: Optional[List[int]] = None,
 		explanation: Optional[str] = None,
 		explanation_parse_mode: Optional[str] = None,
 		explanation_entities: Optional[List[MessageEntity]] = None,
+		explanation_media: Optional[_InputPollMedia] = None,
 		open_period: Optional[int] = None,
 		close_date: Optional[int] = None,
 		is_closed: Optional[bool] = None,
+		description: Optional[str] = None,
+		description_parse_mode: Optional[str] = None,
+		description_entities: Optional[List[MessageEntity]] = None,
+		media: Optional[_InputPollMedia] = None,
 		disable_notification: Optional[bool] = None,
 		protect_content: Optional[bool] = None,
 		allow_paid_broadcast: Optional[bool] = None,
@@ -1357,13 +1440,24 @@ class Methods(core.BaseBot):
 			'is_anonymous': is_anonymous,
 			'type': type,
 			'allows_multiple_answers': allows_multiple_answers,
-			'correct_option_id': correct_option_id,
+			'allows_revoting': allows_revoting,
+			'shuffle_options': shuffle_options,
+			'allow_adding_options': allow_adding_options,
+			'hide_results_until_closes': hide_results_until_closes,
+			'members_only': members_only,
+			'country_codes': country_codes,
+			'correct_option_ids': correct_option_ids,
 			'explanation': explanation,
 			'explanation_parse_mode': explanation_parse_mode,
 			'explanation_entities': explanation_entities,
+			'explanation_media': explanation_media,
 			'open_period': open_period,
 			'close_date': close_date,
 			'is_closed': is_closed,
+			'description': description,
+			'description_parse_mode': description_parse_mode,
+			'description_entities': description_entities,
+			'media': media,
 			'disable_notification': disable_notification,
 			'protect_content': protect_content,
 			'allow_paid_broadcast': allow_paid_broadcast,
@@ -1376,7 +1470,7 @@ class Methods(core.BaseBot):
 	async def send_checklist(
 		self,
 		business_connection_id: str,
-		chat_id: int,
+		chat_id: Union[int, str],
 		checklist: InputChecklist,
 		disable_notification: Optional[bool] = None,
 		protect_content: Optional[bool] = None,
@@ -1447,15 +1541,19 @@ class Methods(core.BaseBot):
 		self,
 		chat_id: int,
 		draft_id: int,
-		text: str,
 		message_thread_id: Optional[int] = None,
+		text: Optional[str] = None,
 		parse_mode: Optional[Union[str, enums.ParseMode]] = None,
 		entities: Optional[List[MessageEntity]] = None,
 	) -> bool:
 		'''
         Use this method to stream a partial message
         to a user while the message is being
-        generated. Returns True on success.
+        generated. Note that the streamed draft is ephemeral
+        and acts as a temporary 30-second preview -
+        once the output is finalized, you must call
+        sendMessage with the complete message to persist it
+        in the user's chat. Returns True on success.
 
         Reference: https://core.telegram.org/bots/api#sendmessagedraft
 		'''
@@ -2257,17 +2355,19 @@ class Methods(core.BaseBot):
 	async def get_chat_administrators(
 		self,
 		chat_id: Union[int, str],
+		return_bots: Optional[bool] = None,
 	) -> List[_ChatMember]:
 		'''
         Use this method to get a list of
-        administrators in a chat, which aren't bots. Returns
-        an Array of ChatMember objects.
+        administrators in a chat. Returns an Array of
+        ChatMember objects.
 
         Reference: https://core.telegram.org/bots/api#getchatadministrators
 		'''
 
 		response = await self._send_request('getChatAdministrators', {
 			'chat_id': chat_id,
+			'return_bots': return_bots,
 		})
 		return [ChatMemberAdapter.validate_python(x) for x in response]
 
@@ -2308,6 +2408,27 @@ class Methods(core.BaseBot):
 		})
 		return ChatMemberAdapter.validate_python(response)
 
+	async def get_user_personal_chat_messages(
+		self,
+		user_id: int,
+		limit: int,
+	) -> List[Message]:
+		'''
+        Use this method to get the last messages
+        from the personal chat (i.e., the chat currently
+        added to their profile) of a given user.
+        On success, an array of Message objects is
+        returned.
+
+        Reference: https://core.telegram.org/bots/api#getuserpersonalchatmessages
+		'''
+
+		response = await self._send_request('getUserPersonalChatMessages', {
+			'user_id': user_id,
+			'limit': limit,
+		})
+		return [Message.model_validate(x) for x in response]
+
 	async def set_chat_sticker_set(
 		self,
 		chat_id: Union[int, str],
@@ -2659,6 +2780,25 @@ class Methods(core.BaseBot):
 		})
 		return BoolAdapter.validate_python(response)
 
+	async def answer_guest_query(
+		self,
+		guest_query_id: str,
+		result: _InlineQueryResult,
+	) -> SentGuestMessage:
+		'''
+        Use this method to reply to a received
+        guest message. On success, a SentGuestMessage object is
+        returned.
+
+        Reference: https://core.telegram.org/bots/api#answerguestquery
+		'''
+
+		response = await self._send_request('answerGuestQuery', {
+			'guest_query_id': guest_query_id,
+			'result': result,
+		})
+		return SentGuestMessage.model_validate(response)
+
 	async def get_user_chat_boosts(
 		self,
 		chat_id: Union[int, str],
@@ -2696,6 +2836,78 @@ class Methods(core.BaseBot):
 		})
 		return BusinessConnection.model_validate(response)
 
+	async def get_managed_bot_token(
+		self,
+		user_id: int,
+	) -> str:
+		'''
+        Use this method to get the token of
+        a managed bot. Returns the token as String
+        on success.
+
+        Reference: https://core.telegram.org/bots/api#getmanagedbottoken
+		'''
+
+		response = await self._send_request('getManagedBotToken', {
+			'user_id': user_id,
+		})
+		return StrAdapter.validate_python(response)
+
+	async def replace_managed_bot_token(
+		self,
+		user_id: int,
+	) -> str:
+		'''
+        Use this method to revoke the current token
+        of a managed bot and generate a new
+        one. Returns the new token as String on
+        success.
+
+        Reference: https://core.telegram.org/bots/api#replacemanagedbottoken
+		'''
+
+		response = await self._send_request('replaceManagedBotToken', {
+			'user_id': user_id,
+		})
+		return StrAdapter.validate_python(response)
+
+	async def get_managed_bot_access_settings(
+		self,
+		user_id: int,
+	) -> BotAccessSettings:
+		'''
+        Use this method to get the access settings
+        of a managed bot. Returns a BotAccessSettings object
+        on success.
+
+        Reference: https://core.telegram.org/bots/api#getmanagedbotaccesssettings
+		'''
+
+		response = await self._send_request('getManagedBotAccessSettings', {
+			'user_id': user_id,
+		})
+		return BotAccessSettings.model_validate(response)
+
+	async def set_managed_bot_access_settings(
+		self,
+		user_id: int,
+		is_access_restricted: bool,
+		added_user_ids: Optional[List[int]] = None,
+	) -> bool:
+		'''
+        Use this method to change the access settings
+        of a managed bot. Returns True on success.
+
+        Reference: https://core.telegram.org/bots/api#setmanagedbotaccesssettings
+		'''
+
+		response = await self._send_request('setManagedBotAccessSettings', {
+			'user_id': user_id,
+			'is_access_restricted': is_access_restricted,
+			'added_user_ids': added_user_ids,
+		})
+		return BoolAdapter.validate_python(response)
+
 	async def set_my_commands(
 		self,
 		commands: List[BotCommand],
@@ -3600,6 +3812,73 @@ class Methods(core.BaseBot):
 		})
 		return BoolAdapter.validate_python(response)
 
+	async def answer_web_app_query(
+		self,
+		web_app_query_id: str,
+		result: _InlineQueryResult,
+	) -> SentWebAppMessage:
+		'''
+        Use this method to set the result of
+        an interaction with a Web App and send
+        a corresponding message on behalf of the user
+        to the chat from which the query originated.
+        On success, a SentWebAppMessage object is returned.
+
+        Reference: https://core.telegram.org/bots/api#answerwebappquery
+		'''
+
+		response = await self._send_request('answerWebAppQuery', {
+			'web_app_query_id': web_app_query_id,
+			'result': result,
+		})
+		return SentWebAppMessage.model_validate(response)
+
+	async def save_prepared_inline_message(
+		self,
+		user_id: int,
+		result: _InlineQueryResult,
+		allow_user_chats: Optional[bool] = None,
+		allow_bot_chats: Optional[bool] = None,
+		allow_group_chats: Optional[bool] = None,
+		allow_channel_chats: Optional[bool] = None,
+	) -> PreparedInlineMessage:
+		'''
+        Stores a message that can be sent by
+        a user of a Mini App. Returns a
+        PreparedInlineMessage object.
+
+        Reference: https://core.telegram.org/bots/api#savepreparedinlinemessage
+		'''
+
+		response = await self._send_request('savePreparedInlineMessage', {
+			'user_id': user_id,
+			'result': result,
+			'allow_user_chats': allow_user_chats,
+			'allow_bot_chats': allow_bot_chats,
+			'allow_group_chats': allow_group_chats,
+			'allow_channel_chats': allow_channel_chats,
+		})
+		return PreparedInlineMessage.model_validate(response)
+
+	async def save_prepared_keyboard_button(
+		self,
+		user_id: int,
+		button: KeyboardButton,
+	) -> PreparedKeyboardButton:
+		'''
+        Stores a keyboard button that can be used
+        by a user within a Mini App. Returns
+        a PreparedKeyboardButton object.
+
+        Reference: https://core.telegram.org/bots/api#savepreparedkeyboardbutton
+		'''
+
+		response = await self._send_request('savePreparedKeyboardButton', {
+			'user_id': user_id,
+			'button': button,
+		})
+		return PreparedKeyboardButton.model_validate(response)
+
 	async def edit_message_text(
 		self,
 		text: str,
@@ -3693,22 +3972,22 @@ class Methods(core.BaseBot):
 	) -> Union[Message, bool]:
 		'''
         Use this method to edit animation, audio, document,
-        photo, or video messages, or to add media
-        to text messages. If a message is part
-        of a message album, then it can be
-        edited only to an audio for audio albums,
-        only to a document for document albums and
-        to a photo or a video otherwise. When
-        an inline message is edited, a new file
-        can't be uploaded; use a previously uploaded file
-        via its file_id or specify a URL. On
-        success, if the edited message is not an
-        inline message, the edited Message is returned, otherwise
-        True is returned. Note that business messages that
-        were not sent by the bot and do
-        not contain an inline keyboard can only be
-        edited within 48 hours from the time they
-        were sent.
+        live photo, photo, or video messages, or to
+        add media to text messages. If a message
+        is part of a message album, then it
+        can be edited only to an audio for
+        audio albums, only to a document for document
+        albums and to a photo, a live photo,
+        or a video otherwise. When an inline message
+        is edited, a new file can't be uploaded;
+        use a previously uploaded file via its file_id
+        or specify a URL. On success, if the
+        edited message is not an inline message, the
+        edited Message is returned, otherwise True is returned.
+        Note that business messages that were not sent
+        by the bot and do not contain an
+        inline keyboard can only be edited within 48
+        hours from the time they were sent.
 
         Reference: https://core.telegram.org/bots/api#editmessagemedia
 		'''
@@ -3801,7 +4080,7 @@ class Methods(core.BaseBot):
 	async def edit_message_checklist(
 		self,
 		business_connection_id: str,
-		chat_id: int,
+		chat_id: Union[int, str],
 		message_id: int,
 		checklist: InputChecklist,
 		reply_markup: Optional[InlineKeyboardMarkup] = None,
@@ -3977,6 +4256,53 @@ class Methods(core.BaseBot):
 		})
 		return BoolAdapter.validate_python(response)
 
+	async def delete_message_reaction(
+		self,
+		chat_id: Union[int, str],
+		message_id: int,
+		user_id: Optional[int] = None,
+		actor_chat_id: Optional[int] = None,
+	) -> bool:
+		'''
+        Use this method to remove a reaction from
+        a message in a group or a supergroup
+        chat. The bot must have the 'can_delete_messages' administrator
+        right in the chat. Returns True on success.
+
+        Reference: https://core.telegram.org/bots/api#deletemessagereaction
+		'''
+
+		response = await self._send_request('deleteMessageReaction', {
+			'chat_id': chat_id,
+			'message_id': message_id,
+			'user_id': user_id,
+			'actor_chat_id': actor_chat_id,
+		})
+		return BoolAdapter.validate_python(response)
+
+	async def delete_all_message_reactions(
+		self,
+		chat_id: Union[int, str],
+		user_id: Optional[int] = None,
+		actor_chat_id: Optional[int] = None,
+	) -> bool:
+		'''
+        Use this method to remove up to 10000
+        recent reactions in a group or a supergroup
+        chat added by a given user or chat.
+        The bot must have the 'can_delete_messages' administrator right
+        in the chat. Returns True on success.
+
+        Reference: https://core.telegram.org/bots/api#deleteallmessagereactions
+		'''
+
+		response = await self._send_request('deleteAllMessageReactions', {
+			'chat_id': chat_id,
+			'user_id': user_id,
+			'actor_chat_id': actor_chat_id,
+		})
+		return BoolAdapter.validate_python(response)
+
 	async def send_sticker(
 		self,
 		chat_id: Union[int, str],
@@ -4352,54 +4678,6 @@ class Methods(core.BaseBot):
 		})
 		return BoolAdapter.validate_python(response)
 
-	async def answer_web_app_query(
-		self,
-		web_app_query_id: str,
-		result: _InlineQueryResult,
-	) -> SentWebAppMessage:
-		'''
-        Use this method to set the result of
-        an interaction with a Web App and send
-        a corresponding message on behalf of the user
-        to the chat from which the query originated.
-        On success, a SentWebAppMessage object is returned.
-
-        Reference: https://core.telegram.org/bots/api#answerwebappquery
-		'''
-
-		response = await self._send_request('answerWebAppQuery', {
-			'web_app_query_id': web_app_query_id,
-			'result': result,
-		})
-		return SentWebAppMessage.model_validate(response)
-
-	async def save_prepared_inline_message(
-		self,
-		user_id: int,
-		result: _InlineQueryResult,
-		allow_user_chats: Optional[bool] = None,
-		allow_bot_chats: Optional[bool] = None,
-		allow_group_chats: Optional[bool] = None,
-		allow_channel_chats: Optional[bool] = None,
-	) -> PreparedInlineMessage:
-		'''
-        Stores a message that can be sent by
-        a user of a Mini App. Returns a
-        PreparedInlineMessage object.
-
-        Reference: https://core.telegram.org/bots/api#savepreparedinlinemessage
-		'''
-
-		response = await self._send_request('savePreparedInlineMessage', {
-			'user_id': user_id,
-			'result': result,
-			'allow_user_chats': allow_user_chats,
-			'allow_bot_chats': allow_bot_chats,
-			'allow_group_chats': allow_group_chats,
-			'allow_channel_chats': allow_channel_chats,
-		})
-		return PreparedInlineMessage.model_validate(response)
-
 	async def send_invoice(
 		self,
 		chat_id: Union[int, str],
@@ -4682,7 +4960,7 @@ class Methods(core.BaseBot):
 
 	async def send_game(
 		self,
-		chat_id: int,
+		chat_id: Union[int, str],
 		game_short_name: str,
 		business_connection_id: Optional[str] = None,
 		message_thread_id: Optional[int] = None,