Update to new category groups

Author: sonallux

CHANGELOG.md

@@ -5,13 +5,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- Adjust the categories of some endpoints to match with the official [Spotify Web API Reference](https://developer.spotify.com/documentation/web-api). No endpoint have been removed, they just got moved to other categories.
+  - Added `CategoriesApi` and `GenresApi` category
+  - Removed `BrowseApe`, `LibraryApi` and `PersonalizationApi`
+  - Renamed `UsersProfileApi` to `UsersApi`
 - Add "Get an Audiobook's Chapters" endpoint
 - Add "Get User's Saved Audiobooks" endpoint
 - Add "Save Audiobooks for Current User" endpoint
 - Add "Remove User's Saved Audiobooks" endpoint
 - Add "Check User's Saved Audiobooks" endpoint
 - Fix type of `shuffleState` in `CurrentlyPlayingContext` to `boolean`
-- Bump jackson to `2.14.1`
+- Fix return type of "Get Category's Playlists request" from `PagedPlaylists` to `PagingFeaturedPlaylist`
+- Fix return type of "Get Featured Playlists request" from `PagedPlaylistsAndMessage` to `PagingFeaturedPlaylist`
+- Fix type of `narrators` field in `AudiobookBase` from `Narrator` to `List<Narrator>`
+- Bump jackson to `2.15.2`
+- Bump okhttp to `4.10.0`
 
 ## [3.1.0]
 - Change the API of the recommendations request. All `seed*` parameters are now considered optional because not all of them are always required. It must be at least one `seed*` parameter present.

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/generators/ObjectModelCreator.java

@@ -32,10 +32,11 @@ public SpotifyWebApi createSpotifyWebApiModel(OpenAPI openAPI) {
     }
 
     private void visitPathItem(String path, PathItem pathItem) {
-        var categoryName = JavaUtils.getCategoryName(pathItem);
-        var category = spotifyWebApi.getCategory(categoryName);
-
-        pathItem.readOperationsMap().forEach((httpMethod, operation) -> visitOperation(category, httpMethod, path, operation));
+        pathItem.readOperationsMap().forEach((httpMethod, operation) -> {
+            var categoryName = JavaUtils.getCategoryName(operation);
+            var category = spotifyWebApi.getCategory(categoryName);
+            visitOperation(category, httpMethod, path, operation);
+        });
     }
 
     private void visitOperation(ApiCategory category, PathItem.HttpMethod method, String path, Operation operation) {

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/generators/SpotifyWebApiGenerator.java

@@ -29,6 +29,8 @@ private Map<String, Object> createContext(OpenAPI openAPI, JavaPackage javaPacka
         context.put("endpointUrl", openAPI.getServers().get(0).getUrl());
 
         var apis = openAPI.getPaths().values().stream()
+                .flatMap(pathItem -> pathItem.readOperationsMap().values().stream())
+                .map(JavaUtils::getCategoryName)
                 .map(JavaUtils::getCategoryClassName)
                 .distinct()
                 .sorted()

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/util/JavaUtils.java

@@ -3,7 +3,6 @@
 import com.google.common.base.CaseFormat;
 import de.sonallux.spotify.generator.java.generators.BaseObjectGenerator;
 import io.swagger.v3.oas.models.Operation;
-import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.ComposedSchema;
 import io.swagger.v3.oas.models.media.MapSchema;
@@ -143,12 +142,8 @@ public static Optional<String> getTypeOfSchema(Schema<?> schema) {
         return Optional.empty();
     }
 
-    public static String getCategoryName(PathItem pathItem) {
-        return (String)pathItem.getExtensions().get("x-spotify-docs-category");
-    }
-
-    public static String getCategoryClassName(PathItem pathItem) {
-        return getCategoryClassName(getCategoryName(pathItem));
+    public static String getCategoryName(Operation operation) {
+        return operation.getTags().get(0);
     }
 
     public static String getCategoryClassName(String categoryName) {

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

@@ -12,37 +12,33 @@ public class SpotifyWebApi  {
     private final AlbumsApi albumsApi;
     private final ArtistsApi artistsApi;
     private final AudiobooksApi audiobooksApi;
-    private final BrowseApi browseApi;
+    private final CategoriesApi categoriesApi;
     private final ChaptersApi chaptersApi;
     private final EpisodesApi episodesApi;
-    private final FollowApi followApi;
-    private final LibraryApi libraryApi;
+    private final GenresApi genresApi;
     private final MarketsApi marketsApi;
-    private final PersonalizationApi personalizationApi;
     private final PlayerApi playerApi;
     private final PlaylistsApi playlistsApi;
     private final SearchApi searchApi;
     private final ShowsApi showsApi;
     private final TracksApi tracksApi;
-    private final UsersProfileApi usersProfileApi;
+    private final UsersApi usersApi;
 
     SpotifyWebApi(ApiClient apiClient) {
         this.albumsApi = new AlbumsApi(apiClient);
         this.artistsApi = new ArtistsApi(apiClient);
         this.audiobooksApi = new AudiobooksApi(apiClient);
-        this.browseApi = new BrowseApi(apiClient);
+        this.categoriesApi = new CategoriesApi(apiClient);
         this.chaptersApi = new ChaptersApi(apiClient);
         this.episodesApi = new EpisodesApi(apiClient);
-        this.followApi = new FollowApi(apiClient);
-        this.libraryApi = new LibraryApi(apiClient);
+        this.genresApi = new GenresApi(apiClient);
         this.marketsApi = new MarketsApi(apiClient);
-        this.personalizationApi = new PersonalizationApi(apiClient);
         this.playerApi = new PlayerApi(apiClient);
         this.playlistsApi = new PlaylistsApi(apiClient);
         this.searchApi = new SearchApi(apiClient);
         this.showsApi = new ShowsApi(apiClient);
         this.tracksApi = new TracksApi(apiClient);
-        this.usersProfileApi = new UsersProfileApi(apiClient);
+        this.usersApi = new UsersApi(apiClient);
     }
 
     public static SpotifyWebApiBuilder builder() {

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

@@ -11,6 +11,16 @@
 public class AlbumsApi {
     private final ApiClient apiClient;
 
+    /**
+     * <h4>Check User's Saved Albums</h4>
+     * <p>Check if one or more albums is already saved in the current Spotify user's 'Your Music' library.</p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify IDs</a> for the albums. Maximum: 20 IDs.</p>
+     * @return a {@link CheckUsersSavedAlbumsRequest} object to build and execute the request
+     */
+    public CheckUsersSavedAlbumsRequest checkUsersSavedAlbums(String ids) {
+        return new CheckUsersSavedAlbumsRequest(apiClient, ids);
+    }
+
     /**
      * <h4>Get Album</h4>
      * <p>Get Spotify catalog information for a single album.</p>
@@ -40,4 +50,42 @@ public GetAlbumsTracksRequest getAlbumsTracks(String id) {
     public GetMultipleAlbumsRequest getMultipleAlbums(String ids) {
         return new GetMultipleAlbumsRequest(apiClient, ids);
     }
+
+    /**
+     * <h4>Get New Releases</h4>
+     * <p>Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).</p>
+     * @return a {@link GetNewReleasesRequest} object to build and execute the request
+     */
+    public GetNewReleasesRequest getNewReleases() {
+        return new GetNewReleasesRequest(apiClient);
+    }
+
+    /**
+     * <h4>Get User's Saved Albums</h4>
+     * <p>Get a list of the albums saved in the current Spotify user's 'Your Music' library.</p>
+     * @return a {@link GetUsersSavedAlbumsRequest} object to build and execute the request
+     */
+    public GetUsersSavedAlbumsRequest getUsersSavedAlbums() {
+        return new GetUsersSavedAlbumsRequest(apiClient);
+    }
+
+    /**
+     * <h4>Remove Users' Saved Albums</h4>
+     * <p>Remove one or more albums from the current user's 'Your Music' library.</p>
+     * @param ids <p>A JSON array of the <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify IDs</a>. For example: <code>[&quot;4iV5W9uYEdYUVa79Axb7Rh&quot;, &quot;1301WleyT98MSxVHPZCA6M&quot;]</code><br/>A maximum of 50 items can be specified in one request. <em><strong>Note</strong>: 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 RemoveAlbumsUserRequest} object to build and execute the request
+     */
+    public RemoveAlbumsUserRequest removeAlbumsUser(java.util.List<String> ids) {
+        return new RemoveAlbumsUserRequest(apiClient, ids);
+    }
+
+    /**
+     * <h4>Save Albums for Current User</h4>
+     * <p>Save one or more albums to the current user's 'Your Music' library.</p>
+     * @param ids <p>A JSON array of the <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify IDs</a>. For example: <code>[&quot;4iV5W9uYEdYUVa79Axb7Rh&quot;, &quot;1301WleyT98MSxVHPZCA6M&quot;]</code><br/>A maximum of 50 items can be specified in one request. <em><strong>Note</strong>: 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 SaveAlbumsUserRequest} object to build and execute the request
+     */
+    public SaveAlbumsUserRequest saveAlbumsUser(java.util.List<String> ids) {
+        return new SaveAlbumsUserRequest(apiClient, ids);
+    }
 }

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

@@ -11,6 +11,16 @@
 public class AudiobooksApi {
     private final ApiClient apiClient;
 
+    /**
+     * <h4>Check User's Saved Audiobooks</h4>
+     * <p>Check if one or more audiobooks are already saved in the current Spotify user's library.</p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify IDs</a>. For example: <code>ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ</code>. Maximum: 50 IDs.</p>
+     * @return a {@link CheckUsersSavedAudiobooksRequest} object to build and execute the request
+     */
+    public CheckUsersSavedAudiobooksRequest checkUsersSavedAudiobooks(String ids) {
+        return new CheckUsersSavedAudiobooksRequest(apiClient, ids);
+    }
+
     /**
      * <h4>Get an Audiobook</h4>
      * <p>Get Spotify catalog information for a single audiobook.<br><strong>Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.</strong></p>
@@ -40,4 +50,33 @@ public GetAudiobookChaptersRequest getAudiobookChapters(String id) {
     public GetMultipleAudiobooksRequest getMultipleAudiobooks(String ids) {
         return new GetMultipleAudiobooksRequest(apiClient, ids);
     }
+
+    /**
+     * <h4>Get User's Saved Audiobooks</h4>
+     * <p>Get a list of the audiobooks saved in the current Spotify user's 'Your Music' library.</p>
+     * @return a {@link GetUsersSavedAudiobooksRequest} object to build and execute the request
+     */
+    public GetUsersSavedAudiobooksRequest getUsersSavedAudiobooks() {
+        return new GetUsersSavedAudiobooksRequest(apiClient);
+    }
+
+    /**
+     * <h4>Remove User's Saved Audiobooks</h4>
+     * <p>Remove one or more audiobooks from the Spotify user's library.</p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify IDs</a>. For example: <code>ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ</code>. Maximum: 50 IDs.</p>
+     * @return a {@link RemoveAudiobooksUserRequest} object to build and execute the request
+     */
+    public RemoveAudiobooksUserRequest removeAudiobooksUser(String ids) {
+        return new RemoveAudiobooksUserRequest(apiClient, ids);
+    }
+
+    /**
+     * <h4>Save Audiobooks for Current User</h4>
+     * <p>Save one or more audiobooks to the current Spotify user's library.</p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify IDs</a>. For example: <code>ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ</code>. Maximum: 50 IDs.</p>
+     * @return a {@link SaveAudiobooksUserRequest} object to build and execute the request
+     */
+    public SaveAudiobooksUserRequest saveAudiobooksUser(String ids) {
+        return new SaveAudiobooksUserRequest(apiClient, ids);
+    }
 }

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

@@ -0,0 +1,32 @@
+package de.sonallux.spotify.api.apis;
+
+import de.sonallux.spotify.api.http.ApiClient;
+import de.sonallux.spotify.api.apis.categories.*;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Categories
+ */
+@RequiredArgsConstructor
+public class CategoriesApi {
+    private final ApiClient apiClient;
+
+    /**
+     * <h4>Get Several Browse Categories</h4>
+     * <p>Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p>
+     * @return a {@link GetCategoriesRequest} object to build and execute the request
+     */
+    public GetCategoriesRequest getCategories() {
+        return new GetCategoriesRequest(apiClient);
+    }
+
+    /**
+     * <h4>Get Single Browse Category</h4>
+     * <p>Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p>
+     * @param categoryId <p>The <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify category ID</a> for the category.</p>
+     * @return a {@link GetCategoryRequest} object to build and execute the request
+     */
+    public GetCategoryRequest getCategory(String categoryId) {
+        return new GetCategoryRequest(apiClient, categoryId);
+    }
+}