feat(api): api call to remove items from playlist

Author: Jiankai Zheng

src/main/java/spotify/api/impl/PlaylistApiRetrofit.java

@@ -16,10 +16,7 @@
 import spotify.models.playlists.PlaylistSimplified;
 import spotify.models.playlists.PlaylistTrack;
 import spotify.models.playlists.Snapshot;
-import spotify.models.playlists.requests.AddItemPlaylistRequestBody;
-import spotify.models.playlists.requests.CreateUpdatePlaylistRequestBody;
-import spotify.models.playlists.requests.ReorderPlaylistItemsRequestBody;
-import spotify.models.playlists.requests.ReplacePlaylistItemsRequestBody;
+import spotify.models.playlists.requests.*;
 import spotify.retrofit.services.PlaylistService;
 import spotify.utils.LoggingUtil;
 import spotify.utils.ResponseChecker;
@@ -321,6 +318,39 @@ public void uploadCoverImageToPlaylist(String playlistId, String base64EncodedJp
         }
     }
 
+    @Override
+    public Snapshot deleteItemsFromPlaylist(String playlistId, String snapshotId, DeleteItemsPlaylistRequestBody items) {
+        if (playlistId == null || playlistId.isEmpty()) {
+            final String errorMessage = "Playlist id is empty!";
+            logger.error(errorMessage);
+            throw new IllegalArgumentException(errorMessage);
+        }
+
+        if (snapshotId != null && snapshotId.isEmpty()) {
+            logger.warn("An empty snapshot id was passed in. The snapshot id has now been set to NULL.");
+            snapshotId = null;
+        }
+
+        logger.trace("Constructing HTTP call to remove items from a playlist.");
+        Call<Snapshot> httpCall = playlistService.deleteItemsFromPlaylist("Bearer " + this.accessToken, playlistId, items);
+
+        try {
+            logger.info("Executing HTTP call to remove items from a playlist.");
+            logger.debug(String.format("Removing items from playlist %s with snapshot id %s", playlistId, snapshotId));
+            logger.debug(String.format("Removing the following items %s", items));
+            LoggingUtil.logHttpCall(logger, httpCall);
+            Response<Snapshot> response = httpCall.execute();
+
+            ResponseChecker.throwIfRequestHasNotBeenFulfilledCorrectly(response, HttpStatusCode.OK);
+
+            logger.info("Items have been successfully removed from the playlist");
+            return response.body();
+        } catch (IOException ex) {
+            logger.error("HTTP request to remove items from playlist has failed");
+            throw new HttpRequestFailedException(ex.getMessage());
+        }
+    }
+
     private void validateParametersReorderFunction(String playlistId, ReorderPlaylistItemsRequestBody requestBody) {
         if (playlistId == null || playlistId.isEmpty()) {
             final String errorMessage = "Playlist id can not be empty!";

src/main/java/spotify/api/interfaces/PlaylistApi.java

@@ -7,6 +7,7 @@
 import spotify.models.playlists.PlaylistTrack;
 import spotify.models.playlists.Snapshot;
 import spotify.models.playlists.requests.CreateUpdatePlaylistRequestBody;
+import spotify.models.playlists.requests.DeleteItemsPlaylistRequestBody;
 import spotify.models.playlists.requests.ReorderPlaylistItemsRequestBody;
 
 import java.util.List;
@@ -34,4 +35,6 @@ public interface PlaylistApi {
     void replacePlaylistItems(String playlistId, List<String> listOfItemUris);
 
     void uploadCoverImageToPlaylist(String playlistId, String base64EncodedJpegImage);
+
+    Snapshot deleteItemsFromPlaylist(String playlistId, String snapshotId, DeleteItemsPlaylistRequestBody items);
 }

src/main/java/spotify/api/spotify/SpotifyApi.java

@@ -26,6 +26,7 @@
 import spotify.models.paging.Paging;
 import spotify.models.playlists.*;
 import spotify.models.playlists.requests.CreateUpdatePlaylistRequestBody;
+import spotify.models.playlists.requests.DeleteItemsPlaylistRequestBody;
 import spotify.models.playlists.requests.ReorderPlaylistItemsRequestBody;
 import spotify.models.recommendations.RecommendationCollection;
 import spotify.models.shows.SavedShowSimplified;
@@ -345,6 +346,11 @@ public void uploadCoverImageToPlaylist(String playlistId, String base64EncodedJp
         playlistApi.uploadCoverImageToPlaylist(playlistId, base64EncodedJpegImage);
     }
 
+    public Snapshot deleteItemsFromPlaylist(String playlistId, String snapshotId, DeleteItemsPlaylistRequestBody items) {
+        logger.info("Requesting to remove items from a playlist");
+        return playlistApi.deleteItemsFromPlaylist(playlistId, snapshotId, items);
+    }
+
     private void setup(final String accessToken) {
         logger.trace("Constructing Retrofit APIs");
         this.trackApi = new TrackApiRetrofit(accessToken);