Update to spotify-web-api-core 2021.8.23 (#75)

Author: sonallux

spotify-web-api-java-generator/pom.xml

@@ -20,7 +20,7 @@
     <url>https://github.com/sonallux/spotify-web-api-java</url>
 
     <properties>
-        <spotify-web-api-core.version>2021.7.20</spotify-web-api-core.version>
+        <spotify-web-api-core.version>2021.8.23</spotify-web-api-core.version>
         <guava.version>30.1.1-jre</guava.version>
         <picocli.version>4.6.1</picocli.version>
         <flexmark.version>0.62.2</flexmark.version>

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/templates/ApiTemplate.java

@@ -123,6 +123,7 @@ private List<Parameter> generateEndpointRequest(SpotifyWebApiEndpoint endpoint,
         var optionalPathParameters = new ArrayList<Parameter>();
         var optionalQueryParameters = new ArrayList<Parameter>();
         var optionalBodyParameters = new ArrayList<Parameter>();
+        Parameter rawBodyParameter = null;
 
         for (var parameter : endpoint.getParameters()) {
             switch (parameter.getLocation()) {
@@ -134,10 +135,16 @@ private List<Parameter> generateEndpointRequest(SpotifyWebApiEndpoint endpoint,
                     addParameter(parameter, requiredQueryParameters, optionalQueryParameters);
                     break;
                 }
-                case BODY: {
-                    addParameter(parameter, requiredBodyParameters, optionalBodyParameters);
-                    break;
-                }
+            }
+        }
+
+        if (endpoint.getRequestBody() != null) {
+            if (endpoint.getRequestBody() instanceof SpotifyWebApiEndpoint.JsonRequestBody) {
+                var requestBody = ((SpotifyWebApiEndpoint.JsonRequestBody) endpoint.getRequestBody());
+                requestBody.getParameters().forEach(p -> addParameter(p, requiredBodyParameters, optionalBodyParameters));
+            } else if (endpoint.getRequestBody() instanceof SpotifyWebApiEndpoint.Base64ImageRequestBody) {
+                var requestBody = ((SpotifyWebApiEndpoint.Base64ImageRequestBody) endpoint.getRequestBody());
+                rawBodyParameter = new RawBodyParameter("base64Image", "String", requestBody.getDescription(), requestBody.getContentType());
             }
         }
 
@@ -147,12 +154,16 @@ private List<Parameter> generateEndpointRequest(SpotifyWebApiEndpoint endpoint,
         context.put("optionalPathParameters", optionalPathParameters);
         context.put("optionalQueryParameters", optionalQueryParameters);
         context.put("optionalBodyParameters", optionalBodyParameters);
+        context.put("rawBodyParameter", rawBodyParameter);
 
         List<Parameter> requiredParameterList = new ArrayList<>();
         requiredParameterList.add(new Parameter("apiClient", "ApiClient", "The API client"));
         requiredParameterList.addAll(requiredPathParameters);
         requiredParameterList.addAll(requiredQueryParameters);
         requiredParameterList.addAll(requiredBodyParameters);
+        if (rawBodyParameter != null) {
+            requiredParameterList.add(rawBodyParameter);
+        }
         context.put("requiredParameters", requiredParameterList.stream()
             .map(Parameter::asMethodParameter)
             .collect(joining(", ")));
@@ -220,4 +231,15 @@ public String asJavaDoc() {
             return "@param " + javaName + " " + description;
         }
     }
+
+    @Getter
+    @Setter
+    private static class RawBodyParameter extends Parameter {
+        private String contentType;
+
+        public RawBodyParameter(String name, String type, String description, String contentType) {
+            super(name, type, description);
+            this.contentType = contentType;
+        }
+    }
 }

spotify-web-api-java-generator/src/main/resources/templates/request.mustache

@@ -49,6 +49,9 @@ public class {{className}} {
 {{#requiredBodyParameters}}
             .addBodyParameter("{{name}}", {{javaName}})
 {{/requiredBodyParameters}}
+{{#rawBodyParameter}}
+            .withRawBody(okhttp3.RequestBody.create({{javaName}}, okhttp3.MediaType.get("{{contentType}}")))
+{{/rawBodyParameter}}
         ;
 {{#parametersWithDefaultValue}}
         this.{{javaName}}({{defaultValue}});

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/FollowApi.java

@@ -36,7 +36,7 @@ public CheckIfUserFollowsPlaylistRequest checkIfUserFollowsPlaylist(String playl
     /**
      * <h3>Follow Artists or Users</h3>
      * <p>Add the current user as a follower of one or more artists or other Spotify users.</p>
-     * @param type <p>The ID type: either <code>artist</code> or <code>user</code>.</p>
+     * @param type <p>The ID type.</p>
      * @param ids <p>A JSON array of the artist or user <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify IDs</a>. For example: <code>{ids:[&quot;74ASZWbe4lXaubB36ztrGX&quot;, &quot;08td7MxkoHQkXnWAYD8d6Q&quot;]}</code>. A maximum of 50 IDs can be sent in one request. <em>Note: if the <code>ids</code> parameter is present in the query string, any IDs listed here in the body will be ignored.</em></p>
      * @return a {@link FollowArtistsUsersRequest} object to build and execute the request
      */

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/PlaylistsApi.java

@@ -99,7 +99,7 @@ public GetPlaylistsTracksRequest getPlaylistsTracks(String playlistId) {
      * @param tracks <p>An array of objects containing <a href="https://developer.spotify.com/spotify-documentation/web-api/#spotify-uris-and-ids">Spotify URIs</a> of the tracks or episodes to remove. For example: <code>{ &quot;tracks&quot;: [{ &quot;uri&quot;: &quot;spotify:track:4iV5W9uYEdYUVa79Axb7Rh&quot; },{ &quot;uri&quot;: &quot;spotify:track:1301WleyT98MSxVHPZCA6M&quot; }] }</code>. A maximum of 100 objects can be sent at once.</p>
      * @return a {@link RemoveTracksPlaylistRequest} object to build and execute the request
      */
-    public RemoveTracksPlaylistRequest removeTracksPlaylist(String playlistId, java.util.List<String> tracks) {
+    public RemoveTracksPlaylistRequest removeTracksPlaylist(String playlistId, java.util.List<java.util.Map<String, Object>> tracks) {
         return new RemoveTracksPlaylistRequest(apiClient, playlistId, tracks);
     }
 
@@ -130,9 +130,10 @@ public ReplacePlaylistsTracksRequest replacePlaylistsTracks(String playlistId, j
      * <h3>Upload a Custom Playlist Cover Image</h3>
      * <p>Replace the image used to represent a specific playlist.</p>
      * @param playlistId <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a> for the playlist.</p>
+     * @param base64Image <p>The new cover image of the playlist as a Base64 encoded JPEG image. Maximum payload size is 256KB.</p>
      * @return a {@link UploadCustomPlaylistCoverRequest} object to build and execute the request
      */
-    public UploadCustomPlaylistCoverRequest uploadCustomPlaylistCover(String playlistId) {
-        return new UploadCustomPlaylistCoverRequest(apiClient, playlistId);
+    public UploadCustomPlaylistCoverRequest uploadCustomPlaylistCover(String playlistId, String base64Image) {
+        return new UploadCustomPlaylistCoverRequest(apiClient, playlistId, base64Image);
     }
 }

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/follow/FollowArtistsUsersRequest.java

@@ -24,7 +24,7 @@ public class FollowArtistsUsersRequest {
     /**
      * <h3>Follow Artists or Users request</h3>
      * @param apiClient <p>The API client</p>
-     * @param type <p>The ID type: either <code>artist</code> or <code>user</code>.</p>
+     * @param type <p>The ID type.</p>
      * @param ids <p>A JSON array of the artist or user <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify IDs</a>. For example: <code>{ids:[&quot;74ASZWbe4lXaubB36ztrGX&quot;, &quot;08td7MxkoHQkXnWAYD8d6Q&quot;]}</code>. A maximum of 50 IDs can be sent in one request. <em>Note: if the <code>ids</code> parameter is present in the query string, any IDs listed here in the body will be ignored.</em></p>
      */
     public FollowArtistsUsersRequest(ApiClient apiClient, String type, java.util.List<String> ids) {

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/playlists/RemoveTracksPlaylistRequest.java

@@ -45,7 +45,7 @@ public class RemoveTracksPlaylistRequest {
      * @param playlistId <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a></p>
      * @param tracks <p>An array of objects containing <a href="https://developer.spotify.com/spotify-documentation/web-api/#spotify-uris-and-ids">Spotify URIs</a> of the tracks or episodes to remove. For example: <code>{ &quot;tracks&quot;: [{ &quot;uri&quot;: &quot;spotify:track:4iV5W9uYEdYUVa79Axb7Rh&quot; },{ &quot;uri&quot;: &quot;spotify:track:1301WleyT98MSxVHPZCA6M&quot; }] }</code>. A maximum of 100 objects can be sent at once.</p>
      */
-    public RemoveTracksPlaylistRequest(ApiClient apiClient, String playlistId, java.util.List<String> tracks) {
+    public RemoveTracksPlaylistRequest(ApiClient apiClient, String playlistId, java.util.List<java.util.Map<String, Object>> tracks) {
         this.apiClient = apiClient;
         this.request = new Request("DELETE", "/playlists/{playlist_id}/tracks")
             .addPathParameter("playlist_id", String.valueOf(playlistId))

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/playlists/UploadCustomPlaylistCoverRequest.java

@@ -31,11 +31,13 @@ public class UploadCustomPlaylistCoverRequest {
      * <h3>Upload a Custom Playlist Cover Image request</h3>
      * @param apiClient <p>The API client</p>
      * @param playlistId <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a> for the playlist.</p>
+     * @param base64Image <p>The new cover image of the playlist as a Base64 encoded JPEG image. Maximum payload size is 256KB.</p>
      */
-    public UploadCustomPlaylistCoverRequest(ApiClient apiClient, String playlistId) {
+    public UploadCustomPlaylistCoverRequest(ApiClient apiClient, String playlistId, String base64Image) {
         this.apiClient = apiClient;
         this.request = new Request("PUT", "/playlists/{playlist_id}/images")
             .addPathParameter("playlist_id", String.valueOf(playlistId))
+            .withRawBody(okhttp3.RequestBody.create(base64Image, okhttp3.MediaType.get("image/jpeg")))
         ;
     }
 

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/models/Album.java

@@ -3,24 +3,21 @@
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import lombok.*;
 
-/**
- * <a href="https://developer.spotify.com/documentation/web-api/reference/#object-albumobject">AlbumObject</a>
- */
 @Getter
 @Setter
 @NoArgsConstructor
 @JsonTypeInfo(use = JsonTypeInfo.Id.NONE) // Disable deserialization based on @JsonTypeInfo
 public class Album extends BaseObject {
     /**
-     * <p>The type of the album: <code>album</code>, <code>single</code>, or <code>compilation</code>.</p>
+     * <p>The type of the album.</p>
      */
     public String albumType;
     /**
      * <p>The artists of the album. Each artist object includes a link in <code>href</code> to more detailed information about the artist.</p>
      */
     public java.util.List<Artist> artists;
     /**
-     * <p>The markets in which the album is available: <a href="http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2 country codes</a>. Note that an album is considered available in a market when at least 1 of its tracks is available in that market.</p>
+     * <p>The markets in which the album is available: <a href="http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2 country codes</a>. Note that an album is considered available in a market when at least one of its tracks is available in that market.</p>
      */
     public java.util.List<String> availableMarkets;
     /**
@@ -36,7 +33,7 @@ public class Album extends BaseObject {
      */
     public ExternalUrl externalUrls;
     /**
-     * <p>A list of the genres used to classify the album. For example: &quot;Prog Rock&quot; , &quot;Post-Grunge&quot;. (If not yet classified, the array is empty.)</p>
+     * <p>A list of the genres used to classify the album. (If not yet classified, the array is empty.)</p>
      */
     public java.util.List<String> genres;
     /**
@@ -52,15 +49,15 @@ public class Album extends BaseObject {
      */
     public String name;
     /**
-     * <p>The popularity of the album. The value will be between 0 and 100, with 100 being the most popular. The popularity is calculated from the popularity of the album's individual tracks.</p>
+     * <p>The popularity of the album, with 100 being the most popular. The popularity is calculated from the popularity of the album's individual tracks.</p>
      */
     public int popularity;
     /**
-     * <p>The date the album was first released, for example &quot;1981-12-15&quot;. Depending on the precision, it might be shown as &quot;1981&quot; or &quot;1981-12&quot;.</p>
+     * <p>The date the album was first released. Depending on the precision, it might be shown as &quot;1981&quot; or &quot;1981-12&quot;.</p>
      */
     public String releaseDate;
     /**
-     * <p>The precision with which release_date value is known: &quot;year&quot; , &quot;month&quot; , or &quot;day&quot;.</p>
+     * <p>The precision with which release_date value is known.</p>
      */
     public String releaseDatePrecision;
     /**

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/models/AlbumRestriction.java

@@ -10,13 +10,7 @@
 @NoArgsConstructor
 public class AlbumRestriction {
     /**
-     * <p>The reason for the restriction. Supported values:</p>
-     * <ul>
-     * <li><code>market</code> - The content item is not available in the given market.</li>
-     * <li><code>product</code> - The content item is not available for the user's subscription type.</li>
-     * <li><code>explicit</code> - The content item is explicit and the user's account is set to not play explicit content.<br>
-     * Additional reasons may be added in the future. <strong>Note</strong>: If you use this field, make sure that your application safely handles unknown values.</li>
-     * </ul>
+     * <p>The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.</p>
      */
     public String reason;
 }