spotted 0.24.0 → 0.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +1 -1
- data/lib/spotted/internal/type/base_model.rb +1 -0
- data/lib/spotted/models/album_bulk_retrieve_response.rb +26 -2
- data/lib/spotted/models/album_restriction_object.rb +13 -1
- data/lib/spotted/models/album_retrieve_response.rb +26 -2
- data/lib/spotted/models/artist_list_albums_response.rb +13 -1
- data/lib/spotted/models/artist_object.rb +13 -1
- data/lib/spotted/models/audio_analysis_retrieve_response.rb +39 -3
- data/lib/spotted/models/audio_feature_bulk_retrieve_response.rb +13 -1
- data/lib/spotted/models/audio_feature_retrieve_response.rb +13 -1
- data/lib/spotted/models/audiobook_base.rb +13 -1
- data/lib/spotted/models/audiobook_bulk_retrieve_response.rb +13 -1
- data/lib/spotted/models/audiobook_retrieve_response.rb +13 -1
- data/lib/spotted/models/author_object.rb +13 -1
- data/lib/spotted/models/browse/category_get_playlists_response.rb +13 -1
- data/lib/spotted/models/browse/category_list_response.rb +26 -2
- data/lib/spotted/models/browse/category_retrieve_response.rb +13 -1
- data/lib/spotted/models/browse_get_featured_playlists_response.rb +13 -1
- data/lib/spotted/models/browse_get_new_releases_response.rb +26 -2
- data/lib/spotted/models/chapter_bulk_retrieve_response.rb +13 -1
- data/lib/spotted/models/chapter_restriction_object.rb +13 -1
- data/lib/spotted/models/chapter_retrieve_response.rb +13 -1
- data/lib/spotted/models/copyright_object.rb +13 -1
- data/lib/spotted/models/episode_object.rb +13 -1
- data/lib/spotted/models/episode_restriction_object.rb +13 -1
- data/lib/spotted/models/external_id_object.rb +13 -1
- data/lib/spotted/models/external_url_object.rb +13 -1
- data/lib/spotted/models/followers_object.rb +13 -1
- data/lib/spotted/models/image_object.rb +13 -1
- data/lib/spotted/models/linked_track_object.rb +13 -1
- data/lib/spotted/models/me/album_list_response.rb +39 -3
- data/lib/spotted/models/me/album_remove_params.rb +13 -1
- data/lib/spotted/models/me/album_save_params.rb +13 -1
- data/lib/spotted/models/me/audiobook_list_response.rb +26 -2
- data/lib/spotted/models/me/context_object.rb +13 -1
- data/lib/spotted/models/me/device_object.rb +13 -1
- data/lib/spotted/models/me/episode_list_response.rb +13 -1
- data/lib/spotted/models/me/episode_remove_params.rb +13 -1
- data/lib/spotted/models/me/episode_save_params.rb +13 -1
- data/lib/spotted/models/me/following_bulk_retrieve_response.rb +30 -2
- data/lib/spotted/models/me/following_follow_params.rb +13 -1
- data/lib/spotted/models/me/following_unfollow_params.rb +13 -1
- data/lib/spotted/models/me/player/queue_get_response.rb +16 -1
- data/lib/spotted/models/me/player_get_currently_playing_response.rb +30 -2
- data/lib/spotted/models/me/player_get_state_response.rb +29 -2
- data/lib/spotted/models/me/player_list_recently_played_response.rb +16 -1
- data/lib/spotted/models/me/player_start_playback_params.rb +13 -1
- data/lib/spotted/models/me/player_transfer_params.rb +13 -1
- data/lib/spotted/models/me/show_list_response.rb +13 -1
- data/lib/spotted/models/me/show_remove_params.rb +13 -1
- data/lib/spotted/models/me/show_save_params.rb +13 -1
- data/lib/spotted/models/me/track_list_response.rb +13 -1
- data/lib/spotted/models/me/track_remove_params.rb +13 -1
- data/lib/spotted/models/me/track_save_params.rb +13 -1
- data/lib/spotted/models/me_retrieve_response.rb +26 -2
- data/lib/spotted/models/narrator_object.rb +13 -1
- data/lib/spotted/models/paging_playlist_object.rb +13 -1
- data/lib/spotted/models/playlist_retrieve_response.rb +18 -5
- data/lib/spotted/models/playlist_track_object.rb +13 -1
- data/lib/spotted/models/playlist_tracks_ref_object.rb +13 -1
- data/lib/spotted/models/playlist_update_params.rb +13 -1
- data/lib/spotted/models/playlist_user_object.rb +13 -1
- data/lib/spotted/models/playlists/follower_follow_params.rb +13 -1
- data/lib/spotted/models/playlists/track_add_params.rb +13 -1
- data/lib/spotted/models/playlists/track_remove_params.rb +13 -1
- data/lib/spotted/models/playlists/track_update_params.rb +13 -1
- data/lib/spotted/models/recommendation_get_response.rb +26 -2
- data/lib/spotted/models/resume_point_object.rb +13 -1
- data/lib/spotted/models/search_query_response.rb +91 -7
- data/lib/spotted/models/show_base.rb +13 -1
- data/lib/spotted/models/show_retrieve_response.rb +13 -1
- data/lib/spotted/models/simplified_artist_object.rb +13 -1
- data/lib/spotted/models/simplified_chapter_object.rb +13 -1
- data/lib/spotted/models/simplified_episode_object.rb +13 -1
- data/lib/spotted/models/simplified_playlist_object.rb +5 -4
- data/lib/spotted/models/simplified_track_object.rb +13 -1
- data/lib/spotted/models/time_interval_object.rb +16 -1
- data/lib/spotted/models/track_object.rb +26 -2
- data/lib/spotted/models/track_restriction_object.rb +13 -1
- data/lib/spotted/models/user_retrieve_profile_response.rb +13 -1
- data/lib/spotted/models/users/playlist_create_params.rb +13 -1
- data/lib/spotted/models/users/playlist_create_response.rb +18 -5
- data/lib/spotted/resources/me/albums.rb +6 -2
- data/lib/spotted/resources/me/episodes.rb +6 -2
- data/lib/spotted/resources/me/following.rb +6 -2
- data/lib/spotted/resources/me/player.rb +6 -2
- data/lib/spotted/resources/me/shows.rb +6 -2
- data/lib/spotted/resources/me/tracks.rb +6 -2
- data/lib/spotted/resources/playlists/followers.rb +3 -1
- data/lib/spotted/resources/playlists/tracks.rb +9 -3
- data/lib/spotted/resources/playlists.rb +3 -1
- data/lib/spotted/resources/users/playlists.rb +3 -1
- data/lib/spotted/version.rb +1 -1
- data/rbi/spotted/models/album_bulk_retrieve_response.rbi +41 -3
- data/rbi/spotted/models/album_restriction_object.rbi +22 -1
- data/rbi/spotted/models/album_retrieve_response.rbi +41 -3
- data/rbi/spotted/models/artist_list_albums_response.rbi +19 -0
- data/rbi/spotted/models/artist_object.rbi +19 -0
- data/rbi/spotted/models/audio_analysis_retrieve_response.rbi +57 -0
- data/rbi/spotted/models/audio_feature_bulk_retrieve_response.rbi +19 -0
- data/rbi/spotted/models/audio_feature_retrieve_response.rbi +19 -0
- data/rbi/spotted/models/audiobook_base.rbi +20 -1
- data/rbi/spotted/models/audiobook_bulk_retrieve_response.rbi +22 -3
- data/rbi/spotted/models/audiobook_retrieve_response.rbi +22 -3
- data/rbi/spotted/models/author_object.rbi +22 -3
- data/rbi/spotted/models/browse/category_get_playlists_response.rbi +25 -3
- data/rbi/spotted/models/browse/category_list_response.rbi +44 -6
- data/rbi/spotted/models/browse/category_retrieve_response.rbi +22 -3
- data/rbi/spotted/models/browse_get_featured_playlists_response.rbi +25 -3
- data/rbi/spotted/models/browse_get_new_releases_response.rbi +41 -3
- data/rbi/spotted/models/chapter_bulk_retrieve_response.rbi +19 -0
- data/rbi/spotted/models/chapter_restriction_object.rbi +21 -2
- data/rbi/spotted/models/chapter_retrieve_response.rbi +19 -0
- data/rbi/spotted/models/copyright_object.rbi +25 -2
- data/rbi/spotted/models/episode_object.rbi +19 -0
- data/rbi/spotted/models/episode_restriction_object.rbi +21 -2
- data/rbi/spotted/models/external_id_object.rbi +28 -2
- data/rbi/spotted/models/external_url_object.rbi +21 -2
- data/rbi/spotted/models/followers_object.rbi +27 -4
- data/rbi/spotted/models/image_object.rbi +26 -3
- data/rbi/spotted/models/linked_track_object.rbi +19 -0
- data/rbi/spotted/models/me/album_list_response.rbi +63 -6
- data/rbi/spotted/models/me/album_remove_params.rbi +23 -1
- data/rbi/spotted/models/me/album_save_params.rbi +23 -1
- data/rbi/spotted/models/me/audiobook_list_response.rbi +44 -6
- data/rbi/spotted/models/me/context_object.rbi +19 -0
- data/rbi/spotted/models/me/device_object.rbi +19 -0
- data/rbi/spotted/models/me/episode_list_response.rbi +27 -3
- data/rbi/spotted/models/me/episode_remove_params.rbi +23 -1
- data/rbi/spotted/models/me/episode_save_params.rbi +23 -1
- data/rbi/spotted/models/me/following_bulk_retrieve_response.rbi +47 -3
- data/rbi/spotted/models/me/following_follow_params.rbi +23 -1
- data/rbi/spotted/models/me/following_unfollow_params.rbi +23 -1
- data/rbi/spotted/models/me/player/queue_get_response.rbi +19 -0
- data/rbi/spotted/models/me/player_get_currently_playing_response.rbi +38 -0
- data/rbi/spotted/models/me/player_get_state_response.rbi +38 -0
- data/rbi/spotted/models/me/player_list_recently_played_response.rbi +19 -0
- data/rbi/spotted/models/me/player_start_playback_params.rbi +19 -0
- data/rbi/spotted/models/me/player_transfer_params.rbi +19 -0
- data/rbi/spotted/models/me/show_list_response.rbi +27 -4
- data/rbi/spotted/models/me/show_remove_params.rbi +23 -1
- data/rbi/spotted/models/me/show_save_params.rbi +23 -1
- data/rbi/spotted/models/me/track_list_response.rbi +29 -4
- data/rbi/spotted/models/me/track_remove_params.rbi +23 -1
- data/rbi/spotted/models/me/track_save_params.rbi +19 -0
- data/rbi/spotted/models/me_retrieve_response.rbi +47 -5
- data/rbi/spotted/models/narrator_object.rbi +22 -3
- data/rbi/spotted/models/paging_playlist_object.rbi +22 -3
- data/rbi/spotted/models/playlist_retrieve_response.rbi +30 -9
- data/rbi/spotted/models/playlist_track_object.rbi +19 -0
- data/rbi/spotted/models/playlist_tracks_ref_object.rbi +27 -2
- data/rbi/spotted/models/playlist_update_params.rbi +19 -0
- data/rbi/spotted/models/playlist_user_object.rbi +19 -0
- data/rbi/spotted/models/playlists/follower_follow_params.rbi +23 -1
- data/rbi/spotted/models/playlists/track_add_params.rbi +19 -0
- data/rbi/spotted/models/playlists/track_remove_params.rbi +19 -0
- data/rbi/spotted/models/playlists/track_update_params.rbi +19 -0
- data/rbi/spotted/models/recommendation_get_response.rbi +41 -3
- data/rbi/spotted/models/resume_point_object.rbi +27 -4
- data/rbi/spotted/models/search_query_response.rbi +151 -18
- data/rbi/spotted/models/show_base.rbi +20 -1
- data/rbi/spotted/models/show_retrieve_response.rbi +22 -3
- data/rbi/spotted/models/simplified_artist_object.rbi +19 -0
- data/rbi/spotted/models/simplified_chapter_object.rbi +19 -0
- data/rbi/spotted/models/simplified_episode_object.rbi +19 -0
- data/rbi/spotted/models/simplified_playlist_object.rbi +8 -6
- data/rbi/spotted/models/simplified_track_object.rbi +19 -0
- data/rbi/spotted/models/time_interval_object.rbi +31 -4
- data/rbi/spotted/models/track_object.rbi +38 -0
- data/rbi/spotted/models/track_restriction_object.rbi +21 -2
- data/rbi/spotted/models/user_retrieve_profile_response.rbi +19 -0
- data/rbi/spotted/models/users/playlist_create_params.rbi +19 -0
- data/rbi/spotted/models/users/playlist_create_response.rbi +30 -9
- data/rbi/spotted/resources/me/albums.rbi +14 -0
- data/rbi/spotted/resources/me/episodes.rbi +14 -0
- data/rbi/spotted/resources/me/following.rbi +14 -0
- data/rbi/spotted/resources/me/player.rbi +14 -0
- data/rbi/spotted/resources/me/shows.rbi +14 -0
- data/rbi/spotted/resources/me/tracks.rbi +14 -0
- data/rbi/spotted/resources/playlists/followers.rbi +7 -0
- data/rbi/spotted/resources/playlists/tracks.rbi +21 -0
- data/rbi/spotted/resources/playlists.rbi +7 -0
- data/rbi/spotted/resources/users/playlists.rbi +7 -0
- data/sig/spotted/models/album_bulk_retrieve_response.rbs +17 -3
- data/sig/spotted/models/album_restriction_object.rbs +10 -1
- data/sig/spotted/models/album_retrieve_response.rbs +17 -3
- data/sig/spotted/models/artist_list_albums_response.rbs +7 -0
- data/sig/spotted/models/artist_object.rbs +7 -0
- data/sig/spotted/models/audio_analysis_retrieve_response.rbs +21 -0
- data/sig/spotted/models/audio_feature_bulk_retrieve_response.rbs +7 -0
- data/sig/spotted/models/audio_feature_retrieve_response.rbs +7 -0
- data/sig/spotted/models/audiobook_base.rbs +9 -2
- data/sig/spotted/models/audiobook_bulk_retrieve_response.rbs +10 -3
- data/sig/spotted/models/audiobook_retrieve_response.rbs +10 -3
- data/sig/spotted/models/author_object.rbs +7 -3
- data/sig/spotted/models/browse/category_get_playlists_response.rbs +13 -3
- data/sig/spotted/models/browse/category_list_response.rbs +20 -6
- data/sig/spotted/models/browse/category_retrieve_response.rbs +10 -3
- data/sig/spotted/models/browse_get_featured_playlists_response.rbs +13 -3
- data/sig/spotted/models/browse_get_new_releases_response.rbs +17 -3
- data/sig/spotted/models/chapter_bulk_retrieve_response.rbs +7 -0
- data/sig/spotted/models/chapter_restriction_object.rbs +7 -3
- data/sig/spotted/models/chapter_retrieve_response.rbs +7 -0
- data/sig/spotted/models/copyright_object.rbs +7 -3
- data/sig/spotted/models/episode_object.rbs +7 -0
- data/sig/spotted/models/episode_restriction_object.rbs +7 -3
- data/sig/spotted/models/external_id_object.rbs +19 -4
- data/sig/spotted/models/external_url_object.rbs +7 -3
- data/sig/spotted/models/followers_object.rbs +11 -3
- data/sig/spotted/models/image_object.rbs +18 -3
- data/sig/spotted/models/linked_track_object.rbs +7 -0
- data/sig/spotted/models/me/album_list_response.rbs +30 -6
- data/sig/spotted/models/me/album_remove_params.rbs +8 -1
- data/sig/spotted/models/me/album_save_params.rbs +8 -1
- data/sig/spotted/models/me/audiobook_list_response.rbs +20 -6
- data/sig/spotted/models/me/context_object.rbs +7 -0
- data/sig/spotted/models/me/device_object.rbs +7 -0
- data/sig/spotted/models/me/episode_list_response.rbs +12 -3
- data/sig/spotted/models/me/episode_remove_params.rbs +8 -1
- data/sig/spotted/models/me/episode_save_params.rbs +8 -1
- data/sig/spotted/models/me/following_bulk_retrieve_response.rbs +18 -3
- data/sig/spotted/models/me/following_follow_params.rbs +8 -1
- data/sig/spotted/models/me/following_unfollow_params.rbs +8 -1
- data/sig/spotted/models/me/player/queue_get_response.rbs +7 -0
- data/sig/spotted/models/me/player_get_currently_playing_response.rbs +14 -0
- data/sig/spotted/models/me/player_get_state_response.rbs +14 -0
- data/sig/spotted/models/me/player_list_recently_played_response.rbs +7 -0
- data/sig/spotted/models/me/player_start_playback_params.rbs +7 -0
- data/sig/spotted/models/me/player_transfer_params.rbs +7 -1
- data/sig/spotted/models/me/show_list_response.rbs +16 -3
- data/sig/spotted/models/me/show_remove_params.rbs +8 -1
- data/sig/spotted/models/me/show_save_params.rbs +8 -1
- data/sig/spotted/models/me/track_list_response.rbs +16 -3
- data/sig/spotted/models/me/track_remove_params.rbs +8 -1
- data/sig/spotted/models/me/track_save_params.rbs +7 -0
- data/sig/spotted/models/me_retrieve_response.rbs +23 -3
- data/sig/spotted/models/narrator_object.rbs +7 -3
- data/sig/spotted/models/paging_playlist_object.rbs +10 -3
- data/sig/spotted/models/playlist_retrieve_response.rbs +10 -3
- data/sig/spotted/models/playlist_track_object.rbs +7 -0
- data/sig/spotted/models/playlist_tracks_ref_object.rbs +8 -3
- data/sig/spotted/models/playlist_update_params.rbs +13 -1
- data/sig/spotted/models/playlist_user_object.rbs +7 -0
- data/sig/spotted/models/playlists/follower_follow_params.rbs +8 -1
- data/sig/spotted/models/playlists/track_add_params.rbs +7 -1
- data/sig/spotted/models/playlists/track_remove_params.rbs +7 -0
- data/sig/spotted/models/playlists/track_update_params.rbs +7 -0
- data/sig/spotted/models/recommendation_get_response.rbs +17 -3
- data/sig/spotted/models/resume_point_object.rbs +11 -2
- data/sig/spotted/models/search_query_response.rbs +67 -18
- data/sig/spotted/models/show_base.rbs +9 -2
- data/sig/spotted/models/show_retrieve_response.rbs +10 -3
- data/sig/spotted/models/simplified_artist_object.rbs +7 -0
- data/sig/spotted/models/simplified_chapter_object.rbs +7 -0
- data/sig/spotted/models/simplified_episode_object.rbs +7 -0
- data/sig/spotted/models/simplified_track_object.rbs +7 -0
- data/sig/spotted/models/time_interval_object.rbs +12 -2
- data/sig/spotted/models/track_object.rbs +14 -0
- data/sig/spotted/models/track_restriction_object.rbs +7 -3
- data/sig/spotted/models/user_retrieve_profile_response.rbs +7 -0
- data/sig/spotted/models/users/playlist_create_params.rbs +13 -1
- data/sig/spotted/models/users/playlist_create_response.rbs +10 -3
- data/sig/spotted/resources/me/albums.rbs +2 -0
- data/sig/spotted/resources/me/episodes.rbs +2 -0
- data/sig/spotted/resources/me/following.rbs +2 -0
- data/sig/spotted/resources/me/player.rbs +2 -0
- data/sig/spotted/resources/me/shows.rbs +2 -0
- data/sig/spotted/resources/me/tracks.rbs +2 -0
- data/sig/spotted/resources/playlists/followers.rbs +1 -0
- data/sig/spotted/resources/playlists/tracks.rbs +3 -0
- data/sig/spotted/resources/playlists.rbs +1 -0
- data/sig/spotted/resources/users/playlists.rbs +1 -0
- metadata +2 -2
|
@@ -66,9 +66,10 @@ module Spotted
|
|
|
66
66
|
optional :owner, -> { Spotted::Models::Users::PlaylistCreateResponse::Owner }
|
|
67
67
|
|
|
68
68
|
# @!attribute published
|
|
69
|
-
# The playlist's public/private status (if it
|
|
70
|
-
# `true` the playlist
|
|
71
|
-
# playlist status is not relevant. For more about
|
|
69
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
70
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
71
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
72
|
+
# public/private status, see
|
|
72
73
|
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
73
74
|
#
|
|
74
75
|
# @return [Boolean, nil]
|
|
@@ -123,7 +124,7 @@ module Spotted
|
|
|
123
124
|
#
|
|
124
125
|
# @param owner [Spotted::Models::Users::PlaylistCreateResponse::Owner] The user who owns the playlist
|
|
125
126
|
#
|
|
126
|
-
# @param published [Boolean] The playlist's public/private status (if it
|
|
127
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
127
128
|
#
|
|
128
129
|
# @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
|
|
129
130
|
#
|
|
@@ -193,7 +194,17 @@ module Spotted
|
|
|
193
194
|
# @return [Array<Spotted::Models::PlaylistTrackObject>, nil]
|
|
194
195
|
optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::PlaylistTrackObject] }
|
|
195
196
|
|
|
196
|
-
# @!
|
|
197
|
+
# @!attribute published
|
|
198
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
199
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
200
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
201
|
+
# public/private status, see
|
|
202
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
203
|
+
#
|
|
204
|
+
# @return [Boolean, nil]
|
|
205
|
+
optional :published, Spotted::Internal::Type::Boolean
|
|
206
|
+
|
|
207
|
+
# @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
|
|
197
208
|
# Some parameter documentations has been truncated, see
|
|
198
209
|
# {Spotted::Models::Users::PlaylistCreateResponse::Tracks} for more details.
|
|
199
210
|
#
|
|
@@ -212,6 +223,8 @@ module Spotted
|
|
|
212
223
|
# @param total [Integer] The total number of items available to return.
|
|
213
224
|
#
|
|
214
225
|
# @param items [Array<Spotted::Models::PlaylistTrackObject>]
|
|
226
|
+
#
|
|
227
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
215
228
|
end
|
|
216
229
|
end
|
|
217
230
|
end
|
|
@@ -66,10 +66,12 @@ module Spotted
|
|
|
66
66
|
#
|
|
67
67
|
# Remove one or more albums from the current user's 'Your Music' library.
|
|
68
68
|
#
|
|
69
|
-
# @overload remove(ids: nil, request_options: {})
|
|
69
|
+
# @overload remove(ids: nil, published: nil, request_options: {})
|
|
70
70
|
#
|
|
71
71
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
|
|
72
72
|
#
|
|
73
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
74
|
+
#
|
|
73
75
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
74
76
|
#
|
|
75
77
|
# @return [nil]
|
|
@@ -85,10 +87,12 @@ module Spotted
|
|
|
85
87
|
#
|
|
86
88
|
# Save one or more albums to the current user's 'Your Music' library.
|
|
87
89
|
#
|
|
88
|
-
# @overload save(ids: nil, request_options: {})
|
|
90
|
+
# @overload save(ids: nil, published: nil, request_options: {})
|
|
89
91
|
#
|
|
90
92
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
|
|
91
93
|
#
|
|
94
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
95
|
+
#
|
|
92
96
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
93
97
|
#
|
|
94
98
|
# @return [nil]
|
|
@@ -74,10 +74,12 @@ module Spotted
|
|
|
74
74
|
# feedback that you have, or issues that you discover, in our
|
|
75
75
|
# [developer community forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
|
|
76
76
|
#
|
|
77
|
-
# @overload remove(ids: nil, request_options: {})
|
|
77
|
+
# @overload remove(ids: nil, published: nil, request_options: {})
|
|
78
78
|
#
|
|
79
79
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
|
|
80
80
|
#
|
|
81
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
82
|
+
#
|
|
81
83
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
82
84
|
#
|
|
83
85
|
# @return [nil]
|
|
@@ -102,10 +104,12 @@ module Spotted
|
|
|
102
104
|
# you have, or issues that you discover, in our
|
|
103
105
|
# [developer community forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
|
|
104
106
|
#
|
|
105
|
-
# @overload save(ids:, request_options: {})
|
|
107
|
+
# @overload save(ids:, published: nil, request_options: {})
|
|
106
108
|
#
|
|
107
109
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
|
|
108
110
|
#
|
|
111
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
112
|
+
#
|
|
109
113
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
110
114
|
#
|
|
111
115
|
# @return [nil]
|
|
@@ -67,10 +67,12 @@ module Spotted
|
|
|
67
67
|
# Add the current user as a follower of one or more artists or other Spotify
|
|
68
68
|
# users.
|
|
69
69
|
#
|
|
70
|
-
# @overload follow(ids:, request_options: {})
|
|
70
|
+
# @overload follow(ids:, published: nil, request_options: {})
|
|
71
71
|
#
|
|
72
72
|
# @param ids [Array<String>] A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts
|
|
73
73
|
#
|
|
74
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
75
|
+
#
|
|
74
76
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
75
77
|
#
|
|
76
78
|
# @return [nil]
|
|
@@ -87,10 +89,12 @@ module Spotted
|
|
|
87
89
|
# Remove the current user as a follower of one or more artists or other Spotify
|
|
88
90
|
# users.
|
|
89
91
|
#
|
|
90
|
-
# @overload unfollow(ids: nil, request_options: {})
|
|
92
|
+
# @overload unfollow(ids: nil, published: nil, request_options: {})
|
|
91
93
|
#
|
|
92
94
|
# @param ids [Array<String>] A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts
|
|
93
95
|
#
|
|
96
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
97
|
+
#
|
|
94
98
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
99
|
#
|
|
96
100
|
# @return [nil]
|
|
@@ -287,7 +287,7 @@ module Spotted
|
|
|
287
287
|
# API only works for users who have Spotify Premium. The order of execution is not
|
|
288
288
|
# guaranteed when you use this API with other Player API endpoints.
|
|
289
289
|
#
|
|
290
|
-
# @overload start_playback(device_id: nil, context_uri: nil, offset: nil, position_ms: nil, uris: nil, request_options: {})
|
|
290
|
+
# @overload start_playback(device_id: nil, context_uri: nil, offset: nil, position_ms: nil, published: nil, uris: nil, request_options: {})
|
|
291
291
|
#
|
|
292
292
|
# @param device_id [String] Query param: The id of the device this command is targeting. If not supplied, th
|
|
293
293
|
#
|
|
@@ -297,6 +297,8 @@ module Spotted
|
|
|
297
297
|
#
|
|
298
298
|
# @param position_ms [Integer] Body param: Indicates from what position to start playback. Must be a positive n
|
|
299
299
|
#
|
|
300
|
+
# @param published [Boolean] Body param: The playlist's public/private status (if it should be added to the u
|
|
301
|
+
#
|
|
300
302
|
# @param uris [Array<String>] Body param: Optional. A JSON array of the Spotify track URIs to play.
|
|
301
303
|
#
|
|
302
304
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -353,12 +355,14 @@ module Spotted
|
|
|
353
355
|
# works for users who have Spotify Premium. The order of execution is not
|
|
354
356
|
# guaranteed when you use this API with other Player API endpoints.
|
|
355
357
|
#
|
|
356
|
-
# @overload transfer(device_ids:, play: nil, request_options: {})
|
|
358
|
+
# @overload transfer(device_ids:, play: nil, published: nil, request_options: {})
|
|
357
359
|
#
|
|
358
360
|
# @param device_ids [Array<String>] A JSON array containing the ID of the device on which playback should be started
|
|
359
361
|
#
|
|
360
362
|
# @param play [Boolean] **true**: ensure playback happens on new device.<br/>**false** or not provided:
|
|
361
363
|
#
|
|
364
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
365
|
+
#
|
|
362
366
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
363
367
|
#
|
|
364
368
|
# @return [nil]
|
|
@@ -64,10 +64,12 @@ module Spotted
|
|
|
64
64
|
#
|
|
65
65
|
# Delete one or more shows from current Spotify user's library.
|
|
66
66
|
#
|
|
67
|
-
# @overload remove(ids: nil, request_options: {})
|
|
67
|
+
# @overload remove(ids: nil, published: nil, request_options: {})
|
|
68
68
|
#
|
|
69
69
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](https://developer.spotify.com/documentation/we
|
|
70
70
|
#
|
|
71
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
72
|
+
#
|
|
71
73
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
72
74
|
#
|
|
73
75
|
# @return [nil]
|
|
@@ -83,10 +85,12 @@ module Spotted
|
|
|
83
85
|
#
|
|
84
86
|
# Save one or more shows to current Spotify user's library.
|
|
85
87
|
#
|
|
86
|
-
# @overload save(ids: nil, request_options: {})
|
|
88
|
+
# @overload save(ids: nil, published: nil, request_options: {})
|
|
87
89
|
#
|
|
88
90
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](https://developer.spotify.com/documentation/we
|
|
89
91
|
#
|
|
92
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
93
|
+
#
|
|
90
94
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
91
95
|
#
|
|
92
96
|
# @return [nil]
|
|
@@ -66,10 +66,12 @@ module Spotted
|
|
|
66
66
|
#
|
|
67
67
|
# Remove one or more tracks from the current user's 'Your Music' library.
|
|
68
68
|
#
|
|
69
|
-
# @overload remove(ids: nil, request_options: {})
|
|
69
|
+
# @overload remove(ids: nil, published: nil, request_options: {})
|
|
70
70
|
#
|
|
71
71
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
|
|
72
72
|
#
|
|
73
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
74
|
+
#
|
|
73
75
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
74
76
|
#
|
|
75
77
|
# @return [nil]
|
|
@@ -85,10 +87,12 @@ module Spotted
|
|
|
85
87
|
#
|
|
86
88
|
# Save one or more tracks to the current user's 'Your Music' library.
|
|
87
89
|
#
|
|
88
|
-
# @overload save(ids:, timestamped_ids: nil, request_options: {})
|
|
90
|
+
# @overload save(ids:, published: nil, timestamped_ids: nil, request_options: {})
|
|
89
91
|
#
|
|
90
92
|
# @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
|
|
91
93
|
#
|
|
94
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
95
|
+
#
|
|
92
96
|
# @param timestamped_ids [Array<Spotted::Models::Me::TrackSaveParams::TimestampedID>] A JSON array of objects containing track IDs with their corresponding timestamps
|
|
93
97
|
#
|
|
94
98
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -36,12 +36,14 @@ module Spotted
|
|
|
36
36
|
#
|
|
37
37
|
# Add the current user as a follower of a playlist.
|
|
38
38
|
#
|
|
39
|
-
# @overload follow(playlist_id, public: nil, request_options: {})
|
|
39
|
+
# @overload follow(playlist_id, public: nil, published: nil, request_options: {})
|
|
40
40
|
#
|
|
41
41
|
# @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
|
|
42
42
|
#
|
|
43
43
|
# @param public [Boolean] Defaults to `true`. If `true` the playlist will be included in user's public pla
|
|
44
44
|
#
|
|
45
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
46
|
+
#
|
|
45
47
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
46
48
|
#
|
|
47
49
|
# @return [nil]
|
|
@@ -17,12 +17,14 @@ module Spotted
|
|
|
17
17
|
# have different parameters. These operations can't be applied together in a
|
|
18
18
|
# single request.
|
|
19
19
|
#
|
|
20
|
-
# @overload update(playlist_id, insert_before: nil, range_length: nil, range_start: nil, snapshot_id: nil, uris: nil, request_options: {})
|
|
20
|
+
# @overload update(playlist_id, insert_before: nil, published: nil, range_length: nil, range_start: nil, snapshot_id: nil, uris: nil, request_options: {})
|
|
21
21
|
#
|
|
22
22
|
# @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
|
|
23
23
|
#
|
|
24
24
|
# @param insert_before [Integer] The position where the items should be inserted.<br/>To reorder the items to the
|
|
25
25
|
#
|
|
26
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
27
|
+
#
|
|
26
28
|
# @param range_length [Integer] The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of
|
|
27
29
|
#
|
|
28
30
|
# @param range_start [Integer] The position of the first item to be reordered.
|
|
@@ -88,12 +90,14 @@ module Spotted
|
|
|
88
90
|
#
|
|
89
91
|
# Add one or more items to a user's playlist.
|
|
90
92
|
#
|
|
91
|
-
# @overload add(playlist_id, position: nil, uris: nil, request_options: {})
|
|
93
|
+
# @overload add(playlist_id, position: nil, published: nil, uris: nil, request_options: {})
|
|
92
94
|
#
|
|
93
95
|
# @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
|
|
94
96
|
#
|
|
95
97
|
# @param position [Integer] The position to insert the items, a zero-based index. For example, to insert the
|
|
96
98
|
#
|
|
99
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
100
|
+
#
|
|
97
101
|
# @param uris [Array<String>] A JSON array of the [Spotify URIs](/documentation/web-api/concepts/spotify-uris-
|
|
98
102
|
#
|
|
99
103
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -117,12 +121,14 @@ module Spotted
|
|
|
117
121
|
#
|
|
118
122
|
# Remove one or more items from a user's playlist.
|
|
119
123
|
#
|
|
120
|
-
# @overload remove(playlist_id, tracks:, snapshot_id: nil, request_options: {})
|
|
124
|
+
# @overload remove(playlist_id, tracks:, published: nil, snapshot_id: nil, request_options: {})
|
|
121
125
|
#
|
|
122
126
|
# @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
|
|
123
127
|
#
|
|
124
128
|
# @param tracks [Array<Spotted::Models::Playlists::TrackRemoveParams::Track>] An array of objects containing [Spotify URIs](/documentation/web-api/concepts/sp
|
|
125
129
|
#
|
|
130
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
131
|
+
#
|
|
126
132
|
# @param snapshot_id [String] The playlist's snapshot ID against which you want to make the changes.
|
|
127
133
|
#
|
|
128
134
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -49,7 +49,7 @@ module Spotted
|
|
|
49
49
|
# Change a playlist's name and public/private state. (The user must, of course,
|
|
50
50
|
# own the playlist.)
|
|
51
51
|
#
|
|
52
|
-
# @overload update(playlist_id, collaborative: nil, description: nil, name: nil, public: nil, request_options: {})
|
|
52
|
+
# @overload update(playlist_id, collaborative: nil, description: nil, name: nil, public: nil, published: nil, request_options: {})
|
|
53
53
|
#
|
|
54
54
|
# @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
|
|
55
55
|
#
|
|
@@ -61,6 +61,8 @@ module Spotted
|
|
|
61
61
|
#
|
|
62
62
|
# @param public [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
63
63
|
#
|
|
64
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
65
|
+
#
|
|
64
66
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
65
67
|
#
|
|
66
68
|
# @return [nil]
|
|
@@ -11,7 +11,7 @@ module Spotted
|
|
|
11
11
|
# [add tracks](/documentation/web-api/reference/add-tracks-to-playlist).) Each
|
|
12
12
|
# user is generally limited to a maximum of 11000 playlists.
|
|
13
13
|
#
|
|
14
|
-
# @overload create(user_id, name:, collaborative: nil, description: nil, public: nil, request_options: {})
|
|
14
|
+
# @overload create(user_id, name:, collaborative: nil, description: nil, public: nil, published: nil, request_options: {})
|
|
15
15
|
#
|
|
16
16
|
# @param user_id [String] The user's [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids).
|
|
17
17
|
#
|
|
@@ -24,6 +24,8 @@ module Spotted
|
|
|
24
24
|
#
|
|
25
25
|
# @param public [Boolean] Defaults to `true`. The playlist's public/private status (if it should be added
|
|
26
26
|
#
|
|
27
|
+
# @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
28
|
+
#
|
|
27
29
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
30
|
#
|
|
29
31
|
# @return [Spotted::Models::Users::PlaylistCreateResponse]
|
data/lib/spotted/version.rb
CHANGED
|
@@ -159,6 +159,17 @@ module Spotted
|
|
|
159
159
|
sig { params(popularity: Integer).void }
|
|
160
160
|
attr_writer :popularity
|
|
161
161
|
|
|
162
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
163
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
164
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
165
|
+
# public/private status, see
|
|
166
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
167
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
168
|
+
attr_reader :published
|
|
169
|
+
|
|
170
|
+
sig { params(published: T::Boolean).void }
|
|
171
|
+
attr_writer :published
|
|
172
|
+
|
|
162
173
|
# Included in the response when a content restriction is applied.
|
|
163
174
|
sig { returns(T.nilable(Spotted::AlbumRestrictionObject)) }
|
|
164
175
|
attr_reader :restrictions
|
|
@@ -205,6 +216,7 @@ module Spotted
|
|
|
205
216
|
genres: T::Array[String],
|
|
206
217
|
label: String,
|
|
207
218
|
popularity: Integer,
|
|
219
|
+
published: T::Boolean,
|
|
208
220
|
restrictions: Spotted::AlbumRestrictionObject::OrHash,
|
|
209
221
|
tracks:
|
|
210
222
|
Spotted::Models::AlbumBulkRetrieveResponse::Album::Tracks::OrHash,
|
|
@@ -254,6 +266,12 @@ module Spotted
|
|
|
254
266
|
# The popularity of the album. The value will be between 0 and 100, with 100 being
|
|
255
267
|
# the most popular.
|
|
256
268
|
popularity: nil,
|
|
269
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
270
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
271
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
272
|
+
# public/private status, see
|
|
273
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
274
|
+
published: nil,
|
|
257
275
|
# Included in the response when a content restriction is applied.
|
|
258
276
|
restrictions: nil,
|
|
259
277
|
# The tracks of the album.
|
|
@@ -286,6 +304,7 @@ module Spotted
|
|
|
286
304
|
genres: T::Array[String],
|
|
287
305
|
label: String,
|
|
288
306
|
popularity: Integer,
|
|
307
|
+
published: T::Boolean,
|
|
289
308
|
restrictions: Spotted::AlbumRestrictionObject,
|
|
290
309
|
tracks: Spotted::Models::AlbumBulkRetrieveResponse::Album::Tracks
|
|
291
310
|
}
|
|
@@ -415,6 +434,17 @@ module Spotted
|
|
|
415
434
|
end
|
|
416
435
|
attr_writer :items
|
|
417
436
|
|
|
437
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
438
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
439
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
440
|
+
# public/private status, see
|
|
441
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
442
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
443
|
+
attr_reader :published
|
|
444
|
+
|
|
445
|
+
sig { params(published: T::Boolean).void }
|
|
446
|
+
attr_writer :published
|
|
447
|
+
|
|
418
448
|
# The tracks of the album.
|
|
419
449
|
sig do
|
|
420
450
|
params(
|
|
@@ -424,7 +454,8 @@ module Spotted
|
|
|
424
454
|
offset: Integer,
|
|
425
455
|
previous: T.nilable(String),
|
|
426
456
|
total: Integer,
|
|
427
|
-
items: T::Array[Spotted::SimplifiedTrackObject::OrHash]
|
|
457
|
+
items: T::Array[Spotted::SimplifiedTrackObject::OrHash],
|
|
458
|
+
published: T::Boolean
|
|
428
459
|
).returns(T.attached_class)
|
|
429
460
|
end
|
|
430
461
|
def self.new(
|
|
@@ -440,7 +471,13 @@ module Spotted
|
|
|
440
471
|
previous:,
|
|
441
472
|
# The total number of items available to return.
|
|
442
473
|
total:,
|
|
443
|
-
items: nil
|
|
474
|
+
items: nil,
|
|
475
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
476
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
477
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
478
|
+
# public/private status, see
|
|
479
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
480
|
+
published: nil
|
|
444
481
|
)
|
|
445
482
|
end
|
|
446
483
|
|
|
@@ -453,7 +490,8 @@ module Spotted
|
|
|
453
490
|
offset: Integer,
|
|
454
491
|
previous: T.nilable(String),
|
|
455
492
|
total: Integer,
|
|
456
|
-
items: T::Array[Spotted::SimplifiedTrackObject]
|
|
493
|
+
items: T::Array[Spotted::SimplifiedTrackObject],
|
|
494
|
+
published: T::Boolean
|
|
457
495
|
}
|
|
458
496
|
)
|
|
459
497
|
end
|
|
@@ -8,6 +8,17 @@ module Spotted
|
|
|
8
8
|
T.any(Spotted::AlbumRestrictionObject, Spotted::Internal::AnyHash)
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
12
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
13
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
14
|
+
# public/private status, see
|
|
15
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
16
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
17
|
+
attr_reader :published
|
|
18
|
+
|
|
19
|
+
sig { params(published: T::Boolean).void }
|
|
20
|
+
attr_writer :published
|
|
21
|
+
|
|
11
22
|
# The reason for the restriction. Albums may be restricted if the content is not
|
|
12
23
|
# available in a given market, to the user's subscription type, or when the user's
|
|
13
24
|
# account is set to not play explicit content. Additional reasons may be added in
|
|
@@ -26,10 +37,17 @@ module Spotted
|
|
|
26
37
|
|
|
27
38
|
sig do
|
|
28
39
|
params(
|
|
40
|
+
published: T::Boolean,
|
|
29
41
|
reason: Spotted::AlbumRestrictionObject::Reason::OrSymbol
|
|
30
42
|
).returns(T.attached_class)
|
|
31
43
|
end
|
|
32
44
|
def self.new(
|
|
45
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
46
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
47
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
48
|
+
# public/private status, see
|
|
49
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
50
|
+
published: nil,
|
|
33
51
|
# The reason for the restriction. Albums may be restricted if the content is not
|
|
34
52
|
# available in a given market, to the user's subscription type, or when the user's
|
|
35
53
|
# account is set to not play explicit content. Additional reasons may be added in
|
|
@@ -40,7 +58,10 @@ module Spotted
|
|
|
40
58
|
|
|
41
59
|
sig do
|
|
42
60
|
override.returns(
|
|
43
|
-
{
|
|
61
|
+
{
|
|
62
|
+
published: T::Boolean,
|
|
63
|
+
reason: Spotted::AlbumRestrictionObject::Reason::TaggedSymbol
|
|
64
|
+
}
|
|
44
65
|
)
|
|
45
66
|
end
|
|
46
67
|
def to_hash
|
|
@@ -122,6 +122,17 @@ module Spotted
|
|
|
122
122
|
sig { params(popularity: Integer).void }
|
|
123
123
|
attr_writer :popularity
|
|
124
124
|
|
|
125
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
126
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
127
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
128
|
+
# public/private status, see
|
|
129
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
130
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
131
|
+
attr_reader :published
|
|
132
|
+
|
|
133
|
+
sig { params(published: T::Boolean).void }
|
|
134
|
+
attr_writer :published
|
|
135
|
+
|
|
125
136
|
# Included in the response when a content restriction is applied.
|
|
126
137
|
sig { returns(T.nilable(Spotted::AlbumRestrictionObject)) }
|
|
127
138
|
attr_reader :restrictions
|
|
@@ -161,6 +172,7 @@ module Spotted
|
|
|
161
172
|
genres: T::Array[String],
|
|
162
173
|
label: String,
|
|
163
174
|
popularity: Integer,
|
|
175
|
+
published: T::Boolean,
|
|
164
176
|
restrictions: Spotted::AlbumRestrictionObject::OrHash,
|
|
165
177
|
tracks: Spotted::Models::AlbumRetrieveResponse::Tracks::OrHash,
|
|
166
178
|
type: Symbol
|
|
@@ -209,6 +221,12 @@ module Spotted
|
|
|
209
221
|
# The popularity of the album. The value will be between 0 and 100, with 100 being
|
|
210
222
|
# the most popular.
|
|
211
223
|
popularity: nil,
|
|
224
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
225
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
226
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
227
|
+
# public/private status, see
|
|
228
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
229
|
+
published: nil,
|
|
212
230
|
# Included in the response when a content restriction is applied.
|
|
213
231
|
restrictions: nil,
|
|
214
232
|
# The tracks of the album.
|
|
@@ -241,6 +259,7 @@ module Spotted
|
|
|
241
259
|
genres: T::Array[String],
|
|
242
260
|
label: String,
|
|
243
261
|
popularity: Integer,
|
|
262
|
+
published: T::Boolean,
|
|
244
263
|
restrictions: Spotted::AlbumRestrictionObject,
|
|
245
264
|
tracks: Spotted::Models::AlbumRetrieveResponse::Tracks
|
|
246
265
|
}
|
|
@@ -367,6 +386,17 @@ module Spotted
|
|
|
367
386
|
end
|
|
368
387
|
attr_writer :items
|
|
369
388
|
|
|
389
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
390
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
391
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
392
|
+
# public/private status, see
|
|
393
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
394
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
395
|
+
attr_reader :published
|
|
396
|
+
|
|
397
|
+
sig { params(published: T::Boolean).void }
|
|
398
|
+
attr_writer :published
|
|
399
|
+
|
|
370
400
|
# The tracks of the album.
|
|
371
401
|
sig do
|
|
372
402
|
params(
|
|
@@ -376,7 +406,8 @@ module Spotted
|
|
|
376
406
|
offset: Integer,
|
|
377
407
|
previous: T.nilable(String),
|
|
378
408
|
total: Integer,
|
|
379
|
-
items: T::Array[Spotted::SimplifiedTrackObject::OrHash]
|
|
409
|
+
items: T::Array[Spotted::SimplifiedTrackObject::OrHash],
|
|
410
|
+
published: T::Boolean
|
|
380
411
|
).returns(T.attached_class)
|
|
381
412
|
end
|
|
382
413
|
def self.new(
|
|
@@ -392,7 +423,13 @@ module Spotted
|
|
|
392
423
|
previous:,
|
|
393
424
|
# The total number of items available to return.
|
|
394
425
|
total:,
|
|
395
|
-
items: nil
|
|
426
|
+
items: nil,
|
|
427
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
428
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
429
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
430
|
+
# public/private status, see
|
|
431
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
432
|
+
published: nil
|
|
396
433
|
)
|
|
397
434
|
end
|
|
398
435
|
|
|
@@ -405,7 +442,8 @@ module Spotted
|
|
|
405
442
|
offset: Integer,
|
|
406
443
|
previous: T.nilable(String),
|
|
407
444
|
total: Integer,
|
|
408
|
-
items: T::Array[Spotted::SimplifiedTrackObject]
|
|
445
|
+
items: T::Array[Spotted::SimplifiedTrackObject],
|
|
446
|
+
published: T::Boolean
|
|
409
447
|
}
|
|
410
448
|
)
|
|
411
449
|
end
|
|
@@ -89,6 +89,17 @@ module Spotted
|
|
|
89
89
|
sig { returns(String) }
|
|
90
90
|
attr_accessor :uri
|
|
91
91
|
|
|
92
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
93
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
94
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
95
|
+
# public/private status, see
|
|
96
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
97
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
98
|
+
attr_reader :published
|
|
99
|
+
|
|
100
|
+
sig { params(published: T::Boolean).void }
|
|
101
|
+
attr_writer :published
|
|
102
|
+
|
|
92
103
|
# Included in the response when a content restriction is applied.
|
|
93
104
|
sig { returns(T.nilable(Spotted::AlbumRestrictionObject)) }
|
|
94
105
|
attr_reader :restrictions
|
|
@@ -114,6 +125,7 @@ module Spotted
|
|
|
114
125
|
Spotted::Models::ArtistListAlbumsResponse::ReleaseDatePrecision::OrSymbol,
|
|
115
126
|
total_tracks: Integer,
|
|
116
127
|
uri: String,
|
|
128
|
+
published: T::Boolean,
|
|
117
129
|
restrictions: Spotted::AlbumRestrictionObject::OrHash,
|
|
118
130
|
type: Symbol
|
|
119
131
|
).returns(T.attached_class)
|
|
@@ -152,6 +164,12 @@ module Spotted
|
|
|
152
164
|
# The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
|
|
153
165
|
# album.
|
|
154
166
|
uri:,
|
|
167
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
168
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
169
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
170
|
+
# public/private status, see
|
|
171
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
172
|
+
published: nil,
|
|
155
173
|
# Included in the response when a content restriction is applied.
|
|
156
174
|
restrictions: nil,
|
|
157
175
|
# The object type.
|
|
@@ -179,6 +197,7 @@ module Spotted
|
|
|
179
197
|
total_tracks: Integer,
|
|
180
198
|
type: Symbol,
|
|
181
199
|
uri: String,
|
|
200
|
+
published: T::Boolean,
|
|
182
201
|
restrictions: Spotted::AlbumRestrictionObject
|
|
183
202
|
}
|
|
184
203
|
)
|