Spotify.NET/SpotifyAPI.Web/Clients/Interfaces/ILibraryClient.cs

213 lines
9.2 KiB
C#
Raw Normal View History

2020-05-20 07:48:08 +01:00
using System.Collections.Generic;
using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
/// <summary>
/// Endpoints for retrieving information about,
/// and managing, tracks that the current user has saved in their “Your Music” library.
/// </summary>
2020-05-20 07:48:08 +01:00
public interface ILibraryClient
{
2020-05-28 15:30:17 +01:00
/// <summary>
/// Remove one or more albums from the current users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-remove-albums-user
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<bool> RemoveAlbums(LibraryRemoveAlbumsRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Remove one or more tracks from the current users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-remove-tracks-user
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<bool> RemoveTracks(LibraryRemoveTracksRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Delete one or more shows from current Spotify users library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-remove-shows-user
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<bool> RemoveShows(LibraryRemoveShowsRequest request);
/// <summary>
/// Delete one or more episodes from current Spotify users library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference/#endpoint-remove-episodes-user
/// </remarks>
/// <returns></returns>
Task<bool> RemoveEpisodes(LibraryRemoveEpisodesRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Save one or more tracks to the current users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-save-tracks-user
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<bool> SaveTracks(LibrarySaveTracksRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Save one or more albums to the current users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-save-albums-user
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<bool> SaveAlbums(LibrarySaveAlbumsRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Save one or more shows to current Spotify users library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-save-shows-user
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<bool> SaveShows(LibrarySaveShowsRequest request);
/// <summary>
/// Save one or more episodes to current Spotify users library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference/#endpoint-save-episodes-user
/// </remarks>
/// <returns></returns>
Task<bool> SaveEpisodes(LibrarySaveEpisodesRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Check if one or more tracks is already saved in the current Spotify users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-check-users-saved-tracks
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<List<bool>> CheckTracks(LibraryCheckTracksRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Check if one or more albums is already saved in the current Spotify users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-check-users-saved-albums
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<List<bool>> CheckAlbums(LibraryCheckAlbumsRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Check if one or more shows is already saved in the current Spotify users library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-check-users-saved-shows
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<List<bool>> CheckShows(LibraryCheckShowsRequest request);
/// <summary>
/// Check if one or more episodes is already saved in the current Spotify users library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference/#endpoint-check-users-saved-episodes
/// </remarks>
/// <returns></returns>
Task<List<bool>> CheckEpisodes(LibraryCheckEpisodesRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of the songs saved in the current Spotify users Your Music library.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-saved-tracks
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<Paging<SavedTrack>> GetTracks();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of the songs saved in the current Spotify users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-saved-tracks
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<Paging<SavedTrack>> GetTracks(LibraryTracksRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of the albums saved in the current Spotify users Your Music library.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-saved-albums
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<Paging<SavedAlbum>> GetAlbums();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of the albums saved in the current Spotify users Your Music library.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-saved-albums
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<Paging<SavedAlbum>> GetAlbums(LibraryAlbumsRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of shows saved in the current Spotify users library.
/// Optional parameters can be used to limit the number of shows returned.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-saved-shows
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<Paging<SavedShow>> GetShows();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of shows saved in the current Spotify users library.
/// Optional parameters can be used to limit the number of shows returned.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-saved-shows
/// </remarks>
/// <returns></returns>
2020-05-20 07:48:08 +01:00
Task<Paging<SavedShow>> GetShows(LibraryShowsRequest request);
/// <summary>
/// Get a list of episodes saved in the current Spotify users library.
/// Optional parameters can be used to limit the number of shows returned.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-users-saved-episodes
/// </remarks>
/// <returns></returns>
Task<Paging<SavedEpisodes>> GetEpisodes();
/// <summary>
/// Get a list of episodes saved in the current Spotify users library.
/// Optional parameters can be used to limit the number of shows returned.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-users-saved-episodes
/// </remarks>
/// <returns></returns>
Task<Paging<SavedEpisodes>> GetEpisodes(LibraryEpisodesRequest request);
2020-05-20 07:48:08 +01:00
}
}