de.sonallux.spotify.api.apis.ShowsApi Maven / Gradle / Ivy
Show all versions of spotify-web-api-java Show documentation
package de.sonallux.spotify.api.apis;
import de.sonallux.spotify.api.http.ApiClient;
import de.sonallux.spotify.api.apis.shows.*;
import lombok.RequiredArgsConstructor;
/**
* Shows
*/
@RequiredArgsConstructor
public class ShowsApi {
private final ApiClient apiClient;
/**
* Check User's Saved Shows
* Check if one or more shows is already saved in the current Spotify user's library.
* @param ids A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs.
* @return a {@link CheckUsersSavedShowsRequest} object to build and execute the request
*/
public CheckUsersSavedShowsRequest checkUsersSavedShows(String ids) {
return new CheckUsersSavedShowsRequest(apiClient, ids);
}
/**
* Get Several Shows
* Get Spotify catalog information for several shows based on their Spotify IDs.
* @param ids A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs.
* @return a {@link GetMultipleShowsRequest} object to build and execute the request
*/
public GetMultipleShowsRequest getMultipleShows(String ids) {
return new GetMultipleShowsRequest(apiClient, ids);
}
/**
* Get Show
* Get Spotify catalog information for a single show identified by its unique Spotify ID.
* @param id The Spotify IDfor the show.
* @return a {@link GetShowRequest} object to build and execute the request
*/
public GetShowRequest getShow(String id) {
return new GetShowRequest(apiClient, id);
}
/**
* Get Show Episodes
* Get Spotify catalog information about an show’s episodes. Optional parameters can be used to limit the number of episodes returned.
* @param id The Spotify IDfor the show.
* @return a {@link GetShowsEpisodesRequest} object to build and execute the request
*/
public GetShowsEpisodesRequest getShowsEpisodes(String id) {
return new GetShowsEpisodesRequest(apiClient, id);
}
/**
* Get User's Saved Shows
* Get a list of shows saved in the current Spotify user's library. Optional parameters can be used to limit the number of shows returned.
* @return a {@link GetUsersSavedShowsRequest} object to build and execute the request
*/
public GetUsersSavedShowsRequest getUsersSavedShows() {
return new GetUsersSavedShowsRequest(apiClient);
}
/**
* Remove User's Saved Shows
* Delete one or more shows from current Spotify user's library.
* @param ids A JSON array of the Spotify IDs.
A maximum of 50 items can be specified in one request. Note: if the ids
parameter is present in the query string, any IDs listed here in the body will be ignored.
* @return a {@link RemoveShowsUserRequest} object to build and execute the request
*/
public RemoveShowsUserRequest removeShowsUser(java.util.List ids) {
return new RemoveShowsUserRequest(apiClient, ids);
}
/**
* Save Shows for Current User
* Save one or more shows to current Spotify user's library.
* @param ids A JSON array of the Spotify IDs.
A maximum of 50 items can be specified in one request. Note: if the ids
parameter is present in the query string, any IDs listed here in the body will be ignored.
* @return a {@link SaveShowsUserRequest} object to build and execute the request
*/
public SaveShowsUserRequest saveShowsUser(java.util.List ids) {
return new SaveShowsUserRequest(apiClient, ids);
}
}