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

trueconf/types/requests/created_personal_chat.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from trueconf.client.context_controller import BoundToBot
+from trueconf.enums.chat_type import ChatType
+from trueconf.types.last_message import LastMessage
+
+
+@dataclass
+class CreatedPersonalChat(BoundToBot, DataClassDictMixin):
+    """
+        **Event type:** a new personal chat was created.
+
+        This object is received in the handler when a personal chat is created in TrueConf.
+
+        Notes:
+            This class is used as the event type in handler functions decorated with `@<router>.created_personal_chat()`.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/server-requests/#createP2PChat
+
+        Attributes:
+            chat_id (str): Unique identifier of the personal chat.
+            title (str): Title of the chat (usually the participant’s name).
+            chat_type (ChatType): Type of the chat (should be `p2p`).
+            last_message (LastMessage | None): The last message in the chat, if available.
+            unread_messages (int): Number of unread messages in the personal chat.
+
+        Examples:
+            ```python
+            from trueconf.types import CreatedPersonalChat
+
+            @<router>.created_personal_chat()
+            async def on_created(event: CreatedPersonalChat):
+                print(f"Personal chat created with id {event.chat_id}")
+            ```
+        """
+    chat_id: str = field(metadata={"alias": "chatId"})
+    title: str
+    chat_type: ChatType = field(metadata={"alias": "chatType"})
+    last_message: LastMessage | None = field(metadata={"alias": "lastMessage"})
+    unread_messages: int = field(metadata={"alias": "unreadMessages"})

trueconf/types/requests/edited_message.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from trueconf.client.context_controller import BoundToBot
+from trueconf.types.content.text import TextContent
+
+
+@dataclass
+class EditedMessage(BoundToBot, DataClassDictMixin):
+    """
+       **Event type:** a message was edited.
+
+       This object is received in the handler when a previously sent message is edited in a chat.
+
+       Notes:
+           This class is used as the event type in handler functions decorated with `@<router>.edited_message()`.
+
+       Source:
+           https://trueconf.com/docs/chatbot-connector/en/server-requests/#editMessage
+
+       Attributes:
+           timestamp (int): Unix timestamp (milliseconds) of when the edit occurred.
+           content (TextContent): The updated content of the edited message.
+           chat_id (str): Unique identifier of the chat where the message was edited.
+
+       Examples:
+           ```python
+           from trueconf.types import EditedMessage
+
+           @<router>.edited_message()
+           async def on_edited(event: EditedMessage):
+               print(f"Message in chat {event.chat_id} was edited: {event.content.text}")
+           ```
+       """
+    timestamp: int
+    content: TextContent
+    chat_id: str = field(metadata={"alias": "chatId"})

trueconf/types/requests/removed_chat.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from trueconf.client.context_controller import BoundToBot
+
+
+@dataclass
+class RemovedChat(BoundToBot, DataClassDictMixin):
+    """
+        **Event type:** a chat was removed.
+
+        This object is received in the handler when a private, group, channel, or conference chat is deleted.
+
+        Notes:
+            This class is used as the event type in handler functions decorated with `@<router>.removed_chat()`.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/server-requests/#removeChat
+
+        Attributes:
+            chat_id (str): Unique identifier of the chat that was removed.
+
+        Examples:
+            ```python
+            from trueconf.types import RemovedChat
+
+            @<router>.removed_chat()
+            async def on_removed(event: RemovedChat):
+                print(f"Chat removed: {event.chat_id}")
+            ```
+        """
+    chat_id: str = field(metadata={"alias": "chatId"})

trueconf/types/requests/removed_chat_participant.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from trueconf.client.context_controller import BoundToBot
+from trueconf.types.author_box import EnvelopeAuthor
+
+
+@dataclass
+class RemovedChatParticipant(BoundToBot, DataClassDictMixin):
+    """
+        **Event type:** a participant was removed from a chat.
+
+        This object is received in the handler when a user is removed from a group, channel, or conference chat.
+
+        Notes:
+            This class is used as the event type in handler functions decorated with `@<router>.removed_chat_participant()`.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/server-requests/#removeChatParticipant
+
+        Attributes:
+            timestamp (int): Unix timestamp (milliseconds) of when the event occurred.
+            chat_id (str): Unique identifier of the chat where the participant was removed.
+            user_id (str): TrueConf ID of the participant who was removed.
+            removed_by (EnvelopeAuthor): Information about the user who removed the participant.
+
+        Examples:
+            ```python
+            from trueconf.types import RemovedChatParticipant
+
+            @<router>.removed_chat_participant()
+            async def on_removed(event: RemovedChatParticipant):
+                print(event.user_id)
+            ```
+        """
+    timestamp: int
+    chat_id: str = field(metadata={"alias": "chatId"})
+    user_id: str = field(metadata={"alias": "userId"})
+    removed_by: EnvelopeAuthor = field(metadata={"alias": "removedBy"})

trueconf/types/requests/removed_message.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from trueconf.client.context_controller import BoundToBot
+from trueconf.types.author_box import EnvelopeAuthor
+
+
+@dataclass
+class RemovedMessage(BoundToBot, DataClassDictMixin):
+    """
+        **Event type:** a message was removed.
+
+        This object is received in the handler when a message is deleted from a chat.
+
+        Notes:
+            This class is used as the event type in handler functions decorated with `@<router>.removed_message()`.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/server-requests/#removeMessage
+
+        Attributes:
+            chat_id (str): Unique identifier of the chat from which the message was removed.
+            message_id (str): Unique identifier of the removed message.
+            removed_by (EnvelopeAuthor): Information about the user who removed the message.
+
+        Examples:
+            ```python
+            from trueconf.types import RemovedMessage
+
+            @<router>.removed_message()
+            async def on_removed(event: RemovedMessage):
+                print(f"Message {event.message_id} removed from chat {event.chat_id}")
+            ```
+        """
+    chat_id: str = field(metadata={"alias": "chatId"})
+    message_id: str = field(metadata={"alias": "messageId"})
+    removed_by: EnvelopeAuthor = field(metadata={"alias": "removedBy"})

trueconf/types/requests/uploading_progress.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from trueconf.client.context_controller import BoundToBot
+
+
+@dataclass
+class UploadingProgress(BoundToBot, DataClassDictMixin):
+    """
+        **Event type:** file upload progress.
+
+        This object is received in the handler when a file is being uploaded and the upload progress is updated.
+
+        Notes:
+            This class is used as the event type in handler functions decorated with `@<router>.uploading_progress()`.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/server-requests/#uploadingProgress
+
+        Attributes:
+            file_id (str): Unique identifier of the file being uploaded.
+            progress (int): Number of bytes uploaded to the server.
+
+        Examples:
+            ```python
+            from trueconf.types import UploadingProgress
+
+            @<router>.uploading_progress()
+            async def on_progress(event: UploadingProgress):
+                print(f"File {event.file_id}: uploaded {event.progress} bytes")
+            ```
+    """
+    file_id: str = field(metadata={"alias": "fileId"})
+    progress: int

trueconf/types/responses/__init__.py

@@ -0,0 +1,57 @@
+from .forward_message_response import ForwardMessageResponse
+from .edit_survey_response import EditSurveyResponse
+from .get_chat_by_id_response import GetChatByIdResponse
+from .remove_message_response import RemoveMessageResponse
+from .send_message_response import SendMessageResponse
+from .get_file_info_response import Previews
+from .get_file_info_response import GetFileInfoResponse
+from .send_survey_response import SendSurveyResponse
+from .subscribe_file_progress_response import SubscribeFileProgressResponse
+from .api_error import ApiError
+from .create_group_chat_response import CreateGroupChatResponse
+from .get_user_display_name_response import GetUserDisplayNameResponse
+from .get_chats_response import GetChatsResponse
+from .create_channel_response import CreateChannelResponse
+from .get_chat_participants_response import GetChatParticipantsResponse
+from .upload_file_response import UploadFileResponse
+from .add_chat_participant_response import AddChatParticipantResponse
+from .has_chat_participant_response import HasChatParticipantResponse
+from .remove_chat_response import RemoveChatResponse
+from .get_message_by_id_response import GetMessageByIdResponse
+from .get_chat_history_response import GetChatHistoryResponse
+from .create_p2p_chat_response import CreateP2PChatResponse
+from .unsubscribe_file_progress_response import UnsubscribeFileProgressResponse
+from .remove_chat_participant_response import RemoveChatParticipantResponse
+from .edit_message_response import EditMessageResponse
+from .auth_response_payload import AuthResponsePayload
+from .send_file_response import SendFileResponse
+
+__all__ = [
+    'ForwardMessageResponse',
+    'EditSurveyResponse',
+    'GetChatByIdResponse',
+    'RemoveMessageResponse',
+    'SendMessageResponse',
+    'Previews',
+    'GetFileInfoResponse',
+    'SendSurveyResponse',
+    'SubscribeFileProgressResponse',
+    'ApiError',
+    'CreateGroupChatResponse',
+    'GetUserDisplayNameResponse',
+    'GetChatsResponse',
+    'CreateChannelResponse',
+    'GetChatParticipantsResponse',
+    'UploadFileResponse',
+    'AddChatParticipantResponse',
+    'HasChatParticipantResponse',
+    'RemoveChatResponse',
+    'GetMessageByIdResponse',
+    'GetChatHistoryResponse',
+    'CreateP2PChatResponse',
+    'UnsubscribeFileProgressResponse',
+    'RemoveChatParticipantResponse',
+    'EditMessageResponse',
+    'AuthResponsePayload',
+    'SendFileResponse'
+]

trueconf/types/responses/add_chat_participant_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class AddChatParticipantResponse(DataClassDictMixin):
+    pass

trueconf/types/responses/api_error.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class ApiError(DataClassDictMixin):
+    error_code: int = field(metadata={"alias": "errorCode"})
+
+    _error_messages = {
+        # Network Errors
+        100: "Connection error",
+        101: "Connection timeout",
+        102: "TLS/SSL error",
+        103: "Unsupported protocol",
+        104: "Route not found",
+
+        # Authorization Errors
+        200: "Not authorized",
+        201: "Invalid credentials",
+        202: "User disabled",
+        203: "Credentials expired",
+
+        # Chat Errors
+        300: "Internal server error",
+        301: "Operation timeout",
+        302: "Access denied",
+        303: "Not enough rights",
+        304: "Chat not found",
+        305: "User is not a chat participant",
+        306: "Message not found",
+        307: "Unknown message",
+        308: "File not found",
+        309: "User already in chat",
+    }
+
+    def __str__(self):
+        return f"[{self.error_code}] {self._error_messages.get(self.error_code, 'Unknown error')}"

trueconf/types/responses/auth_response_payload.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class AuthResponsePayload(DataClassDictMixin):
+    user_id: str = field(metadata={"alias": "userId"})
+    connection_id: str = field(metadata={"alias": "connectionId"})

trueconf/types/responses/create_channel_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class CreateChannelResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})

trueconf/types/responses/create_group_chat_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class CreateGroupChatResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})

trueconf/types/responses/create_p2p_chat_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class CreateP2PChatResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})

trueconf/types/responses/edit_message_response.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class EditMessageResponse(DataClassDictMixin):
+    message_id: str = field(metadata={"alias": "messageId"})
+    timestamp: int

trueconf/types/responses/edit_survey_response.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class EditSurveyResponse(DataClassDictMixin):
+    message_id: str = field(metadata={"alias": "messageId"})
+    timestamp: int

trueconf/types/responses/forward_message_response.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class ForwardMessageResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})
+    message_id: str = field(metadata={"alias": "messageId"})
+    timestamp: int

trueconf/types/responses/get_chat_by_id_response.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from trueconf.types.last_message import LastMessage
+
+
+@dataclass
+class GetChatByIdResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})
+    title: str
+    chat_type: int = field(metadata={"alias": "chatType"})
+    unread_messages: int = field(metadata={"alias": "unreadMessages"})
+    last_message: LastMessage = field(metadata={"alias": "lastMessage"})

trueconf/types/responses/get_chat_history_response.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import List
+from mashumaro import DataClassDictMixin
+from trueconf.types.message import Message
+
+@dataclass
+class GetChatHistoryResponse(DataClassDictMixin):
+    count: int
+    chat_id: str = field(metadata={"alias": "chatId"})
+    messages: List[Message] = field(
+        default_factory=list,
+        metadata={"alias": "messages"})

trueconf/types/responses/get_chat_participants_response.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import List
+from mashumaro import DataClassDictMixin
+from trueconf.types.chat_participant import ChatParticipant
+
+
+@dataclass
+class GetChatParticipantsResponse(DataClassDictMixin):
+    participants: List[ChatParticipant] = field(
+        default_factory=list,
+        metadata={"alias": "participants"})

trueconf/types/responses/get_chats_response.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import List
+from mashumaro import DataClassDictMixin
+from trueconf.types.responses.get_chat_by_id_response import GetChatByIdResponse
+
+
+@dataclass
+class GetChatsResponse(DataClassDictMixin):
+    chats: List[GetChatByIdResponse] = field(
+        default_factory=list,
+        metadata={"alias": "chats"})

trueconf/types/responses/get_file_info_response.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import Optional, List
+from mashumaro import DataClassDictMixin
+from trueconf.enums.file_ready_state import FileReadyState
+
+
+@dataclass
+class Previews(DataClassDictMixin):
+    name: str
+    size: int
+    mimetype: str = field(metadata={"alias": "mimeType"})
+    download_url: str = field(metadata={"alias": "downloadUrl"})
+
+
+@dataclass
+class GetFileInfoResponse(DataClassDictMixin):
+    name: str
+    size: int
+    previews: Optional[List[Previews]]
+    mimetype: str = field(metadata={"alias": "mimeType"})
+    download_url: Optional[str] = field(metadata={"alias": "downloadUrl"})
+    ready_state: FileReadyState = field(metadata={"alias": "readyState"})
+    info_hash: str = field(metadata={"alias": "infoHash"})

trueconf/types/responses/get_message_by_id_response.py

@@ -0,0 +1,26 @@
+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, EnvelopeBox
+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 GetMessageByIdResponse(DataClassDictMixin):
+    timestamp: int
+    type: MessageType
+    author: EnvelopeAuthor
+    box: EnvelopeBox
+    content: Union[
+        TextContent, AttachmentContent, SurveyContent, ParticipantRoleContent, RemoveParticipant, ForwardMessage]
+    message_id: str = field(metadata={"alias": "messageId"})
+    chat_id: str = field(metadata={"alias": "chatId"})
+    is_edited: bool = field(metadata={"alias": "isEdited"})
+    reply_message_id: Optional[str] = field(default=None, metadata={"alias": "replyMessageId"})

trueconf/types/responses/get_user_display_name_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class GetUserDisplayNameResponse(DataClassDictMixin):
+    display_name: str = field(metadata={"alias": "displayName"})

trueconf/types/responses/has_chat_participant_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class HasChatParticipantResponse(DataClassDictMixin):
+    result: bool

trueconf/types/responses/remove_chat_participant_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class RemoveChatParticipantResponse(DataClassDictMixin):
+    pass

trueconf/types/responses/remove_chat_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class RemoveChatResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})

trueconf/types/responses/remove_message_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class RemoveMessageResponse(DataClassDictMixin):
+    pass

trueconf/types/responses/send_file_response.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class SendFileResponse(DataClassDictMixin):
+    timestamp: int
+    chat_id: str = field(metadata={"alias": "chatId"})
+    message_id: str = field(metadata={"alias": "messageId"})

trueconf/types/responses/send_message_response.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class SendMessageResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})
+    message_id: str = field(metadata={"alias": "messageId"})
+    timestamp: int

trueconf/types/responses/send_survey_response.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class SendSurveyResponse(DataClassDictMixin):
+    chat_id: str = field(metadata={"alias": "chatId"})
+    message_id: str = field(metadata={"alias": "messageId"})
+    timestamp: int

trueconf/types/responses/subscribe_file_progress_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class SubscribeFileProgressResponse(DataClassDictMixin):
+    result: bool

trueconf/types/responses/unsubscribe_file_progress_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class UnsubscribeFileProgressResponse(DataClassDictMixin):
+    result: bool

trueconf/types/responses/upload_file_response.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+
+
+@dataclass
+class UploadFileResponse(DataClassDictMixin):
+    upload_task_id: str = field(metadata={"alias": "uploadTaskId"})

trueconf/types/update.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from mashumaro import DataClassDictMixin
+from trueconf.client.context_controller import BoundToBot
+
+
+@dataclass
+class Update(BoundToBot, DataClassDictMixin):
+    method: str
+    type: int
+    id: int
+    payload: dict

trueconf/utils/__init__.py

@@ -0,0 +1,3 @@
+from .generate_secret_for_survey import generate_secret_for_survey
+from .token import get_auth_token
+from .token import validate_token

trueconf/utils/generate_secret_for_survey.py

@@ -0,0 +1,10 @@
+import hashlib
+import secrets
+
+
+async def generate_secret_for_survey(title: str) -> str:
+    random_str = secrets.token_hex(8)
+    combined = title + random_str
+    hash_ = hashlib.sha1(combined.encode("utf-8")).hexdigest()
+
+    return hash_