de.sonallux.spotify.api.apis.EpisodesApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotify-web-api-java Show documentation
A Java wrapper for Spotify's Web API
The newest version!
package de.sonallux.spotify.api.apis;

import de.sonallux.spotify.api.http.ApiClient;
import de.sonallux.spotify.api.apis.episodes.*;
import lombok.RequiredArgsConstructor;

/**
 * Episodes
 */
@RequiredArgsConstructor
public class EpisodesApi {
    private final ApiClient apiClient;

    /**
     * Check User's Saved Episodes
     * Check if one or more episodes is already saved in the current Spotify user's 'Your Episodes' library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum..
     * @param ids A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.
     * @return a {@link CheckUsersSavedEpisodesRequest} object to build and execute the request
     */
    public CheckUsersSavedEpisodesRequest checkUsersSavedEpisodes(String ids) {
        return new CheckUsersSavedEpisodesRequest(apiClient, ids);
    }

    /**
     * Get Episode
     * Get Spotify catalog information for a single episode identified by its unique Spotify ID.
     * @param id The Spotify ID for the episode.
     * @return a {@link GetEpisodeRequest} object to build and execute the request
     */
    public GetEpisodeRequest getEpisode(String id) {
        return new GetEpisodeRequest(apiClient, id);
    }

    /**
     * Get Several Episodes
     * Get Spotify catalog information for several episodes based on their Spotify IDs.
     * @param ids A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.
     * @return a {@link GetMultipleEpisodesRequest} object to build and execute the request
     */
    public GetMultipleEpisodesRequest getMultipleEpisodes(String ids) {
        return new GetMultipleEpisodesRequest(apiClient, ids);
    }

    /**
     * Get User's Saved Episodes
     * Get a list of the episodes saved in the current Spotify user's library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
     * @return a {@link GetUsersSavedEpisodesRequest} object to build and execute the request
     */
    public GetUsersSavedEpisodesRequest getUsersSavedEpisodes() {
        return new GetUsersSavedEpisodesRequest(apiClient);
    }

    /**
     * Remove User's Saved Episodes
     * Remove one or more episodes from the current user's library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
     * @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 RemoveEpisodesUserRequest} object to build and execute the request
     */
    public RemoveEpisodesUserRequest removeEpisodesUser(java.util.List ids) {
        return new RemoveEpisodesUserRequest(apiClient, ids);
    }

    /**
     * Save Episodes for Current User
     * Save one or more episodes to the current user's library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
     * @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 SaveEpisodesUserRequest} object to build and execute the request
     */
    public SaveEpisodesUserRequest saveEpisodesUser(java.util.List ids) {
        return new SaveEpisodesUserRequest(apiClient, ids);
    }
}