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

128 lines
5.8 KiB
C#
Raw Normal View History

2020-05-01 19:05:28 +01:00
using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
public interface IBrowseClient
{
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of categories used to tag items in Spotify (on, for example, the Spotify players “Browse” tab).
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-categories
/// </remarks>
/// <returns></returns>
2020-05-01 19:05:28 +01:00
Task<CategoriesResponse> GetCategories();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of categories used to tag items in Spotify (on, for example, the Spotify players “Browse” tab).
/// </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-categories
/// </remarks>
/// <returns></returns>
2020-05-01 19:05:28 +01:00
Task<CategoriesResponse> GetCategories(CategoriesRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a single category used to tag items in Spotify (on, for example, the Spotify players “Browse” tab).
/// </summary>
/// <param name="categoryId">The Spotify category ID for the category.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-a-category
/// </remarks>
/// <returns></returns>
2020-05-01 19:05:28 +01:00
Task<Category> GetCategory(string categoryId);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a single category used to tag items in Spotify (on, for example, the Spotify players “Browse” tab).
/// </summary>
/// <param name="categoryId">The Spotify category ID for the category.</param>
/// <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-a-category
/// </remarks>
/// <returns></returns>
2020-05-01 19:05:28 +01:00
Task<Category> GetCategory(string categoryId, CategoryRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of Spotify playlists tagged with a particular category.
/// </summary>
/// <param name="categoryId">The Spotify category ID for the category.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-a-categories-playlists
/// </remarks>
/// <returns></returns>
2020-05-01 19:05:28 +01:00
Task<CategoryPlaylistsResponse> GetCategoryPlaylists(string categoryId);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of Spotify playlists tagged with a particular category.
/// </summary>
/// <param name="categoryId">The Spotify category ID for the category.</param>
/// <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-a-categories-playlists
/// </remarks>
/// <returns></returns>
2020-05-01 19:05:28 +01:00
Task<CategoryPlaylistsResponse> GetCategoryPlaylists(string categoryId, CategoriesPlaylistsRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Recommendations are generated based on the available information for a given seed entity and matched against
/// similar artists and tracks. If there is sufficient information about the provided seeds,
/// a list of tracks will be returned together with pool size details.
/// </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-recommendations
/// </remarks>
/// <returns></returns>
Task<RecommendationsResponse> GetRecommendations(RecommendationsRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Retrieve a list of available genres seed parameter values for recommendations.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-recommendation-genres
/// </remarks>
/// <returns></returns>
Task<RecommendationGenresResponse> GetRecommendationGenres();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of new album releases featured in Spotify (shown, for example, on a Spotify players “Browse” tab).
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-new-releases
/// </remarks>
/// <returns></returns>
Task<NewReleasesResponse> GetNewReleases();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of new album releases featured in Spotify (shown, for example, on a Spotify players “Browse” tab).
/// </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-new-releases
/// </remarks>
/// <returns></returns>
Task<NewReleasesResponse> GetNewReleases(NewReleasesRequest request);
2020-05-02 13:58:11 +01:00
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of Spotify featured playlists (shown, for example, on a Spotify players Browse tab).
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-featured-playlists
/// </remarks>
/// <returns></returns>
2020-05-02 13:58:11 +01:00
Task<FeaturedPlaylistsResponse> GetFeaturedPlaylists();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get a list of Spotify featured playlists (shown, for example, on a Spotify players Browse tab).
/// </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-featured-playlists
/// </remarks>
/// <returns></returns>
2020-05-02 13:58:11 +01:00
Task<FeaturedPlaylistsResponse> GetFeaturedPlaylists(FeaturedPlaylistsRequest request);
2020-05-01 19:05:28 +01:00
}
}