Users

get_user

get_user(
    client: AsyncClient,
    access_token: str,
    username_or_id: str | UUID,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> FullUser | UserBlockedByMe | UserBlockMe | PrivateUser

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

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
username_or_id	имя пользователя или его UUID TYPE: str | UUID
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	необходима авторизация
NotFoundError	пользователь не найден
UserBlockedError	пользователь заблокирован

get_me

get_me(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> FullMe | DeletedMe

Получить текущего пользователя.

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

RETURNS	DESCRIPTION
FullMe	данные пользователя TYPE: FullMe | DeletedMe
DeletedMe	при удалённом аккаунте TYPE: FullMe | DeletedMe

RAISES	DESCRIPTION
UnauthorizedError	ошибка авторизации
ProfileNotFoundError	аккаунт не создан

follow

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

Подписаться на пользователя

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
username_or_id	имя пользователя или его UUID TYPE: str | UUID
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	ошибка авторизации
NotFoundError	Пользователь не найден
ConflictError	Вы уже подписана на этого пользователя
ValidationError	Нельзя подписаться на себя
UserBlockedError	пользователь заблокирован

Returns: Количество подписчиков пользователя

unfollow

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

Отписать от пользователя

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
username_or_id	имя пользователя или его UUID TYPE: str | UUID
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	ошибка авторизации
NotFoundError	Пользователь не найден

Returns: Количество подписчиков пользователя

get_followers

get_followers(
    client: AsyncClient,
    access_token: str,
    username_or_id: str | UUID,
    page: int = 1,
    limit: int = 30,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> tuple[PagePagination, list[UserWithFollowing]]

Получить подписчиков пользователя.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
username_or_id	имя пользователя или его UUID TYPE: str | UUID
page	страница TYPE: int DEFAULT: 1
limit	максимальное количество пользователей на странице TYPE: int DEFAULT: 30
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	ошибка авторизации
NotFoundError	Пользователь не найден
ParamsValidationError	1 <= limit <= 100
ParamsValidationError	page >= 1
UserBlockedError	пользователь заблокирован

get_following

get_following(
    client: AsyncClient,
    access_token: str,
    username_or_id: str | UUID,
    page: int = 1,
    limit: int = 30,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> tuple[PagePagination, list[UserWithFollowing]]

Получить подписчики пользователя.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
username_or_id	имя пользователя ли его UUID TYPE: str | UUID
page	страница TYPE: int DEFAULT: 1
limit	максимальное количество пользователей на странице TYPE: int DEFAULT: 30
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	ошибка авторизации
NotFoundError	Пользователь не найден
ParamsValidationError	1 <= limit <= 100
ParamsValidationError	page >= 1
UserBlockedError	пользователь заблокирован

get_top_clans

get_top_clans(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> list[Clan]

Получить топ кланов.

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

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

get_who_to_follow

get_who_to_follow(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> list[UserWithFollowersCount]

Получить топ по подпискам.

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

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

search_users

search_users(
    client: AsyncClient,
    access_token: str,
    query: str,
    limit: int = 20,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> list[UserWithFollowersCount]

Поиск пользователей.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
query	текст запроса TYPE: str
limit	максимальное количество выданных пользователей TYPE: int DEFAULT: 20
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	ошибка авторизации
ValidationError	1 <= limit <= 50

get_pins

get_pins(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> tuple[PinSlug | None, list[PinWithDate]]

Получить список пин'ов и текущий пин.

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

RETURNS	DESCRIPTION
tuple[PinSlug | None, list[PinWithDate]]	(активный пин, список доступных пинов) Если пина нет в enum PinSlug, то его в списке не будет

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен

set_pin

set_pin(
    client: AsyncClient,
    access_token: str,
    pin_slug: PinSlug,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> PinSlug

Изменить пин.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
pin_slug	slug пина TYPE: PinSlug
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
PinNotOwnedError	вы не обладаете этим пином или такого пина не существует
ParamsValidationError	1 <= len(slug) <= 50

delete_pin

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

Убрать пин.

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

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен

get_privacy

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

Получить настройки приватности текущего пользователя.

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

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен

update_privacy

update_privacy(
    client: AsyncClient,
    access_token: str,
    is_private: bool | None = None,
    likes_visibility: Visibility | None = None,
    wall_access: Visibility | None = None,
    show_last_seen: bool | None = None,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> Privacy

Изменить настройки приватности текущего пользователя.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
is_private	приватный ли пользователь TYPE: bool | None DEFAULT: None
likes_visibility	кто может видеть лайкнутые посты TYPE: Visibility | None DEFAULT: None
wall_access	кто может писать на стене TYPE: Visibility | None DEFAULT: None
show_last_seen	показывать время последнего посещения TYPE: bool | None DEFAULT: None
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен

get_profile

get_profile(
    client: AsyncClient,
    access_token: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> Profile | BannedProfile | NotCreatedProfile

Профиль текущего пользователя.

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

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен

create_profile

create_profile(
    client: AsyncClient,
    access_token: str,
    avatar: str,
    display_name: str,
    username: str,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> CreateUserResponse

Создать профиль

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
avatar	эмоджи профиля TYPE: str
display_name	имя TYPE: str
username	имя пользователя TYPE: str
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
InvalidAAvatarError	Неправильный эмоджи
UsernameTakenError	имя пользователя занято
ParamsValidationError	Неправильное имя пользователя

update_profile

update_profile(
    client: AsyncClient,
    access_token: str,
    bio: str | None = None,
    display_name: str | None = None,
    username: str | None = None,
    banner_id: UUID | None = None,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> Me

Обновить профиль.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
bio	о себе TYPE: str | None DEFAULT: None
display_name	имя TYPE: str | None DEFAULT: None
username	имя пользователя TYPE: str | None DEFAULT: None
banner_id	UUID файла нового баннера TYPE: UUID | None DEFAULT: None
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
ITDError	Био максимум 160 символов
ITDError	Имя от 1 до 50 символов
ITDError	Юзернейм 3-50 символов, только буквы, цифры и _
ForbiddenError	На баннер можно поставить только свой файл
ValidationError	Баннер может быть только изображением
UsernameTakenError	Имя пользователя уже занято
GIFRequiresVerificationError	Только верефицированные пользователи могут поставить гифку на баннер

delete_banner

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

Удалить баннер.

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

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен

block

block(
    client: AsyncClient,
    access_token: str,
    username_or_id: str | UUID,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> None

Изменить настройки приватности текущего пользователя.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
username_or_id	имя пользователя или UUID TYPE: str | UUID
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
NotFoundError	пользователь не найден
ConflictError	пользователь уже заблокирован
ValidationError	нельзя заблокировать себя

unblock

unblock(
    client: AsyncClient,
    access_token: str,
    username_or_id: str | UUID,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> None

Разблокировать пользователя.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
username_or_id	имя пользователя или UUID TYPE: str | UUID
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
NotFoundError	пользователь не найден
ConflictError	пользователь не заблокирован

get_blocked

get_blocked(
    client: AsyncClient,
    access_token: str,
    page: int = 1,
    limit: int = 20,
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> tuple[PagePagination, list[BlockedAuthor]]

Получить заблокированных пользователей.

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
access_token	access токен TYPE: str
page	страница TYPE: int DEFAULT: 1
limit	максимальное количество пользователей на странице TYPE: int DEFAULT: 20
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
ParamsValidationError	1 <= limit <= 100
ParamsValidationError	page >= 1

get_follow_status

get_follow_status(
    client: AsyncClient,
    access_token: str,
    user_ids: list[UUID],
    domain: str = "xn--d1ah4a.com",
    **kwargs,
) -> dict[UUID, bool]

Подписаны ли вы на пользователей.

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

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
ParamsValidationError	len(user_ids) <= 20

delete_account

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

Удалить аккаунт. После удаления аккаунта все остальные эндпоинт, требущие авторизации будут выбрасывать AccountDeletedError, кроме get_me.

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

RAISES	DESCRIPTION
UnauthorizedError	неверный access токен
AlreadyDeletedError	аккаунт уже удалён

RETURNS	DESCRIPTION
datetime	Время, до которого можно восстановить аккаунт

restore_account

restore_account(
    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	неверный access токен
NotDeletedError	аккаунт не удалён

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

check_username

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

Не зянято ли это имя

PARAMETER	DESCRIPTION
client	httpx.AsyncClient TYPE: AsyncClient
username	имя пользовтеля TYPE: str
domain	домен TYPE: str DEFAULT: 'xn--d1ah4a.com'

RAISES	DESCRIPTION
InvalidInputError	len(username) >= 1

RETURNS	DESCRIPTION
bool	Не зянято ли это имя