Закреплённые

class yandex_music._client.pins.PinsMixin

Закреплённые.

Миксин для методов, связанных с закреплёнными элементами.

pins(*args, **kwargs)

Получение списка закреплённых элементов.

Parameters:

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список закреплённых элементов или None.

Return type:

yandex_music.PinsList | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

pin_album(album_id, **kwargs)

Закрепление альбома.

Parameters:

  • album_id (str | int) – Уникальный идентификатор альбома.

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Закреплённый элемент.

Return type:

yandex_music.Pin

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

unpin_album(album_id, **kwargs)

Открепление альбома.

Parameters:

  • album_id (str | int) – Уникальный идентификатор альбома.

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

pin_artist(artist_id, **kwargs)

Закрепление артиста.

Parameters:

  • artist_id (str | int) – Уникальный идентификатор артиста.

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Закреплённый элемент.

Return type:

yandex_music.Pin

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

unpin_artist(artist_id, **kwargs)

Открепление артиста.

Parameters:

  • artist_id (str | int) – Уникальный идентификатор артиста.

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

pin_playlist(uid, kind, **kwargs)

Закрепление плейлиста.

Parameters:

  • uid (str | int) – Уникальный идентификатор владельца плейлиста.

  • kind (str | int) – Номер плейлиста.

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Закреплённый элемент.

Return type:

yandex_music.Pin

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

unpin_playlist(uid, kind, **kwargs)

Открепление плейлиста.

Parameters:

  • uid (str | int) – Уникальный идентификатор владельца плейлиста.

  • kind (str | int) – Номер плейлиста.

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

pin_wave(seeds, **kwargs)

Закрепление волны.

Parameters:

  • seeds (str) – Идентификатор волны (например, “artist:12345”).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Закреплённый элемент.

Return type:

yandex_music.Pin

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

unpin_wave(seeds, **kwargs)

Открепление волны.

Parameters:

  • seeds (str) – Идентификатор волны.

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.