Automated update of fixed-spotify-open-api.yml (#244)

Author: sonallux

spotify-web-api-java-generator/fixed-spotify-open-api.yml

@@ -23,7 +23,7 @@ public CheckUsersSavedAudiobooksRequest checkUsersSavedAudiobooks(String 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>
+     * <p>Get Spotify catalog information for a single audiobook. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.</p>
      * @param id <p>The <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify ID</a>for the audiobook.</p>
      * @return a {@link GetAudiobookRequest} object to build and execute the request
      */
@@ -33,7 +33,7 @@ public GetAudiobookRequest getAudiobook(String id) {
 
     /**
      * <h4>Get Audiobook Chapters</h4>
-     * <p>Get Spotify catalog information about an audiobook's chapters.<br><strong>Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.</strong></p>
+     * <p>Get Spotify catalog information about an audiobook's chapters. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.</p>
      * @param id <p>The <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify ID</a>for the audiobook.</p>
      * @return a {@link GetAudiobookChaptersRequest} object to build and execute the request
      */
@@ -43,7 +43,7 @@ public GetAudiobookChaptersRequest getAudiobookChapters(String id) {
 
     /**
      * <h4>Get Several Audiobooks</h4>
-     * <p>Get Spotify catalog information for several audiobooks identified by their Spotify IDs.<br><strong>Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.</strong></p>
+     * <p>Get Spotify catalog information for several audiobooks identified by their Spotify IDs. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.</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 GetMultipleAudiobooksRequest} object to build and execute the request
      */

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

@@ -13,7 +13,7 @@ public class ChaptersApi {
 
     /**
      * <h4>Get a Chapter</h4>
-     * <p>Get Spotify catalog information for a single chapter.<br><strong>Note: Chapters are only available for the US, UK, Ireland, New Zealand and Australia markets.</strong></p>
+     * <p>Get Spotify catalog information for a single audiobook chapter. Chapters are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.</p>
      * @param id <p>The <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify ID</a>for the chapter.</p>
      * @return a {@link GetChapterRequest} object to build and execute the request
      */
@@ -23,7 +23,7 @@ public GetChapterRequest getChapter(String id) {
 
     /**
      * <h4>Get Several Chapters</h4>
-     * <p>Get Spotify catalog information for several chapters identified by their Spotify IDs.<br><strong>Note: Chapters are only available for the US, UK, Ireland, New Zealand and Australia markets.</strong></p>
+     * <p>Get Spotify catalog information for several audiobook chapters identified by their Spotify IDs. Chapters are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.</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=0IsXVP0JmcB2adSE338GkK,3ZXb8FKZGU0EHALYX6uCzU</code>. Maximum: 50 IDs.</p>
      * @return a {@link GetSeveralChaptersRequest} object to build and execute the request
      */

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

@@ -13,7 +13,7 @@ public class PlayerApi {
 
     /**
      * <h4>Add Item to Playback Queue</h4>
-     * <p>Add an item to the end of the user's current playback queue.</p>
+     * <p>Add an item to the end of the user's current playback queue. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @param uri <p>The uri of the item to add to the queue. Must be a track or an episode uri.</p>
      * @return a {@link AddToQueueRequest} object to build and execute the request
      */
@@ -50,7 +50,7 @@ public GetRecentlyPlayedRequest getRecentlyPlayed() {
 
     /**
      * <h4>Get Available Devices</h4>
-     * <p>Get information about a user’s available devices.</p>
+     * <p>Get information about a user’s available Spotify Connect devices. Some device models are not supported and will not be listed in the API response.</p>
      * @return a {@link GetUsersAvailableDevicesRequest} object to build and execute the request
      */
     public GetUsersAvailableDevicesRequest getUsersAvailableDevices() {
@@ -68,7 +68,7 @@ public GetUsersCurrentlyPlayingTrackRequest getUsersCurrentlyPlayingTrack() {
 
     /**
      * <h4>Pause Playback</h4>
-     * <p>Pause playback on the user's account.</p>
+     * <p>Pause playback on the user's account. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @return a {@link PauseUsersPlaybackRequest} object to build and execute the request
      */
     public PauseUsersPlaybackRequest pauseUsersPlayback() {
@@ -77,7 +77,7 @@ public PauseUsersPlaybackRequest pauseUsersPlayback() {
 
     /**
      * <h4>Seek To Position</h4>
-     * <p>Seeks to the given position in the user’s currently playing track.</p>
+     * <p>Seeks to the given position in the user’s currently playing track. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @param positionMs <p>The position in milliseconds to seek to. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.</p>
      * @return a {@link SeekToPositionInCurrentlyPlayingTrackRequest} object to build and execute the request
      */
@@ -87,7 +87,7 @@ public SeekToPositionInCurrentlyPlayingTrackRequest seekToPositionInCurrentlyPla
 
     /**
      * <h4>Set Repeat Mode</h4>
-     * <p>Set the repeat mode for the user's playback. Options are repeat-track, repeat-context, and off.</p>
+     * <p>Set the repeat mode for the user's playback. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @param state <p><strong>track</strong>, <strong>context</strong> or <strong>off</strong>.<br/><strong>track</strong> will repeat the current track.<br/><strong>context</strong> will repeat the current context.<br/><strong>off</strong> will turn repeat off.</p>
      * @return a {@link SetRepeatModeOnUsersPlaybackRequest} object to build and execute the request
      */
@@ -97,7 +97,7 @@ public SetRepeatModeOnUsersPlaybackRequest setRepeatModeOnUsersPlayback(String s
 
     /**
      * <h4>Set Playback Volume</h4>
-     * <p>Set the volume for the user’s current playback device.</p>
+     * <p>Set the volume for the user’s current playback device. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @param volumePercent <p>The volume to set. Must be a value from 0 to 100 inclusive.</p>
      * @return a {@link SetVolumeForUsersPlaybackRequest} object to build and execute the request
      */
@@ -107,7 +107,7 @@ public SetVolumeForUsersPlaybackRequest setVolumeForUsersPlayback(int volumePerc
 
     /**
      * <h4>Skip To Next</h4>
-     * <p>Skips to next track in the user’s queue.</p>
+     * <p>Skips to next track in the user’s queue. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @return a {@link SkipUsersPlaybackToNextTrackRequest} object to build and execute the request
      */
     public SkipUsersPlaybackToNextTrackRequest skipUsersPlaybackToNextTrack() {
@@ -116,7 +116,7 @@ public SkipUsersPlaybackToNextTrackRequest skipUsersPlaybackToNextTrack() {
 
     /**
      * <h4>Skip To Previous</h4>
-     * <p>Skips to previous track in the user’s queue.</p>
+     * <p>Skips to previous track in the user’s queue. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @return a {@link SkipUsersPlaybackToPreviousTrackRequest} object to build and execute the request
      */
     public SkipUsersPlaybackToPreviousTrackRequest skipUsersPlaybackToPreviousTrack() {
@@ -125,7 +125,7 @@ public SkipUsersPlaybackToPreviousTrackRequest skipUsersPlaybackToPreviousTrack(
 
     /**
      * <h4>Start/Resume Playback</h4>
-     * <p>Start a new context or resume current playback on the user's active device.</p>
+     * <p>Start a new context or resume current playback on the user's active device. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @return a {@link StartUsersPlaybackRequest} object to build and execute the request
      */
     public StartUsersPlaybackRequest startUsersPlayback() {
@@ -134,7 +134,7 @@ public StartUsersPlaybackRequest startUsersPlayback() {
 
     /**
      * <h4>Toggle Playback Shuffle</h4>
-     * <p>Toggle shuffle on or off for user’s playback.</p>
+     * <p>Toggle shuffle on or off for user’s playback. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @param state <p><strong>true</strong> : Shuffle user's playback.<br/><strong>false</strong> : Do not shuffle user's playback.</p>
      * @return a {@link ToggleShuffleForUsersPlaybackRequest} object to build and execute the request
      */
@@ -144,7 +144,7 @@ public ToggleShuffleForUsersPlaybackRequest toggleShuffleForUsersPlayback(boolea
 
     /**
      * <h4>Transfer Playback</h4>
-     * <p>Transfer playback to a new device and determine if it should start playing.</p>
+     * <p>Transfer playback to a new device and optionally begin playback. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.</p>
      * @param deviceIds <p>A JSON array containing the ID of the device on which playback should be started/transferred.<br/>For example:<code>{device_ids:[&quot;74ASZWbe4lXaubB36ztrGX&quot;]}</code><br/><em><strong>Note</strong>: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return <code>400 Bad Request</code></em></p>
      * @return a {@link TransferUsersPlaybackRequest} object to build and execute the request
      */

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

@@ -34,7 +34,7 @@ public ChangePlaylistDetailsRequest changePlaylistDetails(String playlistId) {
 
     /**
      * <h4>Create Playlist</h4>
-     * <p>Create a playlist for a Spotify user. (The playlist will be empty until you <a href="https://developer.spotify.com/documentation/web-api/reference/add-tracks-to-playlist">add tracks</a>.)</p>
+     * <p>Create a playlist for a Spotify user. (The playlist will be empty until you <a href="https://developer.spotify.com/documentation/web-api/reference/add-tracks-to-playlist">add tracks</a>.) Each user is generally limited to a maximum of 11000 playlists.</p>
      * @param userId <p>The user's <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify user ID</a>.</p>
      * @param name <p>The name for the new playlist, for example <code>&quot;Your Coolest Playlist&quot;</code>. This name does not need to be unique; a user may have several playlists with the same name.</p>
      * @return a {@link CreatePlaylistRequest} object to build and execute the request

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

@@ -13,7 +13,7 @@ public class SearchApi {
 
     /**
      * <h4>Search for Item</h4>
-     * <p>Get Spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks that match a keyword string.<br><strong>Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.</strong></p>
+     * <p>Get Spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks that match a keyword string. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.</p>
      * @param q <p>Your search query.</p><p>You can narrow down your search using field filters. The available filters are <code>album</code>, <code>artist</code>, <code>track</code>, <code>year</code>, <code>upc</code>, <code>tag:hipster</code>, <code>tag:new</code>, <code>isrc</code>, and <code>genre</code>. Each field filter only applies to certain result types.</p><p>The <code>artist</code> and <code>year</code> filters can be used while searching albums, artists and tracks. You can filter on a single <code>year</code> or a range (e.g. 1955-1960).<br>The <code>album</code> filter can be used while searching albums and tracks.<br>The <code>genre</code> filter can be used while searching artists and tracks.<br>The <code>isrc</code> and <code>track</code> filters can be used while searching tracks.<br>The <code>upc</code>, <code>tag:new</code> and <code>tag:hipster</code> filters can only be used while searching albums. The <code>tag:new</code> filter will return albums released in the past two weeks and <code>tag:hipster</code> can be used to return only albums with the lowest 10% popularity.<br></p>
      * @param type <p>A comma-separated list of item types to search across. Search results include hits from all the specified item types. For example: <code>q=abacab&amp;type=album,track</code> returns both albums and tracks matching &quot;abacab&quot;.</p>
      * @return a {@link SearchRequest} object to build and execute the request

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

@@ -10,7 +10,7 @@
  * <h2>Get the User's Queue request</h2>
  *
  * <h3>Required OAuth scopes</h3>
- * <code>user-read-playback-state</code>
+ * <code>user-read-currently-playing, user-read-playback-state</code>
  *
  * <h3>Response</h3>
  * <p>Information about the queue</p>

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

@@ -16,7 +16,7 @@
  * <p>A set of devices</p>
  */
 public class GetUsersAvailableDevicesRequest {
-    private static final TypeReference<Devices> RESPONSE_TYPE = new TypeReference<>() {};
+    private static final TypeReference<ManyDevices> RESPONSE_TYPE = new TypeReference<>() {};
     private final ApiClient apiClient;
     private final Request request;
 
@@ -34,7 +34,7 @@ public GetUsersAvailableDevicesRequest(ApiClient apiClient) {
      * Build the request into an executable api call
      * @return an executable api call
      */
-    public ApiCall<Devices> build() {
+    public ApiCall<ManyDevices> build() {
         return apiClient.createApiCall(request, RESPONSE_TYPE);
     }
 }

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

@@ -9,6 +9,10 @@
 @Setter
 @NoArgsConstructor
 public class CurrentlyPlaying {
+    /**
+     * <p>Allows to update the user interface based on which playback actions are available within the current context.</p>
+     */
+    public Disallows actions;
     /**
      * <p>A Context Object. Can be <code>null</code>.</p>
      */

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

@@ -10,7 +10,7 @@
 @NoArgsConstructor
 public class Device {
     /**
-     * <p>The device ID.</p>
+     * <p>The device ID. This ID is unique and persistent to some extent. However, this is not guaranteed and any cached <code>device_id</code> should periodically be cleared out and refetched as necessary.</p>
      */
     public String id;
     /**

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

@@ -3,14 +3,11 @@
 import lombok.*;
 
 /**
- * DevicesObject
+ * ManyDevices
  */
 @Getter
 @Setter
 @NoArgsConstructor
-public class Devices {
-    /**
-     * <p>A list of 0..n Device objects</p>
-     */
+public class ManyDevices {
     public java.util.List<Device> devices;
 }