Notifications

get_notifications ¶

get_notifications(
    client: AsyncClient,
    access_token: str,
    offset: int = 0,
    limit: int = 30,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> tuple[bool, list[Notification]]

Получить уведомления.

PARAMETER	DESCRIPTION
`client`	httpx.AsyncClient TYPE: `AsyncClient`
`access_token`	access токен TYPE: `str`
`offset`	сдвиг TYPE: `int` DEFAULT: `0`
`limit`	максимально количество уведомлений в ответе, любое число TYPE: `int` DEFAULT: `30`
`domain`	домен TYPE: `str` DEFAULT: `'xn--d1ah4a.com'`

RETURNS	DESCRIPTION
`tuple[bool, list[Notification]]`	bool есть ли ещё уведомления, list[Notification] список уведомлений

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`ITDError`	offset >= 0

read_batch_notifications ¶

read_batch_notifications(
    client: AsyncClient,
    access_token: str,
    notifications_ids: list[UUID],
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> int

Пометить прочитанными несколько уведомлений.

PARAMETER	DESCRIPTION
`client`	httpx.AsyncClient TYPE: `AsyncClient`
`access_token`	access токен TYPE: `str`
`notifications_ids`	список UUID уведомлений TYPE: `list[UUID]`
`domain`	домен TYPE: `str` DEFAULT: `'xn--d1ah4a.com'`

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`ParamsValidationError`	len(notifications_ids) <= 20

RETURNS	DESCRIPTION
`int`	Количество прочитанных уведомлений

read_notification ¶

read_notification(
    client: AsyncClient,
    access_token: str,
    notification_id: UUID,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> bool

Пометить сообщение прочитанным.

PARAMETER	DESCRIPTION
`client`	httpx.AsyncClient TYPE: `AsyncClient`
`access_token`	access токен TYPE: `str`
`notification_id`	UUID уведомления TYPE: `UUID`
`domain`	домен TYPE: `str` DEFAULT: `'xn--d1ah4a.com'`

RETURNS	DESCRIPTION
`bool`	Успешна ли операция

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации

get_notifications_count ¶

get_notifications_count(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> int

Получить количество непрочитанных уведомлений.

PARAMETER	DESCRIPTION
`client`	httpx.AsyncClient TYPE: `AsyncClient`
`access_token`	access токен TYPE: `str`
`domain`	домен TYPE: `str` DEFAULT: `'xn--d1ah4a.com'`

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации

RETURNS	DESCRIPTION
`int`	Количество непрочитанных уведомлений.

read_all_notifications ¶

read_all_notifications(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> bool

Пометить все уведомления прочитанными.

PARAMETER	DESCRIPTION
`client`	httpx.AsyncClient TYPE: `AsyncClient`
`access_token`	access токен TYPE: `str`
`domain`	домен TYPE: `str` DEFAULT: `'xn--d1ah4a.com'`

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации

RETURNS	DESCRIPTION
`bool`	Успешна ли операция

get_notification_settings ¶

get_notification_settings(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> NotificationsSettings

Получить настройки уведомлений.

PARAMETER	DESCRIPTION
`client`	httpx.AsyncClient TYPE: `AsyncClient`
`access_token`	access токен TYPE: `str`
`domain`	домен TYPE: `str` DEFAULT: `'xn--d1ah4a.com'`

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации

RETURNS	DESCRIPTION
`NotificationsSettings`	Настройки уведомлений

update_notification_settings ¶

update_notification_settings(
    client: AsyncClient,
    access_token: str,
    comments: bool | None = None,
    enabled: bool | None = None,
    follows: bool | None = None,
    mentions: bool | None = None,
    sound: bool | None = None,
    likes: bool | None = None,
    wall_posts: bool | None = None,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> NotificationsSettings

Настроить уведомления

PARAMETER	DESCRIPTION
`client`	httpx.AsyncClient TYPE: `AsyncClient`
`access_token`	access токен TYPE: `str`
`comments`	комментарии TYPE: `bool \| None` DEFAULT: `None`
`enabled`	включены ли уведомления TYPE: `bool \| None` DEFAULT: `None`
`follows`	подписки TYPE: `bool \| None` DEFAULT: `None`
`mentions`	упоминания TYPE: `bool \| None` DEFAULT: `None`
`sound`	звуки при уведомлениях TYPE: `bool \| None` DEFAULT: `None`
`likes`	лайки TYPE: `bool \| None` DEFAULT: `None`
`wall_posts`	посты на стене TYPE: `bool \| None` DEFAULT: `None`
`domain`	домен TYPE: `str` DEFAULT: `'xn--d1ah4a.com'`

RETURNS	DESCRIPTION
`NotificationsSettings`	Новые настройки уведомлений

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации