maxapi-python 1.2.4__py3-none-any.whl → 2.0.0__py3-none-any.whl

pymax/types/domain/attachments/enums.py

@@ -0,0 +1,27 @@
+from enum import Enum
+
+
+class AttachmentType(str, Enum):
+    """Тип вложения сообщения."""
+
+    PHOTO = "PHOTO"
+    VIDEO = "VIDEO"
+    FILE = "FILE"
+    STICKER = "STICKER"
+    AUDIO = "AUDIO"
+    CONTROL = "CONTROL"
+    CONTACT = "CONTACT"
+    CALL = "CALL"
+    SHARE = "SHARE"
+    INLINE_KEYBOARD = "INLINE_KEYBOARD"
+
+
+class TranscriptionStatus(str, Enum):
+    """Статус транскрибации аудио."""
+
+    FAILED = "FAILED"
+    MEDIA_NOT_READY = "MEDIA_NOT_READY"
+    NOT_SUPPORTED = "NOT_SUPPORTED"
+    PROCESSING = "PROCESSING"
+    SUCCESS = "SUCCESS"
+    UNKNOWN = "UNKNOWN"

pymax/types/domain/attachments/file.py

@@ -0,0 +1,56 @@
+from typing import Literal
+
+from pydantic import Field
+
+from pymax.types.domain.base import CamelModel
+
+from .enums import AttachmentType
+
+
+class FileAttachment(CamelModel):
+    """Файловое вложение сообщения.
+
+    Используйте этот тип для входящих файлов в ``Message.attaches``. Временный
+    URL для скачивания можно получить через ``client.get_file_by_id``.
+
+    Example:
+        .. code-block:: python
+
+           for attach in message.attaches:
+               if isinstance(attach, FileAttachment):
+                   file = await client.get_file_by_id(
+                       message.chat_id,
+                       message.id,
+                       attach.file_id,
+                   )
+
+    :ivar file_id: ID файла.
+    :vartype file_id: int
+    :ivar name: Имя файла.
+    :vartype name: str
+    :ivar size: Размер файла в байтах.
+    :vartype size: int
+    :ivar token: Токен файла.
+    :vartype token: str
+    :ivar type: Тип вложения.
+    :vartype type: Literal[AttachmentType.FILE]
+    """
+
+    file_id: int
+    name: str
+    size: int
+    token: str
+    type: Literal[AttachmentType.FILE] = Field(alias="_type")
+
+
+class FileRequest(CamelModel):
+    """Данные для скачивания файлового вложения.
+
+    :ivar unsafe: Помечен ли файл как небезопасный.
+    :vartype unsafe: bool
+    :ivar url: URL файла.
+    :vartype url: str
+    """
+
+    unsafe: bool
+    url: str

pymax/types/domain/attachments/keyboards/__init__.py

@@ -0,0 +1 @@
+from .inline import InlineKeyboardAttachment

pymax/types/domain/attachments/keyboards/inline.py

@@ -0,0 +1,19 @@
+from typing import Any, Literal
+
+from pydantic import Field
+
+from pymax.types.domain.attachments import AttachmentType
+from pymax.types.domain.base import CamelModel
+
+
+class InlineKeyboardAttachment(CamelModel):
+    """Вложение inline-клавиатуры.
+
+    :ivar type: Тип вложения.
+    :vartype type: Literal[AttachmentType.INLINE_KEYBOARD]
+    :ivar keyboard: Данные inline-клавиатуры.
+    :vartype keyboard: dict[str, Any]
+    """
+
+    type: Literal[AttachmentType.INLINE_KEYBOARD] = Field(alias="_type")
+    keyboard: dict[str, Any]

pymax/types/domain/attachments/photo.py

@@ -0,0 +1,45 @@
+from typing import Literal
+
+from pydantic import Field
+
+from pymax.types.domain.base import CamelModel
+
+from .enums import AttachmentType
+
+
+class PhotoAttachment(CamelModel):
+    """Фото-вложение сообщения.
+
+    Используйте этот тип для входящих фото в ``Message.attaches``. Для отправки
+    нового фото используйте ``pymax.Photo`` из ``pymax.files``.
+
+    Example:
+        .. code-block:: python
+
+           for attach in message.attaches:
+               if isinstance(attach, PhotoAttachment):
+                   print(attach.photo_id, attach.base_url)
+
+    :ivar base_url: URL фотографии.
+    :vartype base_url: str
+    :ivar height: Высота изображения.
+    :vartype height: int
+    :ivar width: Ширина изображения.
+    :vartype width: int
+    :ivar photo_id: ID фотографии.
+    :vartype photo_id: int
+    :ivar photo_token: Токен фотографии.
+    :vartype photo_token: str
+    :ivar preview_data: Данные превью.
+    :vartype preview_data: bytes | None
+    :ivar type: Тип вложения.
+    :vartype type: Literal[AttachmentType.PHOTO]
+    """
+
+    base_url: str
+    height: int
+    width: int
+    photo_id: int
+    photo_token: str
+    preview_data: bytes | None = None
+    type: Literal[AttachmentType.PHOTO] = Field(alias="_type")

pymax/types/domain/attachments/share.py

@@ -0,0 +1,29 @@
+from typing import Any, Literal
+
+from pydantic import Field
+
+from pymax.types.domain.base import CamelModel
+
+from .enums import AttachmentType
+
+
+class ShareAttachment(CamelModel):
+    """Вложение предпросмотра ссылки.
+
+    :ivar type: Тип вложения.
+    :vartype type: Literal[AttachmentType.SHARE]
+    :ivar url: URL ссылки.
+    :vartype url: str | None
+    :ivar title: Заголовок предпросмотра.
+    :vartype title: str | None
+    :ivar description: Описание предпросмотра.
+    :vartype description: str | None
+    :ivar image: Данные изображения предпросмотра.
+    :vartype image: dict[str, Any] | None
+    """
+
+    type: Literal[AttachmentType.SHARE] = Field(alias="_type")
+    url: str | None = None
+    title: str | None = None
+    description: str | None = None
+    image: dict[str, Any] | None = None

pymax/types/domain/attachments/sticker.py

@@ -0,0 +1,50 @@
+from typing import Literal
+
+from pydantic import Field
+
+from pymax.types.domain.base import CamelModel
+
+from .enums import AttachmentType
+
+
+class StickerAttachment(CamelModel):
+    """Стикер-вложение сообщения.
+
+    :ivar author_type: Тип автора стикера, если Max его прислал.
+    :vartype author_type: str | None
+    :ivar lottie_url: URL Lottie-анимации.
+    :vartype lottie_url: str | None
+    :ivar url: URL стикера.
+    :vartype url: str
+    :ivar sticker_id: ID стикера.
+    :vartype sticker_id: int
+    :ivar tags: Теги стикера.
+    :vartype tags: list[str] | None
+    :ivar width: Ширина стикера.
+    :vartype width: int
+    :ivar set_id: ID набора стикеров.
+    :vartype set_id: int
+    :ivar time: Время или версия стикера в данных Max.
+    :vartype time: int
+    :ivar sticker_type: Тип стикера.
+    :vartype sticker_type: str
+    :ivar audio: Есть ли аудио.
+    :vartype audio: bool
+    :ivar height: Высота стикера.
+    :vartype height: int
+    :ivar type: Тип вложения.
+    :vartype type: Literal[AttachmentType.STICKER]
+    """
+
+    author_type: str | None = None
+    lottie_url: str | None = None
+    url: str
+    sticker_id: int
+    tags: list[str] | None = None
+    width: int
+    set_id: int
+    time: int
+    sticker_type: str
+    audio: bool
+    height: int
+    type: Literal[AttachmentType.STICKER] = Field(alias="_type")

pymax/types/domain/attachments/video.py

@@ -0,0 +1,90 @@
+from typing import Any, Literal
+
+from pydantic import Field, model_validator
+
+from pymax.types.domain.base import CamelModel
+
+from .enums import AttachmentType
+
+
+class VideoAttachment(CamelModel):
+    """Видео-вложение сообщения.
+
+    Используйте этот тип для входящих видео в ``Message.attaches``. Временный
+    URL для просмотра можно получить через ``client.get_video_by_id``.
+
+    Example:
+        .. code-block:: python
+
+           for attach in message.attaches:
+               if isinstance(attach, VideoAttachment):
+                   video = await client.get_video_by_id(
+                       message.chat_id,
+                       message.id,
+                       attach.video_id,
+                   )
+
+    :ivar height: Высота видео.
+    :vartype height: int
+    :ivar width: Ширина видео.
+    :vartype width: int
+    :ivar video_id: ID видео.
+    :vartype video_id: int
+    :ivar duration: Длительность видео.
+    :vartype duration: int
+    :ivar preview_data: Данные превью.
+    :vartype preview_data: bytes
+    :ivar type: Тип вложения.
+    :vartype type: Literal[AttachmentType.VIDEO]
+    :ivar thumbnail: URL миниатюры.
+    :vartype thumbnail: str
+    :ivar token: Токен видео.
+    :vartype token: str
+    :ivar video_type: Код типа видео в Max.
+    :vartype video_type: int
+    """
+
+    height: int
+    width: int
+    video_id: int
+    duration: int
+    preview_data: bytes
+    type: Literal[AttachmentType.VIDEO] = Field(alias="_type")
+    thumbnail: str
+    token: str
+    video_type: int
+
+
+class VideoRequest(CamelModel):
+    """Данные для просмотра видео-вложения.
+
+    :ivar external: Признак или URL внешнего источника видео.
+    :vartype external: str | bool | None
+    :ivar cache: Использовать ли кеш.
+    :vartype cache: bool
+    :ivar url: URL видео.
+    :vartype url: str
+    """
+
+    external: str | bool | None = Field(default=None, alias="EXTERNAL")
+    cache: bool
+    url: str
+
+    @model_validator(mode="before")
+    @classmethod
+    def unwrap_dynamic_url(cls, value: Any) -> Any:
+        """Нормализует динамический ключ URL в поле ``url``.
+
+        :param value: Значение, переданное в валидатор модели.
+        :type value: Any
+        :returns: Данные запроса видео или исходное значение.
+        :rtype: Any
+        """
+        if not isinstance(value, dict) or "url" in value:
+            return value
+
+        for key, url in value.items():
+            if key not in ("EXTERNAL", "cache"):
+                return {**value, "url": url}
+
+        return value

pymax/types/domain/auth.py

@@ -0,0 +1,161 @@
+from pydantic import BaseModel, Field
+
+from pymax.api.models import CamelModel
+
+
+class StartAuthResponse(CamelModel):
+    """Ответ на начало авторизации.
+
+    :ivar token: Токен авторизационного запроса.
+    :vartype token: str
+    :ivar code_length: Длина кода подтверждения.
+    :vartype code_length: int
+    :ivar request_max_duration: Максимальное время ожидания запроса кода.
+    :vartype request_max_duration: int
+    :ivar request_count_left: Количество оставшихся запросов кода.
+    :vartype request_count_left: int
+    :ivar alt_action_duration: Время до доступности альтернативного действия.
+    :vartype alt_action_duration: int
+    """
+
+    token: str
+    code_length: int
+    request_max_duration: int
+    request_count_left: int
+    alt_action_duration: int
+
+
+class Token(CamelModel):
+    """Токен авторизации или регистрации.
+
+    :ivar token: Значение токена.
+    :vartype token: str
+    """
+
+    token: str
+
+
+class TokenAttrs(BaseModel):
+    """Набор токенов, возвращенных после проверки кода или пароля.
+
+    :ivar login: Токен входа.
+    :vartype login: Token | None
+    :ivar register_token: Токен регистрации.
+    :vartype register_token: Token | None
+    """
+
+    login: Token | None = Field(None, alias="LOGIN")
+    register_token: Token | None = Field(None, alias="REGISTER")
+
+
+class PasswordChallenge(CamelModel):
+    """Запрос дополнительной проверки паролем.
+
+    :ivar track_id: ID проверки.
+    :vartype track_id: str
+    :ivar hint: Подсказка пароля.
+    :vartype hint: str | None
+    """
+
+    track_id: str
+    hint: str | None = None
+
+
+class CheckCodeResponse(CamelModel):
+    """Ответ на проверку кода подтверждения.
+
+    :ivar token_attrs: Токены, доступные после проверки.
+    :vartype token_attrs: TokenAttrs
+    :ivar password_challenge: Данные проверки паролем, если она нужна.
+    :vartype password_challenge: PasswordChallenge | None
+    """
+
+    token_attrs: TokenAttrs = Field(default_factory=TokenAttrs)
+    password_challenge: PasswordChallenge | None = None
+
+    @property
+    def login_token(self) -> str | None:
+        """Возвращает токен входа.
+
+        :returns: Токен входа или ``None``, если сервер его не вернул.
+        :rtype: str | None
+        """
+        return self.token_attrs.login.token if self.token_attrs.login else None
+
+    @property
+    def register_token(self) -> str | None:
+        """Возвращает токен регистрации.
+
+        :returns: Токен регистрации или ``None``, если сервер его не вернул.
+        :rtype: str | None
+        """
+        if not self.token_attrs.register_token:
+            return None
+        return self.token_attrs.register_token.token
+
+
+class CheckPasswordResponse(CamelModel):
+    """Ответ на проверку пароля.
+
+    :ivar token_attrs: Токены, доступные после проверки.
+    :vartype token_attrs: TokenAttrs
+    :ivar error: Ошибка проверки.
+    :vartype error: str | None
+    """
+
+    token_attrs: TokenAttrs = Field(default_factory=TokenAttrs)
+    error: str | None = None
+
+    @property
+    def login_token(self) -> str | None:
+        """Возвращает токен входа.
+
+        :returns: Токен входа или ``None``, если сервер его не вернул.
+        :rtype: str | None
+        """
+        return self.token_attrs.login.token if self.token_attrs.login else None
+
+
+class RequestQrResponse(CamelModel):
+    """Ответ на запрос QR-авторизации.
+
+    :ivar expires_at: Время истечения QR-кода в формате Unix time.
+    :vartype expires_at: int
+    :ivar polling_interval: Интервал проверки статуса.
+    :vartype polling_interval: int
+    :ivar qr_link: Ссылка для QR-кода.
+    :vartype qr_link: str
+    :ivar track_id: ID QR-авторизации.
+    :vartype track_id: str
+    :ivar ttl: Время жизни QR-кода.
+    :vartype ttl: int
+    """
+
+    expires_at: int
+    polling_interval: int
+    qr_link: str
+    track_id: str
+    ttl: int
+
+
+class QrStatus(CamelModel):
+    """Статус QR-авторизации.
+
+    :ivar expires_at: Время истечения QR-кода в формате Unix time.
+    :vartype expires_at: int
+    :ivar login_available: Доступен ли вход.
+    :vartype login_available: bool | None
+    """
+
+    expires_at: int
+    login_available: bool | None = None
+
+
+class CheckQrResponse(CamelModel):
+    """Ответ на проверку статуса QR-авторизации.
+
+    :ivar status: Статус QR-авторизации.
+    :vartype status: QrStatus
+    """
+
+    status: QrStatus

pymax/types/domain/base.py

@@ -0,0 +1,17 @@
+from pydantic import BaseModel, ConfigDict
+from pydantic.alias_generators import to_camel
+
+
+class CamelModel(BaseModel):
+    """Базовая модель с поддержкой camelCase alias-имен.
+
+    Модель разрешает заполнение полей как по Python-именам, так и по alias,
+    автоматически строит camelCase alias и допускает дополнительные поля.
+    """
+
+    model_config = ConfigDict(
+        alias_generator=to_camel,
+        populate_by_name=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+    )