Package: maxapi.methods.types

maxapi.methods.types

added_admin_chat

AddedListAdminChat

Bases: BaseModel

Ответ API при добавлении списка администраторов в чат.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

added_members_chat

FailedUserDetails

Bases: BaseModel

Детали ошибки для пользователя.

Attributes:

Name	Type	Description
error_code	str	Код ошибки.
user_ids	List[int]	Список ID пользователей, для которых произошла ошибка.

AddedMembersChat

Bases: BaseModel

Ответ API при добавлении списка пользователей в чат.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

deleted_bot_from_chat

DeletedBotFromChat

Bases: BaseModel

Ответ API при удалении бота из чата.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

deleted_chat

DeletedChat

Bases: BaseModel

Ответ API при удалении чата (?).

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

deleted_message

DeletedMessage

Bases: BaseModel

Ответ API при удалении сообщения.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

deleted_pin_message

DeletedPinMessage

Bases: BaseModel

Ответ API при удалении закрепленного в чате сообщения.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

edited_message

EditedMessage

Bases: BaseModel

Ответ API при изменении сообщения.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

getted_list_admin_chat

GettedListAdminChat

Bases: BaseModel

Ответ API с полученным списком администраторов чата.

Attributes:

Name	Type	Description
members	List[ChatMember]	Список участников с правами администратора.
marker	Optional[int]	Маркер для постраничной навигации (если есть).

getted_members_chat

GettedMembersChat

Bases: BaseModel

Ответ API с полученным списком участников чата.

Attributes:

Name	Type	Description
members	List[ChatMember]	Список участников с правами администратора.
marker	Optional[int]	Маркер для постраничной навигации (если есть).

getted_pineed_message

GettedPin

Bases: BaseModel

Ответ API с информацией о закреплённом сообщении.

Attributes:

Name	Type	Description
message	Optional[Message]	Закреплённое сообщение, если оно есть.

getted_subscriptions

GettedSubscriptions

Bases: BaseModel

Ответ API с отправленным сообщением.

Attributes:

Name	Type	Description
message	Message	Объект отправленного сообщения.

getted_updates

get_update_model(event, bot) async

Конвертировать словарь с событием в модель обновления.

Source code in maxapi/methods/types/getted_updates.py

async def get_update_model(event: dict, bot: "Bot") -> UpdateUnion | None:
    """Конвертировать словарь с событием в модель обновления."""
    try:
        event_object = UpdateUnionAdapter.validate_python(event)
    except ValueError:
        # Пришло новое событие, которое данная библиотека пока
        # не умеет обрабатывать. Возвращаем None, чтобы обработать это
        # в вызывающем коде и не ломать процесс получения обновлений
        return None

    return await enrich_event(event_object=event_object, bot=bot)

process_update_request(events, bot) async

Конвертировать словарь с обновлениями в список моделей.

Source code in maxapi/methods/types/getted_updates.py

async def process_update_request(
    events: dict[str, Any],
    bot: "Bot",
) -> list[UpdateUnion]:
    """Конвертировать словарь с обновлениями в список моделей."""
    events_models = []

    for event in events["updates"]:
        event_model = await get_update_model(event, bot)
        if event_model is None:
            update_type = event["update_type"]
            logger.warning(
                UNKNOWN_UPDATE_DISCLAIMER.format(update_type=update_type)
            )
            continue

        events_models.append(event_model)

    return events_models

pinned_message

PinnedMessage

Bases: BaseModel

Ответ API при добавлении списка администраторов в чат.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

removed_admin

RemovedAdmin

Bases: BaseModel

Ответ API при отмене прав администратора у пользователя в чате

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

removed_member_chat

RemovedMemberChat

Bases: BaseModel

Ответ API при удалении участника из чата.

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или описание ошибки.

sended_action

SendedAction

Bases: BaseModel

Ответ API после выполнения действия.

Attributes:

Name	Type	Description
success	bool	Статус успешности выполнения операции.
message	Optional[str]	Дополнительное сообщение или описание ошибки.

sended_callback

SendedCallback

Bases: BaseModel

Ответ API после выполнения callback-действия.

Attributes:

Name	Type	Description
success	bool	Статус успешности выполнения callback.
message	Optional[str]	Дополнительное сообщение или описание ошибки.
bot	Optional[Bot]	Внутреннее поле для хранения ссылки на экземпляр бота (не сериализуется).

sended_message

SendedMessage

Bases: BaseModel

Ответ API с отправленным сообщением.

Attributes:

Name	Type	Description
message	Message	Объект отправленного сообщения.

subscribed

Subscribed

Bases: BaseModel

Результат подписки на обновления на Webhook

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.

unsubscribed

Unsubscribed

Bases: BaseModel

Результат отписки от обновлений на Webhook

Attributes:

Name	Type	Description
success	bool	Статус успешности операции.
message	Optional[str]	Дополнительное сообщение или ошибка.