python-trueconf-bot 1.0.0__py3-none-any.whl

trueconf/methods/send_survey.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.methods.base import TrueConfMethod
+from trueconf.types.responses.send_survey_response import SendSurveyResponse
+
+
+@dataclass
+class SendSurvey(TrueConfMethod[SendSurveyResponse]):
+    __api_method__ = "sendSurvey"
+    __returning__ = SendSurveyResponse
+
+    chat_id: str
+    server: str
+    path: str
+    title: str
+    secret: str
+    description: str
+    button_text: str = "{{Go to survey}}"
+    reply_message_id: str | None = None
+    app_version: int = 1
+
+    def __post_init__(self):
+        super().__init__()
+
+    def payload(self):
+        return {
+            "chatId": self.chat_id,
+            "replyMessageId": self.reply_message_id,
+            "content": {
+                "url": f"https://{self.server}/webtools/survey",
+                "appVersion": self.app_version,
+                "path": self.path,
+                "title": self.title,
+                "description": self.description,
+                "buttonText": self.button_text,
+                "secret": self.secret,
+                "alt": f"📊 <a href='https://{self.server}/webtools/survey?id={self.path}&error=autologin_not_supported'>{self.title}</a>"
+            }
+        }

trueconf/methods/subscribe_file_progress.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.methods.base import TrueConfMethod
+from trueconf.types.responses.subscribe_file_progress_response import SubscribeFileProgressResponse
+
+
+@dataclass
+class SubscribeFileProgress(TrueConfMethod[SubscribeFileProgressResponse]):
+    __api_method__ = "subscribeFileProgress"
+    __returning__ = SubscribeFileProgressResponse
+
+    file_id: str
+
+    def __post_init__(self):
+        super().__init__()
+
+    def payload(self):
+        return {
+            "fileId": self.file_id
+        }

trueconf/methods/unsubscribe_file_progress.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.methods.base import TrueConfMethod
+from trueconf.types.responses.unsubscribe_file_progress_response import UnsubscribeFileProgressResponse
+
+
+@dataclass
+class UnsubscribeFileProgress(TrueConfMethod[UnsubscribeFileProgressResponse]):
+    __api_method__ = "unsubscribeFileProgress"
+    __returning__ = UnsubscribeFileProgressResponse
+
+    file_id: str
+
+    def __post_init__(self):
+        super().__init__()
+
+    def payload(self):
+        return {
+            "fileId": self.file_id
+        }

trueconf/methods/upload_file.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.methods.base import TrueConfMethod
+from trueconf.types.responses.upload_file_response import UploadFileResponse
+
+
+@dataclass
+class UploadFile(TrueConfMethod[UploadFileResponse]):
+    __api_method__ = "uploadFile"
+    __returning__ = UploadFileResponse
+
+    file_size: int
+
+    def __post_init__(self):
+        super().__init__()
+
+    def payload(self):
+        return {
+            "fileSize": self.file_size,
+        }

trueconf/types/__init__.py

@@ -0,0 +1,25 @@
+from .message import Message
+from .requests.added_chat_participant import AddedChatParticipant
+from .requests.created_channel import CreatedChannel
+from .requests.created_group_chat import CreatedGroupChat
+from .requests.created_personal_chat import CreatedPersonalChat
+from .requests.edited_message import EditedMessage
+from .requests.removed_chat import RemovedChat
+from .requests.removed_chat_participant import RemovedChatParticipant
+from .requests.removed_message import RemovedMessage
+from .requests.uploading_progress import UploadingProgress
+from .update import Update
+
+__all__ = [
+    "AddedChatParticipant",
+    "CreatedChannel",
+    "CreatedGroupChat",
+    "CreatedPersonalChat",
+    "EditedMessage",
+    "Message",
+    "RemovedChat",
+    "RemovedChatParticipant",
+    "RemovedMessage",
+    "Update",
+    "UploadingProgress",
+]

trueconf/types/author_box.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+
+from trueconf.enums.envelope_author_type import EnvelopeAuthorType
+
+
+@dataclass
+class EnvelopeAuthor(DataClassDictMixin):
+    id: str
+    type: EnvelopeAuthorType
+
+
+@dataclass
+class EnvelopeBox(DataClassDictMixin):
+    id: int
+    position: str

trueconf/types/chat_participant.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+from trueconf.enums.chat_participant_role import ChatParticipantRole
+
+
+@dataclass
+class ChatParticipant(DataClassDictMixin):
+    user_id: str = field(metadata={"alias": "id"})
+    role: ChatParticipantRole

trueconf/types/content/__init__.py

@@ -0,0 +1,25 @@
+from .survey import SurveyContent
+from .chat_created import ParticipantRoleContent
+from .forward_message import ForwardMessage
+from .attachment import AttachmentContent
+from .remove_participant import RemoveParticipant
+from .text import TextContent
+from .base import AbstractEnvelopeContent
+from .photo import Photo
+from .video import Video
+from .sticker import Sticker
+from .document import Document
+
+__all__ = [
+    'SurveyContent',
+    'ParticipantRoleContent',
+    'ForwardMessage',
+    'AttachmentContent',
+    'RemoveParticipant',
+    'TextContent',
+    'AbstractEnvelopeContent',
+    'Photo',
+    'Video',
+    'Sticker',
+    'Document',
+]

trueconf/types/content/attachment.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import Optional
+from trueconf.client.context_controller import BoundToBot
+from trueconf.types.content.base import AbstractEnvelopeContent
+
+
+@dataclass
+class AttachmentContent(BoundToBot, AbstractEnvelopeContent):
+    file_name: str = field(metadata={"alias": "name"})
+    file_size: int = field(metadata={"alias": "size"})
+    file_id: str = field(default="", metadata={"alias": "fileId"})
+    mimetype: str = field(default="", metadata={"alias": "mimeType"})
+    ready_state: Optional[int] = field(default=None, metadata={"alias": "readyState"})

trueconf/types/content/base.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from abc import ABC
+from mashumaro import DataClassDictMixin
+
+
+class AbstractEnvelopeContent(DataClassDictMixin, ABC):
+    """Маркерный базовый класс."""
+    pass

trueconf/types/content/chat_created.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from trueconf.types.content.base import AbstractEnvelopeContent
+
+
+@dataclass
+class ParticipantRoleContent(AbstractEnvelopeContent):
+    user_id: str = field(metadata={"alias": "userId"})
+    role: str

trueconf/types/content/document.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.client.context_controller import BoundToBot
+from pathlib import Path
+
+
+@dataclass
+class Document(BoundToBot):
+    """
+    Represents a file attached to a message.
+
+    This class provides access to file metadata and utility methods such as downloading and preview access.
+
+    Attributes:
+        file_id (str): Unique identifier of the file.
+        file_name (str): Name of the file as stored on the server.
+        file_size (int): Size of the file in bytes.
+        mimetype (str): MIME type of the file.
+    """
+
+    file_id: str
+    file_name: str
+    file_size: int
+    mimetype: str
+
+    @property
+    async def url(self) -> str:
+        """
+        Returns the direct download URL of the file.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the original video file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.download_url
+
+    @property
+    async def preview_url(self) -> str:
+        """
+        Returns the preview URL of the file, if available.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the preview version of the video file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.preview.download_url
+
+    async def download(self, dest_path: str) -> Path | None:
+        """
+        Shortcut for the `download_file_by_id` method of the bot instance.
+
+        Automatically fills the following attributes:
+            - `file_id`
+
+        Use this method to download the current file by its ID.
+
+        Args:
+            dest_path (str): Destination path to save the file.
+                If not specified, a temporary file will be created using
+                `NamedTemporaryFile(prefix="tc_dl_", suffix=file_name, delete=False)`.
+
+        Returns:
+            Path | None: Path to the downloaded file, or None if the download failed.
+        """
+        return await self.bot.download_file_by_id(file_id=self.file_id, dest_path=dest_path)

trueconf/types/content/forward_message.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import Optional, Union
+from trueconf.enums.message_type import MessageType
+from trueconf.types.content.base import AbstractEnvelopeContent
+from trueconf.types.author_box import EnvelopeAuthor, EnvelopeBox
+from trueconf.types.content.attachment import AttachmentContent
+from trueconf.types.content.survey import SurveyContent
+from trueconf.types.content.text import TextContent
+
+
+@dataclass
+class ForwardMessage(AbstractEnvelopeContent):
+    timestamp: int
+    type: MessageType
+    author: EnvelopeAuthor
+    content: Union[TextContent, AttachmentContent, SurveyContent]
+    message_id: str = field(metadata={"alias": "messageId"})
+    chat_id: str = field(metadata={"alias": "chatId"})
+    is_edited: Optional[bool] = field(metadata={"alias": "isEdited"})
+    box: Optional[EnvelopeBox]

trueconf/types/content/photo.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.client.context_controller import BoundToBot
+from pathlib import Path
+
+@dataclass
+class Photo(BoundToBot):
+    """
+    Represents an image file attached to a message.
+
+    This class provides access to file metadata and utility methods such as downloading and preview access.
+
+    Attributes:
+        file_id (str): Unique identifier of the image file.
+        file_name (str): Name of the file as stored on the server.
+        file_size (int): Size of the file in bytes.
+        mimetype (str): MIME type of the image.
+    """
+
+    file_id: str
+    file_name: str
+    file_size: int
+    mimetype: str
+
+    @property
+    async def url(self) -> str:
+        """
+        Returns the direct download URL of the image file.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the original image file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.download_url
+
+    @property
+    async def preview_url(self) -> str:
+        """
+        Returns the preview URL of the image file, if available.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the preview version of the image file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.preview.download_url
+
+    async def download(self, dest_path: str) -> Path | None:
+        """
+        Shortcut for the `download_file_by_id` method of the bot instance.
+
+        Automatically fills the following attributes:
+            - `file_id`
+
+        Use this method to download the current file by its ID.
+
+        Args:
+            dest_path (str): Destination path to save the file.
+                If not specified, a temporary file will be created using
+                `NamedTemporaryFile(prefix="tc_dl_", suffix=file_name, delete=False)`.
+
+        Returns:
+            Path | None: Path to the downloaded file, or None if the download failed.
+        """
+        return await self.bot.download_file_by_id(file_id=self.file_id, dest_path=dest_path)

trueconf/types/content/remove_participant.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+
+from trueconf.types.content.base import AbstractEnvelopeContent
+
+
+@dataclass
+class RemoveParticipant(AbstractEnvelopeContent):
+    user_id: str = field(metadata={"alias": "userId"})

trueconf/types/content/sticker.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.client.context_controller import BoundToBot
+from pathlib import Path
+
+@dataclass
+class Sticker(BoundToBot):
+    """
+    Represents a sticker file attached to a message.
+
+    This class provides access to file metadata and utility methods such as downloading and preview access.
+
+    Attributes:
+        file_id (str): Unique identifier of the sticker file.
+        file_name (str): Name of the file as stored on the server.
+        file_size (int): Size of the file in bytes.
+        mimetype (str): MIME type of the sticker.
+    """
+
+    file_id: str
+    file_name: str
+    file_size: int
+    mimetype: str
+
+    @property
+    async def url(self) -> str:
+        """
+        Returns the direct download URL of the sticker file.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the original sticker file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.download_url
+
+    @property
+    async def preview_url(self) -> str:
+        """
+        Returns the preview URL of the sticker file, if available.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the preview version of the sticker file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.preview.download_url
+
+    async def download(self, dest_path: str) -> Path | None:
+        """
+        Shortcut for the `download_file_by_id` method of the bot instance.
+
+        Automatically fills the following attributes:
+            - `file_id`
+
+        Use this method to download the current file by its ID.
+
+        Args:
+            dest_path (str): Destination path to save the file.
+                If not specified, a temporary file will be created using
+                `NamedTemporaryFile(prefix="tc_dl_", suffix=file_name, delete=False)`.
+
+        Returns:
+            Path | None: Path to the downloaded file, or None if the download failed.
+        """
+        return await self.bot.download_file_by_id(file_id=self.file_id, dest_path=dest_path)

trueconf/types/content/survey.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import Optional
+from mashumaro import DataClassDictMixin
+from trueconf.types.content.base import AbstractEnvelopeContent
+
+
+@dataclass
+class SurveyContent(AbstractEnvelopeContent, DataClassDictMixin):
+    url: str
+    title: str
+    path: Optional[str] = None
+    description: Optional[str] = None
+    button_text: Optional[str] = field(default=None, metadata={"alias": "buttonText"})
+    app_version: Optional[int] = field(
+        default=None, metadata={"alias": "appVersion"}
+    )
+    secret: Optional[str] = None
+    alt: Optional[str] = None

trueconf/types/content/text.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from trueconf.types.content.base import AbstractEnvelopeContent
+
+
+@dataclass
+class TextContent(AbstractEnvelopeContent):
+    text: str
+    parse_mode: str = field(metadata={"alias": "parseMode"})

trueconf/types/content/video.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from trueconf.client.context_controller import BoundToBot
+from pathlib import Path
+
+@dataclass
+class Video(BoundToBot):
+    """
+    Represents a video file attached to a message.
+
+    This class provides access to file metadata and utility methods such as downloading and preview access.
+
+    Attributes:
+        file_id (str): Unique identifier of the video file.
+        file_name (str): Name of the file as stored on the server.
+        file_size (int): Size of the file in bytes.
+        mimetype (str): MIME type of the video.
+    """
+
+    file_id: str
+    file_name: str
+    file_size: int
+    mimetype: str
+
+    @property
+    async def url(self) -> str:
+        """
+        Returns the direct download URL of the video file.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the original video file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.download_url
+
+    @property
+    async def preview_url(self) -> str:
+        """
+        Returns the preview URL of the video file, if available.
+
+        Source: https://trueconf.com/docs/chatbot-connector/en/files/#retrieving-file-information-and-downloading-the-file
+
+        Returns:
+            str: A URL pointing to the preview version of the video file.
+        """
+
+        r = await self.bot.get_file_info(self.file_id)
+        return r.preview.download_url
+
+    async def download(self, dest_path: str) -> Path | None:
+        """
+        Shortcut for the `download_file_by_id` method of the bot instance.
+
+        Automatically fills the following attributes:
+            - `file_id`
+
+        Use this method to download the current file by its ID.
+
+        Args:
+            dest_path (str): Destination path to save the file.
+                If not specified, a temporary file will be created using
+                `NamedTemporaryFile(prefix="tc_dl_", suffix=file_name, delete=False)`.
+
+        Returns:
+            Path | None: Path to the downloaded file, or None if the download failed.
+        """
+        return await self.bot.download_file_by_id(file_id=self.file_id, dest_path=dest_path)
+

trueconf/types/last_message.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import Optional, Union
+from mashumaro import DataClassDictMixin
+from trueconf.enums.message_type import MessageType
+from trueconf.types.author_box import EnvelopeAuthor
+from trueconf.types.content.text import TextContent
+from trueconf.types.content.attachment import AttachmentContent
+from trueconf.types.content.survey import SurveyContent
+from trueconf.types.content.remove_participant import RemoveParticipant
+from trueconf.types.content.forward_message import ForwardMessage
+from trueconf.types.content.chat_created import ParticipantRoleContent
+
+
+@dataclass
+class LastMessage(DataClassDictMixin):
+    message_id: str = field(metadata={"alias": "messageId"})
+    timestamp: int
+    author: EnvelopeAuthor
+    type: MessageType
+    content: Union[TextContent, AttachmentContent, SurveyContent, ParticipantRoleContent, RemoveParticipant, ForwardMessage]
+
+    @property
+    def content_type(self) -> MessageType:
+        return self.type
+
+    @property
+    def text(self) -> Optional[str]:
+        return self.content.text if isinstance(self.content, TextContent) else None
+
+    @property
+    def file(self) -> Optional[AttachmentContent]:
+        return self.content if isinstance(self.content, AttachmentContent) else None