botapi-py 1.5.6__tar.gz → 1.5.8__tar.gz

{botapi_py-1.5.6 → botapi_py-1.5.8}/PKG-INFO

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

@@ -1,6 +1,6 @@
 [project]
 name = "botapi-py"
-version = "1.5.6"
+version = "1.5.8"
 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.6 → botapi_py-1.5.8}/src/botapi/methods.py

@@ -66,6 +66,10 @@ from .types import (
 	WebAppData,
 	ProximityAlertTriggered,
 	MessageAutoDeleteTimerChanged,
+	ManagedBotCreated,
+	ManagedBotUpdated,
+	PollOptionAdded,
+	PollOptionDeleted,
 	ChatBoostAdded,
 	BackgroundFill,
 	_BackgroundFill,
@@ -119,6 +123,7 @@ from .types import (
 	KeyboardButton,
 	KeyboardButtonRequestUsers,
 	KeyboardButtonRequestChat,
+	KeyboardButtonRequestManagedBot,
 	KeyboardButtonPollType,
 	ReplyKeyboardRemove,
 	InlineKeyboardMarkup,
@@ -225,6 +230,9 @@ from .types import (
 	BusinessBotRights,
 	BusinessConnection,
 	BusinessMessagesDeleted,
+	SentWebAppMessage,
+	PreparedInlineMessage,
+	PreparedKeyboardButton,
 	ResponseParameters,
 	InputMedia,
 	_InputMedia,
@@ -288,8 +296,6 @@ from .types import (
 	InputContactMessageContent,
 	InputInvoiceMessageContent,
 	ChosenInlineResult,
-	SentWebAppMessage,
-	PreparedInlineMessage,
 	LabeledPrice,
 	Invoice,
 	ShippingAddress,
@@ -1325,13 +1331,20 @@ 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,
+		correct_option_ids: Optional[List[int]] = None,
 		explanation: Optional[str] = None,
 		explanation_parse_mode: Optional[str] = None,
 		explanation_entities: Optional[List[MessageEntity]] = 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,
 		disable_notification: Optional[bool] = None,
 		protect_content: Optional[bool] = None,
 		allow_paid_broadcast: Optional[bool] = None,
@@ -1357,13 +1370,20 @@ 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,
+			'correct_option_ids': correct_option_ids,
 			'explanation': explanation,
 			'explanation_parse_mode': explanation_parse_mode,
 			'explanation_entities': explanation_entities,
 			'open_period': open_period,
 			'close_date': close_date,
 			'is_closed': is_closed,
+			'description': description,
+			'description_parse_mode': description_parse_mode,
+			'description_entities': description_entities,
 			'disable_notification': disable_notification,
 			'protect_content': protect_content,
 			'allow_paid_broadcast': allow_paid_broadcast,
@@ -1455,8 +1475,7 @@ class Methods(core.BaseBot):
 		'''
         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.
+        generated. Returns True on success.
 
         Reference: https://core.telegram.org/bots/api#sendmessagedraft
 		'''
@@ -1720,6 +1739,7 @@ class Methods(core.BaseBot):
 		can_pin_messages: Optional[bool] = None,
 		can_manage_topics: Optional[bool] = None,
 		can_manage_direct_messages: Optional[bool] = None,
+		can_manage_tags: Optional[bool] = None,
 	) -> bool:
 		'''
         Use this method to promote or demote a
@@ -1752,6 +1772,7 @@ class Methods(core.BaseBot):
 			'can_pin_messages': can_pin_messages,
 			'can_manage_topics': can_manage_topics,
 			'can_manage_direct_messages': can_manage_direct_messages,
+			'can_manage_tags': can_manage_tags,
 		})
 		return BoolAdapter.validate_python(response)
 
@@ -1776,6 +1797,30 @@ class Methods(core.BaseBot):
 		})
 		return BoolAdapter.validate_python(response)
 
+	async def set_chat_member_tag(
+		self,
+		chat_id: Union[int, str],
+		user_id: int,
+		tag: Optional[str] = None,
+	) -> bool:
+		'''
+        Use this method to set a tag for
+        a regular member in a group or a
+        supergroup. The bot must be an administrator in
+        the chat for this to work and must
+        have the can_manage_tags administrator right. Returns True on
+        success.
+
+        Reference: https://core.telegram.org/bots/api#setchatmembertag
+		'''
+
+		response = await self._send_request('setChatMemberTag', {
+			'chat_id': chat_id,
+			'user_id': user_id,
+			'tag': tag,
+		})
+		return BoolAdapter.validate_python(response)
+
 	async def ban_chat_sender_chat(
 		self,
 		chat_id: Union[int, str],
@@ -2671,6 +2716,41 @@ 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 set_my_commands(
 		self,
 		commands: List[BotCommand],
@@ -3575,6 +3655,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,
@@ -4327,54 +4474,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],

{botapi_py-1.5.6 → botapi_py-1.5.8}/src/botapi/types.py

@@ -36,6 +36,7 @@ class Message(MaybeInaccessibleMessage):
 	sender_chat: Optional[Chat] = Field(default=None)
 	sender_boost_count: Optional[int] = Field(default=None)
 	sender_business_bot: Optional[User] = Field(default=None)
+	sender_tag: Optional[str] = Field(default=None)
 	business_connection_id: Optional[str] = Field(default=None)
 	forward_origin: Optional[_MessageOrigin] = Field(default=None)
 	is_topic_message: Optional[bool] = Field(default=None)
@@ -45,6 +46,7 @@ class Message(MaybeInaccessibleMessage):
 	quote: Optional[TextQuote] = Field(default=None)
 	reply_to_story: Optional[Story] = Field(default=None)
 	reply_to_checklist_task_id: Optional[int] = Field(default=None)
+	reply_to_poll_option_id: Optional[str] = Field(default=None)
 	via_bot: Optional[User] = Field(default=None)
 	edit_date: Optional[int] = Field(default=None)
 	has_protected_content: Optional[bool] = Field(default=None)
@@ -120,7 +122,10 @@ class Message(MaybeInaccessibleMessage):
 	giveaway: Optional[Giveaway] = Field(default=None)
 	giveaway_winners: Optional[GiveawayWinners] = Field(default=None)
 	giveaway_completed: Optional[GiveawayCompleted] = Field(default=None)
+	managed_bot_created: Optional[ManagedBotCreated] = Field(default=None)
 	paid_message_price_changed: Optional[PaidMessagePriceChanged] = Field(default=None)
+	poll_option_added: Optional[PollOptionAdded] = Field(default=None)
+	poll_option_deleted: Optional[PollOptionDeleted] = Field(default=None)
 	suggested_post_approved: Optional[SuggestedPostApproved] = Field(default=None)
 	suggested_post_approval_failed: Optional[SuggestedPostApprovalFailed] = Field(default=None)
 	suggested_post_declined: Optional[SuggestedPostDeclined] = Field(default=None)
@@ -769,6 +774,7 @@ class ChatMemberAdministrator(ChatMember):
 	can_pin_messages: Optional[bool] = Field(default=None)
 	can_manage_topics: Optional[bool] = Field(default=None)
 	can_manage_direct_messages: Optional[bool] = Field(default=None)
+	can_manage_tags: Optional[bool] = Field(default=None)
 	custom_title: Optional[str] = Field(default=None) 
 
 class ChatMemberMember(ChatMember):
@@ -781,6 +787,7 @@ class ChatMemberMember(ChatMember):
 
 	status: Literal['member'] = 'member' # pyright: ignore[reportIncompatibleVariableOverride]
 	user: User
+	tag: Optional[str] = Field(default=None)
 	until_date: Optional[int] = Field(default=None) 
 
 class ChatMemberRestricted(ChatMember):
@@ -804,11 +811,13 @@ class ChatMemberRestricted(ChatMember):
 	can_send_polls: bool
 	can_send_other_messages: bool
 	can_add_web_page_previews: bool
+	can_edit_tag: bool
 	can_change_info: bool
 	can_invite_users: bool
 	can_pin_messages: bool
 	can_manage_topics: bool
-	until_date: int 
+	until_date: int
+	tag: Optional[str] = Field(default=None) 
 
 class ChatMemberLeft(ChatMember):
 	'''
@@ -2323,6 +2332,7 @@ class Update(BaseModel):
 	chat_join_request: Optional[ChatJoinRequest] = Field(default=None)
 	chat_boost: Optional[ChatBoostUpdated] = Field(default=None)
 	removed_chat_boost: Optional[ChatBoostRemoved] = Field(default=None)
+	managed_bot: Optional[ManagedBotUpdated] = Field(default=None)
 	
 	@staticmethod
 	def from_dict(
@@ -2372,7 +2382,8 @@ class User(BaseModel):
 	can_connect_to_business: Optional[bool] = Field(default=None)
 	has_main_web_app: Optional[bool] = Field(default=None)
 	has_topics_enabled: Optional[bool] = Field(default=None)
-	allows_users_to_create_topics: Optional[bool] = Field(default=None) 
+	allows_users_to_create_topics: Optional[bool] = Field(default=None)
+	can_manage_bots: Optional[bool] = Field(default=None) 
 
 class Chat(BaseModel):
 	'''
@@ -2473,6 +2484,8 @@ class MessageEntity(BaseModel):
 	user: Optional[User] = Field(default=None)
 	language: Optional[str] = Field(default=None)
 	custom_emoji_id: Optional[str] = Field(default=None)
+	unix_time: Optional[int] = Field(default=None)
+	date_time_format: Optional[str] = Field(default=None)
 	
 	@staticmethod
 	def from_dict(
@@ -2557,7 +2570,8 @@ class ReplyParameters(BaseModel):
 	quote_parse_mode: Optional[str] = Field(default=None)
 	quote_entities: Optional[List[MessageEntity]] = Field(default=None)
 	quote_position: Optional[int] = Field(default=None)
-	checklist_task_id: Optional[int] = Field(default=None) 
+	checklist_task_id: Optional[int] = Field(default=None)
+	poll_option_id: Optional[str] = Field(default=None) 
 
 class PhotoSize(BaseModel):
 	'''
@@ -2739,9 +2753,13 @@ class PollOption(BaseModel):
     Reference: https://core.telegram.org/bots/api#polloption
 	'''
 
+	persistent_id: str
 	text: str
 	voter_count: int
-	text_entities: Optional[List[MessageEntity]] = Field(default=None) 
+	text_entities: Optional[List[MessageEntity]] = Field(default=None)
+	added_by_user: Optional[User] = Field(default=None)
+	added_by_chat: Optional[Chat] = Field(default=None)
+	addition_date: Optional[int] = Field(default=None) 
 
 class InputPollOption(BaseModel):
 	'''
@@ -2765,6 +2783,7 @@ class PollAnswer(BaseModel):
 
 	poll_id: str
 	option_ids: List[int]
+	option_persistent_ids: List[str]
 	voter_chat: Optional[Chat] = Field(default=None)
 	user: Optional[User] = Field(default=None) 
 
@@ -2783,12 +2802,15 @@ class Poll(BaseModel):
 	is_anonymous: bool
 	type: str
 	allows_multiple_answers: bool
+	allows_revoting: bool
 	question_entities: Optional[List[MessageEntity]] = Field(default=None)
-	correct_option_id: Optional[int] = Field(default=None)
+	correct_option_ids: Optional[List[int]] = Field(default=None)
 	explanation: Optional[str] = Field(default=None)
 	explanation_entities: Optional[List[MessageEntity]] = Field(default=None)
 	open_period: Optional[int] = Field(default=None)
-	close_date: Optional[int] = Field(default=None) 
+	close_date: Optional[int] = Field(default=None)
+	description: Optional[str] = Field(default=None)
+	description_entities: Optional[List[MessageEntity]] = Field(default=None) 
 
 class ChecklistTask(BaseModel):
 	'''
@@ -2929,6 +2951,55 @@ class MessageAutoDeleteTimerChanged(BaseModel):
 
 	message_auto_delete_time: int 
 
+class ManagedBotCreated(BaseModel):
+	'''
+    This object contains information about the bot that
+    was created to be managed by the current
+    bot.
+
+    Reference: https://core.telegram.org/bots/api#managedbotcreated
+	'''
+
+	bot: User 
+
+class ManagedBotUpdated(BaseModel):
+	'''
+    This object contains information about the creation, token
+    update, or owner update of a bot that
+    is managed by the current bot.
+
+    Reference: https://core.telegram.org/bots/api#managedbotupdated
+	'''
+
+	user: User
+	bot: User 
+
+class PollOptionAdded(BaseModel):
+	'''
+    Describes a service message about an option added
+    to a poll.
+
+    Reference: https://core.telegram.org/bots/api#polloptionadded
+	'''
+
+	option_persistent_id: str
+	option_text: str
+	poll_message: Optional[_MaybeInaccessibleMessage] = Field(default=None)
+	option_text_entities: Optional[List[MessageEntity]] = Field(default=None) 
+
+class PollOptionDeleted(BaseModel):
+	'''
+    Describes a service message about an option deleted
+    from a poll.
+
+    Reference: https://core.telegram.org/bots/api#polloptiondeleted
+	'''
+
+	option_persistent_id: str
+	option_text: str
+	poll_message: Optional[_MaybeInaccessibleMessage] = Field(default=None)
+	option_text_entities: Optional[List[MessageEntity]] = Field(default=None) 
+
 class ChatBoostAdded(BaseModel):
 	'''
     This object represents a service message about a
@@ -3443,6 +3514,7 @@ class KeyboardButton(BaseModel):
 	style: Optional[str] = Field(default=None)
 	request_users: Optional[KeyboardButtonRequestUsers] = Field(default=None)
 	request_chat: Optional[KeyboardButtonRequestChat] = Field(default=None)
+	request_managed_bot: Optional[KeyboardButtonRequestManagedBot] = Field(default=None)
 	request_contact: Optional[bool] = Field(default=None)
 	request_location: Optional[bool] = Field(default=None)
 	request_poll: Optional[KeyboardButtonPollType] = Field(default=None)
@@ -3490,6 +3562,21 @@ class KeyboardButtonRequestChat(BaseModel):
 	request_username: Optional[bool] = Field(default=None)
 	request_photo: Optional[bool] = Field(default=None) 
 
+class KeyboardButtonRequestManagedBot(BaseModel):
+	'''
+    This object defines the parameters for the creation
+    of a managed bot. Information about the created
+    bot will be shared with the bot using
+    the update managed_bot and a Message with the
+    field managed_bot_created.
+
+    Reference: https://core.telegram.org/bots/api#keyboardbuttonrequestmanagedbot
+	'''
+
+	request_id: int
+	suggested_name: Optional[str] = Field(default=None)
+	suggested_username: Optional[str] = Field(default=None) 
+
 class KeyboardButtonPollType(BaseModel):
 	'''
     This object represents type of a poll, which
@@ -3706,7 +3793,8 @@ class ChatAdministratorRights(BaseModel):
 	can_edit_messages: Optional[bool] = Field(default=None)
 	can_pin_messages: Optional[bool] = Field(default=None)
 	can_manage_topics: Optional[bool] = Field(default=None)
-	can_manage_direct_messages: Optional[bool] = Field(default=None) 
+	can_manage_direct_messages: Optional[bool] = Field(default=None)
+	can_manage_tags: Optional[bool] = Field(default=None) 
 
 class ChatMemberUpdated(BaseModel):
 	'''
@@ -3782,6 +3870,7 @@ class ChatPermissions(BaseModel):
 	can_send_polls: Optional[bool] = Field(default=None)
 	can_send_other_messages: Optional[bool] = Field(default=None)
 	can_add_web_page_previews: Optional[bool] = Field(default=None)
+	can_edit_tag: Optional[bool] = Field(default=None)
 	can_change_info: Optional[bool] = Field(default=None)
 	can_invite_users: Optional[bool] = Field(default=None)
 	can_pin_messages: Optional[bool] = Field(default=None)
@@ -4309,6 +4398,37 @@ class BusinessMessagesDeleted(BaseModel):
 	chat: Chat
 	message_ids: List[int] 
 
+class SentWebAppMessage(BaseModel):
+	'''
+    Describes an inline message sent by a Web
+    App on behalf of a user.
+
+    Reference: https://core.telegram.org/bots/api#sentwebappmessage
+	'''
+
+	inline_message_id: Optional[str] = Field(default=None) 
+
+class PreparedInlineMessage(BaseModel):
+	'''
+    Describes an inline message to be sent by
+    a user of a Mini App.
+
+    Reference: https://core.telegram.org/bots/api#preparedinlinemessage
+	'''
+
+	id: str
+	expiration_date: int 
+
+class PreparedKeyboardButton(BaseModel):
+	'''
+    Describes a keyboard button to be used by
+    a user of a Mini App.
+
+    Reference: https://core.telegram.org/bots/api#preparedkeyboardbutton
+	'''
+
+	id: str 
+
 class ResponseParameters(BaseModel):
 	'''
     Describes why a request was unsuccessful.
@@ -4464,27 +4584,6 @@ class ChosenInlineResult(BaseModel):
 	location: Optional[Location] = Field(default=None)
 	inline_message_id: Optional[str] = Field(default=None) 
 
-class SentWebAppMessage(BaseModel):
-	'''
-    Describes an inline message sent by a Web
-    App on behalf of a user.
-
-    Reference: https://core.telegram.org/bots/api#sentwebappmessage
-	'''
-
-	inline_message_id: Optional[str] = Field(default=None) 
-
-class PreparedInlineMessage(BaseModel):
-	'''
-    Describes an inline message to be sent by
-    a user of a Mini App.
-
-    Reference: https://core.telegram.org/bots/api#preparedinlinemessage
-	'''
-
-	id: str
-	expiration_date: int 
-
 class LabeledPrice(BaseModel):
 	'''
     This object represents a portion of the price