yandex-music-client
Version:
``` npm i yandex-music-client ```
141 lines (140 loc) • 5.56 kB
TypeScript
import type { InvocationInfo } from '../models/InvocationInfo';
import type { Playlist } from '../models/Playlist';
import type { PlaylistRecommendations } from '../models/PlaylistRecommendations';
import type { VisibilityEnum } from '../models/VisibilityEnum';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class PlaylistsService {
readonly httpRequest: BaseHttpRequest;
constructor(httpRequest: BaseHttpRequest);
/**
* Получение полной информации о плейлистах по их идентификатору
* @param formData
* @returns any Ok
* @throws ApiError
*/
getPlaylistsByIds(formData: {
/**
* uid владельца плейлиста и kind плейлиста через двоеточие и запятую
*/
playlistIds?: Array<string>;
}): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Array<Playlist>;
}>;
/**
* Получение списка плейлистов пользователя.
* @param userId Идентификатор пользователя
* @returns any Ok
* @throws ApiError
*/
getPlayLists(userId: number): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Array<Playlist>;
}>;
/**
* Получение плейлиста по уникальному идентификатору
* @param userId Идентификатор пользователя
* @param kind Идентификатор плейлиста
* @returns any Ok
* @throws ApiError
*/
getPlaylistById(userId: number, kind: number): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Playlist;
}>;
/**
* Получение плейлистов по идентификаторам
* @param userId Идентификатор пользователя
* @param kinds
* @param mixed
* @param richTracks
* @returns any Ok
* @throws ApiError
*/
getUserPlaylistsByIds(userId: number, kinds: string, mixed: boolean, richTracks: boolean): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Array<Playlist>;
}>;
/**
* Создание нового плейлиста
* @param userId Идентификатор пользователя
* @param formData
* @returns any Ok
* @throws ApiError
*/
createPlaylist(userId: number, formData: {
title: string;
visibility: VisibilityEnum;
}): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Playlist;
}>;
/**
* Изменение названия плейлиста.
* @param userId Идентификатор пользователя
* @param kind Идентификатор плейлиста
* @param formData
* @returns any Изменение видимости плейлиста
* @throws ApiError
*/
renamePlaylist(userId: number, kind: number, formData: {
value?: string;
}): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Playlist;
}>;
/**
* Удаление плейлиста
* @param userId Идентификатор пользователя
* @param kind Идентификатор плейлиста
* @returns any Ok
* @throws ApiError
*/
deletePlaylist(userId: number, kind: number): CancelablePromise<{
invocationInfo: InvocationInfo;
result: string;
}>;
/**
* Добавление треков в плейлист
* Используй '{"diff":{"op":"insert","at":0,"tracks":[{"id":"20599729","albumId":"2347459"}]}}' - для добавления, {"diff":{"op":"delete","from":0,"to":1,"tracks":[{"id":"20599729","albumId":"2347459"}]}} - для удаления треков
* @param userId Идентификатор пользователя
* @param kind Идентификатор плейлиста
* @param formData
* @returns any Ok
* @throws ApiError
*/
changePlaylistTracks(userId: number, kind: number, formData: {
diff?: string;
revision?: string;
}): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Playlist;
}>;
/**
* Получение рекомендаций для плейлиста
* @param userId Идентификатор пользователя
* @param kind Идентификатор плейлиста
* @returns any Ok
* @throws ApiError
*/
getRecommendations(userId: number, kind: number): CancelablePromise<{
invocationInfo: InvocationInfo;
result: PlaylistRecommendations;
}>;
/**
* Изменение видимости плейлиста
* Необходимо передать "public" или "private" в качестве значения
* @param userId Идентификатор пользователя
* @param kind Идентификатор плейлиста
* @param formData
* @returns any Изменение видимости плейлиста
* @throws ApiError
*/
changePlaylistVisibility(userId: number, kind: number, formData: {
value?: VisibilityEnum;
}): CancelablePromise<{
invocationInfo: InvocationInfo;
result: Playlist;
}>;
}