Skip to content

Commit

Permalink
Automated update of fixed-spotify-open-api.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
sonallux authored and github-actions[bot] committed Jul 24, 2024
1 parent 5793045 commit dfabd11
Show file tree
Hide file tree
Showing 11 changed files with 704 additions and 689 deletions.
1,349 changes: 679 additions & 670 deletions spotify-web-api-java-generator/fixed-spotify-open-api.yml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ public CheckCurrentUserFollowsRequest checkCurrentUserFollows(String type, Strin
}

/**
* <h4>Check if Users Follow Playlist</h4>
* <p>Check to see if one or more Spotify users are following a specified playlist.</p>
* <h4>Check if Current User Follows Playlist</h4>
* <p>Check to see if the current user is following a specified playlist.</p>
* @param playlistId <p>The <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify ID</a> of the playlist.</p>
* @param ids <p>A comma-separated list of <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify User IDs</a> ; the ids of the users that you want to check to see if they follow the playlist. Maximum: 5 ids.</p>
* @return a {@link CheckIfUserFollowsPlaylistRequest} object to build and execute the request
*/
public CheckIfUserFollowsPlaylistRequest checkIfUserFollowsPlaylist(String playlistId, String ids) {
return new CheckIfUserFollowsPlaylistRequest(apiClient, playlistId, ids);
public CheckIfUserFollowsPlaylistRequest checkIfUserFollowsPlaylist(String playlistId) {
return new CheckIfUserFollowsPlaylistRequest(apiClient, playlistId);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public ChangePlaylistDetailsRequest name(String name) {
}

/**
* @param _public <p>If <code>true</code> the playlist will be public, if <code>false</code> it will be private.</p>
* @param _public <p>The playlist's public/private status (if it should be added to the user's profile or not): <code>true</code> the playlist will be public, <code>false</code> the playlist will be private, <code>null</code> the playlist status is not relevant. For more about public/private status, see <a href="https://developer.spotify.com/documentation/web-api/concepts/playlists">Working with Playlists</a></p>
* @return this request
*/
public ChangePlaylistDetailsRequest _public(boolean _public) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public CreatePlaylistRequest(ApiClient apiClient, String userId, String name) {
}

/**
* @param _public <p>Defaults to <code>true</code>. If <code>true</code> the playlist will be public, if <code>false</code> it will be private. To be able to create private playlists, the user must have granted the <code>playlist-modify-private</code> <a href="https://developer.spotify.com/documentation/web-api/concepts/scopes/#list-of-scopes">scope</a></p>
* @param _public <p>Defaults to <code>true</code>. The playlist's public/private status (if it should be added to the user's profile or not): <code>true</code> the playlist will be public, <code>false</code> the playlist will be private. To be able to create private playlists, the user must have granted the <code>playlist-modify-private</code> <a href="https://developer.spotify.com/documentation/web-api/concepts/scopes/#list-of-scopes">scope</a>. For more about public/private status, see <a href="https://developer.spotify.com/documentation/web-api/concepts/playlists">Working with Playlists</a></p>
* @return this request
*/
public CreatePlaylistRequest _public(boolean _public) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,37 @@
import de.sonallux.spotify.api.models.*;

/**
* <h2>Check if Users Follow Playlist request</h2>
* <h2>Check if Current User Follows Playlist request</h2>
*
* <h3>Response</h3>
* <p>Array of booleans</p>
* <p>Array of boolean, containing a single boolean</p>
*/
public class CheckIfUserFollowsPlaylistRequest {
private static final TypeReference<java.util.List<Boolean>> RESPONSE_TYPE = new TypeReference<>() {};
private final ApiClient apiClient;
private final Request request;

/**
* Check if Users Follow Playlist request
* Check if Current User Follows Playlist request
* @param apiClient <p>The API client</p>
* @param playlistId <p>The <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify ID</a> of the playlist.</p>
* @param ids <p>A comma-separated list of <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify User IDs</a> ; the ids of the users that you want to check to see if they follow the playlist. Maximum: 5 ids.</p>
*/
public CheckIfUserFollowsPlaylistRequest(ApiClient apiClient, String playlistId, String ids) {
public CheckIfUserFollowsPlaylistRequest(ApiClient apiClient, String playlistId) {
this.apiClient = apiClient;
this.request = new Request("GET", "/playlists/{playlist_id}/followers/contains")
.addPathParameter("playlist_id", String.valueOf(playlistId))
.addQueryParameter("ids", String.valueOf(ids))
;
}

/**
* @param ids <p><strong>Deprecated</strong> A single item list containing current user's <a href="https://developer.spotify.com/documentation/web-api/concepts/spotify-uris-ids">Spotify Username</a>. Maximum: 1 id.</p>
* @return this request
*/
public CheckIfUserFollowsPlaylistRequest ids(String ids) {
this.request.addQueryParameter("ids", String.valueOf(ids));
return this;
}

/**
* Build the request into an executable api call
* @return an executable api call
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public FollowPlaylistRequest(ApiClient apiClient, String playlistId) {
}

/**
* @param _public <p>Defaults to <code>true</code>. If <code>true</code> the playlist will be included in user's public playlists, if <code>false</code> it will remain private.</p>
* @param _public <p>Defaults to <code>true</code>. If <code>true</code> the playlist will be included in user's public playlists (added to profile), if <code>false</code> it will remain private. For more about public/private status, see <a href="https://developer.spotify.com/documentation/web-api/concepts/playlists">Working with Playlists</a></p>
* @return this request
*/
public FollowPlaylistRequest _public(boolean _public) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public GetUsersTopArtistsRequest(ApiClient apiClient) {
}

/**
* @param timeRange <p>Over what time frame the affinities are computed. Valid values: <code>long_term</code> (calculated from several years of data and including all new data as it becomes available), <code>medium_term</code> (approximately last 6 months), <code>short_term</code> (approximately last 4 weeks). Default: <code>medium_term</code></p>
* @param timeRange <p>Over what time frame the affinities are computed. Valid values: <code>long_term</code> (calculated from ~1 year of data and including all new data as it becomes available), <code>medium_term</code> (approximately last 6 months), <code>short_term</code> (approximately last 4 weeks). Default: <code>medium_term</code></p>
* @return this request
*/
public GetUsersTopArtistsRequest timeRange(String timeRange) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public GetUsersTopTracksRequest(ApiClient apiClient) {
}

/**
* @param timeRange <p>Over what time frame the affinities are computed. Valid values: <code>long_term</code> (calculated from several years of data and including all new data as it becomes available), <code>medium_term</code> (approximately last 6 months), <code>short_term</code> (approximately last 4 weeks). Default: <code>medium_term</code></p>
* @param timeRange <p>Over what time frame the affinities are computed. Valid values: <code>long_term</code> (calculated from ~1 year of data and including all new data as it becomes available), <code>medium_term</code> (approximately last 6 months), <code>short_term</code> (approximately last 4 weeks). Default: <code>medium_term</code></p>
* @return this request
*/
public GetUsersTopTracksRequest timeRange(String timeRange) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public class CurrentlyPlayingContext {
*/
public boolean shuffleState;
/**
* <p>Unix Millisecond Timestamp when data was fetched.</p>
* <p>Unix Millisecond Timestamp when playback state was last changed (play, pause, skip, scrub, new song, etc.).</p>
*/
public long timestamp;
}
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class Playlist extends BaseObject {
*/
public PlaylistOwner owner;
/**
* <p>The playlist's public/private status: <code>true</code> the playlist is public, <code>false</code> the playlist is private, <code>null</code> the playlist status is not relevant. For more about public/private status, see <a href="https://developer.spotify.com/documentation/web-api/concepts/playlists">Working with Playlists</a></p>
* <p>The playlist's public/private status (if it is added to the user's profile): <code>true</code> the playlist is public, <code>false</code> the playlist is private, <code>null</code> the playlist status is not relevant. For more about public/private status, see <a href="https://developer.spotify.com/documentation/web-api/concepts/playlists">Working with Playlists</a></p>
*/
@lombok.experimental.Accessors(prefix = "_")
public boolean _public;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public class SimplifiedPlaylist extends BaseObject {
*/
public PlaylistOwner owner;
/**
* <p>The playlist's public/private status: <code>true</code> the playlist is public, <code>false</code> the playlist is private, <code>null</code> the playlist status is not relevant. For more about public/private status, see <a href="https://developer.spotify.com/documentation/web-api/concepts/playlists">Working with Playlists</a></p>
* <p>The playlist's public/private status (if it is added to the user's profile): <code>true</code> the playlist is public, <code>false</code> the playlist is private, <code>null</code> the playlist status is not relevant. For more about public/private status, see <a href="https://developer.spotify.com/documentation/web-api/concepts/playlists">Working with Playlists</a></p>
*/
@lombok.experimental.Accessors(prefix = "_")
public boolean _public;
Expand Down

0 comments on commit dfabd11

Please sign in to comment.