spotted 0.1.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 +7 -0
- data/.ignore +2 -0
- data/CHANGELOG.md +25 -0
- data/README.md +236 -0
- data/SECURITY.md +27 -0
- data/lib/spotted/client.rb +169 -0
- data/lib/spotted/errors.rb +228 -0
- data/lib/spotted/file_part.rb +58 -0
- data/lib/spotted/internal/cursor_url_page.rb +86 -0
- data/lib/spotted/internal/oauth2.rb +87 -0
- data/lib/spotted/internal/transport/base_client.rb +567 -0
- data/lib/spotted/internal/transport/pooled_net_requester.rb +204 -0
- data/lib/spotted/internal/type/array_of.rb +168 -0
- data/lib/spotted/internal/type/base_model.rb +529 -0
- data/lib/spotted/internal/type/base_page.rb +55 -0
- data/lib/spotted/internal/type/boolean.rb +77 -0
- data/lib/spotted/internal/type/converter.rb +327 -0
- data/lib/spotted/internal/type/enum.rb +131 -0
- data/lib/spotted/internal/type/file_input.rb +111 -0
- data/lib/spotted/internal/type/hash_of.rb +188 -0
- data/lib/spotted/internal/type/request_parameters.rb +42 -0
- data/lib/spotted/internal/type/union.rb +237 -0
- data/lib/spotted/internal/type/unknown.rb +81 -0
- data/lib/spotted/internal/util.rb +915 -0
- data/lib/spotted/internal.rb +20 -0
- data/lib/spotted/models/album_list_params.rb +43 -0
- data/lib/spotted/models/album_list_response.rb +297 -0
- data/lib/spotted/models/album_list_tracks_params.rb +50 -0
- data/lib/spotted/models/album_restriction_object.rb +39 -0
- data/lib/spotted/models/album_retrieve_params.rb +33 -0
- data/lib/spotted/models/album_retrieve_response.rb +287 -0
- data/lib/spotted/models/artist_list_albums_params.rb +61 -0
- data/lib/spotted/models/artist_list_albums_response.rb +195 -0
- data/lib/spotted/models/artist_list_params.rb +27 -0
- data/lib/spotted/models/artist_list_related_artists_params.rb +14 -0
- data/lib/spotted/models/artist_list_related_artists_response.rb +16 -0
- data/lib/spotted/models/artist_list_response.rb +16 -0
- data/lib/spotted/models/artist_list_top_tracks_params.rb +33 -0
- data/lib/spotted/models/artist_list_top_tracks_response.rb +16 -0
- data/lib/spotted/models/artist_object.rb +108 -0
- data/lib/spotted/models/artist_retrieve_params.rb +14 -0
- data/lib/spotted/models/audio_analysis_retrieve_params.rb +14 -0
- data/lib/spotted/models/audio_analysis_retrieve_response.rb +628 -0
- data/lib/spotted/models/audio_feature_list_params.rb +27 -0
- data/lib/spotted/models/audio_feature_list_response.rb +214 -0
- data/lib/spotted/models/audio_feature_retrieve_params.rb +14 -0
- data/lib/spotted/models/audio_feature_retrieve_response.rb +203 -0
- data/lib/spotted/models/audiobook_list_chapters_params.rb +50 -0
- data/lib/spotted/models/audiobook_list_params.rb +43 -0
- data/lib/spotted/models/audiobook_list_response.rb +266 -0
- data/lib/spotted/models/audiobook_retrieve_params.rb +33 -0
- data/lib/spotted/models/audiobook_retrieve_response.rb +255 -0
- data/lib/spotted/models/author_object.rb +19 -0
- data/lib/spotted/models/browse/category_get_playlists_params.rb +36 -0
- data/lib/spotted/models/browse/category_get_playlists_response.rb +29 -0
- data/lib/spotted/models/browse/category_list_params.rb +51 -0
- data/lib/spotted/models/browse/category_list_response.rb +121 -0
- data/lib/spotted/models/browse/category_retrieve_params.rb +34 -0
- data/lib/spotted/models/browse/category_retrieve_response.rb +47 -0
- data/lib/spotted/models/browse_get_featured_playlists_params.rb +49 -0
- data/lib/spotted/models/browse_get_featured_playlists_response.rb +27 -0
- data/lib/spotted/models/browse_get_new_releases_params.rb +34 -0
- data/lib/spotted/models/browse_get_new_releases_response.rb +245 -0
- data/lib/spotted/models/chapter_list_params.rb +43 -0
- data/lib/spotted/models/chapter_list_response.rb +408 -0
- data/lib/spotted/models/chapter_restriction_object.rb +29 -0
- data/lib/spotted/models/chapter_retrieve_params.rb +33 -0
- data/lib/spotted/models/chapter_retrieve_response.rb +398 -0
- data/lib/spotted/models/copyright_object.rb +28 -0
- data/lib/spotted/models/episode_list_params.rb +43 -0
- data/lib/spotted/models/episode_list_response.rb +16 -0
- data/lib/spotted/models/episode_object.rb +382 -0
- data/lib/spotted/models/episode_restriction_object.rb +28 -0
- data/lib/spotted/models/episode_retrieve_params.rb +33 -0
- data/lib/spotted/models/external_id_object.rb +35 -0
- data/lib/spotted/models/external_url_object.rb +20 -0
- data/lib/spotted/models/followers_object.rb +28 -0
- data/lib/spotted/models/image_object.rb +35 -0
- data/lib/spotted/models/linked_track_object.rb +53 -0
- data/lib/spotted/models/market_list_params.rb +14 -0
- data/lib/spotted/models/market_list_response.rb +16 -0
- data/lib/spotted/models/me/album_check_params.rb +29 -0
- data/lib/spotted/models/me/album_check_response.rb +10 -0
- data/lib/spotted/models/me/album_list_params.rb +52 -0
- data/lib/spotted/models/me/album_list_response.rb +318 -0
- data/lib/spotted/models/me/album_remove_params.rb +31 -0
- data/lib/spotted/models/me/album_save_params.rb +31 -0
- data/lib/spotted/models/me/audiobook_check_params.rb +29 -0
- data/lib/spotted/models/me/audiobook_check_response.rb +10 -0
- data/lib/spotted/models/me/audiobook_list_params.rb +36 -0
- data/lib/spotted/models/me/audiobook_list_response.rb +287 -0
- data/lib/spotted/models/me/audiobook_remove_params.rb +29 -0
- data/lib/spotted/models/me/audiobook_save_params.rb +29 -0
- data/lib/spotted/models/me/context_object.rb +46 -0
- data/lib/spotted/models/me/device_object.rb +82 -0
- data/lib/spotted/models/me/episode_check_params.rb +29 -0
- data/lib/spotted/models/me/episode_check_response.rb +10 -0
- data/lib/spotted/models/me/episode_list_params.rb +52 -0
- data/lib/spotted/models/me/episode_list_response.rb +32 -0
- data/lib/spotted/models/me/episode_remove_params.rb +31 -0
- data/lib/spotted/models/me/episode_save_params.rb +31 -0
- data/lib/spotted/models/me/following_check_params.rb +49 -0
- data/lib/spotted/models/me/following_check_response.rb +10 -0
- data/lib/spotted/models/me/following_follow_params.rb +50 -0
- data/lib/spotted/models/me/following_list_params.rb +53 -0
- data/lib/spotted/models/me/following_list_response.rb +94 -0
- data/lib/spotted/models/me/following_unfollow_params.rb +50 -0
- data/lib/spotted/models/me/player/queue_add_params.rb +38 -0
- data/lib/spotted/models/me/player/queue_get_params.rb +18 -0
- data/lib/spotted/models/me/player/queue_get_response.rb +59 -0
- data/lib/spotted/models/me/player_get_currently_playing_params.rb +48 -0
- data/lib/spotted/models/me/player_get_currently_playing_response.rb +175 -0
- data/lib/spotted/models/me/player_get_devices_params.rb +16 -0
- data/lib/spotted/models/me/player_get_devices_response.rb +18 -0
- data/lib/spotted/models/me/player_get_state_params.rb +48 -0
- data/lib/spotted/models/me/player_get_state_response.rb +200 -0
- data/lib/spotted/models/me/player_list_recently_played_params.rb +45 -0
- data/lib/spotted/models/me/player_list_recently_played_response.rb +35 -0
- data/lib/spotted/models/me/player_pause_playback_params.rb +28 -0
- data/lib/spotted/models/me/player_seek_to_position_params.rb +38 -0
- data/lib/spotted/models/me/player_set_repeat_mode_params.rb +38 -0
- data/lib/spotted/models/me/player_set_volume_params.rb +36 -0
- data/lib/spotted/models/me/player_skip_next_params.rb +28 -0
- data/lib/spotted/models/me/player_skip_previous_params.rb +28 -0
- data/lib/spotted/models/me/player_start_playback_params.rb +68 -0
- data/lib/spotted/models/me/player_toggle_shuffle_params.rb +37 -0
- data/lib/spotted/models/me/player_transfer_params.rb +40 -0
- data/lib/spotted/models/me/playlist_list_params.rb +36 -0
- data/lib/spotted/models/me/show_check_params.rb +29 -0
- data/lib/spotted/models/me/show_check_response.rb +10 -0
- data/lib/spotted/models/me/show_list_params.rb +36 -0
- data/lib/spotted/models/me/show_list_response.rb +197 -0
- data/lib/spotted/models/me/show_remove_params.rb +47 -0
- data/lib/spotted/models/me/show_save_params.rb +31 -0
- data/lib/spotted/models/me/top_list_top_artists_params.rb +47 -0
- data/lib/spotted/models/me/top_list_top_tracks_params.rb +47 -0
- data/lib/spotted/models/me/track_check_params.rb +29 -0
- data/lib/spotted/models/me/track_check_response.rb +10 -0
- data/lib/spotted/models/me/track_list_params.rb +52 -0
- data/lib/spotted/models/me/track_list_response.rb +34 -0
- data/lib/spotted/models/me/track_remove_params.rb +31 -0
- data/lib/spotted/models/me/track_save_params.rb +74 -0
- data/lib/spotted/models/me_retrieve_params.rb +14 -0
- data/lib/spotted/models/me_retrieve_response.rb +157 -0
- data/lib/spotted/models/narrator_object.rb +19 -0
- data/lib/spotted/models/paging_playlist_object.rb +66 -0
- data/lib/spotted/models/playlist_retrieve_params.rb +63 -0
- data/lib/spotted/models/playlist_retrieve_response.rb +217 -0
- data/lib/spotted/models/playlist_track_object.rb +64 -0
- data/lib/spotted/models/playlist_tracks_ref_object.rb +28 -0
- data/lib/spotted/models/playlist_update_params.rb +56 -0
- data/lib/spotted/models/playlist_user_object.rb +65 -0
- data/lib/spotted/models/playlists/follower_check_params.rb +29 -0
- data/lib/spotted/models/playlists/follower_check_response.rb +10 -0
- data/lib/spotted/models/playlists/follower_follow_params.rb +30 -0
- data/lib/spotted/models/playlists/follower_unfollow_params.rb +16 -0
- data/lib/spotted/models/playlists/image_list_params.rb +16 -0
- data/lib/spotted/models/playlists/image_list_response.rb +10 -0
- data/lib/spotted/models/playlists/image_update_params.rb +24 -0
- data/lib/spotted/models/playlists/track_add_params.rb +45 -0
- data/lib/spotted/models/playlists/track_add_response.rb +18 -0
- data/lib/spotted/models/playlists/track_list_params.rb +82 -0
- data/lib/spotted/models/playlists/track_remove_params.rb +52 -0
- data/lib/spotted/models/playlists/track_remove_response.rb +18 -0
- data/lib/spotted/models/playlists/track_update_params.rb +67 -0
- data/lib/spotted/models/playlists/track_update_response.rb +18 -0
- data/lib/spotted/models/recommendation_get_params.rb +549 -0
- data/lib/spotted/models/recommendation_get_response.rb +86 -0
- data/lib/spotted/models/recommendation_list_available_genre_seeds_params.rb +14 -0
- data/lib/spotted/models/recommendation_list_available_genre_seeds_response.rb +16 -0
- data/lib/spotted/models/resume_point_object.rb +27 -0
- data/lib/spotted/models/search_retrieve_params.rb +120 -0
- data/lib/spotted/models/search_retrieve_response.rb +930 -0
- data/lib/spotted/models/show_list_episodes_params.rb +50 -0
- data/lib/spotted/models/show_list_params.rb +43 -0
- data/lib/spotted/models/show_list_response.rb +176 -0
- data/lib/spotted/models/show_retrieve_params.rb +33 -0
- data/lib/spotted/models/show_retrieve_response.rb +238 -0
- data/lib/spotted/models/simplified_artist_object.rb +73 -0
- data/lib/spotted/models/simplified_chapter_object.rb +209 -0
- data/lib/spotted/models/simplified_episode_object.rb +211 -0
- data/lib/spotted/models/simplified_playlist_object.rb +147 -0
- data/lib/spotted/models/simplified_track_object.rb +161 -0
- data/lib/spotted/models/time_interval_object.rb +32 -0
- data/lib/spotted/models/track_list_params.rb +43 -0
- data/lib/spotted/models/track_list_response.rb +16 -0
- data/lib/spotted/models/track_object.rb +375 -0
- data/lib/spotted/models/track_restriction_object.rb +28 -0
- data/lib/spotted/models/track_retrieve_params.rb +33 -0
- data/lib/spotted/models/user_retrieve_profile_params.rb +14 -0
- data/lib/spotted/models/user_retrieve_profile_response.rb +90 -0
- data/lib/spotted/models/users/playlist_create_params.rb +65 -0
- data/lib/spotted/models/users/playlist_create_response.rb +219 -0
- data/lib/spotted/models/users/playlist_list_params.rb +36 -0
- data/lib/spotted/models.rb +168 -0
- data/lib/spotted/request_options.rb +77 -0
- data/lib/spotted/resources/albums.rb +102 -0
- data/lib/spotted/resources/artists.rb +150 -0
- data/lib/spotted/resources/audio_analysis.rb +41 -0
- data/lib/spotted/resources/audio_features.rb +67 -0
- data/lib/spotted/resources/audiobooks.rb +105 -0
- data/lib/spotted/resources/browse/categories.rb +105 -0
- data/lib/spotted/resources/browse.rb +78 -0
- data/lib/spotted/resources/chapters.rb +72 -0
- data/lib/spotted/resources/episodes.rb +69 -0
- data/lib/spotted/resources/markets.rb +32 -0
- data/lib/spotted/resources/me/albums.rb +127 -0
- data/lib/spotted/resources/me/audiobooks.rb +121 -0
- data/lib/spotted/resources/me/episodes.rb +138 -0
- data/lib/spotted/resources/me/following.rb +133 -0
- data/lib/spotted/resources/me/player/queue.rb +65 -0
- data/lib/spotted/resources/me/player.rb +382 -0
- data/lib/spotted/resources/me/playlists.rb +44 -0
- data/lib/spotted/resources/me/shows.rb +127 -0
- data/lib/spotted/resources/me/top.rb +76 -0
- data/lib/spotted/resources/me/tracks.rb +121 -0
- data/lib/spotted/resources/me.rb +69 -0
- data/lib/spotted/resources/playlists/followers.rb +93 -0
- data/lib/spotted/resources/playlists/images.rb +67 -0
- data/lib/spotted/resources/playlists/tracks.rb +157 -0
- data/lib/spotted/resources/playlists.rb +91 -0
- data/lib/spotted/resources/recommendations.rb +160 -0
- data/lib/spotted/resources/search.rb +51 -0
- data/lib/spotted/resources/shows.rb +102 -0
- data/lib/spotted/resources/tracks.rb +69 -0
- data/lib/spotted/resources/users/playlists.rb +82 -0
- data/lib/spotted/resources/users.rb +41 -0
- data/lib/spotted/version.rb +5 -0
- data/lib/spotted.rb +257 -0
- data/manifest.yaml +15 -0
- data/rbi/spotted/client.rbi +104 -0
- data/rbi/spotted/errors.rbi +205 -0
- data/rbi/spotted/file_part.rbi +37 -0
- data/rbi/spotted/internal/cursor_url_page.rbi +22 -0
- data/rbi/spotted/internal/oauth2.rbi +34 -0
- data/rbi/spotted/internal/transport/base_client.rbi +292 -0
- data/rbi/spotted/internal/transport/pooled_net_requester.rbi +79 -0
- data/rbi/spotted/internal/type/array_of.rbi +104 -0
- data/rbi/spotted/internal/type/base_model.rbi +302 -0
- data/rbi/spotted/internal/type/base_page.rbi +42 -0
- data/rbi/spotted/internal/type/boolean.rbi +58 -0
- data/rbi/spotted/internal/type/converter.rbi +216 -0
- data/rbi/spotted/internal/type/enum.rbi +82 -0
- data/rbi/spotted/internal/type/file_input.rbi +59 -0
- data/rbi/spotted/internal/type/hash_of.rbi +104 -0
- data/rbi/spotted/internal/type/request_parameters.rbi +29 -0
- data/rbi/spotted/internal/type/union.rbi +128 -0
- data/rbi/spotted/internal/type/unknown.rbi +58 -0
- data/rbi/spotted/internal/util.rbi +484 -0
- data/rbi/spotted/internal.rbi +16 -0
- data/rbi/spotted/models/album_list_params.rbi +74 -0
- data/rbi/spotted/models/album_list_response.rbi +479 -0
- data/rbi/spotted/models/album_list_tracks_params.rbi +86 -0
- data/rbi/spotted/models/album_restriction_object.rbi +82 -0
- data/rbi/spotted/models/album_retrieve_params.rbi +59 -0
- data/rbi/spotted/models/album_retrieve_response.rbi +439 -0
- data/rbi/spotted/models/artist_list_albums_params.rbi +103 -0
- data/rbi/spotted/models/artist_list_albums_response.rbi +338 -0
- data/rbi/spotted/models/artist_list_params.rbi +44 -0
- data/rbi/spotted/models/artist_list_related_artists_params.rbi +30 -0
- data/rbi/spotted/models/artist_list_related_artists_response.rbi +30 -0
- data/rbi/spotted/models/artist_list_response.rbi +27 -0
- data/rbi/spotted/models/artist_list_top_tracks_params.rbi +59 -0
- data/rbi/spotted/models/artist_list_top_tracks_response.rbi +30 -0
- data/rbi/spotted/models/artist_object.rbi +166 -0
- data/rbi/spotted/models/artist_retrieve_params.rbi +27 -0
- data/rbi/spotted/models/audio_analysis_retrieve_params.rbi +30 -0
- data/rbi/spotted/models/audio_analysis_retrieve_response.rbi +1080 -0
- data/rbi/spotted/models/audio_feature_list_params.rbi +44 -0
- data/rbi/spotted/models/audio_feature_list_response.rbi +382 -0
- data/rbi/spotted/models/audio_feature_retrieve_params.rbi +27 -0
- data/rbi/spotted/models/audio_feature_retrieve_response.rbi +338 -0
- data/rbi/spotted/models/audiobook_list_chapters_params.rbi +89 -0
- data/rbi/spotted/models/audiobook_list_params.rbi +74 -0
- data/rbi/spotted/models/audiobook_list_response.rbi +377 -0
- data/rbi/spotted/models/audiobook_retrieve_params.rbi +59 -0
- data/rbi/spotted/models/audiobook_retrieve_response.rbi +332 -0
- data/rbi/spotted/models/author_object.rbi +30 -0
- data/rbi/spotted/models/browse/category_get_playlists_params.rbi +64 -0
- data/rbi/spotted/models/browse/category_get_playlists_response.rbi +51 -0
- data/rbi/spotted/models/browse/category_list_params.rbi +89 -0
- data/rbi/spotted/models/browse/category_list_response.rbi +204 -0
- data/rbi/spotted/models/browse/category_retrieve_params.rbi +62 -0
- data/rbi/spotted/models/browse/category_retrieve_response.rbi +68 -0
- data/rbi/spotted/models/browse_get_featured_playlists_params.rbi +87 -0
- data/rbi/spotted/models/browse_get_featured_playlists_response.rbi +49 -0
- data/rbi/spotted/models/browse_get_new_releases_params.rbi +59 -0
- data/rbi/spotted/models/browse_get_new_releases_response.rbi +423 -0
- data/rbi/spotted/models/chapter_list_params.rbi +74 -0
- data/rbi/spotted/models/chapter_list_response.rbi +588 -0
- data/rbi/spotted/models/chapter_restriction_object.rbi +50 -0
- data/rbi/spotted/models/chapter_retrieve_params.rbi +59 -0
- data/rbi/spotted/models/chapter_retrieve_response.rbi +551 -0
- data/rbi/spotted/models/copyright_object.rbi +41 -0
- data/rbi/spotted/models/episode_list_params.rbi +74 -0
- data/rbi/spotted/models/episode_list_response.rbi +30 -0
- data/rbi/spotted/models/episode_object.rbi +485 -0
- data/rbi/spotted/models/episode_restriction_object.rbi +48 -0
- data/rbi/spotted/models/episode_retrieve_params.rbi +59 -0
- data/rbi/spotted/models/external_id_object.rbi +50 -0
- data/rbi/spotted/models/external_url_object.rbi +32 -0
- data/rbi/spotted/models/followers_object.rbi +42 -0
- data/rbi/spotted/models/image_object.rbi +47 -0
- data/rbi/spotted/models/linked_track_object.rbi +88 -0
- data/rbi/spotted/models/market_list_params.rbi +27 -0
- data/rbi/spotted/models/market_list_response.rbi +26 -0
- data/rbi/spotted/models/me/album_check_params.rbi +46 -0
- data/rbi/spotted/models/me/album_check_response.rbi +13 -0
- data/rbi/spotted/models/me/album_list_params.rbi +88 -0
- data/rbi/spotted/models/me/album_list_response.rbi +529 -0
- data/rbi/spotted/models/me/album_remove_params.rbi +56 -0
- data/rbi/spotted/models/me/album_save_params.rbi +56 -0
- data/rbi/spotted/models/me/audiobook_check_params.rbi +46 -0
- data/rbi/spotted/models/me/audiobook_check_response.rbi +13 -0
- data/rbi/spotted/models/me/audiobook_list_params.rbi +61 -0
- data/rbi/spotted/models/me/audiobook_list_response.rbi +414 -0
- data/rbi/spotted/models/me/audiobook_remove_params.rbi +49 -0
- data/rbi/spotted/models/me/audiobook_save_params.rbi +46 -0
- data/rbi/spotted/models/me/context_object.rbi +77 -0
- data/rbi/spotted/models/me/device_object.rbi +123 -0
- data/rbi/spotted/models/me/episode_check_params.rbi +46 -0
- data/rbi/spotted/models/me/episode_check_response.rbi +13 -0
- data/rbi/spotted/models/me/episode_list_params.rbi +88 -0
- data/rbi/spotted/models/me/episode_list_response.rbi +55 -0
- data/rbi/spotted/models/me/episode_remove_params.rbi +56 -0
- data/rbi/spotted/models/me/episode_save_params.rbi +53 -0
- data/rbi/spotted/models/me/following_check_params.rbi +86 -0
- data/rbi/spotted/models/me/following_check_response.rbi +13 -0
- data/rbi/spotted/models/me/following_follow_params.rbi +91 -0
- data/rbi/spotted/models/me/following_list_params.rbi +89 -0
- data/rbi/spotted/models/me/following_list_response.rbi +187 -0
- data/rbi/spotted/models/me/following_unfollow_params.rbi +97 -0
- data/rbi/spotted/models/me/player/queue_add_params.rbi +63 -0
- data/rbi/spotted/models/me/player/queue_get_params.rbi +34 -0
- data/rbi/spotted/models/me/player/queue_get_response.rbi +143 -0
- data/rbi/spotted/models/me/player_get_currently_playing_params.rbi +88 -0
- data/rbi/spotted/models/me/player_get_currently_playing_response.rbi +304 -0
- data/rbi/spotted/models/me/player_get_devices_params.rbi +32 -0
- data/rbi/spotted/models/me/player_get_devices_response.rbi +34 -0
- data/rbi/spotted/models/me/player_get_state_params.rbi +85 -0
- data/rbi/spotted/models/me/player_get_state_response.rbi +335 -0
- data/rbi/spotted/models/me/player_list_recently_played_params.rbi +77 -0
- data/rbi/spotted/models/me/player_list_recently_played_response.rbi +67 -0
- data/rbi/spotted/models/me/player_pause_playback_params.rbi +50 -0
- data/rbi/spotted/models/me/player_seek_to_position_params.rbi +65 -0
- data/rbi/spotted/models/me/player_set_repeat_mode_params.rbi +65 -0
- data/rbi/spotted/models/me/player_set_volume_params.rbi +61 -0
- data/rbi/spotted/models/me/player_skip_next_params.rbi +47 -0
- data/rbi/spotted/models/me/player_skip_previous_params.rbi +50 -0
- data/rbi/spotted/models/me/player_start_playback_params.rbi +113 -0
- data/rbi/spotted/models/me/player_toggle_shuffle_params.rbi +63 -0
- data/rbi/spotted/models/me/player_transfer_params.rbi +66 -0
- data/rbi/spotted/models/me/playlist_list_params.rbi +61 -0
- data/rbi/spotted/models/me/show_check_params.rbi +46 -0
- data/rbi/spotted/models/me/show_check_response.rbi +13 -0
- data/rbi/spotted/models/me/show_list_params.rbi +61 -0
- data/rbi/spotted/models/me/show_list_response.rbi +277 -0
- data/rbi/spotted/models/me/show_remove_params.rbi +83 -0
- data/rbi/spotted/models/me/show_save_params.rbi +56 -0
- data/rbi/spotted/models/me/top_list_top_artists_params.rbi +81 -0
- data/rbi/spotted/models/me/top_list_top_tracks_params.rbi +81 -0
- data/rbi/spotted/models/me/track_check_params.rbi +46 -0
- data/rbi/spotted/models/me/track_check_response.rbi +13 -0
- data/rbi/spotted/models/me/track_list_params.rbi +88 -0
- data/rbi/spotted/models/me/track_list_response.rbi +58 -0
- data/rbi/spotted/models/me/track_remove_params.rbi +56 -0
- data/rbi/spotted/models/me/track_save_params.rbi +130 -0
- data/rbi/spotted/models/me_retrieve_params.rbi +27 -0
- data/rbi/spotted/models/me_retrieve_response.rbi +257 -0
- data/rbi/spotted/models/narrator_object.rbi +30 -0
- data/rbi/spotted/models/paging_playlist_object.rbi +83 -0
- data/rbi/spotted/models/playlist_retrieve_params.rbi +112 -0
- data/rbi/spotted/models/playlist_retrieve_response.rbi +327 -0
- data/rbi/spotted/models/playlist_track_object.rbi +101 -0
- data/rbi/spotted/models/playlist_tracks_ref_object.rbi +41 -0
- data/rbi/spotted/models/playlist_update_params.rbi +93 -0
- data/rbi/spotted/models/playlist_user_object.rbi +109 -0
- data/rbi/spotted/models/playlists/follower_check_params.rbi +52 -0
- data/rbi/spotted/models/playlists/follower_check_response.rbi +13 -0
- data/rbi/spotted/models/playlists/follower_follow_params.rbi +54 -0
- data/rbi/spotted/models/playlists/follower_unfollow_params.rbi +32 -0
- data/rbi/spotted/models/playlists/image_list_params.rbi +32 -0
- data/rbi/spotted/models/playlists/image_list_response.rbi +13 -0
- data/rbi/spotted/models/playlists/image_update_params.rbi +45 -0
- data/rbi/spotted/models/playlists/track_add_params.rbi +82 -0
- data/rbi/spotted/models/playlists/track_add_response.rbi +31 -0
- data/rbi/spotted/models/playlists/track_list_params.rbi +141 -0
- data/rbi/spotted/models/playlists/track_remove_params.rbi +100 -0
- data/rbi/spotted/models/playlists/track_remove_response.rbi +31 -0
- data/rbi/spotted/models/playlists/track_update_params.rbi +111 -0
- data/rbi/spotted/models/playlists/track_update_response.rbi +31 -0
- data/rbi/spotted/models/recommendation_get_params.rbi +864 -0
- data/rbi/spotted/models/recommendation_get_response.rbi +152 -0
- data/rbi/spotted/models/recommendation_list_available_genre_seeds_params.rbi +30 -0
- data/rbi/spotted/models/recommendation_list_available_genre_seeds_response.rbi +26 -0
- data/rbi/spotted/models/resume_point_object.rbi +47 -0
- data/rbi/spotted/models/search_retrieve_params.rbi +218 -0
- data/rbi/spotted/models/search_retrieve_response.rbi +1381 -0
- data/rbi/spotted/models/show_list_episodes_params.rbi +86 -0
- data/rbi/spotted/models/show_list_params.rbi +74 -0
- data/rbi/spotted/models/show_list_response.rbi +238 -0
- data/rbi/spotted/models/show_retrieve_params.rbi +59 -0
- data/rbi/spotted/models/show_retrieve_response.rbi +305 -0
- data/rbi/spotted/models/simplified_artist_object.rbi +121 -0
- data/rbi/spotted/models/simplified_chapter_object.rbi +287 -0
- data/rbi/spotted/models/simplified_episode_object.rbi +289 -0
- data/rbi/spotted/models/simplified_playlist_object.rbi +230 -0
- data/rbi/spotted/models/simplified_track_object.rbi +239 -0
- data/rbi/spotted/models/time_interval_object.rbi +54 -0
- data/rbi/spotted/models/track_list_params.rbi +74 -0
- data/rbi/spotted/models/track_list_response.rbi +27 -0
- data/rbi/spotted/models/track_object.rbi +556 -0
- data/rbi/spotted/models/track_restriction_object.rbi +48 -0
- data/rbi/spotted/models/track_retrieve_params.rbi +59 -0
- data/rbi/spotted/models/user_retrieve_profile_params.rbi +27 -0
- data/rbi/spotted/models/user_retrieve_profile_response.rbi +159 -0
- data/rbi/spotted/models/users/playlist_create_params.rbi +107 -0
- data/rbi/spotted/models/users/playlist_create_response.rbi +336 -0
- data/rbi/spotted/models/users/playlist_list_params.rbi +64 -0
- data/rbi/spotted/models.rbi +132 -0
- data/rbi/spotted/request_options.rbi +57 -0
- data/rbi/spotted/resources/albums.rbi +100 -0
- data/rbi/spotted/resources/artists.rbi +129 -0
- data/rbi/spotted/resources/audio_analysis.rbi +29 -0
- data/rbi/spotted/resources/audio_features.rbi +44 -0
- data/rbi/spotted/resources/audiobooks.rbi +105 -0
- data/rbi/spotted/resources/browse/categories.rbi +91 -0
- data/rbi/spotted/resources/browse.rbi +63 -0
- data/rbi/spotted/resources/chapters.rbi +69 -0
- data/rbi/spotted/resources/episodes.rbi +66 -0
- data/rbi/spotted/resources/markets.rbi +21 -0
- data/rbi/spotted/resources/me/albums.rbi +101 -0
- data/rbi/spotted/resources/me/audiobooks.rbi +86 -0
- data/rbi/spotted/resources/me/episodes.rbi +112 -0
- data/rbi/spotted/resources/me/following.rbi +99 -0
- data/rbi/spotted/resources/me/player/queue.rbi +45 -0
- data/rbi/spotted/resources/me/player.rbi +315 -0
- data/rbi/spotted/resources/me/playlists.rbi +34 -0
- data/rbi/spotted/resources/me/shows.rbi +101 -0
- data/rbi/spotted/resources/me/top.rbi +62 -0
- data/rbi/spotted/resources/me/tracks.rbi +112 -0
- data/rbi/spotted/resources/me.rbi +49 -0
- data/rbi/spotted/resources/playlists/followers.rbi +70 -0
- data/rbi/spotted/resources/playlists/images.rbi +47 -0
- data/rbi/spotted/resources/playlists/tracks.rbi +177 -0
- data/rbi/spotted/resources/playlists.rbi +102 -0
- data/rbi/spotted/resources/recommendations.rbi +336 -0
- data/rbi/spotted/resources/search.rbi +71 -0
- data/rbi/spotted/resources/shows.rbi +100 -0
- data/rbi/spotted/resources/tracks.rbi +66 -0
- data/rbi/spotted/resources/users/playlists.rbi +78 -0
- data/rbi/spotted/resources/users.rbi +29 -0
- data/rbi/spotted/version.rbi +5 -0
- data/sig/spotted/client.rbs +62 -0
- data/sig/spotted/errors.rbs +117 -0
- data/sig/spotted/file_part.rbs +21 -0
- data/sig/spotted/internal/cursor_url_page.rbs +13 -0
- data/sig/spotted/internal/oauth2.rbs +19 -0
- data/sig/spotted/internal/transport/base_client.rbs +131 -0
- data/sig/spotted/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/spotted/internal/type/array_of.rbs +48 -0
- data/sig/spotted/internal/type/base_model.rbs +102 -0
- data/sig/spotted/internal/type/base_page.rbs +24 -0
- data/sig/spotted/internal/type/boolean.rbs +26 -0
- data/sig/spotted/internal/type/converter.rbs +79 -0
- data/sig/spotted/internal/type/enum.rbs +32 -0
- data/sig/spotted/internal/type/file_input.rbs +25 -0
- data/sig/spotted/internal/type/hash_of.rbs +48 -0
- data/sig/spotted/internal/type/request_parameters.rbs +17 -0
- data/sig/spotted/internal/type/union.rbs +52 -0
- data/sig/spotted/internal/type/unknown.rbs +26 -0
- data/sig/spotted/internal/util.rbs +185 -0
- data/sig/spotted/internal.rbs +9 -0
- data/sig/spotted/models/album_list_params.rbs +30 -0
- data/sig/spotted/models/album_list_response.rbs +237 -0
- data/sig/spotted/models/album_list_tracks_params.rbs +38 -0
- data/sig/spotted/models/album_restriction_object.rbs +34 -0
- data/sig/spotted/models/album_retrieve_params.rbs +25 -0
- data/sig/spotted/models/album_retrieve_response.rbs +222 -0
- data/sig/spotted/models/artist_list_albums_params.rbs +49 -0
- data/sig/spotted/models/artist_list_albums_response.rbs +141 -0
- data/sig/spotted/models/artist_list_params.rbs +20 -0
- data/sig/spotted/models/artist_list_related_artists_params.rbs +15 -0
- data/sig/spotted/models/artist_list_related_artists_response.rbs +14 -0
- data/sig/spotted/models/artist_list_response.rbs +13 -0
- data/sig/spotted/models/artist_list_top_tracks_params.rbs +25 -0
- data/sig/spotted/models/artist_list_top_tracks_response.rbs +14 -0
- data/sig/spotted/models/artist_object.rbs +101 -0
- data/sig/spotted/models/artist_retrieve_params.rbs +15 -0
- data/sig/spotted/models/audio_analysis_retrieve_params.rbs +15 -0
- data/sig/spotted/models/audio_analysis_retrieve_response.rbs +518 -0
- data/sig/spotted/models/audio_feature_list_params.rbs +20 -0
- data/sig/spotted/models/audio_feature_list_response.rbs +170 -0
- data/sig/spotted/models/audio_feature_retrieve_params.rbs +15 -0
- data/sig/spotted/models/audio_feature_retrieve_response.rbs +153 -0
- data/sig/spotted/models/audiobook_list_chapters_params.rbs +38 -0
- data/sig/spotted/models/audiobook_list_params.rbs +30 -0
- data/sig/spotted/models/audiobook_list_response.rbs +189 -0
- data/sig/spotted/models/audiobook_retrieve_params.rbs +25 -0
- data/sig/spotted/models/audiobook_retrieve_response.rbs +174 -0
- data/sig/spotted/models/author_object.rbs +15 -0
- data/sig/spotted/models/browse/category_get_playlists_params.rbs +34 -0
- data/sig/spotted/models/browse/category_get_playlists_response.rbs +30 -0
- data/sig/spotted/models/browse/category_list_params.rbs +40 -0
- data/sig/spotted/models/browse/category_list_response.rbs +101 -0
- data/sig/spotted/models/browse/category_retrieve_params.rbs +27 -0
- data/sig/spotted/models/browse/category_retrieve_response.rbs +37 -0
- data/sig/spotted/models/browse_get_featured_playlists_params.rbs +38 -0
- data/sig/spotted/models/browse_get_featured_playlists_response.rbs +28 -0
- data/sig/spotted/models/browse_get_new_releases_params.rbs +32 -0
- data/sig/spotted/models/browse_get_new_releases_response.rbs +185 -0
- data/sig/spotted/models/chapter_list_params.rbs +30 -0
- data/sig/spotted/models/chapter_list_response.rbs +286 -0
- data/sig/spotted/models/chapter_restriction_object.rbs +15 -0
- data/sig/spotted/models/chapter_retrieve_params.rbs +25 -0
- data/sig/spotted/models/chapter_retrieve_response.rbs +271 -0
- data/sig/spotted/models/copyright_object.rbs +19 -0
- data/sig/spotted/models/episode_list_params.rbs +30 -0
- data/sig/spotted/models/episode_list_response.rbs +13 -0
- data/sig/spotted/models/episode_object.rbs +259 -0
- data/sig/spotted/models/episode_restriction_object.rbs +15 -0
- data/sig/spotted/models/episode_retrieve_params.rbs +25 -0
- data/sig/spotted/models/external_id_object.rbs +23 -0
- data/sig/spotted/models/external_url_object.rbs +15 -0
- data/sig/spotted/models/followers_object.rbs +17 -0
- data/sig/spotted/models/image_object.rbs +17 -0
- data/sig/spotted/models/linked_track_object.rbs +52 -0
- data/sig/spotted/models/market_list_params.rbs +14 -0
- data/sig/spotted/models/market_list_response.rbs +15 -0
- data/sig/spotted/models/me/album_check_params.rbs +25 -0
- data/sig/spotted/models/me/album_check_response.rbs +9 -0
- data/sig/spotted/models/me/album_list_params.rbs +40 -0
- data/sig/spotted/models/me/album_list_response.rbs +249 -0
- data/sig/spotted/models/me/album_remove_params.rbs +28 -0
- data/sig/spotted/models/me/album_save_params.rbs +28 -0
- data/sig/spotted/models/me/audiobook_check_params.rbs +25 -0
- data/sig/spotted/models/me/audiobook_check_response.rbs +9 -0
- data/sig/spotted/models/me/audiobook_list_params.rbs +34 -0
- data/sig/spotted/models/me/audiobook_list_response.rbs +204 -0
- data/sig/spotted/models/me/audiobook_remove_params.rbs +25 -0
- data/sig/spotted/models/me/audiobook_save_params.rbs +25 -0
- data/sig/spotted/models/me/context_object.rbs +47 -0
- data/sig/spotted/models/me/device_object.rbs +69 -0
- data/sig/spotted/models/me/episode_check_params.rbs +25 -0
- data/sig/spotted/models/me/episode_check_response.rbs +9 -0
- data/sig/spotted/models/me/episode_list_params.rbs +40 -0
- data/sig/spotted/models/me/episode_list_response.rbs +25 -0
- data/sig/spotted/models/me/episode_remove_params.rbs +28 -0
- data/sig/spotted/models/me/episode_save_params.rbs +26 -0
- data/sig/spotted/models/me/following_check_params.rbs +41 -0
- data/sig/spotted/models/me/following_check_response.rbs +9 -0
- data/sig/spotted/models/me/following_follow_params.rbs +44 -0
- data/sig/spotted/models/me/following_list_params.rbs +52 -0
- data/sig/spotted/models/me/following_list_response.rbs +94 -0
- data/sig/spotted/models/me/following_unfollow_params.rbs +46 -0
- data/sig/spotted/models/me/player/queue_add_params.rbs +34 -0
- data/sig/spotted/models/me/player/queue_get_params.rbs +19 -0
- data/sig/spotted/models/me/player/queue_get_response.rbs +53 -0
- data/sig/spotted/models/me/player_get_currently_playing_params.rbs +34 -0
- data/sig/spotted/models/me/player_get_currently_playing_response.rbs +160 -0
- data/sig/spotted/models/me/player_get_devices_params.rbs +17 -0
- data/sig/spotted/models/me/player_get_devices_response.rbs +16 -0
- data/sig/spotted/models/me/player_get_state_params.rbs +34 -0
- data/sig/spotted/models/me/player_get_state_response.rbs +181 -0
- data/sig/spotted/models/me/player_list_recently_played_params.rbs +40 -0
- data/sig/spotted/models/me/player_list_recently_played_response.rbs +38 -0
- data/sig/spotted/models/me/player_pause_playback_params.rbs +27 -0
- data/sig/spotted/models/me/player_seek_to_position_params.rbs +32 -0
- data/sig/spotted/models/me/player_set_repeat_mode_params.rbs +32 -0
- data/sig/spotted/models/me/player_set_volume_params.rbs +32 -0
- data/sig/spotted/models/me/player_skip_next_params.rbs +27 -0
- data/sig/spotted/models/me/player_skip_previous_params.rbs +27 -0
- data/sig/spotted/models/me/player_start_playback_params.rbs +58 -0
- data/sig/spotted/models/me/player_toggle_shuffle_params.rbs +32 -0
- data/sig/spotted/models/me/player_transfer_params.rbs +32 -0
- data/sig/spotted/models/me/playlist_list_params.rbs +34 -0
- data/sig/spotted/models/me/show_check_params.rbs +25 -0
- data/sig/spotted/models/me/show_check_response.rbs +9 -0
- data/sig/spotted/models/me/show_list_params.rbs +34 -0
- data/sig/spotted/models/me/show_list_response.rbs +137 -0
- data/sig/spotted/models/me/show_remove_params.rbs +34 -0
- data/sig/spotted/models/me/show_save_params.rbs +28 -0
- data/sig/spotted/models/me/top_list_top_artists_params.rbs +40 -0
- data/sig/spotted/models/me/top_list_top_tracks_params.rbs +40 -0
- data/sig/spotted/models/me/track_check_params.rbs +25 -0
- data/sig/spotted/models/me/track_check_response.rbs +9 -0
- data/sig/spotted/models/me/track_list_params.rbs +40 -0
- data/sig/spotted/models/me/track_list_response.rbs +21 -0
- data/sig/spotted/models/me/track_remove_params.rbs +28 -0
- data/sig/spotted/models/me/track_save_params.rbs +49 -0
- data/sig/spotted/models/me_retrieve_params.rbs +14 -0
- data/sig/spotted/models/me_retrieve_response.rbs +121 -0
- data/sig/spotted/models/narrator_object.rbs +15 -0
- data/sig/spotted/models/paging_playlist_object.rbs +50 -0
- data/sig/spotted/models/playlist_retrieve_params.rbs +38 -0
- data/sig/spotted/models/playlist_retrieve_response.rbs +178 -0
- data/sig/spotted/models/playlist_track_object.rbs +55 -0
- data/sig/spotted/models/playlist_tracks_ref_object.rbs +19 -0
- data/sig/spotted/models/playlist_update_params.rbs +44 -0
- data/sig/spotted/models/playlist_user_object.rbs +64 -0
- data/sig/spotted/models/playlists/follower_check_params.rbs +27 -0
- data/sig/spotted/models/playlists/follower_check_response.rbs +9 -0
- data/sig/spotted/models/playlists/follower_follow_params.rbs +27 -0
- data/sig/spotted/models/playlists/follower_unfollow_params.rbs +17 -0
- data/sig/spotted/models/playlists/image_list_params.rbs +17 -0
- data/sig/spotted/models/playlists/image_list_response.rbs +9 -0
- data/sig/spotted/models/playlists/image_update_params.rbs +25 -0
- data/sig/spotted/models/playlists/track_add_params.rbs +34 -0
- data/sig/spotted/models/playlists/track_add_response.rbs +17 -0
- data/sig/spotted/models/playlists/track_list_params.rbs +58 -0
- data/sig/spotted/models/playlists/track_remove_params.rbs +47 -0
- data/sig/spotted/models/playlists/track_remove_response.rbs +17 -0
- data/sig/spotted/models/playlists/track_update_params.rbs +58 -0
- data/sig/spotted/models/playlists/track_update_response.rbs +17 -0
- data/sig/spotted/models/recommendation_get_params.rbs +350 -0
- data/sig/spotted/models/recommendation_get_response.rbs +79 -0
- data/sig/spotted/models/recommendation_list_available_genre_seeds_params.rbs +15 -0
- data/sig/spotted/models/recommendation_list_available_genre_seeds_response.rbs +14 -0
- data/sig/spotted/models/resume_point_object.rbs +23 -0
- data/sig/spotted/models/search_retrieve_params.rbs +88 -0
- data/sig/spotted/models/search_retrieve_response.rbs +706 -0
- data/sig/spotted/models/show_list_episodes_params.rbs +38 -0
- data/sig/spotted/models/show_list_params.rbs +30 -0
- data/sig/spotted/models/show_list_response.rbs +125 -0
- data/sig/spotted/models/show_retrieve_params.rbs +25 -0
- data/sig/spotted/models/show_retrieve_response.rbs +162 -0
- data/sig/spotted/models/simplified_artist_object.rbs +71 -0
- data/sig/spotted/models/simplified_chapter_object.rbs +147 -0
- data/sig/spotted/models/simplified_episode_object.rbs +147 -0
- data/sig/spotted/models/simplified_playlist_object.rbs +126 -0
- data/sig/spotted/models/simplified_track_object.rbs +140 -0
- data/sig/spotted/models/time_interval_object.rbs +28 -0
- data/sig/spotted/models/track_list_params.rbs +30 -0
- data/sig/spotted/models/track_list_response.rbs +13 -0
- data/sig/spotted/models/track_object.rbs +295 -0
- data/sig/spotted/models/track_restriction_object.rbs +15 -0
- data/sig/spotted/models/track_retrieve_params.rbs +25 -0
- data/sig/spotted/models/user_retrieve_profile_params.rbs +15 -0
- data/sig/spotted/models/user_retrieve_profile_response.rbs +85 -0
- data/sig/spotted/models/users/playlist_create_params.rbs +44 -0
- data/sig/spotted/models/users/playlist_create_response.rbs +180 -0
- data/sig/spotted/models/users/playlist_list_params.rbs +34 -0
- data/sig/spotted/models.rbs +127 -0
- data/sig/spotted/request_options.rbs +34 -0
- data/sig/spotted/resources/albums.rbs +27 -0
- data/sig/spotted/resources/artists.rbs +37 -0
- data/sig/spotted/resources/audio_analysis.rbs +12 -0
- data/sig/spotted/resources/audio_features.rbs +17 -0
- data/sig/spotted/resources/audiobooks.rbs +27 -0
- data/sig/spotted/resources/browse/categories.rbs +29 -0
- data/sig/spotted/resources/browse.rbs +22 -0
- data/sig/spotted/resources/chapters.rbs +19 -0
- data/sig/spotted/resources/episodes.rbs +19 -0
- data/sig/spotted/resources/markets.rbs +11 -0
- data/sig/spotted/resources/me/albums.rbs +31 -0
- data/sig/spotted/resources/me/audiobooks.rbs +27 -0
- data/sig/spotted/resources/me/episodes.rbs +31 -0
- data/sig/spotted/resources/me/following.rbs +34 -0
- data/sig/spotted/resources/me/player/queue.rbs +21 -0
- data/sig/spotted/resources/me/player.rbs +88 -0
- data/sig/spotted/resources/me/playlists.rbs +15 -0
- data/sig/spotted/resources/me/shows.rbs +31 -0
- data/sig/spotted/resources/me/top.rbs +23 -0
- data/sig/spotted/resources/me/tracks.rbs +32 -0
- data/sig/spotted/resources/me.rbs +29 -0
- data/sig/spotted/resources/playlists/followers.rbs +26 -0
- data/sig/spotted/resources/playlists/images.rbs +20 -0
- data/sig/spotted/resources/playlists/tracks.rbs +43 -0
- data/sig/spotted/resources/playlists.rbs +30 -0
- data/sig/spotted/resources/recommendations.rbs +62 -0
- data/sig/spotted/resources/search.rbs +17 -0
- data/sig/spotted/resources/shows.rbs +27 -0
- data/sig/spotted/resources/tracks.rbs +19 -0
- data/sig/spotted/resources/users/playlists.rbs +25 -0
- data/sig/spotted/resources/users.rbs +14 -0
- data/sig/spotted/version.rbs +3 -0
- metadata +734 -0
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
class PlaylistTrackObject < Spotted::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute added_at
|
|
7
|
+
# The date and time the track or episode was added. _**Note**: some very old
|
|
8
|
+
# playlists may return `null` in this field._
|
|
9
|
+
#
|
|
10
|
+
# @return [Time, nil]
|
|
11
|
+
optional :added_at, Time
|
|
12
|
+
|
|
13
|
+
# @!attribute added_by
|
|
14
|
+
# The Spotify user who added the track or episode. _**Note**: some very old
|
|
15
|
+
# playlists may return `null` in this field._
|
|
16
|
+
#
|
|
17
|
+
# @return [Spotted::Models::PlaylistUserObject, nil]
|
|
18
|
+
optional :added_by, -> { Spotted::PlaylistUserObject }
|
|
19
|
+
|
|
20
|
+
# @!attribute is_local
|
|
21
|
+
# Whether this track or episode is a
|
|
22
|
+
# [local file](/documentation/web-api/concepts/playlists/#local-files) or not.
|
|
23
|
+
#
|
|
24
|
+
# @return [Boolean, nil]
|
|
25
|
+
optional :is_local, Spotted::Internal::Type::Boolean
|
|
26
|
+
|
|
27
|
+
# @!attribute track
|
|
28
|
+
# Information about the track or episode.
|
|
29
|
+
#
|
|
30
|
+
# @return [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject, nil]
|
|
31
|
+
optional :track, union: -> { Spotted::PlaylistTrackObject::Track }
|
|
32
|
+
|
|
33
|
+
# @!method initialize(added_at: nil, added_by: nil, is_local: nil, track: nil)
|
|
34
|
+
# Some parameter documentations has been truncated, see
|
|
35
|
+
# {Spotted::Models::PlaylistTrackObject} for more details.
|
|
36
|
+
#
|
|
37
|
+
# @param added_at [Time] The date and time the track or episode was added. \_**Note**: some very old
|
|
38
|
+
# playl
|
|
39
|
+
#
|
|
40
|
+
# @param added_by [Spotted::Models::PlaylistUserObject] The Spotify user who added the track or episode. \_**Note**: some very old
|
|
41
|
+
# playli
|
|
42
|
+
#
|
|
43
|
+
# @param is_local [Boolean] Whether this track or episode is a [local file](/documentation/web-api/concepts/
|
|
44
|
+
#
|
|
45
|
+
# @param track [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject] Information about the track or episode.
|
|
46
|
+
|
|
47
|
+
# Information about the track or episode.
|
|
48
|
+
#
|
|
49
|
+
# @see Spotted::Models::PlaylistTrackObject#track
|
|
50
|
+
module Track
|
|
51
|
+
extend Spotted::Internal::Type::Union
|
|
52
|
+
|
|
53
|
+
discriminator :type
|
|
54
|
+
|
|
55
|
+
variant :track, -> { Spotted::TrackObject }
|
|
56
|
+
|
|
57
|
+
variant :episode, -> { Spotted::EpisodeObject }
|
|
58
|
+
|
|
59
|
+
# @!method self.variants
|
|
60
|
+
# @return [Array(Spotted::Models::TrackObject, Spotted::Models::EpisodeObject)]
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
class PlaylistTracksRefObject < Spotted::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute href
|
|
7
|
+
# A link to the Web API endpoint where full details of the playlist's tracks can
|
|
8
|
+
# be retrieved.
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :href, String
|
|
12
|
+
|
|
13
|
+
# @!attribute total
|
|
14
|
+
# Number of tracks in the playlist.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer, nil]
|
|
17
|
+
optional :total, Integer
|
|
18
|
+
|
|
19
|
+
# @!method initialize(href: nil, total: nil)
|
|
20
|
+
# Some parameter documentations has been truncated, see
|
|
21
|
+
# {Spotted::Models::PlaylistTracksRefObject} for more details.
|
|
22
|
+
#
|
|
23
|
+
# @param href [String] A link to the Web API endpoint where full details of the playlist's tracks can b
|
|
24
|
+
#
|
|
25
|
+
# @param total [Integer] Number of tracks in the playlist.
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
# @see Spotted::Resources::Playlists#update
|
|
6
|
+
class PlaylistUpdateParams < Spotted::Internal::Type::BaseModel
|
|
7
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Spotted::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute collaborative
|
|
11
|
+
# If `true`, the playlist will become collaborative and other users will be able
|
|
12
|
+
# to modify the playlist in their Spotify client. <br/> _**Note**: You can only
|
|
13
|
+
# set `collaborative` to `true` on non-public playlists._
|
|
14
|
+
#
|
|
15
|
+
# @return [Boolean, nil]
|
|
16
|
+
optional :collaborative, Spotted::Internal::Type::Boolean
|
|
17
|
+
|
|
18
|
+
# @!attribute description
|
|
19
|
+
# Value for playlist description as displayed in Spotify Clients and in the Web
|
|
20
|
+
# API.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :description, String
|
|
24
|
+
|
|
25
|
+
# @!attribute name
|
|
26
|
+
# The new name for the playlist, for example `"My New Playlist Title"`
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :name, String
|
|
30
|
+
|
|
31
|
+
# @!attribute public
|
|
32
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
33
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
34
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
35
|
+
# public/private status, see
|
|
36
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
37
|
+
#
|
|
38
|
+
# @return [Boolean, nil]
|
|
39
|
+
optional :public, Spotted::Internal::Type::Boolean
|
|
40
|
+
|
|
41
|
+
# @!method initialize(collaborative: nil, description: nil, name: nil, public: nil, request_options: {})
|
|
42
|
+
# Some parameter documentations has been truncated, see
|
|
43
|
+
# {Spotted::Models::PlaylistUpdateParams} for more details.
|
|
44
|
+
#
|
|
45
|
+
# @param collaborative [Boolean] If `true`, the playlist will become collaborative and other users will be able t
|
|
46
|
+
#
|
|
47
|
+
# @param description [String] Value for playlist description as displayed in Spotify Clients and in the Web AP
|
|
48
|
+
#
|
|
49
|
+
# @param name [String] The new name for the playlist, for example `"My New Playlist Title"`
|
|
50
|
+
#
|
|
51
|
+
# @param public [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
52
|
+
#
|
|
53
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
class PlaylistUserObject < Spotted::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for this
|
|
8
|
+
# user.
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute external_urls
|
|
14
|
+
# Known public external URLs for this user.
|
|
15
|
+
#
|
|
16
|
+
# @return [Spotted::Models::ExternalURLObject, nil]
|
|
17
|
+
optional :external_urls, -> { Spotted::ExternalURLObject }
|
|
18
|
+
|
|
19
|
+
# @!attribute href
|
|
20
|
+
# A link to the Web API endpoint for this user.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :href, String
|
|
24
|
+
|
|
25
|
+
# @!attribute type
|
|
26
|
+
# The object type.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, Spotted::Models::PlaylistUserObject::Type, nil]
|
|
29
|
+
optional :type, enum: -> { Spotted::PlaylistUserObject::Type }
|
|
30
|
+
|
|
31
|
+
# @!attribute uri
|
|
32
|
+
# The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this
|
|
33
|
+
# user.
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :uri, String
|
|
37
|
+
|
|
38
|
+
# @!method initialize(id: nil, external_urls: nil, href: nil, type: nil, uri: nil)
|
|
39
|
+
# Some parameter documentations has been truncated, see
|
|
40
|
+
# {Spotted::Models::PlaylistUserObject} for more details.
|
|
41
|
+
#
|
|
42
|
+
# @param id [String] The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for this
|
|
43
|
+
#
|
|
44
|
+
# @param external_urls [Spotted::Models::ExternalURLObject] Known public external URLs for this user.
|
|
45
|
+
#
|
|
46
|
+
# @param href [String] A link to the Web API endpoint for this user.
|
|
47
|
+
#
|
|
48
|
+
# @param type [Symbol, Spotted::Models::PlaylistUserObject::Type] The object type.
|
|
49
|
+
#
|
|
50
|
+
# @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this use
|
|
51
|
+
|
|
52
|
+
# The object type.
|
|
53
|
+
#
|
|
54
|
+
# @see Spotted::Models::PlaylistUserObject#type
|
|
55
|
+
module Type
|
|
56
|
+
extend Spotted::Internal::Type::Enum
|
|
57
|
+
|
|
58
|
+
USER = :user
|
|
59
|
+
|
|
60
|
+
# @!method self.values
|
|
61
|
+
# @return [Array<Symbol>]
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Followers#check
|
|
7
|
+
class FollowerCheckParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute ids
|
|
12
|
+
# **Deprecated** A single item list containing current user's
|
|
13
|
+
# [Spotify Username](/documentation/web-api/concepts/spotify-uris-ids). Maximum: 1
|
|
14
|
+
# id.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :ids, String
|
|
18
|
+
|
|
19
|
+
# @!method initialize(ids: nil, request_options: {})
|
|
20
|
+
# Some parameter documentations has been truncated, see
|
|
21
|
+
# {Spotted::Models::Playlists::FollowerCheckParams} for more details.
|
|
22
|
+
#
|
|
23
|
+
# @param ids [String] **Deprecated** A single item list containing current user's [Spotify Username](/
|
|
24
|
+
#
|
|
25
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Followers#follow
|
|
7
|
+
class FollowerFollowParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute public
|
|
12
|
+
# Defaults to `true`. If `true` the playlist will be included in user's public
|
|
13
|
+
# playlists (added to profile), if `false` it will remain private. For more about
|
|
14
|
+
# public/private status, see
|
|
15
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
16
|
+
#
|
|
17
|
+
# @return [Boolean, nil]
|
|
18
|
+
optional :public, Spotted::Internal::Type::Boolean
|
|
19
|
+
|
|
20
|
+
# @!method initialize(public: nil, request_options: {})
|
|
21
|
+
# Some parameter documentations has been truncated, see
|
|
22
|
+
# {Spotted::Models::Playlists::FollowerFollowParams} for more details.
|
|
23
|
+
#
|
|
24
|
+
# @param public [Boolean] Defaults to `true`. If `true` the playlist will be included in user's public pla
|
|
25
|
+
#
|
|
26
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Followers#unfollow
|
|
7
|
+
class FollowerUnfollowParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!method initialize(request_options: {})
|
|
12
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Images#list
|
|
7
|
+
class ImageListParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!method initialize(request_options: {})
|
|
12
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Images#update
|
|
7
|
+
class ImageUpdateParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute body
|
|
12
|
+
# Base64 encoded JPEG image data, maximum payload size is 256 KB.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :body, String
|
|
16
|
+
|
|
17
|
+
# @!method initialize(body:, request_options: {})
|
|
18
|
+
# @param body [String] Base64 encoded JPEG image data, maximum payload size is 256 KB.
|
|
19
|
+
#
|
|
20
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Tracks#add
|
|
7
|
+
class TrackAddParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute body_position
|
|
12
|
+
# The position to insert the items, a zero-based index. For example, to insert the
|
|
13
|
+
# items in the first position: `position=0` ; to insert the items in the third
|
|
14
|
+
# position: `position=2`. If omitted, the items will be appended to the playlist.
|
|
15
|
+
# Items are added in the order they appear in the uris array. For example:
|
|
16
|
+
# `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M"], "position": 3}`
|
|
17
|
+
#
|
|
18
|
+
# @return [Integer, nil]
|
|
19
|
+
optional :body_position, Integer, api_name: :position
|
|
20
|
+
|
|
21
|
+
# @!attribute body_uris
|
|
22
|
+
# A JSON array of the
|
|
23
|
+
# [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For
|
|
24
|
+
# example:
|
|
25
|
+
# `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}`<br/>A
|
|
26
|
+
# maximum of 100 items can be added in one request. _**Note**: if the `uris`
|
|
27
|
+
# parameter is present in the query string, any URIs listed here in the body will
|
|
28
|
+
# be ignored._
|
|
29
|
+
#
|
|
30
|
+
# @return [Array<String>, nil]
|
|
31
|
+
optional :body_uris, Spotted::Internal::Type::ArrayOf[String], api_name: :uris
|
|
32
|
+
|
|
33
|
+
# @!method initialize(body_position: nil, body_uris: nil, request_options: {})
|
|
34
|
+
# Some parameter documentations has been truncated, see
|
|
35
|
+
# {Spotted::Models::Playlists::TrackAddParams} for more details.
|
|
36
|
+
#
|
|
37
|
+
# @param body_position [Integer] The position to insert the items, a zero-based index. For example, to insert the
|
|
38
|
+
#
|
|
39
|
+
# @param body_uris [Array<String>] A JSON array of the [Spotify URIs](/documentation/web-api/concepts/spotify-uris-
|
|
40
|
+
#
|
|
41
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Tracks#add
|
|
7
|
+
class TrackAddResponse < Spotted::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute snapshot_id
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :snapshot_id, String
|
|
12
|
+
|
|
13
|
+
# @!method initialize(snapshot_id: nil)
|
|
14
|
+
# @param snapshot_id [String]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Tracks#list
|
|
7
|
+
class TrackListParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute additional_types
|
|
12
|
+
# A comma-separated list of item types that your client supports besides the
|
|
13
|
+
# default `track` type. Valid types are: `track` and `episode`.<br/> _**Note**:
|
|
14
|
+
# This parameter was introduced to allow existing clients to maintain their
|
|
15
|
+
# current behaviour and might be deprecated in the future._<br/> In addition to
|
|
16
|
+
# providing this parameter, make sure that your client properly handles cases of
|
|
17
|
+
# new types in the future by checking against the `type` field of each object.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :additional_types, String
|
|
21
|
+
|
|
22
|
+
# @!attribute fields
|
|
23
|
+
# Filters for the query: a comma-separated list of the fields to return. If
|
|
24
|
+
# omitted, all fields are returned. For example, to get just the total number of
|
|
25
|
+
# items and the request limit:<br/>`fields=total,limit`<br/>A dot separator can be
|
|
26
|
+
# used to specify non-reoccurring fields, while parentheses can be used to specify
|
|
27
|
+
# reoccurring fields within objects. For example, to get just the added date and
|
|
28
|
+
# user ID of the adder:<br/>`fields=items(added_at,added_by.id)`<br/>Use multiple
|
|
29
|
+
# parentheses to drill down into nested objects, for
|
|
30
|
+
# example:<br/>`fields=items(track(name,href,album(name,href)))`<br/>Fields can be
|
|
31
|
+
# excluded by prefixing them with an exclamation mark, for
|
|
32
|
+
# example:<br/>`fields=items.track.album(!external_urls,images)`
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :fields, String
|
|
36
|
+
|
|
37
|
+
# @!attribute limit
|
|
38
|
+
# The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100.
|
|
39
|
+
#
|
|
40
|
+
# @return [Integer, nil]
|
|
41
|
+
optional :limit, Integer
|
|
42
|
+
|
|
43
|
+
# @!attribute market
|
|
44
|
+
# An
|
|
45
|
+
# [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
46
|
+
# If a country code is specified, only content that is available in that market
|
|
47
|
+
# will be returned.<br/> If a valid user access token is specified in the request
|
|
48
|
+
# header, the country associated with the user account will take priority over
|
|
49
|
+
# this parameter.<br/> _**Note**: If neither market or user country are provided,
|
|
50
|
+
# the content is considered unavailable for the client._<br/> Users can view the
|
|
51
|
+
# country that is associated with their account in the
|
|
52
|
+
# [account settings](https://www.spotify.com/account/overview/).
|
|
53
|
+
#
|
|
54
|
+
# @return [String, nil]
|
|
55
|
+
optional :market, String
|
|
56
|
+
|
|
57
|
+
# @!attribute offset
|
|
58
|
+
# The index of the first item to return. Default: 0 (the first item). Use with
|
|
59
|
+
# limit to get the next set of items.
|
|
60
|
+
#
|
|
61
|
+
# @return [Integer, nil]
|
|
62
|
+
optional :offset, Integer
|
|
63
|
+
|
|
64
|
+
# @!method initialize(additional_types: nil, fields: nil, limit: nil, market: nil, offset: nil, request_options: {})
|
|
65
|
+
# Some parameter documentations has been truncated, see
|
|
66
|
+
# {Spotted::Models::Playlists::TrackListParams} for more details.
|
|
67
|
+
#
|
|
68
|
+
# @param additional_types [String] A comma-separated list of item types that your client supports besides the defau
|
|
69
|
+
#
|
|
70
|
+
# @param fields [String] Filters for the query: a comma-separated list of the
|
|
71
|
+
#
|
|
72
|
+
# @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100.
|
|
73
|
+
#
|
|
74
|
+
# @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
|
|
75
|
+
#
|
|
76
|
+
# @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
|
|
77
|
+
#
|
|
78
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Tracks#remove
|
|
7
|
+
class TrackRemoveParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute tracks
|
|
12
|
+
# An array of objects containing
|
|
13
|
+
# [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) of the tracks
|
|
14
|
+
# or episodes to remove. For example:
|
|
15
|
+
# `{ "tracks": [{ "uri": "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" },{ "uri": "spotify:track:1301WleyT98MSxVHPZCA6M" }] }`.
|
|
16
|
+
# A maximum of 100 objects can be sent at once.
|
|
17
|
+
#
|
|
18
|
+
# @return [Array<Spotted::Models::Playlists::TrackRemoveParams::Track>]
|
|
19
|
+
required :tracks, -> { Spotted::Internal::Type::ArrayOf[Spotted::Playlists::TrackRemoveParams::Track] }
|
|
20
|
+
|
|
21
|
+
# @!attribute snapshot_id
|
|
22
|
+
# The playlist's snapshot ID against which you want to make the changes. The API
|
|
23
|
+
# will validate that the specified items exist and in the specified positions and
|
|
24
|
+
# make the changes, even if more recent changes have been made to the playlist.
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :snapshot_id, String
|
|
28
|
+
|
|
29
|
+
# @!method initialize(tracks:, snapshot_id: nil, request_options: {})
|
|
30
|
+
# Some parameter documentations has been truncated, see
|
|
31
|
+
# {Spotted::Models::Playlists::TrackRemoveParams} for more details.
|
|
32
|
+
#
|
|
33
|
+
# @param tracks [Array<Spotted::Models::Playlists::TrackRemoveParams::Track>] An array of objects containing [Spotify URIs](/documentation/web-api/concepts/sp
|
|
34
|
+
#
|
|
35
|
+
# @param snapshot_id [String] The playlist's snapshot ID against which you want to make the changes.
|
|
36
|
+
#
|
|
37
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
38
|
+
|
|
39
|
+
class Track < Spotted::Internal::Type::BaseModel
|
|
40
|
+
# @!attribute uri
|
|
41
|
+
# Spotify URI
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :uri, String
|
|
45
|
+
|
|
46
|
+
# @!method initialize(uri: nil)
|
|
47
|
+
# @param uri [String] Spotify URI
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Tracks#remove
|
|
7
|
+
class TrackRemoveResponse < Spotted::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute snapshot_id
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :snapshot_id, String
|
|
12
|
+
|
|
13
|
+
# @!method initialize(snapshot_id: nil)
|
|
14
|
+
# @param snapshot_id [String]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Tracks#update
|
|
7
|
+
class TrackUpdateParams < Spotted::Internal::Type::BaseModel
|
|
8
|
+
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Spotted::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute body_uris
|
|
12
|
+
#
|
|
13
|
+
# @return [Array<String>, nil]
|
|
14
|
+
optional :body_uris, Spotted::Internal::Type::ArrayOf[String], api_name: :uris
|
|
15
|
+
|
|
16
|
+
# @!attribute insert_before
|
|
17
|
+
# The position where the items should be inserted.<br/>To reorder the items to the
|
|
18
|
+
# end of the playlist, simply set _insert_before_ to the position after the last
|
|
19
|
+
# item.<br/>Examples:<br/>To reorder the first item to the last position in a
|
|
20
|
+
# playlist with 10 items, set _range_start_ to 0, and _insert_before_
|
|
21
|
+
# to 10.<br/>To reorder the last item in a playlist with 10 items to the start of
|
|
22
|
+
# the playlist, set _range_start_ to 9, and _insert_before_ to 0.
|
|
23
|
+
#
|
|
24
|
+
# @return [Integer, nil]
|
|
25
|
+
optional :insert_before, Integer
|
|
26
|
+
|
|
27
|
+
# @!attribute range_length
|
|
28
|
+
# The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of
|
|
29
|
+
# items to be reordered begins from the _range_start_ position, and includes the
|
|
30
|
+
# _range_length_ subsequent items.<br/>Example:<br/>To move the items at index
|
|
31
|
+
# 9-10 to the start of the playlist, _range_start_ is set to 9, and _range_length_
|
|
32
|
+
# is set to 2.
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :range_length, Integer
|
|
36
|
+
|
|
37
|
+
# @!attribute range_start
|
|
38
|
+
# The position of the first item to be reordered.
|
|
39
|
+
#
|
|
40
|
+
# @return [Integer, nil]
|
|
41
|
+
optional :range_start, Integer
|
|
42
|
+
|
|
43
|
+
# @!attribute snapshot_id
|
|
44
|
+
# The playlist's snapshot ID against which you want to make the changes.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :snapshot_id, String
|
|
48
|
+
|
|
49
|
+
# @!method initialize(body_uris: nil, insert_before: nil, range_length: nil, range_start: nil, snapshot_id: nil, request_options: {})
|
|
50
|
+
# Some parameter documentations has been truncated, see
|
|
51
|
+
# {Spotted::Models::Playlists::TrackUpdateParams} for more details.
|
|
52
|
+
#
|
|
53
|
+
# @param body_uris [Array<String>]
|
|
54
|
+
#
|
|
55
|
+
# @param insert_before [Integer] The position where the items should be inserted.<br/>To reorder the items to the
|
|
56
|
+
#
|
|
57
|
+
# @param range_length [Integer] The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of
|
|
58
|
+
#
|
|
59
|
+
# @param range_start [Integer] The position of the first item to be reordered.
|
|
60
|
+
#
|
|
61
|
+
# @param snapshot_id [String] The playlist's snapshot ID against which you want to make the changes.
|
|
62
|
+
#
|
|
63
|
+
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Spotted
|
|
4
|
+
module Models
|
|
5
|
+
module Playlists
|
|
6
|
+
# @see Spotted::Resources::Playlists::Tracks#update
|
|
7
|
+
class TrackUpdateResponse < Spotted::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute snapshot_id
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :snapshot_id, String
|
|
12
|
+
|
|
13
|
+
# @!method initialize(snapshot_id: nil)
|
|
14
|
+
# @param snapshot_id [String]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|