v1 milestone

venv/lib/python3.12/site-packages/aiogram/methods/send_voice.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, List, Optional, Union
+
+from pydantic import Field
+
+from ..client.default import Default
+from ..types import (
+    UNSET_PARSE_MODE,
+    ForceReply,
+    InlineKeyboardMarkup,
+    InputFile,
+    Message,
+    MessageEntity,
+    ReplyKeyboardMarkup,
+    ReplyKeyboardRemove,
+    ReplyParameters,
+)
+from .base import TelegramMethod
+
+
+class SendVoice(TelegramMethod[Message]):
+    """
+    Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
+
+    Source: https://core.telegram.org/bots/api#sendvoice
+    """
+
+    __returning__ = Message
+    __api_method__ = "sendVoice"
+
+    chat_id: Union[int, str]
+    """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
+    voice: Union[InputFile, str]
+    """Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » <sending-files>`"""
+    message_thread_id: Optional[int] = None
+    """Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"""
+    caption: Optional[str] = None
+    """Voice message caption, 0-1024 characters after entities parsing"""
+    parse_mode: Optional[Union[str, Default]] = Default("parse_mode")
+    """Mode for parsing entities in the voice message caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details."""
+    caption_entities: Optional[List[MessageEntity]] = None
+    """A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*"""
+    duration: Optional[int] = None
+    """Duration of the voice message in seconds"""
+    disable_notification: Optional[bool] = None
+    """Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound."""
+    protect_content: Optional[Union[bool, Default]] = Default("protect_content")
+    """Protects the contents of the sent message from forwarding and saving"""
+    reply_parameters: Optional[ReplyParameters] = None
+    """Description of the message to reply to"""
+    reply_markup: Optional[
+        Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
+    ] = None
+    """Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user."""
+    allow_sending_without_reply: Optional[bool] = Field(
+        None, json_schema_extra={"deprecated": True}
+    )
+    """Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
+
+.. deprecated:: API:7.0
+   https://core.telegram.org/bots/api-changelog#december-29-2023"""
+    reply_to_message_id: Optional[int] = Field(None, json_schema_extra={"deprecated": True})
+    """If the message is a reply, ID of the original message
+
+.. deprecated:: API:7.0
+   https://core.telegram.org/bots/api-changelog#december-29-2023"""
+
+    if TYPE_CHECKING:
+        # DO NOT EDIT MANUALLY!!!
+        # This section was auto-generated via `butcher`
+
+        def __init__(
+            __pydantic__self__,
+            *,
+            chat_id: Union[int, str],
+            voice: Union[InputFile, str],
+            message_thread_id: Optional[int] = None,
+            caption: Optional[str] = None,
+            parse_mode: Optional[Union[str, Default]] = Default("parse_mode"),
+            caption_entities: Optional[List[MessageEntity]] = None,
+            duration: Optional[int] = None,
+            disable_notification: Optional[bool] = None,
+            protect_content: Optional[Union[bool, Default]] = Default("protect_content"),
+            reply_parameters: Optional[ReplyParameters] = None,
+            reply_markup: Optional[
+                Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
+            ] = None,
+            allow_sending_without_reply: Optional[bool] = None,
+            reply_to_message_id: 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__(
+                chat_id=chat_id,
+                voice=voice,
+                message_thread_id=message_thread_id,
+                caption=caption,
+                parse_mode=parse_mode,
+                caption_entities=caption_entities,
+                duration=duration,
+                disable_notification=disable_notification,
+                protect_content=protect_content,
+                reply_parameters=reply_parameters,
+                reply_markup=reply_markup,
+                allow_sending_without_reply=allow_sending_without_reply,
+                reply_to_message_id=reply_to_message_id,
+                **__pydantic_kwargs,
+            )